Operating System BS2000 OS DX V1.0 (en)

&pagelevel(3)&pagelevel

Request information on form entries

Component:	SPOOL
Functional area:	Controlling spoolout job
Domain:	SPOOL-PRINT-ADMINISTRATION SPOOL-PRINT-SERVICES
Privileges:	STD-PROCESSING PRINT-SERVICE-ADMINISTRATION SAT-FILE-EVALUATION SAT-FILE-MANAGEMENT SECURITY-ADMINISTRATION
Routing code:	$

Function

The SHOW-SPOOL-FORMS command provides information on data from the form entry for the specified form or the form assigned to the specified type of printer. When a form and a printer type are specified the information is output in full, otherwise only the important data is selected, sorted by form name. The number of forms listed can be freely limited by selection criteria. Those forms are selected whose form entry includes the values specified for the respective operands (logical ANDing).

The SHOW-SPOOL-FORMS operands have the same names and meanings as the operands of the SPSERVE statement ADD-SPOOL-FORM. The operand value *ALL (usually the default) means that the respective operand will not be used as a selection criterion.

The command supports structured output in S variables (see "Output in S variables").

Format

SHOW-SPOOL-FORMS

,SELECT = ALL / PARAMETERS(...)
	*PARAMETERS(...)
		\|	FORM-NAME = ALL / list-poss(255): STD / <alphanum-name 1..6 with-wild(24)>
		\|	,DEVICE-TYPE = *ALL / <filename 1..16 without-cat-user-gen-vers> /
		\|	list-poss(51):ALL-LOCAL-PRINTERS / ALL-REMOTE-PRINTERS /
		\|	HP-PRINTER / HP90-PRINTER / *LP-PRINTER /
		\|	LP-EMULATED-PRINTER / LP48-PRINTER / *LP65-PRINTER / *VIRTUAL /
		\|	2050-APA-PRINTER / 2090-APA-PRINTER / *PCL-PRINTER /
		\|	2090-TWIN-PRINTER / DJET-REMOTE-PRINTER /
		\|	2030-PCL-PRINTER / 4011-REMOTE-PRINTER /
		\|	4812-REMOTE-PRINTER / 4813-REMOTE-PRINTER /
		\|	4818-PCL-REMOTE-PRINTER / 4821-PCL-REMOTE-PRINTER /
		\|	4822-PCL-REMOTE-PRINTER / 4824-PCL-REMOTE-PRINTER /
		\|	4825-PCL-REMOTE-PRINTER / 8121-REMOTE-PRINTER /
		\|	9000-EPFX-REMOTE-PRINTER / 9000-EPLQ-REMOTE-PRINTER /
		\|	9000-EPSQ-REMOTE-PRINTER / 9000-PCL-REMOTE-PRINTER /
		\|	9000-PRO-REMOTE-PRINTER / 9000-PS-REMOTE-PRINTER /
		\|	9000-REMOTE-PRINTER / 9001-REMOTE-PRINTER /
		\|	9001-31-REMOTE-PRINTER / 9002-REMOTE-PRINTER /
		\|	9003-REMOTE-PRINTER / 9004-REMOTE-PRINTER /
		\|	9011-REMOTE-PRINTER / 9012-REMOTE-PRINTER /
		\|	9013-REMOTE-PRINTER / 9014-REMOTE-PRINTER /
		\|	9015-REMOTE-PRINTER / 9021-REMOTE-PRINTER /
		\|	9022-REMOTE-PRINTER / 9022-200-REMOTE-PRINTER /
		\|	9025-REMOTE-PRINTER / 9026-PCL-REMOTE-PRINTER /
		\|	9026-RENO-REMOTE-PRINTER / 9045-ANSI-REMOTE-PRINTER /
		\|	9046-REMOTE-PRINTER / 9097-REMOTE-PRINTER /
		\|	*9645-REMOTE-PRINTER
		\|	,OWNER = ALL / <alphanum-name 1..8 with-wild(24)> / list-poss(16): OWN / <name 1..8>
		\|	,ACCESS-DATE= ANY / TODAY / *INTERVAL(...)
		\|		*INTERVAL(...)
		\|			\|	FROM = 1950-01-01 / <date with-compl>
		\|			\|	,TO = *TODAY / <date with-compl>
		\|	,LINE-SIZE = ALL / <integer 30..180> / RANGE(...)
		\|		*RANGE(...)
		\|			\|	LOW = <integer 30..180>
		\|			\|	,HIGH = <integer 30..180>
		\|	,PAGE-SIZE = ALL / <integer 1..250> / RANGE(...)
		\|		*RANGE(...)
		\|			\|	LOW = <integer 1..250>
		\|			\|	,HIGH = <integer 1..250>
		\|	,HEADER-PAGE = ALL / list-poss(4): YES / NO / RESPOOL / *ONE
		\|	,TRAILER-PAGE = ALL / list-poss(3): YES / NO / INFO
		\|	,VERTICAL-CONTROL = ALL / LOOP(...) / SPACING(...) / NONE
		\|		*LOOP(...)
		\|			\|	LOOP-NAME = *ALL / <alphanum-name 1..3 with-wild(24)> /
		\|			\|	list-poss(16): <alphanum-name 1..3>
		\|		*SPACING(...)
		\|			\|	LINES-PER-INCH = ALL / DENSITY(...) / list-poss(8): 3 / 4 / 6 / 8 / 10 / 12 / 15 / 20
		\|			\|		*DENSITY(...)
		\|			\|			\|	LINES = <integer 1..999>
		\|			\|			\|	,INCHES = <integer 1..999>
		\|			\|	,CHANNEL1-POSITION = ALL / <integer 1..255> / RANGE(...)
		\|			\|		*RANGE(...)
		\|			\|			\|	LOW = <integer 1..255>
		\|			\|			\|	,HIGH = <integer 1..255>
		\|	,ROTATION-CONTROL = ALL / LOOP(...) / *SPACING(...) / *NONE
		\|		*LOOP(...)
		\|			\|	LOOP-NAME = *ALL / <alphanum-name 1..3 with-wild(24)> /
		\|			\|	list-poss(16): <alphanum-name 1..3>
		\|		*SPACING(...)
		\|			\|	LINES-PER-INCH = ALL / DENSITY(...) / list-poss(8): 3 / 4 / 6 / 8 / 10 / 12 / 15 / 20
		\|			\|		*DENSITY(...)
		\|			\|			\|	LINES = <integer 1..999>
		\|			\|			\|	,INCHES = <integer 1..999>
		\|			\|	,CHANNEL1-POSITION = ALL / <integer 1..255> / RANGE(...)
		\|			\|		*RANGE(...)
		\|			\|			\|	LOW = <integer 1..255>
		\|			\|			\|	,HIGH = <integer 1..255>
		\|	,CHARACTER-SET = ALL / <alphanum-name 1..3 with-wild(24)> / list-poss(16): NONE /
		\|	<alphanum-name 1..3>
		\|	,ROTATION-CHARACT-SET = ALL / <alphanum-name 1..3 with-wild(24)> / list-poss(16): NONE /
		\|	<alphanum-name 1..3>
		\|	,BAND-IDENTIFICATION = ALL / <alphanum-name 1..4 with-wild(24)> / list-poss(16): NONE /
		\|	<alphanum-name 4..4>
		\|	,PREFORM = ALL / <alphanum-name 1..4 with-wild(24)> / list-poss(16): NONE /
		\|	<alphanum-name 1..4>
		\|	,CHARACTER-IMAGE = ALL / <alphanum-name 1..3 with-wild(24)> / list-poss(16): NONE /
		\|	<alphanum-name 1..3>
		\|	,TWO-UP-PROCESSING = ALL / list-poss(3): NO / MODE-1 / MODE-2
		\|	,DIA-PROCESSING = ALL / PARAMETERS(...)
		\|		*PARAMETERS(...)
		\|			\|	FORMS-OVERLAY = ALL /<alphanum-name 1..2 with-wild(24)> / list-poss(16): NONE /
		\|			\|	<alphanum-name 2..2>
		\|			\|	,FORMS-OVERLAY-BUFFER = *ALL / <alphanum-name 1..4 with-wild(24)> /
		\|			\|	list-poss(16): <alphanum-name 1..4>
		\|	,PRINTER-RESOURCES = ALL / NONE / LP65(...) / APA(...)
		\|		*LP65(...)
		\|			\|	PAGE-DEFINITION = *ALL / <integer 1..50000> / *RANGE(...)
		\|			\|		*RANGE(...)
		\|			\|			\|	LOW = <integer 1..50000>
		\|			\|			\|	,HIGH = <integer 1..50000>
		\|			\|	,STACKER-OFFSET = ALL / YES / *NO
		\|			\|	,SEPARATOR-PAGE-TRAY = ALL / NONE / <integer 1..3> / *RANGE(...)
		\|			\|		*RANGE(...)
		\|			\|			\|	LOW = <integer 1..3>
		\|			\|			\|	,HIGH = <integer 1..3>
		\|		*APA(...)
		\|			\|	FORM-DEFINITION = *ALL / <alphanum-name 1..8 with-wild(24)> /
		\|			\|	list-poss(16): <alphanum-name 1..8>
		\|			\|	,PAGE-DEFINITION = *ALL / <alphanum-name 1..8 with-wild(24)> /
		\|			\|	list-poss(16): <alphanum-name 1..8>
