ABAP Keyword Documentation → ABAP - Reference → User Dialogs → Classic Lists → Spooling Lists → Spool Parameters
Overview of All Spool ParametersOther versions: 7.31 | 7.40 | 7.54
The following table lists all spool parameters by their associated input parameters in the function modules GET_PRINT_PARAMETERS and SET_PRINT_PARAMETERS. The second column shows the label in the spool dialog window. The third column contains the name of the component in the structure PRI_PARAMS whose content, however, cannot be modified directly in a program.
|Input Parameter||Dialog Field||Component||Meaning|
|IN_PARAMETERS||-||-||Full structure of type PRI_PARAMS; any single values passed in parallel overwrite the associated component.|
|ARCHIVE_MODE||Archive Mode||ARMOD||If "1" print only (default), if "2" archive only, if "3" print and archive.|
|AUTHORITY||Authorization||PRBER||Authorization value for authorization object S_SPO_ACT. This can be used to check whether or not a user is allowed to carry out certain actions on the spool request.|
|COPIES||Number of copies||PRCOP||Number or printouts, default 1.|
|COVER_PAGE||Selection cover page (if "PARAMSEL" passed to MODE)||PRBIG||If 'X', a cover page with the input values of the selection layout is printed, default " ".|
|DATA_SET||-||PRDSN||Template for the name of the spool file, default is empty.|
|DEFAULT_SPOOL_SIZE (GET_PRINT_PARAMETERS only)||Spool request has a width of maximum 255 characters||-||If "X", line break forced after the 255th column, default " ".|
|DEPARTMENT||Department||PRABT||Department name for the SAP cover page, default taken from user address.|
|DESTINATION||Output device||PDEST||Name of a printer or fax machine, default taken from user master data.|
|DRAFT (GET_PRINT_PARAMETERS only)||Text only||-||If "X" only text is printed, default is " ".|
|EXPIRATION||Retention period||PEXPI||Number of days for which the spool request is retained by the spool system, default is 8.|
|FOOT_LINE (SET_PRINT_PARAMETERS only)||-||FOOTL||If "X" footer printed (only if spooling screen lists) whose content can be modified in the spool dialog window under Parameters, default is empty.|
|HOST_COVERPAGE||OS cover page||PRUNX||If "X" the operating system cover page is printed, default is " ".|
|IMMEDIATELY||Time of printing||PRIMM||If "X" the spool request is sent immediately, if "A" the spool request is printed at a later time(only for non-front-end printers), if " " the spool request must be printed manually, default taken from user master data.|
|LAYOUT||Formatting||PAART||Page format, depending on the output device, different formats with different maximum page lengths and widths can be specified, default defined internally.|
|LINE_COUNT||Lines (subproperty of Formatting)||LINCT||Number of lines per page, functions like the addition
|LINE_SIZE||Columns (subproperty of Formatting)||LINSZ||Characters per list row, functions like the addition
|LIST_NAME||Name||PLIST||The name of the spool request if not printed immediately, default is a combination of the start of the program name from the parameter REPORT and the user name|
|LIST_TEXT||Title||PRTXT||Description text for the spool request, appears on the default cover page and is displayed in the output controller instead of LIST_NAME, default is empty.|
|NEW_LIST_ID||New spool request||PRNEW||If "X" (default) a new spool request is created, otherwise the system attempts to attach the spoolrequest to an existing request, works only if LIST_NAME, DESTINATION, COPIES, and LAYOUT match and PROTECT_LIST is empty.|
|NO_FRAMES (GET_PRINT_PARAMETERS only)||No frame characters||-||If "X" no frame characters are printed, default is " ".|
|PRIORITY||Print priority||PRIOT||"1" (high) to "9" (low), default is "1".|
|PROTECT_LIST (GET_PRINT_PARAMETERS only)||Protection from attachments||-||If "X" no further requests can be attached to the spool request, default is " ".|
|RECEIVER||Recipient||PRREC||Recipient name for the SAP cover page, default taken from user address.|
|RELEASE||Delete immediately after printing||PRREL||If "X" spool request is deleted immediately after printing, otherwise after EXPIRATION, default taken from user master data.|
|REPORT (GET_PRINT_PARAMETERS only)||-||-||If MODE is the same as "BATCH", the name of the program to be startedmust be entered in REPORT. The list rows per page (LINE_COUNT) and the characters per list row (LINE_SIZE)are then taken from the introductory program statement of the specified program. Still the default forthe first part of the name of the spool request overwritten by LIST_NAME (the default for this is
|SAP_COVER_PAGE||SAP cover sheet||PRSAP||If "X" a standard cover page with standard information is created, if "D" (default) the cover page printed depends on the settings of the printer, if " " no cover page is created.|
|SUPPRESS_SHADING (GET_PRINT_PARAMETERS only)||Colors/shading suppressed in the printout||-||If "X" colors/shading are suppressed in the printout, default is " ".|
|TYPE||-||PTYPE||Type of the spool request.|
|UC_DISPLAY_MODE (GET_PRINT_PARAMETERS only)||Character format||-||Unicode spool output, if "1" characters are printed with the output length one, if "2" all characters are printed in their own output lengths, if "3" all characters are printed with the length two.|
|WITH_STRUCTURE (GET_PRINT_PARAMETERS only)||Spool list with structure information||-||If "X" structure information is also printed (for ACC and RTL output), default is " ".|
|-||Print All, Print from Page ... to||-||Restricts the number of pages printed, default is Print All.|
- The input parameters of GET_PRINT_PARAMETERS that do not have a component in the structure PRI_PARAMS
are not passed to a spool request explicitly during
NEW-PAGE PRINT ONand
SUBMIT TO SAP-SPOOLand are defined internally by the function module instead.
- Using SET_PRINT_PARAMETERS only allows the setting those spool parameters that are stored in components of the PRI_PARAMS structure.
- The spool parameters LINE_COUNT and LINE_SIZE do not overwrite the additions
LINE-SIZEof the introductory statement of a program specified using REPORT if the value "BATCH" is passed to the parameter MODE. In this case, the corresponding input fields in the spool dialog box are not ready for input. If these values exceed the maximum values defined by LAYOUT, then the list cannot be spooled.
- The values of the components of the structure PRI_PARAMS are usually intended for internal use only
and do not always match the values specified directly, such as in the addition
The following table lists all archiving parameters by their associated input parameters in the function modules GET_PRINT_PARAMETERS and SET_PRINT_PARAMETERS. The second column shows the label in the spool dialog window. The third column contains the name of the component in the structure ARC_PARAMS whose content, however, cannot be modified directly in a program.
|Input Parameter||Dialog Field||Component||Meaning|
|IN_ARCHIVE_PARAMETERS||-||-||Full structure of type ARC_PARAMS, any single values passed in parallel overwrite the associated component.|
|AR_OBJECT||Document type||AR_OBJECT||Document type of the archiving object.|
|ARCHIVE_ID||-||ARCHIVE_ID||Target archive of the archiving request.|
|ARCHIVE_INFO||Information||INFO||Information ID for the archiving request.|
|ARCHIVE_TEXT||Text||ARCTEXT||Description text of the archiving request.|
|SAP_OBJECT||Object type||SAP_OBJECT||Object type of the SAP object.|
- Requests can be archived only if these parameters are specified consistently and in full. Archiving works across all applications. With the exception of certain basic settings, no other actions are required. If spool lists need to be saved specific to an application, some special actions must be taken. For information about these actions, see the ArchiveLink documentation in the
SAP NetWeaver documentation in SAP Help Portal. .
- When archiving long lists, it may be useful to write index information to the list using
PRINT-CONTROL INDEX-LINE. This makes it easier to search the archived list at a later date.
The following table lists the control parameters of the function module GET_PRINT_PARAMETERS.
|MODE||Possible values "BATCH", "CURRENT","DEFVALS", "DISPLAY", "PARAMS", "PARAMSEL" (see below)|
|NO_DIALOG||If "X" no spool dialog window is displayed|
The following table shows the values that can be passed to MODE.
|"BATCH"||The function module gets spool parameters for a background request. The executable program to bestarted must be specified in the import parameter REPORT. If this executable program contains the additions
|"CURRENT"||The function module is used to determine the current spool parameters after spooling has been activated. If nothing is being spooled, the default values are used.|
|"DEFVALS"||Always gets the default values.|
|"DISPLAY"||The spool parameters are displayed in the spool dialog box but cannot be changed.|
|"PARAMS"||Standard setting, the user can choose Print or Cancel on the spool dialog window.|
|"PARAMSEL"||Like "PARAMS", however the additional checkbox Selection Cover Page appears on the spool dialog window.|
Output Parameters of GET_PRINT_PARAMETERS
The following table lists the output parameters of the function module GET_PRINT_PARAMETERS.
|OUT_PARAMETERS||Set of spool parameters in a structure of the type PRI_PARAMS. Either complete or empty-|
|OUT_ARCHIVE_PARAMETERS||Set of archiving parameters in a structure of the type ARC_PARAMS. Either complete or empty-|
|VALID||If "X", all spool parameters or archiving parameters are present and printing or archiving is possible.If " ", the structures are empty and printing or archiving is not possible. VALID is " " if Cancel is used to exit the spool dialog window.|
|VALID_FOR_SPOOL_CREATION||If "X", enough spool parameters are available to create a spool request. There is no guarantee,however, that this request can be printed or archived. If " ", the structures are empty and a spoolrequest cannot be created. This is different from VALID only if the spool dialog box is not displayed. If the spool dialog box is displayed, VALID_FOR_SPOOL_CREATION is filled just like VALID.|