Operations and Commands

System operations and commands.
spool
This page explains system operations. The Commands page explains commands.
System Operations
To operate
Spool
and file queues, use the commands, interfaces, and related information that follows:
2
2
System Operators
You can customize
Spool
for your site-specific requirements.
In general terms, a system operator can be any
one
of the following:
  • The MVS console operator is a
    Spool
    system operator.
  • Any
    Spool
    user with a user ID authorization level 2 is an operator, when logged on to a display terminal.
  • Any
    Spool
    user with the appropriate authorization level is an operator, when using a communication channel through an application program. This includes, users using the
    Spool
    Menu System.
It is not always easy to define a system operator precisely. An operator logged on to
Spool
through a display terminal can issue commands to control
Spool
. Those using the
Spool
Menu System may also issue commands to control
Spool
.
Checkpoint and Spool Data Sets
Spool
must have one checkpoint data set and one or more spool data sets. The
Spool
checkpoint data set is allocated on a direct access volume with the default data set name CAI.ESFCHKPT. The
Spool
data sets are allocated on direct access volumes. The default spool data set name is CAI.ESFSPOOL. The structure and organization of the checkpoint and spool data sets and the data set names are specified by the
Spool
parameter data set.
A secondary checkpoint data set can be defined, which is used as a duplex copy of the primary checkpoint data set. Therefore, it can be used for manual recovery in case the primary checkpoint data set becomes unusable.
File Queue Data
This section provides file queue data including check-pointing, destination names, and whether a printed file is purged.
Checkpoint
The
Spool
system maintains an in-core file queue, which is check-pointed whenever it is changed. Each spool file in the system is identified by a unique file sequence number, an eight-character filename, an eight-character file destination name, and an eight-character user ID. The filename is not used directly by the system and can contain any alphanumeric character string. It can be used simply as a file description.
Destination Name
The destination name is used to identify the printer node on which the file is to be printed. Any printer in the network group in which the destination printer is defined may select the file for print processing, unless it operates in restricted-selection mode. If a printer operates in restricted-selection mode, it only selects files for output processing if their destination name matches the real node name or alias name of the printer.
Remember that each file has an output class definition (A-Z, 0-9), an
8-character form number, and a 4-character forms control buffer name.
Purging and Retaining Files
When a
Spool
file has been printed, it may or may not be purged automatically. This is usually specified by users, who can usually keep files as long as necessary, even after they have been printed.
You can retain any particular file after it has been printed. The file is marked as printed and retained for a specified number of hours. If you want to retain files for longer, the Re-queue File (RF) command can be used to remove the file printed indicator. Non-printed files are also eligible for automatic purging, but they are kept in the system for an installation-dependent additional time, which is added to the normal file retention time.
Spool
Operator Commands
This section provides information about how to enter the operator commands that control
Spool
.
Operator Commands
From an MVS console, the
Spool
system provides two methods to enter operator commands.
Use the following format:
F ESF,command
where ESF is the name of the procedure to start the
Spool
system. Some installations might use a different name.
Or enter the command preceded by the subsystem communication character
(-):
-command
The installation-specific subsystem communication character, if used, is specified in the
Spool
parameter data set.
Multiple Commands
You can enter more than one command on one command line.
Multiple commands are separated by semicolons:
command1;command2;command3
The subsystem communication character is not repeated for each command. It is only specified at the start of the first command.
When
OPS/MVS
is used to stop
Spool
and multiple commands are needed, then multiple commands must be separated by TWO semicolons to leave ONE semicolon to be passed on to
Spool
.
Example:
CMD1(F &JOBNAME,PNET;;SHUTDOWN;;DA) CMD2(F &JOBNAME,TNET;;SHUTDOWN;;DA) CMD3(F &JOBNAME,DA;;TNET;;SHUTDOWN,F)
Printer Control Commands
The following commands are used to control printers:
  • B -- Backspace printer
  • C -- Cancel printer
  • D -- Display printer status
  • E -- Restart printer
  • F -- Forward space printer
  • I -- Interrupt printer
  • P -- Stop printer
  • R -- Repeat printer
  • S -- Start printer
  • T -- Reset printer (change parameters)
  • Z -- Halt printer
