Show filter definitions
Component: | SPOOL |
Functional area: | Controlling spoolout job |
Domain: | SPOOL-PRINT-ADMINISTRATION |
Privileges: | HARDWARE-MAINTENANCE |
Function
The SHOW-SPOOL-FILTERS command requests information on the filter definitions from the SPOOL parameter file.
The command supports structured output in S variables (see "Output in S variables").
Format
SHOW-SPOOL-FILTERS | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Operands
SELECT = *ALL / *PARAMETERS(...)
Specifies according to which criteria the filters are to be selected for which information is requested. If *ALL (default) is specified, information is displayed on all the filters entered.
SELECT = *PARAMETERS(...)
Starts a list of selection criteria.
FILTER-NAME = *ALL / <alphanum-name 1..8 with-wild(24)> / list-poss(255): <alphanum-name 1..8>
The symbolic name of the filter is the selection criterion.
FILTER-LOCATION = *ALL / <composed-name 1..50 with-wild(24)> / list-poss(255): *SYSTEM / <composed-name 1..50>
The object module of the filter is the selection criterion.
INPUT-FORMAT-NAME = *ALL / list-poss(16): *TEXT / *HP / *SPDS / *PCL /*PLAIN-TEXT /
<c-string 1..63 with-low>
The input format, i.e. the document format converted by the filter is the selection criterion.
OUTPUT-FORMAT-NAME = *ALL / list-poss(16): *TEXT / *HP / *SPDS / *PCL /*PLAIN-TEXT /
<c-string 1..63 with-low>
The output format, i.e. the document format into which the filter converts the data is the selection criterion.
REDIRECTION = *ALL / *NO / *REMOTE(...)
The remote printer to which the SPOOLOUT jobs that use the filter have to be diverted is the selection criterion.
DEVICE-NAME = *ALL / <alphanum-name 1..8>
Name of the printer.
OBJECT-NAME = *ALL / <alphanum-name 1..8 with-wild(24)> / <alphanum-name 1..8>
The filter object module name (type R library element) is the selection criterion.
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.
EXCEPT = *NONE / *PARAMETERS(...)
Specifies which filter entries are to be excluded from the selection (negative list).
EXCEPT = *NONE
None of the filter entries are excluded from the selection.
EXCEPT = *PARAMETERS(...)
Introduces a list of exclusion criteria.
FILTER-NAME = *NONE / <alphanum-name 1..8 with-wild(24)> / list-poss(255): <alphanum-name 1..8>
Filter entries with the specified symbolic name are excluded.
FILTER-LOCATION = *NONE / <composed-name 1..50 with-wild(24)> / list-poss(255): *SYSTEM /
<composed-name 1..50>
Filter entries with the specified object module are excluded.
INPUT-FORMAT-NAME = *NONE / list-poss(16): *TEXT / *HP / *SPDS / *PCL / *PLAIN-TEXT /
<c-string 1..63 with-low>
Filter entries with the specified input format are excluded.
OUTPUT-FORMAT-NAME = *NONE / list-poss(16): *TEXT / *HP / *SPDS / *PCL / *PLAIN-TEXT /
<c-string 1..63 with-low>
Filter entries with the specified output format are excluded.
REDIRECTION = *NONE / *NO / *REMOTE(...)
Filter entries whose SPOOLOUT jobs have to be diverted to the specified remote printers are excluded.
DEVICE-NAME = *NONE / <alphanum-name 1..8>
Specifies the name of the printer.
OBJECT-NAME = *NONE / <alphanum-name 1..8 with-wild(24)> / <alphanum-name 1..8>
Filter entries with the specified filter object module names (type R library element) are excluded.
CLUSTER-NAME = *STD / *LOCAL-CLUSTER / <alphanum-name 1..8>
Specifies the cluster for which information is to be issued.
*LOCAL-CLUSTER is presumed for *STD (see SERVER-NAME for further details).
SERVER-NAME = *STD / *HOME / <alphanum-name 1..8>
Specifies the servers for which information is to be issued.
*HOME is presumed for *STD.
*STD has been introduced for reasons of compatibility. The default source parameter file for this command depends on the work mode (static, dynamic, on-configuration or command).
If a SPOOL parameter file is specified (mode: static or dynamic), that is the default source parameter file. If no parameter files are specified (mode: on-configuration or command) the default source parameter file is the home system spool parameter file.
INFORMATION = *SUMMARY / *ALL
Specifies the information to be issued.
INFORMATION = *SUMMARY
Only the first line is output for each element.
INFORMATION = *ALL
All lines are output for each element.
Return codes
(SC2) | SC1 | Maincode | Meaning |
|---|---|---|---|
0 | CMD0001 | No error | |
2 | 0 | SPM0412 | No filter exists |
2 | 0 | SPM0518 | User is not authorized |
1 | CMD0202 | Syntax error | |
32 | SCP0974 | System error. Command rejected | |
64 | SCP0975 | No authorization for this command |
Output formats
(1) INFORMATION = *SUMMARY
FILTER-NAME FILTER-LOCATION @@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
(2) INFORMATION = *ALL
FILTER-NAME FILTER-LOCATION @@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ ACCESS-DATE : @@@@-@@-@@ INPUT-FORMAT-NAMES @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ OUTPUT-FORMAT-NAME @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ REDIRECTION = @@@@@@@ (DEVICE-NAME = @@@@@@@@) OBJECT-NAME = @@@@@@@@
Meaning of the output fields
Output field | Contents |
|---|---|
ACCESS-DATE | Date of the last modification or utilization |
FILTER-LOCATION | Library in which the filter and the SDF-P-LOGON procedure allowing the filter to be loaded and executed are stored. |
FILTER-NAME | Symbolic filter name. |
INPUT-FORMAT-NAMES | Name of the lists of input formats. |
OUTPUT-FORMAT-NAME | Output formats. |
REDIRECTION | Option allowing SPOOL jobs to be redirected to remote printers. |
DEVICE-NAME | Remote printer name |
OBJECT-NAME | Object module name |
Output in S variables
The command's INFORMATION operand identifies the S variables which are to be created. The possible values for INFORMATION are *ALL and *SUMMARY.
Output information | Name of the S variable | T | Contents | Condition |
|---|---|---|---|---|
Name of the remote printer | var(*LIST).DEVICE-NAME | S | ' ' | INF=*ALL |
Library in which the filter and the LOGON procedure which permits it to be loaded and executed is stored | var(*LIST).FILTER-LOCATION | S | *SYSTEM | INF=*ALL/ |
Symbolic name of filter | var(*LIST).FILTER-NAME | S | ' ' | INF=*ALL/ |
Name of the list of input formats | var(*LIST).INPUT-FORMAT-NAME(*LIST) | S | ' ' | INF=*ALL |
Time stamp | var(*LIST).LAST-ACCESS | S | *NONE | INF=*ALL |
Name of the object module | var(*LIST).OBJECT-NAME | S | ' ' | INF=*ALL |
Output formats | var(*LIST).OUTPUT-FORMAT-NAME | S | ' ' | INF=*ALL |
Option to redirect SPOOL jobs to remote printers | var(*LIST).REDIRECTION | S | *REMOTE | INF=*ALL |