All Downloads are FREE. Search and download functionalities are using the official Maven repository.

src.com.ibm.as400.access.doc-files.PrintAttributes.html Maven / Gradle / Ivy

Go to download

The Open Source version of the IBM Toolbox for Java

There is a newer version: 11.1
Show newest version




  

   
   
  IBM Toolbox for Java: Object Keys
  

   
  

   
  

   
  








Print Object Attributes














Table of Contents
















3812 SCS (Fonts)





  
ID


  
ATTR_3812SCS


  
Type


  
String (one character)


  
Description


  
Whether the spooled file contains fonts supported only on the
3812 printer.  Valid values are Y (yes) or N (no).
















Accounting Code





  
ID


  
ATTR_ACCOUNT_CODE


  
Type


  
String


  
Description


  
An identifier assigned by the system to record the resources
used to write the spooled file.
















Advanced Function Printing





  
ID


  
ATTR_AFP


  
Type


  
String


  
Description


  
Indicates whether this spooled file uses AFP resources external to
the spooled file. Valid values are *YES and *NO.
















AFP Resource





  
ID


  
ATTR_AFP_RESOURCE


  
Type


  
String 


  
Description


  
The Integrated File System path of the external AFP (Advanced Function Print) resource.
The format of the Integrated File System path is "/QSYS.LIB/library.LIB/resource.type" where
    library is the library that contains the resource, resource is
the name of the resource and type is the resource type.  Valid values
for type include FNTRSC, FORMDF, OVL, PAGSEG, and PAGDFN.
  
















Align Forms





  
ID


  
ATTR_ALIGNFORMS


  
Type


  
String


  
Description


  
The time at which a forms alignment message will be sent.  Valid values are *WTR, *FILE, *FIRST. 
















Align Page





  
ID


  
ATTR_ALIGN 


  
Type


  
String 


  
Description


  
Indicates whether a forms alignment message is sent prior to printing
this spooled file. Valid values are *YES, *NO. 
















Allow Direct Print





  
ID


  
ATTR_ALWDRTPRT 


  
Type


  
String 


  
Description


  
Indicates whether the printer writer allows the printer to be allocated
to a job that prints directly to a printer. Valid values are *YES, *NO.
  
















ASCII Transparency





  
ID


  
ATTR_ASCIITRANS


  
Type


  
String (one character)


  
Description


  
For SCS spooled files, whether ASCII commands are embedded in the 
spooled file.  Valid values are Y (yes) or N (no).
















Authority





  
ID


  
ATTR_AUT 


  
Type


  
String 


  
Description


  
Specifies the authority that is given to users who do not have specific
authority to the output queue. Valid values are *USE, *ALL, *CHANGE, *EXCLUDE,
*LIBCRTAUT. 
















Authority to Check





  
ID


  
ATTR_AUTCHK 


  
Type


  
String 


  
Description


  
Indicates what type of authorities to the output queue allow the user
to control all the files on the output queue. Valid values are *OWNER,
*DTAAUT. 
















Automatically End Writer





  
ID


  
ATTR_AUTOEND 


  
Type


  
String 


  
Description


  
Specifies if the writer should be automatically ended. Valid values
are *NO, *YES. 
















Auxiliary Storage Pool





  
ID


  
ATTR_AUX_POOL


  
Type


  
Integer


  
Description


  
Specifies the number of the auxiliary storage pool (ASP) that the spooled file is stored on. 
The possible values are:
    
    

      
  • 1: System ASP
    • 

      
  • 2-32: One of the user ASPs
    • 

    


  















Auxiliary Storage Pool Device Name





  
ID


  
ATTR_ASPDEVICE


  
Type


  
String


  
Description


  
The name of the auxiliary storage pool (ASP) device 
that the spooled file is stored on.  Valid values are
*SYSBAS or a specific auxiliary storage pool device name.
















Back Margin Offset Across





  
ID


  
ATTR_BKMGN_ACR


  
Type


  
Float 


  
Description


  
For the back side of a piece of paper, it specifies, how far in from
the left side of the page printing starts. The special value *FRONTMGN
is encoded as -1.0. 
















Back Margin Offset Down





  
ID


  
ATTR_BKMGN_DWN 


  
Type


  
Float 


  
Description


  
For the back side of a piece of paper, it specifies, how far down from
the top of the page printing starts. The special value *FRONTMGN is
encoded as -1. 
















Back Overlay





  
ID


  
ATTR_BACK_OVERLAY 


  
Type


  
String 


  
Description


  
The Integrated File System path of the back overlay or a special value.  If the value is an
    Integrated File System path it will have the format "/QSYS.LIB/library.LIB/overlay.OVL" where
    library is the library of the resource and overlay is the
    name of the overlay.
    Valid special values include *FRONTOVL.
  
















Back Overlay Offset Across





  
ID


  
ATTR_BKOVL_ACR 


  
Type


  
Float 


  
Description


  
The offset across from the point of origin where the overlay is printed.
















Back Overlay Offset Down





  
ID


  
ATTR_BKOVL_DWN 


  
Type


  
Float 


  
Description


  
The offset down from the point of origin where the overlay is printed.
  
















Barcode





  
ID


  
ATTR_BARCODE


  
Type


  
String (one character)


  
Description


  
Whether the spooled file contains bar codes created using 
the BARCODE keyword in the data description specifications
(DDS).  Valid values are Y (yes) or N (no).
















Between Copies Status





  
ID


  
ATTR_BTWNCPYSTS 


  
Type


  
String 


  
Description


  
Whether or not the writer is between copies of a multiple copy spooled file.  Returned
values are *YES or *NO.
















Between Files Status





  
ID


  
ATTR_BTWNFILESTS 


  
Type


  
String 


  
Description


  
Whether or not the writer is between files.  Returned values are *YES or *NO.
















Changes





  
ID


  
ATTR_CHANGES 


  
Type


  
String 


  
Description


  
The time at which pending changes take effect. Valid values are
*NORDYF, *FILEEND, or blank which implies no changes pending to the
writer. 
















Character ID





  
ID


  
ATTR_CHARID


  
Type


  
String (one character)


  
Description


  
Whether the character ID can change within the spooled file.  Valid
values are Y (yes) or N (no).
















Character Set Library Name





  
ID


  
ATTR_CHRSET_LIB


  
Type


  
String


  
Description


  
The name of the library containing the font character set
object.  Valid values are *LIBL or a specific library name.
















Character Set Name





  
ID


  
ATTR_CHRSET


  
Type


  
String


  
Description


  
The name of the font character set object used to print the 
spooled file.  Valid values are *FONT or a specific font character
set name.
















Character Set Point Size





  
ID


  
ATTR_CHRSET_SIZE


  
Type


  
Float


  
Description


  
The point size in which to print the spooled file's character data.
    Valid values are from 000.1 to 999.0.  Value 000.0 represents *NONE,
    the character set does not have a point size.
  
















Characters Per Inch





  
ID


  
ATTR_CPI


  
Type


  
Float


  
Description


  
The number of characters per horizontal inch.
















Characters Per Inch Changes





  
ID


  
ATTR_CPI_CHANGES


  
Type


  
String (one character)


  
Description


  
Whether the spooled file changes the characters per inch
(cpi) within the file.  Valid values are Y (yes) or N (no).
















Code Page





  
ID


  
ATTR_CODEPAGE


  
Type


  
String 


  
Description


  
The mapping of graphic characters to code points for this spooled file.
    If the graphic character set field contains a special value, this field
    may contain a zero (0).
  
















Code Page Library Name





  
ID


  
ATTR_CODEPAGE_NAME_LIB


  
Type


  
String


  
Description


  
The name of the library containing the code page used to print
    this spooled file. Valid values are *LIBL or a specific library
    name.
  
















Code Page Name





  
ID


  
ATTR_CODEPAGE_NAME


  
Type


  
String


  
Description


  
The name of the code page used to print this spooled file.
















Coded Font Array





  
ID


  
ATTR_CODFNT_ARRAY


  
Type


  
String


  
Description


  
The name of the fonts used for printing spooled files 
    containing line data. This corresponds to the CHARS parameter
    of MVS and VM printing services. A maximum of 4 four-character-coded
    font names are returned.
  
















Coded Font Library Name





  
ID


  
ATTR_CODEDFNTLIB 


  
Type


  
String 


  
Description


  
The name of the library that contains the coded font. This field may
    contain blanks if the coded font name field has a special value. 
  
















Coded Font Name





  
ID


  
ATTR_CODEDFNT 


  
Type


  
String 


  
Description


  
The name of the coded font. A coded font is an AFP resource that is
composed of a character set and a code page. Special values include *FNTCHRSET.
  
















