The Display All Spooled files command provides a subfile of selected
spooled files in a 'display only' function. Any user may use the
command to display his own spooled files. To display spooled files
owned by other users, the current user must be authorized to the
TAAALLSPLF authorization list. Standard options exist to display
data or attributes plus parameter controlled options.
DSPALLSPLF may be used as part of a user menu option so the user can
display his own spooled files (or attributes) without being able to
change or delete any of the spooled files. The programmer designing
the menu can specify command parameters to control whether the
following options appear:
- SNDNETSPLF
- Change to a different output queue (see later discussion)
- HLD/RLSSPLF
- DSPPRTSPC TAA Tool
- PRTPAGRNG TAA Tool
- DSPFSTSPLF TAA Tool (as the F19 Function key)
A typical command would be:
DSPALLSPLF
All spooled files owned by the current user would be displayed
(QPJOBLOG, QPSRVDMP, and QPPGMDMP are omitted by default).
If authorized to the TAAALLSPLF authorization list, DSPALLSPLF also
allows users to be able to display spooled file information owned by
other users. There are two levels of authorization that may be used.
See the discussion on Security.
The F11 key may be used for an alternate view which will describe the
date/time the spooled file was opened.
Selection criteria
------------------
Selection criteria exists for any or all of the following:
- User (spooled file owner) - may be generic
- Output queue
- Spooled file name (may be generic)
- Job name (may be generic)
- Form type
- User data
- Status
- Start and end date of when the file was opened
- Omit list of spooled files
- Defaults to omit QPJOBLOG, QSRVDMP, and QPPGMDMP
- Omit list of output queues
For example, if you are properly authorized to the TAAALLSPLF
authorization list, you could display every spooled file on the
system that is at least 2 days old in the 'HLD' status by the
command:
DSPALLSPLF USER(*ALL) STATUS(*HLD) ENDDATE(nnnnnn)
If no records exist for the selection criteria, the default is that
the display appears with an appropriate message. A command parameter
allows an option to send an escape message if no spooled files exist
to be displayed. This is intended to allow a menu user to see a
message on the menu rather than seeing an empty subfile with a
message.
Option 2 for Changing to an Output Queue
----------------------------------------
The CHGOUTQ parameter defaults to *NONE meaning that Option 2 will
not be displayed and is not valid.
If an output queue is named, Option 2 will appear at the top of the
display and the user will be allowed to enter the option. If option
2 is requested, the spooled file is changed to the output queue
specified for the CHGOUTQ parameter. The name of the output queue
will appear at the bottom of the display.
The intent of the option is to allow the user to have a personal
output queue and determine what spooled files should be printed.
Option 2 is performed by using CHGSPLFA internally. The CHGSPLFA
command cannot be prompted for.
Use with other TAA Tools
------------------------
There are other TAA Tools that may be of assistance when creating a
strategy for spooled files such as:
- CHGALLSPLF - Changes attributes of SPLFs in an OUTQ
- DLTOLDSPLF - Deletes SPLFs based on criteria
- SPLARC - Provides for save and restore of SPLFs
For example, you could have a strategy where the end users use
DSPALLSPLF and use the Hold option when they do not want to print a
spooled file at the current time. You could run DLTOLDSPLF and use
the MOVTOOUTQ function to move the spooled files to a central output
queue for all those that are in a held status and are two days old.
Using the SPLARC function, you could backup the central output queue
and delete the spooled files. This would allow a reprint capability
if required.
Security
--------
Any user can use the command by taking the default of USER(*CURRENT)
to display his own spooled files.
If the user is authorized to the TAAALLSPLF authorization list, he
can display spooled files owned by other users. Two levels of
authorization can be used to either allow or disallow authorization
to the spooled files in a private output queue (such as used for the
printing of payroll checks). The definition of a private output
queue is that it is created with the following attributes:
DSPDTA(*NO)
OPRCTL(*NO)
AUTCHK(*OWNER)
If the user has *USE authority to the TAAALLSPLF authorization list,
he can display all spooled files except those that are in a private
output queue and he is not the owner of.
If the user has *CHANGE authority to the TAAALLSPLF authorization
list, he can display any spooled file. This is the equivalent of
*SPLCTL special authority, but allows 'display only' functions. Note
that an *ALLOBJ user has *CHANGE authority to TAAALLSPLF.
To authorize a user to display any spooled file regardless of the
owner, use EDTAUTL or specify:
ADDAUTLE AUTL(TAAALLSPLF) USER(xxx) AUT(*CHANGE)
The authorized user could then display all spooled files regardless
of owner such as those beginning with PAY:
DSPALLSPLF USER(*ALL) FILE(PAY*)
To allow access to any output queue and the ability to display any
spooled file, DSPALLSPLF adopts QSECOFR authority. Because the user
must be authorized to the TAAALLSPLF authorization list to access
spooled files other than his own, the Security Officer has control
over who is authorized to the function.
DSPALLSPLF escape messages you can monitor for
----------------------------------------------
TAA9893 USER(*CURRENT) not used and not auth to TAAALLSPLF
TAA9894 Omit output queue does not exist
TAA9895 No SPLFs meet criteria (Optional based on ESCAPE parm)
Escape messages from based on functions will be re-sent.
API Use
-------
The QUSLSPL API is used to access the information. Some selection
criteria is performed by the API and some is performed within the
program.
Using generic names causes slower performance because the selection
criteria cannot be completely performed by the API.
Command parameters *CMD
------------------
USER The user name of the owner of the spooled files.
The default is *CURRENT.
A specific user name, a generic name, or *ALL may
also be used. If a specific user name (other than
the current user), a generic name, or *ALL is used,
the user must have *USE authority to the TAAALLSPLF
authorization list.
OUTQ The output queue containing the spooled files to be
displayed. The default is *ALL.
If a specific output queue is entered, a qualified
library name may be used. If the qualified library
name is blank, *LIBL is assumed.
FILE The spooled file name to be selected. The default
is *ALL. A specific name or a generic name may be
entered.
JOB The qualified job name to be selected. The default
is *ALL. A specific job name or a generic job name
may be entered.
The user portion of the qualified job name may be
entered if a job name (specific or generic) was
entered. The default is blank.
The job number portion of the qualified job name may
be entered if the job name is specific.
FORMTYPE The form type to be selected. The default is *ALL.
A specific name or the special value *STD may be
entered.
USRDTA The user data to be selected. The default is *ALL.
A specific name may be entered.
STATUS The status of the spooled files to be selected. The
default is *ALL. The values *RDY, *HLD, or *SAV may
be entered.
STRDATE The start date that a spooled file was opened. The
default is *START meaning any date is valid.
A specific date may be entered in job format.
*CURRENT may be used for the current date. If a
specific date is entered, the spooled file must have
been opened on or after the start date and on or
before the end date.
ENDDATE The end date that a spooled file was opened. The
default is *END meaning the oldest date a spooled
was opened. *CURRENT may be entered to mean the
current date. A specific date may be entered in job
format. If a specific date is entered, the spooled
file must have been opened on or after the start
date and on or before the end date.
OMITFILE Whether to omit a list of spooled file names. The
default is *DMPLOG meaning any spooled files named
QPJOBLOG, QPSRVDMP, and QPPGMDMP are omitted.
*NONE may be specified to cause all spooled files to
be considered (none are omitted). A list of up to
10 file names may be entered.
SNDNETSPLF Whether to allow an option for SNDNETSPLF. *YES is
the default which causes an option to appear on the
subfile display so the user may prompt for the
SNDNETSPLF command.
*NO may be specified to eliminate the option being
displayed or entered.
CHGOUTQ Whether to allow Option 2 for changing the output
queue assigned to the spooled file. The default is
*NONE in which case Option 2 does not appear and is
not valid.
The intent of the parameter is to allow the user to
have a personal output queue and determine what
spooled files will be printed.
If an output queue is named, '2=Chg OUTQ' will
appear as an option. If the option is requested,
the CHGSPLFA command is run internally to change the
output queue assigned to the spooled file. No other
CHGSPLFA options exist and prompting (F4) may not be
used. The name of the output queue that will be
used appears at the bottom of the display.
A qualified name of the output queue may be entered.
If the library name is left blank, *LIBL is assumed.
HLDRLS Whether to allow an option for HLD/RLSSPLF. *YES is
the default which causes options for HLDSPLF and
RLSSPLF to appear on the subfile display.
*NO may be specified to eliminate the options being
displayed or entered.
DSPPRTSPC Whether to allow an option for the TAA Tool
DSPPRTSPC. *YES is the default which causes the
option to appear on the subfile display.
DSPPRTSPC displays the spooled file data with blank
lines included as well as skipping information. It
provides a better picture of what the printed output
would look like (the system DSPSPLF function
squeezes out any blank lines). DSPPRTSPC is limited
to those spooled files capable of being used with
CPYSPLF (does not support special graphics).
*NO may be specified to eliminate the option being
displayed or entered.
PRTPAGRNG Whether to allow an option for the TAA Tool
PRTPAGRNG. *YES is the default which allows the
option to appear on the subfile display so the user
can prompt for PRTPAGRNG.
PRTPAGRNG allows the re-printing of a spooled file
with a range of pages. The original spooled file
attributes are not changed to reflect the page
range. PRTPAGRNG is limited to those spooled files
capable of being used with CPYSPLF (does not support
special graphics).
*NO may be specified to eliminate the option being
displayed or entered.
DSPFSTSPLF The output queue to be assigned for the DSPFSTSPLF
command if any. The default is *NONE. When *NONE
is specified, the F19 key does not appear on the
display.
If an output queue is named, F19 appears as a valid
Function key for the DSPFSTSPLF TAA command.
The intent of DSPFSTSPLF is to allow the user to see
the printing status of his first spooled file in the
output queue normally used for printing. If no
writer is assigned, the information is highlighted.
If the users first spooled file is currently
printing, the information is shown on the DSPALLSPLF
subfile and is repeated on the DSPFSTSPLF display.
If the users spooled file is ready to print on an
output queue that has a writer assigned, the number
of spooled files and number of pages ahead of the
users first spooled file in that output queue are
shown. This provides an indication to the user of
when the spooled file will be output.
Only one output queue may be specified. If the
normal output is to a 'hot queue', the name of the
'hot queue' should be used. If you are using the
CHGOUTQ parameter to name the 'hot queue', the same
output queue name should be used for DSPFSTSPLF.
A qualified name of the output queue may be entered.
If the library name is left blank, *LIBL is assumed.
ESCAPE Whether to send an escape message if no spooled
files exist for the selection criteria. The default
is *NO which means the user will see a message on
the subfile describing the condition.
*YES may be specified to cause the escape message
TAA9895 to be sent. This is intended to allow a
menu user to see a message on the menu rather than
seeing an empty subfile with a message.
OMITOUTQ A list of up to 50 output queues to be omitted. Any
output queues entered will be omitted. A qualified
name must be used. All output queues specified are
checked for existence.
Restrictions
------------
** A maximum of 2000 spooled files are supported.
** Other restrictions exist as described in the previous
comments.
Prerequisites
-------------
The following TAA Tools must be on your system:
CHKGENERC Check generic
DSPPRTSPC Display printer space
DSPSPLFA Display spooled file attributes
EXTLST Extract list
EXTLST2 Extract list 2
FILEFDBCK File feedback
HLRMVMSG HLL Remove message
PRTPAGRNG Print page range
RTVDAT Retrieve date
UNADOPT Unadopt program
SNDESCMSG Send escape message
Implementation
--------------
None, the tool is ready to use. To specify other than
USER(*CURRENT), the user must have *USE authority to the TAAALLSPLF
authorization list.
Objects used by the tool
------------------------
Object Type Attribute Src member Src file
------ ---- --------- ---------- ----------
DSPALLSPLF *CMD TAASPMM QATTCMD
TAASPMMC *PGM CLP TAASPMMC QATTCL
TAASPMMC2 *PGM CLP TAASPMMC2 QATTCL
TAASPMMC3 *PGM CLP TAASPMMC3 QATTCL
TAASPMMR *PGM RPG TAASPMMR QATTRPG
TAASPMMD *FILE DSPF TAASPMMD QATTDDS
|
