---<br />title: "splr_main"<br />original_file: "splr_main"<br />generated: "2026-06-12 10:24:25"<br />---<br /><br />**<br /># <br />Introduction### TP Spooler<br />## <br />Who Should Read This Guide<br />This guide is written primarily for use by those persons who will be using the MAGEC TP Spooler software to manage hardcopy output and reports.<br />Copies of this guide should be distributed to:<br />Application developers<br />Security officers<br />Database administrators<br />System programmers<br />Auditors<br />## <br />Supplemental Reading<br />This guide is written assuming that the reader is familiar with the overall MAGEC philosophy. It presumes that you (cont.)<br />understand how the "standard set of nine" functions work and that you are familiar with the standard screen formats of (cont.)<br />MAGEC. We suggest that you first read the MAGEC *Application User's Guide*, if you have not already.<br /># <br />Overview<br />## <br />Purpose for Spooler<br />The TP Spooler facility gives MAGEC users the ability to "spool" reports from batch and online applications and to (cont.)<br />print them at the system line printer and/or at online hardcopy devices (IBM 3287, 3268, etc.). The Spooler provides a (cont.)<br />number of valuable services and facilities and solves several technical problems often encountered when attempting to (cont.)<br />use online hardcopy devices. Some of the problems solved are:<br />Different message protocols for various devices.<br />Different treatment required for local and remote connected online devices.<br />Interleaving of reports having multiple "pages" in a multi-tasking environment.<br />Lack of control of special forms mounted at the target device.<br />Inability to re-route reports when hardware failures occur.<br />MAGEC TP SPOOLING allows any number of online tasks and/or batch tasks to spool reports concurrently.<br />It allows for any number of reports to be concurrently printed at online and system printers.<br />It allows for any report to be routed or re-routed to any location or to the system printers.<br />It stores print data in compressed format on its own spool file which never requires re-organization and recaptures freed space automatically.<br />It allows for report DISPOSITION and FORMS control as well as LOCATION designation. Reports may be specified to print spontaneously or to await operator intervention.<br />Multiple COPIES of reports may be specified and dynamic operator commands may be used to PAUSE, BACKUP, ADVANCE, or FLUSH reports while printing.<br />Using the TP Spooling System is no more complicated than writing to a standard print file.<br />## <br />Environment<br />The Spooling System operates only in a MAGEC environment and under the control of the MAGEC Security System.<br />A major portion of the benefit of the Spooler is that it enforces a discipline over accesses to online hardcopy (cont.)<br />devices; therefore it is important that all messages and reports directed to those devices be routed using the Spooling (cont.)<br />system. The Spooler does not prevent you from writing directly to any device from your program; but, doing so could (cont.)<br />void the benefits of the system.<br />Reports are stored on the Spool file (SPL file) to await printing. Control information about the reports is stored on (cont.)<br />the Report Header file (RPH file). A "Spooler Supervisor" routine periodically "polls" those files looking for reports (cont.)<br />which are ready to be printed and for matching devices on which to print them. To prevent the Spooler Supervisor from (cont.)<br />monopolizing the resources of your system, a DELAY is inserted at intervals in the "polling sequence". The duration of (cont.)<br />this DELAY can be dynamically modified via online commands.<br />Application programs wishing to direct output to online printers do so by building "print lines" (as they would to a (cont.)<br />line printer) and CALL'ing the system-provided user subroutine (as though they were WRITE'ing to the printer) for each (cont.)<br />print line. The "Spool Subroutine" compresses the print lines and "blocks" them for storage on the SPL file. A (cont.)<br />"copybook" is provided for your programs to make it easy to CALL the Spool Subroutine.<br /># <br />Security<br />## <br />Online Functions<br />The MAGEC Security System controls all online Spooler functions. Refer to the MAGEC "Security" chapter for more information.<br />All online Spooler functions are defined as being in Logical Application number 48 to the Security System.<br />MAGEC Lookup Table # 252 defines all LOCATIONS. You can add new definitions using the online function as:<br />TBLADD 252/xxx<br />where:<br />xxx<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br />= desired new LOCATION code)<br />All the TP Spooler online function codes require at least a Level 1 authorization, your installation may specify that (cont.)<br />they require higher. Some functions require a Level 9. In most cases, operators with less than a Level 9 will only be (cont.)<br />permitted to access report and device data for their own LOCATION. This provides for isolation of remote LOCATIONs and (cont.)<br />protection against having one LOCATION view or modify another LOCATION's reports or devices.<br />Spooler online functions may only be done from terminals which are defined to the MAGEC Device file (DVC) unless you are a Level 9.<br />If you have a Level-9 authorization for Logical Application 48 you can make any entry from any terminal; but, operators (cont.)<br />having Level 1 through 8 are usually restricted to their own LOCATIONs. The special privileges for Level 9 operators (cont.)<br />give Technical Support personnel the capabilities they require from time to time.<br />We recommend that every LOCATION with hardcopy devices also have at least one video terminal so that they can use the dynamic commands.<br />## <br />Auto-Startup<br />An automatic startup feature is available, it automatically restarts the Supervisor "polling" when the TP system is "brought up". It is described later in this chapter.<br /># <br />System Files<br />There are two files provided with the MAGEC TP Spooler. They are the Spool file (SPL) and the Report Header file (RPH). (cont.)<br />The Spooler also uses the standard MAGEC Device file (DVC) which is part of the MAGEC Security (cont.)<br />System.<br />## <br />DVC File<br />The DVC file contains the defintions for all hardcopy and video terminals on the network. The Security System (cont.)<br />references the DVC file to determine LOCATION and to provide Terminal-level security control when an operator logs on (cont.)<br />to MAGEC. The Spooler uses the DVC file to further restrict access to certain Spooler online functions and, for (cont.)<br />printers, to route reports to the appropriate devices.<br />You can, if you are properly authorized, see and update the device profiles on the DVC file using the online functions:<br />DVCADD<br />**<br />ADD a device<br />**<br />DVCCHG<br />**<br />CHanGe a device<br />**<br />DVCDEL<br />**<br />DELete a device<br />**<br />DVCSEE<br />**<br />SEE a device<br />**<br />DVCDUP<br />**<br />DUPlicate a device<br />**<br />DVCNXT<br />**<br />see NeXT device<br />**<br />DVCLOC<br />**<br />LOCate a device<br />**<br />DVCSCN<br />**<br />SCaN device data<br />**<br />DVCFND<br />**<br />FiND device data<br />## <br />DVC File Maintenance<br />Online, real-time maintenance is provided for the DVC file using the Device Control Screen shown in Figure 01.<br />The Screen Key (SKEY) is where you enter the Terminal ID (<br />tttt<br />) for the device you wish to see or update on the file. The terminal ID must be the same as that defined to the TP (cont.)<br />Monitor for that device. If you enter an asterisk ( * ) into SKEY then MAGEC will default to the terminal ID of the (cont.)<br />terminal you are at.<br />**ID** is not an enterable field, it displays the Terminal ID on inquiries.<br />**Location** is where you specify the 3-character mnemonic Location code for the location of the device. The Location (cont.)<br />codes must be defined on MAGEC Lookup Table #252. The location description will display beside the (cont.)<br />code.<br />**Buf Size** is the hardware buffer size, used to limit the maximum number of bytes of message which can be transmitted to the device. The default is 1920 bytes. You can alter this field.<br />**Type** is the terminal type. Entries of "3286", "3289", etc. designate hardcopy devices. "3270", "3278", etc., designate video devices. You can enter into this field.<br />**L/R** is where you specify whether this is a local (L), remote (R), logical unit (U), or dial-up (D) device. You can enter into this field.<br />**Desc** is an up-to 30-character description of the device being defined. You can alter this here.<br />**Status** is where the system displays, and you can modify, the current status of the device. If the status of a (cont.)<br />device is BUSY and the operator wishes to alter it to any other status, he must first issue the<br />**<br />SPLR PAUSE<br />command to that device. Valid statuses are:<br />A<br />or<br />AVAILABLE<br />&nbsp;<br />B<br />or<br />BUSY<br />&nbsp;<br />D<br />or<br />DISABLED<br />&nbsp;<br />P<br />or<br />PAUSED<br />&nbsp;<br />&nbsp;<br />**Form** is the mnemonic name (or code) for the paper forms mounted on the device. A blank entry means that this device (cont.)<br />may accept any report regardless what FORM was specified for it. Blank, therefore, tells MAGEC to ignore FORM (cont.)<br />matching.<br />**User Views** is where the operator enters Y and N codes to specify which User Views are available to this device. This field is used only by the Security system.<br />**Active Report** is not enterable; it is where MAGEC displays the report number of the report currently being printed (cont.)<br />at this device. If no report is active then it will show blanks; if one is active it will be a 5-digit numeric report (cont.)<br />number. On the DVCSEE function, you may press PF6 to automatically transfer to the Report Header Display (RPHSEE) for (cont.)<br />the report indicated.<br />**Time Out** is the number of minutes which may elapse between transactions from this device before MAGEC will (cont.)<br />automatically log off the operator, the lesser value between this and the time out from the SIF profile will apply. (cont.)<br />This field is used only by the Security system.<br />**Print Classes** is where you specify the Print Classes which this device is to service. Valid Classes are A thru Z (cont.)<br />and 0 thru 9; thus, there are 36 possible Classes. Any combination of Letters and Numbers is valid, the system will (cont.)<br />automatically sequence them into ascending order and eliminate duplicates.<br />**Authorized Hours** is the range of time (Hours and Minutes) during which this device may be logged on to. This field is used only by the Security system.<br />**Days**** **indicates, using Y and N codes, the days-of-week during which this device may be logged on to and whether it may be used on Holidays. This field is used only by the Security system.<br />**MAXIMUM AUTHORIZATION LEVELS**** BY APPLICATION** is an array of up to 50 Authorization Codes (0 - 9) corresponding (cont.)<br />to the defined LAP's. When an operator logs on to this device, the lesser value (for each LAP) of these and the ones (cont.)<br />from the operator's SIF profile will apply. This field is used only by the Security system.<br />| ```<br />**<br />&nbsp;DVCxxx tttt<br />&nbsp; M A G E C DEVICE DEFINITION (CRT/PRINTER)<br />&nbsp;ID=&nbsp;tttt<br />&nbsp;Location:&nbsp;___&nbsp;(&nbsp;___________________<br />_________________________&nbsp;)&nbsp;Buf Size:&nbsp; _____<br />&nbsp;Type:&nbsp;____ L/R:______ 7-Color(Y/N):&nbsp;_&nbsp; --TEST--&nbsp; --PROD--<br />&nbsp;Desc:&nbsp;______________________________ 87654321 87654321<br />&nbsp;Status&nbsp;_________&nbsp; Form:&nbsp;____&nbsp; User Views:&nbsp;________ ________<br />&nbsp;Active Report&nbsp;_____&nbsp; Time Out:&nbsp;___ min.<br />&nbsp;Print Classes:&nbsp;______________________ SMTWTFSH<br />Authorized Hours&nbsp;:&nbsp;__&nbsp;__&nbsp;to __&nbsp;__&nbsp; Days:&nbsp;________<br /><br />next: splr02.md.txt