TAA Tools
DSPWTR          DISPLAY WRITER                         TAAPRTO

The Display  Writer command is  similar to  the system WRKWTR  command,
but  allows only display  options plus  describing the number  of files
in  the  associated output  queue.   The  command  is intended  for end
users who need  to display information about  one or more writers,  but
should  not  be able  to  make  any changes.    An  optional method  of
displaying  the output queue  associated with the  printer is provided.

A typical command would be:

             DSPWTR    WTR(ABC)

The  writer  associated  with  the  printer  ABC  would  be  displayed.
Standard options  exist to display the  writer or device.   An optional
method of displaying the output queue is provided.

DSPOUTQ program for displaying the output queue
-----------------------------------------------

The DSPOUTQ  parameter allows a method of  letting the user display the
spooled files  that  are  in  the  output  queue  associated  with  the
printer.  The  parameter controls what  Option 7 on the  DSPWTR subfile
display will do (if it exists).

The   default  is  *STD   which  uses   the  TAA   WRKALLSPLF  command.
WRKALLSPLF  allows  the  tailoring  of a  display  that  is  similar to
WRKOUTQ so that  specific options may  be omitted or  added.  The  only
options supported by *STD are:

            5 = Display
            8 = Display attributes

DSPOUTQ(*NONE) may be  specified to prevent Option 7  from appearing on
the DSPWTR subfile display.

A  specific program  may be named  to allow  you to  tailor the command
that is used.   It  could be either  WRKOUTQ or WRKSPLF  both of  which
will  allow  the user  to  make  changes.   Or  it  could be  your  own
tailored version of WRKALLSPLF or some other function.

If   you  supply  a  program   name,  it  must   accept  the  following
parameters:

          WTR       *CHAR  LEN(10)  Writer
          OUTQ      *CHAR  LEN(10)  The output queue
          OUTQL     *CHAR  LEN(10)  The output queue library

The OUTQ and OUTQL values  are what was known  when DSPWTR was used  to
first  convert the  information.    It  is possible  that  a  different
output  queue  is  now  being  used.    Your program  could  first  use
RTVWTRSTS  to  retrieve the  current  output queue  and  library before
further processing.  The  OUTQ, OUTQL, and number of  files information
is  updated in  the  data used  by  the DSPWTR  subfile  when a  return
occurs  from your program.   The PRTDEV is not  updated and remains its
original value.

IPDS Printers
-------------

If an  IPDS printer  is used,  the information  on  the DSPWTR  subfile
display or with  Option 5 (Display Writer Status) will  rarely show the
specifics  of the  spooled file.   This  is  due to  the fact  that the
entire  spooled  file  is   sent  to  the   device  and  the   specific
information such as the page being printed is not known.

Security considerations
-----------------------

The DSPWTR  command must use  CVTPRTSTS which requires  *JOBCTL special
authority.   To  allow a  basic  user profile  to use  DSPWTR,  the sub
program  TAAPRTOC11  is  used  which adopts  QSECOFR  authority  to use
CVTPRTSTS.

DSPWTR escape messages you can monitor for
------------------------------------------

None.  Escape messages from based on functions will be re-sent.

DSPWTR Command parameters                             *CMD
-------------------------

   WTR           The name  of the  writer to  display information  for.
                 The  name of  the writer  and the  printer  device are
                 synonymous.    A  specific  or  generic writer  (print
                 device) may be named.   *PRT may be specified for  all
                 printers.   *ALL  may be  specified  for all  spooling
                 writers.

   DSPOUTQ       The  program to  be used  for Option  7 on  the DSPWTR
                 subfile display  to display  the  output queue.    The
                 default  is  *STD   which  uses  the   WRKALLSPLF  TAA
                 command   with   a  definition   that   supports  only
                 5=Display and 8=Display attributes.

                 *NONE  may be  specified to  remove Option  7 from the
                 DSPWTR subfile display.

                 A program  name  and library  may be  named  to run  a
                 command  that  is tailored  for  the  situation.   The
                 program    could   contain   WRKOUTQ   (which   allows
                 changes), a tailored  version of  WRKALLSPLF, or  your
                 own  specialized  function.    See  the  documentation
                 section on DSPOUTQ.

   OUTPUT        How  to  output the  results.   *  is  the  default to
                 display the  spooled file  if the  command is  entered
                 interactively.  The  spooled file is deleted  after it
                 is displayed  if it is ended with  F3/F12 or the Enter
                 key.   To  retain the  spooled file,  you may  use the
                 the System Request  'Cancel' function and  the spooled
                 file will exist in a HLD status.

                 If  the  command is  entered  in  batch  or *PRINT  is
                 specified,  the spooled  file is output  and retained.
                 The WRKWTR OUTPUT(*PRINT) function is used.


Restrictions
------------

None.

Prerequisites
-------------

The following TAA Tools must be on your system:

     CHKOBJ3         Check object 3
     CVTPRTSTS       Convert printer status
     DSPWTRSTS       Display writer status
     HLRMVMSG        HLL Remove message
     RPGSTSDS        RPG status data structure
     RSNLSTMSG       Resend last message
     RTVOUTQA        Retrieve output queue attributes
     RTVPGMSTK2      Retrieve program stack 2
     SNDESCINF       Send escape information
     SNDESCMSG       Send escape message
     WRKALLSPLF      Work all spooled files

Implementation
--------------

None, the tool is ready to use.

Objects used by the tool
------------------------

   Object        Type    Attribute      Src member    Src file
   ------        ----    ---------      ----------    ----------

   DSPWTR        *CMD                   TAAPRTO       QATTCMD
   TAAPRTOC      *PGM       CLP         TAAPRTOC      QATTCL
   TAAPRTOC2     *PGM       CLP         TAAPRTOC2     QATTCL
   TAAPRTOC3     *PGM       CLP         TAAPRTOC3     QATTCL
   TAAPRTOC11    *PGM       CLP         TAAPRTOC11    QATTCL
   TAAPRTOR      *PGM       RPG         TAAPRTOR      QATTRPG
   TAAPRTOD      *FILE      DSPF        TAAPRTOD      QATTDDS
					

Added to TAA Productivity tools October 15, 2012


Home Page Up to Top