Coded Font Point Size





  
ID


  
ATTR_CODEDFONT_SIZE


  
Type


  
Float


  
Description


  
The point size in which to print the spooled file's character data.
    Valid values are from 000.1 to 999.0.  Value 000.0 represents *NONE,
    the coded font does not have a point size.
  
















Color





  
ID


  
ATTR_COLOR


  
Type


  
String (one character)


  
Description


  
Whether the spooled file contains data stream commands requesting
    color.  Valid values are Y (yes) or N (no).
  
















Constant Back Overlay





  
ID


  
ATTR_CONSTBCK_OVL


  
Type


  
String (one character)


  
Description


  
Whether or not constant back overlay is used.  Constant back overlay
allows the user to print overlays on the back side of each sheet of 
media without the need for the print application to generate print blank
pages.  Valid values are "0" (*NOCONSTANT) or "1" (*CONSTANT).
















Control Character





  
ID


  
ATTR_CONTROLCHAR 


  
Type


  
String 


  
Description


  
Whether this file uses the American National Standards printer
control character. The possible values are *NONE for no print control
characters are passed in the data that is printed or *FCFC which means
that the first character of every record is an American National
Standards printer control character. 
















Convert Line Data





  
ID


  
ATTR_CONVERT_LINEDATA


  
Type


  
String 


  
Description


  
Whether the line data is converted to AFPDS before it is written to spool. The possible values are *NO and *YES.
















Copies





  
ID


  
ATTR_COPIES 


  
Type


  
Integer 


  
Description


  
The total number of copies to be produced for this spooled file. 
















Copies Left to Produce





  
ID


  
ATTR_COPIESLEFT 


  
Type


  
Integer 


  
Description


  
The remaining number of copies to be produced for this spooled file.
  
















Corner Staple





  
ID


  
ATTR_CORNER_STAPLE


  
Type


  
String 


  
Description


  
The reference corner to be used for a corner staple. A staple is
driven into the media at the reference corner. Valid values are *NONE,
*DEVD, *BOTRIGHT, *TOPRIGHT, *TOPLEFT, and *BOTLEFT.
















Current Page





  
ID


  
ATTR_CURPAGE 


  
Type


  
Integer 


  
Description


  
Current page that is being written by the writer job. 
















Data Format





  
ID


  
ATTR_DATAFORMAT 


  
Type


  
String 


  
Description


  
Data format. Valid values are *RCDDATA, *ALLDATA. 
















Data Queue





  
ID


  
ATTR_DATA_QUEUE 


  
Type


  
String 


  
Description


  
Specifies the Integrated File System path of the data queue that is associated with the output
queue or "*NONE" if no data queue is associated with the the output queue.  The
format of the Integrated File System path is "/QSYS.LIB/library.LIB/dataqueue.DTAQ" where library
is the library that contains the data queue and dataqueue is the name of
the data queue.
  
















Date File Last Used





  
ID


  
ATTR_DATE_USED


  
Type


  
String 


  
Description


  
The date the spooled file data was last displayed, copied, 
printed or sent; or when the spooled file attributes were last
changed.
The date format is CYYMMDD, where C=century (0=19XX, 1=20XX),
YY=year, MM=month, and DD=day.
















Date File Opened (created)





  
ID


  
ATTR_DATE 


  
Type


  
String 


  
Description


  
For spooled files this is the date the spooled file was opened.
For AFP resources this is the date the object was last modified.
The date format is CYYMMDD, where C=century (0=19XX, 1=20XX),
YY=year, MM=month, and DD=day.
















Date Writer Began Processing Spooled File





  
ID


  
ATTR_DATE_WTR_BEGAN_FILE 


  
Type


  
String 


  
Description


  
Indicates the date at which the writer began processing this spooled file.
    The date format is CYYMMDD, where C=century (0=19XX, 1=20XX),
    YY=year, MM=month, and DD=day.
  
















Date Writer Completed Processing Spooled File





  
ID


  
ATTR_DATE_WTR_CMPL_FILE 


  
Type


  
String 


  
Description


  
Indicates the date at which the writer finished this spooled file.
    The date format is CYYMMDD, where C=century (0=19XX, 1=20XX),
    YY=year, MM=month, and DD=day.
  
















User Specified DBCS Data





  
ID


  
ATTR_DBCSDATA 


  
Type


  
String 


  
Description


  
Whether the spooled file contains double-byte character set (DBCS)
    data. Valid values are *NO and *YES.
  
















DBCS Extension Characters





  
ID


  
ATTR_DBCSEXTENSN 


  
Type


  
String 


  
Description


  
Whether the system is to process the DBCS extension characters. Valid
    values are *NO and *YES. 
  
















DBCS Character Rotation





  
ID


  
ATTR_DBCSROTATE


  
Type


  
String


  
Description


  
Whether the DBCS characters are rotated 90 degrees counterclockwise
    before printing. Valid values are *NO and *YES.
  
















DBCS Characters Per Inch





  
ID


  
ATTR_DBCSCPI 


  
Type


  
Integer 


  
Description


  
The number of double-byte characters to be printed per inch. Valid
    values are -1, -2, 5, 6, and 10. The value *CPI is encoded as -1. The value
    *CONDENSED is encoded as -2.
  

















DBCS Coded Font Library Name





  
ID


  
ATTR_DBCS_FNT_LIB


  
Type


  
String


  
Description


  
The name of the library containing the DBCS coded font.  Valid values 
    are *CURLIB, *LIBL, and a specific library name.
  
















DBCS Coded Font Name





  
ID


  
ATTR_DBCS_FNT


  
Type


  
String


  
Description


  
The name of the DBCS coded font used to print DBCS coded 
    data on printers configured as AFP(*YES).  Valid values are
    *SYSVAL or a specific DBCS coded font.
  
















DBCS Coded Font Point Size





  
ID


  
ATTR_DBCS_FNT_SIZE


  
Type


  
Float


  
Description


  
The point size in which to print the spooled file's character data.
    Valid values are from 000.1 to 999.0.  Value 000.0 represents *NONE,
    the DBCS coded font does not have a point size.
  
















DBCS SO/SI Spacing





  
ID


  
ATTR_DBCSSISO 


  
Type


  
String 


  
Description


  
Determines the presentation of shift-out and shift-in characters when
    printed. Valid values are *NO, *YES, and *RIGHT.
  
















DDS (Data description specifications)





  
ID


  
ATTR_DDS


  
Type


  
String (one character)


  
Description


  
Whether the spooled file was created with data description 
    specifications (DDS).  Valid values are Y (yes) or N (no).
  
















Decimal Format





  
ID


  
ATTR_DECIMAL_FMT


  
Type


  
String


  
Description


  
Whether the decimal format from the DECFMT job attribute or 
    from the printer file was used when the spooled file was
    created.  Valid values are *FILE or *JOB.
  
















Defer Write





  
ID


  
ATTR_DFR_WRITE 


  
Type


  
String 


  
Description


  
Whether print data is held in system buffers before 
















Double Wide Characters





  
ID


  
ATTR_DOUBLEWIDE


  
Type


  
String (one character)


  
Description


  
For SCS spooled files, whether the characters are printed 
    twice as wide as normal.  Valid values are Y (yes) or N (no).
  
















Drawer Change





  
ID


  
ATTR_DRAWERCHANGE


  
Type


  
String (one character)


  
Description


  
Whether the printer drawer is changed within the spooled
    file.  Valid values are Y (yes) or N (no).
  
















Degree of Page Rotation





  
ID


  
ATTR_PAGRTT 


  
Type


  
Integer 


  
Description


  
The degree of rotation of the text on the page, with respect to the
way the form is loaded into the printer. Valid values are -1, -2, -3, 0,
90, 180, 270. The value *AUTO is encoded as -1, the value *DEVD is encoded
as -2, and the value *COR is encoded as -3. 
















Delete File After Sending





  
ID


  
ATTR_DELETESPLF 


  
Type


  
String 


  
Description


  
Delete the spooled file after sending? Valid values are *NO and *YES.
  
















Destination Option





  
ID


  
ATTR_DESTOPTION 


  
Type


  
String 


  
Description


  
Destination option. A text string that allows the user to pass options
to the receiving system. 
















Destination Type





  
ID


  
ATTR_DESTINATION 


  
Type


  
String 


  
Description


  
Destination type. Valid values are *OTHER, *AS400, *PSF2. 
















Device Class





  
ID


  
ATTR_DEVCLASS 


  
Type


  
String 


  
Description


  
The device class. 
















Device Model





  
ID


  
ATTR_DEVMODEL 


  
Type


  
String 


  
Description


  
The model number of the device. 
