File Control Commands
The following commands are used to control files:
  • AF -- Release file
  • CF -- Close a temporarily closed file
  • DF -- Display files
  • HF -- Hold file
  • PD -- Purge all printed files
  • PF -- Purge file
  • RF -- Re-queue file
  • TF -- Reset file (change parameters)
System Commands
The following commands are used to control the
Spool
system:
  • ABEND -- Abends the
    Spool
    system
  • CHKPT -- Forces a checkpoint
  • DA -- Displays active files
  • DS -- Displays the current status of the
    Spool
    system
  • ESYS -- Resets another
    Spool
    system
  • REINIT -- Reads the startup parameters and reinitialize some parameters without closing down
    Spool
  • SHUTDOWN -- Stops the
    Spool
    system
  • WRITELOG -- Releases the log file
XFER Interface
The XFER interface is used to transfer files between JES2 or JES3 and
Spool
; it can be subdivided into an ESFTOJES part and a JESTOESF part.
The following commands are used to control the XFER interface:
  • DX -- Displays status of the XFER interface
  • HX -- Stops the XFER interface
  • SX -- Starts the XFER interface
NJE Interface
The
Spool
system provides an NJE interface which can be used for the automatic transfer of spool files between the
Spool
system and other NJE nodes. The NJE interface provides a link to, for example, JES2, JES3/BDT, RSCS, POWER, and other
Spool
systems.
The following commands are used to control the NJE interface.
  • C -- Cancels current activity with another NJE node
  • D -- Displays the status of a session with another NJE node
  • P -- Stops a session with another NJE node
  • S -- Starts a session with another NJE node
  • Z -- Halts a session with another NJE node
VTAM Network Interface
Spool
provides a VTAM Network interface for 3270 VTAM displays and printers. The network interface must be active for
Spool
to be able to send files to printers, to enable users to logon from terminals, or to use the NJE interface.
The following commands are used to control the network interface:
  • PNET -- Stops the network interface. Active sessions are allowed to finish.
  • SNET -- Starts the network interface.
  • TNET -- Stops the network interface immediately. Active sessions are interrupted.
Advanced Communication Interface
The Advanced Communication Interface lets the user programs to send commands to
Spool
, and to receive responses and other messages generated by
Spool
. Each user program interfaces with
Spool
through a communication channel.
The following commands are used to control communication channels:
  • DC -- Displays the status of communication channels
  • PC -- Stops a communication channel
  • SC -- Starts a communication channel
SUBSYS Interface
The SUBSYS interface lets any program using fixed or variable record formats to create or retrieve a file from
Spool
. This interface is used by coding the SUBSYS parameter on the DD-statement with a number of
Spool
defined sub-parameters.
The following commands can control the SUBSYS interface:
  • HS -- Stops the SUBSYS interface
  • SS -- Starts the SUBSYS interface
Virtual Printer Interface
The Virtual Printer interface is used to get print from old applications which write directly on a network printer into
Spool
.
The following commands are used to control the virtual printer interface:
  • C -- Cancels the current transmission
  • P -- Stops a virtual printer session
  • PNET, VPS -- Stops the virtual printer interface
  • S -- Starts a virtual printer session
  • SNET, VPS -- Starts the virtual printer interface
  • TV -- Initiates and terminates virtual printer interface traces
  • Z -- Halts a virtual printer session
PSF Interface
The PSF interface is used to let PSF perform the actual printing.
The commands are the same as for other printers with the exception of PFSS, which stops a PSF address space.
The following commands are used to display the status of the PSF interface:
  • DS, FSS -- Display active Functional Subsystem address spaces.
  • DS, FSA -- Display active Functional Subsystem Applications and Functional Subsystem address spaces.
View
Interface
The
Spool
to
View
interface can be used to copy files from
Spool
to
View
(formerly known as SAR.)
The
Spool
to
View
interface can be used for:
  • Automatic transfer of files to
    View
    for further processing
  • Automatic creation of file back up copies into
    View
  • Automatic archival of files into
    View
The following commands can be used to control this interface:
  • CSAR
    Cancels and halts the
    Spool
    to
    View
    interface.
  • HSAR
    Halts the
    Spool
    to
    View
    interface.
  • SSAR
    Starts the
    Spool
    to
    View
    interface.