,EXCEPT = NONE / PARAMETERS(...)
	*PARAMETERS(...)
		\|	FORM-NAME = NONE / <alphanum-name 1..6 with-wild(24)> / list-poss(16): STD /
		\|	<alphanum-name 1..6>
		\|	,OWNER = NONE / <alphanum-name 1..8 with-wild(24)> / list-poss(16): OWN / <name 1..8>
		\|	,VERTICAL-CONTROL = *NONE / *LOOP(...)
		\|		*LOOP(...)
		\|			\|	LOOP-NAME = <alphanum-name 1..3 with-wild(24)> / list-poss(16): <alphanum-name 1..3>
		\|	,ROTATION-CONTROL = NONE / LOOP(...)
		\|		*LOOP(...)
		\|			\|	LOOP-NAME = <alphanum-name 1..3 with-wild(24)> / list-poss(16): <alphanum-name 1..3>
		\|	,CHARACTER-SET = *NONE / <alphanum-name 1..3 with-wild(24)> /
		\|	list-poss(16): <alphanum-name 1..3>
		\|	,ROTATION-CHARACT-SET = *NONE / <alphanum-name 1..3 with-wild(24)> /
		\|	list-poss(16): <alphanum-name 1..3>
		\|	,BAND-IDENTIFICATION = *NONE / <alphanum-name 1..4 with-wild(24)> /
		\|	list-poss(16): <alphanum-name 4..4>
		\|	,PREFORM = *NONE / <alphanum-name 1..4 with-wild(24)> / list-poss(16): <alphanum-name 1..4>
		\|	,CHARACTER-IMAGE = *NONE / <alphanum-name 1..3 with-wild(24)> /
		\|	list-poss(16): <alphanum-name 1..3>
		\|	,DIA-PROCESSING = NONE / PARAMETERS(...)
		\|		*PARAMETERS(...)
		\|			\|	FORMS-OVERLAY = *NONE /<alphanum-name 1..2 with-wild(24)> /
		\|			\|	list-poss(16): <alphanum-name 2..2>
		\|			\|	,FORMS-OVERLAY-BUFFER = *NONE / <alphanum-name 1..4 with-wild(24)> /
		\|			\|	list-poss(16): <alphanum-name 1..4>
		\|	,PRINTER-RESOURCES = NONE / APA(...)
		\|		*APA(...)
		\|			\|	FORM-DEFINITION = *NONE / <alphanum-name 1..8 with-wild(24)> /
		\|			\|	list-poss(16): <alphanum-name 1..8>
		\|			\|	,PAGE-DEFINITION = *NONE / <alphanum-name 1..8 with-wild(24)> /
		\|			\|	list-poss(16):<alphanum-name 1..8>
