Display PDF Map Entries (DSPPDFMAPE)

Where allowed to run:
  • Interactive job (*INTERACT)
Threadsafe: No
Parameters
Examples
Error messages

The Display PDF Map Entries (DSPPDFMAPE) command displays entries in the specified PDF map.

A filter can be specified to control which entries are displayed. Each map entry has critera to specify which spooled files it applies to. The filter you create for the Display PDF map entries command searches those criteria to determine which entries to display.

All the fields for the filter are used when scanning each entry in the PDF map for a match.

Top

Parameters

Keyword Description Choices Notes
PDFMAP PDF Map Qualified object name Required, Positional 1
Qualifier 1: PDF Map Name
Qualifier 2: Library Name, *LIBL, *CURLIB
FILTER Filter Element list Optional, Positional 2
Element 1: Output queue Qualified object name
Qualifier 1: Output queue Generic name, name, *ALL
Qualifier 2: Library Generic name, name, *LIBL, *CURLIB, *ALL
Element 2: Spooled file Generic name, name, *ALL
Element 3: Job name Generic name, name, *ALL
Element 4: User Generic name, name, *ALL
Element 5: User data Character value, *ALL
Element 6: Form type Character value, *ALL
Element 7: Routing tag Character value, *ALL
Top

PDF Map (PDFMAP)

Specifies the name of the PDF map to be displayed.

This is a required parameter.

Qualifier 1: PDF map

pdf-map-name
Specifies the name of the PDF map.

Qualifier 2: Library

*LIBL
All libraries in the job's library list are searched until the first match is found.
*CURLIB
The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
library-name
Specifies the name of the library to be searched.
Top

Filter (FILTER)

Specifies which entries in the PDF map to display. If you want to see all entries, specify *ALL for each filter entry. This is the default. If you want to see only certain types of entries, for example, all entries for spooled files on a specific output queue, enter values for any of the filter entries.

Element 1: Output queue

Qualifier 1: Output queue
*ALL
Specifies that any value for the output queue field in the PDF map entry satisfies this field in the filter. Do not specify a value for the library.
output-queue-name
Specifies the output queue name used as a search argument when scanning PDF map entries.
generic-name
Specify the generic name of the object to be considered a match. A generic name is a character string that contains one or more characters followed by an asterisk (*). All objects that have names with the same prefix as the generic name are considered a match for this field.
output-queue-name
Specifies that only a specific value in the Output queue name field in a PDF map entry satisfies this field in the filter. You must specify a value for the library.

Specify a library name only if you have specified a value other than *ALL for the output queue name. Otherwise, the library value is ignored.

Qualifier 2: Library
library-name
Specifies a specific value for the output queue library name argument. Only an exact match in the Library field in a PDF map entry satisfies this field in the filter.
generic-name
Specify the generic name of the output queue's library on the PDF map entry. A generic name is a character string that contains one or more characters followed by an asterisk (*). All objects that have names with the same prefix as the generic name are considered a match.
*LIBL
Specifies that only a value of *LIBL in the output queue's Library field in a PDF map entry satisfies this field in the filter.
*CURLIB
Specifies that only a value of *CURLIB in the output queue's Library field in a PDF map entry satisfies this field in the filter.
*ALL
Specifies that any value for the output queue's Library field in a PDF map entry satisfies this field in the filter.

Element 2: Spooled file

Specifies the spooled file name to be used as a search argument when scanning PDF map entries.

*ALL
Specifies that any value for the PDF map entry's Spooled file field satisfies this field in the filter.
spooled-file-name
Specifies a specific value for the PDF map entry's Spooled file argument. Only an exact match in the Spooled file field satisfies this field in the filter.
generic-name
Specify the generic name of the object to be considered a match. A generic name is a character string that contains one or more characters followed by an asterisk (*). All objects that have names with the same prefix as the generic name are considered a match for this field.

Element 3: Job name

Specifies the job name to be used as a search argument when scanning PDF map entries.

*ALL
Specifies that any value for the PDF map entry's Job name field satisfies this field in the filter.
job-name
Specifies a specific value for the PDF map entry's Job name argument. Only an exact match in the Job name field satisfies this field in the filter.
generic-name
Specify the generic name of the object to be considered a match. A generic name is a character string that contains one or more characters followed by an asterisk (*). All objects that have names with the same prefix as the generic name are considered a match for this field.

Element 4: User

Specifies the user name to be used as a search argument when scanning PDF map entries.

*ALL
Specifies that any value for the PDF map entry's User field in the PDF map entry satisfies this field in the filter.
user-name
Specifies a specific value for the PDF map entry's user name argument. Only an exact match in the User field satisfies this field in the filter.
generic-name
Specify the generic name of the object to be considered a match. A generic name is a character string that contains one or more characters followed by an asterisk (*). All objects that have names with the same prefix as the generic name are considered a match for this field.

Element 5: User data

Specifies the user data used as a search argument when scanning PDF map entries.

*ALL
Specifies that any value for the User data field in the PDF map entry satisfies this field in the filter.
user-data
Specifies a specific value for the user data argument. Only an exact match in the User data field in a PDF map entry satisfies this field in the filter.

Element 6: Form type

Specifies the form type to be used as a search argument when scanning PDF map entries.

*ALL
Specifies that any value for the PDF map entry's Form type field in the PDF map entry satisfies this field in the filter.
form-type
Specifies a specific value for the PDF map entry's Form type argument. Only an exact match in the Form type field satisfies this field in the filter.

Element 7: Routing tag

Specifies the routing tag used as a search argument when scanning PDF map entries.

*ALL
Specifies that any value for the PDF map entry's Routing tag field in the PDF map entry satisfies this field in the filter.
routing-tag
Specifies a specific value for the PDF map entry's Routing tag argument. Only an exact match in the routing tag field satisfies this field in the filter.
Top

Examples

Example 1:

DSPPDFMAPE    PDFMAP(QGPL/BIGSALES)
              FILTER(*ALL *ALL *ALL *ALL *ALL *ALL)

This command displays all map entries in the PDF map object.

Example 2:

DSPPDFMAPE    PDFMAP(QGPL/BIGSALES)
              FILTER(QGPL/SPECIAL *ALL *ALL *ALL *ALL *ALL)

This command displays all map entries in BIGSALES that specify an output queue of QGPL/SPECIAL.

Example 3:

DSPPDFMAPE    PDFMAP(QGPL/BIGSALES)
              FILTER(*LIBL/SPECIAL *ALL BIGTICKET *ALL *ALL *ALL)
              OUTPUT(*PRINT)

This command displays all map entries in BIGSALES that specify an output queue of *LIBL/SPECIAL and have a value for User data of 'BIGTICKET'.

Top

Error messages

*ESCAPE Messages

CPF9801
Object &2 in library &3 not found.
CPF9802
Not authorized to object &2 in &3.
CPF9803
Cannot allocate object &2 in library &3.
CPF9810
Library &1 not found.
CPF9820
Not authorized to use library &1.
Top