Device Status





  
ID


  
ATTR_DEVSTATUS 


  
Type


  
Integer 


  
Description


  
The status of the printer device. Valid values are 0 (varied
off), 10 (vary off pending), 20 (vary on pending), 30 (varied on), 40
(connect pending), 60 (active), 66 (active writer), 70 (held), 75
(powered off), 80 (recovery pending), 90 (recovery canceled), 100
(failed), 106 (failed writer), 110 (being serviced), 111 (damaged), 112
(locked), 113 (unknown). 
















Device Type





  
ID


  
ATTR_DEVTYPE 


  
Type


  
String 


  
Description


  
Specifies the type of printer configured in the device 
description (Printer object). Valid values are 3287, 3812,
4214, 4234, 4245, 4247, 5219, 5224, 5225, 5256, 5262,
5553, 5583, 6252, 6404, 6408, 6412, *IPDS.
















Display any File





  
ID


  
ATTR_DISPLAYANY 


  
Type


  
String 


  
Description


  
Whether users who have authority to read this output queue can display
the output data of any output file on this queue or only the data in their
own files. Valid values are *YES, *NO, *OWNER. 
















Days Until File Expires





  
ID


  
ATTR_DAYS_UNTIL_EXPIRE


  
Type


  
Integer


  
Description


  
Specifies the number of days to keep the spooled file.
















Drawer for Separators





  
ID


  
ATTR_DRWRSEP 


  
Type


  
Integer 


  
Description


  
Identifies the drawer from which the job and file separator pages are
to be taken. Valid values are -1, -2, 1, 2, 3. The value *FILE is encoded
as -1, and the value *DEVD is encoded as -2. 
















Edge Stitch Number of Staples





  
ID


  
ATTR_EDGESTITCH_NUMSTAPLES 


  
Type


  
Integer 


  
Description


  
The number of staples that are applied along the finishing operation axis. 
















Edge Stitch Reference Edge





  
ID


  
ATTR_EDGESTITCH_REF 


  
Type


  
String 


  
Description


  
Where one or more staples are driven into the media along the
finishing operation axis. Valid values are *NONE, *DEVD, *BOTTOM,
*RIGHT, *TOP, and *LEFT. 
















Edge Stitch Reference Offset





  
ID


  
ATTR_EDGESTITCH_REFOFF 


  
Type


  
Float 


  
Description


  
The offset of the edge stitch from the reference edge toward the center of the media. 
















End Pending Status





  
ID


  
ATTR_ENDPNDSTS 


  
Type


  
String 


  
Description


  
Whether an End Writer (ENDWTR) command has been issued for this writer.  Possible
values are *NO - no ENDWTR command was issued, *IMMED - the writer ends as soon as its
output buffers are empty, *CTRLD - the writer ends after the current copy of the spooled
file has printed, *PAGEEND - the writer ends at the end of the page. 
















Ending Page





  
ID


  
ATTR_ENDPAGE 


  
Type


  
Integer 


  
Description


  
The page number at which to end printing the spooled file. Valid values
are 0 or the ending page number. The value *END is encoded as 0. 
















Envelope Source





  
ID


  
ATTR_ENVLP_SOURCE 


  
Type


  
String 


  
Description


  
The size of the envelope in the envelope source.  If this field
is not specified or the value is not valid, the special value of *MFRTYPMDL
is used.  Valid values are *NONE - there is no envelope source, 
*MFRTYPMDL - the envelope size suggested by the manufacturer type
and model is used, *MONARCH (3.875 x 7.5 inches), *NUMBER9 (3.875 x 8.875 inches),
*NUMBER10 (4.125 x 9.5 inches), *B5 (176mm x 250mm),
*C5 (162mm x 229mm), *DL (110mm x 220mm). 
















Expiration Date





  
ID


  
ATTR_EXPIRATION_DATE


  
Type


  
String


  
Description


  
The date the spooled file will be eligible for removal from the system 
by the Delete Expired Spooled Files (DLTEXPSPLF) command.  If this value is
blank the file will not expire.  The spooled file expires at 23:59:59,
system local time on the date specified.  The date format is CYYMMDD,
where C=century (0=19XX, 1=20XX), YY=year, MM=month, and DD=day.
















Field Outlining





  
ID


  
ATTR_FIELD_OUTLIN


  
Type


  
String (one character)


  
Description


  
Whether the spooled file outlines fields of data with
boxes.  Valid values are Y (yes) or N (no).

















File Separators





  
ID


  
ATTR_FILESEP 


  
Type


  
Integer 


  
Description


  
The number of file separator pages that are placed at the beginning
of each copy of the spooled file. Valid values are -1, or the number of
separators. The value *FILE is encoded as -1. 
















Fold Records





  
ID


  
ATTR_FOLDREC 


  
Type


  
String 


  
Description


  
Whether records that exceed the printer forms width are folded (wrapped)
to the next line. Valid values are *YES, *NO. 
















Font Changes





  
ID


  
ATTR_FONT_CHANGES


  
Type


  
String (one character)


  
Description


  
Whether the spooled file uses multiple fonts.  Valid 
values are Y (yes) or N (no).
















Font Identifier





  
ID


  
ATTR_FONTID


  
Type


  
String 


  
Description


  
The printer font that is used. Valid special values include *CPI and
*DEVD. 
















Font Resolution for Formatting





  
ID


  
ATTR_FONTRESFMT


  
Type


  
String


  
Description


  
The font resolution Print Services Facility (PSF) should
try to use when printing the spooled file.  Valid values are
*DEVD, *SEARCH, 240, or 300.
















Form Definition





  
ID


  
ATTR_FORM_DEFINITION


  
Type


  
String 


  
Description


  
The Integrated File System path name of the form definition or a special value.
    If an Integrated File System path is specified the format is "/QSYS.LIB/library.LIB/formdef.FORMDF"
    where library is the library of the form definition and
    formdef is the name of the form definition.
    Valid special values include *NONE, *INLINE, *INLINED, and *DEVD.
  
















Form Feed





  
ID


  
ATTR_FORMFEED 


  
Type


  
String 


  
Description


  
The manner in which forms feed to the printer. Valid values are *CONT,
*CUT, *AUTOCUT, *DEVD. 
















Form Type





  
ID


  
ATTR_FORMTYPE 


  
Type


  
String 


  
Description


  
The type of form to be loaded in the printer to print this spooled
file. 
















Form Type Message Option





  
ID


  
ATTR_FORMTYPEMSG 


  
Type


  
String 


  
Description


  
Message option for sending a message to the writer's message queue
when the current form type is finished. Valid values are *MSG, *NOMSG,
*INFOMSG, *INQMSG. 
















Front Margin Offset Across





  
ID


  
ATTR_FTMGN_ACR 


  
Type


  
Float 


  
Description


  
For the front side of a piece of paper, it specifies, how far in from
the left side of the page printing starts. The special value *DEVD is encoded
as -2.0. 
















Front Margin Offset Down





  
ID


  
ATTR_FTMGN_DWN 


  
Type


  
Float 


  
Description


  
For the front side of a piece of paper, it specifies, how far down
from the top of the page printing starts. The special value *DEVD is encoded
as -2. 

















Front Overlay






  
ID



  
ATTR_FRONT_OVERLAY 



  
Type



  
String 



  
Description



  
The Integrated File System path of the front overlay.  The format of the Integrated File System path is
    "/QSYS.LIB/library.LIB/overlay.OVL" where
    library is the library of the resource and overlay is the
    name of the overlay.
    The string *NONE is used to indicate that no front overlay is specified.
  
















Front Overlay Offset Across





  
ID


  
ATTR_FTOVL_ACR 


  
Type


  
Float 


  
Description


  
The offset across from the point of origin where the overlay is printed.
  
















Front Overlay Offset Down





  
ID


  
ATTR_FTOVL_DWN 


  
Type


  
Float 


  
Description


  
The offset down from the point of origin where the overlay is printed.
  
















Graphic Character Set





  
ID


  
ATTR_CHAR_ID 


  
Type


  
String 


  
Description


  
The set of graphic characters to be used when printing this file. Valid
special values include *DEVD, *SYSVAL, and *JOBCCSID. 
















Graphics





  
ID


  
ATTR_GRAPHICS


  
Type


  
String (one character)


  
Description


  
Whether the spooled file contains graphics.  Valid
values are Y (yes) or N (no).
















Graphics Token





  
ID


  
ATTR_GRAPHICS_TOK


  
Type


  
String


  
Description


  
The printer type on which graphics in the spooled file can be
printed.  Valid values are 4214, 4234, 522X, or IPDS.
