,SERVER-NAME = *HOME / <alphanum-name 1..8>
,CLUSTER-NAME = *LOCAL-CLUSTER / <alphanum-name 1..8>
,INFORMATION = SUMMARY / ALL

Operands

SELECT = *ALL / *PARAMETERS(...)
Specifies the criteria to be used for selecting the forms about which information is to be output. Specifying *ALL (default value) causes information about all forms entered to be output.

SELECT = *PARAMETERS(...)
Initiates a list of selection criteria.

FORM-NAME = *ALL / list-poss(255): *STD / <alphanum-name 1..6 with-wild(24)>
The selection criterion is the form name. Wildcards may not be specified within a list.

DEVICE-TYPE = *ALL / ....
The selection criterion is the type of printer (see syntax format).

OWNER = *ALL / <alphanum-name 1..8 with-wild(24)> / list-poss(16): *OWN / <name 1..8>
The selection criterion is the user ID of the user who created the form entry. Nonprivileged users may only specify *ALL or *OWN.

ACCESS-DATE = *ANY / *TODAY / *INTERVAL(...)
The selection criterion is the date of the last change or the last utilization within a print process. This date may be required as an additional criterion for the output of the form entry. It can be a specific date or a date range.

ACCESS-DATE = *TODAY
The last modification or change was performed on the current date.

ACCESS-DATE = *INTERVAL(...)
Specifies a date range.

FROM = 1950-01-01 / <date with-compl>
Earliest date in the date range.

TO = *TODAY / <date with-compl>
Latest date in the date range. The current date is set by default.

LINE-SIZE = *ALL / <integer 30..180> / *RANGE(...)
The selection criterion is the maximum form width (in 1/10 of an inch).

LINE-SIZE = *RANGE(...)
Specification of a range of values that contains the maximum form width.

LOW = <integer 30..180>
Lower range limit.

HIGH = <integer 30..180>
Upper range limit.

PAGE-SIZE = *ALL / <integer 1..250> / *RANGE(...)
The selection criterion is the height of the form (in 1/10 of an inch).

