Océ · 4.5 APA Control Key Data Set List: KEYxxx ... 8.1.4 JES3 Header, Separator, Message, ... 9 SPS Commands

Océ
PRISMAproduction/MVS V3.8
Administrator's Guide

...and Training?Our Systems & Software training center in BocaRaton, Florida, holds classes on the printingsystem described in this manual. We can alsoconduct these courses at your site or in the BocaEducation Center on request.

Information contact:Donald [email protected] (561) 997-3259Fax (561) 997-2591

To register for a class contact:Carol Leslie‘Ask to register for Software Education’Phone (561) 997-3251

Océ Printing Systems, USA5600 Broken Sound Blvd.Boca Raton, FL 33487

February 2001 Edition

Copyright Océ Printing Systems GmbH 2000

All rights reserved, including rights of translation, reprinting,reproduction by coying or any other method.

Offenders will be liable for damages. All rights, including rights createdby patent grant or registration of a utility model or design, are reserved.

Delivery subject to availability; right of technical modifications reserved.

Preface

U21020-J-Z247-7-7600

Preface

This document is intended to provide information for SPS administrators and users aboutthe SPS/MVS-APA product. It contains information on all installation options available, andguidelines for selecting which options are appropriate to given user requirements. Detailedcoding information for all installation and user parameters are included. This document willbe useful to both administrators and end users of the SPS/MVS-APA product.

Summary of Amendments

U21020-J-Z247-7-7600

Summary of Amendments

Summary of Amendmentsfor U21020-J-Z247-5-7600for SPS/MVS-APA Version 3.8 Update June 2000

• Support for JCL OUTPUT statement parameters, COLORMAP, OFFSETXF,OFFSETYF, OFFSETXB, OFFSETYB, OVERLAYF, OVERLAYB, DUPLEX, INTRAY,OUTBIN

• New DD statement for Object Container library OBJCONDD

• New parameter in SETUPxxx member, COLORMAP(colormap-name) to be used as thedefault colormap for the printer session

• New parameters in USER/FORMS control file, PRESENTATION(PORTRAIT180) and(LANDSCAPE180)

• SETUP verification support from formdef for color ids introduced

• UPGRADED color support triplets in PTOCA, IOCA, GOCA & BCOCA resources

• JPEG IOCAs supported

• MULTI-LEVEL IOCA support

• Relative line positioning support in PAGEDEF

• Triplet x’27’ support for rotation of page segments and other OCA objects in write testcommand

• Incorporation of 3.6 PTF’s with 3.6 base level forming the 3.8 base level

Contents

U21020-J-Z247-7-7600

Contents1 SPS/MVS-APA Introduction.......................................................................................... 11.1 What is SPS/MVS-APA ................................................................................................ 11.2 What can SPS do to Simplify Printing .......................................................................... 21.3 SPS Processing Overview............................................................................................ 3

1.3.1 FSI Interface .......................................................................................................... 31.3.2 SSI Interface .......................................................................................................... 4

1.4 Operating System Requirements ................................................................................. 51.5 APA Support Summary ................................................................................................ 6

1.5.1 User Input .............................................................................................................. 61.5.2 Installation Specifications....................................................................................... 71.5.3 Reliability, Availability, Serviceability (RAS) ........................................................... 8

2 Planning the SPS/MVS-APA Requirements ................................................................ 92.1 Object of Product Implementation ................................................................................ 92.2 SPS/MVS-APA Usage Modes .................................................................................... 10

2.2.1 Forms Table Option ............................................................................................. 102.2.2 JCL Control Option .............................................................................................. 102.2.3 User Control File Option ...................................................................................... 10

2.3 Determining SPS/MVS-APA User Requirements....................................................... 112.4 Parameter Data Set and Member Naming ................................................................. 122.5 Determining Data Sets and Parameter Members ...................................................... 132.6 The Forms Table ........................................................................................................ 14

2.6.1 Forms Mounts ...................................................................................................... 142.6.2 Predefined Processing......................................................................................... 152.6.3 Special Header, Separator, Message and Trailer Pages..................................... 15

2.7 User Control Files and Control Data Sets .................................................................. 162.8 SPS Printer Table....................................................................................................... 162.9 Initialization Member................................................................................................... 172.10 Exits.......................................................................................................................... 172.11 Installation Examples................................................................................................ 18

2.11.1 Example 1: Initial Installation.............................................................................. 182.11.2 Example 2: Adding AFPDS applications under JCL control .............................. 212.11.3 Example 3: Adding User Control File Support ................................................... 222.11.4 Example 4: Initialization Changes ...................................................................... 23

3 SPS System Parameters ............................................................................................. 253.1 Parameter Overview................................................................................................... 25

Contents

U21020-J-Z247-7-7600

3.2 SPS Minimum Requirements in SPS.SPSPARM....................................................... 283.3 SPSPARM Member Descriptions............................................................................... 293.4 SPS Initialization Parameter Descriptions .................................................................. 313.5 Control Statement Format and Parameter Syntax ..................................................... 31

4 APA System Parameter Descriptions ........................................................................ 334.1 Coding the APA SPSPARM Members ....................................................................... 33

4.1.1 Quick Install ......................................................................................................... 334.1.2 Fully Coded Members.......................................................................................... 34

4.2 APA Printer Table: SPSPRINT................................................................................... 364.2.1 SPSPRINT APA Control Statement Format ........................................................ 364.2.2 SPSPRINT APA Key Word Descriptions ............................................................. 36

4.3 APA Printer Execution Parameters: SETUPxxx......................................................... 414.3.1 SETUPxxx APA Control Statement Format......................................................... 414.3.2 SETUPxxx APA Key Word Descriptions.............................................................. 44

4.4 APA Printer Execution Parameters: FORMxxx .......................................................... 694.4.1 FORMxxx APA Control statement Format........................................................... 704.4.2 FORMxxx APA Key Word Descriptions ............................................................... 70

4.5 APA Control Key Data Set List: KEYxxx..................................................................... 734.5.1 KEYxxx APA Control Statement Format.............................................................. 734.5.2 KEYxxx APA Key Word Descriptions .................................................................. 73

4.6 APA Special Information Pages: HSMTffff ................................................................. 744.6.1 HSMTffff APA Control Statement Format............................................................ 744.6.2 HSMTffff APA Key Word Descriptions................................................................. 74

4.7 APA Forms Control File: DFLTffff .............................................................................. 754.8 APA Message Table: MSGSUxxx .............................................................................. 76

4.8.1 MSGSUxxx APA Control Statement Format........................................................ 764.8.2 MSGSUxxx APA Key Word Descriptions ............................................................ 76

4.9 TCP/IP Support with SPS........................................................................................... 78

5 Control File Processing .............................................................................................. 795.1 What is Control File Processing ................................................................................. 795.2 How is Control File Processing Used ......................................................................... 795.3 How is SPS User Control File Processing Defined for a Printer ................................ 805.4 User and Forms Control Files .................................................................................... 815.5 How is User Control File Processing Requested for Output ...................................... 825.6 User Coding Examples............................................................................................... 84

5.6.1 Example 1: Requesting a Predefined Form......................................................... 845.6.2 Example 2: Requesting AFPDS Options by the JCL Parameters ...................... 855.6.3 Example 3: Requesting User Defined Options from User Control File................ 85

5.7 APA Hierarchy of Override and Defaults .................................................................... 875.8 SPS System Defined Defaults for APA Printers......................................................... 885.9 APA Override Examples............................................................................................. 89

Contents

U21020-J-Z247-7-7600

6 APA Control File Parameters...................................................................................... 916.1 APA Control File Statement Formats ......................................................................... 92

7 Direct Printing............................................................................................................ 1077.1 Overview................................................................................................................... 107

7.1.1 What is Direct Printing ....................................................................................... 1077.1.2 Special Supported Functions ............................................................................. 1077.1.3 Unsupported Functions...................................................................................... 108

7.2 How is SPS Direct Printing Made Available.............................................................. 1097.2.1 Define the Direct Printers................................................................................... 1097.2.2 Code the Printer JCL Inserts.............................................................................. 1107.2.3 Establish Authorization....................................................................................... 112

7.3 User Direct Printing Requirements ........................................................................... 1137.3.1 Basic User.......................................................................................................... 1137.3.2 Special Requirements User ............................................................................... 113

7.4 User JCL Requirements ........................................................................................... 1147.5 Direct Printing Programming Considerations ........................................................... 115

7.5.1 Multiple Files in One Print Session .................................................................... 1157.5.2 Notification of Print Completion.......................................................................... 1157.5.3 DCB Parameters BUFNO and BLKSIZE ........................................................... 1167.5.4 Avoiding NPRO in Direct Printing Mode............................................................. 1167.5.5 Avoiding Re-synchronization of Twins ............................................................... 1177.5.5.1 Programming Interface: .................................................................................. 1177.5.6 Specifying SETUP Options for a Print Session.................................................. 1177.5.6.1 Programming Interface: .................................................................................. 1187.5.7 Psf Exit 16.......................................................................................................... 118

8 Printing with SPS....................................................................................................... 1198.1 Information Page Suppression ................................................................................. 119

8.1.1 Header, Separator, and Trailer Page Suppression by Administrator................. 1198.1.2 Message Page Suppression by Administrator or End User............................... 1198.1.3 JES2 Header, Separator, Message, and Trailer Page Control .......................... 1208.1.4 JES3 Header, Separator, Message, and Trailer Page Control .......................... 120

8.2 SPS Userlib Processing ........................................................................................... 1208.3 Inline Resources....................................................................................................... 1218.4 Immediate Machine Carriage Control....................................................................... 1218.5 Unprintable Data Sets .............................................................................................. 1218.6 Twin Printer Messages ............................................................................................. 1228.7 Printer Status NRD and Message SPS0260A.......................................................... 1228.8 Messages IEC031I and IEC032I for Trace Data Sets.............................................. 1238.9 Checkpoint Intervals and Restart ............................................................................. 1238.10 Font Interchange Information ................................................................................. 1238.11 Hardware Two Up................................................................................................... 1248.12 Post-processing Machines ..................................................................................... 124

Contents

U21020-J-Z247-7-7600

8.13 Printing IOCA AFPDS............................................................................................. 1248.14 Printing GOCA AFPDS........................................................................................... 1248.15 Printing BCOCA AFPDS......................................................................................... 1258.16 Printing MICR-Fonts ............................................................................................... 1258.17 Overlays and Page Segments Called from LNDs .................................................. 1258.18 Printing on Network Printers................................................................................... 1258.19 Direct Printing of Overlays and Page Segments .................................................... 1268.20 FCB Parameter for APA Printers............................................................................ 1268.21 Data Set Separator on same Physical Page as Output File................................... 1268.22 Exchanging the Front and Back Pages on Twin Printers ....................................... 1278.23 N-UP Support ......................................................................................................... 1278.24 Outline Fonts .......................................................................................................... 1278.25 SMF Accounting ..................................................................................................... 1278.26 Color Support ......................................................................................................... 1288.27 Type-2 Interface Support........................................................................................ 1288.28 Automatic Page Numbering ................................................................................... 1298.29 APA Resources Usage Listing ............................................................................... 1298.30 L-Units per Unit Base ............................................................................................. 1298.31 SPS Input Bin Processing ...................................................................................... 1298.32 Usage of Double Byte Fonts................................................................................... 1308.33 Orientation Issues in the Migration from Page Mode to IPDS................................ 1318.34 Techniques for the Migration from Simplex to Duplex ........................................... 136

8.34.1 Using SPS Control File Parameters................................................................. 1368.34.2 Using Conditional Processing to Eject to New Form ....................................... 1368.34.3 Applications Generating Invoke Media Maps................................................... 1388.34.4 Migrating to N_UP Duplex ............................................................................... 139

8.35 X2UP and N_UP Printing ....................................................................................... 1408.35.1 X2UP Printing .................................................................................................. 1418.35.2 Basic N_UP Printing ........................................................................................ 1428.35.3 Enhanced N_UP Printing ................................................................................. 143

8.36 Setup Verification ................................................................................................... 145

9 SPS Commands......................................................................................................... 1479.1 MVS Commands ...................................................................................................... 147

9.1.1 STOP (P) Command.......................................................................................... 1479.2 FSS Commands ....................................................................................................... 148

9.2.1 CANCEL Command........................................................................................... 1489.3 Printer Commands ................................................................................................... 149

9.3.1 FDIS Command ................................................................................................. 1499.3.2 FORM Command............................................................................................... 1509.3.3 PRTI Command ................................................................................................. 1519.3.4 PTFI Command ................................................................................................. 1519.3.5 QINT Command................................................................................................. 1519.3.6 SDIS Command................................................................................................. 152

Contents

U21020-J-Z247-7-7600

9.3.7 STAQ Command ............................................................................................... 1539.3.8 STAT Command ................................................................................................ 1539.3.9 TOPE Command ............................................................................................... 1549.3.10 TCLO Command.............................................................................................. 1549.3.11 TDIS Command ............................................................................................... 1549.3.12 TINT Command ............................................................................................... 1559.3.13 TLEV Command .............................................................................................. 1559.3.14 TSET Command .............................................................................................. 156

10 Optional System Tailoring...................................................................................... 15710.1 Information Pages ................................................................................................... 158

10.1.1 IPAGINFO Macro............................................................................................. 16110.1.2 Operands of the IPAGINFO Macro.................................................................. 16210.1.3 IPLINE Macro................................................................................................... 17110.1.3.1 Block Letters ................................................................................................. 17310.1.3.2 Attributes of Infopages Variables .................................................................. 17410.1.3.3 Installation Supplied Variables ...................................................................... 17510.1.4 IPSTRU Macro................................................................................................. 17510.1.5 IPEND .............................................................................................................. 17510.1.6 $IECHNG and $IELEV..................................................................................... 175

10.2 PSF Compatible Information Page......................................................................... 17610.3 PSF Compatible Exit 7 ........................................................................................... 178

10.3.1. Exit Activation.................................................................................................. 17810.3.2 Supported Exit 7 Calls...................................................................................... 178

10.4 Coding User Exit Routines ..................................................................................... 18010.4.1 Coding Conventions......................................................................................... 18010.4.2 Linkage Conventions ....................................................................................... 18110.4.3 Global Exit Area (GEA) .................................................................................... 18110.4.4 Working Storage .............................................................................................. 18110.4.5 Control Blocks.................................................................................................. 181

10.5 Accounting Exit ....................................................................................................... 18310.5.1 Parameter List.................................................................................................. 18310.5.2 Return Codes................................................................................................... 18310.5.3 Programming Considerations .......................................................................... 184

10.6 Input Record Processing Exit ................................................................................. 18410.6.1 SPOOL Record Processing ............................................................................. 18510.6.2 Parameter List.................................................................................................. 18510.6.3 Return Codes................................................................................................... 18610.6.4 Programming Considerations .......................................................................... 18610.6.5 Sample Record Processing Examples ............................................................ 18910.6.5.1 Modify the current record. ............................................................................. 18910.6.5.2 Insert a record before the current record. ..................................................... 189

10.7 Message Processing Exits ..................................................................................... 19010.7.1 Parameter List.................................................................................................. 191

Contents

U21020-J-Z247-7-7600

10.7.2 Return Codes................................................................................................... 19110.7.3 Programming Considerations .......................................................................... 192

10.8 Data-set Allocation Exit .......................................................................................... 19310.8.1 Parameter List.................................................................................................. 19310.8.2 Return Codes................................................................................................... 19410.8.3 Programming Considerations .......................................................................... 194

10.9 Resource Read Exit................................................................................................ 19510.9.1 Types of Call .................................................................................................... 19510.9.2 Begin D/S Call.................................................................................................. 19510.9.3 Normal Call ...................................................................................................... 19610.9.3.1 Parameter list................................................................................................ 19610.9.3.2 Return codes................................................................................................. 19710.9.3.3 Programming notes ...................................................................................... 19710.9.4. Eod Call .......................................................................................................... 19810.9.4.1 Parameter list................................................................................................ 19810.9.4.2 Return Codes................................................................................................ 19910.9.4.3 Programming Notes...................................................................................... 19910.9.5. Discard Call..................................................................................................... 19910.9.5.1 Parameter list................................................................................................ 19910.9.5.2 Return Codes................................................................................................ 20010.9.5.3 Programming Notes...................................................................................... 20010.9.6. Normal Termination Call ................................................................................. 20110.9.6.1 Parameter List............................................................................................... 20110.9.6.2 Return Codes................................................................................................ 20110.9.6.3 Programming Notes:..................................................................................... 20110.9.7. Abnormal Termination Call ............................................................................. 20110.9.7.1 Parameter List............................................................................................... 20110.9.7.2 Return Codes................................................................................................ 20210.9.7.3 Programming Notes...................................................................................... 20210.9.8. Trace Records ................................................................................................ 20210.9.9. Abend Codes .................................................................................................. 203

10.10 Page Segment Exit............................................................................................... 20410.10.1. Types of calls ................................................................................................ 20410.10.2. Page Segment not Found call....................................................................... 20410.10.2.1 Parameter list.............................................................................................. 20410.10.2.2 Return codes............................................................................................... 20510.10.3. Trace Records .............................................................................................. 20510.10.4. Abend Codes ................................................................................................ 205

10.11 Message Table Modification................................................................................. 20610.12 Restricted Messages............................................................................................ 20710.13 Preparing Installation Supplied Variables............................................................. 208

10.13.1 JES Spooled Data Sets ................................................................................. 20810.13.2 Direct Printing Data Sets................................................................................ 20910.13.3 Parameter Lists.............................................................................................. 210

Contents

U21020-J-Z247-7-7600

10.13.4 Return Codes................................................................................................. 21110.13.5 Programming Considerations ........................................................................ 211

11 Messages and Codes.............................................................................................. 21311.1 Conventions............................................................................................................ 21311.2 SPS Messages ....................................................................................................... 21411.3 SPS Abend Codes.................................................................................................. 214

Appendix A: APA Parameter Selection Order.............................................................. 215

Appendix B: SMF type 6 Record Format...................................................................... 218

Appendix C: Page Counters Reported in SMF Records............................................ 229

List of Illustrations ......................................................................................................... 231

List of Tables .................................................................................................................. 235

Bibliography.................................................................................................................... 237

Index ................................................................................................................................ 238

Contents

U21020-J-Z247-7-7600

SPS/MVS-APA Introduction

U21020-J-Z247-7-7600 1

1 SPS/MVS-APA Introduction

1.1 What is SPS/MVS-APASPS/MVS-APA is the printer subsystem that drives IPDS single and twin printerssupporting SNIPDS data streams (a data stream fully compatible with the IPDS datastream) under MVS/SP2 (XA), MVS/SP3-SP4-SP5 (ESA), OS/390, and subsequent MVSsystems. SPS/MVS-APA is a part of SPS/MVS, an integrated software package supportingall Océ APA, LIP, and MOD2 printer models under the MVS based operating systems.SPS/MVS-APA is a member of the SPS product family which includes support for printersunder other operating systems like VSE, BS2000, UNIX and WINDOWS-NT.

SPS/MVS-APA, as distributed, includes the base SPS product and one driver supportingAPA printers. Multiple executions of this driver may function concurrently under the sameaddress space or in several address spaces within the system. The SPS APA driveraccepts SPS data stream (SPDS, a fully compatible PSF data stream) and line input. Itconverts these input types (may be intermixed) to an SNIPDS data stream. The input datastream may be either JES spooled output or direct printing output from a program.Optionally library resource processing specifications may be overridden and specialhardware features may be selected by control file requests.

APA printers use library resources to control the formatting of input print data streams.These resources are read from libraries before the data stream is processed. SPSprovides the capability of controlling, adding to, or overriding resource processing from anycombination of the following sources:

• Installation predefined processing associated with form names

• User specified requests in the JCL

• User specified requests in control files

• Operator entered JES2 or JES3 commands

The listed sources are merged with the library resources to produce the final print datastream formatting. Using the above facilities an installation or user has full control over


2 U21020-J-Z247-7-7600

such processing options as input bin and output stacker, duplexing, font selection,presentation, etc..

1.2 What can SPS do to Simplify PrintingSPS provides an option that makes it possible for the SPS administrator to define userform names that are associated with predefined print formatting models. Using this facility,the SPS administrator can establish a variety of predefined print formatting models tohandle the standard print jobs in an installation. These predefined print characteristics areselected by form names associated with each of the models. This facility is used byproviding a list of form names with associated output formats to end users who then onlyneed to select the appropriate form name to generate the desired output format.

This mode of operation effectively removes all need for the end user to understand detailsabout APA processing. The end user only needs to know the form name associated withthe print formatting desired. A form print definition can be overridden by user control fileparameters when alternate processing is needed. This override facility provides great printflexibility to the end user while minimizing the knowledge required.

SPS/MVS-APA provides a user control file installation option which permits theidentification of users or user groups who are permitted to provide their own predefinedprint models. These users have total flexibility in their processing options. They can build aset of personalized print models to handle their unique print job requirements. This optionrequires the end user have a knowledge of how to use and code print control files. Thislevel of understanding requires very little time to master. Selected users or user groupsmay be given this authority as desired. This option may be used with the predefined formsoption (forms control file).

The information pages facility (header, separator, message, and trailer pages) provide thecapability of generating uniquely designed information pages for specific print models(forms). On cut sheet printers this provides clear output separation in all situations,allowing for offset stacking, colored separator forms and other features. In all situations itprovides the capability of matching information page sizes and formats with special formsrequirements.

The direct printing facility makes it possible for an application program to directly drivesingle and twin APA printers without spooling the output through JES. Multiple printers maybe driven by an application in the same address space if required.

Last, but not least, SPS/MVS-APA provides full error recovery for IPDS printers. Theseerror recovery facilities take also in consideration the device characteristics and advancedfeatures of Océ printers.


U21020-J-Z247-7-7600 3

1.3 SPS Processing OverviewSPS uses only standard documented interfaces. No modifications are introduced in theMVS or JES environments. SPS uses the Functional Subsystem Interface (FSI) tocommunicate with the Job Entry Subsystem (JES) installed in the host MVS system, andthe Subsystem Interface (SSI) to communicate with data management routines in thedirect printing environment.

1.3.1 FSI Interface

The FSI is an IBM supported customer interface permitting an address space tocommunicate with the spooling and operator facilities of the installed JES. The FSIsupports such functions as connecting and disconnecting Functional Subsystems (FSS‘s)and Functional Subsystem Applications (FSA's) to JES (establishing and terminatingcommunication), opening and closing spool output files, reading spool records, receivingoperator or JES initiated orders, receiving posts from JES, and sending responses to JES.

SPS is defined to JES in the JES initialization parameters at installation time as one ormore FSS's, each with one or more FSA's, which are printer drivers. These FSA's run assubtasks of the FSS they are associated with. One FSS and its active FSA's reside in oneaddress space.

When the operator issues a start printer to any SPS controlled device, if the FSS for thisprinter has not been started, an address space is created and the FSS is loaded into theaddress space and initialized. This is followed by an FSA driver being associated with theprinter and attached as a subtask. If the FSS for the printer already exists in an addressspace, just the FSA subtask attach takes place. The FSA subtask initializes and loads theappropriate printer driver, and then requests a spool file from JES. Spool files areprocessed until the printer is drained, at which time the FSA controlling the printer isdetached. Other FSA's driving different printers continue to process. When the printer isagain started by the operator a new copy of the FSA is attached and initialized, and theprocess continues as before.

A spool print file is processed by merging the user control file data with the user JCL, andthe installation specified form processing, then the required resources are loaded and thefile is printed. The APA driver uses data management to read resources from theirlibraries, and the FSI interface to read user generated spool files. It then sends thecombined print data and resources to the printer as an SPDS using EXCPVR with PCIinterrupts.

At completion of printing, a spool file is returned to the JES system, which either deletes orkeeps the spool file depending on the operator or user request. If an error occurs duringthe processing of a spool file, in most cases the spool file is returned to JES with a requestto save it on the spool. When the error is correctable (as for instance font not found) thefile can be reprinted from the most recent checkpoint or the beginning. When the error in a


4 U21020-J-Z247-7-7600

saved spool file is not correctable the operator or user must delete the file. All operatorprinter requests are processed by SPS. When a file is interrupted by the operator, it ischeckpointed so that it may be restarted at a later time. A cancelled file will be purged.

1.3.2 SSI Interface

The SSI is an IBM supported customer interface enabling applications to establishcommunication and interface with system routines. The application becomes a definedsubsystem of the operating system and receives control when specified services arerequested.

During system initialization SPS is defined to the operating system as a subsystem, theservice routines that SPS will need are loaded to the CSA, and the SPS subsystem ismade active. After initialization, control is passed to SPS during JCL conversion,allocation, deallocation, open, close, and put or write.

During JCL conversion, the subsystem interface function of SPS determines if a validrequest for SPS direct printing services has been made. If an invalid request is detected,the JOB receives a JCL error. SPS performs no processing during allocation anddeallocation, control is immediately returned. At open SPS is attached, allocates andbuilds the control blocks required for direct printing processing, and establishes a putroutine interface by requesting ACB processing. If this is the first printer used by the job,SPS also establishes a pseudo FSS/FSA environment. SPS receives control during put orwrite processing, processes the request and returns control to the user. At close SPSfrees any control blocks used for direct printing, cleans up storage, and is detached. IfSPS determines this is the last SPS printer used by the address space, SPS also deletesthe pseudo FSS/FSA environment.


U21020-J-Z247-7-7600 5

1.4 Operating System RequirementsSPS version 3.8 will run without restrictions on MVS systems at the release levels listedbelow. Any specifically required PTF's are documented by the ++IF REQ statements ofthe supplied installation deck.

MVS/XA Version 2.1.3 and above

MVS/ESA Version 3, 4 and 5

OS/390 Version 1 and 2

To use the SPS PSORT facility you should have at least MVS/ESA Version 3. For somefunctions of the sorter, MVS/ESA Version 4 is needed.


6 U21020-J-Z247-7-7600

1.5 APA Support SummarySPS processing support for APA single and twin printers can be divided into three majorcategories: user input, installation specifications, and RAS facilities. The main elements ofthese functions are listed in the following sections.

1.5.1 User Input

Input Data Stream Processing: Accepts from the spooling system or a user program anyuser generated data stream that conforms to the SPDS Data Stream Reference Manual.These data streams may include line data, composed text data, and any resource type.

Resource Data Stream Processing: Reads from libraries any input data stream or JCLreferenced resources. These resources may be:

• Form definitions (FORMDEF)

• Page definitions (PAGEDEF)

• Page segments

• Overlays

• Fonts (Coded Fonts, Font characters sets, Code pages)

• Color mapping tables

Control File Support (extended JCL): SPS reads control statements from control filespermitting the selection of features and control of individual print job processing throughoverriding FORMDEF and PAGEDEF specifications that is not possible through normalJCL. The following functions are currently supported for APA single and twin printers:

• Selection of the duplex options for both portrait and landscape pages: simplex, normal,and tumble

• Selection of the twin duplex options for both portrait and landscape pages: zigzagnormal, and zigzag tumble

• Selection of input bin and output stacker

• Two up printing

• Listing of active file options

• Copies with from/to pages

• Selection of eject to front facing function

• Flip print on A-Twin printers

• Enhanced double byte character set usage


U21020-J-Z247-7-7600 7

• 3800 compatible media origin

• Selection of presentation

• Font pruning

• Input bin substitution

• Selection of chars, formdef, pagedef

• Warning only messages

• Spooled message page

Job Control Language (JCL): SPS accepts all page printer related JCL

Message Generation: SPS generates operator and user related messages concerning allphases of data stream processing. User messages are printed at the end of the useroutput or may be spun off to a spool file.

Checkpointing: Processing checkpoints may be requested by the user or installation on atime or page count interval basis. This facility permits the restart of a data streaminterrupted by operator, user error, or hardware error.

1.5.2 Installation Specifications

System parameters: SPS supports a variety of initialization parameters and processingdefaults. All options specified under control file support above can be specified by aninstallation for a specific form or output class. The active setup and file parameters can beseen via the SDIS and FDIS SPS commands.

Information Pages: Flexible, easily defined installation header, trailer, data set separator,and message pages. Different information page formats may be defined for each printer,output class or form name. PSF compatible user exits for information pages are alsosupported.

Predefined Form Processing: Any form can have installation defined print characteristicsthat will be used automatically when the form name is requested.

Setup processing dependant on the number of input bins from a cutsheet printer is done.

Accounting: SPS generates the standard SMF type 6 accounting record for all input datastreams processed. If MVS is not able to write an SMF record SPS informs the operator,allowing retry or ignore actions. Even when SPS abends or the MVS system crashes SPSwrites SMF records for the printing files (either at clean-up or at reselection time) assuringa 100% reliable accounting system for the printing jobs.


8 U21020-J-Z247-7-7600

User exits: The following exit points are defined:

• Record: Modify, delete or insert records to be printed in the input data stream.Additional support for repositioning and paper jams is included in the input record exitinterface. Each printer may have its own unique record processing exit.

• Accounting: Modify SMF type 6 accounting records generated by SPS. Each printermay have its own unique accounting exit.

• Message: Perform special processing when any given message is issued. A differentexit may be defined for each SPS message. Each printer may have its own unique setof message exits.

• Direct:Direct printing compatibility exit. Provides full compatibility with IBM's directprinting exit interface and processing.

• D/S Allocation: May change the output file characteristics or request SPS to purge orhold a file without printing it. Each printer may have its own unique data-set allocationexit.

• Resource read: Modify, delete or insert resources read from system or user libraries.

• Page Segment: Allows SPS to continue processing if a page segment missingcondition is reached.

• PSF exits: Full compatible PSF exit interface for exits 1,2 and 3 is provided. A subsetof PSF exit interface 7 is provided.

1.5.3 Reliability, Availability, Serviceability (RAS)

Dumping: Diagnostic dumps are automatically taken in the event of program orunexplained errors. For direct printing applications, SPS must be RACF authorized inorder to be able to write SYSUDUMPs.

Tracing: An SPS trace facility is defined which permits the collection of information on allphases of SPS processing. The level of detail of the trace information collected may beselected by the installation and varies from flow trace to all control blocks, input and outputdata.

Error recovery: SPS provides full error recovery for APA printers and guarantees thatprint data sets are not purged from the JES spool unless successfully printed.

EREP: In the event of a printer hardware error, SPS records an outboard type record inSYS1.LOGREC for analysis by EREP.

Planning the SPS/MVS-APA Requirements

U21020-J-Z247-7-7600 9

2 Planning the SPS/MVS-APA Requirements

2.1 Object of Product ImplementationSPS/MVS-APA provides a number of modes of use. In its simplest user mode, SPSsupports the selection of a form name defining all print characteristics for a print datastream. In its most advanced mode, SPS supports user specified print options in JCL,user, and/or forms control files. All modes of use are available to both the JES spoolprocessed data streams and direct printing generated data streams. An installation will notusually need to give all users access to all available options. Many of the print options thatSPS/MVS-APA provides may not be required at an installation at all. The implementationof options that are not required will unnecessarily complicate the installation, maintenance,and use of SPS.

The ideal installation of SPS/MVS-APA is the one that is easiest for the user whilepermitting him to perform the functions he requires. The more advanced modes of SPSusage, if required, will most likely be only needed by specific user groups or departments.SPS provides the capability of restricting these facilities to specific user groups. The initialtask of the administrator is to determine what modes of use will be sufficient for theinstallation needs and what user groups associated with these modes need to be defined.

The options selected determine the data sets required by SPS, the installation parametermembers needed, the user parameters required, and the complexity of the override logicof the parameters. The administrator should implement only those data sets andparameter members that are needed to support user requirements. Support of options notinitially installed can be easily added later without impacting the SPS users or IPLing theoperating system.


10 U21020-J-Z247-7-7600

2.2 SPS/MVS-APA Usage ModesThree installation options are provided by SPS/MVS-APA to support formatting of printdata streams:

1. Forms table

2. JCL control

3. User control file

2.2.1 Forms Table Option

The forms table supports the definition of form names with predefined print options. This isthe simplest mode of use for SPS users. It permits a user to select a set of formatting andprocessing options by single form name specified in the JCL. The form name is associatedwith a predefined set of formatting and processing options defined by the SPSadministrator in an SPS system parameter library. A system parameter library is notnormally modifiable by any user, thus users cannot corrupt these predefinitions.

The forms table option makes it possible for a user to select formatting by generalrequirements associated with single form names or output class rather than by detailedparameters or JCL specifications. The end user needs no detailed understanding of theprinter functions, resources, or SPS options required to format the output. The forms tableoption also provides support of operator forms mounting messages, recognition of formsalready mounted, and automatic bin selection of forms on cut sheet printers. The formstable processing option is recommended as the initial implementation for SPS/MVS-APA,and should be the mode made available to the general user.

2.2.2 JCL Control Option

SPS accepts all the AFPDS (Advanced Function Presentation Data Stream) formattingoptions specifiable in the JCL. This is the standard support of AFPDS offered by IBM. Thisoption controls formatting of output entirely by the JCL specifications. Using this installationoption the end user needs to be familiar with the JCL AFPDS formatting parameters.When this option is used with the forms table option, JCL specification may be overriddenby the options in the forms control file. This option requires no understanding of the SPSproduct or facilities by a user familiar with IBM's standard support of APA printers. Thisoption is always available when SPS is installed.

2.2.3 User Control File Option

The user control file permits a user or user group to specify formatting and processingparameters in members of a user control file data set defined and made accessible to the


U21020-J-Z247-7-7600 11

user or user group by the SPS administrator. These parameters may be a completedescription of the formatting and processing requirements, overrides and additions topredefined formatting and processing definitions established by the SPS administrator inthe forms control file (accessed via the forms table), overrides to JCL specifications, oroverrides to options within the resources selected by the job. The user control file optionpermits the maximum flexibility to the user, but requires the most understanding of theproduct.

2.3 Determining SPS/MVS-APA User RequirementsInstallations that have users unfamiliar with APA printing should define a forms table andforms control files that contain predefinitions of the standard print jobs required by theseusers. These users should receive a list of the forms or class names with a description ofthe input expected and the formatting that will take place. The entire printing requirementsof this user type should be initially supported by the forms table option. When aninstallation has cut sheet printers with multiple input bins, the forms table option may alsobe installed if automatic bin selection of mounted forms is desired, or multiple forms are tobe processed in a single print data stream (see the SETUPxxx REAINUS parameter).

The JCL control option is always available when SPS/MVS-APA is installed. An installationwith a user base fully familiar with AFPDS JCL could initially install SPS with only JCLcontrol support. Forms control and user control file support could be added later as theinstallation becomes more familiar with the SPS product. However, the simplifiedformatting and additional formatting options that SPS offers will not be available until theforms table and control file options are implemented.

User groups that would like to predefine their own formatting options, or have the flexibilityof overriding resource specifications such as duplex/simplex, control input and stackerselection on cut sheet printers, etc. need the control file option support. This option caneasily be installed after initial installation and only requires a reinitialization of the selectedprinter to activate.


12 U21020-J-Z247-7-7600

2.4 Parameter Data Set and Member NamingThere are no restrictions on the data set names used by the administrator for SPS/MVS-APA parameter data sets. Parameter member names within the data sets are likewiseunrestricted with the exception of the print table which has a mandatory name ofSPSPRINT. However, data set and member naming conventions have been adopted forconvenience of reference within the Administrator's Guide and sample membersdistributed with the product. For a summary of these naming conventions please seeFigure 1 on page 12.

Data Sets

SPS.SPSPARM System parameter librarySPS.CTLccccc User control data sets

Initialization Members (SPS.SPSPARM)

SPSPRINT Printer table (mandatory name)SETUPxxx Printer initialization parametersMSGSUxxx Message tableFORMxxx Form tableKEYxxx Control key data set list

Form Specific Members

DFLTffff Administrator defined formatting for form/classHSMTffff Special header, separator, message and trailer page for form/class

Where:

ccccc Installation assigned suffix to identify a control file user or usergroup

ffff Form name to which member appliesxxx Address of the printer to which the member applies

Figure 1: Parameter Data Set and Member Naming Conventions Used in SPS/MVS-APA Administrator'sGuide

It is recommended that the SPS administrator also adopt some set of naming conventionsthat makes it possible to recognize from the member name the printer associated withprinter related parameter members, and the form associated with form related parametermembers. Additionally, if control data sets are to be used, it is useful to be able to identifythe user group to which a control data set belongs from the control data set name.


U21020-J-Z247-7-7600 13

2.5 Determining Data Sets and Parameter MembersThe identifying numbers of the installation options to be installed should be determinedfrom the installation options list in "SPS/MVS-APA Usage Modes" on page 10. Thesenumbers should be used in Figure 2 to determine the data sets and parameter memberrequired.

When user control data sets are required, user groups should be identified and controldata sets allocated for each separate group. The control data sets for a group should beprotected from update by other groups with RACF or any other security product that theinstallation may have installed (please see "RACF Considerations" in the SPS/MVSInstallation Guide manual).

Form Info Control Key ControlOption Form Table Form Default Pages Data Set List Data Set

Number (FORMxxx) (DFLTffff) (HSMTffff) (KEYxxx) (SPS.CTLccccc)

1 Req Req Opt Opt -2 Opt Opt Opt Opt Opt3 Opt/Recomm Opt Opt Req Req

Figure 2: Parameter Members For the User Profiles.


14 U21020-J-Z247-7-7600

2.6 The Forms Table

2.6.1 Forms Mounts

For all user profiles it should be noted that a forms table (FORMxxx) is recommended. Theforms table not only provides names for predefined formatting options associated with aform or class name, it also is the mechanism for requesting mounts on cut sheet printers.Cut sheet printers may have up to 16 input bins (A to P) that can take a variety of formsizes and preprinted forms. A user print job will expect specific forms mounted in the inputbins. The JES mount processing only provides for the mounting of one form in a printerand does not provide a means for identifying in which input bin the form is to be mounted.Since print jobs on cut sheet printers may use up to 16 different forms concurrently theoperator must be notified which forms are to be used and in which bins. The forms tableprovides this capability.

If a forms table is not desired, the REAINUS (YES) option from the SETUPxxx membershould be specified. With this option SPS will support up to 4 real forms for mountprocessing and each two bytes from the JCL forms will be considered a different realforms.

The forms table contains a list of user form names which identify the entries in the formstable desired by the requester. Each of these entries can identify up to 16 real formnames to be mounted and their corresponding input bins. By using the forms table tocontrol mounts an advanced user can make use of up to 16 forms in a print job andautomate the mount notification of the operator.

The forms entry may have also a sysout class instead of a user forms name. In this caseno real forms specification is allowed, only the name of a forms control file.

When no entry in the forms table corresponds to a user specified JCL form name, the formname is considered to be a real form name, and will be selected from whichever bin it iscurrently mounted. If no form of the specified form name is mounted a mount request willbe issued to the operator for the form name. The default input bin will be A, but theoperator has the option to change this bin. Whichever input bin is chosen by the operatorfor mounting will be forced by SPS for input requests by any job requesting the form name.The bin number will be substituted for any bin number specified in a user or forms controlfile or formdef.

SPS also forces an input bin when the JCL forms is contained in the forms table but onlyone real forms is specified. Message SPS0925W is issued when SPS forces the use of aninput bin. With the PRINTOPT (YES) option or the FDIS command you may be alsoinformed that SPS forced the bin selection.

An advanced user of SPS data streams has the capability of selecting any input binregardless of its mount status. It is recommended that the installation require advancedusers of SPS to utilize the forms table for requesting mounts. This will help to avoid invalid


U21020-J-Z247-7-7600 15

requests by advanced users. The mount status of the input bins is always known to SPSwith or without the use of the forms table. Unless coded within the SPS data stream, SPSwill not allow a user to use a form not mounted or not requested by the job.

Continuous forms printers are considered to only have input bin A. All mount requests inthe forms table for bin A will be processed by SPS for continuous forms printers. Mountrequests for other input bins will be ignored.

For cut-sheet printers SPS obtains the number of input bins available from the printer andup to 16 input bins are supported by SPS. After mount processing, if the AFPDS datastream selects an input bin which is not available, SPS will react according to the IBINSUBparameter from SETUPxxx or control file, i.e., SPS will either use the first available inputbin (IBINSUB (YES)) or return the file to the spool as unprintable (IBINSUB (NO)).

You should note that the only moment that the operator should change the physical formsof the printer (to a different type) is when the SPS/JES setup message is pending. This isalso the moment to change in the printer panel the characteristics (length and width) of thenew forms. If the operator does not adhere to these procedures, SPS will not be able tocorrectly control the setup across files or to guarantee the accuracy of account information(via SMF) regarding the forms length.

2.6.2 Predefined Processing

SPS provides the capability of predefining print data stream processing by form or bysysout class name. Each entry in the forms table can request predefined processing byspecifying a forms control file name. Processing options may be requested by theadministrator in this forms control file such as formdef, pagedef, duplex, chars, etc.. Whenthis option is implemented users can request, by form or sysout class name in the JCL, thepredefined processing. No other AFPDS JCL parameters will be necessary. Installationpredefined processing is established in the DFLTffff member associated with the formsentry in the form table for the printer (FORMxxx). The options defined by the administratorcan be overridden by user control file requests.

2.6.3 Special Header, Separator, Message and Trailer Pages

SPS/MVS-APA provides the capability of having different specially designed informationpages used for each form entry in the forms table. When special information pages are notrequested, the default information pages from the initialization parameter member(SETUPxxx) are used. Installation defined information pages for specific forms or sysoutclasses are defined in the HSMTffff member associated with the forms entry in the formstable for the printer (FORMxxx).


16 U21020-J-Z247-7-7600

2.7 User Control Files and Control Data SetsA user control file is a member of a control data set that contains formatting andprocessing options for a print data stream. The parameters in the control file may be thecomplete specification or overrides to specifications found in a form control file, aresource, or the JCL. A form control file processing definition is basically a control file in asystem parameter library. The SPS administrator may define as many control datasets asneeded to support the user groups authorized to this mode of processing. The control datasets (SPS.CTLccccc) for the system are defined in the control key data set list member(KEYxxx) of the system parameter library (SPS.SPSPARM). The user of control files mustbe able to create and update members defining the processing desired in the control dataset assigned to that user.

A control data set is defined for a user or user group by allocating the data set and placingthe name in the control key data set list member of the SPS parameter library.Authorization to update the data set must be given to the user or user group for which thedata set is created, and denied to all others. The authorization function can be performedby RACF (please see SPS/MVS Installation Guide). New control datasets may be added atany time to the control key data set list. A new control data set will be recognized bySPS/MVS-APA as soon as the printer associated with the control key data set list isstopped and restarted. Other printers controlled by SPS, even in the same address space,require no action and are unaffected.

2.8 SPS Printer TableThe SPS printer table is a member of the SPS system parameter library (SPS.SPSPARM)that contains an entry for each printer in the installation that is supported by SPS. There isone printer table member (SPSPRINT) in an installation. The printer table entry identifiesthe JES printer name, address, initialization member (if needed), and the supported usagemodes. The printer table member must be present in the SPS system parameter library.Starting from the printer table SPS reads the initialization member if required, and themembers indicated for the supported usage modes.

The JES printer name used for sps printers should have a number between 0 and 9999.Higher numbers will cause an error message at SPS startup and SPS will imediatelyterminate.


U21020-J-Z247-7-7600 17

2.9 Initialization MemberSPS supports a number of initialization options and default settings. There is a maximumof one initialization member (SETUPxxx) for each printer. All parameters in theinitialization member have predefined defaults and are optional. Only those parametersthat are to be changed from the default values need to be coded in the initializationmember. If none of the initialization parameters are to be changed by the administratorthen the initialization member does not have to be included in the system parameterlibrary. If PRINTSET (YES) is specified in the SETUPxxx member, SPS lists, during printerstart up, all initialization options specified or defaulted. This list of options appears in thesystem hardcopy log. With the SDIS command the operator may see the value of one orall initialization options at any time during the execution of SPS.

2.10 ExitsSPS/MVS-APA provides the capability of adding installation exits for accounting, inputrecord processing, message processing, data-set allocation, direct printing, page segmentprocessing, resource read processing. For those customers with PSF, it also allows theuse of and PSF exits 1, 2, and 3; it also allows the use of a subset of functions from exit 7.These PSF modules are used in their object form. No reassembly of these exits isnecessary.

Separate message processing exits can be defined for every SPS message or one exitmay be defined for all messages. Where the function is simple, such as messagesuppression or automated response, the function can be accomplished without coding anexit. Message exits and simple message processing modifications are defined for eachmessage in the message table member (MSGSUxxx) for the printer.

All changes to exit processing are recognized by stopping and starting the printerassociated with the exit. Exits producing program checks may be automatically recoveredand disabled without terminating SPS wherever possible, if this processing is requested.For a complete discussion of exits please see Section 10.7 Message Processing Exits onpage 188.

SPS provides some sample exits which may be used to obtain specific functions like:continue printout after page segment not found conditions, print of overlays and pagesegments without a print stream, merging the data set separator page with applicationprint data into the same physical page, avoid use of FCB name as pagedef name, direct allmessages into the system console.


18 U21020-J-Z247-7-7600

2.11 Installation ExamplesThe following examples show the coding of parameter members from an initial installationto the full support of SPS functions. This coding would be done by the administrator ofSPS/MVS-APA. Corresponding examples illustrating user requests for functions can befound in "User Coding Examples" on page 84. The examples use standard page printingterms.

2.11.1 Example 1: Initial Installation

Suppose that an APA continuous forms printer (single) is being installed at address 7A1.The JES2 printer address is PRT4. The administrator has decided that this printer shouldinitially print all standard system listings that previously printed on a line printer.Additionally the administrator has decided to provide a landscape two up that will print twostandard listing pages (132 characters wide) one above the other on one physical page inthe portrait orientation (short side of physical page is top of page), and a portrait two up forprogram files (80 characters wide) that will print two vertical pages side by side on onephysical page in the landscape orientation (long side of physical page is top of page). Thetwo up formats are intended to ease storage of listings and save paper. All these formatswill print on the same continuous form (12" x 14"). The end users are unfamiliar withAFPDS JCL, and no AFPDS applications are installed.

The administrator has determined that all of the above functions can be handled by theforms table option (see "SPS/MVS-APA Usage Modes" on page 10). The administratorfinds from Figure 2 on page 13 that members FORMxxx and DFLTffff will be needed andpossibly KEYxxx. Additionally SPSPRINT is always required. The administrator decides toplace DFLTffff members in the system parameter library so KEYxxx is not needed (pleasesee "APA Printer Execution Parameters: FORMxxx" on page 69 for explanation).

The forms table will require definitions for the standard installation form name (STD) whichis selected by JES when no form name is requested, landscape two up (L2UP), portraittwo up (P2UP). All of the system output for this installation uses fixed width character sets(also known as fixed pitch). In the past, system output was always at 6 characters per inch(cpi), so the form named STD should be associated with a 6 cpi character set. Thelandscape two up is putting two 14" x 12" pages on one vertical page, so each page mustfit into a 12" wide by 7" high page. A reasonable fit can be achieved by using a 15 cpicharacter set. This makes the 132 character wide line 8.8 inches, leaving 3.2 inches formargins. The old page had 72 lines of up to 132 characters. 72 lines at 10.7 lines/inchrequires 6.73 inches print area. So a reasonable fit can be achieved with a formdefspecifying a presentation of portrait with direction across and one copy group positioningacross 1.6 inches (side margin) and down .1 inches1 (top margin). The pagedef should

1 Océ printers have no unprintable area at the top and bottom of a form.


U21020-J-Z247-7-7600 19

specify direction across with a page definition specifying a printable area of width 8.8inches (132 character line width) and a height of 13.8 inches (2 72 line pages at 10.7 linesper inch with .1 margins top and bottom and space between the pages). To handle skip tochannel 1's for both pages a channel 1 should be positioned down .1 inch with 72 linesdefined, and a second channel 1 should be defined down 6.9 inches with 72 lines defined.A formdef and pagedef must be calculated and built for P2UP in a similar manner.

For the initial installation of SPS/MVS-APA the following is required:

1. System parameter library (always required)

2. Printer table member (always required)

3. User form and predefined format members for standard system output (STD)

4. User form and predefined format members for landscape two up (L2UP)

5. User form and predefined format members for portrait two up (P2UP)

The coding of each of these members can be found in Figure 3. If the administrator is alsoresponsible for building and installing the startup procedure, this must also be done.

The relationships between the user and real forms names are very important, as theycontrol whether mount messages requiring operator reply will be issued. The user formname is the name that appears in the mount request, the real form name is the name thatSPS considers is mounted on the printer. The real form name STDW has been used toidentify 12" x 14" standard white continuous form paper. Unless special forms mounts arerequested that are not in the forms table, after initially starting the printer there will be nomount requests that the operator must reply to. If a real form name that is not in the formtable as a user form is requested it will have to be mounted as normal under JES.

SPS header and trailer pages are normally printed at the beginning and end of a JESoutput group. Separator and message pages precede and follow each print data set withinthe output group. Various JES and user options can affect the content of the output group.These options are DMNDSET and USERSET on the JES OUTDEF statement, andGROUPID in the user JCL. These options should be selected carefully to insure thatinformation pages accompanying special forms are available for the operator to identify theoutput. In general DMNDSET=NO will cause header and trailer pages to accompany aspecial form.


20 U21020-J-Z247-7-7600

SPS.SPSPARM : System parameter library in which members are located

SPSPRINT : Printer table member

PRT(PRT4) CUU(7A1) FTBL(FORM7A1)FORM7A1 : Forms table member defining 3 user form names

FORM(STD) DMBR(DFLTSTD) RFORM('STDW(A)')FORM(L2UP) DMBR(DFLTL2UP) RFORM('STDW(A)')FORM(P2UP) DMBR(DFLTP2UP) RFORM('STDW(A)')

DFLTSTD : Member defining form STD, predefined format for standard output

FORMDEF(STD)PAGEDEF(STD)CHARS(GT10)

DFLTL2UP : Member defining form L2UP predefined format for landscape two up pages

FORMDEF(L2UP)PAGEDEF(L2UP)CHARS(GT15)

DFLTP2UP : Member defining form P2UP, predefined format for portrait two up pages

FORMDEF(P2UP)PAGEDEF(P2UP)CHARS(GT15)

Figure 3: Data Set and Member Coding For Example 1: Initial Installation. Figure shows the members andparameters required for the initial installation as defined by the administrator.


U21020-J-Z247-7-7600 21

2.11.2 Example 2: Adding AFPDS applications under JCL control

Suppose now that the company has installed an AFPDS text formatting program that is tobecome the company standard. Text formatting program output is mostly self contained,meaning it contains all formatting instructions and resource requests, or resources instream in the print data set. Predefined commonly used standard documents can andshould be defined in the forms table, but these may not satisfy all user requirements.Some options such as special forms definitions, page definitions, and character sets maybe selectable in the JCL, depending on the product and user options selected. All formsdefined in the form table have predefined formatting which cannot be overridden by JCL.Any form name not in the forms table will cause a mount request. In order to provide fullAFPDS JCL control to the users the administrator defines the user form name JCL whichhas no predefined formatting, so no overriding of the JCL will take place from the formstable. By referencing the form name JCL a user can specify all AFPDS options in the JCL.

The change to support this new user requirement can be seen in Figure 4. The changemay be made while the printer is active. After the change is made the printer must bestopped and restarted to make it available to the users.


FORM7A1: Forms table member defining form name allowing AFPDS JCL specifications

...........FORM(JCL) RFORM('STDW(A)')

Figure 4: Example: Adding AFPDS Applications Under JCL control. Figure shows the addition to example 1to provide a user form name that has no predefined processing so that specifications can be made in the JCLwithout being overridden.


22 U21020-J-Z247-7-7600

2.11.3 Example 3: Adding User Control File Support

Now suppose that the users have become familiar with SPS and AFPDS processing. Thedocuments department wants to predefine their own processing, some users need to beable to override standard form definitions, and some users need to be able to overridespecifications in the resources like duplex, character sets, shifting on the page, etc. Thedocuments department and the general users need access to control files.

The administrator decides to support these requirements by providing a general usercontrol file for all users, and a special control file for the documents department. The twocontrol files must be allocated by the administrator. Control file usage must be set up asan option for the printer, and the control files must be defined to SPS. The general usercontrol file is open to all users, the documents department control file should be protectedby RACF or other product so that no unauthorized users can change or use it. Thechanges required are shown in Figure 5. These changes can be made while the printer isactive. After the changes are made the printer must be stopped and restarted to makethem available to the general users and the documents department.


SPSPRINT : Printer table member making control key processing available for the printer

PRT(PRT4) CUU(7A1) FTBL(FORM7A1) CTLKY(KEY7A1) TRIG(####)KEY7A1: Control key data set list member defining control file libraries for printer

CTLKEY(GENUSER) CTLDSN(SPS.CTLGEN)CTLKEY(DOCSDEPT) CTLDSN(SPS.CTLDOCS)

Figure 5: Data Set and Member Coding For Example 3: Adding User Control File Support. Figure showsthe changes and additions to example 1 to add user control file support and control data sets for the generaluser and the documents department.


U21020-J-Z247-7-7600 23

2.11.4 Example 4: Initialization Changes

Now suppose the administrator has coded new header, separator, and trailer pages, andan accounting exit for the installation. The new separator page names are INSTHDR,INSTSEP, and INSTTLR. The accounting exit is named INSTSMF6. The administrator hasalso decided that a dump should always be taken when message SPS0209A is issued(REPLY 'Y' TO TRY AGAIN, 'N' TO TERMINATE SPS WITH A DUMP, OR ENTER APRINTER COMMAND). Additionally the administrator wants minimal tracing with no writingof the trace records to a data set.

These changes must be made in the initialization and message exit table members of thesystem parameter library. No initialization or message exit table members are currentlycoded, as the defaults have up until now been adequate. The administrator must addprinter initialization and message exit table member names to the entry for the printer inthe printer table, and printer initialization and message exit table members containing thedesired new options to the SPS system parameter library.

The changes required by the administrator are illustrated in Figure 6. All changes may bemade while the printer is active. After the changes are made the printer must be stoppedand restarted to activate them on the printer.


SPSPRINT : Printer table member

PRT(PRT4) CUU(7A1) FTBL(FORM7A1) CTLKY(KEY7A1) TRIG(####) * SETUP(SETUP7A1) MSGSU(MSGSU7A1)

SETUP7A1: Initialization member for the printer

HDRLMOD(INSTHDR)SEPLMOD(INSTSEP)TLRLMOD(INSTTLR)SMF6EXIT(INSTSMF6)TRACELEV(1)TRACEFILE(NO)

MSGSU7A1 : Message exit table member defining automated response to messageSPS0209A

MSGID(90000209) RESP(N)

Figure 6: Data Set and Member Coding For Example 4: Initialization Changes. Figure shows the printertable changes, initialization member, and message table, to support the addition of installation header,separator and trailer pages, an accounting exit, requesting only in memory tracing, and automated response toa message.

SPS System Parameters

U21020-J-Z247-7-7600 25

3 SPS System Parameters

3.1 Parameter OverviewSPS provides a number of parameters supporting installation and user requirements.Installation related parameters are coded in parameter members SPSPRINT, SETUPxxx,KEYxxx and MSGSUxxx. User print requirement parameters are coded in FORMxxx,DFLTffff, HSMTffff, user control files, and certain defaults in SETUPxxx. Installationrelated parameters provide such information as printer addresses, buffer requirements,installed exits and message processing. User print requirement parameters provide printprocessing details such as predefined forms processing, special header, separator,message and trailer pages (information pages), user selected printing characteristics, anddefaults for most printing options when not coded.

SPS parameters are defined in the members of SPS.SPSPARM. These members areaccessed during the initialization of each printer. Every printer controlled by SPS may havea set of members in SPS.SPSPARM that define the characteristics of the printer and itsprocessing options. The parameter members read during the initialization of each printerare determined by the printer type installed and the options that are chosen by theinstallation. Most member types are optional for each printer, depending on whether thefunction controlled by the member is desired. For instance control key processing can onlybe performed for an APA printer when member KEYxxx is present. Form specificprocessing can only be defined if FORMxxx and DFLTffff are present. When two printershave the same parameters (usually the case for identical printer types) they may point tothe same member name(s) for these parameters.

When any SPS system parameter member is changed, a STOP and START of any printercontrolled by this member must be performed in order to make SPS use the changedvalues.

Most members need not be coded if the SPS parameter defaults are acceptable to theinstallation. Coding none of the optional members causes:

• Standard APA processing with no SPS defined overrides of FORMDEF or PAGEDEFspecifications possible (besides input bin for cut-sheet printers).


26 U21020-J-Z247-7-7600

• Use of default header, separator, message and trailer pages for all outputs.

• No predefined special forms printing characteristics.

• Suppression of internal processing diagnosis messages.

Initialization starts with the member name SPSPRINT (mandatory name). This membercontains the table of printers controlled by SPS. Each printer entry is identified by the JESprinter name and MVS device number. The printer entry identifies additional memberscontaining the parameters associated with that printer. The optional members that eachprinter may have are:

1. Setup member (SETUPxxx)

2. Form table member (FORMxxx)

3. Special message processing member (MSGSUxxx)

4. Control key data set list member (KEYxxx)

Additionally each form definition in the form table member (FORMxxx) for the printer maypoint to two more optional processing members for that form entry:

1. Special header, separator, message, and trailer page definitions member (HSMTffff)

2. Form control file member (DFLTffff) defining form specific processing


U21020-J-Z247-7-7600 27

Figure 7: Structure of Parameter Members in SPS.SPSPARM: Figure shows the logical structure of theparameter members with the keywords that select each member, and the physical order of reading eachfile. The member names are in bold type, the keywords appear at the entrance to each box, and thephysical order in which members are read by SPS is indicated by the number in the upper right hand cornerof each box. Keywords at the entrance to a box select the member identified in that box, and are coded inthe member identified in the box directly above in the hierarchy.

Figure 7 shows the complete parameter member structure for a single APA printer startingwith its entry in the printer table. The member naming conventions suggested in thisdocument and illustrated in the model SPSSAMP members have been used in thisdiagram and in the member descriptions below. The diagram can also be used in theevent of error to determine at which member input parameter verification terminated. Tohelp in the coding of the parameter members, a set of model members has been providedin SPS.SPSSAMP that are correctly coded for one APA printer.

The member names used in this document and for parameter members inSPS.SPSPARM are formed using the following fixed mnemonics indicating the membertype: SETUP, FORM, KEY, HSMT, and DFLT. To this base is suffixed the printer devicenumber (xxx) that the member describes, or the form name (ffff) for which the memberdefines special processing. This scheme makes it easy to identify which members areassociated with each printer or form. The actual member names that an installation selects


28 U21020-J-Z247-7-7600

are arbitrary, but it is suggested that some identifying naming conventions be used,because a great many member names may be required when an installation has severalSPS controlled printers that take advantage of the optional processing definitions. Themember used for a given printer can always be determined by examining the printer entryin the printer table (SPSPRINT), and the form member to which this entry points.

3.2 SPS Minimum Requirements in SPS.SPSPARMSPS has a set of defaults predefined that are appropriate to most installations. SPS willassume these defaults when either a parameter is not coded or a parameter member isnot present. When these defaults are acceptable to an installation, most parametermembers for an APA printer need not be coded. Using all the defaults possible, it will onlybe necessary to code an SPSPRINT table for an APA printer.

In order to take advantage of enhanced processing options available in SPS, memberKEYxxx must be coded for an APA printer. Predefined processing by form name requiresmembers FORMxxx and DFLTffff. Special message processing requires an MSGSUxxxmember. Alternate initialization parameters require SETUPxxx.


U21020-J-Z247-7-7600 29

3.3 SPSPARM Member DescriptionsThe following parameter members are currently supported:

Member Description

SPSPRINT This member name must be present in the SPS.SPSPARM library for anAPA printer. It contains the printer table defining all printers controlled bySPS procedures. A printer's entry in this table contains the JES name forthe printer, printer I/O device number, and trigger (for control fileprocessing support), and is the starting point for determining a printer'sparameters. This member points to the following parameter definitionmembers using the corresponding key word parameters:

Key Word Member Function

FTBL Form table (see member FORMxxx below)

SETUP Processing parameters (see member SETUPxxx below)

MSGSU Special message processing (see member MSGSUxxxbelow)

CTLKY Control key table (see member KEYxxx below)

SETUPxxx This member contains parameters controlling the printer execution options.It is optional for APA printers. All parameters have defaults if not specified.The execution options that are controlled by this member are:

1. Printer driver specification

2. Buffer control

3. Information pages

4. Message printing options

5. Installation exits

6. Trace processing and monitoring

7. Termination options and appendages

8. JES operator command character

9. APA resource library ddnames and defaults

10. APA print control defaults (font, undefined characters)

11. Double byte font options

12. 3800-3 conversion options

13. Direct print options


30 U21020-J-Z247-7-7600

14. Network printer options

15. NPRO options

16. Forms table modes

FORMxxx This member specifies the forms table. The forms table contains thedefinitions of forms or output classes selected by the installation forpredefined processing options on the printer. The forms specified mayinclude both the standard form and special forms requested by form name.The output classes may include any valid JES sysout class. This memberis optional for an APA printer. When FORMxxx is not present, defaultsfrom the SETUPxxx member or SPS system defaults will be used for allforms when the user has not specified a parameter either in his JCL orcontrol file. Optionally this member points to the following parameterdefinition members using the corresponding key word parameters:

Key Word Member Function

MOD Special information pages (see member HSMTffff below)

DMBR Forms control file member (see member DFLTffff below)

MSGSUxxx This member specifies the message table. The message table contains alist of all messages which require special processing. Some processingcan be specified directly in the member. For more complex requirements,it can request that an exit be given control. Please see "APA MessageTable: MSGSUxxx" on page 76 for a full discussion of the message table.This member is optional for an APA printer. This member is only usedwhen MSGSP (YES) is specified (or defaulted) in SETUPxxx.

KEYxxx This member specifies the control key data set list. It contains a table ofcontrol keys to be recognized by the printer driver, with the correspondingdata set names to be used to find control file members which requestspecial processing (see "Control File Processing" on page 79 for adescription of this processing). This member is optional for an APA printer.

HSMTffff This member contains the names of header, separator, message, andtrailer pages that are to be used for a particular form or sysout class in theform table. These information pages, when present, override the defaultspecifications in SETUPxxx for the printer. This member is optional for anAPA printer.

DFLTffff This member is the forms control file. A forms control file contains the printjob characteristics for a particular form or sysout class listed in the formtable. These values will be used if the user does not specify a user controlfile in his JCL or does not specify a parameter in a user control file selectedby the JCL. This member is optional for an APA printer.


U21020-J-Z247-7-7600 31

3.4 SPS Initialization Parameter DescriptionsThe description and syntax for all APA printer related installation parameters can be foundin "APA System Parameter Descriptions" on page 33. The sample control statementsfound in the boxes preceding the parameter description lists in these chapters have beencoded in the suggest order for the parameters. This organization keeps associatedparameters together, simplifying coding and maintenance of the parameter members. Theactual parameter descriptions are in alphabetical order by parameter for ease of reference.

3.5 Control Statement Format and Parameter SyntaxEach member is a collection of one or more control statements related to a printer or form.Each control statement contains one or more parameters defining some facet of theprocessing. A control statement is coded in positions 1-71 of the records in the parametermembers with any non-blank character in 72 indicating continuation to the next record. Acontrol statement may be a maximum of 10 records long (9 continuation records). Blanklines may appear anywhere between the control statements. Comments may be placedanywhere on or between the control statements except in the middle of a key wordparameter. This includes starting on one record of a control statement and ending on anyfollowing record in the control statement. A comment on a control statement withoutparameters is valid and is processed as a null control statement. Comments areintroduced by '/*' and terminated with '*/'. The only restriction on the contents of a commentis that a comment terminator (*/) should not be used as text within the comment. Pleaserefer to Figure 8 for allowable syntax examples.

All parameters are keywords. Their general format is KEYWORD(value1,...,valuen).Keyword values must be enclosed by parentheses. Multiple keyword values must beseparated by commas. Blanks will be taken as part of the value if present. This meanskeyword parameters interrupted by a continuation to the next record must be codedthrough column 71 and begin in column 1 of the next record to avoid unwanted blanks.Keyword parameters may be coded in any order on the control statement, however theorder suggested in the parameter descriptions will help to avoid errors and simplifymaintenance.

A keyword should not be coded more than once in a member unless specifically allowed.


32 U21020-J-Z247-7-7600

1 COLUMNS 72

/* This example illustrates all the rules for statements and *//* keywords. The entire example is valid syntax from the blank *//* line above this comment to the blank line following the end *//* of example comment. This comment is 5 null control statements *//* of 1 line each */

/* Statement 1 */ KEYWORD1(value1,...,valuen) /* Possible comment */C KEYWORD2(value1,...,valuen) /* Possible comment */C KEYWORDn(value1,...,valuen) /* Possible comment */

/* The following statement illustrates key word continuation C situations that are allowed. This comment is 1 null control C statement of 3 lines */

/* Statement 2 */ KEYWORD1(value1,...,valuen) KEYWORCD2(value1,...,valuen) /* Possible comment */ KEYWORDN(valCue1,...,valuen) /* Possible comment */

/* The following statement illustrates comment continuation *//* situations. This comment is 1 null control statement of 1 line C and 1 null control statement of 2 lines */

/* Statement 3 */KEYWORD1(value1,...,valuen)/* Possible continued C comment */ KEYWORD2(value1,...,valuen) /C* Possible continued comment */ KEYWORDn(value1,...,valuen)

/* End of Statement Syntax Example */

Figure 8: Statement Syntax Examples.

APA System Parameter Descriptions

U21020-J-Z247-7-7600 33

4 APA System Parameter Descriptions

This chapter contains the syntax and parameter descriptions for all system parametersavailable to APA printers. All parameters have not defaults with the exception ofTCPNAME and PORT in the SPSPRINT member. The defaults are underlined in thecontrol statement formats, and will be taken when a keyword is not coded.

4.1 Coding the APA SPSPARM MembersThere are two approaches to coding the SPSPARM members: Quick Install and FullyCoded Members. Both methods are supported by model members in SPS.SPSSAMP.

The Quick Install approach is useful to get SPS up and running with the least knowledgeof SPS parameters required. It relies on all the SPS predefined defaults. The SETUPoptions may be examined online via the SDIS command to determine which parameteroptions have been selected. Changing options always requires consulting thedocumentation.

The Fully Coded Members approach assumes no defaults. Each member has all theparameters coded in the member. This makes it easy to determine and modify the valuesof current parameters online. Models have been coded for all possible members for APAprinters. These models may be found in SPS.SPSSAMP.

For both the Quick Install and the Fully Coded Members methods, the simplest way todefine the SPS parameter members that will be required is to code one printer at a timestarting with its entry in the SPSPRINT member, and then coding each member pointed toby the parameters, until all members for the printer are coded. Please refer to Figure 7 onpage 27 for the member structure defining a printer.

4.1.1 Quick Install

These installation instructions only support the SPS basic environment for channelattached printers. The intent of "Quick Install" is to provide a running SPS/MVS-APAsystem that can be used to gain experience with the product with the least possibleknowledge of the parameters and parameter members. After a little experience with the


34 U21020-J-Z247-7-7600

product is acquired the administrator can add the options that will be necessary for theproduction environment. These options should be added by following the proceduresunder "Fully Coded Members".

The following is a step by step procedure for coding the SPS parameter members by thequick install approach:

1. Build an entry in the printer table (SPSPRINT in SPS.SPSPARM) for the printer beingdefined by filling out PRT( ) and depending how the printers are attached thecorresponding parameters.

2. Remove all other parameters on the printer statement, including the statementcontinuation character. This will cause all SPS parameters to use defaults.

4.1.2 Fully Coded Members

This method relies on the model SPS parameter members that are supplied with SPS inSPS.SPSSAMP. These members contain all the parameters supported in each member,fully coded with the supplied defaults and explanatory comments. All model membersending in XXX and FFFF are for APA printers. For a full description of the parametermembers and structure please refer to "SPS System Parameters" on page 25.

The following is a step by step procedure for filling out the parameter members:

1. Build an entry in the printer table (SPSPRINT in SPS.SPSPARM) for the printer beingdefined and fill out the optional parameters. The parameters SETUP( ), FTBL( ),MSGSU( ), and CTLKY( ) identify other members in SPS.SPSPARM that will be usedfor this printer.

2. Assign the suffix of the other SPS.SPSPARM members according to the names givenin the changed SPSPRINT printer definition. Use the prototypes from SPS.SPSSAMPto create these new members.

3. Change the printer options in the SETUPxxx member as desired.

If form names or output classes with predefined special processing options are to bedefined (forms control files):

4. Define the forms and output classes that are to be supported on the printer withpredefined processing options in the FORMxxx member. Modify the model FORMXXXmember of SPS.SPSSAMP. Place this new member in SPS.SPSPARM. The optionalparameters MOD( ) and DMBR( ) identify other members in SPS.SPSPARM that maybe needed for a form or output class. See items 5.) and 6.) below.

5. For each form or output class that requires special header, separator, message, ortrailer page(s) (MOD coded in form table), use the model HSMTFFFF member from theSPS.SPSSAMP, where ffff should be changed to a 1 to 4 character form name oroutput class identifier, and fill in the special header, separator, message, or trailer page


U21020-J-Z247-7-7600 35

load module names to be used for the form or output class. Create your new memberis SPS.SPSPARM.

6. For each form or output class that requires special predefined print characteristics,change the model member DFLTFFFF from SPS.SPSSAMP to create DFLTffff inSPS.SPSPARM, where ffff should be the form name selected or an output classidentifier in FORMxxx. Define the APA print characteristics for the form or output classin DFLTffff.

If this printer is to use user control files

7. Define the trigger value that will activate this function. The trigger is defined in theuser‘s JCL via the MODIFY= parameter. See “5 [textmarke ctlproc]Control FileProcessing“ on page 79 for further explanation of this facility.

8. Define the control keys and control data sets for the printer in the KEYxxx member.

If special message processing is desired for the printer (MSGSU coded in SPSPRINTmember):

9. Define the special message processing in MSGSUxxx. The sample MSGSUxxx inSPS.SPSSAMP contains examples of message processing options for APA printers ascomments.

The above procedure should be repeated for each APA printer to be defined as an SPScontrolled printer in the installation. When any parameter member would be identical to aprevious printer parameter member, the member name of the previous printer parametermember may be referenced instead of coding a new member.


36 U21020-J-Z247-7-7600

4.2 APA Printer Table: SPSPRINT

4.2.1 SPSPRINT APA Control Statement Format

PRT(prtname) /*Required for all printers*/ C CUU(xxx[x][,zww[w]]|LIP|MD2|APA) /*Required for local printers*/ C APPLID (applname) LUNAME (luname) /*Required for network printers*/ C NETID (netname) LOGMODE (modname) /*Optional for network printers*/ C SETUP(SETUPxxx) FTBL(FORMxxx) MSGSU(MSGSUxxx) /*Optional*/ C TRIG(tttt) CTLKY(KEYxxx) /*Optional*/

TCPNAME(TCPNAME|TCPIP) /*Required for network printers*/ C PORT(XXXX|5001) /*Required for network printers*/ C HOSTNAME(HOSTNAME) /*Optional for network printers*/ C IPADDR(AAA,BBB,CCC,DDD) /*Optional for network printers*/ C

Figure 9: Format of APA SPSPRINT Member Control Statement

4.2.2 SPSPRINT APA Key Word Descriptions

Key Word Parameter Description

APPLID (applname)

This parameter must be coded for a network attached printer.The applname must be defined as an APPL entry in a VBUILDTYPE=APPL member in the VTAM definitions. SPS uses this name toopen the VTAM ACB. Please see "Printing on Network Printers" on page125 for more information.

CTLKY (KEYxxx)

Name of a member containing the control key data set list for the printerbeing defined. The control key data set list is a list of control files and thecorresponding keys that select them. The keys are entered by the user inhis JCL along with the trigger for the printer (see TRIG key word) toindicate user control file processing. The data set corresponding to the keyin the control key data set list is then used to select print processingparameters for the user's print job (please see "Control File Processing"on page 79 for a description of this processing). This parameter is optionalfor APA printers, no default is defined. When TRIG is specified CTLKYmust be specified.

CUU (xxx[x] [,zww[w]] | LIP | MD2 | APA)


U21020-J-Z247-7-7600 37

The device number(s) of the printer being defined. The device number isthe number specified in the ADDRESS=device-number parameter of theIODEVICE macro statement in the MVS Configuration Program run orIOCP generation for the system. You may specify 3 or 4 hexadecimal digitsas device number. If you specify 4 digits your MVS system should supportit. If you specify 3 digits SPS assumes the leftmost digit is 0. For a

single printer only xxx[x] is specified, for a twin printer zww[w] is theaddress of the second printer and identifies the printer as a twin printer. Ifyou specify LIP, MD2 or APA SPS assumes he is driving a dummy printerfrom the specified device type. In this case no physical printer is allocatedby SPS. Such specification works only when using the SPS PSORTfunction (CUU(LIP)) or SPS is installed together with any other product thatassumes the driving functions for this dummy printer in conjunction withSPS. The load module name of this product should be specified in theDRIVER parameter from the SETUPxxx SPSPARM member (SPSSSORTfor the PSORT function). Please see the PSORT User´s Guide manual orthe specific product documentation for more information about thisfunction. Required parameter for local or dummy printers. This parametershould not be specified for network printers. No default is defined.

FTBL (FORMxxx)

Name of a member in SPS.SPSPARM that contains the forms table for theprinter being defined. The forms table defines the print characteristics (viaforms control files) and real forms info of all forms or sysout classes to beprinted on the printer for which the installation wants special or formsspecific processing. This parameter is optional for all printer types, nodefault is defined.

HOSTNAME (HOSTNAME)

The domain name of a host, which is defined to the network for aspecial printing system. SPS/MVS-APA uses the API macroGETHOSTBYNAME in order to get the corresponding IP address.TCP/IP tries to resolve the hostname through a name server, if one ispresent. If a name server is not present, the system searches forHOSTS.SITEINFO data set until a matching host name is found.Please refer to the IP Configuration Guide for detailed information.

IPADDR (AAA,BBB,CCC,DDD)


38 U21020-J-Z247-7-7600

The address which is defined to the network for a special printing systemfor example (IPADDR = Internet Protocol Address). Instead of specifying aHOSTNAME you can specify an IPADDR .


U21020-J-Z247-7-7600 39

LOGMODE (modname)

LOGMODE is a required parameter for network printers.The modname specifies an entry in a LOGMODE table in the VTAMdefinitions. This parameter overwrites the default specified in the VTAMdefinitions for the PU and the LU. Please see "Printing on NetworkPrinters" on page 125 for more information.

LUNAME (luname)

This parameter must be coded for a network attached printer.The luname is the logical unit name in an SNA network to which the printeris attached. In an OS/2 - PSF/2 environment this name must be defined asa local LU to the communication manager. For SIEPRIS APA orPRISMA/APA you should define the LUNAME for the server software. ForLU 1 printers this name is specified only in VTAM. Please see "Printing onNetwork Printers" on page 125 for more information. If you specify theluname as **SIM** SPS simulates an SNA printer with 300 dpi. This maybe useful for testing purposes.

MSGSU (MSGSUxxx)

Name of a member containing the message table for the printer beingdefined. This table identifies messages with special processing for theprinter. This parameter is optional for all printer types, no default is defined.The MSGSUxxx member is only used if MSGSP (YES) is specified ordefaulted in the SETUPxxx member.

NETID (netname)

NETID is an optional parameter for network printers.The netname specifies the network that contains this logical unit. If notspecified the local network is assumed. Please see "Printing on NetworkPrinters" on page 125 for more information.

PORT (XXXX|5001)

Port-Number according to the printer type. For IPDS-TCP/IP printer thedefault port is 5001.

PRT (prtname)

For JES controlled printers the JES name for the printer being defined.This name is used by the operator to issue JES commands to the printer.For JES2, this parameter is always of the form PRTn, where n correspondsto the 'n' from PRT(n) in the JES2 parameter member. For JES3, the entireparameter is the JNAME on the device statement in the JES3 initializationdeck.


40 U21020-J-Z247-7-7600

For direct printing printers that are also to be controlled by JES, the JESprinter table entry can be used for both JES and direct printing modes. Ifadditional or separate entries for a direct printer are desired any name maybe chosen that is 2 to 8 characters, where the first character is alphabeticand the last is numeric. For more information about direct printing pleasesee "7.2 How is SPS Direct Printing Made Available" on page 109.

This parameter is required for all printer types, no default is defined.

SETUP (SETUPxxx)

Name of a member in SPS.SPSPARM containing the initializationparameters for the printer being defined. When not included the defaultsfor all parameters contained in the SETUP member will be used. Thisparameter is optional for all printer types, no default is defined.

TCPNAME (TCPNAME)

Name of the TCP/IP procedure in the operating system. The default nameis TCPIP.

TRIG (tttt)

A four character alphanumeric value used as a trigger for the printer beingdefined. This value when matched by a corresponding value specified by auser in his JCL, causes user control file processing (please see "ControlFile Processing" on page 79 for a description of control file processing).This parameter is optional for APA printers, no default is defined. WhenCTLKY is specified TRIG must be specified.


U21020-J-Z247-7-7600 41

4.3 APA Printer Execution Parameters: SETUPxxx

4.3.1 SETUPxxx APA Control Statement Format

The format of the SETUPxxx member for APA printers is:

Printer Driver SpecificationDRIVER (driver-name|SPSSSORT|SPSPAPA2)

Buffer ControlNUMCCWB (number-of-ccw-buffers | 2)NUMIDAB (number-of-ida-buffers | 3)STAQINT (hundredth-of-second | 0)PDSBUF# (number-of-buffers | 6)PDSBUFL (buffer-length | 24576)RDSBUF# (number-of-buffers | 6)RDSBUFL (buffer-length | 12288)OUTBUF# (number-of-buffers | 6)OUTBUFL (buffer-length | 8192)NDFBUFL (twin-printer-resident-buffer | 8388608[,FIX | ,NOFIX])

Information PagesHDRLMOD (lmod-name | SPSMHDRA)SEPLMOD (lmod-name | SPSMSEPA)MSGLMOD (lmod-name | SPSMMSGA)TLRLMOD (lmod-name | SPSMTLRA)INFOERR (CONT | ABEND)

Message and Command Processing OptionsNOTIFY (node1.user1, node2.user2, node3.user3,node4.user4)CMDIF (WTOR | MODIFY)PIMSG (YES | NO [ ,CANCEL | ,HOLD])MSGLIM (msg-limit | 100)MSGSP (YES | NO)TWINMSGS (NPRO | NONPRO)SPOOLMSG (YES | NO)PRINTOPT (YES | NO)PRINTSET (YES | NO)


42 U21020-J-Z247-7-7600

Installation ExitsRECEXIT (exit-name)SMF6EXIT (exit-name)MSGEXDP (exit-name)DSALEXIT (exit-name)PSFX01 (exit-name)PSFX02 (exit-name)PSFX03 (exit-name)PSFX07 (exit-name)PSFBTBL (table-name)RDSREXIT (exit-name)PSEGEXIT (exit-name)

Trace Control and MonitoringTRACELEV (0 | 1 | 2 | 3 | 4)TRACETYPE ([INITERM] [,REQFLOW] [,DISPAT] [,INVRET] C [,PDS] [,RDS] [,ORDER] [,PS] [,CCW] [,VTAM] | ALL)TRACESET (hex-pair-string |FF,FF,FF,FF,FF,FF,FF,FF)TRACEFILE (USER | NO )RESLIST (YES | NO)PSSTOMGT (NO | YES)NOTRDMO (YES | NO)

Abnormal Termination Options and AppendagesPRTERROR (HONOR | NOTHONOR)DUMP (YES | NO)ABENDAPG (suffix | WM)SIOAPG(suffix | WS)

JES Operator Command CharacterCMDCHAR (jes-command-prefix | $ | *)

Resource Library DDNAMESFDEFDD (formdef-lib-dd | FORMDEF)PDEFDD (pagedef-lib-dd | PAGEDEF)PSEGDD (pageseg-lib-dd | PAGESEG)OVLYDD (overlay-lib-dd | OVERLAY)FONTDD (font-lib-dd | FONT)OBJCONDD (object-container-dd | OBJCON)


U21020-J-Z247-7-7600 43

Print Control DefaultsCHARS (charset1 [,charset2] [,charset3] [,charset4]| GT10)DATACK ([BLKCHAR] [,BLKPOS])FORMDEF (formdef-name | 0101 | 0101LA)PAGEDEF (pagedef-name | V06483 | STD3)ETFF (YES | NO)ETFH (YES | NO)PRTNUFON (number-of-fonts | NOLIMIT | 0)PRTNUOVE (number-of-overlays | NOLIMIT | 0)PRTNUPSE (number-of-psegs | NOLIMIT | 0)LUPUB (l-units-per-ubase | 0)FPRUN (YES | SINGLE | DOUBLE | NO)WRONLY ([FONT]]]] [[[[,PSEG]]]] [[[[,OVLY]]]] [[[[,FDEF]]]] [[[[,PDEF]]]] [[[[,HWFEAT] [,RESCONF]]]] | YES | NO)IBINSUB (YES | NO)FLIP (YES | NO)INLIOPT (YES | NO)COLORMAP (colormap-name)

Double Byte Font OptionsENDBCS (YES | NO )

3800-3 Conversion OptionsCOMP38MO (YES | NO)

Direct Print OptionsSETUPDP (YES | NO)HDRDP ([YES | NO] [,MARK | NOMARK])

Network Print OptionsRELMODE (IDLE | TIME | NONE)RELINTV (member-of-seconds | 0)DISCINTV (number-of-seconds | 0)TIMEOUT (STOP | REDRIVE)ACQINTV (number-of-seconds | 0)MGMTMODE (IMMED | DIALIN | OUTAVAIL)FAILURE (STOP | WCONNECT)CONNINTV (number-of-seconds | 0)REMSETUP (YES | NO)NUMACKR (0-99)RESPTIME (number-of-seconds | 60)NORESP (Operator | Terminate)QUEINTV (number-of-seconds | 60)QUETMOUT (number-of-seconds | 15)

NPRO optionsANPRO (num-add-sheets | 0)

Forms Table ModesREAINUS (YES | NO)


44 U21020-J-Z247-7-7600

Figure 10: Format of the SETUPxxx Member Control Statement for APA Printers: In the figure all keywordsare optional and each control statement is only one keyword. Keywords not coded will use defaults.

4.3.2 SETUPxxx APA Key Word Descriptions

The parameters specified in this member determine the initialization options. Allparameters are optional and have defaults defined tailored to APA printers. The modelmember SETUPxxx contains a full list of the parameters coded with the defaults that aresupplied for APA printers. They print the model header, separator, message, and trailerpages appropriate to the printer, and select proper initial performance options. The bufferrelated parameters can have an effect on the performance of the printers and thereforeshould be tuned to suit installation requirements after some experience with the printer'sperformance in the installation has been gained and if performance problems are noted.See SPS/MVS Installation Guide for a discussion of buffer parameters and performancetuning.

You may use the SPS SDIS command or the PRINTSET SETUPxxx option to obtain a listof all options specifiable in the SETUPxxx member and its corresponding source (SETUPor default).


ABENDAPG (suffix)

The suffix for the abnormal end appendage module. This suffix should bechanged when an installation has an appendage routine defined with aname other than IGG019WM. WM is the default suffix for APA printerswhen ABENDAPG is not specified. When this suffix is changed the SMPinstallation JCLIN must also be modified to match the new suffix. Pleasesee SPS/MVS Installation Guide for modifications required in the SMPapply.

ACQINTV (number-of-seconds)

Valid for network printers only.

Valid only when relmode=time and timeout=redrive specified. Interval thatshould expire after SPS has released the printer before SPS may try toreallocate the printer LU session. SPS will allocate the printer session inaccordance with the mgmtmode parameter.

0 - SPS will not wait between releasing and reallocating theprinter session. This is the default value.

1-86400 - interval in seconds, between release and reallocation of theprint session.


U21020-J-Z247-7-7600 45

ANPRO (number-of-additional-sheets)

A value between 0 and 999 which specifies the number of additionalsheets that SPS should take into consideration when executing a softwaredriven NPRO. The default is 0. When 0 is specified SPS puts the whole fileinto the stacker when executing an NPRO function. If a post-processingmachine is being used some additional pages may be necessary in orderto pass the whole file through the post processing machine. The number ofthese additional sheets is specified via this parameter.

CHARS (charset1 [[[[,charset2]]]] [[[[,charset3]]]] [[[[,charset4]]]])

A list of 1 to 4 default CHARS. Each character set name may have 1 to 6bytes. The default CHARS are used when none is supplied by the user inthe DD card for a print data set and JES does not supply one from the JESinitialization parameters (UCS=0 for JES2 printers). It is used in allsituations where no CHARS name is available and one is needed. WhenCHARS is not specified, GT10 is the default. This parameter is alwaysused for information pages when CHARS is not coded in the IPAGINFOmacro.

Note: CHARS interacts with JES initialization parameters. For a fulldiscussion of this interaction please see SPS/MVS Installation Guide.

CMDCHAR (jes-command-prefix)

The character used to prefix a JES operator command. Used by SPS whenissuing a start printer command to JES. $ is the default for JES2, * forJES3. A blank is not allowed.

CMDIF (WTOR | MODIFY)

Specifies the kind of interface that should be used for SPS commands (notJES commands). If WTOR is specified the printer subtask will issue amessage with reply (WTOR) - message SPS0260A - just after initialization.To enter commands to this printer the operator just answer the messagewith the desired command. There will be one pending message per printer.

If MODIFY is specified any SPS command should be issued via the MVSModify (F) command. The JES printer name should then precede thecommand itself because the SPS main task receives the commands for allits subtasks (printers).

See chapter 9 "SPS commands" for an explanation on all SPS commandsavailable.

The default for this parameter is MODIFY, but for direct printing, SPSalways forces the WTOR option, regardless of what is requested by thisparameter.


46 U21020-J-Z247-7-7600

COMP38MO (YES | NO)

Default for the COMP38MO option if not specified in a control file. Controlsthe setting of the media origin. The default is NO.

NO The media origin will be set according to the rules definedfor AFP1 type (IPDS) printers.

YES If a FORMDEF is used which has no presentationparameter, the media origin will be set according to therules valid for 3800 model 3 page printers.

COLORMAP (colormap-name)

Specifies the default COLORMAP name that will be used for this printersession when no colormap is specified in the JCL.

There is no default for this parameter, when not specified a hardwarecolormap reset is performed.

CONNINTV (number-of-seconds)

Valid for network printers only. Valid for any relmode whenfailure=wconnect specified.

Interval in seconds waited by SPS if VTAM can not establish the LUsession between SPS and the printer. The default is 0.

0 SPS will wait for an unlimited period of time.

1-86400 Interval in seconds waited by SPS. If this interval expiresbefore the session is established SPS terminates the JESprinter session.

DATACK ([BLKCHAR] [,BLKPOS])

Selects the default for how data checks are to be handled for invalidcharacters, and print requests which lie outside the valid printable area,when not specified in the JCL or a control file. Any or all of the options maybe selected. When this parameter is not coded data checks will not beblocked unless specified in the JCL or a control file.

BLKCHAR Undefined character data checks should be suppressed.Please note that you may also block undefined charactersin the font used.

BLKPOS Print checks due to printing in locations outside the validprintable area should be suppressed.


U21020-J-Z247-7-7600 47

DISCINTV (number-of-seconds)

Valid for network printers only. Valid only for relmode=none. Interval thatshould expire after SPS has nothing to print in order to release the printer.SPS will release the printer independent if a request to use it was made byanother VTAM application. The default value is 0.

0 SPS will never release the printer (for relmode=none).

1-86400 Interval in seconds (counted since SPS detects that it hasnothing more to print) that SPS will wait before releasingthe printer.

DRIVER (driver-name | SPSSSORT | SPSPAPA2)

Specifies the load module name of the print server which will drive theprinter. The default is SPSPAPA2, which is the printer driver for APAprinters. When a dummy printer is defined for the SPS PSORT facility(CUU(LIP) in the SPSPRINT table) the driver SPSSSORT should be used(see PSORT User´s Guide).

DSALEXIT (exit-name)

Specifies the name of the data-set allocation exit. This exit receives controleach time SPS obtains a new output file to be printed and it may purge orhold the file or change its processing characteristics (like FORMDEF,PAGEDEF, etc...). Please see "Data-set Allocation Exit" on page 193 forexit coding considerations. The default is no exit specified.

DUMP (YES | NO)

Determines whether a dump will be taken or suppressed before a retry isattempted after an abend. This option should be specified as YES unlessthere is a special circumstance that requires the suppression of dumps.YES is the default for APA printers when DUMP is not specified.

YES Generate a dump before a retry is attempted after anabend.

NO Suppress dump generation before retries are attempted.

ENDBCS (YES | NO)

Default for the ENDBCS option, if not specified in a control file. Controlsthe activation of the enhanced SOSI feature of SPS. The default its NO.

NO SPS processes the SOSI bytes in a PSF compatible way,i.e. you may specify only 2 fonts, the first should be a singlebyte font and the second a double byte font. The SOSIbytes may be used to switch from font one to font two andvice versa.


48 U21020-J-Z247-7-7600

YES With this option an enhanced SOSI processing is supportedby SPS. In this mode you may specify as many single anddouble byte font pairs as you want. Each pair should havefirst a single byte font and following it a double byte font.For example, a valid CHARS would be:

CHARS=(SIN1,DOB1,SIN2,DOB2,SIN3,DOB3)

You may switch between each pair via TRC controlcharacters, but you must always specify the TRCcorresponding to a single byte font. After "landing" in thesingle byte font from a pair you may switch to itscorresponding double byte font via the SHIFT-OUT byte,and return to the single byte font via the SHIFT-IN byte.

When you specify ENDBCS(YES) you have the followingrestriction:

If you use DBCS specified in the PAGEDEF you may nothave SOSI bytes in your DATA-STREAM and you may notspecify the PRMODE=SOSIx parameter in the JCL.

ETFF (YES | NO)

Eject to front facing sheet option for fanfold printers. The default value isNO.

YES SPS will issue an 'eject to front facing sheet' before eachBDT structured field found in the input data or anyinformation page, if the printer supports the eject to frontfacing sheet command.

NO SPS will not issue EFFS commands for BDT SF.

ETFH (YES | NO)

Eject to front facing sheet option for fanfold printers for header pages only.The default value is NO.

YES SPS will issue an 'eject to front facing sheet' before writingthe header page, if the printer supports the eject to frontfacing sheet command.

NO SPS will not issue an 'eject to front facing sheet' beforewriting the header page.

FAILURE (STOP | WCONNECT)

Valid for network printers only. Valid for any relmode. Action done by SPSwhen the printer LU session cannot be reallocated when SPS requests it(printer is used by another VTAM application or printer LU is inactive).


U21020-J-Z247-7-7600 49

WCONNECT SPS will wait until VTAM indicates that the printer isavailable according to the connintv interval (Default).

STOP SPS will stop the JES printer session.

FDEFDD (formdef-lib-dd)

Ddname of the form definition library to be used for page printers.FORMDEF is the default ddname when FDEFDD is not specified.

FLIP (YES | NO)

Default for the flip option, if not specified in a control file. Valid forA-Twins only. The default is NO. Exchange of the output from printer 1(front pages) with printer 2 (back pages).

NO Do not exchange.

YES Exchange it.

FONTDD (font-lib-dd)

Ddname of the font library to be used for APA printers. FONT is the defaultddname when FONTDD is not specified.

FORMDEF (formdef-name)

1 to 6 character name of the default form definition to be used when noform definition has been specified by the user in the JCL. This name is thesame name that the user would specify in the JCL keywordFORMDEF=formdef-name. When not specified the default FORMDEF forcut-sheet printers is 0101 and for fan-folded printers is 0101LA. Thisparameter is always used for information pages when FORMDEF is notcoded in the IPAGINFO macro.

FPRUN (YES | SINGLE | DOUBLE | NO)

Default for the font pruning function, if not specified in a control file. Whenfont pruning is requested SPS loads on the printer only the charactersdefined in the code page (and not all characters defined in the fontcharacter set). The default is NO.

NO SPS should not make font pruning.

YES SPS should make font pruning for single and double bytefonts.

SINGLE SPS should make font pruning for single byte fonts only.

DOUBLE SPS should make font pruning for double byte fonts only.


50 U21020-J-Z247-7-7600

HDRLMOD (lmod-name)

Name of the job header page load module to be used when no otherheader page has been selected through the resolution of a print job'sparameters. Special job header pages can be selected for any form orsysout class in the form table using the MOD parameter. An APA modelheader page is supplied with the SPS product. The APA model headerpage is named SPSMHDRA. Both the source and load module for the APAheader page are supplied with SPS in SPS.SPSSAMP and SPS.SPSLINK.Please see "Information Page Suppression" on page 119 for how tosuppress header pages. The default for APA printers is SPSMHDRA.

HDRDP ([YES | NO] [,MARK | NOMARK])

Controls header and trailer processing in direct printing. Headers andtrailer pages may be included or suppressed, when included they may usethe mark forms option or not.

Header/trailer page generation options:

YES Generate a header page each time a printer is opened anda trailer page each time it is closed. This is the default whennot specified.

NO Suppress header and trailer pages for the print datastreams on this printer.

Header/trailer mark forms options:

MARK Mark the form after each trailer page generated on theprinter. This is the default when not specified.

NOMARK Do not mark the forms after trailer page generation.

IBINSUB (YES | NO)

Default for the input bin substitution function, if not specified in a controlfile. The default value for this parameter is NO.

NO When a desired input bin is not available on a cut-sheetprinter SPS will terminate the printout of the output file.

YES When a desired input bin is not available on a cut-sheetprinter SPS will use the first available input bin instead ofthe desired one.


U21020-J-Z247-7-7600 51

INFOERR (CONT | ABEND)

Specifies the SPS action after an error while trying to load (invalid linkageoption, I/O error, lmod not found, etc.) or build an information page loadmodule (not enough space for a variable or block letter building, etc.). IfABEND is specified SPS will issue a diagnostic message and abend afterthese kind of errors, in order to avoid the risk of incorrect printout. If CONTis specified SPS will issue a diagnostic message and print this message inplace of the information page in error. This diagnostic message is printedwith the printing options of the print file (formdef, chars, pagedef, etc.). Thedefault is ABEND. The CONT processing is compatible to SPS 3.2 andprevious versions.

INLIOPT (YES | NO)

Inline resources optimization

YES SPS should optimize the processing of inline resources. Thisoption is required in order to process inline resources otherthan formdefs and pagedefs in direct printing mode. Fordeferred mode this option optimizes the performance of printjobs which have a lot of references to inline resources.

This option requires more region storage as all inline resourcesare mantained in storage during the printout of a file (above theline).

NO No optimization for inline resources is done (default).

LUPUB (L-units-per-ubase)

Number of L-units per unit base supported by the printer for a unit base of10 inches.

A value of 0 or 1 to 32767 may be specified. The default is 0.

0 SPS will use any value specified in the AFPDS data streamand will send it unchanged to the printer.

1-32767 SPS will convert the L-units per unit base from the inputdata stream to the value specified in this field.

MGMTMODE (IMMED | DIALIN | OUTAVAIL)

Valid for network printers only. Valid for any relmode. Action done by SPSafter the printer is released and (for relmode=time) acqintv expires. Thedefault is OUTAVAIL.


52 U21020-J-Z247-7-7600

OUTAVAIL SPS will try to reallocate the printer LU session afterobtaining a file from JES.

IMMED SPS will try to reallocate the printer LU sessionimmediately.

DIALIN SPS will try to reallocate the printer LU session as soon asthe switched line is connected or the VTAM LU is madeactive.

MSGEXDP (exit-name)

Message processing exit for direct printing. Provided for compatibility withIBM's direct printing processing exit 16 from PSF. Exit interface is totallycompatible with PSF. PSF exits may be used without modification. Allprocessing provided is also available in the normal SPS message exit tableand associated exits. New exit functions should be implemented using theSPS message exit table, as this will usually greatly simplify theimplementation.

MSGLIM (msg-limit)

Number of warning messages to be printed when the user has notspecified PIMSG in the JCL. When this threshold is reached the output iscancelled or held according to the PIMSG SETUPxxx parameter. 0indicates all messages generated should be printed. When MSGLIM is notspecified 100 will be used as the default for APA printers.

MSGLMOD (lmod-name)

Name of the message page load module to be used when no othermessage page has been selected through the resolution of a print job'sparameters. Message pages are printed for each data set when anymessages have been issued. For multiple copies, message pages areprinted at the end of all copies of a print data set. When there are nomessages to be printed the message page will be suppressed.

Special message pages can be selected for any form or sysout class in theform table using the MOD parameter. An APA model message page issupplied with the SPS product. The APA model message page is namedSPSMMSGA. Both the source and load module for the APA message pageare supplied with SPS in SPS.SPSSAMP and SPS.SPSLINK. Please see"Information Page Suppression" on page 119 for how to suppressmessage pages.

MSGSP (YES | NO)

Internal processing message suppression. Determines whether the SPSinternal processing messages should be printed or suppressed. These


U21020-J-Z247-7-7600 53

messages are only useful for debugging SPS and should not be printedunless requested by a service representative. YES is the default for APAprinters when MSGSP is not specified:

YES Suppress the internal processing messages.

NO Print the internal processing messages. Suppresses theprocessing of the MSGSUxxx member, i.e., any messagesuppression desired by the installation will not occur andany user message exit will not receive control.

NDFBUFL (twin-printer-resident-buffer [,FIX | ,NOFIX])

Size of storage to be allocated for the resident twin printer buffer. Thisbuffer is only required for twin printers. Values specified will be roundedupward to multiples of 4K. The default is a 8,388,608 byte buffer not fixedin storage, which is allocated above the line. The maximum value is99,999,999 bytes. The performance of the twin printer can be seriouslyimpacted if this buffer is too small. If you are running SPS without ESD filesit is especially important to allocate this buffer large enough otherwise itcould happen that SPS is not able to print listings with a big amount of datain each page.

NORESP (Operator | Terminate)

Valid for TCP/IP printers only. SPS optional actions after the RESPTIMEinterval exceeds. One or all actions may be specified. See the RESPTIMEparameter for other actions.

The default is operator.

Operator SPS will issue a message describing the non-responsestate to the operator.

Terminate SPS will terminate (drain) the JES printer (FSAtermination).

NOTIFY (node1.user1, node2.user2, node3.user3, node4.user4)

Specifies a default notification list for this printer. This list specifies up to 4userids with an optional nodeid (NJE). When SPS issues a message whichrequires operation attention (seventh digit from the message number is ‘A’or ‘E’) or informs the operator about a printer intervention required error,SPS tries also to send this message to all userids contained in the currentNOTIFY list. If the message is related to an output file and the JCL


54 U21020-J-Z247-7-7600

OUTPUT statement of this file has the NOTIFY keyword, that list is used.Otherwise the SETUP NOTIFY list is used, if specified.

This list is useful for departmental network printers, so that 1 to 4 usersmay be informed if errors occur on the printer.

The default is no NOTIFY list.

NOTRDMO (YES | NO)

Not ready indication in the UCB. The default is NOTRDMO (NO).

NO SPS will not provide an extra not ready indication in theUCB. The SPS STAT command should be used in order toobtain not ready information.

YES When the printer goes to a not ready state without pagebuffer full, SPS will set bit UCB2OPT0 (X'80') in byteUCBTBYT 2 (X'11' from UCB common segment - secondbyte from UCBTYPE word). This option should be usedwith extreme care in order to be sure that the UCB settingdoes not conflict with any software in the user environment.This option is useful when user monitoring programs checkthe printer UCBs for not ready states.

NUMACKR (number-of-acknowledge-reply / 0-99)

For SNA LU6.2and TCP/IP attached printers the SETUPxxx parametermay be used to obtain a better transmission performance. Number ofphysical pages that SPS will attempt to send to the printer beforerequesting an ack reply with updated page counter information. Specifyingzeroes means that SPS will use its internal default.

NUMCCWB (number-of-ccw-buffers / 2)

Number of fixed 4K buffers used to build the ccw channel programs for onephysical printer. These buffers are allocated below the line, only for localprinters. For twin printers this parameter specifies the number of buffersused for each physical printer. A value between 2 and 255 may bespecified. The default is 2. The default is enough for most configurations.SPS will abend if more ccw buffers than initially allocated are neededduring the print session.


U21020-J-Z247-7-7600 55

NUMIDAB (number-of-ida-buffers)

Number of fixed 4K buffers used to build the IDAWs for the physicalprinter. These buffers are allocated below the line, only for local printers.For twin printers this parameter specifies the number of buffers used foreach physical printer. A value between 3 and 255 may be specified. Thedefault is 3. The default is enough for most configurations. SPS will abendif more IDAW buffers than initially allocated are needed during the printsession.

OBJCONDD (object-container-dd)

Ddname of the object container library to be used for page printers.OBJCON is the default ddname when OBJCONDD is not specified.

OUTBUF# (number-of-buffers)

Number of output buffers to be used to drive the printer. This number canhave a significant influence on performance if too small. This numbershould be at least 2. The default for APA printers is 6. A maximum of 255buffers may be specified. For twin printers this parameter specifies thenumber of output buffers used for each physical printer. As SPS uses thePCI interrupt technique to drive the printers, an increase in the outputbuffer number may avoid start-stop problems with heavy applicationsand/or very fast printers. The STAQ SPS command and the STAQINTSETUPxxx parameter may be used to see the influence of the buffernumber increase on the internal I/O queues of SPS and on thereceived/committed page counters from the printers.

OUTBUFL (buffer-length)

Size of the output buffers to be used for sending data to the printer. Thisnumber must be at least 8192 for APA printers. The default for APAprinters is 8192. Please see the Installation Guide "performanceconsiderations" for a discussion of buffer parameters and performance.For values greater than 8K please verify whether your printer and channelattachment (like channel extenders) support it. The maximum valuespecifiable is 64K. For LU 6.2 connections the maximum value is 32K, ifmore than 32K is specified SPS will adjust OUTBUFL to 8196 andOUTBUF# to 4.

OVLYDD (overlay-lib-dd)

Ddname of the overlay library to be used for page printers. OVERLAY isthe default ddname when OVLYDD is not specified.


56 U21020-J-Z247-7-7600

PAGEDEF (pagedef-name)

1 to 6 character name of the default page definition to be used when nopage definition has been specified by the user in the JCL and none issupplied by JES from the initialization parameters. It is used in all situationswhere no PAGEDEF name is available and one is needed. This name isthe same name that the user would specify in the JCL keywordPAGEDEF=pagedef-name. When not specified the default PAGEDEF forcut-sheet printers is V06483, and for fan-folded printers is STD3. Thisparameter is always used for information pages when PAGEDEF is notcoded in the IPAGINFO macro.

Note: PAGEDEF interacts with JES initialization parameters and the JCLFCB parameter. For a full discussion of this interaction please seeSPS/MVS Installation Guide.

PDEFDD (pagedef-lib-dd)

Ddname of the page definition library to be used for APA printers.PAGEDEF is the default ddname when PDEFDD is not specified.

PDSBUF# (number-of-buffers)

Number of buffers to be allocated for reading files from the JES spool. ForAPA printers this number should be at least 2. The default for APA printersis 6. The maximum value is 255.

PDSBUFL (buffer-length)

Size of the buffers to be used for files from JES spool. A value between8192 and 36864 may be specified. The value is rounded down to a 4Kboundary. The default for APA printers is 24576. This value must be largeenough to accept the largest single logical record that will be presented toSPS from any application.

PIMSG (YES | NO [[[[,CANCEL | HOLD])

Error message printing default. Determines whether warning messages willbe printed when the user does not specifically request the printing orsuppression of warning error messages via the PIMSG keyword in the JCL.This parameter can cause suppression of the message page if NO iscoded and the user has not specified the option in his JCL. YES is thedefault for APA printers when PIMSG is not specified.

This parameter also specifies the action taken by SPS when the number ofwarning messages specified in the MSGLIM setup parameter or PIMSGJCL keyword is exceeded. The default action is CANCEL. Please look alsoat the PRTERROR output statement keyword.


U21020-J-Z247-7-7600 57

YES Print error messages when the user does not specifyPIMSG in the JCL.

NO Do not print error messages when the user does notspecify PIMSG in the JCL.

CANCEL SPS will purge the spool file if more warning messages areissued than specified in MSGLIM (SETUPxxx) or PIMSG(JCL).

HOLD SPS will return the output group to the spool in hold whenthe MSGLIM (SETUPxxx) or PIMSG (JCL) limit isexceeded.

PRINTOPT (YES | NO)

Specifies the default for the PRINTOPT option, which may be alsospecified in a control file. If YES is specified SPS prints in the messagepage a list of all options used to print the output file (like PAGEDEF,COPYMARK, INBIN, USERLIB, etc.) with the corresponding source fromwhere they were obtained (JCL, SETUPxxxx, defaulted, forms control file,etc.). This list may be used for diagnostic purposes in cases where anoutput file is not correctly printed or when a printing option seems to beobtained from the wrong source. The same listing may be also obtained viathe SPS command FDIS, if issued while the output file is being printed(also at intervention required state). Via the FDIS command this listing maybe also directed to the system console or to the hardcopy log. See ”SPScommands” for more information about the FDIS command. The default isPRINTOPT (NO), which produces no diagnostic listing.

PRINTSET (YES | NO)

Specifies if SPS should list the options used for the current print session atthe hardcopy log. These options correspond to all SETUPxxx parametersand are listed immediately after starting the printer. For each option itssource is also listed (DEFAULT or SETUP). The same information can bealso obtained via the SDIS command (see ”SPS commands”). The defaultis PRINTSET (NO) which produces no listing.

PRTERROR (HONOR | NOTHONOR)

Usage of the PRTERROR parameter from the JCL output statement.

NOTHONOR SPS should not honor the PRTERROR parameter from theoutput statement. This is the default.

HONOR SPS should HONOR the PRTERROR parameter from theoutput statement. The PRTERROR output parameter


58 U21020-J-Z247-7-7600

allows the user to change the default termination option(PURGE,HOLD) for output files with error.

PRTNUFON (member-of-fonts)

Controls the maximum number of fonts (or font sections for DBCS) to beloaded on the printer before SPS deletes all fonts and loads only the fontsneeded for the current page.

0 SPS will use its internal default which is currently 80. This isthe default option.

nnnn Another limit from 1 to 2G.

NOLIMIT SPS will load fonts until the printer reports overflow of fontstorage.

PRTNUOVE (number-of-overlays)

Controls the maximum number of overlays to be loaded on the printerbefore SPS deletes all overlays and loads only the overlays needed for thecurrent page.

0 SPS will use its internal default which is currently 100. Thisis the default option.

nnnn Another limit from 1 to 9999.

NOLIMIT SPS will load overlays until the printer reports overflow ofoverlay storage.

PRTNUPSE Controls the maximum number of page segments to be loaded on theprinter before SPS deletes all page segments and loads only the pagesegments needed for the current page.

0 SPS will use its internal default which is currently 100. Thisis the default option.

nnnn Another limit from 1 to 9999.

NOLIMIT SPS will load page segments until the printer reportsoverflow of page segment storage.

PSEGDD (pageseg-lib-dd)

Ddname of the page segment library to be used for APA printers.PAGESEG is the default ddname when PSEGDD is not specified.

PSEGEXIT (exit-name)

Specifies the name of the page segment exit to be used. This exit mayallow SPS to continue printing a file when a page segment is not found.


U21020-J-Z247-7-7600 59

See Page Segment Exit for more information on how to implement thisexit. By default, no exit will be taken.

PSFBTBL (table-name)

Specifies the name of the PSF compatible block character table to be usedfor information page block letters. You may specify here the PSF deliveredtable APSUBTBL or the SPS delivered table SPSUBTBL (also delivered asa source module in the SPS.SPSSAMP library). If you modify andrecompile/relink SPSUBTBL you may customize the block letters from yourinformation pages (generated via IPLINEs variables or via the PSFcompatible exits 1,2 and 3). If you do not specify this parameter the originalSPS block letter table is used (compatible to JES block letters) and youcan not customize it. Also included In the SPSUBTBL module is a tablecontaining the names used for months. This table will be used with theinformation page variable %DATX.

PSFX01 (exit-name)

The name of the exit routine for header page compatible with PSF. Ifspecified SPS will not use the standard SPS header page processing butthe PSF compatible way to print header pages. Please see "PSFCompatible Information Page" on page 176 for more information.

PSFX02 (exit-name)

The name of the exit routine for trailer page compatible with PSF. Ifspecified SPS will not use the standard SPS trailer page processing but thePSF compatible way to print trailer pages. Please see "PSF CompatibleInformation Page" on page 176 for more information.

PSFX03 (exit-name)

The name of the exit routine for data-set separator compatible with PSF. Ifspecified SPS will not use the standard SPS data-set separator processingbut the PSF compatible way to print data-set separator pages. Please see"PSF Compatible Information Page" on page 176 for more information.

PSFX07 (exit-name)

Specifies the name of the exit routine compatible to PSF exit number 7.Just a subset of the PSF exit 7 functions are currently supported by SPS.Many not supported exit 7 functions may be implemented in SPS inanother way (via control file parameters, via the data-set allocation exit, viathe resource read exit, etc.). Please see „PSF Compatible Exit 7“ on page178 for more information.


60 U21020-J-Z247-7-7600

PSSTOMGT (YES | NO)

Activates or deactivates the management of storage for the PS/APA drivercomponent of SPS.

YES SPS will not immediately return freed storage to theoperating system. This option avoids the CPU overhead ofcontinuously freeing and reallocating storage. This is thedefault and should be changed only if requested by an Océsystem representative.

NO SPS will immediately return freed storage to the operatingsystem. This option should be used just for diagnosticpurposes.

QUEINTV (number of seconds)

Valid for TCP/IP printers only valid for RELMODE(idle) or RELMODE(time)only.

As RELMODE(idle/time) is currently not supported for TCP/IP printers, thisparameter is currently not used by SPS.

Interval in seconds between each query done by sps in order to see if theprinter is being requested by another application. A query may be delayedbecause an i/o is in progress or the printer is not ready.

For RELMODE(idle) a query is done only when there are no more filesavailable for this printer from JES.

5-9999 - minimum interval in seconds between each query.

The default is 60 seconds.

QUETMOUT (number of seconds)

Valid for TCP/IP printers only.

Valid for RELMODE(idle) or relmode(time) only.

As RELMODE(idle/time) is currently not supported for TCP/IP printers, this

parameter is currently not used by SPS.

Interval in seconds that SPS will wait for a printer response while doing a

TCP/IP request during a query to the printer. The query is used to know ifother applications want to allocate the printer.

For RELMODE(idle) a query is done only when there are no more filesavailable for this printer from JES.

1-60 - time-out interval for query requests in seconds.


U21020-J-Z247-7-7600 61

RDSBUF# (number-of-buffers)

The number of buffers to be allocated for reading resources. For APAprinters this should be at least 2. The default for APA printers is 6. Themaximum value is 255.

RDSBUFL (buffer-length)

Size of the buffers to be used for reading from resource libraries(FONTLIB, PSEGLIB, etc.). For APA printers this number must be at least8192. The default for APA printers is 12288. The maximum value is 36864.The specified value is rounded down to 4K boundaries. his value must belarge enough to accept the largest single logical record that will bepresented to SPS from any resource, including resources contained inUSERLIBs.

RDSREXIT (exit-name)

Specifies the name of the resource read exit routine. This exit receivescontrol when SPS reads external resources (Formdefs, Pagedefs, etc.)from system or user libraries. The exit may inspect and modify theseresources and influence the printing process of SPS. See ”Resource ReadExit” on page 195 for more information on how to implement this exit.

REAINUS (YES | NO)

Controls how SPS obtains the name of the real forms for all input binsfrom a cut-sheet printer. The default for this parameter is NO.

NO SPS will use the forms table RFORM parameter for it. Inthis case up to 16 real forms are supported for setuppurposes.

YES SPS will obtain the real forms name from the user formsname, 2 characters for each real forms. In this case up to 4real forms are supported for setup purpose.

For example:

When forms = 01446378 in the JCL we will have:

USER FORMS NAME = '01446378'Real forms for BIN A = '01'Real forms for BIN B = '44'Real forms for BIN C = '63'Real forms for BIN D = '78'


62 U21020-J-Z247-7-7600

RECEXIT (exit-name)

Specifies the name of the record processing exit to be used to add, deleteor modify input records before printing. No record processing exit will beinvoked when RECEXIT is not specified. Please see "Input RecordProcessing Exit" on page 184 for exit coding information. The default forAPA printers is no exit specified.

RELINTV (number-of-seconds)

Valid for network printers only. Interval that should expire - from jobboundary to job boundary - before SPS attends a request to release theprinter. This interval is used only when relmode=idle or time is specified.

The default is 0.

0 - No interval should expire. For relmode=time this meansthat SPS will release the printer after terminating to print allfiles from the current output group. For relmode=idle itmeans that SPS will release the printer after terminating theprintout of one output group if no more files are available tobe printed.

1-86400 Interval in seconds. For relmode=idle SPS should be idleduring this time before releasing the printer because of arequest from another application. For relmode=time thistime should expire between 2 job boundaries so that SPSmay release the printer because of a request from anotherapplication.

RELMODE (IDLE | TIME | NONE)

Valid for network printers only. Release mode - how SPS will respond torequests to release the printer received from other VTAM applications.

The default is NONE.

NONE SPS will not release the printer because of a request fromanother application. See the DISCINTV parameter for otherpossibilities.

IDLE SPS will release the printer because of a request fromanother application as long as SPS has no file to print afterthe RELINTV interval expired.

TIME SPS will release the printer because of a request fromanother application after the RELINTV expired, even ifmore jobs are available to be printed. SPS will start theRELINTV just when starting to read a new output group and


U21020-J-Z247-7-7600 63

will release the printer only after an output group iscomplete.

REMSETUP (YES | NO)

Specifies if SPS should perform setup for forms change for networkprinters. The default is NO.

RESPTIME (number-of-seconds / 0-9999)

Valid for TCP/IP printers only interval in seconds waited by SPS if noresponse is received from the printer for a TCP/IP request.

During the session initialization or termination SPS forces a RESPTIMEvalue of 20 seconds.

The default value is 60 seconds.

0 - SPS will wait for an unlimited period of time.

1 - 9999 interval in seconds, waited by SPS. If this interval expiresSPS will inform JES about the non-responding status andproceed according to the NORESP and notify parameters(the notify list may be also specified in the outputstatement)

RESLIST (YES | NO)

Specifies if SPS should generate a resource usage report for each printedfile or not. This report describes each external resource used (formdef,pagedef, page segment, overlay or font) informing also the resource librarydsname from where the resource was read. When you specify RESLIST(YES) you should also code the DD statement SPSRnnnn (where nnnn isthe JES printer number specified with four digits) in your SPS procedure.The default is RESLIST (NO).

SEPLMOD (lmod-name)

Name of the data set separator page load module to be used when noother separator page has been selected through the resolution of a printjob's parameters. Special data set separator pages can be selected for anyform or sysout class in the form table using the MOD parameter. An APAmodel data set separator page is supplied with the SPS product. The APAmodel separator page is named SPSMSEPA. Both the source and loadmodule for the APA separator page are supplied with SPS inSPS.SPSSAMP and SPS.SPSLINK. Please see "Information PageSuppression" on page 119 for how to suppress separator pages. Thedefault for APA printers is SPSMSEPA.


64 U21020-J-Z247-7-7600

SETUPDP (YES | NO)

Controls whether normal SPS setup will be performed or ignored duringdirect printing. The default is YES when not specified.

YES Perform normal SPS setup for each open of a print file.

NO Ignore setup in direct printing mode.

SIOAPG (suffix | WS)

The suffix of the startio appendage module. This suffix should be changedwhen an installation has an appendage routine defined with a name otherthan IGG019WS. WS is the default suffix for APA printers when SIOAPGis not specified. When this suffix is changed the SMP installation JCLINmust also be modified to match the new suffix. Please see SPS/MVSInstallation Guide for modifications required in the SMP apply.

SMF6EXIT (exit-name)

Specifies the name of the SMF type 6 accounting record processing exit tobe used to modify or suppress SMF type 6 accounting records before theyare written to SMF. No accounting record processing exit will be invokedwhen SMF6EXIT is not specified. Please see "Accounting Exit" on page183 for exit coding information. The default for APA printers is no exitspecified.

SPOOLMSG (YES | NO)

Specifies the default for the SPOOLMSG option, which may be alsospecified in a control file. If NO is specified any eventual warning or errormessages related to an output file are printed just after the output file itselfin the so called message page. This is the default. If YES is specified thediagnostic messages are written into a spool file which is dynamicallyallocated when the output file is stacked. This dynamically allocated file isalso immediately spun off, so that it may be printed or viewed according toits file options. These options are specified in the SPSOnnnn OUTPUTstatement, which should be coded in the SPS procedure for each printerwith SPOOLMSG (YES). You may leave the SPS diagnostic messages inspool or print them in a small LU1 printer. You may code NOTIFY= in theSPSOnnnn OUTPUT statement so that you are informed at your TSOterminal that a message page was printed on the LU1 printer.

STAQINT (hundredth-of-seconds)

Specifies the interval between automatically issued STAQ commands. TheSTAQ command is useful for diagnostic purposes. See ”9 SPSCommands” on page 147 for more information about the STAQ command.


U21020-J-Z247-7-7600 65

The interval is specified in hundredths of a second. The default is 0 andmeans that no STAQ command is automatically issued by SPS. The STAQcommand is not supported for network printers.

TIMEOUT (STOP | REDRIVE)

Valid for network printers only. Valid for any relmode. Action done by SPSafter the DISCINTIV (for relmode=none) or RELINTV(relmode=time|idle) interval expires. The default is REDRIVE.

REDRIVE SPS will release the printer (terminate the VTAM LUsession), maintain the JES printer session and do theaction specified by the MGMTMODE parameter.

STOP SPS will terminate the JES printer session.

TLRLMOD (lmod-name)

Name of the job trailer page load module to be used when no other trailerpage has been selected through the resolution of a print job's parameters.Special trailer pages can be selected for any form or sysout class in theform table using the MOD parameter. An APA model job trailer page issupplied with the SPS product. The APA model trailer page is namedSPSMTLRA. Both the source and load module for the APA trailer page aresupplied with SPS in SPS.SPSSAMP and SPS.SPSLINK. Please see"Information Page Suppression" on page 119 for how to suppress trailerpages. The default for APA printers is SPSMTLRA.

TRACEFILE (USER | NO)

Indicates whether the SPS trace data sets are to be used for collectingtrace records on auxiliary storage, or that all writing of auxiliary storagetrace records is to be suppressed. The default is USER. You may use SPScommands to dynamically close and open the trace files. See "SPSCommands" on page 147 for more information. Please see SPS/MVSInstallation Guide for more information on the trace files.

USER The SPS trace data sets with ddnames SPS1nnnn andSPS2nnnn are to be used for collecting trace records,where nnnn is the JES printer number expanded to 4 digits.These DD's must be defined in the SPS startup procedure.

NO Suppresses writing to auxiliary storage of all trace records.The in core wrap around trace table will still be generated.Trace will not be written to the SPS trace data sets eventhough they are present in the SPS startup procedure.

TRACELEV (0 | 1 | 2 | 3 | 4 )


66 U21020-J-Z247-7-7600

Specifies the trace level to be used by SPS. This number determines thelevel of detail to be collected in the trace records. Most of the data fromtrace levels higher than 1 is only available if a trace data set is activebecause data longer than 20 bytes will be truncated in the main storagewrap around trace table. For this reason trace levels higher than 1 are notrecommended when trace data sets are not active. Trace level 3 with SPStrace data sets allocated is recommended for initial installation. Trace level0 with SPS trace data sets allocated is recommended for a productionimplementation. The default for APA printers when TRACELEV is notspecified is 0. You may use SPS commands to dynamically change thetrace level. See "SPS Commands" on page 147 for more information.Please see SPS/MVS Installation Guide for performance considerationsand information on the use of traces.

0 No trace records are generated to auxiliary storage. Only trace level 1records for SPS base product (no printer driver records) are generatedto the main storage wrap around trace table. This is the recommendedtrace level for normal operations without trace data sets.

SPS/MVS-APA is delivered as a base product component, and an APAprinter driver component. The base product component provides theinterface for the operating system and user requests. When limitingtrace collection, the base product trace information is the most importantto have in the trace table. All trace levels higher than 0 collect therecords from both the base product and the APA printer drivercomponents. In order to have the SPS internal trace table in a dump youshould request the LSQA to be dumped. You request the dumping ofLSQA via the IEADMPxx and/or IEADMRxx members ofSYS1.PARMLIB. You may dynamically change the dump options viathe CHNGDUMP operator command.

1 Generate a flow trace. This option generates the wrap around tracetable in memory and also writes the records to auxiliary storage if thetrace data sets are available and the corresponding TRACEFILE optionis selected.

2 Generate a flow and status trace. This option is used when a problem isbeing diagnosed (usually at the direction of a service representative).Trace data sets should be available for the record collection.

3 Generate a flow, status, and control block trace. Also input and outputdata is traced under this trace level. This option is used during initialinstallation to diagnose installation problems. Subsequently it may berequested by a service representative. Trace data sets should beavailable for the record collection.


U21020-J-Z247-7-7600 67

4 Generate a flow, status, control block, data and big control blocks trace.This option should only be used when a problem is being diagnosed(usually at the direction of a service representative). Trace data setsmust be available for the record collection.

TRACESET (hex-pair-string)

An up to 16 character hex string used by a service representative torequest predefined tracing options for diagnostic purposes. Every 2 hexcharacters must be separated by a comma. Unspecified values areconsidered F. TRACESET(xx) would expand to xxFFFFFFFFFFFFFF,TRACESET(,,,,,,,xx) would expand to FFFFFFFFFFFFFFxx. You may useSPS commands to change the traceset specification. See "SPSCommands" on page 147 for more information. The default is all F's.

TRACETYPE ([ALL] | [INITERM] [,REQFLOW] [,DISPAT] [,INVRET] [,PDS] [,RDS][,ORDER] [,PS] [,CCW] [,VTAM])

The types of trace records to be collected. Any of the record types listedbelow can be selected or combined. The default is ALL when TRACETYPEis not specified. For more information on this parameter please seeSPS/MVS Installation Guide.

ALL All trace record types are to be collected.

INITERM Initialization and termination trace records are to becollected.

REQFLOW Request flow trace records are to be collected.

DISPAT Dispatcher trace records are to be collected.

INVRET Invoke/return trace records are to be collected.

PDS Primary data stream trace records are to be collected.

RDS Resource data stream trace records are to be collected.

ORDER Order processing trace records are to be collected

PS Print server trace records are to be collected.

CCW Channel command word processing trace records are to becollected.

VTAM VTAM related trace records (for LU1 and LU 6.2 printers)are collected.

TWINMSGS (NPRO | NONPRO)


68 U21020-J-Z247-7-7600

Specifies message page processing on the twin printer. See also theSPOOLMSG option for related processing.

NPRO Perform a nonprocess run out before the message data setis processed. This forces the print data set into the stackerbefore any messages are printed.

NONPRO Start the message page immediately after printing the lastpage of the print data set. A copy of all the messages forthe job will be reprinted in a separate spool file if messagesare issued that cannot be printed with the print data set(please see "Twin Printer OUTPUT Statement" in theSPS/MVS Installation Guide for full description). NONPROis the default when not specified.

WRONLY ([FONT] [,PSEG] [,OVLY] [,FDEF] [,PDEF] [,HWFEAT] [,RESCONF] |YES | NO)

Default for the warning only function, if not specified in a control file.

The warning only function allows SPS to continue processing when certainkind of errors occur . SPS will only issue a warning message but will try tocontinue printing the output file. The default is NO.

NO SPS will terminate the printing of the output file when any ofthe errors below occur.

FONT SPS will issue a warning message and continue printoutwhen a font is not found.

PSEG SPS will issue a warning message and continue printoutwhen a page segment is not found.

OVLY SPS will issue a warning message and continue printoutwhen an overlay is not found.

FDEF SPS will issue a warning message and continue printoutwhen a formdef is not found.

PDEF SPS will issue a warning message and continue printoutwhen a pagedef is not found.

HWFEAT SPS will issue a warning message and continue printoutwhen a hw feature is missing on the printer.

RESCONF SPS will issue a warning message and continue printoutwhen a conflict exists between the output file and itsrequested resources.

YES SPS will issue a warning message and continue printoutwhen any of the above described errors occur.


U21020-J-Z247-7-7600 69

4.4 APA Printer Execution Parameters: FORMxxxThis optional member is a table of user specifiable form names or output classes for whichthe installation wishes to predefine processing options. The form table makes it possiblefor an installation to predefine the processing options for any form name or output class.Using the form table, a single form name or output class coded in the JCL can select thecomplete processing definition for an output. Unique print characteristics, header,separator, message and trailer pages may be defined for each form name or output class.A single form name coded in the form table may request multiple real form names to bemounted in specific input bins (for a continuous forms printer, only one real form - for inputbin A - should be specified). SPS will coordinate with the operator the setup of multipleforms specified in this table. SPS will answer setup messages automatically2 for all formnames in the forms table whose requirements are already satisfied, thus eliminatingoperator intervention in these situations. SPS will take into consideration as many realforms from the forms table entry as input bins contained in the printer used. Up to 16 inputbins and real forms are supported. When an unavailable input bin is selected (via formdefor control file) SPS either uses the first available input bin (IBINSUB(YES) in control file onSETUPxxx) or returns the output group in hold to the queue (IBINSUB(NO)).

A form need not be put in the form table if no predefined processing or multiple real formsmounting is desired, an output class need not be in the table if no predefined processing isrequired. Form names coded in the JCL that are not found in the table are considered realforms and the initial mount request is for bin A. The operator has an opportunity to alter thebin specification if the printer is not a continuous forms printer.

The JES default form may be included in this table as well as the installation defined formnames. The JES default form is the form specified in the JES initialization parameters.When no form name is specified in the JES initialization parameters, JES uses STD as thedefault form name.

You may specify up to 32767 entries in the forms table.

2 Automatic reply to setup messages for JES3 versions previous to SP3 or local JES3 systems is not

supported.


70 U21020-J-Z247-7-7600

4.4.1 FORMxxx APA Control statement Format

FORM(+++++++c | ++++++++ | ffff | ########) C MOD(HSMTffff) DCKEY(cont-key) DMBR(DFLTffff) C RFORM('form1(A)' [,'form2(B)'][,'form3(C)']...[,′′′′form16(P)′′′′])

Figure 11: Format of APA FORMxxx Control Statement

4.4.2 FORMxxx APA Key Word Descriptions


DCKEY (cont-key)

The control key to be used to identify the forms control file data set namein which to search for the member name specified in the DMBR parameterfor this form or output class. The list of control keys defined for this printeralong with their corresponding data-set names is found in the KEYxxxmember for this printer. DCKEY is an optional parameter. When it is notspecified the system parameter library is assumed (SPS.SPSPARM) forany DMBR forms control file member request. If it is desired to allow usersto reference control files defined in the system parameter library directly inthe JCL- as user control files (not through the form name in the formstable) the system parameter library must be defined in the control key dataset list member KEYxxx with a control key. The default for DCKEY is nonespecified. Please see DMBR description below for more information onforms control file processing.

DMBR (DFLTffff)

The name of a forms control file member that contains predefined printcharacteristics for this form or output class. The parameters in thismember will be used for any control file parameters unless the userrequests a user control file member.

The user control file is specified by providing a trigger, control key, andcontrol file member name in the MODIFY and CHARS parameters of theJCL. For more information on this processing please see "Control FileProcessing" on page 79.

The member specified in DMBR will be taken from the control key data setindicated by DCKEY. If DCKEY is not specified the member will be takenfrom the system parameter library (SPS.SPSPARM). DMBR is an optionalparameter, but must be specified when DCKEY is specified. The default forthis parameter is none specified.


U21020-J-Z247-7-7600 71

FORM (+++++++c | ++++++++ | ffff | ########)

The name of the form or output class being defined by this entry in theforms table. The form name is an installation defined name to be coded inthe JCL to identify the processing and real forms mounting requirementsfor an output dataset. A form name may be up to 8 characters (however,form names longer than 4 cannot be specified on a DD statement. only onan OUTPUT statement). JES output class names are recognized by coding+++++++ with the output class appended at the end: +++++++A would beJES output class A. When an output file has both a form name and outputclass corresponding to entries in the form table, the form name entry willbe used.

For form names, the # character may be used as a “wild card.“ Thus thespecification FORM(#BC#) would match a form name of ABCD.

The generic form name ######## may be used to identify processing forany form not defined in the forms table. When this entry is present, anyform name not in the forms table will be processed according to thedefined processing options in this entry. When the generic form name iscoded it will be processed before the output class option, causing no outputclass definitions to be processed (the generic class name ++++++++ willnot be processed also).

The generic class name ++++++++ may be used to identify processing forany class not defined in the forms table. This entry will be used only if noforms entry match, no generic forms name entry is present (########)and no class entry matches. Since an output file might match more thanone FORM() specification, the following hierarchy will be used to determinewhich specification will be active (item 1 having precedence):

1. A match with exact form name or a wildcard match whichever is first inthe forms table.

2. The generic form name (########)

3. A match for output class

4. The generic class name

This parameter must be specified, and has no default value.

MOD (HSMTffff)

The name of a member in the SPS.SPSPARM library that contains thenames of special header, separator, message and trailer page loadmodules to be used for this form name or output class. If this parameter isnot specified, the header, separator, message, and trailer pages defined bythe HDRLMOD, SEPLMOD, MSGLMOD, and TLRLMOD parameters in the


72 U21020-J-Z247-7-7600

SETUPxxx member for this printer will be used. This parameter is optional.The default for this parameter is none specified.

RFORM ('form1(A)' [,'form2(B)'] [,'form3(C)']...[[[[,´form16(P)´]]]])

A list of up to 16 real form names to be mounted when the user form namefor this entry is coded in the JCL. This parameter must be specified when aform name is being defined (or the generic form name ######## is coded),and cannot be specified when an output class is being defined. SPS willnot mount more real forms in the printer than input bins available.

Real forms are any operator forms used by the installation. Real formnames must have their input bin specified. Subsequent use by the print jobwill be by bin number.

On continuous forms printers only requests for input bin A will be honored.Requests for forms in bins B to P will receive a warning message and beignored. This means that the user form name will be considered a realform name for the purpose of the mount.


U21020-J-Z247-7-7600 73

4.5 APA Control Key Data Set List: KEYxxxPlease see "Control File Processing" on page 79 for a description of control file processingbefore coding KEYxxx. This member is a table of the control keys and correspondingcontrol data sets used for the printer being defined. Up to 16 data sets can be specified forone printer. The same data set may be specified for more than one printer. These datasets are dynamically allocated, so there are no DD statements required in the startupprocedure. A data set is selected when a user specifies in his JCL the trigger defined forthe printer and the proper control key for the data set. A data set is also selected whenDCKEY is specified for a form or sysout class in the forms table.

4.5.1 KEYxxx APA Control Statement Format

CTLKEY(cont-key) CTLDSN(ctl-dsn)

Figure 12: Format of APA KEYxxx Control Statement: In this figure all keywords are required.

4.5.2 KEYxxx APA Key Word Descriptions


CTLDSN (ctl-dsn)

The control data set that is selected when the user specifies the control keyin CTLKEY. This data set is searched to find the member that the user hasspecified in his JCL or has been specified in the DMBR parameter from theforms table entry which contains the print job control information). Thisparameter must be specified if CTLKEY is specified, there is no default.

CTLKEY (cont-key)

The control key to be coded by the user in his JCL or the SPSadministrator in the forms table (FORMxxx) to identify the control data setspecified in CTLDSN. The control key must be 5 to 8 alphanumeric ornational characters. This parameter must be specified if CTLDSN isspecified, there is no default.


74 U21020-J-Z247-7-7600

4.6 APA Special Information Pages: HSMTffffThis member identifies special header, separator, message, and trailer page load modulesto be used for the form or output class whose entry in the form table (FORMxxx) points tothis member. Any or all of the special information pages may be defined. When aninformation page type is not specified, the corresponding default in SETUPxxx will be used(HDRLMOD, SEPLMOD, MSGLMOD, or TLRLMOD). If PSFX01, 02, 03 is specified in theSETUPxxx member the corresponding exit is used instead of the data from the info pagesload modules. Please see "PSF Compatible Information Page" on page 176 for moreinformation.

4.6.1 HSMTffff APA Control Statement Format

HDRLMOD(lmod-name) SEPLMOD(lmod-name) MSGLMOD(lmod-name) C TLRLMOD(lmod-name)

Figure 13: Format of APA HSMTffff Control Statement: In this figure all keywords are optional. Keywords notspecified will use defaults from SETUPxxx.

4.6.2 HSMTffff APA Key Word Descriptions


HDRLMOD (lmod-name)

Special header page load module to be used for the form or output classthat points to this member.

MSGLMOD (lmod-name)

Special message page load module to be used for the form or output classthat points to this member.

SEPLMOD (lmod-name)

Special separator page load module to be used for the form or output classthat points to this member.

TLRLMOD (lmod-name)

Special trailer page load module to be used for the form or output classthat points to this member.


U21020-J-Z247-7-7600 75

4.7 APA Forms Control File: DFLTffffThis member contains predefined print characteristics to be used for the form or outputclass specifying this member in the forms table. It provides the SPS administrator a meansof predefining the pagedef, formdef and other formatting characteristics of standardinstallation print requirements. Please see "APA Control File Parameters" on page 91 for adescription of the keyword parameters specifiable in this member.

The parameters in this member will be used when a user does not request his own controlfile in the JCL (user control file), or when a parameter has not been specified in the usercontrol file. Any or all the keyword parameters may be filled in; all coded parameters willoverride any JCL specifications. The use of values specified in this member may besuppressed for APA printers by selecting the option FORMCTL(NO) in the user control filefor the print data set. Please see Table 1 on page 217 in Appendix A for the overridehierarchy of all SPS parameters.

Via the FDIS SPS command, the PRINTOPT(YES) option from the control file, or thePRINTOPT(YES) option from SETUPxxx you may obtain a list of all printing options for afile with its respective source (JCL, JES, control file, setup, default, etc.)


76 U21020-J-Z247-7-7600

4.8 APA Message Table: MSGSUxxxThis member contains a table of message identifiers for which special processing isrequested. Messages may be either primary messages or environmental messages.Primary messages indicate the occurrence of errors or events. Environmental messagesdescribe all of the conditions at the time of errors or events. Several primary messagesmay be issued together for one failure. When all the primary messages for a failure requirethe same environmental messages to describe the errors reported by the primarymessages, the combination of the primary and environmental messages is referred to as amessage group. Up to 4095 primary and environmental messages can be selected forspecial processing on each printer.

All messages in the message table, whether a primary message or an environmentalmessage may be suppressed, have an automatic operator reply generated, or transfercontrol to an exit routine.

To determine the structure of message groups, examine a message page printout of thegroup. The primary messages will all be clustered together with a line skipped betweeneach primary message, the associated environmental messages will follow the primarymessages and be clustered without any line spacing between the messages.

Sample member MSGSUXXX in SPS.SPSSAMP may be used to help code this memberfor an APA printer.

SPS only uses the MSGSUxxx member when MSGSP(YES) is coded or defaulted in theSETUPxxx member.

4.8.1 MSGSUxxx APA Control Statement Format

MSGID(msg-id) /* Required */ C RESP(msg-resp) /* Optional */ C EXIT(lmod-name) /* Optional */

Figure 14: Format of the APA MSGSUxxx Member

4.8.2 MSGSUxxx APA Key Word Descriptions


EXIT (lmod-name)

Specifies the name of a user exit routine which should be called each timethis message is issued. See "Message Processing Exits" on page 190 forinformation about how to code message exit routines.

This keyword causes RESP to be ignored.


U21020-J-Z247-7-7600 77

MSGID (msg-id)

Specifies the message identifier of the primary or environmental messageto receive special processing. The message identifier is not the messagenumber displayed at the console or on the message page. To find themessage identifier of a message, you should search for the messagenumber in SPS.SPSMESS in the language member used for the printer.The first 8 bytes of the message is the message identifier.

If MSGID is specified alone the requested message will be suppressed.

If 00000000 is specified as msg-id this entry will apply to all messages notspecified in any other entry of MSGSUxxx. You could then code an entrywhich suppresses all SPS messages, or specify an exit routine whichreceives control for all SPS messages. Such an exit, like sample exitSPSMMEXC, may reroute all SPS messages which normally go to theprinter (message page) to the console.

Note: Certain messages are not eligible for special processing byMSGSUxxx. For a list of restricted messages please see "RestrictedMessages" on page 207.

RESP (msg-id)

Specifies an answer to be given each time this message is issued by SPS.A message will be suppressed when an automatic operator response isspecified.

This keyword will be ignored when the EXIT parameter is also specified.


78 U21020-J-Z247-7-7600

4.9 TCP/IP Support with SPS

General: SPS needs at least version 3.2 of the TCP/IP product.

NEW KEYWORDS IN THE SPSPRINT MEMBER:

The printer definition member SPSPRINT (in SPSPARM library) supports the newparameters

IPADDR

HOSTNAME

PORT

TCPNAME

These parameters are necessary to define the address of the TCP/IP printer. For asample definition of a TCP/IP printer please have a look at the SPSPRINT - member inSPS SAMPLIB.

Control File Processing

U21020-J-Z247-7-7600 79

5 Control File Processing

5.1 What is Control File ProcessingControl file processing is an extension to JCL. Current JCL does not support thespecification of many features available on Océ advanced function printers, and providesonly limited capability of overriding APA resource specifications. Control file processingpermits the specification of advanced features for any print data set, line or APA and alsoprovides substantial user override capability of resource specifications. Control fileprocessing may be used to request such options and APA resource overrides asadvanced duplexing for single and twin printers, rotation, character sets, selecting inputbin(s) and output stacker(s) for cut sheet, etc..

Control file processing is available to the administrator for establishing predefinedformatting and processing options for installation standard print jobs defined in the formstable (forms control files). The system administrator may also make control file processingavailable to users or user groups for direct control of their formatting and processing needs(user control files).

5.2 How is Control File Processing UsedThe system administrator may establish control files that control the formatting andprocessing for form names or sysout classes in the forms table. These control files containSPS/MVS-APA parameters requesting print data set processing options for all requestersof these user form names or sysout classes. When any of these user form names orsysout classes are requested in an SPS print job, the formatting and processing optionsspecified by the administrator are used to control the printing of the print data set. This isthe simplest mode of use of SPS and is recommended for the general user (forms controlfiles).

The system administrator may also establish user groups that are authorized to controltheir own print data set processing. User groups with this authority may request overrides


80 U21020-J-Z247-7-7600

to the forms table specifications that the administrator has established, request override toresources selected to control the printing of a data set, or may completely specify theirown processing (user control files).

5.3 How is SPS User Control File Processing Defined for a PrinterSPS user control file processing is defined for a printer by specifying the TRIG parameterfor a printer in the print table member (SPSPRINT) of the SPS parameter library, andspecifying control keys and corresponding control data sets in the KEYxxx memberpointed to by the CTLKY parameter for the printer. The TRIG parameter is used to signalin the JCL that control file processing is requested. The control key is used in the JCL toidentify a particular control data set to be used for control file processing. The KEYxxxmember contains a list of control keys defined by the installation with the control data setsthat they select. Figure 15 illustrates a control file definition for printer PRT4 with deviceaddress 7A1. The trigger for the control file is ####, the control key is SIEMENS, and thecontrol data set identified by the control key is SPS.CTLFILE.

MEMBER SPSPRINT:

PRT(PRT4) CUU(7A1) FTBL(FORM7A1) TRIG(####) CTLKY(KEY7A1)

MEMBER KEY7A1:

CTLKEY(SIEMENS) CTLDSN(SPS.CTLFILE)

Figure 15: Sample Control File Definition


U21020-J-Z247-7-7600 81

5.4 User and Forms Control FilesAn administrator may want to define forms control files that specify the print characteristicsof standard jobs, so that all users will be able to reference them when needed. Thesecontrol files may be referenced by the form names or sysout classes listed in the formstable. The control data sets containing these files should be defined with at least "readonly" access to the user. An installation may also need user control files that a user canuse to specify his own print job characteristics. These data sets must be defined with“read/write” access for the users or user groups to which they are assigned. Theserequirements are easily satisfied by defining separate data sets for user groups and theinstallation, and protecting them appropriately (please see "RACF Considerations" in theSPS/MVS Installation Guide).

The forms control file members (see "APA Forms Control File: DFLTffff" on page 75) thatare optionally specified in the forms table (FORMxxx) should not be updateable by theuser. The SPS parameter library is the default control data set for forms control files. Usingthis default makes it possible to put all administrator controlled parameters in a single dataset protected against user update. It is also possible to define a separate library for formscontrol files. This data set and its control key would have to be defined in the control keytable member (KEYxxx). The system parameter library can be made accessible to theuser by defining a control key for it and including this key and the name of the systemparameter library in the control key table member for the printer. This allows control filemembers defined by the administrator to be used by the user without referencing a formname or sysout class in the forms table.

A control file must be a member from a partitioned data set with fixed record format andlogical record length 80.


82 U21020-J-Z247-7-7600

5.5 How is User Control File Processing Requested for OutputWhen the trigger for a printer is found in the JCL MODIFY keyword of a DD defining a printdata set, the first 2 CHARS subparameters are concatenated to form a 5 to 8 byte name.This name is considered to be control key that selects a control file data set in the listfound in KEYxxx. The 3rd and 4th CHARS subparameters are concatenated to form a 5 to8 byte member name. If the control key is found in the control key list in KEYxxx, then thecorresponding control data set is used to find the member name. The contents of thismember are used in addition to the JCL to define the print characteristics and options forthe print data set.

When the MODIFY parameter is the trigger for a printer, and four CHARS parameters arespecified, SPS considers that user control file processing has been requested. When theMODIFY parameter is not a trigger defined in the print table, user control file processing isnot performed. In this case the CHARS parameter will be used as a standard CHARSparameter in which up to 4 fonts can be specified, and the MODIFY parameter will beignored.

When a valid trigger for the printer is specified in the MODIFY parameter, all 4 CHARSsubparameters must be specified in order to form the control key and the member name.If any of the 4 CHARS subparameters required to form the control key and member nameare not present, an error in control file processing is reported. The first and third CHARfields must contain 4 alphanumeric characters, the second and fourth CHARS fields cancontain 1 to 4 characters. If these conditions are not met, the concatenations that form thecontrol key and control file member name will form names different than the requesterexpects. The above stated rules imply that the minimum length for a control key or controlfile member name is 5 characters.

Form and user control file processing can be requested for output for a single print DD, orfor the output from an entire job. Control file requests for a single print DD can be on theDD or on an OUTPUT statement referenced by the DD. Control file requests for theoutput from an entire job should be on ant OUTPUT statement containingDEFAULT=YES, which can be implicitly or explicitly referenced by the DD. In general theuse of the OUTPUT statement is the easiest, and provides the most flexibility. A usercontrol file request for a single DD with the request on the DD statement is shown inFigure 16. The figure shows a user request for member name MYNAME in the controldata set SPS.CTLFILE defined in Figure 15. A user control file request for the samecontrol file for a single DD but using an OUTPUT statement referenced by the DDstatement is shown in Figure 17. A user control file request for the same control file butused for the entire output of a job is shown in Figure 18.

//PRTDSN DD SYSOUT=W,// MODIFY=####,CHARS=(SIEM,ENS,MYNA,ME)

Figure 16: Sample User Control File Processing Request for a Single DD.


U21020-J-Z247-7-7600 83

//ONEDD OUTPUT MODIFY=####,CHARS=(SIEM,ENS,MYNA,ME)//.................//PRTDSN DD SYSOUT=W,OUTPUT=*.ONEDD

Figure 17: Sample User Control File Processing Request for a Single Print DD Using an OUTPUTStatement Referenced by the DD: The OUTPUT statement in this example can be in the same step as the DDor must precede the first EXEC statement in the job.

//...... JOB ......//ALLDSN OUTPUT JESDS=ALL,DEFAULT=YES,// MODIFY=####,CHARS=(SIEM,ENS,MYNA,ME)//...... EXEC ......//PRTDSN DD SYSOUT=W

Figure 18: Sample User Control File Processing Request for the Entire Output of a Job ReferencedImplicitly by the DD.


84 U21020-J-Z247-7-7600

5.6 User Coding ExamplesThe following examples show how a user would request various functions of SPS/MVS-APA for JES spooled data streams.3

User coding examples 1 to 3 request formatting and processing provided by theadministrator installation examples 1 to 3 in "Installation Examples" on page 18. For adetailed description of the control file statements and parameters, please see "APAControl File Parameters" on page 91.

5.6.1 Example 1: Requesting a Predefined Form

Suppose that a general user wants to print assembler output with two listing pages perphysical sheet. The user wants the JES data sets to be printed normally. An assemblerlisting is less than 132 characters per line so the administrator defined form L2UP willmeet the user's requirement for the assembler listing (please see Figure 3). JES data setswill print on form STD by default. Form STD has been defined by the administrator to becompatible with normal 3211 output, so the JES data sets will print normally by default.The user coding required may be found in Figure 19.

USER JCL: User sysout DD requesting predefined form L2UP,

//............. JOB ..............//............. EXEC ..............//SYSPRINT DD SYSOUT=(W,,L2UP)

Figure 19: JCL For Example 1: Requesting a Predefined Form.

Explanation (please refer to Figure 3): The predefined form L2UP in the form parameter ofthe SYSOUT field is used for the assembler listing output directed to SYSPRINT. Thisform has been defined by the administrator in the form table FORM7A1. The entry in theform table selects control file processing member DFLTL2UP which selects a formdef,pagedef, and character set that will produce 2 listing pages per physical sheet. The systemdata sets select by default the form STD, also defined by the SPS administrator in the formtable. Form STD selects the control file processing defined in member DFLTSTD whichselects a formdef, pagedef, and character set that will process system output producing asimilar appearance to 3211 output.

3 These examples work equally well for direct printing data streams when the SYSOUT statement is changed

to "//userdd DD SUBSYS=(SPSD,PRTn),DCB=(userdcb)" and the direct printing JCL is included in theEXEC step of the procedure. The model for direct printing JCL may be found in SPS.SPSSAMP memberSPSDPROC.


U21020-J-Z247-7-7600 85

5.6.2 Example 2: Requesting AFPDS Options by the JCL Parameters

Now suppose that a user familiar with standard AFPDS JCL parameters wishes to select aparticular formdef, pagedef, and character set for a job output. The user wants all the joboutput including the system data sets to use the same pagedef, formdef, and characterset. This user can use the administrator defined form JCL to cause all JCL fields to beprocessed in the standard manner (please see Figure 4). The user JCL may be found inFigure 20.

USER JCL: User JCL requesting AFPDS Options By JCL Parameters

//............. JOB ..............//ALLDSN OUTPUT JESDS=ALL,DEFAULT=YES,FORMS=JCL,// FORMDEF=010110,PAGEDEF=A06462,CHARS=CE10//............. EXEC ..............//SPSPRINT DD SYSOUT=W

Figure 20: JCL Coding For Example 2: Requesting AFPDS Options by the JCL Parameters.

Explanation (please refer to Figure 4 and preceding figures): The form name JCL in theform parameter has been defined by the administrator in the form table FORM7A1. Nopredefined processing for this form name has been requested, so all processing will comeeither from the JCL or from a user control file (if requested in the JCL). Since no usercontrol file has been requested in the JCL (see "How is User Control File ProcessingRequested for Output" on page 82), all the parameters specified in the JCL will be used. Inparticular the formdef, pagedef, and chars parameters 010110, A06462, and CE10respectively, will be used. The system output will use the user specification becauseJESDS=ALL has been specified on the OUTPUT statement. Had a user control file beenspecified, those specifications would have overridden the JCL specifications.

5.6.3 Example 3: Requesting User Defined Options from User Control File

Now suppose that a user with authorization to use user control files (please see "Example3: Adding User Control File Support" on page 22) has all print processing defined in theuser control file MYCTLFLE. The user is using formdef MYFORM and pagedef MYPAGE,however MYFORM specifies DUPLEX and MYPAGE specifies the GT10 character set.The user wants SIMPLEX and the character set SI0A (German serif). The user JCL anduser control file may be found in Figure 21.


86 U21020-J-Z247-7-7600

User JCL: User sysout DD requesting user control file

//SPSPRINT DD SYSOUT=W,// MODIFY=####,CHARS=(GENU,SER,MYCT,LFLE)

SPS.CTLGEN(MYCTLFLE): User control file for print job

FORMDEF(MYFORM)PAGEDEF(MYPAGE)CHARS(SI0A)DUPLEX(SIMPLEX)

Figure 21: JCL and User Control File Coding For Example 3: User Defined Options From a User ControlFile.

Explanation (please refer to Figure 5 and preceding figures): The user has specified thetrigger #### in the MODIFY field of the JCL. This value is checked in the printer statementfor the printer in member SPSPRINT in SPS.SPSPARM. Since it is the trigger for theprinter, SPS evaluates whether the CHARS field might be a control file specification. Thecontrol key data set list member for the printer is found to be KEY7A1 from the printerdefinition statement. The first two CHARS fields are concatenated to form GENUSER andthis name is checked to see whether it is a valid control key in the control key data set listmember KEY7A1. Since it is a valid control key, the third and fourth CHARS fields areconcatenated to form MYCTLFLE. This member name is searched in the control data setSPS.CTLGEN selected by the control key GENUSER. The member MYCTLFLE is foundin this data set and its contents are used as the user defined print options (user controlfile). In this member, the user has specified formdef MYFORM and pagedef MYPAGE;also SIMPLEX has been specified as an override to formdef MYFORM, and the characterset SI0A has been requested as an override to the pagedef MYPAGE.


U21020-J-Z247-7-7600 87

5.7 APA Hierarchy of Override and DefaultsFigure 22 shows the hierarchy of override for APA parameters from all sources for APAprinters. The override order is from top down, each level overriding all sources under it,with user control files overriding all other sources.

Level Description

8 User control files (from JCL MODIFY and CHARS)

7 Forms control files

6 Selected FORMDEF and PAGEDEF from whatever source used

5 AFPDS print data stream

4 JCL

3 JES parameter member of SYS1.PARMLIB

2 SPS setup member for the printer in SPS.SPSPARM

1 SPS system defaults

Figure 22: APA Parameter Override Hierarchy

Table 1 in Appendix A has a list of all APA printer parameters with their possible sourcesand override order. You may use the FDIS SPS command or the PRINTOPT SETUPxxxor control file option in order to obtain a list of all printing options being used and theirrespective sources.

APA control file support provides the ability to override values coded in formdefs andpagedefs. The processing of formdefs and pagedefs is a two step process in the hierarchytable. First the name of the formdef or pagedef is determined using the hierarchy table. Alllevels 1-8 with the exception of level 5 have parameters that could provide the name of aformdef or pagedef to be used. The name provided by the highest level will be used. Thesecond step uses the formdef or pagedef selected as level 6. Note that the formdef orpagedef selected may be coded in the AFPDS data stream. Specifications within theselected formdef or pagedef will be overridden by requests made in levels above 6. Thismeans user and forms control file specifications will override values coded in formdefs andpagedefs (see Figure 22). When no specific requests are made in the user or form controlfiles, formdef and pagedef processing will take place normally. Any fields not coded in theformdef or pagedef, but coded in the JCL or other sources lower than level 5 will be used.Figure 23 lists the currently supported control file parameters for APA printers that may beused to override values coded in formdefs and pagedefs.


88 U21020-J-Z247-7-7600

Parameter Description

CHARS Character set list for table reference character processing

DUPLEX Controls simplex, duplex, or tumble processing and the presentation

INBIN Selects input forms bin or form name

OUTBIN Selects output stacker

PRESENTATION Controls the presentation

X2UP Prints two input pages on one output page

Figure 23: Control File Parameters That Can Override an APA Formdef or Pagedef Specification

5.8 SPS System Defined Defaults for APA PrintersSPS has system defined defaults for all possible parameters. These defaults are filled inafter all possible user or installation coded sources have been processed. In the APAparameter hierarchy (see Figure 22) this is at level 1.

The system defined defaults will always be used for control file specifiable parameterswhen a value is not supplied by some other source in the parameter hierarchy (see Figure22). These values for control file specifiable parameters may be found in Figure 24. Asummary of all possible APA printer parameters, their possible sources, and the overrideorder may be found in Table 1 on page 217 in Appendix A.

You may use the FDIS SPS command or the PRINTOPT SETUPxxx or control file optionto obtain a list of all printing options used and their sources.

Parameter System Default

DUPLEX SIMPLEXINBIN AOUTBIN 1PRESENTATION NO OVERRIDETRCTYPE IBMX2UP NO

Figure 24: SPS System Defaults for APA Printers: These values are always used when no other sourceprovides a value for the parameter.


U21020-J-Z247-7-7600 89

5.9 APA Override ExamplesFormdef and pagedef coded information from all sources will be overridden by userspecified control file parameters or installation specified forms control file parameters.These resource types may be read from system libraries, user libraries, or inline from theAFPDS print data stream. The resolution of formdef and pagedef parameters is a two stepprocess:

1. First the name of the selected resource is determined by the hierarchy table in Figure22 on page 87.

2. Then the contents of the resource is used as level 6 in the table to determine theoverrides of specified values and resolution of unspecified values.

Overrides are resolved by determining the highest level in which the parameter is codedand substituting that value. In all situations where no overrides are specified in the formscontrol file or user control file (requests above level 6) the resource itself controls the printcharacteristics to be used. When an option is not specified in the resource, then thatoption will be taken from the first source available in the hierarchy below level 6. When anoption is specified in the resource, the resource specification will be used.

A few examples may help to clarify the override order. Suppose for an APA printer that:

1. The input bin is specified in the forms control file using the INBIN parameter.

2. The input bin is specified in the formdef to be used for the print data set.

3. The user requests user control file processing in the JCL.

4. The user specifies an input bin in his user control file using the INBIN parameter.

5. The user requests the use of the forms control file by specifying FORMCTL(YES) in theuser control file.

The input bin in the user control file will override all other sources. This is because a usercontrol file specification is at level 8 in Figure 22 on page 87, higher than any otherspecification. If the input bin was not specified in the user control file, then the formscontrol file input bin would be used. This is because a forms control file is at level 7 andwould override a formdef specification which is at level 6.

Now suppose that:

1. A formdef is requested in the user control file.

2. A formdef with a different name is inline in the IPDS data stream.

3. The formdef name of the inline formdef is requested in the JCL.

4. DUPLEX is specified in the formdef requested by the user control file.

5. SIMPLEX processing is requested in the forms control file by specifyingDUPLEX(SIMPLEX).


90 U21020-J-Z247-7-7600

6. The user requests user control file processing in the JCL.

7. The user specifies DUPLEX(TUMBLE) in the user control file.

The formdef specified in the user control file will be used to print and determine the duplexoption. Inline formdefs to be used must be requested either in the user control file, formscontrol file, or the JCL or you should request FORMDEF=DUMMY in the control file orJCL. The request for the inline formdef in the JCL is at level 4, which is lower than the usercontrol file request at level 8, so it is overridden by the user control file request. If noformdef request were in the user control file, the inline formdef would be used to controlprinting and determine the duplex option.

The contents of the selected formdef are used at level 6 in the hierarchy chart todetermine the duplex option to be used. TUMBLE processing will be used because theuser control file specifying TUMBLE is at level 8, and overrides the formdef specification atlevel 6. If the user control file did not request a DUPLEX option, then SIMPLEX processingwould be used because a forms control file is at level 7, and overrides a formdef codedoption at level 6. If neither user nor forms control files were coded, the DUPLEX specifiedin the formdef would be used.

APA Control File Parameters

U21020-J-Z247-7-7600 91

6 APA Control File Parameters

The parameters described in this section can be specified in any user control filerequested in the JCL or in a forms control file. The parameters apply to APA printers underJES spool processing or direct printing. FORMCTL is only meaningful in a user controlfile. Any parameter specified for a printer or control file type that is not applicable will beignored, but will not be considered an error or terminate processing of a data set.

With the exception of FORMCTL, no control file parameters have defaults at the controlfile level. SPS system defaults will be used for all parameters that have not acquired avalue from some other source. The SPS system defaults supplied may be found in Figure24.

You may use the FDIS SPS command or the PRINTOPT control file/SETUPxxx option toobtain a list of all printing options in effect with their respective sources.


92 U21020-J-Z247-7-7600

6.1 APA Control File Statement Formats

CC(SNI)CHARS(font | 'font(mxm)' | 'font(mxm)',...,font )COMP38MO (YES | NO)COPIES (num-copies, first-page, last-page | EOF)DATACK([BLKCHAR][,BLKPOS])DUPLEX(SIMPLEX | NORMAL | TUMBLE | ZZNORM | ZZTUMB

| RSIMPLEX | RNORMAL | RTUMBLE | RZZNORM | RZZTUMB)ENDBCS (YES | NO)ETFF (YES | NO)ETFH (YES | NO)FLIP (YES | NO)FORMCTL(YES | NO)FORMDEF (formdef-name | DUMMY)FPRUN (YES | NO | SINGLE | DOUBLE)INBIN(A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | A4 | A4UNCUT | A3 |A3UNCUT | B4 | LETTER | LEGAL| LEDGER)IBINSUB (YES | NO)OUTBIN(1 | 2)PAGEDEF(pagedef-name | DUMMY)PRESENTATION (LEAVE | PORTRAIT | LANDSCAPE | PORTRAIT90 | PORTRAIT180 |LANDSCAPE90 | LANDSCAPE180)PRINTOPT (YES | NO)SPOOLMSG (YES | NO)TRCTYPE(IBM | SNI | XEROX)TWINMSGS(NPRO | NONPRO)WRONLY (YES | NO | FONT | PSEG | OVLY | FDEF | PDEF | HWFEAT | RESCONF)X2UP(OFF | ON | LEFT | RIGHT | ICOPIES)

Figure 25: Format of the APA Control File Member Statements: All keywords are optional. Each controlstatement has only one keyword.


U21020-J-Z247-7-7600 93


CC (SNI)

SNI standard carriage control characters are to be used for this file.

CHARS ('font(mxm)' | font,'font(mxm)' | font,...,'font(mxm)' | font)

A list of up to 64 font names, optionally with the matrix memory (mxm)position in which they are to be loaded. This list overrides any fontsspecified in the pagedef or data stream. Each font name is 1 to 6characters in length. The complete font name in the library consists of a 2-character prefix, which depends on the printer type, followed by the namespecified here. SPS generates this name at execution time.

The mxm position corresponds to the trc value in the print data set that willselect the particular font. SPS supports trc's (mxm positions) from 0 to 63,when specified in this parameter. The mxm's can be in any order. Mxmposition 0 must always be coded if the CHARS parameter is specified.This is because when a CHARS list is present, position 0 is used to printtrc's requesting mxm positions that have not been loaded.

The mxm's can be in any order. When the mxm position is not explicitlycoded, mxm positions start at 0 and increment by 1 for each font namecoded in the parameter statement. When an mxm field is specified with afont, that font is loaded into the specified mxm position and the next fontspecified, if it doesn’t have an mxm position coded, will be loaded into themxm plus 1 position. For example:

CHARS(GT10,'GT12(11)',GT15)

would cause GT10 to be loaded into mxm position 0, GT12 into position 11and GT15 into position 12. This means a 0 trc would select GT10, an 11 trcwould select GT12, and a 12 trc would select GT15. All other trc's (mxmpositions) would have no font defined.

COMP38MO (YES | NO)

Controls the setting of the media origin.

NO The media origin will be set according to the rules definedfor AFP1 type printers.

YES If a FORMDEF is used which has no presentationparameter, the media origin will be set according to therules valid for 3800 model 3 page printers.


94 U21020-J-Z247-7-7600

COPIES (num-copies, first-page, last-page | EOF)

Number of copies to be printed from a specific range of logical pages ofthe output file. Any number of copies parameters may be contained in acontrol file. SPS processes them in the specified order. If any copiesstatement is specified in the control file, the copies parameter from the JCLis ignored.

num-copies Number of copies requested. A value from 1 to 32767 maybe specified. This subparameter is required.

first-page First logical page to be printed in all copies. A value from 1to 2147483647 may be specified. This subparameter isoptional. The default is 1.

last-page Last logical page to be printed in all copies. A value from 1to 2147483647 or EOF may be specified. Thissubparameter is optional. The default is EOF.

DATACK ([BLKCHAR][,BLKPOS])

Selects how data checks are to be handled for invalid characters, and offpage print requests. When DATACK is not specified in a control file andalso not specified in the JCL, the defaults specified in SETUPxxx will beused. When no defaults are requested in SETUPxxx, errors will beprocessed unblocked. When either of the options is selected, no othersource will be considered. Any unspecified option will be processed asunblocked. Data checks will not be blocked unless requested by thisparameter, in the JCL, or in SETUPxxx.

BLKCHAR Undefined character data checks should be suppressed.Please note that you may also block characters in the fontused.

BLKPOS Requests to print in positions outside the valid printablearea will be suppressed, printout will not be terminated.

DUPLEX (SIMPLEX | NORMAL | TUMBLE | ZZNORM | ZZTUMB | RSIMPLEX |RNORMAL | RTUMBLE | RZZNORM | RZZTUMB)

Determines whether printing will be on one or both sides of a form; thedirection of printing of the second side in relation to the first side when twosided printing is requested; and for the zigzag options, the order of thepages. These options select the proper orientation of the text on the pagefor left or top binding requirements.

These options will override the formdef specification.

The use of the DUPLEX parameter in a control file overrides theFORMDEF-specified orientation and direction as well as the relation


U21020-J-Z247-7-7600 95

between front and back pages of a twin or duplex printer, whatever thedefinition in the formdef was. When DUPLEX is not specified in a controlfile then the FORMDEF-adjustments are in effect. This gives you thechance to customize orientation, direction and front/back relation in aneasier way, without changing the FORMDEF used.

If you just want to override the orientation from the FORMDEF, use thePRESENTATION option. If you want to override the simplex/duplexspecification only, specify PRESENTATION (LEAVE) together with theDUPLEX specification.

The zig-zag specifications are not valid if N-UP or X2UP are requested inthe formdef or control file.

SIMPLEX Simplex printing requested. Simplex printing is single sidedprinting on a portrait page. For continuous forms aftermachine bursting, and cut sheet as stacked, this optionpermits binding a single sided portrait document on the leftor top side.

NORMAL Normal duplex printing requested. Normal duplex printing istwo sided printing with the top of the front page being thetop of the back page on a portrait page. For continuousforms after machine bursting, and cut sheet as stacked,this option permits binding of a two sided portrait documenton the left side.

TUMBLE Tumble duplex printing requested. Tumble duplex printingis duplex printing with the bottom of the front page beingthe top of the back page on a portrait page. For continuousforms after machine bursting, and cut sheet as stacked,this option permits binding a two sided portrait formatdocument on the top.

ZZNORM Zigzag normal duplex printing requested. Zigzag normalduplex printing is two sided printing on continuous formswith the top of the front page being the top of the back pageon a portrait page after three sided cutting of edges (top,right, and bottom). This option permits binding a two sidedportrait document on the left side after the cut edges areremoved. This option is only used on twin printers.

ZZTUMB Zigzag tumble duplex printing requested. Zigzag tumbleduplex printing is two sided printing on continuous formswith the top of the front page being the bottom of the backpage on a portrait page after three sided cutting of theedges (right, left, and bottom). This option permits binding a


96 U21020-J-Z247-7-7600

two sided portrait document on the top side after the cutedges are removed. This option is only used on twinprinters.

RSIMPLEX Reverse simplex printing requested. Reverse simplexprinting is single sided printing on a landscape page. Forcontinuous forms after machine bursting, and cut sheet asstacked, this option permits binding a single sidedlandscape document on the left side or top.

RNORMAL Reverse normal duplex printing requested. Reverse normalduplex printing is two sided printing with the top of the frontpage being the top of the back page on a landscape page.For continuous forms after machine bursting, and cut sheetas stacked, this option permits binding a two sidedlandscape format document on the left side.

RTUMBLE Reverse tumble duplex printing requested. Reverse tumbleduplex printing is duplex printing with the bottom of the frontpage being the top of the back page on a landscape page.For continuous forms after machine bursting, and cut sheetas stacked, this option permits binding a two sidedlandscape format document on the top.

RZZNORM Reverse zigzag normal duplex printing requested. Reversezigzag normal duplex printing is two sided printing oncontinuous forms with the top of the front page being thetop of the back page on a landscape page after three sidedcutting (top, right, and bottom). This option permits bindinga two sided landscape document on the left side after thecut edges are removed. This option is only used on twinprinters.

RZZTUMB Reverse zigzag tumble duplex printing requested. Reversezigzag tumble duplex printing is two sided printing oncontinuous forms with the top of the front page being thebottom of the back page on a landscape page after threesided cutting (right, left and bottom). This option permitsbinding a two sided landscape document on the top afterthe cut edges are removed. This option is only used on twinprinters.


U21020-J-Z247-7-7600 97

ENDBCS (YES | NO)

This parameter controls the activation of the enhanced SOSI feature ofSPS for Double Byte Character Sets (DBCS).

NO SPS processes the SOSI bytes in a PSF compatible way,i.e., you may specify only 2 fonts, the first should be asingle byte font and the second a double byte font. TheSOSI bytes may be used to switch from font one to font twoand vice versa.

YES With this option an enhanced SOSI processing is supportedby SPS. In this mode, you may specify as many single anddouble byte font pairs as you want. Each pair should havefirst a single byte font and following it a double byte font.For example, a valid CHARS would be:


You may switch between each pair via TRC controlcharacters, but you must always specify the TRCcorresponding to a single byte font. After "landing" in thesingle byte font from a pair you may switch to itscorresponding double byte font via the SHIFT-OUT byte,and return to the single byte font via the SHIFT-IN byte.

When you specify ENDBCS(YES) you have the followingrestriction:

If you specify DBCS in the PAGEDEF, you may not haveSOSI bytes in your data-STREAM; and you may not specifythe PRMODE=SOSIX parameter in your JCL.

ETFF (YES | NO)

Eject to front facing sheet option for fanfold printers.

YES SPS will issue an 'eject to front facing sheet' before eachBDT structured field found in the input data or anyinformation page, if the printer supports the eject to frontfacing sheet command.

NO SPS will not issue EFFS commands for BDT SF.


98 U21020-J-Z247-7-7600

ETFH (YES | NO)

YES SPS will issue an 'eject to front facing sheet' before writingthe header page, if the printer supports the eject to frontfacing sheet command.

NO SPS will not issue an 'eject to front facing sheet' beforewriting the header page.

FLIP (YES | NO)

Valid for A-Twins only. Exchange of the output from printer 1 (front pages)with printer 2 (backpages).

NO Do not exchange.

YES Exchange it.

FORMCTL Selects whether a forms control file should be used to resolve parametersnot coded in a user control file. This parameter is only valid in a usercontrol file. YES is the default if FORMCTL is not coded.

YES Use the forms control file, if any, to resolve parameters notcoded in the user control file.

NO Ignore the forms control file, if any, when resolvingparameters not specified in the user control file.

FORMDEF (formdef_name)

A 1 to 6 character name of the form definition to be used in printing theprint data stream. This name is the same name the user would specify inthe JCL keyword FORMDEF. Please see "Inline Formdefs and Pagedefs"on page 120 for more information on inline formdefs.

The complete resource name in the library consists of the two characterprefix F1 followed by the name specified here. SPS generates this name atexecution time.

FPRUN (YES | SINGLE | DOUBLE | NO)

Specification of the font pruning function. When font pruning is requestedSPS loads on the printer only the characters defined in the code page (andnot all characters defined in the font character set).

NO SPS should not do font pruning.

YES SPS should make font pruning for single and double bytefonts.

SINGLE SPS should make font pruning for single byte fonts only.

DOUBLE SPS should make font pruning for double byte fonts only.


U21020-J-Z247-7-7600 99

INBIN (A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | A4 | A4UNCUT |A3 | A3UNCUT | B4 | LETTER | LEGAL | LEDGER)

Selection of the input bin from which to take the form on a page printer.The selection is by physical bin or by standard form name. When astandard form name is used, the input bin on the printer containing theform will be selected. Please see also the IBINSUB option for informationabout not available input bins.

A Take form from bin A.

B Take form from bin B.

C Take form from bin C.

D Take form from bin D.

E Take form from bin E.

F Take form from bin F.

G Take form from bin G.

H Take form from bin H.

I Take form from bin I.

J Take form from bin J.

K Take form from bin K.

L Take form from bin L

M Take form from bin M.

N Take form from bin N.

O Take form from bin O.

P Take form from bin P.

A4 Take form from a bin that currently contains DIN A4 forms(8.27" x 11.69").

A4UNCUT Take form from a bin that currently contains DIN A4 uncutforms (8.27" x 11.69").

A3 Take form from a bin that currently contains DIN A3 forms(11.69" x 16.54").

A3UNCUT Take form from a bin that currently contains DIN A3 uncutforms (11.69" x 16.54").

B4 Take form from a bin that currently contains DIN B4 forms(10.12" x 14.33").


100 U21020-J-Z247-7-7600

LETTER Take form from a bin that currently contains letter sizeforms (8.50" x 11.69").

LEGAL Take form from a bin that currently contains legal sizeforms (8.50" x 14.00").

LEDGER Take form from a bin that currently contains ledger sizeforms (11.00" x 17.00").

IBINSUB (YES | NO)

Input bin substitution function.

NO If a desired input bin is not available on a cut-sheet printer,SPS will terminate the printing of the output file.

YES If a desired input bin is not available on a cut-sheet printer,SPS will use the first available input bin instead of thedesired one.

OUTBIN (1 | 2)

Determines into which stacker the printed form will be stacked. The lettersA and B corresponding to stacker 1 and 2 respectively, and are alsoaccepted for compatibility with previous releases.

1 Place form in stacker 1.

2 Place form in stacker 2.

PAGEDEF (pagedef-name)

A 1 to 6 character name of the page definition to be used in printing theprint data stream. This name is the same name the user would specify inthe JCL keyword PAGEDEF. Please see "Inline Formdefs and Pagedefs"on page 120 for more information on inline pagedefs.

The complete resource name in the library consists of the two characterprefix P1 followed by the name specified here. SPS generates this name atexecution time.


U21020-J-Z247-7-7600 101

PRESENTATION (LEAVE | PORTRAIT | LANDSCAPE | PORTRAIT90 | PORTRAIT180 | LANDSCAPE90) | LANDSCAPE180)

Allows the presentation specification from the FORMDEF to be used, evenif duplex is specified in the control file. When the DUPLEX parameter is notspecified in a control file, this parameter overrides only the presentationspecification from the FORMDEF. The specification of this parameter(PORTRAIT, LANDSCAPE, etc.) affects cut-sheet printers even when theFORMDEF does not specify N-UP. Normally, for non-N-UP FORMDEFs,you can not change the presentation of cut-sheet printers from PORTRAITvia the FORMDEF.

LEAVE Presentation specified via file resources should be used bySPS and will not be affected by the duplex parameterspecified on the control file. The duplex parameter mayoverride only the duplexing feature. So, duplex(simplex)and duplex(rsimplex) will have the same effect,duplex(normal) and duplex(rnormal) will have the sameeffect, and so on.

PORTRAIT SPS should force presentation PORTRAIT, regardlesswhat the external resources specify or what the duplex()parameter specifies. So, duplex(simplex) withpresentation(PORTRAIT) has the same result asduplex(simplex) only. Duplex(rsimplex) withpresentation(PORTRAIT) has the same effect asduplex(simplex) only.

LANDSCAPE SPS should force presentation LANDSCAPE, regardlesswhat the external resources specify or what the duplex()parameter specifies. So, duplex(rsimplex) with presentation(LANDSCAPE) has the same result as duplex (rsimplex)only. Duplex(simplex) with presentation (LANDSCAPE) hasthe same effect as Duplex (Rsimplex) only.

PORTRAIT90 SPS should force presentation PORTRAIT90, regardlesswhat the external resources specify or what the duplex()parameter specifies. So, if duplex(rsimplex) orduplex(simplex) is specified SPS will always print withpresentation PORTRAIT90.

PORTRAIT180 SPS should force presentation PORTRAIT180, regardlesswhat the external resources specify or what the duplex()parameter specifies. So, if duplex(rsimplex) orduplex(simplex) is specified SPS will always print withpresentation PORTRAIT180.


102 U21020-J-Z247-7-7600

LANDSCAPE90 SPS should force presentation LANDSCAPE90,regardless what the external resources specify or what theduplex() parameter specifies. So, if duplex(rsimplex) orduplex(simplex) is specified SPS will always print withpresentation LANDSCAPE90.

LANDSCAPE180 SPS should force presentation LANDSCAPE180,regardless what the external resources specify or what theduplex() parameter specifies. So, if duplex(rsimplex) orduplex(simplex) is specified SPS will always print withpresentation LANDSCAPE180.

PRINTOPT (YES | NO)

If YES is specified, SPS prints on the message page a list of all optionsused to print the output file (like PAGEDEF, COPYMARK, INBIN,USERLIB, etc.). It will also identify the corresponding source from wherethey were obtained (JCL, SETUPxxxx, defaulted, forms control file, etc.).This list may be used for diagnostic purposes in cases where an output fileis not correctly printed or when a printing option seems to be obtained fromthe wrong source. The same listing may be also obtained via the SPScommands FDIS, if the command is issued while the output file is beingprinted (also at intervention required state). Via the FDIS command, thislisting may be also directed to the system console or to the hardcopy log.See “SPS commands“ for more information about the FDIS command.

SPOOLMSG (YES | NO)

If NO is specified any warning or error messages related to an output fileare printed just after the output file itself in the so-called message page. IfYES is specified, the diagnostic messages are written into a spool filewhich is dynamically allocated when the output file is stacked. Thisdynamically allocated file is also immediately spun off, so that it can beprinted or viewed in the spool according to its file options. These optionsare specified in the OUTPUT statement SPSOnnnn, which should becoded in the SPS procedure for each printer. With SPOOLMSG (YES) youmay retain the SPS diagnostic messages in the spool or print them in asmall LU1 printer. You may code NOTIFY= in the SPSOnnnn OUTPUTstatement so that you are informed at your TSO terminal that a messagepage was printed on the LU1 printer.

TRCTYPE (IBM | SNI | XEROX )

Selects the type of table reference character (TRC) processing for printdata sets which specify TRC. The presence of table reference charactersis indicated by the user in either the JCL OUTPUT statement (TRC=YESparameter) or DD statement (DCB=OPTCD=J parameter). The DCB


U21020-J-Z247-7-7600 103

parameter can also be coded in the user program. If no TRC is specified inthe print data set, this parameter is ignored.

Fonts which may be selected by TRC are loaded into matrix memorypositions (MXM's) in the printer as determined by one of the following:

1. User control file CHARS list as specified

2. Forms control file CHARS list as specified

3. PAGEDEF font list order starting at mxm 0 (if not a default PAGEDEF).

4. JCL CHARS list order starting at mxm 0

5. Default PAGEDEF font list order starting at mxm 0

Table reference characters select the matrix memory position in which afont is loaded. IBM TRCs support mxm positions 0 through 127, SNI TRCssupport mxm positions 0-254.

IBM Interpret TRC as an IBM table reference character. One ofthe following rules apply to IBM TRCs depending where thefont list is taken from and the highest loaded mxm position.

1. TRC's may be characters 0-3 (X'F0'-X'F3') or X'00-X'03'. The characters 0-3 are converted to X'00'-X'03'to determine the mxm position.

2. TRC's may be hex characters X'00'-X'7F'.

When an IBM TRC is invalid, or addresses an mxm that isnot loaded with a font, the font at mxm 0 is used. Due to thecoding requirements of JCL CHARS, PAGEDEFs, andcontrol file CHARS lists, mxm 0 always contains either thedefault font or a font selected by the font list source.

The following table shows which of the above rules applies,depending on where the font list is taken from and thehighest loaded mxm position. The font list used will be thefirst not empty font list source encountered going down the"source of font list" column. The number of the TRC rulethat applies is the number found at the intersection of thecolumn indicating highest loaded mxm position and theselected font list source row.


104 U21020-J-Z247-7-7600

SOURCE OFFONT LIST

HIGHEST LOADEDMXM POSITION

0 - 3 4 – 127User control file (1) (2)Form control file (1) (2)PAGEDEF (1) (2)CHARS (1) -

SNI Interpret trc as an SNI table reference character. SNI TRCscan be hex characters X'00' - X'FE', which select mxmpositions 0-254, respectively. When an SNI TRC is invalid,or addresses an mxm that is not loaded with a font, the fontat mxm 0 is used. Due to the coding requirements of JCLCHARS, PAGEDEFs, and control file CHARS lists, mxm 0always contains either the default font or a font selected bythe font list source.

XEROX Interpret TRC as a XEROX table reference character.XEROX TRC characters can be hex characters X'F0' toX´FF´, which select mxm positions 0-15 respectively.

TWINMSGS (NPRO | NONPRO)

Specifies message page processing on the twin printer. When notspecified the value from SETUPxxx will be used.For a similar option, please see the SPOOLMSG parameter also.NPRO Perform a nonprocess run out before the message data set

is processed. This forces the print data set into the stackerbefore any messages are printed.

NONPRO Start the message page immediately after printing the lastpage of the print data set. A copy of all the messages forthe job will be reprinted in a separate spool file if messagesare issued that cannot be printed with the print data set(please see "Twin Printer OUTPUT Statement" in theSPS/MVS Installation Guide for full description). NONPROis the default when not specified.


U21020-J-Z247-7-7600 105

WRONLY ([FONT] [,PSEG] [,ONLY] [,PDEF] [,HWFEAT] [,RESCONF] | YES | NO)

Warning only function. The warning only function allows SPS to continueprocessing when certain kinds of errors occur. SPS will issue a warningmessage, but will try to continue printing the output file.NO SPS will terminate the printing of the output file when any of

the errors below occur.

FONT SPS will issue a warning message and continue printoutwhen a font is not found.

PSEG SPS will issue a warning message and continue printoutwhen a page segment is not found.

OVLY SPS will issue a warning message and continue printoutwhen an overlay is not found.

FDEF SPS will issue a warning message and continue printoutwhen a formdef is not found.

PDEF SPS will issue a warning message and continue printoutwhen a pagedef is not found.

HWFEAT SPS will issue a warning message and continue printoutwhen a hardware feature is not available or installed on theprinter.

RESCONF SPS will issue a warning message and continue printoutwhen a conflict exists between the output file and itsrequested resources.

YES SPS will issue a warning message and continue printoutwhen any of the errors described above occur.

X2UP (OFF | ON | LEFT | RIGHT | ICOPIES)

Selects whether the two up feature should be used to print the data set.The two up feature is a software controlled hardware function that causestwo input pages of the print data stream to be printed on one physicaloutput page. Please see "Hardware Two Up" on page 124 for anexplanation about the relationship between hardware two up and softwaretwo up.

OFF Set the printer to one up. This will be the default if thisparameter is not specified, and corresponds to the sameprintout as if the printer does not have the two up feature.

ON Use the two up feature to print two consecutive input pageson each physical output page.The consecutive input pages (1,2,3,4,5,..) are printed on


106 U21020-J-Z247-7-7600

the paper in a left→right sequence:page 1 on the left side of sheet 1page 2 on the right side of sheet 1page 3 on the left side of sheet 2page 4 on the right side of sheet 2page 5 on the left side of sheet 3....For a twin-system, the page sequence on the paper is:page 1 on the left front side of sheet 1page 2 on the right back side of sheet 1

(= backside of page 1)page 3 on the right front side of sheet 1page 4 on the left back side of sheet 1

(= backside of page 3)page 5 on the left front side of sheet 2page 6 on the right back side of sheet 2


(= backside of page 7)....

LEFT The same as ON

RIGHT Similar to ON, except the page sequence on the paper isright→left instead of left→right.

ICOPIES Use the two up feature to print two copies of each inputpage on each physical output page.

Direct Printing

U21020-J-Z247-7-7600 107

7 Direct Printing

7.1 Overview

7.1.1 What is Direct Printing

Direct printing is the SPS support that makes it possible for a user application to printdirectly to an online APA Printer allocated to the application, without passing through thespooling system. Full conversion of Siemens Nixdorf Printer Data Stream (SPDS) input toSNI Intelligent Printer Data Stream (SNIPDS) output is performed transparent to the userapplication and the data management routines that it uses (OPEN, PUT/WRITE, CLOSE).This support is provided for both single and twin printer models.

7.1.2 Special Supported Functions

The following functions, generally not supported in other direct printing subsystems, areavailable under the SPS direct printing subsystem:

• Job header and trailer pages (HDRDP SETUPxxx parameter)

• Mark forms (HDRDP SETUPxxx parameter)

• SMF record 6 recording

• Accounting exit

• Input record exit

• Message exits

•••• Forms setup processing (SETUPDP SETUPxxx parameter)• Data-set allocation exit

• User libraries

• Notification of print completion

Direct Printing

108 U21020-J-Z247-7-7600

• User variables in header and trailer pages

• Use of user defined BUFNO and BLKSIZE DCB parameters

•••• Selection of different print session options (SETUPxxx) controlled by the applicationprogram at open time

•••• Eliminate unnecessary NPRO processes

For more information on using and coding header/trailer pages and user variables, as wellas accounting (SMF recording), input record, and message exits, please see: "OptionalSystem Tailoring" on page157. For the mark forms specification, please see HDRDP,under "SETUPxxx APA Key Word Descriptions" on page 44. Refer to the JCL ReferenceManual for information on how to use user libraries. Print notification and DCB parametersare discussed later in this chapter under "Direct Printing Programming Considerations" onpage 115.

7.1.3 Unsupported Functions

• Checkpoint/restart

• JES printer commands

• Recovery after output errors

• Multiple print files in one SPS print session

• Multiple tasks opening and closing SPS printers

• The information page variables: CLAS, DEST, SEGI, JOID, PGNA

•••• Use of the SETPRT macro

Direct Printing

U21020-J-Z247-7-7600 109

7.2 How is SPS Direct Printing Made AvailableSPS direct printing is available to user applications after installation of SPS. The standardSMP installation of SPS installs all modules needed for direct printing. The post SMP stepsinclude the definition of the SPS subsystem SPSD in the subsystem definition memberIEFSSN00 of SYS1.PARMLIB4.

In order to facilitate and control the use of direct printing by users, the SPS Administratorshould set up a basic mode of use. The following tasks should be performed:

1. Define the direct printers

2. Code the printer JCL inserts

3. Establish authorization (if required)

7.2.1 Define the Direct Printers

The direct printer must be defined in the printer table SPSPRINT in SPS.SPSPARM.Usually a printer is already defined if the printer is also to be used by JES. If the printer isnot defined as a JES printer, the name of the direct printer in the printer table can be anyname 2 to 8 characters that begins with an alphabetic character and ends with a number.More than one entry in the printer table for the same direct printer is allowed. This makespossible different initialization parameters for the same printer under different directprinting jobs. For more information about coding the SPSPRINT member please see "4.2APA Printer Table: SPSPRINT" on page 36.

The desired direct printing parameters should be coded for the printer. If the printer is tobe used under its JES definition, only the choices for HDRDP, MSGEXDP, NPRO, andSETUPDP need be examined. When special direct printer entries are being used in theprinter table all members pointed to by the printer table entry can be coded specially forthe direct printing processing being defined. These members include: SETUPxxx,FORMxxx, MSGSUxxx, KEYxxx, HSMTffff, and DFLTffff. For information about codingthese members please see "APA System Parameter Descriptions" on page 33.

The application program may override the SETUPxxx member to be used in an SPS printsession to be opened. (see 'Direct Printing Programming Considerations' later).

4 To prevent the use of direct printing in an installation it is only necessary to remove the SPSD subsystem

definition statement from IEFSSN00.

Direct Printing

110 U21020-J-Z247-7-7600

7.2.2 Code the Printer JCL Inserts

When SPS is used in direct printing mode by an application, all of SPS executes in theapplication address space. In order for SPS to execute in the application address space alldata sets and libraries required for SPS execution must be allocated in that addressspace. The direct printing JCL insert member provides the necessary JCL to theapplication execute step for these allocations. The insert member is essentially the sameas the SPS startup procedure for JES, but without the execute card.

An insert member should be created for each physical printer defined in the SPSPRINTmember of SPS.SPSPARM that will be used for direct printing. More than one entry for aphysical printer may be defined. Each entry for the same physical printer should use thesame insert member, provided that all the SPS data sets and libraries are the same. Eachinsert member defines all the data sets and libraries that are required for direct printing ona particular printer. Different physical printers will generally require different insertmembers because the trace and dump data sets should be unique for each physicalprinter. A single printer may require several insert members if different libraries are to beused for different jobs.

Figure 26 on page 111 shows a JCL insert member for one APA printer (either single ortwin) with the recommended data sets. The suggested naming conventions have beenused. A model direct printing JCL insert member is provided in SPSDINC ofSPS.SPSSAMP. This member should be modified for each physical printer. The trace datasets should be preallocated and the DD cards adjusted for the printer address and dataset names. Other data set names should be adjusted to suit installation requirements. Ifthe same printer is used for direct printing and under JES, the SPS startup procedure forthe printer may be used to create the JCL insert member by removing the execute card.

Direct Printing

U21020-J-Z247-7-7600 111

//* SPS: MODEL DIRECT PRINTING INSERT FOR ONE APA//* PRINTER ATTACHED TO 7A1 (PRT4)//*//* SET THE SPS DATA SET PREFIX://*// SET PREFIX=SPS//*//* SPS EXECUTION ORIENTED DATA SETS://*//STEPLIB DD DSN=&PREFIX..SPSLINK,DISP=SHR//SYSUDUMP DD SYSOUT=A//SPSMSGDD DD DSN=&PREFIX..SPSMESS(ENGLISH),DISP=SHR// DD DSN=&PREFIX..SPSMESS(ENGLISH2),DISP=SHR//SPSPARM DD DSN=&PREFIX..SPSPARM,DISP=SHR//*//* PRT4: 7A1 APA LIBRARIES FOR 240 DPI//*//FORMDEF DD DSN=&PREFIX..SPSFD24,DISP=SHR//PAGEDEF DD DSN=&PREFIX..SPSPD24,DISP=SHR//OVERLAY DD DSN=&PREFIX..SPSOL24,DISP=SHR//PAGESEG DD DSN=&PREFIX..SPSPS24,DISP=SHR//FONT DD DSN=&PREFIX..SPSFO24,DISP=SHR//*//* APA LIBRARIES FOR 300 DPI//*//SPSFD30 DD DSN=&PREFIX..SPSFD30,DISP=SHR//SPSPD30 DD DSN=&PREFIX..SPSPD30,DISP=SHR//SPSOL30 DD DSN=&PREFIX..SPSOL30,DISP=SHR//SPSPS30 DD DSN=&PREFIX..SPSPS30,DISP=SHR//SPSFO30 DD DSN=&PREFIX..SPSFO30,DISP=SHR//*//* DD STATEMENT NEEDED FOR RESLIST (YES)//*//SPSR0004 DD SYSOUT=R//*//* OUTPUT STATEMENT NEEDED FOR SPOOLMSG (YES)//*//SPSO0004 OUTPUT CLASS=O//*//* PRT4: 7A1 (APA) NEED ONLY IF TWIN PRINTER://* (1) OUTPUT STATEMENT FOR TWINMSGS(NONPRO)//* (2) EXTERNAL STORAGE DATA SET//*//SPSM0004 OUTPUT CLASS=W//SPSW0004 DD DSN=&PREFIX..ESD0004,DISP=OLD//*//* PRT4: 7A1 (APA) DIAGNOSTIC DATA SETS://*//SPS10004 DD DSN=&PREFIX..TRA10004,DISP=SHR,DCB=(BUFNO=20)//SPS20004 DD DSN=&PREFIX..TRA20004,DISP=SHR,DCB=(BUFNO=20)Figure 26: Model APA JCL Insert Member for Direct Printing (SPSDINC)

Direct Printing

112 U21020-J-Z247-7-7600

7.2.3 Establish Authorization

When direct printing is installed, all users have access to its facilities unless they arerestricted by the security system of the installation. Since a user can substitute privatelibraries for all SPS libraries except the libraries from which the SPS load modules areexecuted, no security can be achieved by protecting these libraries.

The simplest scheme for controlling the usage of direct printing is to restrict the universalaccess for the SPS load module library for non-reentrant load modules to “none”. Thename of this library is SPS.SPSLINK, and it will be either a steplib or in linklist. SPS cannotrun without loading from this library. It also must be authorized, and therefore is normallyprotected from modification by end users.

All SPS started tasks must be authorized to read this library. All users and user groupsthat are permitted to use direct printing should also be authorized to read this library.

There are many ways to control usage of direct printing. An installation must design itsown scheme based on the facilities of the security product they have installed. The methoddescribed above is adequate for RACF.

Direct Printing

U21020-J-Z247-7-7600 113

7.3 User Direct Printing RequirementsSPS direct printing supports both end users with basic requirements and end users withspecial requirements.

7.3.1 Basic User

The basic end user requires no knowledge of SPS system parameters or data sets. Usercontrol files may be allowed or prohibited by the SPS administrator. All parameters andJCL are provided and controlled by the SPS Administrator. For this user, all that will berequired is to include the JCL insert defined by the administrator, and to indicate on theapplication sysout DD statement that the SPS subsystem is driving the printer. This is therecommended method for using SPS direct printing.

7.3.2 Special Requirements User

The end user with special requirements must have a complete understanding of SPSinstallation and initialization parameters. This is because all the installation options of SPSare available. SPS runs in the application address space, with all the DDs allocated in theapplication JCL. This gives the user with special requirements access to a completepersonal copy of SPS. SPS allocates all data sets by ddname, permitting a user tosubstitute user libraries and data sets for all SPS allocations. Using user substitutedlibraries a user with special requirements can code all SPS initialization parameters,predefined forms processing, header and trailer pages, accounting, input record andmessage exits. User created parameter libraries, resource libraries, trace and dump datasets require no special authorization. Header pages, trailer pages, and any SPS exits mustcome from authorized libraries because they are loaded. Users requiring access to thesefacilities must have their load libraries authorized by the administrator.

Direct Printing

114 U21020-J-Z247-7-7600

7.4 User JCL RequirementsSPS direct printing can be used by any application without modifying the applicationprogram. The only requirements are:

1. Include with the application JCL the additional JCL statements required to support SPSrunning in the application address space

2. Indicate in the application output DD statement that the device is driven by the SPSsubsystem

3. Indicate the printing options via an OUTPUT statement or control file. In direct printingmode no printing options should be specified in the DD statement (like CHARS). If anyoptions are specified in the DD statement they are ignored.

The additional JCL statements required for execution will normally be included in theapplication JCL by an INCLUDE statement. This statement should reference a JCLmember in proclib that has been prepared by the SPS administrator. The applicationoutput DD statement must have the SUBSYS keyword added. The subsystem name is thefirst subparameter, always SPSD. The second subparameter is the printer name asentered in the printer table SPSPRINT in SPS.SPSPARM. An example of the JCL requiredfor running IEBGENER appears in Figure 27 on page 114. This example is memberSPSDSAMP from the library SPS.SPSSAMP. This example uses the JCL insert thatappears in Figure 26 on page 111.

//USERD JOB (ACCOUNT,USER),SUSER,USER=USER,// MSGCLASS=X,NOTIFY=USER,CLASS=A//*//* SPS DIRECT PRINTING SAMPLE JOB//*//GENERDI EXEC PGM=IEBGENER,REGION=1M//OUT2 OUTPUT CHARS=GF15,FORMS=STD//SYSPRINT DD SYSOUT=*//SYSIN DD DUMMY//SYSUT2 DD SUBSYS=(SPSD,'PRT4'),OUTPUT=*.OUT2,// DCB=(RECFM=FBA,LRECL=80,BLKSIZE=800,BUFNO=10)// INCLUDE MEMBER=SPSDINC//SYSUT1 DD *1 TEST FOR SPS DIRECT PRINTING TEST FOR SPS DIRECT PRINTING TEST FOR SPS DIRECT PRINTING TEST FOR SPS DIRECT PRINTING TEST FOR SPS DIRECT PRINTING TEST FOR SPS DIRECT PRINTING

Figure 27: Sample Direct Printing Job (SPSDSAMP)

Direct Printing

U21020-J-Z247-7-7600 115

7.5 Direct Printing Programming Considerations

7.5.1 Multiple Files in One Print Session

An SPS direct printing print session is started each time the printer is opened andterminated when the printer is closed. During a print session SPS is attached andinitialized, the application program writes all the print data set to the printer, and SPS isterminated and detached. An application program can initiate as many print sessionsduring one execution as required, but each session will go through full initialization andtermination of SPS, if an open and close of the printer is performed. Open and closetrigger the writing of the message page, header and trailer page if this option is used, andmoving of the last page of the output into the stacker. It is not recommended that anapplication print multiple data sets in one print session, however if this type processing isperformed:

• No header and trailer pages will be printed between the data sets of the session

• The message page generated will be for all the data sets in the session

• For two-sided output, the application must keep track of front and back sides so thatnew input data sets start on the front side

• There will be no non-process run out that guarantees each print data set completednormally.

7.5.2 Notification of Print Completion

This function notifies the application program of failures in processing during the printsession. This function is the default processing of SPS when installed, but can be changedby the user. The application will be notified in one of the following ways:

• Abend during OPEN

• I/O error during PUT/WRITE

• Abend during CLOSE

If an application opens and closes the output file many times to print multiple listings, itshould have an ESTAE exit to intercept OPEN/CLOSE abends. This exit will permit theapplication to know that printing of a listing was not all right and start printing the nextlisting. In the same way a SYNAD exit should be provided to get control when PUT errorsoccur. When the application program does not encounter an I/O error or abend until afterclosing the printer DCB, it is sure that all pages were correctly stacked.

If you prefer that SPS never abends on close or gives I/O errors on PUT because of a filenot being correctly stacked you, should recompile the SPS load module SPSMDDNB.SPSMDDNB is delivered as load module and as a source module in SPS.SPSSAMP. The

Direct Printing

116 U21020-J-Z247-7-7600

source module has the macro DDNBLOCK. The macro DDNBLOCK has the parameterUSERAB. The delivered SPSMDDMB has USERAB=YES coded on it. This corresponds tothe default notification process. Just change to USERAB=NO and recompile /relinkSPSMDDNB. SPS will then bypass the close abends and PUT I/O errors. WhenUSERAB=NO is specified the installation should provide its own method to check if directprinting files were correctly stacked.

You must specify the following linkage options when relinking SPSMDDNB:

• non-reentrant (omit the RENT attribute)

• AMODE=24

• RMODE=24

You should use SPS.SPSSAMP as macro library (in addition to the MVS macro libraries)when compiling SPSMDDNB.

7.5.3 DCB Parameters BUFNO and BLKSIZE

SPS direct printing honors all DCB parameters. This means the user specified block sizeand number of buffers will be used. These parameters have a large impact on theperformance of the printer. A large block size for the printer data set causes more recordsto be passed together to the SPS direct printing processor by the application program.This can substantially reduce the number of passes through the direct printing processorfor a given print data set. Large numbers of buffers allows the application processing to beahead of the printer processing, preventing the printer from waiting for work. Small blocksizes or an insufficient number of buffers will cause the printer to go into start stop modeand use unnecessary amounts of CPU time.

The block size should be set as high as possible, and the number of buffers should be noless than 10. These parameters may be used on the printer regardless of the input dataset DCB. A large number of buffers and a high blocking factor on the input data sets willimprove the performance of the application program as well. Poor performance on theinput data set can be a bottleneck that slows the printer processing.

7.5.4 Avoiding NPRO in Direct Printing Mode

There are two situations where SPS does not make an NPRO processing in direct printingmode

1. When a paper jam occurs the print session terminates when running in direct printingmode (no restart capability in the direct printing interface). In this situation no NPRO isperformed, as all pages before the stacker should be re-printed anyway.

2. When NPRO(O) is specified in the SETUPxxx member SPS never makes an NPROat print file termination. The user is then responsible for specifying in the ANPRO

Direct Printing

U21020-J-Z247-7-7600 117

SETUPxxx parameter the total number of pages to be NPROed. Using the ANPROoption may avoid start-stops during NPRO processing when using post-processingmachines.

7.5.5 Avoiding Re-synchronization of Twins

SPS may avoid the re-synchronization of SRA twin printers which normally occurs between2 direct printing sessions. The re-synchronization is avoided only if the following criteriaare satisfied:

• The direct printing program normally closes a print session (SPS normally terminatesthe npro/anpro processing)

• The same program subsequently opens a print session to the same SRA twin

• The SRA twin is still synchronized at the subsequent SPS start-up

7.5.5.1 Programming Interface:

In order to use this function, the direct printing program should have an exit list in its printerDCB. The exit list should have 2 special entries, with identifiers x'5E' and x'5F', eachcontaining a pointer to an 8 byte field with the following meanings:

'5E' After a 'good' close of a direct printing session SPS passes to the direct printingprogram an 8-byte token in this area. If the direct printing program alsoconsiders the print session as normally completed it should pass this token tothe next session (open) in the '5F' token area. The direct printing program mustinitialize its '5E' token area (8 bytes) with binary zeroes before each open.

'5F' If the direct printing program received a token in the '5E' area from its previoussession, it may pass the same token in the '5F' token area, to request SPS tonot re-synchronize the printers. SPS will only avoid re-synchronization if thetwins are still synchronized, have SRA controllers and have the same unitaddresses as in the previous print session.

If the direct printing program did not receive a token in its previous session (inthe '5E' area), it should initialize this '5F' area with binary zeroes (or do notprovide the pointer to the area, or do not provide a '5F' entry in the exit list)before issuing an open.

7.5.6 Specifying SETUP Options for a Print Session

SPS allows a direct printing program to specify which SETUPxxx member should be usedfor the printing session. This request overrides the SPS specification from the SPSPRINTmember. The following section explains how to implement this function.

Direct Printing

118 U21020-J-Z247-7-7600

7.5.6.1 Programming Interface:

In order to use this function, the direct printing program should have an exit list in its printerDCB. The exit list should have a special entry, with identifier x'5D' containing a pointer toan 8 byte field. This field should contain the setup member name, padded with blanks onthe right. If the field contains 8 blanks or 8 binary zeroes, no override is done.

7.5.7 Psf Exit 16

SPS allows a direct printing installation to run a PSF compatible exit 16. The SPS interfaceto exit 16 is totally compatible with PSF at the functional and programming levels. Pleasesee the MSGEXDP SETUPxxx parameter for specification of an exit 16.

Printing with SPS

U21020-J-Z247-7-7600 119

8 Printing with SPS

This chapter explains some special situations that may occur when printing with SPS andhow they may be handled.

8.1 Information Page SuppressionSPS has 4 types of information pages: header, separator, message, and trailer pages.These pages may be selectively suppressed by the SPS administrator, end user, operator,or systems programmer.

8.1.1 Header, Separator, and Trailer Page Suppression by Administrator

The SPS administrator can generate header, separator, and trailer pages with no lines.These are null information pages, they will be processed as information pages but sincethey have no lines, no page will be printed. Such pages can be referenced in the formstable information page parameter member (HSMTffff), or in the installation setup member(SETUPxxx) causing the referenced information page to be suppressed.

8.1.2 Message Page Suppression by Administrator or End User

There are two ways to suppress a message page.

1. The installation may have a generic (MSGID (00000000) in MSGSUxxx) message exit(like sample SPSMMEXC) which redirects all message page messages to theconsole.

2. The administrator (in the SETUPxxx or forms control file) or the end user (in the usercontrol file) may specify SPOOLMSG(YES) for one or all listings. With this optionactive each message page will be spooled as a separate output group instead of beingprinted.

The administrator or end user may also suppress warning messages via the PIMSGparameter from SETUPxxx or JCL OUTPUT statement.

Printing with SPS

120 U21020-J-Z247-7-7600

8.1.3 JES2 Header, Separator, Message, and Trailer Page Control

In JES2 the operator can suppress or enable the printing of header and trailer pagesbetween output groups using the $TPRTn command and the parameters S=N or S=Y forsuppress or print. The separator page between data sets and copies can be controlled bythe SEPDS parameter. The systems programmer can set the initialization defaults with thesame parameters on the printer statement in the JES2 initialization deck. Neither theoperator nor the system programmer can control the printing of the messages pages.

8.1.4 JES3 Header, Separator, Message, and Trailer Page Control

In JES3 the operator can suppress or enable the printing of job header and data setseparator pages using the *X,WTR command and the parameters H=N or H=Y forsuppress or print. The trailer page between output groups can be controlled by specifyingB=Y or B=N. The systems programmer can set the initialization defaults with the HEADERand BURST parameters on the DEVICE statement in the JES3 initialization deck. Neitherthe operator nor the system programmer can control the printing of the messages pages.

8.2 SPS Userlib ProcessingSPS userlib processing considers any userlib or userlib concatenation the primaryresource libraries. All resources will be searched first in these libraries and then in thesystem defined libraries, this includes the default pagedef and formdef.

Userlibs and userlib concatenations are deallocated only when both all resources loadedfrom any of the libraries have been deleted from the printer, and all files using any of thelibraries have been stacked.

SPS will reload a resource from a userlib when it has been changed in the disk librarysince the last time it was read. Resources that have not been changed will not be reloaded(a changed resource is recognized either via a new TTR or via changed information in theuser area from the directory entry). Changes to resources in userlibs do not require thestopping and restarting of the printer to be activated.

In order to load or to use a resource from a user library the userid of the print file should beauthorized via RACF or a similar product to access the specified library. If the listing istransmitted via NJE to the MVS system where it should be printed the USERID isinvalidated (set to ????????) by NJE (because it is not valid in the received system). Anyuser library accessed by this printout should have at least ”UNIVERSAL ACCESS =READ” otherwise SPS will not allow the application to be printed.

Printing with SPS

U21020-J-Z247-7-7600 121

8.3 Inline ResourcesInline formdef, pagedef and colormap usage may be requested in two ways under SPS:

1. When DUMMY is specified as the formdef, pagedef or colormap name in the JCL, inthe case of formdef and pagedef also in user or forms control file, any inline formdef,pagedef or colormap will be used from the data stream. If more than one is present thefirst will be used, if none are present the SPS default will be used in the case of formdefand pagedef otherwise the hardware default will be used in the case of colormaps.

2. When the name of a formdef, pagedef or colormap is present in the JCL, in the case offormdef and pagedef also in user or forms control file, the name is compared to anyinline resource in the print data stream. If a formdef, pagedef or colormap resource ofthat name is found, it will be used. When no formdef, pagedef or colormap with thatname is found, normal library search for the name will be performed.

The activation of in stream formdefs, pagedefs and colormaps by JCL or control filespecification is unique, all other in stream resources will be used before library search.

Starting with the appropriate PTF level of version 3.2 SPS supports all kind of resourcesas inline resources.

8.4 Immediate Machine Carriage ControlWhen printing a file with machine control characters JES eliminates any data from recordsthat contain immediate machine control characters (like '8B' which is skip to channel 1immediate). Also, if an invalid machine control character is coded and JES understandsthat it is an immediate command (bit 6 is on in the command byte), JES does not give thedata contained in this record to SPS. JES gives only the invalid machine control characterto SPS.

8.5 Unprintable Data SetsAll releases previous to JES 3.1.3 will continue to print the rest of the data sets in anoutput group after encountering a data set that is unprintable. When printing of theprintable data sets is complete the entire output group will be put in hold.

Starting with JES 3.1.3, an unprintable data set encountered in an output group cause theentire output group to be interrupted and placed in hold when the unprintable data set isfreed by SPS. Since an APA printer may have many data sets in the print train, it is

Printing with SPS

122 U21020-J-Z247-7-7600

possible that data sets which are part of the same output group and sequentially after theunprintable data set may be printed before the output group is finally interrupted.

8.6 Twin Printer MessagesTwin printers have 2 print stations so located that the second side of an output is printedup to 32 pages after the first side. This means that twin printers may produce messagesfor the second side of an output after the message page has been printed for the print dataset. An option is available that causes a nonprocess run out before the message page isprinted, however this wastes 32 pages for every print data set. An alternative option is thereprinting of all the messages for a print data set after the printout has completed, whenany messages are generated after the message data set is printed. This option results intwo copies of the messages, the first of which is printed with the print data set and isincomplete, the second printed after the print data set and is complete. When a secondcopy is generated a message is sent to the console, and the output is placed in a spool filewith the jobname that is the procedure step name. Please see TWINMSGS options in"SETUPxxx APA Key Word Descriptions" on page 44 for selecting these options.

An alternative to the TWINMSGS(NONPRO) option is the SOOLMSG option, which writesany message page into the spool.

8.7 Printer Status NRD and Message SPS0260ASPS printers will always show a printer status of NRD indicated to the operator command"d u,,,xxx,1" where xxx is the printer device number. The operating system is unable tointerpret all of the sense bytes from SPS printers and so considers the device not ready.The true status of SPS printers can be displayed via the STAT SPS command. Thiscommand causes SPS to issue message SPS0261I which displays the current status ofthe printer, or printers in the case of a twin printer. The possible statuses displayed are:

NO I/O IN PROGRESS

I/O IN PROGRESS

NOT READY

NOT READY - PAGE BUFFER FULL

See "STAT Command" on page 153 for more information about the STAT command.

If your installation has a monitoring program which inspects the UCBs for printer not readystatus you should specify the NOTRDMO(YES) option in the SETUPxxx member.

Printing with SPS

U21020-J-Z247-7-7600 123

8.8 Messages IEC031I and IEC032I for Trace Data SetsMessages IEC031I and IEC032I will be issued when the trace data sets used by SPS areswitched. These messages may be suppressed from the console for the SPS trace datasets by installing sample message suppression exit SPSIXMSG in LPALIB or a linklistlibrary. The message exit is activated by placing an entry for each of the messages in theMPFLSTxx member of SYS1.PARMLIB that is used by the installation.

8.9 Checkpoint Intervals and RestartCheckpointing may be requested in seconds or in pages. Checkpointing is established byJES initialization, operator commands, or in the user JCL. When checkpoint intervals arerequested in pages, SPS counts physical pages, not sides. This means a checkpointinterval for duplexed output when requested in pages will contain twice as much output asfor simplex output.

Checkpoint intervals affect also accounting. SPS ensures that all pages checkpointed willbe also SMF-accounted even if SPS or MVS crashes before the output file is completelyprinted.

When SPS restarts a file having a checkpoint record with an old format, SPS will eitherignore it and print from the beginning of the file, or read the file up to the restart point(dummy printing) and then start to print. A corresponding message is issued by SPS toinform which action will be taken. When SPS restarts a file that was originally printed withanother PDSBUFL value (buffer length for reading the file), SPS will dummy print up to therestart point. A message will be also issued.

8.10 Font Interchange InformationSPS supports font interchange information via the global resource identifier (GRID) fromthe MCF2 structured field. Using this capability of the SPDS data stream allows the samedata stream to be printed in different operational environments (MVS, VSE, UNIX, VM).According to the GRID SPS will select the right font for the operating environment. Onlyfonts that agree with the naming conventions of the IBM Core Interchange Fonts aresupported via the GRID. SPS supports the following for presentation interchange:

• Eight language groups: Latin 1, Latin 2/3/5, Latin 4, Arabic, Cyrillic Greek, Hebrew, Thaiand Symbols.

• Three font families: Courier, Helvetica and Times New Roman.

Printing with SPS

124 U21020-J-Z247-7-7600

• Four typefaces: normal, bold, italic and bold italic.

8.11 Hardware Two UpThe hardware two up setting on the printer may not be used when SPS drives the printer.SPS sets the X2UP characteristics (one up, two up or identical copies) according to thespecification in the control file or FORMDEF (for print files), or the IPAGINFO macro orFORMDEF (for information pages).

8.12 Post-processing MachinesIf you have any post-processing machine attached to your printer you may find itinteresting to use the ANPRO(n) keyword from the SETUPxxx member. This parameterrequests that SPS should eject additional sheets when doing a software NPRO function.The NPRO function consists in putting all sheets from a completely printed listing into thestacker. When no post-processing machine is attached SPS knows exactly how manysheets are necessary to put into the stacker (in this case the default ANPRO(0) should beused). When a post-processing machine is attached, SPS can not know how manyadditional sheets he should put into the stacker. In this case you should specify thenumber of additional sheets via the ANPRO(n) parameter.

8.13 Printing IOCA AFPDSStarting with version 2.6 SPS provides full support for IOCA in AFP data streams. Startingwith the appropriate PTF level of SPS 3.2, IM1 images are converted into IOCA image ifthe printing resolution of the IM1 images does not match the printing resolution of theprinter. Also the replicate and trim function from IOCAs is supported by SPS 3.6.

8.14 Printing GOCA AFPDSStarting with version 3.2 SPS provides full support for GOCA AFP data streams.

Printing with SPS

U21020-J-Z247-7-7600 125

8.15 Printing BCOCA AFPDSStarting with version 3.2 SPS provides full support for BCOCA AFP data streams. WithSPS 3.6 BCOCA is also supported via PAGEDEFs (LND specification).

8.16 Printing MICR-FontsStarting with version 3.2 SPS supports MICR-Fonts on TROY-printers. Using a twinsystem, the TROY-printer can only be connected to the second printer. Starting withversion 3.6, SPS supports MICR printing for twin printers when one of the printers isequipped with MICR toner.

8.17 Overlays and Page Segments Called from LNDsStarting with version 3.2 SPS supports the inclusion of overlays and page segments viaLNDs from a PAGEDEF. That means that if the line defined by the LND is written, thereferred overlay or page segment is than included on the page.

8.18 Printing on Network PrintersStarting with version 3.2 SPS is able to print on network attached printers. These printersmay be locally controlled by SIEPRIS APA, PRISMA/APA or PSF/2. For a network printeryou must specify APPLID, LOGMODE and LUNAME in your printer definition statementtable SPSPRINT (SPSPARM file). With the appropriate PTF level SPS 3.2 supports alsoLU1 printers.

SPS uses the LU 6.2 protocol to communicate with SIEPRIS APA, PRISMA/APA orPSF/2. The output files transmitted to the remote station are first stored in a spool file forlater printing. Any host operator command given while SPS is transmitting the file affectsthe spooled copy of the file. The resulting file will be later printed. SPS also supportsPSF/2 in direct printing mode, i.e., without spooling the data in PSF/2.

Please see the SPS/MVS Installation Guide for more information about how to define anetwork printer for SPS. Please refer to the SIEPRIS APA or PRISMA/APA documentationfor more information about how to receive files on the print server spool and to print them.

Printing with SPS

126 U21020-J-Z247-7-7600

During a file transmission, SPS checks in all resource-request-cases the presence ofresources on the network station. In the hit-case (resources already transmitted or storedon the remote station by whatever means) SPS continues with input-stream-processing(next resource or print data). In miss-case the resources are transmitted to the remotestation and stored there as temporary or permanent resources.

8.19 Direct Printing of Overlays and Page SegmentsStarting with version 3.6 the sample input record exit SPSMREOV is delivered as loadmodule and source module (SPS.SPSSAMP). If you request this sample exit to beexecuted via the RECEXIT SETUPxxx parameter SPS will be able to directly print overlaysand page segments as data. This should be used for testing purposes only as positioningerrors may occur.

8.20 FCB Parameter for APA PrintersFor APA printers, special processing is performed with the FCB parameter. When printingline data, if no PAGEDEF is specified, the FCB name is prefixed with the PAGEDEF prefix(P1) and requested as a PAGEDEF. This facility makes it easier to use existing JCL,which was coded to print in non-APA printers. You should only convert the FCB to aPAGEDEF and use your JCL requesting FCBs as it is.

If you want to have SPS bypass this standard FCB processing, you should compile andlink the sample data-set allocation exit SPSMDSFC and request its execution via theDSALEXIT parameter from the SETUPxxx member.

8.21 Data Set Separator on same Physical Page as Output FileIf you want to print the data set separation page on the same physical page as your printfile (user data in the back side of the data set separator), you should request SPS to usethe sample input record exit routine SPSMREXD (RECEXIT parameter from SETUPxxxmember).

This sample exit inserts the data-set separator before each copy of the file. This sampleexit is provided in load module and source format. This sample exit should be linked asrent, amode=31, rmode=any.

Printing with SPS

U21020-J-Z247-7-7600 127

This exit assumes that the data-set separator has ANSI carriage control characters, using'1' to skip to new page and no other carriage control besides blank. The exit converts thecarriage control characters to machine ones if the file being printed has machine controlcharacters. The data-set separator should be printable with the resources specified for theprint file (formdef, pagedef, fonts). The exit provides the data-set separator also when(because of paper jams or repositioning commands) the output file reprints from thebeginning.

The data-set separator from the exit is only inserted when the JES printer definitionspecifies no data-set separators, otherwise double separators would be printed(SEPDS=N for JES2).

8.22 Exchanging the Front and Back Pages on Twin PrintersYou may use the FLIP(YES) option from SETUPxxx or a control file in order to exchangethe front and back pages from a A-Twin printer.

8.23 N-UP SupportStarting with the appropriate PTF level of version 3.2 SPS supports basic and enhancedN-UP.

8.24 Outline FontsStarting with version 3.6 SPS provides support for outline fonts.

8.25 SMF AccountingSPS writes the SMF type 6 record for each file printed, containing the accountinginformation for the printed file (number of pages printed, etc.). As accounting is a veryimportant processing for most customers, especially print shops, SPS has two specialenhancements in this area, usually not available in other printer drivers:

Printing with SPS

128 U21020-J-Z247-7-7600

a) Operator Notification and Retry by Accounting Failure:

The SMF component from MVS may be unable to write the SMF record into itsaccounting file. Some of the reasons are: lack of buffers, SMF files full, SMF inactive,recording of record type 6 inactive, etc.. If any of these conditions occur SPS informsthe operator and allows him to RETRY, IGNORE or ABEND. This feature guaranteesthat the operator will at least be informed for any impeachment of the accounting file. Ifyour installation does not want to implement SMF accounting you may automate theanswer to the SPS message with the IGNORE reply via the MSGSUxxx member ofSPS.SPSPARM.

b) Guaranteed Account Writing by SPS for MVS crashes:

When SPS or MVS crashes (SPS abend, MVS wait, CPU power off) the printout of thecurrent file is interrupted. This interrupted file will be printed later from its lastcheckpoint. If 1 million pages were printed up to the crash point a significant accountingvalue should not be lost. SPS writes the SMF accounting record representing theprinted data up to the checkpoint time in the JES checkpoint record. In case of a crashthe SMF accounting is written for the printout up to the last checkpoint, as the file willbe later restarted from that checkpoint record. For ESTAE-interrupted errors (SPSabends) SPS writes the SMF record in its ESTAE routine. For errors not intercepted viathe ESTAE exit (like an MVS wait state), SPS writes the SMF accounting record whenSPS re-obtains the print file after the MVS and SPS systems are restarted. This printfile will then be printed from the checkpoint.

8.26 Color SupportStarting with the appropriate PTF level of version 3.2 SPS supports name color.

8.27 Type-2 Interface SupportStarting with the appropriate PTF level of version 3.2 SPS supports the type-2 interface forFORMDEFS including the 'SMM SUPPORT'.

Printing with SPS

U21020-J-Z247-7-7600 129

8.28 Automatic Page NumberingStarting with version 3.6 SPS supports, together with SLE version 2.06, the automaticpage numbering feature. When building a PAGEDEF with SLE you may specify a field inyour page where SPS should automatically write the current page number. Please refer tothe SLE documentation for information on how to request this function in your PAGEDEF.

8.29 APA Resources Usage ListingThis function is available with SPS version 3.6. If you have an application which runs withmany system and user resource libraries, and uses a lot of different APA resources (fonts,overlays, etc.), it may be difficult for you to transport this application to another MVSsystem. This is because you may not know which resources are used or from whichlibraries they come. If you print this application once using the RESLIST(YES) option fromSETUPxxx, SPS will generate a report containing all resources used with their respectivelibraries.

8.30 L-Units per Unit BaseSome printers do not support all possible L-Units per unit base specifications available inthe AFPDS data stream. If this is your case, you may request that SPS convert the L-Unitsper unit base value received in the data-stream into another one that is supported by yourprinter. See the LUPUB SETUPxxx parameter.

8.31 SPS Input Bin ProcessingFor printers with more then one input bin (like cutsheet printers) SPS performs specialprocessing related to the INBIN (input bin) parameter from the control file when REAINUS(NO) is specified or defaulted.

If the user form corresponds to only one real form (i.e., the user form is not defined in theFORMxxx table or is defined with just one real form), SPS first verifies whether the INBINparameter was specified in the control file (either user or forms control file). If notspecified, SPS specifies the INBIN parameter itself, with the value corresponding to theinput bin where the real form is mounted. If the user specified the INBIN parameter SPS

Printing with SPS

130 U21020-J-Z247-7-7600

checks if the INBIN value matches the input bin where the real form is mounted. If it doesnot match, SPS changes the INBIN value and issues message SPS0927W to inform theoperator/user about this change.

If the user form is defined in the FORMxxx table and corresponds to more than one realform, SPS verifies if a user coded INBIN value specifies an input bin where a real form isdefined for that user form. If this is not true, SPS returns the affected output group in holdto the spool after issuing message SPS0923E.

8.32 Usage of Double Byte FontsSPS supports an enhanced double byte font SOSI processing via the ENDBCS parameter.This parameter may be specified in the SETUPxxx member (default option for whole printsession) or in a control file (specification for one file).

You specify this option in the following way:

ENDBCS(YES|NO)

NO this is the default value for this option in the SETUPxxx member. WithENDBCS(NO) SPS processes the SOSI bytes in a PSF compatible way,i.e. you may specify only 2 fonts, the first should be a single byte font andthe second a double byte font. The SOSI bytes may be used to switch fromfont one to font two and vice versa.

YES with this option an enhanced SOSI processing is supported by SPS. In thismode you may specify as many single and double byte font pairs as youwant. Each pair should have first a single byte font and following it a doublebyte font. For example, a valid chars would be:


You may switch between each pair via TRC control characters, but youmust always specify the TRC corresponding to a single byte font. After"landing" in the single byte font from a pair you may switch to itscorresponding double byte font via the SHIFT-OUT byte, and return to thesingle byte font via the SHIFT-IN byte.

When you specify ENDBCS(YES) you have the following restriction:

If you use DBCS specified in the PAGEDEF you may not have SOSI bytesin your data-stream and you may not specify the PRMODE=SOSIXparameter in the JCL.

Printing with SPS

U21020-J-Z247-7-7600 131

8.33 Orientation Issues in the Migration from Page Mode to IPDSThe purpose of this section is to describe page orientation issues as they relate to pagemode (model 3) and IPDS mode (model 4) printing on Océ Printing Systems continuousforms devices. The term page mode is used herein to describe the characteristics of theOcé Printing Systems model 3 printers and some of the earliest devices supported by theAFP architecture. The term IPDS mode is used to describe Océ Printing Systems model 4printers. When migrating page mode applications to IPDS devices the page orientationmay change on initial testing. It is important to understand the relationship of device originwith respect to logical page dimensions to explain why this happens.

Figure 28 illustrates the relationship between the page mode device origin and the physicalform. The device origin is fixed on a page mode device. A portrait page placed on anarrow form will have the print direction of across in its logical page attributes (top left).Because maintenance charges are applied by the amount of paper moved verticallythrough the printer, some portrait applications were designed to take advantage of printinga portrait page on a wide form. This is illustrated in the top right of Figure 28. This wouldrequire that the logical page print direction attributes be set to the down direction. As isillustrated in the lower quadrants of Figure 28, an across print direction on a wide formimplies a landscape orientation, while a down direction attribute for a narrow form implieslandscape.

*

LOGICAL PAGE

*

PAGE MODE Device Origin

* Hardware Origin*

*

*

PORTRAIT

LANDSCAPE

PRINT DIRECTION ACROSS

PRINT D

IREC

TION

DO

WN

Figure 28: PAGE MODE Device Origin

Printing with SPS

132 U21020-J-Z247-7-7600

Figure 29 illustrates how new attributes in the form definition were created to support IPDSmode printing. The newer form definitions contain the parameters PRESENTATION(LANDSCAPE or PORTRAIT) and DIRECTION (ACROSS or DOWN). Now logical pageplacement depends on what the logical page dimensions are, the form dimensions of theform loaded at print time and these new attributes in the form definition. If theseparameters are not present in the form definition, the PRESENTATION is assumed to bePORTRAIT and the DIRECTION is assumed to be ACROSS. This is illustrated in the tophalf of Figure 29. If the page mode application has logical page dimensions where thewidth is greater than the height, the new form definition attributes are required to correctlyplace the logical page on the physical form.

LOGICAL PAGE

*

* Hardware Origin***

*

PORTRAIT ACROSS

LANDSCAPE ACROSS

IPDS MODE Device Origin

Figure 29: IPDS MODE Device Origin

IPDS devices actually support four possible hardware origins as shown in the figure below.

Printing with SPS

U21020-J-Z247-7-7600 133

0,0

0,0

0,0

0,0

0,0

0,0

0,0

0,0

PORTRAIT PORTRAIT90LANDSCAPE LANDSCAPE90

WIDEFORMS

NARROWFORMS

Figure 30: Supported Hardware Origins

SPS supports all of the above PRESENTATION parameters in form definitions or viaexclusive control files. These control files can override the existing form definition specifiedfor the original page mode application. An additional parameter, COMP38MO(YES) isuseful in moving page mode applications to IPDS printers where no change of forms willoccur in the migration. Any of these SPS parameters can be applied to one or more FORMvalues or one or more CLASS values. So in the situation described in Figure 29 where theoriginal page mode application printed on a landscape form, one need only code aCOMP38MO parameter once for all applications using a specific form setup. The need tomigrate all form definitions previously developed for page mode devices can be eliminated.This flexibility can be exploited even further when migrating page mode applications towide forms. Figure 31 below illustrates the effect of the PRESENTATION parameter onX2UP format also supported on SRA - IPDS devices.

1 2

0,0 0,0

21

0,0

0,0

210,

0

0,0

1 2

0,0 0,0

PORTRAIT LANDSCAPE PORTRAIT90 LANDSCAPE90

Figure 31: Effect of the PRESENTATION Parameter

To appreciate the power of the SPS PRESENTATION parameter consider an applicationoriginally designed for a page mode device, having both landscape and portrait output onwide forms. The logical page attributes would contain across and down print directions forlandscape and portrait orientations respectively. If PRESENTATION(LANDSCAPE) isused, print direction down will result in output oriented up side down. OnlyPRESENTATION(PORTRAIT90) provides an acceptable result.

Printing with SPS

134 U21020-J-Z247-7-7600

LANDSCAPE(X2UP)

PORTRAIT90(X2UP)

21

0,0

0,0

210,

0

0,0

Across

Acro

ss

Down

Down

Original Page Mode Application

0,0 POR

TRAIT

Dow

n

0,0

LANDSCAPE

Across

1

2

Figure 32: PRESENTATION(PORTRAIT90)

The following table was produced testing page mode resources and data using SPSdriving an Océ Printing Systems P S-440 (in IPDS mode). The left side of the ‘ONE UPIPDS’ column shows that the SPS parameter COMP38MO(YES) is useful to migratemodel 3 applications to model 4 devices when the same form will be implemented. Thesubsequent columns illustrate the use of the PRESENTATION parameter when differentforms will be used. Tests were also successful for duplex output using the SPSparameter, DUPLEX(NORMAL) for each row below.

Printing with SPS

U21020-J-Z247-7-7600 135

PAGE MODE ONE UP IPDS X2UP IPDS


0,0

LANDSCAPE

Across

10,0

LANDSCAPE

Across

2SPS PARAMETERSCOMP38MO(YES)

0,0

LANDSCAPE

Across

10,0

LANDSCAPE

Across

2

21

0,0

0,0

Acr

oss

Acr

oss

SPS PARAMETERSX2UP(ON)PESENTATION(PORTRAIT90)

1 2

0,0

0,0

Across

Across

SPS PARAMETERSX2UP(ON)PESENTATION(LANDSCAPE)

0,0

LANDSC

APE

Across

1

SPS PARAMETERS/* THE FORM HAS CHANGED */PRESENTATION(LANDSCAPE)

LANDSC

APE

LANDSC

APE LA

NDS

CA

PE

LAN

DSC

APE

SPS PARAMETERSCOMP38MO(YES)

SPS PARAMETERSX2UP(ON)PESENTATION(PORTRAIT90)

0,0 LA

ND

SCAP

E

Acr

oss 1

SPS PARAMETERS/* THE FORM HAS CHANGED */PRESENTATION(PORTRAIT90)

21

0,0

Acr

oss

Down


POR

TRA

IT

Dow

n

0,0

LANDSCAPE

Across

1

2

POR

TRA

IT

Dow

n

0,0

LANDSCAPE

Across

1

20,0 0,0

0,0

LAN

DSC

APE PORTRAIT

SPS PARAMETERS/* SAME FORM */COMP38MO(YES)

SPS PARAMETERS/* THE FORM HAS CHANGED */PRESENTATION(LANDSCAPE90)


0,0

LAN

DSC

APE

2 DO

WN

1PORTRAIT

Across

0,0

0,0

PORTRAIT

1

Across

0,0 PO

RTR

AIT

Acr

oss

1

0,0

LANDSCAPEDOWN

2

SPS PARAMETERSX2UP(ON)PESENTATION(PORTRAIT)

1

0,0

PORTRAIT

Across 0,0

NOTE:PORTRAIT IS THE DEFAULT FOR SPS.THE PARAMETERS SHOWN BELOW ARE OPTIONAL.

0,02 D

OW

NLA

ND

SCA

PE

LAN

DSC

APE

2 DO

WN

SPS PARAMETERSCOMP38MO(YES)

SPS PARAMETERS/* THE FORM HAS CHANGED */PRESENTATION(PORTRAIT)


0,0

PORTRAIT

2

Across

1PORTRAIT

Across

0,0

PORTRAIT

2

Across

0,0

PORTRAIT

1

Across

0,0POR

TRA

IT

Across

2

0,0POR

TRA

IT

Across

1

SPS PARAMETERSX2UP(ON)PESENTATION(PORTRAIT)

21

0,0

PORTRAIT

Across 0,0

PORTRAIT

Across

NOTE:PORTRAIT IS THE DEFAULT FOR SPS.THE PARAMETERS SHOWN BELOW ARE OPTIONAL.

Figure 33: DUPLEX(NORMAL)

Printing with SPS

136 U21020-J-Z247-7-7600

8.34 Techniques for the Migration from Simplex to DuplexThe term page mode is used herein to describe the characteristics of the Océ PrintingSystems model 3 printers and some of the earliest devices supported by the AFParchitecture. The term IPDS mode is used to describe Océ Printing Systems model 4printers. The purpose of this section is to describe some techniques for migrating simplexapplications to duplex. When migrating page mode applications to IPDS devices, addingthe function of duplex printing should be considered as it offers substantial paper savings.

8.34.1 Using SPS Control File Parameters

SPS has exclusive control files that can override specific functions contained in form andpage definitions originally written for other devices. These control files add the flexibility ofapplying the override to one or more devices, based on one or more FORM values or oneor more CLASS values. The need to migrate all form definitions previously developed forpage mode devices can be eliminated. This flexibility can be exploited even further whenmigrating page mode applications to two up printing. The SPS DUPLEX parametersupports all formats available within standard AFP architecture.

8.34.2 Using Conditional Processing to Eject to New Form

Some output files contain data that is destined for multiple recipients. To duplex this typeof file will require additional logic to control when an eject is required. The application couldbe modified to generate invoke media map (IMM) records. Rather than rewrite theapplication creating the output file it is usually possible to modify the page definition,adding the logic to invoke simplex or duplex printing. The figure below illustrates the needfor logic to cause an eject to a new form after printing page 1 for customer 2.

PRINT STREAMCUSTOMER 1: RECORDS for PAGE 1

RECORDS for PAGE 2

CUSTOMER 2: RECORDS for PAGE 1

CUSTOMER 3:RECORDS for PAGE 1RECORDS for PAGE 2RECORDS for PAGE 3 : :

Customer 1Page 1

Customer 1Page 2

Customer 2Page 1

Customer 3Page 1

SIMPLEX

Customer 1

Page 2

BLANK

Customer 3

Page 2

Customer 3

Page 4

BACK

Customer 1Page 1

Customer 2Page 1

Customer 3Page 1

Customer 3Page 3

FRONT

DUPLEX

Figure 34: Using Conditional Processing to Eject to New Form

Printing with SPS

U21020-J-Z247-7-7600 137

The original form definition and page definition for simplex printing might appear asfollows:

FORMDEF SIMPLX REPLACE YES ; COPYGROUP SIMPLX ; SUBGROUP COPIES 1 ;SETUNIST 1 IN 1 IN 8 LPI ;

PAGEDEF SIMPLX REPLACE YES ;FONT GT10; PAGEFORMAT SIMPLX WIDTH 11.0 IN HEIGHT 8.5 IN; PRINTLINE CHANNEL 1 REPEAT 60 FONT GT10 POSITION 0.2 0.625 ;

If each page of print data contains an account number for example, it can be used tocause an eject to a new form.

The following logic is added to the page definition and the formdef specifies duplex.FORMDEF DUPLX REPLACE YES ; COPYGROUP DUPLX DUPLEX NORMAL ; SUBGROUP COPIES 1 BOTH ;SETUNIST 1 IN 1 IN 8 LPI ;

PAGEDEF DUPLX REPLACE YES ;FONT GT10; PAGEFORMAT DUPLX WIDTH 11.0 IN HEIGHT 8.5 IN; PRINTLINE CHANNEL 1 REPEAT 1 FONT GT10 POSITION 0.2 0.625 ; CONDITION EJECT START 50 LENGTH 15 WHEN CHANGE NEWFORM ;

PRINLINE REPEAT 59 FONT GT10 ;

Printing with SPS

138 U21020-J-Z247-7-7600

8.34.3 Applications Generating Invoke Media Maps

Some simplex applications make use of the IMM structured field to delimit records foreach page. There are a number reasons for doing this such as overlay selection, offsetstacking, etc. One of the fundamental functions of the IMM structured field is to ‘eject tonew form’. This explains why these types of applications may still print in simplex mode,even though the SPS DUPLEX parameter is being employed. The use of an N_UP formdefinition can be used to override the effect of the IMM to cause two sided print. The figurebelow illustrates an application with output containing IMMs to select different overlays.The form definition must be modified to cause duplex output.

PRINT STREAMCUSTOMER 1: IMM PAGE1

RECORDS for PAGE 1IMM PAGE234RECORDS for PAGE 2

CUSTOMER 2: IMM PAGE1RECORDS for PAGE 1

CUSTOMER 3: IMM PAGE1RECORDS for PAGE 1IMM PAGE234RECORDS for PAGE 2IMM PAGE234RECORDS for PAGE 3IMM PAGE234RECORDS for PAGE 3 :-

Customer 1Page 1OVERLAY 1




SIMPLEX

Customer 1

Page 2

OVERLAY 2

BLANK

Customer 3

Page 2

OVERLAY 2

Customer 3

Page 4

OVERLAY 2

BACK





FRONT

DUPLEX

Figure 35: Applications Generating Invoke Media Maps

For a page mode application the form definition would appear as follows:

FORMDEF SIMPLX REPLACE YES ;

COPYGROUP PAGE1 ;

OVERLAY OVLY1 ;

SUBGROUP COPIES 1 OVLY1;

COPYGROUP PAGE234 ;

OVERLAY OVLY2 ;

SUBGROUP COPIES 1 OVLY2 ;

The N_UP function in a form definition modifies the treatment of IMMs through the use ofthe INVOKE subcommand. Valid N_UP values range from 1 to 4, in the above examplewe can make use of N_UP 1. he number of copy groups required does not change.

Printing with SPS

U21020-J-Z247-7-7600 139

To achieve the correct treatment of IMMs, the form definition is coded as follows:

FORMDEF DUPLX REPLACE YES ;

PRESENT LANDSCAPE DIRECTION ACROSS ;

COPYGROUP PAGE1

DUPLEX NORMAL

N_UP 1

PLACE 1 FRONT OVLY1

PLACE 1 BACK

INVOKE FRONT ;

COPYGROUP PAGE234

DUPLEX NORMAL

N_UP 1

PLACE 1 FRONT OVLY2

PLACE 1 BACK OVLY2

INVOKE NEXT;

8.34.4 Migrating to N_UP Duplex

In many model 3 to model 4 migrations it will be desirable to migrate an application from‘one up’ simplex to two up duplex. Taking the same example above the information belowillustrates how simple this change is to the form definition.

PRINT STREAMCUSTOMER 1: IMM PAGE1

RECORDS for PAGE 1IMM PAGE234RECORDS for PAGE 2

CUSTOMER 2: IMM PAGE1RECORDS for PAGE 1

CUSTOMER 3: IMM PAGE1RECORDS for PAGE 1IMM PAGE234RECORDS for PAGE 2IMM PAGE234RECORDS for PAGE 3IMM PAGE234RECORDS for PAGE 3 :





SIMPLEX DUPLEX TWO UP

FRONTBACK

BLAN

KCustom

er 1Page 1O

VERLAY 1

Custom

er 2Page 1O

VERLAY 1

Custom

er 3Page 1O

VERLAY 1

Custom

er 3Page 3O

VERLAY 2 C

usto

mer

3

Page

4

OVE

RLA

Y 2

Cus

tom

er 3

Page

2

OVE

RLA

Y 2

Cus

tom

er 1

Page

2

OVE

RLA

Y 2

Figure 36: Migrating to N_UP Duplex

Printing with SPS

140 U21020-J-Z247-7-7600

FORMDEF DUPLX REPLACE YES ;

PRESENT LANDSCAPE DIRECTION ACROSS ;

COPYGROUP PAGE1

DUPLEX NORMAL

N_UP 2

PLACE 1 FRONT OVLY1

PLACE 2 BACK

PLACE 2 FRONT OVLY1

PLACE 1 BACK

INVOKE FRONT ;

COPYGROUP PAGE234

DUPLEX NORMAL

N_UP 2

PLACE 1 FRONT OVLY2

PLACE 2 BACK OVLY2

PLACE 2 FRONT OVLY2

PLACE 1 BACK OVLY2

INVOKE NEXT;

8.35 X2UP and N_UP PrintingThere is no question that continuous forms LASER printers supporting 17 inch wideimages, offer some of the lowest costs per page for high volume statement applications.When we speak of costs we generally refer to the burdens of machine maintenance,supplies, paper and operational labor. Application development and applicationmaintenance are additional costs. These are the ”unburdened” costs that will not directlyrelate to the amount of print volume generated by the application. These costs come to theforefront when application conversion is necessary to migrate existing applications to newor different printing systems technology.

The purpose of this section is to describe X2UP and N_UP support on OPS high volumeprinters. Many statement applications in production today were originally designed togenerate groups of text records representing one statement per physical form. Theintroduction of LASER printing systems supporting wide forms created a need to simplifythe placement of multiple images on larger forms. X2UP, N_UP and enhanced N_UP(sometimes referred to as Power Positioning) are terms used to describe this ability ofplacing multiple images on a single form without re-coding the statement application. Inboth simplex or duplex mode, SRA technology supports X2UP and all facets of N_UP.

Printing with SPS

U21020-J-Z247-7-7600 141

8.35.1 X2UP Printing

X2UP was developed by Océ Printing Systems to support their exclusive offering (at thetime) of a device capable of imaging 17 inch wide images on a printed form. SRA andAPA2 control units support the placement of two images side by side on one form.Through operator control, an AFP form definition or a control file, one can specify:

1. The placement of AFPDS or MODCA:P in two up format.

2. The placement of line records via a page definition in two up format.

With X2UP the AFP application pages are placed sequentially on the form. In simplexmode the first page is placed on the left and the second page is placed on the right side ofthe form.

LogicalPage

LogicalPage

1 2

Figure 37: X2UP Simplex Page Placement

In duplex mode the first image is placed on the left front, the second image is placed onthe back, so that when the form is split, it produces a page with print on both sides. Thenext two images produce two sided print on the right portion of the form.

BACK

Logical

Page

Logical

PageFRONT

LogicalPage

LogicalPage

1 34

2

Figure 38 - X2UP Duplex Page Placement

Additional X2UP parameters can cause the first image to be placed on the right side of theform (X2UP RIGHT), or that an identical copy of the left side of the form be produced on

Printing with SPS

142 U21020-J-Z247-7-7600

the right side of the form (X2UP ICOPIES). Using X2UP does not require any changes toexisting page definitions or overlays.

8.35.2 Basic N_UP Printing

N_UP has two levels of support, basic N_UP and Enhanced N_UP. Using a form definitionone can place pages sequentially on a form, breaking the form up into logical partitions asfollows:

N_UP 1 N_UP 2 N_UP 3 N_UP 4

1

0,0

1

0,0

1 2

0,0 0,0

1

2

0,0

0,0

1 2 3

0,0 0,0 0,0

1

2

3

0,0

0,0

0,0

3 1

4 2

0,00,0

0,0 0,0

1 2

3 4

0,0 0,0

0,0 0,0

Figure 39: - Portrait Across Partition Assignments for Basic N_UP

The above illustrates the default orientations for each logical page placement. BasicN_UP can also orient the logical pages for landscape orientation. N_UP 2 in the aboveillustration is equivalent to X2UP ON for simplex printing (also shown in Figure 37). Induplex mode N_UP 2 does not modify image placement on the front of the form. In duplexmode, page three will be placed on the back of page two and page four will be placed onthe back of page one.

Printing with SPS

U21020-J-Z247-7-7600 143

BACK

Logical

Page

Logical

PageFRONT

LogicalPage

LogicalPage

1 23

4

Figure 40 - Page Placement for Basic N_UP in Duplex Mode (Cut Sheet Printers)

The page placement for basic N_UP in duplex mode will not be a feasible choice for moststatement application printing. Basic N_UP may have more uses for SYSOUT reportprinting in duplex mode.

1

2

0,0

0,0

3

4

0,0

0,0

FRONT BACK

Figure 41 - Basic N_UP Page Placement for Landscape Across Orientation

8.35.3 Enhanced N_UP Printing

Enhanced N_UP uses the partition arrangement shown in Figure 39. However, thesequence of each logical page placement can be modified for any possibility. Theexamples discussed thus far have involved the placement of two images on one form, asthis is the most common usage of N_UP for existing high volume statement applications.Enhanced N_UP introduces some interesting coding deviations which need to beaddressed.

Printing with SPS

144 U21020-J-Z247-7-7600

0,0 0,0

PAGE 1

PAGE 2PAGE 3PAGE 4PAGE 5PAGE 6PAGE 7

CONSTANTOVERLAY

OVERLAY O1GRID

Figure 42 - Asymmetrical Page Placement Using Enhanced N_UP

The format shown in Figure 42 can be accomplished using Enhanced N_UP because upto four partitions can be coded for each side of a form. In duplex mode, this means amaximum of eight logical pages can be placed per form. Logical page placement need notbe symmetrical for each side of the form, (in this case seven on the front and one on theback). Partitions in the form definition can be coded so that no logical page placementtakes place. This allows for an uneven numbers of pages per form, or an overlayplacement in a particular partition without application data.

The example in Figure 42 helps to clarify the function available with Enhanced N_UP. Forline data, it would be more practical to code a page definition (possibly having floatingoverlays or page segments) for this type of page layout. A page definition allows more sub-pages than partitions possible with N_UP and this approach allows printing on a widevariety of devices not supporting N-UP. Furthermore, formatting this type of output using apage definition allows it to become a candidate for side by side printing using an EnhancedN_UP or X2UP form definition.

For applications that generate fully composed AFP data, N_UP and X2UP provide the onlyfacility available today for imaging multiple pages on one form. This is because a pagedefinition has no effect on the output format of fully composed AFP data.

X2UP and N_UP are powerful tools that facilitate the migration of existing high volumestatement applications to technology that now supports 17 inch wide print images. For newapplications, if the output is not destined to a wide form, the use of N_UP may not be themost sensible approach.

Printing with SPS

U21020-J-Z247-7-7600 145

8.36 Setup Verification

Description

The user may define a list of set-up IDs (Color IDs) in the formdef. PS will compare the ID-list with the Ids that the printer has returned (accessible with XOH-OPC).

Only the Setup Verification in the active Medium Map are checked!

If an ID is not available in the printer the operator should reply the console-messageSPI4740I.

PS-Implementation

No test is executed if:

No set-up IDs are specified in formdef.

The printer does not support the "Printer Set-Up" Self-Defining Field in the XOH-OPC.

During Dummy printing (Checkpoint or Restart)

Dependent from the operators reply the job is printed or is rejected as unprintable. Themessage can also be answered automatically by LI (PSF-compatibility). The message isprinted out in addition on the message page (SPI4741E).

Notes:

A-Twin: The verification finished successfully when the set-up-ID matches in one printer ofa A-Twin. Setup Verification for user data started after processing Header and Separatorpages.

SPS Commands

U21020-J-Z247-7-7600 147

9 SPS Commands

In addition to the JES printer related commands supported by SPS (like $SPRTx, $ZPRTx,$IPRTx, etc...) there are also some commands given directly to SPS (not via JES) toachieve some other functions.

9.1 MVS Commands

9.1.1 STOP (P) Command

This MVS command allows the operator to terminate one SPS procedure when no printersare started. This command is not available in direct printing mode.

The format of this command is:

P procid

where:

procid is the procedure id used to start the SPS procedure and corresponds to theFSS id specified in the JES2PARM or JES3 inish deck.

When any printer is started for the specified procedure and the STOP command is issuedSPS rejects the command with a message indicating that printer(s) are still active. AnotherSTOP command has to be given later, after all FSS related printers are drained.

SPS Commands

148 U21020-J-Z247-7-7600

9.2 FSS CommandsFSS commands are issued to the SPS main task and not to a specific printer (FSA)subtask. These commands are always issued via the MVS MODIFY (F) command. FSScommands are not available in direct printing mode.

The general format of an FSS command is:

F procid,command

where:


command is the SPS FSS command.

9.2.1 CANCEL Command

This command is issued to the SPS main task in order to request the immediatetermination of one SPS printer task running under this FSS. The canceled task willterminate with a system abend code 33E (termination because of detach macro). Thiscommand should be used only if the SPS printer is hanging (wait) or looping and you arenot able to drain it (for JES2, $PPRTx). The advantage of this command to a simple MVSCANCEL command is that other printers running under the same procedure are notaffected. If you have just one printer running under this FSS you may also issue the MVSCANCEL command.

The format of the CANCEL command is:

F procid,PRTx,CANCEL

where:


PRTx is the JES printer name as specified in the JES2PARM, JES3 inish deckand SPSPRINT SPSPARM member.

SPS Commands

U21020-J-Z247-7-7600 149

9.3 Printer CommandsPrinter commands are executed by the corresponding printer subtask. There are 2 ways toissue such commands depending on the specification of the CMDIF parameter from theSETUPxxx member (SPSPARM). If CMDIF(WTOR) is specified the printer subtask issuesa message with answer (WTOR) just after its initialization (message SPS0260A). Youenter printer commands just answering this message. In this case, the format of anyprinter command is:

R xx,command

If CMDIF(MODIFY) is specified or defaulted no pending message is issued by the printersubtask. You have to enter printer commands via the MVS MODIFY (F) command. TheSPS main task receives these commands, checks if the requested printer subtask isactive and passes the command to the printer subtask. In this case, the format of anyprinter command is:

F procid,PRTx,command

where:


PRTx is the JES printer name as specified in the JES2PARM, JES3 inish deckand SPSPRINT SPSPARM member.

SPS always uses the WTOR interface for printer commands in direct printing mode.

9.3.1 FDIS Command

This command requests SPS to display the print file options used by the output filecurrently being printed. The source from each of these options is also displayed. Forexample:

CHARS = (GT10,GT12) - user control file

FORMDEF = (0101) - forms control file

PAGEDEF = (STD) - JCL

COPYMARK = (DATASET) - JES

FCFILE = (SPSPARM/SIMPMEM) - JCL

FLIP = (NO) - Default

SEPPAGE = (YES) - JES

The display can be directed to the console, hardcopy log or message page. IfSPOOLMSG(YES) is also specified in a control file or SETUPxxx the listing directed to the

SPS Commands

150 U21020-J-Z247-7-7600

message page can be held in the spool. You may obtain the same list with thePRINTOPT(YES) option from the control file or SETUPxxx.

If you are doing problem determination for a listing which is being printed wrongly you mayjust depress the stop key on the printer during the printout, issue the commandFDIS=(ALL),M, depress the start key on the printer, issue the JES2 commands PPRTx,IPRTx, and you will have in the message page from your listing all options/sources used.You may then check if you are using the options that you expect.


F procid,PRTx,FDIS=(option-name | ALL) [,H] [,M] for CMDIF(MODIFY)

or

R xx,FDIS =(option-name | ALL) [,H] [,M] for CMDIF (WTOR)

where:

option-name name of any JCL, JES, control file or general file option which should bedisplayed. By specifying FDIS=(ALL) you may obtain a list of all currentlysupported options for this command.

ALL requests the display of all file options and sources for the file currentlybeing printed.

H requests the display into the hardcopy log.

M requests the display in the message page.

If neither H nor M is specified the display is directed to the console.

An output of the FDIS=(ALL) command (or PRINTOPT(YES) option) should be sent toOcé together with any problem documentation related to a wrong application printout.

9.3.2 FORM Command

This command requests SPS to show the current user and real forms mounted on theprinter. The format of this command is :

F procid,PRTx,FORM for CMDIF (MODIFY)

or

Rxx, FORM for CMDIF (WTOR)

SPS Commands

U21020-J-Z247-7-7600 151

9.3.3 PRTI Command

This command requests SPS to display information about the printer type, model,resolution and supported features. For Océ printers the functional code version from theprinter is also displayed. This command is automatically issued when the JES printer isstarted and when any of the printer features are changed.


F procid,PRTx,PRTI for CMDIF(MODIFY)

or

Rxx,PRTI for CMDIF(WTOR)

9.3.4 PTFI Command

This command requests SPS to show the PTF level of one or all modules. If the level of allmodules is requested just the modules which have any PTF applied are shown. The outputof this command (ALL option) should be attached to any documentation sent to Océ tosolve a problem. The format of this command is:

F procid,PRTx, PTFI=(modname | ALL) for CMDIF(MODIFY)

or

Rxx, PTFI = (modname | ALL) for CMDIF (WTOR)

where

modname name of an SMP mod entry for the SPS base component or APA printerdriver

ALL indicates that a list of all modules with applied maintenance should bedisplayed.

A special module name - INFOPLEV - may be used to verify the SPS PTF level forcompatibility between the SPS code and compiled information page load modules. If youassign your information pages the standard names SPSMHDRx, SPSMSEPx,SPSMMSGx and SPSMTLRx you may also see their PTF level via this commandalthough your modules are not standard components of SPS.

9.3.5 QINT Command

This command requests SPS to change the value given for the STAQINT SETUPxxxparameter. The STAQINT parameter specifies a value in hundreds of seconds for a cyclic,automatically issued STAQ command. When debugging performance problems a cyclic

SPS Commands

152 U21020-J-Z247-7-7600

STAQ command may be useful in order to observe the amount of data in the SPS internalI/O queues and in the printer (received and committed page counters) during the printout.

Please see the description of the STAQ command and of the STAQINT SETUPxxxparameter for more information. The format of this command is:

F procid,PRTx,QINT nnnnnn

or

Rxx, QINT nnnnnn

where

nnnnnn is the interval in hundreds of seconds for the automatically issued STAQcommand.

9.3.6 SDIS Command

This command requests SPS to display information about one or all startup optionsspecifiable in the SETUPxxx SPSPARM member. For each SETUPxxx keyword its currentvalue and the source from where the value was taken are displayed (SETUPxxx,DEFAULT or COMMAND). The output can be displayed into the console or the hardcopylog. If PRINTSET (YES) is coded in the SETUPxxx member SPS automatically issues thecommand SDIS=(ALL), H at printer start-up.


F procid,PRTx,SDIS=(SETUPxxx-keyword-name | ALL) [,H] for CMDIF(MODIFY)

or

Rxx,SDIS=(SETUPxxx-keyword-name | ALL) [,H] for CMDIF (WTOR)

where:

SETUPxxx-keyword-name is the name of any keyword specifiable in the SETUPxxxSPSPARM member (likeDRIVER,TRACELEV,RECEXIT,etc.), which should haveits value and source displayed

ALL requests a display of all start-up options with theirsources.

H requests SPS to direct the display to the hardcopy log. Ifnot specified SPS will direct its display to the console.

An output of the SDIS=(ALL) command should be sent to Océ together with anydocumentation of a problem.

SPS Commands

U21020-J-Z247-7-7600 153

9.3.7 STAQ Command

This command requests SPS to show information about its I/O queue usage ( active andposted queues) and the current received and committed page counters. The active queuecontains all ccw sets currently being executed by the printer. The posted queue containsall ccw sets already posted as completed for which SPS is doing or will do post-processing.

Please see the description of message SPS0274I in the SPS/MVS-APA Messages Guidefor more information about this command.


F procid, PRTx,STAQ for CMDIF(MODIFY)

or

Rxx,STAQ for CMDIF(WTOR)

9.3.8 STAT Command

This command requests that SPS show the I/O status of the physical printer(s). For localprinters, SPS will also display the status of the SPS active queue (CCWs whose channelprogram is being executed), and the SPS posted queue (CCWs where I/O operationscompleted; SPS will do or is doing post-processing on these CCWs).


F procid,PRTx,[STAT] for CMDIF(MODIFY)

or

R xx,[STAT] for CMDIF(WTOR)

The STAT command is the default printer command and may be entered by justanswering the pending WTOR with EOB or by specifying the printer name for the MVSMODIFY (F) command.

See section "Printer Status NRD and Message SPS0260A" on page 122 for moreinformation about the STAT command. See the description of messages SPS0260A andSPS0261I in the SPS/MVS-APA Messages Guide for more information about thiscommand.

SPS Commands

154 U21020-J-Z247-7-7600

9.3.9 TOPE Command

This command requests that SPS open the trace files. Any previous information containedin the trace files is lost after they are opened. If the trace files are already open thiscommand is ignored. After successfully opening the trace files, SPS writes a trace recordindicating the dynamic open operation.


F procid,PRTx,TOPE for CMDIF(MODIFY)

or

R xx,TOPE for CMDIF(WTOR)

9.3.10 TCLO Command

This command requests that SPS should close the trace files. After successfully closingthe trace files, they may be unloaded to a tape or formatted using the FPTRACE samplejob (see SPSSAMP library). When the unload/formatting job terminates the trace files maybe opened again via the TOPE command. If the trace files are already closed thiscommand is ignored. Before closing the trace files SPS writes a trace record indicating thedynamic close operation and automatically issues the TINT command to write the internaltrace table into the trace files.


F procid,PRTx,TCLO for CMDIF(MODIFY)

or

R xx,TCLO for CMDIF(WTOR)

9.3.11 TDIS Command

This command requests that SPS should display the status of the trace environment viamessage SPS0266I.


F procid,PRTx,TDIS for CMDIF(MODIFY)

or

R xx,TDIS for CMDIF(WTOR)

Please see the description of message SPS0266I in the SPS/MVS-APA Messages Guidefor more information about this command.

SPS Commands

U21020-J-Z247-7-7600 155

9.3.12 TINT Command

This command requests that SPS write its internal trace table into the trace file (trace level2 is required).

Events from some special components of SPS are only traced in the internal trace table(like PCI appendage, JES X-memory routines, direct printing, open/close/put routines).The TINT command is automatically executed at normal and abnormal termination timeand before the trace files are closed via the TCLO command.


F procid, PRTx, TINT for CMDIF(MODIFY)

or

R xx, TINT for CMDIF(WTOR)

9.3.13 TLEV Command

This command requests that SPS change the trace level specification (see TRACELEVkeyword from SETUPxxx). The trace level controls the amount of information traced. Level0 corresponds to the minimum trace and level 4 to the maximum of trace information.


F procid,PRTx,TLEV n for CMDIF(MODIFY)

or

R xx,TLEV n for CMDIF(WTOR)

where:

n is a digit between 0 and 4 specifying the new trace level.

SPS Commands

156 U21020-J-Z247-7-7600

9.3.14 TSET Command

This command requests that SPS change the trace set specification (see TRACESETkeyword from SETUPxxx). The traceset controls which components from the PS (printserver) FMID of SPS are traced. The traceset specifications should be changed only onrequest from an Océ representative.


F procid,PRTx,TSET xxxxxxxxxxxxxxxx

or

R xx,TSET xxxxxxxxxxxxxxxx

where:

xxxxxxxxxxxxxxxx is a 16 character hex string specifying the new traceset value.Each digit may be 0 - 9 or A - F (one hex digit representation).All 16 digits must be specified each time this command isissued.

Optional System Tailoring

U21020-J-Z247-7-7600 157

10 Optional System Tailoring

SPS is delivered with default information pages (header, separator, message, and trailerpages), and a standard accounting routine that generates the SMF type 6 record. Thissection describes how an installation may generate specially defined information pages,modify the SMF records, provide record and message processing exits, inspect andmodify APA external resources read, affect the processing of SPS after a not-found pagesegment and modify the text of operator messages. This chapter also describes the exitscompatible with PSF exits 1, 2, 3, 7 and 16. The following sample exits are provided inSPS.SPSSAMP, in addition to those that are clarified in the following chapter.

Member name: Function:

SPSMDSCM Sample DS-ALLOC for Page Sorter.

SPSMDSCO DS-ALLOC support for OCA.

SPSMDSOS DS-ALLOC support for OCA.

SPSMDSUN DS-ALLOC support for Undefined Character.

SPSMDS1N DS-ALLOC support for Cut Sheet Emulation.

SPSMREC0 OCA to STC conversion.

SPSMREC1 OCA to STC plus OVERLAY & PAGESEG to text.

SPSMREOS ‘45’x color triplet to IM1 conversion.

SPSMREUN Default graphic character change for all inline code pages.

SOSMRE1N Inline formdef conversion to X2UP(ON).


158 U21020-J-Z247-7-7600

10.1 Information PagesAn installation may define special information pages to be used for selected forms oroutput classes on each printer. The IPAGINFO, IPLINE, IPSTRU, and IPEND macros areused to generate header, separator, message and trailer pages. After the macros arecoded the information page must be assembled and linkedited non-reentrant intoSPSLINK or linklib. Since information pages are not reentrant, they cannot be placed inLPALIB. The jobs that generated the distributed information pages may be found insamplib members SPSMHDRA, SPSMSEPA, SPSMMSGA, and SPSMTLRA. Thedistributed information pages use the default CHARS, FORMDEF, and PAGEDEF definedin SETUPxxx.

SPSMHDRP, SPSMSEPP and SPSMTLRP are delivered in source and load moduleformat. These samples produce information pages in a PSF-like format, but using thestandard SPS macros instead of PSF exit routines. These samples may help customers tocontinue using their old information page formats in a way that allow better customizationand changes.

Information pages specified in SETUPxxx as default will be used for all jobs, unlessoverridden in the form table member by an HSMTffff specification for a form name oroutput class. Every form or output class for each printer can have unique informationpages.

Any specific information page type may be suppressed by generating an information pageload module with no IPLINE or IPSTRU macro instructions (this generates an informationpage with no lines to be printed). When running under JES3 this method may be used toselectively suppress job header and dataset separator pages, as these are controlled viathe same printer parameter in this system.

All information pages are load modules that are modified at the time of printing. They mustbe compiled with the assembler option ALIGN (default option). They must be linkedited notreentrant, not reusable, and not refreshable, with any valid residency mode. These linkageeditor parameters are NORENT, NOREUS (not refreshable is assumed). RMODE=ANY isadvised but not a must. Information pages will be retained in storage and modified eachtime they are printed unless the SPS default for the DELETE option on the IPAGINFOmacro is overridden.

An information page is coded as an assembler program, however no knowledge ofassembler is required. The entire page is defined by coding SPS supplied macros. Thefirst statement of an information page program is an IPAGINFO macro which defines theprint characteristics of the information page. This macro may be optionally followed byIPLINE macros for each line on the page. An installation may define that any staticinformation, as well as selected job information, should appear on any of the lines of theinformation page. Either large block letters or standard size letters may be coded forvariables. The number of lines on the information page is determined by the number ofIPLINE macros coded. The IPSTRU macro may be used to define structured fields instead


U21020-J-Z247-7-7600 159

of line data. An information page is terminated by an IPEND macro. Please see Figure 43for a sample job to create an information page.

One information page module should be coded for each of the header, trailer, message orseparator pages that the installation wishes to replace, modify, or define. The modulenames specified for these information pages must agree with the correspondingparameters in the SETUPxxx member for a printer, or be specified in the HSMTffffmember for the special form or output class requiring them. User generated or modifiedinformation pages should be reassembled when a new release of SPS is installed.

Errors related with loading or editing an information page ( I/O error on load, invalid linkageoptions, not enough space to edit a variable) are reported by SPS via messageSPS0340E. If INFOERR (ABEND) is specified or defaulted in SETUPxxx, SPS issues theabend U345 after message the SPS0340E. If INFOERRR (CONT) is specified (compatiblewith version 3.2 and below) SPS prints message SPS0340E in place of the wronginformation page (using the print file options) and continues processing.

If you compile/relink your own information pages with the standard names SPSMHDRx,SPSMSEPx, SPSMMSGx and SPSMTLRx you will be able to see their PTF level with theSPS command PTFI. This may be useful when checking for matching PTF level betweenuser info pages and module INFOPLEV (PTFI=(INFOPLEV)) which represents the PTFlevel for info pages support in SPS.


160 U21020-J-Z247-7-7600

//SUSER JOB 'ACCOUNT #','NAME',MSGLEVEL=(1,1)// EXEC ASMACL,PARM.C='ALIGN',PARM.L='NORENT,NOREUS'//C.SYSLIB DD// DD DSNAME=SPS.SPSSAMP,DISP=SHR//C.SYSIN DD *SPSMHDRA AMODE 31SPSMHDRA RMODE ANY IPAGINFO CC=ASA, X COPIES=1, X DATACK=(BLKCHAR,BLKPOS) X DELETE=NO, MAINTAIN IN STORAGE X MODE=LINE, X MODESW=NO, X NAME=SPSMHDRA, X TRCTYPE=NO, X TYPE=HDR IPLINE '1 SPS/MVS-APA HEADER PAGE ' IPLINE ' ' IPLINE ' CLASS = %CLAS JOB = %JOBN ROOM = %ROOM ' IPLINE ' JOID = %JOID ADDR = %ADDR DEST = %DEST ' IPLINE ' PRTN = %PRTN DATE = %DATE TIME = %TIME ' IPLINE ' SEG = %SEGI FORM = %FORM CONT = %CONT ' IPLINE ' PGNA = %PGNA ' IPLINE ' ' IPLINE ' @CLAS ' IPLINE ' ' IPLINE ' ' IPLINE ' ' IPLINE ' ' IPLINE ' ' IPLINE ' ' IPLINE ' ' IPLINE ' ' IPLINE ' ' IPLINE ' ' IPLINE ' ' IPEND//L.SYSLMOD DD DSNAME=SPS.SPSLINK(SPSMHDRA),DISP=SHR

Figure 43: Sample Job to Create a Header Page for APA Printers


U21020-J-Z247-7-7600 161

10.1.1 IPAGINFO Macro

IPAGINFO [,CC = ASA | IBM | SINGLE | DOUBLE | TRIPLE | SNI | SIEMENS] [,CHARS = ((font,mxm) [,(font,mxm)]) ] [,COMP38M=YES|NO] [,COPIES = n | 1 ] [,DATACK = ([BLKCHAR][,BLKPOS]) ] [,DELETE = YES | NO ] [,DUPLEX = SIMPLEX | NORMAL | TUMBLE | ZZNORM | ZZTUMB

| RSIMPLEX | RNORMAL | RTUMBLE | RZZNORM | RZZTUMB ] [,FLIP=YES|NO] [,FORMDEF = name ] [,INBIN = 1-255 ] [,NAME = name ] [,OUTBIN = 1-255 ] [,PAGEDEF = name ] [,PRESENT=LEAVE | PORTRAIT | LANDSCAPE | PORTRAIT90 | LANDSCAPE90] [,SOSI = SOSI1 | SOSI2 ] [,TRCTYPE = NO | IBM | SNI | SIEMENS | XEROX] [,TYPE = HDR | TLR | SEP | MSG ] [,X2UP = OFF | ON | LEFT | RIGHT | ICOPIES ]

Figure 44: Format of the IPAGINFO macro

Several of the fields of the IPAGINFO macro are necessary in order to print theinformation page. These fields are CHARS, FORMDEF, and PAGEDEF. When notspecified they will be taken from the defaults defined in SETUPxxx. The info page optionsFPRUN, WRONLY and IBINSUB (see control file parameters) are obtained from thecorresponding output file being printed.


162 U21020-J-Z247-7-7600

10.1.2 Operands of the IPAGINFO Macro


IPAGINFO The operation code for the information page macro.

CC= ASA | IBM | SINGLE | DOUBLE | TRIPLE | SNI | SIEMENS

Specifies the type of printer control characters to be used. When notspecified the default is ASA.

ASA The ANSI-defined printer control characters are to be usedto print the information page.

IBM IBM standard control characters are to be used on theinformation page.

SINGLE Single spacing is to be used on the information page.

DOUBLE Double spacing is to be used on the information page.

TRIPLE Triple spacing is to be used on the information page.

SNI SNI type control characters are to be used.

SIEMENS SNI type control characters are to be used.

CHARS= ((font,mxm) [,(font,mxm)])

A list of up to 64 font names with the matrix memory (mxm) position inwhich they are to be loaded. This list is used when the PAGEDEF does nothave a font list.

Each character set is 1 to 6 characters in length. The complete characterset name in the library consists of a 2 character prefix which depends onthe printer, followed by the name specified here. SPS generates this nameat execution time.

The mxm position corresponds to the trc value in the print data set that willselect the particular font. SPS supports trc's (mxm positions) from 0 to 63.The mxm's can be in any order. Mxm position 0 must be coded if theCHARS parameter has any fonts specified because position 0 is used toprint in the case of trc's requesting mxm positions which have not beenloaded.

If CHARS is not specified and the pagedef does not have a font list, thedefault character set from the SETUPxxx member is used for thisinformation page.


U21020-J-Z247-7-7600 163

COMP38M= YES | NO

Controls the setting of the media origin.

NO The media origin will be set according to the rules definedfor AFP1 type printers.

YES If a FORMDEF is used without the presentation parameterthe media origin will be set according to the rules valid for3800 model 3 page printers.

COPIES= n | 1

Specifies the number of copies of the information page to be printed. Whennot specified 1 copy is the default.

DATACK= ([BLKCHAR][,BLKPOS])

Specifies how data checks are to be handled for invalid characters, and offpage print requests. When DATACK is not specified, the default is all errortypes blocked.

BLKCHAR specifies that invalid character data errors will not bereported to SPS.Please note that you may also block characters in the fontused.

BLKPOS specifies that print position errors will not be reported toSPS.

DELETE= YES | NO

Specifies whether this information page should be deleted from virtualstorage at the end of the print job. Code NO if this page is to be used formany different print jobs. When not specified, NO is the default.

DUPLEX= SIMPLEX | NORMAL | TUMBLE | ZZNORM | ZZTUMB |RSIMPLEX | RNORMAL | RTUMBLE | RZZNORM | RZZTUMB

Determines whether printing will be on one or both sides of a form, thedirection of printing of the second side in relation to the first side when twosided printing is requested, and in the zigzag options the order of the pageson the sides. These options select the proper orientation of the text on thepage for left or top binding requirements. When DUPLEX and PRESENTare not specified the FORMDEF specification will be used.

The use of the DUPLEX parameter overrides the FORMDEF-specifiedorientation and direction (unless PRESENT=LEAVE is specified) as well asthe relation between front and back pages of a twin or duplex printer,whatever the definition in the formdef was. When DUPLEX is not specifiedthen the FORMDEF-adjustments are in effect. This gives you the chance


164 U21020-J-Z247-7-7600

to customize orientation, direction and front/back relation in an easier way,without changing the FORMDEF used.

Please see also the PRESENT keyword.

The zig-zag options are only valid if N-UP and X2UP are not specified inthe FORMDEF and IPAGINFO macro.

SIMPLEX Simplex printing requested. Simplex printing is single sidedprinting on a portrait page. For continuous forms aftermachine bursting, and cut sheet as stacked, this optionpermits binding a single sided portrait document on the leftor top side.

NORMAL Normal duplex printing requested. Normal duplex printing istwo sided printing with the top of the front page being thetop of the back page on a portrait page. For continuousforms after machine bursting, and cut sheet as stacked,this option permits binding of a two sided portrait documenton the left side.

TUMBLE Tumble duplex printing requested. Tumble duplex printingis duplex printing with the bottom of the front page beingthe top of the back page on a portrait page. For continuousforms after machine bursting, and cut sheet as stacked,this option permits binding a two sided portrait formatdocument on the top.

ZZNORM Zigzag normal duplex printing requested. Zigzag normalduplex printing is two sided printing on continuous formswith the top of the front page being the top of the back pageon a portrait page after three sided cutting of edges (top,right, and bottom). This option permits binding a two sidedportrait document on the left side after the cut edges areremoved. This option is only used on twin printers.

ZZTUMB Zigzag tumble duplex printing requested. Zigzag tumbleduplex printing is two sided printing on continuous formswith the top of the front page being the bottom of the backpage on a portrait page after three sided cutting of theedges (right, left, and bottom). This option permits binding atwo sided portrait document on the top side after the cutedges are removed. This option is only used on twinprinters.


U21020-J-Z247-7-7600 165

RSIMPLEX Reverse simplex printing requested. Reverse simplexprinting is single sided printing on a landscape page. Forcontinuous forms after machine bursting, and cut sheet asstacked, this option permits binding a single sidedlandscape document on the left side or top.

RNORMAL Reverse normal duplex printing requested. Reserve normalduplex printing is two sided printing with the top of the frontpage being the top of the back page on a landscape page.For continuous forms after machine bursting, and cut sheetas stacked, this option permits binding a two sidedlandscape format document on the left side.

RTUMBLE Reverse tumble duplex printing requested. Reverse tumbleduplex printing is duplex printing with the bottom of the frontpage being the top of the back page on a landscape page.For continuous forms after machine bursting, and cut sheetas stacked, this option permits binding a two sidedlandscape format document on the top.

RZZNORM Reverse zigzag normal duplex printing requested. Reversezigzag normal duplex printing is two sided printing oncontinuous forms with the top of the front page being thetop of the back page on a landscape page after three sidedcutting (top, right, and bottom). This option permits bindinga two sided landscape document on the left side after thecut edges are removed. This option is only used on twinprinters.

RZZTUMB Reverse zigzag tumble duplex printing requested. Reversezigzag tumble duplex printing is two sided printing oncontinuous forms with the top of the front page being thebottom of the back page on a landscape page after threesided cutting (right, left and bottom). This option permitsbinding a two sided landscape document on the top afterthe cut edges are removed. This option is only used on twinprinters.

FLIP= YES | NO

Valid for A-Twin printers only. Exchange of the output from printer 1 (frontpages) with printer 2 (back pages).

NO Do not exchange.

YES Exchange it.


166 U21020-J-Z247-7-7600

FORMDEF= name

Specifies the 1 to 6 character name of the form definition that will be usedfor this information page.

The complete resource name in the library consists of a two characterprefix F1 followed by the name specified here. SPS generates this name atexecution time.

If FORMDEF is not specified the default FORMDEF from the SETUPxxxmember is used for this information page.

INBIN= 1-255

Specifies the number from 1 to 255 of the input bin containing the forms tobe used for printing the information page. Numbers 1, 2, 3,..., 16correspond to the input bins A, B, C,...., P respectively. If this parameter isnot specified the input bin from the corresponding file will be used for thisinformation page.

NAME= name

Specifies the 1 to 8 character module name of this information page. Thisparameter must be specified in the macro.

OUTBIN= 1-255

Specifies the number from 1 to 255 of the output stacker where the formsused for printing the information page are to be stacked. If this parameteris not specified the output stacker from the corresponding file will be usedfor this information page.

For compatibility with previous releases OBIN is still accepted with itsassociated bin number conventions.

PAGEDEF= name

Specifies the 1 to 6 character name of the page definition that will be usedfor a line print job.

The complete resource name in the library consists of the two characterprefix P1 followed by the name specified here. SPS generates this name atexecution time.

If PAGEDEF is not specified, the PAGEDEF from the SETUPxxx memberwill be used for this information page.


U21020-J-Z247-7-7600 167

PRESENT= LEAVE | PORTRAIT | LANDSCAPE | PORTRAIT90 | LANDSCAPE90

Allows the presentation specification from the FORMDEF to be used evenif duplex is specified in this IPAGINFO macro or overrides only thepresentation from the FORMDEF. The specification of a presentation onthis parameter (PORTRAIT, LANDSCAPE, etc.) affects also cut-sheetprinters even when the FORMDEF does not specify N-UP. You can notchange the presentation of cut-sheet printers from PORTRAIT via theFORMDEF.

LEAVE Presentation specified via resources should be used bySPS and not affected by the duplex parameter specified onthis IPAGINFO macro. The duplex parameter may overrideonly the duplexing feature. So, DUPLEX=SIMPLEX andDUPLEX=RSIMPLEX will have the same effect,DUPLEX=NORMAL and DUPLEX=RNORMAL will have thesame effect, and so on.

PORTRAIT SPS should force the presentation PORTRAIT, does notmatter what the external resources specify and what theDUPLEX parameter specifies. So, DUPLEX=SIMPLEX andPRESENT=PORTRAIT has the same result asDUPLEX=SIMPLEX only. DUPLEX=RSIMPLEX andPRESENT=PORTRAIT has the same effect asDUPLEX=SIMPLEX only.

LANDSCAPE SPS should force the presentation LANDSCAPE, does notmatter what the external resources specify and what theDUPLEX parameter specifies. So, DUPLEX=RSIMPLEXand PRESENT=LANDSCAPE has the same result asDUPLEX=RSIMPLEX only. DUPLEX=SIMPLEX andPRESENT=LANDSCAPE has the same effect asDUPLEX=RSIMPLEX only.

PORTRAIT90 SPS should force the presentation PORTRAIT90, does notmatter what the external resources specify and what theDUPLEX parameter specifies. So, if DUPLEX=RSIMPLEXor DUPLEX=SIMPLEX is specified SPS will always printwith presentation PORTRAIT90.

LANDSCAPE90 SPS should force the presentation LANDSCAPE90, doesnot matter what the external resources specify and what theDUPLEX parameter specifies. So, if DUPLEX=RSIMPLEXor DUPLEX=SIMPLEX is specified SPS will always printwith presentation LANDSCAPE90.


168 U21020-J-Z247-7-7600

SOSI= SOSI1 | SOSI2

Specifies that SOSI control is to be used for printing this information page.When not specified, no SOSI control will be used for printing thisinformation page.

SOSI1 specifies that the SO or SI code invokes the font switch andcauses a blank (X'40') to replace the SOSI code.

SOSI2 specifies that the SO or SI code invokes the font switchonly. No blank is inserted to replace the SOSI code.

Each input line of the information page must start with a single byte font. Ifthe line starts with a double byte font you must start the line with an SOcontrol, irrespective of how the last line ended.

TRCTYPE= NO | IBM | SNI | SIEMENS |XEROX

Selects the type of table reference character processing for printing aninformation page containing TRC's. When not specified, NO is the default.

Fonts which may be selected by trc are loaded into matrix memorypositions (MXM's) in the printer determined by one of the following:

1. PAGEDEF font list order starting at mxm 0

2. Information page CHARS list as specified

3. SETUPxxx CHARS

Table reference characters select the matrix memory position in which afont is loaded. IBM trc's support mxm positions 0 through 127, SNI trc'ssupport mxm positions 0-254.

NO No TRC information is stored in the data to be printed onthe information page.

IBM Interpret trc as an IBM table reference character. Thefollowing rules apply to IBM trc's depending where the fontlist is taken from and the highest loaded mxm position.When an IBM trc is invalid or addresses an mxm that is notloaded with a font, the font at mxm 0 is used. Due to thecoding requirements of PAGEDEFs and information pageCHARS lists, mxm 0 always contains either the default fontor a font selected by the font list source.

1. TRC's may be characters 0-3 (X'F0'-X'F3') or X'00'-X'03'. The characters 0-3 are converted to X'00'-X'03'to determine the mxm position.

2. TRC's may be hex characters X'00'-X'7F'.


U21020-J-Z247-7-7600 169

The following table shows which rule applies depending onwhere the font list is taken from and the highest loadedmxm position. The font list used will be the first not emptyfont list source encountered going down the "source of fontlist" column. The number of the trc rule that applies is thenumber found at the intersection of the column indicatinghighest loaded mxm position and the selected font listsource row.

SOURCE OFFONT LIST

HIGHEST LOADEDMXM POSITION

0 - 3 4 - 127Infopage CHARS (1) (2)PAGEDEF (1) (2)SETUPxxx CHARS (1) -

SNI Interpret trc as an SNI table reference character. SNI trc'scan be hex characters X'00'-X'FE' which select mxmpositions 0-254 respectively. When an SNI trc is invalid oraddresses an mxm that is not loaded with a font, the font atmxm 0 is used. Due to the coding requirements ofPAGEDEFs and information page CHARS lists, mxm 0always contains either the default font or a font selected bythe font list source.

SIEMENS Same as SNI.

XEROX Interpret TRC as a XEROX table reference character.XEROX TRC characters can be hex characters X'F0' toX´FF´, which select mxm positions 0-15 respectively.

TYPE= HDR | TLR | SEP | MSG

Specifies the type of information page that is to be generated by thismacro. This parameter must be specified in the macro.

HDR This macro should produce a header page.

TLR This macro should produce a trailer page.

SEP This macro should produce a separator page.

MSG This macro should produce a message page.


170 U21020-J-Z247-7-7600

X2UP= OFF | ON | LEFT | RIGHT | ICOPIES

Selects whether the two up feature should be used to print the informationpage. The two up feature is a software controlled hardware function thatcauses two input pages of the print data stream to be printed on onephysical output page. Please see "Hardware Two Up" on page 124 for anexplanation about the relationship between the hardware two up and thesoftware two up.

OFF Set the printer to one up. This will be the default if thisparameter is not specified and corresponds to the sameprintout as if the printer does not have the two up feature.

ON Use the hardware two up feature to print two consecutiveinformation pages on each physical output page.The consecutive input pages (1,2,3,4,5,..) are printed onthe paper in a left→right sequence:page 1 on the left side of sheet 1page 2 on the right side of sheet 1page 3 on the left side of sheet 2page 4 on the right side of sheet 2page 5 on the left side of sheet 3

In case of a twin-system the page sequence on the paperis:page 1 on the left front side of sheet 1page 2 on the right back side of sheet 1


(= backside of page 3)page 5 on the left front side of sheet 2page 6 on the right back side of sheet 2


(= backside of page 7)....

LEFT The same as ON

RIGHT Similar to ON, except the page sequence on the paper isright→left instead of left→right.

COPIES Use the hardware two up feature to print two copies of eachinformation page on one physical output page.


U21020-J-Z247-7-7600 171

10.1.3 IPLINE Macro

Code one IPLINE macro for each line to appear on the output page. Each line starts withIPLINE ' in columns 2 to 9 and contains free form text and/or variables from the specialvariable list below. A line of text is terminated by a quotation mark. If an output line isdesired that exceeds column 71, any non blank character should be place in column 72 toindicate continuation of the line to the next record, and the line should be continued on thenext record starting in column 16. Quotation marks may be printed by coding them twice.

If no IPLINE and IPSTRU macros are coded SPS will generate an information page withno lines to be printed. Such an information page will generate no printout although SPS willrecognize the existence of the information page itself.

The following words have special meaning when they appear in the text of an IPLINEmacro. They are used as variables referencing the associated information, which is eithersupplied by JES or the installation. If the contents is not available for any reason (JESversion too early, field not supplied by installation, etc.) a blank field will be printed.

%ADDR Printer address (3 bytes).

%BLDN Building (1 to 60 bytes) from OUTPUT statement. If not present use theWABLDG variable from the work attributes segment of the user profiledefinition in RACF or similar product.

%CLAS Output class of printed job (1 byte).

%CONT 5 character field indicating whether this is an original print job (START), arestart of a print job after a checkpoint (CONTI), or a restart of a print jobafter repositioning due to operator command or I/O error on printer(REPOS).

%COPY 3 character copy number, useful when separator pages are requestedbefore each copy.

%DATE Date of printing in format dd/mm/yy.

%DATX Date of printing in format dd mmm yyyy (like 05 AUG 1996), (11 bytes).You may change the standard abbreviations used for the months in thisvariable in the last table of module SPSUBTBL (SPSSAMP). You shouldthan recompile/relink SPSUBTBL and request SPS to use it via thePSFBTBL parameter from SETUPxxx.

%DAT1 Date in USA format mm/dd/yy.

%DDNA Ddname of print data set (8 bytes).


172 U21020-J-Z247-7-7600

%DEL1-4 Delivery addresses 1 through 4, 1 to 60 bytes each from OUTPUTstatement. If not present use the WAADDR1-4 variables from the workattributes segment of the user profile definition in RACF or similar product.

%DEPT Department (1 to 60 bytes) from OUTPUT statement. If not present use theWADEPT variable from the work attributes segment of the user profiledefinition in RACF or similar product.

%DEST Destination of output (8 bytes).

%D2TE Date of printing in format dd/mm/yyyy (10 bytes).

%D2T1 Date of printing in format mm/dd/yyyy (10 bytes).

%FORM Form name specified in JCL (8 bytes).

%GLIN Total number of input records read in the whole output group. This variablehas a correct value only when printed on the trailer page from the outputgroup (11 bytes).

%GLPA Total number of logical input pages read for the whole output group. Thisvariable has a correct value only when printed on the trailer page from theoutput group (11 bytes).

%GRPN Output group name (8 bytes).

%GRP1 Output group id1, converted from 2 byte hex to character (8 bytes).

%GRP2 Output group id2, converted from 2 byte hex to character (8 bytes).

%JOBN Job name (8 bytes).

%JOID Job number (8 bytes).

%LIVE LI/MVS Version (3 bytes)

%NAME Programmer name (1 to 60 bytes) from OUTPUT statement. If not presentuse %PGNA (20 bytes) from JOB card. If not present use the WANAMEvariable from the work attributes segment of the user profile definition inRACF or similar product.

%PGNA Programmer name (20 bytes) from JOB card.

%PRTN Printer name as coded in the SPSPRINT member (8 bytes).

%PSVE PS/APA Version (4 bytes)

%ROOM Programmer room from JOB card (4 bytes).

%ROM1 Programmer room from OUTPUT statement (1 to 60 bytes). If not presentuse %ROOM (4 bytes) from JOB card. If not present use the WAROOMvariable from the work attributes segment of the user profile definition inRACF or similar product.

%RTIT Report title (1 to 60 bytes), from output statement.


U21020-J-Z247-7-7600 173

%SEGI 5 byte printout segment identifier (only JES2 V4 and above).

%SPSV SPS/MVS-APA Version (3 bytes) .

%STEP Step name of print data set (8 bytes).

%SYID SMF system name (4 bytes).

%TIME Time of printing in format hh:mm:ss (8 bytes).

%TITX Time of printing in format hh:mm:ss AM/PM (like 08:20:02 PM) (11 bytes).

%USD0-F Values from the USERDATA output parameter. Each value may have alength of up to 60 bytes.

%USER User id which submitted the print job (8 bytes).

%US00-47 Installation supplied variables to print. Each variable may be 1-255characters as defined by installation in macro IPUSEVAR. See "PreparingInstallation Supplied Variables" on page 208 for more information aboutthese variables. Previous SPS versions supported up to variable %US63. Ifyou use the variables from %US48 to %US63 you should transfer itsinformation into lower numbered variables (%US00 to %US47) and use thesubstring notation (each user variable may have up to 255 bytes).

10.1.3.1 Block Letters

Any of the variables on the IPLINE macro may also be printed in large block letters. Toprint a variable in block letters @ replaces the % that normally precedes the variable.Code 11 blank lines after a line containing block letter variables (block letters are 12 lineshigh). You should also calculate whether your block letter text will fit into the width of yourinformation page. Use the following formula:

(14 x N) - 2

where N is the number of characters in the value of the variable in question. This givesthe number of spaces that are required across the width of your physical page toaccommodate the particular variable value in block lettering. The maximum permissiblenumber of spaces is naturally dependent on the width of your physical form. If any blockletter attribute is specified (see 'Attributes of Infopage Variables' later) the line should be132 bytes long (normal block letters) or 84 bytes long (performance block letters).

The SPS block letter routine accepts any alphanumeric or national character and also thefollowing special characters:

. , / ' ( ) * & + - = ¢

SPS may use two kinds of block letter tables. The default block letter table (used whenPSFBTBL is not specified in the SETUPxxx) is an internal SPS table (not user modifiable)


174 U21020-J-Z247-7-7600

which is compatible to the JES block letter table. When PSFBTBL (table-name) isspecified SPS uses a PSF-compatible block letter table. This can be the PSF block lettertable itself (APSUBTBL) or the SPS table SPSUBTBL, which is delivered as samplesource module (SPSSAMP) and load module. You may modify and recompile/relinkSPSUBTBL in order to change the format of your block letters. See the instructions in thesource code of the tables. In order to use performance block letters (see 'Attributes ofInfopages Variables' later) you must use a PSF-compatible block letter table, otherwiseunpredictable results may occur. Block letters may be left-justified or centered, normal orslanted and performance block letters or not. (See 'Attributes of Infopages Variables'later).

10.1.3.2 Attributes of Infopages Variables

An information page variable may have up to 5 attributes. The attributes are coded as 5positional parameters, just after the variable name, under parenthesis. The first 2attributes, used for substring notation, are valid for normal and block letter variables. Thelast 3 attributes are valid only for block letters.

The format of the attributes is:

%VAR1(b,l,c,s,h)

where:

b is the first position of the variable to be used (from 1 to variable value length)

l is the length of that part of the variable to be used beginning at position 'b' (from 1to variable value length)

c the block letter should be centered

s the block letter should be slanted

h the block letter should have the PSF-compatible high speed format (also calledperformance block letter). If it is specified a PSF compatible block letter tableshould be used (see PSFBTBL SETUPxxx parameter).

When you specify any of the block letter attributes (c, s, or h) your block letter variableshould be in the first position of a line (just after CC/TRC) and you should provide allIPLINES for the block letter expansion with at least 132 bytes plus CC/TRC (or 84 bytesplus CC/TRC when performance block letters are used). Also, the variables are assumedto be 8 bytes long, padded with blanks. The centering function searches for the first none-blank byte from right to left in order to center the readable information in the 8 byte field.

The following are examples of valid use of the attributes:

@JOBN(,,C) job name in block letters, centered (8 bytes).

@CLAS(,,C,S) class in block letters, slanted, centered (1 byte).


U21020-J-Z247-7-7600 175

@JOBN(2,2,,,H) second and third letters from job name, in block letters, left justified, notslanted, using the performance block letters.

10.1.3.3 Installation Supplied Variables

The variables %US00 to %US47 (@US00 to @US47 for block letters) may be used inSPS JES spool data set processing to print information on the header, separator, or trailerpage that is not available via standard infopage variables. The installation can assignthese variable values for SPS JES spool data set processing in installation prepared JESstandard exist or at user defined exit points (see sample members SPSIX23 for JES2 andSPSIX45 for JES3). These variables may also be used by a direct printing application toplace information in the header and trailer page. A direct printing application can assignthese variables values in the direct printing processing program. Please see "PreparingInstallation Supplied Variables" on page 208 for detailed information on preparing thesefields for printing.

10.1.4 IPSTRU Macro

Code any structured field in this macro. This macro can be intermixed with IPLINE macrosto include any structured field elements that can validly be included in line data. IPSTRUcan also be used to define an entire composed text page. IPSTRU would normally be usedto include the pages, page segments, images, required resources, etc. from libraries,rather than defining the entire page inline. Composed text within the structured fields willnot be scanned for variable substitution or block letters. For more information onstructured fields, please refer to the publication SPS Data Stream Reference Manual.

If no IPSTRU and IPLINE macros are coded SPS will generate an information page withno lines to be printed. Such an information page will generate no printout although SPS willrecognize the existence of the information page itself.

10.1.5 IPEND

Use this macro to indicate the end of an information page definition. Code IPEND startingin column 2. Leave the rest of this line blank.

10.1.6 $IECHNG and $IELEV

These macros are used by the IPAGINFO macro in the compilation of the informationpages. They generate the header for the information pages which contains release levelinformation that is checked during loading of the information pages. These macros mustbe used from the SPS release in which the information pages are to be used.


176 U21020-J-Z247-7-7600

10.2 PSF Compatible Information PageSPS supports exits to print header, d/s separator and trailes pages in a compatible way toPSF exits 1, 2 and 3. For instructions on how to use the PSF exits the PSF documentationshould be used in addition to the instructions that follow. The SPS implementation forthese exits was based on PSF version 2.1.1, and runs also with PSF version 2.2.

The following items should be noted in addition to the PSF exits description:

• The name of the PSF exits is specified in the SETUPxxx member via the parameters:

PSFX01(......) /* Exit 1 LMOD Name */PSFX02(......) /* Exit 2 LMOD Name */PSFX03(......) /* Exit 3 LMOD Name */

• The way to request PSF exit processing (instead of default SPS information pages viaIPLINES macros) is via the specification of the PSFXnn parameter in the SETUPxxxmember. The default is the standard info pages of SPS. A mix of SPS and PSF infopages (hdr page via exit and trailer page via macros) is allowed.

• SPS does not support the output statements in the SPS startup procedure in order tospecify the PSF info pages printing characteristics. Instead, the lmods produced via theIPAGINFO/IPLINES macros should be compiled and linked and requested via theSETUPxxx member or forms control table. In the IPAGINFO macro the user shouldspecify the PSF info page printing characteristics (like FORMDEF, PAGEDEF, etc...).When a PSF exit is requested, SPS ignores the lines generated via IPLINES macrosand uses as info page data the output from the PSF exit.

• The following restrictions apply to the PSF exits in relation to the PSF implementation:

- If the APSUCOM load module is not provided in the SPS library its pointer is passedas 0 in the ECAUCOMP field. SPS does not provide a macro corresponding to theAPSXUCOM macro.

- No sample PSF exit is provided with SPS.

- Fields ECAPTF, ECAREL, ECEPTF and ECEREL are passed with zeroes to theexits.

- Field ECASABP contains a pointer to the main control block of the SPS printingtask, the GCA, which does not have the same lay-out as the corresponding PSFcontrol block pointed by this field.

- Field ECAMARP always contains zeroes.

- Field ECARNDM always contains '1111111'.


U21020-J-Z247-7-7600 177

- Flag bits from byte ECADRF are ignored by SPS when passed to its put routine(except ECADRS). The corresponding specifications should be coded in theIPAGINFO macro used to specify the printing characteristics of the information page(carriage control, trc). This means that the carriage control type can not be changedfrom one record to the next. The exit should set ECADRS each time it calls the PUTroutine passing a structured field record. In this case no '5A' carriage controlcharacter should be passed in the exit record preceding the structured field. SPSwill insert itself the '5A' carriage control. When the exit calls the PUT routine passinga line record bit ECADRS must be 0.

- If block letters are required in ECAFLAGS and you want SPS to use the PSF-compatible block letter table, you should specify PSFBTBL (table-name) in theSETUPxxx. Table-name can be the PSF block letter table APSUBTBL or the SPSdelivered table SPSUBTBL. You may customize and recompile/relink theSPSUBTBL table to your installation requirements (SPSSAMP). If performanceblock letters are requested (ECAPBLK on) you MUST use a PSF compatible blockletter table. The default block letter table of SPS is compatible to JES block letters.

- Fields ECEDPDEF and ECEDFDEF contain the default PAGEDEF and FORMDEFspecified in the SETUPxxx member.

- Field ECEPDEVK contains the name of the SETUPxxx member being used for thecurrent print session.


178 U21020-J-Z247-7-7600

10.3 PSF Compatible Exit 7SPS supports a very restricted subset of the PSF exit 7 interface in order to allow an Exit 7to make a security check (via RACF, for example) via the resource access call. The PSFdsects used for the exit interface are for PSF/MVS version 2.2 (please note that the XTP7dsect changed in PSF/MVS version 2.2).

10.3.1. Exit Activation

PSFX07(exit-name) should be specified in the SETUPxxx member from SPSPARM.

10.3.2 Supported Exit 7 Calls

a) Init Call (XTP7ETYP = XTP7INIT):

In this call the exit may only set any of the flag bits from byte XTP7NACC, in orderto request SPS to make a resource access call for specific resource types. Noother function is performed by SPS after returning from the INIT call.

b) Resource Access call (XTP7ETYP = XTP7ACC):

This call may be issued by SPS, if requested via XTP7NACC, for pagedefs,formdefs, page segments, overlays and coded fonts.

In this call there will be always only one RLST queued in the XTP7.

The following Exit7 related fields are set in the XTP before the resource access call:

XTPRECP

XTPJSPAP

The following fields are set in XTP7 before the resource access call:

XTP7CID

XTP7LENG

XTP7ETYP

XTP7RTYP

XTP7DSTY

XTP7DSAT (either print file or header page)

XTP7RFLG, with XTP7ETFF, EFFH, PRNS and PRND on


U21020-J-Z247-7-7600 179

XTP7RESC

XTP7LSTP

XTP7LSTC

XTP7PNAM

The following fields are set in RLST before the resource access call:

RLSTCID

RLSTLENG

RLSTRESC

RLSTRRI

RLSTAUX (for information page resources)

RLSTNAME

RLSTUSER (for resources from userlibs)

After returning from the resource access call SPS tests bit XTP7TDS. If on, SPS printsmessage SPS0319I on the message page and returns the print file to JES in hold. If theexit passes a string via fields XTP7MSGP and XTP7MSGL, SPS adds this information tomessage SPS0319I.

No other function is performed by SPS after returning from the resource access call (likeresource substitution, reload request, etc.).


180 U21020-J-Z247-7-7600

10.4 Coding User Exit RoutinesSPS supports 6 exit types that can be used for both JES spool data stream processingand direct printing:

1. Accounting

2. Input record processing

3. Message processing

4. Data-set allocation

5. Resource read exit

6. Page Segment exit

These are the SPS standard exits. There are no coding differences between JES spooland direct printing for these exits. Coding conventions for these exit types are describedbelow.

An additional exit, the SPS direct printing compatibility exit, is supported for compatibilitywith PSF direct printing processing exit 16. The SPS direct printing exit is 100%compatible in coding conventions and functions with the corresponding PSF exit. This exitshould only be used if an existing application is being migrated to SPS that makes use ofthis exit in the original system. In general SPS standard exits will provide the samefunctions with much simpler implementation. For further information about the compatibilityexit please consult the PSF documentation for exit 16.

You specify the name of the direct printing exit with the parameter MSGEXDP (exit-name)from SETUPxxx.

10.4.1 Coding Conventions

All SPS standard exits receive control by conventional subroutine call linkage conventions.A static work area (global exit area) is provided that is common to all exit routines.

At entry to all exits the registers are:

R1 Points to a parmlist for the exit

R13 Save area in which to save entry registers

R14 Return address

R15 Entry point of exit invoked

At return, R15 should be loaded with a return code that indicates what action SPS shouldtake in relation to the exit function.


U21020-J-Z247-7-7600 181

R12 should be used as the base register for the exit, and the name of the routine inEBCDIC should be coded at the entry point +4. When these conventions are followed, thename of the routine will appear in SPS messages and trace records in the event of anabend.

User exits requesting abnormal termination should use abend codes U691-U699. Theseabend codes have been reserved for exit requested abends.

Exits should be reassembled with each new release of SPS. They also need to bereassembled whenever JES or operating system control blocks that they reference arechanged. Exits need not be reentrant, but reentrancy will save main storage.

10.4.2 Linkage Conventions

Exits must be linked into authorized libraries. They need not be reentrant, but reentrancywill save main storage. All exits may be linkedited in any valid AMODE/RMODEcombination.

10.4.3 Global Exit Area (GEA)

The first parameter in the parmlist passed to an exit is the Global Exit Area. This is a 2048byte work area that is under the control of all exit routines. It is allocated once for a printersession, and remains allocated until the printer is drained or abnormally terminated. Theexit routines may use this area as an exit communication area, work area, and anchor forexit required control blocks and storage.

10.4.4 Working Storage

Exits may acquire working storage if more is needed than is available in the GEA.However, only subpools that are automatically freed at task termination should be used.The GEA is acquired and freed by SPS.

10.4.5 Control Blocks

All control blocks passed to exit routines are either SPS, JES, or Operating System controlblocks. The macros for generating DSECTs for SPS control blocks are supplied inSPS.SPSSAMP. The macros for the required JES and operating system DSECTs are inSYS1.MACLIB.

The following macros provide DSECTs for the control blocks that may be passed to theexit routines:


182 U21020-J-Z247-7-7600

Macro Control Block

DSLIST Data-set list block (SPS)

DSNBLOCK Data-set block (SPS)

DSXPARM Data-set allocation exit parameter list (SPS)

GCA Global control area (SPS)

GEA Global exit area (SPS)

IAZIDX Index table and index entry (OS)

IAZJSPA Job separator page data area (OS)

IFASMFR(6) SMF type 6 record (OS)

IPCONTRO Control parameter area for user variables (SPS)

IPPARM Parameter list for user variables (SPS)

IPUSEVAR User variable (SPS)

KYDUPD Keyword update (SPS)

MEMBLOCK Member block (SPS)

MEPARM Message exit parameter list (SPS)

PDB Primary data stream block (SPS)

PDSINFO Primary data stream information control block (SPS)

POHEADER Cell poll header (SPS)

PRTINFO Printer information block (SPS)

PSINFO Print Server information block (SPS)

RDDCB Resource DCB block (SPS)

RDSBLOCK Resource data stream block (SPS)

READBLOC Resource read block (SPS)

REXPARM Record exit parameter list (SPS)

RPXPARM Page Segment exit parameter list (SPS)

RRXPARM Resource read exit parameter list (SPS)

R6XPARM Accounting exit parameter list (SPS)


U21020-J-Z247-7-7600 183

10.5 Accounting ExitThe accounting exit permits an installation to receive control and perform special functionsevery time an SMF type 6 record is generated by SPS. An SMF type 6 record is generatedby SPS for every print data set processed. Using this exit it is possible for an installation tomodify or suppress the SMF type 6 record, or even maintain a separate accounting orperformance file. A sample accounting exit may be found in memberSPSM6EXI of SPS.SPSSAMP. You find the format of the SMF type 6 record generated bySPS in the appendix B from this manual.

The accounting exit is activated by specifying the SMF6EXIT parameter in the SETUPxxxmember for the printer. This parameter should contain the name of the load module that isthe exit.

10.5.1 Parameter List

When control is received by the accounting exit, R1 points to the following parameter list(mapped by DSECT R6XPARM):

Offset Parameter Description

+0 Pointer to global exit area (GEA)

+4 Pointer to SMF type 6 record for the print data set

+8 Length of SMF type 6 record for the print data set

+C Pointer to primary data stream information control block (PDSINFO) for theprint data set

+10 Pointer to job separator page area (JSPA) for the print data set

+14 Pointer to abend processing flag byte

N An exit abend should disable the exit but not abend SPS if possible

Y An exit abend should terminate SPS (default)

+18 Pointer to the PDB (SPS control block with file information).

10.5.2 Return Codes

At return from the accounting exit, R15 should be loaded with one of the following returncodes:

RC Action

0 SPS should write the SMF record normally

4 SPS should not write the SMF record


184 U21020-J-Z247-7-7600

10.5.3 Programming Considerations

All control blocks are the actual control blocks not copies.

Any fields changed invalidly may cause an abend in SPS or JES.

The length of the SMF type 6 record cannot be changed.

Invalid SMF records may not be discovered until installation SMF processing is attempted.

The default for the abend processing flag is abend SPS in case of exit abend. The defaultis active on the first invocation of the exit. The abend option may be changed at anyinvocation of the exit and remains in effect until next changed.

This exit may use fields PDBTIPAG and PDBTILIA in the PDB control block to obtain thetotal number of logical input pages and input records in the output group up to thecurrent file. If processing the last file in the output group these fields contain thecounters for the whole output group.

10.6 Input Record Processing ExitThe input record processing exit permits an installation to make modifications or deletethe current input record, and insert record(s) before and/or after the current inputrecord. SPS invokes the input record processing exit every time SPS reads an inputrecord from the spool or encounters an end of data set transmission (EOT). Sampleinput record processing exits can be found in SPS.SPSSAMP member SPSMREXI.SPSMREXI illustrates inserting and deleting records.

The sample input record exit SPSMREOV allows page segments and overlays to beprinted as data.

The sample input record exit SPSMREUN allows the customers to find characters in aprint file which are causing data-checks.

SPSMRECO and SPSMREC1 - input record exit may be used to convert the PTOCAtext controls set extended text color (SEC) with OCA type into the text control text color(STC) when they appear in inline resources or input data.

The sample input record exit SPSMREXD allows a data-set separator to be printed inthe same physical page as the first file page.

The sample input record exit SPSMREOS. The exits should be used when you haveextended color triplets (including shadings) and your printer does not support them.


U21020-J-Z247-7-7600 185

The input record processing exit is activated by specifying the RECEXIT parameter inthe SETUPxxx member for the printer. This parameter should contain the name of theload module that is the exit.

10.6.1 SPOOL Record Processing

JES processes spool records by reading blocks from the spool into buffers andconstructing an index list for the records contained in a buffer. An index list consists of abase section and index entries. Each index entry consists of a pointer to the beginning of arecord, and descriptive information concerning the record. Records in JES spool buffersmay be spanned, in which case the index list contains pointers to each segment of thespanned record, and the descriptive information indicates the start of a record, middlesegments, and last segment. For more information concerning JES spool bufferprocessing please consult the JES2 or JES3 Program Logic Manual.

SPS passes a record to the input record exit as a pointer to the beginning of the recordand a pointer to an index list. The index list is exactly the same format as a JES index listwith only one index entry. Spanned records read from the spool are reassembled by SPSand presented to the exit as a single unspanned record. The index list presented to theexit is an internally generated index list correctly describing the reassembled record SPSpasses to the exit. This simplifies user exit processing as no spanned record logic isnecessary in the exit.


When control is received by the input record processing exit, R1 points to the followingparameter list (mapped by DSECT REXPARM):



+4 Pointer to EOT indicator byte. This indicates end of copy.

N Not end of copy

E Normal end of copy

I Abnormal end of copy (cancel, interrupt, restart, I/O error, or repositioning)

+8 Pointer to EOT request flag byte

N Exit does not want EOT notification (default)

Y Exit requires EOT notification

+C Pointer to input record or 0 if EOT notification without record

+10 Pointer to index list for input record and output index list for a modified record


186 U21020-J-Z247-7-7600

+14 Length of input record

+18 Pointer to PDSINFO for print data set

+1C Pointer to JSPA for print data set

+20 Pointer to POS positioning flag byte

N Next sequential

B Beginning of transmission

A Altered non sequential position

+24 Pointer to abend processing flag byte



+28 Pointer to working unit flag passed to SPS from exit

Y Records being added start a new unit of work

+2C Pointer to a 4-byte field containing the pointer to the lines of the data-setseparator. Used if POS flag contains 'B' and JES d/s separators are inactive. Eachline starts with a 4 byte length field followed by the line itself.

+30 Pointer to a 4-byte field containing the length of all d/s separator page lines if theprevious parameter has a separator page.

10.6.3 Return Codes

At return from the exit, R15 should be loaded with one of the following return codes:

RC Action

0 SPS should write record normally

4 SPS should skip record

8 SPS should use index list supplied by exit instead of input record index list (exitindex list may contain pointer(s) to new input record(s))


• All control blocks are the actual control blocks not copies.

• Any modification of the record passed to the exit, with the exception of a skip recordrequest, requires that both the input record and the input index be copied to user exitstorage and modified as appropriate.


U21020-J-Z247-7-7600 187

• Changing the length of a record requires that the data length field (IDXRECL) in thenew (copied) index entry for the record be updated to the new length.

• The carriage control type (IDXANSI or IDXMACH) and OPTCD=J option (IDXOPJ) ofthe current record passed to the exit cannot be changed. This includes the current inputrecord, and modified or inserted records.

• Adding a record requires that the index for the current record be copied to a work areaand a new entry be added to the index which describes the new record. The number ofentries field (IDXNUM) in the fixed portion of the index must be updated with the newnumber of records in the index list. The new record can be inserted before the currentrecord by moving the index entry for the current record right and inserting the new entrybefore it, or after the current record by adding the new index after the current recordindex.

Up to 32767 records may be added as desired in one invocation of the exit.

Spanned records may be added in the exit provided the index list has IDXSRS,IDXSRM, and IDXSRE properly coded.

When records are added, control is not returned to the exit until the next JES spoolinput record is processed. The exit will not receive control for any of the insertedrecords.

• Inserted records should all have the record identifier of the current input record inIDXRECID, even if the current input record is to be deleted.

• When a record to be inserted is a structured field record (X'5A' in first byte) the flagIDXDSR must be set in the index entry to indicate a structured field record, and eitherIDXANSI OR IDXMACH must have been set in the current input record to indicatecarriage control character present (X'5A').

However since the carriage control specification (IDXANSI and IDXMACH) cannot bechanged, this means that structured field records cannot be inserted before or after linedata records without carriage control, and line data records without carriage controlcannot be inserted before or after structured field records.

• The default for the end of data set transmission (EOT) option is no notification. Thisdefault is active on the first invocation of the exit. The exit may request that EOTnotification be given if the exit requires this information by setting the EOT option flag inthe parmlist. The EOT notification status remains in effect until it is next changed.

EOT may be indicated concurrent with a record being given to the exit, or alone with norecord being passed. When EOT notification is turned off the exit will never receivecontrol without a record to be processed.

When SPS indicates EOT (pointer at +4) with the abnormal end flag set (I), no recordcan be changed, inserted, or deleted by the exit even though a record pointer may be


188 U21020-J-Z247-7-7600

present. The positioning flag byte pointer (+20) may or may not be present. In all casesof EOT with abnormal end indicated SPS assumes RC = 0 from the exit.

• The abnormal end of copy value (I) for the EOT indicator byte is currently given bySPS, when requested by the exit, in the following cases:

1. SPS starts reading a following copy of a file without reaching end of file from theprevious copy (e.g. because of a printer error or forward space to next copy).

2. SPS starts reading a file without reaching end of file from the previous file (e.g.because of a printer error).

3. SPS reaches end of copy while processing a repositioning command.

4. SPS releases a file to JES, either as completely or incompletely processed, withoutreaching end of file in its read processing (e.g. because of a cancel or interruptcommand, or after a printer I/O error followed by NPRO).

• The default for the abend processing flag is abend SPS in case of exit abend. Thedefault is active on the first invocation of the exit. The abend option may be changed atany invocation of the exit and remains in effect until next changed.

• If your JES version supports AMODE=31 for FSS printers the input record exit shouldbe prepared to receive the input record above the line. SPS does not move the inputrecord to a 24-bit area even if the input record exit has AMODE=24.

• The data-set separator parameters (lines and length) allow an input record exit to printthe d/s separator as first data page and have it in the same physical page of the firstlogical page from the printing file.

• The working unit flag should be used when the exit adds/modifies a lot of records whichare logically dependent. For example, if the exit detects an input record, then excludes10 pages and adds in place of them 5 new pages, it is not desired that because of apaper jam or repositioning command SPS repositions in the middle of an excludedpage. When the exit specifies Y - new working unit - it establishes something likeSYNC points in the input data, so that repositioning will never occur to the middle of aworking unit and the result printout will be always OK, even when paper jams andrepositioning occur. See sample exit SPSMRE10 for an illustration about using thisflag.


U21020-J-Z247-7-7600 189

10.6.5 Sample Record Processing Examples

10.6.5.1 Modify the current record.

In this example the current record must be moved to the exit work area because it is to bemodified and possibly shortened or lengthened. A new index list must be created to showthe location and length of the new record.

1. Copy record to exit work area.

2. Copy index list to exit work area.

3. Update record as desired.

4. Update record index field IDXRADR to point to new record location

5. If the record has been lengthened or shortened update index field IDXRECL with newlength of record.

6. Update pointer to index list in parmlist to reflect new index list in exit work area.

7. Set R15 to 8 indicating use new index list and record it points to.

8. Return to SPS.

10.6.5.2 Insert a record before the current record.

In this example the current record is not to be changed so it can be left where it is. A newindex list must be created which includes the current record and the record to be inserted.

1. Copy index list to exit work area.

2. Copy index entry for current record to index position for second record entry.

3. Build record to be inserted in exit work area.

4. Update first record index field IDXRADR to point to new record location.

5. Update first record index field IDXRECL with length of record to be inserted.

6. Update IDXNUM in fixed segment of index list to the number of index entries in newindex list (2 entries: the record to be inserted and the current record).

7. Update pointer to the index list in parmlist to reflect new index list in exit work area.

8. Set R15 to 8 indicating use new index list and the records to which it points.

9. Return to SPS.


190 U21020-J-Z247-7-7600

10.7 Message Processing ExitsMessage processing exits permit an installation to receive control and perform installationdefined functions every time a message designated as having an exit for the printer is tobe issued. An exit specified in a generic MSGSUxxx entry (MSGID(00000000)) will receivecontrol for all messages not specified in other MSGSUxxx entries. Within the exit anydesired processing can be performed such as: issuing a new message or messagesbased on the content of the original message and suppressing the original message,replying to the message, maintaining installation statistics related to the content of themessage, rerouting a message page message to the console, etc.. Certain messages maynot be intercepted by an exit. For a list of these messages please see "RestrictedMessages" on page 207.

SPS messages may be primary or environmental. Primary and environmental messagesmay form a group.

A message processing exit is activated by specifying the message identifier in the MSGIDparameter and the exit load module name in the EXIT parameter of the MSGSUxxxmember for the printer. The message identifier is the first number associated with amessage in the message table, not the message number printed at the console (secondfield in the message table). Up to 4095 messages may have message processing exits foreach printer. The same exit may be used for more than one message if desired. A samplemessage processing exit is provided in SPS.SPSSAMP member SPSMMEXI.

The sample exit SPSMMEXC reroutes a message from the message page to the console.If specified in a generic MSGSUxxx entry (MSGID(00000000)) this exit reroutes all SPSmessages to the console.

An installation should be aware that messages may be deleted or have their contentchanged from release to release of SPS. This would impact any related exit. If it is onlydesired to suppress printing of a message, or supply an automatic operator response,these functions can be performed within the message exit table member MSGSUxxxwithout the use of an exit (see "APA Message Table: MSGSUxxx" on page 76). Somemessages cannot have their message processing modified by the message exit table. Fora list of these messages please see "Restricted Messages" on page 207.

If it is desired to change the text of a message without adding variable information, thisfunction can be performed by modifying the message table member using the ISPF editor(see "Message Table Modification" on page 206).

A message exit routine receives control from SPS only when MSGSP(YES) is specified ordefaulted in the SETUPxxx SPSPARM member.


U21020-J-Z247-7-7600 191


When control is received by the message processing exit, R1 points to the followingparameter list (mapped by DSECT MEPARM):



+4 Pointer to the input message being issued

+8 Length of input message

+C Pointer to the response returned by the exit (MEPRESP)

+10 Length of the response returned by the exit (MEPRELEN)

+14 Pointer to the message descriptor flag byte (MEPTYPE)

X'01' Message without response issued to console (MEPTSEN)

X'02' Message requiring response issued to console MEPTSENR)

X'04' Message will be issued to printer (message page) (MEPTPUT)

+18 Pointer to 8 byte message identifier

+1C Pointer to abend processing flag byte



10.7.2 Return Codes

At return from the message processing exit, R15 should be loaded with one of thefollowing return codes:

RC Action

0 SPS should issue the message normally

4 SPS should suppress the message and use the response supplied by the exit ifany


192 U21020-J-Z247-7-7600



• The input message can be modified in place, as long as its length is not changed.

• A message generated by a WTO in the exit will appear on the console before the inputmessage if the input message is not suppressed.

• Message flag byte

1. X'01' and X'02' are mutually exclusive but either may appear with X'04'.

2. When X'02' (message response required) is set on input and the exit requestssuppression of the message, the exit must supply a response to the message, andthe length of the response.

• When an operator reply is supplied by an exit, both the message and reply aresuppressed from the console listing.


• The MEPTYPE flag may be changed by the exit in order to reroute the message. Thefollowing changes are allowed:

A. If MEPTSEN and MEPTSENR are originally off (message will not be displayed onthe console) the exit may set MEPTSEN to request the message to be displayed on theconsole, without reply.

B. If MEPTSEN is originally on (MEPTSENR will be always off) (message will be displayedon the console, without reply) the exit may reset MEPTSEN to suppress the messagefrom being displayed on the console.

C. If MEPTSENR is originally on (MEPTSEN will be always off) (message will be displayedon the console, with reply) the exit may reset MEPTSENR to suppress the messagefrom being displayed on the console. The exit must also provide a reply for themessage via fields MEPRESP and MEPRELEN.

D. If MEPTPUT is originally on (message will be written to the message page) the exit mayreset MEPTPUT to suppress the message from being written to the message page.

The exit may do more than one change, as long as all conditions required for each changeexist. If the exit makes an invalid change, SPS ignores it.


U21020-J-Z247-7-7600 193

10.8 Data-set Allocation ExitThe data-set allocation exit permits an installation to receive control each time SPSobtains a new output file from JES. This exit may modify the data-set characteristics (likeFORMDEF, PAGEDEF, etc.) and/or request SPS to hold or purge the output file withoutprinting it. Sample data-set allocation exits may be found in members SPSMDSEX,SPSMDSFC, SPSMDSCM, SPSMDSCO and SPSMDSUN of SPS.SPSSAMP.

SPSMDSEX shows how to request SPS to use a FORMDEF if the user requests a specificflash (3800 migration). SPSMDSFC shows how to bypass the use of the FCB name asPAGEDEF name when no PAGEDEF is requested. Both exits use the KYDUPD macro toinform SPS about changes in the output file options (FORMDEF, PAGEDEF). If youmaintain this convention, changes made by the exit will be reported via thePRINTOPT(YES) option (control file/SETUPxxx) and FDIS command. Please look at thesamples and in the KYDUPD macro comments for instructions on how to use it.

The sample exit SPSMDSCO is usefull if you have an AFP application which generatesSEC OCA type and your printer does not support it.

The sample exit SPSMDSUN helps the customer to find characters in a print file which arecausing data-checks.

The member SPSMDS1N may be used to emulate cse (cut-sheet-emulation) via SPS(currently neither SPS or the a-twin support real cse).

The member SPSMDSOS should be used when you have extended color triplets(including shadings) and your printer does not support them

The data-set allocation exit is activated by specifying the DSALEXIT parameter in theSETUPxxx member for the printer. This parameter should contain the name of the loadmodule that is the exit.


When control is received by the exit, R1 points to the following parameter list (mapped bydsect DSXPARM)



+4 Pointer to JSPA for the print data set

+8 Pointer to primary data stream information control block (PDSINFO) for theprint data set

+C Pointer to abend processing flag byte



194 U21020-J-Z247-7-7600


+10 Pointer to PSINFO

+14 Pointer to PRTINFO

10.8.2 Return Codes

At return from the data-set allocation exit, R15 should be loaded with one of the followingreturn codes:

RC Action

0 SPS should process this file normally. The PDSINFO control block mayhave been modified by the exit in order to reflect changes in the data-setcharacteristics (macro KYDUPD inform these changes to SPS).

4 SPS should return this data-set immediately to spool (SPS will not print it)in the hold status.

8 SPS should return this data-set immediately to spool (SPS will not print it)as completely processed. The data-set will be purged.



• Any fields changed invalidly may cause an abend in SPS or JES.

• The exit may change the PDSINFO control block in order to change any data-setcharacteristics (like FORMDEF, PAGEDEF, etc...). The return code should then be 0otherwise the change will have no effect (the data-set will not be printed). Changesshould be informed to SPS via macro KYDUPD. Please see sample exits SPSMDSEXand SPSMDSFC (SPSSAMP) for instructions on how to use macro KYDUPD.

• This exit may be also used to change any JSPA information (used to print informationpages) besides the JSPAUSR1 field (see user variables). The JSPAUSR1 field shouldbe changed via the JES2 exit 23 or JES3 exit 45.

• SPS issues a message to the console and to the message page each time the exitrequests SPS to hold or purge an output file.

• If SPS finds any error trying to obtain the output file characteristics (DD statement,OUTPUT statement and control file) this exit will not be called for the respective file.



U21020-J-Z247-7-7600 195

10.9 Resource Read ExitThe resource read exit has the ability to inspect and modify external APA resources(FORMDEF, PAGEDEF, PAGE SEGMENTS, etc.) read from system or user libraries.

The resource read exit is activated by specifying the RDSREXIT parameter in theSETUPxxx SPSPARM member.

Besides the control blocks DSLIST, DSNBLOCK and MEMBLOCK all other control blocksare below the line. The buffer read by SPS is located below the line. The buffer providedby the exit may be located below or above the line, storage key 1.

Member SPSMRRCO (RDSREXIT SETUPXXX PARM) may be used to convert thePTOCA text controls set extended text color (SEC) with OCA type into the text control settext color (STC).

Member SPSMRRUN helps customers to find characters in a print file which are causingdata-checks.

Member SPSMRR1N may be used to emulate cse (cut-sheet-emulation) via SPS(currently neither SPS or the a-twin support real cse).

Member SPSMRROS may be used when you have extended color triplets (includingshadings) and your printer does not support them.

The DSECT RRXPARM describes the parmlist received by the exit.

10.9.1 Types of Call

There are 6 types of calls for the resource read exit.

- begin d/s call

- normal call

- eod call

- discard call

- normal termination call

- abnormal termination call

10.9.2 Begin D/S Call

This call will be performed by the d/s allocation exit of SPS. This exit may set any of theflag bytes in field PDSRXCAL from the PDSINFO control block to indicate for which APAresource types the RDS read exit should be called for this spool file. These flags may bealso changed in any other call for the same output file (NORMAL, EOD or DISCARD


196 U21020-J-Z247-7-7600

CALLS). PDSRXCAL is a string of 7 bytes initialized by SPS to binary zeros, each bytecorresponding to an APA resource type, in the same sequence as described inRDSBLOCK, field RDSRTYPE. When the byte has the value X'FF', SPS will call the exitfor that resource type.

10.9.3 Normal Call

This call will be issued each time an MVS check macro completes with or without I/O errorfor an APA resource and the PDSINFO for this file indicates that the call should be donefor this resource type.

10.9.3.1 Parameter list

When control is received by the exit for the normal call, R1 points to the followingparameter list (mapped by DSECT RRXPARM):


+0 pointer to global exit area (GEA).

+4 pointer to a fullword containing value. X'00000004' - normal call (Call type).

+8 pointer to one byte field

c'N' - abend should disable exit

c'Y' - abend terminates SPS (default) (Abend processing flag)

+C contains MVS and JES information about one output file. (JSPA)

+10 contains SPS information about one output file. (PDSINFO)

+14 represents one resource opened for one output file. (RDSBLOCK)

+18 represents the MVS data-set from where the resource was read.(DSNBLOCK)

+1C represents the MVS data-set member name of the resource read.(MEMBLOCK)

+20 represents the data-set concatenation list used to find the resource.(DSLIST)

+24 represents the DCB used to open the d/s concatenation list where theresource was read from. (RDDCB)

+28 represents the block just read from the resource via the read/check macro.Contains the pointer to this block in field READBUFF. (READBLOC)

+2C exit may pass here a pointer to a block, (BDW, RDW, RECORD, RDW,RECORD,....) to be used instead of the block pointed by READBLOC (the


U21020-J-Z247-7-7600 197

exit receives in the parm list a pointer to a fullword where it may store thepointer to the buffer). (PT_BLOC)

10.9.3.2 Return codes

RC Action

0 Use block originally read. Exit should not modify the input block.

4 Use block originally read. Exit modified the block in the original buffer(different retcodes for tracing purposes - SPS will re-trace the same bufferagain).

8 SPS should 'forget' the block read and use the block passed by the exit inplace of it. The exit should not change any READBLOC field.

10.9.3.3 Programming notes

a) The exit is responsible for later freemain of any allocated buffer. This may be donein the termination calls. At subtask termination MVS frees any subtask storage stillallocated (besides some special subpools).

b) The exit should identify the specific resource being processed via the PDS token(primary data stream token, field PDSID of PDSINFO, which uniquely identifies forSPS each opened spool file) or JSPA d/s resource name (field JSPCEDSN, whichuniquely identifies an output file on JES) and the RDS name and type for theresource being read (see RDSBLOCK fields). For a specific resource name/typeand output file, SPS can have only one open RDS at one time.

The resource token (field RDSTOKEN from RDSBLOCK) can be the same for afuture read of the same resource (for the same or another spool file) or may alsobe different (i.e., do not rely on it for sequence control).

The exit is not necessarily called sequentially for one resource before a call foranother resource is initiated (in the currently SPS implementation the sequence isobserved, but the SPS design is free on this point).

Fields RDSXUSR1 and RDSXUSR2 from the RDSBLOCK are reserved forexclusive use of this exit. Note that the RDSBLOCK represents one uniquereading process of a resource.

c) The exit is informed via flag RDSIOERR in RDSBLOCK that an I/O error occurredwhile trying to read the block. In this case the exit must return with return code 0.The call in this situation is just to inform the exit. No EOD or discard call will beissued after the I/O error normal call.

d) If the exit changes a resource which is later reused for another file without beingread again the changed resource is reused and the exit is not called again. This


198 U21020-J-Z247-7-7600

occurs also if the new file does not have its PDSINFO flags requesting the exit toreceive control.

e) The buffer passed to SPS should be maintained intact by the exit up to the nextNORMAL, EOD or DISCARD Call for the same resource or a normal or abnormaltermination call.

10.9.4. Eod Call

This call will be issued each time an MVS check macro completes when reading from anAPA resource and the DCB EOD exit from SPS is entered. Additionally, the PDSINFOflags for this output file should be set in order to request the RDS read exit to receivecontrol for that resource type.


When control is received by the exit for the EOD call, R1 points to the following parameterlist (mapped by DSECT RRXPARM):


+0 pointer to global area (GEA)

+4 pointer to a fullword containing value.

X'00000008' - eod call (Call type)




+C contains mvs and jes information about one output file (JSPA)

+10 contains sps information about one output file. (PDSINFO)


+18 represents the mvs data-set from where the resource was read.(DSNBLOCK)

+1C represents the mvs data-set member name of the resource read.(MEMBLOCK)


+24 represents the dcb used to open the d/s concatenation list where theresource was read from. (RDDCB)


U21020-J-Z247-7-7600 199

+28 represents the buffer where a block would be read via the read/checkmacro. No block is read into the buffer pointed by field READBUFF.(READBLOC)

+2C exit may pass here a pointer to a block, (BDW, RDW, RECORD, RDW,RECORD,....) to be used as last block from the RDS (the exit receives inthe parmlist a pointer to a fullword where it may store the pointer to thebuffer). (PT_BLOCK)

10.9.4.2 Return Codes

RC Action

0 Assume EOD as originally informed.

4 Not used.

8 SPS should insert the block passed by the exit after the last block of theresource. After this block is processed SPS will call the exit again with anEOD call. This may occur many times, until the exit returns with code 0.

10.9.4.3 Programming Notes

a) All programming notes for normal call apply also to the EOD call.

b) The EOD call may be the first call if the resource is an empty member in the MVSlibrary.

c) The EOD call may be skipped for a resource if the 'discard call' is issued for thesame resource or if the 'Abnormal Termination call' is issued before normalcompletion of the read process.

10.9.5. Discard Call

This call will be issued each time SPS discards the processing of reading a resource.Additionally, the PDSINFO flags for this output file should request the RDS read exit to becalled for this resource type.


When control is received by the exit for the DISCARD call, R1 points to the followingparameter exit (mapped by DSECT RRXPARM):


+0 Pointer to global exit area (GEA).


200 U21020-J-Z247-7-7600

+4 pointer to a fullword 0 containing value.X'0000000C' - discard call (Call type).



c'Y' - abend terminates SPS (default) (Abend processing flag).




+18 represents the MVS data-set from where the resource was read.(DSNBLOCK).

+1C represents the MVS data-set member name of the resource read.(MEMBLOCK)


+24 represents the DCB used to open the d/s concatenation list where theresource was read from. (RDDCB)


RC Action

0 Discard processing should continue.


a) Programming notes b), d) and e) for the NORMAL call apply also to the DISCARDcall

b) This call may be the first and last call for a RDS if SPS started the resourcereading and than wants to discard it before the first block is checked.

c) A 'discard call' does not necessarily mean an abnormal event in SPS. Forexample, if a resource reading is occurring and a paper jam occurs SPS no longerneeds this resource data and will therefore discard it. The same resource willprobably be read again later. A 'discard call' may also be issued because of a printerror (the output group will probably be returned to hold status on the queue), orbecause of an SPS error which will result in a user abend, or because of a systemabend while reading the resource.

d) If SPS abends, a resource read may be discarded but the 'discard call' could beskipped. However, in this case an 'abnormal termination call' will be issued as long


U21020-J-Z247-7-7600 201

as the recovery and clean-up processing of SPS does not suffer a second abendbefore the exit is called.

10.9.6. Normal Termination Call

This call will be issued each time SPS terminates normally and the RDS read exit hadbeen specified in the SETUPxxx member.

10.9.6.1 Parameter List

When control is received by the exit for the normal terminal call, R1 points to the followingparameter list (mapped by DSECT RRXPARM).


+0 global exit area (GEA)

+4 pointer to a fullword containing value X'00000010' - normal terminationcall(Call type)



c'Y' - abend terminates SPS (default)

(Abend processing flag)


RC Action

0 Continue SPS normal termination.

10.9.6.3 Programming Notes:

a) A 'normal termination call' may be followed by an 'abnormal termination call' if SPSabends in the termination processing after calling the exit.

10.9.7. Abnormal Termination Call

This call will be issued each time that SPS abnormally terminates and the RDS read exithad been specified in the SETUPxxx member.

10.9.7.1 Parameter List



202 U21020-J-Z247-7-7600


+4 pointer to a fullword containing value:

X'00000014' - abnormal termination call (Call type)



c'Y' - abend terminates SPS (default). SPS will always assume 'Y' for thisflag and this call type. (Abend processing flag)


RC Action

0 Continue SPS abnormal termination.


a) Programming note from the NORMAL TERMINATION Call applies also to theABNORMAL TERMINATION Call.

b) An invalid return code will be ignored by SPS.

c) This call is issued from the SPS estae exit. The exit should observe any MVSprogramming restrictions relative to the estae environment. An abend in the exit inthis call may have unpredictable results in the clean-up process from SPS(procedure do not stop, printer does not drain, or similar), but will be reported witha message by the SPS second level estae exit.

10.9.8. Trace Records

SPS writes a trace record containing the resource buffer read before a 'Normal Call' isissued for the exit.

If the exit modifies the buffer inplace, provides a new buffer or provides a last bufferanother trace record is written after the exit returns control to SPS.

These buffers are written in the trace files when the trace level is specified as 3 or 4 andtrace type RDS is included.

You may format these records with the following parameters of the SPS trace formattingprogram :

OWNERID(LI)

PRTSEG(1,2,3)

RECID(64-65)


U21020-J-Z247-7-7600 203

10.9.9. Abend Codes

The following abend codes are issued by SPS because of RDS read exit related errors:

323 invalid retcode from rdsrexit normal call

324 invalid pt_buffer from rdsrexit

325 invalid retcode from rdsrexit discard call

326 invalid retcode from rdsrexit eod call

327 invalid retcode from rdsrexit normal term call

SPS reserves user abend codes 691 to 699 to user exit routines.


204 U21020-J-Z247-7-7600

10.10 Page Segment ExitThe page segment exit receives control when special events occur related to pagesegments. Currently implemented is only the 'Page Segment not Found' call type.

This exit is activated by specifying the PSEGEXIT parameter in the SETUPxxx member.

All parameters passed to the exit are below the line.

Module SPSMPSEX is a sample page segment exit used to request to continueprocessing with a warning message each time a page segment is not found. This exit isprovided in source code format and load module format (SPSSAMP and SPSLINK).

10.10.1. Types of calls

• Page Segment not Found call

10.10.2. Page Segment not Found call

• This call will be issued each time a page segment is required but not found, either inthe user libraries or system libraries.


When control is received by the exit for this call, R1 points to the following parameter list(mapped by DSECT RPXPARM):



+4 pointer to a fullword containing value.

X'00000004' - PSEG not found call (Call type)






+14 represents one page segment opened for one output file (RDSBLOCK)


U21020-J-Z247-7-7600 205

10.10.2.2 Return codes

RC Action

0 SPS should terminate processing this output file and return the outputgroup in hold to the spool.

4 SPS should continue processing this file and ignore the missing pagesegment. No warning message is issued.

8 SPS should continue processing this file and ignore the missing pagesegment. SPS should issue a warning message to the message page ofthis file.

10.10.3. Trace Records

SPS writes a trace record before and after calling this exit. You may format these recordswith the following parameters of the SPS trace formatting program:

OWNERID(LI)

PRTSEG(1,2,3)

RECID(135-136)

10.10.4. Abend Codes

The following abend codes are issued by SPS because of PSEG exit related errors

328 invalid retcode from page segment not found call

SPS reserves user abend codes 691 to 699 to user exit routines.


206 U21020-J-Z247-7-7600

10.11 Message Table ModificationThe text of most messages issued by SPS can be modified to suit installationrequirements (please see "Restricted Messages" on page 207 for a list of messages thatcannot be modified in this way). This function is easily performed using the ISPF editor.

SPS messages are located in SPS.SPSMESS under the language file name used on theprinter. The messages consist of a token in the first columns identifying the message, andthe text of the message. The text of the message consists of an external message numberseen by the operator, the text of the message, and optionally some variable informationthat changes each time the message is issued. The variable information is identified byvariable names beginning with an & . In general the text of the message will make clearthe meaning of the variables, however this can always be determined by looking up themessage in manual SPS/MVS-APA Messages Guide.

Any new message text can be constructed by the installation. The variables from theoriginal message may appear anywhere in the new message and in any order. Any or all ofthe variables may be suppressed in the new message text if they are not desired.


U21020-J-Z247-7-7600 207

10.12 Restricted MessagesSome SPS messages are not accessible to the installation. Generally these messageshave some processing requirement that prevents their interception and modification. Suchmessages cannot be modified by an exit, processed by the message table memberMSGSUxxx, or have alterations to their text in the message table be effective. The specificreason for the restriction may be found as comments to the message in the messagetable. The following is a list of all restricted messages:

SPS0291E SPS0602E SPS0920E SPS0956E SPS0962W SPS0968WSPS0292W SPS0603E SPS1920E SPS0957E SPS0963WSPS0351W SPS0604E SPS2920E SPS0958W SPS0964ESPS0352W SPS0605E SPS0921E SPS0959W SPS0965ESPS0600E SPS0606E SPS0922W SPS0960W SPS0966WSPS0601E SPS0917E SPS0955W SPS0961W SPS0967E


208 U21020-J-Z247-7-7600

10.13 Preparing Installation Supplied VariablesInstallation defined variables %US00 to %US63 (@US00 to @US63 for block letters)permit an installation to define or calculate values from JES or direct printing that are to beprinted in information pages. An example would be printing the line or page count of anoutput group on the header page for the group. An installation would assign thesevariables values in JES exits or user defined exit points for JES spooled data sets and inthe print application for direct printing data sets.

10.13.1 JES Spooled Data Sets

For these data sets the contents of installation variables must be defined in a JES exit thathas access to the JSPA just previous to its being passed to SPS. The JSPA is passed toSPS for each print data set in an output group. This makes it possible to define variablesfor header, separator, or trailer pages, depending on which are selected for the data set tobe printed.

JES indicates the required information pages in the IAZFSIP control block returned as aresult of a GETDS request. A single data set output group would have IAZFSIP flags setindicating that header, separator, and trailer pages are required (provided all are selectedfor printing by the installation in the JES initialization parameters or by operatorcommands). However in a multiple data set output group the first data set would haveflags indicating only header and separator pages are required. A middle data set wouldhave flags indicating that only a separator page is required. The last data set in a multipledata set output group would have flags indicating only a separator and trailer page arerequired. Installation variables passed by the JSPA may be placed in any informationpages requested for a data set by coding user variables in the IPLINE macros generatingthe information page.

SPS processes user variables by the following steps:

1. SPS gets a data set to print (GETDS FSI request). It may be the first, middle or lastdata set in the output group. A pointer to the JSPA for this data set is provided with thedata set.

2. SPS takes the user field from the JSPA (JSPAUSR1), and uses it as a pointer toinstallation supplied variables if it is not 0 and points to a valid parm list.

3. SPS processes all information pages requested for the data set by inserting the userfields if referenced on the information pages. Supplied values not referenced on anyinformation page are ignored, referenced variables that are not supplied by the exitreceive blanks.

4. When all processing for the print data set is complete, the area containing theinstallation variables and work control blocks is freed by SPS, if running under JES3. If


U21020-J-Z247-7-7600 209

running under JES2 SPS frees this areas just when completing the processing for thelast file in an output group.

This different processing depending on the JES subsystem occurs because the JES2exit 23 receives control only for the first file in the group, although JES2 copies theJSPAUSR1 field from this first file to all other files from the same group. JES3 exit 45receives control for each output file.

The exit must prepare the control blocks that define the contents of the variables used,and must put the address of a parmlist in the JSPA user field JSPAUSR1. This parmlistcontains a pointer to a control block defining the dynamic area used by the installation forthe installation variables, and pointers to control blocks defining each variable. This area isacquired by the exit and freed by SPS. It should not be reused by the exit because there isno guarantee that the installation variables will be used before the next print dataset is requested. As JES3 exit 45 receives control in the JES address space the areaacquired by the exit should be in subpool 241 (CSA).

If the same print file using user variables may be printed by SPS or PSF the user exit23/45 should recognize it in order to not allocate storage areas which will not be freed byPSF. Otherwise a PSF user exit should be responsible to check these areas.

Members SPSIX23 (for JES2) and SPSIX45 (for JES3) are comprehensive examples forgenerating installation variables that would provide line and page counts in a JES2 orJES3 system using the JES separator page exit 23 (JES2) or 45 (JES3). Also inSPS.SPSSAMP are the macros IPPARM, IPCONTRO, and IPUSEVAR which generatethe DSECTs for the parmlist, user variable control area, and the user variablesrespectively.

10.13.2 Direct Printing Data Sets

Direct printing user variables are assigned values by the print application driving theprinter. The direct printing application must prepare the control blocks that define thecontents of the variables used, and must put the address of the parmlist (IPPARM) in theDCB exit list for the printer being driven. IPPARM contains a pointer to a control blockdefining the dynamic area used by the application for the user variable control blocksrequired (IPPARM, IPCONTRO, and IPUSEVAR), and pointers to control blocks definingeach variable. This area is acquired and freed by the application. It may be reused by theapplication for a new print data set.

The preparation of the control blocks for user variables under direct printing is similar tothe preparation for JES spooled data sets. The preparation of user exit control blocks inthe sample exit SPSIX23 in SPS.SPSSAMP for JES2 spooled data sets can be used as amodel for direct printing control blocks.

The pointer to user variables (IPPARM), number of user variables (IPCONTRO), lengthand content (IPUSEVAR) may be updated at any time during the print data set processing.


210 U21020-J-Z247-7-7600

Variables to be included in the header must be defined before opening the printer data set.Variables to be included in the trailer must be defined before closing the printer data set.

10.13.3 Parameter Lists

The following is the format of the parameter list (IPPARM) established by the exitgenerating the installation variables or the direct printing application. JES user exits mustplace the pointer to this parameter list in JSPAUSR1 of the JSPA for the output data setbefore returning to JES. The direct printing application must place the pointer to thisparameter list in the DCB exit list of the printer DCB before opening the printer for the printdata set for which the user variables are to be used. The IPPARM pointer should beplaced in the first unused entry in the exit list. An unused entry has a first byte of X'00'. ForJES user exit conventions when receiving control from JES, please consult the appropriateJES user modifications manual.

Offset Parameter Description (IPPARM)

+0 Pointer to the control parameters (IPCONTRO)

+4 Pointer to 1st IPUSEVAR control block, this is installation variable US00

+8 Pointer to 2nd IPUSEVAR control block if needed, this is installationvariable US01

... .........................................................

+C0 Pointer to 48th IPUSEVAR control block if needed, this is installationvariable US47

The following is the format of the control parameter list (IPCONTRO). It is established bythe exit or direct printing application generating the installation variables and pointed to byIPPARM.

Offset Parameter Description (IPCONTRO)

+0 Pointer to the dynamic area used by the exit to contain all its parameterlists (IPPARM, IPCONTRO, and IPUSEVAR's)

+4 Length of the dynamic area used by the exit

+8 Number of variables defined by the exit (pointers in IPPARM)

The following is the format of the installation variables established by the exit or directprinting application generating the installation variables. They are pointed to by IPPARM.

Offset Parameter Description (IPUSEVAR)

+0 Length of the variable

+1 EBCDIC contents of the variable USnn pointed to by IPPARM


U21020-J-Z247-7-7600 211

10.13.4 Return Codes

Please see the documentation for the JES user exit for a description of the return codes.


• All control blocks passed to SPS must be contained within the dynamic area pointed toby IPCONTRO.

• The dynamic area passed to SPS for JES spool data set processing should be insubpool 0 for JES2 or subpool 241 for JES3, key 1. The length should be the same asoriginally getmained. SPS uses this information to freemain the area. The installationexit is responsible for freemaining any other areas acquired.

• If the length of the dynamic area specified in IPCONTRO is 0, SPS spool data setprocessing will not attempt to freemain the area. User exits must not reuse the areaunless they have verified that the associated data set has been freed by SPS becausenew output data sets may be acquired by JES before information pages for previousdata sets are generated.

• The dynamic area passed to SPS by a direct printing application must be in a subpoolkey combination that is not fetch protected. The dynamic area is not freed by SPS sothe application should make provision for freeing it. The dynamic area may be reusedby the application after the print data set is closed.

• Variable pointers in IPPARM that are 0 will cause blanks to be substituted for thevariables if referenced in an information page, no abend will occur.

• Variable pointers in IPPARM are not checked for being valid addresses in the dynamicarea supplied by the installation exit.

• Variables referenced in information pages that are not in the IPPARM list will haveblanks substituted, no abend will occur.

• Variables defined in IPPARM that exceed US47 will be ignored, no abend will occur.

• Variables with lengths longer than will fit on an information page line will be truncated,no abend will occur.

• Variables whose length are 0 in IPUSEVAR will have blanks substituted if referenced inan information page, no abend will occur.

• When the number of variables specified in IPCONTRO is 0, all variables in theinformation pages will be set to blanks, no abend will occur.

Messages and Codes

U21020-J-Z247-7-7600 213

11 Messages and Codes

11.1 ConventionsAll messages issued by SPS are in the following format:

SPxnnnnt PRTn: TEXT

where:

SP Prefix identifier of all SPS messages.

x The component identifier of the message.

I APA feature fmid of SPS

S Base fmid of SPS

1 LINE feature fmid of SPS (LIP or MOD2)

R PSORT (page sort) component of SPS

nnnn Serial number of the message.

t Type of message:

A Action message. This message needs an operator action.

E Error message. This message occurred because of a severe error.

I Informational message.

W Warning message. Some unusual situation occurred.

PRTn JES printer name for the printer to which the message refers. The printer name isnot repeated in each of the message descriptions in the manual, but will bepresent in all messages that are associated with a particular printer.

All SPS messages are issued with routing code 7 and no descriptor code.

Messages and Codes

214 U21020-J-Z247-7-7600

11.2 SPS MessagesExplanations of all SPS messages and resultant system actions, along with suggesteduser, operator, and systems programmer responses may be found in the SPS/MVS-APAMessages Guide.

11.3 SPS Abend CodesVarious abend codes can be issued by SPS to indicate error conditions. These codesappear in the text of messages SPS0920E and SPS0513E. Most of these codes are onlymeaningful to the SPS systems support staff, and should be reported to your Océ servicerepresentative. Some codes can indicate a condition for which an installation can takecorrective action. The abend codes that can be meaningful to an installation are listed inthe SPS/MVS-APA Messages Guide together with an explanation and suggested action.When an installation cannot successfully resolve a problem by the action indicated, pleasereport the problem and abend termination code information to your Océ supportrepresentative.

APA Parameter Selection Order

U21020-J-Z247-7-7600 215

Appendix A: APA Parameter Selection Order

This appendix contains a table showing where SPS parameters controlling jobs printed inAPA printers may come from, and the hierarchy order of the parameter sources.

The table shows the possible parameters in the leftmost column and the possible sourcesacross the top. The parameter will be taken from the first source in which it is codedmoving from left to right, all other sources further right will be overridden. Where aparameter has a different name from a given source, the name has been inserted in thetable.


216 U21020-J-Z247-7-7600

PARAMETERAFPDSDATA

STREAM5

USERCONTROL

FILE

FORMSCONTROL

FILE

FORMDEFOR

PAGEDEF6JCL JES SETUPxxx

SPSSYSTEM

DEFAULTS

CC X X X

CHARS X X X X7 X X(ucs) X

CKPTPAGE X X

CKPTSEC X X

CLASS X X

COLORMAP X X

COMP38MO X X X

CONTROL X

COPIES X X X X X

DATACK X X X X

DUPLEX9 X X X X X

ENDBCS X X X

ETFF X X X

ETFH X X X

FCB X X

FLIP X X X

FORMCTL X

FORMDEF X X X X

FORMS X X

FPRUN X X X

5 This column does not include parameters found in a pagedef or formdef even thoughthe selected pagedef or formdef is coded in the AFPDS data steam. The parameterssupplied by formdefs or pagedefs when viewed as a source for parameters are in the"FORMDEF OR PAGEDEF" column.

6 This column is the selected formdef or pagedef to be used. Their names aredetermined from any of the sources referenced in the FORMDEF or PAGEDEFparameter rows. The actual formdef or pagedef used may be coded inline in theAFPDS data stream or loaded from a library.

7 A font list from the default PAGEDEF has less priority as a JCL specified or JES defaulted CHARS list. The font list from a requested PAGEDEF or an inline PAGEDEF has more priority as the CHARS from JCL or JES.

9 Items that are so marked indicate that the JCL parameter has a higher priority than theequivalent entry in the formdef/pagedef.


U21020-J-Z247-7-7600 217

IBINSUB X X X

INBIN9 X X X X8 X

MODIFY X X

NOTIFY X X

PARAMETERAFPDSDATA

STREAM

USERCONTROL

FILE

FORMSCONTROL

FILE

FORMDEFOR

PAGEDEFJCL JES SETUPxxx

SPSSYSTEM

DEFAULTSOFFSETXF X

OFFSETYF X

OFFSETXB X

OFFSETYB X

OUTBIN9 X X X X X

OVERLAYF X

OVERLAYB X

PAGEDEF X X X X(fcb) X

PIMSG X X/msglim

PRESENTATION X X X

PRINTOPT X X X

PRMODE X X

SPOOLMSG X X X

TRC X

TRCTYPE X X X

TWINMSGS X X X

WRONLY X X X

X2UP X X X XTable 1: Hierarchy of parameters for APA printers

8 The JCL equivalent parameter to INBIN is INTRAY.9 Items that are so marked indicate that the JCL parameter has a higher priority than theequivalent entry in the formdef/pagedef.

Page Counters Reported in SMF Records

218 U21020-J-Z247-7-7600

Appendix B: SMF type 6 Record Format

This appendix contains the format of the SMF record type 6 as it is written by SPS eachtime that SPS completes the processing of an output file.

See 'SMF Accounting' on page 127 for more information about how and when SPSwrites SMF records.

Offset Name Length Format Description

00 SMF6LEN 2 binary Record length

02 SMF6SEG 2 binary Segment Descriptor

04 SMF6FLG 1 binary System Indicator

Bit Meaning when set0-2 Reserved3 MVS/SP Version 4 and above4 MVS/SP Version 35 MVS/SP Version 26 VS27 Reserved

Note: For MVS/SP Version 4, bits 3, 4, 5, and 6will be on.

05 SMF6RTY 1 binary SMF Record type (= X'06')

06 SMF6TME 4 binary Time since midnight, in hundredths of asecond, that the record was moved into theSMF buffer.

0A SMF6DTE 4 packed Date that the record was moved into the SMFbuffer, in the form 0cyydddF, where yy is theyear, ddd is the day, and F is the sign.

0E SMF6SID 4 EBCDIC System identification (from the SID parameter).

12 SMF6JBN 8 EBCDIC Job name (taken from the job's JSPA)


U21020-J-Z247-7-7600 219


1A SMF6RST 4 binary Time since midnight, in hundredths of asecond, that the reader recognized the JOBcard for this job.

1E SMF6RSD 4 packed Date that the reader recognized the JOB cardfor this job, in the form 0cyydddF, where yy isthe year, ddd is the day, and F is the sign.

22 SMF6UIF 8 EBCDIC User identification (taken from JMR-submitorsUSERID).

2A SMF60WC 1 EBCDIC SYSOUT class (this field contains a blank fordirect-print data sets).

2B SMF6WST 4 binary Time since midnight, in hundredths of asecond, at which SPS began output service forthis job.Note: The timestamp should not be used todetermine printer utilization, since this record iswritten during print data set cleanup, which maybe quite different than the time at end of print;and SPS may "look ahead" before the previousjob has finished as well.

2F SMF6WSD 4 packed Date at which SPS began output service forthis job, in the form 0cyydddF, where yy is theyear, ddd is the day, and F is the sign.Note: This date should not be used todetermine printer utilization, since this record iswritten during print data set cleanup, which maybe quite different than the time at end of print;and SPS may "look ahead" before the previousjob has finished as well.

33 SMF6NLR 4 binary Number of logical records written by SPS. (Thisfield is filled in when a data set is completed orrestarted; it includes repeats and restarts). Thisfield is non-cumulative.

37 SMF6IOE 1 binary I/O status indicators

Bit Meaning when set0-4 Reserved5 Data buffer read error6 Reserved7 Control buffer read error

38 SMF6NDS 1 binary Number of data sets processed by the writerand included in this record. If multiple copiesare produced, each copy is counted.


220 U21020-J-Z247-7-7600


39 SMF6FMN 4 EBCDIC Form number. Only the first four bytes appearin this field. This field corresponds to the userforms (not the real forms, i.e. RFORMS). If nooperator command to change the forms isgiven during setup (like $TPRTx,F=xxxx), thisfield corresponds to the JCL requested formsname (via DD statement or OUTPUTstatement).

3D SMF6PAD1 1 binary Section Indicators - The sections will be in theorder listed below when the corresponding bit isturned on (currently set to X'F0' by SPS whendriving APA printers).

Bit Meaning when set0 Non-impact printing subsystem section

present1 Common section present2 All-points-addressable (APA) printing

subsystem section present3 Enhanced SYSOUT support section

present4-7 Reserved

3E SMF6SBS 2 binary Subsystem Indicator (Always set to X'0007' -FSS)


U21020-J-Z247-7-7600 221

I/O Data Section:


00 SMF6LN1 2 binary Length of rest of record, including this field, butnot including any additional sections indicatedby the SMF6PAD1 field.

02 SMF6DCI 1 binary Data Set Control Indicators

Bit Meaning when set0 Reserved1 Record represents spin data sets2 Operator ended this data group3 Operator restarted data set with

destination4 Operator restarted this data group5 Received operator restarted data set6 Operator started with single space7 Reserved

03 SMF6INDC 1 binary Record level indicator

Value Support level6 SPS

04 SMF6JNM 4 EBCDIC Reserved

08 SMF6OUT 8 EBCDIC Logical Output Device Name (JES Printername) for local printers. For network printerscontains the VTAM logical unit name.

10 SMF6FCB 4 EBCDIC Reserved

14 SMF6UCS 4 EBCDIC Reserved

18 SMF6PGE 4 binary Page counter; number of physical imagesprinted including copies and repositioning, aswell as message pages.


222 U21020-J-Z247-7-7600

Non-impact printing subsystem section: These fields are non-cumulative acrossinterrupts.


00 SMF6LN2 2 binary Length of the non-impact printing subsystemsection, including this field.

02 SMF6CPS 8 binary Copies Distribution - 8 1-byte counters. Eachcounter represents one copy group.

0A SMF6CHR 16 EBCDIC Names of FONT1 - FONT4 either from thecontrol file, or if not defined in the control file,from the JCL CHARS parameter.

1A SMF6MID 4 EBCDIC Reserved

1E SMF6FLI 4 EBCDIC Reserved

22 SMF6FLC 1 binary Reserved

23 SMF6BID 1 binary Flag Byte

Bit Meaning when set0 Reserved1 DCB subparameter OPTCD=J was

specified. Each output data linecontained a table reference characterthat was used to select the font to beused when printing the line

2 Cut-sheet printer3-7 Reserved


U21020-J-Z247-7-7600 223

Common section


00 SMF6LN3 2 binary Length of Common Section

02 SMF6ROUT 4 EBCDIC Meaning when set00010000 = Local routing

NNNNRRRR = Remote routingNNNN = Node numberRRRR = Remote dev within that node

0000NNNN = Special local routing

06 SMF6EFMN 8 EBCDIC Output form number. This field corresponds tothe user forms (not the real forms, i.e. orOUTPUT statement).

0E 16 EBCDIC Reserved.

1E SMF6JBID 8 EBCDIC Job ID. This is the 8-character job number inthe form JOBnnnnn, STCnnnnn, or TSUnnnnn.

26 SMF6STNM 8 EBCDIC Stepname.

2E SMF6PRNM 8 EBCDIC Procedure step name.

36 SMF6DDNM 8 EBCDIC DD name.

3E SMF6USID 8 EBCDIC Userid from creator of output file, taken fromjobcard.

46 SMF6SECS 8 EBCDIC Security label. Although SPS does not yetsupport security labels, if one is provided itsname is written in this field.

4E SMF6PRMD 8 EBCDIC The processing mode from the data set(prmode - line, page, sosi1, sosi2, etc...).

56 SMF6DSNM 53 EBCDIC The name of the data-set being printed.

8B 3 EBCDIC Reserved.

8E SMF6OTOK 20 EBCDIC Output security token. Common token for oneoutput group.


224 U21020-J-Z247-7-7600

All-Points-Addressable Printing Subsystem Section: These fields contain meaningfuldata only if the all-points-addressable printing subsystem is running under the control ofa functional subsystem. That is, SMF6SBS equals X'0007'.


00 SMF6LN4 2 binary Length of APA Section

02 SMF6BNOF 2 binary Offset to multi bin header section

04 SMF6FONT 4 binary Number of fonts mapped with an MCF.

08 SMF6LFNT 4 binary Number of fonts actually loaded into the printer

0C SMF6OVLY 4 binary Number of overlays mapped with an MMO

10 SMF6LOLY 4 binary Number of overlay loaded into the printer

14 SMF6PGSG 4 binary Number of page segments mapped with anMPS

18 SMF6LPSG 4 binary Number of page segments loaded into theprinter

1C SMF6IMPS 4 binary Number of sides of sheets of paper printed(number of logical impressions), includingduplicates and separators. This field is non-cumulative across interrupts and is valid onlywhen SMFINDC is equal to or greater thanX'02'.

20 SMF6FEET 4 binary Number of feet of forms printed for this printdataset (set to zero for printers that do notreport paper size). This field is non-cumulativeacross interrupts.

24 SMF6PGDF 4 binary Number of PAGEDEFs used

28 SMF6FMDF 4 binary Number of FORMDEFs used


U21020-J-Z247-7-7600 225

2C SMF6BIN 1 binary Bin indicators. This field is valid only for printersthat support bin selection.

Bit Meaning when set0 Bin 1 used for any part of the data set1 Bin 2 used for any part of the data set2 Bin 3 used for any part of the data set3 Bin 4 used for any part of the data set4-7 Reserved


226 U21020-J-Z247-7-7600


2D SMF6PGOP 1 binary Duplex indicators.

Bit Meaning when set0 Normal Duplex was used for any part of

the data set1 Tumble Duplex was used for any part of

the data set2-7 Reserved

2E SMF6FLG3 1 binary Flags

Bit Meaning when set0 Reserved1 The job header page was printed2 The job trailer page was printed3-7 Reserved

2F 1 Reserved

30 12 Reserved

3C SMF6FDNM 8 EBCDIC FORMDEF name used to print the dataset

44 SMF6PDNM 8 EBCDIC PAGEDEF name used to print the dataset

4C SMF6PTDV 8 EBCDIC Name of the SETUP member in SPSPARM thatwas used when this dataset was printed.

54 SMF6OCNM 32 EBCDIC Object container names.

74 SMF6LPGE 4 binary Number of logical pages processed (Theaccumulative number of logical pages per side)

This field is not incremented in the followingcases:

• On an NPRO request

• When a blank page is generated becauseSPS/MVS is not generating header andtrailer pages, but forms marking is active.

Multi-bin header section


U21020-J-Z247-7-7600 227


00 SMF6BNLN 2 binary Length of bins section including this field.

02 SMF6BNUM 2 binary Number of counters entries.

Multi-bin counter section. For fan-fold printers just one bin counter is provided. For cut-sheet printers 12 bin counters are provided. Counters for non-existent or non-used inputbins contain binary zeroes.


00 SMF6BNNO 1 binary Bin number

01 SMF6BNCT 3 binary Bin counter

04 SMF6BNLE 2 binary Paper length in millimeters

06 SMF6BNWI 2 binary Paper width in millimeters

ESS Section


00 SMF6LN5 2 binary Length of ess section including this field.

02 SMF6SGID 4 binary Segment identifier, 0 when file is notsegmented or for first segment.

06 SMF6IND 1 binary Section indicator.Bit 0 - error obtaining scheduler JCL facility(SJF) information. Scheduler work block textunit (SWBTU) data area is not present.

07 SMF6RSV 1 Reserved.

08 SMF6JDVT 8 ebcdic JCL definition table (JDT) name in JCLdefinition vector table (JDVT).


228 U21020-J-Z247-7-7600

10 SMF6TUL 2 binary Text unit (SWBTU) data area length withoutincluding the length of this field.

12 SMF6TU VAR binary Text unit (SWBTU) data area. The data areacan be processed using the SWBTUREQmacro and is mapped by MVS macroIEFSJPFX.


U21020-J-Z247-7-7600 229

Appendix C: Page Counters Reported in SMFRecords

Twin printing, duplex (cut-sheet) printing, and the use of the X2UP parameter will affectthe reporting of page counters in SMF records. There are three values reported whichmight be used to determine the quantity of output produced: SMF6PGE, SMF6IMPS,and SMF6FEET. The following table reviews the definitions of these values from Error!Reference source not found.:

Name Description

SMF6PGE Page counter; number of physical images printed including copies and repositioning, aswell as message pages.

SMF6IMPS Number of sides of sheets of paper printed (number of logical impressions), includingduplicates and separators. This field is non-cumulative across interrupts, and is validonly when SMFINDC is equal to or greater than X’02’.

SMF6FEET Number of feet of forms printed for this print dataset (set to zero for printers that do notreport paper size). This field is non-cumulative across interrupts.

• Meaning of SMF6FEET

When printing on a twin printing system, SMF6FEET counts the length of the forms, notdouble the length. The hardware foot-count, as reported by each printer, will beincremented by this amount. For reports printed on a single printer, this value should equalthe amount that the printer hardware foot-count will be incremented. For duplex cut-sheetprinting, although the printer will increment the hardware “click value” twice (2 imagesproduced were produced), SMF6FEET will increment only once per sheet.

• The relationship between SMF6PGE, SMF6IMPS, and SMF6FEET

SMF6PGE counts the number of forms printed, SMF6IMPS counts the number of sides offorms printed, and SMF6FEET as above. If you print an even number of pages in a duplexreport and there are no blank pages, SMF6IMPS will be exactly double SMF6PGE. Forthose reports which contain an occasional blank sheet due to the “eject to front facing”command, the value of SMF6IMPS will not be incremented for any blank side which resultsfrom the execution of this command.


230 U21020-J-Z247-7-7600

Additional considerations apply when you print multiple-up reports either with an N_UPFORMDEF or with the X2UP parameter. SMF6PGE and SMF6IMPS do NOT count thenumber of logical pages (or N_UP partitions), but rather the number of forms processed.Thus, for an X2UP print, SMF6IMPS is approximately equal to half the number of logicalpages. SMF6PGE is equal to SMF6IMPS for simplex or approximately half of SMF6IMPSfor duplex. These factors will cause a disagreement (by about half for X2UP reports) in thenumber of pages reported by JES and the number of pages reported by SPS for thesemultiple-up reports.

When you generate reports based upon these numbers, you may sometimes need to havea method to determine these factors. For example, you may test SMF6PGOP for x'80' orx'40' to determine if you are dealing with duplex output. Similarly, the name of the printerdevice in SMF6OUT might be used to determine whether the report was produced on atwin printer. In most cases, reporting won’t need to know if the report was a multi-up, butthis can usually be determined. For instance, the FORMDEF name is available inSMF6FDNM. For reports invoking X2UP via a control file, the same criteria can be tested;i.e., output class (SMF6OWC) or form name (SMF6EFNM).

List of Illustrations

U21020-J-Z247-7-7600 231


Figure 1: Parameter Data Set and Member Naming Conventions Used in SPS/MVS-APA Administrator's Guide.............................................................................................. 12

Figure 2: Parameter Members For the User Profiles .................................................... 13

Figure 3: Data Set and Member Coding For Example 1: Initial Installation................ 20

Figure 4: Example: Adding AFPDS Applications Under JCL control.......................... 21

Figure 5: Data Set and Member Coding For example 3. Adding User Control FileSupport.............................................................................................................................. 22

Figure 6: Data Set and Member Coding For Example 4: Initialization Changes ........ 23

Figure 7: Structure of Parameter Members in SPS.SPSPARM .................................... 27

Figure 8: Statement Syntax Examples ........................................................................... 32

Figure 9: Format of APA SPSPRINT Member Control Statement ................................ 36

Figure 10: Format of the SETUPxxx Member Control Statement for APA Printers ... 44

Figure 11: Format of APA FORMxxx Control Statement .............................................. 70

Figure 12: Format of APA KEYxxx Control Statement.................................................. 73

Figure 13: Format of APA HSMTffff Control Statement................................................ 74

Figure 14: Format of the APA MSGSUxxx Member....................................................... 76

Figure 15: Sample Control File Definition...................................................................... 80


232 U21020-J-Z247-7-7600

Figure 16: Sample User Control File Processing Request for a Single DD................ 82

Figure 17: Sample User Control File Processing Request for a Single Print DD Usingan OUTPUT Statement Referenced by the DD .............................................................. 83

Figure 18: Sample User Control File Processing Request for the Entire Output of aJob Referenced Implicitly by the DD .............................................................................. 83

Figure 19: JCL For Example 1: Requesting a Predefined Form .................................. 84

Figure 20: JCL Coding For Example 2: Requesting AFPDS Options by the JCLParameters ........................................................................................................................ 85

Figure 21: JCL and User Control File Coding For Example 3: User Defined OptionsFrom a User Control File ................................................................................................. 86

Figure 22: APA Parameter Override Hierarchy.............................................................. 87

Figure 23: Control File Parameters That Can Override an APA Formdef or PagedefSpecification ..................................................................................................................... 88

Figure 24: SPS System Defaults for APA Printers ........................................................ 88

Figure 25: Format of the APA Control File Member Statements ................................. 92

Figure 26: Model APA JCL Insert Member for Direct Printing (SPSDINC)................ 111

Figure 27: Sample Direct Printing Job (SPSDSAMP).................................................. 114

Figure 28: PAGE MODE Device Origin ......................................................................... 131

Figure 29: IPDS MODE Device Origin........................................................................... 132

Figure 30: Supported Hardware Origins ...................................................................... 133

Figure 31: Effect of the PRESENTATION Parameter................................................... 133

Figure 32: PRESENTATION(PORTRAIT90) .................................................................. 134

Figure 33: DUPLEX(NORMAL) ...................................................................................... 135

Figure 34: Using Conditional Processing to Eject to New Form............................... 136

Figure 35: Applications Generating Invoke Media Maps............................................ 138


U21020-J-Z247-7-7600 233

Figure 36: Migrating to N_UP Duplex ........................................................................... 139

Figure 37: X2UP Simplex Page Placement................................................................... 141

Figure 38 - X2UP Duplex Page Placement ................................................................... 141

Figure 39: - Portrait Across Partition Assignments for Basic N_UP ......................... 142

Figure 40 - Page Placement for Basic N_UP in Duplex Mode (Cut Sheet Printers) . 143

Figure 41 - Basic N_UP Page Placement for Landscape Across Orientation .......... 143

Figure 42 - Asymmetrical Page Placement Using Enhanced N_UP .......................... 144

Figure 43: Sample Job to Create a Header Page for APA Printers............................ 160

Figure 44: Format of the IPAGINFO macro .................................................................. 161

List of Tables

U21020-J-Z247-7-7600 235

List of Tables

Table 1: Hierarchy of parameters for APA printers ..................................................... 217

List of Tables

236 U21020-J-Z247-7-7600

Bibliography

U21020-J-Z247-7-7600 237

Bibliography

• Printer Data Stream (SPDS) Model 4Reference ManualU9737-J-Z247-X-7600

• SPS/MVSInstallation GuideU20944-J-Z247-X-7600

• SPS/MVS-APAMessages GuideU21745-J-Z247-X-7600

• SPS/MVS-APAThe PSORT User´s GuideU26433-J-Z247-1-7600

• SPS APA Type Fonts with 240 dpiPrint SamplesU23008-J-Z249-X-7400

• SPS APA Type Fonts with 300 dpiPrint SamplesU23009-J-Z249-X-7400

• Electronic Twin Printing SystemOperating ManualU7637-J-Z246-X-7600

• Electronic Twin Printing SystemOperator's Reference CardU9739-J-Z248-X-7600

• Model 2,3 and 4 Electronic Printing SystemOperator's Reference CardU8316-J-Z248-X-7600

Bibliography

238 U21020-J-Z247-7-7600

Index

Aabend codes, 214accounting exit, 183. see also exits

parameter list, 183programming considerations, 184return codes, 183

Bblock letters. see information pages

Ccoding SPSPARM members

APA printers, 33fully coded members, 34quick install, 33

commands, SPS, 147control file

control statementsAPA, 92

defining for printer, 80. see also SPSPRINT. see alsoKEYxxxCTLDSN parameter, 80CTLKEY parameter, 80CTLKY parameter, 80TRIG parameter, 80

processing, 79requesting for printer, 82

CHARS parameter, 82MODIFY parameter, 82trigger, 82

system, 81

user, 81control file parameter summary

APA, 215control file parameters

defaults, 87, 88examples, 89keywords

CC, 93CHARS, 88, 92, 93COMP38MO, 93COPIES, 94DATACK, 92, 94DUPLEX, 88, 92, 94ENDBCS, 97ETFF, 97ETFH, 98FLIP, 98FORMCTL, 91, 92, 98FORMDEF, 88, 92, 98FPRUN, 98IBINSUB, 100INBIN, 88, 92, 99OUTBIN, 88, 92, 100PAGEDEF, 88, 92, 100PRESENTATION, 101PRINTOPT, 102RSHIFT, 88, 92SPOOLMSG, 102TRC, 102TRCTYPE, 92, 102TWINMSGS, 92, 104WRONLY, 105X2UP, 102, 105, 167

Index

U21020-J-Z247-7-7600 239

override hierarchy, 87APA resources, 87APA summary, 215data stream, 87FORMDEF, 87, 88JCL, 87JES, 87PAGEDEF, 87, 88setup member, 87system defaults, 88

control statement format, 31Core Interchange Fonts, 123

Ddata-set allocation exit, 193. see also exits


defaults, 28descriptor codes, 213DFLTffff

control statements, 92description, 30, 75keywords. see control file parameterparameter overview, 27structure, 27

direct printing, 107

EENDBCS, 130ESA. see operating system requirements

APA, 5exist

data-set allocation, 193SPSIXMSG, 123

exits, 180. see also message processing exitsaccounting, 183. see also accounting exitcoding, 180coding conventions, 180control blocks, 181

DSLIST, 182DSNBLOCK, 182DSXPARM, 182

GCA, 182GEA, 182IAZIDX, 182IAZJSPA, 182IFASMFR(6), 182IPCONTRO, 182IPPARM, 182IPUSEVAR, 182KYDUPD, 182MEMBLOCK, 182MEPARM, 182PDB, 182PDSINFO, 182POHEADER, 182PRTINFO, 182PSINFO, 182R6XPARM, 182RDDCB, 182RDSBLOCK, 182READBLOC, 182REXPARM, 182RPXPARM, 182RRXPARM, 182

data-set allocation. see also data-set allocation exitglobal exit area (GEA), 181input record processing, 184. see also input record

processing exitinstallation supplied variables, 208linkage conventions, 181message processing, 190. see also message processing

exitmessage table modification, 206restricted messages, 207SPSMREXI (add, delete), 184working storage, 181

EXITS, 193, 195

FFCB

use for APA printer, 126FORMDEF

override parameters, 88FORMxxx, 68–72

Bibliography

240 U21020-J-Z247-7-7600

control statement, 70description, 30keywords

DCKEY, 70DMBR, 70FORM, 70, 71MOD, 70, 71RFORM, 72

structure, 27FSI. see functional subsystem interfacefunctional subsystem interface, 3

GGEA, 181. see also exitsglobal exit area, 181. see also exitsGOCA-BCOCA AFPDS, 124, 125GRID, 123

HHSMTffff, 73–74


HDRLMOD, 74MSGLMOD, 74SEPLMOD, 74TLRLMOD, 74

parameter overview, 27structure, 27

IINBIN

SPS processing, 129information pages, 158

block letters, 173coding, 158example, 160installation supplied variables, 208keywords

X2UP, 170macros

$IECHNG, 175

$IELEV, 175IPAGINFO, 161IPEND, 175IPLINE, 171IPSTRU, 175

operands, 162CC, 162CHARS, 162COMP38M, 163COPIES, 163DATACK, 163DELETE, 163DUPLEX, 163FLIP, 165FORMDEF, 166INBIN, 166NAME, 166OUTBIN, 166PAGEDEF, 166PRESENT, 167SOSI, 168TRCTYPE, 168TYPE, 169

special variables, 171%ADDR, 171%BLDN, 171%CLAS, 171%CONT, 171%COPY, 171%D2T1, 172%D2TE, 172%DAT1, 171%DATE, 171%DATX, 171%DDNA, 171%DEL1-4, 172%DEPT, 172%DEST, 172%FORM, 172%GLIN, 172%GLPA, 172%GRP1, 172%GRP2, 172%GRPN, 172

Index

U21020-J-Z247-7-7600 241

%JOBN, 172%JOID, 172%NAME, 172%PGNA, 172%PRTN, 172%ROM1, 172%ROOM, 172%RTIT, 172%SEGI, 173%STEP, 173%SYID, 173%TIME, 173%TITX, 173%US00-47, 173%USD0-F, 173%USER, 173

input binSPS processing, 129

input record processing exit. see also exitsparameter list, 185programming considerations, 186return codes, 186

installation defined variablesparameter lists, 210programming considerations, 211return codes, 211

installation supplied variables. see information pagesinstallation supplied variables exit, 208. see also

information pagesIntermediate Device, 125IOCA AFPDS, 124IPADDR, 78IPAGINFO macro, 160–70

operands. see information pagesIPEND macro, 175. see also information pagesIPLINE macro, 171. see also information pagesIPSTRU macro, 175. see also information pages

JJCL parameter summary

APA, 215JES PRINTER, 16

KKEYxxx, 72–73


CTLDSN, 73CTLKEY, 73

structure, 27

LLANDSCAPE, 101, 167LANDSCAPE180, 102LANDSCAPE90, 102, 167LEAVE, 101, 167

MMCF2, 123message format, 213message processing exit, 190. see also exits


message table modification, 206. see also exitsmessage text modification, 206messages, 214

descriptor codes, 213format, 213routing codes, 213

MICR-Fonts, 125MODIFY parameter, 82MSGSUxxx, 75–77


EXIT, 76MSGID, 76, 77RESP, 76, 77

structure, 27

NNUMACKR, 54

Bibliography

242 U21020-J-Z247-7-7600

Ooperating system requirements

MVS/ESA, 5MVS/XA, 5

override hierarchy, 87. see also control file parameterssummary

APA, 215override parameters. see control file parametersoverviews

control files, 79optional system tailoring, 157system parameters, 25

PPAGEDEF

override parameters, 88. see also control fileparameters

parameter override hierarchy, 87. see also control fileparameters

PARMSRC summaryAPA, 215

PORT, 78PORTRAIT, 101, 167PORTRAIT180, 101PORTRAIT90, 101, 167post-processing devices, 124preparing installation supplied variables. see information

pagesPreparing Installation Supplied Variables, 208printing with SPS, 119

RRDSREXIT, 195RECEXIT, 184registers, 180routing codes, 214

SSETUPxxx, 40–68

control statements, 41description, 29keyword

SETUPDP, 64keywords

ABENDAPG, 41, 44ANPRO, 45CHARS, 41CMDCHAR, 41, 45CMDIF, 45COLORMAP, 46COMP38MO, 46CONNINTV, 46DATACK, 46DISCINTV, 47DRIVER, 47DSALEXIT, 47DUMP, 41, 47ENDBCS, 47ETFF, 48ETFH, 48FAILURE, 48FDEFDD, 41, 49FLIP, 49FONTDD, 41, 49FORMDEF, 41, 49FPRUN, 49HDRDP, 50HDRLMOD, 41, 50IBINSUB, 50INFOERR, 51LUPUB, 51MAXFORM, 41MGMTMODE, 51MSGEXDP, 52MSGLIM, 41, 52MSGLMOD, 41, 52MSGSP, 41, 52NDFBUFL, 41, 53NORESP, 53NOTIFY, 53NOTRDMO, 54NUMCCWB, 54NUMIDAB, 55OBJCONDD, 55OUTBUF#, 41, 55OUTBUFL, 41, 55

Index

U21020-J-Z247-7-7600 243

OVLYDD, 41, 55PAGEDEF, 41, 56PDEFDD, 41, 56PDSBUF#, 41, 56PDSBUFL, 41, 56PGFIXIO, 41PIMSG, 41, 56PRINTOPT, 57PRINTSET, 57PRTERROR, 57PRTNUFON, 58PRTNUOVE, 58PRTNUPSE, 58PSEGDD, 41, 58PSEGEXIT, 58PSFBTBL, 59PSFX01, 59PSFX02, 59PSFX03, 59PSFX07, 59PSSTOMGT, 60QUEITV, 60QUETMOUT, 60RDSBUF#, 41, 61RDSBUFL, 41, 61RDSREXIT, 61REAINUS, 61RECEXIT, 41, 62RELINTV, 62RELMODE, 62REMSETUP, 63RESLIST, 63SEPLMOD, 41, 63SIOAPG, 64SMF6EXIT, 41, 64SPOOLMSG, 64STAQINT, 64TIMEOUT, 65TLRLMOD, 41, 65TRACEFILE, 41, 65TRACELEV, 41, 66TRACELIM, 41TRACESET, 41, 67TRACETYPE, 41, 67

TWINMSGS, 68WRONLY, 68

structure, 27SETUPXXX, 54, 184, 195SMF type 6 record, 218SNA LU62, 54SPSMDSOS, 193SPSMHDRP, 158SPSMREC1, 184SPSMRECO, 184SPSMREXI (add, delete), 184SPSMRRCO, 195SPSMRROS, 195SPSMSEPP, 158SPSMTLRP, 158SPSPRINT, 27, 36–40, 78


CTLKY, 36, 80CUU, 36, 37FTBL, 36LOGMODE, 39MSGSU, 36NETID, 39PRT, 36, 39SETUP, 36, 40TRIG, 36, 40, 80

structure, 27statement syntax, 31support summary

APA, 6syntax, 31system parameter members. see also each member name

coding APA members, 33fully coded members, 34quick install, 33

control statement format, 31defaults, 28descriptions, 29members

DFLTffff, 27, 75FORMxxx, 27, 69HSMTffff, 27, 74

Bibliography

244 U21020-J-Z247-7-7600

KEYxxx, 27, 73MSGSUxxx, 27, 76SETUPxxx, 27, 41SPSPRINT, 27, 36

structure, 27system parameters. see 'system parameter members' for

member names. see each member name for keywordshow organized, 31syntax, 31

system tailoring, 157accounting exit, 183data-set allocation exit, 193information pages, 158installation supplied variables exit, 208message processing exit, 190message table modification, 206

record processing exit, 184

TTCP/IP, 54TCP/IP Support, 78TCPNAME, 78trigger, 82twin

messages, 122two up, 124Two Up, 105

XX2UP, 124XA. see operating system requirements

Documents

Océ · 4.5 APA Control Key Data Set List: KEYxxx ... 8.1.4 JES3 Header, Separator, Message, ... 9 SPS Commands