Group Level Index Tags





  
ID


  
ATTR_GRPLVL_IDXTAG


  
Type


  
String (One character)


  
Description


  
Whether the spooled file contains group level index tags as 
indicated by the DDS keyword DOCIDXTAG with a tag level of GROUP.
Valid values are Y (yes) or N (no).
















Justification





  
ID


  
ATTR_JUSTIFY 


  
Type


  
Integer 


  
Description


  
The percentage that the output is right justified. Valid values are
0, 50, 100. 
















Held Status





  
ID


  
ATTR_HELDSTS 


  
Type


  
String 


  
Description


  
Whether the writer is held. Valid values are *YES, *NO. 
















Highlight





  
ID


  
ATTR_HIGHLIGHT


  
Type


  
String (one character)


  
Description


  
Whether the spooled file contains character data that is
to appear darker than the surrounding character data.  Valid
values are Y (yes) or N (no).
















Hold Spool File





  
ID


  
ATTR_HOLD 


  
Type


  
String 


  
Description


  
Whether the spooled file is held. Valid values are *YES, *NO. 
















Hold Pending Status





  
ID


  
ATTR_HOLDPNDSTS 


  
Type


  
String 


  
Description


  
Whether a Hold Writer (HLDWTR) command has been issued for this writer.  Possible values
are *NO - no HLDWTR command was issued, *IMMED - the writer is held when its output buffers
are empty, *CTRLD - writer held after the current copy of the spooled file has printed,
*PAGEEND - writer held at the end of the page.
















Image Configuration





  
ID


  
ATTR_IMGCFG


  
Type


  
String


  
Description


  
The transform services for a variety of image and print data-stream formats.















Initialize the Writer





  
ID


  
ATTR_WTRINIT 


  
Type


  
String 


  
Description


  
The user can specify when to initialize the printer device. Valid values
are *WTR, *FIRST, *ALL. 
















Internet Address





  
ID


  
ATTR_INTERNETADDR 


  
Type


  
String 


  
Description


  
The internet address of the receiving system. 
















IPDS Pass-Through





  
ID


  
ATTR_IPDSPASSTHRU


  
Type


  
String (one character)


  
Description


  
Specifies whether IPDS pass-through is done for the spooled file.
    Valid values are 0 (*DEVD), 1 (*NO), or 2 (*YES).
  
















IPP Attributes CCSID





  
ID


  
ATTR_IPP_ATTR_CCSID


  
Type


  
Integer


  
Description


  
Indicates the CCSID of the IPP specified spooled file attributes.
















IPP Attributes Natural Language





  
ID


  
ATTR_IPP_ATTR_NL


  
Type


  
String


  
Description


  
Indicates the natural language of the IPP specified spooled
    file attributes. For example 'en' English or 'fr' French.
  
















IPP Job ID





  
ID


  
ATTR_IPP_JOB_ID 


  
Type


  
Integer 


  
Description


  
IPP Job ID relative to the IPP printer that created the job. 
















IPP Job Name





  
ID


  
ATTR_IPP_JOB_NAME


  
Type


  
String 


  
Description


  
User friendly name of job. 
















IPP Job Name NL





  
ID


  
ATTR_IPP_JOB_NAME_NL


  
Type


  
String 


  
Description


  
Natural language of job name. 

















IPP Job Originating User Name





  
ID


  
ATTR_IPP_JOB_ORIGUSER 


  
Type


  
String 


  
Description


  
Identifies the end user that submitted this IPP job. 
















IPP Job Originating User Name NL





  
ID


  
ATTR_IPP_JOB_ORIGUSER_NL 


  
Type


  
String 


  
Description


  
Identifies the natural language of job-originating user name. 
















IPP Printer Name





  
ID


  
ATTR_IPP_PRINTER_NAME 


  
Type


  
String 


  
Description


  
Identifies the IPP printer that created this job. 
















Job CCSID





  
ID


  
ATTR_JOBCCSID 


  
Type


  
Integer


  
Description


  
The CCSID of the job that created the spooled file. 
















Job Name





  
ID


  
ATTR_JOBNAME 


  
Type


  
String 


  
Description


  
The name of the job that created the spooled file. 

















Job Number






  
ID



  
ATTR_JOBNUMBER 



  
Type



  
String 



  
Description



  
The number of the job that created the spooled file. 

















Job Separators






  
ID



  
ATTR_JOBSEPRATR 



  
Type



  
Integer 



  
Description



  
The number of job separators to be placed at the beginning of the output
for each job having spooled files on this output queue. Valid values are
-2, 0-9. The value *MSG is encoded as -2. Job separators are specified
when the output queue is created. 


















Job System Name





  
ID


  
ATTR_JOBSYSTEM


  
Type


  
String


  
Description


  
The name of the system that ran the job that created the 
spooled file.














Job User





  
ID


  
ATTR_JOBUSER 


  
Type


  
String 


  
Description


  
The name of the user that created the spooled file. 
















Last Page Printed





  
ID


  
ATTR_LASTPAGE 


  
Type


  
Integer 


  
Description


  
The number of the last printed page is the file if printing ended before
    the job completed processing.
  
















Length of Page





  
ID


  
ATTR_PAGELEN 


  
Type


  
Float 


  
Description


  
The length of a page. Units of measurement are specified in the measurement
    method attribute. 
















Library Name





  
ID


  
ATTR_LIBRARY 


  
Type


  
String 


  
Description


  
The name of the library. 
















Line Spacing





  
ID


  
ATTR_LINESPACING 


  
Type


  
String 


  
Description


  
How a file's line data records are spaced when printed. The
information is returned only for *LINE and *AFPDSLINE printer device
types files. Valid values are *SINGLE, *DOUBLE, *TRIPLE, or *CTLCHAR. 
















Lines Per Inch





  
ID


  
ATTR_LPI 


  
Type


  
Float 


  
Description


  
The number of lines per vertical inch in the spooled file. 
















Lines Per Inch Changes





  
ID


  
ATTR_LPI_CHANGES


  
Type


  
String (one character)


  
Description


  
Whether the lines per inch (lpi) changes within the spooled 
file.  Valid values are Y(yes) or N (no).
















Manufacturer Type and Model





  
ID


  
ATTR_MFGTYPE 


  
Type


  
String 


  
Description


  
Specifies the manufacturer, type, and model when transforming print
data from SCS to ASCII. 
















Maximum Jobs per Client List





  
ID


  
ATTR_MAX_JOBS_PER_CLIENT 


  
Type


  
Integer 


  
Description


  
Supplied by the client to indicate the maximum printer queue size of limitation. 
















Maximum Records





  
ID


  
ATTR_MAXRCDS


  
Type


  
Integer 


  
Description


  
The maximum number of records allowed in this file at the time this
file was opened. The value *NOMAX is encoded as 0. 
















Measurement Method





  
ID


  
ATTR_MEASMETHOD 


  
Type


  
String 


  
Description


  
The measurement method that is used for the length of page and width
of page attributes. Valid values are *ROWCOL, *UOM. 
















Message Queue





  
ID


  
ATTR_MESSAGE_QUEUE 


  
Type


  
String 


  
Description


  
The Integrated File System path of the message queue that the writer uses for operational
messages.  The format of the Integrated File System path is "/QSYS.LIB/library.LIB/messageque.MSGQ"
where library is the library that contains the message queue and
    messageque is the name of the message queue.
  

















Message Help






  
ID



  
ATTR_MSGHELP 



  
Type



  
char(*) 



  
Description



  
The message help, which is sometimes known as second-level text, can
be returned by a "retrieve message" request. The system limits
the length to 3000 characters (English version must be 30% less to allow
for translation). 
















Message ID





  
ID


  
ATTR_MSGID 


  
Type


  
String 


  
Description


  
The message ID. 

















Message Reply






  
ID



  
ATTR_MSGREPLY 



  
Type



  
String



  
Description



  
The message reply. Text string to be provided by the client which answers
a message of type "inquiry". In the case of message retrieved,
the attribute value is returned by the server and contains the default
reply which the client can use. The system limits the length to 132 characters.
Should be null-terminated due to variable length. 

















Message Text






  
ID



  
ATTR_MSGTEXT 



  
Type



  
String



  
Description



  
The message text, that is sometimes known as first-level text, can
be returned by a "retrieve message" request. The system limits
the length to 132 characters. 

















Message Type






  
ID



  
ATTR_MSGTYPE 



  
Type



  
String 



  
Description



  
The message type, a 2-digit, EBCDIC encoding. Two types of messages
indicate whether one can "answer" a "retrieved" message:
'04' Informational messages convey information without asking for a reply
(may require a corrective action instead), '05' Inquiry messages convey
information and ask for a reply. 

