PAGE-SIZE = *RANGE(...)
Specification of a range of values that includes the maximum form height.

LOW = <integer 1..250>
Lower range limit.

HIGH = <integer 1..250>
Upper range limit.

HEADER-PAGE = *ALL / list-poss(4): *YES / *NO / *RESPOOL / *ONE
The selection criterion is the entry specifying whether a header page is to be printed.

TRAILER-PAGE = *ALL / list-poss(3): *YES / *NO / *INFO
The selection criterion is the entry specifying whether a trailer page is to be printed.

VERTICAL-CONTROL = *ALL / *NONE / *LOOP(...) / *SPACING(...)
The selection criterion is the entry specifying the type of feed control.

VERTICAL-CONTROL = *LOOP(...)
Feed control via loop record.

LOOP-NAME = *ALL / <alphanum-name 1..3 with-wild(24)> /list-poss(16): <alphanum-name 1..3>
Name of the loop record.

VERTICAL-CONTROL = *SPACING(...)
Initiates a list of selection criteria.

LINES-PER-INCH = *ALL / *DENSITY(...) / list-poss(8): 3 / 4 / 6 / 8 / 10 / 12 / 15 / 20
The selection criterion is the line density (number of lines per inch).

LINES-PER-INCH = *DENSITY(...)
The selection criterion is the line density, specified by the number of lines (LINES) and the form length (INCHES).

LINES = <integer 1..999>
Number of lines.

INCHES = <integer 1..999>
Form length in inches.

CHANNEL1-POSITION = *ALL / <integer 1..255> / *RANGE(...)
The selection criterion is the position of the line (loop record) on which “channel 1” is located.

CHANNEL1-POSITION = *RANGE(...)
Specification of a range of values for the position.

LOW = <integer 1..255>
Lower range limit.

HIGH = <integer 1..255>
Upper range limit.

ROTATION-CONTROL = *ALL / *NONE / *LOOP(...) / *SPACING(...)
The selection criterion is whether rotated page feed is controlled by a loop record or an additional line feed controller.

ROTATION-CONTROL = *LOOP(...)
Feed is controlled by a loop record.

LOOP-NAME - *ALL / <alphanum-name 1..3 with-wild(24)> / list-poss(16): <alphanum-name 1..3>
Name of the loop record.

ROTATION-CONTROL = *SPACING(...)
Feed is controlled by an additional line feed controller.

LINES-PER-INCH = *ALL / *DENSITY(...) / list-poss(8): 3 / 4 / 6 / 8 / 10 / 12 / 15 / 20
The selection criterion is the line density (number of lines per inch).

LINES-PER-INCH = *DENSITY(...)
The selection criterion is the line density, specified by the number of lines (LINES) and the length of the form (INCHES).

LINES = <integer 1..999>
Number of lines.

INCHES = <integer 1..999>
Form length in inches.

CHANNEL1-POSITION = *ALL / <integer 1..255> / *RANGE(...)
The selection criterion is the line number in the simulated loop on which the “channel 1” vertical tabulator is defined.

CHANNEL1-POSITION = *RANGE(...)
Specification of a range of values for the line number.

LOW = <integer 1..255>
Lower range limit.

HIGH = <integer 1..255>
Upper range limit.

CHARACTER-SET = *ALL / <alphanum-name 1..3 with-wild(24)> / list-poss(16): *NONE /
<alphanum-name 1..3>
The selection criterion is the name of the character set.

ROTATION-CHARACT-SET = *ALL / <alphanum-name 1..3 with-wild(24)> /
list-poss(16): *NONE / <alphanum-name 1..3>
The selection criterion is the name of the character set used for rotated pages.

BAND-IDENTIFICATION = *ALL / <alphanum-name 1..4 with-wild(24)> /
list-poss(16): *NONE / <alphanum-name 4..4>
The selection criterion is the name of the type band.

PREFORM = *ALL / <alphanum-name 1..24 with-wild> /
list-poss(16): *NONE / <alphanum-name 1..4>
The selection criterion is the entry specifying the printer control character sequence that must be sent at the start of a job. Only for LP-EMULATED-PRINTER.

CHARACTER-IMAGE = *ALL / <alphanum-name 1..3 with-wild(24)> / list-poss(16): *NONE /
<alphanum-name 1..3>
The selection criterion is the name of the conversion table.

TWO-UP-PROCESSING = *ALL / list-poss(3): *NO / *MODE-1 / *MODE-2
The selection criterion is the entry specifying whether and which two-up mode is to be used for printing. (Only for HP90 printers.)

DIA-PROCESSING = *ALL / *PARAMETERS(...)
The selection criteria are the default settings for forms when using overlays.

DIA-PROCESSING = *PARAMETERS(...)
Specifies the settings for EFO and FOB data overlays.

