esp 5.2 command reference

774
ESP Workload Manager Version 5.2 Command Reference ESP-CR-02

Upload: sandra-e-jonas

Post on 10-Oct-2014

1.750 views

Category:

Documents


68 download

TRANSCRIPT

Page 1: ESP 5.2 Command Reference

ESP Workload ManagerVersion 5.2

Command ReferenceESP-CR-02

Page 2: ESP 5.2 Command Reference

2

Second Edition (October 1999)

This edition applies to Version 5 Release 2 of ESP Workload Manager Documentation.

The software and related manuals are protected by copyright law.

ESP Workload Manager Documentation�1992-1998,1999 Cybermation Inc.All rights reserved.No portion of this publication may be reproduced, stored in a retrieval system, or transmitted inany form or by any means without express written permission of Cybermation Inc.,80 Tiverton Court, Markham, Ontario, L3R 0G4, Canada, (905)-479-4611.www.cybermation.com

U.S. Government Users. RESTRICTED RIGHTS - Use, Duplication or Disclosure restricted byGSA ADP Schedule Contract with Cybermation Inc.

Trademark Notice:ESP Workload Manager is a registered trademark of Cybermation Inc.

All other brand and product names are trademarks or registered trademarks of their respectivecompanies.

Page 3: ESP 5.2 Command Reference

3

Introduction

Overview

This manual The ESP Workload Manager Command Reference contains all the commands andstatements available to ESP users. Use it as a reference for when you want acomplete description of the commands (or statements) and all valid keywords andparameters. Use the examples to see how each command and statement might beused.

If you know the command you want to use, and are familiar with its options, butsimply want to see the syntax, use the ESP Command Quick Reference.

Enteringcommands

ESP commands may be entered in Line mode, Page mode, batch, or loaded from adata set (using the LOAD command). Many can also be entered from a systemconsole.

ESP statements must be entered in a data set specific to the type of statement used.

Consult the ESP Workload Manager User’s Guide for more background material onany part of the Command Reference.

Issuing consolecommands

To issue a command from the system console, use the MODIFY command, as in

F ESP, where ESP is the started task name. For example:

F ESP,STATUS

Issuing OPERcommands

To issue a command that requires OPER authority from TSO, precede it withOPER. For example:

OPER STATUS

Issuingcommands inbatch

To issue a command in batch, use the following JCL after your job card:

//EXEC PGM=ESP,REGION=4000K//SYSPRINT DD SYSOUT=*//SYSIN DD *ESP command...ESP command

Continued on next page

Page 4: ESP 5.2 Command Reference

4

Overview, Continued

Subsystemname

If the subsystem name for ESP is not ‘ESP’, you need to type the subsystem namewhen entering a command in batch. For example, if the subsystem name is ‘ESPA’,type:

//EXEC PGM=ESP,PARM=’SUBSYS(ESPA)’,REGION=4000K

Steplib If the TSO command processor is not in a LINKLIST library, you need STEPLIB orJOBLIB statement in your JCL. Your statement may look like:

//STEPLIB DD DSN=CYB.ESP.LOAD,DISP=SHR

Wildcards andmasking

Many of the commands permit the use of a wildcard character and generic masking.Use the asterisk (*) as a wildcard to match any character, and a hyphen (-) formasking.

For example, to display all calendars:

LISTCAL –

To display all calendars with names containing XY in character positions 3 and 4:

LISTCAL **XY-

To display all calendars with two-character names:

LISTCAL **

Page 5: ESP 5.2 Command Reference

5

Syntax Diagrams

Input ESP is not case sensitive. Even though we show commands in uppercase, when youtype a command on the command line, you do not need to type the command inuppercase letters.

Syntaxconventions

The Syntax diagrams in this manual use the following conventions:

Notation MeaningApostrophes “ or ‘ Must be entered as shown.Comma , Must be entered as shown.Ellipsis … The parameter can be repeated. Do not enter ellipsis.Lower Case Italicsparameter

A parameter must be substituted. User supplied variableor character string.

Uppercase parameter The parameter must be spelled as shown. You can enterthe command and the parameter in either upper or lowercase.

OR-bar ( | ) Indicates an exclusive value on left or right of bar. Youmust enter one of the items. You cannot enter more thanone.

Underline ______ If you do not enter one of the parameters, the systemsupplies the underlined parameter, which is the default.

Parentheses ( ) andspecial characters

Parameter enclosed in parentheses is mandatory and mustbe entered as shown.

Single parameter insquare brackets [ ]

Optional parameter, do not type the brackets.

Stacked parameters inbraces { } { }

Mandatory, you must enter one of the parameters. Youcannot enter more than one.

Stacked parameters insquare brackets [ ] [ ]

Optional parameter, you can enter one value, or none.

Stacked parameterswith OR-bars ( | ) andsquare brackets[ ]|[ ]

Optional, mutually exclusive parameters. Enter one ornone.

Stacked parameters insquare brackets withinbraces {[ ]}

Mandatory, you must enter one of these parameters. Youcan enter more than one.

Page 6: ESP 5.2 Command Reference

6

Summary of Changes

Introduction This manual contains information previously presented in ESP-CR-01, whichsupports ESP Workload Manager version 5.1.

ChangedInformation

This manual contains terminology, maintenance and editorial changes. A verticalline to the left of the text indicates technical changes or additions to the text.

NewInformation

The following commands have been added:

• AGENT

• AGENTMSG

• ESPCOM

• ESP XCF commands:

• DELETE

• DISPLAY

• FORCE

• HELP

• PURGE

• SET

• SPIN TRACE

• START

• STOP

• VERIFY

• JOBRES

• MAPUSER

• MGRADDR

• MGRMSG

• TRYJOIN

The following statements have been added:

• ABSORB

• DURATION

• STEPEND

Page 7: ESP 5.2 Command Reference

7

Introduction ................................................................................................................................................... 3Overview............................................................................................................................................... 3Syntax Diagrams................................................................................................................................... 5Summary of Changes............................................................................................................................ 6ABANDON DEPENDENCIES Statement ......................................................................................... 15ABANDON RESOURCES Statement ............................................................................................... 17ABANDON SUBMISSION Statement .............................................................................................. 19ABENDLIM Command...................................................................................................................... 22ABSORB Statement ........................................................................................................................... 24ADJUST Command............................................................................................................................ 25AFTER Statement............................................................................................................................... 27AGENT Command ............................................................................................................................. 31AGENTMSG Command..................................................................................................................... 34AGENTRCV Command ..................................................................................................................... 37ALERTDEF Command ...................................................................................................................... 41ALLOWUNDEF Statement................................................................................................................ 44ALTCAL Command ........................................................................................................................... 45ALTEVENT Command...................................................................................................................... 47ALTGROUP Command...................................................................................................................... 50ALTSIG Command............................................................................................................................. 52ALTTJ Command............................................................................................................................... 53ALTUSER Command......................................................................................................................... 55APPL Statement.................................................................................................................................. 58APPLJOB Command - Controlling Jobs and subAppls ..................................................................... 63APPLJOB Command - Controlling Applications............................................................................... 74BACKOUT ......................................................................................................................................... 76BKUPEVS Command......................................................................................................................... 77BKUPHIST Command ....................................................................................................................... 78BKUPINDX Command ...................................................................................................................... 79BKUPJNDX Command...................................................................................................................... 81BKUPUDEF Command...................................................................................................................... 83BREAK Command ............................................................................................................................. 85CALENDAR Command ..................................................................................................................... 87CCCHK Statement.............................................................................................................................. 89CCFAIL Statement ............................................................................................................................. 94CELLTRC Command ......................................................................................................................... 97CHECKEXC Statement.................................................................................................................... 100CLASS Command ............................................................................................................................ 103CLRSYSMS Command .................................................................................................................... 107CMDPRFX Command...................................................................................................................... 108COM Command................................................................................................................................ 109CONNECT Command ...................................................................................................................... 110CONSOLE Command ...................................................................................................................... 112COPY Command .............................................................................................................................. 114COPYJCL Statement ........................................................................................................................ 116COREQ Statement............................................................................................................................ 119CPU Command ................................................................................................................................. 122CRITERIA Command....................................................................................................................... 124CRITPATH Command ..................................................................................................................... 127CRITPATH Application Statement .................................................................................................. 129DAB Command ................................................................................................................................ 131DATASET Statement ....................................................................................................................... 133DATEFORM Command................................................................................................................... 135DATEFORM Reporting Command.................................................................................................. 137

Page 8: ESP 5.2 Command Reference

8

DEFAT Command............................................................................................................................ 139DEFAULT Command....................................................................................................................... 142DEFCAL Command ......................................................................................................................... 144DEFGROUP Command.................................................................................................................... 147DEFHOL Command ......................................................................................................................... 150DEFPN Command ............................................................................................................................ 153DEFPRINT Command - DATASET Option .................................................................................... 156DEFPRINT Command - FILE Option .............................................................................................. 159DEFPRINT Command - SYSOUT Option....................................................................................... 161DEFPRIO Command ........................................................................................................................ 163DEFSIG Command........................................................................................................................... 164DEFSPEC Command........................................................................................................................ 166DEFSYML Command ...................................................................................................................... 169DEFTJ Command ............................................................................................................................. 172DEFTM: Define Tracking Model.................................................................................................... 174DEFUSER Command ....................................................................................................................... 178DELAT Command............................................................................................................................ 182DELAYINT: Delay Interval ............................................................................................................ 183DELAYSUB Statement .................................................................................................................... 184DELCAL Command ......................................................................................................................... 187DELETE Command - Event Definition........................................................................................... 188DELETE Command - General.......................................................................................................... 189DELGROUP Command.................................................................................................................... 190DELHOL Command......................................................................................................................... 191DELPN Command ............................................................................................................................ 193DELSIG Command........................................................................................................................... 194DELSPEC Command........................................................................................................................ 195DELSYML Command ...................................................................................................................... 197DELTJ Command ............................................................................................................................. 198DELTM Command ........................................................................................................................... 200DELUSER Command....................................................................................................................... 201DESELECT Statement ..................................................................................................................... 202DFLTUSER Command..................................................................................................................... 205DFPNODE Command ...................................................................................................................... 207DISCONN Command ....................................................................................................................... 209DISPLAY Command ........................................................................................................................ 210DJCDATA Statement ....................................................................................................................... 212DJCNET Statement .......................................................................................................................... 218DN Command ................................................................................................................................... 220DO Statement.................................................................................................................................... 223DOCLIB Statement........................................................................................................................... 225DQ Command ................................................................................................................................... 227DSNAME Statement......................................................................................................................... 229DSTRDLY Command ...................................................................................................................... 233DSTREXCL Command .................................................................................................................... 235DSTRIG Command .......................................................................................................................... 237DSTRIG Statement ........................................................................................................................... 242DSTRST Command.......................................................................................................................... 244DUEOUT Statement ......................................................................................................................... 246DURATION Statement..................................................................................................................... 250EARLYSUB Statement .................................................................................................................... 251ECHO Command .............................................................................................................................. 254EICLASS Command......................................................................................................................... 256EJECT Command ............................................................................................................................. 259ELSE Statement................................................................................................................................ 260

Page 9: ESP 5.2 Command Reference

9

END Command................................................................................................................................. 262ENDDEF Command ......................................................................................................................... 263ENDDO Statement ........................................................................................................................... 264%ENDEXCL Statement ................................................................................................................... 266ENDHC Command ........................................................................................................................... 268%ENDINCL Statement..................................................................................................................... 269ENDJOB Statement .......................................................................................................................... 271ENDMODEL Command .................................................................................................................. 273ENDPRINT Command ..................................................................................................................... 274ENDR Command .............................................................................................................................. 275ENDTEMPL Statement .................................................................................................................... 276ESP Statement .................................................................................................................................. 277ESPCOM Command......................................................................................................................... 279ESPCTR Command .......................................................................................................................... 280ESPNOMSG Statement .................................................................................................................... 282//*ESPSYMBOL Statement.............................................................................................................. 284EVENT Command............................................................................................................................ 286EVENTOPT Command .................................................................................................................... 291EVENTSET Command..................................................................................................................... 292%EXCLUDE Statement ................................................................................................................... 295EXIT Statement ................................................................................................................................ 299EXPECT Command.......................................................................................................................... 302FILENAME Statement ..................................................................................................................... 303FILE_TRIGGER Statement.............................................................................................................. 305FLAGUNDEF Statement.................................................................................................................. 307FLOW Command.............................................................................................................................. 309FOOTING Command ....................................................................................................................... 311//* FROM Statement......................................................................................................................... 313FROM Command.............................................................................................................................. 315GENDOC Command ........................................................................................................................ 317GENFLOW Command ..................................................................................................................... 319GENPROJ Command ....................................................................................................................... 321GENTIME Command....................................................................................................................... 323GO Command ................................................................................................................................... 327GROUP Command ........................................................................................................................... 328HARDCOPY Command - DATASET Option ................................................................................. 330HARDCOPY Command - FILE Option ........................................................................................... 332HARDCOPY Command - SYSOUT Option .................................................................................... 334HISTFILE Command - Reporting .................................................................................................... 336HISTFILE Command - Definition/Alteration .................................................................................. 338HOLD Command - Event Level ....................................................................................................... 340HOLD Command - General.............................................................................................................. 342IF Statement...................................................................................................................................... 344%INCLUDE Statement..................................................................................................................... 346INET Command................................................................................................................................ 350INFOCOMM Command................................................................................................................... 353INFOMSG Command....................................................................................................................... 355INIT Command................................................................................................................................. 357INPUT Command ............................................................................................................................. 359INPUTDS Statement......................................................................................................................... 360INTEGER Statement ........................................................................................................................ 362INVOKE Command.......................................................................................................................... 365JCLLIB Statement ............................................................................................................................ 367JESCOMCH Command.................................................................................................................... 370

Page 10: ESP 5.2 Command Reference

10

JESTYPE Command......................................................................................................................... 371JOB Statement .................................................................................................................................. 372JOBATTR Statement........................................................................................................................ 379JOBINFO Command ........................................................................................................................ 382JOBMAP Command ......................................................................................................................... 386JOBRES Command .......................................................................................................................... 391JOBTREE Command........................................................................................................................ 392JTPEXCL Command ........................................................................................................................ 394JUMPTO Statement.......................................................................................................................... 396LABEL Command ............................................................................................................................ 399LATESUB Statement ....................................................................................................................... 401LAX Command................................................................................................................................. 404LCMDPRFX Command ................................................................................................................... 406LDSN Command .............................................................................................................................. 407LDTE Command............................................................................................................................... 408LDTREL Command.......................................................................................................................... 409LDXE Command .............................................................................................................................. 410LIBSUB Command........................................................................................................................... 411LIST Command ................................................................................................................................ 413LISTAPPL Command....................................................................................................................... 416LISTAPTF Command....................................................................................................................... 421LISTAT Command ........................................................................................................................... 422LISTCAL Command ........................................................................................................................ 424LISTCKPT Command ...................................................................................................................... 426LISTEVS Command......................................................................................................................... 427LISTGRP Command......................................................................................................................... 429LISTHIST Command........................................................................................................................ 431LISTHOL Command ........................................................................................................................ 432LISTJTML Command ...................................................................................................................... 434LISTPN Command ........................................................................................................................... 435LISTQ Command.............................................................................................................................. 436LISTSADL Command ...................................................................................................................... 437LISTSCH Command......................................................................................................................... 438LISTSIG Command .......................................................................................................................... 441LISTSPEC Command....................................................................................................................... 443LISTSYML Command ..................................................................................................................... 446LISTTRAK Command...................................................................................................................... 448LISTUSER Command ...................................................................................................................... 449LISTXMEZ Command ..................................................................................................................... 451LJ Command..................................................................................................................................... 452LOAD Command.............................................................................................................................. 455LOADAGDF Command................................................................................................................... 457LOADJTDT Command .................................................................................................................... 458LOADSCHF Command.................................................................................................................... 460LOADUPDT Command ................................................................................................................... 461LOGPRT Command ......................................................................................................................... 462LSAR Command............................................................................................................................... 463LSYS Command ............................................................................................................................... 468LSYSMSGS Command .................................................................................................................... 470LTCELL Command.......................................................................................................................... 471LTJ Command .................................................................................................................................. 472LTM Command ................................................................................................................................ 474LTZONE Command ......................................................................................................................... 475MAPGEN Command ........................................................................................................................ 476MAPUSER Command ...................................................................................................................... 478

Page 11: ESP 5.2 Command Reference

11

MAXINITS Command ..................................................................................................................... 479MEMBER Statement ........................................................................................................................ 481MGRADDR Command .................................................................................................................... 483MGRMSG Command ....................................................................................................................... 485MODEL Statement ........................................................................................................................... 491MODEL Command........................................................................................................................... 492MONITOR Statement....................................................................................................................... 495MREPORT Command...................................................................................................................... 497MSG Command ................................................................................................................................ 500MSGLIMIT Statement...................................................................................................................... 502MSGTYPE Command ...................................................................................................................... 504NEXT Command .............................................................................................................................. 507NOCHECKEXC Statement .............................................................................................................. 509NODE Command.............................................................................................................................. 510NORUN Statement ........................................................................................................................... 512NOSCHED Command ...................................................................................................................... 515NOTIFY Statement........................................................................................................................... 517ON Command ................................................................................................................................... 522OPTIONS Statement......................................................................................................................... 525PANSUB Command ......................................................................................................................... 529PASSWORD Command ................................................................................................................... 531PNODES Statement.......................................................................................................................... 532POST Command ............................................................................................................................... 535POSTREQ Statement........................................................................................................................ 537PREALLOC Command .................................................................................................................... 541PREREQ Statement .......................................................................................................................... 543PRIORITY Statement ....................................................................................................................... 547PROFILE Statement ......................................................................................................................... 549PURGSCHF Command .................................................................................................................... 551QUIESCE Command ........................................................................................................................ 553QUIT Statement................................................................................................................................ 554QUPDATE Command ...................................................................................................................... 556RACROUTE Command ................................................................................................................... 557REEXEC Statement.......................................................................................................................... 559RELCOUNT Statement .................................................................................................................... 562RELDELAY Statement .................................................................................................................... 564RELEASE Command - Event Level................................................................................................. 566RELEASE Command - General ....................................................................................................... 568RELEASE Statement........................................................................................................................ 569REMOVE Command........................................................................................................................ 572REPORT Command.......................................................................................................................... 574RESDEF Command .......................................................................................................................... 575RESDFLT Command........................................................................................................................ 583RESOLVE Statement ....................................................................................................................... 588RESOURCE Statement..................................................................................................................... 590RESREFR Command........................................................................................................................ 594RESTART Command ....................................................................................................................... 595RESTORE Command ....................................................................................................................... 596RESUME - Event Level.................................................................................................................... 598RESUME - General .......................................................................................................................... 600REXXOFF Statement ....................................................................................................................... 601REXXON Statement......................................................................................................................... 602ROSSUB Command ......................................................................................................................... 605ROUTE Statement ............................................................................................................................ 606

Page 12: ESP 5.2 Command Reference

12

RUN Statement ................................................................................................................................. 608SADGEN Command......................................................................................................................... 612SADLINK Command ....................................................................................................................... 617SADLOAD Command...................................................................................................................... 619SADUPD Command......................................................................................................................... 621SAFGRANT Command.................................................................................................................... 622SAFOPTS Command........................................................................................................................ 624SAFRDEF Command ....................................................................................................................... 627SAFRDEL Command ....................................................................................................................... 628SAFREVOK Command.................................................................................................................... 629SCAN Command .............................................................................................................................. 630SCHEDULE Command .................................................................................................................... 633SECURE Statement .......................................................................................................................... 637SELECT Statement........................................................................................................................... 638SEND Command .............................................................................................................................. 642SETPRINT Command ...................................................................................................................... 645SETWIDTH Command .................................................................................................................... 646SHADOW Command ....................................................................................................................... 647SIGCYCLE Command ..................................................................................................................... 649SIGPOST Command......................................................................................................................... 651SIGWAIT Command ........................................................................................................................ 653SIMULATE Command..................................................................................................................... 655SMFSTATS Command..................................................................................................................... 662SORT Command............................................................................................................................... 663SPACE Command ............................................................................................................................ 665SPINLOG Command ........................................................................................................................ 666SPUSER Command .......................................................................................................................... 667STATUS Command.......................................................................................................................... 668STEPEND Statement........................................................................................................................ 669SUBAPPL Statement........................................................................................................................ 670SUBMIT Command.......................................................................................................................... 675SUSPEND Command - Event Level ................................................................................................ 678SUSPEND Command - General ....................................................................................................... 680SYMLIB Command.......................................................................................................................... 681SYSMSGS Command....................................................................................................................... 683TAG Statement ................................................................................................................................. 687TEMPLATE Statement .................................................................................................................... 689TEMPLIB Statement ........................................................................................................................ 694TEST Command ............................................................................................................................... 696THEN Statement............................................................................................................................... 698TIME Command ............................................................................................................................... 700TITLE Command.............................................................................................................................. 701TRACE Command............................................................................................................................ 704TRACEDEF Command .................................................................................................................... 707TRACEPRT Command .................................................................................................................... 709TRACKDEF Command.................................................................................................................... 711TRACKING Command .................................................................................................................... 716TRACKOPT Command.................................................................................................................... 718TRDFLT Command.......................................................................................................................... 721TRIGGER Command........................................................................................................................ 722TRYJOIN Command ........................................................................................................................ 727UNALLOC Command...................................................................................................................... 728//* UNTIL Statement ........................................................................................................................ 729USE Command ................................................................................................................................. 731USER Command............................................................................................................................... 732

Page 13: ESP 5.2 Command Reference

13

USERMOD Command ..................................................................................................................... 733VS Command.................................................................................................................................... 735WILDCARD Statement .................................................................................................................... 737XCF DELETE Command................................................................................................................. 739XCF DISPLAY Command ............................................................................................................... 741XCF FORCE Command ................................................................................................................... 744XCF HELP Command ...................................................................................................................... 746XCF PURGE Command ................................................................................................................... 747XCF SET TERMOPT Command ..................................................................................................... 749XCF SET TRACE Command........................................................................................................... 751XCF SPIN TRACE Command ......................................................................................................... 752XCF START SERVICE Command.................................................................................................. 753XCF START TRACE Command ..................................................................................................... 754XCF STOP GROUP Command........................................................................................................ 755XCF STOP MEMBER Command.................................................................................................... 756XCF STOP SERVICE Command..................................................................................................... 757XCF STOP TRACE Command ........................................................................................................ 758XCF VERIFY Command.................................................................................................................. 759XMITMDL: Identify Tracking Models To Transmit ...................................................................... 760

Page 14: ESP 5.2 Command Reference

14

Page 15: ESP 5.2 Command Reference

15

ABANDON DEPENDENCIES Statement

Overview The ABANDON DEPENDENCIES statement is used to submit a job without itspredecessor dependencies once it meets a specified time. This does not override amanual hold, a time dependency, or a resource dependency for a job.

Type ESP Application statement.

Syntax The syntax of the ABANDON DEPENDENCIES statement is:

ABANDON DEPENDENCIES criteria

Parameter DescriptionCriteria Schedule criteria that resolve to a single date and time.

Usage notes Specifying ABANDON DEPENDENCIES does not override a:

• Manual hold• Time dependency• Resource dependency.

Relatedinformation

For information on abandoning a submission time for a job, see the ABANDONSUBMISSION statement.

For information on abandoning a job’s resource requirements, see the ABANDONRESOURCES statement.

For information on manipulating jobs within Applications or subApplications, see theAPPLJOB or AJ command.

For information on Applications, see the ESP Workload Manager User’s Guide.

Continued on next page

Page 16: ESP 5.2 Command Reference

16

ABANDON DEPENDENCIES Statement, Continued

Example 1 The following ABANDON DEPENDENCIES statement submits a job without it’spredecessor dependency:

JOB PAYJOB1RUN DAILYRELEASE PAYJOB2

ENDJOBJOB PAYJOB2

RUN DAILYABANDON DEPENDENCIES 9PM

ENDJOB

In the above example, PAYJOB2 is submitted at 9 pm or when PAYJOB1completes, whichever comes first.

Example 2 The following ABANDON DEPENDENCIES statement submits a job without it’spredecessor dependency:

JOB PAYJOB3RUN DAILYRELEASE PAYJOB4

ENDJOBJOB PAYJOB4

RUN DAILYDELAYSUB 6PMABANDON DEPENDENCIES 7PM

ENDJOB

In the above example, PAYJOB4 is not submitted until 6 pm, and its dependency onPAYJOB3 is abandoned at 7 pm.

Example 3 The following ABANDON DEPENDENCIES statement submits a job without itspredecessor dependency, but not until a resource is available:

JOB PAYJOB5RUN DAILYRELEASE PAYJOB5

ENDJOBJOB PAYJOB6

RUN DAILYRESOURCE (1,T3480)ABANDON DEPENDENCIES NOW PLUS 2 HOURS

ENDJOB

In the above example, PAYJOB6 has a dependency on PAYJOB5 that is abandoned2 hours from the time the Application is scheduled. However, PAYJOB6 is notsubmitted until 1 unit of a resource called T3480 is available.

Page 17: ESP 5.2 Command Reference

17

ABANDON RESOURCES Statement

Overview The ABANDON RESOURCES statement is used to submit a job without itsresource dependencies at a specified time.

Type ESP Application statement.

Syntax The syntax of the ABANDON RESOURCES statement is:

ABANDON RESOURCES criteria

Parameter DescriptionCriteria Schedule criteria that resolve to a single date and time.

Usage notes Specifying ABANDON RESOURCES does not override a:

• Manual hold• Time dependency.

Relatedinformation

For information on abandoning a submission time for a job, see the ABANDONSUBMISSION statement.

For information on abandoning a job’s predecessor dependencies, see theABANDON DEPENDENCIES statement.

For information on manipulating jobs within Applications or subApplications, see theAPPLJOB or AJ command.

For information on Applications, see the ESP Workload Manager User’s Guide.

Example 1 The following ABANDON RESOURCES statement submits a job without meetingits resource requirement:

JOB PAYJOB1RUN DAILYRESOURCE (1,T3480)ABANDON RESOURCES 9PM

ENDJOB

In the above example, PAYJOB1 is submitted at 9 pm or when 1 unit of a resourcecalled T3480 is available, whichever comes first.

Continued on next page

Page 18: ESP 5.2 Command Reference

18

ABANDON RESOURCES Statement, Continued

Example 2 The following ABANDON RESOURCES statement submits a job without meetingits resource requirement:

JOB PAYJOB2RUN DAILYRESOURCE (1,CICSUP)ABANDON RESOURCES NOW PLUS 1 HOUR

ENDJOB

In the above example, PAYJOB2 is submitted 1 hour from the time the Applicationwas scheduled or when 1 unit of a resource called CICSUP is available, whichevercomes first.

Example 3 The following ABANDON RESOURCES statement submits a job without meetingits resource requirement based on the day of the week:

JOB PAYJOB3RUN DAILYRESOURCE (1,CICSUP)IF TODAY(‘MONDAY’) THEN -

ABANDON RESOURCES 7AMELSE -

ABANDON RESOURCES 9AMENDJOB

In the above example, PAYJOB3 is submitted at:

• 7 am on Mondays or when 1 unit of a resource called CICSUP is available• 9 am on all other days or when 1 unit of a resource called CICSUP is available.

Page 19: ESP 5.2 Command Reference

19

ABANDON SUBMISSION Statement

Overview The ABANDON SUBMISSION statement is used to bypass job submission at aspecified time.

Type ESP Application statement.

Syntax The syntax of the ABANDON SUBMISSION statement is:

ABANDON SUBMISSION criteria

Parameter DescriptionCriteria Schedule criteria that resolve to a single date and time when the

Application builds.

Usage notes When a job’s submission is abandoned, ESP flags the job with a status of ‘EXECABANDONED’ on the CSF, but retains the PREDWAIT PNODE until the job'spredecessors complete. Once the predecessors complete, the job is then bypassed.

The following example shows an abandoned job’s PNODE and STATUSinformation:

Consolidated Status: View PAYROLL Row 1 of 3, Col 1

COMMAND ===> SCR ===> CSR

Jobname APPL PNODE STATUS___ PAYJOB1 PAYROLL EXEC EXECUTING STEP1___ PAYJOB2 PAYROLL PREDWAIT COMPLETE, EXEC ABANDONED___ PAYJOB3 PAYROLL PREDWAIT WAITING, HC=1

In the above example, PAYJOB2’s submission was abandoned, but it retained thePREDWAIT PNODE. It waits for PAYJOB1 to complete before it becomesbypassed.

Usage notescontinued

If you want to run PAYJOB3 immediately when PAYJOB2 is bypassed, use theABANDON DEPENDENCIES statement in combination with the ABANDONSUBMISSION statement.

Specifying ABANDON SUBMISSION does not override a:

• Manual hold• Time dependency• Resource dependency.

Continued on next page

Page 20: ESP 5.2 Command Reference

20

ABANDON SUBMISSION Statement, Continued

Relatedinformation

For information on abandoning a job’s predecessor dependencies, see theABANDON DEPENDENCIES statement.

For information on abandoning a job’s resource requirements, see the ABANDONRESOURCES statement.

For information on manipulating jobs within Applications or subApplications, seethe APPLJOB or AJ command.

Example 1 The following ABANDON SUBMISSION statement abandons the submission of ajob at a specific time:

JOB PAYJOB1RUN DAILYREL PAYJOB2

ENDJOBJOB PAYJOB2

RUN DAILYABANDON SUBMISSION 9PM

ENDJOB

In the above example, submission of PAYJOB2 is abandoned at 9 pm if PAYJOB1is not complete by that time.

Example 2 The following ABANDON SUBMISSION statement abandons the submission of ajob at a specific time:

JOB PAYJOB3RUN DAILYREL PAYJOB4

ENDJOBJOB PAYJOB4

RUN DAILYABANDON SUBMISSION NOW PLUS 1 HOUR

ENDJOB

In the above example, PAYJOB4’s submission is abandoned 1 hour from the timethe Application was scheduled if PAYJOB3 has not completed by that time.

Continued on next page

Page 21: ESP 5.2 Command Reference

21

ABANDON SUBMISSION Statement, Continued

Example 3 The following ABANDON SUBMISSION statement abandons the submission ofmultiple jobs:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB5

RUN WORKDAYSREL PAYJOB6

JOB PAYJOB6RUN WORKDAYSREL PAYJOB7ABANDON SUBMISSION 9PM

JOB PAYJOB7RUN WORKDAYSABANDON SUBMISSION 9PM

ENDJOB

In the above example, if PAYJOB5 does not complete by 9 pm, PAYJOB6 andPAYJOB7 are not run.

Note: To abandon a group of jobs, consider using subApplications. You can thenuse Alert processing to bypass a group of jobs with one command. Refer to the ESPWorkload Manager Advanced User’s Guide.

Example 4 The following ABANDON SUBMISSION and ABANDON DEPENCENCIESstatements are used to abandon the submission of a job and allow the abandonedjob’s successor to be submitted.

JOB PAYJOB8RUN DAILYREL PAYJOB9

ENDJOBJOB PAYJOB9

RUN DAILYREL PAYJOB10ABANDON SUBMISSION 03.00ABANDON DEPENDENCIES 03.01

ENDJOBJOB PAYJOB10

RUN DAILYENDJOB

In the above example, If PAYJOB9 is not submitted by 3 am:

• Submission is abandoned• Dependency on PAYJOB8 is dropped at 3:01• PAYJOB9 is marked complete, and the hold count of PAYJOB10 is decremented• ABANDON DEPENDENCIES time is slightly later than the ABANDON

SUBMISSION time to avoid timing problems.

Page 22: ESP 5.2 Command Reference

22

ABENDLIM Command

Overview The ABENDLIM command is used to display or set the abend queue size for jobsthat ESP is tracking which produce a non-zero return code.

Type General command.

Authority OPER authority is required to issue the ABENDLIM command.

Syntax The syntax of the ABENDLIM command is:

ABENDLIM [count]

Parameter Descriptioncount Indicates the abend queue size. There is no default. If a count

is not specified, the abend queue size is displayed.

Usage notes When ESP detects that one of the jobs it is tracking abends or produces a non-zeroreturn code, it adds an entry to a list of abended jobs. The entry identifies thejobname, job number, termination time and completion code.

The ABENDLIM command specifies how long the list is to be allowed to grow.Once the list has grown to its full size, i.e. the count you specify, each newlyabended job causes the removal of the oldest job from the list. Thus, specifyingABENDLIM 100 causes ESP to keep track of the last 100 abended jobs.

It is not required that an ABENDLIM count be specified, as job abend informationcan be displayed using other commands, i.e. LJ, LTJ jobname I and the CSF.

If an ABENDLIM count is specified, you can display abended jobs using the DAB(display abended jobs) command.

If you increase the ABENDLIM count, ESP begins to store a longer list of jobs fromthe point at which you issue the command. For example, if you change ABENDLIMfrom 20 to 100, you will not immediately see any changes in a DAB display.

Continued on next page

Page 23: ESP 5.2 Command Reference

23

ABENDLIM Command, Continued

Relatedinformation

For information on displaying the abended queue, see the DAB (display abendedqueue) command.

For information on displaying job information, see the LJ (list job status) command.

For information on displaying job information, see the LTJ (list a tracked jobdefinition) command.

For information on displaying abended jobs using the CSF, see the ESP WorkloadManager User’s Guide.

Example 1 This following ABENDLIM command displays the abend queue size:

ABENDLIM

In the above example, when the ABENDLIM command is issued with no countparameter, the following display is produced indicating the abend queue size and thenumber of abended jobs:

ABEND QUEUE MAX = 20, 4 CURRENTLY QUEUED

Example 2 The following ABENDLIM command sets the abend queue size:

ABENDLIM 100

In the above example, the abend queue size is set to 100, indicating that ESP keepstrack of the last 100 abended jobs.

Page 24: ESP 5.2 Command Reference

24

ABSORB Statement

Overview The ABSORB statement is used to reserve a quantity of resources for jobs thatrequire a large resource count. Resource Absorption reserves the resources that areavailable at the time the job is next in the queue and holds them while waiting toaccumulate the remainder of resources required for that job. Jobs with smallerresource requirements cannot use the reserved resource. The ABSORB statementprevents jobs with large resource requirements incurring a processing delay.

Type ESP Application statement.

Syntax The syntax of the ABSORB statement is:

ABSORB

Usage The ABSORB statement will only ABSORB resources if the request is for less thanor equal to the maximum resource defined. An ABSORB statement is coded withinthe scope of the job statement, above the RESOURCE statement, where ResourceAbsorption is to occur. ABSORB can also be used at the Application level.

Example –Absorbstatement

This example shows coding an ABSORB statement within the scope of the jobstatement:APPL ABSRESJCLLIB ‘CYBER.JCLLIB.CNTL’JOB JOBX

RUN DAILYABSORBRESOURCE (4,T3480)

ENDJOB

When JOBX is first in the queue, the Resource Manager begins the process ofreserving the required resources, 4 units of T3480. Jobs that follow JOBX in thequeue that require less than or equal to the same resource, and are the same jobpriority, will not be submitted before JOBX.

Note:

A job with a higher priority and the same resource requirements will take theresources and run before the lower priority job with the ABSORB statement. Oncethe higher priority job completes, or has the resources it needs, the process ofgathering resources starts again.

Types ofresources

Absorption is available for the following types of resources:

• Renewable

• Depletable.

Page 25: ESP 5.2 Command Reference

25

ADJUST Command

Overview The ADJUST command is used to adjust the execution time or CPU time for one ormore jobs when using ESP’s modeling feature to forecast future workload.

Type Model command.

Syntax The syntax of the ADJUST command is:

ADJUST [EXECTIME(factor)][CPUTIME(factor)][JOBS(jobname[,jobname]...)]

Parameter DescriptionEXECTIME Indicates that an adjustment is to be made to the execution time

(or elapsed run time) of the requested job(s).CPUTIME Indicates that an adjustment is to be made to the CPU time of

the requested job(s).factor Indicates the adjustment factor expressed as a percentage.

Prefix the adjustment factor with a “+” or “-” sign, whichallows the MODEL processor to determine whether theexecution time or CPU time should be increased or decreased.

JOBS Limits the adjustment(s) to one or more jobnames or jobprefixes. The adjustment(s) are applied to all jobs in themodeling period if the JOBS keyword is not specified.

jobname Indicates one to eight alphanumeric character jobname or list ofjobnames to which the adjustment(s) apply. Asterisks or ahyphen as the last character may be used to perform masking.

Restriction The ADJUST command is only available with Modeling.

Usage notes ESP estimates a job’s execution time and CPU time based on historical data. Anadjustment factor alters these estimates. You can adjust the execution time or CPUtime for one or more jobs.

This may be useful when elapsed run times for jobs vary greatly at different times ofthe year, such as at year-end.

Relatedinformation

For information on forecasting future workload, see the ESP Workload ManagerUser’s and Advanced User’s Guides.

Continued on next page

Page 26: ESP 5.2 Command Reference

26

ADJUST Command, Continued

Example 1 The following ADJUST command adjusts the CPU time and execution time for alljobs in the modeling period:

ADJUST EXECTIME(-10) CPUTIME(-30)

In the above example:

• The execution time is adjusted by -10%• The CPU time is adjusted by -30%.

Example 2 The following ADJUST command adjusts the execution time for specific jobs:

ADJUST EXECTIME(+300) JOBS(ACC-,YEND****)

In the above example, the execution time is adjusted by +300% for all jobsbeginning with ‘ACC’, or having ‘YEND’ as the first 4 characters of their jobnames.

Example 3 The following ADJUST command adjust the execution time for a specific job on aspecific day:

IF TODAY(‘LAST DAY OF MONTH’) THEN -ADJUST EXECTIME(+200) JOB(PAYJOB1)

In the above example, the execution time is adjusted by +200% for PAYJOB1 on thelast day of the month.

Page 27: ESP 5.2 Command Reference

27

AFTER Statement

Overview The AFTER statement is used to specify any job(s) which are predecessors to a joband should indicate a release to this job upon completion. The default is successfulcompletion.

Type ESP Application statement.

Syntax The syntax of the AFTER statement is:

AFTER {jobname}{(jobname{(A)|(U)|(N)[,jobname(A)|(U)|(N]...})}{ADD(jobname{(A)|(U)|(N)[,jobname(A)|(U)|(N]...})}{DROP(jobname{(A)|(U)|(N)[,jobname(A)|(U)|(N]...})}

Parameter Descriptionjobname Indicates a jobname up to eight characters. Enclose multiple job

names in parentheses, separated by a blank or a comma.Jobnames may be qualified.

ADD Indicates that the specified job(s) be added to the currentlydefined AFTERs.

DROP Indicates that the specified job(s) be dropped from the currentlydefined AFTERs.

A Release on abnormal termination of a predecessor. Thisincludes condition code failures.

N Release on successful termination of a predecessor. This is thedefault.

U Release on any termination of a predecessor.

Usage notes Use AFTER to indicate the names of job(s) that are predecessors to this job andwhich will decrement the hold count on this job upon completion.

The termination parameters (A, U, N) are available only for jobs in an Application.

Note: This is different from the way the AFTER support on a DJCDATA statementworks.

Relatedinformation

For information on other ways specifying predecessor and successor relationships,see the RELEASE, PREREQ and POSTREQ statements.

For information on specifying predecessor and successor relationships, see the ESPWorkload Manager User’s Guide.

For jobs in JES3 or DJC jobnets, see the ABNORMAL and NORMAL parametersas documented in the JES3 or DJC User’s Guide.

Continued on next page

Page 28: ESP 5.2 Command Reference

28

AFTER Statement, Continued

Example 1 The following AFTER statement is used to indicate job relationships:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN DAILYENDJOBJOB PAYJOB2

RUN DAILYAFTER PAYJOB1

ENDJOB

In the above example, PAYJOB2 is submitted after the successful completion ofPAYJOB1.

Example 2 The following AFTER statement is used to indicate job relationships:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB3

RUN DAILYENDJOBJOB PAYJOB4

RUN DAILYENDJOBJOB PAYJOB5

RUN DAILYAFTER (PAYJOB3(U),PAYJOB4)

ENDJOB

In the above example, PAYJOB5 is submitted after any termination of PAYJOB3and the successful completion of PAYJOB4.

Continued on next page

Page 29: ESP 5.2 Command Reference

29

AFTER Statement, Continued

Example 3 The following AFTER and AFTER ADD statements are used to indicate jobrelationships:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB6

RUN DAILYENDJOBJOB PAYJOB7

RUN DAILYENDJOBJOB PAYJOB8

RUN DAILYAFTER PAYJOB6AFTER ADD(PAYJOB7)

ENDJOB

In the above example, PAYJOB8 is submitted after the successful completion ofPAYJOB6 and PAYJOB7.

Example 4 The following AFTER statements are used to indicate job relationships:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB9

RUN DAILYENDJOBJOB PAYJOB10

RUN DAILYAFTER PAYJOB9

ENDJOBJOB PAYJOB11 CONDITIONAL

RUN DAILYAFTER (PAYJOB10(A))

ENDJOB

In the above example, PAYJOB10 is submitted after the successful completion ofPAYJOB9. PAYJOB11 is conditional upon the abnormal completion ofPAYJOB10. If PAYJOB10 completes successfully, PAYJOB11 is bypassed.

Continued on next page

Page 30: ESP 5.2 Command Reference

30

AFTER Statement, Continued

Example 5 The following AFTER and AFTER ADD statements are used to indicate jobrelationships:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB12

RUN DAILYENDJOBJOB PAYJOB13

RUN DAILYENDJOBJOB PAYJOB14

RUN DAILYAFTER ADD(PAYJOB12)AFTER ADD(PAYJOB13)

ENDJOB

In the above example, PAYJOB14 is submitted after the successful completion ofPAYJOB12 and PAYJOB13.

Other examples Here are more examples using the AFTER statement:

Indicates that PAYJOB4 has 3 predecessors that must complete successfully beforeit is submitted:

JOB PAYJOB4AFTER (PAYJOB1,PAYJOB2,PAYJOB3)

Indicates that PAYJOB5 is to be released after an abnormal termination ofPAYJOB1:

JOB PAYJOB5AFTER (PAYJOB1(A))

Indicates that PAYJOB6 is to be released after all three of the following conditionsare met:

• The successful completion of PAYJOB1• An abnormal termination of PAYJOB2• Any termination of PAYJOB3.

JOB PAYJOB6AFTER PAYJOB1AFTER ADD(PAYJOB2(A))AFTER ADD(PAYJOB3(U))

Page 31: ESP 5.2 Command Reference

31

AGENT Command

Overview The AGENT command is used to display the contents of the Agent Definition file(AGENTDEF), and controls the flow of messages to the Agent.

Type General command.

Authority OPER authority is required to issue the AGENT command.

Syntax The syntax of the AGENT command is:

OPER AGENT [name][name LIST(ALL|CM_OWNED|DM_OWNED|ORPHANS)][name FLUSH|QUIESCE|RESTART]

Parameter DescriptionAGENT Displays the contents of the Agent Definition file.name Name specifies the name of the target Agent as defined in the

Agent Definition file.

Note:• Can be a valid Agent name as defined in the AgentDefinition file, or wild cards – (any character wild card)or * (single character wild card).• If name is not specified, the command is equal to:AGENT – LIST, which lists the contents of the AgentDefinition file for all Agents attached to this CentralManager.

LIST Lists the contents of the Agent Definition file for the namedAgent. This is the default.

Result:• Name of the Agent• IP address and port of the Agent• Communication protocol• Prefixing options• Encryption options• Character set• OS platform• Retry interval• Owning Manager• Active sessions

Continued on next page

Page 32: ESP 5.2 Command Reference

32

AGENT Command, Continued

ALL Lists all types of Agents, including those owned by theCentral Manager, those owned by a Distributed Manager, andthose that have no current owner.

CM_OWNED Lists all Agents owned by the central Manager.DM_OWNED Lists all Agents owned by Distributed Manager(s).ORPHANS Lists all Agents that currently have no owner assigned.FLUSH Purges all pending messages for each specified Agent. In ESP

Version 5 Release 2, FLUSH is used with the ESPCOMcommand.

QUIESCE Holds all messages to be sent to the named Agent until theRESTART command is issued.

RESTART Resumes sending messages to the named Agent. Usedfollowing the use of QUIESCE.

Example 1 The following is an example of the AGENT command:

OPER AGENT

Response received from the above command:

HP_CHIAddress 131.50.25.12Port 3001CommType TCP/IP, No prefixing, No encryption, Charcode ASCII,OS UNIXRetry Interval 0Owned by 131.50.30.15No active session for this Agent.

In this example, there is only one Agent attached to the Workload Manager wherethe command was issued.

Example 2 The following is an example of the AGENT command used to hold the messages toan Agent:

OPER AGENT HP QUIESCE

In this example, the Agent HP is quiesced.

Example 3 The following is an example of the AGENT command used to restart the sending ofmessages to the Agent after a QUIESCE command was issued:

OPER AGENT HP RESTART

In this example, the Agent HP is restarted.

Continued on next page

Page 33: ESP 5.2 Command Reference

33

AGENT Command, Continued

Example 4 The following is an example of the AGENT command used to purge messagequeues:

OPER AGENT HP- FLUSH

In this example, the wildcard (-) is used resulting in message queues of all Agentswhose names begin with HP being purged.

Example 5 The following is an example of the AGENT command used to list all Agents ownedby Distributed Manager(s):

OPER AGENT – LIST(DM_OWNED)

Page 34: ESP 5.2 Command Reference

34

AGENTMSG Command

Overview The AGENTMSG command is used to issue commands and send messages toAgents.

Type General command.

Authority OPER authority is required to issue the AGENTMSG command.

To issue the AGENTMSG command, you require read access to the SAF resource:AGENTMSG.verbsubverb.name.

Syntax The syntax of the AGENTMSG command is:

AGENTMSG {date|.} {time|.} agentname {from|.} {objectname|.}[CONTROL SETINITS|SHUTDOWN|CANCEL|FLUSH|REFRESH|CLRFILES][MGRADDR port()|address()]

Parameter Descriptiondate Indicates the date the message is sent. Specify the actual date

or use a period(.) as a placeholder, if omitting the date.time Indicates the time the message is sent. Specify the actual time

or use a period(.) as a placeholder, if omitting the time.agentname The name of the target Agent.from Indicates who the message is from. Specify who the message

is from or use a period(.) as a placeholder, if omitting who itis from.

Continued on next page

Page 35: ESP 5.2 Command Reference

35

AGENTMSG Command, Continued

Syntax con’t

Parameter Descriptionobjectname The name of the UNIX workload object to which the

command refers. This is a multi-option field. For commandsthat are not related to a specific workload object, specify aperiod(.) in place of the object name.

Note: To cancel the script, specify the name in the followingformat: jobname/appl.gen/MAIN

CONTROL Indicates the action to be taken, keywords entered as shown.The following are the options used with CONTROL:

• SETINITS nnnnSets the maximum number of initializations allowedon the Agent.Nnnn is the new number.Results in the workload object being ignored.

• SHUTDOWNInstructs the Agent to shutdown after the work thatwas executing completes.

• CANCELStops the specified workload object if it has alreadystarted.Removes the specified workload object from theinput queue, if it has not already started.

• FLUSHFlushes the specified workload object fromthe input queue, if it has not already startedexecution.Does not effect the workload object, if the WOB hasalready started.Sends status back to the Manager.

• REFRESHCauses the Agent to reload the security file.

• CLRFILESClears the schedwork file and commlog file.

Continued on next page

Page 36: ESP 5.2 Command Reference

36

AGENTMSG Command, Continued

Syntax con’t

Parameter DescriptionMGRADDR Tells the Agent to respond to messages from the Manager on

a new IP address and port. Is used when the Manager ismoved to a new machine, or when you want the Agent to takedirection from a different Manager. This is a temporarychange, until the next time the Agent is restarted.

port( ) Indicates the new port number.address( ) Indicates the new IP address.

Examples The following example shows using the AGENTMSG command to shutdown theAgent named UNIX_CHICAGO:

AGENTMSG . . UNIX_CHICAGO . . CONTROL SHUTDOWN

In the next example, the Agent named UNIX_RENO is told to cancel the workloadobject emp.date in generation 3 of the application EMPADDR:

AGENTMSG . . UNIX_RENO . emp.data/EMPADDR.3/MAIN CONTROLCANCEL

Page 37: ESP 5.2 Command Reference

37

AGENTRCV Command

Overview The AGENTRCV command is used to define and display the Manager’s receiverfunction for communication with ESP agents.

Type General command.

Authority OPER authority is required to issue the AGENTRCV command.

Syntax The syntax of the AGENTRCV statement is:

OPER AGENTRCV[DEFINE] [NAME(name)][DELETE][LIST][HALT][QUIESCE][RESTART][SET][PORT(portnumber)][SYMDEST(symdest)][LU(luname) TPNAME(tpname) LOGMODE(logmode)][POLLINGINTERVAL(interval1[,interval2])][{DUMPMSGS|NODUMPMSGS}][ENCRYPT|NOENCRYPT]

Parameter Descriptionname Indicates a unique 1 to 8 character agent receiver

name. The first character must be alphabetic or anational character. It is optional for the DISPLAYand LIST options and required for all otheroptions.

DEFINE Defines an Agent receiver to the ESP subsystemand starts it.

DELETE Stops an Agent receiver and deletes it from theESP subsystem.

LIST Displays the status of the ESP subsystem’s Agentreceiver(s). This is the default.

HALT Stops an Agent receiver without deleting it.QUIESCE Stops an Agent receiver without deleting it. An

alias of HALT.RESTART Restarts an Agent receiver that has been HALTed

or QUIESCEd.

Continued on next page

Page 38: ESP 5.2 Command Reference

38

AGENTRCV Command, Continued

Syntax (continued)

Parameter DescriptionSET Sets an Agent receiver parameter dynamically.PORT Indicates the TCP port number of a TCP/IP Agent

receiver. This parameter is only valid with theDEFINE and SET options. If specified with theSET option, the Agent receiver must be in a haltedstate. This parameter is mutually exclusive withthe,POLLINGINTERVAL LOGMODE, LU,MESSAGEQUEUENAME, SYMDEST andTPNAME parameters.

portnumber TCP/IP port number.SYMDEST Indicates a symbolic destination name in the

APPC side information file that represents theAgent LU (Logical Unit) and TP (TransactionProgram) name, and the LOGMODE name of thesession on which the APPC conversation is to becarried. This parameter may only be specifiedwith the DEFINE and SET options. Thisparameter is mutually exclusive with the PORTparameter.

symdest Specifies where Agent messages are received in anAPPC/APPN network.

LU Indicates the LU (Logical Unit) name of an APPCAgent receiver. This parameter may only bespecified with the DEFINE and SET options. Ifspecified with the DEFINE option and theSYMDEST parameter is omitted, then theLOGMODE and TPNAME parameters must alsobe specified. This parameter is mutually exclusivewith the PORT parameter.

luname APPC LU (Logical Unit) name.TPNAME Indicates the TP (Transaction Program) name of

the APPC Agent. This parameter may only bespecified with the DEFINE and SET options. Ifspecified with the DEFINE option and theSYMDEST parameter is omitted, then theLOGMODE and LU parameters must also bespecified. This parameter is mutually exclusivewith the PORT parameter.

tpname APPC TP (Transaction Program) name.

Continued on next page

Page 39: ESP 5.2 Command Reference

39

AGENTRCV Command, Continued

Syntax (continued)

Parameter DescriptionLOGMODE Indicates the mode name designating the network

properties for the session to be allocated for theAPPC conversation with the Agent. Thisparameter may only be specified with the DEFINEand SET options. If specified with the DEFINEoption and the SYMDEST parameter is omitted,then the LU and TPNAME parameters must alsobe specified. This parameter is mutually exclusivewith the PORT parameter.

logmode APPC logmode name.POLLINGINTERVAL Indicates polling intervals for an APPC receiver.

This parameter is only valid with the DEFINE andSET options. It is mutually exclusive with thePORT parameter.

interval1 Indicates the polling interval in seconds for anAPPC agent receiver. If omitted, the default is 5seconds.

interval2 Indicates the polling interval in seconds for anAPPC agent receiver if an error occurs. Thisvalue should be higher than “interval1”. Ifomitted, “interval1” is used.

DUMPMSGS/NODUMPMSGS

All the specified agent receiver’s messages arewritten to the console in a dump format(DUMPMSGS). May only be specified with theDEFINE and SET options.

ENCRYPT Specifies encrypted data will be accepted.NOENCRYPT Specifies that both encrypted and unencrypted

data can be received.

Usage notes Agent clients of versions earlier than 1.2 must connect to an Agent receiver thatspecifies PREFIXING. Agent clients version 1.2 or later provide an option(CommMsgPrefix=Y - see the Agent documentation for details) to specifyPREFIXING.

An Agent that specifies CommMsgPrefix=Y must connect to an Agent receiver thatspecifies PREFIXING. All other Agents must connect to an Agent receiver thatspecifies (or defaults to) NOPREFIXING. Cybermation recommends the use ofPREFIXING wherever possible.

Prefixingupdate

In ESP Workload Manager Version 5 Release 2 the PREFIXING|NOPREFIXINGkeywords are obsolete. ESP Workload Manager automatically determines ifprefixing is used or not.

Continued on next page

Page 40: ESP 5.2 Command Reference

40

AGENTRCV Command, Continued

Example 1 The following AGENTRCV command displays agent receivers:

AGENTRCV

In the above example, the status of the ESP subsystem’s agent receivers aredisplayed

Example 2 The following AGENTRCV command is used to define and start a TCP/IP agentreceiver:

AGENTRCV DEFINE NAME(CYBTCPIP) PORT(6664)

In the above example, an agent receiver named CYBTCPIP is started and will listensfor incoming connections on TCP/IP port 6664.

Example 3 The following AGENTRCV command is used to stop a TCP/IP agent receiver:AGENTRCV HALT NAME(CYBTCPIP)

orAGENTRCV QUIESCE NAME(CYBTCPIP)

In the above example, an agent receiver named CYBTCPIP is stopped using eitherHALT or QUIESCE.

Example 4 The following AGENTRCV command is used to reset the TCP port: of the aboveTCP/IP agent receiver to 6667:

AGENTRCV SET NAME(CYBTCPIP) PORT(6667)

In the above example, the TCP/IP port is reset to port 6667 for an agent receivernamed CYBTCPIP.

Page 41: ESP 5.2 Command Reference

41

ALERTDEF Command

Overview The ALERTDEF command is used to define and display alert definitions. An Alertdefinition points to an Event that is automatically triggered when the Alert isprocessed as part of a NOTIFY statement.

Type General command.

Authority OPER authority is required to issue the ALERTDEF command.

Syntax The syntax of the ALERTDEF command is:

ALERTDEF {ADD|ALTER|DELETE|LIST}[ID(xxxx)][EVENT(eventid)]

Parameter DescriptionADD Add an Alert definition.ALTER Alter the Event identifier of a previously defined Alert

definition.DELETE Delete an Alert definition.LIST Display one or more Alert definitions. This is the default.xxxx One to four-character logical identifier of the Alert definition.

This identifier is used in conjunction with a NOTIFY statementin an ESP Procedure.

eventid Name of the Event to be automatically triggered when thisAlert is invoked as a result of workload reaching a particularstage in processing, i.e. jobend or failure.

Continued on next page

Page 42: ESP 5.2 Command Reference

42

ALERTDEF Command, Continued

Usage notes The Alert feature enables ESP to trigger an Event for all jobs, or only specific jobs,in an ESP Application. You can trigger the Event at different monitor points, such astime of job submission, job start time, or when a job becomes overdue at anyprocessing stage. These correspond to the different processing points supported onthe NOTIFY statement.

To use the Alert feature, take these three steps:

1. Use the NOTIFY statement in an ESP Application to identify when to trigger theAlert.

2. Define the Alert with the ALERTDEF command.

3. Define the Event triggered by the Alert.

Alerts can be defined dynamically; i.e. via Page mode, but are not retained acrossrecycles of ESP. To ensure that Alert definitions are retained across recycles ofESP, insert the appropriate ALERTDEF commands in the ESP Workload ManagerInitialization Parameters.

Relatedinformation

For information on triggering Events automatically when workload reaches aparticular stage in processing, see the ESP Workload Manager User’s Guide.

For information on notifying users or consoles, or triggering an Event whenworkload reaches a particular stage in processing, see the NOTIFY statement.

Example 1 The following ALERTDEF command defines an Alert and associates that Alert withan Event name:

ALERTDEF ADD ID(INFO) EVENT(CYBER.CREATE_RECORD)

In the above example, an Alert with a logical identifier of ‘INFO’ is defined andassociated with an Event called ‘CYBER.CREATE_RECORD’, which isautomatically triggered when the following NOTIFY statement appears in an ESPApplication:

NOTIFY ABEND ALERT(INFO)

Example 2 The following ALERTDEF command alters an alert to associate it with a new Eventname:

ALERTDEF ALTER ID(INFO) EVENT(CYBER.CREATE_INFO_RECORD)

In the above example, an alert with a logical identifier of ‘INFO’ is altered toassociate it with a new Event - ‘CYBER.CREATE_INFO_RECORD’.

Continued on next page

Page 43: ESP 5.2 Command Reference

43

ALERTDEF Command, Continued

Example 3 The following ALERTDEF command displays all Alerts:

ALERTDEF

In the above example, all defined Alerts are displayed.

Example 4 The following ALERTDEF command deletes an alert:

ALERTDEF DELETE ID(INFO)

In the above example, an alert with a logical identifier of ‘INFO’ is deleted.

Example 5 The following ALERTDEF command displays an alert:

ALERTDEF ID(INFO)

In the above example, an alert with a logical identifier of ‘INFO’ is displayed.

Page 44: ESP 5.2 Command Reference

44

ALLOWUNDEF Statement

Overview The ALLOWUNDEF statement is used to turn off the flagging of undefinedsymbols in a symbolic variable library data set.

Type Symbolic variable library statement.

Syntax The syntax of the ALLOWUNDEF statement is:

ALLOWUNDEF

Restriction The ALLOWUNDEF statement cannot be used in ESP Procedures.

Usage notes The ALLOWUNDEF statement complements the FLAGUNDEF statement, whichrequests the flagging of undefined symbols.

ALLOWUNDEF turns off the flagging so that undefined symbols can be processedwithout an error message being issued.

By default, ESP allows undefined symbols.

RelatedStatements

For information on flagging undefined symbols, see the FLAGUNDEF statement.

Example 1 The following FLAGUNDEF and ALLOWUNDEF statements turn the flagging ofundefined symbols on and off:

FLAGUNDEFA=%BCALLOWUNDEFB=%XY

In the above example, when ESP encounters these undefined symbols whilesubmitting a job:

• A=%BC results in an error message - flagging is on (FLAGUNDEF)• B takes on the value of %XY - flagging is off (ALLOWUNDEF).

Page 45: ESP 5.2 Command Reference

45

ALTCAL Command

Overview The ALTCAL command is used to modify an existing calendar definition.

Type General command.

Authority SPECIAL or CALENDARDEF authority is required to issue the ALTCALcommand in non-SAF environments. With SAF you control access to calendarsusing the CALENDAR.calname resource.

Syntax The syntax of the ALTCAL command is:

{ALTCAL|ALTC} calname[LOGICAL|ABSOLUTE][SHIFT(hh:mm)][WEEKSTART(day)][WORKDAYS(workday[,workday]...)]

Parameter Descriptioncalname Indicates the name of the calendar to be modified.LOGICAL/ABSOLUTE

Indicates a logical or absolute calendar. If you are modifyingfrom an absolute calendar to a logical calendar, you need tospecify both logical and SHIFT(hh:mm).

hh:mm Modifies the start time of a logical day.day Indicates the first day of the week.workday Indicates which days are to be considered workdays.

Separate each with a blank or comma.

Usage notes Cybermation recommends you use absolute calendars because of their ease of use.

Relatedinformation

For information on defining and deleting calendars, see the DEFCAL and DELCALcommands.

For information on working with calendars, see the ESP Workload ManagerAdministrator’s Guide.

Example 1 The following ALTCAL command modifies the first day of the week:

ALTCAL PAYROLL WEEKSTART(MONDAY)

In the above example, the first day of the week is changed to MONDAY on thePAYROLL calendar.

Continued on next page

Page 46: ESP 5.2 Command Reference

46

ALTCAL Command, Continued

Example 2 The following ALTCAL command modifies the start time of each logical day:

ALTCAL FISCAL SHIFT(09:00)

In the above example, each logical day on the FISCAL calendar is changed to start a9 am.

Page 47: ESP 5.2 Command Reference

47

ALTEVENT Command

Overview The ALTEVENT command is used to change certain characteristics of one or moreEvents. Specify any number of parameters to cause multiple changes to a singleEvent or group of Events to which you have access.

Type General command.

Authority You can only alter Events to which you have access.

Syntax The syntax of the ALTEVENT command is:

ALTEVENT eventid{[CLASS(classname)]}{[CALENDAR(cal1[,cal2]...)]}{[ADD(hours,minutes)|SUBTRACT(hours,minutes)]}{[EVENTSET(evdsid)]}{[SYMLIB(sym1[,sym2]...)]}{[SYSTEM(newsys,oldsys)]}

Parameter Descriptioneventid Indicates an Event identifier. It may contain asterisks and

hyphens when a group of Events are to be altered at one time.classname Indicates a new ESP class, up to eight alphanumeric

characters, the first of which must be alphabetic.cal1 Indicates a calendar name, up to eight alphanumeric

characters, the first of which is alphabetic.cal2 Indicates a calendar name, up to eight alphanumeric

characters, the first of which is alphabetic.hours,minutes Indicates the changes you want to make to the scheduled

execution times. You can add or subtract hours and minutesto compute a new set of time and date schedules. If you onlywant to change the time by a certain number of minutes,specify a zero in the hours field, e.g. ADD(0,45).

evdsid Indicates the ID of an Event data set. This allows you to limitchanges to a particular Eventset in a non-SAF environment.

sym1-sym3 Indicates one, two or three-replacement symbol-librarynames, separated by a blank or comma. An asterisk ispermitted instead of a name if you want to change one symbollibrary without affecting others.

newsys Indicates an ESP system ID. This is the SYSTEM identifierto which you are changing.

oldsys Indicates an ESP system ID on which an ESP subsystem isrunning. It may contain asterisks and a hyphen. It limitschanges to Events to be executed on the specified system ID.This is the SYSTEM identifier from which you are changing.

Continued on next page

Page 48: ESP 5.2 Command Reference

48

ALTEVENT Command, Continued

Usage notes Use the SYSTEM parameter to change Events queued to a specific system orsystems. This is required when the ESP system identifier changes.

If you are altering the system ID or changing execution times, the schedule is alteredat the next scheduled scan. If the Event is already scheduled on another system, itexecutes on that system. When the next day’s schedule is built, the new system IDis taken into account. In the same way, the schedule changes come into effectfollowing the schedule scan.

To alter other characteristics of an Event or group of Events such as JCL library:

1. Use the LIST command with the ALL parameter in Page mode2. Type EDIT3. Make the required changes and then save them to a data set (i.e. CREATE)4. Use the LOAD command to load the data set to ESP.

Note: When the ALTEVENT command contains asterisks or a hyphen, all matchingentries are altered. If you are unsure which Events a particular command affects,use a LIST command to test the specified mask.

You cannot alter the Eventset for one or more Events with the ALTEVENTcommand.

Relatedinformation

For information on working with Events, see the ESP Workload Manager User’sGuide.

Example 1 The following ALTEVENT command changes the system on which a group ofEvents execute to an alternative system:

ALTEVENT MYGROUP.- SYSTEM(PROD TEST)

In the above example, Events in MYGROUP are altered to execute on systemPROD, instead of system TEST.

Example 2 The following ALTEVENT command changes the class associated with a group ofEvents:

ALTEVENT PROD.PAY- CLASS(PAYJOBS)

In the above example, Events that start with PROD.PAY have their Event classchanged to PAYJOBS.

Continued on next page

Page 49: ESP 5.2 Command Reference

49

ALTEVENT Command, Continued

Example 3 The following ALTEVENT command changes the symbol library that a group ofEvents access:

ALTEVENT MYGROUP.- SYMLIB(SYSSM1,MYSYM)

In the above example, Events in MYGROUP are altered to access symbol librariesSYSSM1 and MYSYM.

Note: If you want to change the second or third SYMLIB without affecting anintervening one, specify an asterisk in the place of the unaffected SYMLIB asfollows:

ALTEVENT PROD.- SYMLIB(* * PRODSYMS)

In the above example, the third SYMLIB is changed to PRODSYMS. The first andsecond SYMLIBS remain the same.

Example 4 The following ALTEVENT command advances the scheduled execution time of anEvent:

ALTEVENT CYBER.EARLY SUBTRACT(0,30)

In the above example, CYBER.EARLY’s scheduled execution time is advanced(brought forward) by 30 minutes.

Example 5 The following ALTEVENT command changes the system identifier:

ALTEVENT - SYSTEM(SYSB,SYSA) EVENTSET(CLIENT1)

In the above example, the system identifier is changed from SYSA to SYSB, for allEvents in Eventset CLIENT1.

Example 6 The following ALTEVENT command alters the calendars referenced by an Event:

ALTEVENT PAYROLL.JOBS CALENDAR(*,PAYCAL3)

In the above example, PAYROLL.JOBS’ secondary calendar is changed to referencePAYCAL3.

Example 7 The following ALTEVENT command delays the scheduled execution time of anEvent:

ALTEVENT PROD.DAILY ADD(2,30)

In the above example, all of the PROD.DAILY Events have their scheduledexecution time delayed by 2 hours and 30 minutes.

Page 50: ESP 5.2 Command Reference

50

ALTGROUP Command

Overview The ALTGROUP command is used to modify an existing group definition.

Type General command.

Authority SPECIAL or GROUPDEF authority is required to issue the ALTGROUP command.

Note: ALTGROUP is applicable only when using ESP Workload Manager’sinternal security.

Syntax The syntax of the ALTGROUP command is:

{ALTGROUP} groupname{ALTG}

{[EVENTSET(eventdsid)]}{[DEPARTMENT(deptid)]}{[AUTH {(OPER)|(NOOPER)]}{[UREAD|NOUREAD]}{[RACID|NORACID]}{[CALENDAR(cal1[,cal2]...)]}

Parameter Descriptiongroupname Indicates the specific name of an ESP group.eventdsid Indicates the logical identifier of the Event database used to

store Events prefixed with the group name.deptid Indicates a department name of up to eight characters to

which this group belongs. It may contain asterisks and mayalso have a hyphen in the last character position.

OPER Indicates that Events having this group name as a prefix cancontain operator commands.

NOOPER Removes the OPER attribute.UREAD Indicates that universal read access is available for any Event

defined using this group prefix.RACID Indicates that the security attributes of the group name should

be used when ESP processes an Event rather than the ID ofthe defining user.

NORACID Indicates that the security attributes of the group name shouldno longer be used when ESP processes an Event.

cal1 Indicates the name of the first default calendar, up to eightalphanumeric characters.

cal2 Indicates the name of the second default calendar, up to eightalphanumeric characters.

Continued on next page

Page 51: ESP 5.2 Command Reference

51

ALTGROUP Command, Continued

Usage notes To set the second default calendar without affecting the setting of the first calendar,code an asterisk (*) as the first calendar name. To nullify a calendar, specify‘NONE’.

Relatedinformation

For information on defining groups, see the ESP Workload Manager Administrator’sGuide.

Example 1 The following example alters the second default calendar for a group:

ALTGROUP GROUP1 CALENDAR(* CAL3)

In the above example, GROUP1’s secondary calendar is altered to reference CAL3.The first default calendar is left as is.

Example 2 The following example alters various attributes of a group:

ALTGROUP GROUP27 DEPARTMENT(ACCOUNTS)-NOUREAD AUTH(NOOPER)

In the above example, GROUP27:

• Is assigned to a department called ACCOUNTS• Has its universal read access removed• Has its ability to issue operator commands removed.

Page 52: ESP 5.2 Command Reference

52

ALTSIG Command

Overview The ALTSIG command is used to alter the number of generations of a signal.

Type General command.

Authority You can only alter a signal beginning with the prefix of your user ID or a group towhich you have access.

Syntax The syntax of the ALTSIG command is:

ALTSIG signalname GEN(genno)

Parameter Descriptionsignalname Indicates a signal name in the format prefix.signalname,

where signalname is 1-16 alphanumeric characters. If theprefix is not specified, the current group prefix set by theGROUP command is used.

genno Indicates the number of generations of a signal that are to bestored.

Relatedinformation

For information on defining and working with signals, see the ESP WorkloadManager Advanced User’s Guide.

For information on defining and deleting signals, see the DEFSIG and DELSIGcommands.

Example 1 The following example alters the number of generations of a signal:

ALTSIG CYBER.SIGNAL1 GEN(10)

In the above example, CYBER.SIGNAL1 is altered to store 10 generations.

Example 2 The following example alters the number of generations of a signal:

ALTSIG DAILY_SIGNAL2 GEN(7)

In the above example, DAILY_SIGNAL2 is altered to store 7 generations. If thecurrent group is PROD, then PROD.DAILY_SIGNAL2 is altered.

Page 53: ESP 5.2 Command Reference

53

ALTTJ Command

Overview The ALTTJ command is used to change selected characteristics of a tracked job.Normally tracked jobs are defined in a Job Tracking Definition Table and thiscommand is not required.

Type General command.

Authority SCHEDULER or a matching ownership string is required to issue the ALTTJcommand.

Syntax The syntax of the ALTTJ command is:

ALTTJ jobname{[PREFIX]}{[OWNER(ownerid)]}{[TRACK|NOTRACK]}{[MODEL(modelname)]}{[INDEX(indexcount)]}

Parameter Descriptionjobname Indicates the job definition or definitions to be altered. The

jobname can contain asterisks or a hyphen, requesting that alljob definitions matching the mask be altered.

PREFIX Indicates that the entry being altered is a jobname prefix entryrather than an explicit job entry.

Note: This parameter is only applicable if you are not using ajob tracking definition table.

ownerid Indicates an ownership string for the job(s). It consists of upto eight alphanumeric characters, including asterisks or ahyphen. This is only valid in non-SAF environments.

TRACK Indicates that you want the job to be tracked.NOTRACK Indicates that you do not want the job to be tracked.modelname Indicates the name of the tracking model to be associated with

the job or jobs.indexcount Indicates the number of ancestors of a job that are to remain

on the job index data set.

Relatedinformation

For information on tracking workload, see the ESP Workload ManagerAdministrator’s Guide.

Continued on next page

Page 54: ESP 5.2 Command Reference

54

ALTTJ Command, Continued

Example 1 The following example alters the tracking model associated with a group of jobs:

ALTTJ PA- MODEL(PAYROLL)

In the above example, all jobs beginning with ‘PA’ are associated with a trackingmodel called ‘PAYROLL’.

Example 2 The following example alters characteristics associated with a specific job:

ALTTJ WEEKLYBK TRACK MODEL(MODEL2)

In the above example, ‘WEEKLYBK’ should now be tracked and be associated witha tracking model called ‘MODEL2’.

Page 55: ESP 5.2 Command Reference

55

ALTUSER Command

Overview The ALTUSER command is used to alter the definition of a user.

Type General command.

Authority SPECIAL or USERDEF authority is required to issue the ALTUSER command.

Note: ALTUSER is applicable only when using ESP Workload Manager’s internalsecurity.

Syntax The syntax of the ALTUSER command is:

{ALTUSER|ALTU} userid[GROUP(USERID)|(groupname)|(PREFIX)][PASSWORD(password)][EVENTSET(eventdsid)][HISTFILE(histfile)][DEPARTMENT(deptid)][AUTH[(OPER) |(NOOPER)]

[(SPECIAL) |(NOSPECIAL)][(ANY) |(NOANY)][(SCHED) |(NOSCHED)][(USERDEF) |(NOUSERDEF)][(GROUPDEF) |(NOGROUPDEF)][(CONNECTDEF) |(NOCONNECTDEF)][(CALENDARDEF)|(NOCALENDARDEF)]]

[AUTHTAB(tabname)][CALENDAR(cal1[,cal2]...)]

Parameter Descriptionuserid Indicates the name of the user entry to be modified.USERID Indicates the user ID is to be used as an Event name prefix.groupname Indicates the group that is to be used as the Event name

prefix.PREFIX Requests the current TSO profile data set prefix is used as

the Event name prefix.password Indicates a password of up to eight characters which is to

be associated with the user ID for accessing the ESPcommand through a batch job. This applies only if you arenot using a security product.

eventdsid Indicates the logical identifier of the Event database usedto store Events prefixed with the user ID.

histfile Indicates the history file ID or mask to which the user hasaccess.

Continued on next page

Page 56: ESP 5.2 Command Reference

56

ALTUSER Command, Continued

Syntax (continued)

Parameter Descriptiondeptid Indicates a department name of up to eight characters to

which this user belongs. It may contain asterisks and mayalso have a hyphen in the last character position.

SPECIAL Indicates the user can access the Administrator commandset of ESP.

OPER Indicates Events having the user ID as a prefix can containoperator commands.

ANY Indicates the user can define and access Events with anygroup prefix.

SCHED Allows the user to define P-Nodes, tracking models andjob tracking parameters.

USERDEF Indicates the user can define other users within the samedepartment, or department sub-group, provided they usethe same Eventset. This user can define other users withequal or lesser authority than him or herself. TheDEPARTMENT parameter must also be used with thiskeyword.

GROUPDEF Indicates the user can define other groups within the samedepartment, or department sub-group, provided they usethe same Eventset. This user can define groups with equalor less authority than his or her own group, but will not beable to use the RACID option which is only available withthe DEFGROUP command to a user with the SPECIALattribute.

CONNECTDEF Indicates the user can connect any user to any groupwithin the same department, or department sub-group.

CALENDARDEF Indicates the user can define calendars and assign their useto other users within the same department, or departmentsub-group.

NOSPECIAL Removes the SPECIAL attribute.NOOPER Removes the OPER attribute.NOANY Removes the ANY attribute.NOSCHED Removes the SCHED attribute.NOUSERDEF Removes the USERDEF attribute.NOGROUPDEF Removes the GROUPDEF attribute.NOCONNECTDEF Removes the CONNECTDEF attribute.tabname Indicates the name of the authorization table assigned to

the user.cal1 Indicates the name of the first default calendar, up to eight

characters.cal2 Indicates the name of the second default calendar, up to

eight characters.

Continued on next page

Page 57: ESP 5.2 Command Reference

57

ALTUSER Command, Continued

Usage notes To set the second default calendar without affecting the setting of the first calendar,code an asterisk as the first calendar name. To nullify a calendar, specify ‘NONE’.

Relatedinformation

For information on defining users, groups, departments, and so on, see the ESPWorkload Manager Administrator’s Guide.

Example 1 The following ALTUSER command changes a user’s attributes:

ALTUSER USER1 AUTH(SPECIAL,ANY,OPER)

In the above example, USER1’s authority attributes are changed to SPECIAL, ANYand OPER.

Example 2 The following ALTUSER command changes a user’s calendar information:

ALTUSER USER2 CALENDAR(* NONE)

In the above example, USER2’s second default calendar is removed.

Example 3 The following ALTUSER command allows a user access to history files:

ALTUSER GX991 HISTFILE(HIST-)

In the above example, GX991 is allowed to access any history file beginning with‘HIST’.

Example 4 The following ALTUSER command changes a user’s authorization table:

ALTUSER CYTR AUTHTAB(AT0001)

In the above example, an authorization table called AT0001 is assigned to CYTR.

Page 58: ESP 5.2 Command Reference

58

APPL Statement

Overview The APPL statement is used to identify the name of an Application, and to indicatecertain processing options for the Application.

Type ESP Application statement.

Syntax The syntax of the APPL statement is:

APPL applid[WAIT][HOLD][POST_WHILE_WAITING|NOPOST_WHILE_WAITING]¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯

[JOB_ANCESTOR_WAIT(LAST|ANY)][NOPOST_UNTIL_READY|POST_OLDEST|NOPOST_OLDEST]

¯¯¯¯¯¯¯¯¯¯¯¯¯[INDEX(nn)][SAF_PROF_APPL|SAF_PROF_GROUP][OWNER(CENTRAL_MANAGER|manager)]

Parameter Descriptionapplid Indicates an Application identifier up to eight

alphanumeric or national characters. The firstcharacter can not be numeric.

WAIT Indicates that concurrent processing of differentgenerations of an Application is not permitted.

HOLD Indicates that the Application is to be generated onhold.

POST_WHILE_WAITING Indicates that EXTERNAL and MANUAL jobswithin the Application are posted complete even ifthe Application is in:• APPLWAIT• SUBAPPL WAIT• JOB_ANCESTOR_WAIT.This is the default.

NOPOST_WHILE_WAITING Indicates that EXTERNAL and MANUAL jobswithin the Application are not posted complete ifthe Application is in:• APPLWAIT• SUBAPPL WAIT• JOB_ANCESTOR_WAIT.

NOPOST_OLDEST Indicates that EXTERNAL and MANUAL jobsare posted complete in all active generations of anApplication. This is the default. This overridesthe TRACKOPT setting for this Application.

Continued on next page

Page 59: ESP 5.2 Command Reference

59

APPL Statement, Continued

Syntax (continued)

Parameter DescriptionPOST_OLDEST Indicates that EXTERNAL and MANUAL jobs

are posted complete in the oldest active generationof an Application. This overrides the TRACKOPTsetting for this Application.

NOPOST_UNTIL_READY Prevent each job in this Application from beingmarked complete until the job has been readied.

JOB_ANCESTOR_WAIT(LAST) Prevent each job in this Application from beingsubmitted until a previous run of the same job hascompleted. LAST requires that the job becomplete in the previous generation.

JOB_ANCESTOR_WAIT(ANY) Prevent each job in this Application from beingsubmitted until a previous run of the same job hascompleted. ANY requires that the job be completein all previous generations.

INDEX(nn) Indicates the number of generations of theApplication to be retained on the APPLFILE. Thedefault is 20; the maximum allowed is 99.

SAF_PROF_GROUP Indicates that jobs within the Application are to beprotected by the GROUP.groupname andGROUPX.groupname resources. This is onlyapplicable if SAF is used for ESP security. This isthe default.

SAF_PROF_APPL Indicates that jobs within the Application are to beprotected by the APPL.applname.jobname andAPPLX.applname.jobname resources. This is onlyapplicable if SAF is being used for ESP security.

NOTIFY_SUBAPPL_COMPLETE Indicates that ESP should generate a consolemessage (i.e. ESP1276) when a subApplicationcompletes.

OWNER Indicates the name of the owning ESP Managerfor this Application, and for Links and Tasks inthis Application. Specify a valid Manager name asdefined in the AGENTDEF file, up to 16alphanumeric characters in length, where the firstcharacter must be alpha or a national character. Ifyou do not specify OWNER,CENTRAL_MANAGER is the default. Theowning Manager is the only one with authority toupdate the status of an Application.

Continued on next page

Page 60: ESP 5.2 Command Reference

60

APPL Statement, Continued

Usage notes Use the WAIT parameter to specify that an Application should not begin processinguntil the previous generation of the Application is complete. By default, ESP allowsconcurrent processing of different generations of the same Application. If you selectthe WAIT parameter, you can use other keywords to control posting of jobs.

Use the JOB_ANCESTOR _WAIT keyword when you want to allow concurrentprocessing of two generations of an Application but want to ensure that a previousrun of a job (i.e. in the prior, or in all previous generations) has completed prior tosubmitting the same job.

The NOPOST_UNTIL_READY option prevents a job from being consideredcomplete until it is readied (i.e. all dependencies met). This is useful where a job inan Application requires the completion of a manually submitted predecessor thatruns multiple times.

When an EXTERNAL or MANUAL job completes and multiple generations of theApplication exist, ESP must decide which generation of the Application to post thejob complete in. You can use the POST_OLDEST or NOPOST_OLDESTkeywords to control this, but the recommended method is to use EXTERNALSCHEDULED(‘criteria’) on the JOB statement.

Use the INDEX parameter to control the number of generations of the Application toretain on the APPLFILE. An incomplete Application is not deleted unless thenumber of generations exceeds 99; ESP temporarily expands the index whennecessary.

Only one APPL statement is allowed in an ESP Application.

If you are running a distributed Application and you want it to be able to completewhen the mainframe is unavailable, specify a Distributed Manager as the owner.

RelatedStatements

For information on manipulating Applications, subApplications, jobs withinApplications or jobs within subApplications, see the APPLJOB or AJ command, orthe CSF.

For information on displaying Applications or subApplications, see the LISTAPPLOR LAP command.

For information on displaying Application file information, see the LISTAPTFcommand.

For information on Applications and subApplications, see the ESP WorkloadManager User’s Guide.

For information on posting EXTERNAL or MANUAL jobs complete when multiplegenerations of an Application exist, see the JOB statement.

Example 1 The following APPL statement identifies a name for an ESP Application:

APPL PAYROLL

In the above example, PAYROLL is used to identify this ESP Application.

Continued on next page

Page 61: ESP 5.2 Command Reference

61

APPL Statement, Continued

Example 2 The following WAIT parameter on the APPL statement identifies a certainprocessing option for an ESP Application:

APPL PAYROLL WAIT

In the above example, no more than one generation of the PAYROLL Applicationcan process at the same time.

Example 3 The following INDEX parameter on the APPL statement identifies a certainprocessing option for an ESP Application:

APPL PAYROLL INDEX(50)

In the above example, the number of generations of the PAYROLL Applicationretained in the ESP Application file is 50.

Example 4 The following WAIT and NOPOST_WHILE_WAITING parameters on the APPLstatement identify certain processing options for an ESP Application:

APPL PAYROLL WAIT NOPOST_WHILE_WAITING

In the above example:

• More than one generation of the PAYROLL Application can process at the sametime

• External and manual jobs are not marked complete in any generation of thePAYROLL Application that is waiting for another generation of the sameApplication to complete.

Example 5 The following POST_OLDEST parameter on the APPL statement identifies acertain processing option for an ESP Application:

APPL PAYROLL POST_OLDEST

In the above example, external and manual jobs are marked complete only in theoldest active generation of the PAYROLL Application.

Example 6 The following example defines the central ESP Manager as the owning Manager ofthis Payroll Application Monday to Friday, and the Distributed Manager DMCHI asthe owning ESP Manager on weekends:IF TODAY(‘WEEKEND’) THENAPPL PAYROLL OWNER(DMCHI)ELSEAPPL PAYROLL

ENDDO

JCLLIB ………TEMPLIB ………

Continued on next page

Page 62: ESP 5.2 Command Reference

62

APPL Statement, Continued

Example 7 The following INDEX and JOB_ANCESTOR_WAIT(LAST) parameters on theAPPL statement identify certain processing options for an ESP Application:

APPL PAYROLL INDEX(10) JOB_ANCESTOR_WAIT(LAST)JCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

In the above example:

• 10 generations of the PAYROLL Application are retained in the ESP Applicationfile

• More than one generation of the PAYROLL Application can process at the sametime, but each job must wait until its ancestor job (i.e. in previous generation) iscomplete.

Other examples Here are more examples using the APPL statement.

Indicates that Application PAYROLL is to be generated on hold:

APPL PAYROLL HOLD

Indicates that external and manual jobs are marked complete even if the Applicationis in:

• APPLWAIT• SUBAPPL WAIT• JOB_ANCESTOR_WAIT.

APPL PAYROLL POST_WHILE_WAITING

Indicates that jobs within the PAYROLL Application are to be protected by theAPPL.applname.jobname and APPLX.applname.jobname resources, if SAF is beingused for ESP security:

APPL PAYROLL SAF_PROF_APPL

Indicates that ESP should generate a console message when each subApplicationwithin the PAYROLL Application completes:

APPL PAYROLL NOTIFY_SUBAPPL_COMPLETEJCLLIB ‘CYBER.JCL.CNTL’SUBAPPL ACCREC

Page 63: ESP 5.2 Command Reference

63

APPLJOB Command - Controlling Jobs and subAppls

Overview The APPLJOB command is used to control jobs, subApplications and Applications.The short form of this command name is AJ.

For purposes of clarity, the APPLJOB command description is split into twosections – Controlling Jobs and Applications, and Controlling Applications. If youwant to control an Application, see “APPLJOB Command - ControllingApplications”.

Type ESP Application command.

Continued on next page

Page 64: ESP 5.2 Command Reference

64

APPLJOB Command - Controlling Jobs and subAppls, Continued

Syntax The syntax of the APPLJOB command is:

{APPLJOB|AJ} jobname[ANCESTOR(number)][APPLICATION(applspec)][OLDEST]{SETREASON}[REASON(‘string’)]{BYPASS|UNBYPASS}{COMPLETE}{DROPDEP[(jobname[,jobname]...)]}{DROPRES}{HOLD|RELEASE}{INSERT [PREDECESSORS(name[,name]...)]

[SUCCESSORS(name[,name]...)][ATTRIBUTES(type)][SUBAPPL(name)][TAG(tag)][VERIFY|NOVERIFY][DATASET(dsname)][MEMBER(membername)]}

{READY}{REQUEST|UNREQUEST}{RESET [DROPEXEC(‘time’)]

[DELAYSUB(‘time’)|EARLYSUB(‘time’)][LATESUBMIT(‘time’)][LATESTART(‘time’)][LATEEND(‘time’)][ABANDONRESOURCETIME(‘time’)][ABANDONDEPENDENCYTIME(‘time’)]}

{RESUBMIT [DATASET(dsname)][MEMBER(membername)][JOBNAME(name)][RRJOBID(jobid)][USER1(userinfo)][USER2(userinfo)][USER3(userinfo)][USER4(userinfo)][ENCPARM1(userinfo)][ENCPARM2(userinfo)][ENCPARM3(userinfo)][ENCPARM4(userinfo)][ENCPARM5(userinfo)][ENCPARM6(userinfo)][ENCPARM7(userinfo)][ENCPARM8(userinfo)][ENCPARM9(userinfo)][ENCPARMA(userinfo)][ENCPARMB(userinfo)][ENCPARMC(userinfo)][FROMSTEP(stepname)][TOSTEP(stepname)][VERIFY|NOVERIFY][RESTART]}

{UNWAIT}

Continued on next page

Page 65: ESP 5.2 Command Reference

65

APPLJOB Command - Controlling Jobs and subAppls, Continued

Syntax (continued)

Parameter Descriptionjobname The jobname parameter can take any of the

following forms:• nnnn JES job number• job 1-8 alphanumeric jobname• job.qual 1-8 alphanumeric jobname followed

by 1-8 alphanumeric job qualifier• subapplid 1-8 alphanumeric subApplication

identifier.ANCESTOR Indicates the number of generations to go back.

Can be specified as + or -; both are treated thesame (e.g. -2 and 2 both mean 2 generations backfrom current). The default is 0, i.e. currentgeneration.

APPLICATION(applspec) Optional. However, it is mandatory whenREQUEST, RESUB or INSERT are specified. Ifthe job is not yet submitted, the jobname must beaugmented by the Application name. If morethan one generation of the Application is active,the relative or obsolete generation of theApplication (or the OLDEST keyword) must alsobe specified. This is in the form aaa.nnn whereaaa is the Application name and nnn is theabsolute generation number, or aaa.-rrr whererrr is the relative generation, 0 being the mostrecent.

OLDEST Indicates the action is to be performed on theoldest incomplete generation of the Application.

SETREASON Sets a User Status field to the specified string.When you specify SETREASON, you must alsospecify REASON. SETREASON can beabbreviated to SET.

REASON(‘string’) Specifies a reason for a particular action to beperformed. It can consist of up to 28 charactersenclosed in single quotes. Use a period(.) to resetthis field. The information in this field isdisplayed in the User Status and Status fields ofthe Consolidated Status Panel.

BYPASS/UNBYPASS The BYPASS keyword is used to indicate that ajob is no longer required. As soon as thedependencies are met, the job is bypassed.Successor jobs are posted as in a normal jobcompletion. If a job is BYPASSED, it can beUNBYPASSED at any time up to submission.

Continued on next page

Page 66: ESP 5.2 Command Reference

66

APPLJOB Command - Controlling Jobs and subAppls, Continued

Syntax (continued)

Parameter DescriptionCOMPLETE Simulates normal completion of a job. This immediately

posts successor jobs and EXTERNAL references. It canbe used in a situation where the job failed, but a rerun isnot necessary. The command can also be used prior to ajob beginning execution.

DROPDEP (jobname) If DROPDEP is specified without any parameters, allpredecessor relationships from a job are removed bymarking all the predecessor dependencies as satisfied.You can also drop individual dependencies byspecifying predecessor jobs.

DROPRES Removes all resource requirements for this job.HOLD Place a job on manual hold.RELEASE Release a job from manual hold.INSERT Indicates that the job specified is to be inserted into the

Application specified by the APPL parameter.PREDECESSORS(joblist) Indicates predecessor jobs that must complete

successfully prior to the job specified. It can only beused in conjunction with the INSERT keyword. Thedefault is none.

joblist specifies job names to be used for an insertrequest. A maximum of 50 job names can be specified.The job names can have a conditional relationshipassociated with them as follows:

• (jobname(cond),jobname,jobname(cond),...)

Where jobname is the name of a job and cond is aconditional relationship as follows:

• U - insert on unconditional completion• N - insert on normal completion only (default)• A - insert on abnormal completion only.

Continued on next page

Page 67: ESP 5.2 Command Reference

67

APPLJOB Command - Controlling Jobs and subAppls, Continued

Syntax (continued)

Parameter DescriptionSUCCESSORS(joblist) Indicates successor jobs that must run after the job

specified completes successfully. It can only be used inconjunction with the INSERT keyword. The default isnone.

joblist specifies job names to be used for an insert request.A maximum of 50 job names can be specified. The jobnames can have a conditional relationship associated withthem as follows:

• (jobname(cond),jobname,jobname(cond),...)

Where jobname is the name of a job and cond is aconditional relationship as follows:

• U - insert on unconditional completion• N - insert on normal completion only (default)• A - insert on abnormal completion only.

ATTRIBUTES(type) Specifies the attributes of the job. The following arevalid: JOB, TASK, LINK, CONDITIONAL, HOLD,REQUEST, MANUAL and EXTERNAL. The default isJOB. It can only be used in conjunction with the INSERTkeyword.

SUBAPPL(subappl) Inserts the job as a member of the specifiedsubApplication.

TAG(tag) Associate this tag with the inserted job.VERIFY/NOVERIFY

Verify or do not verify that a data set and member exist byopening and closing. This can be used with the INSERTand RESUB actions.

DATASET(dsname) Indicates an explicit JCL library name (may includemember name).

MEMBER(membername)

Indicates an explicit overriding JCL member name.

READY Remove all job dependencies (except resources) from ajob (including time, predecessors, manual hold).

REQUEST/UNREQUEST

Indicate whether an on-request job is required. The jobmust be identified as an on-request job by use of theREQUEST keyword on the JOB statement in ESPPROC.A job can be requested or unrequested up to the time ofsubmission. If it is not requested at the time ofsubmission, the job is bypassed. Normal end is signaled tosuccessor jobs.

Continued on next page

Page 68: ESP 5.2 Command Reference

68

APPLJOB Command - Controlling Jobs and subAppls, Continued

Syntax (continued)

Parameter Description

RESET Reset a time associated with a job. Thetimes that can be reset are:

• DROPEXEC• DELAYSUB/EARLYSUB• LATESUBMIT• LATESTART• LATEEND• ABANDONRESOUCETIME• ABANDONDEPENDENCYTIME.

DROPEXEC(‘time’) Indicates a time after which a job is not tobe submitted. This corresponds to theABANDON SUBMISSION time.

DELAYSUB | EARLYSUB(‘time’) Indicates a time before which a job is notto be submitted. This corresponds to theDELAYSUB or EARLYSUB time.

LATESUBMIT(‘time’) Indicates a time at which, if a job has notbeen submitted, it is to be consideredoverdue. This corresponds to theLATESUB time.

LATESTART(‘time’) Indicates a time at which, if a job has notstarted executing, it is to be consideredoverdue. This corresponds to theDUEOUT INPUT time.

LATEEND(‘time’) Indicates a time at which, if a job has notended execution, it is to be consideredoverdue. This corresponds to theDUEOUT EXEC time.

ABANDONRESOURCETIME(‘time’) Indicates a time at which any resources forwhich a job is waiting are to be ignored,and the job is dropped from the ResourceManager’s control and readied. Thiscorresponds to the ABANDONRESOURCES time.

ABANDONDEPENDENCYTIME(‘time’) Indicates a time at which any predecessorsfor which a job is waiting, are ignored,and the job is readied for submission. Thiscorresponds to the ABANDONDEPENDENCIES time.

RESUBMIT Identifies the job is to be resubmitted.The last data set from which the job wassubmitted is used, unless you use theDATASET keyword to specify analternate data set.

Continued on next page

Page 69: ESP 5.2 Command Reference

69

APPLJOB Command - Controlling Jobs and subAppls, Continued

Syntax (continued)

Parameter DescriptionDATASET(dsname) Indicates an explicit JCL library name form which a

job is to be resubmitted (may include member name).MEMBER(membername) Indicates an explicit JCL library member for

resubmission of the job.JOBNAME(name) Indicates the job name for rerun, if different from the

original job name.RRJOBID(jobid) Specifies the JES job number of the job being rerun.

It can only be used for jobs being restarted using ESPEncore. By default, this corresponds to the previousrun of the job.

USER1-USER4 Indicates user parameters for resubmitted jobs. Theseare passed to the USER1-USER4 ESP symbolicvariables. Initially these variables are set to a nullstring (‘’).Up to 80 characters of information can be specifiedfor each parameter.

ENCPARM1-ENCPARM9andENCPARMA-ENCPARMC

Indicates parameters of data for resubmitting a jobusing ESP Encore. Up to 60 characters ofinformation can be specified for each parameter.

FROMSTEP(stepname) Specifies the first step of the job to be rerun. Use(stepname.procstepname) for steps within aProcedure. The default is the first step. Can only beused with ESP Encore.

TOSTEP(stepname) Specifies the last step of the job to be rerun. Use(stepname.procstepname) for steps within aProcedure. The default is the last step. Can only beused with ESP Encore.

RESTART Indicates the job is to be restarted using ESP Encore.It can only be used in conjunction with the RESUBfunction.

UNWAIT Removes a job, or subApplication, from “wait” statuswhen it is waiting on a previous generation of thesame job (i.e. job ancestor wait), or subApplication(i.e. sub-appl wait).

Continued on next page

Page 70: ESP 5.2 Command Reference

70

APPLJOB Command - Controlling Jobs and subAppls, Continued

Usage notes If an EXTERNAL job is marked complete in the home Application, ESP marks thatjob complete in all other active Applications to which the job belongs.

The APPLJOB command can be issued from a system console to complete an entireApplication, or a job within an Application. This functionality requires USERMOD35.

The APPLJOB command can be used to manipulate jobs and subApplications. Thekeywords which can be used with subApplications are:

• BYPASS and UNBYPASS• REQUEST and UNREQUEST• HOLD and RELEASE• COMPLETE• READY• UNWAIT.

Relatedinformation

For information on Applications, see the ESP Workload Manager User’s Guide.

For information on manipulating entire Applications, see the APPLJOB Command -Manipulate Applications.

Example 1 The following AJ command requests a job:

AJ PAYJOB1 REQUEST APPL(PAYROLL.0)

In the above example, PAYJOB1 is requested.

Example 2 The following AJ command resubmits a job from a different library:

AJ PAYJOB2 RESUB APPL(PAYROLL.0) DATASET(‘CYBER.COPY.JCL’)

In the above example, PAYJOB2 is resubmitted from CYBER.COPY.JCL.

Example 3 The following AJ command holds a job by jobname:

AJ PAYJOB3 HOLD APPL(PAYROLL.0)

In the above example, PAYJOB3 is held.

Example 4 The following AJ command marks a job complete by job number:

AJ 154 COMPLETE APPL(PAYROLL.0)

In the above example, job number 154 is marked complete.

Continued on next page

Page 71: ESP 5.2 Command Reference

71

APPLJOB Command - Controlling Jobs and subAppls, Continued

Example 5 The following AJ command inserts a job into an Application:

AJ PAYJOB4 INSERT APPL(PAYROLL.293) PREDECESSORS(PAYJOB3) -SUCCESSORS(PAYJOB5)

In the above example, PAYJOB4 is inserted into generation 293 of the PAYROLLApplication. It runs after PAYJOB3 completes successfully, but before PAYJOB5.

Example 6 The following AJ command inserts a task into an Application:

AJ REPORT.BALANCE INSERT APPL(PAYROLL) PREDECESSORS(PAYJOB6) -ATTRIBUTES(TASK)

In the above example, a task called REPORT.BALANCE is inserted into the currentgeneration of the PAYROLL Application. It runs after PAYJOB6 completessuccessfully.

Example 7 The following AJ command requests a subApplication:

AJ REQJOBS REQUEST APPL(PAYROLL.0)

In the above example, a subApplication called REQJOBS is requested. EachREQUEST job in this subApplication is requested. This eliminates the need torequest each job individually.

Example 8 The following AJ command bypasses a subApplication:

AJ PAYJOBS BYPASS APPL(PAYROLL.0)

In the above example, a subApplication called PAYJOBS is bypassed. Thisindicates that all remaining jobs in this subApplication are no longer required.

Example 9 The following AJ command resets a job’s delayed submission time:

AJ PAYJOB7 RESET DELAYSUB(‘9PM’) APPL(PAYROLL.0)

In the above example, PAYJOB7’s delayed submission time is reset to 9 pm.

Example 10 The following AJ command holds a job with a reason:

AJ PAYJOB8 HOLD REASON(‘WAITING FOR TAPE 09999’)APPL(PAYROLL.0)

The following AJ command releases a job and resets the reason field to null:

AJ PAYJOB8 RELEASE REASON(.) APPL(PAYROLL.0)

Continued on next page

Page 72: ESP 5.2 Command Reference

72

APPLJOB Command - Controlling Jobs and subAppls, Continued

Example 11 The following AJ command inserts a job on hold:

AJ PAYJOB9 INSERT ATTRIBUTES(HOLD) APPL(PAYROLL.0)

In the above example, PAYJOB9 is inserted on hold into the current generation ofthe PAYROLL Application.

Example 12 The following AJ command resubmits a job using original JCL library. Thecharacter string ‘,RESTART=STEP20’ is passed to the JCL as the USER1 variable.

AJ PAYJOB10 RESUB USER1(‘,RESTART=STEP20’) APPL(CYBER1)

The following is a sample jobcard and the corresponding jobcard used forresubmission:

PAYJOB10 JOB...MSGCLASS=X%USER1resolves to:

PAYJOB10 JOB...MSGCLASS=X,RESTART=STEP20

Example 13 PAYJOB11 is resubmitted using the USER2 symbolic variable. It is used to pass arun type parameter to a restart program. For the first run of the job, the run typeparameter is P; on the resubmit of the job, the run type parameter is R.

In JCL://STEP1 EXEC UCC11RMS,RUNTYPE=’%USER2’

In ESP Procedure or Symbol Library:IF USER2=’’ THEN USER2=’P’

On Resubmit:AJ PAYJOB11 RESUB USER2(‘R’) APPL(PAYROLL)

Example 14 The following AJ command inserts a job with two predecessors into an Application:

AJ PAYJOB12 INSERT PREDECESSORS(PAYJOB10,PAYJOB11)APPL(PAYROLL.0)

In the above example, PAYJOB12 is inserted into the current generation of thePAYROLL Application. It runs after PAYJOB10 and PAYJOB11 completesuccessfully.

Example 15 The following AJ command inserts a job into an Application with one predecessor:

AJ PAYJOB13 INSERT APPL(PAYROLL.0) PREDECESSORS(PAYJOB11(U))

In the above example, PAYJOB13 is inserted into the current generation of thePAYROLL Application. It runs after PAYJOB11 completes, whether or not it issuccessful.

Continued on next page

Page 73: ESP 5.2 Command Reference

73

APPLJOB Command - Controlling Jobs and subAppls, Continued

Example 16 The following AJ command inserts a link into an Application:

AJ LINKIT INSERT APPL(PAYROLL.0) PREDECESSOR(PAYJOB14) -SUCCESSOR(PAYJOB15) ATTRIBUTE(LINK)

In the above example, a link called LINKIT is inserted into the current generation ofthe PAYROLL Application. It runs after PAYJOB14 completes successfully, butbefore PAYJOB15.

Example 17 The following AJ command is issued from a system console to complete a job:

F ESPM,AJ PAYJOB16 COMPLETE APPL(PAYROLL.0)

In the above example, PAYJOB16 is completed.

Example 18 The following AJ command set the User Status Field:

AJ PAYJOB17 SETREASON REASON(‘WAITING FOR TAPE’)APPL(PAYROLL.0)

In the above example, the User Status Field for PAYJOB17 indicates that the job iswaiting for a tape.

Example 19 The following AJ command resubmits a job:

AJ PAYJOB18 RESUB RESTART APPL(PAYROLL.0)

In the above example, PAYJOB18 is resubmitted and ESP Encore is used.

Example 20 The following series of AJ commands insert a job with a time dependency:

AJ PAYJOB19 INSERT ATTRIBUTE(HOLD) APPL(PAYROLL.0)AJ PAYJOB19 RESET DELAYSUB(‘9PM’) APPL(PAYROLL.0)AJ PAYJOB19 RELEASE APPL(PAYROLL.0)

In the above example, PAYJOB19 is inserted on hold into the current generation ofthe PAYROLL Application. PAYJOB19’s submission time is set to 9 pm and thenreleased from hold.

Page 74: ESP 5.2 Command Reference

74

APPLJOB Command - Controlling Applications

Overview The APPLJOB command is used to control jobs, subApplications and Applications.The short form of this command name is AJ.

For purposes of clarity, the APPLJOB command description is split into twosections – Controlling Jobs and Applications, and Controlling Applications. If youwant to control jobs or subApplications, see “APPLJOB Command - ControllingJobs and subAppls”.

Type ESP Application command.

Syntax The syntax of the APPLJOB

{APPLJOB|AJ} ALL APPL(applspec) [COMPLETE][HOLD][RELEASE][UNWAIT][OLDEST]

Parameter Descriptionapplspec Indicates the Application name. If more than one generation

of the Application is active, the relative or absolutegeneration of the Application (or the OLDEST keyword)must also be specified. This is in the form aaa.nnn whereaaa is the Application name and nnn is the absolutegeneration number, or aaa.-rrr where rrr is the relativegeneration, 0 being the most recent.

COMPLETE Completes an Application.HOLD Holds an Application. This stops submission of jobs in the

Application and places the Application in ‘APPLHOLD’status.

RELEASE Releases an Application, i.e. remove from ‘APPLHOLD’status.

UNWAIT Removes an Application from ‘APPLWAIT’ status.OLDEST Indicates the action is performed on the oldest active

generation of the Application.

Usage notes When you complete an Application, the next generation of the Application canprocess.

Relatedinformation

For information on Applications, see the ESP Workload Manager User’s Guide.

For information on manipulating jobs belonging to Applications, see the APPLJOBCommand - Manipulate Application Jobs.

Continued on next page

Page 75: ESP 5.2 Command Reference

75

APPLJOB Command - Controlling Applications, Continued

Example 1 Marking the current generation of an Application complete:

AJ ALL APPL(PAYROLL.0) COMPLETE

In the above example, the current generation of the PAYROLL Application iscompleted.

Example 2 Marking the -1 generation of an Application complete:

AJ ALL APPL(PAYROLL.-1) COMPLETE

In the above example, the -1 generation of the PAYROLL Application is completed.

Example 3 The following AJ command is issued from a system console to complete anApplication:

F ESP,AJ ALL COMPLETE APPL(PAYROLL.0)

In the above example, the current generation of the PAYROLL Application iscompleted.

Example 4 The following AJ command removes an Application from ‘APPLWAIT’ status:

AJ ALL UNWAIT APPL(PAYROLL.293)

In the above example, the generation 293 of the PAYROLL Application is removedfrom ‘APPLWAIT’ status.

Example 5 The following AJ command releases an Application:

AJ ALL RELEASE APPL(PAYROLL.0)

In the above example, the current generation of PAYROLL is released. Thisremoves it from ‘APPLHOLD’ status.

Page 76: ESP 5.2 Command Reference

76

BACKOUT

Overview Use the BACKOUT command if you experience serious difficulties that require youto revert to a previous release of ESP.

Type General command.

Authority OPER authority is required to issue the BACKOUT command.

Syntax The syntax of the BACKOUT command is:

BACKOUT {V510}{V451}{V442}{V441}{V440}

Usage notes The BACKOUT command converts any Events in initiator classes other than 0 toclass 0 so they can be used with previous releases of ESP.

When you issue the BACKOUT command, you see a message indicating backout isbeginning. When completed, a message is written to the audit log identifying thenumber of TDRs moved to Event initiator class 0.

For more information on Event initiator classes, see the ESP Workload ManagerInstallation Guide.

Example To back out the current release, and bring up release 4.5.1 of ESP:

BACKOUT V451

Page 77: ESP 5.2 Command Reference

77

BKUPEVS Command

Overview The BKUPEVS command is used to initiate the immediate backup of an Event dataset.

Type General command.

Authority OPER authority is required to issue the BKUPEVS command.

Syntax The syntax of the BKUPEVS command is:

BKUPEVS eventdsid

Parameter Descriptioneventdsid Indicates the identifier of the Event data set using up to eight

characters.

Usage notes The BKUPEVS command schedules an immediate backup of an Event data set. Thedata set is backed up to a non-VSAM data set whose name must be defined by theBKUPDSNAME parameter on an EVENTSET command or Initialization Parameter.

Relatedinformation

For information on defining or altering an Event Data set, see the EVENTSETparameter in the ESP Workload Manager Installation Guide.

Example The following BKUPEVS command initiates an Event Data set backup:

BKUPEVS EVENT1

In the above example, EVENT1 is immediately backed up.

Page 78: ESP 5.2 Command Reference

78

BKUPHIST Command

Overview The BKUPHIST command is used to initiate the immediate backup of a history dataset.

Type General command.

Authority OPER authority is required to issue the BKUPHIST command.

Syntax The syntax of the BKUPHIST command is:

BKUPHIST histfid

Parameter Descriptionhistfid Indicates the identifier of the history recording database using

up eight characters.

Usage notes The BKUPHIST command schedules an immediate backup of a history file(HISTFILE). The data set is backed up to a non-VSAM data set whose name mustbe defined by the BKUPDSNAME parameter on a HISTFILE command orInitialization Parameter.

Relatedinformation

For information on defining or altering a History data set, see the HISTFILEparameter in the ESP Workload Manager Installation Guide.

Example 1 The following BKUPHIST command initiates an History data set backup:

BKUPHIST HIST1

In the above example, HIST1 is backed up immediately.

Page 79: ESP 5.2 Command Reference

79

BKUPINDX Command

Overview The BKUPINDX command is used to initiate the immediate backup of the Indexdata set, set the backup schedule, or display the next scheduled backup time.

Type General command.

Authority OPER authority is required to issue the BKUPINDX command.

Syntax The syntax of the BKUPINDX command is:

BKUPINDX [?|schedule]

Parameter Description? Requests the time of the next scheduled backup be displayed.schedule Indicates the regular backup schedule.

Usage notes The BKUPINDX command sets the time schedule for the regular Index data setbackup. The backup is made to the data set specified on the INDEX InitializationParameter identified by the BACKUPDATSET parameter. If a schedule time isomitted, an immediate backup takes place.

The BKUPINDX command has to be issued only once because the schedule ischeckpointed. It can be reissued at any time if schedule changes are needed.

Information is lost on cold start of ESP.

Relatedinformation

For information on Index file structure and recovery, see the ESP WorkloadManager Diagnostics and Recovery Guide.

For information on defining the Index data set, see the ESP Workload ManagerInstallation Guide.

Example 1 The following BKUPINDX command initiates an Index data set backup:

BKUPINDX

In the above example, the Index data set is immediately backed up.

Continued on next page

Page 80: ESP 5.2 Command Reference

80

BKUPINDX Command, Continued

Example 2 The following BKUPINDX command displays the scheduled backup time:

BKUPINDX ?

In the above example, the next scheduled backup time of the Index data set isdisplayed.

Example 3 The following BKUPINDX command schedules an Index data set backup:

BKUPINDX DAILY AT 6AM

In the above example, the Index data set is scheduled for backup at 6am every day.

Page 81: ESP 5.2 Command Reference

81

BKUPJNDX Command

Overview The BKUPJNDX command is used to initiate the immediate backup of the job indexdatabase, set the backup schedule, or display the time of the next scheduled backuptime.

Type General command.

Authority OPER authority is required to issue the BKUPJNDX command.

Syntax The syntax of the BKUPJNDX command is:

BKUPJNDX [?|schedule]

Parameter Description? Requests that the time of the next scheduled backup be

displayed.schedule Indicates the regular backup schedule.

Usage notes The BKUPJNDX command sets the time schedule for the Job Index data set backup.The backup is made to the data set identified by the BACKUPDATASET parameteron the JOBINDEX Initialization Parameter. If a schedule time is omitted, animmediate backup will take place.

The BKUPJNDX command has to be issued only once because the schedule ischeckpointed. It can be reissued at any time if schedule changes are needed.

BKUPJNDX commands can be stored in ESP’s cold start Initialization Parameters.

Information is lost on cold start of ESP.

Relatedinformation

For information on defining the Job Index data set, see the ESP Workload ManagerInstallation Guide.

Example 1 The following BKUPJNDX command initiates a Job Index data set backup:

BKUPJNDX

In the above example, the Job Index data set is backed up immediately.

Continued on next page

Page 82: ESP 5.2 Command Reference

82

BKUPJNDX Command, Continued

Example 2 The following BKUPJNDX command displays the scheduled backup time:

BKUPJNDX ?

In the above example, the next scheduled backup time of the Job Index data set isdisplayed.

Example 3 The following BKUPJNDX command schedules a Job Index data set backup:

BKUPJNDX DAILY AT 6AM

In the above example, the Job Index data set is scheduled for backup at 6 am everyday.

Page 83: ESP 5.2 Command Reference

83

BKUPUDEF Command

Overview The BKUPUDEF command is used to initiate the immediate backup of the UserDefinition data set or set a backup schedule.

Type General command.

Authority OPER authority is required to issue the BKUPUDEF command

Syntax The syntax of the BKUPUDEF command is:

BKUPUDEF [schedule]

Parameter Description? Requests that the time of the next scheduled backup be

displayed.schedule Indicates the regular backup schedule

Usage notes The BKUPUDEF command sets the time schedule for the regular User Definitiondata set backup. The backup is made to the data set identified by theBACKUPDATSET parameter on the USERDEF Initialization Parameter. If aschedule time is omitted, an immediate backup takes place.

The BKUPUDEF command has to be issued only once because the schedule ischeckpointed. It can be reissued at any time if schedule changes are needed. If thesystem is down when a backup is to take place, the backup commences as soon asESP is restarted.

BKUPUDEF commands can be stored in ESP’s cold start Initialization Parameters.

Information is lost on cold start of ESP.

Example 1 The following BKUPUDEF command initiates a User Definition data set backup:

BKUPUDEF

In the above example, the User Definition data set is backed up immediately.

Continued on next page

Page 84: ESP 5.2 Command Reference

84

BKUPUDEF Command, Continued

Example 2 The following BKUPUDEF command displays the scheduled backup time:

BKUPUDEF ?

In the above example, the next scheduled backup time of the User Definition data setis displayed.

Example 3 The following BKUPDEF command schedules a User Definition data set backup:

BKUPUDEF DAILY AT 6AM

In the above example, the User Definition data set is scheduled for backup at 6 amevery day.

Page 85: ESP 5.2 Command Reference

85

BREAK Command

Overview The BREAK command is used to request section breaks at specified parts of ahistory report to produce blank lines, a new page or subtotals. A break makes thehistory report easier to read and analyze.

Type Reporting command.

Syntax The syntax of the BREAK command is:

BREAK fieldlength[SPACE n][EJECT][SUBTOTAL]

Parameter Descriptionfield Indicates the name of a field where you want the break to

occur. This field must have been specified in a previousDISPLAY section.

length Indicates the number of characters of the display field to bechecked. When a mismatch occurs within this number ofcharacters, a break occurs.

SPACE n Indicates n blank lines are to be printed when a section breakoccurs.

EJECT Requests a new page be forced when a break occurs.SUBTOTAL Requests a subtotal be printed.

Usage notes Use the BREAK subcommand to define at which points in the report you want to:

• Force a new page• Print any number of blank lines• Produce a subtotal.

You can specify several break elements in a break section.

ESP subtotals only meaningful fields such as CPUTIME and DEXCP, but notJOBNO.

Relatedinformation

For information on history reporting, see the ESP Workload Manager User’s Guide.

Continued on next page

Page 86: ESP 5.2 Command Reference

86

BREAK Command, Continued

Example 1 The following BREAK command is used to produce a subtotal, start a new page andprint a blank line:

REPORTFROM 8AM YESTERDAYCRITERIA APPLSYS EQ PAYROLLDISPLAY JOBNAME JOBNO ACCOUNT CPUTIMESORT ACCOUNT JOBNAMEBREAK ACCOUNT 3 EJECT SUBTOTALBREAK JOBNAME 2 SPACE 1ENDR

In the above example:

• When the first three characters of the account name change, a subtotal is printedand a new page started

• When the first two characters of the jobname change, one blank line is left.

Page 87: ESP 5.2 Command Reference

87

CALENDAR Command

Overview The CALENDAR command is used to indicate one or two calendars to be used forprocessing, in addition to the SYSTEM calendar. It is normally used as an Eventdefinition command.

Type General command.

Syntax The syntax of the CALENDAR command is:

CALENDAR calendar1[,calendar2]

Parameter Descriptioncalendar1 Indicates the name of a calendar. Cal1 is searched first for

any special day, period and holiday definitions.calendar2 Indicates the name of a calendar. Cal2 is searched second for

any special day, period and holiday definitions.

Usage notes You can use the CALENDAR command to specify up to two additional calendarsfor an Event, so that you can schedule Events and jobs in terms that might be uniqueto your calendar.

If you do not specify a calendar, ESP uses the calendar(s) assigned by default to thegroup or user that owns the Event.

ESP merges holiday definitions in all calendars associated with an Event. Whenspecial days or periods use the same name in different calendars, ESP uses the firstdefinition it finds. ESP searches in this order:

1. The first calendar you define for the Event, or first default calendar.

2. The second calendar you define for the Event, or second default calendar.

3. The SYSTEM calendar.

You can also use the CALENDAR command in a batch job and in Page mode tospecify a calendar. You can specify one calendar only.

Relatedinformation

For information on setting special calendars, see the ESP Workload Manager User’sGuide.

For information on using calendars and using calendar terms, see the ESP WorkloadManager User’s Guide.

For information on defining and deleting calendars, see the DEFCAL and DELCALcommands.

Continued on next page

Page 88: ESP 5.2 Command Reference

88

CALENDAR Command, Continued

Example 1 The following CALENDAR command requests that a calendar be used for an Event:

EVENT ID(CYBER.FISCAL_JOBS)CALENDAR FISCALSCHEDULE FIRST DAY OF FISCAL_MONTHINVOKE ‘CYBER.PROCLIB.CNTL(FISCJOBS)’ENDDEF

In the above example, CYBER.FISCAL_JOBS looks at the FISCAL calendar first todetermine what ‘FISCAL_MONTH means, so ESP knows when to schedule theEvent. If ESP does not find FISCAL_MONTH on the FISCAL calendar, ESP thenlooks at the SYSTEM calendar to see if FISCAL_MONTH is defined there.

Note: If FISCAL_MONTH is not defined on either calendar, you receive Eventdefinition errors, i.e. ESP does not permit you to save an Event that contains invalidschedule criteria.

Example 2 The following CALENDAR command indicates the name of a calendar to besearched for holidays:

CALENDAR FISCALLISTHOL -

In the above example, the FISCAL calendar and the SYSTEM calendar are searchedfor holidays.

Page 89: ESP 5.2 Command Reference

89

CCCHK Statement

Overview The CCCHK facility is designed to detect errors in condition codes. It offers thecapability to immediately stop a failing job, without running any subsequent stepsregardless of the COND parameters.

Unless either the FAIL or STOP condition is seen on a matching CCCHK statement,ESP Workload Manager will not interrupt the flow of the job.

Type ESP Application statement.

Syntax The syntax of the CCCHK statement is:

CCCHK [JOB(jobmask)][STEP(stepname)][PROC(procstep][PROGRAM(progname)][RC(num)|RC(num1:num2)|RC(Sccc)|RC(Unnnn)][OK|FAIL][CONTINUE|STOP]

Parameter Description JOB(jobmask) Indicates a string that matches a job name. It may

contain the wildcard characters “-” and “*” which standfor any string and any character respectively. Thisparameter is optional. If this parameter is missing, thisstatement matches with any jobname.

STEP(stepname) Indicates a step within the job. It refers to the label fieldon the EXEC statement in the user’s JCL. Thisparameter is optional. If this parameter is missing, thenthis statement matches with any stepname.

PROC(procstep) Indicates a particular step within a catalogued orinstream procedure. Specifically, it refers to the label onthe EXEC statement inside a cataloged procedure or aninstream procedure. (It does not refer to the name of theprocedure.) This statement must be used in conjunctionwith the ‘STEP’ parameter.

PROGRAM(progname) Indicates the name of the program being executed by thestep, as found in the PGM parameter on the EXECstatement of the job. This parameter is optional.

RC(num) Indicates a condition code of num, where num is aninteger between 0 and 4095 inclusive. This valuerepresents a condition code, not a user abend code. TheRC parameter is required, either in this format or one ofthe formats that follow.

RC(num1:num2) Indicates a condition code between num1 and num2inclusive. The value of num2 must not be smaller thannum1. These values represent condition codes only, notuser abend codes.

Continued on next page

Page 90: ESP 5.2 Command Reference

90

CCCHK Statement, Continued

Syntax (continued)

Parameter DescriptionRC(Sccc) Indicates a system abend code, such as S0C1 or SB37.

The ccc must be three hexadecimal digits.RC(Unnnn) Indicates a user abend code, such as “U0001” or

“U0462”. The nnnn must be exactly four decimal digits,and cannot exceed 4095.

OK Indicates that the job has not failed. OK is the default.FAIL Indicates that the job should be considered failed. When

the job has failed, it may or may not continue, dependingupon the value of CONTINUE/STOP.

CONTINUE Indicates that the job should continue processing withthe next step, whether or not the job was deemed to havefailed. This is the default.

STOP Indicates that the job should be stopped immediately.No other steps should be executed. Only one ofCONTINUE or STOP may be specified.

CCCHK andCCFAIL

ESP can control condition code checking of jobs using either the CCCHK orCCFAIL statement. CCCHK was developed to replace CCFAIL and is not intendedfor use in combination with CCFAIL. If the two statements are used together, bothsets of checks are performed, and if either one indicates a failure, then the job willbe considered a failure for reason CCFAIL. CCFAIL step (named ESPCCFCK) willnot be inserted into any job which uses CCCHK.

CCCHKstatements

There is a limit of 281 CCCHK statements from all sources for a single job.

Usage notes If a step abends, and a matching CCCHK statement specifies CONTINUE, the jobproceeds as usual. That is, the subsequent steps are given an opportunity to execute,but they are bypassed as usual unless their COND parameter specifies EVEN orONLY. However when STOP is specified on the CCCHK statement the job isflushed immediately, and not even the COND=EVEN or COND=ONLY stepsexecute.

Several CCCHK statements may be active for a single job, allowing for anaccumulation of effect that is not achievable with CCFAIL. For example, oneCCCHK statement might indicate a particular action, and other statements mightindicate some exceptional cases.

Continued on next page

Page 91: ESP 5.2 Command Reference

91

CCCHK Statement, Continued

Usage notescontinued

CCCHK statements may be associated with specific stepnames or specific programs.For example, a CCCHK statement can indicate an action to be taken only whenIEBGENER abends a certain way.

The CCCHK statement may appear in the ESP Initialization Parameters and in anESP Procedure. Within an ESP Procedure, they may appear within or outside thescope of a job.

When a job is executing, all pertinent CCCHK statements are searched sequentiallywhenever any jobstep ends. The statements that are pertinent to a job include thosein the ESP Initialization Parameters, those in the ESP Procedure outside of the scopeof a job, and those that are within the scope of a job being executed. The statementsare searched in the following order:

1. Those in an ESP Procedure within the scope of a job2. Those in an ESP Procedure but not within the scope of a job3. Those in ESP Workload Manager Initialization Parameters.

At the end of each step, these CCCHK statements are searched until a statement isfound that matches the JOB, STEP, PROGRAM, and RC parameters of the step thatjust ended. Searching then stops and the first matching CCCHK statement is used todetermine the disposition of the job.

If FAIL was specified on the first matching CCCHK statement, then the job isconsidered failed.

If OK was specified for a particular step, then the job is not considered failed, unlessthe matching CCCHK statement from another step indicates FAIL.

Note: If the matching CCCHK statement from any step indicates FAIL, the job isconsidered failed.

If CONTINUE was specified on the first matching CCCHK statement, the jobproceeds with the next step. That step may be bypassed if it contains certain CONDparameters on its EXEC statement.

If STOP was specified, the job stops immediately, with no other steps beingexecuted.

RelatedStatements

For information on using ESP to insert trailer steps into JCL to check conditioncodes, see the ESP Workload Manager Advanced User’s Guide.

Continued on next page

Page 92: ESP 5.2 Command Reference

92

CCCHK Statement, Continued

Statementusage

The CCCHK statement can be used for all jobs within an Application or specificjobs within an Application.

Example 1 The following globally placed CCCHK statement indicates how ESP should handlejobs when completion codes are matched:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’CCCHK RC(1:4095) FAILJOB PAYJOB1

In the above example, any job in the PAYROLL Application is considered to havefailed if any step within any job produces a condition code greater than 0.

Example 2 The following local and global CCCHK statements indicate how ESP should handlejobs when completion codes are matched:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’CCCHK RC(1:4095) FAIL STOPJOB PAYJOB2CCCHK RC(8) OK CONTINUE

In the above example, any job in the PAYROLL Application is considered to havefailed and stops processing immediately if a condition code of greater than 0 isproduced. A condition code of 8 for PAYJOB2 is considered to be acceptable andprocessing continues for PAYJOB2.

Example 3 The following local and global CCCHK statements indicate how ESP should handlejobs when completion codes are matched:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’CCCHK RC(1:4095) FAIL STOPJOB PAYJOB3CCCHK PROGRAM(IEBGENER) RC(12) OK CONTINUE

In the above example, any job in the PAYROLL Application is considered to havefailed and stops processing immediately if a condition code of greater than 0 isproduced. A condition code of 12 produced by program IEBGENER for jobPAYJOB3 is acceptable, the job is not flagged as failed, and processing continuesfor this job.

Continued on next page

Page 93: ESP 5.2 Command Reference

93

CCCHK Statement, Continued

Example 4 The following local and global CCCHK statements indicate how ESP should handlejobs when completion codes are matched:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’CCCHK RC(1:4095) FAIL STOPJOB PAYJOB4CCCHK STEP(STEP001) RC(SB37) FAIL STOP

JOB PAYJOB5CCCHK STEP(STEP001) PROC(STEP020) RC(1:12) OK CONTINUECCCHK STEP(STEP004) RC(8) FAIL STOP

In the above example, any job in the PAYROLL Application is considered to havefailed and stops processing immediately if a condition code of greater than 0 isproduced.

If step STEP01 receives a system B37 abend for job PAYJOB4 the job is flagged asfailed and processing stops immediately. Note that any subsequent step withCOND=EVEN or COND=ONLY is not executed.

A condition code between 1 and 12 for job PAYJOB5 produced by step STEP01procstep STEP020 is acceptable and the job is not flagged as failed. But if stepSTEP04 produces a condition code of 8, then PAYJOB5 should be flagged as failedand processing stops immediately.

Ignore anabend

CCCHK does provide the ability to ignore an abend. With the new capability, ahistory will be maintained by CCCHK of each job step which had a completion code(not a condition code), and whether or not there was a matching CCCHK statementwith OK. At the end of the job, if there are no other failure conditions of any kind,and each and every completion code, system or user, was marked OK, and none ofthem were of the CANCEL type (system completion code in the form X22), then theapplication manager will be signalled to treat the job as successful. Successors willthen be released.

This processing is only done at the end of the job, and has no effect on the normalhandling by MVS and JES of a job which had a step abend. Monitors at the job steplevel will see an abend, just as they always have. COND parameters of EVEN and/orONLY will be required to cause steps after the abended step to be executed.Displays of the job by LJ, LTJ, or LAP will still show the abend, as will historyreporting. Alert processing will consider the job a success, not a failure.

Page 94: ESP 5.2 Command Reference

94

CCFAIL Statement

Overview The CCFAIL statement is used to identify which condition codes should cause ESPto consider a job as failed and prevent successor jobs from being submitted. TheCCFAIL statement can be used for all jobs within an Application or for specific jobswithin an Application.

Type ESP Application statement.

Syntax The syntax of the CCFAIL statement is:

CCFAIL (stepname,operator,value)

Parameter Descriptionstepname Indicates a stepname. You must use the exact job or PROC

stepname. For procs, use stepname.procstepname. An asterisk (*)represents any step.• stepname indicates the name of a step within the job. It refers to

the label field on the EXEC statement in the JCL.• procstepname indicates a particular step within a catalogued or

instream procedure. Specifically, it refers to the label on theEXEC statement inside a cataloged procedure or an instreamprocedure. This parameter is optional. If this parameter ismissing, this statement matches with any procstepname.

operator Specify valid comparison operators as follows:• >= or GE• <= or LE• > or GT• < or LT• = or EQ• ¬= or NE

value Specifies the value of the condition code for which you want tocheck.

Usage notes You can use the CCFAIL statement as a global option for all jobs in an Applicationor within the scope of a job statement for an individual job. A job specific CCFAILstatement overrides the global CCFAIL statement.

Multiple condition codes can be specified by separating each (stepname, operatorand value) with a blank. If the specified condition codes are met, the job is flaggedand a message is sent to the operator’s console and to the user ID listed in the JESNOTIFY parameter, after the job has completed. ESP treats the job as anunsuccessful completion, and holds dependent jobs.

Continued on next page

Page 95: ESP 5.2 Command Reference

95

CCFAIL Statement, Continued

Usage notescontinued

When ESP submits a job, it adds a trailer step to the job that executes only if thecondition codes specified for failure are not met. Otherwise, the trailer step does notexecute and the job fails with a ‘JOB FAILED – JCL ERROR’ condition. Steps aftera bad condition code execute unless you have COND parameters in the JCL tobypass them.

Note: The CCFAIL statement is limited by what you can do with the CONDparameter in JCL.

RelatedStatements

For information on checking condition codes, see the CCCHK statement.

Note: ESP can control condition code checking of jobs by using either the CCFAILor CCCHK statement. CCCHK was developed to replace CCFAIL and is notintended for use in combination with CCFAIL. If the two statements are usedtogether, both sets of checks are performed, and if either one indicates a failure, thenthe job will be considered a failure for reason CCFAIL. CCFAIL step (namedESPCCFCK) will not be inserted into any job which uses CCCHK.

For information on using ESP to insert trailer steps into JCL to check conditioncodes, see the ESP Workload Manager Advanced User’s Guide.

Example 1 The following globally placed CCFAIL statement identifies when ESP shouldconsider a job as failed:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’CCFAIL (*,GT,4)JOB PAYJOB1

In the above example, any job in the PAYROLL Application is considered to havefailed if any step within any job produces a condition code greater than 4.

Example 2 The following locally placed CCFAIL statement identifies when ESP shouldconsider a job as failed:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1CCFAIL (STEP004,GT,8)

In the above example, PAYJOB1 is considered to have failed if STEP004 produces acondition code greater than 8.

Continued on next page

Page 96: ESP 5.2 Command Reference

96

CCFAIL Statement, Continued

Example 3 The following locally placed CCFAIL statement identifies conditions when ESPshould consider a job to have failed:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB3CCFAIL (STEPJ.STEPP,GT,0)

In the above example, PAYJOB3 is considered to have failed if procstep STEPPwithin job step STEPJ produces a condition code greater than 0.

Example 4 The following local and globally placed CCFAIL statements identify when ESPshould consider a job as failed:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’CCFAIL (*,GT,8)JOB PAYJOB4CCFAIL (STEP002,GT,4)

In the above example, any job in the PAYROLL Application except PAYJOB4 isconsidered to have failed if any step produces a condition code greater than 8.PAYJOB4 is considered to have failed if STEP002 produces a condition codegreater than 4.

Note: Any condition code for the other steps in PAYJOB4 is accepted as good,because a job-specific CCFAIL statement overrides a globally-placed CCFAILstatement.

Example 5 The following local and globally placed CCFAIL statements identify conditionswhen ESP should consider a job as failed:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’CCFAIL (*,GT,8)JOB PAYJOB5CCFAIL (STEP001,GT,8) (STEP002,GT,4) (STEP003,GT,8)

In the above example, any job in the PAYROLL Application except PAYJOB5 isconsidered to have failed if any step produces a condition code greater than 8.PAYJOB5 is considered failed if any of the following occur:

• STEP001 produces a condition code greater than 8• STEP002 produces a condition code greater than 4• STEP003 produces a condition code greater than 8.

Note: If you don’t want the locally placed CCFAIL statement to override theglobally placed CCFAIL statement, specify each step and the appropriate CCFAILstatement for that step, as coded above.

Page 97: ESP 5.2 Command Reference

97

CELLTRC Command

Overview The CELLTRC command is used to trace storage cell usage. This can be usefulwhen diagnosing problems involving uncontrolled storage allocation.

Type General command.

Authority OPER authority is required to issue the CELLTRC command.

Syntax The syntax of the CELLTRC command is:

CELLTRC

Usage notes A snapshot data set must first be created. This data set will contain the storage cellsnapshots that are generated by the CELLTRC command. The following DCBattributes should be used:

DSORG=PS,RECFM=VB,LRECL=137,BLKSIZE=6144

The following DD statement must be added to the ESP subsystem catalogedprocedure:

//CELLTRC DD DISP=SHR,DSN=celltrc.dataset

Start the subsystem with the following command. Note that the ‘@CELLTRC’keyword must be the first parameter in the PARM string. Once activated, celltracing remains active only during the current execution of ESP. To keep celltracing active, the ‘@CELLTRC’ keyword must be used each time ESP is started:

S ESP,PARM=‘@CELLTRC,...’

The CELLTRC command causes the subsystem to generate a storage cell snapshotand place it in the cell trace data set that is named in the CELLTRC DD statement.It may be issued from an MVS console or from Page mode.

To deactivate cell tracing, restart the subsystem without using the ‘@CELLTRC’keyword.

Continued on next page

Page 98: ESP 5.2 Command Reference

98

CELLTRC Command, Continued

Usage notescontinued

The storage cell snapshot consists of three sections: the cell pool header display, thecell display, and the cell summary.

The cell pool header display shows the available cell size and how many of each sizeare currently allocated. The COUNT field indicates how many cells of a particularsize are allocated, while the ACTIVITY field shows the number of gets and freesdone for this cell size:

SIZE 8, COUNT 0, ACTIVITY 0SIZE 16, COUNT 17, ACTIVITY 42SIZE 32, COUNT 59, ACTIVITY 104SIZE 64, COUNT 31, ACTIVITY 85SIZE 128, COUNT 32, ACTIVITY 427

The cell display describes each individual cell that is presently allocated. Its sizeand requestor CSECT are shown, along with up to 64 bytes of its contents. Alsoshown is the CSECT that called the requestor CSECT. The offset within eachCSECT from which the request was made is also shown:

CELL SIZE 128, REQUESTED BY CYBXI000+0054, CALLED BYCYBXR003+0CA6

+0 00039F80 00000000 000076F3 00873C54 00000000 ...+20 00039FA0 00000000 00000000 003D2448 003D2450 ...

CELL SIZE 32, REQUESTED BY CYBXI003+0CF4, CALLED BYCYBJS107+0DB8

+0 003D2448 00000000 008876F3 00000000 00000000 ...

...

Usage notescontinued

The cell summary lists the number of cells that are currently allocated, but arrangedby requestor’s base address and requesting address, and by the requestor’s caller’sbase address and calling address. The following example shows that 3 cells of size32 are currently allocated, having been requested by CYBXI003 at offset 0CF4 whowas called by CYBJS107 at offset 0DB8. The base address of the CYBXI003CSECT is at 02357708, and the request was made from address 023583FC:

---- STORAGE ALLOCATED BY REQUESTOR’S ADDRESSADDR 0234574C, BASE 023456F8, COUNT 1, BYTES 128 -CYBXI000+0054ADDR 023583FC, BASE 02357708, COUNT 3, BYTES 32 -CYBXI003+0CF4

---- STORAGE ALLOCATED BY REQUESTOR’S CALLER’S ADDRESSADDR 02365E38, BASE 02365080, COUNT 3, BYTES 32 -CYBJS107+0DB8ADDR 02358C36, BASE 02357F90, COUNT 1, BYTES 128 -CYBXR003+0CA6

Continued on next page

Page 99: ESP 5.2 Command Reference

99

CELLTRC Command, Continued

Example The following CELLTRC command is used to trace storage cell usage:

CELLTRC

In the above example, storage cell usage is generated and placed in the cell tracedata set named in the CELLTRC DD statement.

Page 100: ESP 5.2 Command Reference

100

CHECKEXC Statement

Overview The CHECKEXC statement is used to indicate that ESP should check the last non-blank character of every card image written to the internal reader. If the symbolicvariable is representing that last non-blank character is set to a ‘¬’ (‘not’ sign), thecard image is deleted. If the symbol variable is set to blank, null, or to any otherstring, the card image is not deleted. The CHECKEXC statement cannot be used inan ESP Procedure.

Type Symbolic variable library statement.

Syntax The syntax of the CHECKEXC statement is:

CHECKEXC

Usage notes Enter the CHECKEXC statement anywhere in a symbolic library data set. Multipleexclusion symbols can be used.

Define the symbolic variable that is to represent the last non-blank character, eitherin a symbol library data set, or in an ESP Procedure. The value can be a blankcharacter, null character or any other character string.

Use the symbol in your JCL wherever you want to exclude a JCL statement.

Reference the symbolic variable library and ESP Procedure (if you defined thesymbolic variable in an ESP Procedure) in the Event that submits the JCL.

To turn the feature off, specify NOCHECKEXC.

Note: The recommended method for including and excluding JCL is to use‘%INCLUDE IF’ and ‘%EXCLUDE IF’.

RelatedStatements

For information on turning off the checking of the last non-blank character of everycard image written to the internal reader, see the NOCHECKEXC statement.

For information on selectively including JCL, see the %INCLUDE statement.

For information on selectively excluding JCL, see the %EXCLUDE statement.

Continued on next page

Page 101: ESP 5.2 Command Reference

101

CHECKEXC Statement, Continued

Example 1 The following CHECKEXC statement indicates that ESP should check the last non-blank character of every card image written to the internal reader, and set the valueof a symbolic variable:

CHECKEXCX=’¬’

In the above example, when ‘%X’ appears as the last non-blank character on anycard image written to the internal reader, that card image is excluded.

The following example uses the exclusion symbol (defined above) in JCL:

//PAYJOB1 JOB …//STEP001 EXEC PGM=ABC//STEP002 EXEC PGM=DEF%X

In the above example, when ESP submits PAYJOB1, STEP002 is excluded.

Example 2 The following CHECKEXC statement indicates that ESP should check the last non-blank character of every card image written to the internal reader, and set the valueof a symbolic variable on specific days:

CHECKEXCZ=’ ’%INCLUDE DAY(MONDAY,THURSDAY)Z=’¬’%ENDINCL

In the above example, on Mondays and Thursdays, the last non-blank character of acard image is set to ‘¬’, excluding that card image.

The following is an example of using the exclusion symbol (defined above) in JCL:

//PAYJOB2 JOB …//STEP001 EXEC PGM=ABC%Z//STEP002 EXEC PGM=DEF//STEP003 EXEC PGM=GHI%Z

In the above example, when ESP submits PAYJOB2 it includes:

• STEP002 each time• STEP001 and STEP003 each time except on Mondays and Thursdays, because the

value of ‘Z’ is set to ‘¬’ on those days.

Continued on next page

Page 102: ESP 5.2 Command Reference

102

CHECKEXC Statement, Continued

Example 3 The following shows how to exclude JCL by using a symbolic variable library andan ESP Procedure.

The following CHECKEXC statement is specified in a symbolic variable data set:

CHECKEXC

In the above example, CHECKEXC is specified to indicate that ESP should checkthe last non-blank character of every card image written to the internal reader.

The following IF/THEN/ELSE logic is specified in an ESP Procedure to set thevalue of the symbolic variable:

IF TODAY(‘FIRST WORKDAY OF MONTH’) THEN FWM=’¬’ELSE FWM=’ ’

In the above example, the value of a symbolic variable called ‘FWM’ is set to ‘¬’ onthe last workday of each month.

The following example uses the exclusion symbol (defined above) in JCL:

//PAYJOB3 JOB …//STEP001 EXEC PGM=JKL//STEP002 EXEC PGM=MNO%FWM

In the above example, when ESP submits PAYJOB3 it includes:

• STEP001 each time• STEP002 each time except on the first workday of each month, because the value

of ‘FWM’ is set to ‘¬’.

Page 103: ESP 5.2 Command Reference

103

CLASS Command

Overview The CLASS command is used to display and manipulate class queues. When anEvent is defined, it can be associated with a particular class. A class is a user-defined string of up to eight characters that can be used to group Events logicallytogether. If a class name is omitted from an Event definition, the Event name prefixis used as the class name.

Type General command.

Authority OPER authority is required to issue the CLASS command.

Syntax The syntax of the CLASS command is:

{CLASS|CL} classname[HOLD|RELEASE][SUSPEND|RESUME][EXEMPT|DEEXEMPT][RESET|FLUSH][IGNORE|PROCESS][LIST]

Parameter Descriptionclassname Indicates a class name specification of up to eight characters.

The specification may include wildcards. Several class namescan be specified. They should be entered within parenthesesand separated by blanks or commas.

HOLD Indicates Events in classes described by the class name areplaced in a hold queue at their scheduled time.

RELEASE Indicates any Events held in class queues described by theclass name are released and placed on the overdue queue. Amessage is issued indicating how many Events were releasedin each class.

SUSPEND Indicates Events in classes described by the class name arebypassed at their scheduled execution time.

RESUME Indicates the SUSPEND restriction is removed for the classesdescribed by the class string.

EXEMPT Indicates Events in classes described by the class name areexempt from class hold or suspend restrictions.

DEEXEMPT Removes the EXEMPT restriction.RESET Removes any restrictions from the specified class name.

Continued on next page

Page 104: ESP 5.2 Command Reference

104

CLASS Command, Continued

Syntax (continued)

Parameter DescriptionFLUSH Indicates any Events on the specified class hold queues are

flushed and will not execute. This does not affect futurescheduled executions.

IGNORE Indicates Events in classes described by the class name areignored at their scheduled execution time only on the ESPsystem that issued the CLASS command with the IGNOREparameter.

PROCESS Indicates the IGNORE restriction is removed for the classesdescribed by the class name.

LIST Displays any class hold queues for the specified classes. Thisis the default.

Usage notes The CLASS command allows you to manipulate a group of Events.

If the CLASS command is entered with no parameters, the current list of restrictionsis displayed, along with the names of any class hold queues and the number ofEvents in each.

The class restriction lists and hold queues are checkpointed and are retained acrosswarm starts. A cold start clears all the queues and class restriction lists.

The scope of the CLASS command is that of the current system only, and not of anyother systems sharing the same data sets. Issue the CLASS command on eachsystem that you want to affect.

Holding a class affects active Applications by preventing any further job submissionuntil you release the class or exempt the associated Event.

If you suspend a class associated with an active Application, the Application stopsprocessing and does not continue when you resume the class.

Relatedinformation

For information on starting an Event definition, see the EVENT command.

For information on working with ESP Events, see the ESP Workload ManagerUser’s Guide.

For information on putting ESP into a quiesced state, see the QUIESCE command.

Example 1 The following CLASS command displays all classes:

CLASS

In the above example, all class queues are displayed.

Continued on next page

Page 105: ESP 5.2 Command Reference

105

CLASS Command, Continued

Example 2 The following CLASS commands hold an Event class:

CLASS PROD HOLD LIST

In the above example, all Events associated with the ‘PROD’ class are held.

Note: By specifying LIST (above) you will receive the following message:

FOLLOWING CLASSES EXEMPT(E), HELD(H) SUSPENDED(S) IGNORED(I)PROD1(S), PROD2(S)

Example 3 The following CLASS command holds specific Event classes:

CLASS - HOLD;CLASS **PA- EXEMPT

In the above example, all Event classes are held, except for those Event classes withcharacters ‘PA’ in positions three and four.

Example 4 The following CLASS command resumes a previously held Event class:

CLASS PROD RESUME

In the above example, all Events associated with the PROD class are resumed.

Example 5 The following CLASS command suspends all Event classes except one.

CLASS - SUSPEND;CLASS PAY EXEMPT LIST

In the above example, all Event classes are suspended, except the Event classesassociated with the PAY class.

Note: By specifying LIST (above), you receive the following message:FOLLOWING CLASSES EXEMPT(E), HELD(H) SUSPENDED(S) IGNORED(I)PAY(E), -(S)

Example 6 The following CLASS command holds specific Event classes:

CLASS (CLNT1,CLNT2) HOLD

In the above example, all Event classes CLNT1 and CLNT2 are held.

Continued on next page

Page 106: ESP 5.2 Command Reference

106

CLASS Command, Continued

Example 7 The following CLASS command flushes all classes:

CLASS - FLUSH

In the above example, all class hold queues are flushed and do not execute. Thisdoes not affect future scheduled executions.

Page 107: ESP 5.2 Command Reference

107

CLRSYSMS Command

Overview The CLRSYSMS command is used to clear system message interceptions whichwere defined using the SYSMSGS command.

Type General command.

Authority OPER authority is required to issue the CLRSYSMS command.

Syntax The syntax of the CLRSYSMS command is:

CLRSYSMS ID(xxxx)

Parameter DescriptionID(xxxx) Indicates an identifier consisting of four alphanumeric

characters to clear a specific message intercept. To clear allsystem message intercepts, code ID(*).

Relatedinformation

For information on intercepting messages written to the system message data set, seethe SYSMSGS command.

For information on displaying information on all system messages that are currentlybeing intercepted by ESP, see the LSYSMSGS command.

Example 1 The following CLRSYSMS command clears a specific system intercept:

CLRSYSMS ID(0022)

In the above example, a system message intercept whose identifier is 0022 iscleared.

Example 2 The following CLRSYSMS command clears all system message intercepts:

CLRSYSMS ID(*)

In the above example, all system message intercepts are cleared.

Page 108: ESP 5.2 Command Reference

108

CMDPRFX Command

Overview The CMDPRFX command allows you to substitute the string the ‘F stcname,’(where stcname is the started task name for ESP) with a single character. Thisallows you to enter a single character instead of specifying ‘F stcname,’ whenmodify commands to ESP are entered from a system console.

Type General command.

Authority OPER authority is required to issue the CMDPRFX command.

Syntax The syntax of the CMDPRFX command is:

CMDPRFX character ‘F stcname,’

Parameter Descriptioncharacter Indicates a single character, which is to be substituted for the

‘F stcname’ string, where stcname is the name of your ESPstarted task.

Usage notes Do not choose an MVS command character, i.e. C (Cancel), Z (Halt) or F (Modify)and so on, to represent the ‘F ESP,’ string.

Relatedinformation

For information on displaying whether command prefixing is in effect or not, see theLCMDPRFX command.

Example 1 The following CMDPRFX command substitutes a single character for the‘F ESPPROD,’ string:

CMDPRFX # ‘F ESPPROD,’

In the above example, # is substituted for ‘F ESPPROD,’ when modify commands toESP are entered from a system console.

As a result of setting the command prefix to #, you can enter the following commandfrom a system console to trigger an Event.

# TRIGGER CYBER.PAYROLL ADD

Page 109: ESP 5.2 Command Reference

109

COM Command

Overview The COM command is used to add any number of comments, anywhere in an Eventbetween the EVENT command and the ENDDEF command. ESP ignores anycomments when an Event is triggered.

Type Event definition command.

Syntax The syntax of the COM command is:

COM comment

Parameter Descriptioncomment Any string.

Usage notes If you have more than one comment, you must use COM at the beginning of eachcomment line.

Relatedinformation

For information on starting an Event definition, see the EVENT command.

For information on ending an Event definition, see the ENDDEF command.

For information on working with ESP Events, see the ESP Workload ManagerUser’s Guide.

Example 1 The following COM command is used to add a comment to an Event:

EVENT ID(CYBER.PAYJOBS)COM THIS IS AN EVENT TO SUBMIT PAYROLL JOBS EVERY THURSDAYSCHEDULE 19:00 THURSDAYSSUBMIT ‘PROD.JCL.CNTL(PAYJOB1)’SUBMIT ‘PROD.JCL.CNTL(PAYJOB2)’ENDDEF

In the above example, a comment is added to the Event indicating what the Event isdoing (submitting jobs) and when the Event is to submit those jobs (Thursdays).

Page 110: ESP 5.2 Command Reference

110

CONNECT Command

Overview The CONNECT command is used to tell ESP which user belongs to which group.

Type General command.

Authority SPECIAL or CONNECTDEF authority is required to issue the CONNECTcommand in a non-SAF environment.

Note: CONNECT is applicable only when using ESP Workload Manager’s internalsecurity.

Syntax The syntax of the CONNECT command is:

{CONNECT|CON} useridGROUP(groupname)[EXECUTE][READ][UPDATE]

Parameter Descriptionuserid Indicates the name of the user to be connected to the group.groupname Indicates the name of the group to which the user is to be

connected.EXECUTE Indicates the user ID is permitted to trigger an Event; with

additional READ access, the user can control jobs in anApplication created by an Event with the followingrestrictions: unable to insert jobs or resubmit a job with adifferent JCL library.

READ Indicates the user ID is permitted to display an Event, list theschedule and display the status of jobs the Event submits.

UPDATE Indicates the user ID is permitted to define or update an Eventdefinition; with additional READ access, the user can controljobs in an Application created by an Event with norestrictions.

Continued on next page

Page 111: ESP 5.2 Command Reference

111

CONNECT Command, Continued

Usage notes A user with an authority attribute of ANY has access to any Group. Such a userdoes not need to be connected to any Group.

If you do not define a type of access, i.e. READ, EXECUTE or UPDATE, the userhas unrestricted access to Events with the Group prefix.

You can connect a user to more than one group. When you connect a user to morethan one group, that user can use the GROUP command in Page mode to switchbetween his or her user ID and any group he or she can access. This is useful whenusing commands where a group prefix is required.

When you display a group, ESP lists all the users connected to that group.

When you display a user, ESP lists all the groups to which a user is connected. Ifthere are any access restrictions to a group, they are listed in parenthesis. ESP usesthe following abbreviations for access permissions: R (READ), X (EXECUTE), andU (UPDATE).

Relatedinformation

For information on removing a user’s access from a Group prefix, see theDISCONN command.

For information on working with users and groups, see the ESP Workload ManagerAdministrator’s Guide.

For information on listing a user definition, see the LISTUSER command.

Example 1 The following CONNECT command connects a user to a group:

CONNECT USER1 GROUP(PROD)

In the above example, USER1 is connected to PROD. USER1 has full access toEvents with the PROD prefix because READ, EXECUTE or UPDATE were notspecified.

Example 2 The following CONNECT command connects a user to a group:

CONNECT USER2 GROUP(TEST) EXECUTE

In the above example, USER2 is connected to TEST. USER2 is permitted to triggerEvents with the TEST prefix. If READ access is given to USER2 in addition toEXECUTE access, USER2 is able to control jobs in an Application created by anEvent, but unable to insert jobs or resubmit a job with a different JCL library.

Page 112: ESP 5.2 Command Reference

112

CONSOLE Command

Overview The CONSOLE command is used to set the ‘owning’ or primary console. Allgeneral message traffic is directed to the ‘owning’ console.

Type General command.

Authority OPER authority is required to issue the CONSOLE command.

Syntax The syntax of the CONSOLE parameter is:CONSOLE [*|ucmid|0|name]

Parameter Description* Requests the console issuing the command is made the

primary console.

ucmid Indicates a one or two digit console UCMID.

0 Indicates no console. Messages routed by routing code on tothe active Master console.

name Indicates the one-to-eight character name of an active consolein the ESP complex.

Usage notes A primary console must be an active one with the capability for both input andoutput. If no operands are specified, the current primary console information isdisplayed. The console must be active when the request is issued.

Example 1 The following CONSOLE command sets a primary console:

CONSOLE 2

In the above example, console 2 is set as the primary console.

Example 2 The following CONSOLE command sets a primary console:

CONSOLE *

In the above example, the issuing console assumes the role of the primary console.

Continued on next page

Page 113: ESP 5.2 Command Reference

113

CONSOLE Command, Continued

Example 3 The following CONSOLE command sets a primary console:

CONSOLE BOSS

In the above example, a console named BOSS is set as the primary console.

Page 114: ESP 5.2 Command Reference

114

COPY Command

Overview The COPY command is used to specify an output data set or file to receive all orsubsets of the job history record read in from the input source. The COPYcommand is useful when you want to separate data in a history file into one or morefiles.

Type Reporting command.

Syntax The syntax of the COPY command is:

COPY {DATASET(dsname)}{FILE(filename)}[SELECT|ALL|REJECT][EXTEND]

Parameter Descriptiondsname Indicates the name of the output data set. This is mutually

exclusive with the filename option.filename Indicates the name of the file to which the data is to be

written. This is mutually exclusive with the dsname option.SELECT Indicates only records matching any selection criteria are

copied. If no CRITERIA section exists in the reportdefinition, all records are copied.

ALL Indicates all records in the input file(s) are copied to theoutput file.

REJECT Indicates the copy is restricted to any records that fail tomatch any selection criteria. If no criteria section exists, norecords are copied.

EXTEND Indicates the data to be copied be added to the end of theoutput data set rather than to replace existing data.

Usage notes There is no restriction to the number of COPY commands that can be included in asingle report definition; records are copied in their original sequence.

ESP writes to any format sequential data set. If a data set is new and you have notyet specified a record format for it, ESP uses the following default:

• LRECL=4096• RECFM=VBS• BLKSIZE=6144

Relatedinformation

For information on history reporting, see the ESP Workload Manager User’s Guide.

Continued on next page

Page 115: ESP 5.2 Command Reference

115

COPY Command, Continued

Example 1 The following COPY command copies data into two separate files:

REPORTHISTFILE HIST1CRITERIA RDRON GT TODAY LESS 12 WEEKSCOPY SELECT FILE(DISK1)COPY REJECT FILE(TAPE1)

In the above example, records less than 12 weeks old when the request is made arecopied the file DISK1. Records that are more than 12 weeks old when the request ismade are copied to the file TAPE1.

Page 116: ESP 5.2 Command Reference

116

COPYJCL Statement

Overview The COPYJCL statement is used to generate a copy of the JCL for every job ESPsubmits. When you use the COPYJCL statement you must specify the library that isto receive the copy, followed by either the JOBNAME or JOBID keyword. Thisworking copy of the JCL can be used for job re-submission. ESP keeps track ofwhere the job was submitted from and the JCL that was used.

Type ESP Event statement, ESP Application statement.

Syntax The syntax of the COPYJCL statement is:

COPYJCL {datasetname|NONE}[GENERATION(genno)][JOBNAME|JOBID]

Parameter Descriptiondatasetname Indicates the name of an existing partitioned data set to which

you have update authority. This is the data set to which the JCLcopy is made.

NONE Indicates no JCL copy is needed. This can only be used at thejob level in an Application.

genno Indicates the name of an existing GDG and optional generationnumber. The generation number should be a zero or a negativenumber. GENERATION can be abbreviated to GEN.

JOBNAME Indicates the member name used for storing the JCL for a job isthe same as the jobname. This is the default.

JOBID Indicates the member name used for storing the JCL for a job isthe JES jobid. It is in the form JOBnnnnn, where nnnnn is thejob number.

Continued on next page

Page 117: ESP 5.2 Command Reference

117

COPYJCL Statement, Continued

Usage notes You can specify COPYJCL in the Event definition of any Event that submits jobs.This copy is written to a member of a PDS, providing a working copy of the JCLwith, where applicable, all symbolic variables resolved and NET cards (forDJC/JES3) are included.

You can also specify COPYJCL within an Application definition to identify one ormore jobs for which you want to use COPYJCL. This gives you the advantage ofusing COPYJCL for specific jobs.

The JOBNAME keyword requests that the member name used for storing the JCLfor a job is the same as the jobname. This is the default. Each submission of aparticular job overwrites the previous copy of that job’s JCL.

Use the JOBID keyword when you want ESP to store the copy of the JCL by jobnumber. ESP creates a member name starting with JOB, followed by a five–digitJES job number. The system assigns this number sequentially. A member is notoverwritten until its five–digit number reoccurs.

Note: With either option (JOBNAME or JOBID), you can write the JCL to a PDSGDG (generation data group).

RelatedStatements

For information on working with ESP Events, see the ESP Workload ManagerUser’s Guide.

For information on identifying JCL, see the ESP Workload Manager User’s Guide.

Example 1 The following COPYJCL statement used in an ESP Event indicates that ESP shouldwrite a copy of all submitted jobs to a PDS:

EVENT ID(CYBER.PAYROLL)INVOKE ‘CYBBS01.PROCLIB.CNTL(PAYROLL)’COPYJCL ‘CYBER.COPYLIB.CNTL’ JOBNAMEENDDEF

In the above example, ESP writes a copy of all submitted jobs within the‘PAYROLL’ Application to ‘CYBER.COPYLIB.CNTL’ and stores the jobs byjobname.

Continued on next page

Page 118: ESP 5.2 Command Reference

118

COPYJCL Statement, Continued

Example 2 The following COPYJCL statement used in an ESP Application indicates that ESPshould write a copy of all submitted jobs except PAYJOB2 to a PDS:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’COPYJCL ‘CYBER.COPYLIB.CNTL’ JOBIDJOB PAYJOB1

RELEASE PAYJOB2JOB PAYJOB2

RELEASE PAYJOB3COPYJCL NONE

JOB PAYJOB3ENDJOBSELECT (PAYJOB1,PAYJOB2,PAYJOB3)

In the above example, ESP writes a copy of all submitted jobs within the‘PAYROLL’ Application excluding PAYJOB2 to ‘CYBER.COPYLIB.CNTL’ andstores the jobs by JES jobid.

Example 3 The following COPYJCL statement used in an ESP Event indicates that ESP shouldwrite a copy of all submitted jobs to a GDG.

EVENT ID(CYBER.PAYROLL)INVOKE ‘CYBBS01.PROCLIB.CNTL(PAYROLL)’COPYJCL ‘CYBER.COPYLIB.CNTL’ GEN(0) JOBNAMEENDDEF

In the above example, ESP writes a copy of all submitted jobs within the‘PAYROLL’ Application to the current generation of ‘CYBER.COPYLIB.CNTL’and stores the jobs by job name.

Page 119: ESP 5.2 Command Reference

119

COREQ Statement

Overview The COREQ statement is used to specify the name(s) of any other job that isselected automatically whenever the specified job is selected. The specified job andall of its co-requisites are allowed to execute simultaneously.

Type ESP Application statement.

Syntax The syntax of the COREQ statement is:

COREQ {jobname}{jobname[,jobname]...}{ADD(jobname[,jobname]...)}{DROP(jobname[,jobname]...)}

Parameter Descriptionjobname Indicates a jobname in up to eight characters. Enclose multiple

job names in parentheses, separated by a blank or a comma.ADD Indicates the specified job(s) be added to those currently

defined COREQs. If a previous COREQ statement wasspecified in the ESPPROC, the job(s) is added to these as well.

DROP Indicates the specified job(s) be dropped from those currentlydefined COREQs.

Usage notes A COREQ statement overrides any previous COREQ statement for the same jobunless the ADD keyword is specified. COREQ can be used with any job to nameother jobs that must be selected for execution whenever this job is selected.

The COREQ statement specifies jobs that are selected when the specified job isselected. It does not cause the COREQ jobs to inherit any of the relationships of thespecified job. The appropriate relationships need to be specified using PREREQ,POSTREQ, AFTER, or RELEASE statements.

The COREQ statement forces selection of the co-requisite jobs - no SELECTstatement or RUN statement is required.

RelatedStatements

For information on specifying job relationships, see the AFTER, RELEASE,PREREQ, and POSTREQ statements.

For information on Applications, see the ESP Workload Manager User’s Guide.

Continued on next page

Page 120: ESP 5.2 Command Reference

120

COREQ Statement, Continued

Example 1 The following COREQ statement identifies job relationships within an Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN MONDAYCOREQ PAYJOB2

JOB PAYJOB2ENDJOB

In the above example, whenever PAYJOB1 is selected, ESP always selectsPAYJOB2. There is no relationship between PAYJOB1 and PAYJOB2.

Example 2 The following COREQ statement identifies job relationships within an Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB3

RUN WORKDAYSCOREQ (PAYJOB4,PAYJOB5,PAYJOB6)

JOB PAYJOB4JOB PAYJOB5JOB PAYJOB6ENDJOB

In the above example, PAYJOB3, PAYJOB4, PAYJOB5 and PAYJOB6 are selectedfor submission and will run simultaneously on workdays.

Example 3 The following COREQ statement identifies job relationships within an Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB7

RUN WORKDAYSCOREQ (PAYJOB8,PAYJOB9)COREQ ADD(PAYJOB10,PAYJOB11)

JOB PAYJOB8JOB PAYJOB9JOB PAYJOB10JOB PAYJOB11ENDJOB

In the above example, whenever PAYJOB7 is selected, ESP always selectsPAYJOB8, PAYJOB9, PAYJOB10 and PAYJOB11.

Continued on next page

Page 121: ESP 5.2 Command Reference

121

COREQ Statement, Continued

Example 4 The following COREQ and RELEASE statements are used to:

• Indicate jobs that can run simultaneously• Indicate a relationship between jobs.

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB12

RUN DAILYRELEASE PAYJOB13

JOB PAYJOB13RUN FRIDAYCOREQ (PAYJOB14,PAYJOB15,PAYJOB16)

ENDJOB

In the above example:

• PAYJOB12 runs every day• On Friday’s PAYJOB12, PAYJOB14, PAYJOB15 and PAYJOB16 run

simultaneously, because the COREQ jobs do not inherit any relationship toPAYJOB13

• PAYJOB13 runs after PAYJOB12 successfully completes.

Page 122: ESP 5.2 Command Reference

122

CPU Command

Overview The CPU command is used in conjunction with the NODE parameter, to define theresource topology of your network. The CPU command defines each CPU within anode.

Type General command.

Syntax The syntax of the CPU parameter is:

CPU name [ADD|DEL|LIST|SET]NODE(nodename)[ROUTEJCL(‘/*JOBPARM SYSAFF=...’)][ORDER(nn)][CURRENT][ACTIVE|INACTIVE][DEL[FORCE]]

Parameter Descriptionname Indicates the name to identify this CPU. This must be a

unique name. When used with NODE, you may have thename correspond to, for example, an existing JES node nameor SMF id, but this is not mandatory. The asterisk (*) andhyphen (-) may be used as wild card characters for maskingthe name with all parameters except ADD.

ADD Indicates this is a new definition.DEL Deletes one or more existing definitions.LIST Displays list of one or more existing definitions. This is the

default.SET Modifies attributes of existing definitions.NODE(nodename) Indicates the node of which the CPU is a member as specified

by the NODE parameter.ROUTEJCL Indicates a JCL image that, when inserted into a job’s JCL,

causes the job to be routed to the appropriate CPU or node.ORDER(nn) Allows the installation to define a search sequence. When

ESP tries to schedule a job, it scans for resource availabilityby CPU, searching the CPUs in sequence defined by theORDER value. If two CPUs have the necessary resources toexecute a job, ESP schedules the job to the one with thelowest ORDER value.

CURRENT Indicates the CPU on which the ESP subsystem doing thesubmission is executing. No ROUTE JCL is generated forjobs on the current system.

ACTIVE Indicates a CPU or node be considered active. This is thedefault.

Continued on next page

Page 123: ESP 5.2 Command Reference

123

CPU Command, Continued

ACTIVE (continued)

Parameter DescriptionINACTIVE Indicates a CPU or node be considered inactive. ESP does

not attempt to schedule a job to that node or CPU while it isinactive.

DEL FORCE Indicates the specified CPU is to be deleted. The FORCEoption is only valid when deleting the last defined CPU.

Note: The CPU must be inactive to be deleted.

Usage notes The CPU command is generally used at the Initialization Parameter level, and isused in conjunction with the NODE parameter to define the resource topology ofyour network.

Relatedinformation

For information on defining the resource topology of your network, see the CPU,NODE, and RESFILE parameters in the ESP Workload Manager Installation Guide.

For information on Resources, see the ESP Workload Manager User’s Guide.

Example 1 The following CPU command displays all defined CPU’s:

CPU - LIST

In the above example, all CPUs defined as part of the resource topology aredisplayed.

Example 2 The following CPU command first inactivates a specific CPU, then deletes thatCPU:

CPU T1 SET INACTIVE

then

CPU T1 DEL FORCE

In the above example, T1 is inactivated and then deleted.

Example 3 The following NODE and CPU commands define a node and CPU:

NODE TORONTO ADDCPU T1 ADD NODE(TORONTO) CURRENT

In the above example, a single node called TORONTO is defined, and a single CPUcalled T1 is defined as a member of the TORONTO node.

Page 124: ESP 5.2 Command Reference

124

CRITERIA Command

Overview The CRITERIA command is used to specify selection criteria when producing ESPhistory reports. You can specify several field, operator and value groups.

Type Reporting command.

Syntax The syntax of the CRITERIA command is:

CRITERIA field operator value

Parameter Descriptionfield Indicates a field name keyword (such as JOBNAME).

For a detailed list of the history reporting fields, see the ESPWorkload Manager User’s Guide.

operator Indicates a comparison operator in either their letter orsymbol form:

• LT or <• LE or <=• EQ• NE or ¬ =• GT or >• GE or >=

value Indicates the value against which comparisons should bemade. Its format depends on the field type.

Usage notes You can specify several criteria sections in a single report using multiple criteriacommands. ESP selects a job if it satisfies any criteria section.

You can specify several criteria elements on 1 criteria statement. To be selected ajob must satisfy all criteria.

You can also use the ‘OR’ and ‘AND’ logical operators.

If you want to compare a field to a null string, use a blank enclosed in single quotes,as in ‘ ’.

If you do not specify a CRITERIA section in your report, ESP selects all records thatmeet the time criteria.

Relatedinformation

For information on history reporting, see the ESP Workload Manager User’s Guide.

Continued on next page

Page 125: ESP 5.2 Command Reference

125

CRITERIA Command, Continued

Example 1 The following CRITERIA command specifies selection criteria:

CRITERIA APPLSYS EQ PAYROLL

In the above example, jobs that belong to the PAYROLL Application are selected.

Example 2 The following CRITERIA command specifies selection criteria:

CRITERIA APPLSYS EQ PAYROLLCRITERIA JOBNAME EQ P-

In the above example, jobs that belong to the PAYROLL Application, or jobs thatstart with P, are selected.

Example 3 The following CRITERIA command specifies selection criteria:

CRITERIA APPLSYS EQ PAYROLL JOBNAME EQ P-

In the above example, jobs that belong to the PAYROLL Application, and jobs thatstart with P, are selected.

Example 4 The following CRITERIA command specifies selection criteria:

CRITERIA ENDT GT 09:00 TODAY

In the above example, jobs that have completed execution since 9 am today areselected.

Continued on next page

Page 126: ESP 5.2 Command Reference

126

CRITERIA Command, Continued

Example 5 The following CRITERIA command specifies selection criteria:

CRITERIA JOBNAME EQ XYZ- CPUTIME GT 11L00 TEXCP GT 0 -STATUS EQ COMPLETE

In the above example, jobs which meet all of the following criteria are selected:

• Have names beginning ‘XYZ’• Consume more than 11 seconds of CPU time• Perform I/O to tape• And which have completed processing.

Example 6 The following CRITERIA command specifies selection criteria:

CRITERIA TEXCP GT 0 OR DEXCP GT 10000CRITERIA JOBNAME EQ ABC- OR JOBNAME EQ A*

In the above example, jobs which meet any of the following criteria are selected:

• Have more than 10000 EXCPs to DASD devices• Perform I/O to tape• Have names beginning ‘ABC’• Two-character names that begin with ‘A’.

Example 7 The following CRITERIA command specifies selection criteria:

CRITERIA ESPSUB EQ ‘YES’ AND APPLSYS NE ‘ ’

In the above example, all jobs submitted by ESP that do not belong to anApplication are selected.

Page 127: ESP 5.2 Command Reference

127

CRITPATH Command

Overview The CRITPATH command is used to enable or disable Critical Path analysis on thisESP system.

Type General command.

Authority OPER authority is required to issue the CRITPATH command.

Syntax The syntax of the CRITPATH command is:

CRITPATH [DISABLE|ENABLE|ON]

Operand DescriptionDISABLE Disallows critical path analysis on this system. Critical path

analysis cannot be used on this system when disabled. This isthe default.

ENABLE Allows critical path analysis on this system. Then specifyCRITPATH ON within the Applications where you wantcritical path analysis performed.

ON Turn on critical path analysis for all Applications. It can beturned off within an Application using the CRITPATH OFFstatement.

Usage notes By default, critical path analysis is turned off or disabled for all Applications thatESP generates. To control usage of critical path analysis a CRITPATH initializationstatement, a CRITPATH Application statement and a CRITPATH command areprovided. The following chart summarizes how ESP handles critical path analysisbased on various CRITPATH parameter and statement settings:

If the CRITPATHinitialization parameter isset to …

And the CRITPATHApplication statement isset to …

Then critical pathanalysis is …

DISABLE OFF Not calculatedDISABLE ON Not calculatedDISABLE Not specified Not calculatedENABLE OFF Not calculatedENABLE ON CalculatedENABLE Not specified Not calculated

ON OFF Not calculatedON ON CalculatedON Not specified Calculated

Continued on next page

Page 128: ESP 5.2 Command Reference

128

CRITPATH Command, Continued

Usage notes,cont’d

If critical path analysis is activated by coding either CRITPATH ON in theInitialization Parameters, or CRITPATH ENABLE in the Initialization Parametersand CRITPATH ON in the Application, but no jobs are coded with the CRITICALkeyword, ESP calculates the path to the job that will finish last and identifies thatpath as the critical path.

RelatedStatements

For information on critical path analysis, see the ESP Workload Manager User’sGuide.

For information on specifying whether critical path analysis is to be performed foran Application, see the CRITPATH Application statement.

For information on overriding historical elapsed time defaults, see the DURATIONstatement.

Example 1 The following CRITPATH command turns on critical path analysis:

CRITPATH ON

In the above example, critical path analysis is turned on for all Applicationsgenerated by ESP on this system. If required, critical path analysis can be turned offfor specific Applications by coding CRITPATH OFF in the Application definition.

Example 2 The following CRITPATH command enables critical path analysis:

CRITPATH ENABLE

In the above example, critical path analysis is enabled for this ESP system. To turnon critical path analysis for an Application, code CRITPATH ON in the Applicationdefinition.

Example 3 The following CRITPATH command disables critical path analysis:

CRITPATH DISABLE

In the above example, critical path analysis is disabled for this ESP system. To turnoff critical path analysis for an Application, code CRITPATH OFF in theApplication definition.

Page 129: ESP 5.2 Command Reference

129

CRITPATH Application Statement

Overview This CRITPATH statement is used to specify whether critical path analysis is to beperformed for this Application.

Type ESP Application statement

Syntax The syntax of the CRITPATH statement is:

CRITPATH [ON|OFF]

Operand DescriptionON Turns on Critical Path analysis for this Application.

Note: Critical Path analysis must also be enabled for this ESPsystem. Enable it using the CRITPATH InitializationParameter, or the CRITPATH operator command.

OFF Turns off Critical Path analysis for this Application. Use thisoption when Critical Path analysis is turned on in theInitialization Parameter, but you don’t want to perform theanalysis for this specific Application.

Usage notes The CRITPATH statement works in conjunction with the CRITPATH InitializationParameter or the CRITPATH command to turn Critical Path analysis on or off. TheCRITPATH Initialization Parameter and command are used to enable Critical Pathanalysis on the system. To perform the analysis, you need to turn Critical Pathanalysis on, using the CRITPATH statement.

Relatedinformation

For information on critical path analysis, see the ESP Workload Manager User’sGuide.

For information on enabling or disabling critical path analysis, see the CRITPATHcommand.

Example 1 The following CRITPATH command turns on critical path analysis:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’CRITPATH ONJOB PAYJOB1

In the above example, critical path analysis is turned on for the PAYROLLApplication.

Continued on next page

Page 130: ESP 5.2 Command Reference

130

CRITPATH Application Statement, Continued

Example 2 The following CRITPATH command turns off critical path analysis:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’CRITPATH OFFJOB PAYJOB2

In the above example, critical path analysis is turned off for the PAYROLLApplication.

Page 131: ESP 5.2 Command Reference

131

DAB Command

Overview The DAB command is used to display all or selected jobs from the abended queue.

Type General command.

Authority OPER authority is required to issue the DAB command.

Syntax The syntax of the DAB command is:

DAB [LEVEL(jobstring)][LAST(minutes)|FROM(time)][TIME][DATE][PROD]

Parameter Descriptionjobstring Indicates one or more jobname prefixes to limit the display to

a particular group of jobs. The string can contain asterisksand a hyphen.

minutes Indicates only jobs that abended in the last n minutes are to bedisplayed.

time Indicates only jobs that abended after that specified time areto be displayed. This must be a time in the past. The timeand date can be specified in free format. If the time and datecontain blanks or commas, enclose the whole string withinquotes.

TIME Indicates the time of the abend is displayed together with thecompletion code.

DATE Indicates the date of the abend is displayed together with thecompletion code.

PROD Indicates an updated display of ABENDed jobs (i.e. onlythose still in ABEND status). This keyword applies only tojobs in an Application.

Usage notes The DAB command displays jobs from the abended queue. The size of the abendedqueue is set with the ABENDLIM command.

The jobname, job number and completion code fields are always displayed. Jobs aredisplayed in reverse chronological order; that is the most recently abended jobs areshown first. This command can be issued from a system console.

Continued on next page

Page 132: ESP 5.2 Command Reference

132

DAB Command, Continued

Relatedinformation

For information on displaying abended jobs using the CSF, see the ESP WorkloadManager User’s Guide.

For information on displaying or setting the abend queue size for jobs that ESP istracking, see the ABENDLIM command.

Example 1 The following DAB command displays all abended jobs:

DAB

In the above example, all abended jobs on the queue up to the limit set by theABENDLIM command are displayed.

Example 2 The following DAB command displays specific jobs:

DAB LEVEL(PR- PAY-) FROM(1AM) TIME

In the above example, jobs with names beginning with PR and PAY that haveabended since 1:00 am, are displayed.

Example 3 The following DAB command displays abended jobs within the last hour:

DAB LAST(60) TIME

In the above example, jobs that have abended in the last 60 minutes are displayed.The time each job abended is also displayed.

Example 4 The following DAB command displays an updated list of abended jobs:

DAB PROD

In the above example, an updated display of ABENDed jobs is displayed, i.e. onlythose jobs still in abend status.

Page 133: ESP 5.2 Command Reference

133

DATASET Statement

Overview The DATASET statement is used to specify the JCL library and optional membername to be used for a particular job. The DATASET statement must be placedwithin the scope of a JOB statement.

Type ESP Application statement.

Syntax The syntax of the DATASET statement is:

DATASET ‘dsname’[member]

Parameter Descriptiondsname Indicates the name of the data set.member If this is a PDS, it optionally specifies the member name. If the

member name is omitted, the job name is the default.

Usage notes The DATASET you specify applies only to this particular job. ‘DATASET’ is usedto identify the JCL library and optionally the member name to be used for aparticular job. This overrides, for this job only, the default JCL library alreadynamed in a JCLLIB statement.

RelatedStatements

For information on specifying different JCL libraries, see the ESP WorkloadManager User’s Guide.

Example 1 The following DATASET statement indicates an alternative JCL library for a jobwithin an Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN DAILYRELEASE PAYJOB2

JOB PAYJOB2RUN DAILYDATASET ‘CYBER.ALTJCL.CNTL’

ENDJOB

In the above example, when ESP submits jobs in the PAYROLL Application:

• PAYJOB1 is submitted from ‘CYBER.JCL.CNTL’• PAYJOB2 is submitted from ‘CYBER.ALTJCL.CNTL’.

Continued on next page

Page 134: ESP 5.2 Command Reference

134

DATASET Statement, Continued

Example 2 The following DATASET statement indicates an alternative JCL library andmember for a job within an Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB3

RUN DAILYRELEASE PAYJOB4

JOB PAYJOB4RUN DAILYDATASET ‘CYBER.ALTJCL.CNTL(PAYJOB99)’

ENDJOB

In the above example, when ESP submits jobs in the PAYROLL Application:

• PAYJOB3 is submitted from ‘CYBER.JCL.CNTL’• PAYJOB4 is submitted from member PAYJOB99 within data set

‘CYBER.ALTJCL.CNTL’.

Example 3 The following DATASET statement indicates an alternative JCL library for a jobwithin an Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB5

RUN DAILYIF TODAY(‘FEB 21, 1998’) THEN -

DATASET ‘CYBER.ALTJCL.CNTL’ENDJOB

In the above example, if today is February 21st, 1998, ESP submits PAYJOB5 fromCYBER.ALTJCL.CNTL.

Example 4 The following DATASET statement indicates an alternative JCL library for a jobwithin an Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB6

RUN DAILYIF DAYS_FROM(FEB 1,1998’) GE 0 AND -

DAYS_TO(‘FEB 22,1998’) GE 0 THEN -DATASET ‘CYBER.ALTJCL.CNTL’

ENDJOB

In the above example, ESP submits PAYJOB6 from CYBER.ALTJCL.CNTL, fromFebruary 1st, 1998 up to and including, February 22nd, 1998.

Page 135: ESP 5.2 Command Reference

135

DATEFORM Command

Overview The DATEFORM command is used to set the date format used in schedulestatements.

Type General command.

Authority OPER authority is required to issue the DATEFORM command.

Syntax The syntax of the DATEFORM command is:

DATEFORM [YMD|MDY|DMY]

Parameter DescriptionYMD Sets the date format to YY/MM/DD. This is the default.

MDY Sets the date format to MM/DD/YY.

DMY Sets the date format to DD/MM/YY.

Usage notes ESP recognizes the date format xx/xx/xx. The DATEFORM command instructs ESPhow to interpret this format. Only one of the date formats is valid at yourinstallation. This is normally specified in the ESP Initialization Parameters.

The DATEFORM command only affects dates in the format xx/xx/xx. You can stilluse terms like May 24, 1997 and 24MAY97 regardless of this setting.

Relatedinformation

For information on setting the date format used in schedule statements, see theDATEFORM Initialization Parameter in the ESP Workload Manager InstallationGuide.

For information on setting the date format used to customize the format of datefields when using ESP’s history reporting facility, see the ESP Workload ManagerUser’s Guide.

Example 1 The following DATEFORM example displays the current date:

DATEFORM

In the above example, the current date format setting is displayed.

Continued on next page

Page 136: ESP 5.2 Command Reference

136

DATEFORM Command, Continued

Example 2 The following DATEFORM command sets the date format:

DATEFORM MDY

In the above example, a schedule statement 05/24/97 is interpreted as May 24, 1997.

Page 137: ESP 5.2 Command Reference

137

DATEFORM Reporting Command

Overview The DATEFORM reporting command is used to customize the format of date fieldsdisplayed in an ESP history report.

Type Reporting command.

Syntax The syntax of the DATEFORM command is:

DATEFORM [YMD|MDY|DMY|JULIAN|YM]

Parameter DescriptionYMD Sets the date format to DAYYYYYMMDD.

• MON19980524MDY Sets the date format to DAYMMDDYY.

• MON052498DMY Sets the date format to DAYDDMMMYY. This is the default.

• MON24MAY98JULIAN Sets the date format to DAYDDDYY.

• MON14498YM Sets the date format to DAYYYYYMM.

• MON199805

Usage notes The DATEFORM command, used to set the date format used in schedulestatements, and the DATEFORM reporting command used to control the formattingof dates in history reports, are completely different in their context; they are twoseparate commands.

Relatedinformation

For information on history reporting, see the ESP Workload Manager User’s Guide.

For information on setting the date format used in schedule statements, see theDATEFORM command.

Continued on next page

Page 138: ESP 5.2 Command Reference

138

DATEFORM Reporting Command, Continued

Example 1 The following DATEFORM command formats the dates used in a history report:

REPORTHISTFILE HIST1FROM 8AM YESTERDAYCRITERIA APPLSYS EQ PAYROLLDATEFORM JULIANDISPLAY JOBNAME JOBNO CMPC EXECSDATE ENDDATEENDR

In the above example, all jobs in the PAYROLL Application are displayed using aJulian date format as follows:

JOBNAME JOB COMP START ENDNO CODE DATE DATE

PAYJOB1 1234 0 MON16497 MON16497PAYJOB2 1235 0 MON16497 MON16497PAYJOB3 1236 S0C1 MON16497 MON16497PAYJOB3 1378 0 TUE16597 TUE16597

Page 139: ESP 5.2 Command Reference

139

DEFAT Command

Overview The DEFAT command is used to define or alter an authorization table, limitingaccess to tracked job data. An authorization table provides a way to control accessto job tracking data. This command only applies if you are using ESP’s internalsecurity.

Type General command.

Authority SPECIAL authority is required to issue the DEFAT command.

Syntax The syntax of the DEFAT command is:

DEFAT tabnameINCLUDE(jobname,authstring[,jobname,authstring]...)[EXCLUDE(jobname,authstring[,jobname,authstring]...)[ADD|REPLACE]

Parameter Descriptiontabname Indicates the name of the authorization table in up to eight

alphanumeric characters.jobname Indicates a jobname, in up to eight characters, which you use

as the first half of a jobname/authstring pair. The jobnamecan contain asterisks or a hyphen for masking.

authstring Indicates a string of up to eight characters, which must matchone of the fields identified with a job. The fields are definedin the AUTHSTR Initialization Parameter. The authstringcan contain asterisks or a hyphen for masking. It forms thesecond half of the jobname/authstring pair.

ADD Indicates this is a new authorization table definition. Thedefinition fails if a definition with the same name alreadyexists. This is the default.

REPLACE Indicates an authorization table is being replaced. Thisparameter is necessary if an authorization table with the samename exists, and you want to change it.

Continued on next page

Page 140: ESP 5.2 Command Reference

140

DEFAT Command, Continued

Usage notes The authorization string may be any of the account number fields or a security userID, as decided by the installation. To access job-tracking information, the name ofthe tracked job and the account number or user ID related to the job must have anexact match in the authorization table assigned to the user requesting the trackingdata.

A user is associated with an authorization table via the DEFUSER command.

The INCLUDE section of the authorization table gives specific control over trackedjob information. It does this by listing jobname/authstring pairs (any number can bespecified in one DEFAT command). The user to whom an authorization table isassigned can access any of the jobs listed in the INCLUDE section of the table,provided the name and authstring of the job matches a jobname/authstring pair in thetable.

The EXCLUDE feature is useful when the INCLUDE section specifies a genericgroup of jobs by the use of asterisks or a hyphen. Specific jobs within such a groupcan be excluded with the EXCLUDE parameter.

If you want to edit or change the authorization table, use the DEFAT command withthe REPLACE parameter.

Relatedinformation

For information on defining or altering authorization tables, see ESP WorkloadManager Administrator’s Guide.

For information on associating an authorization table with a user, see the DEFUSERcommand.

For information on specifying one of jobs related fields used to identify theownership of a job, see the ESP Workload Manager Installation Reference Guide.

Example 1 The following DEFAT command defines an authorization table:

DEFAT AUTHTAB1 INCLUDE(JOB1,PROD,JOB2,PROD)

In the above example, the first jobname is JOB1, and the authorization string thatmakes up the pair is PROD. PROD represent the user ID for the job and theAUTHSTR Initialization Parameter has been set to RACUSER. JOB2 is paired withthe same authstring. JOB1 and JOB2 using account PROD are, therefore, accessibleto users who have the authorization table AUTHTAB1 assigned to them.

Continued on next page

Page 141: ESP 5.2 Command Reference

141

DEFAT Command, Continued

Example 2 The following DEFAT command defines an authorization table:

DEFAT AUTHTAB2 INCLUDE(ABC-,AC0-,XYZ-,AC0-) EXCLUDE(-,AC02)

In the above example, the authorization string is the first account number as definedby the AUTHSTR Initialization Parameter. Any jobname beginning with the threecharacters ABC or XYZ, with an account number that begins with AC0, excludingAC02.

Example 3 The following DEFAT command defines an authorization table:

DEFAT AUTHTAB3 INCLUDE(JOB1,AC02,JOB2,ACO2)

The following table shows whether a user whose authorization table is AUTHTAB3is allowed access to various jobname/account combinations.

Jobname Account AccessJOB1 AC02 ALLOWEDJOB2 AC02 ALLOWEDJOB1 ACO2A DISALLOWED

Page 142: ESP 5.2 Command Reference

142

DEFAULT Command

Overview The DEFAULT command is used to define default values for use on job card JCLsubmitted by ESP. This command can be used only if you are using ESP’s internalsecurity.

Type General command.

Syntax The syntax of the DEFAULT command is:

{DEFAULT|DEFLT} {[USER{(userid|NONE)}]}{[GROUP{(racfgroupid|(NONE)}]}{[PASSWORD{(password)|(NONE)}]}

Parameter Descriptionuserid Indicates the user ID you want ESP to place as an operand of

the USER keyword on the job card for JCL submitted byESP.

racfgroupid Indicates the group name you want ESP to place as anoperand of the GROUP keyword on the job card for JCLsubmitted by ESP.

password Indicates the password you want ESP to place as an operandof the PASSWORD keyword on the job card for JCLsubmitted by ESP.

NONE Use this if you want to nullify a previous setting. Thecorresponding operand on the job card is left unmodified.

Usage notes The DEFAULT command is not commonly used as the use of USER andPASSWORD on job cards is not very common.

The DEFAULT command provides the ability to set defaults for jobs submitted byESP. If any of these parameters is already specified on a job card, it is notoverridden.

Relatedinformation

For information on the user ID used for job submission, see the ESP WorkloadManager Administrator’s Guide.

Continued on next page

Page 143: ESP 5.2 Command Reference

143

DEFAULT Command, Continued

Example 1 The following DEFAULT command defines default values for job cards of jobssubmitted by ESP:

DEFAULT USER(RACUSER1) GROUP(PAYROLL) PASSWORD(MYSECRET)

In the above example, the default user ID is RACUSER1, the default group isPAYROLL, and the default password is MYSECRET, on the job card for submittedJCL.

Page 144: ESP 5.2 Command Reference

144

DEFCAL Command

Overview The DEFCAL command is used to define an ESP calendar. Use calendars to definescheduling terms that satisfy specific processing situations.

Type General command.

Authority SPECIAL or CALENDARDEF authority is required in a non-SAF environment toissue the DEFCAL command. With SAF, you control access to calendars using theCALENDAR.calname resource.

Syntax The syntax of the DEFCAL command is:

{DEFCAL|DEFC} calname[OWNER(string)][DEPARTMENT(deptid)][LOGICAL|ABSOLUTE][SHIFT(hh:mm)][WEEKSTART(day)][WORKDAYS(workday[,workday]...)]

Parameter Descriptioncalname Indicates the name of the calendar. Can be up to eight

alphanumeric or national characters ($, #, @). The firstcharacter must be alphabetic.

string Indicates a user/group in up to eight characters. It maycontain asterisks and may also have a hyphen in the lastcharacter position. This controls who can alter or delete thecalendar. It doesn’t control who can define holidays andspecial days for the calendar. This applies only if you areusing ESP’s internal security.

deptid Indicates a department name of up to eight characters towhich this calendar belongs. It may contain asterisks andmay also have a hyphen in the last character position. Thisapplies only if you are using ESP’s internal security.

LOGICAL/ABSOLUTE

Indicates a logical calendar or an absolute calendar. Thedefault is ABSOLUTE (i.e. days begin at midnight).

Note: Absolute calendars are recommended.hh:mm Indicates the start time of a logical day. If specified, your

logical day is shifted forward by the specified time.day Indicates the first day of the week. This overrides the default

specified in the ESP Initialization Parameters.workday Indicates which days are to be considered workdays.

Separate each with a comma. This overrides the defaultspecified in the ESP Initialization Parameters.

Continued on next page

Page 145: ESP 5.2 Command Reference

145

DEFCAL Command, Continued

Usage notes When ESP is installed, a calendar called SYSTEM is defined. All Events have readaccess to the SYSTEM calendar.

Note: The SYSTEM calendar should contain only those scheduling entries that allESP users need.

Once a calendar is defined, users that have access can define holidays, special daysand special period entries to be placed in it.

You can also define a calendar using ESP’s ISPF interface - Option M from the ESPMain Menu.

Relatedinformation

For information on defining calendars, see the ESP Workload ManagerAdministrator’s Guide.

For information on using special calendars in an Event, see the ESP WorkloadManager User’s Guide.

For information on using calendars, see the ESP Workload Manager User’s Guide.

For information on defining and deleting holidays, see the DEFHOL and DELHOLcommands.

For information on defining and deleting special days, see the DEFSPEC andDELSPEC commands.

For information on altering the attributes of a calendar, see the ALTCAL command.

For information on displaying information about calendars, see the LISTCALcommand.

For information on assigning default calendars to users in a SAF environment, seethe ESP Workload Manager Administrator’s Guide.

For information on assigning default calendars to users in a non-SAF environment,see the DEFUSER and DEFGROUP commands.

Example 1 The following DEFCAL command defines the system calendar:

DEFCAL SYSTEM

In the above example, the system calendar is defined. The first day of the week, andthe workdays are determined by the ESP Initialization Parameters.

Example 2 The following DEFCAL command defines a calendar:

DEFCAL CAL1 OWNER(CYBER) WEEKSTART(SUN) -WORKDAYS(MON,TUE,WED,THU,FRI)

In the above example, CAL1 is defined. The first day of the week is Sunday andworkdays are Monday through Friday, inclusive.

Continued on next page

Page 146: ESP 5.2 Command Reference

146

DEFCAL Command, Continued

Example 3 The following is an example of defining a calendar using ESP’s ISPF interface:

ESP -------------------------- DEFINE A CALENDAR ------------------------- ESPCOMMAND ===>

NAME OF CALENDAR ===> FISCALOWNER ===>DEPARTMENT ===>

LOGICAL DAY START ===> (Hours and Minutes, e.g. 08:01)DEFAULT ===> (Enter L for logical, A for absolute)

WORKDAYS: SUNDAY ===> (Enter Y against each day that isMONDAY ===> Y to be eligible as a workday. Leave allTUESDAY ===> Y blank to pick up installation default)

WEDNESDAY ===> YTHURSDAY ===> YFRIDAY ===> Y

SATURDAY ===>

FIRST DAY OF WEEK ===> MON (SUN, MON etc. Blank for installation default)

ANY MORE? ===> (Enter Y to define more calendars)

In the above example, a calendar called FISCAL is defined. The first day of theweek is Monday and workdays are Monday through Friday, inclusive.

Page 147: ESP 5.2 Command Reference

147

DEFGROUP Command

Overview The DEFGROUP command is used to define a group to ESP. Defining a group andconnecting users to it allows you to manage and control access to and use of ESP ata group level. This command only applies if you are using ESP’s internal security.

Type General command.

Authority SPECIAL or GROUPDEF authority is required to issue the DEFGROUP command.

Syntax The syntax of the DEFGROUP command is:

{DEFGROUP|DEFG} groupnameEVENT(eventdsid)[DEPARTMENT(deptid)][AUTH(OPER)][UREAD][RACID][CALENDAR(cal1[,cal2]...)]

Parameter Descriptiongroupname Indicates a one to eight character group name.eventdsid Indicates in up to eight characters the logical identifier of the

Event database used to store Events prefixed with the groupname defined.

deptid Indicates a department name of up to eight characters towhich this group belongs. It may contain asterisks and mayalso have a hyphen in the last character position.

OPER Indicates Events having this group name as a prefix cancontain operator commands.

UREAD Indicates universal read access is available for any Eventdefined using this group prefix.

RACID Indicates the group name should be used for securityattributes when ESP processes an Event rather than the ID ofthe defining user.

cal1 Indicates the name of the first default calendar for Events thatstart with the group prefix, up to eight characters.

cal2 Indicates the name of the second default calendar, up to eightcharacters.

Continued on next page

Page 148: ESP 5.2 Command Reference

148

DEFGROUP Command, Continued

Usage notes The default calendars are used by Events that have no explicit calendarspecification. They are searched in the order specified. All Events automaticallyhave access to the SYSTEM calendar, which is searched after the default calendars.

A user with an authority attribute of ANY has access to any Group. Such a user doesnot need to be connected to any Group.

ESP controls access to Events by the high level prefix under which the Event isstored. If a user saves an Event using an ESP user ID as the high level prefix, onlythat user and users with ‘ANY ’ authority can access the Event. When any memberof a group saves an Event using the ESP group name as the high level prefix, anymember of that group and users with ‘ANY’ authority have access to the Event.

You can also define and list a group using ESP’s ISPF interface - Option M from theESP Main Menu.

Relatedinformation

For information on defining groups, see the ESP Workload Manager Administrator’sGuide.

For information on defining and deleting users, see the DEFUSER/DELUSERcommands.

For information on deleting groups, see the DELGROUP command.

For information on displaying information about a group, see the LISTGRPcommand.

For information on altering a group definition, see the ALTGROUP command.

For information on connecting and disconnecting users to and from groups, see theCONNECT and DISCONN commands.

Example 1 The following DEFGROUP command defines an ESP group and assigns an Eventdata set:

DEFGROUP PROD EVENTSET(EVENT1) RACID

In the above example, a group called PROD is defined and Event data set EVENT1is assigned to the group. Events are processed under the groupname.

Example 2 The following DEFGROUP command defines an ESP group, assigns an Event dataset and a default calendar:

DEFGROUP PAYGRP EVENTSET(EVENT2) CALENDAR(FISCAL)

In the above example, a group called PAYGRP is defined and Event data setEVENT2 is assigned to the group. PAYGRP’s default calendar is FISCAL.

Continued on next page

Page 149: ESP 5.2 Command Reference

149

DEFGROUP Command, Continued

Example 3 The following DEFGROUP command assigns a department to a group:

DEFGROUP SCHED EVENTSET(EVENT1) DEPARTMENT(PRODSUPP)AUTH(OPER)

In the above example, SCHED is defined as part of the PRODSUPP department.SCHED has the authority to issue ESP operator commands.

Page 150: ESP 5.2 Command Reference

150

DEFHOL Command

Overview The DEFHOL command is used to define a holiday.

Type General command.

Authority You can define holidays only in the calendar defined as your first default calendar,or in calendars to which you have access. If you do not have any default calendarsdefined, the holiday is automatically stored in the SYSTEM calendar.

Syntax The syntax of the DEFHOL command is:

{DEFHOL|DEFH} holidaynameSTART(starttime)END(endtime)|FOR(duration)[RETAIN{(2,days)|(x,units)}][CALENDAR(calname)]

Parameter Descriptionholidayname Indicates the name of a holiday. Can be up to 16

alphanumeric or national characters ($, #, @). The underscorecharacter can also be used.

starttime Indicates the starting time and date of the holiday. If the datespecification contains separators, it should be enclosed inquotes. You have the option to specify UNTIL followed by atime and date specification, which tells ESP when the holidayends. If you use UNTIL, you must enclose the entirespecification in quotes.

endtime Indicates the time and date the holiday ends. It is mutuallyexclusive with the FOR parameter, and with UNTIL orENDING in the START parameter. Specifying acombination of these terms produces unpredictable results.

duration Indicates the length of the holiday in hours.x,units Indicates the number of days, weeks or years after each

occurrence of the holiday that you want to remain on thesystem for reference. The default is two days. If you specifya number but no units, this value automatically defaults todays. This determines how long you can refer back to aholiday after it occurs.

calname Indicates the name of the calendar in which the holiday is tobe defined, otherwise user ID defaults are used.

Continued on next page

Page 151: ESP 5.2 Command Reference

151

DEFHOL Command, Continued

Usage notes The time duration for a holiday is 24 hours, unless you specify otherwise. You candefine multiple holidays with the same name, but you must define each oneseparately. As an alternative to defining two back-to-back 24 hour holidaysindividually, you can define one holiday with a duration of 48 hours.

In an Event definition, you can schedule based on holidays or use an ON commandsuch as ‘on holiday’. This allows you to bypass, delay or advance the schedule if itnormally falls on a holiday or a particular day of the week.

You can also define and list a holiday using ESP’s ISPF interface - Option L fromthe ESP Main Menu.

ESP deletes a holiday after its retain count expires. It does this whenever an updateis made to the calendar containing the holiday.

For logical day processing, holidays should be defined in ABSOLUTE terms even ifstored in a LOGICAL calendar.

Relatedinformation

For information on specifying holiday names in schedule criteria, see the ESPWorkload Manager User’s Guide.

For information on deleting holidays, see the DELHOL command.

For information on defining and deleting special days and periods, see theDEFSPEC and DELSPEC commands.

For information on displaying holiday information, see the LISTHOL command.

For information on advancing, delaying, or ignoring Event processing, see the ONcommand.

For information on displaying information about a calendar, see the LISTCALcommand.

Example 1 The following DEFHOL commands define a holiday for three years:

DEFHOL CHRISTMAS START(‘25 DECEMBER 1998’) FOR(24)DEFHOL CHRISTMAS START(‘25 DECEMBER 1989’) FOR(24)DEFHOL CHRISTMAS START(‘25 DECEMBER 2000’) FOR(24)

In the above example, multiple holidays with the same name - CHRISTMAS aredefined as 24 hour holidays in three successive years.

Continued on next page

Page 152: ESP 5.2 Command Reference

152

DEFHOL Command, Continued

Example 2 The following DEFHOL command defines a holiday with a specific start and endusing UNTIL with the START keyword to define the end time for a holiday. Notethe use of quotes:

DEFHOL NEW_YEARS START(‘31ST DEC UNTIL 2ND JAN’)

In the above example, NEW_YEARS is defined to start on December 31st untilJanuary 2nd at 00:00.

Example 3 The following DEFHOL command defines a holiday in a specific calendar:

DEFHOL DAYOFF START(‘4PM JAN 5, 1998’) -END(‘4PM JAN 6, 1998’) RETAIN(6,MONTHS) CALENDAR(MYCAL)

In the above example, DAYOFF is defined to start on January 5th, 1998 at 4 pmending January 6th, 1998 at 4 pm. The definition of DAYOFF resides on MYCALfor 6 months after it occurs.

Note You should not need to use logical calendars. Logical calendars can causeunanticipated results. Cybermation recommends you use absolute calendars becauseof their ease of use, and because they can handle almost all scheduling requirements.

Page 153: ESP 5.2 Command Reference

153

DEFPN Command

Overview The DEFPN command is used to define a processing node (P-Node) to ESP, andwhich users or consoles are allowed to perform a POST to it. ESP tracks jobsthrough some P-Nodes automatically. After a job passes through the output phase,you can identify additional (manual) P-Nodes for the job. These processing phasesmay include bursting of output, distribution and so on.

Type General command.

Authority SCHEDULER authority is required in a non-SAF environment to issue the DEFPNcommand. With SAF, you control the ability to use P-Nodes using thePNODE.pnodename resource.

Syntax The syntax of the DEFPN command is:

DEFPN name[USERS(id[,id]...)][ADD|REPLACE][SEQUENCE(seqno)][OWNER(ownerid)]

Parameter Descriptionname Indicates the name of the P-Node, in up to 16 characters.id Indicates the ID(s) of the users or system consoles that can

post a job out of this P-Node. The ID strings can containasterisks or a hyphen for masking. Console Ids are in theform SYSCONnn, where nn is the console UCMID. Thisapplies only if you are using ESP’s internal security.

ADD Indicates this is a new definition. The request fails if adefinition with the same name already exists. ADD is thedefault.

REPLACE Replaces a current P-Node definition of same name.seqno Indicates the relative sequence number used when displaying

queues. When a DQ or DN command is used, the P-Nodequeues are displayed according to their sequence numbers.The sequence numbers can be in the range 0 to 255.

ownerid Specifies the name of the user(s) who can alter or delete thisP-Node definition. The owner ID can contain asterisks or ahyphen for masking. This applies only if you are using ESP’sinternal security.

Continued on next page

Page 154: ESP 5.2 Command Reference

154

DEFPN Command, Continued

Usage notes At installation time, the INPUT, EXEC and OUTPUT P-Nodes are defined. ESPtracks jobs through these P-Nodes automatically.

A job does not need to complete a manual P-Node for a successor job to run. If youneed to set up job dependencies with a manual phase of a job, consider using tasksin an ESP Application.

Once you have defined the P-Node name, authorized users can type the POSTcommand to post a job as having completed processing at a specific P-Node.

Relatedinformation

For information on defining processing nodes (P-Nodes), see the ESP WorkloadManager Advanced User’s Guide.

For information on deleting manual P-Nodes, see the DELPN command.

For information on displaying P-Node information, see the LISTPN command.

For information on posting a job complete from a manual P-Node, see the POSTcommand.

For information on specifying the name of a P-Node through which a job has to passbefore it can be marked complete, see the PNODES statement.

Example 1 The following DEFPN commands define automatic P-Nodes that ESP uses to trackjobs:

DEFPN INPUTDEFPN EXECDEFPN OUTPUT

In the above example, P-Nodes that ESP uses to track jobs are defined. ESPautomatically assigns sequence numbers.

Example 2 The following DEFPN command defines a P-Node and identifies which users canpost a job from which consoles:

DEFPN BURSTER USERS(SYSCON02,SYSCON01,PROD-) SEQ(150) -OWNER(SCH-)

In the above example, BURSTER is defined. System consoles 1 and 2 and userswith IDs beginning with PROD can post a job from this P-Node. When the queue isdisplayed, the relative sequence number for this P-Node is 150. Only users with IDsbeginning with SCH can alter or delete this entry.

Continued on next page

Page 155: ESP 5.2 Command Reference

155

DEFPN Command, Continued

Example 3 The following DEFPN command defines or replaces a P-Node to represent thedistribution of output:

DEFPN DISTRIB USERS(SYSCON03,SCH-) REPLACE

In the above example, ESP user beginning with SCH can issue the POST commandfrom system console 03.

Once a P-Node is defined (above), you can use that P-Node as a job requirement asfollows:

JOB PAYJOB1PNODES DISTRIBRUN DAILY

ENDJOB

To post PAYJOB1 complete from the DISTRIB P-Node, authorized users can issuethe following POST command:

POST PAYJOB1 PNODE(DISTRIB)

Page 156: ESP 5.2 Command Reference

156

DEFPRINT Command - DATASET Option

Overview The DEFPRINT command defines a logical report name to which output is directed.It defines the characteristics of an auxiliary output device and associates the logicalreport name to it. Output can be directed to a sysout class, data set, or DD file.

Type General command.

Syntax The syntax of the DEFPRINT data set option command is:

DEFPRINT repnameDATASET(dsname)[VOLUME(serial)][UNIT(unitname)][SPACE(primary,[secondary])TRACKS|BLOCKS|CYLINDERS][EXTEND][LRECL(length)][RECFM{(V)|(F)}][PAGELENGTH(lines)][BLOCK(size)][BLKSIZE(block)]

Parameter Descriptionrepname Indicates a one to eight character alphanumeric logical report

name.dsname Identifies the data set name to which the output is diverted.

You should include a member name if you are divertingoutput to a PDS.

serial Identifies the volume serial number (up to six characters) forthe data set if you are specifying a new data set, or if you areusing an existing data set that is not catalogued.

unitname Indicates the name of the output device type, using up to eightcharacters.

primary Indicates the primary allocation you want to assign, inparentheses. You must specify after this whether you areallocating CYLINDERS, TRACKS or BLOCKS.

secondary Indicates the secondary allocation you want to assign, inparentheses. If you use this parameter, you must use theappropriate keyword to specify whether you allocateCYLINDERS, TRACKS or BLOCKS. If you are specifyingprimary and secondary allocation, specify one of thesekeywords after the secondary allocation specified. Do not useparentheses.

EXTEND Indicates the output should be added to the end of the dataset. If you do not specify EXTEND, the data set isoverwritten.

Continued on next page

Page 157: ESP 5.2 Command Reference

157

DEFPRINT Command - DATASET Option, Continued

Syntax (continued)

Parameter Descriptionlength Indicates the logical record length for each line of output.

Specify the number of characters you want in each line.V Indicates variable length records. This is the default. The

line length is four bytes less than what you specified under‘LRECL’.

F Indicates fixed length records.lines Indicates the number of lines on each page, including titles

and footings.size Indicates the size in bytes of a block allocation unit.block Indicates the actual length of blocks on a data set. The limit

is 32767 bytes.

Usage notes You must use the ENDPRINT command to close each data file you opened withDEFPRINT.

Relatedinformation

For information on ending a report print definition, see the ENDPRINT command.

For information on directing output to a file, see the DEFPRINT command - FileOption.

For information on directing output to a sysout class, see the DEFPRINT command -SYSOUT Option.

For information on requesting that a data type printout be directed to a data set,sysout class or DD file from Page mode, see the HARDCOPY command.

For information on setting the default output environment for TITLE processing, seethe SETPRINT command.

For information on defining a title to be displayed at the top of the next andsubsequent pages of printed data, see the TITLE command.

Example 1 The following DEFPRINT command defines a logical report name:

DEFPRINT CYBRPT1 DATASET(‘ESP.MODEL.REPORT1’)

In the above example, CYBRPT1 is associated with a preallocated data set. Outputis directed to ESP.MODEL.REPORT1.

Continued on next page

Page 158: ESP 5.2 Command Reference

158

DEFPRINT Command - DATASET Option, Continued

Example 2 The following DEFPRINT command dynamically allocates a data set:

DEFPRINT CYBRPT2 DATASET(‘ESP.MODEL.REPORT2’) -SPACE(2,1) TRACKS VOLUME(CYB001) -LRECL(150) RECFM(FBA) BLKSIZE(15000)

In the above example, ESP.MODEL.REPORT2 is dynamically allocated andassigned a logical identifier of CYBRPT2. Output is directed toESP.MODEL.REPORT2.

Page 159: ESP 5.2 Command Reference

159

DEFPRINT Command - FILE Option

Overview The DEFPRINT command defines a logical report name to which output is directed.It defines the characteristics of an auxiliary output device and associates the logicalreport name to it. Output can be directed to a sysout class, data set, or DD file.

Type General command.

Syntax The syntax of the DEFPRINT command is:

DEFPRINT repnameDDNAME(file)[EXTEND][LRECL(length)][RECFM{(V)|(F)}][PAGELENGTH(lines)][BLOCK(size)][BLKSIZE(block)]

Parameter Descriptionrepname Indicates a one to eight character alphanumeric logical report

name.file Indicates the data set name to which the output is diverted.

You should include a member name if you are divertingoutput to a PDS.

serial Indicates the volume serial number (up to six characters) forthe data set if you are specifying a new data set, or if you areusing an existing data set that is not catalogued.

unitname Indicates the name of the output device type, using up to eightcharacters.

primary Indicates the primary allocation you want to assign, inparentheses. You must specify after this whether you areallocating CYLINDERS, TRACKS or BLOCKS.

secondary Indicates the secondary allocation you want to assign, inparentheses. If you use this parameter, you must use theappropriate keyword to specify whether you allocateCYLINDERS, TRACKS or BLOCKS. If you are specifyingprimary and secondary allocation, specify one of thesekeywords after the secondary allocation specified. Do not useparentheses.

EXTEND Indicates the output should be added to the end of the dataset. If you do not specify EXTEND, the data set isoverwritten.

length Indicates the logical record length for each line of output.Specify the number of characters you want in each line.

V Indicates variable length records. This is the default. The linelength is four bytes less than what you specified under‘LRECL’.

Continued on next page

Page 160: ESP 5.2 Command Reference

160

DEFPRINT Command - FILE Option, Continued

Syntax (continued)

Parameter DescriptionF Indicates fixed length records.lines Indicates the number of lines on each page, including titles

and footings.size Indicates the size in bytes of a block allocation unit.block Indicates the actual length of blocks on a data set. The limit

is 32767 bytes.

Usage notes You must use the ENDPRINT command to close each data file you opened withDEFPRINT.

Relatedinformation

For information on ending a report print definition, see the ENDPRINT command.

For information on directing output to a data set, see the DEFPRINT command -DATASET Option.

For information on directing output to a sysout class, see the DEFPRINT command -SYSOUT Option.

For information on requesting that a data type printout be directed to a data set,sysout class or DD file from Page mode, see the HARDCOPY command.

For information on setting the default output environment for TITLE processing, seethe SETPRINT command.

For information on defining a title to be displayed at the top of the next andsubsequent pages of printed data, see the TITLE command.

Example 1 The following DEFPRINT command defines a logical report name:

DEFPRINT JR1RPT DDNAME(RPTDD1) LRECL(133) RECFM(F)

In the above example, output for report JR1RPT is routed to a file. The logicalrecord length for each line of output written to RPTDD1 should be 133, in fixedlength records.

Page 161: ESP 5.2 Command Reference

161

DEFPRINT Command - SYSOUT Option

Overview The DEFPRINT command defines a logical report name to which output is directed.It defines the characteristics of an auxiliary output device and associates the logicalreport name to it. Output can be directed to a sysout class, data set, or DD file.

Type General command.

Syntax The syntax of the DEFPRINT command is:

DEFPRINT repnameSYSOUT(class)[DEST(destcode)][COPIES(n)][FORM(type)][LRECL(length)][RECFM{(V)|(F)}][PAGELENGTH(lines)][UCS(char)][SPIN]

Parameter Descriptionrepname Indicates a one to eight alphanumeric logical report name.class Indicates a one-character class number.destcode Indicates a destination code of up to eight characters. If you

do not specify ‘DEST’, the destination defaults to ‘LOCAL’.n Indicates the number of copies you want printed. The

maximum is 240 copies.type Indicates the type of form you want to use for printing, using

up to four characters.length Indicates the logical record length for each line of output.

Specify the number of characters you want in each line.V Indicates variable length records. This is the default. The

line length is four bytes less than what you have specifiedunder ‘LRECL’.

F Indicates fixed length records.lines Indicates the number of lines on each page, including titles

and footings.char Indicates the universal character set type you want to be used

on the printer for this printout.SPIN Indicates the data should be made available for printing as

soon as you enter the ENDPRINT command.

Usage notes You must use the ENDPRINT command to close each data file you opened withDEFPRINT.

Continued on next page

Page 162: ESP 5.2 Command Reference

162

DEFPRINT Command - SYSOUT Option, Continued

Relatedinformation

For information on ending a report print definition, see the ENDPRINT command.

For information on directing output to a file, see the DEFPRINT command - FileOption.

For information on directing output to a data set, see the DEFPRINT command -DATASET Option.

For information on requesting that a data type printout be directed to a data set,sysout class or DD file from Page mode, see the HARDCOPY command.

For information on setting the default output environment for TITLE processing, seethe SETPRINT command.

For information on defining a title to be displayed at the top of the next andsubsequent pages of printed data, see the TITLE command.

Example 1 The following DEFPRINT command defines a logical report name:

DEFPRINT DEPT123 SYSOUT(J)

In the above example, output for report DEPT123 is directed to a sysout class of J.

Page 163: ESP 5.2 Command Reference

163

DEFPRIO Command

Overview The DEFPRIO command is used to assign a default priority to all jobs with nopriority specified in their JCL for the purposes of modeling. Priorities can rangefrom 1 to 15, with 15 being the highest.

Type MODEL command.

Syntax The syntax of the DEFPRIO command is:

DEFPRIO nn

Parameter Descriptionnn Indicates a default priority in the range 1-15. The highest

priority is 15. If not specified, the default is 3.

Usage notes Use the DEFPRIO command to assign a default selection priority to all jobs withoutone. This is normally the default job priority defined on your system.

Within a job class, the model processor selects jobs for execution in order ofpriority. A job with a higher priority is selected for execution sooner; jobs with thesame priority are selected on a first-in first-out basis.

This command only applies to modeling. It does not affect actual job execution.

Relatedinformation

For information on ESP’s modeling feature, see Advanced Forecasting in the ESPWorkload Manager Advanced User’s Guide.

Example 1 The following DEFPRIO command sets a default priority:

DEFPRIO 12

In the above example, a default priority of 12 is set for all jobs whose JCL does notalready contain a priority statement.

Page 164: ESP 5.2 Command Reference

164

DEFSIG Command

Overview The DEFSIG command is used to define a signal. A signal can represent a manualtask, such as the arrival of a tape, or an automated task, such as the successfulcompletion of a job. Signals are commonly used with DJC/JES3 networks, which donot offer the flexibility of Applications.

Type General command.

Syntax The syntax of the DEFSIG command is:

DEFSIG signalname[GEN(genno)]

Parameter Descriptionsignalname Indicates the name of the signal. A signal has a two-part

name consisting of a prefix which is a group name (or userID), followed by a description of up to 16 characters. Ifprefix is not specified, the current group prefix is used.

genno Indicates the number of generations of a signal to be stored.The default, if not specified, is 1.

Usage notes Signals cause an ESP Event to wait for a condition in addition to its schedule criteriabefore it executes. A signal may represent a manual task, such as the arrival of aninput tape, or an automated task, such as the completion of a job.

Signals are available only at the Event level. If you are using an Application andneed to set up conditions at the job level for jobs in the Application, the best methodis through tasks.

Relatedinformation

For information on signal processing, see the ESP Workload Manager AdvancedUser’s Guide.

For information on cycling a signal, see the SIGCYCLE command.

For information on posting a generation of a signal, see the SIGPOST command.

For information on identifying that signal must be marked complete beforeexecution of the Event, see the SIGWAIT command.

For information on altering the numbers of generations of a signal, see the ALTSIGcommand.

For information on displaying all generation of a signal, see the LISTSIG command.

For information on setting up job level conditions in Applications, see the ESPWorkload Manager User’s Guide.

Continued on next page

Page 165: ESP 5.2 Command Reference

165

DEFSIG Command, Continued

Example 1 The following DEFSIG command defines a signal:

DEFSIG CYBER.DAILY_SIGNAL1 GEN(7)

In the above example, CYBER.DAILY_SIGNAL1 is defined with 7 generations tobe stored.

Example 2 The following DEFSIG command defines a signal:

DEFSIG SIGNAL2 GEN(5)

In the above example, SIGNAL2 is defined using the current group/user prefix withfive generations to be stored. If the current group prefix is TX5312, the signal nameis TX5312.SIGNAL2.

Page 166: ESP 5.2 Command Reference

166

DEFSPEC Command

Overview The DEFSPEC command is used to define a special day or period.

Type General command.

Authority You can only define special days in the calendar defined as your first defaultcalendar, or in calendars to which you have access. If you do not have any defaultcalendars defined, the special day is stored automatically in the SYSTEM calendar.

Syntax The syntax of the DEFSPEC command is:

DEFSPEC specnameON(date)|REPEAT(‘schedule’)[CALENDAR(calname)][USING(cal1[,cal2]...)][RETAIN(x,units)]

Parameter Descriptionspecname Indicates a name for the special day you are defining, using

up to 16 characters. The name may include the underscore,numerics, and national characters. Blanks are not allowed.

date Indicates the date and time on which the special day occurs,or specifies the beginning date and time of a single specialperiod. You must specify at least two special periods of thesame name so that ESP knows when the first period ends. Ifthe date specification contains separators, it must be enclosedin quotes. ON is mutually exclusive with the REPEATparameter.

schedule Use this parameter when specifying multiple special days orregular periods with the same name. It allows you to specifymore occurrences of an existing special day or perioddefinition without having to completely redefine them.Specify a valid schedule criteria, that defines when thespecial day or period should repeat itself (such as ‘every 15thworkday at 9 am’, ‘6 times’, ‘until 15th June’). If you useseparators, enclose the statement in quotes. REPEAT ismutually exclusive with the ON parameter.

calname Indicates the calendar in which the special day or period is tobe defined. This is the TARGET calendar on the ISPF panel.

cal1, cal2 Indicates up to two calendar names. The USING parameter isused if you refer to a special day or period in the REPEATparameter. The calendars you specify with USING tell ESPwhere to find the special day or period definitions to whichyou are referring. This is the SOURCE calendar on the ISPFpanel.

Continued on next page

Page 167: ESP 5.2 Command Reference

167

DEFSPEC Command, Continued

Syntax (continued)

Parameter Descriptionx, units Indicates the number of days, weeks or years after each

occurrence of the special day or period that you want it toremain on the system for reference. The default is two days.If you specify a number but no units, this value automaticallydefaults to days.

Usage notes If you define 2 special days with the same name, ESP treats the time between themas a special period.

You cannot use ON and REPEAT together. You must, however, use one of thesetwo options after specifying the required special day/period name.

If you use the REPEAT parameter without using the n TIMES parameter, andwithout specifying either an UNTIL or ENDING date, ESP uses one year as adefault. You can only use the n TIMES parameter if you use REPEAT.

Use the RETAIN parameter to ensure that a special day definition remains on thesystem for more than the default of two days after the special day (or first day of aspecial period) has passed. For example, you probably want to ensure that any fiscalmonth definition remains on the system for at least one year, so you can refer to the‘9TH FISCAL_MONTH OF FISCAL_YEAR’. Specify ‘RETAIN(1,YEAR)’ or‘RETAIN(365)’ (if units are omitted, this defaults to days). If all payroll days needto be referred to for at least six months after they pass, you would specify:‘RETAIN(6,MONTHS)’. ESP deletes a special day after the retain count expires. Itdoes this whenever an update is made to the calendar containing the special day.

You can also define and list special days and periods using ESP’s ISPF interface -Option L from the ESP main menu.

Relatedinformation

For information on specifying special days or periods in schedule criteria, see theESP Workload Manager User’s Guide.

For information on deleting special days or periods, see the DELSPEC command.

For information on defining and deleting holidays, see the DEFHOL and DELHOLcommands.

For information on displaying special day and period information, see theLISTSPEC command.

For information on displaying information about a calendar, see the LISTCALcommand.

Continued on next page

Page 168: ESP 5.2 Command Reference

168

DEFSPEC Command, Continued

Example 1 The following DEFSPEC command defines a special day:

DEFSPEC YEAR_END ON(‘LAST WORKDAY OF AUG’) USING(CAL1) -CALENDAR(CAL2)

In the above example, YEAR_END is defined as the last workday of August of thecurrent year, in the CAL2 calendar. CAL1 is used as a reference for workdays.

Example 2 The following DEFSPEC command defines multiple special days:

DEFSPEC PAYROLL_DAY -REPEAT(‘THU EVERY 2 WEEKS UNTIL JAN3,1998’) -RETAIN(365)

In the above example, PAYROLL_DAY is defined and occurs every two weeks onThursdays. The special day definition is to remain on the system for one year.

Example 3 The following DEFSPEC command defines multiple special periods:

DEFSPEC SESSION REPEAT(‘39 TIMES EVERY 4 WEEKS STARTING -1ST JAN’) RETAIN(1 YEAR)

In the above example, 39 special periods called SESSION, which occur regularly,are defined every four weeks starting on 1st January. The special period definition isto remain on the system for 1 year.

Example 4 The following DEFSPEC command defines multiple special days:

DEFSPEC FISCAL_YEAR REPEAT (‘1MAY YEARLY UNTIL 30APR2001’) -CAL(ACCT1) RETAIN(2 YEARS)

In the above example, fiscal years starting May 1st are defined up to the year 2001 inthe calendar ACCT1. Each fiscal year is retained on the system for two calendaryears.

Page 169: ESP 5.2 Command Reference

169

DEFSYML Command

Overview The DEFSYML command is used to define or alter a symbol library. This allowsESP to reference a collection of data sets using a logical identifier.

Type General command.

Authority SPECIAL, SCHEDULER or CALENDARDEF authority is required to issue theDEFSYML command in non-SAF environments. With SAF, you control access tosymbol libraries using the SYMLIB.symname resource.

Syntax The syntax of the DEFSYML command is:

DEFSYML name[DATASET(dsn[,dsn]...)][USERS(user[,user]...)][ADD|REPLACE]

Parameter Descriptionname Indicates the name of the symbol library. It can consist of up

to eight alphanumeric characters, the first of which must bealphabetic.

dsn Indicates one or more data sets to be scanned when thesymbol library set is referenced by an Event. The namesshould be the valid names of data sets. If a data set is a PDS,then each member containing symbols must be specified.Separate each with a blank or comma.

user Indicates one or more user or group prefixes or masks, torestrict access to the symbol library sets. Asterisks and ahyphen can be used for generic masks. If no user IDs arespecified, access to the symbol library set is not restricted.This applies only if you are not using SAF.

ADD Indicates this is a new definition, and is not to replace anexisting entry, if there is one. This is the default.

REPLACE Indicates this definition replaces an existing one.

Continued on next page

Page 170: ESP 5.2 Command Reference

170

DEFSYML Command, Continued

Usage notes To use a symbol library, use the SYMLIB command in an Event definition.

Users can define their own variables and use built–in symbolic variables in JCL,command input, and in job definitions. A user can define and work with symbolicvariables in either a symbolic variable library or an ESP Procedure.

When symbolic variable libraries are used to store user defined symbolic variables,the ability to use ESP’s IF-THEN-ELSE language construct is lost.

If you want to use IF-THEN-ELSE type statements in combination with user definedsymbolic variables, you need to store those definitions in a member of a PDS andinvoke that member from your Event or ESP Procedure.

If you need to alter a symbol library definition, use the DEFSYML command withthe replace option.

Relatedinformation

For information on setting symbol libraries, see the ESP Workload Manager User’sGuide.

For information on invoking user symbolic variables, see the ESP WorkloadManager Advanced User’s Guide.

For information on displaying information on symbol libraries, see the LISTSYMLcommand.

For information on deleting a symbol library, see the DELSYML command.

For information on requesting the inclusion of one or more symbolic variablelibraries, see the SYMLIB command.

Example 1 The following DEFSYML command defines a symbolic variable library:

DEFSYML SYMSET1 DA(‘ESP.SYMLIB(DATEPARM)’)

In the above example, SYMSET1 is defined and consists of the memberDATEPARM of the ESP.SYMLIB data set.

Example 2 The following DEFSYML command defines a symbolic variable library:

DEFSYML SYMSET2 DA(‘CYBER.PAYROLL.SYMBOLS’, -‘CYBER.COMMON.SYMBOLS(DATE)’)

In the above example, SYMSET2 is defined and consists of the sequential data setCYBER.PAYROLL.SYMBOLS and the member DATE of the PDSCYBER.COMMON.SYMBOLS.

Continued on next page

Page 171: ESP 5.2 Command Reference

171

DEFSYML Command, Continued

Example 3 The following DEFSYML command replaces a current symbolic variable librarydefinition:

DEFSYML SYMSET1 DA(‘ESP.SYMLIB(DATEPARM)’) REPLACE

In the above example, the current SYMSET1 definition is replaced.

Page 172: ESP 5.2 Command Reference

172

DEFTJ Command

Overview The DEFTJ command is used to define the tracking parameters for a job, either byfull jobname or jobname prefix. The preferred method for defining tracked jobs is aJob Tracking Definition Table.

Type General command.

Authority SCHEDULER authority or a matching ownership string is required to issue theDEFTJ command in a non-SAF environment. With SAF, you control access toESP’s Tracked Job commands using the TJD.jobname resource.

Syntax The syntax of the DEFTJ command is:

DEFTJ jobnameMODEL(modelname)[TRACK|NOTRACK][INDEX(indexcount)][OWNER(ownerid)][PREFIX]

Parameter Descriptionjobname Indicates the job or job prefix to be defined. If a prefix is

defined, the jobname should contain asterisks or a hyphen.modelname Indicates the name of the tracking model to be associated with

the job(s). This is required unless you specify NOTRACK.You can override this using the MODEL statement for a jobin an Application.

TRACK Indicates you want the job to be tracked. This is the default.NOTRACK Indicates you do not want the job tracked.indexcount Indicates the number of ancestors of a job that are to remain

on the job index data set. This defaults to the index countspecified on the tracking model for the job.

ownerid Indicates an ownership string for the job(s). It may containasterisks or a hyphen. This applies if your are using ESP’sinternal security.

PREFIX Indicates the entry being defined is a jobname prefix entryrather than a full jobname. Use this keyword if the jobnamecontains asterisks or a hyphen.

Continued on next page

Page 173: ESP 5.2 Command Reference

173

DEFTJ Command, Continued

Usage notes All tracked jobs must be associated with a tracking model.

As an alternative to using the DEFTJ command to tell ESP what to track, you canuse a job tracking definition table (JTDT) to identify the characteristics of the jobsyou want ESP to track. ESP can track jobs based on jobname, execution class,programmer name, account number, job type or the user ID associated with the jobs.Job tracking definition tables provide greater flexibility defining the properties ofthe jobs you want ESP to track and are therefore recommended.

Relatedinformation

For information on job tracking definition tables, see the ESP Workload ManagerAdministrator’s Guide.

For information on defining or altering a tracking model, see the DEFTM command.

For information on displaying tracked jobs, see the LTJ and LJ commands.

For information on changing characteristics of a tracked job, see the ALTTJcommand.

For information on deleting a tracked job definition, see the DELTJ command.

Example 1 The following DEFTJ commands define what ESP will track:

DEFTJ PAYJOB99 MODEL(PAYSPEC) INDEX(10)DEFTJ PAY- MODEL(PAYREG) PREFIXDEFTJ TEST- NOTRACKDEFTJ - MODEL(MODEL1) PREFIX

In the above example:

• PAYJOB99 is associated with the PAYSPEC tracking model. Ten instances ofPAYJOB99 are retained on the job index file.

• Jobs starting with PAY are associated with the PAYREG tracking model• Jobs starting with TEST are not tracked• All other jobs are associated with the MODEL1 tracking model.

Page 174: ESP 5.2 Command Reference

174

DEFTM: Define Tracking Model

Overview The DEFTM command is used to define or alter a job tracking model. A trackingmodel allows you to keep the tracking characteristics that apply to a job or group ofjobs in one place. Each job you want ESP to track must have an associated trackingmodel.

Type General command.

Authority SPECIAL authority is required to issue the DEFTM command in a non-SAFenvironment. With SAF, you control access to tracking models using theMODEL.modelname resource.

Syntax The syntax of the DEFTM command is:

DEFTM name[TRACK|NOTRACK][PNODE(pnode[,pnode]...)][ADD|REPLACE]

[INDEX(10)|(indexcount)][HISTFILE(histid)][MONITOR(groupname)][JOBSTARTEVENT(eventname)][JOBENDEVENT(eventname)][JOBFAILEVENT(eventname)][JOBABENDEVENT(eventname)][STEPENDEVENT(eventname)][STEPFAILEVENT(eventname)][STEPABENDEVENT(eventname)]

Parameter Descriptionname Indicates the name of the tracking model, in up to eight

characters.TRACK Indicates you want jobs using this model tracked. This is

the default.NOTRACK Indicates jobs using this model are not tracked. This is

normally specified in the job tracking definition table.

Continued on next page

Page 175: ESP 5.2 Command Reference

175

DEFTM: Define Tracking Model, Continued

Syntax (continued)

Parameter Descriptionpnode Indicates the name of a processing node through which a

job has to pass before it can be considered complete. Ifmore than one P-Node is specified, the jobs must passthrough the P-Nodes in the order specified. The P-Nodename can be followed by a parenthesized string containinga due-out time. This can be an actual time in the form‘HH.MM’, or an elapsed time in the form ‘+HH.MM’.The P-Nodes INPUT, EXEC, and OUTPUT do not have tobe specified unless using a due-out time. This is notcommonly used with ESP Applications.

ADD Indicates this is a new definition. This is the default. Therequest fails if a definition with the same name alreadyexists.

REPLACE Indicates the model is to be replaced. This parameter mustbe used if a definition with the same name exists.

indexcount Indicates the number of ancestors of a job that are toremain on the job index data set. This value should be atleast as large as the highest number of similarly namedjobs to be active in the job queues at one time. The defaultis 10 jobs.

histfid Indicates the identifier of a job history recording data set(its logical name) that is to receive history data for jobsusing this tracking model. This allows you to REPORT onthe jobs.

groupname Indicates any job using this model should check formonitor points and should search Events with this ESPgroup prefix for a monitor Event. You can override thisusing the MONITOR statement for a job in an ESPApplication.

JOBSTARTEVENT Indicates the name of the Event to be triggered wheneverany job using this model starts.

JOBENDEVENT Indicates the name of the Event to be triggered wheneverany job using this model ends (i.e. successful orunsuccessful).

JOBFAILEVENT Indicates the name of the Event to be triggered wheneverany job using this model fails. This Event is triggeredwhen a job abends or fails on condition codes.

JOBABENDEVENT Indicates the name of the Event to be triggered wheneverany job using this model abends. This does not includecondition code failures.

STEPENDEVENT Indicates the name of the Event to be triggered for eachstep end of any job using this model.

Continued on next page

Page 176: ESP 5.2 Command Reference

176

DEFTM: Define Tracking Model, Continued

Syntax (continued)

Parameter DescriptionSTEPFAILEVENT Indicates the name of the Event to be triggered for each

failing step end of any job using this model. Thisincludes abends and condition code failures.

STEPABENDEVENT Indicates the name of the Event to be triggered whenevera step abends for a job using this model. This does notinclude condition code failures.

Usage notes The DEFTM command allows you to centralize the definition of trackingcharacteristics that can be assigned to one job, or a group of jobs. Jobs are normallyassociated with a tracking model using a job tracking definition table.

A tracking model specifies:

• A name for the model

• The manual processing nodes (P–Nodes) through which a job passes

• The number of ancestors of a job ESP should keep on the job index data set, jobmonitor Events or the prefix of job monitor Events and the logical name of ahistory recording data set.

Relatedinformation

For information on displaying the definition of tracking models, see the LTMcommand.

For information on deleting a tracking model definition, see the DELTM command.

For information on tracking definition entries in a job tracking definition table, seethe TRACKDEF statement.

For information on using tracking models and job tracking definition tables, see theESP Workload Manager Administrator’s Guide.

For information on using job monitoring and alert processing, see the ESP WorkloadManager User’s Guide.

Example 1 The following DEFTM command defines a tracking model:

DEFTM MODEL1

In the above example, tracking model MODEL1 is defined and keeps the ten mostrecent executions (default) of each job associated with this tracking model on thejob index data set. No history data is stored for jobs using this model.

Continued on next page

Page 177: ESP 5.2 Command Reference

177

DEFTM: Define Tracking Model, Continued

Example 2 The following DEFTM command defines a tracking model:

DEFTM TESTJOBS INDEX(3)

In the above example, tracking model TESTJOBS is defined and keeps the threemost recent executions of each job associated with this tracking model on the jobindex data set.

Example 3 The following DEFTM command defines a tracking model:

DEFTM PRODJOBS INDEX(10) HISTFILE(HIST1)

In the above example, tracking model PRODJOBS is defined and keeps the ten mostrecent executions of each job associated with this tracking model on the job indexdata set. History data for jobs using this model are stored in the history file whoselogical name is HIST1.

Example 4 The following DEFTM command defines a tracking model and specifies a monitorEvent to be triggered:

DEFTM STEPMON HISTFILE(HIST1) STEPENDEVENT(CYBER.STEPEND)

In the above example, tracking model STEPMON is defined. History data for jobsusing this tracking model are stored in the history file with logical name is HIST1.ESP triggers a monitor Event called CYBER.STEPEND at each end of step for jobsusing this model.

Example 5 The following DEFTM command alters a tracking model definition:

DEFTM MODEL1 HISTFILE(HIST1) INDEX(5) REPLACE

In the above example, tracking model MODEL1’s current definition is replaced withthis new definition.

Example 6 The following DEFTM command defines a tracking model and specifies a monitorEvent to be triggered:

DEFTM MODELSTC JOBSTARTEVENT(CYBER.START_STC) -JOBENDEVENT(CYBER.END_STC)

In the above example, tracking model MODELSTC is defined. ESP triggers amonitor Event called CYBER.START_STC each time a started task using thismodel starts. ESP also triggers a monitor Event call CYBER.END_STC each time astarted task using this model ends.

Page 178: ESP 5.2 Command Reference

178

DEFUSER Command

Overview The DEFUSER command is used to define a user to ESP. You must define eachuser to ESP before it can access and use ESP. This command applies only if you areusing ESP’s internal security.

Type General command.

Authority SPECIAL or USERDEF authority is required to issue the DEFUSER command in anon-SAF environment.

Syntax The syntax of the DEFUSER command is:

{DEFUSER|DEFU} useridEVENTSET(eventdsid)[GROUP{(USERID)|(groupname)|(PREFIX)}][PASSWORD(password)][HISTFILE(histfile)][DEPARTMENT(deptid)]

[(OPER)|(NOOPER)][(SPECIAL)|(NOSPECIAL)][(ANY)|(NOANY)]

[AUTH[(SCHEDULER)|(NOSCHEDULER)]][(USERDEF)|(NOUSERDEF)][(GROUPDEF)|(NOGROUPDEF)][(CONNECTDEF)|(NOCONNECTDEF)][(CALENDARDEF)|(NOCALENDARDEF)]

[AUTHTAB(tabname)][CALENDAR(cal1[,cal2]...)]

Parameter Descriptionuserid Indicates a one to eight character TSO user ID to be defined.eventdsid Indicates, in up to eight characters, the logical identifier of

the Event database used to store Events prefixed with the userID. Use EVENTSET(NONE) to prohibit a user from definingEvents.

USERID Indicates the user ID is to be used as an Event name prefix.This is the default.

groupname Indicates the group which to use as the Event name prefix.PREFIX Indicates the current TSO profile data set prefix is used as the

Event name prefix.password Indicates a password of up to eight characters which is to be

associated with the user ID for accessing the ESP commandthrough a batch job. This is required only if you are not usinga host security package.

Continued on next page

Page 179: ESP 5.2 Command Reference

179

DEFUSER Command, Continued

Syntax (continued)

Parameter Descriptionhistfile Indicates the history file ID or mask, using up to eight

characters, which can contain asterisks or a hyphen.This controls access to the history files for reporting.

deptid Indicates a department name of up to eight characters towhich this user belongs. It may contain asterisks andmay also have a hyphen in the last character position.

SPECIAL Indicates the user can access commands relating toAdministration.

OPER Indicates the user can issue operator commands.ANY Indicates the user can define and access Events with any

group prefix.SCHEDULER Indicates the user can define P-Nodes, tracking models

and job tracking parameters.USERDEF Indicates the user can define other users within the same

department, or department sub-group, provided they usethe same Eventset. This user can define other users withequal or lesser authority. The DEPARTMENT keywordmust be used with this keyword.

GROUPDEF Indicates the user can define other groups within thesame department, or department sub-group, providedthey use the same Eventset. This user can define groupswith equal or less authority than his or her own group,but is not be able to use the RACID option, which isonly available with the DEFGROUP command to a userwith the SPECIAL attribute. The DEPARTMENTkeyword must also be used with this keyword.

CONNECTDEF Indicates a user can connect any user to any groupwithin the same department or department sub–group.

CALENDARDEF Indicates a user defines calendars and makes themavailable to other users within the same department ordepartment sub–group.

NOSPECIAL Removes the SPECIAL attribute.NOOPER Removes the OPER attribute.NOANY Removes the ANY attribute.NOSCHEDULER Removes the SCHEDULER attribute.NOUSERDEF Removes the USERDEF attribute.NOGROUPDEF Removes the GROUPDEF attribute.NOCONNECTDEF Removes the CONNECTDEF attribute.NOCALENDARDEF Removes the CALENDARDEF attribute.NOUSERDEF Removes the USERDEF attribute.tabname Indicates the name of the authorization table assigned to

the user, up to eight characters.

Continued on next page

Page 180: ESP 5.2 Command Reference

180

DEFUSER Command, Continued

Syntax (continued)

Parameter Descriptioncal1 Indicates the name of the first default calendar, up to

eight characters.cal2 Indicates the name of the second default calendar, up to

eight characters.

Usage notes Default calendars are used by Events that have no explicit calendar specification.They are searched in the order specified. All Events automatically have access tothe system calendar, which is searched after the default calendars. A user hasupdate access to the calendar listed as his first default calendar if that calendar doesnot have a department assigned, even though his user ID may not be included in theownership string of the calendar. Authority attributes are independent of each other.For example, if you have SPECIAL authority, you do not automatically have anyother authority attributes.

Usage notescontinued

When you delete a user, none of the Events the user defined will execute.Cybermation supplies a utility, CYBESU01, you can use to change the ownership ofan Event.

You can also define users using ESP’s ISPF interface. Choose Option M from theESP Main Menu.

Relatedinformation

For more information on departments, see the ESP Workload ManagerAdministrator’s Guide.

For information on using authorization tables to control access to job tracking data,see the ESP Workload Manager Administrator’s Guide.

For information on calendars, see the CALENDAR command.

For information on deleting a user, see the DELUSER command.

For information on displaying a user, see the LISTUSER command.

For information on changing a user’s definition, see the ALTUSER command.

Example 1 The following DEFUSER command defines a user to ESP:

DEFUSER CYBUSR1 EVENTSET(EVENT1)

In the above example, CYBUSR1 is defined with no authority and Events for thisuser are stored in the Event database with logical name EVENT1.

Continued on next page

Page 181: ESP 5.2 Command Reference

181

DEFUSER Command, Continued

Example 2 The following DEFUSER command defines a user to ESP:

DEFUSER CYBUSR2 EVENTSET(EVENT1) -AUTH(SPECIAL,ANY,OPER,SCHEDULER)

In the above example, CYBUSR2 has been given the authority to do the following:

• Access commands relating to Administration• Define and access Events with any group prefix• Issue operator commands• Define P-Nodes, tracking models and job tracking parameters.

Example 3 The following DEFUSER command defines a user to ESP:

DEFUSER CYBUSR3 EVENTSET(EVENT1) CALENDAR(CAL1) -HISTFILE(HIST1) AUTH(SCHEDULER)

In the above example, CYBUSR3. The Event data set is EVENT1; the first defaultcalendar is CAL1, access is allowed to the history file HIST1, and the user isallowed to define tracking models, job tracking parameters and processing nodes.

Example 4 The following DEFUSER command defines a user to ESP:

DEFUSER CYBUSR4 EVENTSET(EVENT1) DEPT(MTS-) -AUTH(GROUPDEF,USERDEF,CALENDARDEF,CONNECTDEF) -HISTFILE(HISTF1)

In the above example, CYBUSR4 has been given the authority to do the following:

• Define and administer any department that begins with the string ‘MTS’ and istherefore able to define other departmental sub-groups such as ‘MTS1’, ‘MTS2’,and so on.

• Define other groups and users within his own department or sub-group ofdepartments because of the GROUPDEF and USERDEF keywords. The groupsand users that CYBUSR4 defines can have the same or less authority, and mustuse the same Eventset, EVENT1.

• Define calendars, connect other users to groups and sub-groups that he has access.

Page 182: ESP 5.2 Command Reference

182

DELAT Command

Overview The DELAT command is used to delete an authorization table. This commandapplies only if you are using ESP’s internal security.

Type General command.

Authority SPECIAL authority is required in a non-SAF environment to issue the DELATcommand.

Syntax The syntax of the DELAT command is:

DELAT tabname

Parameter Descriptiontabname Indicates the name of the authorization table to be deleted,

which consists of up to eight characters.

Relatedinformation

For information on defining authorization tables, see the DEFAT command.

For information on authorization tables, see the ESP Workload ManagerAdministrator’s Guide.

Example 1 The following DELAT command deletes an authorization table:

DELAT ATAB01

In the above example, ATAB01 is deleted. A user that has been assigned ATAB01will no longer be able to access job-tracking data.

Page 183: ESP 5.2 Command Reference

183

DELAYINT: Delay Interval

Overview The DELAYINT command is used to set the interval for re-triggering an Eventwhen required data sets are not available.

Type General command.

Authority OPER authority is required to issue the DELAYINT command.

Syntax The syntax of the DELAYINT parameter is:

DELAYINT [nn|5]

Parameter Descriptionnn Indicates a delay interval in minutes. Specify a value from 1

to 15 minutes. The default is 5.

Usage notes If an Event requires a data set that is not available at the trigger time because it is inuse by another user, ESP tries again at the specified DELAYINT time to re-triggerthe Event.

The DELAYINT is normally specified as an Initialization Parameter.

If the DELAYINT command is entered dynamically, for example from Page mode, itoverrides the default Initialization Parameter setting until an IPL is performed.

Relatedinformation

For information on the DELAYINT Initialization Parameter, see the ESP WorkloadManager Installation Guide.

Example 1 The following DELAYINT displays the Event re-triggering interval:

OPER DELAYINT

In the above example, ESP displays the interval for re-triggering an Event whenrequired data sets are not available.

Example 2 The following DELAYINT command causes ESP to retry access to a data set:

OPER DELAYINT 1

In the above example, ESP retries in 1 minute if a required data set, for example JCLlibrary, is not available at trigger time..

Page 184: ESP 5.2 Command Reference

184

DELAYSUB Statement

Overview The DELAYSUB statement is used to specify a job for delayed submission relativeto the scheduled time of the Event. If the Event is not scheduled the delayedsubmission time is relative to the time the Application is generated.

Type ESP Application statement.

Syntax The syntax of the DELAYSUB statement is:

DELAYSUB criteria

Parameter Descriptioncriteria Schedule criteria that resolve to a single date and time when the

Application builds.

Usage notes Use the DELAYSUB statement within the scope of a JOB statement to request that ajob not be submitted until a specified time, even though its predecessors havecompleted. This time parameter can request any date or time relative to the time theApplication was schedule or generated.

If you trigger an Event with a time/date in the past, ESP does not honorDELAYSUB statements, except those that use the term REALNOW.

Although less commonly used, the DELAYSUB statement can be placed outside thescope of any JOB statements (globally) to delay all jobs that are placed after thatglobally placed DELAYSUB statement. Using this method sets a delayedsubmission time for all jobs within the Application, except for those specifying theDELAYSUB statement within the scope of the JOB statement. Jobs that have theirdelayed submission time set as a result of a globally placed DELAYSUB statementcan have those delayed submission times reset only on a job by job basis, and not asa group.

Jobs that are inserted into active Applications do not have delayed submission timeassociated with them. If you want to insert a job into an active Application andassociate a delayed submission time with that job you will have to:

1. Insert the job on hold using the “IJ” CSF line command2. Reset the job’s delayed submission time (“Earliest submit time” field)3. Release the job using the “A” CSF line command.

Continued on next page

Page 185: ESP 5.2 Command Reference

185

DELAYSUB Statement, Continued

RelatedStatements

Note: The DELAYSUB and EARLYSUB statements perform the same function.

For information on resetting time dependencies, see the ESP Workload ManagerUser’s Guide.

For information on manipulating jobs within Application or subApplications, see theAPPLJOB or AJ command.

For information on specifying time dependencies, see the ESP Workload ManagerUser’s Guide.

Example 1 The following DELAYSUB statement sets the delayed submission time of a job:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

DELAYSUB 9PMRUN WORKDAYS

ENDJOB

In the above example, PAYJOB1 has a delayed submission time of 9 pm relative tothe time the PAYROLL Application is generated.

Example 2 The following DELAYSUB statement sets the delayed submission time based on theday of the week:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB2

DELAYSUB 9PMIF TODAY(‘WEEKEND’) THEN DELAYSUB 6PMRUN DAILY

ENDJOB

In the above example, PAYJOB2 has a delayed submission time of:

• 9 pm on weekdays• 6 pm on weekends

Continued on next page

Page 186: ESP 5.2 Command Reference

186

DELAYSUB Statement, Continued

Example 3 The following DELAYSUB statement sets the delayed submission time based on theday of the week:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB3

DELAYSUB 4PMRELEASE PAYJOB4

ENDJOBJOB PAYJOB4

RELEASE PAYJOB5ENDJOBDELAYSUB 7PMJOB PAYJOB5

RELEASE PAYJOB6ENDJOBJOB PAYJOB6ENDJOBSELECT (PAYJOB3,PAYJOB4,PAYJOB5,PAYJOB6)

In the above example:

• PAYJOB3 has a delayed submission time of 4pm• PAYJOB4 does not have a delayed submission time• PAYJOB5 & PAYJOB6 have delayed submission times of 7pm.

Other examples Here are more examples using the DELAYSUB statement.

Sets the delayed submission to 10 minutes after the scheduled time of the Event:

DELAYSUB NOW PLUS 10 MINUTES

Sets the delayed submission time to 10pm two workdays from the scheduled time ofthe Event:

DELAYSUB 10PM TODAY PLUS 2 WORKDAYS

Sets the delayed submission time to 11 pm on the last workday of the month, and to9 pm on all other days this job is submitted:IF TODAY(‘LAST WORKDAY OF MONTH’) THEN -

DELAYSUB 11PMELSE -

DELAYSUB 9PM

Page 187: ESP 5.2 Command Reference

187

DELCAL Command

Overview The DELCAL command is used to delete a calendar and all the holidays and specialdays within it.

Type General command.

Authority SPECIAL or CALENDARDEF authority is required in a non-SAF environment toissue the DELCAL command. With SAF, you control access to calendars using theCALENDAR.calname resource.

Syntax The syntax of the DELCAL command is:

{DELCAL|DELC} calname

Parameter Descriptioncalname Indicates a one to eight character calendar name to be deleted.

Usage notes Deleting a calendar should only take place when you are sure no Event orApplications use schedule terms in the calendar.

Relatedinformation

For information on calendars, see the ESP Workload Manager Administrator’sGuide.

For information on defining calendars, see the DEFCAL command.

Example 1 The following DELCAL command deletes a calendar:

DELCAL PAYCAL

In the above example, PAYCAL and its entire contents, (for example holidays,special days and special periods), are deleted.

Page 188: ESP 5.2 Command Reference

188

DELETE Command - Event Definition

Overview The DELETE command, when used in an Event definition, is used to delete anEvent at a scheduled time.

Type Event command.

Syntax The syntax of the DELETE command is:

{DELETE|DEL} criteria

Parameter Descriptioncriteria Schedule criteria that resolve to a single date and time.

Relatedinformation

For information on working with ESP Events, see the ESP Workload ManagerUser’s Guide.

For information on deleting an Event, outside an Event definition, see the DELETECommand - General.

Example 1 The following DELETE command deletes an Event at a scheduled time:

DELETE 10AM FIRST DAY OF YEAR

In the above example, an Event is deleted at 10 am on the first day of the year.

Example 2 The following DELETE command deletes an Event at a scheduled time:

DELETE 11PM MARCH 2,1998

In the above example, an Event is deleted at 11 pm on March 2nd, 1998.

Page 189: ESP 5.2 Command Reference

189

DELETE Command - General

Overview The DELETE command is used to delete an Event definition.

Type General command.

Syntax The syntax of the DELETE command is:

{DELETE|DEL} eventid

Parameter Descriptioneventid Indicates the name of an Event to be deleted. If no prefix is

specified, your current GROUP prefix is used.

Usage notes The specified Event is deleted at the time the command is entered, even if the Eventis currently scheduled.

Relatedinformation

For information on working with ESP Events, see the ESP Workload ManagerUser’s Guide.

For information on displaying Events, see the LIST command.

For information n scheduling a deletion of an Event, see the DELETE Command -Event Definition.

Example 1 The following DELETE command deletes an Event definition:

DELETE CYBER.PAYROLL

In the above example, CYBER.PAYROLL is deleted.

Page 190: ESP 5.2 Command Reference

190

DELGROUP Command

Overview The DELGROUP command is used to delete a group definition. This commandapplies only if you are using ESP’s internal security.

Type General command

Authority SPECIAL or GROUPDEF authority is required to issue the DELGROUP command.

Syntax The syntax of the DELGROUP command is:

{DELGROUP|DELG} groupname

Parameter Descriptiongroupname Indicates the name of the group to be deleted.

Relatedinformation

For information on defining groups, see the ESP Workload Manager Administrator’sGuide.

For information on defining groups, see the DEFGROUP command.

For information on displaying information about a group, see the LISTGRPcommand.

Example 1 The following DELGROUP command deletes a group:

DELGROUP ACCOUNTS

In the above example, the ACCOUNTS group is deleted.

Page 191: ESP 5.2 Command Reference

191

DELHOL Command

Overview The DELHOL command is used to delete a holiday definition.

Type General command.

Authority You can delete only holidays defined in your first default calendar, or in calendars towhich you have access.

Syntax The syntax of the DELHOL command is:

{DELHOL|DELH} holidaynameSTART(starttime)[CALENDAR(calname)]

Parameter Descriptionholidayname Indicates the 1 to 16 character name of the holidaystarttime Indicates the starting time and date of the holiday. If the date

specification contains separators, it should be enclosed inquotes.

calname Indicates the name of the calendar in which the holiday isdefined.

Usage notes You must delete one holiday at a time.

The holiday name and start time must match an existing definition for the commandto work. The time and date specification must be accurate to within one minute.

If you do not specify a calendar name, the following calendars are searched in theorder listed.

1. The first default calendar as defined in your user ID entry.

2. The second default calendar as defined in your user ID entry.

3. The SYSTEM calendar.

The first matching holiday entry found is deleted.

Usage notescontinued

Normally you do not need to delete holiday definitions. Holidays are automaticallydeleted after the retention period expires, as per the time period specified when theholiday was defined.

Continued on next page

Page 192: ESP 5.2 Command Reference

192

DELHOL Command, Continued

Relatedinformation

For information on defining holidays, see the DEFHOL command.

For information on displaying holiday information, see the LISTHOL command.

Example 1 The following DELHOL command deletes a holiday:

DELHOL TEMPORARY START(‘FEB 22,1998’) CAL(UCAL2)

In the above example, TEMPORARY is deleted from the UCAL2 calendar.

Page 193: ESP 5.2 Command Reference

193

DELPN Command

Overview The DELPN command is used to delete a P-Node definition.

Type General command.

Authority SCHEDULER authority is required in a non-SAF environment to issue the DELPNcommand. With SAF, you control access to P-Nodes using the PNODE.pnodenameresource.

Syntax The syntax of the DELPN command is:

DELPN pnode

Parameter Descriptionpnode Indicates the name of the P-Node being deleted.

Relatedinformation

For information on defining processing nodes (P-Nodes), see the ESP WorkloadManager Advanced User’s Guide.

For information defining manual P-Nodes, see the DEFPN command.

Example 1 The following DELPN command deletes a P-Node:

DELPN DISTRIB

In the above example, the DISTRIB manual P-Node is deleted.

Page 194: ESP 5.2 Command Reference

194

DELSIG Command

Overview The DELSIG command is used to delete a signal.

Type General command.

Authority You can delete only those signals beginning with a prefix to which you have access.

Syntax The syntax of the DELSIG command is:

DELSIG signalname

Parameter Descriptionsignalname Indicates the name of the signal. If the prefix is omitted, the

current group or user prefix is used.

Relatedinformation

For information on signal processing, see the ESP Workload Manager AdvancedUser’s Guide.

For information on defining signals, see the DEFSIG command.

For information on posting a generation of a signal, see the SIGPOST command.

For information on altering the numbers of generations of a signal, see the ALTSIGcommand.

For information on displaying all generations of a signal, see the LISTSIGcommand.

Example 1 The following DELSIG command deletes a signal:

DELSIG CYBER.SIGNAL1

In the above example, CYBER.SIGNAL1 is deleted.

Example 2 The following DELSIG command deletes a signal:

DELSIG SIGNAL2

In the above example, SIGNAL2 is deleted. If, for example the current group prefixis PROD, then PROD.SIGNAL2 is deleted.

Page 195: ESP 5.2 Command Reference

195

DELSPEC Command

Overview The DELSPEC command is used to delete a special day or period definition.

Type General command.

Authority You can delete only special days or periods defined in your first default calendar, orcalendars to which you have access.

Syntax The syntax of the DELSPEC command is:

DELSPEC specnameON(date)[CALENDAR(calname)]

Parameter Descriptionspecname Indicates a 1 to 16 character name of a special day or period.date Indicates the starting time and date of the special day or

period. If the date specification contains separators, it shouldbe enclosed in quotes.

calname Indicates the name of the calendar in which the special day isto be deleted.

Usage notes You must delete one special day at a time.

The special day and start time must match an existing definition for the command towork. The time and date specification must be accurate to within one minute.

If you do not specify a calendar name, the following calendars are searched in theorder listed. The first matching special day/period entry found is deleted.

1. The first default calendar as defined in your user ID entry.

2. The second default calendar as defined in your user ID entry.

3. The SYSTEM calendar.

Normally you do not need to delete special days. Special days are automaticallydeleted after the retention period expires, as per the time period specified when thespecial day was defined.

Continued on next page

Page 196: ESP 5.2 Command Reference

196

DELSPEC Command, Continued

Relatedinformation

For information on using special days, see the ESP Workload Manager User’sGuide.

For information on defining special days or periods, see the DEFSPEC command.

For information on displaying special day and period information, see theLISTSPEC command.

Example 1 The following DELSPEC command deletes a special day:

DELSPEC PAYROLL_DAY ON(‘26TH NOVEMBER 1998’)

In the above example, PAYROLL_DAY, which falls on November 26th, 1998 isdeleted.

Page 197: ESP 5.2 Command Reference

197

DELSYML Command

Overview The DELSYML command is used to delete a symbol library.

Type General command.

Authority SPECIAL, SCHEDULER or CALENDARDEF authority is required to issue theDELSYML command in non-SAF environments. With SAF, you control access tosymbol libraries using the SYMLIB.symname resource.

Syntax The syntax of the DELSYML command is:

DELSYML name

Parameter Descriptionname Indicates the name of the symbolic variable library to be

deleted.

Usage notes The DELSYML command deletes the logical identifier of the symbol library.

Relatedinformation

For information on displaying symbol libraries, see the LISTSYML command.

For information on defining a symbol library, see the DEFSYML command.

Example 1 The following DELSYML command deletes a symbol variable library:

DELSYML USRSYMS

In the above example, USRSYMS is deleted.

Note: Only the logical identifier (USRSYMS) is deleted and not the data setsassociated with the identifier when the symbolic library was defined.

Page 198: ESP 5.2 Command Reference

198

DELTJ Command

Overview The DELTJ command is used to delete tracked job definitions from the job indexfile.

Type General command.

Authority SCHEDULER authority or a matching ownership string is required to issue theDEFTJ command in a non-SAF environment. With SAF, you control access toESP’s Tracked Job commands using the TJD.jobname resource.

Syntax The syntax of the DELTJ command is:

DELTJ jobname[PREFIX]

Parameter Descriptionjobname Indicates the name of the job, or job prefix to delete. Only if

a job prefix is deleted can the name contain asterisks and ahyphen.

PREFIX Indicates a prefix entry is being deleted. This applies only ifyou are not using a Job Tracking Definition Table.

Usage notes Normally you should not need to delete tracked job definitions.

The preferred method for deleting and altering tracked job definitions is a JobTracking Definition Table.

Relatedinformation

For information on job tracking definition tables, see the ESP Workload ManagerAdministrator’s Guide.

For information on changing characteristics of a tracked job, see the ALTTJcommand.

Example 1 The following DELTJ command a tracked job definition:

DELTJ PAYJOB99

In the above example, PAYJOB99 is deleted from the job index file.

Continued on next page

Page 199: ESP 5.2 Command Reference

199

DELTJ Command, Continued

Example 2 The following DELTJ command deletes multiple tracked job definitions:

DELTJ ABC- PREFIX

In the above example, any job whose name starts with the characters ABC is deletedfrom the job index file. Jobs with this prefix that are already tracked continue to betracked as specific entries were built. These can be deleted individually if required.This example applies only if you are not using a Job Tracking Definition table

Page 200: ESP 5.2 Command Reference

200

DELTM Command

Overview The DELTM command is used to delete a tracking model definition.

Type General command.

Authority SPECIAL authority is required to issue the DELTM command in a non-SAFenvironment. With SAF, you control access to tracking models using theMODEL.modelname resource.

Syntax The syntax of the DELTM command is:

DELTM model

Parameter Descriptionmodel Indicates the name of the tracking model to be deleted.

Usage notes Caution should be used when deleting tracking models. Tracking models containtracking characteristics that may apply to a large number of jobs. If a trackingmodel is deleted, ESP no longer tracks all jobs associated with that tracking model.

Relatedinformation

For information on displaying a tracking model, see the LTM command.

For information on defining a tracking model, see the DEFTM command.

For information on tracking definition entries in a Job Tracking Definition Table,see the TRACKDEF statement.

For information on using tracking models, and Job Tracking Definition Tables, seethe ESP Workload Manager Administrator’s Guide.

Example 1 The following DELTM command deletes a tracking model definition:

DELTM MODELTST

In the above example, MODELTST is deleted.

Page 201: ESP 5.2 Command Reference

201

DELUSER Command

Overview The DELUSER command is used to delete a user definition from ESP. Thecommand applies only if you are using ESP’s internal security.

Type General command.

Authority SPECIAL or USERDEF authority is required to issue the DELUSER command in anon-SAF environment.

Syntax The syntax of the DELUSER command is:

{DELUSER|DELU} userid

Parameter Descriptionuserid Indicates the name of the user definition to be deleted.

Relatedinformation

For information on defining users, see the ESP Workload Manager Administrator’sGuide.

For information on defining a user, see the DEFUSER command.

For information on displaying a user, see the LISTUSER command.

For information on changing a user’s definition, see the ALTUSER command.

Example 1 The following DELUSER command deletes a user:

DELUSER CYBUSR9

In the above example, CYBUSR9 is deleted and is no longer able to access ESP.

Page 202: ESP 5.2 Command Reference

202

DESELECT Statement

Overview The DESELECT statement is used to deselect a job or subApplication. Deselectedjobs are not built as part of the Application. Use the DESELECT statement tohandle exceptions to regular schedule criteria.

Type ESP Application statement.

Syntax The syntax of the DESELECT statement is:

DESELECT {jobname|(jobname[,jobname])} [JOB|SUBAPPL]

Parameter Descriptionjobname Indicates a jobname. Enclose multiple jobnames in

parentheses, separated by a blank or comma.JOB Indicates a job is being deselected for submission. This is the

default.SUBAPPL Indicates all jobs within a subApplication are being

deselected for submission.

Usage notes You can deselect a group of jobs using the SUBAPPL parameter.

You can use more than one DESELECT statement.

The DESELECT statement identifies that a previously selected job should not beselected as part of the Application. It can be used only after you have specified aSELECT or RUN statement for the jobs involved.

If the DESELECT statement is used for any job that has PREREQ, POSTREQ orCOREQ specified, the jobs that these statements refer to are deselectedautomatically.

Jobs that are specified as PREREQ, POSTREQ or COREQs can not explicitly bedeselected using a DESELECT statement.

Jobs that are selected to run using a RUN statement can be deselected using aDESELECT statement.

ESP allows multiple SELECT and DESELECT statements for the same job orsubApplication.

You should normally code your DESELECT statements after your SELECTstatements since ESP processes the statements in the order specified.

Continued on next page

Page 203: ESP 5.2 Command Reference

203

DESELECT Statement, Continued

RelatedStatements

For information on selecting a job or subApplication for submission, see theSELECT statement.

For information on selecting and deselecting jobs or subApplications forsubmission, see the ESP Workload Manager User’s Guide.

Example 1 The following DESELECT statement is used to deselect a job on Fridays:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RELEASE PAYJOB2JOB PAYJOB2ENDJOBSELECT (PAYJOB1,PAYJOB2)IF TODAY(‘FRIDAY’) THEN DESELECT PAYJOB2

In the above example, when the PAYROLL Application is generated PAYJOB1 andPAYJOB2 are always selected, except on Fridays, when PAYJOB2 is deselected.

Example 2 The following DESELECT statement is used to deselect two jobs on the firstworkday of the month:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB5

RUN DAILYPOSTREQ PAYJOB6

JOB PAYJOB6ENDJOBIF TODAY(‘FIRST WORKDAY OF MONTH’) THEN DESELECT PAYJOB5

In the above example, when the PAYROLL Application is generated ESP runsPAYJOB5 and PAYJOB6 daily, except on the first workday of the month, whenboth PAYJOB5 and PAYJOB6 are deselected. This is because a DESELECTstatement is used for PAYJOB5, which has a POSTREQ of PAYJOB6.

Continued on next page

Page 204: ESP 5.2 Command Reference

204

DESELECT Statement, Continued

Example 3 The following statements are used to:

• select subApplications• select jobs within an Application• deselect a subApplication• deselect a job within an Application.

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB ACCJOB1

SUBAPPL ACCPAYENDJOBJOB ACCJOB2

SUBAPPL ACCPAYENDJOBJOB BILJOB1

SUBAPPL BILLINGENDJOBJOB BILJOB4

SUBAPPL BILLINGENDJOBJOB PAYJOB10ENDJOBJOB PAYJOB11ENDJOBSELECT (ACCPAY,BILLING) SUBAPPLSELECT (PAYJOB10,PAYJOB11)IF TODAY(‘LAST WORKDAY OF MONTH’) THEN DESELECT BILLING -SUBAPPLIF TODAY(‘MONDAY’) THEN DESELECT ACCJOB2

In the above example:

• The ACCPAY and BILLING subApplications are selected• PAYJOB10 and PAYJOB11 are selected• The BILLING subApplication is not selected on the last workday of the month• ACCJOB2 is not selected on Mondays.

Other examples Here are more examples of using the DESELECT statement.

Indicates a job is not selected for submission:

DESELECT PAYJOB1 or DESELECT PAYJOB1 JOB

Indicates two subApplications are not selected for submission:

DESELECT (PREPJOBS,POSTJOBS) SUBAPPL

Page 205: ESP 5.2 Command Reference

205

DFLTUSER Command

Overview The DFLTUSER command is used to define the characteristics of an undefined usercommunicating with ESP for the first time. This command is needed only if you arenot using a host security product with password protection.

Type General command.

Authority SPECIAL authority is required to issue the DFLTUSER command.

Syntax The syntax of the DFLTUSER command is:

DFLTUSER {[NONE]}{[AUTH {(SPECIAL)|(OPER)|(ANY)}]}{[GROUP{(PREFIX)|(groupid)|(USERID)}]}{[EVENTID(evdb)]}

Parameter DescriptionNONE Indicates no unauthorized users may access the system.AUTH Indicates the attributes to be assigned to the user.SPECIAL Indicates the user is allowed full access to ESP, including

holiday and special day definitions as well as group and userdefinitions.

OPER Indicates the user is allowed to issue ESP operatorcommands.

ANY Indicates the user is allowed to access any Event, even thoughhe is not connected to the group in which the Event isdefined.

GROUP Indicates the default GROUP to which the user is assigned.PREFIX Indicates the TSO profile prefix should be used. This is the

default if the GROUP keyword is not specified.groupid Indicates the group prefix of your choice, using up to eight

characters.USERID Indicates the user ID should be used as a group prefix for

Events.evdb Indicates the identifier of an Event database, using up to eight

characters. This Event database contains the Events that theuser defines, prefixed by his or her own user ID.

Usage notes The GROUP keyword specifies the default GROUP to which the user is assigned.

This command has to be reissued only when any specifications are to be modified.

Continued on next page

Page 206: ESP 5.2 Command Reference

206

DFLTUSER Command, Continued

Relatedinformation

For information on defining and deleting users to ESP, see the DEFUSER andDELUSER commands.

For information on defining users and groups, see the ESP Workload ManagerAdministrator’s Guide.

Example 1 The following DFLTUSER command defines the characteristics of an undefineduser to ESP:

DFLTUSER GROUP(USERID) EVENT(EVENT1)

In the above example, any user who is not defined to ESP has their user ID assignedas their ESP group prefix, and all their Event definitions are stored in the Eventdatabase called EVENT1.

Page 207: ESP 5.2 Command Reference

207

DFPNODE Command

Overview The DFPNODE command is used to display or set the default P-Node for the issuingsystem console or TSO session.

Type General command.

Authority OPER authority is required to issue the DFPNODE command.

Syntax The syntax of the DFPNODE command is:

DFPNODE [pnodename]

Parameter Descriptionpnodename Indicates the name of the default P-Node. If this Parameter is

omitted, the current default P-Node is displayed.

Usage notes The DFPNODE command makes it easier for a TSO user or system console operatorto POST a job from a P-Node because the PNODE parameter of the POST commandis not needed. The PNODE parameter on the POST command can still be used tooverride the default P-Node.

The default P-Node is retained across sessions and IPLs until reset by anotherDFPNODE command.

Relatedinformation

For information on posting a job complete from a manual P-Node, see the POSTcommand.

For information on defining and deleting manual P-Nodes, see the DEFPN andDELPN commands.

For information on defining processing nodes (P-Nodes), see the ESP WorkloadManager Advanced User’s Guide.

Continued on next page

Page 208: ESP 5.2 Command Reference

208

DFPNODE Command, Continued

Example 1 The following DFPNODE command sets a default P-Node:

DFPNODE BURSTER

In the above example, BURSTER is set as the default P-Node for the issuing consoleor user ID. To post jobs from a default P-Node issue the POST command asfollows:

POST MYJOBPOST OTHERJOB

Page 209: ESP 5.2 Command Reference

209

DISCONN Command

Overview The DISCONN command is used to remove the authority of a user to access a groupprefix.

Type General command.

Authority SPECIAL or CONNECTDEF authority is required to issue the DISCONN commandin a non-SAF environment.

Syntax The syntax of the DISCONN command is:

{DISCONN|DISCON} useridGROUP(groupname)

Parameter Descriptionuserid Indicates the user ID to be disconnected.groupname Indicates the name of the group from which the user is being

disconnected.

Usage notes The DISCONN command applies only if your are using ESP’s internal security.

It may be necessary to restrict a user’s access to a Group prefix. You may have to dothis if, for example, the user moves out of that group to another area of yourorganization, or to another company.

Relatedinformation

For information on connecting a user to a group, see the CONNECT command.

For information on listing a user definition, see the LISTUSER command.

Example 1 The following DISCONN command disconnects a user from a group:

DISCONN FRED GROUP(BILLING)

In the above example, FRED is disconnected from the BILLING group.

Page 210: ESP 5.2 Command Reference

210

DISPLAY Command

Overview The DISPLAY command is used to specify which reporting fields you want todisplay when creating history reports.

Type Reporting command.

Syntax The syntax of the DISPLAY command is:

DISPLAY field[length][‘title1’][‘title2’]

Parameter Descriptionfield Indicates the name of a field to be displayed.length Indicates an optional length. This can be used to create more

space between columns. Fields are left justified, blanks arepadded on the right to the length specified.

title1 Indicates a title, enclosed in quotes.title2 Indicates a second title, enclosed in quotes.

Usage notes Once the DISPLAY section is started, several field names can be entered one afteranother, along with optional lengths and titles, separated by a comma. The specifiedfields are placed on the report detail line in the order specified.

If the length of the titles exceeds the length of the field, the column width adjusts toaccommodate the titles.

Relatedinformation

For information on history reporting including a list of valid fields, see the ESPWorkload Manager User’s Guide.

For information on beginning a report definition, see the REPORT command.

Example 1 The following DISPLAY command indicates the fields to display:

DISPLAY APPLSYS JOBNAME JOBNO EXECST ENDT

In the above example, the following fields are displayed as part of a history report:

• Application name (APPLSYS)• Job name (JOBNAME)• Job number (JOBNO)• Execution start time (EXECST)• Execution end time (ENDT).

Continued on next page

Page 211: ESP 5.2 Command Reference

211

DISPLAY Command, Continued

Example 2 The following DISPLAY command indicates the fields to display:

DISPLAY JOBNAME,RDRON,RDRONDATE,TEXCP 5 ‘TAPE’ ‘EXCPS’ -DEXCP 6 ‘DISK’ ‘EXCPS’

In the above example, the following fields are displayed as part of a history report:

• Job name (JOBNAME)• Time at which ESP read the job into the system (RDRON)• Date at job submission (RDRONDATE)• Tape EXCP count to 5 digits, with a title of TAPE EXCPS (TEXCP)• Disk EXCP count to 6 digits, with a title of DISK EXCPS (DEXCP).

Example 3 The following DISPLAY command indicates the fields to display:

DISPLAY JOBNAME 15,CMPC

In the above example, the following fields are displayed as part of a history report:

• Job name, padded on the right with blanks to a width of 15 (JOBNAME)• Completion code (CMPC).

Page 212: ESP 5.2 Command Reference

212

DJCDATA Statement

Overview The DJCDATA statement is used to introduce DJC (Dependent Job Control) or

JES3 statements for a job.

Type ESP Application statement, DJC Network statement.

Syntax The syntax of the DJCDATA statement is:

DJCDATA [ID(name)][RS([op][n,]resname[,[op][n,]resname...])][TC(t)][HC(num)][RL(jobname[,jobname]...)][AB(jobname[,jobname]...)][AF(jobname[,jobname]...)][NC{(F)|(D)|(R)}][AB{(F)|(D)|(R)}][NR(netid,jobname[,netid,jobname]...)][OH{(NO)|(YES)}][LN{(R)|(N)|(C)}][NRCMP{(HOLD|(NOHO)|(FLSH)}][ABCMP{(NOKP)|(KEEP)}]

Syntaxabbreviations

The following keyword abbreviations are used:

Abbreviation Description Abbreviation Description

ID NETID AF AFTER RS RESOURCE NC NORMAL TC TAPES AB ABNORMAL HC NHOLD NR NETREL RL RELEASE OH OPHOLD BF BEFORE LN LASTNET

Continued on next page

Page 213: ESP 5.2 Command Reference

213

DJCDATA Statement, Continued

Syntax

Parameter Description name Indicates the name of the jobnet containing this job. The name

can be up to eight alphanumeric characters, the first of whichmust be alphabetic. This overrides the DJCNET setting.

op A logical operator indicating that the resource must beunavailable or that less than the indicated quantity (n) of theresource must be available. Use a negative quantity of aresource to indicate that a job provides a resource; use a notsign ‘¬’ to indicate that the unavailability of a resource isrequired; use the “less than” sign (<) to indicate that less thanthe indicated quantity must be available. This parameterrequires DJC 3.6.0 and up.

n Used only with a quantum resource. This specifies the numberof units of the specified resource that must be available for thejob to be eligible for execution. It is separated from theresource name by a comma. The default is 1.

resname Indicates the name of a resource that must exist before a jobcan become eligible for execution. The resource specified canbe a real or abstract resource. A logical resource is specifiedwithout a count (n). A combination of quantum, either real orabstract, and logical resources can be specified, up to amaximum of 64.

TC(t) Indicates the number of tape drives required that must be onlineand available to the system for this job to be released. Therange is up to 999. The TC parameter applies to either 3420(reel to reel) or 3480 (cartridge) tape drives, or appliesindiscriminately, depending on a DJC Installation Parameter.This parameter can be specified alone, without being part of aDJC jobnet.

HC(num) Indicates the number of immediate predecessor job completionsrequired before this job can be released for execution. Therange is up to 32,767. This count should not include any jobreferenced by the AFTER, POSTREQ, PREREQ or RELEASEstatements in an ESP Procedure. In these cases, the count isadjusted automatically.

RL(jobname) Indicates the name(s) of jobs in the specified jobnet that aresuccessors to this job. Up to 50 names can be specified,separating each by a comma.

BF(jobname) Indicates the name(s) of up to seven jobs already in the systembefore which this job must run. Separate each job name with acomma. BEFORE dynamically increments the hold count onthe successor job(s). If a successor job is not in the systemwhen this job is read in, the successor’s hold count is notincremented, and BEFORE is ignored. BEFORE can refer toany job, whether or not it is part of a dependent jobnet.

Continued on next page

Page 214: ESP 5.2 Command Reference

214

DJCDATA Statement, Continued

Syntax (continued)

Parameter Description AF(jobname) Indicates the name(s) of up to seven job(s) already in the

system after which this job must run. Separate each job namewith a comma. AFTER dynamically increments the hold counton this job to correspond to the appropriate number of AFTERjobnames specified. If any predecessor job is not in the systemwhen this job is read in, its AFTER count is ignored. AFTERcan refer to any job, whether or not it is part of a dependentjobnet.

NC Indicates the action to be taken for this job when anypredecessor terminates normally:

• D - decrement the NHOLD count of this job. If theNHOLD count goes to zero, this job becomes eligible forexecution. This is the default.

• F - flush this job from the system. The job is canceled, andany output is printed. To any successor job, this appears asan abnormal termination.

• R - retain this job in the system and do not decrement theNHOLD count. This suspends the job and its successorsfrom execution until either the predecessor job isresubmitted, or the operator decreases the NHOLD count.

AB Indicates the action to be taken for this job when anypredecessor terminates abnormally:

• R - retain this job in the system and do not decrement theNHOLD count. This suspends the job and its successorsfrom execution until either the predecessor job isresubmitted, or the operator decreases the NHOLD count.This is the default.

• D - decrement the NHOLD count of this job. If the NHOLDcount goes to zero, this job becomes eligible for execution.

• F - flush this job from the system. The job is cancelled, andany output is printed. To any successor job, this appears asan abnormal termination.

NR Indicates a net release. This job is a predecessor to a job inanother jobnet.• netid specifies the NETID name of the successor job.• jobname identifies the name of the successor job.

You can specify up to fourteen jobs in other jobnets, separatingeach netid-jobname pair with a comma.

Note: JES3 only supports 1 NETID per net release statement.

Continued on next page

Page 215: ESP 5.2 Command Reference

215

DJCDATA Statement, Continued

Syntax (continued)

Parameter Description OH Indicates whether the job is to be placed into dependent job

operator hold:

• NO - specifies that the job is to be processed normally,without operator intervention. This is the default.

• YES - specifies that the job is placed in dependent jobnetwork operator hold. This prevents execution of this jobuntil the operator explicitly releases it.

LN Indicates the disposition of a previous jobnet with the samename:

• N - this is not the first job of a new jobnet and normalprocessing should take place. This is the default.

• R - this is the first job of a new jobnet. Any jobs already onthe system that are in a jobnet with the same NETID, arereleased.

• C - this is the first job of a new jobnet. Any jobs already onthe system that are in a jobnet with the same NETID, arecanceled.

ABCMP Indicates what action JES3 is to take if the job abnormallyterminates:

• NOKP - purge the DJC network if the job abnormallyterminates and has not been resubmitted by the time theother jobs in the network have completed. JES3 purges thenetwork unless successor jobs or sub-networks are missing.This is the default.

• KEEP - keep the DJC network in the system until either thejob is resubmitted and completes normally or the operatorforces the network from the system.

This parameter is for use only with JES3. NRCMP Indicates that a network job, which completed normally is

being resubmitted and that JES3 must erase all references to thejob before the job re-enters the network. The actions for JES3to take are:

• HOLD - hold the job until the operator releases it. This isthe default.

• NOHO - allow the job to be scheduled as system resourcesbecome available.

• FLSH - flush the job from the system.

This parameter is only for use with JES3

Continued on next page

Page 216: ESP 5.2 Command Reference

216

DJCDATA Statement, Continued

Usage notes To use this statement, you must have JES3 or Cybermation’s DJC (Dependent Job

Control) product installed.

It is recommended that you use the job statement elements ‘AFTER’, ‘RELEASE’or one of the requisite statements for job dependency purposes because the requiredNET card information is then automatically built for you. If ‘DJCDATA’ isspecified, any parameters used are merged with the NET card informationautomatically generated in the ESP Procedures, without being checked.

The DJCDATA statement can only be used for a job in either a DJC jobnet or anESP Application. If a job belongs to neither of these then use a job specificautomatic variable to insert the required DJC parameters.

For a job defined in an ESP Application, you can use the RS parameter to identifyDJC resource requirements.

RelatedStatements

For information on Dependent Job Control Card specifications, see the DJC User’sGuide.

Example 1 The following DJCDATA statement is used to request two tape drives and release a

job in another network:

JOB PAYJOB1DJCDATA NETID(PAYNET) TC(2) NR(OTHERNET,PAYJOB99)

ENDJOB

In the above example, PAYJOB1:

• Is part of a net called ‘PAYNET’• Requires two tape drives• Releases PAYJOB99, which belongs to a net called ‘OTHERNET’ after its

successful completion.

Example 2 The following DJCDATA statement is used to request two separate resources:

JOB PAYJOB2DJCDATA RS(1,CICS,1,SCRTAPES)

ENDJOB

In the above example, PAYJOB2:

• Requires 1 unit of a resource called CICS• Requires 1 unit of a resource call SCRTAPES.

Continued on next page

Page 217: ESP 5.2 Command Reference

217

DJCDATA Statement, Continued

Example 3 The following DJCDATA statement is used to request that a job wait until a

resource is not available:

JOB PAYJOB3DJCDATA RS(¬IMSUP)

ENDJOB

In the above example, PAYJOB3 waits until a resource called IMSUP is notavailable.

Example 4 The following DJCDATA statement is used to request that a job only run when the

quantity of a resource is less than 5:

JOB PAYJOB4DJCDATA RS(<5,SCRTAPES)

ENDJOB

In the above example, PAYJOB4 runs only when the available number of units of aresource called SCRTAPES is less than 5.

Example 5 The following DJCDATA statement is used to define a job on operator hold:

JOB PAYJOB5DJCDATA OH(YES)

ENDJOB

In the above example, PAYJOB5 is defined on operator hold.

Page 218: ESP 5.2 Command Reference

218

DJCNET Statement

Overview The DJCNET statement is used to identify that jobs with dependencies are

controlled by DJC (Dependent Job Control) or by JES3. It also specifies the defaultnetwork name for dependent jobs.

Type DJC Network statement.

Syntax The syntax of the DJCNET statement is:

DJCNET netid

Parameter Description

netid Indicates a job network identifier. The maximum length of thenetid is 8 characters. The first character cannot be a number.The netid applies unless:

• You override the netid name with the DJCDATA statementat the job level

• Another DJCNET statement with a different netid appearsin the same ESP Procedure.

Usage notes In ESP you can define groups of related jobs as either a DJC or JES3 job network or

an ESP Application. Applications provide more flexibility and are easier to workwith.

At the initiator stage, ESP submits network jobs to the JES queue when the Event isscheduled or triggered. Each job requires a NET control statement in its JCL thatidentifies:

• The specific network to which it belongs• The dependent actions that are necessary (e.g. completion of a predecessor job)

before JES can initiate the job.

The DJCNET statement allows you to specify the default net identifier for jobs in anESP Procedure.

Jobs defined using DJC or JES3 networks are not available for viewing ormanipulation via the Consolidated Status Facility (CSF) or the Application statuspanels. The CSF and Application status panels are available only for jobs belongingto ESP Applications.

Jobs defined using job networks are viewed and controlled using JES commands.

Continued on next page

Page 219: ESP 5.2 Command Reference

219

DJCNET Statement, Continued

Relatedinformation

For information on DJC, see the DJC User’s Guide.

For information on using DJC or JES3 statements for a job, see the DJCDATAstatement.

Example 1 The following DJCNET statement is used to group related jobs into a DJC network:

DJCNET PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN DAILYRELEASE PAYJOB2

JOB PAYJOB2RUN DAILYRELEASE PAYJOB3

JOB PAYJOB3RUN DAILY

ENDJOB

In the above example, PAYJOB1, PAYJOB2 and PAYJOB3 are grouped together ina DJC network called PAYROLL.

Page 220: ESP 5.2 Command Reference

220

DN Command

Overview The DN command is used to display the names of jobs, TSO users and started tasks

on the P-Node queues.

Type General command.

Authority OPER authority is required to issue the DN command.

Syntax The syntax of the DN command is:

DN [QUEUE(pnodename[,pnodename]...)][JOB[(jobname[,jobname]...)]][TSU[(tsuname[,tsuname]...)]][STC[(stcname[,stcname]...)]][OVERDUE(mins)][AT(time)][TIME][DATE][COMPRESSED][DUE][SID]

Parameter Description

pnodename Indicates the name or names of P-Node(s) to be displayed.Several names can be specified, enclosed in parentheses andseparated by a blank or comma. The names can containasterisks and end with a hyphen for a generic specification.

jobname Indicates the name or names of jobs to be displayed. Severalnames can be specified, if separated by a comma. The namescan contain asterisks and end with a hyphen for a genericspecification.

tsuname Indicates the name(s) of TSO users to be displayed. Severalnames can be specified if separated by a comma. The namescan contain asterisks and end with a hyphen for genericspecification.

stcname Indicates the name(s) of started tasks to be displayed. Severalnames can be specified, if separated by a comma. The namescan contain asterisks and end with a hyphen for a genericspecification.

mins Indicates an overdue amount. Jobs are displayed if they areoverdue by the specified number of minutes. If OVERDUE isspecified with no Parameters, 0 is assumed.

Continued on next page

Page 221: ESP 5.2 Command Reference

221

DN Command, Continued

Syntax (continued)

Parameter Description AT(time) Used together with the DUE or OVERDUE keywords,

requests a display of jobs that would be overdue if notcomplete at the specified time. The time can contain a freeformat date and time specification. It should be enclosed inquotes if it contains a blank or comma.

TIME Indicates the time the job entered the P-Node queue isdisplayed.

DATE Indicates the date the job came into the P-Node queue isdisplayed.

COMPRESSED Indicates the display is compressed to get as many entries ona line as possible. In addition, only the first eight charactersof a P-Node name are displayed.

DUE Indicates the dueout time for each job is displayed. Jobs thatdo not have a dueout time are marked as having no due time.To identify a job as having a dueout time, use the DUEOUTor LATESUB Application statements.

SID Indicates the system ID, where the JOB/STC/TSU was lastposted from, be displayed.

Usage notes As an alternative to using the DN command to display the names of jobs on the P-Node queues, you can use the Consolidated Status Facility (CSF) for monitoring andcontrolling jobs in Applications.

Relatedinformation

For information on displaying the number of jobs on each queue, see the DQcommand.

For information on defining processing nodes (P-Nodes), see the ESP WorkloadManager Advanced User’s Guide.

For information on posting a job complete from a manual P-Node, see the POSTcommand.

For information on monitoring and controlling workload using the CSF, see the ESPWorkload Manager User’s Guide.

Example 1 The following DN command displays all queues:

DN

In the above example, all P-Node queues are displayed.

Continued on next page

Page 222: ESP 5.2 Command Reference

222

DN Command, Continued

Example 2 The following DN command displays the execution P-Node:

DN QUEUE(EXEC) JOB(-)

In the above example, all jobs on the execution P-Node are displayed.

Example 3 The following DN command displays specific jobs:

DN JOB(A-,B-) QUEUE(INPUT) DATE TIME

In the above example, jobs with names that start with A or B in the INPUT queueare displayed. The date and time the jobs entered their respective queues are alsoshown.

Example 4 The following DN command displays overdue jobs:

DN OVERDUE(10) AT(6AM) DUE

In the above example, any job that would be more than ten minutes overdue if itdoes not complete by 6 am is displayed. The due time for each job is displayed aswell as the jobname, number and P-Node name.

Page 223: ESP 5.2 Command Reference

223

DO Statement

Overview The DO statement is used to identify the start of a set of instructions.

Type ESP Control Language (CLANG) statement.

Syntax The syntax of the DO statement is:

DO

Usage notes The DO statement is normally used in conjunction with THEN and ELSE

statements. It groups instructions together, until an ENDDO statement isencountered.

You do not require a DO statement if you have only one instruction. DO must followimmediately after THEN or ELSE, or begin the continuation line. Do not use acontinuation character (– or +) on a DO statement.

The DO statement does not have to be used in conjunction with a THEN or ELSEstatement.

Relatedinformation

For information on ending a set of instructions, see the ENDDO command.

For information on using ESP’s Control Language, see the ESP Workload ManagerUser’s Guide.

Example 1 The following DO and ENDDO statements are used to identify the start and end of a

set of instructions:

IF TODAY(‘LAST WORKDAY OF MONTH’) THEN -DO

SELECT PAYJOB2SEND ‘SUBMITTING MONTH END JOB’ USER(CYB01)

ENDDO

In the above example, on the last workday of the month, ESP:

• Selects PAYJOB2• Sends a message to user CYB01.

Continued on next page

Page 224: ESP 5.2 Command Reference

224

DO Statement, Continued

Example 2 The following DO and ENDDO statements are used to identify the start and end of a

set of compound action statements:

IF DAYS_FROM(‘JAN’) GT 7 THEN DOESP RESUME CYBER.YECHEQUEESP TRIGGER CYBER.YECHEQUE ADDSEND ‘YEAR-END CHEQUES TRIGGERED’ U(CYB02)

ENDDO

In the above example, an ESP built-in function (DAYS_FROM) is used to calculatethe number of days from January 1st. If the number of days from January 1st isgreater than 7, ESP:

• Resumes and then triggers an Event called CYBER.YECHEQUE• Sends a message to user CYB02.

Example 3 The following DO and ENDDO statements are used to identify the start and end of a

set of instructions:

APPL PAYROLLJCLLIB ‘CYBBS01.JCLLIB.CNTL’JOB PAYJOB3

RUN DAILYDO

SEND ‘MESSAGE #1’ U(CYB03)SEND ‘MESSAGE #2’ U(CYB03)

ENDDOENDJOB

In the above example, when the PAYROLL Application is generated PAYJOB3 issubmitted and two messages are sent to user CYB03.

Note: In this example, the DO - ENDDO pairing is not used in conjunction with aTHEN or an ELSE statement.

Example 4 The following DO and ENDDO statements are used to identify the start and end of

an instruction:

IF ACTIVE(‘CICS’) THEN -DO

SEND ‘CICS IS ACTIVE’ CN(01)ENDDO

In the above example, there is only one instruction to process if the IF statementreturns a true value. You can use DO and ENDDO to identify the start and end ofthe instruction.

Alternatively, you could use the following:

IF ACTIVE(‘CICS’) THEN -SEND ‘CICS IS ACTIVE’ CN(01)

Page 225: ESP 5.2 Command Reference

225

DOCLIB Statement

Overview The DOCLIB statement is used to identify the name of the job documentation

library to be used throughout an ESP Procedure. Specifying a DOCLIB statementallows you to use control and user description information, which are components ofESP’s job documentation feature.

Type ESP Procedure statement.

Syntax The syntax of the DOCLIB statement is:

DOCLIB dsname

Parameter Description

dsname Indicates the name of the PDS where the job documentationresides.

Usage notes A job documentation entry is a member of a partitioned data set (PDS). Each entry

consists of the following information:

• Control information - information that ESP uses directly when processing a job,such as the JCL library, job dependencies, and schedule frequency.

• User description - other information you wish to store about a job. For example,ABEND codes, messages, restart instructions, and so on.

You can retrieve job documentation information by the Consolidated Status Facility(CSF), or the JOBINFO (JI) command.

You can access job documentation information directly from CSF with the followingcommands. ESP retrieves the information from the data set identified by theDOCLIB statement in an ESP Procedure.

• BD - browse job documentation• ED - edit job documentation.

The DOCLIB statement can be used to specify the job documentation library youwant used throughout the ESP Procedure. For any job, the documentation librarymember with the same name is accessed unless overridden with a DOCMEMkeyword for the job.

Multiple DOCLIB statements can be specified throughout an ESP Procedure.Where the DOCLIB statements are placed determines where ESP looks to obtain jobdocumentation information. A DOCLIB statement applies to all jobs that follow it,until a new DOCLIB statement occurs.

Continued on next page

Page 226: ESP 5.2 Command Reference

226

DOCLIB Statement, Continued

RelatedStatements

For information on using job documentation, see the ESP Workload Manager User’sGuide.

Example 1 The following DOCLIB statement is used to identify the name of the job

documentation library:

APPL PAYROLLJCLLIB ‘CYBER.JCLLIB.CNTL’DOCLIB ‘CYBER.DOCLIB.CNTL’JOB PAYJOB1JOB PAYJOB2JOB PAYJOB3ENDJOB

In the above example, ESP retrieves job documentation information from‘CYBER.DOCLIB.CNTL’ for all jobs in the PAYROLL Application.

Example 2 The following DOCLIB statement is used to identify the name of the job

documentation library:

APPL PAYROLLJCLLIB ‘CYBER.JCLLIB.CNTL’DOCLIB ‘CYBER.DOCLIB.CNTL’JOB PAYJOB4JOB PAYJOB5DOCLIB ‘CYBER.ALT.DOCLIB.CNTL’JOB PAYJOB6ENDJOB

In the above example, ESP retrieves job documentation information for jobs in thePAYROLL Application as follows:

• For PAYJOB4 and PAYJOB5, ESP looks in CYBER.DOCLIB.CNTL for jobdocumentation information

• For PAYJOB6, ESP looks in CYBER.ALT.DOCLIB.CNTL for jobdocumentation information.

Example 3 The following DOCLIB statement is used to identify the name of the job

documentation library:

DJCNET PAYROLLJCLLIB ‘CYBER.JCLLIB.CNTL’DOCLIB ‘CYBER.DOCLIB.CNTL’JOB PAYJOB7JOB PAYJOB8JOB PAYJOB9ENDJOB

In the above example, ESP retrieves job documentation information fromCYBER.DOCLIB.CNTL for all jobs in a DJC network called PAYROLL.

Page 227: ESP 5.2 Command Reference

227

DQ Command

Overview The DQ command is used to display the names of all or selected P-Node queues,

along with the number of jobs in each queue.

Type General command.

Authority OPER authority is required to issue the DQ command.

Syntax The syntax of the DQ command is:

DQ [QUEUE(pnodename],pnodename]...)]

Parameter Description

pnodename Indicates the name or names of the P-Node to be displayed.Several names can be specified, enclosed in parentheses andseparated by a blank or comma. The names can containasterisks and can end with a hyphen for a genericspecification.

Usage notes As an alternative to using the DQ command to display the P-Node queues, you can

use the Consolidated Status Facility (CSF) for monitoring and controlling jobs inApplications.

Relatedinformation

For information on displaying the names of the jobs in each queue, see the DNcommand.

For information on defining processing nodes (P-Nodes), see the ESP WorkloadManager Advanced User’s Guide.

For information on the CSF, see the ESP Workload Manager User’s Guide.

Example 1 The following DQ command displays all P-Node queues:

DQ

In the above example, all P-Node queues and the corresponding number of jobs ineach of those P-Node queues are displayed.

Continued on next page

Page 228: ESP 5.2 Command Reference

228

DQ Command, Continued

Example 2 The following DQ command displays a specific P-Node queue:

DQ QUEUE(EXEC)

In the above example, the EXEC (execution) P-Node is displayed, along with thenumber of jobs in this P-Node queue.

Example 3 The following DQ command displays a specific P-Node queue:

DQ QUEUE(INPUT EXEC)

In the above example, the INPUT (input) and EXEC (execution) P-Nodes aredisplayed, along with the number of jobs in these P-Node queues.

Page 229: ESP 5.2 Command Reference

229

DSNAME Statement

Overview The DSNAME statement is used in conjunction with the DSTRIG workload object,

and is used to build a data set dependency at the job level into ESP Applications.This statement can identify the creation, closure or renaming of a data set by a job,started task, or TSO user.

Type ESP Application statement.

Syntax The syntax of the DSNAME statement is:

DSNAME dsname[JOBNAME(jobname)][RENAME][ANYCLOSE][COUNT(n)]

Parameter Description

dsname Indicates the full name or generic prefix of a data set. Ageneric prefix is specified by attaching a hyphen ‘-‘ tothe end of the name. The data set name should start withthe high-level index, because the current TSO data setprefix is not used. Use of quotation marks is optional.

JOBNAME(jobprefix) Indicates the full name or generic prefix of a jobname.A generic prefix is signified by a trailing hyphen ‘-‘.This can also be a TSO ID.

RENAME Indicates the trigger should occur if a data set is renamedto dsname. The new data set name becomes thetriggering data set name.

ANYCLOSE Indicates the trigger should occur on any output closureof the specified data set, rather than just the closure of anewly created data set. If you do not use this parameter,the trigger occurs only if the specified data set is created.

COUNT(n) Indicates the trigger should occur every n closures of thespecified data set, where n is a number from 0 - 255.The default is 1.

Continued on next page

Page 230: ESP 5.2 Command Reference

230

DSNAME Statement, Continued

Usage notes The DSTRIG statement defines workload objects associated with an MVS data set

trigger. Within the scope of the DSTRIG workload object, the DSNAME statementis used to describe the trigger.

If you use COUNT, the CSF STATUS field displays this value and the currentcount.

Only one DSNAME statement is allowed per data set trigger object.

ESP does not complete a data set trigger object when the data set closes during theabnormal termination of a task or job step.

You can use the JOB parameter to restrict the trigger to a specific job, started task orTSO user. A batch job running under a user ID does not affect the trigger.

SMF records Data set triggering is based on the creation of certain SMF records. SMF recordtypes 14, 15 and 64 represent the closing of a data set.

Type 14 records are generated by the system when a non-VSAM data set is closed,after it is opened for input. In such a case, the data set was only read by the openingprogram, but not updated. No data set triggering should take place, and thereforeESP ignores these records.

Type 15 records are generated when a non-VSAM data set is closed, after havingbeen opened for output. A new data set might have been created (DISP=NEW) or anexisting data set might have been rewritten or updated (DISP=OLD or MOD).

If ANYCLOSE was specified in the DSTRIG statement, the data set trigger object iscompleted when a type 15 record is detected by ESP. If ANYCLOSE was notspecified, ESP checks to see if the type 15 record represents a new data set beingcreated. If so, the data set trigger object is completed. If an existing data set wasupdated, the trigger does not take place.

Type 15 records are also generated when end-of-volume (EOV) processing takesplace. These records are ignored by ESP. ESP also ignores records pertaining toVIO or temporary data sets.

Type 64 records are generated when a VSAM data set is closed or when EOVprocessing takes place. As with type 15 records, EOV records are ignored. ESPalso ignores TCLOSE records (CLOSE TYPE=T) and records not pertaining to theDATA component of a VSAM cluster.

Relatedinformation

For information on data set triggering at the job level, see the DSTRIG statement.

For information on Application, see the ESP Workload Manager User’s Guide.

For information on data set triggering at the Event level, see the ESP WorkloadManager User’s Guide.

Continued on next page

Page 231: ESP 5.2 Command Reference

231

DSNAME Statement, Continued

Example 1 The following example builds a job-level data set-trigger dependency:

APPL PAYROLLJCLLIB ‘CYB.JCL.CNTL’DSTRIG WAIT4.DLY

DSNAME PROD.DAILY.ACCNTSRUN DAILYREL PAYJOB2

JOB PAYJOB2RUN DAILY

ENDJOB

In the above example, WAIT4.DLY is used to build a job-level dependency with theclosure of a newly created data set called PROD.DAILY.ACCNTS.

Example 2 The following example builds a job-level data set-trigger dependency:

APPL PAYROLLJCLLIB ‘CYB.JCL.CNTL’DSTRIG WAIT4.WKLY

DSNAME PROD.WEEKLY.ACCNTS ANYCLOSERUN DAILYREL PAYJOB4

JOB PAYJOB4RUN DAILY

ENDJOB

In the above example, WAIT4.WKLY is used to build a job-level dependency withany closure of a data set called PROD.WEEKLY.ACCNTS.

Continued on next page

Page 232: ESP 5.2 Command Reference

232

DSNAME Statement, Continued

Other examples Here are more examples using the DSNAME Statement.

Trigger occurs after every second closure of a data set:

DSNAME CYBER.CYCLES COUNT(2)

Trigger occurs when a data set is renamed to SYS1.TEMP.DATA:

DSNAME SYS1.TEMP.DATA RENAME

Trigger occurs when a generation is created:

DSNAME USER1.PAYROLL.G-

Trigger occurs when a generation is created by a specific job:

DSNAME USER1.PAYROLL.G- JOB(ABC)

Page 233: ESP 5.2 Command Reference

233

DSTRDLY Command

Overview The DSTRDLY command is used to delay data set triggered Events or data set

trigger objects when data set activity occurs.

Type General command.

Authority OPER authority is required to issue the DSTRDLY command.

Syntax The syntax of the DSTRDLY command is:

DSTRDLY [nn|0]

Parameter Description

nn Number of seconds to delay. The default is zero.

Usage notes Data set triggered Events or data set trigger objects may trigger too soon after a data

set has been closed. This parameter causes a global delay of data set triggers. Forexample, a data set trigger may occur after a data set is created but prior to the dataset being cataloged.

This is normally coded as an ESP Initialization Parameter.

To display what the data set trigger delay value is currently set to issue theDSTRDLY command with no operands.

Relatedinformation

For information on data set triggering at the job level, see the DSTRIG or DSNAMEstatements.

For information on data set triggering at the Event level, see the ESP WorkloadManager User’s Guide.

Example 1 The following DSTRDLY command displays the data set trigger delay value:

OPER DSTRDLY

In the above example, issuing DSTRDLY with no operand produces the followingdisplay indicating that the current data set trigger delay value is set to zero:

DATASET TRIGGER DELAY VALUE CURRENTLY SET AT 0 SECONDS

Continued on next page

Page 234: ESP 5.2 Command Reference

234

DSTRDLY Command, Continued

Example 2 The following DSTRDLY command sets the data set trigger delay value:

DSTRDLY 15

In the above example, data set triggered Events or data set trigger objects aredelayed by 15 seconds.

Page 235: ESP 5.2 Command Reference

235

DSTREXCL Command

Overview The DSTREXCL command is used to flag an entry in the Data set Trigger Exclude

list as invalid. These entries are not actually deleted from the list. Entries flaggedas inactive are converted to lowercase.

Type General command.

Authority OPER authority is required to issue the DSTREXCL command.

Syntax The syntax of the DSTREXCL command is:

DSTREXCL {pgmname}[(pgmname[,pgmname]...)]

Parameter Description

pgmname Indicates the name of a program to be flagged as no longerpart of the Data set Trigger Exclude list.

Usage notes The Data set Trigger Exclude list consists of a list of programs that are not eligible

for data set triggering. The DSTREXCL Initialization Parameter specifies these.Once this list has been built, you use the DSTREXCL command to flag an entry inthe Data set Trigger Exclude list as invalid.

Relatedinformation

For information on adding an entry to the Data set Trigger Exclude list, see theDSTREXCL Initialization Parameter in the ESP Workload Manager InstallationGuide.

For information on displaying the Data set Trigger Exclude list, see the LDTRELcommand.

Continued on next page

Page 236: ESP 5.2 Command Reference

236

DSTREXCL Command, Continued

Examples The following DSTREXCL Initialization Parameter indicates that a specific program

is not eligible for data set triggering:

DSTREXCL PGM999

Issue the LDTREL to display the Data set Trigger Exclude list:

DSTRIG exclude PGM=PGM999

To flag an entry in the Data set Trigger Exclude list as invalid, issue the followingDSTREXCL command from Page mode:

DSTREXCL PGM999

In the above example, PGM999 is flagged as being invalid. PGM999 is not actuallydeleted from the list, its entry is converted to lowercase as follows:

DSTRIG exclude PGM=pgm999

Page 237: ESP 5.2 Command Reference

237

DSTRIG Command

Overview The DSTRIG command is used to trigger an Event automatically by the creation,

closure or renaming of a data set by a job, started task or TSO user. Triggering canbe restricted to data sets created by a specific job or group of jobnames. Events canalso be made to wait for triggers from activity in more than one data set. ESPaccomplishes data set triggering by watching all SMF records generated by thesystem. SMF record type 14, 15 and 64 are the records that represent the closing ofa data set.

Type Event definition command.

Syntax The syntax of the DSTRIG command is:

DSTRIG dsname [JOB(jobname)][MULTIPLE][PRIMED][RENAME][ANYCLOSE][COUNT(n)][CURRENT(n)]

Parameter Description

dsname Indicates the full name or generic prefix of a data set. Ageneric prefix is specified by attaching a hyphen ‘-’ to the endof the name. You can use a hyphen only at the end of thename. The data set name should start with the high-levelindex, because the current TSO data set prefix will not beused.

jobname Indicates the full name or generic prefix of a jobname. Ageneric prefix is signified by a trailing hyphen ‘-’. This canalso be a TSO ID.

MULTIPLE Indicates closure of at least one other data set is needed totrigger this Event. The Event does not execute until allspecified data set triggers are detected. MULTIPLE must bespecified on each DSTRIG command for the required datasets.

PRIMED Indicates a data set trigger was already detected for this dataset. This parameter is used only when redefining an Event,when one of the specified multiple data set triggers is alreadydetected.

RENAME Indicates the trigger should also occur if a data set is renamedto the dsname specified. The new data set name becomes thetriggering data set name.

Continued on next page

Page 238: ESP 5.2 Command Reference

238

DSTRIG Command, Continued

Syntax (continued)

Parameter Description ANYCLOSE Indicates the trigger should occur on any output closure of the

specified data set, rather than just the closure of a newlycreated data set. If you do not use this parameter, an Event istriggered only if the specified data set is created.

COUNT Indicates the Event is to be scheduled for every n triggers,where n is a number from 0 to 255. A value of 0 results in aschedule for each trigger, as does a value of 1. It defaults to1.

CURRENT Used with the COUNT parameter, it optionally sets the initialtrigger count. The value n can range from 0 to 255. Itdefaults to 0.

Usage notes ESP does not trigger a data set triggered Event when the data set closes during an

abnormal termination of a task or job step. Allocating a partitioned data set in ISPFor executing an IEFBR14 will also not satisfy a data set triggered Event.

The DSTRIG command is used to request that the Event is triggered on the creationor closure of a data set. The trigger actually occurs at the time the data set is closed.If multiple files in a step reference the data set, the trigger occurs only if the filebeing closed is the one that specifies DISP=NEW.

Several DSTRIG commands can be specified for one Event, and each can maintainseparate counters. If the Event also contains SCHEDULE commands, executionscaused by the time schedules do not affect the DSTRIG counters. If you want anEvent to wait on both schedule criteria and data set close criteria, use theHOLD/RELEASE Event definition commands or the data set triggering featurewithin an ESP Application.

When an Event needs more than one data set closure to be eligible for execution, usethe MULTIPLE keyword on each corresponding DSTRIG command. Individualdata set closures are detected, but the Event does not execute until all other DSTRIGcommands with the MULTIPLE keyword also detect data set closures.

You can use the JOB parameter to restrict the trigger to a specific job, started task orTSO user. A batch job running under a user ID does not affect the trigger.

Continued on next page

Page 239: ESP 5.2 Command Reference

239

DSTRIG Command, Continued

SMF records

Type 14 records are generated by the system when a non-VSAM data set is closed,after it is opened for input. In such a case, the data set was only read by the openingprogram, but not updated. No data set triggering should take place, and thereforeESP ignores these records.

Type 15 records are generated when a non-VSAM data set is closed, after havingbeen opened for output. A new data set might have been created (DISP=NEW) or anexisting data set might have been rewritten or updated (DISP=OLD or MOD).

If ANYCLOSE was specified in the DSTRIG statement, the Event is triggered whenESP detects a type 15 record. If ANYCLOSE was not specified, ESP checks to seeif the type 15 record represents a new data set being created. If so, the Event istriggered. If an existing data set was updated, the trigger does not take place.

Type 15 records are also generated when end-of-volume (EOV) processing takesplace. ESP ignores these records. ESP also ignores records pertaining to VIO ortemporary data sets.

Type 64 records are generated when a VSAM data set is closed or when EOVprocessing takes place. As with type 15 records, EOV records are ignored. ESPalso ignores TCLOSE records (CLOSE TYPE=T) and records not pertaining to theDATA component of a VSAM cluster.

Relatedinformation

For information on data set triggering at the Event level, see the ESP WorkloadManager User’s Guide.

For information on displaying data set triggered Events, see the LDXE command.

For information on displaying data sets being checked for closures, creations orrenames, see the LDTE command.

For information on data set triggering at the job level, see the DSTRIG or DSNAMEstatements.

Example 1 The following Event triggers upon any closure of a specific data set:

EVENT ID(CYB.PAYDLY)DSTRIG PROD.PAYROLL.FILE123 ANYCLOSEINVOKE ‘CYB.ESP.PROCS(PAYDLY)’ENDDEF

In the above example, any closure of PROD.PAYROLL.FILE123 automaticallytriggers this Event.

Continued on next page

Page 240: ESP 5.2 Command Reference

240

DSTRIG Command, Continued

Example 2 The following Event triggers upon the creation of a data set:

EVENT ID(CYB.PAYWKLY)DSTRIG PROD.PAYROLL.G- JOB(PAYJOB1)SUBMIT ‘CYB.JCL.CNTL(PAYWKLY)’ENDDEF

In the above example, when a generation of PROD.PAYROLL is created byPAYJOB1, this Event is automatically triggered.

Example 3 The following Event triggers upon any closure of a specific data set and the creation

of another data set:

EVENT ID(CYB.PAYMTH)DSTRIG PROD.PAYROLL.FILE999 ANYCLOSE MULTIPLEDSTRIG PROD.PAYROLL.G- JOB(PAYJOB2) MULTIPLEINVOKE ‘CYB.ESP.PROCS(PAYMTH)’ENDDEF

In the above example, coding MULTIPLE on each DSTRIG command indicates thatthis Event is not triggered until both of the following criteria have been met:

• Any closure of PROD.PAYROLL.FILE999• PAYJOB2 creates a generation of PROD.PAYROLL.

Example 4 The following Event triggers every 255 closures of a specific data set:

EVENT ID(CYB.PAYBKUP)DSTRIG PROD.ESP.COPYJCL ANYCLOSE COUNT(255)INVOKE ‘CYB.ESP.PROCS(PAYBKUP)’ENDDEF

Example 5 The following Event triggers when a data set is renamed:

EVENT ID(CYB.PAYMTH)DSTRIG CYB.ESP.DATA RENAMEINVOKE ‘CYB.ESP.PROCS(PAYMTH)’ENDDEF

In the above example, when a data set is renamed to CYB.ESP.DATA, this Event isautomatically triggered.

Continued on next page

Page 241: ESP 5.2 Command Reference

241

DSTRIG Command, Continued

Example 6 The following Event triggers when a user closes a data set:

EVENT ID(PROD.POST)DSTRIG CICS.WORLD.WIDE ANYCLOSE JOB(USERWK)INVOKE ‘PROD.ESP.PROCS(POST)’ENDDEF

In the above example, when USERWK closes the CICS.WORLD.WIDE data set, thePROD.POST Event triggers. If, however, USERWK submits a job that closes thedata set, ESP uses the job name, not the user ID to determine if the Event shouldtrigger.

Page 242: ESP 5.2 Command Reference

242

DSTRIG Statement

Overview The DSTRIG statement defines a workload object associated with an MVS data set

trigger and is used in conjunction with the DSNAME statement to build a data setdependency at the job level into ESP Applications.

Type ESP Application statement.

Syntax The syntax of the DSTRIG statement is:

{DSTRIG|DT} name[.qualifier][REQUEST][HOLD][CONDITIONAL]

Parameter Description

name Indicates a workload object name in up to eight characters. qualifier Indicates a workload object qualifier in up to eight

characters. It must immediately follow the workload objectname separated by a period.

REQUEST Indicates this is an on-request workload object. HOLD Indicates the workload object is to be placed on manual

hold when ESP generates the Application. You can releasea workload object from manual hold using the CSF or theAPPLJOB (AJ) command. The object completesautomatically while in this state.

CONDITIONAL Indicates this workload object may or may not execute.The Application this workload object belongs to isconsidered complete when all NOCONDITIONALworkload objects are complete.

Usage notes The DSTRIG statement defines a workload object that represents an MVS data set

trigger.

Use the DSNAME statement to identify the requirements of the data set trigger.When these requirements are met, ESP completes the data set trigger object.

Only one DSNAME statement can be used per data set trigger workload object.

A data set trigger object can have a time dependency, or a predecessor dependency,or it can be defined on hold. Each of these conditions prevents the data set objectfrom completing.

You can manipulate (for example holding and resetting the time) a data set triggerobject before it becomes ready (the dependencies are met). Once it is ready, the onlyaction you can take against it is complete.

Continued on next page

Page 243: ESP 5.2 Command Reference

243

DSTRIG Statement, Continued

Relatedinformation

For information on data set triggering at the job level, see the DSNAME statement.

For information on Application, see the ESP Workload Manager User’s Guide.

For information on data set triggering at the Event level, see the ESP WorkloadManager User’s Guide.

For information on displaying data set triggers, see the LDXE command.

Example 1 The following example builds a job-level data set trigger dependency:

APPL PAYROLLJCLLIB ‘CYB.JCL.CNTL’DSTRIG WAIT4.DLYDSNAME PROD.DAILY.ACCNTSRUN DAILYREL PAYJOB2

JOB PAYJOB2RUN DAILY

ENDJOB

In the above example, WAIT4.DLY is used to build a job-level dependency with theclosure of a newly created data set - PROD.DAILY.ACCNTS.

Other examples Here are more examples using the DSTRIG statement.

Indicates a conditional data set trigger object that does not need to complete for theApplication to complete:

DSTRIG FILEA CONDITIONALRUN DAILYDSNAME CYBER.WEEKLY

ENDJOB

Indicates a time requirement for a data set trigger object. If the data set is createdprior to 6 pm, INPUT.DATA is not completed:

DSTRIG INPUT.DATARUN DAILYDELAYSUB 6PMDSNAME CYBER.BILLING

ENDJOB

Page 244: ESP 5.2 Command Reference

244

DSTRST Command

Overview The DSTRST command is used to control data set triggering activity.

Type General command.

Authority OPER authority is required to issue the DSTRST command.

Syntax The syntax of the DSTRST command is:

DSTRST{[SUSPEND|RESUME]}{[QUIESCE|RESTART]}[LOG|NOLOG]

Parameter Description

SUSPEND Suspends data set triggering. All data set triggers are ignored. RESUME Indicates data set trigger processing is resumed. This is the

opposite of SUSPEND. QUIESCE Indicates data set triggering is quiesced. Data set triggers are

detected but no action is taken until this command is issuedwith the RESTART parameter.

RESTART Indicates data set triggering is restarted, and all detectedtriggers processed. This is the opposite of QUIESCE.

LOG Activates data set trigger logging. A message is placed in theaudit log each time a data set is closed, and notifies youwhich Event is triggered.

NOLOG Deactivates data set trigger logging.

Usage notes To display the status of data set triggering, issue the DSTRST command with no

operands.

Relatedinformation

For information on data set triggering at the job level, see the DSTRIG or DSNAMEstatements.

For information on data set triggering at the Event level, see the ESP WorkloadManager User’s Guide.

Example 1 The following DSTRST command displays data set trigger options:

OPER DSTRST

In the above example, data set trigger options are displayed.

Continued on next page

Page 245: ESP 5.2 Command Reference

245

DSTRST Command, Continued

Example 2 The following DSTRST command reactivates data set triggering:

OPER DSTRST RESUME LOG

In the above example, data set triggering is reactivated following a suspension.Data set trigger logging is also activated.

Page 246: ESP 5.2 Command Reference

246

DUEOUT Statement

Overview The DUEOUT statement is used to indicate a due out time for a job from one or

more stages in processing. If the job has not completed the specified stage inprocessing by the due out time, the status field shows OVERDUE in theConsolidated Status Facility (CSF) display of the job.

Type ESP Application statement.

Syntax The syntax of the DUEOUT statement is:

DUEOUT pnodenametime

Parameter Description

pnodename Indicates a P-Node for which you want to specify a due outtime. The P-Nodes are as follows:

• INPUT - indicates the time when a job should start• EXEC - indicates the time when a job should complete

successfully. For links, tasks, and data set trigger objects,EXEC represents the time when it should be markedcomplete.

• OUTPUT - indicates the time when the job should beposted through output, if you are tracking through output.

• Manual - indicates manually defined processing stages.

Note: The P-Nodes used with the DUEOUT statement differfrom CSF P-Nodes.

time The time the job is due out of the specified processing stage.This can be specified in any format but must resolve to a singledate and time when the Application builds.

Continued on next page

Page 247: ESP 5.2 Command Reference

247

DUEOUT Statement, Continued

Usage notes The DUEOUT statement cannot be used outside the scope a job statement.

If the P-Node specified is not found in the job’s tracking model definition or, a P-Node specified on the P-Nodes element, the due out time and P-Node are added tothe end of the P-Node list for this job. The most common p-Nodes used for a job inan ESP Application are INPUT and EXEC.

The time parameter can request any time relative to the time the Application wasgenerated or DJC network submitted.

The DUEOUT statement overrides or sets the time by which this job should beposted out of the P-Node named. If not posted by this time, a message is sent to theoperator and the job is listed in the overdue queue display (DN OVERDUEcommand).

ESP can also send a message or trigger an Event when a job becomes overdue fromthe INPUT or EXEC processing nodes using a NOTIFY statement.

The DUEOUT statement propagates dueout times upstream, i.e. to all predecessorsof the job where a DUEOUT statement is specified. These dueout times are setrelative to the average elapsed times according to the information obtained fromESP’s history file.

Relatedinformation

For information on flagging a job as late for submission, see the LATESUBstatement.

For information providing notification on job status, see the ESP Workload ManagerAdvanced User’s Guide.

Example 1 The following DUEOUT statement indicates the time when a job is flagged as

overdue:

JOB PAYJOB1DUEOUT EXEC 3AM

ENDJOB

In the above example, if PAYJOB1 has not successfully completed the executionphase by 3 am, ESP flags it as overdue and the CSF shows OVERDUE in the Statusfield for the job. The 3 am time is relative to the scheduled time of the Event. Inthis example, if the Event is scheduled at 2 am, but is held up until 4 am, PAYJOB1is overdue when the Application builds.

Continued on next page

Page 248: ESP 5.2 Command Reference

248

DUEOUT Statement, Continued

Example 2 The following DUEOUT statement indicates the time when a task is flagged as

overdue:

JOB WAIT4.TAPE TASKDUEOUT EXEC NOW PLUS 2 HOURS

ENDJOB

In the above example, if WAIT4.TAPE is not marked complete 2 hours after thescheduled time of the Event, it is flagged as overdue and the CSF shows OVERDUEin the Status field for this task.

Example 3 The following DUEOUT statement indicates the time when a job is flagged as

overdue:

JOB PAYJOB2DUEOUT EXEC REALNOW PLUS 30 MINUTES

ENDJOB

In the above example, if PAYJOB2 has not completed successfully 30 minutes afterthe trigger time of the corresponding Event, it is flagged as overdue and the CSFshows OVERDUE in the Status field for the job.

Example 4 The following DUEOUT and ALERT statements indicate the time when a job is

flagged as overdue, and that a message is sent to a user:

JOB PAYJOB3NOTIFY OVERDUE USER(CYB01)DUEOUT EXEC 7AM

ENDJOB

In the above example, if PAYJOB3 is not successfully complete by 7 am:

• It is flagged as overdue and the CSF shows OVERDUE in the Status field forthe job

• A message indicating that PAYJOB3 is overdue is sent to CYB01.

Continued on next page

Page 249: ESP 5.2 Command Reference

249

DUEOUT Statement, Continued

Example 5 The following DUEOUT and ALERT statements indicate the time when jobs within

an Application are flagged as overdue, and that an Alert Event is triggered:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’NOTIFY OVERDUE ALERT(LATE)JOB PAYJOB4

DUEOUT INPUT 7AMRUN DAILYRELEASE PAYJOB5

JOB PAYJOB5DUEOUT EXEC 11AMRUN DAILY

ENDJOB

In the above example, a globally-placed NOTIFY statement and job specificDUEOUT statements are used to:

• Indicate that if any job within the PAYROLL Application becomes overdue, it isflagged as overdue and the CSF shows OVERDUE in the Status field for the job

• Trigger an Alert Event associated with an identifier of LATE.

This technique is useful if you want to provide notification of job status on all jobswithin an Application, as the DUEOUT statement is not available outside the scopeof a job statement.

Page 250: ESP 5.2 Command Reference

250

DURATION Statement

Overview The DURATION statement is used to tell ESP what duration to use for Critical Path.

Type ESP Application statement.

Syntax The syntax of the DURATION statement is:

DURATION value

Parameter Descriptionvalue Indicates the elapsed time estimate, in minutes, for a job.

Usage notes Situations may arise where you want to override historical elapsed times. Forexample, on the last day of the month, a job on the critical path may run longer thannormal. Or maybe no historical information exists for a job on the critical path,because this is the first run of the job. In these situations, you can override historicalelapsed time defaults (that ESP would normally use when calculating Critical Path)by using the DURATION statement to specify an estimated duration for the job.

Example The following example sets the elapsed time estimate for job A to 120 (minutes) onthe last day of the month:

JOB ARUN WORKDAYSIF TODAY(‘LAST DAY OF MONTH’) THEN DURATION 120

ENDJOB

RelatedStatements

For information on how to enable Critical Path analysis, see the CRITPATHcommand.

For information on specifying Critical Path analysis on individual Applications, seethe CRITPATH Application statement.

For information on Critical Path analysis, see the ESP Workload Manager User’sGuide.

Page 251: ESP 5.2 Command Reference

251

EARLYSUB Statement

Overview The EARLYSUB statement is used to specify a job for delayed (or early)submission relative to the scheduled time of the Event. If the Event is notscheduled, the delayed submission time is relative to the time the Application isgenerated.

Type ESP Application statement.

Syntax The syntax of the EARLYSUB statement is:

EARLYSUB criteria

Parameter Descriptioncriteria Schedule criteria that resolves to single date and time.

Usage notes Use the EARLYSUB statement within the scope of a JOB statement to request that ajob not be submitted until a specified time, even though its predecessors havecompleted. This time parameter can request any date or time relative to the time theApplication was schedule or generated.

If you trigger an Event with a time/date in the past, ESP does not honorEARLYSUB statements, except those that use the term REALNOW.

Although less commonly used, the EARLYSUB statement can be placed outside thescope of any JOB statements (globally) to delay all jobs that are placed after thatglobally placed EARLYSUB statement. Using this method sets a delayedsubmission time for all jobs within the Application, except for those specifying theEARLYSUB statement within the scope of the JOB statement. Jobs that have theirdelayed submission time set as a result of a globally placed EARLYSUB statementcan have those delayed submission times reset only on a job by job basis, and not asa group.

Jobs that are inserted into active Applications do not have delayed submission timeassociated with them. If you want to insert a job into an active Application andassociate a delayed submission time with that job you will have to:

1. Insert the job on hold using the “IJ” CSF line command2. Reset the job’s delayed submission time (“Earliest submit time” field)3. Release the job using the “A” CSF line command.

Continued on next page

Page 252: ESP 5.2 Command Reference

252

EARLYSUB Statement, Continued

RelatedStatements

Note: The DELAYSUB and EARLYSUB statements perform the same function.

For information on resetting time dependencies, see the ESP Workload ManagerUser’s Guide.

For information on manipulating jobs within Application or subApplications, see theAPPLJOB or AJ command.

For information on specifying time dependencies, see the ESP Workload ManagerUser’s Guide.

Example 1 The following EARLYSUB statement sets the delayed submission time of a job:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

EARLYSUB 9PMRUN WORKDAYS

ENDJOB

In the above example, PAYJOB1 has a delayed submission time of 9 pm relative tothe time the PAYROLL Application was generated.

Example 2 The following EARLYSUB statement sets the delayed submission time based on theday of the week:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB2

EARLYSUB 9PMIF TODAY(‘WEEKEND’) THEN EARLYSUB 6PMRUN DAILY

ENDJOB

In the above example, PAYJOB2 has a delayed submission time of:

• 9 pm on weekdays• 6 pm on weekends.

Continued on next page

Page 253: ESP 5.2 Command Reference

253

EARLYSUB Statement, Continued

Example 3 The following EARLYSUB statement sets the delayed submission time based on the

day of the week:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’EARLYSUB 4PMJOB PAYJOB3

RELEASE PAYJOB4ENDJOBJOB PAYJOB4

RELEASE PAYJOB5ENDJOBJOB PAYJOB5

RELEASE PAYJOB6ENDJOBJOB PAYJOB6

EARLYSUB 4PMENDJOBSELECT (PAYJOB3,PAYJOB4,PAYJOB5,PAYJOB6)

In the above example, all jobs in the PAYROLL Application have a delayedsubmission time of 4 pm, with the exception of PAYJOB6 that has a delayedsubmission time of 7 pm.

Other examples Here are more examples using the EARLYSUB statement.

Sets the delayed submission time to 10 minutes after the scheduled time of theEvent:

EARLYSUB NOW PLUS 10 MINUTES

Sets the delayed submission time to 10 minutes after the trigger time of the Event:

EARLYSUB REALNOW PLUS 10 MINUTES

Sets the delayed submission time to 10 pm two workdays from the scheduled time ofthe Event:

EARLYSUB 10PM TODAY PLUS 2 WORKDAYS

Sets the delayed submission time to 11 pm on the last workday of the month, and to9 pm on all other day that this job is submitted:

IF TODAY(‘LAST WORKDAY OF MONTH’) THEN -EARLYSUB 11PM

ELSE -EARLYSUB 9PM

Page 254: ESP 5.2 Command Reference

254

ECHO Command

Overview The ECHO command is used to echo data back to your terminal. You can use it to

test the symbols produced by GENTIME commands, symbolic variables, ESPcontrol language (CLANG) statements and ESP built-in functions. Issue the ECHOcommand from page/line mode or from an ESP Procedure for testing purposes priorto permanently storing symbolic variables.

Type General command.

Syntax The syntax of the ECHO command is:

ECHO ‘character string’

Parameter Description

character string Any character string. Enclosed in quotes.

Usage notes The ECHO command cannot be issued from a system console.

Relatedinformation

For information on generating customized date and time variables, see theGENTIME command.

For information on symbolic variables, see the ESP Workload Manager AdvancedUser’s Guide.

For information on ESP built-in functions and ESP’s control language (CLANG),see the ESP Workload Manager User’s Guide.

Example 1 The following ECHO command displays some of the symbols produced by a

GENTIME command:

GENTIME XX FIRST WORKDAY OF MONTH STARTING TODAYECHO ‘%XXMM %XXDD %XXYY’

In the above example, a set of date and time variables is generated with the prefixXX, corresponding to the first workday of the month. The values of three of thesevariables are then echoed back to your terminal.

Continued on next page

Page 255: ESP 5.2 Command Reference

255

ECHO Command, Continued

Example 2 The following ECHO command tests the value returned by a built-in function:

IF TODAY(‘LAST WORKDAY OF MONTH’) THEN ECHO ‘TRUE’ELSE ECHO ‘FALSE’

In the above example, if today is the last workday of the month, the character string‘TRUE’ is echoed, else the string ‘FALSE’ is echoed back to your terminal.

Page 256: ESP 5.2 Command Reference

256

EICLASS Command

Overview The EICLASS command is used to control Event Initiator (EI) class definition and

manipulation. This allows different Events to have their own dedicated set of Eventinitiators and provides a means of prioritizing Event and workload submission forinstallations that trigger multiple Events at the same time.

Type General command.

Authority OPER authority is required to issue the EICLASS command.

Syntax The syntax of the EICLASS command is:

EICLASS [DISPLAY|SET|DELETE][CLASS(nnn)][MPL(nn)]

Parameter Description

DISPLAY Displays the specified EI class settings. If DISPLAY, SET orDELETE are not specified, this is the default. This keywordhas an alias of LIST.

SET Alter the specified EI class settings. DELETE Delete the specified EI class. All TDRs queued to the deleted

class are moved to class 0. CLASS Indicates the target EI class. nnn must be a number from 0 to

255. If DELETE is specified, nnn cannot be 0. If SET orDELETE is specified, CLASS must be specified.

MPL Indicates the maximum number of initiators to be defined forthe specified class. nn is a value from 0 to 16. If SET isspecified, MPL must be specified. If DISPLAY is specified,MPL is ignored.

Continued on next page

Page 257: ESP 5.2 Command Reference

257

EICLASS Command, Continued

Usage notes Define and manipulate Event initiator classes via Initialization Parameters and

commands. For each class, a dedicated set of Event initiators is defined.

EICLASS commands issued from Page mode are not retained across recycles ofESP. To retain EICLASS settings across recycles, insert the EICLASS command(s)in your Initialization Parameters.

For class 0, no explicit definition is required. If class 0 is not defined, it is createdautomatically with an MPL of 1.

The Event initiator class is specified via the EICLASS keyword on the EVENTstatement. There is no panel support for the EICLASS keyword.

SAF authorization controls the use of Event initiator classes. For any non-zero classspecified on an Event, a SAF security check will occur. The requester must haveREAD access to the resource EVENTINITCLASS.nnn resource in order to use theEvent initiator class nnn.

All Application generation for an Event is routed through the specified EICLASS. Ifan Event initiator is not available and one cannot be created, the Event waits until aninitiator of the required class becomes available. If an Event is triggered for whichthere is no defined class, it is routed through class 0.

The Application Manager also makes use of Event initiator classes for workloadsubmission. Optionally, JOBEND and STEPEND monitors can make use of Eventinitiator classes if USERMOD 36 is active. USERMOD 36 allows JOBEND andSTEPEND monitor Events to honor non-zero Event initiator class requests.

The EICLASS keyword is available on both the LISTSCH and EVENT commands.

Relatedinformation

For information on Event Streaming and the EICLASS Initialization Parameter, seethe ESP Workload Manager Installation Guide.

For information on Events, see the ESP Workload Manager User’s Guide.

For information on defining Events, see the EVENT command.

For information on displaying scheduled Events, see the LISTSCH command.

For information on setting usermods, see the USERMOD Initialization Parameter inthe ESP Workload Manager Installation Guide.

Example 1 The following EICLASS command is used to set an Event initiator:

EICLASS SET CLASS(5) MPL(1)

In the above example, one Event initiator is set to class 5.

Continued on next page

Page 258: ESP 5.2 Command Reference

258

EICLASS Command, Continued

Example 2 The following example displays the EI class settings:

OPER EICLASS

Example 3 The following EICLASS commands set Event initiator classes:

EICLASS SET CLASS(0) MPL(1)EICLASS SET CLASS(5) MPL(1)EICLASS SET CLASS(10) MPL(1)

In the above example:• One event initiator to class 0• One event initiator to class 5• One event initiator to class 10.

Example 4 The following EICLASS command sets an Event initiator class:

EICLASS SET CLASS(99) MPL(1)

The following Event definition specifies an Event initiator class:

EVENT ID(CYBER.PAYROLL) EICLASS(99)SCHEDULE 8PM WORKDAYSINVOKE ‘CYBER.PROCLIB.CNTL(PAYROLL)’ENDDEF

In the above example, CYBER.PAYROLL uses Event initiator 99, is scheduled at 8pm each workday, and invokes the PAYROLL ESP Procedure.

Page 259: ESP 5.2 Command Reference

259

EJECT Command

Overview The EJECT command is used to advance the output listing to a new page and is only

valid when the output is directed to a data set. If the output is routed to a terminal,the EJECT command is ignored.

Type General command.

Syntax The syntax of the EJECT command is:

EJECT

Usage notes The EJECT command can be used in batch and with the HARDCOPY and

DEFPRINT commands.

Example 1 The following EJECT command advances output to a new page:

//ESPCMD JOB CYB3000,CLASS=A,MSGCLASS=X//STEP001 EXEC PGM=ESP,PARM='SUBSYS(E510)',REGION=4M//STEPLIB DD DSN=CYB2.ESP510Q.SSCPLINK,DISP=SHR//SYSPRINT DD DSN=CYBER.COMMAND.OUTPUT,DISP=SHR//SYSIN DD *LIST LEVEL(CYBER.PAY-)EJECTLIST LEVEL(CYBER.MFG-)/*

In the above example, two commands are issued in batch to list Events. The EJECTcommand is used to display the payroll Events (CYBER.PAY-) and themanufacturing Events (CYBER.MFG-) on separate pages.

Page 260: ESP 5.2 Command Reference

260

ELSE Statement

Overview The ELSE statement is used in conjunction with an IF statement when the

expression that follows the IF statement returns a false value.

Type ESP Control Language (CLANG) statement.

Syntax The syntax of the ELSE statement is:

ELSE action

Parameter Description

ELSE Can only be used when IF and THEN statements have alreadybeen specified. Defines the action to be taken when evaluationof an IF statement returns a false value. To specify multipleactions you must use the DO and ENDDO statements.

action Indicates the action that should be taken. Usage notes When you use an IF statement, the expression that follows it must return a true or

false value. You can use any number of nested IF statements.

The THEN statement is used in conjunction with an IF statement when theexpression that follows the IF statement returns a true value.

If multiple action statements must be processed, you must begin and end compoundaction statements with the DO and ENDDO language elements.

If you do not include an ELSE statement after an expression returning a false value,ESP passes control to the next line.

If an ELSE statement continues to another line, use a line continuation character (–or +). If there is no continuation character, ESP ignores the ELSE statement.

RelatedStatements

For information on conditionally processing an instruction or group of instructions,see the IF and THEN statements.

For information on using ESP’s Control Language, see the ESP Workload ManagerUser’s Guide.

For information on advanced usage of ESP’s Control Language, see the ESPWorkload Manager Advanced User’s Guide.

Continued on next page

Page 261: ESP 5.2 Command Reference

261

ELSE Statement, Continued

Example 1 The following logic is used to process different action statements:

IF %ESPADAY = ‘MONDAY’ THEN -SEND ‘TODAY IS MONDAY’ U(CYB01)

ELSE -SEND ‘TODAY IS %ESPADAY’ U(CYB01)

In the above example, ESP determines if the actual day is equal to Monday. If theevaluation of this expression is true, ESP sends a message to user CYB01 indicatingthat today is Monday. If the evaluation of this expression is false, ESP sends amessage to user CYB01 indicating what day it is.

Example 2 The following logic is used to set the value of a user defined symbolic variable:

IF ESPSMM<5 THEN DOGENTIME LAST TODAY LESS 1 YEARFINANCIAL_YEAR=’%LASTYY%ESPSYY’

ENDDOELSE DO

GENTIME NEXT TODAY PLUS 1 YEARFINANCIAL_YEAR=’%ESPSYY%NEXTYY’

ENDDO

In the above example, a user defined symbolic variable called‘FINANCIAL_YEAR’ consists of two, 2–digit year numbers, and is set as follows:

• If the scheduled month is January, February, March or April, use last yearfollowed by this year

• For any other month, use current year followed by next year.

Page 262: ESP 5.2 Command Reference

262

END Command

Overview The END command is used to end the ESP terminal session or batch execution.

Type General command.

Syntax The syntax of the END command is:

END

Usage notes To access ESP in Line mode, enter either of the following:

• TSO ESP SUB(subsys)- from the ISPF command line, where subsys is theESP subsystem name

• @LINEMD - from within Page mode

Enter END when you have finished with ESP in Line mode for that particularsession.

Relatedinformation

For information on accessing ESP as a program in TSO, see the ESP WorkloadManager User’s Guide.

Example 1 To access the ESP in Line mode enter the following from the ISPF command line,

where SUB specifies the ESP subsystem name:

Command ===> TSO ESP SUB(E510)

Once in Line mode, enter ESP commands as required:

--> LDSNCHECKPOINT: CYB2.ESP510.CKPT, ALT NONE

USERDEF: CYB2.ESP510.USERDEF, BKUP NONEINDEX: CYB2.ESP510.INDEX, BKUP NONE

JOBINDEX: CYB2.ESP510.JOBINDEXQUEUE: CYB2.ESP510.QUEUE, ALT NONE

TRAKFILE: CYB2.ESP510.TRAKFILEEVENTSET: CYB2.ESP510.EVENT1HISTFILE: CYB2.ESP510.HISTFILEAPPLFILE: CYB2.ESP510.APPLFILE

JTDT: CYB2.ESP510.PARMLIB(JOBDEF1)UPDT: CYB2.ESP510.PARMLIB(PROFILE)

--> END

In the above example, system data sets allocated to ESP are displayed (LDSN).Enter END to terminate this Line mode session.

Page 263: ESP 5.2 Command Reference

263

ENDDEF Command

Overview The ENDDEF command is used to end an Event definition.

Type Event definition command.

Syntax The syntax of the ENDDEF command is:

ENDDEF

Usage notes If the ENDDEF command is omitted when creating an Event, ESP adds this omitted

command.

Relatedinformation

For information on defining Events, see the EVENT command.

For information on Events, see the ESP Workload Manager User’s Guide.

Example 1 The following is an example of an Event definition:

EVENT ID(CYBER.PAYROLL)SCHEDULE DAILY AT 8AMINVOKE ‘CYB.ESP.PROCS(PAYROLL)’ENDDEF

In the above example:

• The definition begins with the EVENT command and the Event’s name• The SCHEDULE command tells ESP when to schedule the Event• The INVOKE invokes an ESP Procedure• The ENDDEF command indicates the end of the definition.

Page 264: ESP 5.2 Command Reference

264

ENDDO Statement

Overview The ENDDO statement is used to identify the end of one or more action statements.

Type ESP Control Language (CLANG) statement.

Syntax The syntax of the ENDDO statement is:

ENDDO

Usage notes Use the ENDDO statement in conjunction with the DO statement to indicate the end

of a set of action statements.

RelatedStatements

For information on identifying the start of a set of compound action statements, seethe DO statement.

For information on using ESP’s Control Language, see the ESP Workload ManagerUser’s Guide.

Example 1 The following DO and ENDDO statements are used to identify the start and end of a

set of action statements:

IF X = ‘BILLING’ THEN DOSEND ‘BILLING JOB WILL RUN TODAY’ CN(01)INVOKE ‘CYBER.PROCLIB.CNTL(BILLING)’

ENDDO

In the above example, if the value of a variable called ‘X’ is equal to ‘BILLING’:

• A message is sent to the console• The BILLING Application is invoked.

Continued on next page

Page 265: ESP 5.2 Command Reference

265

ENDDO Statement, Continued

Example 2 The following DO and ENDDO statements indicate a set of action statements:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN WORKDAYSIF TODAY(‘MONDAY’) THEN -

DODELAYSUB 4PMLATESUB 5PM

ENDDOENDJOB

In the above example, if today is Monday, PAYJOB1’s delayed submission time isset to 4 pm, and its late submission time is set to 5 pm.

Page 266: ESP 5.2 Command Reference

266

%ENDEXCL Statement

Overview The %ENDEXCL statement is used to end the exclusion of JCL or to end the

exclusion of control statements from a symbolic variable library.

Type ESP control statement used in JCL, symbolic variable library statement.

Syntax The syntax of the %ENDEXCL statement is:

%ENDEXCL

Restriction The %ENDEXCL statement cannot be used in ESP Procedures.

Usage notes The %ENDEXCL statement must start in Column 1. If you want to include a

statement with the characters %ENDEXCL starting in column 1, but to have ittreated as data rather than a control statement, code %%ENDEXCL. The firstpercent sign is removed.

Note: Before using the %ENDEXCL statement, check with your systemadministrator to ensure no changes were made during your ESP installation thataffect the way ESP recognizes these statements. For example, another product maymake conflicting use of these terms, in which case your system administrator canchange them.

Relatedinformation

For information on selectively excluding JCL and DATA, see the %EXCLUDEstatement.

For information on selectively including JCL and DATA, see the %INCLUDEstatement.

Example 1 The following %EXCLUDE statement used in a symbolic variable library ends theexclusion of data on Mondays:

%EXCLUDE DAY(MONDAY)PARM=’ABC’%ENDEXCL

In the above example, the symbol ‘PARM’ does not take on the value of ‘ABC’ onMondays.

Continued on next page

Page 267: ESP 5.2 Command Reference

267

%ENDEXCL Statement, Continued

Example 2 The following %EXCLUDE statement used in JCL ends the exclusion of a DD

statement on Mondays:

%EXCLUDE DAY(MONDAY)//INPUT05 DD DSN=CYBER.INPUT.DATA,DISP=SHR%ENDEXCL

In the above example, the DD statement ‘INPUT05’ is excluded on Mondays.

Page 268: ESP 5.2 Command Reference

268

ENDHC Command

Overview The ENDHC command is used to stop routing of output as specified by a

HARDCOPY command.

Type General command.

Syntax The syntax of the ENDHC command is:

ENDHC

Usage notes The ENDHC command is only available in Line mode or Page mode.

When ESP encounters the ENDHC command, it stops writing output data to a dataset, DD file or SYSOUT class.

Relatedinformation

For information on routing command output, see the HARDCOPY command.

Example The following is an example of routing command output:

HARDCOPY DATASET(CYB.COMMAND.OUTPUT(DATA))GENTIME AA TODAYGENTIME BB TODAY PLUS 2 WORKDAYSGENTIME CC LAST WORKDAY OF MONTH STARTING TODAYENDHC

In the above example:

• The HARDCOPY command tells ESP to route command output to a member ofa PDS

• Three GENTIME commands are issued to created customized date and timevariables

• The ENDHC command indicates that ESP is to stop the routing of commandoutput.

Page 269: ESP 5.2 Command Reference

269

%ENDINCL Statement

Overview The %ENDINCL statement is used to end the inclusion of JCL or to end the

inclusion of control statement(s) from a symbolic variable library.

Type ESP control statement used in JCL, symbolic variable library statement.

Syntax The syntax of the %ENDINCL statement is:

%ENDINCL

Usage notes The %ENDINCL statement cannot be used in ESP Procedures.

The %ENDINCL parameter must start in Column 1. If you want to include astatement with the characters %ENDINCL starting in column 1, but to have ittreated as data rather than a control statement, code %%ENDINCL. The first percentsign is removed.

Before using the %ENDINCL statement, check with your system administrator toensure no changes were made during ESP installation that affect the way ESPrecognizes these statements. For example, another product may make conflictinguse of these terms, in which case your system administrator can change them.

Relatedinformation

For information on selectively excluding JCL and DATA, see the %EXCLUDEstatement.

For information on selectively including JCL and DATA, see the %INCLUDEstatement.

Example 1 The following %ENDINCL statement used in a symbolic variable library ends theinclusion of data on Mondays:

%INCLUDE DAY(MONDAY)PARM=’ABC’%ENDINCL

In the above example, the ‘PARM’ takes on the value of ‘ABC’ on Mondays.

Continued on next page

Page 270: ESP 5.2 Command Reference

270

%ENDINCL Statement, Continued

Example 2 The following %ENDINCL statement used in JCL ends the inclusion of a DD

statement on Mondays:

%INCLUDE DAY(MONDAY)//INPUT05 DD DSN=CYBER.INPUT.DATA,DISP=SHR%ENDINCL

In the above example, DD statement ‘INPUT05’ is included on Mondays.

Page 271: ESP 5.2 Command Reference

271

ENDJOB Statement

Overview The ENDJOB statement is used to indicate the end of a job definition. It is not

required to end every JOB statement with an ENDJOB statement, but it is requiredto use an ENDJOB statement after defining all of your jobs and when usingstatement at a global level between jobs.

Type ESP Application statement.

Syntax The syntax of the ENDJOB statement is:

ENDJOB

Usage notes The scope of the JOB statement includes all statements up to an ENDJOB statement

or the next JOB statement. ESP processes commands based on where they areplaced within an Application as follows:

• ESP processes commands outside the scope of JOB statements when theApplication is generated and every time a job becomes eligible (i.e. alldependencies met)

• ESP processes commands within the scope of a JOB statement only when thejob becomes eligible (i.e. all dependencies met)

Statements placed within the scope of a job are referred to as job specificstatements; whereas statements placed outside the scope of a job statement arereferred to as global statements.

RelatedStatements

For information on identifying the name of a job in an Application, see the JOBstatement.

For information on identifying jobs, see the ESP Workload Manager User’s Guide.

Example 1 The following ENDJOB statements are used to end two job definitions:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN DAILYRELEASE PAYJOB2

ENDJOBJOB PAYJOB2

RUN DAILYENDJOB

In the above example, the first ENDJOB statement is used to indicate the end of thejob definition for PAYJOB1. The second ENDJOB statement is used to indicate theend of the job definition for PAYJOB2.

Continued on next page

Page 272: ESP 5.2 Command Reference

272

ENDJOB Statement, Continued

Example 2 The following ENDJOB statement is used to end job definitions:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN DAILYRELEASE PAYJOB2

JOB PAYJOB2RUN DAILY

ENDJOB

In the above example, the ENDJOB statement is used to indicate the end of alldefined jobs within the PAYROLL Application.

Page 273: ESP 5.2 Command Reference

273

ENDMODEL Command

Overview The ENDMODEL command is used to end the model definition mode and invokes

the MODEL generation processor.

Type Model command.

Syntax The syntax of the ENDMODEL command is:

ENDMODEL

Relatedinformation

For information on how ESP processes workload in your environment, see the ESPWorkload Manager Advanced User’s Guide.

For information on beginning the model process, see the MODEL command.

Example 1 The following is an example of a model definition:

DEFPRINT XREF DDNAME(MODEL1)MODEL CYBER.SAD -

START('4PM TODAY ENDING 4PM TODAY PLUS 5 DAYS')MAXINITS 8INIT START(1:8) CLASS(A,B,C,D)MREPORT XREF JR1 FROM('4PM TODAY ENDING 4PM TOMORROW’)

ENDMODELENDPRINT XREF

In the above example:

• The DEFPRINT command directs output to a DD name• The MODEL command invokes the model processor• The MAXINITS and INIT commands define initiators• The MREPORT command selects the modeling report to be generated• The ENDMODEL command ends the model definition and invokes the MODEL

generation processor• The ENDPRINT command creates a report.

Page 274: ESP 5.2 Command Reference

274

ENDPRINT Command

Overview The ENDPRINT command is used to close each of the report data files opened with

the DEFPRINT command.

Type General command.

Syntax The syntax of the ENDPRINT command is:

ENDPRINT reptname

Parameter Description

reptname A one to eight-alphanumeric character logical report name.

Usage notes The report name ended by the ENDPRINT command is assigned on the DEFPRINT

command.

Relatedinformation

For information on defining a report file, see the DEFPRINT command.

Example The following is an example of a model definition:

DEFPRINT XREF DDNAME(MODEL1)MODEL CYBER.SAD.DATA -

START('4PM TODAY ENDING 4PM TODAY PLUS 5 DAYS')MAXINITS 8INIT START(1:8) CLASS(A,B,C,D)MREPORT XREF JR1 FROM('4PM TODAY ENDING 4PM TOMORROW’)

ENDMODELENDPRINT XREF

In the above:

• The DEFPRINT command directs output to a DD name. The logical report nameis XREF.

• The MODEL command invokes the model processor.• The START, MAXINITS, INIT START and MREPORT model statements

define the model.• The ENDMODEL command ends the model definition and invokes the MODEL

generation processor.• The ENDPRINT command closes the logical report called XREF and ESP

creates the report.

Page 275: ESP 5.2 Command Reference

275

ENDR Command

Overview The ENDR command ends a history report definition and starts the report generation

phase.

Type Reporting command.

Syntax The syntax for the ENDR command is:

ENDR

Relatedinformation

For information on beginning a report definition, see the REPORT command.

For information on history reports, see the ESP Workload Manager User’s Guide.

Example 1 The following is an example of a history report definition:

REPORTFROM 7AM YESTERDAYCRITERIA APPLSYS EQ PAYROLLDISPLAY JOBNAME JOBNO APPLSYS CMPCENDR

In the above example:

• The REPORT command invokes the report processor• The FROM, CRITERIA and DISPLAY report statements define the report• The ENDR command ends the report definition and initiates report generation.

Page 276: ESP 5.2 Command Reference

276

ENDTEMPL Statement

Overview The ENDTEMPL statement is used to indicate the end of a template definition.

Type ESP Procedure statement.

Syntax The syntax of the ENDTEMPL statement is:

ENDTEMPL

Relatedinformation

For information on working with templates, see the ESP Workload ManagerAdvanced User’s Guide.

For information on defining templates, see the TEMPLATE statement.

Example 1 The following ENDTEMPL statement is used to indicate the end of a template

definition:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’

TEMPLATE PRTJOBS (1,JOBNAME)JOB %JOBNAME

RUN DAILYENDJOB

ENDTEMPL

PRTJOBS PAYJOB1PRTJOBS PAYJOB2PRTJOBS PAYJOB3

In the above example, the PAYROLL Application is defined using a template calledPRTJOBS. The ENDTEMPL statement ends the PRTJOBS template definition.

Page 277: ESP 5.2 Command Reference

277

ESP Statement

Overview The ESP statement is used to issue any ESP command from within an ESP

Procedure.

Type ESP Procedure statement.

Syntax The syntax of the ESP statement is:

ESP command

Parameter Description

command Any valid ESP command.

Usage notes As part of an Application you may want to issue ESP commands. This is useful, for

example, when you want to manipulate jobs, trigger Events, and perform displays.

Use the ESP or ESPNOMSG statement in an Application to issue an ESP command.ESPNOMSG suppresses responses from the command.

RelatedStatements

For information on issuing ESP commands and having the response from thecommand suppressed, see the ESPNOMSG statement.

Example 1 The following ESP statement is used to trigger an Event:

JOB TRIGGER.EVENT LINK PROCESSRUN DAILYESP TRIGGER CYBER.ACCTJOB ADD

ENDJOB

In the above example, the TRIGGER.EVENT link issues an ESP command totrigger an Event called CYBER.ACCTJOBS.

Continued on next page

Page 278: ESP 5.2 Command Reference

278

ESP Statement, Continued

Example 2 The following ESP statement is used to complete a task when a resource is

available:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB WAIT4.CICS TASK

RUN ANYRELEASE PAYJOB1RESOURCE (1,CICS)ESP AJ WAIT4.CICS COMPLETE APPL(WAIT4.0)

ENDJOBJOB PAYJOB1

RUN ANYENDJOB

In the above example, when a resource called ‘CICS’ becomes available, ESP issuesan APPLJOB command to complete a task called WAIT4.CICS. AfterWAIT4.CICS completes PAYJOB1 is released.

Example 3 The following ESP statements are used to insert a job into an Application, and to

complete a task:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN DAILYRELEASE INSERT.JOB

JOB INSERT.JOB LINK PROCESSRUN DAILYESP AJ PAYJOB99 INSERT APPL(BILLING.0)

ENDJOB

In the above example, when PAYJOB1 successfully completes, an ESP command isissued to insert PAYJOB99 into the current generation of the BILLING Application.

Page 279: ESP 5.2 Command Reference

279

ESPCOM Command

Overview The ESPCOM command is used to display and control ESP communications activitybetween the ESP Agents and ESP Workload Manager.

Type General command.

Authority OPER authority is required to issue the ESPCOM command.

Syntax The syntax of the ESPCOM command is:

ESPCOM {LIST} [DEST(agentname)]{QUIESCE}{RESTART}{FLUSH}

Parameter DescriptionLIST Lists the attributes of the COMMQ checkpoint data set in use.

This is the default. When the DEST keyword is included, thestatus of the specified Agent is also displayed.

DEST Use to specify an individual Agent.agentname Name of the target Agent you want to view or manipulate.QUIESCE Use with the DEST keyword to QUIESCE an individual

Agent.RESTART Use with the DEST keyword to RESTART an individual

Agent.FLUSH Use with the DEST keyword to purge all pending messages

for each specified Agent.

Example The following is an example of the response from the default ESPCOM command:

OPER ESPCOM

CommQ data set name: CYBER.ESP.ESPCOMQsize: 1474560 bytesused: 320 bytes

1 senders are defined, 0 of them quiesced

Page 280: ESP 5.2 Command Reference

280

ESPCTR Command

Overview The ESPCTR command is used to display ESP internal activities relating to Events,

Applications and jobs. These counters represent the activity for this ESP systemonly. No counts are shown for any ESP slave systems or any other remote ESPsystems.

Type General command.

Authority OPER authority is required to issue the ESPCTR command.

Syntax The syntax of the ESPCTR command is:

ESPCTR [RESET]

Usage notes Use the ESPCTR command to display statistics on Applications completed or

created, Events executed, and jobs submitted. These activities are measured in thefollowing intervals: this year, this month, this day, since the last ESP start.

An ESP cold start or the ESPCTR RESET command resets all the values to zero.

Relatedinformation

For information on displaying ESP internal activities from the ESP Main Menu, seethe USE command.

Continued on next page

Page 281: ESP 5.2 Command Reference

281

ESPCTR Command, Continued

Example 1 The following ESPCTR command displays usage statistics:

OPER ESPCTR

APPCMP 499,499,13,143APPCRE 737,737,27,211EVXEQ 2220,2220,43,594JOBSUB 1190,1190,13,365

In the above example:

• APPCMP refers to the number of Applications completed• APPCRE refers to the number of Applications created• EVEXQ refers to the number of Events executed• JOBSUB refers to the number of jobs submitted by ESP.

The statistics are listed in the following order (from left to right): this year, thismonth, this day, since last ESP start.

Note: Entering USE from the ESP main menu produces the identical statistics tothat of the ESPCTR command (above), only formatted differently. ESP ---------------------------------- Usage ----------------- Row 1 to 4 of 4 Command ===> Scroll ===> PAGE This This This Since Last Activity Year Month Day ESP Start ------------------------------------------------------------------------------ Applications completed 499 499 13 143 Applications created 737 737 27 211 Events executed 2220 2220 43 594 Jobs submitted 1190 1190 13 365 ******************************* Bottom of data *******************************

Page 282: ESP 5.2 Command Reference

282

ESPNOMSG Statement

Overview The ESPNOMSG statement is used to issue any ESP command from within an ESP

Procedure and suppress responses from the command. Warnings and errorsresponses are not suppressed.

Type ESP Procedure statement.

Syntax The syntax of the ESPNOMSG statement is:

ESPNOMSG command

Parameter Description

command Any valid ESP command.

Usage notes When most commands execute, they issue some kind of response. This response is

routed to the user who owns the Event. To reduce message clutter, the ESPNOMSGstatement can by used to suppress responses, unless a severe error occurs.

As part of an Application, you may want to issue ESP commands. This is useful, forexample, when you want to manipulate jobs, trigger Events, and perform displays.

Use the ESP or ESPNOMSG statement in an Application to issue an ESP command.ESPNOMSG suppresses responses from the command.

RelatedStatements

For information on issuing ESP commands, see the ESP statement.

Example 1 The following ESPNOMSG statement is used to trigger an Event:

JOB TRIGGER.EVENT LINK PROCESSRUN DAILYESPNOMSG TRIGGER CYBER.ACCTJOB ADD

ENDJOB

In the above example, the TRIGGER.EVENT link issues an ESP command totrigger an Event called CYBER.ACCTJOB. The response from the ESP command(i.e. EVENT TRIGGERED) is suppressed as a result of specifying ESPNOMSG infront of the ESP TRIGGER command.

Continued on next page

Page 283: ESP 5.2 Command Reference

283

ESPNOMSG Statement, Continued

Example 2 The following ESPNOMSG statement is used to complete a task when a resource is

available:

APPL WAIT4JCLLIB ‘CYBER.JCL.CNTL’JOB WAIT4.CICS TASK

RUN ANYRELEASE PAYJOB1RESOURCE (1,CICS)ESPNOMSG AJ WAIT4.CICS COMPLETE APPL(WAIT4.0)

ENDJOBJOB PAYJOB1

RUN ANYENDJOB

In the above example, when a resource called ‘CICS’ becomes available, ESP issuesan APPLJOB command to complete a task called WAIT4.CICS. AfterWAIT4.CICS completes, PAYJOB1 is released. The response from the ESPcommand is suppressed as a result of specifying ESPNOMSG.

Example 3 The following ESPNOMSG statements are used to insert a job into an Application,

and to complete a task:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN DAILYRELEASE INSERT.JOB

JOB INSERT.JOB LINK PROCESSRUN DAILYESPNOMSG AJ PAYJOB99 INSERT APPL(PAYROLL.0)

ENDJOB

In the above example, when PAYJOB1 successfully completes, an ESP command isissued to insert PAYJOB99 into the current generation of the PAYROLLApplication. The response from the ESP command is suppressed as a result ofspecifying ESPNOMSG.

Page 284: ESP 5.2 Command Reference

284

//*ESPSYMBOL Statement

Overview The //*ESPSYMBOL statement is used to change the symbol introducer character,

normally the percent sign (%). The symbol introducer is the character that identifiessymbolic variables to ESP.

Using the //*ESPSYMBOL statement in JCL you can change the symbol introducercharacter to identify another character as the symbol introducer character.Additionally, changing the symbol introducer character allows you to use thepercent sign (%) in your JCL and not have ESP interpret the percent sign (%) as thesymbol introducer character.

Type ESP control statement used in JCL.

Syntax The syntax of the //*ESPSYMBOL statement is:

//*ESPSYMBOL symbol

Parameter Description

symbol Any single alphanumeric or national character.

Restriction The //*ESPSYMBOL statement is only available in JCL.

Usage notes Place the character you want to use as the symbol introducer character in column 14,

separated from the //*ESPSYMBOL statement by a single blank.

If the symbol introducer character is changed, the change remains in effect:

• For the rest of the job during Application process mode, i.e. other jobs are notaffected

• Until ESP encounters another //*ESPSYMBOL statement.

If an individual member contains multiple jobs, the change remains in effect for alljobs within that individual member.

Relatedinformation

For information on changing the symbol introducer using an ESP InitializationParameter, refer to the SYMBOL statement in the ESP Workload ManagerInstallation Guide.

Continued on next page

Page 285: ESP 5.2 Command Reference

285

//*ESPSYMBOL Statement, Continued

Example 1 The following //*ESPSYMBOL statement used in JCL sets the symbol introducer

character:

//*ESPSYMBOL ?//PAYJOB1 JOB CYB,CLASS=A,MSGCLASS=0?INCLUDE DAY(MONDAY)//STEP001 EXEC PGM=PGM1,PARM=’DATE=?ESPSYY?ESPSDDD’?ENDINCL

In the above example, the symbol introducer character is changed from a % to a ?.Subsequent symbol variables reference the ? as the symbol introducer character, andtherefore include STEP001 on Mondays.

Example 2 The following //*ESPSYMBOL statements used in JCL set and reset the symbol

introducer character:

//*ESPSYMBOL #//PAYJOB1 JOB CYB,CLASS=A,MSGCLASS=0#INCLUDE IF(TODAY(‘LAST WORKDAY OF MONTH’))//STEP001 EXEC PGM=PGM1,PARM=’DATE=#ESPSYY#ESPSDDD’#ENDINCL//*ESPSYMBOL %//STEP02 EXEC PGM=PGM2,PARM=‘%ESPAHH%ESPAMN’

In the above example, the symbol introducer character is changed from a % to a #.Subsequent symbol variables reference the # as the symbol introducer character, andinclude STEP001 on last workday of the month. The symbol introducer character isthen reset to a % to avoid JCL errors in later steps that refer to the % as the symbolintroducer character.

Page 286: ESP 5.2 Command Reference

286

EVENT Command

Overview The EVENT command is used to start an Event definition.

Type Event definition command.

Syntax The syntax of the EVENT command is:

EVENT ID(eventid) [ADD|REPLACE][CLASS(classname)][SYSTEM(sysid)][AUTODELETE][HOLD(count)][SUSPEND(count)][MAXPEND(nn)][OWNER(userid)[INHERIT_TRIGGER_USER][EICLASS(eiclassname)]

Parameter Description

eventid Is the name of the Event. The name can be in the formgggg.dddd, or dddd alone. Here gggg is the user/group prefixand dddd is the descriptive name. If the prefix is omitted, theprefix set by the GROUP command takes effect. If the EventID is specified in the label field, the prefix should be omitted. Both the prefix and the descriptive name should consist ofalphanumeric characters, the first of which must bealphabetic. The descriptive name may also contain theunderscore ‘_’ as an alphabet extender. The prefix can be upto eight characters long, while the descriptive name has amaximum length of 16 characters.

ADD Indicates this is a new Event. If one already exists with thesame name, the new definition is ignored. This is the default.

REPLACE Indicates this is a new Event. If one already exists with thesame name, it is to be replaced.

classname Defines to which logical ESP class the Event will belong. Ifthis is omitted, the Event name prefix is used as a class name(up to eight characters).

Continued on next page

Page 287: ESP 5.2 Command Reference

287

EVENT Command, Continued

Syntax (continued)

Parameter Description sysid Indicates the ID of the ESP system to execute the

Event. You may use asterisks or a hyphen formasking. If this parameter is omitted, the currentsystem is used. To specify that the Event mayexecute on any one of the systems available, useSYSTEM(-). If the Event invokes an Application,this should specify the ESP system identifier of themaster.

AUTODELETE Indicates if any members of a PDS required for jobsubmission is not found, (or in the case ofPANVALET, is disabled), an error condition is notraised. This means that ESP continues to process theEvent as long as at least one of the data sets requiredfor submission of the job is available. However, if allthe SUBMIT commands within an Event definitionspecify deleted or disabled members, then the Eventis deleted from the schedule. This is not the default.

HOLD Indicates the Event is placed initially in the held state.Refer to the HOLD command – General.

SUSPEND Indicates the Event is placed initially in thesuspended state. Refer to the SUSPEND command –General.

count Sets HOLD or SUSPEND count. If not specified, thedefault is 1.

MAXPEND(nn) Indicates the maximum number of pending signals forthe Event.

OWNER(userid) Indicates the owner of the Event. If this parameter isnot specified, the last user to modify the Eventbecomes the owner. Ownership in a SAFenvironment affects only which TSO user gets thefailure messages.

USER(userid ) Indicates an overriding RACF user ID for the Event.When the Event executes, it automatically takes onthe security attributes of the OWNER. Normally ifthis parameter is not specified, the last user to modifythe Event in a non-SAF environment, or the Eventhigh-level qualifier in a SAF environment, becomesthe owner.

INHERIT_TRIGGER_USER Indicates the user ID of the user triggering the Eventshould be used for job submission. When the Eventexecutes, it automatically takes on the securityattributes of the user ID triggering the Event. Itoverrides any USER() value. This can be abbreviatedto ITU.

Continued on next page

Page 288: ESP 5.2 Command Reference

288

EVENT Command, Continued

Syntax (continued)

Parameter Description EICLASS(eiclassname) Indicates the Event initiator class, which allows

prioritization of Events and workload submission.SPECIAL authority is required to use this parameterin a non-SAF system. With SAF, you need READaccess to EVENTCLASS.nnn.

Usage note To specify OWNER(user), the person attempting to create or update the Event must

have SPECIAL or ANY authority in a non-SAF system, and READ access toprefix.SETOWNER.user in a SAF system. This is in addition to having updateaccess to the Event. If either authority is missing, the define/update request fails.Browse or edit generates the OWNER keyword if it was used when the Event waspreviously saved. The user may remove the operand and save the Event, in whichcase ownership reverts to the users own id.

To specify USER(user), the person attempting to create or update the Event musthave SPECIAL authority in a non-SAF system, and READ access toprefix.RACID.user in a SAF system. This is in addition to having update access tothe Event. If either authority is missing, the definition or update request fails.Browse or edit generates the USER keyword if it was used when the Event waspreviously saved. The user may remove the operand and save the Event, in whichcase the user ID reverts to the high level qualifier. If INHERIT_TRIGGER_USER isin effect for the Event, or at the system level (RACROUTE parameter), that user IDsupersedes the one in the Event if the Event is executed as a result of a TRIGGERcommand (as opposed to being scheduled). The EVENTSAF user exit may overrideany ESP-selected user ID.

It is possible to specify both OWNER and USER for the same Event, in which casethe defining user must have UPDATE access to the Event, and READ access toprefix.SETOWNER.user, and READ access to prefix.RACID.user. If any one ofthose checks fails, the definition request fails.

You can also define Events using ESP’s ISPF interface - Option E.2 from the ESPmain menu.

Relatedinformation

For information on ending an Event definition, see the ENDDEF command.

For information on deleting an Event definition, see the DELETE command.

For information on Events, see the ESP Workload Manager User’s Guide.

For information on Event initiators, see the ESP Workload Manager InstallationGuide.

Continued on next page

Page 289: ESP 5.2 Command Reference

289

EVENT Command, Continued

Example 1 The following is an example of an Event definition:

EVENT ID(CYBER.PAY1)SCHEDULE 8AM DAILYINVOKE ‘CYBER.ESP.PROCS(PAY1)’ENDDEF

In the above example:

• The EVENT command starts the Event definition• The SCHEDULE and INVOKE Events statements define the Event• The ENDDEF command ends the Event definition.

Continued on next page

Page 290: ESP 5.2 Command Reference

290

EVENT Command, Continued

Example 2 The following is an example of an Event definition:

EVENT ID(CYBER.PAY2) REPLACE SUSPEND OWNER(FRED)SCHEDULE 9AM DAILYINVOKE ‘CYBER.ESP.PROCS(PAY2)’ENDDEF

In the above example:

• The EVENT command starts the Event definition.• The REPLACE parameter is needed to replace the Event definition when it is

updated, if one already exists with the same name.• The SUSPEND parameter indicates that the Event is to be placed in a suspended

state. It does not execute until resumed.• The OWNER parameter indicates that FRED is the owner of the Event.• The SCHEDULE and INVOKE Events statements define the Event.• The ENDDEF command ends the Event definition.

Example 3 The following is an example of an Event definition:

EVENT ID(CYBER.PAY3) SYSTEM(E510) CLASS(PROD) ITUSCHEDULE 9AM DAILYINVOKE ‘CYBER.ESP.PROCS(PAY2)’ENDDEF

In the above example:

• The EVENT command starts the Event definition.• The SYSTEM parameter indicates the system where this Event is to execute.• The CLASS parameter indicates to which logical group this Event belongs.• The ITU parameter indicates that the user ID of the user triggering this Event

should be used for batch submission. This user ID applies only when the Eventis manually triggered.

• The SCHEDULE and INVOKE Events statements define the Event.• The ENDDEF command ends the Event definition.

Example 4 The following is an example of an Event definition:

EVENT ID(CYBER.PAYROLL) EICLASS(99)SCHEDULE 8PM WORKDAYSINVOKE ‘CYBER.PROCLIB.CNTL’ENDDEF

In the above example, an Event initiator class of 99 is assigned toCYBER.PAYROLL.

Page 291: ESP 5.2 Command Reference

291

EVENTOPT Command

Purpose The EVENTOPT command is used to allow or disallow the issue of Write toOperator (WTO) operations from within an Event. EVENTOPT also allows ordisallows the use of system commands from within an Event. EVENTOPT isnormally used as an Initialization Parameter.

Type General command.

Authority OPER authority is required to issue the EVENTOPT command.

Syntax The syntax of the EVENTOPT command is:

EVENTOPT [WTO|NOWTO][VS|NOVS]

Parameter DescriptionWTO Allows Write to Operator from within an Event. This is the

defaultNOWTO Disallows Write to Operator from within an Event.VS Allows the use of MVS commands from within an Event.

This is the default.NOVS Disallows the use of MVS commands from within an Event.

Usage notes The EVENTOPT command supersedes the EVENTWTO command.

If you specify no operands with the EVENTOPT command, the current status isdisplayed.

Relatedinformation

For information on Events, see the ESP Workload Manager User’s Guide.

Example 1 This following EVENTOPT command indicates Event restrictions:

EVENTOPT NOWTO NOVS

In the above example, neither WTOs nor system commands are allowed from withinan Event.

Page 292: ESP 5.2 Command Reference

292

EVENTSET Command

Overview The EVENTSET command is used to define or alter the definition of an Event dataset.

Type General command.

Authority OPER authority is required to issue the EVENTSET command.

Syntax The syntax of the EVENTSET command is:

EVENTSET eventdsid[DSNAME(dsname)][NEWDSNAME(newdsname)][BACKUPDSNAME(backupdsname)|NOBACKUPDSNAME][SCANTIME(schedule)][DEFINE|DELETE|OPEN|CLOSE|SET|FLUSH][SHR|NOSHR][JOURNAL|NOJOURNAL][BUILDSCHED]

Parameter Descriptioneventdsid Indicates a unique identifier of up to eight characters.dsname Indicates the name of a VSAM KSDS defined with the right

attributes.newdsname Indicates a VSAM KSDS similar to the above.backupdsname Indicates a non-VSAM sequential data set.NOBACKUP-DSNAME

Used to remove the backupdsname, if already specified.

schedule Indicates a time schedule using the same syntax as the ESPcommand processor schedule statements. If the text stringcontains blanks or commas, it should be enclosed withinquotes.

DEFINE Indicates a new Event data set is being defined. If notspecified, DEFINE is the default.

DELETE Indicates the Event data set is deleted. The associated VSAMdata set will NOT be deleted—only the logical Event ID isdeleted from ESP. The Event data set must be closed first.DELETE must be issued from a system console.

OPEN Indicates an Event data set is to be reopened.CLOSE Indicates an Event data set is to be closed and de-allocated

from ESP.SET Indicates an existing specification is changed without the

need to open or close the data set.FLUSH Indicates all prior schedule requests for Events on the

deferred queue are flushed. Succeeding schedule requests arehonored.

Continued on next page

Page 293: ESP 5.2 Command Reference

293

EVENTSET Command, Continued

Syntax (continued)

Parameter DescriptionSHR Indicates the data set is to be shared.NOSHR Indicates the data set is not to be shared. This is the default.JOURNAL Indicates a record be written to SMF each time an Event is

defined, updated or deleted (refer to SMFREC InitializationParameter).

NOJOURNAL Indicates no records be written to SMF when the Event file isupdated. Use this keyword to cancel a previous JOURNALrequest. This is the default.

BUILDSCHED Indicates the Time Driven Requests (TDRs) are built.

Usage notes This command is used to define and initialize an Event data set. Use the DEFINEkeyword along with DSNAME and SCANTIME parameters. The identifier is thepermanent name to be associated with that logical entity.

When a user or group prefix is defined, an Event data set is assigned to it. Theassignment is the logical identifier, rather than the actual data set name. This allowsthe data set name to be changed, or a new data set to be assigned at a later time.

The Event data set is scanned at regular intervals to produce a schedule. This isnormally done at 24 hour intervals. If the SCANTIME keyword is omitted, thedefault is ‘6 am daily’. If a backup data set is specified, the backup is performedautomatically while the schedule scan is taking place.

Usage notescontinued

The OPEN and CLOSE options are used when external manipulation of the data setis necessary. For example, if the data set is to be renamed or restored from abackup, these steps should be followed:

1. Issue the EVENTSET eventdsid CLOSE command.

2. Rename the data set or perform any other necessary function.

3. Issue the EVENTSET eventdsid OPEN command. If the data set has beenrenamed or copied to another data set, you can specify a new name through theNEWDSNAME parameter.

When ESP encounters an I/O error on an Event data set, it issues an error messageand closes the data set. Remedial action can then take place. When the problem iscorrected, the EVENTSET OPEN command causes ESP to resume operation withthe data set.

Any Events scheduled for execution while the corresponding data set is in thesuspended state are queued for deferred execution. When the data set is availableagain, execution can resume. Activity on other data sets can proceed as normal.

Continued on next page

Page 294: ESP 5.2 Command Reference

294

EVENTSET Command, Continued

Relatedinformation

For information on the EVENTSET Initialization Parameter, see the ESP WorkloadManager Installation Guide.

For information on Events, see the ESP Workload Manager User’s Guide.

Example 1 The following EVENTSET command defines an Event data set:

EVENTSET EVENT1 DEFINE DSNAME(ESP.EVENT1)-SCAN(‘5AM DAILY’) BACKUP(ESP.BACKUP.EVENT1) SHR

In the above example, a new shared Event data set called EVENT1 is defined. Theactual VSAM data set name is ESP.EVENT1, and the backup data set isESP.BACKUP.EVENT1, which is used every morning at 5:00 am. when EVENT1is scanned.

Other examples Here are more examples using the EVENTSET command.

Indicates the EVENT1 is closed and de-allocated from ESP:

OPER EVENTSET EVENT1 CLOSE

Indicates that no records be written to SMF when the Event file is updated:

OPER EVENTSET EVENT1 SET NOJOURNAL

Page 295: ESP 5.2 Command Reference

295

%EXCLUDE Statement

Overview The %EXCLUDE statement requests selective exclusion of JCL and DATA basedon criteria such as time, date, day of the week and Event ID, or a combination ofthese parameters. The %EXCLUDE statement is used to exclude portions of JCL orto exclude control statements from a symbolic variable library.

Type ESP control statement used in JCL, symbolic variable library statement.

Syntax The syntax of the %EXCLUDE statement is:

%EXCLUDE [FROM(fromdate)][TO(todate)][DAY(dayofweek[,dayofweek]...)][EVENT(eventid)][IF(expression)][COPYJCL]

Parameter Descriptionfromdate Indicates a time and date specification in any format that is

valid in a schedule statement.todate Indicates a time and date specification in any format that is

valid in a schedule statement. If no time is specified, it doesnot include this day.

dayofweek Indicates a valid day of week name, which can be abbreviatedto the first three characters. Several day of week names can bespecified, separated by blanks or commas.

eventid Indicates a valid Event name, which can contain the prefix anddescriptive name, or just the descriptive name of the Event. Ifthe prefix is omitted, the prefix of the current Event is assumed.Several Event IDs can be specified, separated by blanks orcommas.

expression Value of a logical expression.COPYJCL Indicates that the exclusion should apply to the copy of the JCL

written to a library as a result of the COPYJCL statement.

Note: Applies to JCL tailoring only, and not symbolic variablelibraries.

Restriction The %EXCLUDE statement cannot be used in an ESP Procedure.

Continued on next page

Page 296: ESP 5.2 Command Reference

296

%EXCLUDE Statement, Continued

Usage notes The %EXCLUDE parameter must start in Column 1. If you want to use a statementwith the characters %EXCLUDE starting in column 1, but have it treated as datarather than a control statement, code %%EXCLUDE. The first percent sign isremoved.

The %EXCLUDE statement can be continued onto a second line by placing a ‘+’ or‘-’ on the last non-blank character of the line. A ‘+’ strips leading blanks from thenext line, whereas a ‘-’ does not. Only one continuation per statement is allowed.

The scope of an %EXCLUDE statement excludes data until one of the followingstatements is encountered:

• %EXCLUDE statement• %INCLUDE statement• %ENDEXCL statement• %ENDINCL statement.

If no parameters are specified, the data following the %EXCLUDE statement isalways excluded.

If you specify a FROM date but no TO date, a TO date of January 1st 2042 isassumed. Similarly, if you omit a FROM date, a date of January 1st 1900 isassumed.

If no time is specified, 00:00 is assumed for the FROM and TO parameters.

The FROM and TO parameters are based on the scheduled date.

ESP decides what to exclude in the JCL when it submits the job.

Note: Before using the %EXCLUDE statement, check with your systemadministrator to ensure no changes were made during your ESP installation thataffect the way ESP recognizes these statements. For example, another product maymake conflicting use of these terms, in which case your system administrator canchange them.

Relatedinformation

For information on selectively including JCL and data, see the %INCLUDEstatement.

For information on ending the selective exclusion of JCL and data, see the%ENDEXCL statement.

For information on selectively excluding JCL, see the CHECKEXC statement.

Continued on next page

Page 297: ESP 5.2 Command Reference

297

%EXCLUDE Statement, Continued

Example 1 The following %EXCLUDE statement used in a symbolic variable library requests

the exclusion of data on Mondays:

%EXCLUDE DAY(MONDAY)PARM=’ABC’%ENDEXCL

In the above example, the value of PARM resolves to ‘ABC’ every day exceptMondays.

Example 2 The following %EXCLUDE statement used in JCL requests the exclusion of a DD

statement on Mondays:

%EXCLUDE DAY(MONDAY) EVENT(CYBER.PAYROLL)//INPUT05 DD DSN=CYBER.INPUT.DATA,DISP=SHR%ENDEXCL

In the above example, DD statement INPUT05 is excluded on Mondays if the Eventthat submitted the job is called CYBER.PAYROLL.

Example 3 The following %EXCLUDE and %INCLUDE statements create a modified copy of

the JCL that ESP writes to the COPYJCL library:

%EXCLUDE COPYJCL//PAYJOB1 JOB CYB,CLASS=A,MSGCLASS=S%INCLUDE COPYJCL//PAYJOB1 JOB CYB,CLASS=A,MSGCLASS=S,RESTART=STEP002%ENDINCL

In the above example, ESP modifies a copy of the JCL that is written to theCOPYJCL library to include a restart step on the job card.

Continued on next page

Page 298: ESP 5.2 Command Reference

298

%EXCLUDE Statement, Continued

Example 4 The following %EXCLUDE statements used in JCL request the exclusion of

various steps:

//CYBERJOB JOB CYB999,’FRED’,CLASS=A,MSGCLASS=S//STEP1 EXEC PGM=IEFBR14%EXCLUDE IF(ESPSDATE=ESPADATE)//STEP2 EXEC PGM=PGM1%EXCLUDE IF(ESPATIME GT 07.59.00)//STEP3 EXEC PGM=PGM2%EXCLUDE FROM(‘MAY 1,1997’) TO(‘MAY 5,1997’)//STEP4 EXEC PGM=PGM3%EXCLUDE IF(ESPAHH GE ‘08’ AND ESPAHH LE ‘14’ AND -TODAY(‘WED’))//STEP5 EXEC PGM=PGM4%ENDEXCL

In the above example:

• STEP1 executes whenever ESP submits the job• STEP2 is excluded when the actual and scheduled dates are equal• STEP3 is excluded when the actual time is greater than 07.59.00• STEP4 is excluded from May 1,1997 to midnight May 4,1997. This is based on

the scheduled date.• STEP5 is excluded if the actual hour is between 8 am and 2 pm and the

scheduled day is Wednesday.

Other examples Here are more examples using the %EXCLUDE statement.

Request exclusion if the value of CYCLE_NUMBER is equal to 9:

%EXCLUDE IF(CYCLE_NUMBER=9)

Request exclusion if the actual hour is greater than 09 and today is not Friday:

%EXCLUDE IF(ESPAHH GT ‘09’ AND TODAY(‘NOT FRIDAY’))

Request exclusion if a started task called CICSPROD is active:

%EXCLUDE IF(ACTIVE(‘CICSPROD’))

Request exclusion if today is the last day of the year:

%EXCLUDE IF(TODAY(‘LAST DAY OF YEAR’))

Page 299: ESP 5.2 Command Reference

299

EXIT Statement

Overview The EXIT statement is used to quit from your current point in an ESP Procedure.

Type ESP Control Language (CLANG) statement.

Syntax The syntax of the EXIT statement is:

EXIT

Usage notes Use EXIT to quit from your current point in a Procedure. ESP continues to process

pending requests up to the point at which you use EXIT. ESP also processes anyaction statements in the calling Event, or other ESP Procedures invoked in the sameEvent.

ESP ignores EXIT statements within the scope of a JOB statement duringApplication generation. During Application processing, EXIT within the scope of aJOB statement causes ESP to process all statements up to the EXIT and submit thejob.

RelatedStatements

For information on quitting an entire process and the Event that invoked it, see theQUIT statement.

For information on using ESP’s Control Language in Procedures, see the ESPWorkload Manager User’s Guide.

Example 1 The following EXIT statement is used to exit from the current point in an ESP

Procedure:

PAYROLL:ESPPROCIF TODAY(‘DEC 31,1999’) THEN –DO

INVOKE ‘CYBER.PROC.CNTL(ALTPAY)’EXIT

ENDDO/* REGULAR PROCEDURE */

In the above example, if today is December 31, 1999, then ESP invokes analternative ESP Procedure called ‘PROD.PROC.CNTL(ALTPAY)’and then exits.On all other days that this Application is invoked, the regular ESP Procedure isinvoked.

Continued on next page

Page 300: ESP 5.2 Command Reference

300

EXIT Statement, Continued

Example 2 The following EXIT statement is used to exit from the current point in an ESP

Procedure:

IF ACTIVE(’CICS’) THEN JUMPTO STOPELSE JUMPTO GOSTOP:VS ’F CICS,SHUTDOWN’REEXEC IN(5)EXITGO:VS ’F ESP,TRIGGER PROD.NIGHTLY’

In the above example, if CICS is active on the current system, ESP jumps to thelabel called STOP. ESP issues the operator command, schedules re–execution in 5minutes, and exits this Procedure.

If CICS is not active on the current system, ESP jumps to the label called GO andissues a command to trigger an Event.

Example 3 The following Procedure shows the differences when using EXIT and QUIT:

IF TODAY(‘CHRISTMAS’) THEN QUITIF TODAY(‘HOLIDAY’) THEN DO

SEND ’NO WORK TODAY’ U(BOSS)EXIT

ENDDOSEND ‘LET US CONTINUE PROCESSING’ U(CYB01)

In the above example:

• If today is CHRISTMAS, ESP quits the ESP Procedure and no instructions areprocessed

• If today is not CHRISTMAS but it is a holiday, ESP sends a message and exitsthe Procedure at that point

• If none of the above conditions are true, ESP sends a message indicating it willcontinue processing.

Example 4 The following EXIT statement is used to exit from the current point in an ESP

Procedure:

IF ESPSDAY = ‘FRIDAY’ THEN DOSEND ‘NO PROCESSING TODAY’ U(USR01)EXIT

ENDDO

In the above example, if today is FRIDAY, ESP sends the message and exits theESP Procedure at that point.

Continued on next page

Page 301: ESP 5.2 Command Reference

301

EXIT Statement, Continued

Example 5 The following QUIT statement is used to quit the ESP Procedure:

IF ESPSDAY = ‘FRIDAY’ THEN DOSEND ‘NO PROCESSING TODAY’ U(USR01)QUIT

ENDDO

In the above example, if today is FRIDAY, ESP quits the ESP Procedure, withoutsending the message.

Example 6 The following Procedure shows the differences when using EXIT and QUIT within

the scope of the JOB statement:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN WORKDAYSRELEASE PAYJOB2IF TODAY(‘MONDAY’) THEN -

EXITENDJOBJOB PAYJOB2

RUN WORKDAYIF TODAY(‘MONDAY’) THEN -

QUITENDJOB

In the above example, when the PAYROLL Application is generated on a Monday:

• PAYJOB1 is submitted• PAYJOB2 is not submitted and receives an error.

The following is an example of the CSF display when the above Application isgenerated:

ESP Consolidated Status: View PAYROLL -- Row 1 of 2, Col 1COMMAND ===> SCR ===> PAGE

Jobname APPL PNODE STATUS___ PAYJOB1 PAYROLL COMPLETE COMPLETED AT 13.14 21 APR___ PAYJOB2 PAYROLL SUBERROR Submit Error, Quit

Page 302: ESP 5.2 Command Reference

302

EXPECT Command

Overview The EXPECT command is used to tell ESP when an Event is expected to execute.

Use this in Events without SCHEDULE statements if you want the Event’s activitiesreflected when creating scheduled activity reporting.

Type Event definition command.

Syntax The syntax of the EXPECT command is:

EXPECT criteria

Parameter Description

criteria Schedule criteria that resolve to a single date and time.

Usage notes If you want to display Events that do not have SCHEDULE commands, such as

Events triggered by data set activity, you can use the EXPECT subcommand.

If an Event has not triggered by the expected time, the Event continues to wait.

If you trigger an Event containing an EXPECT command, with the REPLACEoption, ESP calculates the next expected execution of the Event.

Relatedinformation

For information on scheduling criteria, see the ESP Workload Manager User’sGuide.

For information on Events, see the ESP Workload Manager User’s Guide.

For information on creating schedule activity reports, see the ESP WorkloadManager User’s Guide.

For information on displaying the schedule, see the LISTSCH command.

Example 1 The following EXPECT command tells ESP when to expect an Event to execute:

EVENT ID(CYBER.PAYJOB)EXPECT 10AM WORKDAYSDSTRIG CYB.INPUT.DATA ANYCLOSESUBMIT ‘CYB.JCL.CNTL(PAYJOB1)ENDDEF

In the above example, this Event does not have a SCHEDULE statement because itis triggered by data set activity and is not reflected in either a scheduled activityreport or on a LISTSCH command. The EXPECT command ensures thatCYBER.PAYJOB is reflected when scheduled activity reports are produced andwhen the schedule is listed.

Page 303: ESP 5.2 Command Reference

303

FILENAME Statement

Overview The FILENAME statement is used in conjunction with the FILE_TRIGGER

workload object, and is used to build a non-MVS file dependency at the job levelinto ESP Applications.

Type ESP Application statement.

Syntax The syntax of the FILENAME statement is:

FILENAME pathto\filename [CREATE|UPDATE|DELETE]

Parameter Description

pathto Indicates the fully qualified path to the directory where thefile filename exists or is created.

filename Indicates the name of the file whose activity triggers therelease of the job named in the associated FILE_TRIGGERstatement.

CREATE Indicates the trigger is to occur when the file is created. Thisis the default.

Note: If the file exists when the job is readied, the triggeroccurs immediately.

UPDATE Indicates the trigger is to occur when the file is updated (i.e.,the time stamp on the file changes).

Note: If the file does not exist when the job is readied, thetrigger does not occur. If the file is subsequently created, thetrigger occurs immediately.

Note: If the file exists when the job is readied and is thendeleted, the trigger does not occur. Deleting a file is notconsidered an update.

Warning: The UPDATE trigger is time-sensitive. If thesystem time on the Manager and Agent is not synchronized,the trigger may not function as expected.

DELETE Indicates the trigger is to occur when the file is deleted. Note: If the file does not exist when the job is readied, thetrigger occurs immediately.

Usage notes The FILENAME statement must be used within the scope of a FILE_TRIGGER

statement to describe the trigger.

Continued on next page

Page 304: ESP 5.2 Command Reference

304

FILENAME Statement, Continued

Relatedinformation

For information on defining a workload object associated with a non-MVS filetrigger, see the FILE_TRIGGER statement.

Example 1 The following example builds a job level file trigger dependency:

FILE_TRIGGER PAY1.PAYSCRIPTAGENT HPUX_TORONTOFILENAME /pay/sched CREATERUN DAILYREL PAYJOB2

ENDJOB

In the above example, PAY1.PAYSCRIPT is used to build a job-level dependencywhen the non-MVS file /pay/sched is created.

Page 305: ESP 5.2 Command Reference

305

FILE_TRIGGER Statement

Overview The FILE_TRIGGER statement defines a workload object associated with a non-

MVS file trigger and is used in conjunction with the FILENAME statement to buildfile dependency, at the job level, into ESP Applications.

Type ESP Application statement.

Syntax The syntax of the FILE TRIGGER statement is:

{FILE_TRIGGER|FM} name[.qualifier][REQUEST][CONDITIONAL]

Parameter Description

name Indicates a workload object name in up to eight characters. qualifier Indicates a workload object qualifier in up to eight

characters. It must immediately follow the workload objectname separated by a period.

REQUEST Indicates this is an on-request job. CONDITIONAL Indicates this job may or may not execute. The Application

this job belongs to is considered complete when allNOCONDITIONAL jobs are complete.

Usage notes Within the scope of a FILE_TRIGGER statement, a FILENAME statement must be

used to describe the trigger.

Relatedinformation

For information on building a non-MVS file dependency, see the FILENAMEstatement.

For information on identifying the name of a job in an Application, see the JOBstatement.

Continued on next page

Page 306: ESP 5.2 Command Reference

306

FILE_TRIGGER Statement, Continued

Example 1 The following example builds a job level file trigger dependency:

APPL PAYROLLJCLLIB ‘CYB.ESP.JCL’FILE_TRIGGER WAIT4.DLY

AGENT AIXV120FILENAME /usr/sched/data UPDATERUN DAILYREL B

JOB BRUN DAILY

ENDJOB

In the above example, WAIT4.DLY is used to build a job level dependency whenthe non-MVS file /usr/sched/data is updated.

Page 307: ESP 5.2 Command Reference

307

FLAGUNDEF Statement

Overview The FLAGUNDEF statement finds references to undefined symbols in a symbol

library data set. It then checks subsequent symbol references and issues an errormessage if it finds any more undefined symbols.

Type Symbolic variable library statement.

Syntax The syntax of the FLAGUNDEF statement is:

FLAGUNDEF

Usage notes The FLAGUNDEF statement cannot be used in ESP Procedures.

If ESP flags an undefined symbol while submitting a job, ESP:

• Deletes the job and requests the user correct and resubmit the job• Identifies the job on the CSF with a PNODE of SUBERROR, and a status of

Submit Error, JCL missing.

The FLAGUNDEF statement affects all subsequent symbol reference processinguntil an ALLOWUNDEF statement is encountered.

If ESP encounters an undefined symbol, ESP processes undefined symbols withoutproducing an error message, i.e. ALLOWUNDEF is the default.

RelatedStatements

For information on turning off the flagging of undefined symbols, see theALLOWUNDEF statement.

For information on symbolic variables, see the ESP Workload Manager AdvancedUser’s Guide.

Example 1 The following FLAGUNDEF statement flags an undefined symbol in a symbolic

variable library:

INTEGER XFLAGUNDEFX=%EXXPADD/7+1

In the above example, ESP flags ‘X’ as an undefined symbol because an ESP built-in symbolic variable (ESPADD) was typed incorrectly (EXXPADD).

Continued on next page

Page 308: ESP 5.2 Command Reference

308

FLAGUNDEF Statement, Continued

Example 2 The following FLAGUNDEF and ALLOWUNDEF statements turn the flagging of

undefined symbols on and off:

FLAGUNDEFA=%BCALLOWUNDEFB=%XY

In the above example, when ESP encounters these undefined symbols whilesubmitting a job:

• A=%BC results in an error message - flagging is on (FLAGUNDEF)• B takes on the value of %XY - flagging is off (ALLOWUNDEF).

Page 309: ESP 5.2 Command Reference

309

FLOW Command

Overview The FLOW command is used in conjunction with the GENFLOW command toidentify a flow chart by a name of up to seven characters. The FLOW commandalso identifies jobs and/or Applications to be exported.

Type Reporting command

Syntax The syntax of the FLOW command is:

FLOW name[APPL(applname)][JOB(jobname)]

Parameter Descriptionname Indicates the name of the flow chart by a name of up to 7

characters.applname Indicates the name of an Application to be exported.jobname Indicates the name or names of jobs to be exported. Several

names can be specified, if separated by a comma. The namescan contain asterisks and end with a hyphen for a genericspecification.

Usage notes The following summarizes how to generate flowcharts with ESP and Timeline:

1. Issue the GENFLOW command indicating the input and output data sets2. Issue the FLOW command to identify the flow chart3. Issue the GO command to indicate all specifications are complete and that the

copy process should proceed4. Use a PC file transfer program to send the data to a PC5. On the PC, use a file editor to edit the file6. Access Timeline to import, view and print flowcharts

Relatedinformation

For information on creating graphical representations of workload, see the ESPWorkload Manager User’s Guide.

For information on exporting data that describes an ESP Application in a formatusable by MS Project, see the GENPROJ command.

For information on exporting data that describes an ESP Application in a formatusable by Timeline, see the GENFLOW command.

For information on indicating that all specifications are complete and that the copyprocess should proceed, see the GO command.

Continued on next page

Page 310: ESP 5.2 Command Reference

310

FLOW Command, Continued

Example 1 The following GENFLOW, FLOW and GO commands are used to export datadescribing an ESP Application in a format usable Timeline:

GENFLOW ‘CYBER.SAD’ ‘CYBER.FLOW’FLOW PAYROLL APPL(PAYROLL)GO

In the above example, ESP:

• Exports the jobnames, start and end times for all jobs in the PAYROLLApplication

• Identifies a flowchart called PAYROLL• Proceeds with the copy process. Note: After the above is completed transfer the file to a PC, edit that file and useTimeline to import, view and print the PAYROLL flowchart.

Example 2 The following GENFLOW, FLOW and GO commands are used to export data

describing an ESP Application in a format usable Timeline:

GENFLOW ‘CYBER.SAD’ ‘CYBER.FLOW’FLOW PAYROLL APPL(PAYROLL) JOB(PAY-)GO

In the above example, ESP:

• Exports the jobnames, start and end times for jobs with PAY in the first threepositions, within the PAYROLL Application

• Identifies a flowchart called PAYROLL• Proceeds with the copy process.

Page 311: ESP 5.2 Command Reference

311

FOOTING Command

Overview The FOOTING command is used to define a line to be displayed at the bottom of the

page when output is directed to a data set. Use the FOOTING command whengenerating history or modeling reports, or issuing an ESP command. Up to seventitle and footing lines can be active at any time.

Type General command, reporting command.

Syntax The syntax of the FOOTING command is:

FOOTING [n][DELETE][‘footing string’]

Parameter Description

n Indicates which footing line is being defined, or deleted. ncan be a value from one to seven. The default is 1.

DELETE Indicates the specified footing line is to be deleted. footing string Indicates the footing to be displayed. It should be enclosed

within quotes. If the footing contains quotes, use two quotesin place of each imbedded quote.

Usage notes The following are built-in variables which you can use in a footing string:

Parameter Description %CE Centers the Parameter within the output line. %DATE Full date, e.g. SUNDAY 4th JANUARY 1998. %DAY Day of week name, e.g. MONDAY. %DD Day of month number, i.e. from 01 to 31. %DDDD Julian day or day of year number. E.g. 365 for last day. %DOW# Day of week number, e.g. ‘1’ for Sunday, ‘7’ for Saturday,

regardless of calendar settings. %EVAL Returns the numeric value of an expression. An output-

format descriptor may follow the parameter to request leadingblanks or zeros.

%HH Hour, in 24-hour format, e.g. ‘14’. %LENGTH Returns the length of the Parameter. %MM Month number, e.g. ‘01’ if the month is January. %MMM First three characters of the month, e.g. ‘JAN’. %MM Minute of the hour. %MONTH Month name, e.g. JANUARY. %PAGE The current page number. %RJ Justifies the parameter on the right side of the output line. %SSS Seconds. %TIME Time, in 24-hour format, e.g. ‘14.30.00’.

Continued on next page

Page 312: ESP 5.2 Command Reference

312

FOOTING Command, Continued

Usage notes (continued)

Parameter Description %YEAR Year, e.g. 1999. %YY Last two characters of year, e.g. ‘99’.

Example 1 The following FOOTING command defines a line to be displayed at the bottom of

each page:

FOOTING ‘PAYROLL GROUP EVENTS’LIST ALL LEVEL(PAYROLL)

In the above example, a footing ‘Payroll Group Events’ is defined to accompany theoutput from the LIST command which requests a display of Events in the groupcalled PAYROLL.

Example 2 The following history report uses the FOOTING command to display an additional

line of information at the bottom of each page:

//HISTRPT JOB CYB3000,CLASS=A,MSGCLASS=X//STEP001 EXEC PGM=ESP,PARM='SUBSYS(E510)',REGION=4M//STEPLIB DD DSN=CYB2.ESP510Q.SSCPLINK,DISP=SHR//SYSPRINT DD SYSOUT=*//SYSIN DD *REPORTFROM 7AM TODAY LESS 1 WEEKCRITERIA JOBNAME EQ PAY-;DISPLAY JOBNAME,JOBNO,EXECSDATE,ENDDATE,CMPCSORT JOBNAMEFOOTING '%DATE %CE(PAYROLL JOBS) %RJ(PAGE %PAGE)'ENDR

In the above example, the following are displayed at the bottom of each page:

• The current date• PAYROLL JOBS, which is justified in the center of the page• The page number, which is justified on the right side of the page.

Example 3 The following FOOTING command defines a line to be displayed at the bottom of

each page:

FOOTING ‘CALENDARS %RJ(PAGE %PAGE)’

In the above example, a footing CALENDARS is defined. . The page number is tobe justified on the right side of the page.

Page 313: ESP 5.2 Command Reference

313

//* FROM Statement

Overview The //* FROM statement is used in combination with the TEMPLIB statement to

indicate that temporary JCL for a job is to be used from a particular date. TheTEMPLIB statement is used in an ESP Procedure to indicate a temporary or overrideJCL library.

Type ESP control statement used in JCL.

Syntax The syntax of the // * FROM statement is:

//*FROM criteria

Parameter Description

criteria Schedule criteria that resolve to a single date and time.

Usage notes The //* FROM statement is used in a JCL library that was identified as a temporary

JCL library using the TEMPLIB statement.

A single blank separates the ‘//*’ and the ‘FROM’.

The //* FROM statement is only available in JCL and must start in card column 1. Itmust be the first statement in the JCL. ESP checks the //* FROM date to determinewhether the JCL should be used. If no time is specified, the start-of-day time is used(default midnight – 00.00).

ESP compares the scheduled time and date of the Event to the criteria on the //*FROM statement to decide whether to use the JCL in the TEMPLIB for a job. If the//* FROM date and time has passed, ESP uses the JCL from the last defined JCLLIBin the Application.

Relatedinformation

For information on further limiting the window in which temporary JCL is used, seethe //* UNTIL statement.

For information on specifying a temporary or override JCL library, see theTEMPLIB statement.

For information on tailoring JCL that ESP submits, see the ESP Workload ManagerAdvanced User’s Guide.

Continued on next page

Page 314: ESP 5.2 Command Reference

314

//* FROM Statement, Continued

Example 1 The following // * FROM statement used in the JCL indicates a time and date from

when temporary JCL should be used:

//* FROM 9AM MAY 24,1999//PAYJOB1 JOB CYB,CLASS=A,MSGCLASS=0

In the above example, temporary JCL for PAYJOB1 is used from 9am on May 24,1999.

Note: If PAYJOB1 is submitted at 10 am, but the Event was scheduled at 8 am, ESPsubmits PAYJOB1 from the default JCL library (JCLLIB) not the temporary JCLlibrary (TEMPLIB).

Example 2 The following //* FROM statement used in the JCL indicates a time and date from

when temporary JCL should be used:

//* FROM AUGUST 6, 1998//PAYJOB2 JOB CYB,CLASS=A,MSGCLASS=0

In the above example, temporary JCL for PAYJOB2 is used from 00:00 (default) onAugust 6, 1998.

Example 3 The following //* FROM and //* UNTIL statements used in the JCL indicate a time

and date window when temporary JCL should be used:

//* FROM 9AM NOVEMBER 27, 1998//* UNTIL 4PM NOVEMBER 30, 1998//PAYJOB3 JOB CYB,CLASS=A,MSGCLASS=0

In the above example, temporary JCL for PAYJOB3 is used from 9 am onNovember 27, 1998 until 4 pm on November 30, 1998.

Page 315: ESP 5.2 Command Reference

315

FROM Command

Overview The FROM command is used to indicate a time range for the history reporting. This

allows you to limit your search based on the job submission time in the history file.You can use any valid schedule statement.

Type Report command.

Syntax The syntax of the FROM command is:

FROM starttime[TO(endtime)]

Parameter Description

starttime Indicates a free format starting time. Use any valid schedulecriteria that resolve to a single date and time.

endtime Indicates a free format, end time specification. (Defaults tonow). Use any valid schedule criteria that resolve to a singledate and time.

Usage notes The FROM parameter restricts history record extraction based on job submission

time. If an end time is not specified, the current time is assumed.

Relatedinformation

For information on reporting, see the ESP Workload Manager User’s Guide.

Example 1 The following history report uses the FROM command to specify a time range for

the history file search:

REPORTFROM 7AM TODAYCRITERIA JOBNAME EQ PAY;DISPLAY JOBNAME,JOBNO,EXECSDATE,ENDDATE,CMPCENDR

In the above example, all jobs with PAY in the first three positions run since 7 amthis morning are displayed in this report.

Continued on next page

Page 316: ESP 5.2 Command Reference

316

FROM Command, Continued

Example 2 The following history report uses the FROM command to specify a time range for

the history file search:

REPORTFROM 8AM YESTERDAY TO 4PM TODAYCRITERIA JOBNAME EQ PAY-;DISPLAY JOBNAME,JOBNO,ACCOUNT,RDRON,DEXCP,TEXCPENDR

In the above example, all jobs with PAY in the first three positions run between 8am yesterday and 4 pm today are displayed in this report.

Other examples Here are more examples using the FROM command.

Limit a history file search from 8 am yesterday to 8 am today:

FROM 8AM YESTERDAY TO 8AM TODAY

Limit a history file search from December 29th, 1999 to January 4th, 2000:

FROM DEC 29TH 1999 TO JAN 4TH 2000

Limit a history file search from 8 am one week ago to now:

FROM 8AM TODAY LESS 1 WEEK

Page 317: ESP 5.2 Command Reference

317

GENDOC Command

Overview Use the GENDOC command to convert an existing job documentation library to a

documentation library usable by ESP.

Type General command.

Syntax The syntax of the GENDOC command is:

GENDOC ‘inputdataset’ ‘outputdataset’[LEVEL(memname[,memname]...)][SNUM]

Parameter Description

inputdataset Indicates the name of the input data set, enclosed in quotes,which must be a PDS.

outputdataset Indicates the name of an output PDS, enclosed in quotes. Therecord format or record length does not have to match that ofthe input data set.

memname Indicates strings that identify the members to be copied. Youcan use wildcards in these strings. The ‘*’ wildcard characteris a single character wildcard, while ‘-’ is the multiple-character wildcard. ABC- matches any member namebeginning with ‘ABC’ while ‘A*C’ matches any three-character name beginning with ‘A’ and ending with ‘C’. Ifthe LEVEL keyword is omitted, all members are copied.

SNUM Indicates the last eight characters of a fixed-length recordshould be discarded during the copy process.

Usage notes The GENDOC command identifies the input data set, the members to be copied, and

the output data set. It also lets you identify changes you want to make when the oldjob documentation is converted.

There are two methods for converting documentation. The method you use dependson how you want to use your existing job documentation:

• If want to use ESP to retrieve your existing job documentation in its presentformat, you can insert a USERDESC label in each job documentation member.

• If you want ESP to modify the data to allow retrieval of information by labelname, you can use the GENDOC command.

Continued on next page

Page 318: ESP 5.2 Command Reference

318

GENDOC Command, Continued

Relatedinformation

For information on identifying lines that are not to be copied to the output data set,see the REMOVE command.

For information on altering or replacing lines in the output data set, or inserting linesat different locations, see the LABEL command.

For information on indicating that all specifications are complete and that the copyprocess should proceed, see the GO command.

For information on ESP’s job documentation facility, see the ESP WorkloadManager User’s Guide.

For information on displaying information from a job documentation library, see theJOBINFO command.

For information on identifying a job documentation library in an Application, seethe DOCLIB statement.

Example 1 The following GENDOC command is used to convert existing job documentation:

GENDOC ‘JOBDOC.DATA’ ‘ESP.JOBDOC.DATA’ LEVEL(JT-,JV-) SNUM

In the above example, all members beginning with ‘JT’ and ‘JV’ are copied fromJOBDOC.DATA to ESP.JOBDOC.DATA, suppressing any line numbers in theright-hand eight columns of each source member record.

Example 2 The following GENDOC, REMOVE, LABEL and GO commands are used to

convert existing job documentation:

GENDOC ‘JOBDOC.DATA’ ‘ESP.JOBDOC.DATA’ LEV(A–,B–) SNUMREMOVE ‘**’LABEL ‘SYSOUT REVIEW’ ‘SYSOUT_REVIEW’ INLINELABEL ‘STEP***’ ‘@:’ OVERLAYLABEL ‘RESTART PROCEDURES’ ‘RESTART:’ BEFOREGO

In the above example, ESP:

• Copies all members beginning with ‘A’ and ‘B’ from the data set‘JOBDOC.DATA’ to the data set ‘ESP.JOBDOC.DATA’, suppressing any linenumbers in the right–hand 8 columns of each source member record.

• Does not copy any lines containing ‘**’.• Replaces any lines starting with ‘SYSOUT REVIEW’ with the character string

‘SYSOUT_REVIEW’.• Overlays the colon on any line beginning with ‘STEP’. The colon is positioned

after the 3rd character following the string ‘STEP’.• Places the label ‘RESTART:’ on its own line before any line starting with the

string ‘RESTART PROCEDURES’.• Proceeds with the copy process.

Page 319: ESP 5.2 Command Reference

319

GENFLOW Command

Overview The GENFLOW command is used to export data that describes an ESP Applicationin a format usable by the PC-based project management software, Timeline. ESPuses information from a Scheduled Activity file and exports the jobname, start andend time fields.

Type Reporting command.

Syntax The syntax of the GENFLOW command is:

GENFLOW ‘inputdsn’ ‘outputdsn’

Parameter Descriptioninputdsn Indicates the name of the scheduled activity data set, enclosed

in quotes.outputdsn Indicates the name of an output data set, enclosed in quotes.

The output data set can be a sequential data set or a memberof a PDS.

Usage notes The following summarizes how to generate flowcharts with ESP and Timeline:

1. Issue the GENFLOW command indicating the input and output data sets2. Issue the FLOW command to identify the flow chart3. Issue the GO command to indicate all specifications are complete and that the

copy process should proceed4. Use a PC file transfer program to send the data to a PC5. On the PC use a file editor to edit the file6. Access Timeline to import, view and print flowcharts.

Relatedinformation

For information on identifying a flowchart, see the FLOW command.

For information on indicating that all specifications are complete and that the copyprocess should proceed, see the GO command.

For information on creating graphical representations of workload, see the ESPWorkload Manager User’s Guide.

For information on exporting data that describes an ESP Application in a formatusable MS Project, see the GENPROJ command.

Continued on next page

Page 320: ESP 5.2 Command Reference

320

GENFLOW Command, Continued

Example 1 The following GENFLOW, FLOW and GO commands are used to export datadescribing an ESP Application in a format usable by Timeline:

GENFLOW ‘ESP.DAILY.SADGEN’ ‘CYB.PC.TRANSFER’FLOW PAYROLL APPL(PAYROLL)GO

In the above example, ESP:

• Exports the jobnames, start and end times of jobs in the PAYROLL Application• Identifies a flowchart called PAYROLL• Proceeds with the copy process. Note: After the above is completed, transfer the file to a PC, edit that file and useTimeline to import, view and print the PAYROLL flowchart.

Page 321: ESP 5.2 Command Reference

321

GENPROJ Command

Overview The GENPROJ command is used to export data that describes an existing ESP

Application in a format usable by the PC based project management software, MSProject. ESP exports the following fields:

• jobname• subApplication name• start & end dates• duration• Late start & late end times• percent complete• tag.

Type Reporting command.

Syntax The syntax of the GENPROJ command is:

GENPROJ applname[.gen|OLDEST]DATASET(‘outputdsn’)

Parameter Description

applname Indicates the name of the Application to be used as input. Anabsolute or relative generation number (gen) can also bespecified as follows:

• applname.0 indicates the most recent generation• applname.-n indicates the nth previous generation• applname.n indicates the absolute generation n

outputdsn Indicates the name of an output data set enclosed in quotes.The output data set can be a sequential data set or a memberof a PDS. It can be VB or FB formats with an LRECL atleast 72 bytes long. ESP does not write records longer than72 bytes in length. ESP assigns the default attributes ofRECFM= FB, LRECL= 80, BLKSIZE= 3120 to data sets thatare allocated without DCB attributes.

OLDEST Indicates the oldest incomplete generation of the Applicationto be used as input. If all generations are complete, you can’tuse OLDEST.

Continued on next page

Page 322: ESP 5.2 Command Reference

322

GENPROJ Command, Continued

Usage notes The Application used as input must be available on the APPLFILE (i.e. accessiblevia the LISTAPPL command). It can be in either an active or complete state.

Information such as average or actual duration, starts date, end date, percentcomplete, late start time, late end time, etc. are exported and can be viewed.

The file created by GENPROJ can be transferred to a PC and then imported intoMicrosoft Project for viewing or printing.

The following summarizes how to generate flowcharts with ESP and MS Project:

1. Issue the GENPROJ command indicating the name of an active Application, andthe output data set. The copy process should proceed

2. Use a PC file transfer program to send the data to a PC3. Execute the Cybermation supplied utility CONVERT.EXE on your PC4. Access MS Project to view and print flowcharts

Relatedinformation

For information on creating graphical representations of workload, see the ESPWorkload Manager User’s Guide.

For information on exporting data that describes an ESP Application in a formatusable by Timeline, see the GENFLOW command.

Example 1 The following GENPROJ command extracts data from an Application:

GENPROJ PAYROLL.0 DATASET(‘PAYROLL.FLOWCHRT’)

In the above example, a file is generated called PAYROLL.FLOWCHRT thatcontains a description of the current generation of the PAYROLL Application.MS Project can then import this file.

Example 2 The following GENPROJ command extracts data from an Application:

GENPROJ PAYROLL OLDEST DATASET(‘PAYROLL.FLOWCHRT’)

In the above example, a file is generated called PAYROLL.FLOWCHRT thatcontains a description of the oldest incomplete generation of the PAYROLLApplication. MS Project can then import this file.

Page 323: ESP 5.2 Command Reference

323

GENTIME Command

Overview The GENTIME command is used to customize date and time symbols for anyscheduling criteria. It may be required to use date and time symbolic variables otherthan ESP’s built-in symbolic variables. Using the GENTIME command you create aset of customized date and time symbolic variables.

Type ESP Procedure statement, symbolic variable library statement.

Syntax The syntax of the GENTIME statement is:

GENTIME prefix criteria

Parameter Descriptionprefix Indicates a user-defined string of up to 55 characters that

becomes the prefix for the symbols you generate with thisstatement.

criteria Schedule criteria that resolve to a single date and time.

Usage notes The prefixes ‘ESPA’ and ‘ESPS’ are reserved for ESP’s built–in symbols andcannot be used in the GENTIME command.

You can test the symbols produced by a GENTIME command prior to storing thegenerated symbols permanently in a symbol library or ESP Procedure. Enter thefollowing commands in Page mode or Line mode:

• Enter the GENTIME command with your prefix and criteria.• Enter the ECHO command to send the symbols back to your terminal for

display. Note: When you use a GENTIME command for testing or demonstration purposes,the generated symbols are only temporary. They are lost when you exit from the ESPMain Menu.

When specifying the criteria in your GENTIME command via Page mode, it isadvised to use ‘STARTING’ to establish effective time and get results consistentwith your ESP Procedures.

GENTIME variables are commonly used in JCL.

Continued on next page

Page 324: ESP 5.2 Command Reference

324

GENTIME Command, Continued

Usage notescontinued

The GENTIME command generates the following 15 customized date and timesymbolic variables:

Variable Description

prefixDATE The Event date in full.• Example: Sunday 4th January 1998

prefixYY The last two digits of the year• Example: 98

prefixYEAR The Year.• Example: 1998

prefixMM The number of month.• Example: 01 for January

prefixMMM The first three characters of month.• Example: Jan

prefixMONTH The name of month.• Example: January

prefixDAY The name of the day of the week.• Example: Monday

prefixDD The number of actual day of month.• Example: 09

prefixDDD The Julian day, or the number day in the year.• Example: 365

PrefixDDQL The ordinal qualifier for the day.• Example: st, nd, rd or th

prefixDOW# The number of day in week as specified in a calendar.• Example: 1 for Sunday (ESP default)

prefixTIME The time in 24-hour format.• Example: 14.55.32

prefixHH The hour in 24-hour format.• Example: 14

prefixMN The minute of hour.• Example: 55

prefixSS The number of seconds past the minute.• Example: 32

You can choose to use any of the variables you generate with the GENTIME

command.

RelatedStatements

For information on testing dates and times produced by the GENTIME command,see the ESP Workload Manager Advanced User’s Guide.

Continued on next page

Page 325: ESP 5.2 Command Reference

325

GENTIME Command, Continued

Example 1 The following GENTIME command is used to generate customized date and time

variables:

GENTIME NWD TODAY PLUS 1 WORKDAY

In the above example, a series of 14 customized date and time based variable aregenerated that refer to the next workday. Each of the 14 variables are prefixed with‘NWD’.

For example, if this GENTIME command was processed on February 18th, 1998:

• %NWDMM resolves to 02• %NWDDD resolves to 049• %NWDYY resolves to 98• %NWDDOW# resolves to 4• %NWDDATE resolves to Wednesday February 18th, 1998.

Example 2 The following GENTIME command is used to generate customized date and time

variables:

GENTIME FWM FIRST WORKDAY OF MONTH STARTING TODAY

In the above example, a series of 14 customized date and time based variable aregenerated that refer to the first workday of the current month. Each of the 14variables are prefixed with ‘FWM’.

Example 3 The output from the first GENTIME command, in the following example, is used as

input to another GENTIME command:

GENTIME PWK TODAY LESS 1 WEEKGENTIME PWD %PWKDATE LESS 1 WORKDAY

In the above example, the first GENTIME command generates a series of date andtime variables that refer to one week ago. Each of the variables are prefixed with‘PWK’. This date is then used in the second GENTIME to generate another seriesof date and time variable that refer to workday prior to one week ago. Each of thesevariables are prefixed with ‘PWD’.

Continued on next page

Page 326: ESP 5.2 Command Reference

326

GENTIME Command, Continued

Example 4 The following GENTIME commands are used to establish a run frequency for a job

in an Application:

APPL PAYROLLJCLLIB 'CYBER.JCL.CNTL'GENTIME AA LAST WORKDAY OF WEEK STA TODAY LESS 1 WEEKGENTIME BB LAST WORKDAY OF MONTH STA TODAY LESS 1 MONTHJOB PAYJOB1

IF TODAY('NOT LAST WORKDAY OF WEEK') AND -TODAY('LAST WORKDAY OF MONTH') THEN RUN TODAY

IF TODAY('1ST FRI OF MONTH') AND %AADATE EQ %BBDATE THEN RUNTODAYENDJOB

In the above example:

• If the last workday of the week is not the last workday of the month then runPAYJOB1 today

• If the last workday of the week is the last workday of the month then PAYJOB1on the 1ST Friday of the next month.

Other examples Here are more examples using the GENTIME command.

Seven days after today:

GENTIME AA TODAY PLUS 7 DAYS

Two workdays prior to today:

GENTIME BB TODAY LESS 2 WORKDAYS

One week prior to today:

GENTIME CC TODAY LESS 1 WEEK

First workday of previous month:

GENTIME DD FIRST WORKDAY OF MONTH STARTING TODAY LESS 1 MONTH

Next day:

GENTIME EE TODAY PLUS 1 DAY

Next workday:

GENTIME FF TODAY PLUS 1 WORKDAY

Two days after today:

GENTIME GG TODAY PLUS 1 DAY

Page 327: ESP 5.2 Command Reference

327

GO Command

Overview The GO command is used in conjunction with the GENDOC and GENFLOW

commands. It indicates that the GENDOC or GENFLOW specification is completeand the copy process should begin.

Type General command, reporting command.

Syntax The syntax of the GO command is:

GO

Relatedinformation

For information on ESP’s job documentation facility, see the ESP WorkloadManager User’s Guide.

For information on creating graphical representations of workload, see the ESPWorkload Manager User’s Guide.

Example 1 The following GENDOC, REMOVE, LABEL and GO commands are used to

convert existing job documentation:

GENDOC ‘JOBDOC.DATA’ ‘ESP.JOBDOC.DATA’ LEV(A–,B–) SNUMREMOVE ‘**’ LABEL ‘RESTART PROCEDURES’ ‘RESTART:’ BEFOREGO

In the above example, the GO command indicates that the GENDOC specification iscomplete and that the copy process should start.

Example 2 The following GENFLOW, FLOW and GO commands are used to export data

describing an ESP Application in a format usable by Timeline:

GENFLOW ‘ESP.DAILY.SADGEN’ ‘CYB.PC.TRANSFER’FLOW PAYROLL APPL(PAYROLL)GO

In the above example, the GO command indicates that the GENFLOW specificationis complete and that the copy process should start.

Page 328: ESP 5.2 Command Reference

328

GROUP Command

Overview The GROUP command is used in Page mode to switch between a user’s user ID and

any group (that is the high level prefix) the user can access. It is useful when usingcommands where a group prefix is required, such as TRIGGER.

Type General command.

Syntax The syntax of the GROUP command is:

{GROUP|GR} [groupprefix][USERID][PREFIX]

Parameter Description

groupprefix Indicates up to eight characters to be the prefix forunqualified Event descriptive names. (You must beconnected to the group specified.)

USERID Indicates the current TSO USERID is used to prefixunqualified Event names.

PREFIX Indicates the current TSO data set name prefix is used as theprefix for unqualified Event names.

Usage notes The value of the group prefix is retained from session to session, until it is reset.

The initial value is ‘USERID’. The group prefix for Events is similar in concept tothe TSO data set name prefix.

If the GROUP command is entered without any operands, your current group prefixis displayed.

The GROUP command can be used with or without the SAF interface.

Relatedinformation

For information on ESP users and groups, see the ESP Workload ManagerAdministrator’s Guide.

For information on defining and deleting groups, see the DEFGROUP andDELGROUP commands.

For information on displaying information about a group, see the LISTGRPcommand.

Continued on next page

Page 329: ESP 5.2 Command Reference

329

GROUP Command, Continued

Example 1 The following GROUP command displays the current group prefix:

GROUP

In the above example, the current group prefix is displayed.

Example 2 The following GROUP command switches a user ID’s access to another group:

GROUP PROD

In the above example, the default prefix is switched to PROD. To trigger an Eventcalled PROD.PAYROLL, this user can issue the TRIGGER command withouthaving to specify the group prefix, as follows:

TRIGGER PAYROLL vs. TRIGGER PROD.PAYROLL

Page 330: ESP 5.2 Command Reference

330

HARDCOPY Command - DATASET Option

Overview

The HARDCOPY command is used to request that a data type printout be divertedto a data set, sysout class or DD file. Each option is documented separately. TheHARDCOPY command cannot be used in batch.

Type General command.

Syntax The syntax of the HARDCOPY command is:

{HARDCOPY|HCPY} DATASET(dsname)[VOLUME(serial)][UNIT(unitname)][SPACE(primary[,secondary]){CYLINDERS}]

{TRACKS}]{BLOCKS}]

[EXTEND][LRECL(length)][RECFM{(V)|(F)}][PAGELENGTH(lines)][BLOCK(size)][BLKSIZE(block)]

Parameter Description

dsname Indicates the data set name, enclosed in quotes, to which theoutput should be diverted. You should include a membername if you are diverting output to a PDS.

serial Indicates the serial number (up to six characters) for the dataset if you are specifying a new data set, or if you are using anexisting data set that is not catalogued.

unitname Indicates the name of the output device type, using up to eightcharacters.

primary Indicates the primary allocation you want to assign, inparentheses. You must specify this if you are allocatingCYLINDERS, TRACKS or BLOCKS.

secondary Indicates the secondary allocation you want to assign, inparentheses. If you use this parameter you must use theappropriate keyword to specify whether you are allocatingCYLINDERS, TRACKS or BLOCKS. If you are specifyingprimary and secondary allocation, specify one of thesekeywords after the secondary allocation specified. Do not useparentheses.

EXTEND Indicates the output should be added to the end of the dataset. If you do not specify EXTEND, the data set isoverwritten.

length Indicates the logical record length for each line of output.Specify the number of characters you want in each line.

V Indicates variable length records. This is the default. Theline length is four bytes less than what you specified under‘LRECL’.

Continued on next page

Page 331: ESP 5.2 Command Reference

331

HARDCOPY Command - DATASET Option, Continued

Syntax (continued)

Parameter Description F Indicates fixed length records. lines Indicates the number of lines on each page, including titles

and footings. size Indicates the size in bytes of a block allocation unit. block Indicates the actual length of blocks on a data set. The limit

is 32767 bytes.

Usage notes Use this command in Page mode when you want to direct output to a data set.

Relatedinformation

For information on stopping the routing of output as specified by a HARDCOPYcommand, see the ENDHC command.

Example 1 The following HARDCOPY command diverts output:

HARDCOPY DATASET(‘PRINT1A.REPS’) SPACE(2,1) TRACKSVOLUME(AX401B)

In the above example, output is diverted to the PRINT1A.REPS data set, with aprimary allocation of two tracks and a secondary allocation of one track, on thevolume serial AX401B.

Example 2 The following HARDCOPY command diverts output to a data set:

HARDCOPY DATASET(‘CYB.HRDCPY’)L LEVEL(PROD-)ENDHC

In the above example, output produced by the LIST command is diverted to theCYB.HRDCPY data set.

Page 332: ESP 5.2 Command Reference

332

HARDCOPY Command - FILE Option

Overview The HARDCOPY command is used to request that a data type printout be diverted

to a data set, sysout class or DD file. Each option is documented separately. TheHARDCOPY command cannot be used in batch.

Syntax The syntax of the HARDCOPY command is:

{HARDCOPY|HCPY} DDNAME(file)[EXTEND][LRECL(length)][RECFM{(V)|(F)}][PAGELENGTH(lines)][BLOCK(size)][BLKSIZE(block)]

Parameter Description

file Indicates a file name using up to eight characters. EXTEND Indicates that the output should be added to the end of the

data set. length Indicates the logical record length for each line of output.

Specify the number of characters you want in each line. V Indicates variable length records. This is the default. The

line length is four bytes less than what you specified under‘LRECL’.

F Indicates fixed length records. lines Indicates the number of lines on each page, including titles

and footings. size Indicates the size in bytes of a block allocation unit. block Indicates the actual length of blocks on a data set. The limit

is 32767 bytes.

Usage notes Use this command in Page mode when you want to direct output to a DD name.

Relatedinformation

For information on stopping the routing of outputs specified by a HARDCOPYcommand, see the ENDHC command.

Example 1 The following HARDCOPY command diverts output:

HARDCOPY DDNAME(HISTREC1) LRECL(80) RECFM(F) EXTEND

In the above example, output is diverted to the HISTREC1 file. The logical recordlength for each line of output should be 80, in fixed length records. All output isadded to the end of the file.

Continued on next page

Page 333: ESP 5.2 Command Reference

333

HARDCOPY Command - FILE Option, Continued

Example 2 The following HARDCOPY command diverts output to a file:

HARDCOPY DDNAME(HRDCPY)L LEVEL(PROD-)ENDHC

In the above example, output produced by the LIST command is diverted to theHRDCPY file.

Page 334: ESP 5.2 Command Reference

334

HARDCOPY Command - SYSOUT Option

Overview The HARDCOPY command is used to request that a data type printout be diverted

to a data set, sysout class or DD file. Each option is documented separately. TheHARDCOPY command cannot be used in batch.

Type General command.

Syntax The syntax of the HARDCOPY command is:

{HARDCOPY|HCPY} SYSOUT(class)[DEST(destcode)][COPIES(n)][FORM(type)][LRECL(length)][RECFM{(V)|(F)}][PAGELENGTH(lines)][UCS(char)][SPIN]

Parameter Description

class Indicates a one-character class number. destcode Indicates a destination code of up to eight characters. If you

do not specify ‘DEST’, the destination defaults to ‘LOCAL’. n Indicates the number of copies you want printed. The

maximum is 240 copies. type Indicates the type of form you want to use for printing, using

up to four characters for the code. length Indicates the logical record length for each line of output.

Specify the number of characters you want in each line. V Indicates variable length records. This is the default. The

line length is four bytes less than what you have specifiedunder ‘LRECL’.

F Indicates fixed length records. lines Indicates the number of lines on each page, including titles

and footings. char Indicates the universal character set type you want to be used

on the printer for this printout. SPIN Indicates that the data should be made available for printing

as soon as you enter the ENDHC (end hardcopy) command.

Usage notes Use this command in Page mode when you want to direct output to SYSOUT.

Relatedinformation

For information on stopping the routing of output as specified by a HARDCOPYcommand, see the ENDHC command.

Continued on next page

Page 335: ESP 5.2 Command Reference

335

HARDCOPY Command - SYSOUT Option, Continued

Example 1 The following HARDCOPY command diverts output:

HARDCOPY SYSOUT(1) DEST(RMT1) FORM(ANC8) SPIN

In the above example, output is diverted to SYSOUT class 1. The destination isRMT1 and the form is ANC8. The data is available as soon as the ENDHCcommand is specified.

Example 2 The following HARDCOPY command diverts output to sysout class S:

HARDCOPY SYSOUT(S)L LEVEL(PROD-)ENDHC

In the above example, output produced by the LIST command is stored under youruser ID.

Page 336: ESP 5.2 Command Reference

336

HISTFILE Command - Reporting

Overview The HISTFILE command is used as part of a report definition. HISTFILE specifies

the identifiers of the HISTORY files to scan in order to generate a history report.

Type Reporting command.

Authority You may be restricted to history files to which you have access. This is controlled

via your ESP administrator. In SAF environments access is specified in the UserProfile Definition Table. In non-SAF environments access is specified via theDEFUSER command.

Syntax The syntax of the HISTFILE command is:

HISTFILE hfid

Parameter Description

hfid Indicates the history file identifier of up to eight characters.Several identifiers can be specified if enclosed in parenthesesand separated by blanks or commas.

Usage notes If you omit this parameter, all history files to which you are permitted access are

scanned.

RelatedStatements

For information on defining or altering the history file, see the HISTFILE command,or the HISTFILE Initialization Parameter in the ESP Workload Manager Installationand Reference Guide.

For information on defining or altering the history file, see the HISTFILE commandin the ESP Workload Manager Installation Guide.

For information on history reporting, see the ESP Workload Manager User’s Guide.

For information on displaying history files, see the LISTHIST command.

For information on working with history files, see the ESP Workload ManagerAdministrator’s Guide.

Continued on next page

Page 337: ESP 5.2 Command Reference

337

HISTFILE Command - Reporting, Continued

Example 1 The following is an example of a history report definition:

REPORTHISTFILE HIST1FROM 7AM YESTERDAYCRITERIA APPLSYS EQ PAYROLLDISPLAY JOBNAME JOBNO APPLSYS CMPCENDR

In the above example:

• The REPORT command invokes the report processor• The HISTFILE command indicates that HIST1 is to be scanned• The FROM, CRITERIA and DISPLAY report statements define the report• The ENDR command ends the report definition and initiates report generation

Other examples Here are more examples using the HISTFILE command.

Indicates that history files with HIST in the first 4 positions are used:

HISTFILE HIST-

Indicates that HIST1 and HIST2 are used:

HISTFILE (HIST1,HIST2)

Page 338: ESP 5.2 Command Reference

338

HISTFILE Command - Definition/Alteration

Overview Used to define or alter the definition of an ESP history data set.

Type General command.

Authority OPER authority is required to issue the HISTFILE command.

Syntax The syntax of the HISTFILE command is:

HISTFILE histfid[DSNAME(dsname)][NEWDSNAME(newdsname)][BACKUPDSNAME(backupdsname)|NOBACKUPDSNAME][DEFINE|DELETE|OPEN|CLOSE|SET][SHR|NOSHR][JOURNAL|NOJOURNAL][BACKUPTIME(‘schedule’)|NOBACKUPTIME]

Parameter Description

histfid Indicates a unique identifier of up to eight characters. dsname Indicates the name of a VSAM KSDS. newdsname Indicates the name of a VSAM KSDS. backupdsname Indicates a non-VSAM sequential data set. NOBACKUPDSNAME Used to remove the backupdsname, if already specified. DEFINE Indicates a new History file database is being defined. If

not specified, DEFINE is assumed. DELETE Indicates a HISTFILE definition is to be deleted. The

associated VSAM data set is NOT deleted, only thelogical HISTFILE ID is deleted.

OPEN Indicates a histfile is to be reopened. CLOSE Indicates a HISTFILE is to be closed and de-allocated. SET Indicates an existing specification is changed without the

need to open or close the data set. SHR Indicates the data set is to be shared. NOSHR Indicates the data set is not to be shared. JOURNAL Indicates a record be written to SMF each time a history

record is inserted, updated or deleted. NOJOURNAL Indicates no records be written to SMF when the

HISTFILE is updated. Use this keyword to cancel aprevious JOURNAL request.

schedule Indicates a time schedule using the same syntax as ESPschedule statements. If the text string contains blanks orcommas, it should be enclosed within quotes.

NOBACKUPTIME Used to remove the backuptime, if already specified.

Continued on next page

Page 339: ESP 5.2 Command Reference

339

HISTFILE Command - Definition/Alteration, Continued

Usage notes The HISTFILE command is used to define and initialize a job history data set. Use

the DEFINE keyword along with the DSNAME Parameter. The identifier (up toeight characters) is the name to be associated with that logical entity.

When a tracking model is defined, a job history file ID can be specified. Thisidentifies to which data set the history data is written. Use of the ID rather than thedata set name allows the actual data set name to be changed without having to alterall references to it.

The BACKUPTIME keyword specifies a time at which time the HISTFILE isautomatically backed up to the BACKUPDSNAME data set.

You can also backup a history file with the BKUPHIST command.

Relatedinformation

For information on working with history files, see the ESP Workload ManagerAdministrator’s Guide.

For information on displaying history files, see the LISTHIST command.

Example 1 The following HISTFILE command defines a history file:

HISTFILE HISTF1 DEFINE DSNAME(ESP.HISTFILE) SHR

In the above example, a new history recording file called HISTF1 is defined. Theactual data set used is ESP.HISTFILE, and its disposition is shared.

Example 2 The following HISTFILE command sets the journal option:

HISTFILE HISTF1 SET JOURNAL

In the above example, records are written to SMF each time a history record isinserted, updated or deleted.

Example 3 The following HISTFILE command closes a history file:

HISTFILE HISTF1 CLOSE

In the above example, HIST1 is closed and de-allocated from ESP.

Page 340: ESP 5.2 Command Reference

340

HOLD Command - Event Level

Overview The HOLD command at the Event level is used to hold an Event from being

processed by ESP at a particular time. When ESP encounters a HOLD command inan Event, it increments the Event’s hold count by one at the time and date specifiedin the command. While the hold count is greater than zero, the Event’s execution ispostponed until the hold count is decremented by the RELEASE command.

Type Event definition command.

Syntax The syntax of the HOLD command is:

HOLD criteria

Parameter Description

criteria Schedule criteria.

Usage notes The RELEASE command is used in conjunction with the HOLD command to make

a previously postponed Event eligible for execution.

If an Event is in both a suspended and a held state when due for scheduling, theEvent is considered suspended.

When the hold count of an Event is reduced to zero, the Event’s overdue countspecified at definition time, on the SCHEDULE command, determines the numberof times the Event should execute. The default overdue count is 1.

Issuing a HOLD command against an Event that invokes an Application takes effecton the next scheduled execution of that Event. An active Application that has aHOLD command issued against the Event that invokes it does not cause thatApplication to stop processing. Use the APPLJOB or AJ command to manipulateApplications and jobs belonging to Applications.

If you are using a time zone on your HOLD command, you should use the sametimezone on your RELEASE command. If the Event has a schedule statement, thesame time zone should be used on the SCHEDULE, HOLD and RELEASEcommands.

Note:

The RESUME command is used in conjunction with the SUSPEND command tomake a previously bypassed Event eligible for execution.

Relatedinformation

For information on Events, see the ESP Workload Manager User’s Guide.

For information on decrementing an Event’s hold count that was previouslyincremented via a HOLD command, see the RELEASE command.

Continued on next page

Page 341: ESP 5.2 Command Reference

341

HOLD Command - Event Level, Continued

Example 1 The following is an example of an Event definition:

EVENT ID(CYBER.PAYROLL)DSTRIG PAYROLL.INPUTHOLD DAILY AT 9AMRELEASE DAILY AT 11AMSUBMIT ‘CYBER.JCL.CNTL(PAYJOB1)’ENDDEF

In the above example, HOLD and RELEASE commands are used to preventPAYJOB1 from being submitted between 9 am and 11 am. If thePAYROLL.INPUT data set is created during 9 am and 11 am, the Event waits.

The following is an example of the comments ESP adds to the Event if thePAYROLL.INPUT is created between 9 am and 11 am:

EVENT ID(CYBER.PAYROLL)DSTRIG PAYROLL.INPUTHOLD DAILY AT 9AMRELEASE DAILY AT 11AMSUBMIT ‘CYBER.JCL.CNTL(PAYJOB1)’/* FOLLOWING EXECUTIONS PENDING:/* DATASET TRIGGER BY JOB ACCJOB9 AT 09.15.00 ON THU FEB, 1998/* DSN PAYROLL.INPUTENDDEF

Example 2 The following is an example of an Event definition:

EVENT ID(CYBER.PAYROLL)DSTRIG PAYROLL.INPUTHOLD 9AM FEB 14, 1998 ONCERELEASE 11AM FEB 14, 1998 ONCESUBMIT ‘CYBER.JCL.CNTL(PAYJOB2)’ENDDEF

In the above example, HOLD and RELEASE commands are used to preventPAYJOB2 from being submitted between 9 am and 11 am on February 14 1998.

Page 342: ESP 5.2 Command Reference

342

HOLD Command - General

Overview The HOLD command is used to hold an Event from being processed by ESP. This

increments the Event’s hold count. While the hold count is greater than zero, theEvent’s execution is postponed until the hold count is decremented by theRELEASE command.

Type General command.

Syntax The syntax of the HOLD command is:

HOLD eventid

Parameter Description

eventid Indicates a valid Event name. If the prefix is omitted thecurrent prefix as set by the GROUP command is used.

Usage notes Holding an Event is different from suspending it.

If the scheduled time for an Event comes up while it is in the suspended state, theEvent execution is bypassed, and it is not considered overdue.

If the Event is in a held state, it is placed in an overdue status. When the Event isfinally released, the overdue count is checked to see whether execution shouldproceed. The Event is checked immediately for every occurrence missed while inthe held state, up to the overdue limit count specified when the Event was defined.

If an Event is in both a suspended and hold state when due for scheduling, the holdstate is ignored, and the Event is considered suspended.

The HOLD command is used in conjunction with the RELEASE command. (TheSUSPEND command goes hand in hand with the RESUME command).

Relatedinformation

For information on Events, see the ESP Workload Manager User’s Guide.

For information on decrementing an Event’s hold count that was previouslyincremented via a HOLD command, see the RELEASE command.

For information on bypassing and resuming an Event’s execution, see theSUSPEND and RESUME commands.

Continued on next page

Page 343: ESP 5.2 Command Reference

343

HOLD Command - General, Continued

Example 1 The following HOLD command postpones the execution of an Event:

HOLD CYBER.PAYROLL

In the above example, CYBER.PAYROLL is held, incrementing its hold count to 1.To decrement the hold count, use the RELEASE command to makeCYBER.PAYROLL eligible for execution.

Page 344: ESP 5.2 Command Reference

344

IF Statement

Overview The IF statement is used to conditionally process an instruction or group of

instructions depending on the evaluation of an expression. The IF statement is usedin conjunction with the THEN and ELSE statements.

Type ESP Control Language (CLANG) statement.

Syntax The syntax of the IF statement is:

IF expression

Parameter Description

expression Indicates an expression that can be evaluated to return a true orfalse value.

Usage notes When you use an IF statement, the expression that follows it must return a true or

false value. You can use any number of nested IF statements.

The THEN statement is used in conjunction with an IF statement when theexpression that follows the IF statement returns a true value.

The ELSE statement is used in conjunction with an IF statement when theexpression that follows the IF statement returns a false value.

If a THEN or ELSE statement continues to another line, use a line continuationcharacter (– or +). If there is no continuation character, ESP ignores the THEN orELSE statements.

You must begin and end compound action statements with DO and ENDDOlanguage elements.

When ESP encounters an IF statement that evaluates as false, ESP skips everythinguntil an ELSE or ENDDO statement is encountered, this includes any symbolicvariable declarations. Symbolic variable declarations coded within an IF statementblock that evaluate as false will result in a variable not defined error message. If youwant a symbolic variable to be available inside and outside an IF statement block,declare it outside.

RelatedStatements

For information on using ESP’s Control Language, see the ESP Workload ManagerUser’s and Advanced User’s Guides.

For more information on specifying conditional logic, see the THEN and ELSEstatements.

Continued on next page

Page 345: ESP 5.2 Command Reference

345

IF Statement, Continued

Example 1 The following logic is used to process different action statements:

IF %ESPADAY = ‘MONDAY’ THEN -SEND ‘TODAY IS MONDAY’ U(USR01)

ELSE -SEND ‘TODAY IS %ESPADAY’ U(USR01)

In the above example, ESP determines if the actual day is equal to Monday. If theevaluation of this expression is true, ESP sends a message indicating that today isMonday to USR01. If the evaluation of this expression is false, ESP sends amessage to USR01 indicating what today is.

Example 2 The following logic is used to determine when a job runs:

JOB PAYJOB1IF TODAY(‘FIRST DAY OF MONTH’) AND TODAY(‘TUESDAY’) THEN -

RUN TODAYENDJOB

In the above example, ESP determines if today is the first day of the month andTUESDAY, and if this condition is true then PAYJOB1 is selected to run.

Example 3 The following logic is used to set the value of a user defined symbolic variable:

IF ESPSMM<5 THEN DOGENTIME LAST TODAY LESS 1 YEARFINANCIAL_YEAR=’%LASTYY%ESPSYY’

ENDDOELSE DO

GENTIME NEXT TODAY PLUS 1 YEARFINANCIAL_YEAR=’%ESPSYY%NEXTYY’

ENDDO

In the above example, a user defined symbolic variable called‘FINANCIAL_YEAR’ which consists of two, 2–digit year numbers, and is set asfollows:

• if the current month is January, February, March or April, use last yearfollowed by this year

• for any other month, use current year followed by next year.

Page 346: ESP 5.2 Command Reference

346

%INCLUDE Statement

Overview The %INCLUDE statement requests selective inclusion of JCL and DATA based oncriteria such as time, date, day of the week and Event ID, or a combination of theseparameters. The %INCLUDE statement is used to include portions of JCL or toinclude control statements from a symbolic variable library.

Type ESP control statement used in JCL and in symbolic variable library statement.

Syntax The syntax of the %INCLUDE statement is:

%INCLUDE [FROM(fromdate)][TO(todate)][DAY(dayofweek[,dayofweek]...)][EVENT(eventid)][IF(expression)][COPYJCL]

Parameter Description

fromdate Indicates a time and date specification in any format that isvalid in a schedule statement.

todate Indicates a time and date specification in any format that isvalid in a schedule statement.

dayofweek Indicates a valid day of week name, which can be abbreviatedto the first three characters. Several day of week names can bespecified, separated by blanks or commas.

eventid Indicates a valid Event name, which can contain the prefix anddescriptive name, or just the descriptive name of the Event. Ifthe prefix is omitted, the prefix of the current Event is assumed.Several Event IDs can be specified, separated by blanks orcommas.

expression Value of a logical expression. COPYJCL Specifies the inclusion should apply to the copy of the JCL

written to a library as a result of the COPYJCL statement. Note: Applies to JCL tailoring only, and not to symbolicvariable libraries.

Continued on next page

Page 347: ESP 5.2 Command Reference

347

%INCLUDE Statement, Continued

Usage notes The %INCLUDE statement cannot be used in an ESP Procedure.

The %INCLUDE parameter must start in Column 1. If you want to include astatement with the characters %INCLUDE starting in column 1, but to have ittreated as data rather than a control statement, code %%INCLUDE. The first percentsign is removed.

The %INCLUDE statement can be continued onto a second line by placing a ‘+’ or‘-’ on the last non-blank character of the line. A ‘+’ strips leading blanks from thenext line, whereas a ‘-’ does not. Only one continuation per statement is allowed.

The scope of an %INCLUDE statement includes data until one of the followingstatements is encountered:

• %INCLUDE statement• %EXCLUDE statement• %ENDINCL statement• %ENDEXCL statement.

If no parameters are specified, the data following the %INCLUDE statement isalways included.

If you specify a FROM date but no TO date, a TO date of January 1st 2042 isassumed. Similarly, if you omit a FROM date, a date of January 1st 1900 isassumed.

If no time is specified, 00:00 is assumed for the FROM and TO parameters.

The FROM and TO parameters are based on the scheduled date.

ESP decides what to include in the JCL when it submits the job.

Usage notescontinued

Note: Before using the %INCLUDE statement, check with your systemadministrator to ensure no changes were made during your ESP installation thataffect the way ESP recognizes these statements. For example, another product maymake conflicting use of these terms, in which case your system administrator canchange them.

Relatedinformation

For information on selectively excluding JCL and DATA, see the %EXCLUDEstatement.

For information on ending the selective inclusion of JCL and DATA, see the%ENDINCL statement.

Continued on next page

Page 348: ESP 5.2 Command Reference

348

%INCLUDE Statement, Continued

Example 1 The following %INCLUDE statement used in a symbolic variable library requests

the inclusion of data on Mondays:

%INCLUDE DAY(MONDAY)PARM=’ABC’%ENDINCL

In the above example, the value of PARM resolves to ‘ABC’ on Mondays.

Example 2 The following %INCLUDE statement used in JCL requests the inclusion of a DD

statement on Mondays:

%INCLUDE DAY(MONDAY)//INPUT05 DD DSN=CYBER.INPUT.DATA,DISP=SHR%ENDINCL

In the above example, the DD statement INPUT05 is included on Mondays.

Example 3 The following %INCLUDE statement used in a symbolic variable library requests

the inclusion of data on different days of the week:

%INCLUDE IF(TODAY(‘MON,WED,FRI’))DIVISION=’123’%INCLUDE IF(TODAY(‘TUE,THU,SAT’))DIVISION=’456’%ENDINCL

In the above example, the value of DIVISION resolves to ‘123’ on Monday,Wednesday or Friday and to ‘456’ on Tuesday, Thursday or Saturday. These daysrefer to the scheduled days of the Event.

Continued on next page

Page 349: ESP 5.2 Command Reference

349

%INCLUDE Statement, Continued

Example 4 The following %INCLUDE statements used in JCL request the inclusion of various

steps:

//CYBERJOB JOB CYB999,CLASS=A,MSGCLASS=S//STEP1 EXEC PGM=IEFBR14%INCLUDE IF(ESPSDATE=ESPADATE)//STEP2 EXEC PGM=PGM1%INCLUDE IF(ESPATIME GT 07.59.00)//STEP3 EXEC PGM=PGM2%INCLUDE FROM(‘MAY 1,1997’) TO(‘MAY 5,1997’)//STEP4 EXEC PGM=PGM3%INCLUDE IF(ESPAHH GE ‘08’ AND ESPAHH LE ‘14’ AND -TODAY(‘WED’))//STEP5 EXEC PGM=PGM4%ENDINCL

In the above example:

• STEP1 is included whenever ESP submits the job• STEP2 is included when the actual and scheduled date are equal• STEP3 is included when the actual time is greater than 07.59.00• STEP4 is included from May 1,1997 to midnight on May 4,1997. This is based

on the scheduled date.• STEP5 is included if the actual is between 8am and 2pm and the scheduled day

is Wednesday.

Other examples Here are more examples using the %INCLUDE statement.

Request inclusion if the value of CYCLE_NUMBER is equal to 9:

%INCLUDE IF(CYCLE_NUMBER=9)

Request inclusion if the actual hour is greater that 09 and today is not Friday:

%INCLUDE IF(ESPAHH GT ‘09’ AND TODAY(‘NOT FRIDAY’))

Request inclusion if a started task called CICSPROD is active:

%INCLUDE IF(ACTIVE(‘CICSPROD’))

Request inclusion if today is the last day of the year:

%INCLUDE IF (TODAY(‘LAST DAY OF YEAR’))

Page 350: ESP 5.2 Command Reference

350

INET Command

Overview The INET command is used to display and manipulate TCP/IP attributes.

Authority OPER authority is required to issue the INET command.

Syntax The syntax of the INET command is:

INET {DISPLAY} {ACTIVE}{CLOSE}{HOST_CACHE}{TCPIP}{TRACE}

{FLUSH HOST_CACHE}{HELP}{PURGE {ID socketid|TASK taskid}}{QUERY HOST hostname}{SET} {TRACE} SYSOUT(class)

{CLOSE {RESET|SHUTDOWN}}{HOST_CACHE TTL(seconds)}

{SPIN} {TRACE}{START} {TRACE}{STOP} {TRACE}

Parameter Description

DISPLAY Displays a TCP/IP object. The following options aresupported:

• INET DISPLAY ACTIVE• CLOSE• INET DISPLAY HOST_CACHE• INET DISPLAY TCPIP• INET DISPLAY TRACE

ACTIVE Display of all active TCP/IP sockets. CLOSE Displays the current TCP/IP close option.

(RESET or SHUTDOWN) HOST_CACHE Displays the ESP TCP/IP host cache entries. TCPIP Displays information on the current TCP/IP stack. TRACE Displays TCP/IP tracing facility. FLUSH FLUSH HOST_CACHE flushes the ESP TCP/IP host cache.

This is useful if a host cache entry has become invalidbecause of a modification to a host entry in the TCP/IPnetwork’s Domain Name System (DNS) configuration.

HELP Displays all the INET command options. PURGE Purges a TCP/IP socket or all TCP/IP sockets running under a

specified task. QUERY HOSThostname

Displays the TCP/IP address of a host. The short form is:INET Q H hostname.

Continued on next page

Page 351: ESP 5.2 Command Reference

351

INET Command, Continued

ID Requests that an active socket be purged.

Note: This option is not supported if IBM’s IUCV is theTCP/IP stack.

socketid Displays a list of currently active TCP/IP sockets. TASK Displays a list of currently active TCP/IP sockets and their

respective task IDs. taskid Displays a list of currently active TCP/IP sockets and their

respective task IDs. SET Sets a TCP/IP object. SYSOUT(class) Indicates a print data set for the TRACE log SYSOUT. CLOSE This parameter should only be used under the direction of

Cybermation technical support. It tells ESP and Workstationserver how to close a TCP/IP connection, either gracefully(SHUTDOWN) or forcefully (RESET). The default isSHUTDOWN.

HOST_CACHETTL

Used to activate or de-activate ESP TCP/IP host caching, orto reset the time to live(TTL) interval. Seconds is the time tolive value within the range 0-99999999. A value of zero(0)de-activates ESP TCP/IP host caching. This command canalso be specified in the Initialization Parameters.

SPIN Spins a TCP/IP object. Currently the only supported optionis:

• INET SPIN TRACE

The TCP/IP trace sysout file is closed and deallocated. Anew one is then immediately allocated and opened.

START Starts a TCP/IP object. Currently the only supported optionis:

• INET START TRACE

A TCP/IP trace sysout file is allocated and opened. Beforethe TCP/IP trace file can be started, it must be set to a sysoutclass by the INET SET TRACE SYSOUT(class) command.

STOP Stops a TCP/IP object. Currently the only supported optionis:

• INET STOP TRACE

The TCP/IP trace file is closed and de-allocated.

Example 1 The following INET command is used to list INET options:

INET HELP

In the above example, all of the INET command parameters are displayed.

Continued on next page

Page 352: ESP 5.2 Command Reference

352

INET Command, Continued

Example 2 The following INET command is used to display TCP/IP sockets:

INET DISPLAY ACTIVE

In the above example, all active TCP/IP sockets are displayed.

Example 3 The following INET command is used to purge all TCP/IP sockets:

INET PURGE TASK 78E0

In the above example, all TCP/IP sockets running under task ID 78E0 are purged.

Examples ofHost CachingTTL

The following short form of the INET SET HOST_CACHE command activates ESPTCP/IP host caching and sets the time to live interval for each host cache entry toone hour:

INET T HC TTL(3600)

The following short form of the INET SET HOST_CACHE command deactivatesESP TCP/IP host caching:

INET T HC TTL(0)

Page 353: ESP 5.2 Command Reference

353

INFOCOMM Command

Overview The INFOCOMM command is used to control transaction servers used in sending

Infoserv requests. Transaction server identifiers are used on the INFOSERVcommand when issuing requests.

Type General command.

Authority OPER authority is required to issue the INFOCOMM command.

Syntax The syntax of the INFOCOMM command is:

INFOCOMM {DEFINE|DISPLAY|DELETE}[serverid][CLIENT(clientname)][TPAPPL(applname)]

Parameter Description

DEFINE Indicates a new server transaction be added. DISPLAY Indicates information on all (or specific) servers for the

current Application be displayed. Information displayedincludes serverid, client name and TP Application name.

DELETE Indicates the deletion of a transaction server. serverid Indicates a logical server identifier of up to 25 characters.

This identifier is specified on the INFOSERV command whensending a request.

clientname Indicates a client name of up to eight characters for yourApplication. This client must be defined to Infoserv via theCLIDEF command.

applname Indicates a 1-44 character TP Application name of theInfoserv task to which this transaction server will send itsrequests. The applname is defined in the Infoserv TPparameter data set.

Usage notes For each client defined to Infoserv you must define a transaction server that will

transmit requests to Infoserv via the LU6.2 Communications Facility (TP Server).

INFOCOMM definitions are normally stored in the ESP Initialization Parameterdata set.

Continued on next page

Page 354: ESP 5.2 Command Reference

354

INFOCOMM Command, Continued

Relatedinformation

For information on ESP Workload Manager’s interface to IBM’sInformation/Management product, see the Infoserv Installation and User’s Guide.

For information on generating a request that is sent to Infoserv, see the INFOSERVcommand.

For information on inter-system communication, see the TP Server Installation andUser’s Guide.

Example 1 The following INFOCOMM command defines a transaction server:

INFOCOMM DEFINE INFO1 CLIENT(ESP) TPAPPL(INFOSERV_MAIN)

In the above example, a new transaction server called INFO1 is defined. The clientname for this Application is ESP and must be defined to Infoserv using the CLIDEFcommand. The INFO1 transaction server will send requests to theINFOSERV_MAIN TP Application.

Example 2 The following INFOCOMM command is used to display transaction servers:

INFOCOMM DISPLAY

In the above example, all existing transaction servers are displayed.

Example 3 The following INFOCOMM command is used to delete a transaction server:

INFOCOMM DELETE INFO1

In the above example, a transaction server called INFO1 is deleted.

Page 355: ESP 5.2 Command Reference

355

INFOMSG Command

Overview The INFOMSG command is used to display informational, warning and error

messages in the body of the screen. Normally these messages are displayed in theupper right corner of the screen with an alarm sound.

Type General command

Syntax The syntax of the INFOMSG command is:

INFOMSG SET|RESET[PREFIX(‘string’)]

Parameter Description

SET Indicates messages should be displayed within the body of thescreen. This includes the full message text and ESP messagenumber.

PREFIX(‘string’) Indicates displayed messages should be prefixed with a userspecified string. PREFIX can be abbreviated to PR. Thisparameter is optional.

RESET Indicates messages should be returned to their normalposition in the upper right corner of the screen.

Usage notes The INFOMSG command is valid only from within Page mode.

If you exit from Page mode and re-enter, you need to re-issue the INFOMSGcommand.

When the INFOMSG command is set, messages are within the screen text.

You can have the messages prefixed with any string by specifying a string whenissuing the INFOMSG command.

Example 1 The following is an example of what an informational message looks like when the

INFOMSG command is not set: ESP -------------------------------- NO MATCHING APPLICATIONS COMMAND ===> ----------------------- TOP OF DATA --------------------------

LAP PAYROLL OLDEST

In the above example, a request is made to display the oldest generation of thePAYROLL Application. An informational message indicates there are no matchingApplications.

Continued on next page

Page 356: ESP 5.2 Command Reference

356

INFOMSG Command, Continued

Example 2 The following is an example of what an informational message looks like when the

INFOMSG command is set: ESP --------------------------------------- ROW 1 COLUMN 1 -- COMMAND ===> ----------------------- TOP OF DATA --------------------------

INFOMSG SETLAP PAYROLL OLDESTESP1142W NO MATCHING APPLICATIONS DEFINED OR AUTHORIZED

In the above example, a request is made to display the oldest generation of thePAYROLL Application. An informational message indicates there are no matchingApplications is displayed within the body of the screen.

Example 3 The following INFOMSG command resets informational messages:

INFOMSG RESET

In the above example, informational messages are displayed in the upper corner ofthe screen.

Example 4 The following INFOMSG command prefixes information messages:

INFOMSG SET PREFIX(INFO_)

In the above example, informational messages are prefixed with INFO_.

Page 357: ESP 5.2 Command Reference

357

INIT Command

Overview The INIT command is used to define and manipulate initiators in your model

process similar to the way you manipulate initiators using JES. The INIT commandis one of the components involved in defining your environment to producemodeling reports that forecast how ESP processes a group of jobs in your particularenvironment.

Type Model command.

Syntax The syntax of the INIT command is:

INIT {START(initnum)}{SET(initnum)}{STOP(initnum)}[CLASS(classname)][CPU(cpunumber)]

Parameter Description

START Indicates the initiator(s) in initnum is started on the specifiedCPU. If the initiator is currently in a “drained” state, itsstatus is changed to “inactive”. The INIT START commandis ignored if the initiator is not currently in a “drained” state.

SET Indicates the class(es) of the initiator(s) in initnum are reset tothe specified classname. Any classes previously assigned tothe initiator(s) are replaced. The CPU that an initiator hasbeen started on may not be altered with the SET keyword.

STOP Indicates the initiator(s) in initnum is stopped. Any jobsrunning in the specified initiator(s) is allowed to completeand the initiator status is changed to “drained”.

initnum Indicates a number, range of numbers, or list of numbers andranges of numbers. Each number must be within the range 1-999.

classname

Indicates up to eight character class names or list of classnames assigned to this initiator. The first character must bealphabetic.

cpunumber Indicates a CPU number where the initiators are to be started.The valid range is 0-7 (up to eight CPUs supported). If notspecified, the default is 0. The CPU keyword should only bespecified with the START keyword.

Continued on next page

Page 358: ESP 5.2 Command Reference

358

INIT Command, Continued

Usage notes Use the MAXINITS command to define the maximum number of initiators for the

model. This should include initiators across all CPUs. A maximum of 999 initiatorscan exist for each model.

Initially, the number of initiators you specify on the MAXINITS command are in adrained state. At any time during modeling, you can manipulate initiators on anyCPU.

Use INIT START, SET and STOP to start, alter and drain initiators any time duringthe model process.

Relatedinformation

For information on defining the maximum number of initiators, see the MAXINITScommand.

For information on how ESP processes workload in your environment, see the ESPWorkload Manager Advanced User’s Guide.

For information on beginning and ending the model process, see the MODEL andENDMODEL commands.

Example 1 The following INIT commands define initiators to be used during a model process:

MAXINITS 20INIT START(1:10) CLASS(A,B,C)INIT START(11:15) CLASS(D,E)INIT START(16:20) CLASS(F)

In the above example:

• Initiators 1 to 10 are started and set to classes A, B and C• Initiators 11 to 15 are started and set to class D and E• Initiators 16 to 20 are started and set to class F

Note: Any time during the model process you can manipulate initiators similar tothe way initiators are manipulated in your environment using the START, SET andSTOP parameters of the INIT command. For example, if required, initiators 16 to20 could be drained by issuing the following command:

INIT STOP(16:20)

Page 359: ESP 5.2 Command Reference

359

INPUT Command

Overview The INPUT command is used to request that ESP read in other records from a dataset other than an active history file. Use any VSAM, KSDS, ESDS or non-VSAMsequential data set as input. The data records must be of the exact same format as theESP history file records.

Type Reporting command.

Syntax The syntax of the INPUT command is:

INPUT {DATASET(dsname)}{FILE(filename)}

Parameter Descriptiondsname Indicates the name of the input data set. This is mutually

exclusive with the FILE option.filename Indicates the name of the input file name. This is mutually

exclusive with the DATASET option.

Usage notes This option is most useful when used with files created as a result of the COPYreporting command or when the ESP subsystem is down. The INPUT commanddoes not require the presence of the subsystem.

Specify any number of INPUT commands - they may be intermixed with HISTFILEstatements. The data sets are processed in the order of their respective INPUTstatements.

Relatedinformation

For information on history reporting, see the ESP Workload Manager User’s Guide.

Example 1 The following is an example of a history report definition:

REPORTINPUT DATASET(CYBER.ESP.HISTORY1)FROM 7AM YESTERDAYCRITERIA APPLSYS EQ PAYROLLDISPLAY JOBNAME JOBNO APPLSYS CMPCENDR

In the above example, the INPUT command is used to request that ESP read historyrecords from CYBER.ESP.HISTORY1 instead of the active history file.

Page 360: ESP 5.2 Command Reference

360

INPUTDS Statement

Overview The INPUTDS statement is used to extract tape volume serial information during ascheduled activity data set generation run. ESP references the tape managementcatalog when it generates the scheduled activity data set.

Type ESP Application statement.

Syntax The syntax of the INPUTDS statement is:

INPUTDS dsname(genno)

Parameter Descriptiondsname Indicates the name of tape input data set.genno Indicates a relative generation number. This must be zero or a

negative number.

Usage notes ESP can generate a data set using this extracted information and feed the data setinto the TMS or CA1 tape pull program.

To use the INPUTDS statement to generate a data set to use as input to the TMS orCA1 tape pull program, take the following steps:

1. Use the INPUTDS statement in the ESP Application, identifying the tape datasets associated with each job

2. Generate a scheduled activity using the SADGEN command in a batch job3. Use the LSAR subcommand specifying TAPEPULL(dsname), where dsname is

the pre–allocated PDS to store tape data set information4. Re–initialize the TAPEPULL data set before you generate the scheduled activity

data set5. Use this PDS as input to the TMS or CA1 tape pull program.

RelatedStatements

For information on extracting tape information, see the ESP Workload ManagerUser’s Guide.

Continued on next page

Page 361: ESP 5.2 Command Reference

361

INPUTDS Statement, Continued

Example 1 The following INPUTDS statements indicate the tape data sets associated with eachjob in an Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN DAILYRELEASE PAYJOB2INPUTDS PROD.PAY.ACCT(-1)

ENDJOBJOB PAYJOB2

RUN DAILYINPUTDS PROD.PAY.BACKUP(0)

ENDJOB

In the above example, two input data sets are identified as follows:

• For PAYJOB1, -1 generation of ‘PROD.PAY.ACCT’ is identified as it’s inputdata set

• For PAYJOB2, the current generation of ‘PROD.PAY.BACKUP’ is identifiedas it’s input data set.

Page 362: ESP 5.2 Command Reference

362

INTEGER Statement

Overview The INTEGER statement is used to define an integer variable before its first

assignment statement.

Type ESP Procedure statement, Symbolic variable library statement.

Syntax The syntax of the INTEGER statement is:

INTEGER varname[,varname...]

Parameter Description

varname Indicates the name of the variable to be defined. A list ofvariable names can be specified, separating each with acomma or space.

Usage notes Use integer symbols if you want to assign arithmetic values or expressions to them,

and manipulate them as numbers, such as A=2+2 and NUMBER=999. You mustfirst use an INTEGER statement to define an integer symbol before you can assign avalue to it.

An integer variable differs from a character variable in the way the value is stored.When you assign a string to an integer variable, the string must consist of a validarithmetic expression. The expression is evaluated and the result stored as a fullword binary number.

If you assign a character string to an integer variable, ESP evaluates the characterstring as if it were an arithmetic expression and then stores the result as an integer.

If you want an INTEGER variable to be available inside and outside an IF block,then declare it outside of the block.

An integer assigned a value within the scope of a JOB statement is available only forthat job in Application process mode. In Application generation mode, an integerhas the value assigned to it by the last executed assignment statement.

ESP’s built-in symbolic variables, ESPA and ESPS, are not available in Page mode,and can not be assigned to integer variables in Page mode.

Relatedinformation

For information on working with user defined symbolic variables, see the ESPWorkload Manager Advanced User’s Guide.

Continued on next page

Page 363: ESP 5.2 Command Reference

363

INTEGER Statement, Continued

Example 1 The following INTEGER statement defines an integer variable:

INTEGER XX=2

In the above example, variable X is defined as an integer variable and assigned thevalue of 2.

Example 2 The following INTEGER statement defines an integer variable:

INTEGER AA=5*25

In the above example, variable A is defined as an integer variable and assigned thevalue of 125.

Example 3 The following INTEGER statement defines an integer variable:

INTEGER BB=%ESPADOW#

In the above example, variable B is defined as an integer variable and assigned thevalue of the current day of the week number. If, for example, today is Thursday, Bis assigned a value of 5.

Example 4 The following INTEGER statement defines integer variables:

INTEGER C,DD=%ESPSDDDC=(%D-1)/7+1

In the above example, variables C and D are first defined as integer variables. D isassigned the current day of year number. C is then given a value that resolves to theweek of year number.

Note: %ESPSDDD represents a number but is stored in character format. In orderto work with this as a number, you must first assign it to an integer variable.

Continued on next page

Page 364: ESP 5.2 Command Reference

364

INTEGER Statement, Continued

Example 5 The following INTEGER statement defines a integer variables outside an IF block:

INTEGER E,FE=222F=444IF TODAY(‘MONDAY’) THEN PARM=%E

ELSE PARM=%F

In the above example, defining the integer outside the IF block, makes it availableinside and outside the block.

Page 365: ESP 5.2 Command Reference

365

INVOKE Command

Overview The INVOKE command is used to invoke an ESP Procedure. The INVOKE

command can be used as part of an Event definition, or from within an ESPProcedure to invoke another ESP Procedure.

Type Event definition command, ESP Procedure command.

Syntax The syntax of the INVOKE command is:

INVOKE ‘dataset(member)’

Parameter Description

dataset Indicates the name of the data set that contains the ESPProcedure. The data set and member must be enclosed inquotes.

member Indicates the name of the member that contains the ESPProcedure you want invoked.

Usage notes To invoke an ESP Procedure from an Event, you must first create the Procedure and

then define the Event to invoke that Procedure.

ESP allows multiple INVOKE commands within an Event or ESP Procedure.However, an Event can only generate one Application. To invoke more than oneApplication requires one Event per Application.

Relatedinformation

For information on invoking an ESP Procedure from an Event, see the ESPWorkload Manager User’s Guide.

For information on invoking an ESP Procedure from another ESP Procedure, see theESP Workload Manager User’s Guide.

Example 1 The following is an example of an Event definition that invokes an ESP Procedure:

EVENT ID(CYBER.PAYROLL)SCHEDULE 10PM WEEKDAYSINVOKE ‘CYBER.PROCS.CNTL(PAYJOBS)’ENDDEF

In the above example, the PAYJOBS ESP Procedure is invoked every weekday at 10pm.

Continued on next page

Page 366: ESP 5.2 Command Reference

366

INVOKE Command, Continued

Example 2 The following is an example of an ESP Procedure that invokes another ESP

Procedure:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’INVOKE ‘CYBER.SYMBOLS.CNTL(DATES)’JOB PAYJOB1

RUN WORKDAYSREL PAYJOB2

JOB PAYJOB2RUN WORKDAYS

ENDJOB

In the above example, every time the PAYROLL Application is invoked, theDATES ESP Procedure is also invoked. The DATES ESP Procedure contains built-in or user defined symbolic variables required by the jobs in the PAYROLLApplication.

Page 367: ESP 5.2 Command Reference

367

JCLLIB Statement

Overview The JCLLIB statement is used to identify the JCL library you want to use for all jobs

following this statement. When ESP encounters a JOB statement, it uses the JCLmember in the JCLLIB with the same name as the job. You can use the MEMBERstatement to override this action.

Type ESP Application statement.

Syntax The syntax of the JCLLIB statement is:

JCLLIB 'dsname'

Parameter Description

dsname Indicates the name of the data set where the JCL resides. Thedata set name must be enclosed in quotes.

Usage notes This statement can be used to specify the JCL library you want to use throughout the

ESP Application unless it is explicitly overridden for a particular job with theDATASET statement. This means that you only have to specify the JCL libraryonce for each Application. Unless the member name is explicitly overridden withthe MEMBER statement, the member name is assumed to be the same as thejobname.

Relatedinformation

For information on identifying JCL libraries, see the ESP Workload Manager User’sGuide.

For information on specifying a temporary or override JCL library, see theTEMPLIB statement.

For information on specifying an optional JCL library for an individual job, see theDATASET statement.

For information on specifying the member name in which ESP finds a job’sexecution JCL, see the MEMBER statement.

Continued on next page

Page 368: ESP 5.2 Command Reference

368

JCLLIB Statement, Continued

Example 1 The following JCLLIB statement identifies the JCL library to be used:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN DAILYREL PAYJOB2

JOB PAYJOB2RUN DAILY

ENDJOB

In the above example, ESP submits all jobs in the PAYROLL Application fromCYBER.JCL.CNTL.

Example 2 The following JCLLIB, MEMBER and DATASET statements specify different JCL

libraries and members:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB3

RUN DAILYREL PAYJOB4MEMBER PAYJOB99

JOB PAYJOB4RUN DAILYDATASET ‘CYBER.ALTJCL.CNTL’

ENDJOB

In the above example:

• ESP uses the default JCL library CYBER .JCL.CNTL to submit PAYJOB3’sexecution JCL from member PAYJOB99

• ESP uses CYBER.ALTJCL.CNTL to submit PAYJOB4’s execution JCL.

Example 3 The following JCLLIB statement specifies the PANVALET library to be used:

‘PROD.ESP.JOBS’ as the default JCL library.

APPL PAYROLLJCLLIB PAN-PROD.ESP.JOBSJOB PAYJOB1

RUN DAILYREL PAYJOB2

JOB PAYJOB2RUN DAILY

ENDJOB

In the above example, ESP will submit all jobs in the PAYROLL Application from aPANVALET library called PROD.ESP.JOBS.

Continued on next page

Page 369: ESP 5.2 Command Reference

369

JCLLIB Statement, Continued

Example 4 The following JCLLIB statements identify different JCL libraries for job in an

Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.LIB1’JOB PAYJOB1

RUN DAILYENDJOBJOB PAYJOB2

RUN DAILYENDJOBJCLLIB ‘CYBER.JCL.LIB2’JOB PAYJOB3

RUN DAILYENDJOB

In the above example, ESP submits PAYJOB1 and PAYJOB2 fromCYBER.JCL.LIB1. ESP submits PAYJOB3 from CYBER.JCL.LIB2.

Page 370: ESP 5.2 Command Reference

370

JESCOMCH Command

Overview The JESCOMCH command is used to specify the character used to prefix JES

commands. Normally this is specified as an Initialization Parameter.

Type General command.

Authority OPER authority is required to issue the JESCOMCH command.

Syntax The syntax of the JESCOMCH command is:

JESCOMCH character

Parameter Description

character Indicates the character used as a JES command prefix. If apunctuation character (such as a semi-colon) is used, it mustbe enclosed in quotes. The default character is $.

Usage notes Use this command if your installation uses a character other than the dollar ($)

symbol to prefix JES commands. Use single quotes to enclose the chosen prefix if itis a punctuation character.

Relatedinformation

For information on specifying a character used to prefix JES commands at theinitialization parameter level, see the ESP Workload Manager Installation Guide.

Example 1 The following JESCOMCH command specifies a character used to prefix JES

commands:

JESCOMCH ‘#’

In the above example, the number sign (#) is used to prefix JES commands.

Page 371: ESP 5.2 Command Reference

371

JESTYPE Command

Overview The JESTYPE command is used to specify the type of JES used by your installation.

Normally this is specified as an Initialization Parameter.

Type General command.

Authority OPER authority is required to issue the JESTYPE command.

Syntax The syntax of the JESTYPE command is:

JESTYPE [2|3][DJC|NODJC]

Parameter Description

2 Indicates JES2 is in use. This is the default. 3 Indicates JES3 is in use. DJC Indicates normal processing for DJC networks. NODJC Indicates existing DJC networks should be processed as

Applications.

Usage notes This command enables ESP to detect differences in processing requirements for the

JES3 subsystems compared with JES2. You may use the NODJC parameter to haveexisting DJC networks converted to Applications without the need to modifyindividual ESP Procedures.

Relatedinformation

For information on specifying the type of JES used by your installation at theInitialization Parameter level, see the ESP Workload Manager Installation Guide.

Example 1 The following JESTYPE command specifies the type of JES in use:

JESTYPE 3

In the above example, JES3 is the subsystem in use.

Page 372: ESP 5.2 Command Reference

372

JOB Statement

Overview The JOB statement is used to identify the name of a job in an Application. The JOB

statement must be used before identifying other job requirements such aspredecessor and successor relationships and run frequencies.

Type ESP Application statement.

Syntax The syntax of the JOB statement is:

JOB jobname[.qualifier][REQUEST|NOREQUEST][TASK [OWNER(Applowner|manager)]|NOTASK][LINK [PROCESS|NOPROCESS] [OWNER(Applowner|manager)]|NOLINK]][MANUAL|NOMANUAL[SCOPE(hh.mm,hh.mm)]

[AUTHSTR(string)]][NODE|NONODE][INHERIT|NOINHERIT][EXTERNAL|NOEXTERNAL[SCOPE(hh.mm,hh.mm)]

[AUTHSTR(string)][APPLID(applname)][SCHEDULED(‘criteria’)]]

[CONDITIONAL|NOCONDITIONAL][HOLD|NOHOLD][CRITICAL|NOTCRITICAL][DOCMEM(docmember)]

Parameter Description

jobname Indicates a jobname of up to eight characters. qualifier Indicates a job qualifier of up to eight characters. It must

immediately follow the jobname separated by a period. REQUEST Indicates this is an on-request job. NOREQUEST Indicates this is not an on-request job. This is the default. TASK Indicates this is a task that requires manual completion.

ESP does not try to submit JCL for a TASK. NOTASK Indicates this is not a task that requires manual completion.

This is the default. OWNER Indicates the name of the owning ESP Manager for Links

and Tasks. Specify a valid Manager name, up to 16alphanumeric characters in length, where the first charactermust be alpha or a national character. If you do not specifyOWNER, the owning Manager of the Application is thedefault. The owning Manager is the only one with authorityto update the status of a workload object.

LINK Indicates this is a task that does not require manualcompletion. ESP does not try to submit JCL for a LINK.

NOLINK Indicates this is a task that does require manual completion.This is the default.

PROCESS Indicates you want to use a LINK to issue commands.

Continued on next page

Page 373: ESP 5.2 Command Reference

373

JOB Statement, Continued

NOPROCESS Indicates you do not want to use a LINK to issuecommands. This is the default.

MANUAL Indicates this job is manually submitted, outside of ESP. NOMANUAL Indicates this job is not being submitted, outside of ESP.

This is the default. string Indicates an authorization string as defined by the

AUTHSTR Initialization Parameter. This can only be usedwith the EXTERNAL and MANUAL keywords.

NODE Indicates a job is a node for inheriting job relationships. Norelationships pass through a node. A relationship between apredecessor and a successor to the node exists only whenESP selects the node. Inherited relationships among thenode and its successors still exist.

NONODE Indicates a job is not a node for inheriting job relationships.This is the default.

INHERIT This is the default. NOINHERIT Indicates job relationships should not be inherited. EXTERNAL Indicates a job is submitted by another ESP Application.

The EXTERNAL parameter is used to build inter-Application dependencies.

NOEXTERNAL Indicates a job is not submitted by another ESPApplication. This is the default.

hh:mm Indicates the number of hours ESP is to do a backwardand/or forward search in the scheduled activity data set fora job. The first parameter indicates how far back theApplication manager should look; the second parameterindicates how far ahead it should look. This parameter canbe a maximum of 12 characters. SCOPE can be used withthe EXTERNAL and MANUAL keywords for jobs in anApplication.

applname Indicates the name of the Application that submits the job. criteria Indicates a scheduled time or range for the scheduled time

of the Event that submits the job or the trigger time issuedfor non-scheduled Events.

CONDITIONAL Indicates this job may or may not execute. The Applicationthis job belongs to is considered complete when allNOCONDITIONAL jobs are complete.

NOCONDITIONAL Indicates this job must complete in order for theApplication to be considered complete. This is the default.

HOLD Indicates a job is to be placed on manual hold when ESPgenerates the Application. You can release a job frommanual hold using the CSF or the APPLJOB (AJ)command.

NOHOLD Indicates a job is not to be placed on manual hold whenESP generates the Application. This is the default.

Continued on next page

Page 374: ESP 5.2 Command Reference

374

JOB Statement, Continued

CRITICAL Indicates this job represents a critical point in theApplication. The longest path to this job, in terms ofexecution time (based on history) is identified as the criticalpath.

NOTCRITICAL Indicates this job does not represent a critical point in theApplication. This is the default.

docmember Indicates a job documentation member with a name otherthan the jobname should be referenced. The default is toreference a member name the same as the jobname.

Usage notes The JOB statement defines the beginning of a job definition. The ENDJOB

statement or another JOB statement signifies the end of a job definition. You mustuse an ENDJOB statement after defining all of your jobs.

ESP processes commands based on where they are placed within an Application asfollows:

• ESP processes commands outside the scope of JOB statements when theApplication is generated and every time a job becomes eligible (i.e., alldependencies met)

• ESP processes commands within the scope of a JOB statement only when thejob becomes eligible (i.e., all dependencies met).

Statements placed within the scope of the job are referred to as job specificstatements, whereas statements placed outside the scope of a job statement arereferred to as global statements.

You can define jobs in any order. ESP submits the jobs based on how you define thejob relationships.

By default, the member name of the JCL library used is the same as the jobname. Tooverride this, use the MEMBER statement and specify the name of the member thatcontains the JCL for the job. The jobname must match the name specified on the jobcard.

A NOINHERIT job that is not selected blocks any dependency chain passingthrough it. Thus, any job released either directly or indirectly by such a job isindependent of any ancestor(s) of the blocking job.

A NOINHERIT job that is selected does not allow a dependency chain to emanatefrom it. In other words, such a job releases any selected immediate successor(s), butdoes not pursue dependency chains through any unselected successor(s).

If you want to use Links and Tasks when the mainframe is unavailable, specify aDistributed Manager as the OWNER of the Link or Task using the OWNERparameter on the JOB or APPL statements.

Continued on next page

Page 375: ESP 5.2 Command Reference

375

JOB Statement, Continued

Relatedinformation

For information on ending a job definition, see the ENDJOB statement.

For information on Applications, see the ESP Workload Manager User’s Guide.

Example 1 The following is an example of an ESP Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN DAILYENDJOB

In the above example, the JOB statement is used to identify PAYJOB1 as part of thePAYROLL Application.

Example 2 The following is an example of an ESP Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN DAILYREL PAYJOB2

JOB PAYJOB2 REQUESTRUN DAILY

ENDJOB

In the above example, PAYJOB2 is defined as an on-request job.

Example 3 The following is an example of an ESP Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB BALANCE.RPT TASK

RUN DAILYENDJOB

In the above example, BALANCE.RPT represents a manual task and must bemarked complete.

Continued on next page

Page 376: ESP 5.2 Command Reference

376

JOB Statement, Continued

Example 4 The following is an example of an ESP Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB3 EXTERNAL

RUN DAILYREL PAYJOB4

JOB PAYJOB4.%ESPSDAY(1:3)DUEOUT EXEC 9PMRUN DAILY

ENDJOB

In the above example:

• PAYJOB3 is defined as submitted by another ESP Application. TheEXTERNAL parameter is used to build a dependency between jobs fromdifferent Applications

• PAYJOB4 is a qualified job. The sub-string of an ESP built-in symbolicvariable is used to comprise the jobname. For example, if this Application wasscheduled on Wednesday, PAYJOB4’s jobname resolves to PAYJOB4.WED. IfPAYJOB4 is not completed by 9 pm, it is flagged as overdue.

Example 5 The following is an example of an ESP Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB5

RUN DAILYREL (PAYJOB6(A))

JOB PAYJOB6 CONDITIONALRUN DAILY

ENDJOB

In the above example, PAYJOB6 is defined as a conditional job that is submittedonly if PAYJOB5 terminates abnormally.

Continued on next page

Page 377: ESP 5.2 Command Reference

377

JOB Statement, Continued

Example 6 The following is an example of an ESP Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB7 EXTERNAL SCHEDULED(‘YESTERDAY’)

RUN LAST WORKDAY OF MONTHREL PAYJOB8

JOB PAYJOB8RUN LAST WORKDAY OF MONTH

ENDJOB

In the above example, PAYJOB7 is submitted by another ESP Application. On thelast workday of the month, ESP ensures PAYJOB7 from the previous daycompleted. PAYJOB8 waits until this dependency is met. The RUN statement forPAYJOB7 reflects the day on which you want ESP to check if the dependency issatisfied.

Example 7 The following is an example of an ESP Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’CRITPATH ONJOB PAYJOB1

RUN DAILYREL (PAYJOB2,PAYJOB3)

JOB PAYJOB2RUN DAILYREL PAYJOB4

JOB PAYJOB3RUN DAILYREL PAYJOB4

JOB PAYJOB4 CRITICALRUN DAILY

ENDJOB

In the above example, PAYJOB4 is identified as the critical point in the PAYROLLApplication. ESP calculates the longest path to this job based on historicalexecution times and identifies this path as the critical path.

Example 8 The following example defines a Distributed Manager as the owning Manager ofthis Link:JOB A LINK OWNER(DMCHI)

Continued on next page

Page 378: ESP 5.2 Command Reference

378

JOB Statement, Continued

Other examples Here are more examples of using the JOB statement.

Indicates that a message is sent when critical jobs within the Application havecompleted successfully:

JOB CRITICAL.POINT LINK PROCESSAFTER (PAYJOB1,PAYJOB2,PAYJOB3)RUN DAILYSEND ‘CRITICAL JOBS COMPLETED AT %ESPATIME’ USER(CYB01)

ENDJOB

Indicates a manually submitted job. ESP looks back 24 hours to see if the job hascompleted successfully. If it has not, ESP waits until it does:

JOB PAYJOB1 MANUAL SCOPE(-24)RUN DAILYREL PAYJOB2

ENDJOB

Indicates this job is submitted as part of the BILLING Application. ESP postsPAYJOB1 complete, when today’s scheduled run of PAYJOB1 completessuccessfully in the BILLING Application. If PAYJOB1 has already completedsuccessfully when this Application is generated, ESP marks PAYJOB1 complete atgeneration time:

JOB PAYJOB1 EXTERNAL SCHEDULED(‘TODAY’) APPLID(PAYROLL)RUN DAILYREL PAYJOB2

ENDJOB

Indicates you wish to reference a job documentation member with a name other thanthe jobname:

JOB PAYJOB1 DOCMEM(SPECIAL)RUN DAILY

ENDJOB

Page 379: ESP 5.2 Command Reference

379

JOBATTR Statement

Overview The JOBATTR statement is used to change a job’s attributes within the scope of a

JOB statement or in job documentation.

Type ESP Application statement.

Syntax The syntax of the JOBATTR statement is:

JOBATTR [EXTERNAL|NOEXTERNAL][MANUAL|NOMANUAL][LINK|NOLINK][TASK|NOTASK][REQUEST|NOREQUEST][PROCESS|NOPROCESS][CONDITIONAL|NOCONDITIONAL][HOLD|NOHOLD][INHERIT|NOINHERIT][NODE|NONODE][SCHEDULED(‘criteria’)][SCOPE(hh.mm,hh.mm)][AUTHSTR(authstring)][APPLID(applname)]

Parameter Description

attributes Indicates the attributes of the job you want to change. Youcan specify more than one attribute by separating them with acomma or space. The attributes are listed above. For moreinformation on the job attributes listed above see the JOBstatement.

Usage notes You may want to define a job with different attributes in special situations. For

example, on a particular day you may want to define a job on hold, whereas on otherdays you do not want the job defined on hold. Instead of defining the job multipletimes with job qualifiers or using IF logic around a JOB statement, you can use theJOBATTR statement.

Using JOBATTR statements in conjunction with IF logic, allows jobs to havecumulative job attributes. For example, if a job is a conditional job on Mondays,and a request job on the first workday of the month, combining JOBATTRstatements with IF logic provides for a cumulative effect when Monday is also thefirst workday of the month; i.e. the job is a conditional request job.

Continued on next page

Page 380: ESP 5.2 Command Reference

380

JOBATTR Statement, Continued

Relatedinformation

For information on identifying the names of jobs in an Application, see the JOBstatement.

For information on Applications, see the ESP Workload Manager User’s Guide.

Example 1 The following JOBATTR statement changes a job’s attributes:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

IF TODAY(‘MONDAY’) THEN JOBATTR HOLDRUN DAILY

ENDJOB

In the above example, PAYJOB1’s attributes are changed to define the job on holdevery Monday.

Example 2 The following JOBATTR statement changes a job’s attributes:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB2

IF TODAY(‘FRIDAY’) THEN JOBATTR HOLDIF TODAY(‘LAST WORKDAY OF MONTH’) THEN JOBATTR REQUESTRUN DAILY

ENDJOB

In the above example:

• PAYJOB2 runs daily• On Fridays, PAYJOB2 has an attribute of HOLD• On the last workday of the month, PAYJOB2 has an attribute of REQUEST.• When the last workday of the month is a Friday, PAYJOB2 has attributes of

HOLD and REQUEST.

Continued on next page

Page 381: ESP 5.2 Command Reference

381

JOBATTR Statement, Continued

Example 3 The following JOBATTR statement changes a job’s attributes:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB3

IF TODAY(‘SUNDAY’) THEN +JOBATTR EXTERNAL SCHEDULED(‘YESTERDAY’)RUN SATURDAY SUNDAYREL PAYJOB4

JOB PAYJOB4RUN SUNDAY

ENDJOB

In the above example, PAYJOB3 uses the JOBATTR statement to define the job asan External job on Sundays. On Sunday, ESP looks back to the previous day(YESTERDAY) to see if PAYJOB3 completed successfully. If it has, PAYJOB3 ismarked complete when the Application is built, otherwise it waits for PAYJOB3 tocomplete.

Example 4 The following JOBATTR statements changes a job’s attributes:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1 CRITICAL

RUN WORKDAYSIF TODAY(‘LAST WORKDAY OF MONTH’) THEN JOBATTR NOTCRITICAL

ENDJOB

In the above example, PAYJOB1’s attributes are changed on the last workday of themonth such that critical path analysis is performed every day except the lastworkday of the month.

Page 382: ESP 5.2 Command Reference

382

JOBINFO Command

Overview The JOBINFO command is used to display job documentation. You can display all

information for a job or display selected information as identified by fields andlabels.

Type General command.

Authority OPER authority is required to issue the JOBINFO command.

Syntax The syntax of the JOBINFO command is:

{JOBINFO|JI} {jobname}{jobid }[ABENDS[(abid[,abid]...)]][AFTER][CCFAIL][COREQ][DATASET][DJCDATA][DUEOUT][FUNCTION][HISTFILE][INPUTDS][MEMBER][MESSAGES[(msgid[,msgid]...)]][MODEL][OPERDATA][PNODES][POSTREQ][PREREQ][PROGRAMMER][RELEASE][FIELD(field[,field...])][ALL]

Parameter Description

jobname Indicates the name of the job for which you want to displayinformation (i.e. PDS member name).

jobid Indicates the JES jobid of the job for which you want todisplay information.

abid Displays information concerning the specified ABENDcode(s). If ABENDS is specified without Parameters, allpossible ABEND codes for the job are displayed.

AFTER Displays names of jobs that are predecessors to this job, andrelease this job for processing.

CCFAIL Displays condition codes that should cause a job to fail. COREQ Displays names of other jobs that are automatically selected

and can run concurrently with this job.

Continued on next page

Page 383: ESP 5.2 Command Reference

383

JOBINFO Command, Continued

Syntax (continued)

Parameter Description DATASET Displays the JCL library used for the job. DJCDATA Displays ESP/DJC net control statements for this job. DUEOUT Displays due out times from P-Nodes. FUNCTION Indicates the function of the job. HISTFILE Displays the name of the history-recording file for the job. INPUTDS Displays the tape data sets required for the job. MEMBER Indicates the member name in which ESP finds the job’s

execution JCL. The default is member name equal tojobname.

msgid Displays information concerning all specified message ID(s).If MESSAGES is specified without parameters, all possiblemessages for the job are displayed.

MODEL Displays the name of the tracking model for the job. OPERDATA Displays a string of operator data (e.g. a title). PNODES Displays names of the P-Nodes specified for the job. POSTREQ Displays the names of jobs that are automatically selected and

executed following execution of this job. PREREQ Displays the names of jobs that are automatically selected and

executed before execution of this job. PROGRAMMER Displays the programmer name. RELEASE Displays the names of jobs that are successors to this job, and

which this job releases for processing. field Displays information contained in user-defined fields. Up to

50 fields can be requested separated by a comma. ALL Displays all job documentation information for this job. This

is the default.

Continued on next page

Page 384: ESP 5.2 Command Reference

384

JOBINFO Command, Continued

Usage notes Use the JOBINFO command at any time to display job information in any amount ofdetail. You can request a display of one field only, such as FUNCTION, or anycombination of available keywords. Separate fields with a comma or a space. Youmust specify the word FIELD for retrieving user-defined fields.

The information displayed comes directly from the job documentation library. Ifany overrides were specified, for example in an ESP Procedure, this is not reflectedin the display that is generated.

Although you can specify multiple fields, ESP can only display data on a particularfield if you have coded it in your job documentation member.

If no optional fields are specified, all job documentation information on the job isdisplayed. There are two versions of the command.

• If JOBINFO is specified from a system console or from ESP’s line or Pagemode preceded by OPER, information is retrieved from the JOBDOC librariesidentified in the started task Procedure.

• If JOBINFO is specified from a TSO terminal without being preceded withOPER, the JOBDOC libraries allocated in your LOGON Procedure or CLISTare used.

Using the CSF to retrieve job documentation information (BD or ED), you cannotselect individual fields, as with the JOBINFO command.

The following table summarizes where and how you can retrieve job documentationinformation:

Origin Command Retrieved from

Consolidated Status Facility BD or ED Library specified in the ESPApplication.

Page mode or line mode JOBINFO DOCLIB in ESP Applicationor JOBDOC DD allocated toyour TSO session

Page mode or line mode OPER JOBINFO JOBDOC DD allocated to theESP started task.

Operator console F ESP,JOBINFO JOBDOC DD allocated to theESP started task.

Relatedinformation

For information on job documentation, see the ESP Workload Manager User’sGuide.

For information on specifying a job documentation library in an ESP Application,see the DOCLIB statement.

Continued on next page

Page 385: ESP 5.2 Command Reference

385

JOBINFO Command, Continued

Example 1 The following JOBINFO command displays all job documentation information:

JOBINFO PAYJOB1

In the above example, all job documentation information for PAYJOB1 is displayed.

Example 2 The following JOBINFO command displays job documentation information:

JOBINFO PAYJOB2 FUNCTION DUEOUT ABENDS(SB37)

In the above example, information on the function, due out time and the specificABEND (SB37) information for job PAYJOB2 is displayed.

Example 3 The following JOBINFO command displays job documentation information:

JOBINFO PAYJOB3 FIELD(PAGER)

In the above example, information about a user defined field is requested.

Example 4 The following JOBINFO command displays job documentation information:

JI PAYJOB4 MESSAGES(Z001,X446) FIELD(SEVERITY,PAGER)

In the above example, information about for PAYJOB4 on two specific messagesand two user-defined fields is requested.

Page 386: ESP 5.2 Command Reference

386

JOBMAP Command

Overview The JOBMAP command is used in conjunction with the MAPGEN command to

produce a list containing detailed information about jobs in Applications, includingtheir relationships to one another.

Type Reporting command.

Syntax The syntax of the JOBMAP command is:

JOBMAP DSN(dsname)[APPL(appl_id)][JOBINDEX][APPLINDEX][RESINDEX][NODISPLAY(list)]

Parameter Description

DSN(dsname) Indicates the name of the map data set created by theMAPGEN command.

APPL(appl_id) Indicates the name of the Application for which theinformation is to be produced. If this parameter is omitted,jobs from all Applications are selected.

JOBINDEX Produces an index of jobs after the job information pages. APPLINDEX Produces an index of Application after the job information

pages. RESINDEX Produces an index of resources after the job information

pages. NODISPLAY(list) Indicates certain information is to be suppressed on the

output. This is a list of values. The possible values and thedata suppressed are listed below.

Continued on next page

Page 387: ESP 5.2 Command Reference

387

JOBMAP Command, Continued

Suppressedfields

The NODISPLAY parameter lists fields that are not to be displayed, as follows:

Value Information Suppressed

EVENT Event name CALENDAR Calendar name(s) JCLDS JCL data set and member name SCOPE Scope (externals and manuals only) CLASS Job class PGMER Programmer name TAPES Tape drives and mounts (both cartridge and reel) ELAPSED Elapsed execution time CPU CPU time HOLDCOUNT Hold count PRED List of predecessor jobs SUCC List of successor jobs RESOURCE List of resources PROC ESP Procedure data set and member name TAG Tag

Continued on next page

Page 388: ESP 5.2 Command Reference

388

JOBMAP Command, Continued

Usage notes Since the JOBMAP command uses the job mapping data set as input, you can report

only on jobs contained in that data set.

Special index pages to the primary report are produced only if the JOBINDEX,APPLINDEX or RESINDEX parameters are specified on the JOBMAP command.

The job information pages contain the following for each job in the schedule:

• Job name• Application name• Job type (job, request, manual, external, etc.)• Scheduled time• Event name• Calendar name(s)• JCL data set and member name• Indication if the JCL data set is a JCLLIB or TEMPLIB• Scope (externals and manuals only)• Job class• Programmer name• Tape drives and mounts (both cartridge and reel)• Elapsed execution time• CPU time• Hold count• List of predecessor jobs• List of successor jobs• List of resources• ESP Procedure data set and member name• Tag.

Relatedinformation

For information on creating a job mapping data set, see the MAPGEN command.

For information on producing a job descendent tree report, see the JOBTREEcommand.

Continued on next page

Page 389: ESP 5.2 Command Reference

389

JOBMAP Command, Continued

Example 1 The following JOBMAP command produces a job map report:

JOBMAP DSN(‘CYBER.MAPGEN’)

In the above example, a job map report is produced and information is obtained fromthe CYBER.MAPGEN job mapping data set.

The following is a sample of the information produced by the above JOBMAPcommand:

JOB NAME APPL NAME TYPE SCHEDULING-------- --------- ---- -------------PAYJOB1 APPL1 JOB SCHEDULED: DAILY

QUALIFIER:EVENT: CYBER.PAYROLLCALENDAR(S): SYSTEMJCL: CYBER.JCL(PAYJOB1)SCOPE:CLASS:PROGRAMMER: FREDTAPES: REEL DRIVES: 0

REEL MOUNTS: 0CART DRIVES: 0CART MOUNTS: 0

ELAPSED: 0H 0M 0S

Example 2 The following JOBMAP command produces a job map report and suppresses certain

information:

JOBMAP DSN(‘CYBER.MAPGEN’) NODISPLAY(ELAPSED,TAPES,CPU)

In the above example, a job map report is produced. Run time information, tape dataand CPU time information are suppressed. Information for this job map is obtainedfrom the CYBER.MAPGEN job mapping data set.

Continued on next page

Page 390: ESP 5.2 Command Reference

390

JOBMAP Command, Continued

Example 3 The following JOBMAP command produces job map, job index and Application

index reports:

JOBMAP DSN(‘CYBER.MAPGEN’) APPL(PAYROLL) JOBINDEX APPLINDEX

In the above example, a job map, job index and Application index reports areproduced for the PAYROLL Application. Information is obtained from theCYBER.MAPGEN job mapping data set.

The following is a sample of the job index page produced by the above JOBMAPcommand:

JOB INDEX PAGE

JOB NAME APPL NAME PAGE-------- --------- ----PAYJOB1 PAYROLL 1PAYJOB2 PAYROLL 2PAYJOB3 PAYROLL 2

END OF LIST

The following is a sample of the Application index page produced by the aboveJOBMAP command:

APPLICATION INDEX PAGE

APPL NAME JOB NAME PAGE--------- -------- ----PAYROLL PAYJOB1 1

PAYJOB2 2PAYJOB3 2

END OF LIST

Page 391: ESP 5.2 Command Reference

391

JOBRES Command

Overview The JOBRES command is used to add new resource requirements for a job andchange existing resource requirements for a job. This is done after the Applicationhas been generated, but before the workload object is readied. If the workload objectis already waiting for resources (RESWAIT state), it is too late.

Type General command.

Syntax The syntax of the JOBRES command is:

JOBRES JOB(name.qual) APPLICATION(name.gen)RESOURCE(n1,res1,n2,res2,…)

Parameter Descriptionname Indicates the name of the job that requires resource

modifications.name.gen Indicates the name and generation number of the Application

in which the job resides.n1,res1 Used to specify the quantity and resource name that will be

set.

Usage notes JOBRES does not add or subtract from the original resource quantity specified, itstrictly sets the new quantity.

You can drop a resource requirement by specifying (0,resname).

Resources not specified in the JOBRES command remain unchanged.

Example The following example shows the full statement syntax:

JOBRES JOB(myjob.q1) APPLICATION(cyber.22) -RESOURCE(1,db2tab1,3,t3480)

Page 392: ESP 5.2 Command Reference

392

JOBTREE Command

Overview The JOBTREE command is used in conjunction with the MAPGEN command toproduce a job descendent tree from the job mapping data set.

Type Reporting command.

Syntax The syntax of the JOBTREE command is:

JOBTREE DSN(dsname)JOB(job_id)[APPL(appl_id)]

Parameter Description

DSN(dsname) Indicates a fully qualified data set name of the map data setcreated by the MAPGEN command.

JOB(job_id) Indicates the name of the job for which the information isproduced.

APPL(appl_id) Indicates the name of the Application for which theinformation is to be produced. If this parameter is omitted,jobs from all Applications are examined for a match. If thejob is in more than one Application, ESP uses the firstinstance it finds.

Usage notes Since the JOBTREE command uses the job mapping data set as input, you can only

report on jobs contained in that data set.

Relatedinformation

For information on creating a job mapping data, set see the MAPGEN command.

For information on producing a job map report, see the JOBMAP command.

Continued on next page

Page 393: ESP 5.2 Command Reference

393

JOBTREE Command, Continued

Example 1 The following JOBTREE command produces a job descendent tree report:

JOBTREE DSN(‘CYBER.MAPGEN’) JOB(PAYJOB1) APPL(PAYROLL)

In the above example, a job map for PAYJOB1 in the PAYROLL Application isproduced, the information is obtained from the CYBER.MAPGEN job mapping dataset.

The following provides a sample of the information produced by the aboveJOBTREE command:

JOB DESCENDENT TREEPAYJOB1 PAYROLL

PAYJOB2 PAYROLLPAYJOB3 PAYROLL

In the above example, PAYJOB1 releases PAYJOB2 and PAYJOB3.

Example 2 The following JOBTREE command produces a job descendent tree report:

JOBTREE DSN(‘CYBER.MAPGEN’) JOB(PAYJOB.RUN1) APPL(PAYROLL)

In the above example, a job map for PAYJOB.RUN1 in the PAYROLL Applicationis produced, the information is obtained from the CYBER.MAPGEN job mappingdata set.

Example 3 The following JOBTREE command produces a job descendent tree report:

JOBTREE DSN(‘CYBER.MAPGEN’) JOB(PAYJOB2)

In the above example, a job map for PAYJOB2 is produced, information is obtainedfrom the CYBER.MAPGEN job mapping data set.

Example 4 The following JOBTREE command produces a job descendent tree report:

JOBTREE DSN(‘CYBER.MAPGEN’) JOB(PAYJOB3) APPL(PAYROLL)JOBTREE DSN(‘CYBER.MAPGEN’) JOB(PAYJOB3) APPL(BILLING)

In the above example, a job map for PAYJOB3 in the PAYROLL and BILLINGApplications is produced, the information is obtained from the CYBER.MAPGENjob mapping data set.

Page 394: ESP 5.2 Command Reference

394

JTPEXCL Command

Overview The JTPEXCL command is used to provide a means to exclude a named program

from affecting the job tracking completion status of the job. Normally thiscommand is coded, with the ADD option, as an ESP Initialization Parameter.

Type General command

Authority OPER authority is required to issue the JTPEXCL command.

Syntax The syntax of the JTPEXCL command is:

JTPEXCL [pgmname](pgmname[,pgmname]...)][ADD|DELETE]

Parameter Description

pgmname Indicates a valid program name. ADD Indicates new information is to be added to the

specification for program exclusion. This is the default. DELETE Delete excluded programs from a previous JTPEXCL

definition.

Usage notes Sometimes the last step in a job executes regardless (i.e. COND=EVEN) of the

execution of other steps in the job. This step normally performs some cleanupactivity. The JTPEXCL command allows you to exclude the name of the programthis last step executes from affecting the job tracking completion status of the job.

Use the JTPEXCL command with no parameters to display the programs excludedfrom job tracking status.

Relatedinformation

For information on excluding programs from affecting job completion status at theInitialization Parameter level, see the JTPEXCL command in the ESP WorkloadManager Installation Guide.

Example 1 The following JTPEXCL command displays excluded programs:

JTPEXCL

In the above example, all excluded programs are displayed.

Continued on next page

Page 395: ESP 5.2 Command Reference

395

JTPEXCL Command, Continued

Example 2 The following JTPEXCL command excludes a program from job tracking status:

JTPEXCL CLEANUP

In the above example, CLEANUP is excluded from affecting the job trackingcompletion status of the job.

Example 3 The following JTPEXCL command deletes a previously defined exclusion:

JTPEXCL CLEANUP DELETE

In the above example, CLEANUP is deleted and no longer affects the job trackingcompletion status of the job.

Page 396: ESP 5.2 Command Reference

396

JUMPTO Statement

Overview The JUMPTO statement is used to cause a forward search within an ESP Procedure

to find the next label of the name given in the JUMPTO statement. Use theJUMPTO statement to skip over whole sections of an ESP Procedure. You can usea JUMPTO statement with or without an IF statement.

Type ESP Procedure Statement.

Syntax The syntax of the JUMPTO statement is:

JUMPTO labelname

Parameter Description

labelname Indicates a valid label name consisting of up to 16alphanumeric characters.

Usage notes The JUMPTO statement is often used with IF-THEN-ELSE statements.

JUMPTO allows you to skip whole processing sections of a Procedure under certainconditions.

Labels used in conjunction with JUMPTO statements can be up to 16 characters.The first character must be an alphabetic character and you must type a colon afterthe last character.

Relatedinformation

For information on ESP’s control language (CLANG) and ESP Procedures, see theESP Workload Manager User’s Guide.

Example 1 The following JUMPTO statement causes a forward search through an ESP

Procedure:

IF TODAY(‘LAST WORKDAY OF FISCALYR’) THEN JUMPTO LSTWDYRSELECT PAYJOB99EXITLSTWDYR:SELECT (PAYJOB1,PAYJOB2)

In the above example, if today is the last workday of the fiscal year ESP jumps to theLSTWDYR label and selects PAYJOB1 and PAYJOB2; otherwise PAYJOB99 isselected.

Continued on next page

Page 397: ESP 5.2 Command Reference

397

JUMPTO Statement, Continued

Example 2 The following JUMPTO statements cause forward searches based on what day this

ESP Procedure is invoked:

APPL FREDJCLLIB 'CYBBS01.JCLLIB.CNTL'IF TODAY('MONDAY') THEN JUMPTO MONDAYIF TODAY('NOT MONDAY') THEN JUMPTO NOT_MONDAYMONDAY:INVOKE 'CYBER.PROCLIB.CNTL(SPECIAL)'

EXITNOT_MONDAY:INVOKE 'CYBER.PROCLIB.CNTL(REGULAR)'

EXIT

In the above example, if today is:

• Monday, ESP jumps to the MONDAY label, invokes the SPECIAL ESPProcedure, and then exits.

• Not Monday, ESP jumps to the NOT_MONDAY label, invokes the REGULARESP Procedure, and then exits.

Example 3 The following JUMPTO statements causes a forward search based on whether or nota started task is active:

IF ACTIVE(‘CICS’) THEN JUMPTO STOPELSE JUMPTO GO

STOP:VS ‘F CICS,SHUTDOWN’REEXEC IN(5)EXITGO:VS ‘F ESP,TRIGGER PROD.PAYROLL’

In the above example, if the CICS started task is active, ESP jumps to the STOPlabel and issues the shutdown command, schedules a re-execution of the Event in 5minutes, and exits. If CICS is not active ESP jumps to the GO label and issues acommand to trigger the PROD.PAYROLL Event.

Continued on next page

Page 398: ESP 5.2 Command Reference

398

JUMPTO Statement, Continued

Example 4 The following JUMPTO statements cause forward searches based on the name of ajob:

JUMPTO %MNJOBCICS1:ESP TRIGGER PROD.CICS1BKUPEXITCICS2:ESP TRIGGER PROD.CICS2BKUPEXITCICS3:ESP TRIGGER PROD,CICS3BKUPEXIT

In the above example, this common ESP Procedure is invoked as a result of a jobmonitor Event. If CICS1, CICS2 or CICS3 abend, a generic job monitor Event isautomatically triggered, and invokes this ESP Procedure. ESP jumps to theappropriate label (based on the jobname, represented by %MNJOB), triggers anEvent, and exits.

Page 399: ESP 5.2 Command Reference

399

LABEL Command

Overview The LABEL command is used in conjunction with the GENDOC, REMOVE andGO commands when converting a non-ESP job documentation library to adocumentation library usable by ESP. The LABEL command alters or replaces linesin the output data set, or inserts lines at different locations in the output data set.

Type General command.

Syntax The syntax of the LABEL command is:

LABEL ‘source_string’ ‘target_string’{BEFORE}{AFTER}{REPLACE}{OVERLAY}{INLINE}{ANY}

Parameter Descriptionsource_string Indicates a string to be scanned. It can contain the ‘*’

wildcard character. If the ANY keyword is not used, thesource string is expected to be the first non-blank characterdata on the line.

target_string Indicates a new string. If the target string contains thecharacter ‘@’, the ‘@’ is replaced by the actual source string.If the source string is specified with wildcard characters, thewildcard characters are replaced with the actual charactersfound.

BEFORE Indicates the target string is placed on a line of its own justahead of the line containing the source string.

AFTER Indicates the target string is placed on a line of its own justafter the line containing the source string.

REPLACE Indicates the line containing the source string is deleted and aline containing just the target string is inserted instead.

OVERLAY Indicates the target string overlay the source string in therecord. The target string is moved to the line being copied,starting at the same column as the source string. If the targetstring is longer than the source string, data following thesource string may be overlaid.

INLINE Indicates the target string be used to replace the source string.If the strings are of unequal length, subsequent data is shiftedleft or right.

ANY Indicates the source string can be located anywhere on aninput line. The default is to look for the source string as thefirst non-blank data on a line.

Continued on next page

Page 400: ESP 5.2 Command Reference

400

LABEL Command, Continued

Usage notes The GENDOC command identifies the input data set, members to be copied, and theoutput data set. It also lets you identify changes you want to make when the olddocumentation converts.

Use the REMOVE, LABEL and GO commands in conjunction with the GENDOCcommand to customize the conversion of non-ESP job documentation to ESP jobdocumentation.

Relatedinformation

For information on converting existing job documentation, see the GENDOCcommand.

For information on identifying lines that are not to be copied to the output data setduring the conversion, see the REMOVE command

For information on indicating that all specifications are complete and that the copyprocess should proceed, see the GO command.

For information on job documentation, see the ESP Workload Manager User’sGuide.

For information on displaying job documentation information, see the JOBINFOcommand, or the ESP Workload Manager User’s Guide.

For information on identifying a job documentation library in an Application, seethe DOCLIB statement.

Example 1 The following GENDOC, REMOVE, LABEL and GO commands are used toconvert existing job documentation:

GENDOC JOBDOC.DATA ESP.JOBDOC.DATA LEV(A–,B–) SNUMREMOVE ‘**’LABEL ‘SYSOUT REVIEW’ ‘SYSOUT_REVIEW’ INLINELABEL ‘STEP***’ ‘@:’ OVERLAYLABEL ‘RESTART PROCEDURES’ ‘RESTART:’ BEFOREGO

In the above example, ESP:

• Copies all members beginning with ‘A’ and ‘B’ from the data set‘JOBDOC.DATA’ to the data set ‘ESP.JOBDOC.DATA’, suppressing any linenumbers in the right–hand 8 columns of each source member record.

• Does not copy any lines containing ‘**’.• Replace any lines starting with ‘SYSOUT REVIEW’ with the character string

‘SYSOUT_REVIEW’.• Overlays the semicolon on any line beginning with ‘STEP’. The semicolon is

positioned after the 3rd character following the string ‘STEP’.• Places the label ‘RESTART:’ on its own line before any line starting with the

string ‘RESTART PROCEDURES’.• Proceeds with the copy process.

Page 401: ESP 5.2 Command Reference

401

LATESUB Statement

Overview The LATESUB statement indicates a late submission time for a job. This is thelatest acceptable submission time before the job is flagged as overdue.

Type ESP Application statement.

Syntax The syntax of the LATESUB statement is:

LATESUB criteria

Parameter Descriptioncriteria Schedule criteria that resolve to a single date and time.

Usage notes ESP can provide notification when a job’s late submission time is exceeded. Forexample, you may want to send a message, or trigger an Event.

From the CSF, you can filter on overdue jobs.

The LATESUB statement can be used for any type of workload object and must beplaced within the scope of a job statement (all statements up to an ENDJOBstatement or the next JOB statement).

The LATESUB time for a link or task represents the time when all of itsdependencies should be met, as there is no actual job submission.

The LATESUB statement’s date and time criteria are relative to the scheduled timeof the Event.

LATESUB does not force the submission of a job when its late submission time isexceeded. To force submission of a job regardless of dependencies use theABANDON DEPENDENCIES statement. To bypass a job after a specified timeand submit successor jobs, use the ABANDON SUBMISSION statement.

To identify that a job has not started or finished by a specific time, use theDUEOUT statement.

The LATESUB statement propagates dueout times upstream, i.e. to all predecessorsof the job where a LATESUB statement is specified. These dueout times are setrelative to the average elapsed times according to the information obtained fromESP’s history file.

Relatedinformation

For information on providing notification on job status, see the NOTIFY statement.

For information on triggering an Event based on a job exceeding its late submissiontime, see the ESP Workload Manager Advanced User’s Guide.

Continued on next page

Page 402: ESP 5.2 Command Reference

402

LATESUB Statement, Continued

Example 1 The following LATESUB statement specifies a late submission time of 22:00:

JOB ARUN DAILYLATESUB 22:00

ENDJOB

In the above example, job A is flagged as overdue if ESP has not submitted the jobby 22:00.

Example 2 The following LATESUB statement specifies a late submission time of 6pm everyday except Monday:

JOB ARUN DAILYIF TODAY(‘MONDAY’) THEN LATESUB 4PM

ELSE LATESUB 6PMENDJOB

In the above example, job A is flagged as overdue if ESP has not submitted it by 6pm every day except on Monday, when the late submission time is 4 pm.

Example 3 The following LATESUB statement specifies a late submission time of 4 pm for alink that issues an operator command:

JOB SET.INITS LINK PROCESSRUN DAILYLATESUB 4PMVS ‘$SI1-5’

ENDJOB

In the above example, job SET.INITS is flagged as overdue if its dependencies arenot satisfied by 4 pm.

Continued on next page

Page 403: ESP 5.2 Command Reference

403

LATESUB Statement, Continued

Example 4 The following Event has a scheduled execution time of 9 pm:

EVENT ID(CYBER.TEST)SCHEDULE 9PM DAILYINVOKE 'CYBBS01.PROCLIB.CNTL(TEST)'ENDDEF

The following job has a late submission time of 10 pm:

JOB ARUN DAILYLATESUB 10PM

ENDJOB

The following CSF display shows the status of a job flagged as overdue:

ESP Consolidated Status: View TEST Row 1 of 2, Col 1COMMAND ===> SCR ===> PAGE

Jobname APPL GEN STATUS___ A TEST 8 SUBMITTED OVERDUE

In the above example, an Event (CYBER.TEST) missed its scheduled executiontime due to system problems. When the Event was triggered at 11 pm, job A wassubmitted and flagged as overdue in the CSF.

Other examples Here are more examples using the LATESUB statement.

Flags the job as overdue if it is not submitted 10 minutes after the scheduledexecution time of the Event:

LATESUB NOW PLUS 10 MINUTES

Flags the job as overdue if it is not submitted by 7am tomorrow:

LATESUB 7AM TOMORROW

Flags the job as overdue if it is not submitted 2 hours after the Event is triggered:

LATESUB REALNOW PLUS 2 HOURS

Page 404: ESP 5.2 Command Reference

404

LAX Command

Overview The LAX command is used to display external jobs in active Applications.

Type General command.

Authority OPER authority is required to issue the LAX command.

Syntax The syntax of the LAX command is:

LAX

Usage notes Use the EXTERNAL keyword as part of a JOB statement to tell ESP the job is partof another Application. This allows you to establish relationships between jobs indifferent Applications.

Relatedinformation

For information on Applications, see the ESP Workload Manager User’s Guide.

For information on posting external or manual jobs complete, see the APPLstatement or the ESP Workload Manager Advanced User’s Guide.

Continued on next page

Page 405: ESP 5.2 Command Reference

405

LAX Command, Continued

Example 1 The following is an example of an Application containing an external job that runsas part of another Application:

APPL BILLINGJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB99 EXTERNAL

RUN WORKDAYSREL BILJOB1

JOB BILJOB1RUN WORKDAYS

ENDJOB

The following is an example of the Application where the External job (above)actually runs:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB99

RUN WORKDAYSENDJOB

The following LAX command displays External jobs in active Applications:

LAXBILLING.28: PAYJOB99

--- 1 APPLS DISPLAYED

In the above example, the LAX command displays the name of the External job andthe Application that job belongs to.

Page 406: ESP 5.2 Command Reference

406

LCMDPRFX Command

Overview The LCMDPRFX command is used to display whether command prefixing is ineffect or not. If command prefixing is in effect, LCMDPRFX displays the characterto be substituted for the ‘F stcname,’, (where stcname is the started task name forESP) string when issuing modify commands to ESP from a system console.

Type General command.

Authority OPER authority is required to issue the LCMDPRFX command.

Syntax The syntax of the LCMDPRFX command is:

LCMDPRFX

Relatedinformation

For information on substituting a character for the ‘F ESP’ string, see theCMDPRFX command.

Example 1 The following LCMDPRFX displays the character that is substituted for the ‘FESP,’ string:

OPER LCMDPRFX'#' 'F ESP,'

In the above example, the number sign (#) was previously set as the character to besubstituted for the ‘F ESP’ string when issuing modify commands to ESP from asystem console.

Page 407: ESP 5.2 Command Reference

407

LDSN Command

Overview The LDSN command is used to produce a display of the current system data setsallocated to ESP.

Type General command.

Syntax The syntax of the LDSN command is:

LDSN

Relatedinformation

For information on defining ESP data sets, see the ESP Workload ManagerInstallation Guide.

Example 1 The following is an example of the display produced by the LDSN command:

LDSNCHECKPOINT: CYBER.ESP510.CKPT, ALT NONE

USERDEF: CYBER.ESP510.USERDEF, BKUP NONEINDEX: CYBER.ESP510.INDEX, BKUP NONE

JOBINDEX: CYBER.ESP510.JOBINDEX, BKUPCYBER.ESP510.BKUP.JOBINDEX

QUEUE: CYBER.ESP510.QUEUE, ALT NONETRAKFILE: CYBER.ESP510.TRAKFILEEVENTSET: CYBER.ESP510.EVENT1HISTFILE: CYBER.ESP510.HISTFILEAPPLFILE: CYBER.ESP510.APPLFILE

JTDT: CYBER.ESP510.PARMLIB(JOBDEF1)UPDT: CYBER.ESP510.PARMLIB(PROFILE)

In the above example, current system data sets allocated to ESP are displayed.

Page 408: ESP 5.2 Command Reference

408

LDTE Command

Overview The LDTE command is used to list data sets being checked for data set activity asspecified by the DSTRIG command in an Event definition or by the DSNAMEstatement in an Application.

Type General command.

Syntax The syntax of the LDTE command is:

LDTE

Relatedinformation

For information on data set triggering at the Event level, see the ESP WorkloadManager User’s Guide.

For information on data set triggering at the job level, see the ESP WorkloadManager User’s Guide.

For information on displaying data sets being checked for closures, creations orrenaming, see the LDXE command.

Example 1 The following is an example of the display produced by the LDTE command:

LDTETHE FOLLOWING DATASET(S) ARE BEING CHECKED FOR DATASETTRIGGERSCYBER.PAYROLL.DATA CREATE-CLOSEUSER.INPUT.CYCLE ANYCLOSE2 DATASET TRIGGERS FOUND

In the above example, data sets checked for data set activity are displayed.

Page 409: ESP 5.2 Command Reference

409

LDTREL Command

Overview The LDTREL command is used to display the entries from the Data set TriggerExclude list.

Type General command.

Authority OPER authority is required to issue the LDTREL command.

Syntax The syntax of the LDTREL command is:

LDTREL

Usage notes The Data set Trigger Exclude list consists of a list of programs that are not eligiblefor data set triggering. The DSTREXCL Initialization Parameter specifies these.

Use the DSTREXCL command to flag an entry in the Data set Trigger Exclude listas invalid.

Relatedinformation

For information on flagging an entry in the Data set Trigger Exclude list as invalid,see the DSTREXCL command.

For information on adding an entry to the Data set Trigger Exclude list at theInitialization Parameter level, see the ESP Workload Manager InitializationReference Guide.

Example 1 The following is an example of the output produced by the LDTREL command:

LDTRELDSTRIG exclude PGM=USRPGM

In the above example, USRPGM is not eligible for data set triggering.

Page 410: ESP 5.2 Command Reference

410

LDXE Command

Overview The LDXE command is used to list data set names and the corresponding Events orApplications waiting for data set activity. Data set trigger requirements areidentified by the DSTRIG command in an Event definition or by the DSNAMEstatement in an Application.

Type General command.

Syntax The syntax of the LDXE command is:

LDXE

Relatedinformation

For information on data set triggering at the Event level, see the ESP WorkloadManager User’s Guide.

For information on data set triggering at the job level, see the ESP WorkloadManager User’s Guide.

For information on displaying data set triggered Events, see the LDTE command.

Example 1 The following is an example of the display produced by the LDXE command:

LDXEEVENT/APPL (WOB)--------------DATASETPAYROLL.1 (WAIT4.DS) CYBER.PAYROLL.DATA,ANYCLOSECYBER.CYCLES USER.INPUT.CYCLE

In the above example, data sets that are checked for closures, creation or renamesare displayed.

Page 411: ESP 5.2 Command Reference

411

LIBSUB Command

Overview The LIBSUB command is used to submit JCL from a Librarian data set to theinternal reader.

Type Event definition command.

Syntax The syntax of the LIBSUB command is:

LIBSUB dsname[(member)]

Parameter Descriptiondsname Indicates a valid LIBRARIAN data set name. You do not

have to specify ‘LIB-’ as a data set identifier, because usingthe LIBSUB command implies the use of a LIBRARIAN dataset.

member Indicates a member name, which can consist of up to 8characters if specified.

Usage notes Several LIBSUB commands may be specified in a single Event. The input data areeffectively concatenated together, so that data from several data sets can be joinedtogether to form one or more jobs.

In the same Event, you can also use the SUBMIT command, as well as submittingfrom ROSCOE and PANVALET data sets.

To submit Librarian jobs as part of an Application, prefix the Librarian data set withLIB- on the JCLLIB statement, as follows:

APPL PAYROLLJCLLIB LIB-LIB01A.DATAJOB PAYJOB1

RUN DAILYENDJOB

Relatedinformation

For information on submitting JCL from an Event, see the ESP Workload ManagerUser’s Guide.

For information on identifying a JCL library, see the JCLLIB statement.

Continued on next page

Page 412: ESP 5.2 Command Reference

412

LIBSUB Command, Continued

Example 1 The following is an example of an Event definition that submits JCL from aLIBRARIAN data set:

EVENT ID(CYBER.ONELIBJOB)SCHEDULE 9AM FIRST MONDAY OF MONTHLIBSUB LIB01A.DATA(PRODCNTL)ENDDEF

In the above example, PRODCNTL is submitted at 9am on the first Monday of themonth from the LIBRARIAN data set LIB01A.DATA.

Page 413: ESP 5.2 Command Reference

413

LIST Command

Overview The LIST command is used to display Event information.

Type General command.

Syntax The syntax of the LIST command by LEVEL is:

{LIST|L} [LEVEL{(groupprefix)|(levelname)}][ALL][SYSTEM][CLASS(classname)][TIMESEQ][PRINT(dsname)][MOD]

The syntax of the LIST command by EVENT is:

{LIST|L} EVENT(eventid)[ALL][PRINT(dsname)][MOD]

Parameter Descriptiongroupprefix Indicates the current group prefix.levelname Enter up to 24 characters in the level name. All Events whose

names begin with the specified string are displayed. Thelevel name can contain asterisks and a hyphen anywhere butin the prefix.

ALL Indicates all available information on the Event(s) isdisplayed. If this parameter is omitted, the display is limitedto the next execution time. The information displayed withthe ALL option is enough to redefine the Event in its entirety.

SYSTEM Indicates the ID of the ESP system that is to execute theEvent is included in the display.

classname Indicates the display is restricted to Events with the specifiedclass name.

TIMESEQ Indicates the Event names are to be displayed in executiontime sequence order rather than alphanumeric collatingsequence.

eventid Indicates the name of a specific Event to be displayed.dsname Indicates the name of a data set to receive the output. The

record format of the data set is preserved. ESP can writefixed, variable or undefined records, blocked or unblocked

MOD Indicates the data set receiving output is appended to.

Continued on next page

Page 414: ESP 5.2 Command Reference

414

LIST Command, Continued

Usage notes When issuing the LIST command from Page mode, that is under the ISPF interface,you must use the abbreviated form of the LIST command (L).

An asterisk indicates that any character in the asterisk location acts as a match.

A hyphen indicates that any character in that or subsequent character positions isconsidered a match.

If the level name contains a period, the part to the left of the period indicates theprefix (group or userid), while the part to the right indicates the descriptive name.

If a prefix is specified, it cannot contain asterisks or a hyphen. If the level namedoes not contain a period, it is assumed to be a prefix if:

• It contains eight characters or less, and• It does not contain either asterisks or a hyphen.

Otherwise it is assumed to be a descriptive name.

The PRINT parameter of the LIST command is useful when changes are required formultiple Events. The following summarizes how to accomplish this:

• Issue the LIST command with the PRINT parameter for the desired group ofEvents

• Edit the data set as required• Issue the LOAD command to re-load the edited Events

Relatedinformation

For information on Events, see the ESP Workload Manager User’s Guide.

For information on loading ESP commands from a data set, see the LOADcommand.

Example 1 The following LIST command displays Event name and execution times:

L LEVEL(PROD)

In the above example, the names and next execution times of all Events defined tothe PROD group prefix are displayed.

Example 2 The following LIST command writes the results to a data set:

L LEVEL(PROD) ALL PRINT(‘ESP.EVENTS’)

In the above example, the complete definitions of all Events defined to the PRODgroup prefix are written to the ESP.EVENTS data set.

Continued on next page

Page 415: ESP 5.2 Command Reference

415

LIST Command, Continued

Example 3 The following LIST command displays Event name and execution times:

LIST LEVEL(CYBER.BKUP-)

In the above the names of all Events beginning with BKUP defined to the CYBERgroup prefix are displayed.

Note: The above LIST command is not abbreviated as it is issued from a batch job.

Example 4 The following command displays specific Events with my current group prefix:

L LEVEL(A-)

In the above example, all Events that start with my current group prefix, followed by‘A’ and any number of characters are displayed.

Example 5 The following LIST command displays Events in execution time sequence:

L LEVEL(PROD.**PR-) TIMESEQ SYS

In the above example, the execution time and system ID of all Events defined to thePROD group prefix whose names have a PR in character positions three and four aredisplayed in execution time sequence.

Example 6 The following LIST command displays information about a specific Event:

L EVENT(CYBER.PAYROLL) ALL

In the above example, all available information for CYBER.PAYROLL is displayed.

Page 416: ESP 5.2 Command Reference

416

LISTAPPL Command

Overview The LISTAPPL command is used to display Application information. The shortform of this command name is LAP.

Type General command.

Syntax The syntax of the LISTAPPL command is:

{LISTAPPL|LAP} applname[.gen][COMPLETE|INCOMPLETE][ALL][PREDECESSORS][SUCCESSORS][CRITPATH|NOTCRITPATH][JOBS][JOB(jobname[,jobname]...)][STATUS][SUBAPPL(subapplname)][OLDEST][DUMP]

Parameter Descriptionapplname The applname parameter can contain a generic specification

with the ‘*’ and ‘-’ acting as single and multi-characterwildcards. An absolute or relative generation number canalso be specified with a specific applname as follows:

• applname.0 - displays the most recent generation ofApplication.

• applname.-n - displays the nth previousgeneration of the Application.

• applname.n - displays the absolute generation nof the Application.

COMPLETE Omission of the COMPLETE keyword results in a display ofApplications that still have active or incomplete jobs, unlessan absolute or relative generation number is specified. TheCOMPLETE keyword requests that completed Applicationsare also included in the display.

INCOMPLETE Displays all incomplete Applications. This is the default ifnot specified.

ALL Displays information about each job. This includes successorand predecessor information for each job, as well as resourceinformation.

JOBS Displays the names of each job in an Application. Thedisplay is divided into two sections: jobs that have completedand jobs that have yet to complete.

Continued on next page

Page 417: ESP 5.2 Command Reference

417

LISTAPPL Command, Continued

Syntax (continued)

Parameter DescriptionPREDECESSORS Displays the names of any predecessors for each complete

job. The PREDECESSORS parameter is used inconjunction with the ALL parameter.

SUCCESSORS Displays the names of any successors for each complete job.The SUCCESSORS parameter is used in conjunction withthe ALL parameter.

CRITPATH Displays all jobs on the critical path if critical path analysisis turned on.

NOTCRITPATH Displays all jobs not on the critical path if critical pathanalysis is turned on.

JOB(jobname) Displays in a structured view each job or qualified job youhave specified.

STATUS Displays the status of each Application, without detailing thejobnames.

SUBAPPL Display is limited to the subApplication specified.OLDEST Requests a display of the oldest incomplete generation of an

Application.DUMP Displays in hexadecimal format Application record

information for problem diagnosis.

Usage notes The LISTAPPL command displays information from the APPLFILE.

The LISTAPPL command displays anticipated end times for all jobs in anApplication.

When critical path analysis is turned on the LISTAPPL command:

• Displays all jobs on the critical path with a label of CRITICAL PATH• Displays the job in the Application that is coded with the CRITICAL keyword

with a label of CRITICAL• Displays all jobs that are not on the critical path.

The LISTAPPL command cannot be issued from a system console.

Use the LAP command with the ALL keyword to give a structured view of an activeApplication or with other keywords to give a summary of active or completedApplications. You can limit the display to specific generations of an Application andto specific jobs within an Application.

Continued on next page

Page 418: ESP 5.2 Command Reference

418

LISTAPPL Command, Continued

Relatedinformation

For information on displaying active Applications from the CSF, see the ESPWorkload Manager User’s Guide.

For information on manipulation jobs in active Applications, see the APPLJOB orAJ command.

For information on critical path analysis, see the ESP Workload Manager User’sGuide.

Example 1 The following LAP command displays an active generation of an Application:

LAP PAYROLL.0 ALL

In the above example, a structured view of the PAYROLL Application is displayed.

Example 2 The following LAP command displays the previous generation of an Application:

LAP PAYROLL.-1 ALL

In the above example, the status of the -1 generation of the PAYROLL Applicationis displayed.

Example 3 The following LAP command displays all generations of an Application that arestored on the APPLFILE:

LAP PAYROLL COMPLETE

In the above example, all complete and incomplete generations of the PAYROLLApplication are displayed.

Example 4 The following LAP command displays a specific job within an Application:

LAP PAYROLL.0 JOB(PAYJOB1)

In the above example, a structured view of PAYJOB1 within the PAYROLLApplication is displayed.

Example 5 The following LAP command displays a subApplication:

LAP FINANCE.0 SUBAPPL(PAYROLL) ALL

In the above example, a structured view of the PAYROLL subApplication within theFINANCE Application is displayed.

Continued on next page

Page 419: ESP 5.2 Command Reference

419

LISTAPPL Command, Continued

Example 6 The following LAP command displays specific jobs within an active generation ofan Application:

LAP PAYROLL JOB(PAYJOB1,PAYJOB2,PAYJOB3) OLDEST

In the above example, a structured view of PAYJOB1, PAYJOB2 and PAYJOB3within the oldest incomplete generation of the PAYROLL Application are displayed.

Example 7 The following LAP command displays predecessors and successors for each job inan Application:

LAP PAYROLL.-2 ALL PRED SUCC

In the above example, the predecessors and successors of each job in the -2generation of the PAYROLL Application, and whether those predecessors orsuccessors are complete, are displayed.

Example 8 The following LAP command display the names of each job in an Application:

LAP PAYROLL.0 JOBS

In the above example, a summary of complete and incomplete jobs within thePAYROLL Application is displayed.

Example 9 The following is an example of the display produced by the LAP command (LAPPAYROLL.105 ALL) with critical path analysis turned off:

APPL PAYROLL GEN 105CREATED AT 13.04 ON WEDNESDAY JANUARY 28TH, 1998

BY EVENT CYBER.PAYROLLPAYJOB1, HC=0SUBMISSION AT 21.00 ON WEDNESDAY JANUARY 28TH, 1998ANTICIPATED END TIME: 21.00 ON WEDNESDAY JANUARY 28TH, 1998PREDECESSORS: (NONE)

SUCCESSORS: PAYJOB2, PAYJOB3PAYJOB2, HC=1ANTICIPATED END TIME: 21.00 ON WEDNESDAY JANUARY 28TH, 1998PREDECESSORS: PAYJOB1

SUCCESSORS: PAYJOB4PAYJOB3, HC=1ANTICIPATED END TIME: 21.00 ON WEDNESDAY JANUARY 28TH, 1998PREDECESSORS: PAYJOB1

SUCCESSORS: PAYJOB4PAYJOB4, HC=2ANTICIPATED END TIME: 21.00 ON WEDNESDAY JANUARY 28TH, 1998PREDECESSORS: PAYJOB2, PAYJOB3

SUCCESSORS: (NONE)

Continued on next page

Page 420: ESP 5.2 Command Reference

420

LISTAPPL Command, Continued

Example 10 The following is an example of the display produced by the LAP command withcritical path analysis turned on:

APPL PAYROLL GEN 105CREATED AT 13.04 ON WEDNESDAY JANUARY 28TH, 1998

BY EVENT CYBER.PAYROLLPAYJOB1, HC=0SUBMISSION AT 21.00 ON WEDNESDAY JANUARY 28TH, 1998ANTICIPATED END TIME: 21.00 ON WEDNESDAY JANUARY 28TH, 1998

- CRITICAL PATHPREDECESSORS: (NONE)

SUCCESSORS: PAYJOB2, PAYJOB3PAYJOB2, HC=1ANTICIPATED END TIME: 21.00 ON WEDNESDAY JANUARY 28TH, 1998PREDECESSORS: PAYJOB1

SUCCESSORS: PAYJOB4PAYJOB3, HC=1ANTICIPATED END TIME: 21.00 ON WEDNESDAY JANUARY 28TH, 1998

- CRITICAL PATHPREDECESSORS: PAYJOB1

SUCCESSORS: PAYJOB4PAYJOB4, HC=2ANTICIPATED END TIME: 21.00 ON WEDNESDAY JANUARY 28TH, 1998

- CRITICALPREDECESSORS: PAYJOB2, PAYJOB3

SUCCESSORS: (NONE)

In the above example, a structured view of the PAYROLL Application is displayed.Jobs on the critical path are displayed with the CRITICAL PATH label, and thecritically identified job in the Application is displayed with the CRITICAL label.

Page 421: ESP 5.2 Command Reference

421

LISTAPTF Command

Overview The LISTAPTF command is used to display information on the current status of theApplication file.

Type General command.

Authority OPER authority is required to issue the LISTAPTF command.

Syntax The syntax of the LISTAPTF command is:

LISTAPTF

Usage notes The information displayed includes data set name, date and time formatted, andcurrent allocation status.

Relatedinformation

For information on defining ESP data sets, see the ESP Workload ManagerInstallation Guide.

Example 1 The following is an example of the display produced by the LISTAPTF command:

OPER LISTAPTFDATASET CYB2.ESP510.APPLFILEFORMATTED AT 17.33.55 ON MONDAY NOVEMBER 17TH, 19973600 SLOTS TOTAL, 3464 AVAILABLE, NEXT IS 928

In the above example, information on the current status of the Application file isdisplayed.

Page 422: ESP 5.2 Command Reference

422

LISTAT Command

Overview The LISTAT command is used to display the contents of an authorization table.

Type General command.

Syntax The syntax of the LISTAT command is:

LISTAT tabname[DECOMPILE]

Parameter Descriptiontabname Indicates the name of the authorization table you want

displayed. The name consists of up to eight characters. Youcan specify asterisks or a hyphen for masking.

DECOMPILE Indicates you want the authorization table to be displayed inthe same way in which it was defined. The DECOMPILEoption generates a DEFAT (define authorization table)command you could feed directly back into ESP.

Usage notes An authorization table provides a way of controlling access to job tracking data. Forinstance, you may not want to allow one customer to view job-tracking informationfor another customer’s jobs. The use of an authorization table means that access todata for tracked jobs depends on the jobname and on an authorization string.

The DEFAT command is used to define or alter an authorization table, limitingaccess to tracked job data. An authorization table provides a way of controllingaccess to job tracking data.

The LISTAT command is not used with the SAF interface.

Relatedinformation

For information on defining or altering an authorization table, see the DEFATcommand or the ESP Workload Manager Administrator’s Guide.

Example 1 The following is an example of the display produced by a LISTAT command:

LISTAT AUTHTAB1JOB AUTH TABLE: AUTHTAB1DEFINED AT 11.30 ON FRI 2JAN99 BY CYBBP01INCLUDE: ABC-,ACO-, XYZ-,ACO-EXCLUDE: -,AC02

In the above example, the contents of an authorization table are displayed.

Continued on next page

Page 423: ESP 5.2 Command Reference

423

LISTAT Command, Continued

Example 2 The following LISTAT command displays the authorization table the way it wasdefined:

LISTAT AUTHTAB1 DECOMPILE

In the above example, AUTHTAB1 is displayed the same way in which it wasdefined.

Page 424: ESP 5.2 Command Reference

424

LISTCAL Command

Overview The LISTCAL command is used to display information about a calendar.

Type General command.

Syntax The syntax of the LISTCAL command is:

{LISTCAL|LCAL} calname

Parameter Descriptioncalname Indicates a name or generic level of the calendar or calendars

displayed. It can be up to eight characters long and can alsocontain asterisks and a hyphen.

Usage notes After you have defined a calendar, and those users with update access have definedtheir scheduling terms in the calendar, you or any other user may want to reviewinformation about the calendar.

Like the users who defined their scheduling terms in the calendar, you may need toreview the calendar information for troubleshooting and maintenance. Other userswho automatically have read access to the calendar may find it useful to review thecalendar information before using it in an Event.

If you do not specify a calendar name, the most recently retrieved calendars aredisplayed. A set of calendars is retrieved as a result of a LISTHOL, LISTSPEC,EVENT, CALENDAR or prior LISTCAL command. If no calendars werepreviously retrieved, you are prompted to enter a calendar name.

Relatedinformation

For information on defining and deleting holidays, see the DEFHOL and DELHOLcommands.

For information on defining and deleting special days, see the DEFSPEC andDELSPEC commands.

For information on altering the attributes of a calendar, see the ALTCAL command.

For information on defining calendars, see the ESP Workload ManagerAdministrator’s Guide or the DEFCAL command.

For information on using special calendars in an Event, the ESP Workload ManagerUser’s Guide.

For information on using calendars, see the ESP Workload Manager User’s Guide.

Continued on next page

Page 425: ESP 5.2 Command Reference

425

LISTCAL Command, Continued

Example 1 The following is an example of the display produced by the LISTCAL command:

LISTCAL SYSTEMCALENDAR NAME: SYSTEMDEPARTMENT: NONEDEFINED: AT 15.42 ON THU 23RD SEP 1993 BY CYBSM04OWNER: USR01WORKDAYS: MON TUE WED THU FRIWEEK STARTS: MONSIZE: 280 BYTESHOLIDAYS: CHRISTMAS, NEW_YEARS, CHRISTMAS, NEW_YEARSSPECIAL DAYS: INVENTORY_DAY(1)

In the above example, the contents of the SYSTEM calendar are displayed.

Example 2 The following LISTCAL command displays specific calendars:

LISTCAL PAY-

In the above example, the contents of all calendars with PAY in the first 3 positionsare displayed.

Page 426: ESP 5.2 Command Reference

426

LISTCKPT Command

Overview The LISTCKPT command is used to display statistics on the Checkpoint data set.

Type General command.

Authority OPER authority is required to issue the LISTCKPT command.

Syntax The syntax of the LISTCKPT command is:

LISTCKPT

Usage notes The information displayed by this command includes the Checkpoint data set name,the maximum size available, and the current usage.

Relatedinformation

For information on defining ESP data sets, see the ESP Workload ManagerInstallation Guide.

Example 1 The following is an example of the display produced by the LISTCKPT command:

OPER LISTCKPTPRIMARY CHECKPOINT CYB2.ESP510.CKPTMAX CHECKPOINT SIZE 737280HIGHEST ADDRESS USED 323232 BYTES IMBEDDED FREE SPACE

In the above example, statistics on the Checkpoint data set are displayed.

Page 427: ESP 5.2 Command Reference

427

LISTEVS Command

Overview The LISTEVS command is used to display the status of any or all of the Event dataset.

Type General command.

Authority OPER authority is required to issue the LISTEVS command.

Syntax The syntax of the LISTEVES command is:

LISTEVS [eventdb]

Parameter Descriptioneventdb Indicates the logical name of an Event data set. If this

parameter is omitted, all the Event data sets are displayed.

Usage notes If an Event data set is closed when the LISTEVS command is issued, the status isdisplayed as follows:

****DATASET IS IN SUSPENDED STATE

Relatedinformation

For information on defining ESP data sets, see the ESP Workload ManagerInstallation Guide.

Example 1 The following is an example of the display produced by the LISTEVS command:

LISTEVSEVENTSET EVENT1, DSN=CYB2.ESP510.EVENT1 SHR NOJRNLNEXT SCAN AT 06.00 ON WEDNESDAY JANUARY 28TH, 1998BACKUP DATASET CYB2.ESP510.BACKUP.EVENT1

In the above example, the status of the EVENT1 data set is displayed.

Example 2 The following LISTEVS command displays all Event data sets:

LISTEVS

In the above example, all Event data sets are displayed

Continued on next page

Page 428: ESP 5.2 Command Reference

428

LISTEVS Command, Continued

Example 3 The following LISTEVS command displays a specific Event data set:

LISTEVS EVENT1

In the above example, the status of the EVENT1 data set is displayed.

Page 429: ESP 5.2 Command Reference

429

LISTGRP Command

Overview The LISTGRP command is used to display information on your current group or anyother group to which you are connected. The LISTGRP command is available onlyin non-SAF environments.

Type General command.

Syntax The syntax of the LISTGRP command is:

{LISTGRP|LG} [groupname]

Parameter Descriptiongroupname Indicates the logical name of the group definition to be

displayed. It may contain asterisks and the last character canbe a hyphen if you want to use masking. If the group name isomitted, your current group is displayed.

Usage notes The information displayed by this command includes the group attributes and thenames of the users who are connected to the group.

Relatedinformation

For information on defining and deleting groups, see the DEFGROUP andDELGROUP commands.

For information on altering a group definition, see the ALTGROUP command.

For information on defining groups, see the ESP Workload Manager Administrator’sGuide.

For information on the System Authorization Facility (SAF), see the ESP WorkloadManager Administrator’s Guide.

Example 1 The following LISTGRP command displays your current group.

LISTGRP

In the above example, a group name is omitted and your current group is displayed.

Continued on next page

Page 430: ESP 5.2 Command Reference

430

LISTGRP Command, Continued

Example 2 The following LISTGRP command displays a specific group:

LISTGRP GROUP1

In the above example, GROUP1 is displayed.

Example 3 The following LISTGRP command displays multiple groups:

LISTGRP PAY-

In the above example, all groups beginning with PAY are displayed.

Example 4 The following LISTGRP command displays all groups:

LISTGRP -

In the above example, all groups are displayed.

Page 431: ESP 5.2 Command Reference

431

LISTHIST Command

Overview The LISTHIST command is used to display the status of any or all of the historyfiles.

Type General command.

Authority OPER authority is required to issue the LISTHIST command.

Syntax The syntax of the LISTHIST command is:

LISTHIST [histfid]

Parameter Descriptionhistfid Indicates the logical name of a HISTFILE using up to eight

characters. It may contain asterisks and a hyphen. If thisParameter is omitted, all the history files are displayed.

Relatedinformation

For information on defining ESP data sets, see the ESP Workload ManagerInstallation Guide.

Example 1 The following is an example of the display produced by the LISTHIST command:

OPER LISTHISTHISTFILE HIST1, DSN=CYB2.ESP510.HISTFILE SHR NOJRNLNO BACKUP TIME SETNO BACKUP DATASET

In the above example, the status of the HIST1 history file is displayed.

Example 2 The following LISTHIST command displays a specific history file:

LISTHIST HIST1

In the above example, the HIST1 history file is displayed.

Example 3 The following LISTHIST command displays specific history files:

LISTHIST HIST-

In the above example, all history files with HIST in the first four positions aredisplayed.

Page 432: ESP 5.2 Command Reference

432

LISTHOL Command

Overview The LISTHOL command is used to list previously defined holidays.

Type General command.

Syntax The syntax of the LISTHOL command is:

{LISTHOL|LH} name[GROUP(groupname)][CALENDAR(calname)][FROM(fromdate)][TO(todate)]

Parameter Descriptionname Indicates a full or generic name. It may contain asterisks and

a hyphen. An asterisk indicates that any character in thatposition is considered a match. A hyphen indicates that allsubsequent characters are considered a match. If thisparameter is omitted, all holidays are displayed. Code ‘-’ ifyou are using any other parameters and want all the holidaysto be displayed.

groupname Indicates holidays from the default calendars of the specifiedgroup are displayed.

calname Indicates the name of the calendar to be searched. Thisparameter is mutually exclusive with the GROUP parameter.

fromdate Indicates a start date for the holidays to be displayed. Onlyholidays that fall on or after this date are displayed. If noyear is specified, ESP uses the current year.

todate Indicates an ending date for the holidays to be displayed.Only holidays that fall on or before this date is displayed. Ifno year is specified, ESP uses the current year.

Usage notes If no group name or calendar name is specified, the most recently retrieved set ofcalendars is displayed. If no calendars were retrieved in the current commandsession, the default calendars for the current group are displayed.

A start and/or end date can be specified to restrict the displayed holidays to aspecific time period. Holidays are displayed in time sequence order within eachcalendar.

The display can be restricted to holidays containing a specified character string. Thefirst parameter specifies a holiday name or generic holiday name. If you want allholidays to be displayed but need to use another parameter, specify a hyphen (‘-’) asthe first parameter.

To specify a date, use any format ESP recognizes. If the date contains any blanks orcommas, enclose the string in quotes.

Continued on next page

Page 433: ESP 5.2 Command Reference

433

LISTHOL Command, Continued

Relatedinformation

For information on defining and deleting holidays, see the DEFHOL and DELHOLcommands.

Example 1 The following LISTHOL command displays holidays currently defined:

LISTHOL

In the above example, a holiday name is omitted and the defined holidays in yourdefault calendar are displayed.

Example 2 The following LISTHOL command displays all holidays up to a specific date:

LISTHOL - CALENDAR(CAL1) TO(SEPT30TH)

In the above example, all holidays in the CAL1 and the SYSTEM calendar up to theend of September are displayed.

Example 3 The following LISTHOL command displays specific holidays for a given year:

LISTHOL N*W- GROUP(PAYROLL) FROM(‘1JAN2001’) TO(‘31JAN2001’)

In the above example, all the holidays in the year 2001 that begin with ‘N’ and have‘W’ in position three of the name are displayed. The calendars to be searched arethe default calendars for the PAYROLL group.

Example 4 The following is an example of the display produced by the LISTHOL command:

CALENDAR SYSTEMNEW_YEARS 00.00 ON THU 1ST JAN 98 TO 00.00 ON FRI 2ND

JAN 98VICTORIA_DAY 00.00 ON MON 18TH MAY 98 TO 00.00 ON TUE 19TH

MAY 98MEMORIAL_DAY 00.00 ON MON 25TH MAY 98 TO 00.00 ON TUE 26TH

MAY 98XMAS 00.00 ON FRI 25TH DEC 98 TO 00.00 ON SAT 26TH

DEC 98---- 5 HOLIDAYS DISPLAYED ----

In the above example, holidays defined on the SYSTEM calendar are displayed.

Page 434: ESP 5.2 Command Reference

434

LISTJTML Command

Overview The LISTJTML command is used to list internal tracking model data.

Type General command.

Authority OPER authority is required to issue the LISTJTML command.

Syntax The syntax of the LISTJTML command is:

LISTJTML

Usage notes The DEFTM command defines a tracking model and allows you to centralize thedefinition of tracking characteristics, which can be assigned to one job, or a group ofjobs. Jobs are normally associated with a tracking model in a job tracking definitiontable.

Relatedinformation

For information on displaying the definition of tracking models, see the LTMcommand.

For information on defining and deleting a tracking model, see the DEFTM andDELTM commands.

Example 1 The following is an example of the display produced by the LISTJTML command:

OPER LISTJTML1 TRACKING MODEL BUFFER5398 MODELS LOCATED IN INCORE BUFFERS88 MODELS LOCATED VIA READ TO JOBINDEX

In the above example, tracking model data is displayed.

Page 435: ESP 5.2 Command Reference

435

LISTPN Command

Overview The LISTPN command is used to display the definition of one or more P-Nodeentries. A P-Node represents a stage a job goes through during processing.

Type General command.

Syntax The syntax of the LISTPN command is:

{LISTPN|LPN} name

Parameter Descriptionname Indicates the name of the P-Node entry to be displayed. It

may contain asterisks and a hyphen to display severalmatching entries.

Usage notes The INPUT, EXEC and OUTPUT P-Nodes are normally defined when installingESP. Any data defined using the DEFPN command is displayed.

Relatedinformation

For information on defining and deleting manual P-Nodes, see the DEFPN andDELPN commands.

For information on defining processing nodes (P-Nodes), see the ESP WorkloadManager Advanced User’s Guide.

Example 1 The following LISTPN command displays an individual P-Node:

LISTPN EXEC

In the above example, the EXEC P-Node is displayed.

Example 2 The following is an example of the display produced by the LISTPN command:

LISTPN -P-NODE - DISTRIB DEFINED AT 10.23 ON WED 28JAN98 BYCYBBS01HISTFILE - NONE, OWNER(CYBBS01), SEQUENCE(140)P-NODE - EXEC DEFINED AT 15.47 ON MON 24NOV97 BYCYBBP01HISTFILE - NONE, OWNER(CYBBP01), SEQUENCE(120)P-NODE - INPUT DEFINED AT 15.47 ON MON 24NOV97 BYCYBBP01HISTFILE - NONE, OWNER(CYBBP01), SEQUENCE(110)P-NODE - OUTPUT DEFINED AT 15.47 ON MON 24NOV97 BYCYBBP01HISTFILE - NONE, OWNER(CYBBP01), SEQUENCE(130)

Page 436: ESP 5.2 Command Reference

436

LISTQ Command

Overview The LISTQ command is used to display information about the current status of theQUEUE data set.

Type General command.

Authority OPER authority is required to issue the LISTQ command.

Syntax The syntax of the LISTQ command is:

LISTQ

Usage notes The information displayed by this command includes the time the QUEUE data setwas formatted, the amount of space allocated and the amount of space used, and theMINHOLD, MINDORM, and MAXDORM values.

Relatedinformation

For information on defining ESP data sets see, the ESP Workload ManagerInstallation Guide.

Example 1 The following is an example of the display produced by the LISTQ command.

OPER LISTQQUEUE DATASET CYB2.ESP510.QUEUEFORMATTED AT 12.33.25 ON MONDAY NOVEMBER 17TH, 1997MAXIMUM SIZE 737280 BYTESHIGHEST ADDRESS USED 72160, 6112 BYTES IMBEDDED FREE SPACEMINHOLD 100, MINDORM 100, MAXDORM 100

In the above example, the current status of the QUEUE data set is displayed.

Page 437: ESP 5.2 Command Reference

437

LISTSADL Command

Overview The LISTSADL command is used to display the current SADLINKs defined.

Type General command.

Authority OPER authority is required to issue the LISTSADL command.

Syntax The syntax of the LISTSADL command is:

LISTSADL

Usage notes The SADLINK command identifies an external SAD file with an internal identifier.Each time ESP initializes, or in response to a SADLOAD command, the contents ofthe SAD file are read and necessary information retained in a main-storage residentlook-up table. To request that the look-up table be used to resolve external linkages,specify the correct SADLINK identifier on the RESOLVE statement in an ESPProcedure.

Relatedinformation

For information on scheduled activity reporting, see the ESP Workload ManagerUser’s Guide.

For information on generating a data set that is used in the creation of scheduledactivity reports, see the SADGEN command.

For information on identifying an external scheduled activity data set, see theSADLINK command.

For information on refreshing an in-core table containing scheduled activity data set,see the SADLOAD command.

For information on resolving dependencies through a scheduled activity data set, seethe RESOLVE command.

Example 1 The following LISTSADL command displays SADLINKs:

LISTSADL

In the above example, all currently defined SADLINKs are displayed.

Page 438: ESP 5.2 Command Reference

438

LISTSCH Command

Overview The LISTSCH command is used to display the Event names and times of the currentschedule cycle (normally 24 hours). These elements include the names andexecution times of all the Events in the schedule, and the overdue, held, or deferredqueues.

Type General command.

Authority OPER authority is required to issue the LISTSCH command.

Syntax The syntax of the LISTSCH command is:

{LISTSCH|LSCH} [FROM(starttime)][TO(endtime)][LEVEL(levelname)][MAXENTRY{(200)|(count)}][DEFERRED(eventdsid)][HELD(class)][OVERDUE][SUSPENDED][DATE][FLUSHED][NONSCHED]

Parameter Descriptionstarttime Indicates a valid start time. This may include a date. If the

specification includes blanks or commas, place it withinquotes.

endtime Indicates the end time and can include a date. If thespecification includes blanks or commas, place it withinquotes.

levelname Indicates a generic Event name specification. It may containasterisks and hyphens.

count Indicates a number from 1-1000. It specifies the maximumnumber of entries to be displayed. This prevents a WTObuffer shortage when output is directed to a console.

eventdsid Indicates the identifier of an Event data set whose deferredqueue is to be displayed.

class Indicates the name of a held class.OVERDUE Indicates entries from the OVERDUE queue are displayed.SUSPENDED Indicates all suspended Events are displayed.

Continued on next page

Page 439: ESP 5.2 Command Reference

439

LISTSCH Command, Continued

Syntax (continued)

Parameter DescriptionDATE Indicates the date is included in the display as well as the

time.FLUSHED Indicates entries that have been flushed from deferred queue

should be displayed. This Parameter is only valid with theDEFERRED keyword. Flushed entries remain in the deferredqueue only while the system is quiesced. As soon as thesystem is restarted, the entries are removed from the queue.

NONSCHED Indicates scheduled Events, as well as Events that areexpected to execute (EXPECT command) are displayed.

Usage notes The MAXENTRY keyword is only available with the console version of theLISTSCH command.

Display portions of the schedule by using the FROM and TO keywords. The displaycan also be restricted to various Event names.

The LISTSCH command does not display the names or submission times forindividual jobs within Events. To display the schedule for jobs refer to scheduledactivity reporting.

The LISTSCH command displays only scheduled Events. If you want to displayEvents that do not have SCHEDULE commands, such as Events triggered by dataset activity you can use the EXPECT command when you define these Events. Usethe NONSCHED keyword on LISTSCH to include expected Events in the display.

The LISTSCH command displays Events from the current time up to the nextscheduled scan, which is normally at 6 am. Events triggered with the ADD optionare displayed on a LISTSCH command, even if the trigger time is past the next scantime.

Relatedinformation

For information on Events, see the ESP Workload Manager User’s Guide.

For information on defining schedule criteria for an Event, see the SCHEDULEcommand.

For information on telling ESP when an Event is expected to execute, see theEXPECT command.

For information on displaying the next scheduled executions of an Event, see theNEXT command.

Continued on next page

Page 440: ESP 5.2 Command Reference

440

LISTSCH Command, Continued

Example 1 The following is a sample of the display produced by the LISTSCH command:

LISTSCH15.00.00 PROD.PAYROLL 15.00.00 PROD.BILLING15.30.00 PROD.CLAIMS 16.00.00 USER01.TEST17.45.00 CYBER.LIFE70 19.15.00 TEST.INVENTORY20.00.00 CYBBS01.FRED 06.00.00 SCAN EVENT1

In the above, all entries on the current schedule are displayed.

Example 2 The following LISTSCH command displays Events:

LISTSCH DATE

In the above example, all Events are displayed, and the date is included in thedisplay. This is useful when you trigger Events for a time/date beyond the next scantime.

Example 3 The following LISTSCH command displays specific Events:

LISTSCH LEVEL(GROUP1.PAY-)

In the above example, Events names beginning with PAY in group GROUP1 aredisplayed.

Example 4 The following LISTSCH command displays held Events:

LISTSCH HELD(ABC)

In the above Events that are held in class ABC are displayed.

Example 5 The following LISTSCH command displays deferred Events:

LISTSCH DEFERRED(EVENT1)

In the above example, the names of Events deferred by the unavailability of theEventset with ID EVENT1 are displayed.

Example 6 The following LISTSCH command displays scheduled and expected Events betweenspecific times:

LISTSCH LEVEL(PROD) FROM(8PM) TO(11PM) NONSCHED

In the above example, scheduled and expected Events that belong to the PRODgroup, with times between 8 pm and 11 pm, are displayed.

Page 441: ESP 5.2 Command Reference

441

LISTSIG Command

Overview The LISTSIG command is used to display all generations of a signal.

Type General command.

Syntax The syntax of the LISTSIG command is:

{LISTSIG|LSIG} signalname[ALL][PENDING]

Parameter Descriptionsignalname Indicates the name of the signal. If a prefix is not specified,

the current group or user is used. Signal name may containan asterisk (*) for wildcard characters and/or a hyphen (-) formasking.

ALL Displays all information about signals. If ALL is notspecified and the signal name contains an asterisk (*) or ahyphen (-), only summary information is displayed.

PENDING Display only signals with pending Events.

Usage notes Signals cause an ESP Event to wait for a condition in addition to its schedule criteriabefore it executes. A signal may represent a manual task, such as the arrival of aninput tape, or an automated task, such as the completion of a job.

Signals are only available at the Event level. If you are using an Application andneed to set up conditions at the job level for jobs in the Application, the best methodis through tasks.

Relatedinformation

For information on signals, see the ESP Workload Manager Advanced User’s Guide.

For information on using tasks to set up conditions at the job level, see the ESPWorkload Manager User’s Guide.

For information on defining and deleting signals, see the DEFSIG and DELSIGcommands.

For information on instructing an Event to wait for the posting of a signal, see theSIGWAIT command.

For information on posting a signal, see the SIGPOST command.

For information on resetting the generation number of a signal, see the SIGCYCLEcommand.

For information on changing the generation number of a signal, see the ALTSIGcommand.

Continued on next page

Page 442: ESP 5.2 Command Reference

442

LISTSIG Command, Continued

Example 1 The following LSIG command displays information about a specific signal:

LSIG CYBER.SIGNAL99 ALL

In the above example, information about all generations of CYBER.SIGNAL99 isdisplayed.

Example 2 The following LSIG command displays information for specific signals:

LSIG CYBER-

In the above example, summary information for all signals starting with the prefixCYBER is displayed.

Example 3 The following LSIG command displays information for pending signals:

LSIG CYBER.- PENDING

In the above example, summary information for all signals starting with CYBER thathave pending Events is displayed.

Page 443: ESP 5.2 Command Reference

443

LISTSPEC Command

Overview The LISTSPEC command is used to list special days and periods.

Type General command.

Syntax The syntax of the LISTSPEC command is:

{LISTSPEC|LS} name[GROUP(groupname)][CALENDAR(calname)][FROM(fromdate)][TO(todate)][COMPRESS][RETAIN]

Parameter Descriptionname Indicates a full or generic name of a special day/period. It

may contain asterisks and a hyphen. An asterisk indicatesthat any character in that position is considered a match. Ahyphen indicates that all subsequent characters are considereda match. If this parameter is omitted, all special days/periodsare displayed. Code a hyphen ‘-’ if you are using any otherparameters and want all special days/periods displayed.

groupname Indicates special days/periods from the default calendars ofthe specified group are displayed.

calname Indicates the name of the calendar to search. This parameteris mutually exclusive with the GROUP parameter.

fromdate Indicates a start date for the special days displayed. Onlyspecial days/periods that fall on or after this date aredisplayed.

todate Indicates an ending date for the special days/periodsdisplayed. Only special days/periods on or before this dateare displayed.

COMPRESS Indicates a compact display is used. Several date and timeentries for each special day are placed on a display line ratherthan the usual one entry per line. The number of entries perline depends on the terminal screen width, or the output dataset logical record length

RETAIN Indicates the display include the length of time the specialday/period is retained (if retained).

Continued on next page

Page 444: ESP 5.2 Command Reference

444

LISTSPEC Command, Continued

Usage notes If no group name or calendar name is specified, the most recently retrieved set ofcalendars is displayed. If no calendars were retrieved in the current commandsession, the default calendars for the current group are displayed.

A start and/or end date can be specified to restrict the displayed special days/periodsto a specific time period. Special days/periods are displayed in time sequence orderwithin each calendar.

The display can be restricted to special days/periods containing a specified characterstring. The first parameter specifies a special day/period name or generic name. Ifyou want all special days/periods to be displayed but need to use another parameter,specify a hyphen (‘-’) as the first parameter.

To specify a date, use any format that ESP recognizes. If the date contains anyblanks or commas, enclose the string in quotes.

Relatedinformation

For information on specifying special days or periods in schedule criteria, see theESP Workload Manager User’s Guide.

For information on defining and deleting special days or periods, see the DEFSPECand DELSPEC commands.

Example 1 The following LISTSPEC command displays special days and periods:

LISTSPEC or LS

In the above example, all the currently defined special days and periods from themost recently retrieved set of calendars or default calendars are displayed.

Example 2 The following LISTSPEC command displays special days and periods on a specificcalendar:

LS - CALENDAR(PAYROLL)

In the example, all currently defined special days and periods on the PAYROLLcalendar are displayed.

Example 3 The following LISTSPEC command displays specific special days and periods for agiven year:

LISTSPEC P*Y- GR(PAYROLL) FROM(‘1JAN2002’) TO(‘31DEC2002’)

In the above example, all special days or periods in 2002 that begin with P and haveY in position three of the name are displayed. The calendars to be searched are thedefault calendars for the PAYROLL group.

Continued on next page

Page 445: ESP 5.2 Command Reference

445

LISTSPEC Command, Continued

Example 4 The following is an example of the display produced by the LISTSPEC command:

CALENDAR SYSTEMFISCAL_YEAR_END

00.00 ON WEDNESDAY SEPTEMBER 30TH, 1998---- 1 DATE LISTED ----

INVENTORY_DAY00.00 ON FRIDAY FEBRUARY 6TH, 199800.00 ON FRIDAY MARCH 6TH, 199800.00 ON TUESDAY APRIL 7TH, 1998---- 3 DATES LISTED ----

PAYDAY00.00 ON FRIDAY JANUARY 30TH, 199800.00 ON FRIDAY FEBRUARY 20TH, 199800.00 ON FRIDAY FEBRUARY 27TH, 1998---- 3 DATES LISTED -------- 3 SPECIAL DAYS DISPLAYED ----

In the above example, special days and periods defined on the SYSTEM calendarare displayed.

Page 446: ESP 5.2 Command Reference

446

LISTSYML Command

Overview The LISTSYML command is used to display information on the symbol libraries towhich you have access.

Type General command.

Syntax The syntax of the LISTSYML command is:

{LISTSYML|LSL} symlib

Parameter Descriptionsymlib Indicates the name of a symbol library set defined using the

DEFSYML command. It may contain asterisks and a hyphenfor generic masking.

Usage notes The information displayed includes the names of the data sets comprising thesymbol library set and user IDs or user ID masks with permitted read access to thesymbols.

Relatedinformation

For information on setting symbol libraries, see the ESP Workload Manager User’sGuide.

For information on invoking user symbolic variables, see the ESP WorkloadManager Advanced User’s Guide.

For information on defining and deleting a symbol library, see the DEFSYML andDELSYML commands.

Example 1 The following LISTSYML command displays a symbol library:

LISTSYML SYM1

In the above example, the attributes of the SYM1 symbol library are displayed.

Example 2 The following LSL command displays all symbol libraries:

LSL -

In the above example, the attributes of all symbol libraries to which you have accessare displayed.

Continued on next page

Page 447: ESP 5.2 Command Reference

447

LISTSYML Command, Continued

Example 3 The following is an example of the display produced by the LISTSYML command:

SYMLIB PAYSYM DEFINED BY USER01 AT 15.17 ON WEDNESDAYJANUARY 28TH, 2002DATASETS: ‘CYBER.SYMBOLS.CNTL(DATES)’USERS: USER01

In the above example, the attributes of the PAYSYM symbol library are displayed.

Page 448: ESP 5.2 Command Reference

448

LISTTRAK Command

Overview The LISTTRAK command is used to display information about the current status ofthe job tracking file

Type General command.

Authority OPER authority is required to issue the LISTTRAK command.

Syntax The syntax of the LISTTRAK command is:

LISTTRAK

Usage notes The information displayed by this command includes when the data set wasformatted and the current allocation status including the number of free slots.

Example 1 The following is an example of the display produced by the LISTTRAK command:

OPER LISTTRAKTRAKFILE CYB2.ESP510.TRAKFILEFORMATTED AT 17.33.37 ON MONDAY NOVEMBER 17TH, 19979896 SLOTS TOTAL, 8127 AVAILABLE, NEXT IS 6979

The above example displays information about the current status of the job trackingfile.

Page 449: ESP 5.2 Command Reference

449

LISTUSER Command

Overview The LISTUSER command is used to display a user definition. The LISTUSERcommand is available only in non-SAF environments. The information displayedincludes authority attributes, default calendars, Eventset and Histfile access, and thenames of the groups to which the user is connected.

Type General command.

Syntax The syntax of the LISTUSER command is:

{LISTUSER|LU} userid

Parameter Descriptionuserid Indicates the name of the user definition to be displayed. It

may contain asterisks and the last character can be a hyphen ifyou want to use masking. If the user ID is not specified, youruser ID definition is displayed.

Relatedinformation

For information on defining users and groups, see the ESP Workload ManagerAdministrator’s Guide.

For more information on departments, see the ESP Workload ManagerAdministrator’s Guide.

For information on using authorization tables to control access to job tracking data,see the ESP Workload Manager Administrator’s Guide.

For information on calendars, see the CALENDAR command.

For information on defining and deleting users, see the DEFUSER and DELUSERcommands.

For information on changing a user’s definition, see the ALTUSER command.

Example 1 The following LISTUSER command displays all users:

LU -

In the above example, all users are displayed.

Example 2 The following LU command displays your user definition:

LU

In the above example, your user definition is displayed.

Continued on next page

Page 450: ESP 5.2 Command Reference

450

LISTUSER Command, Continued

Example 3 The following LU command displays a specific user entry:

LU USER1

In the above example, USER1 is displayed.

Example 4 The following LISTUSER command displays multiple users:

LISTUSER PROD-

In the above example, all users whose IDs begin with PROD are displayed.

Page 451: ESP 5.2 Command Reference

451

LISTXMEZ Command

Overview The LISTXMEZ command is used to display cross memory tracking elements. Across-memory element (XME) is used to pass job and data set information betweenaddress spaces and ESP systems.

Type General command.

Authority OPER authority is required to issue the LISTXMEZ command.

Syntax The syntax of the LISTXMEZ command is:

LISTXMEZ

Example 1 The following is an example of the display produced by the LISTXMEZ command:

OPER LISTXMEZCKPT SPACE USED BY JOB TRACKING XMES 824MAX ALLOWED: NO LIMIT0 XMES FOR A TOTAL OF 0(X'00000000') BYTESQUEUE SPACE USED BY JOB TRACKING XMES 0MAX ALLOWED: 128000 (DEFAULT)0 XMES FOR A TOTAL OF 0(X'00000000') BYTES

In the above example, the cross-memory tracking elements are displayed.

Page 452: ESP 5.2 Command Reference

452

LJ Command

Overview The LJ command is used to display the status of a job being tracked by ESP.

Type General command.

Syntax The syntax of the LJ command is:

LJ jobname[ANCESTOR(genno)][ALL][STEPS][SUBMIT][PNODE][STATUS][DUEOUT][INFODATA][EXTENDED|X]

Parameter Descriptionjobname Indicates the name or JES job number of the job to be

displayed. If the ID is all numeric, it is assumed to be a jobnumber, otherwise it is treated as a jobname. A job nameand job number can be specified together, with the jobnumber enclosed in parentheses, immediately following thejob name.

genno Indicates the ancestor generation number, with zero the mostrecent job, 1 or -1 the previous job and so on. This operandis ignored whenever a job number is specified. This operanddefaults to zero if a job name is used and no generationnumber is specified.

ALL Indicates all the information for the job is displayed. This isthe same as specifying STEPS, SUBMIT, PNODE, andINFODATA. This is the default.

STEPS Indicates step statistics are to be displayed for the job.SUBMIT Indicates submission information, including JCL source data

set, Event name, data set trigger name if any, etc., isdisplayed. This information is available only if ESPsubmitted the job.

PNODE Displays the PNODE(s) for each job.STATUS Displays the current status of the job.DUEOUT Displays P-Node due out times for the job.INFODATA Displays the Information Management record number

associated with this job if one was generated using theInformation Management interface.

EXTENDED or X Displays more detailed date and time information.

Continued on next page

Page 453: ESP 5.2 Command Reference

453

LJ Command, Continued

Usage notes ESP can track the progress of all or selected jobs, even those it did not schedule.ESP provides real time information for each job step, including such information asstepname, completion code, CPU time, elapsed time, and number of tape mounts.

You can request ESP to track jobs, started tasks (STCs), TSO users (TSUs), andsystem messages. ESP must be set up to track jobs in an ESP Application.

The LJ command displays information from ESP’s tracking file (TRAKFILE). Theamount of data stored on this file depends on its size. ESP re-uses slots in theTRAKFILE as required.

Relatedinformation

For information on displaying job level information from the CSF, see the ESPWorkload Manager User’s Guide.

For information on displaying tracked jobs, see the LTJ command.

For information on job tracking, see the ESP Workload Manager Administrator’sGuide.

Example 1 The following LJ command display a job:

LJ PAYJOB1 STATUS

In the above example, the status of PAYJOB1 is displayed.

Example 2 The following LJ command displays a job by its JES job number:

LJ 1234

In the above example, a job whose JES job number is 1234 is displayed.

Example 3 The following LJ command displays a jobs Information Management record:

LJ PAYJOB2 INFODATA

In the above example, PAYJOB2’s Information Management record is displayed.

Example 4 The following LJ command displays step level statistics:

LJ PAYJOB2 STEPS

In the above example, step level statistics are displayed for PAYJOB2.

Continued on next page

Page 454: ESP 5.2 Command Reference

454

LJ Command, Continued

Example 5 The following LJ command displays the second ancestor of a job:

LJ PAYJOB3 ALL AN(2)

In the above example, the second ancestor or -2 generation of PAYJOB3 isdisplayed.

Example 6 The following is an example of the display produced by the LJ command.

LJ PAYJOB4 XPAYJOB4 J08324, IN OUTPUT QUEUE SINCE 16.01.03 28JAN, CC 0SUBMITTED BY ESP AT 16.01.03 ON WED 28JAN, EVENT CYBER.PAYROLLJCL FROM CYBER.JCL.CNTL(PAYJOB4)PROGRAMMER USR01, ACCOUNT CYB3000JOB IS IN APPL PAYROLL

STEPNAME-PROCSTEP-PROGNAME--EXCP-#T-S-N-CPU-TIME-SUNITS-REGION—CMPCS1 IEFBR14 0 0 0 0 0:00.02 168 4K0

PNODE----OUT------DATE--QTIME-POST_BY--SYS-INPUT 16.01.02 28JAN 0 SYSAEXEC 16.01.03 28JAN 1 SYSTEM SYSAOUTPUT * 10M54

In the above example, detailed date and time information is displayed for PAYJOB4using the EXTENDED or X parameter of the LJ command.

Page 455: ESP 5.2 Command Reference

455

LOAD Command

Overview The LOAD command is used to load a series of ESP commands for execution.Enter your commands into a PDS or sequential data set and issue the LOADcommand from Page mode to process these ESP commands.

Note: The LOAD command cannot be used in ESP’s Initialization Parameters.

Type General command.

Syntax The syntax of the LOAD command is:

LOAD 'dsname'

Parameter Descriptiondsname Indicates a valid data set name. The current user prefix is

added if the data set name is not enclosed within quotes. Amember name can be included within the data setspecification. The input data set can be sequential,partitioned or VSAM ESDS. All record formats aresupported.

Usage notes One use of the LOAD command is to load Event definitions from a data set. SeveralEvent definitions can be included in one data set or member.

The LOAD command is useful when you have a number of repetitious commands toexecute (e.g. setting up holidays, defining users, reporting, etc.

Continued on next page

Page 456: ESP 5.2 Command Reference

456

LOAD Command, Continued

Example 1 The following is an example of a PDS member - CYBER.ESP.DATA(CMDS)which contains ESP commands:

SMFSTATSLDSNLIST LEVEL(PROD)

To process the above ESP commands, issue the LOAD command from Page modeas follows:

LOAD ‘CYBER.ESP.DATA(CMDS)’

The following is an example of the display produced by issuing the above LOADcommand:

SMFSTATSESP SUBSYSTEM INITIALIZED AT 10.11.59 ON THURSDAY DECEMBER18TH, 19971490750 ENTRIES TO SMFWTM, 583358 BY BRANCH ENTRY AND 907392BY SVC168304 ENTRIES TO ESP PHASE 29562 JOB STARTS, 304 STC STARTS, 933 TSU STARTS, 20969 STEPENDS

LDSNCHECKPOINT: CYB2.ESP510.CKPT, ALT NONE

USERDEF: CYB2.ESP510.USERDEF, BKUP NONEINDEX: CYB2.ESP510.INDEX, BKUP NONE

JOBINDEX: CYB2.ESP510.JOBINDEX, BKUPCYB2.ESP510.BKUP.JOBINDEX

QUEUE: CYB2.ESP510.QUEUE, ALT NONETRAKFILE: CYB2.ESP510.TRAKFILEEVENTSET: CYB2.ESP510.EVENT1HISTFILE: CYB2.ESP510.HISTFILEAPPLFILE: CYB2.ESP510.APPLFILE

JTDT: CYB2.ESP510.PARMLIB(JOBDEF1)UPDT: CYB2.ESP510.PARMLIB(PROFILE)

LIST LEVEL(PROD)PROOD.PAYROLL NEXT DUE AT 20.00.00 ON THU JAN 29TH,1998PROD.BILLING NEXT DUE AT 09.00.00 ON THU JAN 29TH,1998

Page 457: ESP 5.2 Command Reference

457

LOADAGDF Command

Overview The LOADAGDF command is used to load the Agent definition file.

Type General command

Authority OPER authority is required to issue the LOADAGDF command.

Syntax The syntax of the LOADAGDF command is:

LOADAGDF dsname

Parameter Descriptiondsname Indicates a sequential data set or a member of a partitioned

data set, enclosed in quotes.TEST Indicates that all syntax and logical checks are performed, but

the table is not loaded.

Usage notes The LOADAGDF command is normally included in the ESP InitializationParameters to load the Agent definition file each time ESP initializes.

After making any changes to the Agent definition file, you can use the LOADAGDFcommand to dynamically load a new table.

Relatedinformation

For information on cross platform workload management, see the appropriate ESPWorkload Manager Extension Installation and User Guides.

Example 1 The following LOADAGDF command loads an agent definition file:

LOADAGDF ‘CYBER.PARMLIB(AGENTDEF)’

In the above example, AGENTDEF is loaded from CYBER.PARMLIB.

Example 2 The following LOADAGDF command tests an agent definition file:

LOADAGDF ‘CYBER.PARMLIB(AGENTDEF)’ TEST

In the above example, ESP performs all syntax and logical checks on this Agentdefinition file.

Page 458: ESP 5.2 Command Reference

458

LOADJTDT Command

Overview The LOADJTDT command is used to load the job tracking definition table into thesystem. ESP uses this table to determine what it needs to track.

Type General command.

Authority OPER authority is required to issue the LOADJTDT command.

Syntax The syntax of the LOADJTDT command is:

LOADJTDT dsname

Parameter Descriptiondsname Name of sequential data set or PDS member containing the

job tracking definition table.

Usage notes Normally the job tracking table is loaded when ESP initializes.

You can replace the currently active job tracking definition table with a new table atany time by reissuing the LOADJTDT command with the data set name thatcontains the new table.

If more than one copy of ESP uses the same job tracking definition table, you needto issue the LOADJTDT command for each ESP system.

The job tracking definition table is used for any job that ESP encounters andoverrides any other tracking definitions.

The job tracking definition table overrides any other tracking definitions in thesystem, such as those defined with the DEFTJ command.

Relatedinformation

For information on job tracking definition tables, see the ESP Workload ManagerAdministrator’s Guide.

For information on tracking definition entries in a job tracking definition table, seethe TRACKDEF statement.

For information on defining wildcard characters used in a job tracking definitiontable, see the WILDCARD statement.

Continued on next page

Page 459: ESP 5.2 Command Reference

459

LOADJTDT Command, Continued

Example 1 The following LOADJTDT command loads a job tracking definition table:

OPER LOADJTDT ‘CYBER.PARMLIB(JOBDEF1)’

In the above example, JOBDEF1 is loaded from CYBER.PARMLIB.

Page 460: ESP 5.2 Command Reference

460

LOADSCHF Command

Overview The LOADSCHF command is used to copy schedule information from a sequentialworkfile to a VSAM file that can be viewed from the CSF.

Type General command

Authority OPER authority is required to issue the LOADSCHF command.

Syntax The syntax of the LOADSCHF command is:

LOADSCHF

Usage notes The LOADSCHF command allows you to see future, scheduled workload from theCSF. This is not a common practice.

The LOADSCHF command loads the schedule workfile into core and copies it intothe VSAM schedule file, both of which are identified by the SCHDFILEInitialization Parameter. The schedule workfile must be a scheduled activity dataset. Information contained in the workfile is merged with old information.

The file must be “seeded” with Events that are scheduled to execute by theSADGEN command, in a batch job, prior to loading.

Relatedinformation

For information on the CSF, see the ESP Workload Manager User’s Guide.

For information on purging information from the SCHDFILE, see the PURGSCHFcommand.

For information on generating a scheduled activity data set, see the SADGENcommand.

Example 1 The following LOADSCHF command loads schedule information:

OPER LOADSCHF

In the above example, schedule information is loaded from a sequential workfile to aVSAM file so that it can be viewed from the CSF.

Page 461: ESP 5.2 Command Reference

461

LOADUPDT Command

Overview The LOADUPDT command is used to load the User Profile Definition Table from adata set. The User Profile Definition Table contains one or more PROFILEstatements. User Profile Definition Tables are required only if the SAF interface isbeing used.

Type General command.

Authority OPER authority is required to issue the LOADUPDT command.

Syntax The syntax of the LOADUPDT command is:

LOADUPDT dsname

Parameter Descriptiondsname Indicates the fully qualified data set name, and can include a

member name. The data set can be any fixed or variablelength file with a record length of 80 or greater.

Usage notes You can issue the command in the ESP initialization data set, or once ESP is activeyou can issue the command from your console. Once you have loaded the table, ESPrefers to the table, not to the data set. ESP always refers to the currently loadedtable.

The User Profile Definition Tables needs to be loaded after making changes.

If you are running more than one ESP system, you need to load the User ProfileDefinition Table on each system.

Relatedinformation

For information on identifying the Event prefix and the EVENTSET that ESP usesto store the Event, see the PROFILE statement.

For information on using SAF, see the ESP Workload Manager Administrator’sGuide.

Example 1 The following LOADUPDT command load the User Profile Definition Table:

LOADUPDT CYBER.PARMLIB(PROFILE)

In the above example, PROFILE is loaded from CYBER.PARMLIB.

Page 462: ESP 5.2 Command Reference

462

LOGPRT Command

Overview The LOGPRT command is used to display Event log data collected in the trace dataset(s) during a specified time period.

Type General command.

Authority SPECIAL authority is required to issue the LOGPRT command in a non-SAFenvironment.

Syntax The syntax of the LOGPRT command is:

LOGPRT DSN(dsname[,dsname]...)[FROM(schedule)]

Parameter Descriptiondsname Indicates the name(s) of the trace data set(s) to access for

Event log information. Separate data set names with acomma.

schedule Indicates schedule criteria. The keyword ‘UNTIL’ can beused to restrict the time range. If UNTIL is not used, thecurrent time is used as the end time.

Usage notes This command is not normally used, as the same information is stored in ESP’s auditlog. Immediately before using the LOGPRT command, issue the ‘TRACE WRITE’,‘TRACE CLOSE’ and ‘TRACE OPEN’ operator commands to ensure that theLOGPRT command accesses all current trace data. Trace data set information isdisplayed via the ‘TRACE STATUS’ operator command.

Relatedinformation

For information on printing a trace data set, see the TRACEPRT command.

Example 1 The following LOGPRT command displays logged information:

LOGPRT DSN(‘CYB.ESP.TRACE1’) FROM(‘6PM YESTERDAY -UNTIL 5AM TODAY’)

In the above example, information logged between 6 pm the previous day and 5 amthis morning in CYB.ESP.TRACE1 data set is displayed.

Page 463: ESP 5.2 Command Reference

463

LSAR Command

Overview The LSAR command is used to extract data from a scheduled activity data set toproduce a standard scheduled activity report.

Type General command.

Syntax The syntax of the LSAR command is:

LSAR DSN(dsname)[JOB(jobname[,jobname]...)][GROUP(groupname)][NET(netid)][APPL(application)][JCL(jcldsn)][FROM(schedule)][TO(schedule)][TIMESEQ][STATUS][TAPEPULL(tapeds)][PROJECTED]

Parameter Descriptiondsname Indicates the name of the scheduled activity data set that

contains scheduled activity information, enclosed in quotes.

Note: The scheduled activity data set is generated using theSADGEN command.

jobname Indicates the name of the job(s) for which you want to displaya scheduled activity report. The use of asterisks and a hyphenfor masking is permitted to select a group of jobnames. If thisparameter is omitted, then data on all scheduled jobs isgenerated.

groupname Indicates an ESP group name prefix for which you want togenerate a scheduled activity report. The use of asterisks anda hyphen for masking is permitted.

netid Indicates the identifier for an ESP/DJC or JES3 job network.The use of asterisks and a hyphen for masking is permitted.

application Indicates the name of an Application for which you want todisplay a scheduled activity report. The use of asterisks and ahyphen for masking is permitted.

jcldsn Indicates the name of a JCL data set. It cannot be enclosed inquotes. Only jobs whose JCL that resides in this data set areincluded in the scheduled activity report.

Continued on next page

Page 464: ESP 5.2 Command Reference

464

LSAR Command, Continued

Syntax (continued)

Parameter Descriptionschedule Indicates a valid schedule statement. If the statement

contains separators then it must be enclosed in quotes. Thekeywords ‘ENDING’ or ‘UNTIL’ can be used to restrict thetime range selected.

TIMESEQ Indicates the display of scheduled activity should be sorted inascending time sequence according to the schedule time forthe job. If this keyword is omitted, the display is sorted inalphabetical sequence by jobname. If more than oneoccurrence of a job is scheduled, the jobnames are sorted bytime sequence within a jobname category.

STATUS Indicates an updated status display is required instead of theregular schedule display. This gives the status of all the jobsin the schedule, as well as time and percentage of schedulestill remaining. Actual start and end times, completion codeand rerun indicators are also displayed. This can only be usedafter the SADUPD command has generated updatedinformation.

tapeds Indicates the name of a preallocated PDS used to store tapedata set information. A member is created for each job,which can then be used as input to the TMS or CA1, tapepullprogram. This parameter is used in conjunction with theINPUTDS Application statement.

PROJECTED Creates a Projected vs. Actual report. This report showsprojected start/end times based on MODEL processing andactual start/end times. Prior to running this report, a modelmust be run to update the projected times in the SAD file, andthe SADUPD command must be used to update the SAD filewith actual run information.

Continued on next page

Page 465: ESP 5.2 Command Reference

465

LSAR Command, Continued

Usage notes Since the LSAR command uses information from a scheduled activity data set, youcan only display information that was written to that data set using the SADGENcommand.

If you do not use the ‘FROM’ keyword, the starting time for the scheduled activityreport defaults to NOW. If you do not use either ‘ENDING’ or ‘UNTIL’ with theFROM keyword, and you do not specify ‘TO’, then the scheduled activity reportcontains all data stored in the scheduled activity data set as generated by theSADGEN command.

You may only generate a scheduled activity report on a group to which you haveaccess. If you want a report on all scheduled jobs, then you do not need to use anyof these selection keywords. Use the STATUS keyword to obtain a scheduledversus actual report (i.e. after the SADUPD command) or use the TAPEPULLkeyword if you are using the tapepull facility.

The DSN parameter must be the first parameter after the LSAR command.

To produce scheduled activity reports online, use option S - Schedule Activity fromthe ESP Main Menu.

Relatedinformation

For information on scheduled activity reporting, see the ESP Workload ManagerUser’s Guide.

For information on modeling, see the ESP Workload Manager Advanced User’sGuide.

For information on generating scheduled activity data set, see the SADGENcommand.

For information on updating a scheduled activity data set with actual information,see the SADUPD command.

Example 1 The following is an example of JCL that could be used to produce a scheduleactivity report:

//jobname JOB …//STEP1 EXEC PGM=ESP,PARM='SUBSYS(E510)'//STEPLIB DD DSN=CYB2.ESP510Q.SSCPLINK,DISP=SHR//SYSPRINT DD SYSOUT=*//SYSIN DD *LSAR DSN('CYBER.SAD')/*

In the above example, the LSAR command is run in batch to produce a scheduledactivity report.

Note: Before running this job, ensure the scheduled activity data set containsschedule activity information. To generate a scheduled activity data set, use theSADGEN command in batch only. You may combine the SADGEN and LSARcommands in the same job by running a step for each command.

Continued on next page

Page 466: ESP 5.2 Command Reference

466

LSAR Command, Continued

Example 2 The following LSAR command produces a scheduled activity report:

LSAR DSN(‘CYBER.SAD’) JOB(PAY-) -FROM(‘8PM TODAY UNTIL 8AM TOMORROW’) TIMESEQ

In the above example, a report is produced on activity scheduled in the 12-hourperiod starting at 8 pm tonight using the CYBER.SAD scheduled activity data set.The display is restricted to jobnames beginning with the characters PAY, and ispresented in scheduled time sequence.

Example 3 The following LSAR command produces a scheduled activity report:

LSAR DSN(‘CYBER.SAD’) TO(‘2:30AM TOMORROW’)

In the above example, scheduled activity information on all jobs scheduled forsubmission from NOW until 2:30 am tomorrow morning is produced. The display ispresented in jobname sequence, by default. Data is extracted from the CYBER.SADdata set.

Example 4 The following LSAR command produces a scheduled activity report:

LSAR DSN(‘CYBER.SAD’) STATUS

In the above example, a status display of scheduled activity information as stored inthe CYBER.SAD scheduled activity data set is produced. This data set must havebeen updated using the SADUPD command.

Example 5 The following LSAR command produces a report showing each job’s projected andactual start and end times:

LSAR DSN(‘CYBER.SAD’) PROJECTED

In the above example, a Projected vs. Actual report is produced using informationstored in the CYBER.SAD scheduled data set.

Example 6 The following LSAR command produces a scheduled activity report:

LSAR DSN(‘CYBER.SAD’) APPL(PAYROLL)

In the above example, a status display on scheduled activity information for thePAYROLL Application is produced.

Continued on next page

Page 467: ESP 5.2 Command Reference

467

LSAR Command, Continued

Example 7 The following LSAR command produces a scheduled activity report:

LSAR DSN(‘CYBER.SAD’) JCL(PROD.BACKUP.JCL)

In the above example, a status display on scheduled activity information for jobsresiding in PROD.BACKUP.JCL is produced.

Page 468: ESP 5.2 Command Reference

468

LSYS Command

Overview The LSYS command is used to display information about the current ESP systemand can optionally provide information about other systems sharing the sameQUEUE data set.

Type General command.

Authority OPER authority is required to issue the LSYS command.

Syntax The syntax of the LSYS command is:

LSYS [sysid]

Parameter Descriptionsysid Indicates the ESP system identifier you want to display

information about. The ESP system identifier is specifiedusing the SYSID Initialization Parameter. This field cancontain asterisks and a hyphen. If this field is omitted,information about the current system is displayed.

Usage notes The type of information this command displays includes the CPU model, CPUserial, the system ID on which ESP is running, the checkpoint data set name, and thetime of the last access to the QUEUE data set.

Relatedinformation

For information on defining ESP data sets, see the ESP Workload ManagerInstallation Guide.

Example 1 The following is an example of the display produced by the LSYS command.

OPER LSYSSYS: E510, SMF ID SYSA, CPU SERIAL 003655, MODEL 9672

LAST QUEUE ACCESS AT 21.42.32 ON THURSDAY JANUARY 29TH,1998

CHECKPOINT DATASET CYB2.ESP510.CKPT

In the above example, information about the current ESP system is displayed

Example 2 The following LSYS command displays an ESP system:

LSYS E510

In the above example, information about the E510 system is displayed

Continued on next page

Page 469: ESP 5.2 Command Reference

469

LSYS Command, Continued

Example 3 The following LSYS command displays specific ESP systems:

LSYS ESP-

In the above example, information about ESP systems with ESP in the first threepositions is displayed

Page 470: ESP 5.2 Command Reference

470

LSYSMSGS Command

Overview The LSYSMSGS command displays information on all the system messages that arecurrently being intercepted by ESP.

Type General command.

Authority OPER authority is required to issue the LSYSMSGS command.

Syntax The syntax of the LSYSMSGS command is:

LSYSMSGS

Relatedinformation

For information on intercepting system messages written to the system message dataset, see the SYSMSGS command.

For information on clearing system messages, see the CLRSYSMS command.

Example 1 The following is an example of the display produced by the LSYSMSGS command:

OPER LSYSMSGS'IEF142I' ID(0001), NAME(PAYJOB1), EVENT(CYBER.PAYSTEP)'NOT CATLGD' ID(0002), COL(50:60), WTO, JOBNAME, CANCEL'IEF253I' ID(0010), DESC(2), NAME(A-), EVENT(CYBER.CAN),CANCEL

In the above example, information on all the system messages intercepted by ESP isdisplayed.

Page 471: ESP 5.2 Command Reference

471

LTCELL Command

Overview The LTCELL command is used to display tracking cell (TCELL) information,including the size and current usage of each cell.

Type General command.

Syntax The syntax of the LTCELL command is:

LTCELL

Usage notes TCELLs are required to pass job start, step end, job end and job purge informationto the ESP subsystem.

Relatedinformation

For information on defining tracking storage cells, see the TCELL InitializationParameter in the ESP Workload Manager Installation Guide.

Example 1 The following is an example of the display produced by the LTCELL command.

CELSIZE-POOLSZ-MAXSIZE-CURRUSE-MAXUSED-GETMAINS-OVERFLOW104 100 5100 0 63 0 0160 100 5100 0 28 0 0168 100 5100 0 31 0 0

In the above example, tracking cell information is displayed

Page 472: ESP 5.2 Command Reference

472

LTJ Command

Overview The LTJ command is used to display the definition for a tracked job or group oftracked jobs as stored in the job index file.

Type General command

Syntax The syntax of the LTJ command is:

LTJ jobname[PREFIX][OWNER(ownerid)][MODEL(modelname)][INDEX]

Parameter Descriptionjobname Indicates the name of the job or jobs to be displayed. The job

name specification can contain asterisks and a hyphen so youcan select groups of jobs through masking.

PREFIX Indicates the prefix entries are displayed rather than jobdefinitions. This is not applicable if you are using jobtracking definition tables.

ownerid Displays only jobs with ownership strings equal to orsuperseding the specified ownership string. It consists of upto eight alphanumeric characters and can contain asterisksand a hyphen. This is not applicable if you are using jobtracking definition tables.

modelname Displays only jobs having a matching track model name. Themodel name can consist of up to eight alphanumericcharacters, including asterisks or a hyphen.

INDEX Indicates a display of the index for the job is generated. Thejob number, submission date and time, current status andcompletion code of each indexed job is listed.

Usage notes The LTJ command displays the tracking characteristics of a job, as defined in thejob tracking definition table or through the DEFTJ command, rather than thetracking data on a particular submission of a job.

Relatedinformation

For information on displaying job level information from the CSF, see the ESPWorkload Manager User’s Guide.

For information on displaying the status of a job being tracked by ESP, see the LJcommand.

Continued on next page

Page 473: ESP 5.2 Command Reference

473

LTJ Command, Continued

Example 1 The following LTJ command displays tracking status:

LTJ PAYJOB1

In the above example, the tracking status of PAYJOB1 is displayed.

Example 2 The following LTJ command displays all jobs using specific tracking models:

LTJ - MODEL(PROD-)

In the above example, all jobs using tracking models with names beginning withPROD are displayed.

Example 3 The following LTJ command displays index information for a specific job:

LTJ PAYJOB1 INDEX

In the above example, the job index information for the job PAYJOB1 is displayed.The last n submissions of the job are displayed, where n is limited by the indexcount, which was already defined for the job.

Example 4 The following is an example of the display produced by the LTJ command with theINDEX parameter specified:

LTJ PAYJOB1 INDEXJOB PAYJOB1, MODEL MODEL1, OWNER NONE, 10 JOBS INDEXED, 10 MAXJ08720 ON RDR AT 20.00 THU 29JAN98, ENDED, CC 0, 0.0 MINS_EXEC, 0:00 CPUJ08719 ON RDR AT 20.00 THU 29JAN98, ENDED, CC 0, 0.0 MINS_EXEC, 0:00 CPUJ08717 ON RDR AT 20.00 THU 29JAN98, ENDED, CC 0, 0.0 MINS_EXEC, 0:00 CPUJ08673 ON RDR AT 18.00 THU 29JAN98, ENDED, CC 0, 0.0 MINS_EXEC, 0:00 CPUJ08630 ON RDR AT 16.01 THU 29JAN98, ENDED, CC S806, 0.0 MINS_EXEC, 0:00 CPUJ08474 ON RDR AT 08.00 THU 29JAN98, ENDED, CC 0, 0.0 MINS_EXEC, 0:00 CPUJ08414 ON RDR AT 20.00 WED 28JAN98, ENDED, CC 0, 0.0 MINS_EXEC, 0:00 CPUJ08408 ON RDR AT 20.00 WED 28JAN98, ENDED, CC 0, 0.0 MINS_EXEC, 0:00 CPUJ08365 ON RDR AT 18.00 WED 28JAN98, ENDED, CC 0, 0.0 MINS_EXEC, 0:00 CPUJ08364 ON RDR AT 18.00 WED 28JAN98, ENDED, CC 0, 0.0 MINS_EXEC, 0:00 CPU

In the above example, a display of the index for PAYJOB1 is generated.

Page 474: ESP 5.2 Command Reference

474

LTM Command

Overview The LTM command is used to display the definition of one or more tracking models.

Type General command.

Syntax The syntax of the LTM command is:

LTM name

Parameter Descriptionname Indicates the name of the tracking model to be displayed. It

can contain asterisks and a hyphen to select multiplematching entries.

Usage notes The DEFTM command allows you to centralize the definition of trackingcharacteristics that can be assigned to one job, or a group of jobs. Jobs are normallyassociated with a tracking model via a job tracking definition table.

Any data defined through the DEFTM command is displayed. The fieldNOPRINTDATA of the display is reserved for future use.

Relatedinformation

For information on defining/altering and deleting a tracking model, see the DEFTMand DELTM commands.

For information on job tracking definition tables, see the ESP Workload ManagerAdministrator’s Guide.

Example 1 The following LTM command displays a tracking model:

LTM MODEL1

In the above example, the definition for the MODEL1 tracking model is displayed.

Example 2 The following LTM command displays all tracking models:

LTM -

In the above example, all tracking models are displayed.

Page 475: ESP 5.2 Command Reference

475

LTZONE Command

Overview The LTZONE command is used to display the current time zone settings.

Type General command.

Syntax The syntax of the LTZONE command is:

LTZONE

Relatedinformation

For information on defining ESP data sets, see the ESP Workload ManagerInstallation Guide.

For information on defining time zones, see the TIMEZONE Initialization Parameterin the ESP Workload Manager Installation Guide.

Example 1 The following is an example of the display produced by the LTZONE command.

LTZONECODE--ZONE------OFFSET ! CODE--ZONE------OFFSET ! CODE--ZONE------OFFSET

0 LOCAL 5.00W ! 1 UTC 0.00E ! 2 GMT 0.00E3 Z 0.00E ! 5 EST 5.00W ! 6 CST 6.00W7 MST 7.00W ! 8 PST 8.00W ! 9 AST 4.00W10 EDT 4.00W ! 11 CDT 5.00W ! 12 MDT 6.00W13 PDT 7.00W ! 14 ADT 3.00W ! 16 EASTERN 5.00W17 CENTRAL 6.00W ! 18 MOUNTAIN 7.00W ! 19 PACIFIC 8.00W20 ATLANTIC 4.00W ! 21 NFNDLAND 3.30W

In the above example, the current time zone settings are displayed

Page 476: ESP 5.2 Command Reference

476

MAPGEN Command

Overview The MAPGEN command is used to create a job mapping data set that can then beused by the JOBMAP and JOBTREE commands to produce detailed job levelinformation.

Type Reporting command.

Syntax The syntax of the MAPGEN command is:

MAPGEN DATASET(dsname)EVENT(name)

Parameter DescriptionDATASET(dsname) Indicates a fully qualified data set name. This data set

must be sequential, preallocated and should specify thefollowing DCB attributes:

• RECFM=VBS• LRECL=32756• BLKSIZE=16384• BLKSIZE=27998 - for 3390 devices

EVENT(name) Indicates an Event descriptive name (without the prefix)and may contain wildcards. Does not work with the Eventowner as the descriptive name.

Usage notes The MAPGEN command is available only as a batch job step.

Events may be scheduled or may require manual or data set triggers. There is noneed for these events to have been executed previously as history data is notrequired for the jobs. If history data is available, this historical information isincorporated into the job mapping report.

Relatedinformation

For information on producing a job map report, see the JOBMAP command.

For information on producing a job descendent tree report, see the JOBTREEcommand.

Continued on next page

Page 477: ESP 5.2 Command Reference

477

MAPGEN Command, Continued

Example 1 The following is an example of a batch job to create a job mapping data set:

//jobname JOB ...//STEP1 EXEC PGM=IEFBR14//MAPGEN DD DSN=MY.MAPGEN,DISP=(,CATLG),// UNIT=SYSDA,SPACE=(TRK,(40,20)),//DCB=(DSORG=PS,RECFM=VBS,LRECL=32756,BLKSIZE=16384)//STEP2 EXEC ESP,PARM='SAR'//SYSPRINT DD SYSOUT=A//SYSIN DD *MAPGEN DATASET('CYBER.MAPGEN') EVENT(PAY-)/*

In the above example, a job mapping data set for all jobs invoked by Events whosedescriptive name begins with ‘PAY’ is generated.

Note: The MAPGEN command must be executed through the ESP subsystemstarted task Procedure with a special parm (PARM=‘SAR’ or PARM=‘SAD’).

Other examples Here are more examples using the MAPGEN command.

Generates a job mapping data set for all jobs :

MAPGEN DATASET(‘CYBER.MAPGEN’) EVENT(-)

Generates a job mapping data set for all jobs invoked by an Event with a descriptivename of PAYROLL:

MAPGEN DATASET(‘CYBER.MAPGEN’) EVENT(PAYROLL)

Page 478: ESP 5.2 Command Reference

478

MAPUSER Command

Overview The MAPUSER command is used to map a non-SAF user ID to a valid SAF user IDin the Agent Definition File. It is part of the encrypted message read by the ESPManager for authentication purposes.

MAPUSER can also be used as an OPER command in ESP to show the currentmapping status.

Type General command.

Authority OPER authority is required to issue the MAPUSER command.

Syntax The syntax of the MAPUSER command is:

MAPUSER user TO(central manager userid) AGENT(agentname)

Parameter Descriptionuser Indicates the server user ID to be mapped. The user parameter

is case sensitive and supports wildcards. It has a maximumlength of 32 alpha/numeric characters.

central manageruserid

Indicates the SAF user ID the user/agentname combinationshould map to.

agentname Indicates the name of the Agent the user ID came from.

Example In the following example, the Manager is instructed to use CYBJD01 for securitychecks when it sees the user ID jdoe, from Agent hp_toronto.

MAPUSER jdoe TO(CYBJD01) AGENT(hp_toronto)

This is an example of the display the command OPER MAPUSER will produce.The attributes of the MAPUSER command are defined in the AGENTDEF file.

Page 479: ESP 5.2 Command Reference

479

MAXINITS Command

Overview The MAXINITS command is used to define the maximum number of initiatorsavailable on all systems in your model process. The MAXINITS command is one ofthe components involved in defining your environment to produce modeling reportswhich forecast how ESP processes groups of jobs in your particular environment.

Type Model command.

Syntax The syntax of the MAXINITS command is:

MAXINITS initnum[SERVERS(servernum)]

Parameter Descriptioninitnum Indicates the maximum number of initiators available on all

CPUs. Up to 999 initiators may be specified.servernum Indicates the maximum number of dummy initiators in the

range 1-99 to service ESP links and tasks. If not specified,the default is 20. The SERVERS keyword should not be usedunless required.

Usage notes Use the MAXINITS command to define the maximum number of initiators for themodel. This should include initiators across all CPUs. A maximum of 999 initiatorscan exist for each model.

All initiators specified by the MAXINITS command is defined to the MODELprocessor in the “drained” state. Each initiator must be started by the INITcommand as required.

Use INIT START, SET and STOP to start, alter and drain initiators any time duringthe model process.

Server initiators are transparent to the user. They are internal initiators used toschedule ESP links and tasks. By default, there are 20 of these initiators available atany one time.

There is no need to specify the SERVERS keyword unless your installationschedules a large number of manual task or link jobs at the same time. Becausethese are ‘dummy’ jobs requiring no system resources, they can be scheduled assoon as their predecessors complete. An increase in the number of server initiatorsallows more of these dummy jobs to be scheduled at the same time, increasingthroughput.

Relatedinformation

For information on how ESP processes workload in your environment, seeAdvanced Forecasting in the ESP Workload Manager Advanced User’s Guide.

Continued on next page

Page 480: ESP 5.2 Command Reference

480

MAXINITS Command, Continued

Example 1 The following MAXINITS and INIT commands define initiators to be used during amodel process:

MAXINITS 20INIT START(1:10) CLASS(A,B,C)INIT START(11:15) CLASS(D,E)INIT START(16:20) CLASS(F)

In the above example:

• The maximum number of initiators available during the model process is 20• Initiators 1 to 10 are started and set to classes A, B and C• Initiators 11 to 15 are started and set to class D and E• Initiators 16 to 20 are started and set to class F.

Note: Any time during the model process you can manipulate initiators similar tothe way initiators are manipulated in your environment using the START, SET andSTOP parameters of the INIT command. For example, if required, initiators 16 to20 can be drained by issuing the following command:

INIT STOP(16:20)

Example 2 The following MAXINITS command defines initiators to be used during a modelprocess:

MAXINITS 100 SERVERS(50)

In the above example, 100 initiators are available during the model process toschedule regular jobs; 50 server initiators are available to schedule ESP links andtasks.

Page 481: ESP 5.2 Command Reference

481

MEMBER Statement

Overview The MEMBER statement is used to specify the member name where ESP finds ajob’s execution JCL. The default member name is equal to the job name.

Type ESP Application statement.

Syntax The syntax of the MEMBER statement is:

MEMBER membername

Parameter Descriptionmembername Indicates a member name in up to eight characters.

Usage notes When ESP encounters a JOB statement for a job, it uses the JCL member in theJCLLIB with the same name as the job. Use the MEMBER statement to overridethis action.

The name on the JOB statement must match the job name on the job card in the JCLmember.

Relatedinformation

For information on identifying a JCL library, see the JCLLIB statement.

For information on specifying an optional JCL library for an individual job, see theDATASET statement.

Example 1 The following MEMBER statement specifies the member name where ESP finds ajob’s execution JCL

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

MEMBER PAYJOB99RUN WORKDAYS

ENDJOB

In the above example, ESP submits PAYJOB1’s execution JCL from memberPAYJOB99.

Continued on next page

Page 482: ESP 5.2 Command Reference

482

MEMBER Statement, Continued

Example 2 The following JCLLIB, MEMBER and DATASET statements are used to specifydifferent JCL libraries and members:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB2

RUN DAILYREL PAYJOB3MEMBER PAYJOB99

JOB PAYJOB3RUN DAILYDATASET ‘CYBER.ALTJCL.CNTL’

ENDJOB

In the above example:

• ESP uses the default JCL library CYBER .JCL.CNTL to submit PAYJOB2’sexecution JCL from member PAYJOB99

• ESP uses CYBER.ALTJCL.CNTL to submit PAYJOB3’s execution JCL.

Example 3 The following JCLLIB, MEMBER and DATASET statements are used to specifydifferent JCL libraries and members:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB4

RUN DAILYREL PAYJOB5MEMBER BACKUP

JOB PAYJOB5RUN DAILYREL PAYJOB6DATASET ‘CYBER.ALTJCL.CNTL’

JOB PAYJOB6RUN DAILYDATASET ‘CYBER.ALTJCL.CNTL’MEMBER BACKUP

ENDJOB

In the above example:

• ESP uses the default library of CYBER.JCL.CNTL to submit PAYJOB4’sexecution JCL from member BACKUP

• ESP uses library CYBER.ALTJCL.CNTL to submit PAYJOB5’s execution JCL• ESP uses library CYBER.ALTJCL.CNTL to submit PAYJOB6’s execution JCL

from member BACKUP.

Page 483: ESP 5.2 Command Reference

483

MGRADDR Command

Overview The MGRADDR command is used to notify one or more Agents of the ESPManager’s address (host name or TCP/IP address), so the Agent knows to whichAgent receiver to connect.

Authority OPER authority is required to issue the MGRADDR command.

Syntax The syntax of the MGRADDR command is:

MGRADDR {AGENT}{AGENT(agents)}{AGENT(agents) PORT(port)}{DISPLAY}{HELP}{LIST}

Parameter DescriptionAGENT Used to send notification to all Agents.(agents) Indicates the unique name of the Agent, as defined in the

AGENTDEF file. You can specify the ‘-’ wildcard suffix.(port) Used to tell an Agent to which Agent receiver port number to

connect.DISPLAY Displays the local ESP Manager’s address and home TCP/IP

address. (They are the same if “MANAGER TCP/IP” isspecified in the AGENTDEF file).

HELP Displays MGRADDR command options.LIST Displays the local ESP Manager’s address and home TCP/IP

address. (They are the same if “MANAGER TCP/IP” isspecified in the AGENTDEF file).

Usage notes The MGRADDR command is useful if the ESP Master is stopped on one system andstarted on another because the TCP/IP address changes.

Continued on next page

Page 484: ESP 5.2 Command Reference

484

MGRADDR Command, Continued

Examples ofAgentnotification

To send Manager address notification to all Agents, enter the following:

MGRADDR AGENTorMGRADDR AGENT(-)

To send Manager address notification to Agents with name prefix “CYB”, enter thefollowing:

MGRADDR AGENT(CYB-)

To send Manager address notification to Agent CYBAIX, and to tell it to connect toAgent receiver TCP/IP port 5451, enter the following

MGRADDR AGENT(CYBAIX) PORT(5451)

Displaying themanageraddress

To display the local ESP Manager’s address and home TCP/IP address, enter one ofthe following:

• MGRADDR

• MGRADDR DISPLAY

• MGRADDR LIST

Page 485: ESP 5.2 Command Reference

485

MGRMSG Command

Overview The MGRMSG command is used to request actions to be performed, by theManager, on workload objects, and report object state changes.

Type Automation Framework Message used from an ESP Procedure, or page mode andline mode.

Authority MGRMSG checks to see if the user has appropriate access (READ or UPDATE) toan Application before performing the requested action.

Syntax The syntax of the MGRMSG command is:

MGRMSG (date|.|*} {time|.} {to|.} {from|.} re verbverbmodifier

Parameter Descriptiondate Indicates the date the message is sent. The format of the date

is YYYYMMDD. If omitted, a period(.) or asterisk(*) shouldbe used as a placeholder. An asterisk is interpreted as thecurrent date and time, and will cause the next field to beignored.

time Indicates the time the message is sent. If omitted, a period(.)should be used as a placeholder. The format of the time isHHMM[SS[TH]][{+|-}hhmm]. Where HH is the current hourin 24-hour format, MM is minutes into the hour, SS and THare seconds and hundredths of seconds. The time mayimmediately be followed by a time zone. A time zone isspecified with a ‘-’ indicating a time zone EAST of the PrimeMeridian, and ‘+’ indicates a time zone that is WEST.

to Indicates the network address of the destination, as seen fromthe sender.

from Indicates the address of the sender.re Indicates the name of the object to which this message refers.

In the case of ESP Applications, the object name is in theform, oooo[.qqqq]/aaaaa.ggggg/fffff. Where oooo is theobject name, qqqq is the optional qualifier, aaaaa is theApplication name, ggggg is the generation number of theApplication and fffff is the appl file name. Currently, there isonly one appl file, and its name is MAIN. This field uniquelyidentifies this object across the entire system managementscope.

Continued on next page

Page 486: ESP 5.2 Command Reference

486

MGRMSG Command, Continued

Syntaxcontinued

Parameter Descriptionverb Indicates the intent of the message. Verbs define large areas

of action, for example, ACTION, STATE and RESPONSE.See the table below for descriptions of verbs.

verbmodifier Indicates a modifier for the verb. If omitted, a period(.)should be used as a placeholder.

Examples The following are examples of Automation Framework messages:

19941102 102322-0500 AIX01 APPLMGR@PROD UJ1/AIXAPPL01.1/MAINRUN . Data(…

19941102 1023 APPLMGR@PROD AIX01 UJ1/AIXAPPL01.1/MAIN STATEComplete CMPC(0)

Verbs The ESP Application Manager accepts messages with the following verbs:

Verb DescriptionACTION Requests some action be applied to a workload object, such

as Hold or Release. The verb modifier indicates the actualaction.

STATE Indicates a change of state for the object. The new objectstate is supplied in the verb modifier field.

RESPONSE Indicates a response is being made for a request sent to anagent. It does not indicate a change of state for the object.

ACTION verbmodifiers

The following verb modifiers can be used with the ACTION verb:

Verb modifier DescriptionBYPASS Turns on the BYPASS indicator for the object.DROPDEP Drops some or all predecessor dependencies for the object.

Variable data consists of the keyword Pred, followed by a listof object names in parentheses. Blanks or commas can separateobject names. If this keyword is omitted, all dependencies willbe dropped.

DROPRES Drops some or all resources. Variable data consists of thekeyword Resource, followed by a list of resource names inparentheses. Blanks or commas can separate resource names. Ifthis keyword is omitted, all resource requirements will bedropped.

HOLD Turns on the HOLD flag for the object.

Continued on next page

Page 487: ESP 5.2 Command Reference

487

MGRMSG Command, Continued

ACTION verbmodifierscontinued

Verb modifier DescriptionINSERT Causes a new workload object to be inserted into the

application. For a description of the variable keywordsavailable, see below.

READY Requests the object be immediately placed in the READY state.Any dependencies, hold states or delay submit times aredropped.

RELEASE Indicates the object can have the HOLD attribute removed. Thismay cause a change of state for the object.

REQUEST Turns on the REQUESTED indicator of an object.RESET Requests one or more of the objects properties be modified. For

a description of the variable keywords available, see below.RESUB Request the object be scheduled for re-execution. For a

description of the variable keywords available, see below.UNBYPASS Turns off the BYPASS indicator of an object.UNREQUEST Turns off the REQUESTED indicator of an object.UNWAIT Removes the ancestor wait attribute of the object.UPDATESCBD Causes the Update_SCBE method of the object to be invoked.

Variable data is object implementation defined.

Examples The following are examples of ACTION verb modifiers. Note the fields in themessage are case sensitive. The Manager converts the object name and verb touppercase, but all other fields are left in their original case.

MGRMSG * . applmgr aix01 JOB2/APPL1.5/MAIN ACTION HOLDMGRMSG * . applmgr aix01 JOB2/APPL1.5/MAIN ACTION RESUBMGRMSG * . applmgr aix01 JOB2/APPL1.5/MAIN ACTION DROPDEP -Pred(JOB2)

INSERT andRESET actions

The following is a description of the variable keywords available with the INSERTand RESET actions. Keywords marked with an asterisk and underlined are ignoredwith a RESET request.

Keyword DescriptionAbandonDependency() Time/Date when dependencies are to be dropped.AbandonSubmission() Time/Date when submission of the object to execution is

to be abandoned.Appl*() Specifies the name of an application for an external object.Authstr*() Specifies the authorization string that is associated with an

external object.AverageCPU() Average CPU time consumed, in the form mmmss.AverageElapsed() Average elapsed time in the form mmmss.

Continued on next page

Page 488: ESP 5.2 Command Reference

488

MGRMSG Command, Continued

INSERT andRESET actionscontinued

Keyword DescriptionConditional Indicates this is a conditional job.Doclib() Specifies the name of the library containing documentation for

the object.Docmem() Member name of documentation library entry.Dsname() Submit data set name.EarlySub() Time before when object should not be readied.Espprocfile() Specifies the name of the library containing the objects

definition (ESP Procedure file)External* Indicates object refers to an object in another application.Hold Requests the object be placed in a manual hold condition.LateEnd() Time/Date when an object should complete to avoid becoming

overdue.LateSub() Time/Date when an object should start to avoid becoming

overdue.Manual* Indicates this object is a manually submitted MVS job.Pred() Specifies the names of any predecessor objects. There is no limit

to the number of objects specified here. The object names are inthe form nnnn.qqqq for a qualified object, or nnnn for an objectwithout a qualifier. Object names can be separated by blanks orcommas.

Priority() Specifies the priority the workload object is to have. This is anumber from 0 – 99.

Process Indicates whether Event processing is required for tasks or links.RelDelay() Specifies a minimum delay time to be added to a job after its last

dependency has been met.Request Indicates the object has the REQUEST attribute. In order to run,

it has to be explicitly requested.Resource() Specifies resources the object requires in order to be eligible for

execution. Parameters are specified in the form nnnn,rrrr wherennnn is a numeric quantity and rrrr is the name of a resource. Aresource requirement can be nullified by setting the quantity tozero. The quantity can be omitted, in which case it defaults to 1.For example,Resource(CICS01,2,TAPES,3,SCRATCH,DBTABLE1)requests 1 unit of CICS01 and DBTABLE1, 2 units of TAPESand 3 units of SCRATCH.

Scheduled*() This indicates the scheduled time an external object mustpossess in order to match this object definition.

Continued on next page

Page 489: ESP 5.2 Command Reference

489

MGRMSG Command, Continued

INSERT andRESET actionscontinued

Keyword DescriptionStatements() Specifies one or more statements that should be executed as part

of the processing of the Event/Procedure that is invoked whenthis object is readied. Separate each statement with a semicolon.These statements will be executed after all procedure statementshave been processed. An object need not be defined in the ESPProcedure. For example, to specify an Agent name and exit code,specify Statements(Agent AIX01;EXITCODE0-5 SUCCESS)

Subappl*() Specifies the name of the subappl to which the object belongs.Succ() Specifies the names of any successor objects. There is no limit to

the number of objects specified here. The object names are in theform nnnn.qqqq for a qualified object, or nnnn for an objectwithout a qualifier. Blanks or commas can separate objectnames.

Tag() Specifies a tag for the object.Type*() Specifies the object type. This should be JOB, LINK, TASK or

the long or short name of a workload object class.

Examples The following are examples of INSERT and RESET actions:

MGRMSG * . applmgr . JOB5/APPLA.5/MAIN ACTION INSERT Type(Job) -Hold Pred(JOB2,JOB3.A) Earlysub(21.00 Today) Tag(STREAM1)

* . applmgr . JOB2/APPLA.4/MAIN ACTION RESET Pred(JOB1) -AbandonSubmission(6pm)

RESUB action The following is a description of the variable keywords available with the RESUBaction:

Keyword DescriptionFrom() Restart point.Jobid() Identifier of original job being restarted.RestartParm() Parameter string to be passed to the restart processor.To() Last processing step to be rerun.User1() User restart variable 1.User2() User restart variable 2.User3() User restart variable 3.User4() User restart variable 4.

Continued on next page

Page 490: ESP 5.2 Command Reference

490

MGRMSG Command, Continued

STATE verb The following verb modifiers can be used with the STATE verb:

Verb modifier DescriptionActive Indicates after the state of the object has been modified, the

Activate subroutine of the APPL Manager should be invoked.This should be specified if the state change would beexpected to cause one or more objects to become eligible tobe readied.

Alert() Indicates the name of an Alert to be invoked. Specifying ‘*’causes the Event that created the Application to be invoked asa monitor Event. If this keyword is specified, also supply amonitor point name via the MNPOINT keyword.

Cmpc() Specifies the completion code for the object.Failed Indicates the FAILED condition should be set.Intvrq Indicates intervention is required for the object.Jobno() Sets the ‘job number’ field of the object.MNPoint() Supplies a value for the MNPOINT variable for the execution

of an Alert.NoActivate Indicates the Activate subroutine of the APPL Manager

should not be invoked for this state change.NoFailed Resets the FAILED indicator for an object.NoIntvrq Turns off the intervention required condition for an object.NoUpdateATR Indicates the Application tracking record should not be

updated to disk as a result of this state change message.SetEnd Requests the end time for the object be set from the

timestamp of this message.SetStart Requests the start time of the object be set from the time field

of this message.Status() Specifies a system status string that should be attached to this

object.Tag() Identifies a new tag field for this object.

RESPONSEverb

Response messages have no predefined variable data. They are generated as aresponse to an inquiry originated by the Application Manager or a workload objectimplementation package.

Page 491: ESP 5.2 Command Reference

491

MODEL Statement

Overview The MODEL statement is used to specify the name of the tracking model to be usedfor this job.

Type ESP Application statement.

Syntax The syntax of the MODEL statement is:

MODEL modelname

Parameter Descriptionmodelname Indicates a tracking model name in up to eight characters.

Usage notes The MODEL statement overrides the tracking model specified in the job trackingdefinition table, for a job.

Relatedinformation

For information on displaying the definition of tracking models, see the LTMcommand.

For information on defining and deleting a tracking model definition, see theDEFTM and DELTM commands.

For information on tracking definition entries in a job tracking definition table, seethe TRACKDEF statement.

For information on using tracking models, see the ESP Workload ManagerAdministrator’s Guide.

For information on job tracking definition tables, see the ESP Workload ManagerAdministrator’s Guide.

Example 1 The following MODEL statement specifies the name of the tracking model:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN DAILYREL PAYJOB2

JOB PAYJOB2RUN FRIDAYMODEL ALTMODL

ENDJOB

In the above example, ESP uses tracking model ALTMODL for PAYJOB2regardless of the entry in the job tracking definition table.

Page 492: ESP 5.2 Command Reference

492

MODEL Command

Overview The MODEL command is used to activate the model processor. The modelprocessor updates the projected start and end times for jobs in the scheduled activitydata set. In additional to activating the model processor, the MODEL commandindicates the start of the model period.

Type Model command.

Syntax The syntax of the MODEL command is:

MODEL ‘dsname’[START(‘schedule’)][NOCLASS]

Parameter Descriptiondsname Indicates the data set name of scheduled activity data set,

enclosed in quotes, to be used for MODEL processing.schedule Indicates the start of the model period. If the statement

contains separators, it must be enclosed in quotes. The startperiod defaults to ‘now’ (current time/date) if not specified.If no end time is specified, the default is the start time plus 12hours.

NOCLASS Specifies class processing is bypassed for this model.Initiator classes are not required when starting initiators and ifspecified, are ignored. The NOCLASS option distorts yourmodeling output. Jobs are selected for execution by anyavailable initiator regardless of their class. This could resultin major discrepancies between the forecast and actualcompletion times of your workload. This option should beused only in cases where an installation uses homogeneousinitiator classes or where you are interested only in aScheduled Jobs Cross-Reference (JR1) report.

Usage notes You cannot activate the model processor through ISPF panels or through an ESPProcedure. Modeling is normally done in batch.

The START keyword defines the timeframe used to extract records from thescheduled activity data set. Only jobs within the timeframe are used in the MODELgeneration.

After entering the MODEL command from Line mode or Page mode, the ESPMODEL processor is activated and you can enter MODEL commands. Modelprocessor activation is indicated by:

• The MODEL --> prompt from line mode• Or the MODEL MODE prompt in the upper left corner of the screen from Page

mode.

Continued on next page

Page 493: ESP 5.2 Command Reference

493

MODEL Command, Continued

Relatedinformation

For information on ending the model process, see the ENDMODEL command.

For information on how ESP processes workload in your environment, see the ESPWorkload Manager Advanced User’s Guide.

Example 1 The following MODEL command activates the model processor:

MODEL ‘CYBER.SAD’

In the above example, jobs scheduled between now and now plus 12 hours (default)are used in the MODEL generation.

Example 2 The following MODEL command activates the model processor and indicates thestart of the model period:

MODEL ‘CYBER.SAD’ START(‘6AM TODAY ENDING 6AM TOMORROW’)

In the above example, only jobs scheduled between 6 am today and 6 am tomorroware used in the MODEL generation.

Example 3 The following MODEL command activates the model processor and indicates thestart of the model period and that class processing be bypassed:

MODEL ‘CYBER.SAD’ START(‘8AM TODAY ENDING 8PM TODAY’) NOCLASS

In the above example, only jobs scheduled between 8 am today and 8 pm today areused in the MODEL generation. Job classes are ignored. This is useful forgenerating a Scheduled Jobs Cross-Reference (JR1) report to see job relationships.

Continued on next page

Page 494: ESP 5.2 Command Reference

494

MODEL Command, Continued

Example 4 The following is an example of a model definition:

DEFPRINT XREF DDNAME(MODEL1)MODEL ‘CYBER.SAD’ -

START('4PM TODAY ENDING 4PM TODAY PLUS 5 DAYS')MAXINITS 8INIT START(1:8) CLASS(A,B,C,D)MREPORT RPT1 JR1 FROM('4PM TODAY ENDING 4PM TOMORROW’)

ENDMODELENDPRINT RPT1

In the above example:

• The DEFPRINT command directs output to a DD name• The MODEL command invokes the model processor• The MAXINITS and INIT commands define initiators• The MREPORT command selects the modeling report to be generated• The ENDMODEL command ends the process• The ENDPRINT command creates a report.

Page 495: ESP 5.2 Command Reference

495

MONITOR Statement

Overview The MONITOR statement is used to identify the prefix of your job monitor Eventwhen you define your job in an Application. This prefix must be your user ID or agroup to which you have access. The job monitor Event must use a specific namingconvention.

Type ESP Application statement.

Syntax The syntax of the MONITOR statement is:

MONITOR groupname

Parameter Descriptiongroupname Indicates an ESP Event group name prefix in up to eight

characters.

Usage notes When jobs are submitted, ESP detects that a specific monitor Event or a monitorgroup exists for the job. A monitor group acts as a high level index to point ESP tohigh-level Event prefixes. ESP uses the monitor group specified in an Application,tracking model, or job documentation. ESP then searches and locates the monitorEvent. The identifier of the monitor Event must match the appropriate job and groupcombination. A monitor Event states the monitoring requirements, includingmonitor point and ESP action.

Specifying a MONITOR group within an Application does not override generic jobmonitor Events defined using a tracking model.

The MONITOR statement can be used at a global level within an Application or atthe job level for a specific job. The MONITOR statement can not be used for jobsdefined as EXTERNAL or MANUAL in an Application. If you need to monitor anEXTERNAL job, code the MONITOR statement in the Application where the job issubmitted, i.e. the home Application. If you need to monitor a MANUAL job, youmust identify the MONITOR group in a tracking model, using the DEFTMcommand.

Relatedinformation

For information on job monitoring, see the ESP Workload Manager AdvancedUser’s Guide.

For information on specifying a monitor group or generic job monitor Event, withina tracking model definition, see the DEFTM command.

Continued on next page

Page 496: ESP 5.2 Command Reference

496

MONITOR Statement, Continued

Example 1 The following MONITOR statement identifies a monitor group prefix:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN MONDAYMONITOR PROD

ENDJOB

In the above example, PROD is identified as the monitor group for PAYJOB1. ESPsearches for Events with the PROD prefix that conform to the following namingconvention:

PROD.PAYJOB1_monitorpoint

Therefore, if a job end job monitor Event is defined for PAYJOB1, triggers thefollowing Event when PAYJOB1 ends.

PROD.PAYJOB1_JOBEND

Note: The same results can be achieved by identifying the monitor group within atracking model definition instead of within an Application. The following is anexample of the tracking model definition command:

DEFTM MODEL1 MONITOR(PROD) HISTFILE(HIST1) INDEX(5)

Example 2 The following MONITOR statement identifies a monitor group prefix for an entireApplication:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’MONITOR CYBERJOB PAYJOB2

REL PAYJOB3JOB PAYJOB3

REL PAYJOB4JOB PAYJOB4ENDJOBSELECT (PAYJOB2,PAYJOB3,PAYJOB4)

In the above example, CYBER is identified as the monitor group for all jobs withinthe PAYROLL Application. ESP searches for Events with the CYBER prefix.Therefore, if a step end monitor Event is defined for PAYJOB4, ESP triggersCYBER.PAYJOB4_STEPEND after every step within PAYJOB4 ends.

Page 497: ESP 5.2 Command Reference

497

MREPORT Command

Overview The MREPORT command is used to select the reports containing the modelingoutput and specify the time range for each report.

Type Model command.

Syntax The syntax of the MREPORT command is:

MREPORT repname{JR1|JR2}{ER1|ER2}{RR1|RR2}[FROM(‘schedule’)][CPU(cpunumber)][JOBS(jobname[,jobname]...)]

Parameter Descriptionrepname Indicates a one to eight alphanumeric character logical report

name as defined by the DEFPRINT command.JR1 Generates a Scheduled Jobs Cross Reference report. Can also be

specified as JOB_REPORT_1.JR2 Generates a Projected End Time report. Can also be specified as

JOB_REPORT_2.ER1 Generates a Job Exception report. Can also be specified as

EXCEPTION_REPORT_1.ER2 Generates a Dueout Exception report. Can also be specified as

EXCEPTION_REPORT_2.RR1 Generates the Resource Utilization On Systems report. Can also

be specified as RESOURCE_REPORT_1.RR2 Generates the Resource Utilization By Job report. Can also be

specified as RESOURCE_REPORT_2.schedule Indicates a valid schedule statement. If the statement contains

separators, it must be enclosed in quotes. The keywordsENDING or UNTIL can be used to restrict the time rangeselected. An “EVERY” keyword can also be specified to controlthe reporting increment. If the FROM keyword is not specified,the default is ‘now every two minutes until 6 am tomorrow’.

cpunumber Indicates the CPU number for which the report is generated.The valid range is 0-7 (up to eight CPUs supported). If notspecified, all CPUs are reported on. The CPU keyword is usedonly when a RESOURCE_REPORT_1 (RR1) report isrequested.

Continued on next page

Page 498: ESP 5.2 Command Reference

498

MREPORT Command, Continued

Syntax (continued)

Parameter Descriptionjobname Indicates a one to eight alphanumeric jobname or list of

jobnames to be included in the report. Asterisks or a hyphen asthe last character may be used to perform masking. The JOBSkeyword should be used only if you wish to limit a report tocertain jobnames or job prefixes. All jobs are reported on bydefault if the JOBS keyword is not specified.

Usage notes The recommended data width for all reports is 133 with a record format of FBA.

Relatedinformation

For information on how ESP processes workload in your environment, see the ESPWorkload Manager Advanced User’s Guide.

Example 1 The following MREPORT command selects the modeling report to be generated:

MREPORT CYBER1 RESOURCE_REPORT_1 -FROM(‘6AM TODAY EVERY 5 MINUTES ENDING 6AM TOMORROW’)

In the above example, generation of the Resource Utilization by System Report(RR1) is requested. The report is generated at 5-minute intervals.

Example 2 The following MREPORT command selects the modeling report to be generated:

MREPORT OUTDSN RR2 FROM(‘8:15 JAN1 TO 9:15 JAN2’) CPU(3)

In the above example, generation of the Resource Utilization by Job (RR2) isrequested. Only LOCAL resources defined to CPU3 will appear on the report. Thereport is generated at 2-minute intervals (default).

Continued on next page

Page 499: ESP 5.2 Command Reference

499

MREPORT Command, Continued

Example 3 The following is an example of a model definition:

DEFPRINT XREF DDNAME(MODEL1)MODEL ‘CYBER.SAD’ -

START('4PM TODAY ENDING 4PM TODAY PLUS 5 DAYS')MAXINITS 8INIT START(1:8) CLASS(A,B,C,D)MREPORT RPT1 JR1 FROM('4PM TODAY ENDING 4PM TOMORROW’)

ENDMODELENDPRINT RPT1

In the above example:

• The DEFPRINT command directs output to a DD name• The MODEL command invokes the model processor• The MAXINITS and INIT commands define initiators• The MREPORT command selects the modeling report to be generated• The ENDMODEL command ends the process• The ENDPRINT command creates a report.

Page 500: ESP 5.2 Command Reference

500

MSG Command

Overview The MSG command is used to add or delete routing or descriptor codes to an ESPmessage or range of ESP messages. It can also change the message type.

Type General command.

Authority OPER authority is required to issue the MSG command.

Syntax The syntax of the MSG command is:

MSG {(id[,id]...)}{(id1:id2)}[ROUTE(codes)][DESC(codes)][DELROUTE(codes)][DELDESC(codes)][TYPE(I|W|E|S)]

Parameter Descriptionid Indicates a number in the range 200 to 950. A list of numbers

can be specified, enclosed in parentheses and separated byblanks or commas.

id1:id2 Indicates two numbers each in the range 200 to 950, separatedby a colon, which specify a range of message Ids. A list ofranges can be specified, enclosed in parentheses andseparated by blanks or commas.

codes Indicates a number, range of numbers or list of numbers andranges of numbers. Each number must be within the range 0-16.

ROUTE Indicates one or more routing codes are added when themessage is issued.

DESC Indicates one or more descriptor codes are added whenissuing the messages.

DELROUTE Indicates one or more routing codes are deleted from thosenormally used for the message.

DELDESC Indicates one or more descriptor codes are deleted from thosenormally used for the message.

TYPE Indicates the new message type:

• I informational message• W warning message• E error message• S severe error message

Continued on next page

Page 501: ESP 5.2 Command Reference

501

MSG Command, Continued

Usage notes When a message is about to be issued, the routing and descriptor codes are modifiedaccording to the above specification. The routing and descriptor codes for themessage class, as set by the MSGTYPE command, are also set. The order ofApplication is:

1. DELROUTE and DELDESC from message type (MSGTYPE command).2. ROUTE and DESC from message type (MSGTYPE command).3. DELROUTE and DELDESC from individual message modifier (MSG

command).4. ROUTE and DESC from individual message modifier (MSG command).

Relatedinformation

For information on adding or deleting routing or descriptor codes to groups ofmessages, see the MSGTYPE command.

Example 1 The following are examples of MSG and MSGTYPE commands:

MSGTYPE INFORMATION ROUTE (1:3,10,12)MSGTYPE WARNING ROUTE (1:3,8,10,12) DESC(1)MSG (500:510,525) DESC(2)MSG 530 TYPE(W) DELDESC(1)

In the above example, messages 500 to 550 are informational messages, andmessages 551 to 559 are warning messages.

After these commands are entered:

• All informational messages have routing codes 1,2,3,10 and 12 added.• Warning messages have routing codes 1,2,3,8,10 and 12 added along with

descriptor code 1.• Messages 500 to 510 and 525 would also have descriptor code 2 added, although

they remain informational messages.• Message 530 is converted to a warning message, and has the warning message

routing and descriptor codes added. However, the descriptor code of ‘1’ isdeleted for message 530.

Page 502: ESP 5.2 Command Reference

502

MSGLIMIT Statement

Overview The MSGLIMIT statement is used to allow you to limit the number of consolemessages generated by an Event. MSGLIMIT can be used to suppress excessmessages or to cancel Events that exceed a certain limit.

Type ESP Application statement. General command.

Authority OPER authority is required to issue the MSGLIMIT command.

Syntax The syntax of the MSGLIMIT command is:

MSGLIMIT [n1[,n2][LIST][OFF]

Parameter Descriptionn1 When specified on its own, this causes ESP to cancel an

Event once it exceeds this number of messages.N2 Entering two parameters on MSGLIMIT causes excess

messages to be suppressed while allowing the Event tocontinue. Any message beyond the first n1 from the Event issuppressed. However, if the total number of messagesexceeds n2, the Event is canceled.

LIST Displays MSGLIMIT settings.OFF Inactivates the message limits.

Usage notes If a Procedure contains a MSGLIMIT statement then its value overrides the defaultvalue set by an operator command or Initialization Parameter. MSGLIMIT appliesto the Event that invokes the ESP Procedure.

Example 1 The following MSGLIMIT command displays the message limit settings:

MSGLIMIT -

In the above example, the current message limit setting are displayed.

Example 2 The following MSGLIMIT command sets the message limit:

MSGLIMIT 100

In the above example, the message limit is set to 100. When an Event exceeds 100messages, the Event is canceled.

Continued on next page

Page 503: ESP 5.2 Command Reference

503

MSGLIMIT Statement, Continued

Example 3 The following MSGLIMIT command suppresses messages or cancels an Event:

MSGLIMIT 40,100

In the above example, any message beyond the first 40 from an Event is suppressed.However, if the total number of messages (including the suppressed ones) exceeds100, the Event is canceled.

Page 504: ESP 5.2 Command Reference

504

MSGTYPE Command

Overview The MSGTYPE command is used to add or delete routing or descriptor codes togroups of ESP messages based on their message type.

Type General command.

Authority OPER authority is required to issue the MSG command.

Syntax The syntax of the MSGTYPE command is:

MSGTYPE {INFO|I}{WARNING|W}{ERROR|E}{SEVERE|S}[ROUTE(codes)][DESC(codes)][DELROUTE(codes)][DELDESC(codes)]

Parameter DescriptionINFO Indicates an informational message.WARNING Indicates a warning message.ERROR Indicates an error message.SEVERE Indicates a severe error message.codes Indicates a number, range of numbers or list of numbers and

ranges of numbers. Each number must be within the range 0-16.

ROUTE Indicates one or more routing codes are added when themessage is issued.

DESC Indicates one or more descriptor codes are added whenissuing the messages.

DELROUTE Indicates one or more routing codes are deleted from thosenormally used for the message.

DELDESC Indicates one or more descriptor codes are deleted from thosenormally used for the message.

Continued on next page

Page 505: ESP 5.2 Command Reference

505

MSGTYPE Command, Continued

Usage notes When a message is to be issued, the message type indicator is used to locate themessage type attributes. Any message type attributes are combined with theattributes of the message itself to form the final attributes. The order of Applicationof attributes when both MSG and MSGTYPE apply to a message is:

1. DELROUTE and DELDESC from message type (MSGTYPE command).2. ROUTE and DESC from message type (MSGTYPE command).3. DELROUTE and DELDESC from individual message modifier (MSG

command).4. ROUTE and DESC from individual message modifier (MSG command).

Relatedinformation

For information on adding or deleting routing or descriptor codes to a message orrange of messages, see the MSG command.

Example 1 The following are examples of MSG and MSGTYPE commands:

MSGTYPE INFORMATION ROUTE (1:3,10,12)MSGTYPE WARNING ROUTE (1:3,8,10,12) DESC(1)MSG (500:510,525) DESC(2)MSG 530 TYPE(W) DELDESC(1)

In the above example, messages 500 to 550 are informational messages, andmessages 551 to 559 are warning messages.

After these commands are entered:

• All informational messages have routing codes 1,2,3,10 and 12 added.• Warning messages have routing codes 1,2,3,8,10 and 12 added along with

descriptor code 1.• Messages 500 to 510 and 525 would also have descriptor code 2 added, although

they remain informational messages.• Message 530 is converted to a warning message, and has the warning message

routing and descriptor codes added. However, the descriptor code of ‘1’ isdeleted for message 530.

Example 2 The following MSGTYPE command adds routing codes:

MSGTYPE I ROUTE(1,2,5)MSGTYPE I ROUTE(6) DESC(2)

In the above example, informational messages will have routing codes 1,2,5 and 6and descriptor code 2. If you want to reset any prior setting, specify 0 as the firstrouting or descriptor code.

Continued on next page

Page 506: ESP 5.2 Command Reference

506

MSGTYPE Command, Continued

Example 3 The following resets routing and descriptor codes:

MSGTYPE I ROUTE(0,6) DESC(0,2)

In the above example, previous routing and descriptor code settings are reset beforeadding the new values.

Page 507: ESP 5.2 Command Reference

507

NEXT Command

Overview The NEXT command allows you to display the next scheduled executions of anEvent. The NEXT command lets you specify the number of execution times youwant to test, up to a maximum of 99. As long as your Event contains at least oneSCHEDULE or EXPECT command, ESP computes the execution times and datesfor the number of executions you specify.

Type General command.

Syntax The syntax of the NEXT command is:

NEXT [count]eventid

Parameter Descriptioncount Indicates a number from 1 to 99, specifying the number of

execution times you want to be displayed. The default is 1.eventid Indicates the name of an Event.

Usage notes The NEXT command simulates the schedule commands in an Event to compute thenext ‘n’ execution times.

The use of the HOLD, RELEASE, SUSPEND and RESUME commands affects thedisplay.

If an Event is suspended at the time of display, with no scheduled resume, ESPissues a message and no scheduled executions are displayed.

Relatedinformation

For information on testing schedule criteria before using in an Event, see the TESTcommand.

Example 1 The following is an example of the output produced by the NEXT command:

NEXT 5 CYBER.PAYROLLSCHED AT 21.00.00 ON MONDAY FEBRUARY 2ND, 1999SCHED AT 21.00.00 ON TUESDAY FEBRUARY 3RD, 1999SCHED AT 21.00.00 ON WEDNESDAY FEBRUARY 4TH, 1999SCHED AT 21.00.00 ON THURSDAY FEBRUARY 5TH, 1999SCHED AT 21.00.00 ON FRIDAY FEBRUARY 6TH, 1999

In the above example, the next 5 executions of CYBER.PAYROLL are displayed.

Continued on next page

Page 508: ESP 5.2 Command Reference

508

NEXT Command, Continued

Example 2 The following is an example of the output produced by the NEXT command:

ESP2494W NEXT PROCESSING ENDED AFTER 200 SUSPENDED SCHEDULESNEXT 10 CYBER.PAYROLLSCHED AT 17.00.00 ON WEDNESDAY FEBRUARY 18TH, 1998SCHED AT 17.00.00 ON THURSDAY FEBRUARY 19TH, 1998SCHED AT 17.00.00 ON FRIDAY FEBRUARY 20TH, 1998SCHED AT 17.00.00 ON SATURDAY FEBRUARY 21ST, 1998SCHED AT 17.00.00 ON SUNDAY FEBRUARY 22ND, 1998

In the above example, the Event is suspended after February 22nd, 1998, with noscheduled resume.

Example 3 The following is an example of the output produced by the NEXT command:

NEXT 5 CYBER.PAYROLLSCHED AT 17.00.00 ON WEDNESDAY FEBRUARY 18TH, 1998SCHED AT 17.00.00 ON THURSDAY FEBRUARY 19TH, 1998SCHED AT 17.00.00 ON FRIDAY FEBRUARY 20TH, 1998SCHED AT 17.00.00 ON SATURDAY FEBRUARY 21ST, 1998 HOLD(1)SCHED AT 17.00.00 ON SUNDAY FEBRUARY 22ND, 1998

In the above example, the Event is held at the time of execution and release prior tothe next execution.

Page 509: ESP 5.2 Command Reference

509

NOCHECKEXC Statement

Overview The NOCHECKEXC statement is used to indicate that ESP should not check thelast non-blank character of every card image written to the internal reader. TheNOCHECKEXC statement cannot be used in an ESP Procedure.

Type Symbolic variable library statement.

Syntax The syntax of the NOCHECKEXC statement is:

NOCHECKEXC

Usage notes The NOCHECKEXC statement is used in conjunction with the CHECKEXCstatement which checks the last non-blank character of card images written to theinternal reader. If the last character is a ‘¬’ (‘not’ sign), the card image is deleted.NOCHECKEXC turns off the CHECKEXC feature. The default isNOCHECKEXC.

RelatedStatements

For information on turning on the checking of the last non-blank character of everycard image written to the internal reader, see the CHECKEXC statement.

For information on selectively including JCL, see the %INCLUDE statement.

For information on selectively excluding JCL, see the %EXCLUDE statement.

Example 1 The following NOCHECKEXC statement indicates that ESP should not check thelast non-blank character of every card image written to the internal reader:

NOCHECKEXC

In the above example, coding NOCHECKEXC cancels, or turns off theCHECKEXC feature.

Page 510: ESP 5.2 Command Reference

510

NODE Command

Overview The NODE parameter is used, together with the CPU parameter, to define theresource topology of your network. The NODE parameter defines each systemnode.

Type General command.

Syntax The syntax of the NODE parameter is:

NODE name [ADD|DEL|LIST|SET][ROUTEJCL('/* XEQ nnn')][ACTIVE|INACTIVE]

Operand Descriptionname Indicates the name to identify this NODE. This may

correspond to an existing JES node name or SMF id. Theasterisk (*) and hyphen (-) may be used as wild cardcharacters for masking name with all parameters exceptADD.

ADD Indicates this is a new definition.

DEL Deletes one or more existing definitions.

LIST Displays list of one or more existing definitions. This is thedefault.

SET Modifies attributes of existing definitions.

ROUTEJCL Indicates a JCL image that, when inserted into a job’s JCL,causes the job to be routed to the appropriate CPU or node.

ACTIVE Indicates a node be considered active. This is the default.INACTIVE Indicates a node be considered inactive. ESP will not attempt

to schedule a job to that node or CPU while it is inactive.

Usage notes The CPU command is generally used at the Initialization Parameter level, and isused in conjunction with the NODE parameter to define the resource topology ofyour network.

For information on defining the resource topology of your network see the CPU,NODE, and RESFILE parameters in the ESP Workload Manager Installation Guide.

You also need to define CPU after defining NODE.

It is recommended that you use the CPU and NODE names that JES knows.

Continued on next page

Page 511: ESP 5.2 Command Reference

511

NODE Command, Continued

Relatedinformation

For information on defining the resource topology of your network, see the CPU,NODE, and RESFILE parameters in the ESP Workload Manager Installation Guide.

For information on Resources, see the ESP Workload Manager User’s Guide.

Example 1 The following NODE command displays all defined NODEs:

NODE - LIST

In the above example, all nodes defined as part of the resource topology aredisplayed.

Example 2 The following NODE and CPU commands define a node and CPU:

NODE TORONTO ADDCPU T1 ADD NODE(TORONTO) CURRENT

In the above example, a single node called TORONTO is defined, and a single CPUcalled T1 is defined as a member of the TORONTO node.

Page 512: ESP 5.2 Command Reference

512

NORUN Statement

Overview The NORUN statement is used to handle exceptions to a job’s regular schedulecriteria. The NORUN statement tells ESP when not to select a job for submission.

Type ESP Application statement.

Syntax The syntax of the NORUN statement is:

NORUN criteria

Parameter Descriptioncriteria Schedule criteria that resolve to a single date and time.

Usage notes The NORUN statement is equivalent to: IF TODAY(‘schedule criteria’) THENDESELECT job.

Multiple NORUN statements are allowed.

Use the RUN statement to cause a job to be scheduled. When both RUN andNORUN statements are encountered, ESP uses the last one that applies. Therefore,you should normally specify RUN statements before NORUN statements.

If a NORUN statement is used without a RUN statement for a job, the job isscheduled each time the Event executes except when the NORUN schedule criteriais satisfied.

The NORUN statement can not be used in conjunction with the followingscheduling terms: EVERY, UNTIL, ENDING, TOMORROW, YESTERDAY andSTARTING.

The NORUN statement must be used within the scope of a JOB statement.

Relatedinformation

For information on Applications, see the ESP Workload Manager User’s Guide.

For information on specifying schedule criteria, see the ESP Workload ManagerUser’s Guide.

For information on selecting jobs for submission, see the RUN, SELECT,POSTREQ, PREREQ and COREQ statements.

Continued on next page

Page 513: ESP 5.2 Command Reference

513

NORUN Statement, Continued

Example 1 The following NORUN identifies an exception to a job’s schedule criteria:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN WORKDAYSNORUN FIRST WORKDAY OF MONTH

ENDJOB

In the above example, PAYJOB1 is scheduled for submission on workdays, excepton the first workday of the month.

Example 2 The following NORUN identifies an exception to a job’s schedule criteria:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB2

RUN DAILYNORUN FIRST WORKDAY OF MONTHNORUN LAST WORKDAY OF MONTH

ENDJOB

In the above PAYJOB2 is scheduled for submission every day, except on the firstand last workday of each month.

Example 3 The following NORUN identifies an exception to a job’s schedule criteria:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB3

NORUN WEDNESDAYENDJOB

In the above PAYJOB3 is scheduled for submission every time the Event invokingthis Application executes, except on Wednesdays.

Continued on next page

Page 514: ESP 5.2 Command Reference

514

NORUN Statement, Continued

Example 4 The following NORUN identifies an exception to a job’s schedule criteria:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB4

RUN WORKDAYSIF TODAY(‘FIRST FRI OF MONTH’) AND -

TODAY(‘FIRST WORKDAY OF MONTH’) THEN NORUN TODAYENDJOB

In the above example, PAYJOB4 is scheduled for submission on workdays. If todayis the first Friday of the month and the first workday of the month, the job is notselected for submission.

Example 5 The following NORUN identifies an exception to a job’s schedule criteria:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB5

RUN FRIDAYNORUN FIRST FRIDAY OF MONTHNORUN LAST FRIDAY OF MONTH

ENDJOB

In the above example, PAYJOB5 is scheduled for submission on Fridays. If todayis the first Friday of the month, or the last Friday of the month, the job is notselected for submission.

Other examples Here are more examples of using the NORUN statement.

Indicates that a job is not selected for submission on holidays:

NORUN HOLIDAY

Indicates that a job is not selected for submission on the 3rd, 13th and the 23rd day ofeach month:

NORUN 3RD 13TH 23RD DAY OF MONTH

Indicates that a job is not selected for submission on the 1st day of the fiscal year:

NORUN 1ST DAY OF FISCAL YEAR

Indicates that a job is not selected for submission, i.e. the job is turned off:

NORUN ANY

Page 515: ESP 5.2 Command Reference

515

NOSCHED Command

Overview The NOSCHED command is used to specify when a scheduled Event should notexecute.

Type Event definition command.

Syntax The syntax of the NOSCHED command is:

NOSCHED criteria

Parameter Descriptioncriteria Schedule criteria.

Usage notes In addition to a SCHEDULE command, use any number of NOSCHED commandsto specify when an Event should not execute.

Use the same time on your NOSCHED statement as on your SCHEDULE statement.If no time is specified on the NOSCHED statement, the default is 00:00. Forexample, if you say SCHEDULE 5PM, you should use NOSCHED 5PM.

The NEXT command which lists the next execution times of an Event, reflectsNOSCHED commands.

Relatedinformation

For information on specifying schedule criteria, see the ESP Workload ManagerUser’s Guide.

For information on specifying when an Event should execute, see the SCHEDULEcommand.

For information on specifying when a job should not be scheduled, see the NORUNstatement.

Example 1 The following is an example of an Event definition:

EVENT ID(CYBER.PAYROLL)SCHEDULE 5PM DAILYNOSCHED 5PM LAST WORKDAY OF MONTHINVOKE ‘CYBER.JCL.CNTL(PAYROLL)’ENDDEF

In the above example, CYBER.PAYROLL is scheduled to execute every day at5pm, except on the last workday of the month.

Continued on next page

Page 516: ESP 5.2 Command Reference

516

NOSCHED Command, Continued

Example 2 The following is an example of an Event definition:

EVENT ID(CYBER.PAYJOB)SCHEDULE 5PM DAILYNOSCHED 5PM FEBRUARY 14, 1998 ONCESUBMIT ‘CYBER.JCL.CNTL(PAYJOB1)’ENDDEF

In the above example, CYBER.PAYROLL is scheduled to execute every day at5pm, except on February 14th, 1998.

Page 517: ESP 5.2 Command Reference

517

NOTIFY Statement

Overview The NOTIFY statement is used to notify users or consoles, or trigger an Event whenone or more of the following conditions are met: SUBMIT, JOBSTART, RESUB,OVERDUE, ABEND, FAILURE and JOBEND. The NOTIFY statement isavailable only for jobs belonging to Applications.

Type ESP Application statement.

Syntax The syntax of the NOTIFY statement is:

NOTIFY [SUBMIT][JOBSTART][RESUB][OVERDUE][ABEND][FAILURE][JOBEND][USERS(userid[,userid]...)][SYSTEM(name)][ROUTE(rcode[,rcode]...)][DESC(dcode[,dcode]...)][ALERT(xxxx)]

Parameter DescriptionSUBMIT Indicates notification should take place at job submit time.JOBSTART Indicates notification should take place at job start time.OVERDUE Indicates notification should take place when a job becomes

overdue from any processing node.ABEND Indicates notification should take place when a job ABENDs. This

excludes condition code failures.FAILURE Indicates notification should take place when a job fails. This

includes condition codes failures caused by either the CCCHK orCCFAIL statements.

JOBEND Indicates notification should take place when a job ends. Thisincludes any job end (successful or unsuccessful). This Parametercan also be specified as END.

RESUB Indicates notification should take place when a job resubmittedthrough ESP ends.

userid Indicates up to three TSO user IDs to receive notification.name Indicates the name of a Sysplex member. This is not the ESP

system name – it is the name by which MVS knows the member ofthe Sysplex. Can be used to route a NOTIFY command in aSysplex environment to wherever the user is logged on. Use anasterisk to indicate the message goes wherever ESP is running.

rcode Indicates route code value between 1 and 128 to receivenotification. Separate each route code with a comma.

dcode Indicates descriptor code value between 1 and 16 to receivenotification. Separate each descriptor code with a comma.

Continued on next page

Page 518: ESP 5.2 Command Reference

518

NOTIFY Statement, Continued

Syntax (continued)

Parameter DescriptionALERT(xxxx) Indicates an Event associated with a logical alert identifier should

be triggered. This logical identifier must have been previouslyspecified using an ALERTDEF command. Alternatively, anasterisk (*) can be used to trigger the same Event which invokedthis ESP Procedure.

Usage notes The Alert feature enables ESP to trigger an Event for all jobs, or only specific jobs,in an ESP Application.

To use the Alert feature, you need to take these three steps:

1. Use the NOTIFY statement in an ESP Application to identify when to trigger theAlert.

2. Define the Alert with the ALERTDEF command.

3. Define the Event triggered by the Alert.

Alerts can be defined dynamically, i.e. via Page mode, but are not retained acrossrecycles of ESP. To ensure that alert definitions are retained across recycles of ESP,insert the appropriate ALERTDEF commands in the ESP Workload ManagerInitialization Parameters.

Up to two global NOTIFY statements can be used. The NOTIFY statement can beused within the scope of a job statement in which case all global NOTIFYstatements are overridden. Up to two NOTIFY statements can be used within thescope of a job statement.

Relatedinformation

For information on triggering Events automatically when workload reaches aparticular stage in processing, see the ESP Workload Manager Advanced User’sGuide.

For information on defining and displaying alert definitions, see the ALERTDEFcommand.

Continued on next page

Page 519: ESP 5.2 Command Reference

519

NOTIFY Statement, Continued

Example 1 The following NOTIFY statement notifies users when each job within theApplication starts:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’NOTIFY JOBSTART USERS(CYB01,CYB02)JOB PAYJOB1

REL PAYJOB2JOB PAYJOB2

REL PAYJOB3JOB PAYJOB3ENDJOBSELECT (PAYJOB1,PAYJOB2,PAYJOB3)

In the above example, when each job within the PAYROLL Application starts, usersCYB01 and CYB02 receive notification. The notification is a pre-formattedmessage that looks like this:

JOB PAYJOB1(J09368) STARTED AT 02.15.01 ON 01 FEB 98, APPLPAYROLL

Example 2 The following NOTIFY statement notifies a user if a specific job abends:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB4

NOTIFY ABEND USERS(CYB01) ROUTE(2) DESC(2)RUN WORKDAYS

ENDJOB

In the above example, if PAYJOB4 abends, notification is sent to user CYB01 andall consoles with route code 2. Descriptor code 2 is used to highlight the message.

Example 3 The following NOTIFY statements notifies various users if specific jobs abend:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’NOTIFY ABEND USERS(CYB01)JOB PAYJOB5

NOTIFY ABEND USERS(CYB02)RUN WORKDAYSREL PAYJOB6

JOB PAYJOB6RUN WORKDAYS

ENDJOB

In the above example, notification is sent to user CYB01 for any job in thePAYROLL Application that abends, except for PAYJOB5 where notification is sentto user CYB02.

Continued on next page

Page 520: ESP 5.2 Command Reference

520

NOTIFY Statement, Continued

Example 4 The following NOTIFY statement triggers an Event associated with an alertidentifier:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’NOTIFY ABEND ALERT(INFO)JOB PAYJOB7

REL PAYJOB8JOB PAYJOB8ENDJOBSELECT (PAYJOB7,PAYJOB8)

In the above example, if any job within the PAYROLL Application abends, an alertEvent associated with the INFO identifier is triggered.

Note: The INFO identifier is defined using the ALERTDEF command.

Example 5 The following NOTIFY statement triggers an Event associated with an alertidentifier:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’NOTIFY OVERDUE ALERT(LATE)JOB PAYJOB9

RUN WORKDAYSREL PAYJOB10

JOB PAYJOB10RUN WORKDAYS

ENDJOB

In the above example, if any job within the PAYROLL Application becomesoverdue, an alert Event associated with the LATE identifier is triggered.

Example 6 The following NOTIFY statement notifies a user when jobs within an Applicationstart and end:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’NOTIFY JOBSTART JOBEND USERS(CYB01)JOB PAYJOB11

RUN WORKDAYSREL PAYJOB12

JOB PAYJOB12RUN WORKDAYS

ENDJOB

In the above example, when each job within the PAYROLL Application starts andends, user CYB01 receives notification.

Continued on next page

Page 521: ESP 5.2 Command Reference

521

NOTIFY Statement, Continued

Example 7 The following NOTIFY statement re–triggers the same Event and ESP Procedure.

/*Check invocationIF MNJOB NE ‘’ THEN DO

IF MNPOINT=‘OVERDUE’ AND MNJOB=‘WAIT4’ AND MNQUAL=‘TAPE’THEN +

ESP AJ ALL COMPLETE APPL(%MNAPPL..%MNAPPLGEN)EXIT

ENDDO/*Regular processingAPPL TAPEJOBSJCLLIB ‘CYBER.JCL.CNTL’NOTIFY OVERDUE ALERT(*)JOB WAIT4.TAPE TASK

DUEOUT EXEC 7PMRUN DAILYRELEASE NEXTJOB

ENDJOBJOB NEXTJOB

RUN DAILYENDJOB

In the above example, this Application should be marked complete if a task calledWAIT4.TAPE has not been marked complete by 7 pm. The ESP Procedure tests theMNJOB (monitor jobname) variable to see if ESP is invoking the Procedure due tothe triggering of an Event or due to the ALERT keyword:

• If MNJOB is a null string, ESP generates the Application• Otherwise, the ESP Procedure is being invoked by the Alert. ESP verifies the

monitor point and the name of the overdue job, and completes the Application.

Page 522: ESP 5.2 Command Reference

522

ON Command

Overview The ON command is used in conjunction with the SCHEDULE command toadvance, delay or ignore Event processing if the Event falls on a holiday, weekday,weekend or particular day of the week.

Type Event definition command.

Syntax The syntax of the ON command is:

ON type{ADVANCE}{DELAY}{IGNORE}[n DAYS][n WEEKDAYS]

Parameter Descriptiontype Indicates a type of day. This can be any of the following:

• HOLIDAY - Installation defined holidays. TheLISTHOL command is used to display the holidayscurrently defined by the installation.

• WEEKDAY - Any day of the week except Saturday andSunday.

• WEEKEND - A Saturday or Sunday.• dayname - The name of a single day of the week, e.g.

Saturday, Monday, etc.ADVANCE Indicates the Event is to be advanced (i.e. run earlier) by a

specified number of days or weekdays.DELAY Indicates the Event is to be delayed (i.e. run later) by a

specified number of days or weekdays.IGNORE Specifies if the Event falls on one of the specified days, it is

to be bypassed.n Indicates the number of days or weekdays the Event is to be

advanced or delayed.DAYS Indicates n equals the number of days for the schedule to be

advanced or delayed. This includes Saturdays and Sundays.WEEKDAYS Indicates n equals the number of weekdays for the schedule to

be advanced or delayed. This excludes Saturdays andSundays.

Continued on next page

Page 523: ESP 5.2 Command Reference

523

ON Command, Continued

Usage notes You must use the keyword HOLIDAY, which includes all holidays in the calendarsassociated with the Event. You cannot use a specific holiday name, such asCHRISTMAS.

Your scheduling criteria for Event execution may create conflicts. For example, ifyou want the Event to execute on the second day of every month, but it cannot runon a weekend, tell ESP to either:

• Advance the Event (run it sooner than usual) by any number of days orweekdays

• Delay the event (run it later than usual) by any number of days or weekdays• Ignore the Event (do not run it at all).

If the processing of an ON command results in an Event time earlier than theprevious execution of the Event, that schedule time is ignored. An ON statementaffects only the scheduling of an Event through a SCHEDULE statement.SUSPEND, RESUME, HOLD and RELEASE are not subject to ON conditiontesting.

Use the NEXT command to display the next execution times of an Event. Changesdue to an ON statement are reflected.

Relatedinformation

For information on Events, see Processing ESP Events in the ESP WorkloadManager User’s Guide.

For information on scheduling criteria see, Schedule Criteria in the ESP WorkloadManager User’s Guide.

For information on specifying when a scheduled Event should not execute, see theNOSCHED command.

Example 1 The following is an example of a scheduled Event definition that delays the Eventexecution on a specific day:

EVENT ID(CYBER.PAYROLL)SCHEDULE MONDAY AT 6AM EVERY 14 DAYSON HOLIDAY DELAY 1 DAYINVOKE ‘CYBER.PROCLIB.CNTL(PAYROLL)’ENDDEF

In the above example, CYBER.PAYROLL is scheduled at 6 am every 14 days.When a particular Monday falls on a holiday, the Event is delayed by one day. If thenext day is also a holiday, the Event is delayed again until it falls on a day that is nota holiday. However, to calculate the next Event time, 14 days are added to theoriginal Monday, even though it was a holiday.

Continued on next page

Page 524: ESP 5.2 Command Reference

524

ON Command, Continued

Example 2 The following is an example of a scheduled Event definition that advances the Eventexecution on holidays:

EVENT ID(CYBER.PAYROLL)SCHEDULE 4PM 15TH DAY OF MONTHON HOLIDAY ADVANCE 1 DAYINVOKE ‘CYBER.PROCLIB.CNTL(PAYROLL)’ENDDEF

In the above example, CYBER.PAYROLL is schedule at 4 pm on the 15th day of themonth. On holidays, the Event is advanced 1 day.

Example 3 The following is an example of a scheduled Event definition that ignores the Eventexecution on holidays:

EVENT ID(CYBER.PAYROLL)SCHEDULE FIRST DAY OF THE MONTHON HOLIDAY IGNOREINVOKE ‘CYBER.PROCLIB.CNTL(PAYROLL)’ENDDEF

In the above example, CYBER.PAYROLL is scheduled on the first day of themonth. On holidays the Event is bypassed.

Example 4 The following is an example of a scheduled Event definition that delays the Eventexecution on holidays:

EVENT ID(CYBER.PAYROLL)SCHEDULE 8AM FIRST DAY OF MONTHON HOLIDAY DELAY 7 DAYSINVOKE ‘CYBER.PROCLIB.CNTL(PAYROLL)’ENDDEF

In the above example, CYBER.PAYROLL is scheduled at 8 am on the first day ofthe month. On holidays the Event delayed 7 days.

Example 5 The following is an example of a scheduled Event definition that delays the Eventexecution on holidays:

EVENT ID(CYBER.PAYROLL)SCHEDULE 4PM 15TH DAY OF MONTHON HOLIDAY DELAY 1 WEEKDAYINVOKE ‘CYBER.PROCLIB.CNTL(PAYROLL)’ENDDEF

In the above example, CYBER.PAYROLL is scheduled at 4 pm on the 15th day ofthe month. On holidays the Event is delayed 1 weekday.

Page 525: ESP 5.2 Command Reference

525

OPTIONS Statement

Overview The OPTIONS statement is used to override the default processing options for jobsbelonging to Applications.

Type ESP Application statement.

Syntax The syntax of the OPTIONS statement is:

OPTIONS [INHERIT|NOINHERIT][GENNET|NOGENNET][MANUALSUBMIT|NOMANUALSUBMIT|[TRACKMANUAL|NOTRACKMANUAL][AUTOVARS|NOAUTOVARS][RESTARTSTEP|NORESTARTSTEP]

Parameter DescriptionINHERIT Indicates job relationships are inherited. This is the

default.NOINHERIT Indicates job relationships are not inherited.GENNET Indicates DJC/JES3 NET control cards are generated

for jobs in a DJCNET. This is not applicable to ESPApplications. This is the default.

NOGENNET Indicates DJC/JES3 NET control cards are notgenerated for jobs in a network. This can be used ifthe jobs you are submitting already have NET controlcards.

MANUALSUBMIT Indicates jobs are manually submitted.NOMANUALSUBMIT Indicates jobs will not be manually submitted. This is

the default.TRACKMANUAL Indicates jobs are tracked manually.NOTRACKMANUAL Indicates jobs are not tracked manually.AUTOVARS Indicates ESP allows the use of the automatic variable

insertion feature. This is the default.NOAUTOVARS Indicates ESP does not allow the use of the automatic

variable insertion feature.RESTARTSTEP Indicates a restart step is added to each job in an

Application as identified by the ERMSTEPinitialization parameter.

NORESTARTSTEP Indicates a restart step is not added to each job in anApplication. This is the default.

Continued on next page

Page 526: ESP 5.2 Command Reference

526

OPTIONS Statement, Continued

Usage notes The OPTIONS statement is normally used before your job definitions. OPTIONSRESTARTSTEP/NORESTARTSTEP is available at the job level as well as theSubApplication level for jobs in an Application.

You can use different keywords on a JOB statement to override theMANUALSUBMIT/NOMANUALSUBMIT and the INHERIT/NOINHERIToptions.

It is not necessary to specify NOGENNET for jobs defined in an Application.

Relatedinformation

For information on Applications, see the ESP Workload Manager User’s Guide.

For information on overriding inherited relationships, see the ESP WorkloadManager Advanced User’s Guide.

For information on using the automatic variable insertion feature, see the ESPWorkload Manager Advanced User’s Guide.

For information on adding a restart step, see the ESP Workload Manager AdvancedUser’s Guide.

For information on rerunning/restarting jobs belonging to Applications, see the ESPEncore User’s Guide.

Example 1 The following OPTIONS statement overrides processing options for an Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’OPTIONS RESTARTSTEPJOB PAYJOB1

RUN DAILYREL PAYJOB2

JOB PAYJOB2RUN DAILYREL PAYJOB3

JOB PAYJOB3RUN DAILYOPTIONS NORESTARTSTEP

ENDJOB

In the above example, the OPTIONS RESTARTSTEP statement is used to add arestart step to each job in the PAYROLL Application, except for PAYJOB3.

Continued on next page

Page 527: ESP 5.2 Command Reference

527

OPTIONS Statement, Continued

Example 2 The following OPTIONS statement overrides processing options for an Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’OPTIONS NOINHERITJOB PAYJOB4

RUN DAILYREL PAYJOB5

JOB PAYJOB5RUN FRIDAYREL PAYJOB6

JOB PAYJOB6RUN DAILY

ENDJOB

In the above example, the OPTIONS NOINHERIT statement is used to indicate thatsuccessors to a job are not to inherit job relationships and that relationships among ajob and its successors exist only if there is a definition starting the relationship. If itis not Friday, no relationship exists between PAYJOB4 and PAYJOB6.

Example 3 The following OPTIONS statement identifies processing options for asubApplication:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB RECJOB1

SUBAPPL RECEIVERUN DAILYREL RECJOB2

JOB RECJOB2SUBAPPL RECEIVERUN DAILY

ENDJOBOPTIONS RESTARTSTEPJOB PAYJOB1

SUBAPPL PAYABLEREL PAYJOB2RUN DAILY

JOB PAYJOB2SUBAPPL PAYABLERUN DAILY

ENDJOB

In the above example, the OPTIONS RESTARTSTEP statement is used at thesubApplication level to add a restart step to each job in the PAYABLEsubApplication.

Continued on next page

Page 528: ESP 5.2 Command Reference

528

OPTIONS Statement, Continued

Example 4 The following OPTIONS statement overrides processing options for an Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’OPTIONS MANUALSUBMITJOB PAYJOB6

RUN DAILYREL PAYJOB7

JOB PAYJOB7RUN DAILYREL PAYJOB8

JOB PAYJOB8RUN DAILY

ENDJOB

In the above example, the OPTIONS MANUALSUBMIT statement is used toidentify each job in the PAYROLL Application as manually submitted. This isuseful when another product is submitting work and you want to monitor this workthrough the CSF.

Page 529: ESP 5.2 Command Reference

529

PANSUB Command

Overview The PANSUB command is used to submit JCL from a Panvalet data set to theinternal reader.

Type Event definition command.

Syntax The syntax of the PANSUB command is:

PANSUB dsname[(member)][MEMBER(member)]

Parameter Descriptiondsname Indicates a valid PANVALET data set name. You do not

have to specify ‘PAN-’ as a data set identifier because usingthe PANSUB command implies the use of a PANVALETdata set.

member Indicates a member name, which can consists of up to eightcharacters if specified as part of the data set name or up to tencharacters as a parameter of the MEMBER keyword.

Usage notes Several PANSUB commands may be specified in a single Event. The input data areeffectively concatenated together, so that data from several data sets can be joined toform one or more jobs.

In the same Event you can also use the SUBMIT command, and submit JCL fromROSCOE and LIBRARIAN data sets.

To submit JCL from a PANVALET library as part of an Application, use PAN- as aprefix for your data set name on the JCLLIB statement.

Relatedinformation

For information on submitting JCL from an Event, see the ESP Workload ManagerUser’s Guide.

Example 1 The following is an example of an Event definition that submits JCL from aPANVALET data set:

EVENT ID(CYBER.PANJOB1)SCHEDULE 9AM FIRST MONDAY OF MONTHPANSUB PANDS.DATA(PAYJOB1)ENDDEF

In the above example, PAYJOB1 is submitted from PANVALET data setPANDS.DATA.

Continued on next page

Page 530: ESP 5.2 Command Reference

530

PANSUB Command, Continued

Example 2 The following is an example of an Event definition that submits JCL from aPANVALET data set:

EVENT ID(CYBER.PANJOB2)SCHEDULE 7PM LAST WORKDAY OF MONTHPANSUB CYB.JCL MEMBER(LONGJOB999)ENDDEF

In the above example, LONGJOB999 is submitted from PANVALET data setCYB.JCL. Using the MEMBER keyword allows names up to 10 characters.

Page 531: ESP 5.2 Command Reference

531

PASSWORD Command

Overview The PASSWORD command is used to alter the ESP password associated with youruser ID. This command only applies if you do not have a host security product suchas RACF, ACF2 or Top Secret.

Type General command.

Syntax The syntax of the PASSWORD command is:

PASSWORD oldpswdnewpswd

Parameter Descriptionoldpswd Indicates your current password.newpswd Indicates the new password you want to use.

Usage notes If you are not using a security product and would like to allow the user access toESP through a batch job, you can assign a password to the user.

Relatedinformation

For information on ESP’s internal security, see the ESP Workload ManagerAdministrator’s Guide.

Example 1 The following PASSWORD command alters an ESP password:

PASSWORD APPLES ORANGES

In the above example, the password associated with your user ID is changed fromAPPLES to ORANGES.

Page 532: ESP 5.2 Command Reference

532

PNODES Statement

Overview The PNODES statement is used to specify the name(s) of any user-definedProcessing nodes through which the job must pass before it can be marked ascomplete.

Note: The Application Manager submits successor jobs to those identified with thePNODES statement when the predecessors successfully complete.

Type ESP Application statement.

Syntax The syntax of the PNODES statement is:

PNODES {pnode}{(pnode[,pnode])}

Parameter Descriptionpnode Indicates a P-Node name in up to eight characters. Enclose

multiple P-Node names in parentheses, separated by a blankor comma.

Usage notes This element is used to define any additional user-defined processing nodes for ajob, overriding the P-Nodes specified in the job’s tracking model. The P-Nodesrepresent post-execution phases, they cannot be used for pre-processing.

A job does not need to complete any manual phases for a successor job to run. Ifyou need to set up job dependencies with a manual phase of a job, consider usingtasks in an ESP Application.

Once you define the P-Node name, authorized users can simply type the POSTcommand to post a job as complete at a specific P-Node.

CSF PNODES fields, such as INPUT, EXEC, COMPLETE and FAIL apply only tojobs in an ESP Application and do not include post–execution phases.

Once a P-Node is defined, all users have read access to it.

Continued on next page

Page 533: ESP 5.2 Command Reference

533

PNODES Statement, Continued

Relatedinformation

For information on defining processing nodes (P-Nodes), see the ESP WorkloadManager Advanced User’s Guide.

For information on defining and deleting manual P-Nodes, see the DEFPN andDELPN commands.

For information on displaying P-Node information, see the LISTPN command.

For information on posting a job complete from a manual P-Node, see the POSTcommand.

For information on specifying the name of a P-Node when defining a trackingmodel, see the DEFTM command.

For information on using a TASK workload object to identify manual processingpoints in an Application, see the ESP Workload Manager User’s Guide.

Example 1 The following PNODES statement specifies a user-defined processing node:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN WORKDAYSREL PAYJOB2PNODES BALANCE

JOB PAYJOB2RUN WORKDAYS

ENDJOB

In the above example, PAYJOB1 must be posted out of the BALANCE P-Nodebefore the Tracking Manager considers it complete. PAYJOB2 is released whenPAYJOB1 completes; it does not wait for PAYJOB1 to be posted, from theBALANCE P-Node.

Similar results could be accomplished using a TASK workload object to represent amanual process (the balancing of a report) and is coded as follows:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN WORKDAYSREL BALANCE.RPT

JOB BALANCE.RPT TASKRUN WORKDAYSREL PAYJOB2

JOB PAYJOB2RUN WORKDAYS

ENDJOB

In the above example, when the report produced by PAYJOB1 is balanced, a usercompletes BALANCE.RPT using the APPLJOB (AJ) command, or via the CSF.PAYJOB2 is then released.

Continued on next page

Page 534: ESP 5.2 Command Reference

534

PNODES Statement, Continued

Example 2 The following PNODES statement specifies two user-defined processing nodes:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB3

RUN WORKDAYSREL PAYJOB4PNODES (BURSTER,DISTRIB)

JOB PAYJOB4RUN WORKDAYS

ENDJOB

In the above example, PAYJOB3 must be posted out of the BURSTER andDISTRIB P-Nodes before the Tracking Manager considers it complete. PAYJOB4is released when PAYJOB3 completes; it does not wait for PAYJOB3 to be postedfrom these manual P-Nodes..

Page 535: ESP 5.2 Command Reference

535

POST Command

Overview The POST command is used to post a job complete from a manually defined P-Nodeas defined in an Application using the PNODES statement.

Type General command.

Authority OPER authority is required to issue the POST command.

Syntax The syntax of the POST command is:

POST {job(jobnumber)}[PNODE(pnodename)][FORCE|PURGE]

Parameter Descriptionjob|jobnumber Indicates the name or number of the job to be posted. If a job

number is specified, it should consist of numeric digits only.To uniquely identify a job, both a job name and job numbercan be specified. In this format, the job number is enclosed inparentheses immediately following the job name. Thereshould be no intervening blanks or commas.

pnodename Indicates the name of the P-Node on which the job completedprocessing. The job must currently be queued to that P-Nodeunless FORCE or PURGE is also specified. If this parameteris omitted, the default P-Node for the console or user is used.The default P-Node is specified by the DFPNODE command.

FORCE Indicates the job is posted as complete at a P-Node, eventhough it is not currently queued to that P-Node.

PURGE Indicates the job is removed from any P-Node queue and ismarked as complete.

Usage notes A job does not need to complete any manual phases for a successor job to run. Ifyou need to set up job dependencies with a manual phase of a job, consider usingtasks in an ESP Application.

Once you have defined the P-Node name, authorized users can simply type thePOST command to post a job as complete at a specific P-Node.

Relatedinformation

For information on defining processing nodes (P-Nodes), see the ESP WorkloadManager Advanced User’s Guide.

For information on displaying job on PNODE queues, see the DN command.

Continued on next page

Page 536: ESP 5.2 Command Reference

536

POST Command, Continued

Example 1 The following PNODES statement specifies a user defined processing node:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN WORKDAYSPNODES BALANCE

ENDJOB

In the above example, PAYJOB1 must be posted out of the BALANCE P-Nodebefore it is considered complete. To display the BALANCE P-Node issue thefollowing command:

DN QUEUE(BALANCE)BALANCE: PAYJOB1 09812

Issue the POST command, using one of the following methods, to completePAYJOB1 from the BALANCE P-Node:

POST PAYJOB1 PNODE(BALANCE)

orPOST 9812 PNODE(BALANCE)

orPOST PAYJOB1(9812) PNODE(BALANCE)

orDFPNODE BALANCE - sets the default P-NodePOST PAYJOB1

Page 537: ESP 5.2 Command Reference

537

POSTREQ Statement

Overview The POSTREQ statement is used to specify the names of any other jobs that mustrun after this job executes. ESP automatically selects the jobs for submissionwhenever this job is selected for processing.

Type ESP Application statement.

Syntax The syntax of the POSTREQ statement is:

POSTREQ {jobname}{(jobname{(A)|(U)|(N)[,jobname(A)|(U)|(N]...})}{ADD(jobname{(A)|(U)|(N)[,jobname(A)|(U)|(N]...})}{DROP(jobname{(A)|(U)|(N)[,jobname(A)|(U)|(N]...})}

Parameter Descriptionjobname Indicates a jobname in up to eight characters and may include

a qualifier in up to eight characters. Enclose multiple jobnames in parentheses, separated by a blank or a comma.

ADD Indicates the specified job(s) be added to those currentlydefined as POSTREQs for the job.

DROP Indicates the specified job(s) be dropped from those currentlydefined as POSTREQs.

A Indicates the specified job(s) are released on abnormaltermination, including condition code failures, of apredecessor.

U Indicates the specified job(s) are released on any terminationof a predecessor.

N Indicates the specified job(s) are released on normaltermination of a predecessor. This is the default.

Usage notes POSTREQ can be used with any job to name other jobs that should be selected afterthis job completes (default is successful completion). POSTREQ dynamicallycreates dependencies between this job and the jobs you specify as postrequisites.This POSTREQ statement automatically forces selection of the postrequisite jobs--no SELECT statement or RUN statement needs to be specified for them.Completion of a job decrements the hold count on each postrequisite job.

A POSTREQ statement in an ESP Procedure overrides any previous POSTREQstatement for the same job unless the ADD keyword is specified.

The termination parameters (A,U,N) are available only for jobs in an Application.For jobs in a DJC jobnet, use the ABNORMAL and NORMAL parameters asdocumented in the DJC User’s Guide.

Job definition for POSTREQ jobs are required only if you need to specifyrequirements for these jobs.

Continued on next page

Page 538: ESP 5.2 Command Reference

538

POSTREQ Statement, Continued

Relatedinformation

For information on specifying job relationships, see the AFTER, RELEASE,PREREQ, and POSTREQ statements.

For information on Applications, see the ESP Workload Manager User’s Guide.

Example 1 The following POSTREQ statement identifies job relationships within anApplication:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN WORKDAYSPOSTREQ PAYJOB2

ENDJOB

In the above example, PAYJOB2 is automatically selected for submission and runsafter PAYJOB1 successfully completes.

Example 2 The following POSTREQ statement identifies job relationships within anApplication:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB3

RUN WORKDAYSPOSTREQ (PAYJOB4,PAYJOB5,PAYJOB6)

JOB PAYJOB4JOB PAYJOB5JOB PAYJOB6ENDJOB

In the above example, PAYJOB4, PAYJOB5 and PAYJOB6 are automaticallyselected for submission and runs after PAYJOB3 successfully completes.

Example 3 The following POSTREQ statement identifies job relationships within anApplication:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB7

RUN DAILYPOSTREQ (PAYJOB8(A))

JOB PAYJOB8ENDJOB

In the above example, PAYJOB8 is automatically selected for submission and runsafter the abnormal termination of PAYJOB7. If PAYJOB7 completes successfully,PAYJOB8 is not eligible for submission.

Continued on next page

Page 539: ESP 5.2 Command Reference

539

POSTREQ Statement, Continued

Example 4 The following POSTREQ and CLANG statements identify job relationships withinan Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB9

RUN WORKDAYSPOSTREQ (PAYJOB10,PAYJOB11)IF TODAY(‘FRIDAY’) THEN POSTREQ ADD(PAYJOB12,PAYJOB13)

JOB PAYJOB10JOB PAYJOB11JOB PAYJOB12JOB PAYJOB13ENDJOB

In the above example:

• PAYJOB10 and PAYJOB11 are automatically selected for submission and runafter PAYJOB9 successfully completes

• PAYJOB12 and PAYJOB13 are automatically selected for submission onFridays and run after PAYJOB9 successfully completes

Example 5 The following POSTREQ ADD statements are used to indicate job relationships:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB14

RUN DAILYPOSTREQ ADD(PAYJOB15)POSTREQ ADD(PAYJOB16)

ENDJOB

In the above example, PAYJOB15 and PAYJOB16 are automatically selected forsubmission and run after PAYJOB14 successfully completes.

Example 6 The following PREREQ and POSTREQ statements simplify job relationships:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB LINKIT LINK PROCESS

RUN DAILYPREREQ (PAYJOB17,PAYJOB18,PAYJOB19)POSTREQ (PAYJOB20,PAYJOB21,PAYJOB22)

ENDJOB

In the above example, a link represents the completion of the first three jobs, andreleases the second group of three jobs.

Continued on next page

Page 540: ESP 5.2 Command Reference

540

POSTREQ Statement, Continued

Example 7 The following POSTREQ statement identifies job relationships for qualified jobswithin an Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB23.RUN1

RUN DAILYPOSTREQ PAYJOB23.RUN2

ENDJOB

In the above example, PAYJOB23.RUN2 is automatically selected for submissionand runs after PAYJOB23.RUN1 successfully completes.

Page 541: ESP 5.2 Command Reference

541

PREALLOC Command

Overview The PREALLOC command is used to pre-allocate a data set.

Type General command.

Authority OPER authority is required to issue the PREALLOC command.

Syntax The syntax of the PREALLOC command is:

PREALLOC [dataset][ALLOC|UNALLOC]

Parameter Descriptiondsname Indicates the data set name.ALLOC Indicates the data set be allocated.UNALLOC Indicates a previously allocated data set be restored to non-

preallocated status.

Usage notes ESP bypasses dynamic allocation for each pre-allocated data set when access to thedata set is needed.

Use one PREALLOC statement for each data set you wish to pre-allocate.

This statement can be issued as a command with no operands to display the currentpre-allocation list of data sets, and with the UNALLOC operand to restore apreviously allocated data set to non-preallocated status.

Relatedinformation

For information on defining ESP data sets, see the ESP Workload ManagerInstallation Guide.

Example 1 The following PREALLOC command displays the current pre-allocation list:

OPER PREALLOC

In the above example, the current pre-allocation list is displayed.

Example 2 The following PREALLOC command pre-allocates a data set:

OPER PREALLOC CYBER.JCL.CNTL ALLOC

In the above example, CYBER.JCL.CNTL is pre-allocated for used by ESP.

Continued on next page

Page 542: ESP 5.2 Command Reference

542

PREALLOC Command, Continued

Example 3 The following PREALLOC command unallocates a data set:

OPER PREALLOC CYBER.ESP.PROCS UNALLOC

In the above example, CYBER.ESP.PROCS is unallocated from ESP.

Page 543: ESP 5.2 Command Reference

543

PREREQ Statement

Overview The PREREQ statement is used to specify the names of any other jobs that mustcomplete before this job can execute. ESP automatically selects the jobs forsubmission whenever this job is selected for processing.

Type ESP Application statement.

Syntax The syntax of the PREREQ statement is:

PREREQ {jobname}{(jobname{(A)|(U)|(N)[,jobname(A)|(U)|(N]...})}{ADD(jobname{(A)|(U)|(N)[,jobname(A)|(U)|(N]...})}{DROP(jobname{(A)|(U)|(N)[,jobname(A)|(U)|(N]...})}

Parameter Descriptionjobname Indicates a jobname in up to eight characters and may include

a qualifier in up to eight characters. Enclose multiple jobnames in parentheses, separated by a blank or a comma.

ADD Indicates the specified job(s) be added to those currentlydefined as PREREQs.

DROP Indicates the specified job(s) be dropped from those currentlydefined PREREQs.

A Indicates the specified job(s) release the job you are definingon abnormal termination, including condition code failures.

U Indicates the specified job(s) release the job you are definingon any termination.

N Indicates the specified job(s) released the job you are definingon normal termination. This is the default.

Usage notes PREREQs can be used with any job to name other jobs that should be selectedbefore this job is allowed to execute. PREREQs dynamically create dependenciesbetween this job and the jobs you specify as prerequisites. This PREREQ statementautomatically forces selection of the prerequisite jobs, no SELECT or RUNstatement needs to be specified for them.

A PREREQ statement in an ESP Procedure overrides any previous PREREQstatement for the same job unless the ADD keyword is specified.

The termination parameters (A,U,N) are available only for jobs in an Application.For jobs in a DJC jobnet, use the ABNORMAL and NORMAL parameters asdocumented in the DJC User’s Guide.

Job definitions for PREREQ jobs are required only if you need to specifyrequirements for these jobs.

Continued on next page

Page 544: ESP 5.2 Command Reference

544

PREREQ Statement, Continued

Relatedinformation

For information on specifying job relationships, see the AFTER, RELEASE,COREQ, and POSTREQ statements.

For information on deselecting jobs for submission, see the NORUN andDESELECT statements.

For information on Applications, see the ESP Workload Manager User’s Guide.

Example 1 The following PREREQ statement identifies job relationships within an Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.JOB PAYJOB2

RUN WORKDAYSPREREQ PAYJOB1

ENDJOB

In the above example, PAYJOB1 is automatically selected for submission and runsbefore PAYJOB2.

Example 2 The following PREREQ statement identifies job relationships within an Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB3JOB PAYJOB4JOB PAYJOB5JOB PAYJOB6

RUN WORKDAYSPREREQ (PAYJOB3,PAYJOB4,PAYJOB5)

ENDJOB

In the above example, PAYJOB3, PAYJOB4 and PAYJOB5 are automaticallyselected for submission and run before PAYJOB6.

Example 3 The following PREREQ statement identifies job relationships within an Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB7JOB PAYJOB8

RUN WORKDAYSPREREQ (PAYJOB7(U))

ENDJOB

In the above example, PAYJOB7 is automatically selected for submission and runsbefore PAYJOB8. PAYJOB8 runs whether PAYJOB7 completes successfully ornot.

Continued on next page

Page 545: ESP 5.2 Command Reference

545

PREREQ Statement, Continued

Example 4 The following PREREQ and CLANG statements identify job relationships within anApplication:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB9JOB PAYJOB10JOB PAYJOB11JOB PAYJOB12JOB PAYJOB13

RUN WORKDAYSPREREQ (PAYJOB9,PAYJOB10)IF TODAY(‘MONDAY’) THEN PREREQ ADD(PAYJOB11,PAYJOB12)

ENDJOB

In the above example:

• PAYJOB9 and PAYJOB10 are automatically selected for submission and runbefore PAYJOB13

• PAYJOB12 and PAYJOB13 are automatically selected for submission onMondays and run before PAYJOB13.

Example 5 The following PREREQ statement identifies job relationships within an Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB14

RUN WORKDAYSPREREQ ADD(PAYJOB15)PREREQ ADD(PAYJOB16)

ENDJOB

In the above example, PAYJOB15 and PAYJOB16 are automatically selected forsubmission and run before PAYJOB14.

Example 6 The following PREREQ and POSTREQ statements simplify job relationships:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB LINKIT LINK PROCESS

RUN WORKDAYSPREREQ (PAYJOB17,PAYJOB18,PAYJOB19)POSTREQ (PAYJOB20,PAYJOB21,PAYJOB22)

ENDJOB

In the above example, a link represents the completion of the first three jobs, andreleases the second group of three jobs.

Continued on next page

Page 546: ESP 5.2 Command Reference

546

PREREQ Statement, Continued

Example 7 The following PREREQ statement identifies job relationships for qualified jobswithin an Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB23.RUN2

RUN WORKDAYSPREREQ PAYJOB23.RUN1

ENDJOB

In the above example, PAYJOB23.RUN1 is automatically selected for submissionand runs before PAYJOB23.RUN2.

Page 547: ESP 5.2 Command Reference

547

PRIORITY Statement

Overview The PRIORITY statement is used in conjunction with ESP resources to specify therelative priority of a workload object within an ESP group. The maximum value is99, while the minimum priority value is 0. The default is 0.

Type ESP Application statement.

Syntax The syntax of the PRIORITY statement is:

PRIORITY n

Parameter Descriptionn Indicates a number between 0 and 99. The higher the

number, the higher the priority of the job associated with it.The default is 0.

Usages notes The PRIORITY statement allows you to prioritize jobs within an ESP group. ESPuses the PRIORITY statement when two or more jobs within the same ESP grouprequire the same resource at the same time. In this case, ESP queues the higherpriority job ahead of the lower priority job. The queuing sequence of jobs in othergroups is not affected.

The ESP group name is determined by the Event prefix (i.e. first part of the Eventidentifier). For example:

• CYBER.nnn identifies a job belonging to the CYBER group• PROD.nnn identifies jobs in the PROD group.

For instance, a job that is assigned a priority in a group called CYBER is onlycompared to other jobs in the CYBER group, and not to jobs in another group calledPROD.

The PRIORITY statement applies only to renewable and depletable resources.

Relatedinformation

For information on resources, see the ESP Workload Manager User’s Guide.

For information on requesting resources, see the RESOURCE statement.

Continued on next page

Page 548: ESP 5.2 Command Reference

548

PRIORITY Statement, Continued

Example 1 The following PRIORITY statements are used to prioritize jobs within the same ESPgroup that require the same resource:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN DAILYREL (PAYJOB2,PAYJOB3)

JOB PAYJOB2PRIORITY 99RUN DAILYRESOURCE (1,CICS)

JOB PAYJOB3PRIORITY 9RUN DAILYRESOURCE (1,CICS)

ENDJOB

In the above example, PAYJOB2 has a priority of 99 and is queued ahead ofPAYJOB3, which has a priority of 9. Both jobs belong to the same ESP group andboth jobs require 1 unit of the CICS resource.

Page 549: ESP 5.2 Command Reference

549

PROFILE Statement

Overview A PROFILE statement is used to identify the Event prefix and the EVENTSET thatESP uses to store Events. Optionally, the statement may also identify a History filefrom which a user can report and the default calendars that the Event uses.

Type User Profile Definition Table statement.

Syntax The syntax of the PROFILE statement is:

PROFILE USER(uuuu)EVENTSET(eventset)[HIST(histid)][CALENDAR1(cccc)][CALENDAR2(dddd)]

Parameter Descriptionuuuu Indicates an Event prefix specification (normally equivalent

to a security user ID). The specification may includewildcards.

eventset Indicates the logical ID (eight character internal name) of anEvent data set. It must be a specific name.

histid Indicates the logical ID (eight character internal name) of aHistory file. The specification may include wildcards.

cccc Indicates the name of a calendar to be used as the first defaultcalendar.

dddd Indicates the name of a calendar to be used as the seconddefault calendar.

Usage notes The order of PROFILE statements in the User Profile Definition Table is important,with the most generic statement as the last one in the table. This sequence takes intoaccount the fact that ESP scans the table from top to bottom until it finds aPROFILE statement that matches the prefix of the new Event.

The profile name can include the ESP wildcard characters ‘*’ and ‘-’. The ‘*’matches a single character, and the ‘-’ matches any remaining characters.

As a minimum, ESP requires a User Profile Definition Table loaded from a data setthat contains a single PROFILE statement that sets the Eventset default for all newEvents.

The HISTFILE parameter allows wildcard specifications. This is useful in caseswhere it is desired to allow individual users to process history reports based on morethan one history file. Only one HISTFILE specification may be entered for a givenPROFILE definition.

Continued on next page

Page 550: ESP 5.2 Command Reference

550

PROFILE Statement, Continued

Relatedinformation

For information on using SAF, see the ESP Workload Manager Administrator’sGuide.

For information on loading the User Profile Definition Table, see the LOADUPDTcommand.

Example 1 The following PROFILE statement tells ESP where to save all new Events:

PROFILE USER(-) EVENTSET(EVENT1)

In the above example, ESP stores all new Events in the EVENT1 Eventset.

Example 2 The following PROFILE statement tells ESP where to save specific Events:

PROFILE USER(PROD) EVENTSET(EVENT1) CALENDAR1(CYBER) -HIST(HIST1)

In the above example, ESP stores Events with a prefix of PROD in the EVENT1Eventset. This example also indicates these Event use the CYBER calendar and theuser has access to the HIST1 history file.

Example 3 The following PROFILE statements show multiple entries in a UPDT:

PROFILE USER(PAY–) EVENTSET(PAYEVS) CALENDAR1(PAYCAL)PROFILE USER(PROD–) EVENTSET(PRODEVS) CALENDAR1(PROD)PROFILE USER(–) EVENTSET(EVENT1)

In the above example:

• The first PROFILE statement tells ESP to store Events with a prefix of PAY- inthe PAYEVS Eventset. It also indicates that these Events use the PAYCALcalendar.

• The second PROFILE statement tells ESP to store Events with a prefix ofPROD- in the PRODEVS Eventset. It also indicates that these Events use thePROD calendar.

• The third PROFILE statement tells ESP to store all other Events in the EVENT1Eventset.

Page 551: ESP 5.2 Command Reference

551

PURGSCHF Command

Overview The PURGSCHF command is used to purge completed schedule information fromthe SCHDFILE. This affects what a user sees on the CSF. Information should bepurged regularly to prevent space problems.

Type General command.

Authority OPER authority is required to issue the PURGSCHF command.

Syntax The syntax of the PURGSCHF command is:

PURGSCHF criteria

Parameter Descriptioncriteria Schedule criteria that resolve to a single date and time in the

past.

Usage notes The PURGSCHF command purges only completed jobs. Unless you set aUSERMOD, ESP purges only completed jobs in completed Applications.

The PURGSCHF command does not use any calendar, not even the system calendar,when resolving schedule criteria. If you need to purge schedule information basedon a calendar term, such as workdays, use the GENTIME command to generate anactual date, and use the generated symbolic as part of the PURGSCHF command.

Relatedinformation

For information on the Consolidated Status Facility, see the ESP Workload ManagerUser’s Guide.

Example 1 The following PURGSCHF command purges schedule information:

OPER PURGSCHF TODAY LESS 1 WEEK

In the above example, information older than 1 week is purged from the SCHDFILE.

Example 2 The following PURGSCHF command purges schedule information:

OPER PURGSCHF NOW LESS 36 HOURS

In the above example, information older than 36 hours is purged from theSCHDFILE.

Continued on next page

Page 552: ESP 5.2 Command Reference

552

PURGSCHF Command, Continued

Example 3 The following PURGSCHF command is used in conjunction with the GENTIMEcommand to purge schedule information:

GENTIME XX TODAY LESS 2 WORKDAYSESP OPER PURGSCHF %XXDATE

In the above example, the GENTIME command is used to generate the actual date.The customized date is then used as part of the PURGSCHF command to purgeinformation from the previous 2 workdays.

Note: The above commands reside in an ESP Procedure and are invoked by an ESPEvent.

Example 4 The following PURGSCHF command purges schedule information:

OPER PURGSCHF NOW

In the above example, information older than the current time is purged.

Page 553: ESP 5.2 Command Reference

553

QUIESCE Command

Overview The QUIESCE command is used to put ESP into a quiesced state. While ESP is in aquiesced state Event scheduling and Application processing are quiesced. Jobs thatare running when ESP is quiesced continue to run. No new jobs are submitted.

Type General command.

Authority OPER authority is required to issue the QUIESCE command

Syntax The syntax of the QUIESCE command is:

QUIESCE

Usage notes If ESP is being restarted, you can bring it up in a quiesced state by using theQUIESCE option on the start command.

Relatedinformation

For information on taking ESP out of the quiesced state, see the RESTARTcommand.

Example 1 The following QUIESCE command quiesces Event scheduling and Applicationprocessing:

OPER QUIESCE

In the above example, ESP is quiesced, which is displayed using the STATUScommand as follows:

OPER STATUSESP1977I ESP RELEASE 5.1.0.000 STATUSESP1978I EVENT SCHEDULING QUIESCEDESP1979I DATASET TRIGGERING ACTIVE

In the above example, ESP is in a quiesced state as noted by the ESP1978I message -EVENT SCHEDULING QUIESCED.

Page 554: ESP 5.2 Command Reference

554

QUIT Statement

Overview The QUIT statement is used to quit an ESP Procedure and the Event that invoked it.

Type ESP Control Language (CLANG) statement.

Syntax The syntax of the QUIT statement is:

QUIT

Usage notes Use QUIT to quit a process. If you use QUIT, ESP does not process any pendingrequests from this or any other Procedure invoked by the same Event.

ESP ignores QUIT statements within the scope of a JOB statement duringApplication generation. During Application processing, QUIT within the scope of aJOB statement causes ESP not to process any statements for the job and ESP doesnot submit the job.

RelatedStatements

For information on quitting from your current point in a procedure, see the EXITstatement.

For information on using ESP’s Control Language in Procedures, see the ESPWorkload Manager User’s Guide.

Example 1 The following procedure shows the differences between using EXIT and QUIT:

IF TODAY(‘CHRISTMAS’) THEN QUITIF TODAY(‘HOLIDAY’) THEN DO

SEND ‘NO WORK TODAY’ U(USER01)EXIT

ENDDOSEND ‘LET US CONTINUE PROCESSING’ U(USER02)

In the above example:

• If today is CHRISTMAS, ESP quits the ESP Procedure and no instructions areprocessed

• If today is not CHRISTMAS, but it is a holiday, ESP sends a message and exitsthe Procedure at that point

• If none of the above conditions is true, ESP sends a message indicating thatprocessing will continue.

Continued on next page

Page 555: ESP 5.2 Command Reference

555

QUIT Statement, Continued

Example 2 The following procedure shows the differences between using EXIT and QUITwithin the scope of the job statement:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN WORKDAYSRELEASE PAYJOB2IF TODAY(‘TUESDAY’) THEN -

EXITSEND ‘TODAY IS NOT MONDAY’ U(USR01)

ENDJOBJOB PAYJOB2

RUN WORKDAYIF TODAY(‘MONDAY’) THEN -

QUITENDJOB

In the above example, when the PAYROLL Application is generated on a Monday:

• PAYJOB1 is submitted, and a message is issued if it isn’t Monday• PAYJOB2 is not submitted and receives an error.

The following is an example of the CSF display after PAYJOB1 completes onMonday:

ESP Consolidated Status: View PAYROLL -- Row 1 of 2, Col 1COMMAND ===> SCR ===> PAGE

Jobname APPL PNODE STATUS___ PAYJOB1 PAYROLL COMPLETE COMPLETED AT 13.14 21 APR___ PAYJOB2 PAYROLL SUBERROR Submit Error, Quit

Page 556: ESP 5.2 Command Reference

556

QUPDATE Command

Overview The QUPDATE command is used to force ESP to do a JES status and update P-Node queue information.

Type General command.

Authority OPER authority is required to issue the QUPDATE command.

Syntax The syntax for the QUPDATE command is:

QUPDATE

Usage notes The QUPDATE command allows any job flushed from the system to be recognized.ESP automatically posts these jobs through the EXEC and OUTPUT processingnodes and marks each as a JCL ERROR.

Relatedinformation

For information on displaying P-Node information, see the LISTPN command.

Example 1 The following QUPDATE command updates P-Node queue information:

OPER QUPDATE

In the above example, ESP does a JES status and automatically posts any flushedjobs through the EXEC and OUTPUT P-Nodes.

Page 557: ESP 5.2 Command Reference

557

RACROUTE Command

Overview The RACROUTE command is used to specify how an Event is processed forsecurity purposes. You specify whether ESP should issue a SAF RACINIT prior toexecuting Events, and how the user ID associated with the Event is determined. TheRACROUTE command must be set to ON in environments using the SystemAuthorization Facility (SAF). RACROUTE is normally coded as an InitializationParameter.

Type General command.

Authority OPER authority is required to issue the RACROUTE command.

Syntax The syntax of the RACROUTE command is:

RACROUTE [ON|OFF][ITU|NOITU]

Parameter DescriptionON Indicates ESP should issue a SAF RACINIT before executing

Events.OFF Indicates ESP should not issue a SAF RACINIT before

executing Events. This is the default.ITU Inherit Trigger User - Indicates all triggered Events use the

triggering user ID and associated security profile.NOITU No Inherit Trigger User - Indicates all triggered Events use

the high-level prefix of the Event definition, unless USER isspecified in the Event definition. Only those Events that haveITU in the Event definition use the triggering user ID. This isthe default.

Usage notes If RACROUTE is set to ON, ESP issues a SAF call prior to executing Events. Thisensures Events are processed under ownership of the user ID that defined the Event.

If RACROUTE is set to OFF, ESP processes Events under the ownership of the ESPstarted task.

The ITU option affects Events only when the TRIGGER command is issued.

Relatedinformation

For information on the System Authorization Facility (SAF), see the ESP WorkloadManager Administrator’s Guide.

For information on using RACROUTE at the Initialization Parameter level, see theESP Workload Manager Installation Guide.

Continued on next page

Page 558: ESP 5.2 Command Reference

558

RACROUTE Command, Continued

Example 1 The following RACROUTE command specifies how Events are processed forsecurity purposes:

OPER RACROUTE ON

In the above example, ESP issues a SAF RACINIT before executing Events.

Page 559: ESP 5.2 Command Reference

559

REEXEC Statement

Overview The REEXEC statement is used to request re-execution of the ESP Procedure at aspecific time or after a certain time interval.

Type ESP Application statement

Syntax The syntax of the REEXEC statement is:

REEXEC {AT(‘time’)|IN(interval)}[DELAY|ADDITIONAL][MAXIMUM(count)|NOMAXIMUM]

Parameter Descriptiontime Schedule criteria that resolve to a single date and/or time. If

no time is implied, the start time of a day is used. Encloseparameter in quotes.

interval Indicates a whole number of minutes.DELAY Indicates that when the Procedure is re-executed, job

submission is delayed until the conditional processing is true.All other functions are executed. This is the default.

ADDITIONAL Indicates that additional job submission will take place withevery re-execution.

count Indicates the maximum number of times the Event is re-executed. A value between 1 and 255 can be specified.There is no default.

NOMAXIMUM The default is 255.

Usage notes This statement is used to request re-execution of an ESP Procedure at a specifiedtime or after a certain interval. The Event that invoked the ESP Procedurecontaining the REEXEC statement is scheduled for re-execution.

The variable %ESPREEXEC# can be used to check the number of times a Procedurewas re-executed. The variable is set to zero initially and cannot take on a valuegreater than 255.

ESP stores the number of re–executions in a symbolic variable calledESPREEXEC#. If you use REEXEC within the scope of a JOB statement in anApplication, ESP re–executes only the code associated with that job, and maintainsa separate ESPREEXEC# for each job.

Relatedinformation

For information on re-executing an ESP Procedure, see the ESP Workload ManagerUser’s Guide.

Continued on next page

Page 560: ESP 5.2 Command Reference

560

REEXEC Statement, Continued

Example 1 The following REEXEC command is used in conjunction with the ACTIVE built-infunction to check the status of a started task:

IF ACTIVE(‘CICS’) THEN DOSEND ‘CICS IS DUE TO COME DOWN’ CN(01)REEXEC IN(5)

ENDDOELSE SUBMIT ‘PROD.JCL.CNTL(CICSBKUP)’

In the above example:

• If CICS is active, ESP sends a message to console id 01 and re–executes theProcedure in 5 minutes.

• If CICS is not active, ESP submits the CICSBKUP from PROD.JCL.CNTL.

Example 2 The following REEXEC command is used in conjunction with the JOBONQ built-infunction to check for a specific job on the input queue:

INTEGER COUNTCOUNT=JOBONQ(‘RMTJOB’,‘X’,‘IH’)IF COUNT=1 THEN VS ‘$AJ%XJOBNO1’ELSE DOIF ESPREEXEC#<5 THEN REEXEC IN(30)ELSE SEND ‘I GIVE UP ON RMTJOB’ U(USER01)ENDDO

In the above example:

• If RMTJOB is on the input queue on hold, ESP releases the job.• If RMTJOB is not on the input queue on hold, ESP checks the number of re–

executions. If the number of re–executions is less than 5, ESP re–executes theProcedure in 30 minutes. Otherwise, ESP sends a message.

Example 3 The following REEXEC command delays the submission of a job:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN DAILYRELEASE PAYJOB2

JOB PAYJOB2RUN DAILYIF %ESPREEXEC#=0 THEN REEXEC AT(‘REALNOW PLUS 5 HOURS’)

ENDJOB

In the above example, PAYJOB2 is delayed for 5 hours after PAYJOB1 completes.

Continued on next page

Page 561: ESP 5.2 Command Reference

561

REEXEC Statement, Continued

Other examples Here are more examples using the REEXEC statement.

Indicates re-execution in 5 minutes:

REEXEC IN(5)

Indicates re-execution at the start of the next workday:

REEXEC AT(‘TODAY PLUS 1 WORKDAY’)

Indicates re-execution in 6 hours:

REEXEC AT(‘REALNOW PLUS 6 HOURS’)

Indicates re-execution in five minutes for a maximum of five times:REEXEC IN(5) MAXIMUM(5)

Indicates re-execution in one minute for an unlimited time:REEXEC IN(‘1 MINUTE’) NOMAXIMUM

Page 562: ESP 5.2 Command Reference

562

RELCOUNT Statement

Overview The RELCOUNT statement is used to specify the hold count when a job becomeseligible for submission. By default, ESP does not consider a job eligible forsubmission until its hold count is 0.

Type ESP Application statement.

Syntax The syntax of the RELCOUNT statement is:

RELCOUNT n

Parameter Descriptionn Indicates a positive integer representing the number of

outstanding predecessors before this job is eligible forexecution.

Usage notes If RELCOUNT is not specified, a job is not eligible for execution until allpredecessors are complete (that is, its hold count is reduced to zero).

Relatedinformation

For information on Applications, see the ESP Workload Manager User’s andAdvanced User’s Guides.

Example 1 The following RELCOUNT statement specifies when a job is eligible forsubmission:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN DAILYREL PAYJOB3

JOB PAYJOB2RUN DAILYREL PAYJOB3

JOB PAYJOB3RUN DAILYRELCOUNT 1

ENDJOB

In the above example, when ESP builds the Application, PAYJOB3 has a hold countof 2. By specifying a RELCOUNT of 1 for PAYJOB3, ESP releases this job whenits hold count becomes 1. ESP releases PAYJOB3 when either PAYJOB1 orPAYJOB2 completes successfully.

Continued on next page

Page 563: ESP 5.2 Command Reference

563

RELCOUNT Statement, Continued

Example 2 The following RELCOUNT statement specifies when a job is eligible forsubmission:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB4

RUN DAILYJOB PAYJOB5RUN DAILY

JOB PAYJOB6RUN DAILY

JOB PAYJOB7RUN DAILY

JOB PAYJOB8AFTER(PAYJOB4,PAYJOB5,PAYJOB6,PAYJOB7)RUN DAILYRELCOUNT 3

ENDJOB

In the above example, when ESP builds the Application, PAYJOB8 has a hold countof 4. By specifying a RELCOUNT of 3 for PAYJOB8, ESP releases this job whenits hold count becomes 3. This means ESP releases PAYJOB8 when any one of itspredecessors completes successfully.

Example 3 The following RELCOUNT statement specifies when a job is eligible forsubmission:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’DSTRIG FILEA

RUN DAILYRELEASE PAYJOB1DSNAME CYBER.ESP.FILEA

DSTRIG FILEBRUN DAILYRELEASE PAYJOB1DSNAME CYBER.ESP.FILEB

JOB PAYJOB1RUN DAILYRELCOUNT 1

ENDJOB

In the above example, when ESP builds the Application, PAYJOB1 has a hold countof 2. By specifying a RELCOUNT of 1 for PAYJOB1, ESP releases this job wheneither data set trigger object completes.

Page 564: ESP 5.2 Command Reference

564

RELDELAY Statement

Overview The RELDELAY statement is used to delay job submission at the time that a jobbecomes eligible for submission. The RELDELAY statement uses minutes as itsunit of measure. You can delay job submission up to 255 minutes.

Type ESP Application statement.

Syntax The syntax of the RELDELAY statement is:

RELDELAY nnn

Parameter Descriptionnnn Indicates a positive integer representing the number of

minutes to delay submission. The maximum value allowed is255; the default is 0.

Usage notes When a job becomes eligible for submission, ESP delays submission by the numberof minutes specified by the RELDELAY statement for the job. If a job requires ESPresources, the RELDELAY takes effect before the check for resource availability.

At the time a job is delayed for submission, the status field on the CSF indicates theresolved time and date of the RELDELAY statement, i.e. the number of minutesafter the delayed job becomes eligible for submission. You can reset this resolvedtime and date using the APPLJOB (AJ) command or the CSF to reset the earliestsubmit time.

Relatedinformation

For information on Applications, see the ESP Workload Manager User’s Guide.

For information on delaying the submission of a job relative to the time the Event isscheduled or triggered, see the DELAYSUB statement.

For information on monitoring and manipulating jobs from the CSF, see the ESPWorkload Manager User’s Guide.

For information on manipulating jobs within Applications or subApplications, seethe APPLJOB or AJ command.

If you need to delay more than 255 minutes, use the REEXEC statement.

Continued on next page

Page 565: ESP 5.2 Command Reference

565

RELDELAY Statement, Continued

Example 1 The following RELDELAY statement delays the submission of a specific job:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN DAILYREL PAYJOB2

JOB PAYJOB2RUN DAILYRELDELAY 5

ENDJOB

In the above example, when PAYJOB1 completes successfully, PAYJOB2 becomeseligible for submission and the RELDELAY statement delays the submission ofPAYJOB2 by 5 minutes.

Note: At the time PAYJOB2 is delayed for submission, the status field on the CSFindicates the resolved time and date of the RELDELAY statement, i.e. 5 minutesafter PAYJOB2 becomes eligible for submission, as follows:

E510 Consolidated Status: View PAYROLL - Row 1 of 3, Col 1COMMAND ===> SCR ===> PAGE

Jobname APPL GEN PNODE HC STATUS___ PAYJOB1 PAYROLL 131 COMPLETE 0 COMPLETED AT 21.54 03 FEB___ PAYJOB2 PAYROLL 131 WAITING 0 WAITING UNTIL 21.59 03 FEB

Example 2 The following RELDELAY statement delays a LINK:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB3

RUN DAILYREL FRED

JOB FRED LINK PROCESSRUN DAILYSEND ‘LINKS CAN USE THE RELDELAY STATEMENT TOO’ (USR01)RELDELAY 2REL PAYJOB4

JOB PAYJOB4RUN DAILY

ENDJOB

In the above example, a LINK (FRED), which is normally marked complete by ESPas soon as its dependencies are met, is delayed by 2 minutes after becoming eligiblefor submission, that is, after PAYJOB3 completes successfully.

Page 566: ESP 5.2 Command Reference

566

RELEASE Command - Event Level

Overview When used in an Event definition, the RELEASE command decrements the holdcount associated with the Event at a specified time. When the hold count reacheszero, the Event is eligible for execution. It is used in conjunction with the HOLDcommand.

Type Event definition command.

Syntax The syntax of the RELEASE command is:

RELEASE criteria

Parameter Descriptioncriteria Schedule criteria.

Usage notes The RELEASE command is used in conjunction with the HOLD command to makea previously postponed Event eligible for execution.

ESP processes any pending actions. For example, if an Event missed its scheduledtime while on hold, ESP processes the Event based on the OVERDUE count on theEvent’s SCHEDULE statement.

If you are using a time zone on your RELEASE command, it should match thetimezone on your HOLD command. If the Event has a schedule statement, the sametime zone should be used on the SCHEDULE, HOLD and RELEASE commands.

Note:

The SUSPEND command is used in conjunction with the RESUME command tomake a previously bypassed Event eligible for execution.

Relatedinformation

For information on Events, see the ESP Workload Manager User’s Guide.

For information on holding an Event, see the HOLD command.

For information on releasing a held Event outside of an Event definition, see theRELEASE Command - General.

For information on overdue Events, see the SCHEDULE command.

Continued on next page

Page 567: ESP 5.2 Command Reference

567

RELEASE Command - Event Level, Continued

Example 1 The following is an example of an Event definition:

EVENT ID(CYBER.PAYROLL)DSTRIG PAYROLL.INPUTHOLD DAILY AT 9AMRELEASE DAILY AT 11AMSUBMIT ‘CYBER.JCL.CNTL(PAYJOB1)’ENDDEF

In the above example, HOLD and RELEASE commands are used to preventPAYJOB1 from being submitted between 9 am and 11 am.

Example 2 The following is an example of an Event definition:

EVENT ID(CYBER.PAYROLL)SCHEDULE 6PM DAILYHOLD 5PM LAST DAY OF MONTHRELEASE 9PM LAST DAY OF MONTHSUBMIT ‘CYBER.JCL.CNTL(PAYJOB2)’ENDDEF

In the above example, HOLD and RELEASE commands are used to preventPAYJOB2 from being submitted between 5 pm and 9 pm on the last day of themonth.

Example 3 The following is an example of an Event definition:

EVENT ID(CYBER.PAYROLL)SCHEDULE 8AM WORKDAYSHOLD 7:59 FEB 13,1998 ONCERELEASE 10:01 FEB 13,1998 ONCESUBMIT ‘CYBER.JCL.CNTL(PAYJOB3)’ENDDEF

In the above example, HOLD and RELEASE commands are used to preventPAYJOB3 from being submitted between 7:59 and 10:01 on February 13, 1998only.

Page 568: ESP 5.2 Command Reference

568

RELEASE Command - General

Overview The RELEASE command decrements the hold count associated with an Event. It isused in conjunction with the HOLD command.

Type General command

Syntax The syntax of the RELEASE command is:

RELEASE eventid

Parameter Descriptioneventid Indicates a valid Event name. If no prefix is specified, ESP

uses the current prefix, set by the GROUP command.

Usage notes ESP processes any pending actions. For example, if an Event missed its scheduledtime while on hold, ESP processes the Event based on the OVERDUE count on theEvent’s SCHEDULE statement.

The specified Event has its HOLD count decremented immediately.

The RELEASE command is used in conjunction with the HOLD command to makea previously postponed Event eligible for execution.

Note:

The SUSPEND command is used in conjunction with the RESUME command tomake a previously bypassed Event eligible for execution.

Relatedinformation

For information on overdue Events, see the SCHEDULE command.

For information on Events, see the ESP Workload Manager User’s Guide.

For information on holding an Event, see the HOLD command.

For information on using RELEASE within an Event, see the RELEASE Command -Event Level.

Examples 1 The following RELEASE command releases an Event:

RELEASE CYBER.PAYROLL

In the above example, CYBER.PAYROLL was previously held and is now eligiblefor execution if the hold count was 1. Otherwise, the hold count was decrement by 1.

Page 569: ESP 5.2 Command Reference

569

RELEASE Statement

Overview The RELEASE statement is used to identify a successor to a job. The successor isreleased upon completion of this job.

Type ESP Application statement.

Syntax The syntax of the RELEASE statement is:

RELEASE {jobname}{(jobname{(A)|(U)|(N)[,jobname(A)|(U)|(N]...})}{ADD(jobname{(A)|(U)|(N)[,jobname(A)|(U)|(N]...})}{DROP(jobname{(A)|(U)|(N)[,jobname(A)|(U)|(N]...})}

Parameter Descriptionjobname Indicates a jobname in up to eight characters. Enclose

multiple job names in parentheses, separated by a blank or acomma. Jobnames may be qualified.

ADD Indicates the specified job(s) be added to those currentlydefined RELEASEs.

DROP Indicates the specified job(s) be dropped from those currentlydefined RELEASEs.

A Indicates the specified job(s) are released on abnormaltermination, including condition code failures, of apredecessor.

U Indicates the specified job(s) are released on any terminationof a predecessor.

N Indicates the specified job(s) are released on normaltermination of a predecessor. This is the default.

Usage notes The default is successful completion.

The RELEASE statement increases the hold count of any successor jobs that youname, assuming this job and the successor jobs are selected for execution.

The termination parameters (A,U,N) are available only for jobs in an Application.For jobs in JES3 or DJC jobnets, the ABNORMAL and NORMAL parameters asdocumented in the JES3 or DJC User’s Guide.

Relatedinformation

For information on other ways specifying predecessor and successor relationships,see the AFTER, PREREQ and POSTREQ statements.

For information on specifying job relationships and selecting jobs for submission,see the ESP Workload Manager User’s Guide.

Continued on next page

Page 570: ESP 5.2 Command Reference

570

RELEASE Statement, Continued

Example 1 The following RELEASE statements identifies job relationships within anApplication:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN WORKDAYSRELEASE PAYJOB2

JOB PAYJOB2RUN WORKDAYS

ENDJOB

In the above example, PAYJOB2 is defined as a successor to PAYJOB1 and iseligible for submission upon the successful completion of PAYJOB1.

Example 2 The following RELEASE statement identifies job relationships within anApplication:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB3

RUN WORKDAYSRELEASE (PAYJOB4,PAYJOB5,PAYJOB6)

JOB PAYJOB4RUN WORKDAYS

JOB PAYJOB5RUN WORKDAYS

JOB PAYJOB6RUN FRIDAYS

ENDJOB

In the above example, PAYJOB4, PAYJOB5 and PAYJOB6 are defined assuccessors to PAYJOB3 and are eligible for submission upon the successfulcompletion of PAYJOB3.

Example 3 The following RELEASE statement identifies job relationships within anApplication:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB7

RUN WORKDAYSRELEASE (PAYJOB8(A))

JOB PAYJOB8 CONDITIONALRUN WORKDAYS

ENDJOB

In the above example, PAYJOB8 is defined as a conditional successor to PAYJOB7and is eligible for submission upon the abnormal termination of PAYJOB7. IfPAYJOB7 completes successfully, PAYJOB8 is not eligible for submission.

Continued on next page

Page 571: ESP 5.2 Command Reference

571

RELEASE Statement, Continued

Example 4 The following RELEASE statement identifies job relationships within anApplication:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB9

RUN WORKDAYSRELEASE (PAYJOB10(U))

JOB PAYJOB10 CONDITIONALRUN WORKDAYS

ENDJOB

In the above example, PAYJOB10 is defined as a conditional successor toPAYJOB9 and is eligible for submission after PAYJOB9 completes, successfully ornot.

Example 5 The following RELEASE and RELEASE ADD statements are used to indicate jobrelationships:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB11

RUN WORKDAYSRELEASE ADD(PAYJOB12)RELEASE ADD(PAYJOB13)

JOB PAYJOB12RUN WORKDAYS

JOB PAYJOB13RUN WORKDAYS

ENDJOB

In the above example, PAYJOB12 and PAYJOB13 are submitted after thesuccessful completion of PAYJOB11.

Example 6 The following RELEASE and RELEASE ADD statements are used to indicate jobrelationships:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB14

RUN DAILYRELEASE PAYJOB15RELEASE ADD(PAYJOB16)

ENDJOBJOB PAYJOB15

RUN DAILYJOB PAYJOB16

RUN DAILYENDJOB

In the above example, PAYJOB15 and PAYJOB16 are submitted after thesuccessful completion of PAYJOB14.

Page 572: ESP 5.2 Command Reference

572

REMOVE Command

Overview The REMOVE command is used in conjunction with the GENDOC, LABEL andGO commands when converting an existing job documentation library to adocumentation library usable by ESP. The REMOVE command identifies lines thatare not to be copied to the output data set.

Type General command.

Syntax The syntax of the REMOVE command is:

REMOVE ‘string’

Parameter Descriptionstring Indicates any character string enclosed in quotes.

Usage notes The GENDOC command identifies the input data set, members to be copied, and theoutput data set. It also lets you identify changes you want to make when the olddocumentation converts.

Use REMOVE, LABEL and GO in conjunction with the GENDOC command tocustomize the conversion of existing job documentation to ESP job documentation.

Relatedinformation

For information on converting existing job documentation, see the GENDOCcommand.

For information on altering or replacing lines in the output data set during theconversion, see the LABEL command

For information on indicating that all specifications are complete and that the copyprocess should proceed, see the GO command.

For information on job documentation, see the ESP Workload Manager User’sGuide.

Continued on next page

Page 573: ESP 5.2 Command Reference

573

REMOVE Command, Continued

Example 1 The following GENDOC, REMOVE, LABEL and GO commands are used toconvert existing job documentation:

GENDOC ‘JOBDOC.DATA’ ‘ESP.JOBDOC.DATA’ LEV(A–,B–) SNUMREMOVE ‘**’LABEL ‘SYSOUT REVIEW’ ‘SYSOUT_REVIEW’ INLINELABEL ‘STEP***’ ‘@:’ OVERLAYLABEL ‘RESTART PROCEDURES’ ‘RESTART:’ BEFOREGO

In the above example, ESP will:

• Copies all members beginning with ‘A’ and ‘B’ from the data set‘JOBDOC.DATA’ to the data set ‘ESP.JOBDOC.DATA’, suppressing any linenumbers in the right–hand 8 columns of each source member record.

• Does not copy any lines containing ‘**’.• Replaces any lines starting with ‘SYSOUT REVIEW’ with the character string

‘SYSOUT_REVIEW’.• Overlays the semicolon on any line beginning with ‘STEP’. The semicolon is

positioned after the 3rd character following the string ‘STEP’.• Places the label ‘RESTART:’ on its own line before any line starting with the

string ‘RESTART PROCEDURES’.• Proceed with the copy process.

Page 574: ESP 5.2 Command Reference

574

REPORT Command

Overview The REPORT command is used to begin a report definition.

Type Reporting command.

Syntax The syntax of the REPORT command is:

REPORT

Usage notes The ENDR command must end the report definition. For more information, see theENDR command.

Example 1 The following is an example of a history report definition:

REPORTFROM 7AM YESTERDAYCRITERIA APPLSYS EQ PAYROLLDISPLAY JOBNAME JOBNO APPLSYS CMPCENDR

In the above example:

• The REPORT command invokes the report processor• The FROM, CRITERIA and DISPLAY report statements define the report• The ENDR command ends the report definition and initiates report generation.

Page 575: ESP 5.2 Command Reference

575

RESDEF Command

Overview The RESDEF command is used to define, display, delete or update resources.

Type General command

Authority OPER authority is required to issue the RESDEF command in non-SAFenvironments. With SAF, you control access to resources using theRESOURCE.resname resource.

Syntax The syntax of the RESDEF command is:

RESDEF name [ADD|DEL|LIST|SET][ENTERPRISE|GLOBAL|LOCAL][THRESHOLD|RENEWABLE|DEPLETABLE][OWNERS|WAITERS][NODE(xxx)][CPU(xxx)][MAX(n)][AVAIL(0)][DEVICE(xxxxx)][GRAVITY|NOGRAVITY]

Parameter Descriptionname Indicates the resource name using up to eight alphanumeric

characters. (When using the LIST, DEL or SET parameters,the resource name may include the asterisk (*) and hyphen (-)wild card characters for masking).

ADD Indicates you are defining a new resource.DEL Deletes one or more existing resource definitions.LIST Displays a list of one or more existing resource definitions.

This is the default.SET Modifies attributes of a resource definition. Resource type

and scope cannot be modified.

Continued on next page

Page 576: ESP 5.2 Command Reference

576

RESDEF Command, Continued

Syntax (continued)

Parameter DescriptionENTERPRISE Indicates the resource is equally available across the entire

enterprise - a single resource pool is shared by all MVSimages. This is the default.

GLOBAL Indicates one resource counter is available for eachJESPLEX. This maintains one resource pool for each node.

LOCAL Indicates one resource counter is maintained for each MVSimage.

THRESHOLD Defines a threshold resource type.RENEWABLE Defines a renewable resource type. This is the default.DEPLETABLE Defines a depletable resource type.OWNERS Displays jobs that are currently executing and holding a

resource. This is used with LIST.WAITERS Displays jobs waiting for a resource. This is used with LIST.NODE(xxx) Refers to the node name defined when the system topology

was specified. Limits LIST or SET to a specific node.CPU(xxx) Refers to the node name defined when the system topology

was specified. Limits LIST or SET to a specific CPU.MAX(n) Sets maximum counter value for resource you are defining.AVAIL(n) Sets available value for resource you are defining.DEVICE(xxxxx) Indicates either the IBM generic or esoteric device name that

ESP is to monitor.GRAVITY Indicates jobs are to be routed to other nodes on which the

resource is available.NOGRAVITY Indicates jobs are not to be routed to other nodes on which a

resource is available. This is the default.

Continued on next page

Page 577: ESP 5.2 Command Reference

577

RESDEF Command, Continued

Usage notes -defining aresource

Before you use the resources feature, a data set called the RESFILE needs to bedefined and identified in the ESP Initialization Parameters. CPU and NODEdefinitions are also required. The RESFILE is used to store the followinginformation:

• System topology• Resource definitions• Allocation of resources, i.e. jobs that have resources allocated to them and jobs

waiting to allocate resources.

When you define a resource, you need to:

• Name the resource• Use the ADD keyword to indicate you are defining a new resource• Indicate the scope of the resource - local, global, or enterprise• Indicate the type of resource - renewable, depletable, or threshold• Indicate if the resource represents a real device• Indicate the CPU to which the resource applies• Indicate whether the resource has gravity• Specify the quantities of the resource – available and maximum.

Resource definitions are stored in the RESFILE. If ESP is started with theRESFORM option, information stored in the RESFILE is lost. A useful technique toensure that system topology and resource definitions are not lost on a reformat(RESFORM) of the RESFILE, is to code the following in your ESP InitializationParameters:

IF RESFORM THEN DONODE TORONTO ADD ROUTEJCL(‘/*XEQ TORONTO’)CPU T1 ADD NODE(TORONTO) ROUTEJCL(‘/*JOBPARM SYSAFF=T1’) ORDER(1)

CURRENTCPU T2 ADD NODE(TORONTO) ROUTEJCL(‘/*JOBPARM SYSAFF=T2’) ORDER(2)CPU T3 ADD NODE(TORONTO) ROUTEJCL(‘/*JOBPARM SYSAFF=T3’) ORDER(3)RESDEF T3480 ADD LOCAL RENEWABLE MAX(5) CPU(T1)RESDEF CICSUP ADD GLOBAL THRESHOLD AVAIL(0)RESDEF DB2TAB1 ADD GLOBAL RENEWABLE AVAIL(3)

ENDDO

If you are using the resource feature extensively and have a large number ofresources defined, it may not be desirable to code all your resource definitions in theESP Initialization Parameters. An alternative method is to store your resourcedefinitions in a data set and issue the LOAD command to process the RESDEFcommands, in the event the RESFILE is reformatted.

Note: The LOAD command cannot be used in ESP’s Initialization Parameters.

Continued on next page

Page 578: ESP 5.2 Command Reference

578

RESDEF Command, Continued

Usage notes -resource counts

You can specify maximum and available counts for a resource. For depletable andthreshold resources, there is only one quantity. You can specify either maximum(MAX) or available (AVAIL). For renewable resources, there are maximum andavailable quantities. Maximum is the total quantity of the resource that exists;available is the current quantity.

When setting a renewable resource:

• Setting the MAX count automatically adjusts the AVAIL count.• Setting the AVAIL count has no effect on the MAX count.

The following is an example of the display produced when a resource is listed andwhat happens when the MAX and AVAIL counts are manipulated:

RESDEF CICS LISTResource CICS Local RenewableTORONTO MVSA Max=2 Avail=2

RESDEF CICS SET MAX(4)Resource CICS Local RenewableTORONTO MVSA Max=4 Avail=4

RESDEF CICS SET AVAIL(6)Resource CICS Local RenewableTORONTO MVSA Max=4 Avail=6

Usage notes -resource counts

The following is an example of the display produced when a resource is listed andwhat happens when the AVAIL count is changed for a threshold resource:

RESDEF DAYSHIFT LISTResource DAYSHIFT Local ThresholdTORONTO MVSA Avail=1

RESDEF DAYSHIFT SET AVAIL(2)Resource DAYSHIFT Local ThresholdTORONTO MVSA Avail=2

Continued on next page

Page 579: ESP 5.2 Command Reference

579

RESDEF Command, Continued

Usage notes -Real resources Real resources are intended to work in a single CPU environment, as there is no

capability to be aware of the status of devices on any CPU other than the one wherethe master ESP is running. Therefore real resources should be defined as LOCALand RENEWABLE, using the MAX parameter to identifying the number of devicesbeing made available to ESP submitted jobs, as follows:

RESDEF T3480 ADD LOCAL RENEWABLE MAX(5) DEVICE(3480)

The following is an example of the display produced when listing the aboveresource:

RESDEF T3480 LISTResource T3480 Local RenewableTORONTO MVSA Max=5 Avail=5 Real=5

ESP ensures there are sufficient online, unallocated devices available to satisfy theresource requirements for the current job.For example, if job PAYJOB1 requires 3 units of a real resource called T3480, andESP sees 3 available, but only 2 devices are actually online and unallocated, ESPwaits for resources and PAYJOB1 goes into a RESWAIT state.

Relatedinformation

For information on requesting resources, see the RESOURCE statement.

For information on specifying default resources, see the RESDFLT command.

For information on resources, see the ESP Workload Manager User’s Guide.

Example 1 The following RESDEF command displays all resources:

RESDEF - LIST

In the above example, all existing resource definitions are displayed.

Continued on next page

Page 580: ESP 5.2 Command Reference

580

RESDEF Command, Continued

Example 2 The following RESDEF command defines a resource:

RESDEF IMS ADD LOCAL RENEWABLE MAX(3) CPU(TOR1)

In the above example, IMS is a local, renewable resource with a quantity of 3. IMSresides on the TOR1 MVS image and is used to represent access to an IMS region.The maximum number of jobs requiring 1 unit of the IMS resource that can runconcurrently is 3.

Example 3 The following RESDEF command defines a resource:

RESDEF NITESHFT ADD GLOBAL THRESHOLD AVAIL(1)

In the above example, NITESHFT is a global, threshold resource with a quantity of1. NITESHFT represents a time period when specific jobs can run. The NITESHFTresource can be manipulated, using the SET parameter at the appropriate times toensure night shift jobs run between 1 am - 8 am for example.

Example 4 The following RESDEF command defines a resource:

RESDEF PAYJOB1 ADD LOCAL THRESHOLD AVAIL(0)

In the above example, PAYJOB1 is a local, threshold resource with a quantity of 0.PAYJOB1 is used to represent the completion of a job. The PAYJOB1 resource canbe manipulated, using the SET parameter after the successful completion ofPAYJOB1 to allow successor jobs to be submitted.

Example 5 The following RESDEF command defines a real resource:

RESDEF T3480 ADD LOCAL RENEWABLE DEVICE(3480)

In the above example, T3480 is a local, renewable resource representing 3480cartridge drives. The number of tape drives currently on-line and not allocated iscompared with ESP’s internal counters to determine when jobs that require theT3480 resource are eligible for submission.

Continued on next page

Page 581: ESP 5.2 Command Reference

581

RESDEF Command, Continued

Example 6 The following RESDEF command defines a resource:

RESDEF CICS ADD LOCAL RENEWABLE MAX(1) CPU(TOR2) GRAVITY

In the above example, CICS is a local, renewable resource with a quantity of 1.CICS resides on the TOR2 MVS image and is used to represent access to a CICSregion. The GRAVITY attribute indicates that the CICS resource is available tojobs on other nodes. If a job on another node requires the CICS resource, theappropriate routing information is inserted into the requesting job’s JCL as per thesystem topology statements.

Example 7 The following RESDFLT and RESDEF commands define a default resource:

RESDFLT SCRATCH(SCRTAPES)

RESDEF SCRTAPES ADD GLOBAL DEPLETABLE AVAIL(500)

In the above example:

• The RESDFLT Initialization Parameter or command indicates ESP should makedefault resource assignments for scratch tapes

• The RESDEF command defines a global, depletable resource with a quantity of500. ESP uses historical information to assign scratch tape resourcerequirements to each job in an Application.

Note: Once default resources are turned on, every Application generated by ESPuses default resources. To drop a default resource code the following:

RESOURCE (0,SCRTAPES)

Example 8 The following RESDEF command modifies the attributes of an existing thresholdresource:

RESDEF LOWPRIO SET AVAIL(1)

In the above example, the available quantity of the LOWPRIO resource is set to one.

Continued on next page

Page 582: ESP 5.2 Command Reference

582

RESDEF Command, Continued

Example 9 The following RESDEF command modifies the attributes of an existing depletableresource:

RESDEF SCRTAPES SET AVAIL(550)

In the above example, the available quantity of the SCRTAPES resource is set to550.

Example 10 The following RESDEF command modifies the attributes of an existing renewableresource:

RESDEF CICSUP SET MAX(2)

In the above example, the quantity of the CICSUP resource is set to two.

Example 11 The following RESDEF command deletes a resource:

RESDEF COCONUT DELETE

In the above example, the COCONUT resource is deleted.

Example 12 The following RESDEF command displays a specific resource:

RESDEF DBASE LIST OWNERS WAITERS

In the above example, jobs using, and jobs waiting for, the DBASE resource aredisplayed.

Page 583: ESP 5.2 Command Reference

583

RESDFLT Command

Overview The RESDFLT command is used to identify the default resources you want to use.ESP can make default resource assignments automatically for the following: # oftape drives needed, # of scratch tapes needed, % CPU absorption, total CPU timeused, total elapsed time used, and total print lines generated.

Type General command.

Authority OPER authority is required to issue the RESDFLT command.

Syntax The syntax of the RESDFLT command is:

RESDFLT [LIST][CARTRIDGE(cart)][SCRATCHCART(scratch)][CPUABSORPTION(cpuabs)][CPUTIME(cputime)][ELAPSEDTIME(elapsed)][PRINTLINES(prlines)]

Parameter DescriptionLIST Displays the current default resources.cart Indicates the name of a cartridge tape resource. It should be a global

renewable resource and should identify a device name. ESP requestsa value equal to the average tape drive high water mark for a job, i.e.the average of the maximum number of tape drives required by thejob at any one moment in time. Resource names are restricted to 8characters.

scratch Indicates the name of a scratch tape resource. It should be defined asa depletable resource. This resource should be adjusted to thenumber of scratch tapes made available to ESP jobs. Resource namesare restricted to 8 characters.

Continued on next page

Page 584: ESP 5.2 Command Reference

584

RESDFLT Command, Continued

Syntax (continued)

Parameter Descriptioncpuabs Indicates a resource that reflects CPU absorption. When ESP

submits a job, it looks at the average CPU absorption, calculated asCPU time divided by elapsed time and expressed as a percentage. Itthen assigns that many units of the named resource. For example, ifa job uses 10% of the CPU when it executes, ESP requests 10 unitsof the CPU absorption resource. This resource should be defined asa local renewable resource. Assign a value equal to the maximumCPU utilization you want for ESP submitted jobs. For example, ifyou want ESP to submit jobs that only use up to 80 percent of theCPU, set this value to 80. Resource names are restricted to 8characters.

cputime Indicates the name of a resource that represents the total CPU timeused by a job, expressed in seconds. This is normally a thresholdlocal resource. You can use it to limit the execution of jobs thatrequire more than a certain threshold of CPU time. Resource namesare restricted to 8 characters.

elapsed Indicates the name of a resource that represents total elapsed timeused by a job, expressed in minutes. This is normally a thresholdlocal resource. You can use it to prevent submission of jobs thatrequire more than a certain threshold of elapsed time. For example,if you are scheduling a shutdown of a certain MVS system, you canset the maximum availability of the resource to the number ofminutes before the scheduled shutdown. ESP does not submit a jobthat can, on average, complete prior to the scheduled shutdown time.This value can be adjusted down automatically, as the scheduledtime draws closer, through an automation program or through anESP Event. Resource names are restricted to 8 characters.

prlines Indicates the name of a resource that represents the total print linesgenerated by a job. This is normally a global threshold or depletableresource. You can use it to limit submission of jobs that requiremore than a certain quantity of spool space. This is determined bythe spool size in your installation. Resource names are restricted to8 characters.

Continued on next page

Page 585: ESP 5.2 Command Reference

585

RESDFLT Command, Continued

Usage notes The RESDFLT command is normally stored as an ESP Initialization Parameter,otherwise it disappears with each restart of ESP.

Once you have identified the default resources your installation requires, use theRESDEF command to specify the resource type - renewable, depletable or threshold,and the scope of the resource - local, global or enterprise.

You can use one or more default resources.

The information used to assign default resources is based on information containedin the Job Index file. ESP bases the default resource levels it assigns on an averageof the samples found in this file. The number of samples depends on the index countspecified when the Job Tracking Model was defined. Only information from normaljob completions, and not from abends, is used. The information is updated each timea new generation of an Application is created.

Once default resources are turned on, every Application generated by ESP usesdefault resources. To drop a default resource, request zero unit of the resource. Forexample:

RESOURCE (0,SCRTAPES)

Relatedinformation

For information on requesting resources, see the RESOURCE statement.

For information on defining resource, see the RESDEF command.

For information on specifying default resource at the initialization parameter level,see the ESP Workload Manager Installation Guide.

For information on resources, see the ESP Workload Manager User’s Guide.

Example 1 The following RESDFLT command displays default resources:

OPER RESDFLT LIST

In the above example, all default resources are displayed.

Example 2 The following RESDFLT command defines two default resources:

OPER RESDFLT SCRATCH(SCRTAPES)OPER RESDFLT ELAPSEDTIME(ELAPSE)

orOPER RESDFLT SCRATCH(SCRTAPES) ELAPSEDTIME(ELAPSE)

In the above example, two default resources are defined.

Continued on next page

Page 586: ESP 5.2 Command Reference

586

RESDFLT Command, Continued

Example 3 The following RESDFLT and RESDEF commands define a default resource:

RESDFLT SCRATCH(SCRTAPES)

RESDEF SCRTAPES ADD GLOBAL DEPLETABLE AVAIL(500)

In the above example:

• The RESDFLT Initialization Parameter or command indicates ESP should makedefault resource assignments for scratch tapes.

• The RESDEF command defines a global, depletable resource with a quantity of500.

• ESP uses historical information to assign scratch tape resource requirements toeach job in an Application. ESP automatically decrements the SCRTAPESresource as jobs run.

Note: Once default resources are turned on, all Applications generated by ESP usedefault resources. To drop the SCRTAPES default resource, code the following:

RESOURCE (0,SCRTAPES)

After creating more scratch tapes, use the following command to set the new count:

RESDEF SCRTAPES SET AVAIL(750)

Example 4 The following RESDFLT command changes the name assigned to a defaultresource:

OPER RESDFLT SCRATCH(BLANKTAP)

In the above example, the name previously assigned to this default resource ischanged to BLANKTAP.

Continued on next page

Page 587: ESP 5.2 Command Reference

587

RESDFLT Command, Continued

Example 5 The following RESDFLT and RESDEF commands define a default resource:

RESDFLT ELAPSEDTIME(ELAPSE)

RESDEF ELAPSE ADD LOCAL THRESHOLD AVAIL(60)

In the above example:

• The RESDFLT Initialization Parameter or command indicates ESP should makedefault resource assignments for elapsed time used by a job.

• The RESDEF command defines a local, threshold resource with a quantity of60.

• ESP uses historical information to prevent submission of jobs that require morethan a certain threshold of elapsed time.

The following is an example of a recursive ESP Procedure that could be used tonotify users of a system shutdown and prevent long-running jobs from starting usingthe ELAPSE default resource defined above:

/* PASS NUMBER OF MINUTES TO SHUTDOWN USING USER1/* PARAMETER WHEN TRIGGERING THE EVENT/*/* SEND MESSAGE, DECREMENT TIME AND RE–TRIGGER EVENT IN/* 1 MINUTE IF TIME >= 0/*INTEGER TIMETIME=USER1SEND ‘SYSTEM COMING DOWN IN %TIME MINUTES’ USER(CYB01)ESP RESDEF ELAPSE SET AVAIL(%TIME)TIME=TIME–1IF TIME>=0 THEN ESP TRIGGER OPER.SHUTDOWN +USER1(‘%TIME’) AT(‘NOW PLUS 1 MINUTE’)

Page 588: ESP 5.2 Command Reference

588

RESOLVE Statement

Overview The RESOLVE statement is used to instruct ESP to look at a scheduled activity dataset to resolve an External job dependency. ESP automatically selects the job if it isfound.

Type ESP Application statement.

Syntax The syntax of the RESOLVE statement is:

RESOLVE identifier

Parameter Descriptionidentifier Indicates a one to eight character internal identifier of a

scheduled activity data set. This corresponds to theSADLINK Initialization Parameter.

Usage notes ESP can use a scheduled activity data set (SAD file) to resolve externaldependencies. If ESP finds the job is scheduled, it selects the External job as part ofthe Application. Otherwise, it doesn’t select the External job.

The SADLINK statement gives an external SAD file an internal identifier. Eachtime ESP initializes, or in response to a SADLOAD command, the contents of theSAD file is read and necessary information retained in a table in main storage. Youcan request that the look-up table be used to resolve External job dependencies byspecifying the correct SADLINK identifier on the RESOLVE statement in anApplication.

A more commonly used method to control the resolution of External jobs is to usethe EXTERNAL and SCHEDULED parameters on the JOB statement, as thisprovides the most control for synchronizing Applications.

Relatedinformation

For information on identifying an external scheduled activity data set, see theSADLINK command.

For information on refreshing an in-core table containing a scheduled activity dataset, see the SADLOAD command.

For information on displaying current SADLINK, see the LISTSADL command.

For information on building inter-Application dependencies, see the EXTERNALstatement.

Continued on next page

Page 589: ESP 5.2 Command Reference

589

RESOLVE Statement, Continued

Example 1 The following RESOLVE statement is used to resolve an external dependency:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’RESOLVE SADDLYJOB PAYJOBX EXTERNAL

REL PAYJOB1JOB PAYJOB1

REL PAYJOB2RUN DAILY

JOB PAYJOB3RUN DAILY

ENDJOB

In the above example, the RESOLVE statement instructs ESP to look at thescheduled activity data, with the identifier SADDLY, to see if PAYJOBX isscheduled. If PAYJOBX is found, ESP selects PAYJOBX as part of theApplication. Otherwise, it doesn’t select the External job.

Page 590: ESP 5.2 Command Reference

590

RESOURCE Statement

Overview The RESOURCE statement is used to identify resources required by individual jobsor by an entire Application. An individual job or Application can request anynumber of resources. You can use resources for any type of workload object exceptlinks.

Type ESP Application statement.

Syntax The syntax of the RESOURCE statement is:

RESOURCE {resname1[,resname2]}{(count,resname1[,count,resname2]...)}{ADD(count,resname1[,count,resname2]...)}{DROP(resname1[,resname2])}

Parameter Descriptionresname Indicates a resource name using up to eight alphanumeric

characters. Has a default value of 1.count,resname Indicates the number of units of the resource required by the

job or Application. Resname can be specified with or withouta count. If no count specified, the default is 1.

ADD Indicates this resource requirement is in addition to theexisting resource requirements. A count and the resourcename must also be used when specifying ADD.

DROP(resname) Indicates the resource requirement be dropped. Whenspecified within a JOB...ENDJOB pair, the resourcerequirement is dropped only for that job. When specifiedoutside a JOB...ENDJOB pair, the resource requirement isdropped until the next occurrence of the RESOURCEstatement outside a JOB…ENDJOB pair.

Continued on next page

Page 591: ESP 5.2 Command Reference

591

RESOURCE Statement, Continued

Usage notes The RESOURCE statement contains the number of units of a specific resource that ajob requires followed by the resource name.

If you want to request more than one resource for a job, string your resourcespecifications together. If your specification of a job’s resource requirements takesup more than one line, you should use the hyphen ‘–’ or plus sign ‘+’ as linecontinuation characters.

When you use a RESOURCE statement within an Application definition to providespecific resource information for an individual job, you place the statement betweenthe JOB ... ENDJOB pair. The RESOURCE statement then affects only thatindividual job. It also overrides any resources that occur before the JOB...ENDJOBpair. Use the ADD keyword in this situation.

If the RESOURCE statement is specified outside the scope of a JOB...ENDJOBpair, the RESOURCE statement applies to the jobs that follow it, until a newRESOURCE statement occurs outside the scope of a JOB…ENDJOB pair.

The resource requirements apply to all jobs and tasks but not to links. Jobs insertedinto an Application after it is generated do not inherit any resource requirements.

Once default resources are turned on, every Application generated by ESP usesdefault resources. You do not drop ESP default resource requirements with theDROP keyword. To drop a default resource, request zero units of the resource. Forexample:

RESOURCE (0,SCRTAPES)

The resource information defined to a job is used for scheduling and duringMODEL processing.

Relatedinformation

For information on specifying the relative priority of jobs within an ESP group, seethe PRIORITY statement.

For information on specifying default resources, see the RESDFLT command.

For information on defining resources, see the RESDEF command.

For information on resources, see the ESP Workload Manager User’s Guide.

Example 1 The following RESOURCE statement identifies a resource requirement for aspecific job:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN WORKDAYSRESOURCE (1,CICS)

ENDJOB

In the above example, PAYJOB1 requires 1 unit of a resource called CICS.

Continued on next page

Page 592: ESP 5.2 Command Reference

592

RESOURCE Statement, Continued

Example 2 The following RESOURCE statements identify resource requirements:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB2

RUN WORKDAYSREL PAYJOB3RESOURCE (1,IMS)

JOB PAYJOB3RUN WORKDAYSRESOURCE (1,T3480,2,SCRATCH)

ENDJOB

In the above example:

• PAYJOB2 requires 1 unit of a resource called IMS• PAYJOB3 requires 1 unit of a resource call T3480 and 2 units of a resource

called SCRATCH.

Example 3 The following RESOURCE statements identify resource requirements on specificdays:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB4

RUN WORKDAYSREL PAYJOB5RESOURCE (1,NITESHFT)IF TODAY(‘FRIDAY’) THEN RESOURCE DROP(NITESHFT)

ENDJOB

In the above example, PAYJOB4 requires 1 unit of a resource called NITESHFT,except on Fridays when resource requirements for PAYJOB4 are dropped.

Example 4 The following RESOURCE statement drops a default resource for an Application:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’RESOURCE (0,ELAPSED)JOB PAYJOB5

RUN WORKDAYSREL PAYJOB6

JOB PAYJOB6RUN WORKDAYSREL PAYJOB7

JOB PAYJOB7RUN WORKDAY

ENDJOB

In the above example, the RESOURCE statement instructs ESP not to assign thedefault resource called ELAPSED for any job within the PAYROLL Application.

Continued on next page

Page 593: ESP 5.2 Command Reference

593

RESOURCE Statement, Continued

Example 5 The following RESOURCE statement drops a default resource and identifies aresource requirement:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB8

RUN WORKDAYSRESOURCE (0,ELAPSED,1,LOWPRIO)

ENDJOB

In the above example, the RESOURCE statement instructs ESP not to assign thedefault resource called ELAPSED to PAYJOB8. PAYJOB8 requests 1 unit of aresource called LOWPRIO.

Page 594: ESP 5.2 Command Reference

594

RESREFR Command

Overview The RESREFR command is used in conjunction with real resources, for exampletape devices, to refresh the device list if tape devices are added or deleteddynamically.

Type General command.

Authority OPER authority is required to issue the RESREFR command.

Syntax The syntax of the RESREFR command is:

RESREFR

Usage notes RESREFR refreshes resource status, alleviating problems with jobs going into aRESWAIT status when resources are available. For example, if a job is waiting fora tape drive, and a tape drive is varied online, ESP does not see this, RESREFRrefreshes the device list so that jobs do not unnecessarily wait.

Relatedinformation

For information on defining resources, see the RESDEF command.

For information on resources, see the ESP Workload Manager User’s Guide.

Example 1 The following RESREFR command refreshes resource status:

OPER RESREFR

In the above example, the device list is refreshed with any dynamically added ordeleted tape devices. Any jobs waiting for an available resource have theirRESWAIT status refreshed.

Note: Automate the process by which resource status is refreshed by defining anEvent at regular intervals to issue the RESREFR command, as follows:

EVENT ID(CYBER.RESOURCE_REFRESH)SCHEDULE EVERY 10 MINUTESVS ‘F ESP,RESREFR’ENDDEF

Page 595: ESP 5.2 Command Reference

595

RESTART Command

Overview The RESTART command is used to take ESP out of the quiesced state, restartingEvent scheduling and Application processing.

Type General command.

Authority OPER authority is required to issue the RESTART command.

Syntax The syntax of the RESTART command is:

RESTART

Usage notes Use the RESTART command after ESP has been quiesced using the QUIESCEcommand or the QUIESCE start-up option.

When Event scheduling is restarted, ESP acts as if it was down for the entire time itwas in the quiesced state. That is, Events scheduled to execute while ESP wasquiesced are considered to be overdue. The overdue parameter of each overdueEvent is examined to determine whether it should be executed or bypassed.

Relatedinformation

For information on putting ESP into a quiesced state, see the QUIESCE command.

For information on displaying the current ESP processing status, see the STATUScommand.

Example 1 The following RESTART command restarts Event scheduling and Applicationprocessing:

OPER RESTART

In the above example, ESP is restarted, which is displayed using the STATUScommand as follows:

OPER STATUSESP1977I ESP RELEASE 5.1.0.000 STATUSESP1978I EVENT SCHEDULING ACTIVEESP1979I DATASET TRIGGERING ACTIVE

In the above example, Event scheduling and Application processing are active asnoted by the ESP1978I message - EVENT SCHEDULING ACTIVE.

Page 596: ESP 5.2 Command Reference

596

RESTORE Command

Overview The RESTORE command is used to restore the Event, History, Userdef, Index andJob index data sets. The RESTORE command restores an ESP data set from thebackup copy of its most current state using journalled SMF entries.

Type General command

Syntax The syntax for the RESTORE command is:

RESTORE {EVENTSET(dsname)}{INDEX(dsname)}{USERDEF(dsname)}{JOBINDEX(dsname)}{HISTFILE(dsname)}BACKUP(bkupdsname)SMFID(smfno)[NEWDSNAME(newdsn)][FROMTIME(schedule)]

Parameter DescriptionEVENTSET Indicates the name of an Event data set.INDEX Indicates the name of the Index data set.USERDEF Indicates the name of the User Definition data set.JOBINDEX Indicates the name of the Job Index data set.HISTFILE Indicates the name of a History data set.dsname Indicates the data set name of file to be restored.bkupdsname Indicates the data set name of most current backup from

which the file is to be restored.smfno Indicates the record number used for journalling updates to

SMF file. This corresponds to your SMFREC InitializationParameter.

newdsn Indicates an optional data set name of an existing emptyVSAM file where the data set is restored. This data set musthave the same attributes as dsname.

schedule Any valid schedule statement. If the statement containsseparators, it must be enclosed in quotes. If specified, thistime is used instead of the backup file time.

Usage notes This command can be used only if you are journalling updates to the file you wish torestore.

Continued on next page

Page 597: ESP 5.2 Command Reference

597

RESTORE Command, Continued

Relatedinformation

For information on restoring ESP data sets, see the ESP Workload ManagerInstallation Guide and the ESP Workload Manager Diagnostics and RecoveryGuide.

Example 1 The following is an example of JCL that could be used to restore an ESP data set:

//RESTORE JOB …//STEP01 EXEC PGM=ESP,PARM='SUBSYS(ESPM)'//STEPLIB DD DSN=CYB2.ESP510.SSCPLINK,DISP=SHR//SYSPRINT DD SYSOUT=*//JOURNAL DD DSN=SYS1.SMF.BACKUP(0),DISP=SHR// DD DSN=SYS1.SMF.BACKUP(-1),DISP=SHR//SYSIN DD *UTILRESTORE HISTFILE('CYB2.ESP510.HISTFILE') +NEWDSNAME('CYB2.ESP510.NEW.HISTFILE') +BACKUP('CYB2.ESP510.BACKUP.HISTFILE') +SMFID(240)/*

In the above example, the restore processor merges all of the history file updateswith the last HISTFILE backup and produces a new, up-to-date version of thehistory file.

Page 598: ESP 5.2 Command Reference

598

RESUME - Event Level

Overview When used in an Event definition, the RESUME command is used to decrement thesuspend count associated with an Event at a particular time. When the suspendcount reaches zero, the Event is eligible for execution.

Type Event definition command.

Syntax The syntax of the RESUME command is:

RESUME criteria

Parameter Descriptioncriteria Schedule criteria.

Usage notes The RESUME command is used in conjunction with the SUSPEND command tomake a previously bypassed Event eligible for execution.

The RELEASE command is used in conjunction with the HOLD command to makea previously postponed Event eligible for execution.

If you are using a time zone on your SUSPEND command, you should use the sametime zone on your RESUME command. If the Event has a schedule statement, thesame time zone should be used on the SCHEDULE, SUSPEND and RESUMEcommands.

Relatedinformation

For information on Events, see the ESP Workload Manager User’s Guide.

For information on suspending an Event’s execution, see the SUSPEND command.

For information on decrementing an Event’s hold count, see the RELEASEcommand.

Continued on next page

Page 599: ESP 5.2 Command Reference

599

RESUME - Event Level, Continued

Example 1 The following is an example of an Event definition:

EVENT ID(CYBER.PAYROLL)DSTRIG PAYROLL.INPUTSUSPEND DAILY AT 9AMRESUME DAILY AT 11AMSUBMIT ‘CYBER.JCL.CNTL(PAYJOB1)’ENDDEF

In the above example, SUSPEND and RESUME commands are used to preventPAYJOB1 from being submitted between 9 am and 11 am. If a data set triggerhappens between these times, ESP ignores it.

Example 2 The following is an example of an Event definition:

EVENT ID(CYBER.TIMEMSG)SCHEDULE WORKDAYS HOURLY ROUND STARTING TODAYSEND ‘THE TIME IS %ESPATIME’ U(CYB01)SUSPEND 16:01 WORKDAYSRESUME 7:59 WORKDAYSENDDEF

In the above example, SUSPEND and RESUME commands are used to send amessage between 8 am and 4 pm on workdays.

Page 600: ESP 5.2 Command Reference

600

RESUME - General

Overview The RESUME command is used to decrement the suspend count associated with anEvent. When the suspend count reaches zero, the Event is eligible for execution.

Type General command.

Syntax The syntax of the RESUME command is:

RESUME eventid

Parameter Descriptioneventid Indicates a valid Event name. If no prefix is specified, the

prefix as set by the GROUP command is used.

Usage notes The specified Event has its SUSPEND count decremented immediately.

The SUSPEND command is used in conjunction with the RESUME command tomake a previously bypassed Event eligible for execution.

Note:

The RELEASE command is used in conjunction with the HOLD command to makea previously postponed Event eligible for execution.

Relatedinformation

For information on Events, see the ESP Workload Manager User’s Guide.

For information on suspending an Event’s execution, see the SUSPEND command.

For information on decrementing an Event’s hold count, see the RELEASEcommand.

Examples 1 The following RESUME command resumes an Event:

RESUME CYBER.PAYROLL

In the above example, CYBER.PAYROLL was previously suspended and is noweligible for execution, if the suspend count was at 1. Otherwise, the suspend countwas decrement by 1.

Page 601: ESP 5.2 Command Reference

601

REXXOFF Statement

Overview The REXXOFF statement is used to turn REXX processing off.

Type CLANG statement.

Syntax The syntax of the REXXOFF statement is:

REXXOFF

Usage notes To add REXX expressions to ESP, you must turn REXX on and off using CLANG.CLANG is always present as the primary command language in ESP.

Relatedinformation

For information on turning REXX processing on, see the REXXON statement.

For information on using REXX with ESP, see the ESP Workload ManagerAdvanced User’s Guide.

Example 1 The following REXXON and REXXOFF statements turn REXX processing on andoff:

APPL PAYROLLJCLLIB 'CYBER.JCL.CNTL'REXXON GENDO I=1 TO 10

"JOB PAYJOB"I" RUN ANY"IF I <> 10 THEN " RELEASE PAYJOB"I+1

"ENDJOB"ENDREXXOFF

In the above example, REXX is turned on from ESP to generate an Applicationconsisting of 10 sequential jobs, and then REXX is turned off.

Page 602: ESP 5.2 Command Reference

602

REXXON Statement

Overview The REXXON statement is used to turn REXX processing on by invoking theREXX interpreter. When ESP encounters a REXXON statement, it reads the REXXprocedural statements until it encounters a REXXOFF statement.

Type CLANG statement

Syntax The syntax for the REXXON statement is:

REXXON [GEN|NOGEN][PROC|NOPROC]

Parameter DescriptionGEN Indicates that REXX processing is active during Application

generation mode. This is the default. Use this option if youare using REXX to generate your Application.

NOGEN Indicates that REXX processing is not active duringApplication generation mode.

PROC Indicates that REXX processing is active during Applicationprocess mode. This is the default. Use this option if you areusing REXX to process you Application.

NOPROC Indicates that REXX processing is not active duringApplication process mode.

Usage notes To add REXX expressions to ESP, you must turn REXX on and off using CLANG.CLANG is always present as the primary command language in ESP.

You can activate REXX processing at either the generation or processing stages ofan Application. To invoke or suppress REXX processing at either the generation orprocessing stage of an Application, enter the GEN or PROC keywords after theREXXON statement as follows:

• Type REXXON GEN PROC or REXXON to turn on REXX in the generation andprocessing stages of an Application.

• Type REXXON GEN to turn on REXX in the generation stage only.• Type REXXON PROC to turn on REXX in the processing stage only.

Relatedinformation

For information on using REXX with ESP, see the ESP Workload ManagerAdvanced User’s Guide.

For information on turning REXX processing off, see the REXXOFF statement.

Continued on next page

Page 603: ESP 5.2 Command Reference

603

REXXON Statement, Continued

Example 1 The following REXXON statement turns REXX processing on:

REXXONSAY ‘THIS IS REXX SPEAKING’

REXXOFF

In the above example, REXX is turned on from ESP to send a message back to yourterminal and then turned off again.

Example 2 The following REXXON statement turns REXX processing on and returnsinformation about a job on the CSF:

REXXONNUM=JOBONCSF(‘PAYJOB1’,'X')SAY 'THERE ARE ' NUM 'OCCURENCES OF JOB ' JOBNAME()DO I=1 TO NUM

SAY JOBNAME() 'IS IN APPL ' XAPPL.IENDREXXOFF

In the above example, ESP turns on REXX to return information about a jobcurrently on the CSF.

Example 3 The following REXXON statement turns REXX processing on to generate anApplication:

APPL PAYROLLJCLLIB 'CYBER.JCL.CNTL'REXXON GENDO I=1 TO 10

"JOB PAYJOB"I" RUN ANY"IF I <> 10 THEN " RELEASE PAYJOB"I+1

"ENDJOB"ENDREXXOFF

In the above example, REXX is turned on from ESP to generate an Applicationconsisting of 10 sequential jobs.

Continued on next page

Page 604: ESP 5.2 Command Reference

604

REXXON Statement, Continued

Example 4 The following REXXON statement turns REXX processing on and defines specialdays:

REXXON”ALLOCX DA(’CYB01.DATES’) F(MYINDD) SH”if rc \= 0 thendo”REEXEC IN(1)””EXIT”

endaddress MVS ”EXECIO * DISKR MYINDD (STEM LINE. FINIS”do i=1 to line.0

Date=line.i”ESP DEFSPEC PAY_DAY ON(”Date”) CAL(PAYROLL)”

end”FREEX FILE(MYINDD)”REXXOFF

In the above example, REXX is turned on from ESP to read each line of a data setcontaining dates and then issue the DEPSPEC command for the specified dates.

Page 605: ESP 5.2 Command Reference

605

ROSSUB Command

Overview The ROSSUB command is used to submit JCL from a ROSCOE data set to theinternal reader.

Type Event definition command.

Syntax The syntax of the ROSSUB command is:

ROSSUB dsname

Parameter Descriptiondsname Indicates a valid ROSCOE data set name. You do not have to

specify ‘ROS-’ as a data set identifier because using theROSSUB command implies the use of a ROSCOE data set. Ifyou omit the ROSCOE prefix from the data set name, ESPuses the ROSCOE prefix of the user defining the Event.

Usage notes The ROSSUB command submits JCL from a ROSCOE data set into the internalreader. Several ROSCOE commands may be specified in a single Event. The inputdata are effectively concatenated together, so that data from several data sets can bejoined to form one or more jobs. In the same Event you can also use the ESPSUBMIT command and submit JCL from LIBRARIAN and PANVALET data sets.

You can also use the ROSSUB command in an ESP Procedure.

Relatedinformation

For information on submitting JCL from an Event see, Processing ESP Events in theESP Workload Manager User’s Guide.

Example 1 The following is an example of an Event definition that submits JCL from aROSCOE data set:

EVENT ID(CYBER.ROSJOBS)SCHEDULE 9AM FIRST MONDAY OF MONTHROSSUB RDS.JOBSENDDEF

In the above example a ROSCOE data set is submitted at 9 am on the first Mondayof the month.

Page 606: ESP 5.2 Command Reference

606

ROUTE Statement

Overview The ROUTE statement is used to insert a /*ROUTE statement in a job’s JCL. Thisroutes a job to a different node for execution.

Type ESP Application statement.

Syntax The syntax of the ROUTE statement is:

ROUTE XEQ(nodename)

Parameter Descriptionnodename Indicates a one to eight character JES node name to where

this job is routed for execution.

Usage notes If you use the ROUTE statement to route a job to another JES node, you shouldensure there is tracking data being sent between the two nodes. Check with yourESP system administrator before using this feature.

Another method for routing jobs to other nodes is to use ESP Resources. Using thisfeature, ESP automatically inserts the appropriate routing information to ensure jobsare routed to the required JES node.

Relatedinformation

For information on routing jobs to other JES nodes, see the ESP Workload ManagerAdvanced User’s Guide.

For information on routing jobs to other JES nodes using ESP Resources, see theESP Workload Manager User’s Guide.

For information on inter-system tracking, see the TP Server Installation and User’sGuide.

Continued on next page

Page 607: ESP 5.2 Command Reference

607

ROUTE Statement, Continued

Example 1 The following ROUTE statement routes a job to another JES node:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN DAILYREL PAYJOB3

JOB PAYJOB2RUN DAILYREL PAYJOB3ROUTE XEQ(NODE2)

JOB PAYJOB3RUN DAILYRELCOUNT 1

ENDJOB

In the above example, ESP adds a /*ROUTE card to the JCL it submits forPAYJOB2 to route it to NODE2.

Page 608: ESP 5.2 Command Reference

608

RUN Statement

Overview The RUN statement is used to identify a job’s schedule frequency. ESP allowsmultiple RUN statements for the same job.

Type ESP Application statement.

Syntax The syntax of the RUN statement is:

RUN criteria

Parameter Descriptioncriteria The schedule criteria must resolve to a single date and time

when the Application builds.

Usage notes The RUN statement is equivalent to the following:

IF TODAY(‘criteria’) THEN SELECT job.

In order for a job to be selected for submission, either a RUN, SELECT, PREREQ,POSTREQ or COREQ statement is required.

The RUN statement can not be used in conjunction with the following schedulingterms: EVERY, UNTIL, ENDING, TOMORROW, YESTERDAY and STARTING.The schedule criteria must resolve to a single date and time when the Applicationbuilds.

If a job has a time dependency for submission, you must use either an EARLYSUBor a DELAYSUB statement. The statement ‘RUN 5PM DAILY’ is not valid.

Use the NORUN statement to cause a job not to be scheduled. When both RUN andNORUN statements for a job are encountered, the last one which applies overrides.Normally, the NORUN statement should follow your RUN statement.

RUN statements are used within the scope of a JOB statement. This allows you tolook at a job definition and see the schedule frequency for the job. Many criteria canbe handled with RUN statements without the need for using “IF TODAY” typelogic.

Continued on next page

Page 609: ESP 5.2 Command Reference

609

RUN Statement, Continued

Relatedinformation

For information on Applications, see the ESP Workload Manager User’s Guide.

For information on specifying schedule criteria, see the ESP Workload ManagerUser’s Guide.

For information on selecting jobs for submission, see the SELECT, POSTREQ,PREREQ and COREQ statements.

For information on deselecting jobs for submission, see the NORUN andDESELECT statements.

Example 1 The following RUN statement selects a job for submission:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

RUN WORKDAYSENDJOB

In the above example, PAYJOB1 is selected for submission on workdays.

Example 2 The following RUN statements identify when each job is selected for submission:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB2

RUN DAILYREL PAYJOB3

JOB PAYJOB3RUN FRIDAY

ENDJOB

In the above example, PAYJOB2 is selected for submission every day andPAYJOB3 is selected for submission on Fridays.

Example 3 The following RUN statements identify when a job is selected for submission:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB4

RUN MONDAYRUN 1ST WORDKAY OF MONTH

ENDJOB

In the above example, PAYJOB4 is scheduled for submission on Mondays and onthe first workday of each month.

Continued on next page

Page 610: ESP 5.2 Command Reference

610

RUN Statement, Continued

Example 4 The following RUN statements identify when a job is selected for submission:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB5

RUN MONDAYNORUN 1ST WORKDAY OF MONTH

ENDJOB

In the above example, PAYJOB5 is scheduled for submission on Mondays, excepton the first workday of the month.

Example 5 The following RUN statement is used in conjunction with IF logic to identify whena job is selected for submission:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB6

IF TODAY('LAST WORKDAY OF MONTH') AND -TODAY('NOT LAST WORKDAY OF WEEK') THEN RUN TODAY

ENDJOB

In the above example, PAYJOB6 is scheduled for submission if today is the lastworkday of the month, but not if it is the last workday of the week.

Example 6 The following RUN statement identifies when a job is selected for submission:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB7

RUN 5TH DAY OF MONTH PLUS 0 WORKDAYSENDJOB

In the above example, PAYJOB7 is scheduled for submission on the 5th day of eachmonth. If the 5th day of the month is not a workday, PAYJOB7 is selected forsubmission on the first workday after the 5th day of the month.

Continued on next page

Page 611: ESP 5.2 Command Reference

611

RUN Statement, Continued

Example 7 The following RUN statement is used in conjunction with IF logic, a built-infunction and a user-defined symbolic variable to identify when a job is selected forsubmission:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB8

INTEGER XX=DAYS_FROM(‘JANUARY 1,1999’)IF X//14*14=X THEN DO

RUN TODAYNORUN HOLIDAY

ENDDOENDJOB

In the above example, PAYJOB8 is scheduled for submission every 14 days, afterJanuary 1st, 1999, except if it is a holiday.

Example 8 The following RUN statement is used in conjunction with IF logic, a built-in and auser defined symbolic variables to identify when a job is selected for submission:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’GENTIME A LAST DAY OF MONTH STARTING TODAYGENTIME B LAST SUN OF MONTH STARTING TODAYGENTIME C LAST SAT OF MONTH STARTING TODAYJOB PAYJOB9

IF %ADATE NE %BDATE THEN -RUN %ADATE

ELSE -RUN %CDATE

ENDJOB

In the above example, PAYJOB9 is selected for submission on the last day of themonth, if the last day of the month is not the last Sunday of the month. If the lastday of the month is the last Sunday of the month, then PAYJOB9 is selected forsubmission on the last Saturday of the month.

Page 612: ESP 5.2 Command Reference

612

SADGEN Command

Overview The SADGEN command is used to generate a data set, which is used in the creationof scheduled activity reports. It must be executed through the ESP subsystem startedtask Procedure with a special parm (PARM=‘SAR’ or PARM=‘SAD’).

Type Reporting command.

Syntax The syntax of the SADGEN command is:

SADGEN DATASET(sardb)[FROM(schedule)][TO(schedule)][LOGICALDAYSTART(starttime)][CARRYOVER(codsn)][EVENTSET(evdb)][LEVEL(prefix)][CLASS(classname[,classname]...)][THRESH(mins)][TRACE][JCLOUT(jcldsn)][JOBCLASS(jobclass)][MSGCLASS(msgclass)][RMGRDATA(‘string’[,’string’]...)][NOHIST]

Parameter Descriptionsardb Indicates the name of the data set to store scheduled activity

information.schedule Indicates valid schedule criteria. If the statement contains

separators then it must be enclosed in quotes. The keywords‘ENDING’ or ‘UNTIL’ can be used to restrict the time rangeselected. Defaults are from now to 6 am tomorrow. Youcannot specify a time in the past; you can only specify a timein the future. The start time for a SADGEN run is the later ofthe start time specified in the SADGEN command and thetime at which the command is processed.

starttime Indicates a valid schedule statement. If the statementcontains separators, it must be enclosed in quotes. TheLOGICALDAYSTART keyword specifies the start time ofyour logical processing day; it should match the one specifiedon your calendar. This keyword is not required unless youuse logical day processing.

codsn Indicates the name of a previously scheduled activity data set(data set name or DD name) whose outstanding jobs are to bemerged with the sardb data set.

Continued on next page

Page 613: ESP 5.2 Command Reference

613

SADGEN Command, Continued

Syntax (continued)

Parameter Descriptionevdb Indicates the name of one or more Event databases that

should be scanned to generate scheduled activity data.Asterisks and a hyphen may be used for masking. The defaultis to scan all existing Event data sets.

prefix Indicates an Event group prefix. Asterisks and a hyphen maybe used for masking.

classname Indicates one or more ESP Event class names. Separate eachwith a comma. Asterisks and a hyphen may be used formasking.

mins Indicates a threshold in minutes. Any Event that executesmore frequently than this threshold interval is not simulated.The default is 120.

TRACE Displays all the commands that ESP simulates to create thescheduled activity database.

jcldsn Indicates the name of a sequential data set where the JCL foreach job generated by the SADGEN is stored.

jobclass Indicates a one-character alphanumeric jobclass to beassigned to each job written to the JCLOUT data set.

msgclass Indicates a one-character alphanumeric msgclass to beassigned to each job written to the JCLOUT data set.

string Indicates a quoted string or list of strings that is inserted asthe first step to each job written to the JCLOUT data set.

NOHIST Indicates job history data is not retrieved when creating thescheduled activity data set. This keyword should be specifiedonly if you are not using ESP’s job tracking facility.

Continued on next page

Page 614: ESP 5.2 Command Reference

614

SADGEN Command, Continued

Usage notes To generate data used for scheduled activity reporting, ESP must simulate all theEvents and ESP Procedures it is to execute in a specified period. ESP does this byexecuting the ESP subsystem started task procedure in batch with a specialparameter (PARM=‘SAR’ or PARM=‘SAD’). The output that ESP generates by thissimulation forms a scheduled activity data set.

The default space requirement for the SADGEN data set is 10 primary cylinders and5 secondary cylinders. To change these defaults, specify SADGEN(p,s) where p isthe number of primary cylinders and s, the number of secondary cylinders. Forexample: PARM=‘SAD(25,10)’ results in SPACE=(CYL,(25,10)).

ESP does not reflect an Event in the scheduled activity data set unless it containseither a SCHEDULE or EXPECT command.

You can also create multiple schedule activity data sets. You may want to generateseparate data sets on scheduled activity for the next day or for the next week, or youmay want different data sets for different production groups.

When a scheduled activity data set is generated, it contains a record for each job thatis submitted within the time range you have specified. If a time range is notspecified, the default provided is from ‘NOW’ to ‘6AM TOMORROW’. Data isstored in alphabetical sequence by job name and is displayed using the LSARcommand.

A sequential data set must be allocated before using the SADGEN command towrite data to it.

The scheduled activity data set may be used for reporting, modeling, or to resolveExternal dependencies.

Use of the EVENTSET, LEVEL and CLASS keywords, allows you to select andcontrol the scheduled activity data you want to be stored. The THRESH optionallows you to change the frequency of Events to be simulated. The TRACE optionis used to verify all of the functions that each Event or ESP Procedure performswhen it is scheduled.

Continued on next page

Page 615: ESP 5.2 Command Reference

615

SADGEN Command, Continued

Relatedinformation

For information on scheduled activity reporting, see the ESP Workload ManagerUser’s Guide.

For information on modeling, see the ESP Workload Manager Advanced User’sGuide.

For information on extracting data from the scheduled activity data set, see theLSAR command.

For information on updating a scheduled activity data set with actual information,see the SADUPD command.

For information on resolving dependencies through a scheduled activity data set, seethe RESOLVE command.

For information on identifying an external scheduled activity data set, see theSADLINK command.

For information on refreshing an in-core table containing scheduled activity data set,see the SADLOAD command.

Example 1 The following is an example of JCL that can be used to produce a scheduled activitydata set:

//jobname JOB …//STEP1 EXEC ESP,PARM=’SAR’//SYSPRINT DD SYSOUT=*//SYSIN DD *SADGEN DATASET(‘CYBER.SAD’) -FROM(’8AM TODAY’) TO(‘8AM TOMORROW’)/*

In the above example, the SADGEN command generates a scheduled activity dataset. CYBER.SAD contains information on all Events scheduled or expected toexecute between 8 am today and 8 am tomorrow.

Example 2 The following is an example of JCL that could be used to produce a scheduleactivity data set:

//jobname JOB …//STEP1 EXEC ESP,PARM=’SAR’//SYSPRINT DD SYSOUT=*//SYSIN DD *SADGEN DATASET(‘CYBER.SAD’) -FROM(’8AM TODAY’) TO(‘8AM PLUS 1 WEEK’) -EVENTSET(EVENT1) -LEVEL(PROD-)/*

In the above example, the SADGEN command scans the EVENT1 Event data set togenerate a scheduled activity data set. CYBER.SAD contains information on allEvents beginning with PROD, which are scheduled or expected to execute between8 am today and 8 am next week.

Continued on next page

Page 616: ESP 5.2 Command Reference

616

SADGEN Command, Continued

Example 3 The following is an example of JCL that could be used to produce a scheduledactivity data set:

//jobname JOB …//STEP1 EXEC ESP,PARM=’SAR’//SYSPRINT DD SYSOUT=*//SYSIN DD *SADGEN DATASET(‘CYBER.SAD’) -FROM(’8AM TODAY’) TO(‘8AM TOMORROW’) -THRESH(60)/*

In the above example, the SADGEN command generates a scheduled activity dataset. CYBER.SAD contains information on Events that are scheduled between 8 amtoday and 8 am tomorrow. Events that are scheduled more frequently than once anhour are not included.

Page 617: ESP 5.2 Command Reference

617

SADLINK Command

Overview The SADLINK command is used to assign an identifier to a scheduled activity dataset for resolving External job dependencies. Normally the SADLINK command isused as an Initialization Parameter.

Type General command.

Authority OPER authority is required to issue the SADLINK command.

Syntax The syntax of the SADLINK command is:

SADLINK identifierDATASET(dsname)[GROUP(groupname)]

Parameter Descriptionidentifier Indicates an internal identifier of a scheduled activity data set.

Up to eight alphanumeric characters are allowed.dsname Indicates the name of a sequential data set used for storing

scheduled activity data.groupname Indicates the owning group. Any user who has either

operator authority or update access to the owning group canissue a SADLOAD command to refresh the in-core table.This applies only if you are using ESP’s internal security.

Usage notes The SADLINK command assigns an identifier to a SAD (schedule activity data set)file. Each time ESP initializes, or in response to a SADLOAD command, thecontents of the SAD file are read and information stored in a main-storage table. Torequest this table be used to resolve External job dependencies, specify theSADLINK identifier on the RESOLVE statement in an Application.

Relatedinformation

For information on generating a scheduled activity data set, see the SADGENcommand.

For information on identifying a scheduled activity data set at the InitializationParameter level, see the ESP Workload Manager Installation Guide.

For information on refreshing an in-core table containing scheduled activity data set,see the SADLOAD command.

For information on resolving dependencies through a scheduled activity data set, seethe RESOLVE command.

For information on displaying current SADLINK, see the LISTSADL command.

Continued on next page

Page 618: ESP 5.2 Command Reference

618

SADLINK Command, Continued

Example 1 The following SADLINK command identifies a scheduled data set:

SADLINK SAD1 DATASET(CYBER.SAD)

In the above example, CYBER.SAD is assigned an internal identifier of SAD1. Noowning group is specified.

Example 2 The following SADLINK command identifies a scheduled data set:

SADLINK SAD2 DATASET(CYBER.SAD) GROUP(PROD)

In the above example, CYBER.SAD is assigned an internal identifier of SAD2.PROD is identified as the owning group.

Page 619: ESP 5.2 Command Reference

619

SADLOAD Command

Overview The SADLOAD command is used to refresh a table containing scheduled activitydata set (SAD) information. It should be used whenever there is an update to theSAD file. You can automatically issue the SADLOAD command in batch followingthe generation of the SAD file.

Type General command.

Authority OPER authority is required to issue the SADLOAD command. A user with updateaccess to the owning group (as specified in a SADLINK command) is alsoauthorized.

Syntax The syntax of the SADLOAD command is:

SADLOAD identifier

Parameter Descriptionidentifier Indicates the internal identifier of a scheduled activity data

file (SAD file), as identified by a SADLINK command.

Usage notes The SADLOAD command causes the contents of the specified SAD file to be readand the necessary information stored in a table in main-storage. You can requestthat the look-up table be used to resolve External job dependencies by specifying thecorrect SADLINK identifier on the RESOLVE statement in an ESP Procedure. TheSADLOAD command should be issued whenever the SAD file is updated.

Relatedinformation

For information generating a scheduled activity data set, see the SADGENcommand.

For information on identifying an external scheduled activity data set, see theSADLINK command.

For information on resolving dependencies through a scheduled activity data set, seethe RESOLVE command.

For information on displaying current SADLINK, see the LISTSADL command.

Continued on next page

Page 620: ESP 5.2 Command Reference

620

SADLOAD Command, Continued

Example 1 The following SADLOAD command refreshes the in-core table:

OPER SADLOAD SAD1

In the above example, the in-core table containing scheduled activity information isrefreshed.

Example 2 The following is an example of JCL that could be used to produce a scheduleactivity data set and issue a SADLOAD command. In this example the name of theESP started task is ESP, the name of the ESP subsystem is ESPM:

//jobname JOB …//STEP1 EXEC ESP,PARM=’SAR’//SYSPRINT DD SYSOUT=*//SYSIN DD *SADGEN DATASET(‘CYBER.SAD’) -FROM(’8AM TODAY’) TO(‘8AM TOMORROW’)//STEP2 EXEC PGM=ESP,PARM=’SUBSYS(ESPM)’,COND=(0,NE)//SYSPRINT DD SYSOUT=*//SYSIN DD *SADLOAD SAD1/*

In the above example, the SADGEN command generates a scheduled activity dataset ‘CYBER.SAD’. It contains information on all Events that are scheduled orexpected to execute between 8 am today and 8 am tomorrow. STEP2 defines anautomatic SADLOAD command that occurs whenever the ESP command processorexecutes.

Page 621: ESP 5.2 Command Reference

621

SADUPD Command

Overview The SADUPD command is used to update a scheduled activity data set with actualinformation. It must be executed through the ESP subsystem started task Procedurewith a special parm (PARM=‘SAR’ or PARM=‘SAD’).

Type General command.

Syntax The syntax of the SADUPD command is:

SADUPD [DATASET(sardb)]

Parameter Descriptionsardb Indicates the name of a scheduled activity data set previously

created using the SADGEN command. It does not need to beenclosed in quotes.

Usage notes Note that unlike the SADGEN command, only the DATASET keyword is requiredfor SADUPD. The updated scheduled activity data set can be displayed using theSTATUS keyword on the LSAR command.

The scheduled activity update feature provides you with actual start and end timesfor jobs.

Relatedinformation

For information on extracting data from the scheduled activity data set, see theLSAR command.

For information on scheduled activity reporting, see the ESP Workload ManagerUser’s Guide.

For information generating a scheduled activity data set, see the SADGENcommand.

Example 1 The following is an example of JCL that can be used to update the scheduledactivity data set:

//jobname JOB …//STEP1 EXEC ESP,PARM=’SAR’//SYSPRINT DD SYSOUT=*//SYSIN DD *SADUPD DATASET(CYBER.SAD)

In the above example, the scheduled activity information in CYBER.SAD isupdated. The name of the ESP started task is ESP.

Page 622: ESP 5.2 Command Reference

622

SAFGRANT Command

Overview The SAFGRANT command is used to initialize or change access a user has to a SAFresource. This command can be used only if you are using RACF as your securityproduct.

Type General command.

Syntax The syntax of the SAFGRANT command is:

SAFGRANT (userid1[,userid2]...)(resource[,resource]...)

Parameter Descriptionuserid Indicates the user Id or RACF group to be PERMITed to the

resource specified. A list of user IDs can be specified.resource Indicates the resource for which the PERMITs are issued. A

list of resources can be specified.

Usage notes Use the SAFGRANT command to initialize or change a user’s access to a resource.This command simulates RACF’s RDEFINE and PERMIT commands. ESP issuesthe RDEFINE and PERMIT commands to complete the SAFGRANT request. Youcan specify several user IDs and multiple resource names in a single SAFGRANTcommand.

If you specify a resource you have not yet defined, ESP automatically defines theresource for you. ESP knows the general classname and resource prefix, based onthe SAFCLASS Initialization Parameter. Therefore, do not specify these in theSAFGRANT command. When ESP defines a resource in this way, it assignsUACC(NONE) to the resource.

Relatedinformation

For information on revoking access to SAF resources, see the SAFREVOKcommand.

For information on the System Authorization Facility (SAF), see the ESP WorkloadManager Administrator’s Guide.

For information on identifying the SAF resource class at the Initialization Parameterlevel, see the ESP Workload Manager Installation Guide.

Continued on next page

Page 623: ESP 5.2 Command Reference

623

SAFGRANT Command, Continued

Example 1 The following SAFGRANT command grants access to SAF resources:

SAFGRANT (DEV,SUPPORT,USR01) (ONLINE,GROUP.PAYROLL)

In the above example, RACF groups DEV and SUPPORT, and user USR01 aregranted read access to the ONLINE and GROUP.PAYROLL SAF resources.

Page 624: ESP 5.2 Command Reference

624

SAFOPTS Command

Overview The SAFOPTS command is used to control processing options for the SAFinterface. This statement is normally included in the Initialization Parameter dataset.

Type General command.

Authority OPER authority is required to issue the SAFOPTS command.

Syntax The syntax of the SAFOPTS command is:

SAFOPTS [DSALLOC|NODSALLOC][MVSCMD|NOMVSCMD][UTOKEN|NOUTOKEN][SIM3RDPARTY|NOSIM3RDPARTY][MSGSUPP|NOMSGSUPP][OPERCMDS|NOOPERCMDS

Parameter DescriptionDSALLOC Indicates ESP is to perform a SAF resource check before

dynamically allocating any data set. If the requestor doesnot have at least read access to the DSALLOC.dsnameresource, where dsname is the name of the data set ESP isallocating, the allocation fails. When ESP allocates the dataset on behalf of an Event, ESP uses the Event’s prefix forthe resource check. Otherwise, it uses its own user ID forthe resource check.

NODSALLOC Indicates ESP is not to perform a SAF resource check priorto dynamically allocating any data set. This is the default.

MVSCMD Indicates ESP is to use the MVSCMD.cmdstring resourcewhen verifying an Event’s authority to execute an MVScommand.

NOMVSCMD Indicates ESP is to use the OPER resource instead of theMVSCMD.cmdstring resource. This is the default.

Continued on next page

Page 625: ESP 5.2 Command Reference

625

SAFOPTS Command, Continued

NOMVSCMD (continued)

Parameter DescriptionUTOKEN Indicates ESP performs a Third Party RACHECK using a

SAF user token. When a client makes a request, the hostsystem performs a SAF TOKEN EXTRACT in the client’senvironment and passes the token to ESP (the server) forverification. RACF 1.9 or higher supports SAF user tokens.If you are using a different security product, ensure itsupports SAF TOKEN EXTRACT and Third PartyRACHECK.

NOUTOKEN Indicates ESP performs a Third Party RACHECK on theuser ID of the client. This is the default.

SIM3RDPARTY Indicates ESP simulates Third Party RACHECK processingsince the host security product does not support Third PartyRACHECK. Do not specify this option together with theUTOKEN option.

NOSIM3RDPARTY Indicates ESP uses normal Third Party RACHECKprocessing. This is the default.

MSGSUPP Indicates ESP suppresses violation messages whenperforming a RACHECK. If a violation occurs, the securitysystem product tracks it internally.

NOMSGSUPP Indicates ESP issue violation messages. This is the default.We recommend you use this option during testing.

OPERCMDS Indicates ESP is to use the OPERCMD.cmdname resource,rather than the more general OPER resource, whenverifying a user’s authority to execute an ESP operatorcommand.

NOOPERCMDS Indicates ESP use the OPER resource instead of theOPERCMD.cmdname resource. This is the default.

Usage notes You can use the SAFOPTS command to display the current SAF options. Anexample is shown below.

Relatedinformationcontinued

For information on the System Authorization Facility (SAF), see the ESP WorkloadManager Administrator’s Guide.

For information on identifying the SAF resource class at the Initialization Parameterlevel, see the ESP Workload Manager Installation Guide.

For information on defining SAF options at the Initialization Parameter level, see theESP Workload Manager Installation Guide.

Continued on next page

Page 626: ESP 5.2 Command Reference

626

SAFOPTS Command, Continued

Example 1 The following SAFOPTS command displays SAF options:

OPER SAFOPTSSAF Options: NoMsgSupp NoDsAlloc NoMvsCmd NoUToken NoSim3rdParty NoOperCmdsSAF Class: DSNR, Prefix ESP

In the above example, the current SAF options and the name of the SAF resourceclass are displayed.

Example 2 The following SAFOPTS turns on message suppression:

OPER SAFOPTS MSGSUPP

In the above example, ESP suppresses violation messages when performing aRACHECK.

Page 627: ESP 5.2 Command Reference

627

SAFRDEF Command

Overview The SAFRDEF command allows you to define RACF resources for use with ESP.This command can be used only if you are using RACF as your security product.

Type General command.

Syntax The syntax of the SAFRDEF command is:

SAFRDEF (resource1[,resource2]...)[UACC(NONE|READ|UPDATE|ALTER)]

Parameter Descriptionresource1 Indicates the resource to be defined. The resource classname

and optional resource prefix specified on the ESPSAFCLASS statement are used to build the RDEFINE RACFcommand. A list of resources to be defined can be specified.

UACC(…) Indicates the access for the user against the resource. NONEis the default.

Usage notes The SAFRDEF command works by issuing RACF RDEFINE commands.

Relatedinformation

For information on the System Authorization Facility (SAF), see the ESP WorkloadManager Administrator’s Guide.

For information on identifying the SAF resource class at the Initialization Parameterlevel, see the ESP Workload Manager Installation Guide.

Example 1 The following SAFRDEF command defines two SAF resources:

SAFRDEF (GROUP.OPS,GROUP.SUPPORT) UACC(READ)

In the above example, SAF resources GROUP.OPS and GROUP.SUPPORT, arecreated, both with a Universal Access of READ.

Page 628: ESP 5.2 Command Reference

628

SAFRDEL Command

Overview The SAFRDEL command is used to delete one or more SAF resources. Thiscommand applies only if you are using RACF for ESP security.

Type General command.

Syntax The syntax of the SAFRDEL command is:

SAFRDEL(resource1[,resource2]...)

Parameter Descriptionresource Indicates the resource to be deleted. The resource classname

and optional resource prefix specified on the ESPSAFCLASS statement are used. A list of resources to bedeleted can be specified.

Relatedinformation

For information on the System Authorization Facility (SAF), see the ESP WorkloadManager Administrator’s Guide.

Example 1 The following SAFRDEL command deletes a SAF resource:

SAFRDEL (GROUP.OPS)

In the above example, the GROUP.OPS resource is deleted.

Page 629: ESP 5.2 Command Reference

629

SAFREVOK Command

Overview The SAFREVOK command is used to remove a RACF user or group from theaccess list of a SAF resource. This command applies only if you are using RACFfor ESP security.

Type General command.

Syntax The syntax of the SAFREVOK command is:

SAFREVOK (userid1[,userid2]...)(resource1[,resource2]...)

Parameter Descriptionuserid Indicates the user ID or RACF group to have access revoked.

A list of user IDs can be specified.Resource Indicates the resource against which access is to be revoked.

A list of resources can be specified.

Relatedinformation

For information on granting access to resources, see the SAFGRANT command.

For information on the System Authorization Facility (SAF), see the ESP WorkloadManager Administrator’s Guide.

Example 1 The following SAFREVOK command revokes access to SAF resources:

SAFREVOK (DEV,SUPPORT,USR01) (ONLINE,GROUP.PAYROLL)

In the above example, RACF groups DEV and SUPPORT, and user USR01 arerevoked access to the ONLINE and GROUP.PAYROLL SAF resources.

Page 630: ESP 5.2 Command Reference

630

SCAN Command

Overview The SCAN command is used to scan a JCL data set or member for valid ESP controlstatement syntax. It can check what ESP submits at any time in the future. It canalso place a working copy of a job’s JCL into a work data set.

Type General command.

Syntax The syntax of the SCAN command is:

SCAN {dsname|*}EVENT(eventid)[PRINT(printdsn)][TRJOB(trjobname)][TRDSN(trdsname)][SCHED(schedtime)][JOB(jobname)][SYMBOL(symchar)][SYMLIB(sdsn[,sdsn]...)][TRUNIT(truname)][TRVOL(trvolser)][USER(userid)][GROUP(groupname)][CALENDARS(cal1[,cal2]...)][COPYJCL]

Parameter Descriptiondsname Indicates the data set containing the JCL to be scanned.* Indicates that input is to come from the SYSIN file.eventid Indicates the name of the Event for the job.printdsn Indicates the data set to which the JCL is copied. This data

set cannot be a PDS.trjobname Indicates a jobname for a simulated data set trigger. The

jobname is that of the job creating the data set. Thetrjobname parameter is passed to the ESPTRJOB symbolicvariable.

trdsname Indicates the name of a data set that causes a data set trigger.The trdsname parameter is passed to the ESPTRDSNsymbolic variable.

schedtime Indicates the schedule time for the job. This can be any timespecification valid on a SCHEDULE statement. If it containsseparator characters (comma or blanks), enclose it in quotes.

jobname Indicates the name of the job to be displayed, if the data setcontains a concatenation of multiple jobs.

symchar Indicates a one-byte symbol-introducer character. It defaultsto ‘%’.

Continued on next page

Page 631: ESP 5.2 Command Reference

631

SCAN Command, Continued

Syntax (continued)

Parameter Descriptionsdsn Indicates the name or names of data sets to be read for the

purposes of symbolic variable generation.truname Indicates the generic device type on which the data set is

created causing a data set trigger. The truname parameter ispassed to the ESPTRUNI symbolic variable.

trvolser Indicates the volume serial of the device on which the data setis created causing a data set trigger. The trvolser parameter ispassed to the ESPTRVOL symbolic variable.

userid Indicates the name of the defining user for this Event that ispassed to the ESPUSER symbolic variable.

groupname Indicates the current group name that is passed to theESPGROUP symbolic variable.

cal Indicates any required calendars to be retrieved for this Eventscan.

COPYJCL Indicates that the scan includes any JCL that is generated tothe COPYJCL data set (i.e. any JCL generated by%INCLUDE/EXCLUDE logic).

Usage notes The SCAN command is used to:

• Scan a data set or member to check any imbedded ESP control statements.• Retrieve a working copy of a previously submitted job.• Generate a working copy of a job to be submitted.

Once a JCL data set contains ESP control statements, that data set cannot besubmitted other than through ESP. This is because the ESP control statements causea JCL error. In case of ESP being unavailable, use the SCAN command in batch, togenerate a valid copy of the JCL and write the output to a data set. That data set canthen be submitted through other means.

Continued on next page

Page 632: ESP 5.2 Command Reference

632

SCAN Command, Continued

Example 1 The following SCAN command allows you to:

• Search for ESP control statements within data sets and member of a PDS• Retrieve a working copy of a job that you want to submit• Write the output from the working copies of the jobs to a data set.

SCAN ‘CYBER.JCL.CNTL(PAYJOB1)’ EVENT(CYBER.PAYROLL) –SCHED(‘24 MAY 2001’) SYMLIB(‘ESP.SYMBOLS(MYSYM)’)

In the above example:

• CYBER.JCL.CNTL(PAYJOB1) tells ESP where it can find the JCL for MYJOB• EVENT(CYBER.PAYROLL) is the Event that submits the job• SCHED(‘24TH MAY 2001’) is the schedule criteria• SYMLIB (‘ESP.SYMBOLS(MYSYM)’) contains symbol definitions for the job.

Note: If ESP is down you must run the SCAN command in batch. If ESP is up, youcan use any mode.

Page 633: ESP 5.2 Command Reference

633

SCHEDULE Command

Overview The SCHEDULE command is used to define schedule criteria for an Event, whichgenerally includes a time and a frequency.

Type Event definition command.

Syntax The syntax of the SCHEDULE command is:

{SCHEDULE|SCHED|SCH} criteria[OVERDUE{(count)}][ONCE]

Parameter Descriptioncriteria Schedule criteria.count Indicates an overdue count, a number from 0 to 10. Indicates

how many overdue occurrences of an Event are to bescheduled when an Event misses its scheduled times, perhapsafter a system outage. The default is 1.

ONCE Indicates the specified schedule is executed only once.

Usage notes Specify as many SCHEDULE commands as you need for an Event. The Event isexecuted at each time and date included in each schedule statement except for anycriteria specified on a NOSCHED command. If any times and dates from two ormore separate schedule statements coincide, the Event is executed only once at thattime.

An Event is considered to be overdue when something prevents it from executing atits scheduled time. The following reasons can make an Event overdue:

• A system outage• The Event is on hold• The Event’s class is on hold• Unavailability of Event initiator• ESP being placed in the quiesced state• The Event data set being suspended at the scheduled execution time.

The overdue count, set by the OVERDUE parameter, specifies how many overdueoccurrences of an Event are to be scheduled when normal scheduling is resumed.The default setting for the overdue count is one. If a count of zero is set, the Eventis bypassed and executes at its next scheduled time.

Specify ONCE to request that the schedule statement is executed once only and isthen deleted. If, at that point, no more schedule elements exist and no data settriggers are defined for the Event, the entire Event is scheduled for deletion 24 hourslater.

Continued on next page

Page 634: ESP 5.2 Command Reference

634

SCHEDULE Command, Continued

Relatedinformation

For information on specifying schedule criteria, see the ESP Workload ManagerUser’s Guide.

For information on defining when an Event will execute, see the ESP WorkloadManager User’s Guide.

For information on specifying when an Event should not execute, see theNOSCHED command.

Example 1 The following SCHEDULE command defines the schedule criteria for an Event:

EVENT ID(CYBER.PAYROLL)SCHEDULE 4PM WORKDAYSINVOKE ‘CYBER.PROCS.CNTL(PAYROLL)’ENDDEF

In the above example, CYBER.PAYROLL is scheduled for execution at 4 pmworkdays.

Example 2 The following SCHEDULE command defines the schedule criteria for an Event:

EVENT ID(CYBER.PAYROLL)SCHEDULE 4PM WEEKDAYSSCHEDULE 2PM WEEKENDSINVOKE ‘CYBER.PROCS.CNTL(PAYROLL)’ENDDEF

In the above example, CYBER.PAYROLL is scheduled for execution at 4 pmweekdays and 2 pm on weekends.

Example 3 The following SCHEDULE command defines the schedule criteria for an Event:

EVENT ID(CYBER.PAYROLL)SCHEDULE 8AM WORKDAYSNOSCHED 8AM LAST WORKDAY OF MONTHINVOKE ‘CYBER.PROCS.CNTL(PAYROLL)’ENDDEF

In the above example, CYBER.PAYROLL is scheduled for execution 8 amworkdays, except at 8 am on the last workday of the month.

Continued on next page

Page 635: ESP 5.2 Command Reference

635

SCHEDULE Command, Continued

Example 4 The following SCHEDULE command defines the schedule criteria for an Event:

EVENT ID(CYBER.PAYROLL)SCHEDULE 9AM 2ND-LAST DAY OF MONTHINVOKE ‘CYBER.PROCS.CNTL(PAYROLL)’ENDDEF

In the above example, CYBER.PAYROLL is scheduled for execution at 9 am fromthe second day of the month to the last day of the month.

Example 5 The following SCHEDULE command defines the schedule criteria for an Event:

EVENT ID(CYBER.CMDS)SCHEDULE 10AM WORKDAYS OVERDUE(0)INVOKE ‘CYBER.PROCS.CNTL(CMDS)’ENDDEF

In the above example, CYBER.CMDS is scheduled for execution 10 am workdays.If CYBER.CMDS misses its schedule execution time it does not execute.

Example 6 The following SCHEDULE command defines the schedule criteria for an Event:

EVENT ID(CYBER.PAYROLL)SCHEDULE EVERY 4 HOURS ROUND STARTING 8AM WEEKDAYSINVOKE ‘CYBER.PROCS.CNTL(PAYROLL)’ENDDEF

In the above example, CYBER.PAYROLL is scheduled for execution on weekdaysevery 4 hours starting at 8 am.

Example 7 The following SCHEDULE command defines the schedule criteria for an Event:

EVENT ID(CYBER.PAYROLL)SCHEDULE 8AM FEB21,1998 ONCEINVOKE ‘CYBER.PROCS.CNTL(PAYROLL)’ENDDEF

In the above example, CYBER.PAYROLL is scheduled at 8 am only on February21st, 1998. The Event is scheduled for automatic deletion 24 hours after this time.

Continued on next page

Page 636: ESP 5.2 Command Reference

636

SCHEDULE Command, Continued

Example 8 The following SCHEDULE command defines the schedule criteria for an Event:

EVENT ID(CYBER.PAYROLL)SCHEDULE 10PM FRIDAYSCHEDULE 10PM LAST WORKDAY OF MONTHINVOKE ‘CYBER.PROCS.CNTL(PAYROLL)’ENDDEF

In the above example, CYBER.PAYROLL is scheduled for execution at 10 pm onFridays and on the last workday of the month. When the last workday of the monthis a Friday, the Event executes only once.

Page 637: ESP 5.2 Command Reference

637

SECURE Statement

Overview The SECURE statement is used to secure any symbol.

Type Symbolic variable library statement.

Syntax The syntax of the SECURE statement is:

SECURE variable

Parameter Descriptionvariable Indicates the name of the secured symbolic variable.

Usage notes A secured symbol is one that contains sensitive data, such as a password, andconsequently requires additional security. ESP exerts control over secured symbolsbased on how ESP processes the symbol.

These are some of the controls that ESP exerts on secured symbols:

• ESP only produces the assigned values for JCL submitted to the internal reader• ESP does not produce the assigned values when writing JCL to a COPYJCL

library• SEND or VS subcommands do not produce the assigned values• You cannot assign a secured symbol to another symbol, i.e., a secured symbol

cannot appear to the right of the equal sign (=) in an assignment statement.

Relatedinformation

For information on defining symbolic libraries, see the DEFSYML command.

Example 1 The following is an example of how to identify a secured symbol:

PASSWORD=’OPEN’SECURE PASSWORD

In the above example, ESP resolves the symbolic %PASSWORD only when itencounters the symbol in JCL it submits to the internal reader.

Note: These statements are coded in a symbolic variable library.

Page 638: ESP 5.2 Command Reference

638

SELECT Statement

Overview The SELECT statement is used to identify that a job or subApplication should beselected as part of an Application.

Type ESP Application statement.

Syntax The syntax of the SELECT statement is:

SELECT {jobname|(jobname[,jobname])} [JOB|SUBAPPL]

Parameter Descriptionjobname Indicates a jobname. Enclose multiple jobnames in

parentheses, separated by a blank or comma.JOB Indicates a job is selected for submission. This is the default.SUBAPPL Indicates all jobs within a subApplication are being selected

for submission.

Usage notes The SELECT statement must be used after you have defined your job. If theSELECT statement is used for any job that has COREQ, POSTREQ or PREREQspecified, the jobs that these statements refer to are selected automatically.

Differentiate between whether or not you want to select a job or subApplicationusing the JOB or SUBAPPL keywords. JOB is the default.

Selecting a subApplication allows you to select a group of jobs with one statementinstead of selecting each job individually.

You cannot select a job and a subApplication using the same SELECT statement.

RUN statements are used within the scope of a JOB statement. This allows you tolook at a job definition and see the schedule frequency for the job. Many criteria canbe handled with RUN statements without the need for using “IF TODAY” typelogic.

SELECT statements allow you to easily see all the jobs with the same criteria.Changing the criteria for these jobs requires a change to a single SELECT statement.

Relatedinformation

For information on Applications, see the ESP Workload Manager User’s Guide.

For information on selecting jobs for submission, see the RUN, POSTREQ,PREREQ and COREQ statements.

For information on deselecting jobs for submission, see the DESELECT statement.

Continued on next page

Page 639: ESP 5.2 Command Reference

639

SELECT Statement, Continued

Example 1 The following SELECT statement selects multiple jobs for submission:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

REL PAYJOB2JOB PAYJOB2ENDJOBSELECT (PAYJOB1,PAYJOB2)

In the above example, PAYJOB1 and PAYJOB2 are selected for submissionwhenever the PAYROLL Application is invoked.

Example 2 The following SELECT statement selects multiple jobs for submission on a specificdays:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB3

REL PAYJOB4JOB PAYJOB4ENDJOBIF TODAY(‘WORKDAY’) THEN SELECT (PAYJOB3,PAYJOB4)

In the above example, PAYJOB3 and PAYJOB4 are selected for submission onworkdays.

Example 3 The following SELECT statement selects a subApplication for submission:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’SUBAPPL PREPJOBSJOB PAYJOB5

REL PAYJOB6JOB PAYJOB6

REL PAYJOB7JOB PAYJOB7

REL PAYJOB8JOB PAYJOB8ENDJOBSELECT PREPJOBS SUBAPPL

In the above example, the PREPJOBS subApplication is selected for submissionwhenever the PAYROLL Application is invoked.

Continued on next page

Page 640: ESP 5.2 Command Reference

640

SELECT Statement, Continued

Example 4 The following SELECT statement selects multiple jobs for submission on a specificdays:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB5

REL PAYJOB6JOB PAYJOB6

REL PAYJOB7JOB PAYJOB7ENDJOBIF TODAY(‘WORKDAYS’) THEN SELECT PAYJOB5IF TODAY(‘WEDNESDAY’) THEN SELECT PAYJOB6IF TODAY(‘FRIDAY’) THEN SELECT PAYJOB7

In the above example:

• PAYJOB5 is selected for submission on workdays• PAYJOB6 is selected for submission on Wednesdays• PAYJOB7 is selected for submission on Fridays.

Example 5 The following statements are used to:

• Select subApplications• Select a job within an Application• Deselect a subApplication• Deselect a job within an Application.APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB ACCJOB1

SUBAPPL ACCPAYENDJOBJOB ACCJOB2

SUBAPPL ACCPAYENDJOBJOB BILJOB1

SUBAPPL BILLINGENDJOBJOB BILJOB4

SUBAPPL BILLINGENDJOBJOB PAYJOB10ENDJOBSELECT (ACCPAY,BILLING) SUBAPPLSELECT PAYJOB10IF TODAY(‘LAST WORKDAY OF MONTH’) THEN DESELECT BILLINGSUBAPPLIF TODAY(‘MONDAY’) THEN DESELECT ACCJOB2

In the above example:

• The ACCPAY and BILLING subApplications are selected• PAYJOB10 is selected• The BILLING subApplication is not selected on the last workday of the month• ACCJOB2 is not selected on Mondays.

Continued on next page

Page 641: ESP 5.2 Command Reference

641

SELECT Statement, Continued

Example 6 The following SELECT statement selects multiple jobs on specific days:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB8

REL PAYJOB9JOB PAYJOB9ENDJOBIF TODAY(‘WORKDAYS’) THEN SELECT (PAYJOB8,PAYJOB9)IF TODAY(‘1ST WORKDAY OF MONTH’) THEN DESELECT PAYJOB9

In the above example, PAYJOB8 and PAYJOB9 are selected for submission onworkdays. On the first workday of the month, PAYJOB9 is deselected forsubmission.

Page 642: ESP 5.2 Command Reference

642

SEND Command

Overview The SEND command is used to send a message to yourself, another user, a group ofusers, or an operator console. By default, messages are sent now if a user is loggedon. If a user is not logged on, messages can be queued to the broadcast data set untilthe user logs on.

Type Event definition command.

Syntax The syntax of the SEND command is:

{SEND|SE} ‘message text’[USER{(*)|(userid[,userid]...)}][CN(console)][OPER(routing code)][ROSPFX(rospfx[,rospfx]...)][NONDEL][NOW][SYSTEM(name)]

Parameter Description‘messagetext’

Indicates a message to be transmitted, enclosed within quotes. Ifthe message contains imbedded quotes, they should be doubled up.The message can be up to 124 characters.

* Indicates the message is to be sent to the current user ID. This isthe default. ‘USER’ can be abbreviated to ‘U’.

userid Indicates one or more TSO user IDs to whom the message is sent.If a list of user IDs is specified, separate each one with a blank orcomma.

console Indicates the UCM ID of the console that is to receive the message.routing code Indicates the MCS routing code for a message to be sent to one or

more operator consoles. Value between 1 and 128.rospfx Indicates one or more ROSCOE users, identified by ROSCOE

prefix, to whom the message is sent. If a list of prefixes isspecified, separate each one with a blank or comma.

NONDEL Indicates the message is marked as non-roll-deletable, if it istransmitted to a console.

NOW Indicates the message be sent now if the user is logged on. If theuser is not logged on, the message is not queued to the broadcastdata set.

name Indicates the name of a SYSPLEX member. This is not the ESPsystem name, it’s the name by which MVS knows the member ofthe SYSPLEX. Can be used to route a SEND command in aSYSPLEX environment to wherever the use is logged on. Use anasterisk to indicate the message goes wherever ESP is running.

Continued on next page

Page 643: ESP 5.2 Command Reference

643

SEND Command, Continued

Usage notes You can include several SEND commands in an Event.

A SEND command can also be issued from an ESP Procedure.

Relatedinformation

For information on sending messages, see the ESP Workload Manager User’sGuide.

Example 1 The following SEND command sends a message to a specific user:

EVENT ID(CYBER.MESSAGE)SCHEDULE 8AM DAILYSEND ‘THE TIME IS %ESPATIME’ USER(USR01)ENDDEF

In the above example, USR01 is sent a message at 8 am everyday, indicating thecurrent time (represented by the %ESPATIME symbolic variable).

Example 2 The following SEND command sends a message to a console:

EVENT ID(CYBER.CICS_JOBEND)SEND ‘CICS ENDED’ CN(01) NONDELENDDEF

In the above example, a non-roll-deletable message is sent to console 01, indicatingthat a CICS region has ended.

Example 3 The following SEND commands are used in conjunction with ESP built-in symbolicvariables to send messages when the Application starts and completes:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB START.APPL LINK PROCESS

RUN DAILYREL PAYJOB1SEND ‘%ESPAPPL..%ESPAPGEN STARTED AT %ESPATIME’ USER(USR01)

JOB PAYJOB1RUN DAILYREL PAYJOB2

JOB PAYJOB2RUN DAILYREL END.APPL

JOB END.APPL LINK PROCESSRUN DAILYSEND ‘%ESPAPPL..%ESPAPGEN COMPLETED AT %ESPATIME’

USER(USR01)ENDJOB

In the above example, two messages are sent to USR01, the first when thePAYROLL Application starts and the second when it ends.

Continued on next page

Page 644: ESP 5.2 Command Reference

644

SEND Command, Continued

Other examples Here are more examples using the SEND command.

Indicates the message is sent now if the user is logged on. If the user is not loggedon the message is not queued to the broadcast data set:

SEND ‘SCHEDULING IS EASY WITH ESP’ USER(CYB01) NOW

Indicates the message is sent to a user in a SYSPLEX environment:

SEND ‘SCHEDULING IS EASY WITH ESP’ USER(CYB01) SYSTEM(SYSA)

Indicates a message is sent to two users, if either user is not logged on the messageis queued to the broadcast data set, until the user logs on:

SEND ‘SCHEDULING IS EASY WITH ESP’ U(CYB01,CYB02)

Page 645: ESP 5.2 Command Reference

645

SETPRINT Command

Overview The SETPRINT command is used to set the default output environment for TITLEprocessing.

Type General command.

Syntax The syntax of the SETPRINT command is:

SETPRINT repname

Parameter Descriptionrepname Indicates a one to eight alphanumeric logical report name, as

identified by a DEFPRINT command.

Relatedinformation

For information on defining titles, see the TITLE command.

For information on defining a logical report name, see the DEFPRINT command.

Example 1 The following SETPRINT command shows how titles can be set for a report:

SETPRINT CYBRPT1TITLE 1 ‘CYBERMATION INC.’TITLE 2 ‘DATA CENTER OPERATIONS REPORT’

In the above example, the titles are set for the CYBPRT1 report.

Page 646: ESP 5.2 Command Reference

646

SETWIDTH Command

Overview The SETWIDTH command is used to set the width of output.

Type General command.

Syntax The syntax of the SETWIDTH command is:

SETWIDTH nnn

Parameter Descriptionnnn Indicates the column width of a report. The default is 80.

Usage notes You can use this command to format output, for example, when issuing displaycommands from Page mode.

If you set the width in Page mode, it is reset when you exit from ESP.

Relatedinformation

For information on setting column width in a History report, see the DISPLAYcommand.

Example 1 The following SETWIDTH command is used in an ESP history report to indicate thecolumn width of the report:

REPORTSETWIDTH 80FROM 8AM TODAYCRITERIA APPLSYS EQ PAYROLLDISPLAY JOBNAME JOBNO EXECST CMPCENDR

In the above example, the history report produced by this series of reportingcommands is 80 columns.

Example 2 The following SETWIDTH command is used in Page mode:

SETWIDTH 132LSAR DSNAME(‘CYBER.SADFILE’)

In the above example, the width of output produced by an LSAR command is set to132 columns.

Page 647: ESP 5.2 Command Reference

647

SHADOW Command

Purpose The SHADOW command is used to display and manipulate a Shadow Manager.

Type General command.

Authority OPER authority is required to issue the SHADOW command.

Syntax The syntax of the SHADOW parameter is:SHADOW STATUS

[ASSUMEPRIMARY|ASSUMEPRIMARY FORCE][SHUTDOWN|SHUTDOWN RELINQUISH][HOLD(hold_interval)]

Parameter DescriptionSTATUS Displays the status of the primary/shadow

complex.

ASSUMEPRIMARY Indicates the Shadow Manager should take overthe duty of the primary manager.

ASSUMEPRIMARY FORCE Indicates the Shadow Manager should take overthe duty of the primary manager, whether theprimary manager is still active or not.

SHUTDOWN Indicates the Shadow Manager should relinquishits duty as primary manager and shutdown.

SHUTDOWN RELINQUISH Indicates the Shadow Manager should relinquishits duty as primary manager.

hold_interval Indicates the Shadow Manager should relinquishits duty as primary manager, shutdown, and holdthe primary role for a specified number ofminutes.

Usage notes When the ESP Shadow Manager determines that a hardware or software problemexists on the primary ESP system, ensure that the primary ESP system is completelydown before issuing the SHADOW ASSUMEPRIMARY command.

Continued on next page

Page 648: ESP 5.2 Command Reference

648

SHADOW Command, Continued

Relatedinformation

For information on the ESP Shadow Manager, see the ESP Shadow ManagerInstallation and User’s Guide.

For information on identifying Shadow Managers, see the ESP Workload ManagerInstallation Guide.

Example 1 The following SHADOW command displays the primary/shadow complex:

OPER SHADOW STATUS

Example 2 The following SHADOW command is used to take over primary Manager duties:

OPER SHADOW ASSUMEPRIMARY

In the above example, the Shadow Manager determines that a hardware or softwareproblems exists on the primary ESP system and takes over the duty of the primaryManager.

Example 3 The following SHADOW command is used to relinquish primary Manager duties:

OPER SHADOW RELINQUISH HOLD(20)

In the above example, the Shadow Manager relinquishes its duty as primaryManager and holds the primary role for 20 minutes.

Page 649: ESP 5.2 Command Reference

649

SIGCYCLE Command

Overview The SIGCYCLE command is used to cycle a signal, it creates a new currentgeneration.

Type General command.

Syntax The syntax of the SIGCYCLE command is:

SIGCYCLE signalname

Parameter Descriptionsignalname Indicates the name of the signal. If the prefix is not specified,

the current group or user prefix is used. Signalname maycontain * for wildcard and/or - for masking.

Usage notes Signals cause an ESP Event to wait for a condition in addition to its schedule criteriabefore it executes. A signal may represent a manual task, such as the arrival of aninput tape, or an automated task, such as the completion of a job.

Each signal has a generation number. ESP does not automatically reset thegeneration number of a signal after a signal posts. A cycling process resets thesignal. Cycling increments the generation number to the next higher number.

If the maximum number of generations already exists, ESP deletes the oldestgeneration. The signal definition statement specifies the maximum number ofgenerations. You can view this information using the LISTSIG subcommand.

The SIGCYCLE command can be used in an Event. It can also be used in Pagemode, an ESP Procedure, or batch.

Relatedinformation

For information on defining and deleting signals, see the DEFSIG and DELSIGcommands.

For information on posting a generation of a signal, see the SIGPOST command.

For information on displaying all generation of a signal, see the LISTSIG command.

For information on signal processing, see the ESP Workload Manager AdvancedUser’s Guide.

Continued on next page

Page 650: ESP 5.2 Command Reference

650

SIGCYCLE Command, Continued

Example 1 The following SIGCYCLE command creates a new generation of a signal:

SIGCYCLE TESTSIG

In the above example, the next generation of TESTSIG is cycled. If the currentgroup prefix is CYBER, ESP cycles the CYBER.TESTSIG signal.

Example 2 The following SIGCYCLE command creates a new generation of a signal:

EVENT ID(CYBER.PAYROLL)SCHEDULE 8PM WORKDAYSSIGCYCLE CYBER.SIGNAL1ENDDEF

In the above example, a new generation of CYBER.SIGNAL1 is created at 8 pmeach workday.

Page 651: ESP 5.2 Command Reference

651

SIGPOST Command

Overview The SIGPOST command is used to post a generation of a signal complete.

Type General command.

Syntax The syntax of the SIGPOST command is:

SIGPOST signalname[GEN(genno)]

Parameter Descriptionsignalname Indicates the name of the signal. If the prefix is omitted, the

current group or user prefix is used.genno Indicates the generation, either relative or absolute, of the

signal to be marked complete. A relative number must bezero or negative. If not specified, default is GEN(0), thecurrent generation.

Usage notes ESP does not automatically reset a signal’s generation number when it posts thecurrent generation. To reset the signal, use the SIGCYCLE command.

The SIGPOST command can be used in an Event, or issued from Page mode, an ESPProcedure, or batch.

Relatedinformation

For information on resetting the generation number of a signal, see the SIGCYCLEcommand.

For information on signal processing, see the ESP Workload Manager AdvancedUser’s Guide.

For information on defining and deleting signals, see the DEFSIG and DELSIGcommands.

For information on identifying that a signal must be marked complete beforeexecution of an Event, see the SIGWAIT command.

For information on displaying all generation of a signal, see the LISTSIG command.

Example 1 The following SIGPOST command posts a signal complete:

SIGPOST CYBER.SIGNAL1

In the above example, the current generation of CYBER.SIGNAL1 is postedcomplete.

Continued on next page

Page 652: ESP 5.2 Command Reference

652

SIGPOST Command, Continued

Example 2 The following SIGPOST command posts a signal complete:

SIGPOST CYBER.SIGNAL2 GEN(-1)

In the above example, the -1 relative generation of CYBER.SIGNAL2 is postedcomplete.

Example 3 The following SIGPOST command posts a signal complete:

SIGPOST CYBER.SIGNAL3 GEN(123)

In the above example, generation 123 of CYBER.SIGNAL3 is posted complete.

Example 4 The following SIGPOST command posts a signal complete:

GROUP CYBERSIGPOST MYSIGNAL

In the above example, the group prefix is set to CYBER, and the current generationon CYBER.MYSIGNAL is posted complete.

Example 5 The following SIGPOST command posts a signal complete:

EVENT ID(CYBER.PAYROLL5)SCHEDULE 10PM WORKDAYSSIGPOST CYBER.SIGNAL5 GEN(-1)ENDDEF

In the above example, the -1 relative generation of CYBER.SIGNAL5 is postedcomplete at 10 pm on workdays.

Page 653: ESP 5.2 Command Reference

653

SIGWAIT Command

Overview The SIGWAIT command is used to identify a signal that must be marked completebefore execution of the Event.

Type Event definition command.

Syntax The syntax of the SIGWAIT command is:

SIGWAIT signalname[GEN(genno)]

Parameter Descriptionsignalname Indicates the name of the signal. If the prefix is not specified

the current group prefix is used.genno Indicates an absolute or relative generation number of a

signal. The default is 0 (current generation).

Usage notes To instruct an Event to wait for posting of a signal, insert the SIGWAIT command inthe scheduled Event. You can use more than one SIGWAIT command if the Event isto wait for posting of different signals or different generations of the same signal.

The SIGWAIT command can be used only in conjunction with a SCHEDULEstatement. The Event waits until both the schedule criteria and signal conditions aresatisfied before execution.

Relatedinformation

For information on signal processing, see the ESP Workload Manager AdvancedUser’s Guide.

For information on defining and deleting signals, see the DEFSIG and DELSIGcommands.

For information on posting a generation of a signal, see the SIGPOST command.

For information on resetting the generation number of a signal, see the SIGCYCLEcommand.

For information on altering the numbers of generations of a signal, see the ALTSIGcommand.

For information on displaying all generations of a signal, see the LISTSIGcommand.

For information on specifying the maximum number of pending signals for anEvent, see the EVENT command - MAXPEND parameter.

Continued on next page

Page 654: ESP 5.2 Command Reference

654

SIGWAIT Command, Continued

Example 1 The following SIGWAIT command identifies a signal which must be markedcomplete:

EVENT ID(CYBER.PAYROLL)SCHEDULE 8PM WORKDAYSSIGWAIT PROD.DATA GEN(0)INVOKE ‘CYBER.PROCS.CNTL(PAYROLL)’ENDDEF

In the above example, CYBER.PAYROLL does not execute until PROD.DATA isposted complete and the schedule criteria are satisfied.

Page 655: ESP 5.2 Command Reference

655

SIMULATE Command

Overview The SIMULATE command is used to simulate the functions of an Event.

Type General command.

Syntax The syntax of the SIMULATE command is:

SIMULATE EVENT(eventid)[SCHED(schedtime)][PRINT(printdsn)][JCLDS][COPYJCL][ROOTJOB(job1[,job2]...)][JOB(jobname)][TRJOB(trigger_jobname)][TRDSN(trigger_dsname)][TRVOL(trigger_volume)][TRUNIT(trigger_unit)][USER(user_id)][GROUP(group_id)][PASSWORD(password)][SYMLIB(sym_dsn1[,sym_dsn2]...)][RTYPE(run_type)][WOB(module1[,module2]...)][VARS(variable_list)][SYMBOL(sym_char)][USER1(user_data1)][USER2(user_data2)][USER3(user_data3)][USER4(user_data4)][NOLISTPROC][JCLSCAN(exit_module)][NOREXX][NOTSELECTED][INHERIT]

Continued on next page

Page 656: ESP 5.2 Command Reference

656

SIMULATE Command, Continued

Syntax (continued)

Parameter DescriptionEVENT(eventid) Indicates the name of the Event for which you want

to simulate processing.SCHED(schedtime) Indicates the schedule time to be used for the

simulation. This can be any time specification validon a SCHEDULE command that resolves to a timeand date. If it contains separator characters(commas or blanks), enclose it within quotes. Thedefault is the next scheduled time.

PRINT(printdsn) Indicates the data set to which the JCL is copied.You can specify an asterisk (*) to view the JCL atyour terminal.

JCLDS Displays the JCL libraries used for each job. Thisincludes libraries and members identified byJCLLIB, TEMPLIB, DATASET and MEMBERstatements in an ESP Procedure.

COPYJCL Requests a simulation of what is written to theCOPYJCL library

ROOTJOB Indicates the names of jobs to which you want torestrict the simulation. Specifying jobname+includes jobname in the simulation plus itssuccessors.

JOB Indicates the name of the job being rerun.TRJOB(trigger_jobname) Indicates the job that caused the triggering action.TRDSN(trigger_dsname) Indicates the name of the data set that caused the

triggering action.TRVOL(trigger_volume) Indicates the volume serial number of the data set

that caused the triggering action.TRUNIT(trigger_unit) Indicates the unit name of the data set that caused

the triggering action.USER Indicates the user ID under which to simulate the

Event.GROUP Indicates the group value under which to simulate

the Event.PASSWORD Indicates the password value under which to

simulate the Event.SYMLIB Indicates a list of data set names of symbol libraries

to be used.

Continued on next page

Page 657: ESP 5.2 Command Reference

657

SIMULATE Command, Continued

Syntax (continued)

Parameter DescriptionWOB Generates a WOB module directory for use in the

simulation. If not specified, the directory belongingto the subsystem is used.

VARS(variable_list) Provides a list of variable names and values, e.g.varname(value). These variables can includemonitor and signal variables. The maximum lengthof the text in the list is 255 characters.

SYMBOL Indicates a symbol substitution character to be used.USER1, USER2, USER3and USER4

Indicates the USER variables passed to the Event.Each variable can be up to 80 characters.

NOLISTPROC Indicates unless errors are detected, the text of anyinvoked Procedures is not listed. If this parameter isomitted, the text of the Procedure is listed. If anerror is detected, the error messages are alwayslisted.

JCLSCAN(exit_module) Defines the name of the module used as theJCLSCAN exit module. If this parameter is omitted,no JCLSCAN exit processing is performed forsimulated job submissions.

NOREXX Indicates all input text between a REXXON and aREXXOFF statement is ignored. If this parameter isomitted, the in-line REXX code is interpreted byREXX.

NOTSELECTED Indicates a list is to be produced of all jobs notselected, for any reason. If this parameter isomitted, no list is produced for jobs that were notselected.

INHERIT Indicates if a successor was inherited, the inheritedrelationships are identified in the output report. Ifthis parameter is omitted, no indication is made forjobs that are inherited.

Continued on next page

Page 658: ESP 5.2 Command Reference

658

SIMULATE Command, Continued

Usage notes For the Event you select, the SIMULATE command tells you which jobs ESPsubmits, any messages it sends, how it substitutes symbolic variables, and so on. TheSIMULATE command is particularly useful with ESP Procedures because you canuse it to see how the complex and conditional components of your Procedure run ata particular date and time. ESP also displays error messages if it encountersproblems, such as syntax errors or successor loops in an Application. You cansimulate an Event for a day on which it is not normally scheduled; ESP simulateswhat would happen if the Event was triggered on that particular day.

Use the SIMULATE command to emulate the functions of any Event. If you useSIMULATE with no parameters, the next scheduled occurrence of the Event issimulated. If no scheduled time exists for an Event, ESP will assumes ‘NOW’. Usethe SCHED parameter to specify any valid schedule criteria to be used for thesimulation. This allows you to find out what happens if the Event executes on anyparticular date.

Using the PRINT parameter with SIMULATE requests that a copy of the JCL,which would be used at the time you are simulating, is made to a data set of yourchoice. The generated JCL has any symbols appropriately substituted. If you areusing ESP’s JCL Tailoring facility, any %INCLUDE and %EXCLUDE statementsare resolved. This means that you are able to see the JCL to be used at differenttimes.

You can also simulate Events using ESP’s ISPF interface - Option E.3 from the ESPMain Menu.

Relatedinformation

For information on Events, see the ESP Workload Manager User’s Guide.

Example 1 The following SIMULATE command simulates the functions of an Event:

SIMULATE EVENT(CYBER.PAYROLL) SCHED(‘LAST WORKDAY OF MONTH’)

In the above example, the functions that CYBER.PAYROLL performs on the lastworkday of the month are simulated.

Example 2 The following SIMULATE command simulates the functions of an Event:

SIMULATE EVENT(CYBER.PAYROLL1) SCHED(‘TOMORROW’) ROOTJOB(A,D+)

In the above example, the functions that CYBER.PAYROLL1 performs on the nextday are simulated. The simulation is restricted to job A and job D and itssuccessors.

Continued on next page

Page 659: ESP 5.2 Command Reference

659

SIMULATE Command, Continued

Example 3 The following SIMULATE command simulates the functions of an Event:

SIMULATE EVENT(CYBER.PAYROLL2) SCHED(‘MON’) USER1(‘PAYJOB1’)

In the above example, the functions that CYBER.PAYROLL2 performs on Monday,when the USER1 field is set to PAYJOB1 are simulated.

Other examples Here are more examples using the SIMULATE command.

Simulates an Event and displays the JCL libraries used for each job:

SIMULATE EVENT(CYBER.PAYROLL) JCLDS

Simulates an Event. The name of the module used as the JCLSCAN exit module:

SIMULATE EVENT(CYBER.PAYROLL) JCLSCAN(CHECKJCL)

Simulates an Event. All input text between a REXXON and REXXOFF statement isignored:

SIMULATE EVENT(CYBER.PAYROLL) NOREXX

Simulates an Event. If a successor was inherited, the inherited relationships areidentified:

SIMULATE EVENT(CYBER.PAYROLL) INHERIT

Simulates a job monitor Event and identifies monitor variables used by the Event:

SIMULATE EVENT(CYBER.PAYJOB1_JOBEND) +VARS(MNJOB(PAYJOB1),MNAPPL(PAYROLL))

Simulates an Event and passes a USER variable to the Event:

SIMULATE EVENT(CYBER.PAYROLL) USER1(‘PAYJOB1’)

Simulates an Event for the last day of the month. The output is sent to yourterminal:

SIMULATE EVENT(CYBER.PAYROLL) SCHED(‘LAST DAY OF MONTH’) +PRINT(*)

Continued on next page

Page 660: ESP 5.2 Command Reference

660

SIMULATE Command, Continued

Example 4 The following is an ISPF example, it requests that during simulation of an Event, thetext of any invoked ESP Procedure is not listed:ESP -------------------- SIMULATE EVENT EXECUTION -------------------- ESP

ADDITIONAL OPTIONSCOMMAND ===>DISPLAY PROCEDURE ===> N (blank, N or Y)SIMULATE DATASET TRIGGER ===> (blank, N or Y)SIMULATE SIGNALS ===> (blank, N or Y)SIMULATE MONITOR EVENT ===> (blank, N or Y)JCLSCAN EXIT NAME ===> (blank or name)SUPPRESS REXX ===> (blank, N or Y)SHOW NOT SELECTED ===> (blank, N or Y)SHOW INHERITANCE ===> (blank, N or Y)

The following is an example of the display produced when the ESP Procedure text isnot listed:

ESP ----------------------- EVENT CYBER.PAYROLL ---------------------------ESPCOMMAND ===>INVOKE CYBER.PROCLIB(PAYROLL)SIMULATION OF EVENT CYBER.PAYROLL AT 07.39.26 ON MONDAY MAY 30TH, 1997JOBS: PAYJOB1, PAYJOB992 JOBS SELECTED FOR SUBMISSION

JOB TYPE-JOBNAME--HC-RELEASESJOB PAYJOB1 0 (NONE)REQUEST PAYJOB99 0 (NONE)TASK PAYJOB2 0 (NONE)MAN SUB PAYJOB3 0 (NONE)LINK PAYJOB4 0 (NONE)

EXTERNAL PAYJOB5 0 (NONE)

Continued on next page

Page 661: ESP 5.2 Command Reference

661

SIMULATE Command, Continued

Example 5 The following is an ISPF example, it illustrates the simulation of a data set triggeredEvent:ESP -------------------- SIMULATE EVENT EXECUTION -------------------- ESP

ADDITIONAL OPTIONSCOMMAND ===>

DISPLAY PROCEDURE ===> (blank, N or Y)

SIMULATE DATASET TRIGGER ===> Y (blank, N or Y)

SIMULATE SIGNALS ===> (blank, N or Y)

SIMULATE MONITOR EVENT ===> (blank, N or Y)

JCLSCAN EXIT NAME ===> (blank or name)

SUPPRESS REXX ===> (blank, N or Y)

SHOW NOT SELECTED ===> (blank, N or Y)

SHOW INHERITANCE ===> (blank, N or Y)

Entering Y in the above panel presents you with the following panel, where you canspecify the data set name, the triggering job name, volume serial or unit that causedthe triggering action, as follows:ESP ---------------------- SIMULATE EVENT EXECUTION ---------------------- ESP

DATASET TRIGGER OPTIONSCOMMAND ===>

DATASET NAME ===> CYBER.TEST.DATA

TRIGGERING JOB NAME ===>

VOLUME SERIAL ===>

UNIT ===>

The following is an example of the display produced when data set name field inentered:ESP ----------------------- EVENT CYBER.PAYROLL ---------------------------ESPCOMMAND ===>INVOKE CYBER.PROCLIB(PAYROLL)APPL PAYROLLJCLLIB ‘CYBER.JCLLIB’JOB PAYJOB1RUN DAILYRELEASE PAYJOB2

JOB PAYJOB2RUN DAILY

ENDJOBSIMULATION OF EVENT CYBER.PAYROLL AT 07.39.26 ON MONDAY MAY 30TH, 1997JOBS: PAYJOB1, PAYJOB22 JOB SELECTED FOR SUBMISSION

JOB TYPE-JOBNAME--HC-RELEASESJOB PAYJOB1 0 (PAYJOB1)JOB PAYJOB2 1 (NONE)

Note: You are not testing if this Event is triggered by this data set, you are testingthe Event as if it was triggered by the data set name you specify. ESP resolvessymbolic variables based on this name.

Page 662: ESP 5.2 Command Reference

662

SMFSTATS Command

Overview The SMFSTATS command is used to display SMF statistics. The display includesthe number of job starts, started task starts, TSO user starts and step ends since theESP subsystem initialized.

Type General command.

Syntax The syntax of the SMFSTATS command is:

SMFSTATS

Example 1 The following is an example of the display produced by the SMFSTATS command:

SMFSTATSESP SUBSYSTEM INITIALIZED AT 11.35.47 ON SATURDAY FEBRUARY7TH, 199818959 ENTRIES TO SMFWTM, 8328 BY BRANCH ENTRY AND 10631 BY SVC1904 ENTRIES TO ESP PHASE 270 JOB STARTS, 2 STC STARTS, 12 TSU STARTS, 194 STEP ENDS

In the above example, since ESP initialized there were:

• 70 job starts• 2 started task starts• 12 TSO user starts• 194 step ends.

Page 663: ESP 5.2 Command Reference

663

SORT Command

Overview The SORT command is used to specify an ascending or descending sort sequencefor any of the entries specified by the DISPLAY command in an ESP history report.

Type Reporting command.

Syntax The syntax of the SORT command is:

SORT field{A|D}

Parameter Descriptionfield Indicates the name of a field.A Indicates sorting in ascending sequence. This is the default.D Indicates sorting in descending sequence.

Usage notes Several sort fields can be specified, one after the other, separated by a blank.

Relatedinformation

For information on history reporting, see the ESP Workload Manager User’s Guide.

For information on specifying fields to display on your history report, see theDISPLAY command.

Example 1 The following SORT command specifies the fields to be sorted:

REPORTFROM 8AM YESTERDAYCRITERIA APPLSYS EQ PAYROLLDISPLAY JOBNAME CPUTIME DEXCP EXECSTSORT CPUTIME D DEXCPENDR

In the above example, history data is sorted by decreasing use of CPU time(CPUTIME). If two or more jobs have matching CPU times, they are displayed insequence of ascending DASD EXCP counts (DEXCP).

Continued on next page

Page 664: ESP 5.2 Command Reference

664

SORT Command, Continued

Example 2 The following SORT command specifies the fields to be sorted:

REPORTFROM 8AM YESTERDAYCRITERIA APPLSYS EQ PAYROLLDISPLAY JOBNAME JOBNO INPUTQT EXECQTSORT JOBNAME EXECQTENDR

In the above example, history data is sorted by ascending jobname (JOBNAME). Iftwo or more jobs have the same name, they are displayed in sequence of ascendingexecution queue time (EXECQT).

Page 665: ESP 5.2 Command Reference

665

SPACE Command

Overview The SPACE command is used to space output by one or more lines to make theoutput easier to read.

Type General command.

Syntax The syntax of the SPACE command is:

SPACE [count]

Parameter Descriptioncount Indicates the number of lines to be advanced. The default is

1.

Usage notes The SPACE command can be used in Page mode or in batch.

Example 1 The following SPACE command inserts spaces in an output listing:

LISTSPECSPACE 4LISTHOL

In the above example, four blank lines are inserted between the special day listing(LISTSPEC) and the holiday display (LISTHOL).

Page 666: ESP 5.2 Command Reference

666

SPINLOG Command

Overview The SPINLOG command is used to spin ESP’s audit log to a sysout class.

Type General command.

Authority OPER authority is required to issue the SPINLOG command.

Syntax The syntax of the SPINLOG command is:

SPINLOG

Usage notes The sysout class, and optionally the form number for spinning the audit log, isidentified by the AUDITLOG Initialization Parameter.

Relatedinformation

For information on setting the print characteristics of ESP’s audit log, see theAUDITLOG parameter in the ESP Workload Manager Installation Guide.

Example 1 The following is an example of the display produced by the SPINLOG command.

OPER SPINLOGESP1023I Auditlog dataset spun with 262 records to sysoutclass E

In the above example, 262 records are spun to sysout class E.

Page 667: ESP 5.2 Command Reference

667

SPUSER Command

Overview The SPUSER command is used to identify the initial user who must access ESP toperform the user and group definitions. The SPUSER command is meaningful onlyin non-SAF environments.

Type General command.

Authority OPER authority is required to issue the SPUSER command.

Syntax The syntax of the SPUSER command is:

SPUSER userid

Parameter Descriptionuserid Indicates the TSO user ID of the initial user.

Usage notes This SPUSER command is normally stored in the ESP cold Initialization Parameterdata set.

Relatedinformation

For information on defining an initial user to ESP at the Initialization Parameterlevel, see the ESP Workload Manager Installation Guide.

Example 1 The following SPUSER command identifies the initial user:

OPER SPUSER USR01

In the above example, USR01 is identified as the initial user. USR01 has access toESP to define users.

Page 668: ESP 5.2 Command Reference

668

STATUS Command

Overview The STATUS command is used to display the current ESP processing status.

Type General command.

Authority OPER authority is required to issue the STATUS command.

Syntax The syntax of the STATUS command is:

{STATUS|ST}

Usage notes The STATUS command displays the following information:

• The current ESP release number.• Whether ESP is quiesced or active.• Whether data set triggering is suspended or active.• The names of any suspended Event data sets.

Example 1 The following is an example of the display produced by the STATUS command:

OPER STATUSESP1977I ESP RELEASE 5.1.0.000 STATUSESP1978I EVENT SCHEDULING ACTIVEESP1979I DATASET TRIGGERING ACTIVE

In the above example, the current release of ESP is 5.1.0, ESP is active, data settriggering is active and there are not suspended Event data sets.

Page 669: ESP 5.2 Command Reference

669

STEPEND Statement

Overview The STEPEND statement is used to release resources back to the resource pool atjob step-end. You may release part or all of the resources back to the resource pool.The STEPEND statement is coded within the scope of the job statement. You canhave more than one STEPEND statement in one job.

Type ESP Application statement.

Syntax The syntax of the STEPEND statement is:STEPEND STEPNAME(stepname) PROCSTEP(procstep) –RELRES(n1,resname1,n2,resname2, …)

Parameter Descriptionstepname Indicates the name of the job step.procstep Indicates the name of the proc step.n1,resname Indicates the quantity and name of the resource to be released.

Example The following shows releasing one unit of a resource after STEP1, PROCA:APPL ONEJCLLIB ‘CYBER.JCLLIB.CNTL’JOB JOBA

RUN DAILYRESOURCE (6,T3480)STEPEND STEPNAME(STEP1) PROCSTEP(PROCA) RELRES(1,T3480)

ENDJOB

The following shows releasing two more units of the same resource later in the samejob:

APPL ONEJCLLIB ‘CYBER.JCLLIB.CNTL’JOB JOBA

RUN DAILYRESOURCE (5,T3480)STEPEND STEPNAME(STEP3) PROCSTEP(PROCB) RELRES(2,T3480)

ENDJOB

Ensure the stepnames and procsteps you specify match your JCL exactly. You canrelease resources by specifying just a procstep and not a stepname, if that is howyour JCL is tailored.

Resource types Step-level resource release is available for renewable resources only.

Note Step-level Resource Release only works if USERMOD 11 is off. When USERMOD11 is on, the Application Manager does not get step-end notification.

Page 670: ESP 5.2 Command Reference

670

SUBAPPL Statement

Overview The SUBAPPL statement is used to identify the logical name of a subApplicationwithin an Application. Choose a subApplication name different than that of anyjobname within the Application.

Type ESP Application statement.

Syntax The syntax of the SUBAPPL statement is:

SUBAPPL subapplid [WAIT|NOWAIT]

Parameter Descriptionsubapplid Indicates a subApplication identifier of up to eight

alphanumeric characters. The first character can not benumeric. The name of the subApplication must be differentfrom any job within the Application.

WAIT Indicates concurrent processing of different generations of thesame subApplication is not permitted. ESP ensures that asubApplication waits for the previous generation of the samesubApplication to complete. This can be specified at theApplication or the subApplication level.

NOWAIT Indicates concurrent processing of different generations of thesame subApplication is permitted. This is the default.

Usage notes You may choose to use a subApplication to:

• Break up a large Application into smaller groups of jobs• Combine smaller Applications into one common Application and use

subApplications to group related jobs together. This may alleviate the need forestablishing inter-Application relationships, that is, EXTERNAL jobs.

Using a subApplication allows you to:

• Display and manipulate all jobs in a subApplication using a single command.• Select or deselect all jobs in a subApplication using a single command.• Use the CSF to filter based on the subApplication.• Control concurrent processing of different generations of the same

subApplication.• Report on subApplications.

Continued on next page

Page 671: ESP 5.2 Command Reference

671

SUBAPPL Statement, Continued

Usage notescontinued

You can use the SUBAPPL statement at a global level or at a job level. A job levelsetting overrides a global setting.

You can select jobs within a subApplication by selecting each job or thesubApplication.

Relatedinformation

For information on Applications and subApplications, see the ESP WorkloadManager User’s Guide.

For information on manipulating subApplications using the CSF, see the ESPWorkload Manager User’s Guide.

For information on reporting on subApplications, see the ESP Workload ManagerUser’s Guide.

For information on selecting or deselecting entire subApplications, see the SELECTand DESELECT statements.

For information on manipulating jobs within Applications and subApplications, seethe APPLJOB or AJ command.

Example 1 The following SUBAPPL statement identifies a job as belonging to asubApplication:

JOB MYJOBSUBAPPL PREPJOBS

ENDJOB

In the above example, MYJOB is identified as belonging to the PREPJOBSsubApplication.

Continued on next page

Page 672: ESP 5.2 Command Reference

672

SUBAPPL Statement, Continued

Example 2 The following SUBAPPL statements identify subApplications:

APPL PAYROLLJCLLIB ‘CYB.PROD.JCL’

JOB PAYJOB1SUBAPPL ACCTPAY WAIT

JOB PAYJOB2SUBAPPL ACCTPAY

JOB RECJOB1SUBAPPL ACCTREC

JOB RECJOB2SUBAPPL ACCTREC

ENDJOBSELECT (ACCTPAY,ACCTREC) SUBAPPL

In the above example:

• PAYJOB1 and PAYJOB2 are grouped together into the ACCTPAYsubApplication. Each generation of the ACCTPAY subApplication must wait forthe previous generation to complete.

• RECJOB1 and RECJOB2 are grouped together into the ACCTRECsubApplication. Different generations of the ACCTREV subApplication canprocess at the same time.

Example 3 The following SUBAPPL statements identify subApplications:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’

SUBAPPL ACCTPAY WAITJOB PAYJOB1JOB PAYJOB2ENDJOBSUBAPPL BILLINGJOB BILLJOB1JOB BILLJOB2ENDJOB

In the above example:

• PAYJOB1 and PAYJOB2 are grouped together into the ACCTPAYsubApplication. Different generations of the ACCTPAY subApplication canprocess at the same time.

• BILLJOB1 and BILLJOB2 are grouped together into the BILLINGsubApplication. Different generations of the BILLING subApplication canprocess at the same time.

Continued on next page

Page 673: ESP 5.2 Command Reference

673

SUBAPPL Statement, Continued

Example 4 The following SUBAPPL statements identify jobs for subApplications within anApplication:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’

JOB PAYJOB1DELAYSUB 10PMRUN DAILYREL (REGJOB1,SPECJOB1)

ENDJOBJOB REGJOB1

SUBAPPL REGULARRUN DAILYREL REGJOB2

ENDJOBJOB REGJOB2

SUBAPPL REGULARRUN DAILYREL PAYJOB99

ENDJOBJOB SPECJOB1 REQUEST

SUBAPPL SPECIALRUN DAILYREL SPECJOB2

ENDJOBJOB SPECJOB2 REQUEST

SUBAPPL SPECIALRUN DAILYREL PAYJOB99

ENDJOBJOB PAYJOB99

RUN DAILYENDJOB

In the above example:

• REGJOB1 and REGJOB2 are grouped together into the REGULARsubApplication

• SPECJOB1 and SPECJOB2 are grouped together into the SPECIALsubApplication. Each job in the SPECIAL subApplication is identified as onrequest jobs, i.e. they may or may not run.

• PAYJOB1 and PAYJOB99 do not belong to a subApplication. PAYJOB1 has adelayed submission time of 10 pm.

Note: If this Application is triggered early in the day, it provides the opportunity torequest jobs within the SPECIAL subApplication prior to 10 pm.

Continued on next page

Page 674: ESP 5.2 Command Reference

674

SUBAPPL Statement, Continued

Example 5 The following Application invokes 4 separate members, each containing asubApplication:

APPL PAYROLLJCLLIB ‘CYBER.JCLLIB.CNTL’INVOKE ‘CYBER.PROCS.CNTL(ACCPAY)’INVOKE ‘CYBER.PROCS.CNTL(ACCREC)’INVOKE ‘CYBER.PROCS.CNTL(BILLING)’INVOKE ‘CYBER.PROCS.CNTL(REPORTS)’

In the above example, the PAYROLL Application consists of

• An APPL statement identifies the name of the Application• A JCLLIB statement tells ESP where to find each job’s execution JCL• 4 INVOKE statements identify the subApplications comprising the PAYROLL

Application.

The following are examples of the invoked members:

SUBAPPL ACCPAYJOB ACCJOB1…JOB ACCJOB99

SUBAPPL ACCRECJOB RECJOB1…JOB RECJOB99

SUBAPPL BILLINGJOB BILJOB1…JOB BILJOB99

SUBAPPL REPORTSJOB RPTJOB1…JOB RPTJOB99

Note: This method of subApplication organization is not required, but may providean option when an Application contains many subApplications, with eachsubApplication containing many jobs.

Page 675: ESP 5.2 Command Reference

675

SUBMIT Command

Overview The SUBMIT command is used to submit JCL into the internal reader.

Type Event definition command.

Syntax The syntax of the SUBMIT command is:

{SUBMIT|SUB} dsname[GENERATION(genno)][LEVEL{(levelname[,levelname]...)|(*)}]

Parameter Descriptiondsname Indicates a valid data set name. The current user prefix is

added if the data set name is not enclosed within quotes. Youcan include a member name within the data set specification.

genno Indicates a generation number for a generation data group(GDG). It must be zero or a negative number.

levelname Indicates a one to eight character string, or an asterisk. A listof level names, separated by blanks or commas, can bespecified.

* Indicates all members are to be submitted, in alphabeticalsequence, by member name.

Usage notes A single Event can submit more than one job. If there are relationships between thejobs you are submitting, you must use an Application, not an Event to submit them.

The SUBMIT command can also be issued from an ESP Procedure.

Multiple members of a PDS may be submitted with one SUBMIT command.Specify member names in full or by generic level. You can also request all membersof a PDS be submitted by specifying ‘LEVEL(*)’. Note that when using theLEVEL keyword, members of the PDS are read in alphabetical sequence by membername.

A data set (including a PDS) that is part of a GDG can also be used as a source forJCL. Use the GENERATION keyword to specify the relative generation number.This number must be 0 or negative.

Relatedinformation

For information on submitting JCL from an Event, see the ESP Workload ManagerUser’s Guide.

Continued on next page

Page 676: ESP 5.2 Command Reference

676

SUBMIT Command, Continued

Example 1 The following is an example of an Event definition that submits JCL:

EVENT ID(CYBER.PAYJOB1)SCHEDULE 9AM FIRST MONDAY OF MONTHSUBMIT ‘CYBER.JCL.CNTL(PAYJOB1)’ENDDEF

In the above example, PAYJOB1 is submitted at 9 am on the first Monday of themonth from CYBER.JCL.CNTL.

Example 2 The following is an example of an Event definition that submits two jobs:

EVENT ID(CYBER.PAYJOBS)SCHEDULE 10AM LAST DAY OF MONTHSUBMIT ‘CYBER.JCL.CNTL(PAYJOB2)’SUBMIT ‘CYBER.JCL.CNTL(PAYJOB3)’ENDDEF

In the above example, PAYJOB2 and PAYJOB3 are submitted at 10 am on the lastday of the month from CYBER.JCL.CNTL.

Example 3 The following is an example of an Event definition that submits JCL:

EVENT ID(CYBER.ALLJOBS)SCHEDULE 8PM MONDAYSUBMIT ‘CYBER.JCL.CNTL’ LEVEL(*)ENDDEF

In the above example, all members of CYBER.JCL.CNTL are submitted at 8 pmMondays.

Example 4 The following is an example of an Event definition that submits JCL:

EVENT ID(CYBER.ALLJOBS)SCHEDULE 9PM MONDAYSUBMIT ‘CYBER.JCL.CNTL’ LEVEL(A-,BP-)ENDDEF

In the above example, all members that start with ‘A’ or ‘BP’ are submitted at 9 pmon Mondays from CYBER.JCL.CNTL.

Continued on next page

Page 677: ESP 5.2 Command Reference

677

SUBMIT Command, Continued

Example 5 The following SUBMIT command is used with a built-in function in an ESPProcedure to submit JCL:

IF TODAY(‘NOT LAST DAY OF MONTH’) THEN -SUBMIT ‘CYBER.JCL.CNTL(PAYJOB4)’

In the above example, if today is not the last day of the month, ESP submitsPAYJOB4 from CYB.JCL.CNTL.

Page 678: ESP 5.2 Command Reference

678

SUSPEND Command - Event Level

Overview When used in an Event definition, the SUSPEND command increments the suspendcount of the Event. While the suspend count is greater than zero, Event execution isbypassed.

Type Event definition command.

Syntax The syntax of the SUSPEND command is:

SUSPEND criteria

Parameter Descriptioncriteria Schedule criteria that resolve to a single date and time.

Usage notes The RESUME command is used in conjunction with the SUSPEND command tomake a previously bypassed Event eligible for execution.

If you are using a time zone on your SUSPEND command, you should use the sametime zone on your RESUME command. If the Event has a schedule statement, thesame time zone should be used on the SCHEDULE, SUSPEND and RESUMEcommands.

Note:

The RELEASE command is used in conjunction with the HOLD command to makea previously postponed Event eligible for execution.

Relatedinformation

For information on Events, see the ESP Workload Manager User’s Guide.

For information on holding or releasing an Event’s execution, see the HOLD andRELEASE commands.

For information on decrementing an Event’s suspend count that was previouslyincremented using the SUSPEND command, see the RESUME command.

Example 1 The following is an example of an Event definition:

EVENT ID(CYBER.PAYROLL1)DSTRIG PAYROLL.INPUTSUSPEND DAILY AT 9AMRESUME DAILY AT 11AMSUBMIT ‘CYBER.JCL.CNTL(PAYJOB1)’ENDDEF

In the above example, SUSPEND and RESUME commands are used to preventPAYJOB1 from being submitted between 9 am and 11 am. If the data set triggerhappens between these times, ESP ignores it.

Continued on next page

Page 679: ESP 5.2 Command Reference

679

SUSPEND Command - Event Level, Continued

Example 2 The following is an example of an Event definition:

EVENT ID(CYBER.TIMEMSG)SCHEDULE WORKDAYS HOURLY ROUND STARTING TODAYSEND ‘THE TIME IS %ESPATIME’ U(CYB01)SUSPEND 16:01 WORKDAYSRESUME 7:59 WORKDAYSENDDEF

In the above example, SUSPEND and RESUME commands are used to limit thesending of a message to each hour between 8 am and 4 pm on workdays.

Example 3 The following is an example of an Event definition:

EVENT ID(CYBER.PAYROLL2)SCHEDULE 9PM PST WORKDAYSSUSPEND 8PM PST MARCH 2,1998 ONCERESUME 10PM PST MARCH 2,1998 ONCESUBMIT ‘CYBER.JCL.CNTL(PAYJOB2)’ENDDEF

In the above example, SUSPEND and RESUME commands are used to bypass theEvent between 8 pm and 10 pm Pacific Standard Time, on March 2, 1998 only.

Page 680: ESP 5.2 Command Reference

680

SUSPEND Command - General

Overview When used outside an Event definition, the SUSPEND command increments thesuspend count associated with an Event. When the suspend count is greater thanzero, event execution is bypassed.

Type General command.

Syntax The syntax of the SUSPEND command is:

SUSPEND eventid

Parameter Descriptioneventid Indicates a valid Event name. If no prefix is specified, the

current prefix as set by the GROUP command is used.

Usage notes The specified Event has its SUSPEND count incremented immediately.

The RESUME command is used in conjunction with the SUSPEND command tomake a previously bypassed Event eligible for execution.

The RELEASE command is used in conjunction with the HOLD command to makea previously postponed Event eligible for execution.

Relatedinformation

For information on Events, see the ESP Workload Manager User’s Guide.

For information on incrementing on holding or releasing an Event’s execution, seethe HOLD and RELEASE commands.

For information on decrementing an Event’s suspend count that was previouslyincremented using the SUSPEND command, see the RESUME command.

Examples 1 The following SUSPEND command suspends an Event:

SUSPEND CYBER.PAYROLL

In the above example, CYBER.PAYROLL is suspended and not eligible forexecution.

Page 681: ESP 5.2 Command Reference

681

SYMLIB Command

Overview The SYMLIB command is used to request the inclusion of one or more symbolicvariable libraries

Type Event definition command.

Syntax The syntax of the SYMLIB command is:

{SYMLIB|SYM} {symname}{symname[,symname]...}

Parameter Descriptionsymname Indicates the name of an existing SYMLIB of up to eight

characters. You can specify several names by enclosing thelist within parentheses and separating each item with a blankor comma.

Usage notes The SYMLIB command requests the inclusion of any number of symbolic variablelibraries as defined with the DEFSYML command. A symbolic variable library is acollection of sequential data sets or members or partitioned data sets. Each Eventcan request one or more symbol libraries.

If the same symbol is defined in more than one symbol library referenced in anEvent, the last value of the symbol is used.

Relatedinformation

For information on setting symbol libraries, see the ESP Workload Manager User’sGuide.

For information on invoking user symbolic variables, see the ESP WorkloadManager Advanced User’s Guide.

For information on defining a symbol library, see the DEFSYML command.

For information on displaying information about symbol libraries, see theLISTSYML command.

Continued on next page

Page 682: ESP 5.2 Command Reference

682

SYMLIB Command, Continued

Example 1 The following SYMLIB command references a symbolic variable library:

EVENT ID(CYBER.PAYROLL1)SYMLIB DATESINVOKE ‘CYBER.PROCS.CNTL(PAYROLL)’ENDDEF

In the above example, when ESP processes CYBER.PAYROLL1, it opens the dataset associated with DATES and uses this information to perform symbolic variablesubstitution.

Note: These same results can be accomplished by invoking an ESP Procedure thatstores symbolic variables, as follows:

EVENT ID(CYBER.PAYROLL1)INVOKE ‘CYBER.PROCS.CNTL(PAYROLL)’INVOKE ‘CYBER.SYMBOLS.CNTL(DATES)’ENDDEF

Example 2 The following SYMLIB command references two symbolic variable libraries:

EVENT ID(CYBER.PAYROLL2)SYMLIB MDATES PDATESINVOKE ‘CYBER.PROCS.CNTL(PAYROLL)’ENDDEF

In the above example, when ESP processes CYBER.PAYROLL2, it opens the datasets associated with MDATES and PDATES and uses this information to performsymbolic variable substitution.

Page 683: ESP 5.2 Command Reference

683

SYSMSGS Command

Overview The SYSMSGS command is used to intercept messages written to the systemmessage data set. Use ESP to cancel a job, fail a job, trigger an Event or issue aWTO message when a specific message is intercepted.

Type General command.

Authority OPER authority is required to issue the SYSMSGS command.

Syntax The syntax of the SYSMSGS command is:

SYSMSGS [‘text’][DISABLE|ENABLE|IGNORE][CANCEL|CCFAIL|JCLERROR|WARN][TSU][STC][ID(xxxx)][COL(nn[:nn])][NAME(jobname[,jobname]...)[EVENT(eventid)][COUNT(m)][ROUTE(rcode)][DESC(dcode)][JOBNAME][WTO][COMPRESS]

Parameter Descriptiontext Indicates the part of the message text that defines the message

you want intercepted. This can be a message identifier, aprefix or any part of the message text. This parameter mustnot be specified if the DISABLE, ENABLE or IGNOREkeywords are specified. However, it must be specified if thesekeywords are not specified. The maximum length of thisfield is 32 bytes.

DISABLE Temporarily suspends an existing entry for the specifiedmessage ID and prevents its interception. Note that the IDparameter must be specified and no other parameter may bespecified, including the message text.

ENABLE Re-enables a suspended entry for the specified message ID.Note that the ID parameter must be specified and no otherparameter may be specified, including the message text.

IGNORE Invalidates and deletes an existing entry for the specifiedmessage ID and prevents its interception. Note that the IDparameter must be specified and no other parameter may bespecified, including the message text.

Continued on next page

Page 684: ESP 5.2 Command Reference

684

SYSMSGS Command, Continued

Syntax (continued)

Parameter DescriptionCANCEL Indicates interception of this message text should generate an

MVS cancellation of the job (system abend code 222).CCFAIL Indicates interception of this message should cause a

condition code failure.JCLERROR Indicates interception of this message should cause a JCL

error.WARN Indicates ESP generates a warning message when this

message is intercepted. The messages are displayed when anLTJ command is issued for the job that issued the message.Note that no action takes place with this option, only awarning message is issued.

TSU Indicates interception of this message should only occur fortime sharing users (TSUs).

STC Indicates interception of this message should only occur forstarted tasks (STCs).

ID(xxxx) Indicates an identifier consisting of 4 alphanumericcharacters. You can assign an ID when you defineSYSMSGS, else ESP assigns the next available sequentialnumber. The identifier controls the order of search when ESPis tracking system messages. It must be used with DISABLE,ENABLE and IGNORE. Specify ID(*) for all.

nn Indicates a column or range of columns where the specifiedmessage text should begin. The default is column 1.

jobname Indicates up to 4 jobnames (or jobname strings), thus limitingthe system message interception for a particular job, or set ofjobs.

eventid Indicates the Event to be triggered when the system messageis intercepted. EVENT can be abbreviated as EV.

m Indicates the Event is to be scheduled for every minterceptions of the system message, where m is a numberfrom 0 to 255. A value of 0 results in a schedule for eachinterception, as does a value of 1. It defaults to 1.

rcode Indicates the routing code that identifies the console to whichthis message should be sent. If it is omitted, the defaultrouting code is 2.

dcode Indicates the descriptor code that is to apply to this message.If it is omitted, the default descriptor code is 6. Use DESC(2)for a non-deletable message.

JOBNAME Indicates the job name should be embedded within themessage when it is rebroadcast on the console.

WTO Indicates the message should be rebroadcast as a WTOmessage.

COMPRESS Indicates extra blanks are to be removed from the text.

Continued on next page

Page 685: ESP 5.2 Command Reference

685

SYSMSGS Command, Continued

Usage notes This command causes failure of a job or the triggering of an Event, through theinterception of pre-defined message ID or message text. The message can be issuedfrom a console or from an authorized terminal, and routed to any specified console.Ensure that the ‘SYSMSGS’ parameter is first specified with the TRACKOPTcommand or ESP Initialization Parameter. If ‘TRACKOPT SYSMSGS’ is notspecified, system messages are not intercepted.

The message text must not be specified for the DISABLE, ENABLE or IGNOREparameters. These parameters require that the ID parameter also be specified and noother parameters are allowed.

SYSMSGS must be specified on the system that does the tracking. If ESP is trackingon the Master, enter this on the Master. If ESP is tracking on the Slave, enter this onthe Slave. TRACKOPT SYSMSGS must also be specified on the tracking system.

When the SYSMSGS command is first used to identify message interception, ittakes effect immediately. Use the ENABLE parameter only after a SYSMSGS IDhas been disabled.

Relatedinformation

For information on clearing system message interceptions, see the CLRSYSMScommand.

For information on displaying information on all system messages that are currentlyintercepted by ESP, see the LSYSMSGS command.

Example 1 The following SYSMSGS command intercepts messages:

SYSMSGS ‘NOT CATLGD’ COL(50:60) CANCEL WTO JOBNAME

In the above example, whenever a NOT CATLGD system message is generatedstarting anywhere between columns 50 and 60, cancel the job and embed thejobname when the message is rebroadcast as a WTO.

Example 2 The following SYSMSGS command intercepts messages:

SYSMSGS ‘IEF142I’ NAME(PAYJOB1) EVENT(CYBER.PAYSTEP)

In the above example, whenever an IEF142I system message is generated forPAYJOB1, trigger Event CYBER.PAYSTEP.

Continued on next page

Page 686: ESP 5.2 Command Reference

686

SYSMSGS Command, Continued

Example 3 The following SYSMSGS command intercepts messages:

SYSMSGS ‘IEF253I’ ID(0010) NAME(J-,K-) CANCEL EV(CYBER.CAN)DESC(2)

In the above example, whenever an IEF253I system message is generated for jobswith 2 character names beginning with J or K, cancel the job and trigger EventCYBER.CAN. Highlight the message using descriptor code 2. Assign an ID of 0010to this system message interception.

Example 4 The following SYSMSGS command ignores system message interception for aspecific message ID:

SYSMSGS IGNORE ID(0023)

In the above example, all message system interception processing for systemmessage ID 0023 is ignored.

Example 5 The following SYSMSGS command disables system message interception for aspecific message ID:

SYSMSGS DISABLE ID(0002)

In the above example, all system message interception processing for systemmessage ID 0002 is disabled.

Example 6 The following SYSMSGS command enables system message interception for aspecific message ID:

SYSMSGS ENABLE ID(0002)

In the above example, all system message interception processing for systemmessage ID 0002 is enabled.

Example 7 The following SYSMSGS command activates system message interception for aspecific message ID:

SYSMSGS ‘IEC161I’ NAME(UT-) WARN COUNT(99)

In the above example, whenever 99 IEC161I system messages have been generatedfor jobnames beginning with ‘UT’, a warning message is issued.

Page 687: ESP 5.2 Command Reference

687

TAG Statement

Overview The TAG statement is used to “tag” jobs in an Application with a character string upto 16 characters in length. The TAG statement can be job specific or can apply toall jobs in an Application.

Type ESP Application statement.

Syntax The syntax of the TAG statement is:

TAG ‘string’

Parameter Descriptionstring Indicates a character string in up to 16 characters. If the

string contains separator characters (comma or blanks),enclose it within quotes. This string may contain ESPsymbolic variables.

Usage notes Using the TAG statement allows you to:

• Filter jobs with a common characteristic using the CSF• Pass information to JCL using the %ESPAPTAG symbolic variable.

Relatedinformation

For information on Applications, see the ESP Workload Manager User’s Guide.

For information on the CSF, see the ESP Workload Manager User’s Guide.

Example 1 The following TAG statement associates a character string with a specific job:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’JOB PAYJOB1

TAG ‘CRITICAL JOB’RUN WORKDAYS

ENDJOB

In the above example, PAYJOB1 is tagged with the character string CRITICALJOB.

Continued on next page

Page 688: ESP 5.2 Command Reference

688

TAG Statement, Continued

Example 2 The following TAG statement associates a character string with an entireApplication:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’TAG ‘%ESPSDAY(1:3)’JOB PAYJOB2

RUN WORKDAYSREL PAYJOB3

JOB PAYJOB3RUN WORKDAYSREL PAYJOB4

JOB PAYJOB4RUN WORKDAYS

ENDJOB

In the above example, a symbolic variable is used to tag all jobs in the PAYROLLApplication with the 3-character day of the week name (e.g. MON for Monday).

Other examples Here are more examples using the TAG statement.

Associates a character string with a job:

JOB PAYJOB5TAG IMPORTANT

ENDJOB

Associates a character string with a job:

JOB PAYJOB6TAG ‘TIME 18:00’

ENDJOB

Associates a character string with a job:

JOB PAYJOB7TAG ‘DIVISION 123’

ENDJOB

Page 689: ESP 5.2 Command Reference

689

TEMPLATE Statement

Overview The TEMPLATE statement is used to name a template and identify any parametersand variables available during template processing.

Type ESP Procedure statement.

Syntax The syntax of the TEMPLATE statement is:

TEMPLATE name ([posct] [parms...])[LOCALVARIABLES|GLOBALVARIABLES]

Parameter DescriptionTEMPLATE Indicates the beginning of the template definition.name Indicates the name the template.posct Indicates the number of positional parameters.

Positional parameters must be passed to the templatein the order specified.

parms Indicates any positional, keyword, or keyword(value)parameters.

LOCALVARIABLES Defines variables to be used only with the body of thetemplate.

GLOBALVARIABLES Defines variables to be used within or outside the bodyof the template. This is the default.

Continued on next page

Page 690: ESP 5.2 Command Reference

690

TEMPLATE Statement, Continued

Usage notes Once you use the TEMPLATE statement, specify the statements you want to processeach time the template is used. End the template with the ENDTEMPL statement.To use a template, specify its name and identify the parameters you are passing to it.

Template processing involves the expansion of a template so that ESP can performsubstitution. For example, if a template is used to define an Application consistingof 5 jobs, the template is expanded 5 times. During the expansion of the template,ESP substitutes the appropriate values as per the template definition statements, togenerate the Application.

Templates provide a simplified method of entering data when there is a high degreeof repetition and are useful for defining similar jobs and using other repetitive code.Templates allow you to use and enforce standards and reduce maintenance.

Templates are available any where CLANG is available:

• Page mode• Line mode• ESP Initialization Parameters• ESP Procedures.

Templates are available for use at any time while the same command environment isactive (e.g. Page mode, ESP Event, etc.)

Multiple templates can be used within the input stream (e.g. Application definition).

RelatedStatements

For information on working with templates, see the ESP Workload ManagerAdvanced User’s Guide.

For information on ending a template definition, see the ENDTEMPL statement.

Continued on next page

Page 691: ESP 5.2 Command Reference

691

TEMPLATE Statement, Continued

Example 1 The following template is used to define similar jobs in an Application:

APPL PAYROLLJCLLIB ’CYBBP01.TESTJOBS.CNTL’TEMPLATE ACCPAY (1,JOBNAME)

JOB %JOBNAMESUBAPPL ACCPAYRUN DAILYTAG ‘CRITICAL’

ENDJOBENDTEMPLACCPAY ACCJOB1ACCPAY ACCJOB2ACCPAY ACCJOB3

The TEMPLATE statement indicates:

• The name of the template is ACCPAY• One positional parameter called JOBNAME is available for substitution during

template processing.

During the expansion of the template ESP substitutes the appropriate value forJOBNAME as follows:

• ACCJOB1 runs daily, belongs to the ACCPAY subApplication and has a tag ofCRITICAL associated with it

• ACCJOB 2 runs daily, belongs to the ACCPAY subApplication and has a tag ofCRITICAL associated with it

• ACCJOB3 runs daily, belongs to the ACCPAY subApplication and has a tag ofCRITICAL associated with it.

Example 2 The following is an example of a TEMPLATE definition:

TEMPLATE ANYHOL (3,NAME,DATE,YEAR)DEFHOL %NAME START(%DATE %YEAR)

ENDTEMPL

In the above example, three positional parameters are defined and must be passed tothe template in the specified order - NAME, DATE and YEAR.

The following is an example of passing data to the template:

ANYHOL XMAS DECEMBER25 1999

In the above example, NAME has the value ‘XMAS’, DATE has the value‘DECEMBER25’, YEAR has the value ‘1999’.

Continued on next page

Page 692: ESP 5.2 Command Reference

692

TEMPLATE Statement, Continued

Example 3 The following is an example of a TEMPLATE definition:

TEMPLATE ANYHOL (1,NAME,DATE())DEFHOL %NAME START(%DATE)

ENDTEMPL

In the above example, one positional parameter is identified and must be passed tothe template in the specified order. This represents the name of a holiday. TheDATE can be specified using any scheduling term ESP recognizes.

The following is an example of passing data to the template:

ANYHOL XMAS DATE(DECEMBER 25,1999)

In the above example, NAME has the value ‘XMAS’ and DATE has the value‘DECEMBER 25, 1999’.

Example 4 The following template is used to define similar jobs in an Application:

APPL PAYROLLJCLLIB ’CYBER.JCLLIB.CNTL’TEMPLATE PAY (1 JOBNAME FREQ(DAILY) NEXT())

JOB %JOBNAMEIF FREQ NE ”” THEN RUN %FREQIF NEXT NE ”” THEN RELEASE (%NEXT)TAG PJOB

ENDJOBENDTEMPLPAY PAYJOB1 NEXT(PAYJOB2,PAYJOB3)PAY PAYJOB2 NEXT(PAYJOB4)PAY PAYJOB3 FREQ(WEEKDAYS) NEXT(PAYJOB4)PAY PAYJOB4 NEXT(PAYJOB5)PAY PAYJOB5 FREQ(LAST WORKDAY OF MONTH)

In the above example, the TEMPLATE statement indicates:

• The name of the template is PAY.• One positional parameter is available for substitution during template processing.

This represents the jobname.• The FREQ variable has the value ‘DAILY’.• The NEXT variable is set to null, but can be passed to the template.

During the expansion of the template, ESP substitutes the appropriate value asfollows:

• PAYJOB1 runs daily and releases PAYJOB2 and PAYJOB3• PAYJOB2 runs daily and releases PAYJOB4• PAYJOB3 runs Wednesdays and releases PAYJOB4• PAYJOB4 runs daily and releases PAYJOB5• PAYJOB5 runs on the last workday of the month and has no successors.

Continued on next page

Page 693: ESP 5.2 Command Reference

693

TEMPLATE Statement, Continued

Example 5 The following is an example of a TEMPLATE definition:

TEMPLATE REGJOB (1,NAME,RUN(),NORUN(),REL())JOB %JOB

IF RUN NE ‘’ THEN RUN %RUNIF NORUN NE ‘’ THEN NORUN %NORUNIF REL NE ‘’ THEN RELEASE %REL

ENDJOBENDTEMPL

The following is an example of passing data to the template:

REGJOB PAYJOB1 RUN(LAST DAY OF MONTH) REL(PAYJOB2)REGJOB PAYJOB2 RUN(WORKDAYS) NORUN(FRIDAY) REL(PAYJOB3)REGJOB PAYJOB3 RUN(WED)

• As a result of the first statement: NAME has the value ‘PAYJOB1’, RUN has thevalue ‘LAST DAY OF MONTH’, REL has the value ‘PAYJOB2’.

• As a result of the second statement: NAME has the value ‘PAYJOB2’, RUN hasthe value ‘WORKDAYS’, NORUN has the value ‘FRIDAY’, REL has the value‘PAYJOB3’.

• As a result of the third statement: NAME has the value ‘PAYJOB3’, RUN has thevalue ‘WED’.

Page 694: ESP 5.2 Command Reference

694

TEMPLIB Statement

Overview The TEMPLIB statement is used to identify the temporary or override JCL libraryyou want to use as the default for all jobs following this statement. ESP uses JCLfrom this library for job submission if it exists. Otherwise it uses JCL from the mostrecent JCLLIB statement.

Type ESP Application statement.

Syntax The syntax of the TEMPLIB statement is:

TEMPLIB dsname

Parameter Descriptiondsname Indicates the name of the data set where the override JCL

resides.

Usage notes This statement identifies the temporary JCL library to be used as the default for alljobs following this statement. The member name is assumed to be the same as thejob name. If a temporary library is specified, and the job exists in this library, ESPsubmits the job from the library. Otherwise, ESP uses the JCL library from the mostrecent JCLLIB statement. The //* UNTIL and //* FROM statements can be used tocontrol the use of temporary JCL.

When using TEMPLIB for a job, it is not necessary to have the job in the JCLLIB ifit exists in the TEMPLIB.

ESP does not automatically delete the job from TEMPLIB when it completes.

Relatedinformation

For information on identifying JCL libraries, see the ESP Workload Manager User’sGuide.

For information on specifying a JCL library, see the JCLLIB statement.

For information on specifying an optional JCL library for an individual job, see theDATASET statement.

Relatedinformationcontinued

For information on specifying the member name in which ESP will find a job’sexecution JCL, see the MEMBER statement.

For information on limiting the window in which temporary JCL is used, see the

//* FROM and //* UNTIL statements.

Continued on next page

Page 695: ESP 5.2 Command Reference

695

TEMPLIB Statement, Continued

Example 1 The following TEMPLIB statement identifies an override JCL library:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’TEMPLIB ‘CYBER.OVERRIDE.CNTL’JOB PAYJOB1

RUN WORKDAYSENDJOB

Note: To limit the window in which ESP uses temporary JCL, use the //* FROMand/or //* UNTIL statements as follows:

//* FROM 9AM DECEMBER 31,1999//* UNTIL 5PM JANUARY 4TH, 2000//PAYJOB1 JOB CYB,CLASS=A,MSGCLASS=0

In the above example, ESP uses JCL for PAYJOB1 between December 31st, 1999 at9 am and January 5th, 2000 at 5 pm, if it exists in CYBER.OVERRIDE.CNTL.Otherwise ESP uses JCL from CYBER.JCL.CNTL.

Example 2 The following TEMPLIB statement is used to ensure that JCL from the appropriatescheduled date is used:

APPL PAYROLLJCLLIB ‘CYBER.JCL.CNTL’TEMPLIB ‘CYBER.OVERRIDE.%ESPSYY%ESPSDDD’JOB PAYJOB2

RUN WORKDAYSENDJOB

In the above example, ESP uses JCL for PAYJOB2 if it exists in the temporary JCLlibrary. The name of the temporary library consists of two symbolic variables:%ESPSYY is the 2-digit scheduled year; %ESPSDDD is the 3-digit Julian day.Each day ESP uses a different TEMPLIB.

For example, if the scheduled execution date of the Event that invokes thisApplication is January 1st, 1999, ESP uses the temporary JCL if it exists inCYBER.OVERRIDE.99001. Otherwise, it uses JCL from CYBER.JCL.CNTL.

Page 696: ESP 5.2 Command Reference

696

TEST Command

Overview The TEST command is used to test schedule criteria, prior to actually using them.This tests any date or schedule specification. ESP responds with the actual date andtime. If you specify a number in parentheses after the TEST commands, ESPdisplays as many subsequent dates and times as you indicated.

Type General command.

Syntax The syntax of the TEST command is:

TEST [(n)] criteria

Parameter Descriptionn Indicates how many times the schedule criteria are to be

cycled. The default is 1.criteria Indicates criteria.

Usage notes You can also test schedule criteria using ESP’s ISPF interface - Option E.4 from theESP Main Menu.

Relatedinformation

For information on testing schedule criteria, see the ESP Workload Manager User’sGuide.

Example 1 The following TEST command tests schedule criteria:

TEST (5) LAST WORKDAY OF MONTH

In the above example, the last workday in each of the next 5 months are displayed,as follows:

00.00.00 FRIDAY FEBRUARY 27TH, 1998, DAY 05800.00.00 TUESDAY MARCH 31ST, 1998, DAY 09000.00.00 THURSDAY APRIL 30TH, 1998, DAY 12000.00.00 FRIDAY MAY 29TH, 1998, DAY 14900.00.00 TUESDAY JUNE 30TH, 1998, DAY 181

Continued on next page

Page 697: ESP 5.2 Command Reference

697

TEST Command, Continued

Other examples Here are more examples using the TEST command.

Tests the next 10 workdays :

TEST (10) WORKDAYS

Tests the last workday of the year:

TEST LAST WORKDAY OF YEAR

Tests the first workday of each month starting in November, for the next year:

TEST (12) 6PM FIRST WORKDAY OF MONTH STARTING NOVEMBER

Tests the next 5 holidays:

TEST (5) HOLIDAY

Tests the 3rd Saturday in May:

TEST 3RD SATURDAY OF MAY

Page 698: ESP 5.2 Command Reference

698

THEN Statement

Overview The THEN statement is used in conjunction with an IF statement when theexpression that follows the IF statement returns a true value.

Type ESP Control Language (CLANG) statement.

Syntax The syntax of the THEN statement is:

THEN action-statement

Parameter DescriptionTHEN Can only be used when the IF statement is already specified.

Defines the action to be taken when evaluation of an IFstatement returns a true value. To specify multiple actions, usethe DO and ENDDO statements.

action-statement Indicates the action to be taken.

Usage notes When you use an IF statement, the expression that follows it must return a true orfalse value.

The THEN statement is used in conjunction with an IF statement when theexpression that follows the IF statement returns a true value. When a true value isreturned by the IF statement, ESP processes the statements following the THENstatement.

If multiple statements are required to be processed, you must begin and endcompound action statements with DO and ENDDO language elements.

Usage notescontinued

If a THEN statement continues to another line, use a line continuation character (‘–’or ‘+’). If there is no continuation character, ESP ignores the THEN statement.

The ELSE statement is used in conjunction with an IF statement when theexpression that follows the IF statement returns a false value.

RelatedStatements

For information on using ESP’s Control Language, see the ESP Workload ManagerUser’s Guide.

For information on conditional processing, see the IF, ELSE and DO statements.

Continued on next page

Page 699: ESP 5.2 Command Reference

699

THEN Statement, Continued

Example 1 The following logic is used to process different statements:

IF %ESPADAY = ‘MONDAY’ THEN -SEND ‘TODAY IS MONDAY’ U(CYB01)

ELSE -SEND ‘TODAY IS %ESPADAY’ U(CYB01)

In the above example, ESP determines if the actual day is equal to Monday. If theevaluation of this expression is true, ESP sends a message indicating that today isMonday to ‘CYB01’. If the evaluation of this expression is false, ESP sends amessage to CYB01 indicating what today is.

Example 2 The following logic is used to determine when a job runs:

JOB PAYJOB1IF TODAY(‘15TH DAY OF MONTH’) AND TODAY(‘TUESDAY’) THEN -

RUN TODAYENDJOB

In the above example, ESP determines if today is the 15th day of the month andTUESDAY, and if so PAYJOB1 is selected to run.

Example 3 The following logic is used to set the value of a user defined symbolic variable:

IF ESPSMM<5 THEN DOGENTIME LAST TODAY LESS 1 YEARFINANCIAL_YEAR=’%LASTYY%ESPSYY’

ENDDOELSE DO

GENTIME NEXT TODAY PLUS 1 YEARFINANCIAL_YEAR=’%ESPSYY%NEXTYY’

ENDDO

In the above example, a user-defined symbolic variable called‘FINANCIAL_YEAR’, which consists of two, 2–digit year numbers, is set asfollows:

• If the current month is January, February, March or April, use last year followedby this year

• For any other month, use current year followed by next year.

Page 700: ESP 5.2 Command Reference

700

TIME Command

Overview The TIME command is used to set the start time of a model sub-period. This allowsyou to change environmental factors in the modeling period at specified times.

Type Model command.

Syntax The syntax of the TIME command is:

TIME criteria

Parameter Descriptioncriteria Indicates any valid schedule criteria that denote the start of

the sub-period. If the statement contains separators then itmust be enclosed in quotes. The time is relative to the periodspecified on the MODEL command.

Usage notes A TIME command remains in effect until another TIME command is issued or untilthe end of the modeling period is reached. Any number of TIME commands can beissued for a modeling period. If not specified, the default is the start time specifiedon the MODEL command.

Relatedinformation

For information on beginning and ending the model process, see the MODEL andENDMODEL commands.

For information on modeling, see the ESP Workload Manager Advanced User’sGuide.

Example 1 The following TIME command is used in conjunction with the INIT command to setthe start time of a model sub-period:

TIME 02:00INIT SET(15) CLASS(X)

In the above example, an initiator class is set at 2 am.

Page 701: ESP 5.2 Command Reference

701

TITLE Command

Overview The TITLE command is used to define a title to be displayed at the top of the nextand subsequent pages of printed data. It also skips to the top of the next page.

Type General command.

Syntax The syntax of the TITLE command is:

TITLE n[SET][DELETE][‘title string’}

Parameter Descriptionn Indicates which title line you are defining; the range is 1-7.

The default is 1.SET Indicates the title for subsequent pages is to be set. An

immediate page eject does not occur.DELETE Indicates the specified title line is to be deleted.title string Indicates the title to be displayed. It should be enclosed

within quotes. If you want to use quotes in the title line itself,double them up.

Usage notes Up to seven title and footing lines can be active at any time. If you specify Title 1and Title 3, a blank line is placed between the two title lines you specify. If neitherSET nor DELETE is specified, an immediate page eject occurs.

The following are built-in variables which you can use in a title string:

Parameter Description %CE Centers the Parameter within the output line. %DATE Full date, e.g. SUNDAY 4th JANUARY 1998. %DAY Day of week name, e.g. MONDAY. %DD Day of month number, i.e. from 01 to 31. %DDDD Julian day or day of year number. E.g. 365 for last day. %DOW# Day of week number, e.g. ‘1’ for Sunday, ‘7’ for Saturday,

regardless of calendar settings. %EVAL Returns the numeric value of an expression. An output-

format descriptor may follow the parameter to request leadingblanks or zeros.

%HH Hour, in 24-hour format, e.g. ‘14’. %LENGTH Returns the length of the Parameter. %MM Month number, e.g. ‘01’ if the month is January. %MMM first three characters of the month, e.g. ‘JAN’. %MM Minute of the hour.

Continued on next page

Page 702: ESP 5.2 Command Reference

702

TITLE Command, Continued

Usage notes (continued)

Parameter Description %MONTH Month name, e.g. JANUARY. %PAGE The current page number. %RJ Justifies the parameter on the right side of the output line. %SSS Seconds. %TIME Time, in 24-hour format, e.g. ‘14.30.00’. %YEAR Year, e.g. 1999. %YY Last two characters of year, e.g. ‘99’.

Relatedinformation

For information on reporting, see the ESP Workload Manager User’s Guide.

Example 1 The following TITLE command is used in a history report:

REPORTTITLE '%CE(PAYROLL APPLICATION REPORT FOR %DATE)'FROM 7AM TODAY LESS 2 DAYSCRITERIA APPLSYS EQ PAYROLLDISPLAY APPLSYS,JOBNAME,JOBNO,RDRONDATEENDR

In the above example, a title is associated with this history report.

Example 2 The following TITLE command is used in a modeling report:

DEFPRINT REPORT1 DATASET(‘ESP.MODEL.REPORT1’)TITLE 1 ‘%CE(CYBERMATION INC.)’TITLE 2 ‘%CE(DATA CENTER OPERATIONS)’

In the above example, two titles are associated with this model report.

Example 3 The following TITLE command is used in a batch job:

//ESPCOMND JOB …//STEP001 EXEC PGM=ESP,PARM='SUBSYS(E510)',REGION=4M//STEPLIB DD DSN=CYB2.ESP510Q.SSCPLINK,DISP=SHR//SYSPRINT DD SYSOUT=*//SYSIN DD *TITLE '%CE(ESP DATASETS)'LDSN/*

In the above example, a title is associated with the output produced by an ESPcommand.

Continued on next page

Page 703: ESP 5.2 Command Reference

703

TITLE Command, Continued

Other examples Here are more examples of using the TITLE command.

Deletes title 3 from this point on:

TITLE 3 DELETE

Defines a title without generating a page break:

TITLE 4 SET ‘QUARTERY RESULTS’

Page 704: ESP 5.2 Command Reference

704

TRACE Command

Overview The TRACE command is used to activate the trace facility and allows trace optionsto be set.

Type General command

Authority OPER authority is required to issue the TRACE command

Syntax The syntax of the TRACE parameter is:

TRACE [SET(id[:id])][RESET(id[:id])][SWITCH|CLOSE|OPEN|STATUS|WRITE][REUSE]

Parameter DescriptionSET(id) Indicates one or more record identifiers you want to trace.

You can specify a list of identifiers and a range of identifiers.RESET(id) Indicates one or more record identifiers you no longer want to

trace.SWITCH Requests the data set currently in use for the trace facility be

freed. The next trace data set is activated automatically.With this option, data sets are activated in the sequence inwhich they were first defined. Once the last data set in thesequence is closed, the first trace data set to be defined isused.

CLOSE Requests the closure of the trace data set currently in use, butprevents switching to the next trace data set. The buffersdefined using TRACEDEF automatically continue to holdtrace data in core until a TRACE OPEN command is issued.

OPEN Requests opening of the trace data set most recently active.This is used after TRACE CLOSE is issued to reactivate thesame trace data set.

REUSE Indicates the data set currently in use for the trace facility becheckpointed so that subsequent writes to it begin at thecheckpoint rather than at the start of the data set.

WRITE Writes to the trace data set to clear any buffered data.STATUS Displays information indicating where the trace facility is

active. Display includes how many records were writtensince trace was activated, the current trace data sets in use,and which data set is currently active.

Continued on next page

Page 705: ESP 5.2 Command Reference

705

TRACE Command, Continued

Usage notes TRACE is useful as a problem-solving tool. On occasion Cybermation TechnicalSupport personnel may ask you to SET a specific trace record ID to provideinformation to help with trouble shooting.

If you wish to capture only records relating to Event processing (i.e. type 601), usethe ESPPARM AUDITLOG ddname in the ESP started task procedure or theAUDITLOG Initialization Parameter. This allows the use of a pre-allocatedSYSOUT for Event activity and eliminates the need to use the TRACEDEF andTRACE commands.

Relatedinformation

For information on trace commands and a list of trace records, see the ESPDiagnostic and Recovery Guide.

For information on displaying Event log data collected in the trace data set, see theLOGPRT command.

For information on printing trace data, see the TRACEPRT command.

Example 1 The following TRACE command activates the trace facility:

OPER TRACE SET(602:604,607)

In the above example, a trace is activated and specifies that record IDs 602 through604, and 607 should be traced.

Example 2 The following TRACE command checkpoints the data set currently used for thetrace facility:

OPER TRACE SWITCH REUSE

In the above example, the current data set used for the trace facility is checkpointedbefore switching to the next trace data set. When the current trace data set is laterreused, records are written starting at the checkpoint.

Example 3 The following TRACE command turns off the trace facility for specific records:

OPER TRACE RESET(602:604)

In the above example, the trace is turned off for record Ids 602 through 604.

Continued on next page

Page 706: ESP 5.2 Command Reference

706

TRACE Command, Continued

Example 4 The following TRACE commands write out buffered data and close the trace dataset:

OPER TRACE WRITEOPER TRACE CLOSE

In the above example, prior to printing the trace data set, the buffered data is writtenout and the trace data set is closed.

Page 707: ESP 5.2 Command Reference

707

TRACEDEF Command

Overview The TRACEDEF command is used to identify the data sets to be used to recordinformation collected by the TRACE facility.

Type General command.

Authority OPER authority is required to issue the TRACEDEF command.

Syntax The syntax of the TRACEDEF parameter is:

TRACEDEF DSN(dsname[,dsname]...)[BUF(size,count)]

Parameter Descriptiondsname Indicates the name of one or more data sets to be used as trace

data sets. Separate data set names with a blank or comma.Specifying multiple trace data sets allows you to use theSWITCH parameter with TRACE to free up one trace data setand switch to another.

size, count Indicates the buffers you want to use for the trace data setsyou define. Size specifies the buffer size and count identifieshow many buffers are required. This defaults to (4096,4)-(four buffers, each one 4096 bytes).

Usage notes Before using the TRACE facility, you must allocate one or more trace data sets.You must identify these data sets to ESP with the TRACEDEF command.

You do not have to specify any DCB attributes when you initially allocate the datasets, because ESP does this automatically.

Trace data sets use: DCB=(RECFM=VB,LRECL=4096,BLKSIZE=4100).

The buffers you define continue to hold trace data until each one becomes full. Atthis point, the data is written automatically to the trace data set and another buffer isused.

Relatedinformation

For information on defining a trace data set at the initialization parameter level, seethe ESP Workload Manager Installation Guide.

For information on activating the trace facility, see the TRACE command.

For information on trace commands, see the ESP Diagnostic and Recovery Guide.

Continued on next page

Page 708: ESP 5.2 Command Reference

708

TRACEDEF Command, Continued

Example 1 The following TRACEDEF command defines 2 trace data sets:

TRACEDEF DSN(‘ESPCYB.TRACE1’, ‘ESPCYB.TRACE2’) BUF(23400,3)

In the above example, two trace data sets that each have three 23400 byte buffers aredefined.

Page 709: ESP 5.2 Command Reference

709

TRACEPRT Command

Overview The TRACEPRT command is used to print trace data.

Type General command.

Authority OPER authority is required to issue the TRACEPRT command

Syntax The syntax of the TRACEPRT command is:

TRACEPRT DSN(dsn[,dsn])[FROM(criteria)][SELECT(id[:id])][APPL(appl[,appl...])][JOB(job[,job...])]

Parameter Descriptiondsn Indicates the name of one or more trace data sets.criteria Indicates any valid schedule criteria that represent a time

range.id Indicates a trace ID to print. Ranges are supported.appl Allows selection by Application name. Wildcards are

supported.job Allows selection by jobname. Wildcards are supported.

Usage notes Issue the TRACEPRT command in batch or from Page mode, after collecting tracedata from a TRACE command.

Note:For Cybermation diagnostic purposes, the contents of the raw trace data set arerequired.

Relatedinformation

For information on using the TRACE command, see the TRACE command.

For information on trace commands, see the ESP Diagnostic and Recovery Guide.

Example 1 The following TRACEPRT command prints a trace data set:

TRACEPRT DSN(‘CYBER.TRACE1’) FROM(‘6AM YESTERDAY UNTIL 6AMTODAY’)

In the above example, CYBER.TRACE1 is printed from 6 am yesterday to 6 amtoday.

Continued on next page

Page 710: ESP 5.2 Command Reference

710

TRACEPRT Command, Continued

Example 2 The following TRACEPRT command prints trace data based on an Applicationname:

TRACEPRT DSN(‘CYBER.TRACE1’) APPL(PAYROLL)

In the above example, trace data set information for the PAYROLL Application isprinted.

Example 3 The following TRACEPRT command prints a range of trace IDs:

TRACEPRT DSN(‘CYBER.TRACE1’) SELECT(601:603)

In the above example, trace IDs 601 to 603 are printed.

Page 711: ESP 5.2 Command Reference

711

TRACKDEF Command

Overview The TRACKDEF statement is used to specify tracking definitions in a Job TrackingDefinition Table.

Type Job Tracking Definition Table Statement.

Syntax The syntax of the TRACKDEF statement is:

TRACKDEF [NAME(string)][JOB][STC][TSU][RACID(string)][PGMR(string)][CLASS(classid)][ACCOUNT1(string)][ACCOUNT2(string)][ACCOUNT3(string)][ACCOUNT4(string)][NOTRACK][MODEL(modelname)]

Parameter DescriptionNAME(string) Indicates a one to eight character jobname to be matched on.

Asterisks or a hyphen are used to perform masking. NAMEcan also be specified as JOBNAME.

JOB/STC/TSU Indicate jobs, started tasks or TSO users be tracked. If thesekeywords are not used, the TRACKDEF entry is not specificand all will apply.

RACID(string) Indicates the security system user ID associated with the job.CLASS(classid) Indicates the job’s execution class. This can be up to eight

characters in a JES3 environment.ACCOUNT1 Indicates the job’s first account number. Only the first eight

characters are checked.ACCOUNT2 Indicates the job’s second account number.ACCOUNT3 Indicates the job’s third account number.ACCOUNT4 Indicates the job’s fourth account number.PGMR(string) Indicates the programmer name field associated with the job.

All 20 character positions can be checked.NOTRACK Indicates a job matching the TRACKDEF entry not be

tracked.MODEL Indicates the name of the tracking model to be associated with

a job, started task or TSO user. If neither NOTRACK orMODEL is specified, NOTRACK is assumed. The MODELkeyword must be used if a job is to be tracked. You canoverride this using the MODEL statement for a job in anApplication.

Continued on next page

Page 712: ESP 5.2 Command Reference

712

TRACKDEF Command, Continued

Usage notes A job tracking definition table identifies the characteristics of the jobs you want ESPto track. ESP can track jobs based on jobname, execution class, programmer name,account number, job type, or the user ID associated with the job.

Job tracking definition tables allow the following:

• You can define your own wildcard characters in the table. These characters giveyou great flexibility in defining the property of the job you want ESP to use as thejob tracking parameter.

• You are not restricted to a job name or prefix when defining the trackingparameter. Instead, you can choose from a larger set of properties of the job whendefining the parameter. For example, you can choose the job’s execution class, orthe name of the programmer.

A job tracking definition table consists of a set of ESP WILDCARD andTRACKDEF statements, respectively, in a sequential data set or in a member of aPDS. The use of WILDCARD is optional.

The order of the TRACKDEF statements is important. When tracking data isreceived for a job, ESP scans the TRACKDEF entries in sequence until a match isfound. ESP then takes the action specified by that entry. The entry can identifywhether the job is to be tracked or not. If the job is to be tracked, the defaulttracking model for the job is specified. If no matching entry is found, the job is nottracked.

To track STCs or TSUs, you must identify these are to be tracked using theTRACKOPT command or ESP Initialization Parameter. You can use TRACKDEFstatements to identify which STCs or TSUs to track.

You can also test a job tracking definition table using ESP’s ISPF interface - OptionM.4 from the ESP Main Menu.

Relatedinformation

For information on job tracking definition tables, see the ESP Workload ManagerAdministrator’s Guide.

For information on loading job tracking definition tables (JTDT), see theLOADJTDT command.

For information on defining wildcard characters used in a job tracking definitiontable, see the WILDCARD statement.

For information on defining a tracking model, see the DEFTM command.

For information on displaying the status of tracked jobs, see the LJ command.

For information on specifying tracking options, see the TRACKOPT command.

Continued on next page

Page 713: ESP 5.2 Command Reference

713

TRACKDEF Command, Continued

Example 1 The following TRACKDEF command specifies a tracking definition:

TRACKDEF NAME(-) MODEL(MODEL1)

In the above example, all jobs are tracked using tracking model MODEL1.

Example 2 The following is an example of a job tracking definition table:

TRACKDEF JOB NAME(J–) MODEL(PRODJOBS)TRACKDEF JOB NAME(U–) MODEL(TESTJOBS)

In the above example:

• The first tracking definition statement indicates ESP uses tracking modelPRODJOBS to track all jobs that start with the letter J.

• The second statement indicates ESP uses tracking model TESTJOBS to track alljobs that start with the letter U.

Continued on next page

Page 714: ESP 5.2 Command Reference

714

TRACKDEF Command, Continued

Example 3 The following is an example of a job tracking definition table:

WILDCARD # 0–9 /* NUMERICS */WILDCARD $ A–Z /* ALPHABETICS */WILDCARD + 0–9A–Z /* ALPHANUMERIC */TRACKDEF JOB NAME(DUMMYJOB) NOTRACKTRACKDEF JOB NAME(CYBJOB–) MODEL(CYBMODEL)TRACKDEF JOB NAME($$$$####) MODEL(PRODJOBS)TRACKDEF ACCOUNT1(CYB3000) MODEL(TESTJOBS)TRACKDEF RACID(CYBFM–) MODEL(DEMOMDL)TRACKDEF JOB CLASS(G) MODEL(MODELG)TRACKDEF JOB NAME(–) MODEL(MODEL1)TRACKDEF STC NAME(–) MODEL(MODEL1)

In the above example:

• The first wildcard character ‘#’ matches all numeric characters• The ‘$’ wildcard character matches the alphabetic characters, A through Z,

inclusive• The ‘+’ wildcard character matches the alphanumeric characters, A through Z,

inclusive, and the digits 0 through 9, inclusive• The 1st tracking definition statement indicates ESP does not track a job called

DUMMYJOB• The 2nd tracking definition statement indicates ESP uses model ‘CYBMODEL’ to

track jobs where names begin with ‘CYBJOB’• The 3rd tracking definition statement indicates ESP uses tracking model

‘PRODJOBS’ to track jobs whose names consist of four alphabetic charactersfollowed by four numeric characters

• The 4th tracking definition statement indicates ESP uses tracking model‘TESTJOBS’ to track jobs where the first account number is CYB3000

• The 5th tracking definition statement indicates ESP uses tracking model‘DEMOMDL’ to track jobs with a RACID that begins with ‘CYBFM’

• The 6th tracking definition statement indicates ESP uses tracking model‘MODELG’ to track class G jobs

• The 7th and 8th tracking statements indicate ESP will track all other jobs andstarted tasks using model ‘MODEL1’.

Continued on next page

Page 715: ESP 5.2 Command Reference

715

TRACKDEF Command, Continued

Other examples Here are more examples using the TRACKDEF statement.

Class T jobs regardless of jobname are not tracked:

TRACKDEF NAME(-) CLASS(T)

Track all class P jobs using the tracking model PROD:

TRACKDEF CLASS(P) MODEL(PROD)

Track all started tasks starting with the prefix CICS using the model JOBMON:

TRACKDEF STC NAME(CICS-) MODEL(JOBMON)

Track all jobs submitted by ESP:

TRACKDEF MODEL(DEFAULT)

Track all jobs regardless of jobname. The default tracking model to be used isobtained by concatenating the first two characters of the jobname with the characters‘MODEL’. The job DX12345 uses the model DXMODEL:

TRACKDEF JOB NAME(-) MODEL(NAME(1:2),MODEL)

Do not track jobs with a programmer name field starting with CYBED:

TRACKDEF PGMR(CYBED-) NOTRACK

Track jobs starting with X using the model XSYS:

TRACKDEF JOB NAME(X-) MODEL(XSYS)

Page 716: ESP 5.2 Command Reference

716

TRACKING Command

Overview The TRACKING command is used to enable or disable the ESP tracking facility.

Type General command.

Authority OPER authority is required to issue the TRACKING command.

Syntax The syntax of the TRACKING command is:

TRACKING [COLLECT|NOCOLLECT][STORE|NOSTORE][LOG|NOLOG]

Parameter DescriptionCOLLECT Indicates SMF recording is activated. SMF tracking data is

stored in the TRAKFILE and the History data set(s) isupdated (unless NOSTORE is specified).

NOCOLLECT Indicates SMF recording is deactivated. No SMF data iscollected, no tracking data is written to the TRAKFILE andthe History data set(s) is NOT updated.

STORE Indicates tracking data from SMF be stored in theTRAKFILE and the History data set(s) be updated.

NOSTORE Indicates the tracking processor be quiesced. No trackingdata is written to the TRAKFILE and the History data set isnot updated. The data is temporarily buffered to thecheckpoint data set until STORE is requested.

LOG Reserved for future use.NOLOG Reserved for future use.

Continued on next page

Page 717: ESP 5.2 Command Reference

717

TRACKING Command, Continued

Usage notes If no options are specified, the current tracking settings are displayed (the NOLOGfield of the display is reserved for future use). If an option is specified, it is added tothe current tracking settings.

The COLLECT and STORE options should be active if you wish to perform normaltracking functions.

The COLLECT and NOCOLLECT keywords control the collection of SMF datathat is used by the tracking processor to update the TRAKFILE and the History dataset(s). When NOCOLLECT is specified, SMF data is not captured and the trackingis lost.

The NOSTORE keyword can be used to quiesce the tracking processor temporarily.All tracking functions including Job Monitoring are suspended when NOSTORE isspecified. This is useful when you need to perform maintenance on an ESP HistoryFile. Tracking data is buffered to the checkpoint data set until STORE is requested.When STORE is specified to bring the tracking processor out of quiesced state, anydata that was buffered is written to the TRAKFILE and the History data set(s) isupdated.

Note: The tracking processor should not be left in the NOSTORE mode for longperiods of time as the checkpoint data set could fill up causing tracking data to belost.

Relatedinformation

For information on tracking, see the ESP Workload Manager Administrator’s Guide.

Example 1 The following TRACKING command displays tracking settings:

OPER TRACKING

In the above example, current tracking settings are displayed.

Example 2 The following TRACKING command sets tracking options:

OPER TRACKING COLLECT STORE

In the above example, SMF recording is activated. SMF tracking data is collectedand stored in the TRAKFILE and the History data set is updated.

Example 3 The following TRACKING command quiesces the tracking processor:

OPER TRACKING NOSTORE

In the above example, the tracking processor is quiesced.

Page 718: ESP 5.2 Command Reference

718

TRACKOPT Command

Overview The TRACKOPT command is used to set various tracking options.

Type General command.

Authority OPER authority is required to issue the TRACKOPT command.

Syntax The syntax of the TRACKOPT command is:

TRACKOPT [STC|NOSTC][TSU|NOTSU][SYSMSGS|NOSYSMSGS][MASTER|SLAVE][JAT|NOJAT][TRACK_PURGE|NOTRACK_PURGE][POST_OLDEST|NOPOST_OLDEST]

Parameter DescriptionSTC Indicates started tasks should be tracked.NOSTC Indicates tracking of started tasks should not occur.TSU Indicates TSO users should be tracked.NOTSU Indicates tracking of TSO users should not occur.SYSMSGS Indicates system messages should be intercepted.NOSYSMSGS Indicates interception of system messages should not occur.MASTER Indicates this as the MASTER system for Application

processing.SLAVE Indicates this as a SLAVE system.JAT Indicates a Job Authorization Table is to be used. This only

applies if you are using ESP’s internal security.NOJAT Indicates Job Authorization Tables are not used. This only

applies if you are using ESP’s internal security.

Continued on next page

Page 719: ESP 5.2 Command Reference

719

TRACKOPT Command, Continued

Syntax (continued)

Parameter DescriptionTRACK_PURGE Indicates jobs are tracked through the OUTPUT P-Node.NOTRACK_PURGE Indicates jobs are not tracked through the OUTPUT P-

Node.POST_OLDEST Indicates External and Manual jobs are posted complete

in the oldest active generation of an Application.NOPOST_OLDEST Indicates External and Manual jobs are posted complete

in all generations of an Application. This is the default.

Usage notes If no options are specified, the current tracking options are displayed (the NOLOGfield of the display is reserved for future use). If an option is specified, it is added tothe current tracking options.

TRACKOPT should be specified on each system in a multi-access spoolenvironment. It is normally specified as an ESP Initialization Parameter.

The MASTER and SLAVE keywords apply only to Application processing. Onesystem should be identified as the MASTER system and any other systems shouldbe identified as the SLAVE systems. All Events that create Applications should bescheduled on the MASTER system.

TRACKOPT is normally specified as an Initialization Parameter. If you use theTRACKOPT command, options specified in the Initialization Parameters areoverridden. The information is saved in the checkpoint data set, which means that itis retained across IPLs. However, for a cold start, any information specified in theInitialization Parameters is used.

When an EXTERNAL or MANUAL job completes and multiple generations of anApplication exist, ESP must decide which generation of the Application to post thejob complete in. Use the POST_OLDEST or NOPOST_OLDEST keywords tocontrol this.

Most installations do not need to track jobs through to purge. If this is the case,TRACKOPT NOTRACK_PURGE should be specified. This allows data to bestored on ESP’s TRAKFILE for a longer period of time.

Relatedinformation

For information on setting tracking options at the Initialization Parameter level, seethe ESP Workload Manager Installation Guide.

For information on setting up tracking, see the ESP Workload ManagerAdministrator’s Guide.

Continued on next page

Page 720: ESP 5.2 Command Reference

720

TRACKOPT Command, Continued

Example 1 The following TRACKOPT command displays tracking options:

OPER TRACKOPT

In the above example, current tracking options are displayed.

Example 2 The following TRACKOPT command sets tracking options:

OPER TRACKOPT STC SYSMSGS

In the above example, started tasks and system messages are tracked

Example 3 The following TRACKOPT command sets tracking options:

OPER TRACKOPT NOSTC

In the above example, the tracking of started tasks is turned off.

Page 721: ESP 5.2 Command Reference

721

TRDFLT Command

Overview The TRDFLT command specifies an installation-default to be used when an Event istriggered manually.

Type General command.

Authority OPER authority is required to issue the TRDFLT command.

Syntax The syntax of the TRDFLT command is:

TRDFLT {ADD}{REPLACE}

Parameter DescriptionADD Indicates a manual trigger of an Event should be performed in

addition to the next scheduled execution.REPLACE Indicates a manual trigger replaces the next scheduled

execution for an Event. This is the normal default.

Usage notes The option you specify on the TRDFLT command applies until the next time ESPinitializes. This command is normally specified as an ESP Initialization Parameter.

You can override the TRDFLT setting when you use the TRIGGER command for anEvent.

Relatedinformation

For information on Events, see the ESP Workload Manager User’s Guide.

For information of triggering Events, see the TRIGGER command.

Example 1 The following TRDFLT command specifies a default for manually triggered Events.

TRDFLT ADD

In the above example, the installation default for manually triggered Events is set toADD, i.e. Events are triggered in addition to their regularly scheduled executionunless the REPLACE option is specified on the TRIGGER command.

Page 722: ESP 5.2 Command Reference

722

TRIGGER Command

Overview The TRIGGER command is used to trigger the execution of an Event. The Eventexecution either replaces the next scheduled execution (that is brings forward thenext execution), or it can be a temporary addition to the schedule.

Type General command.

Authority TRIGGER can be issued either as an ESP operator (OPER) command or as an ESPgeneral sub-command.

When issued as an ESP OPER command, access is enabled to all Events, but theissuer must have authorization for OPER commands (or to the TRIGGER commandexplicitly if SAFOPTS OPERCMDS is in effect).

When issued as an ESP general sub-command, access is restricted to Events forwhose prefix the issuer is authorized. Authorization is required for the ESP.GROUPEvent prefix RACF resource (UPDATE authority) or for the ESP.GROUP Eventprefix RACF resource (READ authority).

Syntax The syntax of the TRIGGER command is:

{TRIGGER|TR} eventid[REPLACE|ADD][AT(trigtime)][NOXEQ][SYSTEM(sysid)][FORCE|SATISFY][USER1(‘userinfo’)][USER2(‘userinfo’)][USER3(‘userinfo’)][USER4(‘userinfo’)][HOLD][ROOT(jobname...)]

Continued on next page

Page 723: ESP 5.2 Command Reference

723

TRIGGER Command, Continued

Parameter Descriptioneventid Indicates the name of the Event to be triggered. If prefix is

not specified, your current group prefix is used.REPLACE Indicates this execution is to replace only the next scheduled

execution of the Event. The TRDFLT InitializationParameter sets the default.

ADD Indicates this execution is to be made in addition to thenormal schedule. The normal schedule is not changed. TheTRDFLT Initialization Parameter sets the default.

trigtime Indicates a time, and optionally a date, at which the trigger isto occur. If you use blanks or commas, enclose the string inquotes. If this parameter is omitted, the current time is used.If this parameter specifies a time/date in the past, the Event istriggered now.

NOXEQ Bypasses the next scheduled execution.sysid Indicates the ID of the system on which you want the Event to

execute.FORCE Trigger Event ignoring any signals.SATISFY Trigger Event satisfying any signals.userinfo Indicates up to 80 characters of user data enclosed in single

quotes.HOLD Can be used to place an Application on hold when the Event

being triggered generates an Application. No activity willtake place in the Application until it is released using theAPPLJOB command or CSF.

ROOT Indicates one or more jobnames belonging to the Applicationgenerated by this Event. This requests that only those jobsspecified are to be submitted. Each jobname specificationcan be an individual jobname or can include a plus sign (+) toindicate that this job and all successors are to be selected.ESP builds the named jobs as part of the Applicationregardless of their frequency. Any successors of the namedjobs will only be included if their other selection criteria (interms of date and time) are satisfied.

Usage notes When using the ADD option, the Event is scheduled for execution as if aSCHEDULE statement is being processed. The REPLACE option brings forwardthe next scheduled activity for that Event. If the next statement in the Event is aHOLD statement, it is processed by the TRIGGER, rather than by an execution ofthe Event. Before issuing a TRIGGER REPLACE, you should be aware of the nextaction to be processed for that Event. A TRIGGER ADD always causes theexecution of an Event.

Continued on next page

Page 724: ESP 5.2 Command Reference

724

TRIGGER Command, Continued

Usage notescontinued

Use the AT keyword to specify a future time and date for the trigger to occur. If theREPLACE option is used, the trigger replaces the next scheduled execution on orafter the specified time. The ADD option results in an additional execution.

The NOXEQ keyword is used to suppress an already scheduled Event execution. Ifthe AT keyword is not used, the next scheduled execution is suppressed. If a time isspecified through an AT keyword, a schedule entry for the specified time is searchedfor, and if found, it is marked for deletion. The NOXEQ option is used to suppressthe execution of an Event already on the schedule, which usually spans no more than24 hours. Use the LISTSCH command to display the schedule if you are unsure.

Usage notescontinued

If you wish to re-trigger an Event that has already executed, you can use a triggertime in the past. Variables are resolved and jobs selected based on this past date.

Triggering an Event for a time in the past does not honor DELAYSUB orEARLYSUB statements coded in an Application, unless REALNOW is used in theschedule criteria, i.e. DELAYSUB REALNOW PLUS 10 MINUTES.

The USER1-USER4 fields can be used to pass user data to the Event (andconsequently any ESPPROC the Event invokes) being triggered. This user datareplaces the %USER1-%USER4 variables, respectively, when they are encountered.

Use the ROOT parameter if you wish to build an Application of certain jobs. This isuseful if you wish only to run, or rerun, part of an Application.

If you trigger an Event manually, the SYSTEM identifier in the Event is ignored.To trigger an Event on a particular system, use the SYSTEM parameter on theTRIGGER command.

You can also trigger Events using ESP’s ISPF interface - Option E.3 from the ESPMain Menu.

Relatedinformation

For information on Events, see the ESP Workload Manager User’s Guide.

Example 1 The following TRIGGER command triggers an Event:

TRIGGER CYBER.PAYROLL

In the above example, the TRIGGER command brings forward the next scheduledexecution of CYBER.PAYROLL for immediate execution assuming the TRDFLTInitialization Parameter is set to REPLACE.

Continued on next page

Page 725: ESP 5.2 Command Reference

725

TRIGGER Command, Continued

Example 2 The following TRIGGER command triggers an Event at a specific time:

TRIGGER CYBER.PAYROLL AT(‘3PM TODAY’)

In the above example, the TRIGGER command brings forward the next scheduledexecution of CYBER.PAYROLL and schedules it for 3 pm today.

Example 3 The following TRIGGER command triggers an additional execution of an Event at aspecific time:

TRIGGER CYBER.PAYROLL AT(‘9AM JULY 1ST’) ADD

In the above example, the TRIGGER command triggers an additional execution ofCYBER.PAYROLL and schedules it for 9 am on JULY 1ST.

Example 4 The following TRIGGER command suppresses an Event’s execution:

TRIGGER CYBER.PAYROLL NOXEQ AT(9PM)

In the above example, the TRIGGER command suppresses the execution ofCYBER.PAYROLL, which is scheduled for 9 pm that evening.

Example 5 The following TRIGGER command triggers an Event and passes user data:

TRIGGER CYBER.PAYROLL USER1(‘PAYJOB99’)

In the above example, the TRIGGER command brings forward the next scheduledexecution of CYBER.PAYROLL and passes user data, in this case a jobname ispassed to an ESP Procedure invoked by this Event.

Example 6 The following TRIGGER command triggers an Event at a specific time to build anApplication containing certain jobs:

TRIGGER CYBER.PAYROLL AT(‘4PM TODAY’) REPLACE -ROOT(PAYJOB1,PAYJOB6+)

In the above example, the TRIGGER command brings forward the next scheduledexecution of CYBER.PAYROLL and schedules it for 4 pm today. The Applicationinvoked by this Event is built with jobs PAYJOB1, PAYJOB6 and PAYJOB6’ssuccessors.

Continued on next page

Page 726: ESP 5.2 Command Reference

726

TRIGGER Command, Continued

Example 7 The following TRIGGER command triggers an Event for a time in the past:

TRIGGER CYBER.PAYROLL AT(‘YESTERDAY’) ADD -ROOT(PAYJOB1,PAYJOB3,PAYJOB5+)

In the above example, CYBER.PAYROLL is triggered as if it were yesterday. TheApplication invoked by this Event is built with jobs PAYJOB1, PAYJOB3,PAYJOB5 and PAYJOB5’s successors.

Note: Any date-specific symbolic variables resolve to yesterday’s date.

Example 8 The following TRIGGER command triggers an Event on a specific system:

TRIGGER CYBER.PAYROLL SYSTEM(ESPM)

In the above example, CYBER.PAYROLL executes on system ESPM.

Page 727: ESP 5.2 Command Reference

727

TRYJOIN Command

Overview The TRYJOIN command is used when an ESP subsystem could not join its XCFgroup when it was started. This occurs when, from within ESP, an ESP subsystem isstarted with a conflicting member name. For example, another active XCF memberwith the same name already exists.

Type General command.

Authority OPER authority is required to issue the TRYJOIN command.

Syntax The syntax of the TRYJOIN command is:

TRYJOIN MEMBER(member)

Parameter Descriptionmember Indicates the member name under which ESP joins the XCF

group. It can be up to 16 alphanumeric or national characters.It must not be specified as “MISSING”.

This overrides the MEMBER operand in the SYSPLEXstatement.

Message Upon successful initialization into the XCF group, the following message is issued:

MESSAGE: 4303IESP xxxx has joined XCF group yyyy as member zzzz

Page 728: ESP 5.2 Command Reference

728

UNALLOC Command

Overview The UNALLOC command is used to unallocate a data set from ESP.

Type General command

Authority OPER authority is required to issue the UNALLOC command.

Syntax The syntax of the UNALLOC command is:

UNALLOC dsname

Parameter Descriptiondsname Indicates the data set name to be unallocated.

Usage notes This command may be required when ESP won’t let go of a data set. Thissometimes happens when a user uses some REXX code and does not free the file.

Relatedinformation

For information on unallocating data sets preallocated with the PREALLOCcommand, see the PREALLOC command.

Example 1 The following UNALLOC command unallocates a data set from ESP:

OPER UNALLOC ‘SYS3.ESP.TESTPROC’

In the above example, SYS3.ESP.TESTPROC is unallocated from ESP.

Page 729: ESP 5.2 Command Reference

729

//* UNTIL Statement

Overview The //* UNTIL statement is used in combination with the TEMPLIB statement toindicate that temporary JCL for a job is to be used until a particular date. TheTEMPLIB statement is used in an ESP Procedure to indicate a temporary/overrideJCL library.

Type ESP control statement used in JCL.

Syntax The syntax of the //* UNTIL statement is:

//*UNTIL criteria

Parameter Descriptioncriteria Schedule criteria that resolve to a single date and time.

Usage notes The //* UNTIL statement is used in a JCL library that has been identified as atemporary JCL library using the TEMPLIB statement.

A single blank separates the ‘//*’ and the ‘UNTIL’.

The //* UNTIL statement is only available in JCL and must start in card column 1and must be the first statement in the JCL. ESP checks the “UNTIL” date todetermine whether the JCL should be used. If no time is specified, the start-of-daytime is used (default 00:00).

ESP compares the scheduled time and date of the Event to the criteria on the //*UNTIL statement to decide whether or not it uses the JCL in the TEMPLIB for ajob. If the //* UNTIL date and time has passed ESP uses the JCL from the lastdefined JCLLIB in the Application.

Relatedinformation

For information on further limiting the window in which temporary JCL is used, seethe //* FROM statement.

For information on specifying a temporary/override JCL library, see the TEMPLIBstatement.

Continued on next page

Page 730: ESP 5.2 Command Reference

730

//* UNTIL Statement, Continued

Example 1 The following //* UNTIL statement used in the JCL indicates a time and date untilwhich temporary JCL should be used:

//* UNTIL 9AM MAY 24,1998//PAYJOB1 JOB CYB,CLASS=A,MSGCLASS=0…

In the above example, temporary JCL for PAYJOB1 is used until 9 am on May 24,1998.

Example 2 The following //* UNTIL statement used in the JCL indicates a time and date untilwhich temporary JCL should be used:

//* UNTIL AUGUST 6, 1998//PAYJOB2 JOB CYB,CLASS=A,MSGCLASS=O…

In the above example, temporary JCL for PAYJOB2 is used until 00:00 (default) onAugust 6, 1998.

Example 3 The following //* FROM and //* UNTIL statements used in the JCL indicate a timeand date window when temporary JCL should be used:

//* FROM 9AM NOVEMBER 27, 1998//* UNTIL 4PM NOVEMBER 30, 1998//PAYJOB3 JOB CYB,CLASS=A,MSGCLASS=0…

In the above example, temporary JCL for PAYJOB3 is used from 9 am onNovember 27,1998 up to, but not including, 4 pm on November 30, 1998.

Page 731: ESP 5.2 Command Reference

731

USE Command

Overview The USE command is used to display statistics relating to Events, Applications andjobs. These statistics represent the activity for this ESP system only. No counts areshown for any ESP slave systems or any other remote ESP systems.

Type ESP Main Menu command.

Syntax The syntax of the USE command is:

USE

Usage notes Enter the USE command from the ESP main menu or the ESPCTR command fromPage mode to display ESP internal activity. Both commands produce the sameresults but the formatting of those results is different.

Use the USE command to displays statistics on Applications completed,Applications created, Events executed and jobs submitted. These activities aremeasured on the following intervals: this year, this month, this day, since last ESPstart.

These counters are reset with an ESP cold start or with the ESPCTR command.

Relatedinformation

For information on displaying ESP internal activities, see the ESPCTR command.

Example 1 The following is an example of the display produced by the USE command.This This This Since Last

Activity Year Month Day ESP Start------------------------------------------------------------------------------Applications completed 499 499 13 143Applications created 737 737 27 211Events executed 2220 2220 43 594Jobs submitted 1190 1190 13 365

In the above example, ESP internal activities are displayed.

Page 732: ESP 5.2 Command Reference

732

USER Command

Overview The USER command is used to identify you as a valid ESP user when invoking ESPin batch. This command is not necessary if you are using a security product.

Type General command.

Syntax The syntax of the USER command is:

USER userid/password

Parameter Descriptionuserid Indicates your user ID.password Indicates your current ESP password.

Usage notes When your user ID was defined, a password was assigned to it. The PASSWORDcommand is used to change your password.

Relatedinformation

For information on altering the ESP password associated with your user ID, see thePASSWORD command.

Example 1 The following USER command identifies a valid ESP user:

//JOB1 JOB …...//S1 EXEC PGM=ESP,REGION=4000K//SYSPRINT DD SYSOUT=*//SYSIN DD *USER USER01/APPLES

In the above example, USER01 is identified as a valid ESP user.

Page 733: ESP 5.2 Command Reference

733

USERMOD Command

Overview The USERMOD command is used to define the ESP user modifications to beimplemented.

Type General command

Authority OPER authority is required to issue the USERMOD command

Syntax The syntax of the USERMOD statement is:

USERMOD [SET(usermodid[:usermodid])][RESET(usermodid[:usermodid])][LIST]

Parameter Descriptionusermodid Indicates a number, list of numbers, or range of numbers from

1-255.SET Turn on the usermod.RESET Turn off the usermod.LIST List the active usermods.

Usage notes User modification status is preserved across a restart of ESP, but not an IPL.

You can specify both SET and RESET in the same USERMOD statement. In thiscase, SET is processed before RESET.

USERMODs are normally set in the ESP Initialization Parameters.

Relatedinformation

For information on activating the usermods available with ESP, see the ESPWorkload Manager Installation Guide.

Example 1 The following USERMOD command displays USERMODs:

OPER USERMOD

In the above example, active USERMODs are displayed.

Continued on next page

Page 734: ESP 5.2 Command Reference

734

USERMOD Command, Continued

Example 2 The following USERMOD command turns on a USERMOD:

OPER USERMOD SET(33)

In the above example, USERMOD 33 is activated.

Example 3 The following USERMOD command turns on two USERMODs:

OPER USERMOD SET(33,36)

In the above example, USERMODs 33 and 36 are activated.

Example 4 The following USERMOD turns on a range of USERMODs:

OPER USERMOD SET(33:36)

In the above example, USERMODs 33, 34, 35 and 36 are activated.

Example 5 The following USERMOD turns off a USERMOD:

OPER USERMOD RESET(33)

In the above example, USERMOD 33 is deactivated.

Example 6 The following USERMOD command activates user modifications:

OPER USERMOD SET(1,5:7,18,22:27)

In the above example, USERMODs 1, 5-7, 18 and 22-27 are activated.

Example 7 The following USERMOD command activates and deactivates user modifications:

OPER USERMOD SET(5:9) RESET(7)

In the above example, because SET is processed before RESET, the results of theabove example are as follows:

• USERMODs 5-9 are activated• USERMOD 7 is deactivated.

Page 735: ESP 5.2 Command Reference

735

VS Command

Overview The VS command is used to issue a command to the operating system.

Type Event definition command.

Authority OPER authority is required to issue the VS command. Some commands may havebeen restricted by your security system or by a user exit.

Syntax The syntax of the VS command is:

VS ‘command text’[UCMID(cc)]

Parameter Descriptioncommand text Indicates the text of the command, enclosed within quotes. If

the text contains embedded quotes, they should be doubledup.

cc Indicates the UCMID that receives output from the command.

Usage notes You can use VS to issue operation system command such as JES commands andMVS commands, including ESP operator commands.

Multiple VS commands are allowed in an Event. VS commands can be issued froman ESP Procedure.

Relatedinformation

For information on issuing operating system commands, see the ESP WorkloadManager User’s Guide.

Example 1 The following VS command issues a JES2 command:

EVENT ID(CYBER.INIT_START)SCHEDULE 6AM DAILYVS ‘$SI1-10’ENDDEF

In the above example, initiators 1 through 10 are started at 6 am daily.

Continued on next page

Page 736: ESP 5.2 Command Reference

736

VS Command, Continued

Example 2 The following VS command starts a started task:

EVENT ID(CYBER.START_IMS)SCHEDULE 6AM DAILYVS ‘S IMS10’ENDDEF

In the above example, IMS10 is started at 6 am daily.

Example 3 The following VS command triggers an Event :

JOB MORE.WORK LINK PROCESSRUN DAILYVS ‘F ESPM,TRIGGER CYBER.BACKUPS’

ENDDEF

In the above example, a VS command is placed within a job definition to triggerCYBER.BACKUPS.

Example 4 The following VS command shuts down a started task:

EVENT ID(CYBER.START_IMS)SCHEDULE 6AM DAILYVS ‘F CICS,CSMT SHU,Y’ UCMID(05)ENDDEF

In the above example, a command is issued as if it came from console 05.

Page 737: ESP 5.2 Command Reference

737

WILDCARD Statement

Overview The WILDCARD statement is used to define wildcard characters for use in definingtracked jobs.

Type Job Tracking Definition Table Statement.

Syntax The syntax of the WILDCARD statement is:

WILDCARD charstring

Parameter Descriptionchar Wildcard character.string Consists of a string containing all the valid characters that the

wildcard can match.

Usage notes The wildcard character can be any printable character, with the exception of thecomma, blank, left or right parentheses, semicolon or quote. A ‘-’ between twocharacters indicates a range of valid characters, starting with the character on the leftand extending through the EBCDIC sequence to the character on the right, inclusive.

Use of the WILDCARD statement is optional. It can be used when you have strictnaming standards for jobs.

Relatedinformation

For information on tracking definition entries in a job tracking definition table, seethe TRACKDEF statement.

For information on job tracking definition tables, see the ESP Workload ManagerAdministrator’s Guide.

For information on loading job tracking definition tables (JTDT), see theLOADJTDT command.

Continued on next page

Page 738: ESP 5.2 Command Reference

738

WILDCARD Statement, Continued

Example 1 The following is an example of a job tracking definition table:

WILDCARD # 0–9 /* NUMERICS */WILDCARD $ A–Z /* ALPHABETICS */WILDCARD + 0–9A–Z /* ALPHANUMERIC */TRACKDEF JOB NAME(DUMMYJOB) NOTRACKTRACKDEF JOB NAME(PAY–) MODEL(PAYMODEL)TRACKDEF JOB NAME($$$$####) MODEL(PRODJOBS)

In the above example:

• The first wildcard character ‘#’ matches all numeric characters• The ‘$’ wildcard character matches the alphabetic characters, A through Z,

inclusive• The ‘+’ wildcard character matches the alphanumeric characters, A through Z,

inclusive, and the digits 0 through 9, inclusive• The 1st tracking definition statement indicates ESP does not track a job called

DUMMYJOB.• The 2nd tracking definition statement indicates ESP uses model ‘PAYMODEL’ to

track jobs where names begin with ‘PAY’• The 3rd tracking definition statement indicates ESP uses tracking model

‘PRODJOBS’ to track jobs whose names consist of four alphabetic charactersfollowed by four numeric characters.

Page 739: ESP 5.2 Command Reference

739

XCF DELETE Command

Overview The XCF DELETE command is used to remove quiesced or failed XCF member(s)from the XCF group.

Type ESP XCF command.

Enteringcommands

All ESP XCF commands may be issued via:

• ESP page mode, option G from the ESP main menu• ESP line mode• MVS MODIFY command• ESP Workstation.

Syntax The syntax of the XCF DELETE command is:

XCF {DELETE|DEL} {MEMBER|M} member

Parameter Descriptionmember Indicates the name of the ESP subsystem you want to delete

from the XCF group.

Example –Displaying themember toDelete.

The following display shows XCF member D523 as quiesced.

XCF DISPLAY GROUP

Group=D520, Member=D521, TermOpt=QuiesceGroup Member System ASID Jobname SSID ESP StatusD520 D521 SYSA 0081 D521 D521 Master ActiveD520 D522 SYSA 007D D522 D522 Slave ActiveD520 D523 SYSA 006D D523 D521 Shadow Quiesced

Example –Issuing theDELETEcommand

The following example shows removing XCF member D523:

XCF DELETE MEMBER D523

ESP4234I XCF member D523 deleted, Group=D520

Continued on next page

Page 740: ESP 5.2 Command Reference

740

XCF DELETE Command, Continued

Example –Confirming themember isdeleted.

The following display shows the XCF group with the quiesced member removed.

XCF DISPLAY GROUP

Group=D520, Member=D521, TermOpt=QuiesceGroup Member System ASID Jobname SSID ESP StatusD520 D521 SYSA 0081 D521 D521 Master ActiveD520 D522 SYSA 007D D522 D522 Slave Active

Page 741: ESP 5.2 Command Reference

741

XCF DISPLAY Command

Overview The XCF DISPLAY command is used to view system attributes of your XCF group.

Type ESP XCF command.

Enteringcommands

All ESP XCF commands may be issued via:

• ESP page mode, option G from the ESP main menu• ESP line mode• MVS MODIFY command• ESP Workstation.

Syntax The syntax of the XCF DISPLAY command is:

XCF {DISPLAY|D} {ACTIVE|A}{GROUP|G}{SERVICE|S}{SYSTEM|SYS}{TRACE|TR}

Parameter DescriptionACTIVE Displays the active XCF Service listener(s) on the Master

ESP and the connection(s).GROUP Displays the status of your XCF group.SERVICE Displays the status of the XCF Services in the group.SYSTEM Displays all systems in the Sysplex.TRACE Displays the status of the Trace log.

Continued on next page

Page 742: ESP 5.2 Command Reference

742

XCF DISPLAY Command, Continued

Example –DISPLAYACTIVE

The following example shows the short form of the DISPLAY ACTIVE commandwhen entered from the Master ESP subsystem:

XCF D A

Group=D520, Member=D521Partner Service Status ConnectionListener DSTRIG ActiveListener ROUTING ActiveD522 DSTRIG Active 1,1D522 ROUTING Active 2,2

DISPLAYACTIVE con’t

This is an example of the same command when entered from a Slave ESPsubsystem:

XCF D A

Group=D520, Member=D522Partner Service Status ConnectionD521 DSTRIG Active 1,1D521 ROUTING Active 2,2

Example –DISPLAYGROUP

The following example shows the short form of the DISPLAY GROUP commandwhen entered from the Master ESP subsystem:

XCF D G

Group=D520, Member=D521, TermOpt=QuiesceGroup Member System ASID Jobname SSID ESP StatusD520 D521 SYSA 006B D521 D521 Master ActiveD520 D522 SYSA 006C D522 D522 Slave ActiveD520 D523 SYSA 006D D523 D521 Shadow Active

This is an example of the same command when entered from a Slave ESPsubsystem:

XCF D G

Group=D520, Member=D522, TermOpt=QuiesceGroup Member System ASID Jobname SSID ESP StatusD520 D521 SYSA 006B D521 D521 Master ActiveD520 D522 SYSA 006C D522 D522 Slave ActiveD520 D523 SYSA 006D D523 D521 Shadow Active

Continued on next page

Page 743: ESP 5.2 Command Reference

743

XCF DISPLAY Command, Continued

Example –DISPLAYSERVICE

The following example shows the short form of the DISPLAY SERVICE commandwhen entered from the Master ESP subsystem:

XCF D S

Service Status Group MemberDSTRIG Active D520 D521ROUTING Active D520 D521

This is an example of the same command when entered from a Slave ESPsubsystem:

XCF D S

Service Status Group MemberDSTRIG Active D520 D522ROUTING Active D520 D522

Example –DISPLAYSYSTEM

The following example shows the short form of the DISPLAY SYSTEM command:

XCF D SYS

Sysplex=SYSAPLEX, System=SYSASystem StatusSYSA Active

Example –DISPLAYTRACE

The following example shows the short form of the DISPLAY TRACE command:

XCF D TR

ESP4263I XCF TRACE active, sysout class X

Page 744: ESP 5.2 Command Reference

744

XCF FORCE Command

Overview The XCF FORCE command is used to terminate an active ESP XCF memberabnormally with code S00C.

Type ESP XCF command.

Enteringcommands

All ESP XCF commands may be issued via:

• ESP page mode, option G from the ESP main menu• ESP line mode• MVS MODIFY command• ESP Workstation.

Syntax The syntax of the XCF FORCE command is:

XCF FORCE {MEMBER|M} member

Parameter Descriptionmember Indicates the name of the ESP subsystem you want to

terminate.

Example The following display shows member D522 as active.

XCF DISPLAY GROUP

Group=D520, Member=D521, TermOpt=QuiesceGroup Member System ASID Jobname SSID ESP StatusD520 D521 SYSA 0081 D521 D521 Master ActiveD520 D522 SYSA 007D D522 D522 Slave Active

The following example shows removing XCF member D522:

XCF FORCE MEMBER D522

ESP4232I XCF member D522 forced, Group=D520

Continued on next page

Page 745: ESP 5.2 Command Reference

745

XCF FORCE Command, Continued

Example con’t The following display shows the XCF group with the forced member.

XCF DISPLAY GROUP

Group=D520, Member=D521, TermOpt=QuiesceGroup Member System ASID Jobname SSID ESP StatusD520 D521 SYSA 0081 D521 D521 Master ActiveD520 D522 SYSA 007D D522 D522 Slave Failed

This example shows using the DELETE command to remove the forced member(D522) from the group.

XCF DELETE MEMBER D522

ESP4234I XCF member D522 deleted, Group=D520

The following display shows the remaining member(s) in the group.

XCF DISPLAY GROUP

Group=D520, Member=D521, TermOpt=QuiesceGroup Member System ASID Jobname SSID ESP StatusD520 D521 SYSA 0081 D521 D521 Master Active

Page 746: ESP 5.2 Command Reference

746

XCF HELP Command

Overview The XCF HELP command is used to display the list of ESP XCF commandsavailable.

Type ESP XCF command.

Enteringcommands

All ESP XCF commands may be issued via:

• ESP page mode, option G from the ESP main menu• ESP line mode• MVS MODIFY command• ESP Workstation.

Syntax The syntax of the XCF HELP command is:

XCF {HELP|H|?}

Example –HELPcommand

The following display is the response from the XCF HELP command:

Long Form Short Form

DELETE MEMBER member DEL M|MEM memberDISPLAY ACTIVE|ACTIVITY D A|ACTDISPLAY GROUP|GROUPS D G|GRDISPLAY SERVICE|SERVICES D S|SERVDISPLAY SYSTEM|SYSTEMS D SYSDISPLAY TRACE D TRFORCE MEMBER member FORCE M|MEM memberHELP H|?PURGE CONNECTION connection PG CON connectionPURGE SERVICE service PG S|SERV serviceSET TERMOPT LEAVE|QUIESCE T TO L|QSET TRACE SYSOUT(class) T TR S(class)SPIN TRACE SP TRSTART SERVICE service S S|SERV serviceSTART TRACE S TRSTOP GROUP P G|GRSTOP MEMBER member P M|MEM memberSTOP SERVICE service P S|SERV serviceSTOP TRACE P TRVERIFY MEMBER member VER M|MEM member

Page 747: ESP 5.2 Command Reference

747

XCF PURGE Command

Overview The XCF PURGE command is used to terminate and restart an ESP XCF Service.

Type ESP XCF command.

Enteringcommands

All ESP XCF commands may be issued via:

• ESP page mode, option G from the ESP main menu• ESP line mode• MVS MODIFY command• ESP Workstation.

Syntax The syntax of the XCF PURGE command is:

XCF {PURGE|PG} {SERVICE|SERV|S} service{CONNECTION|CON} connection

Parameter DescriptionSERVICE Used to specify a Service function in the XCF group.service Indicates the name of the ESP XCF Service you want to

terminate and restart.CONNECTION Used to specify a connection number of the listener.connection Indicates the connection number of the listener on the Master

ESP.

Example -PURGESERVICE

The following display shows the status of the XCF group:

XCF DISPLAY ACTIVE

Group=D520, Member=D521Partner Service Status ConnectionListener TRACKING ActiveListener DSTRIG ActiveD522 TRACKING Active 6,10D522 DSTRIG Active 7,11

Continued on next page

Page 748: ESP 5.2 Command Reference

748

XCF PURGE Command, Continued

PURGESERVICE con’t

The following example shows purging an ESP XCF Service:

XCF PURGE SERVICE TRACKING

ESP4221I Listener and 1 connection purged, Service=TRACKING,Group=D520, Member=

The following display shows the status of the XCF group after the TRACKINGService has been purged. Note how the TRACKING Service has been restarted witha new connection.

XCF DISPLAY ACTIVE

Group=D520, Member=D521Partner Service Status ConnectionListener DSTRIG ActiveListener TRACKING ActiveD522 DSTRIG Active 7,11D522 TRACKING Active 8,12

Example -PURGECONNEC-TION

The following example shows purging a connection:

XCF PURGE CONNECTION 3

ESP4225I Connection 3 purged

Page 749: ESP 5.2 Command Reference

749

XCF SET TERMOPT Command

Overview The XCF SET TERMOPT command is used to preset how the ESP XCF memberwill terminate the XCF group.

Type ESP XCF command.

Enteringcommands

All ESP XCF commands may be issued via:

• ESP page mode, option G from the ESP main menu• ESP line mode• MVS MODIFY command• ESP Workstation.

Syntax The syntax of the XCF SET TERMOPT commands is:

XCF {SET|T} {TERMOPT|TO} {LEAVE|L}{QUIESCE|Q}

Parameter DescriptionTERMOPT Used to preset how the XCF member terminates the XCF

group. Entered from the ESP XCF member you are logged onto or previously defined in the Initialization Parameters of theSYSPLEX Statement.

LEAVE This is the default for an XCFLOCAL configuration. It tellsESP to enter a LEAVE state when it terminates normallyfrom the XCF group. LEAVE means a member goes into anundefined state and no record of its existence is maintainedby XCF.

If QUIESCE and LEAVE are omitted and the local system(MVS image) is a member of a sysplex (i.e. uses a couplingdata set), QUIESCE is the default.

If the local MVS system is not a member of a sysplex (i.e.IEASYSnn member specifies PLEXCFG=XCFLOCAL),LEAVE takes effect unconditionally.

QUIESCE This is the default for a sysplex configuration. It tells ESP toenter a Quiesced state when it terminates normally. AQuiesced XCF member is disassociated from XCF Services,but XCF retains a record of its existence. Quiesced membersof an ESP XCF group are included in the response to the ESPsubcommand ‘XCF DISPLAY GROUP’.

Continued on next page

Page 750: ESP 5.2 Command Reference

750

XCF SET TERMOPT Command, Continued

Example –TERMOPTcommand

The following example shows setting ESP to terminate with a Quiesced state usingthe short form of the SET TERMOPT command:

XCF T TO Q

ESP4242I XCF TERMOPT set to QUIESCE, Group=D520, Member=D521

Example –TERMOPT inthe SYSPLEXstatement

The following example shows setting ESP to terminate with a Quiesced state usingthe TERMOPT operand in the SYSPLEX Initialization Parameter:

SYSPLEX GROUP(D520) MEMBER(D521) TERMOPT(QUIESCE)

Relatedinformation

For more information on the SYSPLEX Initialization Parameter, see the ESPWorkload Manager Installation Guide.

For more information on ESP and XCF, see the ESP Workload Manager User’sGuide.

Page 751: ESP 5.2 Command Reference

751

XCF SET TRACE Command

Overview The XCF SET TRACE command is used to define a sysout class for trace dataoutput. XCF SET TRACE can be coded in the Initialization Parameter data set orentered on the fly when trace data is required. It is recommended to put it in yourInitialization Parameter data set.

Type ESP XCF command.

Enteringcommands

All ESP XCF commands may be issued via:

• ESP page mode, option G from the ESP main menu• ESP line mode• MVS MODIFY command• ESP Workstation.

Syntax The syntax of the XCF SET TRACE command is:

XCF {SET|T} {TRACE|TR} {SYSOUT|S}(class)

Parameter Description(class) Indicates an output class for sysout.

Example The following example shows the short form of the SET TRACE command to settrace data to a sysout class of X:

XCF T TR S(X)

Relatedinformation

For more information about the XCF Trace facility, see the ESP Workload ManagerUser’s Guide.

Page 752: ESP 5.2 Command Reference

752

XCF SPIN TRACE Command

Overview The XCF SPIN TRACE command is used to spool trace data from the current tracefile to output and start a new trace file. This command is used when the trace file isstarted upon initialization of the ESP subsystem and kept running for the duration ofthe subsystem session.

Type ESP XCF command.

Enteringcommands

All ESP XCF commands may be issued via:

• ESP page mode, option G from the ESP main menu• ESP line mode• MVS MODIFY command• ESP Workstation.

Syntax The syntax of the XCF SPIN TRACE command is:

XCF {SPIN|SP} {TRACE|TR}

Parameter DescriptionSPIN Used to send trace data to output and start a new trace file.TRACE Indicates XCF Trace facility.

Example The following example shows the short form of the SPIN TRACE command:

XCF SP TR

Relatedinformation

For more information about the XCF Trace facility, see the ESP Workload ManagerUser’s Guide.

Page 753: ESP 5.2 Command Reference

753

XCF START SERVICE Command

Overview The XCF START SERVICE command is used to restart an XCF Service, on the fly,after it has been stopped.

Type ESP XCF command.

Enteringcommands

All ESP XCF commands may be issued via:

• ESP page mode, option G from the ESP main menu• ESP line mode• MVS MODIFY command• ESP Workstation.

Syntax The syntax of the XCF START SERVICE command is:

XCF {START|S} {SERVICE|SERV|S} service

Parameter DescriptionSERVICE Used to specify a Service function in the XCF group.service Indicates the name of the XCF Service you want to restart.

Usage notes XCF Services are registered and activated via the XCF START SERVICEcommand. The following commands must be coded in the Initialization Parameterdata set.

XCF START SERVICE TRACKINGXCF START SERVICE DSTRIG

The above commands are also used to restart a Service, on the fly, after it has beenstopped.

Relatedinformation

For more information on XCF Services, see the ESP Workload Manager User’sGuide.

Page 754: ESP 5.2 Command Reference

754

XCF START TRACE Command

Overview The XCF START TRACE command is used to initialize and activate the XCF Tracefile. The XCF START TRACE command can be used after the XCF SET TRACEcommand in the Initialization Parameter data set if you want to start the trace fileupon initialization of the ESP subsystem. Otherwise, the XCF START TRACEcommand is entered on the fly when you need to capture data.

Type ESP XCF command.

Enteringcommands

All ESP XCF commands may be issued via:

• ESP page mode, option G from the ESP main menu• ESP line mode• MVS MODIFY command• ESP Workstation.

Syntax The syntax of the XCF START TRACE command is:

XCF {START|S} {TRACE|TR}

Parameter DescriptionTRACE Indicates XCF Trace facility.

Example The following example shows the short form of the START TRACE command:

XCF S TR

Relatedinformation

For more information about the XCF Trace facility, see the ESP Workload ManagerUser’s Guide.

Page 755: ESP 5.2 Command Reference

755

XCF STOP GROUP Command

Overview The XCF STOP GROUP command is used to stop all the ESP XCF members in theXCF group.

Type ESP XCF command.

Enteringcommands

All ESP XCF commands may be issued via:

• ESP page mode, option G from the ESP main menu• ESP line mode• MVS MODIFY command• ESP Workstation.

Syntax The syntax of the XCF STOP GROUP command is:

XCF {STOP|P} {GROUP|G}

Parameter DescriptionGROUP Indicates an XCF group.

Page 756: ESP 5.2 Command Reference

756

XCF STOP MEMBER Command

Overview The XCF STOP MEMBER command is used to stop an ESP XCF Member.

Type ESP XCF command.

Enteringcommands

All ESP XCF commands may be issued via:

• ESP page mode, option G from the ESP main menu• ESP line mode• MVS MODIFY command• ESP Workstation.

Syntax The syntax of the XCF STOP MEMBER command is:

XCF {STOP|P} {MEMBER|M} member

Parameter DescriptionMEMBER Used to specify a Member name in the XCF group.member Indicates the name of the ESP subsystem you are targeting.

Example The following example shows the short form of the XCF STOP MEMBERcommand:

XCF P M D523

ESP4231E XCF member D523 stopped, Group=D520

Page 757: ESP 5.2 Command Reference

757

XCF STOP SERVICE Command

Overview The XCF STOP SERVICE command is used to stop an ESP XCF Service.

Type ESP XCF command.

Enteringcommands

All ESP XCF commands may be issued via:

• ESP page mode, option G from the ESP main menu• ESP line mode• MVS MODIFY command• ESP Workstation.

Syntax The syntax of the XCF STOP SERVICE command is:

XCF {STOP|P} {SERVICE|SERV|S} service

Parameter DescriptionSERVICE Used to specify a Service function in the XCF group.service Indicates the name of the Service you want to stop.

Example The following example shows the short form of the XCF STOP SERVICEcommand:

XCF P S TRACKING

ESP4220I XCF service TRACKING stopped, Group=D520, Member=D521

Relatedinformation

For more information on XCF Services, see the ESP Workload Manager User’sGuide.

Page 758: ESP 5.2 Command Reference

758

XCF STOP TRACE Command

Overview The XCF STOP TRACE command is used to stop the trace file after data has beencaptured and to spool the captured data to the preset sysout class specified by theXCF SET TRACE command.

Type ESP XCF command.

Enteringcommands

All ESP XCF commands may be issued via:

• ESP page mode, option G from the ESP main menu• ESP line mode• MVS MODIFY command• ESP Workstation.

Syntax The syntax of the XCF STOP TRACE command is:

XCF {STOP|P} {TRACE|TR}

Parameter DescriptionTRACE Indicates XCF Trace facility.

Example The following example shows the short form of the XCF STOP TRACE command:

XCF P TR

Relatedinformation

For more information about the XCF Trace facility, see the ESP Workload ManagerUser’s Guide.

Page 759: ESP 5.2 Command Reference

759

XCF VERIFY Command

Overview The XCF VERIFY command is used to verify that two ESP XCF members have thesame view of what their connections are. VERIFY is typically used after a PURGEcommand has been executed on a Service or a Connection.

Type ESP XCF command.

Enteringcommands

All ESP XCF commands may be issued via:

• ESP page mode, option G from the ESP main menu• ESP line mode• MVS MODIFY command• ESP Workstation.

Syntax The syntax of the XCF VERIFY command is:

XCF {VERIFY|VER} {MEMBER|M} member

Parameter DescriptionMEMBER Used to specify a Member name in the XCF group.member Indicates the name of the ESP subsystem you are targeting.

Example The following example shows the short form of the XCF VERIFY command:

XCF VER M D522

ESP4243I Verify request transmitted to XCF member D522,Group=D520.

Page 760: ESP 5.2 Command Reference

760

XMITMDL: Identify Tracking Models To Transmit

Overview The XMITMDL command tells ESP which tracking models are to be transmitted,and to which node.

Type General command.

Authority OPER authority is required to issue the XMITMDL command.

Syntax The syntax of the XMITMDL command is:

XMITMDL [ADD|DELETE|LIST]MODEL(modelname[,modelname]...)NODE(nodeid[,nodeid]...)

Parameter DescriptionADD Indicates that new information is to be added to the

specification of tracking data transmitted.DELETE Delete model or node from previous XMITMDL definition.LIST List models and nodes previously defined. This is the default.modelname Name of tracking model, associated with the jobs, for which

data is to be transmitted. Wildcard characters can be used tosignify a group of tracking models. Multiple tracking modelscan be specified.

nodeid For NJE, this is the logical identifier of each node to receivetracking data (as identified on the ISCXMTR statement); forLU6.2, this is the Application name of the target TP server.Multiple nodes can be specified.

Usage notes XMITMDL must be issued from a MASTER ESP system.

Example 1 To identify that all tracking data for model XSYS be sent to ESP_SYSTEM_A,where this is the Application name of the target TP server, specify:OPER XMITMDL ADD MODEL(XSYS) NODE(ESP_SYSTEM_A)

Example 2 To display cross-system tracking models:OPER XMITMDL LIST

Page 761: ESP 5.2 Command Reference

761

%

%ENDEXCL ........................................................... 266%ENDINCL............................................................. 269%EXCLUDE ........................................................... 295%INCLUDE............................................................. 346

/

//* FROM................................................................. 313//* UNTIL ................................................................ 729//*ESPSYMBOL...................................................... 284

A

ABANDON DEPENDENCIES................................. 15ABANDON RESOURCES........................................ 17ABANDON SUBMISSION ...................................... 19Abend limit ................................................................ 22Abended jobs ........................................................... 131ABENDLIM .............................................................. 22ABSORB ................................................................... 24Accessing ESP command through batch job.............. 55Activating user modifications .................................. 733ADJUST .................................................................... 25AFTER....................................................................... 27Agent commands

AGENT ................................................................. 31AGENTMSG......................................................... 34AGENTRCV ......................................................... 37

Agent definition fileloading................................................................. 457testing .................................................................. 457

Agent receivers, manipulating.................................... 37AJ......................................................................... 63, 74ALERTDEF............................................................... 41Alerts, defining .......................................................... 41ALLOWUNDEF........................................................ 44ALTCAL.................................................................... 45ALTEVENT .............................................................. 47ALTGROUP .............................................................. 50ALTSIG ..................................................................... 52ALTTJ ....................................................................... 53ALTUSER ................................................................. 55APPL.......................................................................... 58Application file,displaying....................................... 421Application processing,restarting............................. 595Applications

completing ............................................................. 74holding................................................................... 74processing options ................................................. 58releasing................................................................. 74resource requirements.......................................... 590stopping processing ............................................. 553unwaiting ............................................................... 74

APPLJOB ............................................................ 63, 74Authorization tables

deleting ................................................................ 182displaying ............................................................ 422

B

Backing out new release of ESP ................................ 76

Backing upEventset ................................................................. 77History file ............................................................. 78Index file................................................................ 79Job Index file ......................................................... 81Userdef file ............................................................ 83

BACKOUT ................................................................ 76BKUPEVS ................................................................. 77BKUPHIST................................................................ 78BKUPINDX............................................................... 79BKUPJNDX............................................................... 81BKUPUDEF .............................................................. 83BREAK...................................................................... 85Bypassing

a job ....................................................................... 63a sub-Application................................................... 63Event execution ................................................... 723job submission ....................................................... 19

C

CALENDAR.............................................................. 87Calendars

changing................................................................. 45defining................................................................ 144deleting ................................................................ 187displaying............................................................. 424naming ................................................................. 424referencing ............................................................. 87

CCFAIL ..................................................................... 94CELLTRC.................................................................. 97CHECKEXC ............................................................ 100Checkpoint data set, displaying................................ 426CLASS ..................................................................... 103CLRSYSMS............................................................. 107CMDPRFX .............................................................. 108COM ........................................................................ 109Command output

data set ................................................................. 330file........................................................................ 332sysout ................................................................... 334

CommandsABENDLIM .......................................................... 22ADJUST ................................................................ 25AJ..................................................................... 63, 74ALERTDEF........................................................... 41ALTCAL ............................................................... 45ALTEVENT .......................................................... 47ALTGROUP.......................................................... 50ALTSIG................................................................. 52ALTTJ ................................................................... 53ALTUSER ............................................................. 55APPLJOB ........................................................ 63, 74BACKOUT............................................................ 76BKUPEVS............................................................. 77BKUPHIST ........................................................... 78BKUPINDX .......................................................... 79BKUPJNDX .......................................................... 81BKUPUDEF.......................................................... 83BREAK.................................................................. 85CALENDAR.......................................................... 87

Page 762: ESP 5.2 Command Reference

762

CELLTRC ............................................................. 97CLASS................................................................. 103CLRSYSMS ........................................................ 107CMDPRFX.......................................................... 108COM.................................................................... 109CONNECT .......................................................... 110CONSOLE........................................................... 112COPY .................................................................. 114CPU ..................................................................... 122CRITERIA........................................................... 124CRITPATH ......................................................... 127DAB .................................................................... 131DATEFORM ............................................... 135, 137DEFAT ................................................................ 139DEFAULT........................................................... 142DEFCAL.............................................................. 144DEFGROUP........................................................ 147DEFHOL ............................................................. 150DEFPN ................................................................ 153DEFPRINT.......................................... 156, 159, 161DEFPRIO ............................................................ 163DEFSIG............................................................... 164DEFSPEC............................................................ 166DEFSYML .......................................................... 169DEFTJ ................................................................. 172DEFTM ............................................................... 174DEFUSER ........................................................... 178DELAT................................................................ 182DELAYINT......................................................... 183DELCAL ............................................................. 187DELETE...................................................... 188, 189DELGROUP........................................................ 190DELHOL............................................................. 191DELPN ................................................................ 193DELSIG............................................................... 194DELSPEC............................................................ 195DELSYML .......................................................... 197DELTJ ................................................................. 198DELTM ............................................................... 200DELUSER ........................................................... 201DFLTUSER......................................................... 205DFPNODE........................................................... 207DISCONN ........................................................... 209DISPLAY ............................................................ 210DN ....................................................................... 220DQ ....................................................................... 227DSTRDLY........................................................... 233DSTREXCL ........................................................ 235DSTRIG .............................................................. 237DSTRST .............................................................. 244ECHO .................................................................. 254EICLASS............................................................. 256EJECT ................................................................. 259END..................................................................... 262ENDDEF ............................................................. 263ENDHC ............................................................... 268ENDMODEL....................................................... 273ENDPRINT ......................................................... 274ENDR .................................................................. 275ESPCTR .............................................................. 280EVENT................................................................ 286

EVENTOPT.........................................................291

EVENTSET......................................................... 292EXPECT.............................................................. 302FLOW.................................................................. 309FOOTING............................................................ 311FROM.................................................................. 315GENDOC ............................................................ 317GENFLOW.......................................................... 319GENPROJ............................................................ 321GENTIME ........................................................... 323GO ....................................................................... 327GROUP................................................................ 328HARDCOPY ....................................... 330, 332, 334HISTFILE.................................................... 336, 338HOLD.......................................................... 340, 342INET.................................................................... 350INFOCOMM ....................................................... 353INFOMSG ........................................................... 355INIT ..................................................................... 357INPUT ................................................................. 359INVOKE.............................................................. 365JESCOMCH ........................................................ 370JESTYPE............................................................. 371JOBINFO............................................................. 382JOBMAP ............................................................. 386JOBTREE............................................................ 392JTPEXCL ............................................................ 394LABEL ................................................................ 399LAP...................................................................... 416LAX..................................................................... 404LCMDPRFX........................................................ 406LDSN................................................................... 407LDTE................................................................... 408LDTREL.............................................................. 409LDXE .................................................................. 410LIBSUB............................................................... 411LIST..................................................................... 413LISTAPPL........................................................... 416LISTAPTF........................................................... 421LISTAT ............................................................... 422LISTCAL............................................................. 424LISTCKPT .......................................................... 426LISTEVS ............................................................. 427LISTGRP............................................................. 429LISTHIST............................................................ 431LISTHOL ............................................................ 432LISTJTML........................................................... 434LISTPN ............................................................... 435LISTQ.................................................................. 436LISTSADL .......................................................... 437LISTSCH............................................................. 438LISTSIG .............................................................. 441LISTSPEC ........................................................... 443LISTTRAK.......................................................... 448LISTUSER .......................................................... 449LISTXMEZ ......................................................... 451LJ452LOAD .................................................................. 455LOADAGDF ....................................................... 457LOADJTDT......................................................... 458LOADSCHF ........................................................ 460LOADUPDT........................................................ 461LOGPRT.............................................................. 462

Page 763: ESP 5.2 Command Reference

763

LSYS ................................................................... 468LSYSMSGS ........................................................ 470LTCELL .............................................................. 471LTJ ...................................................................... 472LTM .................................................................... 474LTZONE ............................................................. 475MAPGEN ............................................................ 476MAXINITS ......................................................... 479MODEL............................................................... 492MREPORT .......................................................... 497MSG .................................................................... 500MSGTYPE .......................................................... 504NEXT .................................................................. 507NODE.................................................................. 510NOSCHED .......................................................... 515ON ....................................................................... 522PANSUB ............................................................. 529PASSWORD ....................................................... 531POST ................................................................... 535PREALLOC ........................................................ 541PURGSCHF ........................................................ 551QUIESCE ............................................................ 553QUPDATE .......................................................... 556RACROUTE........................................................ 557RELEASE.................................................... 566, 568REMOVE ............................................................ 572REPORT.............................................................. 574RESDEF .............................................................. 575RESDFLT............................................................ 583RESREFR............................................................ 594RESTART ........................................................... 595RESTORE ........................................................... 596RESUME..................................................... 598, 600ROSSUB ............................................................. 605SADGEN............................................................. 612SADLINK............................................................ 617SADLOAD .......................................................... 619SADUPD............................................................. 621SAFGRANT ........................................................ 622SAFOPTS............................................................ 624SAFRDEF............................................................ 627SAFRDEL ........................................................... 628SAFREVOK........................................................ 629SCAN .................................................................. 630SCHEDULE ........................................................ 633SEND .................................................................. 642SETPRINT .......................................................... 645SETWIDTH ........................................................ 646SHADOW ........................................................... 647SIGCYCLE.......................................................... 649SIGPOST............................................................. 651SIGWAIT ............................................................ 653SIMULATE......................................................... 655SMFSTATS......................................................... 662SORT................................................................... 663SPACE................................................................. 665SPINLOG ............................................................ 666SPUSER .............................................................. 667STATUS.............................................................. 668SUBMIT.............................................................. 675substitution string ................................................ 108

SUSPEND ................................................... 678, 680SYMLIB .............................................................. 681SYSMSGS........................................................... 683TEST ................................................................... 696TIME ................................................................... 700TITLE.................................................................. 701TRACE................................................................ 704TRACEDEF......................................................... 707TRACEPRT......................................................... 709TRACKING......................................................... 716TRACKOPT ........................................................ 718TRDFLT.............................................................. 721TRIGGER............................................................ 722UNALLOC .......................................................... 728USE ..................................................................... 731USER................................................................... 732USERMOD.......................................................... 733VS........................................................................ 735XMITMDL.......................................................... 760

Comments in an Event ............................................. 109Completing

a job ....................................................................... 63a sub-Application................................................... 63an Application........................................................ 74

Condition codeschecking................................................................. 94

Conditional processing............................................. 344CONNECT............................................................... 110Connecting users to groups ...................................... 110CONSOLE ............................................................... 112Console, setting primary .......................................... 112Converting

DJC networks....................................................... 371job documentation libraries ......................... 317, 399

COPY....................................................................... 114COPYJCL ................................................................ 116COREQ.................................................................... 119Co-requisite job........................................................ 119CPU, defining........................................................... 122Creating a job mapping data set ............................... 476CRITERIA ............................................................... 124Critical path analysis

enabling or disabling............................................ 127turning on for an Application............................... 129

CRITPATH...................................................... 127, 129CSF,purging data ..................................................... 551

D

DAB ......................................................................... 131Data set Trigger Delay ............................................. 233Data set triggering.................................................... 229

at Event level ....................................................... 237controlling............................................................ 244delaying ............................................................... 233displaying data set trigger objects........................ 410displaying data set triggered Events..................... 410displaying excluded programs ............................. 409excluding programs.............................................. 235listing data sets..................................................... 408workload object ................................................... 242

Data sets

Page 764: ESP 5.2 Command Reference

764

displaying ............................................................ 407job mapping......................................................... 476preallocating ........................................................ 541restoring............................................................... 596trace ..................................................................... 707

DATASET ............................................................... 133Date and time variables............................................ 323Date formats,schedule criteria.................................. 135DATEFORM ................................................... 135, 137Deactivating user modifications............................... 733Deallocating a data set ............................................. 728DEFAT .................................................................... 139DEFAULT ............................................................... 142Default resources ..................................................... 583DEFCAL.................................................................. 144DEFGROUP ............................................................ 147DEFHOL.................................................................. 150Defining

a footing............................................................... 311a title .................................................................... 701Alerts ..................................................................... 41authorization table ............................................... 139calendars...................................................... 144, 424date and time variables ........................................ 323Event data set....................................................... 292Events .................................................................. 286File trigger workload objects ............................... 305group prefixes...................................................... 169groups .................................................................. 147History file........................................................... 338holidays ....................................................... 150, 151initial user to ESP ................................................ 667jobs ...................................................................... 372P-nodes .......................................................... 56, 153RACF resources................................................... 627resources.............................................................. 575signals.................................................................. 164special days and periods ...................................... 444special days or periods......................................... 166Symbol libraries................................................... 169symbolic library sets ............................................ 169tracked jobs ................................................. 172, 711tracking models.................................................... 174users..................................................................... 178

DEFPN..................................................................... 153DEFPRINT

data set................................................................. 156file........................................................................ 159sysout................................................................... 161

DEFPRIO................................................................. 163DEFSIG ................................................................... 164DEFSPEC ................................................................ 166DEFSYML............................................................... 169DEFTJ...................................................................... 172DEFTM.................................................................... 174DEFUSER................................................................ 178DELAT .................................................................... 182Delaying job submission .......................................... 564Delaying submission ................................................ 184DELAYINT ............................................................. 183DELAYSUB ............................................................ 184

DELCAL ..................................................................187

DELETE .......................................................... 188, 189Deleting

a signal................................................................. 194a special day or period ......................................... 195an Event ............................................................... 188Events .................................................................. 189holidays................................................................ 191P-node.................................................................. 193RACF resources................................................... 628resources .............................................................. 575tracked job definition........................................... 198tracking model ..................................................... 200

DELGROUP ............................................................ 190DELHOL.................................................................. 191DELPN..................................................................... 193DELSIG ................................................................... 194DELSPEC ................................................................ 195DELSYML............................................................... 197DELTJ...................................................................... 198DELTM.................................................................... 200DELUSER................................................................ 201DESELECT.............................................................. 202DFLTUSER ............................................................. 205DFPNODE ............................................................... 207Diagnostic tracing .................................................... 704DISCONN................................................................ 209Disconnecting a user from a group........................... 209DISPLAY................................................................. 210Display width, setting............................................... 646Displaying

a tracked job definition ........................................ 472a user definition ................................................... 449Alerts ..................................................................... 41Application file usage .......................................... 421Applications......................................................... 416calendars .............................................................. 424checkpoint data set............................................... 426cross-memory elements........................................ 451current ESP status ................................................ 668current schedule ................................................... 438current status of the Application .......................... 421data set names...................................................... 407data set triggers.................................................... 408ESP data sets........................................................ 407ESP system information....................................... 468Event data set....................................................... 427Event definitions.................................................. 413excluded programs for data set triggering............ 409external jobs......................................................... 404fields in History Report........................................ 210groups .................................................................. 429History file ........................................................... 431holidays................................................................ 432job documentation information............................ 382job statistics ......................................................... 452job tracking file.................................................... 448names of Events ................................................... 414next execution times .................................... 414, 507P-nodes ................................................................ 435QUEUE data set................................................... 436queues .................................................................. 227queues .................................................................. 220

Page 765: ESP 5.2 Command Reference

765

resources.............................................................. 575SADLINKs .......................................................... 437scheduled activity report...................................... 463signals.................................................................. 441sub-Applications.................................................. 416symbol libraries ................................................... 446system messages .................................................. 470TCP/IP attributes ................................................. 350time zone settings ................................................ 475tracking cell information...................................... 471tracking models.................................................... 474TRAKFILE.......................................................... 448user definitions .................................................... 449user modifications................................................ 733

DJC specifications ................................................... 212DJCDATA ............................................................... 212DJCNET .................................................................. 218DN ........................................................................... 220DO ........................................................................... 223DO, ending............................................................... 264DOCLIB .................................................................. 225DQ ........................................................................... 227Dropping dependencies.............................................. 15Dropping resources .................................................... 17Dropping submit time dependency............................. 19DSNAME................................................................. 229DSTRDLY............................................................... 233DSTREXCL............................................................. 235DSTRIG........................................................... 237, 242DSTRST .................................................................. 244Due out time job submission.................................... 401DUEOUT................................................................. 246DURATION............................................................. 250

E

Early submission time .............................................. 251EARLYSUB ............................................................ 251ECHO ...................................................................... 254Echoing character strings ......................................... 254EICLASS ................................................................. 256EJECT...................................................................... 259ELSE........................................................................ 260Enabling user modifications..................................... 733END ......................................................................... 262ENDDEF.................................................................. 263ENDDO ................................................................... 264ENDHC.................................................................... 268Ending

a model definition................................................ 273an Event definition............................................... 263Line mode............................................................ 262

ENDJOB.................................................................. 271ENDMODEL........................................................... 273ENDPRINT.............................................................. 274ENDR ...................................................................... 275ENDTEMPL............................................................ 276error messages.......................................................... 657ESP .......................................................................... 277ESP commands

issuing from a Procedure ............................. 277, 282ESP Procedures,invoking......................................... 365

ESP tracking definition table.................................... 458ESPCOM ................................................................. 279ESPCTR................................................................... 280ESPNOMSG ............................................................ 282EVENT .................................................................... 286Event data set ............................................. See EventsetEvent definition commands

COM.................................................................... 109DSTRIG............................................................... 237ENDDEF ............................................................. 263EXPECT.............................................................. 302INVOKE.............................................................. 365LIBSUB............................................................... 411NOSCHED .......................................................... 515ON ....................................................................... 522PANSUB ............................................................. 529RELEASE............................................................ 566RESUME............................................................. 598ROSSUB.............................................................. 605SCHEDULE ........................................................ 633SEND................................................................... 642SIGCYCLE.......................................................... 649SIGPOST............................................................. 651SIGWAIT ............................................................ 653SUBMIT.............................................................. 675SUSPEND ........................................................... 678SYMLIB .............................................................. 681VS........................................................................ 735

Event definitions,displaying..................................... 413Event log, displaying................................................ 462Event messages,limiting........................................... 502EVENTOPT............................................................. 291Events

allowing or disallowing WTO ............................. 291altering schedule .................................................. 522changing................................................................. 47classes .................................................................. 103comments............................................................. 109default for triggering............................................ 721deleting ................................................................ 189displaying............................................................. 413displaying next scheduled execution.................... 507displaying schedule.............................................. 438expected time....................................................... 302holding................................................................. 342initiator classes .................................................... 256overdue ................................................................ 633resuming .............................................................. 600schedule criteria ................................................... 633scheduled deletion ............................................... 188scheduled hold ..................................................... 340scheduled release of............................................. 566scheduled resume................................................. 598scheduled suspension........................................... 678scheduling exception............................................ 515simulating ............................................................ 655starting definition................................................. 286stopping processing ............................................. 553suspending ........................................................... 680triggering ............................................................. 722triggering with Alerts ............................................. 41

Page 766: ESP 5.2 Command Reference

766

Eventsetbacking up ............................................................. 77defining................................................................ 292displaying ............................................................ 427

EVENTSET ............................................................. 292Excluding

JCL ...................................................................... 295programs from tracking ....................................... 394

EXIT ........................................................................ 299Exiting from a Procedure ......................................... 299EXPECT .................................................................. 302External job dependencies ....................................... 588External jobs

displaying ............................................................ 404

F

File trigger dependencies ......................................... 303File trigger workload objects ................................... 305FILE_TRIGGER...................................................... 305FILENAME ............................................................. 303FLAGUNDEF.......................................................... 307FLOW ...................................................................... 309Flow charting

MS Project........................................................... 321Timeline....................................................... 309, 319

FOOTING................................................................ 311Formatting output..................................................... 259Frequency of job ...................................................... 608FROM...................................................................... 315

G

GENDOC................................................................. 317GENFLOW.............................................................. 319GENPROJ................................................................ 321GENTIME ............................................................... 323GENTIME variables ................................................ 324GO ........................................................................... 327GROUP.................................................................... 328Group definitions,changing........................................ 50Group prefix,setting ................................................. 328Groups

connecting users .................................................. 110defining................................................................ 147definitions ............................................................ 429deleting ................................................................ 190displaying ............................................................ 429

H

HARDCOPY (DATASET option)........................... 330HARDCOPY (File option)....................................... 332HARDCOPY (Sysout option) .................................. 334HISTFILE ........................................................ 336, 338

displaying ............................................................ 431History file

altering................................................................. 338backing up ..................................................... 78, 339defining................................................................ 338displaying ............................................................ 431

History Reportdate format........................................................... 137ending .................................................................. 275

fields displayed ....................................................210

formatting .............................................................. 85input data set........................................................ 359output data set...................................................... 114selection criteria................................................... 124specifying History file.......................................... 336specifying sort order ............................................ 663starting ................................................................. 574time range ............................................................ 315

HOLD ...................................................................... 342HOLD (Event definition) ......................................... 340Holding

a job ....................................................................... 63a sub-Application................................................... 63an Application........................................................ 74

Holding Events................................................. 340, 342Holiday processing,Events ....................................... 522Holidays

defining................................................................ 150Deleting ............................................................... 191displaying............................................................. 432multiple................................................................ 151

I

IF 344Including JCL........................................................... 346Index file,backing up.................................................. 79INET ........................................................................ 350INFOCOMM............................................................ 353INFOMSG................................................................ 355Infoserv requests,sending ......................................... 353Inheriting relationships,simulating ........................... 655INIT ......................................................................... 357Initiator classes, Events............................................ 256Initiators

controlling for modeling ...................................... 357maximum for modeling........................................ 479

INPUT...................................................................... 359Input data set,tape processing .................................. 360INPUTDS................................................................. 360Inserting

a job ....................................................................... 63a job with a time dependency................................. 73

INTEGER ................................................................ 362INVOKE .................................................................. 365Invoking an ESP Procedure ..................................... 365

J

JCLchanging symbol introducer................................. 284copy of submitted ................................................ 116default values for job card ................................... 142member name....................................................... 481scanning ............................................................... 630submitting from a Librarian data set .................... 411submitting from a Panvalet data set ..................... 529submitting from an Event..................................... 675submitting from ROSCOE data set ...................... 605temporary use....................................................... 729

JCL library ............................................................... 133identifying............................................................ 367override................................................................ 694temporary............................................................. 694

Page 767: ESP 5.2 Command Reference

767

temporary use ...................................................... 313JCL scan exit

simulating ............................................................ 655JCL tailoring

excluding JCL...................................................... 295including JCL ...................................................... 346

JCLLIB .................................................................... 367JES

changing command character .............................. 370changing type....................................................... 371issuing commands from an Event ........................ 735specifing the type................................................. 371

JES3 statements ....................................................... 212JESCOMCH............................................................. 370JESTYPE................................................................. 371JOB .......................................................................... 372Job attributes............................................................ 372

changing .............................................................. 379Job documentation

converting to ESP format..................................... 317displaying ............................................................ 382

Job documentation library........................................ 225converting.................................................... 399, 572

Job Index file,backing up ........................................... 81Job mapping............................................................. 386

data set................................................................. 476successor reports.................................................. 392

Job monitor Events,simulating................................. 655Job monitoring,group prefix .................................... 495Job network identifier .............................................. 218Job Tracking Definition Table

entries .................................................................. 711loading................................................................. 458wildcards ............................................................. 737

Job tracking,excluding programs ............................. 394JOBATTR................................................................ 379JOBINFO................................................................. 382JOBMAP.................................................................. 386JOBRES................................................................... 391Jobs

abended................................................................ 131bypassing ............................................................... 63completing ............................................................. 63controlling ............................................................. 63co-requisite .......................................................... 119data set dependency............................................. 229data set triggers.................................................... 242defining................................................................ 372delayed release..................................................... 564deselecting ................................................... 202, 512displaying statistics.............................................. 452dropping dependencies .......................................... 63due out times........................................................ 246early submission time .......................................... 251ending definition.................................................. 271hold count ............................................................ 562holding................................................................... 63identifying predecessors ...................................... 543identifying successors .......................................... 537inheriting dependencies ....................................... 525inserting ................................................................. 63

inserting with a time dependency........................... 73late submission time............................................. 401listing details........................................................ 386notification........................................................... 517overdue ................................................................ 246post requisites ...................................................... 537prerequisites......................................................... 543processing options ............................................... 525readying ................................................................. 63releasing................................................................. 63requesting............................................................... 63resetting times........................................................ 63resource requirements .......................................... 590restart step............................................................ 525restarting ................................................................ 63resubmitting ........................................................... 63routing to another node........................................ 606run frequency....................................................... 608schedule criteria ................................................... 638scheduling exceptions .......................................... 512selecting............................................................... 638successor information .......................................... 392successors ............................................................ 569tagging ................................................................. 687tracking ................................................................ 711unbypassing ........................................................... 63unrequesting........................................................... 63unwaiting ............................................................... 63

JOBTREE ................................................................ 392JTPEXCL................................................................. 394JUMPTO.................................................................. 396

L

LABEL..................................................................... 399LAP.......................................................................... 416Late submission time................................................ 401LATESUB................................................................ 401LAX ......................................................................... 404LCMDPRFX ............................................................ 406LDSN ....................................................................... 407LDTE ....................................................................... 408LDTREL .................................................................. 409LDXE....................................................................... 410Librarian data set, submitting JCL ........................... 411LIBSUB ................................................................... 411Limiting Event messages.......................................... 502Line mode, ending.................................................... 262LIST ......................................................................... 413LISTAPPL ............................................................... 416LISTAPTF ............................................................... 421LISTAT.................................................................... 422LISTCAL ................................................................. 424LISTCKPT............................................................... 426LISTEVS ................................................................. 427LISTGRP ................................................................. 429LISTHIST ................................................................ 431LISTHOL................................................................. 432LISTJTML............................................................... 434LISTPN.................................................................... 435LISTQ ...................................................................... 436LISTSADL............................................................... 437

Page 768: ESP 5.2 Command Reference

768

LISTSCH ................................................................. 438LISTSIG .................................................................. 441LISTSPEC ............................................................... 443LISTSYML.............................................................. 446LISTTRAK .............................................................. 448LISTUSER............................................................... 449LISTXMEZ.............................................................. 451LJ452LOAD ...................................................................... 455LOADAGDF............................................................ 457Loading

Agent definition file............................................. 457ESP commands.................................................... 455Job Tracking Definition Table............................. 458schedule file......................................................... 460User Profile Definition Table .............................. 461

LOADJTDT............................................................. 458LOADSCHF ............................................................ 460LOADUPDT............................................................ 461LOGPRT.................................................................. 462LSAR ....................................................................... 463LSYS........................................................................ 468LSYSMSGS............................................................. 470LTCELL................................................................... 471LTJ........................................................................... 472LTM......................................................................... 474LTZONE.................................................................. 475

M

MAPGEN ................................................................ 476MAPUSER............................................................... 478Masking,Job Tracking Definition Table .................. 737MAXINITS.............................................................. 479MEMBER................................................................ 481Member name,JCL library ....................................... 481Messages

customizing.......................................................... 504customizing for ESP ............................................ 500displaying in Page mode...................................... 355error ..................................................................... 657intercepting system .............................................. 683Sending................................................................ 642

MGRADDR ............................................................. 483MGRMSG................................................................ 485MODEL ........................................................... 491, 492Modeling

changing times ....................................................... 25ending definition.................................................. 273reports.................................................................. 497starting definition................................................. 492

Modeling commandsADJUST ................................................................ 25DEFPRIO ............................................................ 163ENDMODEL....................................................... 273INIT..................................................................... 357MAXINITS ......................................................... 479MODEL............................................................... 492MREPORT .......................................................... 497TIME ................................................................... 700

MONITOR............................................................... 495MREPORT .............................................................. 497

MS Project file .........................................................321

MSG......................................................................... 500MSGLIMIT.............................................................. 502MSGTYPE............................................................... 504MVS commands,issuing from an Event ................... 735

N

NEXT....................................................................... 507NOCHECKEXC ...................................................... 509NODE ...................................................................... 510NORUN ................................................................... 512NOSCHED............................................................... 515NOTIFY................................................................... 517Numeric variables .................................................... 362

O

ON............................................................................ 522Operating system command,issuing ......................... 735OPTIONS................................................................. 525Output spacing ......................................................... 665Overdue Events ........................................................ 633Overdue jobs ............................................................ 246Override JCL library ................................................ 694

P

Page mode,display ................................................... 355PANSUB.................................................................. 529Panvalet data set, submitting.................................... 529PASSWORD............................................................ 531Permitting access to a resource ................................ 622P-Nodes

assigning to a job ................................................. 532displaying............................................................. 435setting defaults ..................................................... 207specifies the name................................................ 153

PNODES.................................................................. 532POST........................................................................ 535Post requisite jobs .................................................... 537Posting a job from a P-Node .................................... 535Posting a Signal........................................................ 651Postponing job submission....................................... 564POSTREQ................................................................ 537PREALLOC............................................................. 541Predecessors

identifying.............................................................. 27optional ................................................................ 562

Prefix for ESP console commands ........................... 406PREREQ .................................................................. 543Prerequisite jobs....................................................... 543Printing trace data .................................................... 709PRIORITY............................................................... 547Priority of modeling jobs ......................................... 163Procedures,exiting from ........................................... 299PROFILE ................................................................. 549Purging CSF Information ......................................... 551PURGSCHF............................................................. 551

Q

QUEUE data set,displaying...................................... 436QUIESCE................................................................. 553QUIT........................................................................ 554QUPDATE............................................................... 556

Page 769: ESP 5.2 Command Reference

769

R

RACF resources, defining........................................ 627RACINIT ................................................................. 557RACROUTE............................................................ 557Readying

a job....................................................................... 63a sub-Application................................................... 63

Real resources, refreshing ........................................ 594REEXEC.................................................................. 559Re-executing ESP Procedures.................................. 559RELCOUNT ............................................................ 562RELDELAY ............................................................ 564RELEASE................................................ 566, 568, 569Releasing

a job....................................................................... 63a sub-Application................................................... 63an Application ....................................................... 74Event.................................................................... 566Event for processing ............................................ 568

REMOVE ................................................................ 572Removing

job dependencies ................................................... 67lines in job documentation conversion ................ 572

REPORT.................................................................. 574Report output

data set................................................................. 156file........................................................................ 159sysout................................................................... 161

Reporting commandsBREAK ................................................................. 85COPY .................................................................. 114CRITERIA........................................................... 124DATEFORM ....................................................... 137DISPLAY ............................................................ 210ENDR .................................................................. 275FROM.................................................................. 315HISTFILE............................................................ 336INPUT ................................................................. 359REPORT.............................................................. 574SADGEN............................................................. 612SORT................................................................... 663

Reporting,scheduled activity.................................... 463Requesting

a job....................................................................... 63a sub-Application................................................... 63

RESDEF .................................................................. 575RESDFLT ................................................................ 583Resetting times of a job.............................................. 63RESOLVE ............................................................... 588Resource

ABSORB statement ............................................... 24RESOURCE............................................................. 590Resources

default.................................................................. 583defining................................................................ 575deleting ................................................................ 575displaying ............................................................ 575job priority........................................................... 547job requirements .................................................. 590refreshing............................................................. 594setting .................................................................. 575

RESREFR ................................................................ 594RESTART................................................................ 595Restarting

Application processing ........................................ 595Event proccessing ................................................ 595

RESTORE................................................................ 596Restoring ESP data sets............................................ 596RESUME ......................................................... 598, 600Resuming an Event........................................... 598, 600Revoking access to RACF resources........................ 629REXX processing

ending .................................................................. 601starting ................................................................. 602

REXXOFF ............................................................... 601REXXON................................................................. 602ROSCOE data sets,submitting JCL from ................. 605ROSSUB.................................................................. 605ROUTE .................................................................... 606Routing jobs to another node ................................... 606RUN......................................................................... 608Run frequency .......................................................... 608

S

SADGEN ................................................................. 612SADLINK ................................................................ 617SADLINKs,displaying ............................................. 437SADLOAD............................................................... 619SADUPD.................................................................. 621SAF security options ................................................ 624SAFGRANT............................................................. 622SAFOPTS ................................................................ 624SAFRDEF ................................................................ 627SAFRDEL................................................................ 628SAFREVOK............................................................. 629SCAN....................................................................... 630SCHEDULE............................................................. 633Schedule criteria

Events .................................................................. 633jobs ...................................................................... 638sub-Applications .................................................. 638testing .................................................................. 696

Schedule frequency of job........................................ 608Scheduled activity data set

creating ................................................................ 612internal identifier ................................................. 617loading ................................................................. 619updating ............................................................... 621

Scheduled Activity Report,displaying...................... 463Scheduled Events,displaying.................................... 438Scheduling deletion of an Event............................... 188SECURE .................................................................. 637Securing symbols ..................................................... 637Security options,SAF ............................................... 624SELECT................................................................... 638SEND....................................................................... 642Sending a message ................................................... 642SETPRINT............................................................... 645Setting

group prefix ......................................................... 328resources .............................................................. 575tracking options ................................................... 718

Page 770: ESP 5.2 Command Reference

770

SETWIDTH............................................................. 646SHADOW................................................................ 647SIGCYCLE.............................................................. 649Signals

changing number ................................................... 52cycling ................................................................. 649defining................................................................ 164deleting ................................................................ 194displaying ............................................................ 441posting ................................................................. 651waiting on ............................................................ 653

SIGPOST ................................................................. 651SIGWAIT ................................................................ 653SIMULATE ............................................................. 655Simulating

inheriting relationships ........................................ 655job monitor Events .............................................. 655USER variables ................................................... 655

Simulating,an Event ................................................. 655Skipping procedure code.......................................... 396SMF recording,controlling....................................... 716SMF records,data set triggers................................... 239SMF statistics........................................................... 662SMFSTATS ............................................................. 662SORT ....................................................................... 663Sorting report data ................................................... 663SPACE..................................................................... 665Spacing output ......................................................... 665Special days,defining ............................................... 166SPINLOG ................................................................ 666Spinning Audit Log.................................................. 666SPUSER................................................................... 667Starting Agent receivers............................................. 37Statements

%ENDEXCL ....................................................... 266%ENDINCL ........................................................ 269%EXCLUDE ....................................................... 295%INCLUDE ........................................................ 346//* FROM............................................................. 313//* UNTIL............................................................ 729//*ESPSYMBOL ................................................. 284ABANDON DEPENDENCIES............................. 15ABANDON RESOURCES ................................... 17ABANDON SUBMISSION .................................. 19ABSORB ............................................................... 24AFTER .................................................................. 27ALLOWUNDEF ................................................... 44APPL ..................................................................... 58CCFAIL................................................................. 94CHECKEXC........................................................ 100COPYJCL............................................................ 116COREQ ............................................................... 119CRITPATH ......................................................... 129DATASET........................................................... 133DELAYSUB........................................................ 184DESELECT ......................................................... 202DJCDATA........................................................... 212DJCNET .............................................................. 218DO ....................................................................... 223DOCLIB .............................................................. 225DSNAME ............................................................ 229

DSTRIG...............................................................242

DUEOUT............................................................. 246DURATION ........................................................ 250EARLYSUB ........................................................ 251ELSE.................................................................... 260ENDDO ............................................................... 264ENDJOB.............................................................. 271ENDTEMPL........................................................ 276ESP ...................................................................... 277ESPNOMSG........................................................ 282EXIT.................................................................... 299FILE_TRIGGER ................................................. 305FILENAME......................................................... 303FLAGUNDEF...................................................... 307IF 344INPUTDS ............................................................ 360INTEGER............................................................ 362JCLLIB ................................................................ 367JOB...................................................................... 372JOBATTR ........................................................... 379JUMPTO ............................................................. 396LATESUB ........................................................... 401MEMBER............................................................ 481MODEL............................................................... 491MONITOR .......................................................... 495MSGLIMIT ......................................................... 502NOCHECKEXC.................................................. 509NORUN............................................................... 512NOTIFY .............................................................. 517OPTIONS ............................................................ 525PNODES.............................................................. 532POSTREQ ........................................................... 537PREREQ.............................................................. 543PRIORITY........................................................... 547PROFILE............................................................. 549QUIT ................................................................... 554REEXEC.............................................................. 559RELCOUNT........................................................ 562RELDELAY ........................................................ 564RELEASE............................................................ 569RESOLVE ........................................................... 588RESOURCE ........................................................ 590REXXOFF........................................................... 601REXXON ............................................................ 602ROUTE................................................................ 606RUN..................................................................... 608SECURE.............................................................. 637SELECT .............................................................. 638STEPEND ........................................................... 669SUBAPPL............................................................ 670TAG..................................................................... 687TEMPLATE ........................................................ 689TEMPLIB............................................................ 694THEN .................................................................. 698TRACKDEF ........................................................ 711WILDCARD........................................................ 737

STATUS .................................................................. 668STEPEND................................................................ 669Stopping

Agent receivers ...................................................... 37Event processing.................................................. 553

Storage cells, tracing .................................................. 97SUBAPPL................................................................ 670

Page 771: ESP 5.2 Command Reference

771

Sub-Applications...................................................... 416deselecting ........................................................... 202identifying............................................................ 670schedule criteria................................................... 638

Submission, delaying ............................................... 184SUBMIT .................................................................. 675Submitting JCL from an Event................................. 675Successor jobs.......................................................... 569Suppressing response from ESP commands............. 282SUSPEND........................................................ 678, 680Suspending

an Event ....................................................... 678, 680Symbolic variable libraries

defining................................................................ 169deleting ................................................................ 197displaying ............................................................ 446including in an Event ........................................... 681

Symbolic variable library statements%ENDINCL ........................................................ 269%EXCLUDE ....................................................... 295%INCLUDE ........................................................ 346FLAGUNDEF ..................................................... 307GENTIME........................................................... 323INTEGER............................................................ 362SECURE.............................................................. 637

Symbolic variablesallowing undefined ................................................ 44changing introducer character in JCL.................. 284excluding data...................................................... 100footing string ....................................................... 311integers ................................................................ 362title string............................................................. 701

SYMLIB .................................................................. 681SYSMSGS ............................................................... 683System identifier, displaying.................................... 468System messages

clearing ................................................................ 107displaying ............................................................ 470intercepting.......................................................... 683

T

TAG ......................................................................... 687tape pull list.............................................................. 360TCELLs,displaying .................................................. 471TCP/IP attributes

address................................................................. 483displaying ............................................................ 350setting .................................................................. 350

TEMPLATE ............................................................ 689Templates

ending .................................................................. 276starting ................................................................. 689

TEMPLIB ................................................................ 694Temporary JCL,limiting use .................................... 729TEST........................................................................ 696Testing,schedule criteria .......................................... 696THEN....................................................................... 698TIME ....................................................................... 700Time dependencies,late submission time ................. 401Time period for modeling ........................................ 700Time zones,displaying ............................................. 475

Timeline ................................................................... 319TITLE ...................................................................... 701Titles,defining .......................................................... 701TRACE .................................................................... 704Trace data sets

displaying............................................................. 462identifying............................................................ 707

Trace data,printing ................................................... 709TRACEDEF............................................................. 707TRACEPRT ............................................................. 709Tracing,storage cell usage.......................................... 97TRACKDEF ............................................................ 711Tracked job definitions,displaying........................... 472Tracking

enabling and disabling ......................................... 716excluding programs.............................................. 394setting options...................................................... 718

TRACKING............................................................. 716Tracking model

overriding definition ............................................ 491Tracking models

cross-system tracking........................................... 760defining................................................................ 174deleting ................................................................ 200displaying............................................................. 474displaying buffers ................................................ 434replacing .............................................................. 174

TRACKOPT ............................................................ 718TRAKFILE,displaying............................................. 448TRDFLT .................................................................. 721TRIGGER ................................................................ 722Trigger default ......................................................... 721Triggering an Event.................................................. 722TRYJOIN................................................................. 727

U

UNALLOC............................................................... 728Unallocating a data set ............................................. 728Unbypassing

a job ....................................................................... 63a sub-Application................................................... 63

Undefined symbols................................................... 307Undefined symbols,allowing...................................... 44Unrequesting

a job ....................................................................... 63a sub-Application................................................... 63

Unwaitinga sub-Application................................................... 63an Application........................................................ 74

Updatingqueues .................................................................. 556scheduled activity dataset .................................... 621

Usageof ESP,displaying ................................................ 731

Usage, displaying ..................................................... 280USE.......................................................................... 731USER ....................................................................... 732User definition file,backing up................................... 83User definitions

changing................................................................. 55displaying............................................................. 449

Page 772: ESP 5.2 Command Reference

772

User modifications ................................................... 733User Profile Definition Table

loading................................................................. 461specifying user profiles........................................ 549

User profiles............................................................. 549USER variables,simulating ...................................... 655USERMOD.............................................................. 733Users

connecting to a group .......................................... 110defining................................................................ 178deleting ................................................................ 201

V

VS ............................................................................ 735

W

WILDCARD............................................................ 737Workdays, specifying............................................... 144WTO,allowing or disallowing.................................. 291

X

XCF comandsSTOP SERVICE.................................................. 757

XCF commandsDELETE.............................................................. 739DISPLAY ............................................................ 741FORCE ................................................................ 744HELP ................................................................... 746PURGE................................................................ 747SET TERMOPT .................................................. 749SET TRACE........................................................ 751SPIN TRACE ...................................................... 752START SERVICE............................................... 753START TRACE .................................................. 754STOP GROUP..................................................... 755STOP MEMBER................................................. 756STOP TRACE ..................................................... 758VERIFY............................................................... 759

XMEs,displaying...................................................... 451XMITMDL .............................................................. 760

Page 773: ESP 5.2 Command Reference

773

Reader’s Comment FormESP v.5.2 CR-02

We want tohear from you!

Please use this form to communicate your comments about this publication, itsorganization or subject matter. All comments will be considered when conductingfuture revisions to the manual.

Note: Your comments are provided with the understanding that Cybermation mayuse or distribute whatever information you supply in any way it believes appropriatewithout incurring any obligation to you.

PageNumber Comment

Do you wish areply to yourcomments?

Cybermation will reply to your comments, if you request it. Please provide us withyour name and address below.

NameCompany

Address

FaxE-mail

Note: Please note that comments that justify a reply should be of a more technicalnature (e.g. beyond comments about typographical errors.

Page 774: ESP 5.2 Command Reference

774

Mail this form to:Cybermation Inc.80 Tiverton CourtMarkham, OntarioL3R 0G4Attn: Information Development

or Fax it to:Information Development(905) 479-5474