Message Severity






  
ID



  
ATTR_MSGSEV 



  
Type



  
Integer 



  
Description



  
Message severity. Values range from 00 to 99. The higher the value,
the more severe or important the condition. 

















Multi-item Reply Capability






  
ID



  
ATTR_MULTI_ITEM_REPLY 



  
Type



  
String 



  
Description



  
When this attribute value is set to *YES by the client, the
performance of list spooled file operations can be greatly improved.
The default value is *NO.
















Network Identifier






  
ID



  
ATTR_NETWORK 



  
Type



  
String 



  
Description



  
The network identifier of the system where the file was created. 

















Number of Bytes in Spooled File






  
ID



  
ATTR_NUMBYTES_SPLF 



  
Type



  
Integer 



  
Description



  
The total number of bytes available in the stream or spooled file.  
The value indicates the number of bytes BEFORE any transform of the data takes place.
In order to accommodate files of sizes greater than 2**31 - 1 bytes, this value 
is scaled; the user needs to multiply the value by 10K to get the actual number of bytes.
This attribute is not valid for spooled files being viewed in page-at-a-time mode. 

















Number of Bytes to Read/Write






  
ID



  
ATTR_NUMBYTES 



  
Type



  
Integer 



  
Description



  
The number of bytes to read for a read operation, or the number of
bytes to write for a write operation. The object action determines how
to interpret this attribute. 

















Number of Files






  
ID



  
ATTR_NUMFILES 



  
Type



  
Integer 



  
Description



  
The number of spooled files that exist on the output queue. 

















Number of Writers Started to Queue






  
ID



  
ATTR_NUMWRITERS 



  
Type



  
Integer 



  
Description



  
The number of writer jobs started to the output queue. 
















Object Extended Attribute





  
ID


  
ATTR_OBJEXTATTR 


  
Type


  
String 


  
Description


  
An "extended" attribute used by some objects like font resources.
    This value shows up via WRKOBJ and DSPOBJD commands on the server. The
    title on a server screen may just indicate "Attribute". In the
    case of object types of font resources, for example, common values are
    CDEPAG, CDEFNT, and FNTCHRSET.
  
















OfficeVision





  
ID


  
ATTR_OFFICEVISION


  
Type


  
String (one character)


  
Description


  
Specifies whether the spooled file was generated by the 
    OfficeVision licensed program. Valid values are Y (yes) or N (no).
  
















On Job Queue Status





  
ID


  
ATTR_ONJOBQSTS 


  
Type


  
String 


  
Description


  
Whether the writer is on a job queue and therefore is not currently
    running. The possible values are *YES, *NO.
  
















Open Time Commands





  
ID


  
ATTR_OPENCMDS 


  
Type


  
String 


  
Description


  
Specifies whether user wants SCS open time commands to be inserted
    into datastream prior to spool file data. Valid values are *YES, *NO. 
  

















Operator Controlled






  
ID



  
ATTR_OPCNTRL 



  
Type



  
String 



  
Description



  
Whether users with job control authority are allowed to manage or control
the spooled files on this queue. Valid values are *YES, *NO. 
















Order of Files on Queue





  
ID


  
ATTR_ORDER 


  
Type


  
String 


  
Description


  
The order of spooled files on this output queue.
    Valid values are *FIFO, *JOBNBR.
  
















OS/400 Created AFPDS





  
ID


  
ATTR_OS4_CRT_AFP


  
Type


  
String (one character)


  
Description


  
Specifies whether the spooled file was created by i5/OS using
    a printer file with the device type (DEVTYPE) parameter value
    set to *AFPDS. Valid values are Y (yes) or N (no).
  

















Output Bin





  
ID


  
ATTR_OUTPUTBIN 


  
Type


  
Integer 


  
Description


  
The output bin the printer uses for the printed output.
    Values range from 1 to 65535.  The value *DEVD is encoded as 0.
  
















Output Priority





  
ID


  
ATTR_OUTPTY 


  
Type


  
String 


  
Description


  
The priority of the spooled file. The priority ranges from 1 (highest)
    to 9 (lowest). Valid values are 0-9, where 0 represents *JOB.
  

















Output Queue






  
ID



  
ATTR_OUTPUT_QUEUE 



  
Type



  
String 



  
Description



  
The Integrated File System path of the output queue.  The format of the Integrated File System path is
    "/QSYS.LIB/library.LIB/queue.OUTQ" where library is the library
    that contains the output queue and queue is the name of the
    output queue.
  
















Output Queue Status





  
ID


  
ATTR_OUTQSTS 


  
Type


  
String 


  
Description


  
The status of the output queue. Valid values are RELEASED, HELD. 
















Overall Status





  
ID


  
ATTR_OVERALLSTS 


  
Type


  
Integer 


  
Description


  
The overall status of the "logical printer". "Logical printer"
refers to printer device, output queue and writer job. Valid values are
1 (unavailable), 2 (powered off or not yet available), 3 (stopped), 4
(message waiting), 5 (held), 6 (stop pending), 7 (hold pending), 8
(waiting for printer), 9 (waiting to start), 10 (printing), 11 (waiting
for output queue), 12 (connect pending), 13 (powered off), 14
(unusable), 15 (being serviced), 999 (unknown). 
















Overflow Line Number





  
ID


  
ATTR_OVERFLOW 


  
Type


  
Integer 


  
Description


  
The last line to be printed before the data that is being printed overflows
to the next page. 
















Page At A Time





  
ID


  
ATTR_PAGE_AT_A_TIME 


  
Type


  
String 


  
Description


  
Specifies whether the spooled file is to be opened in page-at-a-time mode.
Valid values are *YES and *NO.
















Page Count Estimated





  
ID


  
ATTR_PAGES_EST 


  
Type


  
String 


  
Description


  
Specifies whether the page count is estimated rather than actual.  Valid
values are *YES and *NO.
















Page Definition





  
ID


  
ATTR_PAGE_DEFINITION 


  
Type


  
String 


  
Description


  
The Integrated File System path name of the page definition or a special value.
If an Integrated File System path is specified the format is "/QSYS.LIB/library.LIB/pagedef.PAGDFN"
where library is the library of the page definition and pagedef is
the name of the page definition. Valid special values include *NONE.
















Page Groups





  
ID


  
ATTR_PAGE_GROUPS


  
Type


  
String (one character)


  
Description


  
Whether the spooled file contains page groups as indicated by
the DDS keyword STRPAGGRP and ENDPAGGRP.  Valid values are 
Y (yes) or N (no).
















Page Level Index Tags





  
ID


  
ATTR_PAGELVLIDXTAG


  
Type


  
String (one character)


  
Description


  
Whether the spooled file contains page level index tags as indicated by
the DDS keyword DOCIDXTAG with a tag level of PAGE.  Valid values are 
Y (yes) or N (no).
















Page Number





  
ID


  
ATTR_PAGENUMBER 


  
Type


  
Integer 


  
Description


  
The number of the page to be read from a spooled file opened in page-at-a-time mode.
















Pages Per Side





  
ID


  
ATTR_MULTIUP 


  
Type


  
Integer 


  
Description


  
The number of logical pages that print on each side of each physical
page when the file is printed. Valid values are 1, 2, 4. 
















Page Rotate





  
ID


  
ATTR_PAGE_ROTATE


  
Type


  
String (one character)


  
Description


  
Whether the page rotation is changed within the spooled 
file.  Valid values are Y (yes) or N (no).
















Paper Source 1





  
ID


  
ATTR_PAPER_SOURCE_1 


  
Type


  
String 


  
Description


  
The size of the paper in paper source one. If this field
is not specified or the value is not valid, the special value of *MFRTYPMDL
is used.  Valid values are *NONE - there is no paper source one or the 
paper is manually fed into the printer, 
*MFRTYPMDL - the paper size suggested by the manufacturer type
and model is used, *LETTER (8.5 x 11.0 inches), *LEGAL (8.5 x 14.0 inches),
*EXECUTIVE (7.25 x 10.5 inches), *LEDGER (17.0 x 11.0 inches),
*A3 (297mm x 420mm), *A4 (210mm x 297mm), *A5 (148mm x 210mm),
*B4 (257mm x 364mm), *B5 (182mm x 257mm), *CONT80 (8.0 inches wide with
continuous form), *CONT132 (13.2 inches wide with continuous form). 
