FORMS-OVERLAY = *ALL /<alphanum-name 1..2 with-wild(24)> /
list-poss(16): <alphanum-name 2..2>
The selection criterion is the description of the EFO data overlay.

FORMS-OVERLAY-BUFFER = *ALL / <alphanum-name 1..4 with-wild(24)> /
list-poss(16): <alphanum-name 1..4>
The selection criterion is the description of the FOB data overlay.

PRINTER-RESOURCES = *ALL / *NONE / *LP65(...) / *APA(...)
The selection criterion is the entry specifying whether particular printer functions are to be used.

PRINTER-RESOURCES = *LP65(...)
Designates the printer functions for LP65 printers.

PAGE-DEFINITION = *ALL / <integer 1..50000> / *RANGE(...)
The selection criterion is the number of the default PCL file.

PAGE-DEFINITION = *RANGE(...)
Specification of a range of values that contains the number.

LOW = <integer 1..50000>
Lower range limit.

HIGH = <integer 1..50000>
Upper range limit

STACKER-OFFSET = *ALL / *YES / *NO
The selection criterion is the agreement whether the individual spoolout jobs are to be separated by offset stacking.

SEPARATOR-PAGE-TRAY = *ALL / <integer 1..3> / *RANGE(...)
The selection criterion is the number of blank pages between the individual spoolout jobs.

SEPARATOR-PAGE-TRAY = *RANGE(...)
Specification of a range of values for the number of blank pages.

LOW = <integer 1..3>
Lower range limit.

HIGH = <integer 1..3>
Upper range limit.

PRINTER-RESOURCES = *APA(...)
The selection criteria are the names of the form and page definitions for APA printers.

FORM-DEFINITION = *ALL / <alphanum-name 1..8 with-wild(24)> /
list-poss(16): <alphanum-name 1..8>
The selection criterion is the name of the form definition.

PAGE-DEFINITION = *ALL / <alphanum-name 1..8 with-wild(24)> /
list-poss(16): <alphanum-name 1..8>
The selection criterion is the name of the page definition.

EXCEPT = *NONE / *PARAMETERS(...)
Names of the forms entries to be excluded from the selection (negative list). If *NONE is specified, no forms are excluded from the selection.

EXCEPT = *PARAMETERS(...)
Initiates a list of selection criteria.

FORM-NAME = *NONE / <alphanum-name 1..6 with-wild(24)> / list-poss(16): <alphanum-name 1..6> / *STD
The forms with the specified names are not to be taken into account. If *NONE is specified (the default), the operand is ignored.

OWNER = *NONE / <alphanum-name 1..8 with-wild(24)> / list-poss(16): *OWN / <name 1..8>
Forms entries created by users with the specified user ID are not taken into account. If *NONE is specified (the default) the operand is ignored.

Nonprivileged users can only specify values other than *NONE if they have specified SELECT=*PARAMETERS(OWNER=*OWN) above.

VERTICAL-CONTROL = *NONE / *LOOP(...)
Forms entries with the specified loop record are not taken into account. If *NONE is specified (the default), the operand is ignored.

LOOP-NAME = <alphanum-name 1..3 with-wild(24)> / list-poss(16): <alphanum-name 1..3>
Name of the loop record. If *NONE is specified (this is the default), the operand has no effect.

ROTATION-CONTROL = *NONE / *LOOP(...)
Forms entries with the specified loop record for rotation are not taken into account. If *NONE is specified (the default), the operand is ignored.

LOOP-NAME = <alphanum-name 1..3 with-wild(24)> / list-poss(16): <alphanum-name 1..3>
Name of the loop record. If *NONE is specified (the default), the operand is ignored.

CHARACTER-SET =*NONE / <alphanum-name 1..3 with-wild(24)> / list-poss(16): <alphanum-name 1..3>
Forms entries with the specified character set are not taken into account. If *NONE is specified (the default), the operand is ignored.

ROTATION-CHARACT-SET = *NONE / <alphanum-name 1..3 with-wild(24)> /
list-poss(16): <alphanum-name 1..3>
Forms entries with the specified character set for pages to be printed rotated are not taken into account. If *NONE is specified (the default), the operand is ignored.

BAND-IDENTIFICATION = *NONE / <alphanum-name 1..4 with-wild(24)> /
list-poss(16): <alphanum-name 4..4>
Forms entries with the specified type band are not taken into account. If *NONE is specified (the default), the operand is ignored.

PREFORM = *NONE / <alphanum-name 1..4 with-wild(24)> / list-poss(16): <alphanum-name 1..4>
Forms entries with the specified printer control character sequence are not taken into account. Only for LP-EMULATED-PRINTER. If *NONE is specified (the default), the operand is ignored.