Transformer Interface
You can use the Transformer interface to automatically translate data streams from one format to another, as follows:
  • Text to PDF, HTML, and RTF
  • AFP to PCL, PostScript, and PDF
  • Xerox Metacode to PCL, PostScript, and PDF
Use the following commands to control this interface:
  • HT
    -- Halts the Transformer interface
  • ST
    -- Starts the Transformer interface
LPD/IPP Interface
The
Spool
LPD/IPP Print Server Interface is used to receive print requests from remote print servers and workstations using the TCP/IP LPR/LPD or IPP protocols.
Use the following commands to control the LPD interface:
  • C
    ,
    LPD,
    session
    -- Cancels the LPD/IPP session
  • DA,LPD
    -- Displays active LPD/IPP sessions
  • DS,LPD
    -- Displays the current LPD/IPP status
  • REINIT,LPD
    -- Reads the startup parameters and reinitializes the LPD/IPP Interface
  • PNET, LPD
    -- Stops the LPD/IPP Interface. Active sessions are allowed to finish.
  • SNET,LPD
    -- Starts the LPD/IPP Interface
  • TNET,LPD
    -- Stops the LPD/IPP Interface. Active sessions are terminated.
System Start and Stop
This section provides information about the MVS start command, initialization options, and the stop command.
MVS Start Command
Enter the following MVS command to start
Spool
:
S esf
where
esf
is the name of the procedure used to start the
Spool
system. In some installation-specific cases this may not be ESF.
Initialization Options
Specify the following options in the PARM parameter of the EXEC statement in the procedure used to start
Spool
. If not specified,
Spool
prompts for options during initialization.
Use the OS Reply command to enter one or more of the following options:
  • BUILDQ -- Initiates a warm start and rebuilds the file queue.
  • COLD -- Initiates a cold start and formats the in-core file queue.
  • FORMAT -- Initiates a format cold start.
    Spool
    formats all its spool data sets, and initializes the in-core file queue.
  • LIST -- Produces a listing of the parameter data set.
  • LOG -- Initiates a
    Spool
    system log. This log records all the messages issued by
    Spool
    .
  • NOFMT -- Switches off the FORMAT option.
  • NOLIST -- Switches off the LIST option.
  • NOLOG -- Switches off the LOG option.
  • SCAN -- Initiates a syntactical check of the
    Spool
    parameter data set, after which
    Spool
    will terminate.
  • WARM -- Initiates a normal warm start.
  • U -- Initiates a normal warm start.
  • NULL -- Initiates a normal warm start. When
    Spool
    is successfully initiated, it enters into a
    waiting for work
    mode and is ready to process requests.
Stop Conditions
The following conditions must both be satisfied in order for
Spool
to stop.
  1. The network interface must be stopped using
    one
    of the following methods:
    • Issue the PNET command, which is the normal way to stop the network interface.
    • Issue the TNET command, which can be used if the interface must be stopped immediately. Be aware that all active network sessions are interrupted.
  2. All files must be closed using
    one
    of the following methods:
    • Issue the SHUTDOWN command to enable applications with open files to complete before
      Spool
      stops. No applications are allowed to open files after this.
    • Issue the SHUTDOWN,F command to stop
      Spool
      regardless of open files.
    • MVS STOP command
      P esf
      esf
      is the name of the procedure used to start the
      Spool
      system. In some installation-specific cases this may not be ESF. This is the same as entering the SHUTDOWN,F command to stop
      Spool
      regardless of open files.
Multi-Access
Spool
Multi-Access Spool (MAS) configuration enables sharing of common checkpoint and spool data sets up to 32
Spool
systems.
Cold and Warm Starts
The first system in the complex can (if desired) be cold started, and the other members of the configuration can join the complex by performing a warm start.
File Affinity
When a spool file is created, the application program may specify that the file has affinity to a single system in the MAS configuration. A spool file with affinity to a single system can only be printed on printers, or processed by application programs, on that system. However, the characteristics or status of the spool file may be altered by any system in the configuration. A file without system affinity can be processed by any system in the Multi-Access Spool (MAS) configuration. You can change the affinity of a spool file with the Reset File (TF) command.