Paper Source 2





  
ID


  
ATTR_PAPER_SOURCE_2 


  
Type


  
String 


  
Description


  
The size of the paper in paper source two. If this field
is not specified or the value is not valid, the special value of *MFRTYPMDL
is used.  Valid values are *NONE - there is no paper source two or the 
paper is manually fed into the printer, 
*MFRTYPMDL - the paper size suggested by the manufacturer type
and model is used, *LETTER (8.5 x 11.0 inches), *LEGAL (8.5 x 14.0 inches),
*EXECUTIVE (7.25 x 10.5 inches), *LEDGER (17.0 x 11.0 inches),
*A3 (297mm x 420mm), *A4 (210mm x 297mm), *A5 (148mm x 210mm),
*B4 (257mm x 364mm), *B5 (182mm x 257mm), *CONT80 (8.0 inches wide with
continuous form), *CONT132 (13.2 inches wide with continuous form). 
















Pel Density





  
ID


  
ATTR_PELDENSITY 


  
Type


  
String 


  
Description


  
For font resources only, this value is an encoding of the number of
pels ("1" represents a pel size of 240, "2" represents
a pel size of 320). Additional values may become meaningful as the server defines them. 
















Point Size





  
ID


  
ATTR_POINTSIZE


  
Type


  
Float


  
Description


  
The point size in which this spooled file's text is printed. The special
    value *NONE is encoded as 0.
  
















Print Fidelity





  
ID


  
ATTR_FIDELITY 


  
Type


  
String 


  
Description


  
The kind of error handling that is performed when printing. Valid values
are *ABSOLUTE, *CONTENT. 
















Print on Both Sides





  
ID


  
ATTR_DUPLEX 


  
Type


  
String 


  
Description


  
How the information prints. Valid values are *FORMDF, *NO, *YES, *TUMBLE.
  
















Print Quality





  
ID


  
ATTR_PRTQUALITY 


  
Type


  
String 


  
Description


  
The print quality that is used when printing this spooled file. Valid
values are *STD, *DRAFT, *NLQ, *FASTDRAFT. 
















Print Sequence





  
ID


  
ATTR_PRTSEQUENCE 


  
Type


  
String 


  
Description


  
Print sequence. Valid values are *NEXT. 
















Print Text





  
ID


  
ATTR_PRTTEXT 


  
Type


  
String 


  
Description


  
The text that is printed at the bottom of each page of printed output
and on separator pages. Valid special values include *BLANK and *JOB. 

















Printer






  
ID



  
ATTR_PRINTER 



  
Type



  
String 



  
Description



  
The name of the printer device. 
















Printer Assigned





  
ID


  
ATTR_PRTASSIGNED 


  
Type


  
String 


  
Description


  
Indicates if the printer is assigned. Valid values are 1
(assigned to a specific printer), 2 (assigned to multiple printers), 3
(not assigned). 
















Printer Device Type





  
ID


  
ATTR_PRTDEVTYPE 


  
Type


  
String 


  
Description


  
The printer data stream type. Valid values are *SCS, *IPDS, *USERASCII,
    *AFPDS, *LINE. 
  
















Printer File





  
ID


  
ATTR_PRINTER_FILE


  
Type


  
String 


  
Description


  
The Integrated File System path of the printer file.  The format of the Integrated File System path is
    "/QSYS.LIB/library.LIB/printerfile.FILE" where library is the library
    that contains the printer file and printerfile is the name of
    the printer file.
  
















Printer Queue





  
ID


  
ATTR_RMTPRTQ 


  
Type


  
String 


  
Description


  
The name of the destination printer queue when sending spooled files
    via SNDTCPSPLF (LPR).
  
















Program That Opened File Library Name





  
ID


  
ATTR_PGM_OPN_LIB


  
Type


  
String 


  
Description


  
The name of the library that contains the program that opened
    the spooled file.
  
















Program That Opened File Name





  
ID


  
ATTR_PGM_OPN_FILE


  
Type


  
String 


  
Description


  
The name of the program that opened the spooled file.
















Published Printer





  
ID


  
ATTR_PUBINF


  
Type


  
String


  
Description


  
Indicates if the printer information has been published
    in the LDAP directory.  Valid values are *YES or *NO.
  
















Publishing Info Color Supported





  
ID


  
ATTR_PUBINF_COLOR_SUP


  
Type


  
String


  
Description


  
Indicates color is supported for this publishing list entry.
















Publishing Info Pages per Minute (Color)





  
ID


  
ATTR_PUBINF_PPM_COLOR


  
Type


  
Integer


  
Description


  
The pages per minute supported in color mode for this publishing list entry.
















Publishing Info Pages per Minute (Monochrome)





  
ID


  
ATTR_PUBINF_PPM


  
Type


  
Integer


  
Description


  
The pages per minute supported in monochrome for this publishing list entry.
















Publishing Info Duplex Support





  
ID


  
ATTR_PUBINF_DUPLEX_SUP


  
Type


  
String


  
Description


  
The duplex supported indicator for this publishing list entry.
















Publishing Info Location





  
ID


  
ATTR_PUBINF_LOCATION


  
Type


  
String


  
Description


  
The location description for this publishing list entry.
















Record Format Name Present in Data Stream





  
ID


  
ATTR_RCDFMT_DATA


  
Type


  
String (one character)


  
Description


  
A record format name exists in columns 1-10 of a line data record
    or columns 2-11 if the spooled file contains control characters.
    Valid values are Y (yes) or N (no).
  
















Record Length





  
ID


  
ATTR_RECLENGTH 


  
Type


  
Integer 


  
Description


  
Record length. 
















Reduce Output





  
ID


  
ATTR_REDUCE 


  
Type


  
String 


  
Description


  
The manner in which multiple logical pages print on each side of a physical page.  Valid values *TEXT or ????. 
















Remote Location Name





  
ID


  
ATTR_RMTLOCNAME


  
Type


  
String


  
Description


  
The printer device location name.
















Remote System Name





  
ID


  
ATTR_RMTSYSTEM 


  
Type


  
String 


  
Description


  
Remote system name. Valid special values include *INTNETADR. 
















Replace Unprintable Characters





  
ID


  
ATTR_RPLUNPRT 


  
Type


  
String 


  
Description


  
Whether characters that cannot be printed are to be replaced with another
character. Valid values are *YES or *NO. 
















Replacement Character





  
ID


  
ATTR_RPLCHAR 


  
Type


  
String 


  
Description


  
The character that replaces any unprintable characters.
















Resource library list





  
ID


  
ATTR_RSC_LIB_LIST


  
Type


  
todo


  
Description


  
todo attr_rsc_lib_list
















Restart Printing





  
ID


  
ATTR_RESTART 


  
Type


  
Integer 


  
Description


  
Restart printing. Valid values are -1, -2, -3, or the page number to
restart at. The value *STRPAGE is encoded as -1, the value *ENDPAGE is
encoded as -2, and the value *NEXT is encoded as -3. 
















Saddle Stitch Number of Staples





  
ID


  
ATTR_SADDLESTITCH_NUMSTAPLES 


  
Type


  
Integer 


  
Description


  
The number of staples that are to be applied along the finishing operation axis. 
















Saddle Stitch Reference Edge





  
ID


  
ATTR_SADDLESTITCH_REF 


  
Type


  
String 


  
Description


  
One or more staples are driven into the media along the finishing
operation axis, which is positioned at the center of the media parallel
to the reference edge. Valid values are *NONE, *DEVD, *TOP, and *LEFT. 
















Save File





  
ID


  
ATTR_SAVE_FILE


  
Type


  
String


  
Description


  
The Integrated File System path of the save file that contains the
    saved spooled file.  The format of the Integrated File System path is
    "/QSYS.LIB/library.LIB/savefile.SAVF" where library is the library
    that contains the save file and savefile is the name of
    the save file.  The value is blank if the spooled file was not saved
    to a save file.
  
















Save Spooled File After Written





  
ID


  
ATTR_SAVE


  
Type


  
String 


  
Description


  
Whether the spooled file is kept on the output queue after it is written.
Valid values are *YES, *NO, or *IMMED. 
















Save Command





  
ID


  
ATTR_SAVE_COMMAND


  
Type


  
String


  
Description


  
The command used to save the spooled file.  The value is blank if the
spooled file was not saved.
  
















Save Device





  
ID


  
ATTR_SAVE_DEVICE


  
Type


  
String


  
Description


  
The type of device to which the spooled file was last saved.  The
    value is *SAVF if the last save operation was to a save file.  The 
    value is *TAP if the last save operation was to tape.  The value is
    *OPT if the last save operation was to optical.  The value is the 
    empty string "", if the spooled file was not saved.
  
















Save Label





  
ID


  
ATTR_SAVE_LABEL


  
Type


  
String


  
Description


  
The file label used when the spooled file was saved.  The
    value corresponds to the value specified for the LABEL or OPTFILE
    parameter on the system command used to save the spooled file.
    The value is blank if the object was not saved to tape or optical.
  
