CHARACTER-IMAGE = *NONE / <alphanum-name 1..3 with-wild(24)> /
list-poss(16): <alphanum-name 1..3>
Forms entries with the specified conversion table are not taken into account. If *NONE is specified (the default), the operand is ignored.

DIA-PROCESSING = *NONE / *PARAMETERS(...)
The specified settings for forms when using overlays are ignored.

DIA-PROCESSING = *PARAMETERS(...)
Specifies the settings for EFO and FOB data overlays to be ignored.

FORMS-OVERLAY = *NONE / <alphanum-name 1..2 with-wild(24)> /
list-poss(16): <alphanum-name 2..2>
The specified description of the EFO data overlay is ignored.

FORMS-OVERLAY-BUFFER = *NONE / <alphanum-name 1..4 with-wild(24)> /
list-poss(16): <alphanum-name 1..4>
The specified description of the FOB data overlay is ignored.

PRINTER-RESOURCES = *NONE / *APA(...)
Forms entries with the specified printer attributes are not taken into account. For APA printers only.
If *NONE is specified (the default), the operand is ignored.

PRINTER-RESOURCES = *APA(...)

FORM-DEFINITION = *NONE / <alphanum-name 1..8 with-wild(24)> /
list-poss(16): <alphanum-name 1..8>
Name of the FORMDEF. If *NONE is specified (the default), the operand is ignored.

PAGE-DEFINITION = *NONE / <alphanum-name 1..8 with-wild(24)> /
list-poss(16): <alphanum-name 1..8>
Name of the PAGEDEF. If *NONE is specified (the default), the operand is ignored.

CLUSTER-NAME = *LOCAL-CLUSTER / <alphanum-name 1..8>
Specifies the cluster for which the information is to be output. Only BS2000 clusters can be specified.

SERVER-NAME = *HOME / <alphanum-name 1..8>
Specifies the servers for which information is to be output.

INFORMATION = *SUMMARY / *ALL
Specifies which information is output. The output format depends on the contents of the VERTICAL-CONTROL and ROTATION-CONTROL fields.

INFORMATION = *SUMMARY
Only the first line of each element is output.

INFORMATION = *ALL
All the lines of each element are output.

Return codes

(SC2)	SC1	Maincode	Meaning
	0	CMD0001	No error
2	0	SPM0412	No form present
2	0	SPM0518	No authorization
	1	CMD0202	Syntax error
	32	SCP0974	System error. Command rejected
	64	SCP0975	No authorization for command

Outputs

The output format varies depending on the device type and the values for VERTICAL-CONTROL and ROTATION-CONTROL. The formats shown below are output when INFORMATION=*ALL is specified. When INFORMATION=*SUMMARY is specified, only the first line appears in each case.

Output when line densities are not defined for either VERTICAL-CONTROL or ROTATION-CONTROL

FORM-NAM DEV-TYPE  LI-S PA-S H-P T-P   VERT-CONTROL    ROT-CONTROL    OWNER
                                      L-N/LPI/C-P/C-S L-N/LPI/C-P/C-S
@@@@@@   ####@@@@@  ###  ### @@@ @@@  @@@ ### ### @@@ @@@ ### ### @@@ @@@@@@@
BAND-ID  PREFORM PAGE-DEF FORM-DEF S-O S-P-T  T-UP-P  CH-IM F-OV  F-O-B
@@@@     @@@@    @@@@@@@@ @@@@@@@@ @@@     #  @@@@@@  @@@@@ @@@@@ @@@@@
ACCESS-DATE : @@@@-@@-@@

Output when line densities are defined for VERTICAL-CONTROL and ROTATION-CONTROL

FORM-NAM DEV-TYPE  LI-S PA-S H-P T-P   VERT-CONTROL    ROT-CONTROL    OWNER
                                       L-P-I /C-P/C-S  L-P-I /C-P/C-S
@@@@@@   ####@@@@@  ###  ### @@@ @@@  ###/### ### @@@ ###/### ### @@@ @@@@@@@
BAND-ID  PREFORM PAGE-DEF FORM-DEF S-O S-P-T  T-UP-P  CH-IM F-OV  F-O-B
@@@@     @@@@    @@@@@@@@ @@@@@@@@ @@@     #  @@@@@@  @@@@@ @@@@@ @@@@@
ACCESS-DATE : @@@@-@@-@@

Output when line densities are only defined for VERTICAL-CONTROL

FORM-NAM DEV-TYPE  LI-S PA-S H-P T-P   VERT-CONTROL    ROT-CONTROL    OWNER
                                      L-N/LPI/C-P/C-S  L-P-I /C-P/C-S
@@@@@@   ####@@@@@  ###  ### @@@ @@@  @@@ ### ### @@@ ###/### ### @@@ @@@@@@@
BAND-ID  PREFORM PAGE-DEF FORM-DEF S-O S-P-T  T-UP-P  CH-IM F-OV  F-O-B
@@@@     @@@@    @@@@@@@@ @@@@@@@@ @@@     #  @@@@@@  @@@@@ @@@@@ @@@@@
ACCESS-DATE : @@@@-@@-@@

Output when line densities are only defined for ROTATION-CONTROL

FORM-NAM DEV-TYPE  LI-S PA-S H-P T-P   VERT-CONTROL    ROT-CONTROL    OWNER
                                      L-N/LPI/C-P/C-S  L-P-I /C-P/C-S
@@@@@@   ####@@@@@  ###  ### @@@ @@@  @@@ ### ### @@@ ###/### ### @@@ @@@@@@@
BAND-ID  PREFORM PAGE-DEF FORM-DEF S-O S-P-T  T-UP-P  CH-IM F-OV  F-O-B
@@@@     @@@@    @@@@@@@@ @@@@@@@@ @@@     #  @@@@@@  @@@@@ @@@@@ @@@@@
ACCESS-DATE : @@@@-@@-@@

Note the following points concerning the values for line density:

The asterisk (*) before the value in the LPI field indicates that it is the calculated value for line density and not a defined value (DENSITY(...) operand for ADD-/MODIFY-SPOOL-FORM).
If the field is labeled L-P-I (instead of LPI), the line density has been defined by means of the DENSITY(...) operand and is displayed in the form lines/inches. The loop name (L-N field) is not displayed.

Meanings of the fields

The name in parentheses is the corresponding operand for the SPSERVE statement ADD-SPOOL-FORM. The fields L-N (LOOP-NAME) and LPI are mutually exclusive; in other words, one of the two is always empty.

Output field	Meaning / Contents
ACCESS-DATE	Date of the last modification or utilization
BAND-ID	Name of the BAND-ID (type band)
CH-IM (CHARACTER-IMAGE)	Specifies whether a CHARACTER-IMAGE table has been defined for a specific device type
DEV-TYPE (DEVICE-TYPE)	Device type: only one device type is output per group; In the case of groups #### stands for: LP-PRINT (3337, 3338, 3339) HP-PRINT (3351, 3353) HP90-PR (2090, 2140) LP65-PR (3365) LP48-PR (3348, 3349) The remaining devices are not combined into groups
FORM-DEF	Standard form definition for APA printers
FORM-NAM (FORM-NAME)	Form name
H-P (HEADER-PAGE)	SPOOL header page: 2 header pages (YES), no header page (NO), 1 header page (ONE), 2 header pages after a restart (RESPOOL)
LI-S (LINE-SIZE)	Line length in 1/10 of an inch
OWNER	Under TSOS: User ID of the form owner, i.e. the RSO device administrator or system administration that created the form; For nonprivileged users, the output field is always blank
PAGE-DEF (PAGE-DEFINITION)	Standard PCL file for controlling print output to the APA printers;
PA-S (PAGE-SIZE)	Page size in 1/10 of an inch
PREFORM	Control character sequence for LP-EMULATED-PRINTER
ROT-CONTROL (ROTATION-CONTROL):	Page feed for rotated pages for HP laser printers and RSO printers 9021, 9022, 9022-200, 9025, 9026-RENO, 9026-LJ and LJII:
L-N (LOOP-NAME)	Name of the rotation loop assigned to the form by default;
LPI (LINES-PER-INCH)	Line spacing (RSO mode only);
L-P-I (LINES-PER-INCH)	Line spacing, specified as break (lines/inch)
C-P (CHANNEL1-POSITION)	Line number of the simulated rotation loop on which the “channel 1” vertical tabulator is defined;
C-S (CHARACTER-SET)	Name of the character set to be used by default for printout of rotated pages on this form.
S-O (STACKER-OFFSET)	Separation of the jobs by offset output of the paper stacks on the stacker (single page printers)
S-P-T (SEPARATOR-PAGE-TRAY)	Additional blank page between spoolout jobs; addition blank page between copies of the same job if a header page is printed before each copy
T-P (TRAILER-PAGE)	SPOOL trailer page: Of the three parts of the trailer page either 2 (YES) or 3 (INFO) are printed, or no trailer page is printed (NO)
T-UP-P (TWO-UP-PROCESSING)	Output of two pages side by side on HP90 laser printers and APA printers
VERT-CONTROL (VERTICAL-CONTROL):	Page feed:
L-N (LOOP-NAME)	Name of the loop assigned to the form by default;
LPI (LINES-PER-INCH)	Line spacing (RSO mode only);
L-P-I (LINES-PER-INCH)	Line spacing specified as break (lines/inch)
C-P (CHANNEL1-POSITION)	Line number of the simulated loop on which the “channel 1” vertical tabulator is defined;
C-S (CHARACTER-SET)	Name of the character set assigned to the form by default