Save Sequence Number





  
ID


  
ATTR_SAVE_SEQUENCE_NUMBER


  
Type


  
Integer


  
Description


  
The tape sequence number assigned when the spooled file was 
    saved on tape.  If the spooled file was not saved to tape, the 
    field contains zeros.
  
















Save Volume Format





  
ID


  
ATTR_SAVE_VOLUME_FORMAT


  
Type


  
String


  
Description


  
The format of the saved spooled file.  This format is used when
    spooled files are saved to tape or optical media.  The possible values
    are SERIAL or PARALLEL. For SERIAL, the spooled file was saved serially
    in a single media file.  For PARALLEL, the spooled file was saved
    in a parallel save/restore file with more than one media file.  All of
    the media files are needed to restore this data.
  
















Save Volume ID





  
ID


  
ATTR_SAVE_VOLUME_ID


  
Type


  
String


  
Description


  
The tape or optical volumes that are used for saving the spooled file.
This string contains a maximum of ten (10) six character volume names.
The volume names are separated by blanks.
















Seek Offset





  
ID


  
ATTR_SEEKOFF 


  
Type


  
Integer 


  
Description


  
Seek offset. Allows both positive and negative values relative to the
    seek origin.
  
















Seek Origin





  
ID


  
ATTR_SEEKORG 


  
Type


  
Integer 


  
Description


  
Valid values include 1 (beginning or top), 2 (current), and 3 (end
    or bottom).
  
















Send Priority





  
ID


  
ATTR_SENDPTY 


  
Type


  
String 


  
Description


  
Send priority. Valid values are *NORMAL, *HIGH. 
















Separator Page





  
ID


  
ATTR_SEPPAGE 


  
Type


  
String 


  
Description


  
Allows a user the option of printing a banner page or not. Valid values
    are *YES or *NO.
  
















Source Drawer





  
ID


  
ATTR_SRCDRWR 


  
Type


  
Integer 


  
Description


  
The drawer to be used when the automatic cut sheet feed option is selected.
    Valid values are -1, -2, 1-255. The value *E1 is encoded as -1, and the
    value *FORMDF is encoded as -2.
  
















Spool SCS





  
ID


  
ATTR_SPLSCS 


  
Type


  
Long 


  
Description


  
Determines how SCS data is used during create spool file. 
















Spool the Data





  
ID


  
ATTR_SPOOL 


  
Type


  
String 


  
Description


  
Whether the output data for the printer device is spooled. Valid values
are *YES, *NO. 
















Spooled File Creation Authentication Method





  
ID


  
ATTR_SPLF_AUTH_METHOD 


  
Type


  
Integer 


  
Description


  
Indicates the client authentication method used to create this
spooled file. Valid values include x'00'(*NONE), x'01'(*REQUESTER),
x'02'(*BASIC), x'03'(*CERTIFICATE), and 'x'04'(*DIGEST). 
















Spooled File Creation Security Method





  
ID


  
ATTR_SPLF_SECURITY_METHOD 


  
Type


  
String 


  
Description


  
Indicates the security method used to create this spooled file. Valid values are x'00'(*NONE), x'01'(*SSL3), and x'02'(*TLS). 




 











Spooled File Name





  
ID


  
ATTR_SPOOLFILE 


  
Type


  
String 


  
Description


  
The name of the spooled file. 
















Spooled File Number





  
ID


  
ATTR_SPLFNUM 


  
Type


  
Integer 


  
Description


  
The spooled file number.  Special values allowed are -1 and 0.
The value *LAST is encoded as -1, the value *ONLY is
encoded as 0. 
















Spooled File Restored Date





  
ID


  
ATTR_SPLF_RESTORED_DATE


  
Type


  
String


  
Description


  
The date the spooled file was last restored.  This value is blank if the
spooled file was not restored.  The date format is CYYMMDD,
where C=century (0=19XX, 1=20XX), YY=year, MM=month, and DD=day.
















Spooled File Restored Time





  
ID


  
ATTR_SPLF_RESTORED_TIME


  
Type


  
String


  
Description


  
The time the spooled file was last restored.  This value is blank if the
spooled file was not restored.  The time is in the HHMMSS format, 
where HH=hour, MM=minute, and SS=second.
















Spooled File Saved Date





  
ID


  
ATTR_SPLF_SAVED_DATE


  
Type


  
String


  
Description


  
The date the spooled file was last saved.  This value is blank if the
spooled file was not saved.  The date format is CYYMMDD,
where C=century (0=19XX, 1=20XX), YY=year, MM=month, and DD=day.
















Spooled File Saved Time





  
ID


  
ATTR_SPLF_SAVED_TIME


  
Type


  
String


  
Description


  
The time the spooled file was last saved.  This value is blank if the
spooled file was not saved.  The time is in the HHMMSS format,
where HH=hour, MM=minute, and SS=second.
















Spooled File Size





  
ID


  
ATTR_SPLF_SIZE


  
Type


  
Integer


  
Description


  
The spooled file size. Multiply this value by the spooled file
size multiplier value to get the size of the spooled file in 
number of bytes. The spooled file size is the data stream plus
the "overhead" storage used to store the spooled files's 
data stream.
















Spooled File Size Multiplier





  
ID


  
ATTR_SPLF_SIZE_MULT


  
Type


  
Integer


  
Description


  
The number to multiply the spooled file size value by to 
get the spooled file size in number of bytes.
















Spooled File Status





  
ID


  
ATTR_SPLFSTATUS 


  
Type


  
String 


  
Description


  
The status of the spooled file. Valid values are *CLOSED, *HELD, *MESSAGE,
*OPEN, *PENDING, *PRINTER, *READY, *SAVED, *WRITING. 
















Spooled Output Schedule





  
ID


  
ATTR_SCHEDULE 


  
Type


  
String 


  
Description


  
Specifies, for spooled files only, when the spooled file is available
to the writer. Valid values are *IMMED, *FILEEND, *JOBEND. 
















Started By User





  
ID


  
ATTR_STARTEDBY 


  
Type


  
String 


  
Description


  
The name of the user who started the writer. 
















Starting Page





  
ID


  
ATTR_STARTPAGE 


  
Type


  
Integer 


  
Description


  
The page number at which to start printing the spooled file. Valid
values are -1, 0, 1, or the page number. The value *ENDPAGE is encoded
as -1. For the value 0, printing starts on page 1. For the value 1, the
entire file prints. 
















System Where File Originated





  
ID


  
ATTR_SYSTEM


  
Type


  
String


  
Description


  
The name of the system where the spooled file was created. When
the name of the system where this spooled file was created cannot be
determined, the receiving system name is used. 
















Text Description





  
ID


  
ATTR_DESCRIPTION 


  
Type


  
String 


  
Description


  
Text to describe an instance of an i5/OS object. 
















Time File Opened (Created)





  
ID


  
ATTR_TIME


  
Type


  
String 


  
Description


  
For spooled files this is the time this spooled file was opened.
For AFP resources this is the time the object was last modified.
The time is encoded in a character string with the following format,
HHMMSS where:
    
    

      
  • HH - Hour
    • 

      
  • MM - Minutes
    • 

      
  • SS - Seconds
    • 

    

  
















Time Writer Began Processing Spooled File





  
ID


  
ATTR_TIME_WTR_BEGAN_FILE 


  
Type


  
String 


  
Description


  
Indicates the time at which the writer began processing the spooled file.
The time is encoded in a character string with the following format,
 HH MM SS. 
















Time Writer Completed Processing Spooled File





  
ID


  
ATTR_TIME_WTR_CMPL_FILE 


  
Type


  
String 


  
Description


  
Indicates the time at which the writer finished processing the spooled file.
The time is encoded in a character string with the following format,
 HH MM SS. 

















Total Pages





  
ID


  
ATTR_PAGES 


  
Type


  
Integer 


  
Description


  
The number of pages that are contained in a spooled file. 
















Transform SCS to ASCII





  
ID


  
ATTR_SCS2ASCII 


  
Type


  
String 


  
Description


  
Whether the print data is to be transformed from SCS to ASCII. Valid
values are *YES, *NO. 

















TRC for 1403





  
ID


  
ATTR_TRC1403


  
Type


  
String (One character)


  
Description


  
Whether the spooled file contains 1403 line data with 
table-reference characters (TRC). Valid values are Y (yes) or N (no).

















Unit of Measure





  
ID


  
ATTR_UNITOFMEAS 


  
Type


  
String 


  
Description


  
The unit of measure to use for specifying distances. Valid values are
*CM, *INCH. 
















User Comment





  
ID


  
ATTR_USERCMT


  
Type


  
String


  
Description


  
The 100 characters of user-specified comment that describe the spooled
    file.
  
