Table 154: SHOW-SPOOL-FORMS output fields

Output in S variables

The INFORMATION operand identifies the S variables which are to be created. The possible values of INFORMATION are *ALL and *SUMMARY.

Output information	Name of the S variable	T	Contents	Condition
Type band ID	var(*LIST).BAND-ID	S	*NONE <band-id>	INF=*ALL
Name of the character image table	var(*LIST).CHAR-IMAGE	S	*NONE <char-image>	INF=*ALL
Character set name	var(*LIST).CHAR-SET	S	' ' <char-set-name>	INF=ALL/ SUM
Device type	var(*LIST).DEV-TYPE	S	' ' <dev-type>	INF=ALL/ SUM
Forms overlay buffer	var(*LIST).FOB	S	*NONE <fob>	INF=*ALL
Default form definition for APA printers	var(*LIST).FORM-DEF	S	*NONE <form-def>	INF=*ALL
Form name	var(*LIST).FORM-NAME	S	' ' <form-name>	INF=ALL/ SUM
Forms overlay	var(*LIST).FORM-OVERLAY	S	*NONE <form-overlay>	INF=*ALL
Print a header page NO: no header page ONE: 1 header page RESPOOL: 2 header pages following RESPOOL YES: 2 header pages	var(*LIST).HEAD-PAGE	S	NO ONE RESPOOL YES	INF=ALL/ SUM
Time stamp	var(*LIST).LAST-ACCESS	S	*NONE <yyyy-mm-dd>	INF=*ALL
Line length in 1/10"	var(*LIST).LINE-SIZE	S	30..180	INF=ALL /SUM
User ID of the form owner	var(*LIST).OWNER	S	' ' *NONE <user-id>	INF=ALL/ SUM
Number of the default PCL print output control file	var(*LIST).PAGE-DEF	S	*NONE 0..50000 <page-def>	INF=*ALL
Page size in 1/10"	var(*LIST).PAGE-SIZE	S	1..250	INF=ALL/ SUM
Control character sequence for LP-EMULATED-PRINTER	var(*LIST).PREFORM	S	*NONE <preform>	INF=*ALL
Character set used for rotated pages	var(*LIST).ROT-CHAR-SET	S	' ' <char-set-name>	INF=ALL/ SUM
Line number of the simulated ROTATION loop on which channel 1 is defined (selection criterion for form feed on rotated pages)	var(*LIST).ROT-CONTR.CHAN-1-POS	S	0..255	INF=ALL/ SUM
Form length in inches (selection criterion for form feed on rotated pages)	var(*LIST).ROT-CONTR.INCHES	S	0..999	INF=ALL/ SUM
Number of lines (selection criterion for form feed on rotated pages)	var(*LIST).ROT-CONTR.LINES	S	0..999	INF=ALL/ SUM
Line spacing, number of lines per inch (selection criterion for form feed on rotated pages)	var(*LIST).ROT-CONTR.LPI	S	0..999	INF=ALL/ SUM
Name of the ROTATION loop (selection criterion for form feed on rotated pages)	var(*LIST).ROT-CONTR.LOOP	S	' ' <loop-name>	INF=ALL/ SUM
Number of blank pages between spoolout jobs	var(*LIST).SEPAR-PAGE-TRAY	S	*NONE 1..3	INF=*ALL
Offset stacking of spoolout jobs	var(*LIST).STACKER-OFFSET	S	NO YES	INF=*ALL
Trailer page printing: INFO: print 3 trailer pages NO: no trailer pages *YES: print 2 trailer pages	var(*LIST).TRAIL-PAGE	S	INFO NO *YES	INF=ALL/ SUM
Print two pages side by side	var(*LIST).TWO-UP-PROCESS	S	MODE-1 MODE-2 *NO	INF=*ALL
Form feed controlled by LOOP record (position of the line on which channel 1 is located)	var(*LIST).VERT-CONTR.CHAN-1-POS	S	0..255	INF=ALL/ SUM
Form length in inches (form feed selection criterion)	var(*LIST).VERT-CONTR.INCHES	S	0..999	INF=ALL/ SUM
Number of lines (form feed selection criterion)	var(*LIST).VERT-CONTR.LINES	S	0..999	INF=ALL/ SUM
Name of the LOOP record (form feed selection criterion)	var(*LIST).VERT-CONTR.LOOP	S	' ' <loop-name>	INF=ALL/ SUM
Line spacing, lines per inch (form feed selection criterion)	var(*LIST).VERT-CONTR.LPI	S	0..999	INF=ALL/ SUM

Your Browser is not longer supported

Please use Google Chrome, Mozilla Firefox or Microsoft Edge to view the page correctly

SHOW-SPOOL-FORMS