User Data





  
ID


  
ATTR_USERDATA


  
Type


  
String


  
Description


  
The 10 characters of user-specified data that describe the spooled
    file. Valid special values include *SOURCE.
  
















User Defined Data





  
ID


  
ATTR_USRDEFDATA


  
Type


  
String 


  
Description


  
User defined data to be utilized by user applications or user specified
programs that process spool files. All characters are acceptable. Max size
is 255. 
















User Defined File





  
ID


  
ATTR_USRDEFFILE 


  
Type


  
String 


  
Description


  
Whether the spooled file was created using an API.  Valid values are *YES, or *NO. 
















User Defined Object





  
ID


  
ATTR_USER_DEFINED_OBJECT


  
Type


  
String 


  
Description


  
The Integrated File System path of the user defined object to be utilized
     by user applications that process spool files.  If an Integrated File System path the format
     of the Integrated File System path is "/QSYS.LIB/library.LIB/object.type" where library
     is the name of the library that contains the object or one of the special
     values %LIBL% or %CURLIB%.  object is the name of the object and
     type is the object type.  Valid values for type include
     "DTAARA", "DTAQ", "FILE", "PSFCFG", "USRIDX", "USRQ" and "USRSPC".
     The string "*NONE" is used to indicate no user defined object is to
     be used.
  
















User Defined Option(s)





  
ID


  
ATTR_USRDEFOPT


  
Type


  
String


  
Description


  
User defined options to be utilized by user applications that process
spool files. Up to 4 options may be specifies, each value is length char(10).
All characters are acceptable. 
















User Driver Program Data





  
ID


  
ATTR_USRDRVDATA


  
Type


  
String 


  
Description


  
User data to be used with the user driver program. All characters are
acceptable. Maximum size is 5000 characters. 
















User
Driver Program





  
ID


  
ATTR_USER_DRIVER_PROG 


  
Type


  
String 


  
Description


  
The Integrated File System path of the user defined driver program that processes spooled files.
    The format of the Integrated File System path is "/QSYS.LIB/library.LIB/program.PGM" where
    library is the name of the library that contains the program and
    program is the program name.  The library may be one of the
    special values %LIBL% and %CURLIB% or a specific library name.
    The string "*NONE" is used to indicate that no driver program is defined.
  
















User ID





  
ID


  
ATTR_TOUSERID 


  
Type


  
String 


  
Description


  
User id to whom the spooled file is sent. 
















User ID Address





  
ID


  
ATTR_TOADDRESS 


  
Type


  
String 


  
Description


  
Address of user to whom the spooled file is sent. 
















User Defined Text





  
ID


  
ATTR_USER_DFN_TXT


  
Type


  
String


  
Description


  
User defined text taken from the interactive user profile
    when the spooled file was created.
  
















User Generated Data Stream





  
ID


  
ATTR_USERGEN_DATA


  
Type


  
String 


  
Description


  
Whether the data stream has been validated by a system program
    on the i5/OS when the file was spooled.
  

















User Transform Program





  
ID


  
ATTR_USER_TRANSFORM_PROG 


  
Type


  
String 


  
Description


  
The Integrated File System path of the user defined transform program that
    transforms spool file data  before it is processed by the driver program.
    The format of the Integrated File System path is "/QSYS.LIB/library.LIB/program.PGM" where
    library is the name of the library that contains the program and
    program is the program name.  The library may be one of the
    special values %LIBL% and %CURLIB% or a specific library name.
    The string "*NONE" is used to indicate that no transform program is defined.
  
















User Who Owned File





  
ID


  
ATTR_SPLF_CREATOR


  
Type


  
String


  
Description


  
The name of the user profile that owns this spooled file on the 
    sending system.
















Fidelity





  
ID


  
ATTR_VIEWING_FIDELITY 


  
Type


  
String 


  
Description


  
The processing to take place when viewing a page of  
spooled file data (in page-at-a-time mode).
Valid values are *ABSOLUTE and *CONTENT(default).  To process all non-raster data (commands) prior 
to the current page, *ABSOLUTE is used.  For SCS files, *CONTENT is used to process 
only open time commands plus the current page.  For AFPDS files, *CONTENT
is used to process the first page of data plus the current page.

















VM/MVS Class






  
ID



  
ATTR_VMMVSCLASS 



  
Type



  
String 



  
Description



  
VM/MVS class. Valid values are A-Z and 0-9. 

















When to Automatically End Writer






  
ID



  
ATTR_WTRAUTOEND 



  
Type



  
String 



  
Description



  
When to end the writer if it is to be ended automatically. Valid values
are *NORDYF, *FILEEND. Attribute Automatically end writer must be set to
*YES. 
















Waiting for Data Status





  
ID


  
ATTR_WTNGDATASTS 


  
Type


  
String 


  
Description


  
Whether the writer has written all the data currently in the spooled file
and is waiting for more data.  Possible values are *NO - the writer is not
waiting for more data, *YES - the writer has written all the data currently in
the spooled file and is waiting for more data.  This condition occurs when the
writer is producing an open spooled file with SCHEDULE(*IMMED) specified. 
















Waiting for Device Status





  
ID


  
ATTR_WTNGDEVSTS 


  
Type


  
String 


  
Description


  
Whether the writer is waiting to get the device from a job that is printing
directly to the printer.  Values are *NO - the writer is not waiting for the
device, *YES - the writer is waiting for the device. 

















Waiting
for Message Status






  
ID



  
ATTR_WTNGMSGSTS 



  
Type



  
String 



  
Description



  
Whether the writer is waiting for a reply to an inquiry message.  Values are
*NO and *YES. 

















When to End Writer






  
ID



  
ATTR_WTREND 



  
Type



  
String 



  
Description



  
When to end the writer. Valid value are *CNTRLD, *IMMED, and *PAGEEND.
This is different from when to automatically end the writer. 

















When to Hold File






  
ID



  
ATTR_HOLDTYPE 



  
Type



  
String 



  
Description



  
When to hold the spooled file. Valid values are *IMMED, and *PAGEEND.
  

















Width of Page






  
ID



  
ATTR_PAGEWIDTH 



  
Type



  
Float 



  
Description



  
The width of a page. Units of measurement are specified in the measurement
method attribute. 
















Workstation Customizing Object





  
ID


  
ATTR_WORKSTATION_CUST_OBJECT 


  
Type


  
String 


  
Description


  
 The Integrated File System path of the workstation customizing object.  The format of the Integrated File System path
is "/QSYS.LIB/library.LIB/custobj.WSCST" where library is the library that
contains the customization object and custobj is the name of the workstation
customization object.
  
















Writer Job Name





  
ID


  
ATTR_WTRJOBNAME


  
Type


  
String


  
Description


  
The name of the writer job.
















Writer Job Number





  
ID


  
ATTR_WTRJOBNUM


  
Type


  
String 


  
Description


  
The writer job number. 
















Writer Job Status





  
ID


  
ATTR_WTRJOBSTS 


  
Type


  
String 


  
Description


  
The status of the writer job. Valid values are STR, END, JOBQ, HLD,
MSGW. 
















Writer Job User Name





  
ID


  
ATTR_WTRJOBUSER 


  
Type


  
String 


  
Description


  
The name of the user that started the writer job. 
















Writer Started





  
ID


  
ATTR_WTRSTRTD 


  
Type


  
String 


  
Description


  
Indicates whether or not a writer is started for this printer.  Values
    are 1 - yes a writer is started, 0 - no writer is started. 
















Writer Starting Page





  
ID


  
ATTR_WTRSTRPAGE 


  
Type


  
Integer 


  
Description


  
Specifies the page number of the first page to print from the first
spooled file when the writer job starts. This is only valid if the spooled
file name is also specified when the writer starts. 
















Writing Status





  
ID


  
ATTR_WRTNGSTS 


  
Type


  
String 


  
Description


  
Indicates whether the print writer is in writing status.  Values are
*YES - the writer is in writing status, *NO - the writer is not in writing
status, *FILE - the writer is writing the file separators. 
















Network Print Server Object Attributes




NPS CCSID





  
ID


  
ATTR_NPSCCSID 


  
Type


  
Integer 


  
Description


  
CCSID that the Network Print Server expects that all strings will be
encoded in. 







NPS Level





  
ID


  
ATTR_NPSLEVEL 


  
Description


  
The version, release, and modification level of the Network Print Server.
This attribute is a character string encoded as VXRYMY (ie. "V3R1M0")
where
    
     X is in (0..9)
     Y is in (0..9,A..Z)




© 2015 - 2024 Weber Informatics LLC | Privacy Policy