VTAM Printer Support print queue commands

This topic describes the print queue commands for the VTAM Printer Support (VPS) feature.

CREATEPQ command

Syntax

CREATEPQ (FROM CCAPRQ)

Description

The CREATEPQ command builds the print queue spooling file. The default DDNAME is CCAPRQ. You can use the FROM option to specify an alternate DDNAME.

If you specify SPOOLOPT=X'01' in CCAIN, the spool file is automatically opened.

DEFINE PRINT QUEUE command

Syntax

DEFINE PRINT QUEUE qname (option a) LIKE qname2 LENGTH lines WIDTH columns MAXIMUM max RETENTION n | NONE FORMS NONE | fname

Description

The DEFINE PRINT QUEUE command defines the print queue, using the following parameters:

qname is the associated queue name for this print queue. All references to this queue must be made using this name, including the USE command.

LIKE uses the option (a) characteristics of a previously defined print queue.

LENGTH specifies the number of lines per page. The default setting is 55 lines per page.

WIDTH specifies the number of columns per line with a maximum allowed setting of 256. The default is set at 120 columns per line.

MAXIMUM limits the number of USE print lines per request. The default of zero removes any limit.

RETENTION (optional) is the time in minutes that a print request is retained before purging from the queue. The default is NONE.

FORMS specifies the form, where fname is a 4-character forms name to be used when printing from this queue. The default is NONE, which bypasses any request for a forms change at the VTAM printer.

DELETE PRINT QUEUE command

Syntax

DELETE PRINT QUEUE qname

Description

The DELETE PRINT QUEUE command deletes the specified queue.

qname is the name of the print queue to be deleted.

Before using this command, you must purge the print queue using the PURGE QUEUE command so that no request is queued to the associated VTAM printer when the DELETE PRINT QUEUE command is executed.

DISPLAY PRINT QUEUE command

Syntax

DISPLAY PRINT QUEUE (ALL | qname) option (a) Queuing Printing ALL Waiting Retained NONE

Description

The DISPLAY PRINT QUEUE command displays print queue information.

ALL, the default, displays all print queue information. qname is the name of an individual print queue that you want to display.

To select specific print queue requests for display, specify one of the following (a) options:

• REQUEST ID is the assigned number for this request.
• CREATOR is the User ID of the creator of the request.
• DATE/TIME1 is the date/time that the print request was created from the USE command.
• LINES is the number of lines created from the print request.
• RET (Retention) is the specified time before a request is purged.
• ST specifies the request status:

Status	Means...
Queuing	Not yet implemented
Waiting	Request waiting on printer availability
Printing	Request currently printing
Retained	Reports held for a set retention option

• PRTR ID is the defined VTAM printer name.

DISPLAY PRINT QUEUE DEFINITIONS command

Syntax

DISPLAY PRINT QUEUE DEFINITION (ALL | qname)

Description

The DISPLAY PRINT QUEUE DEFINITIONS command displays the definitions of a print queue. This command can be issued only by the System Manager. The definition display consists of the following:

qname, LENGTH, WIDTH, MAXIMUM, RETENTION, FORMS

ALL, the default, displays all print queue definitions.

qname is the name of an individual print queue definition that you want to display.

The options for this command are described in DEFINE PRINT QUEUE.

PURGE PRINT QUEUE command

Syntax

PURGE PRINT QUEUE qname (WAITING |ALL | RETAINED)

Description

The PURGE PRINT QUEUE command purges the print queue of print requests.

ALL, the default, purges all requests including active printing requests and retained requests.

qname is the name of an individual queue that you want to purge.

WAITING purges only requests waiting for initial printing.

RETAINED purges all requests held with a retention setting.

REPRINT QUEUE command

Syntax

REPRINT QUEUE id | qname (RETENTION n | NONE)

Description

The REPRINT QUEUE command reprints the print queue.

id is the request ID.

qname is the name of an individual queue that you want to reprint.

RETENTION n (optional) is the time in minutes that a print request is retained before purging from the queue. The default is NONE.

REPRINT REQUEST command

Syntax

REPRINT REQUEST id (RETENTION n | NONE)

Description

The REPRINT REQUEST command reprints a specified request.

id is the request ID for the request you want to reprint.

RETENTION n (optional) is the time in minutes that a print request is retained before purging from the queue. The default is NONE.

RESUME PRINT QUEUE command

Syntax

RESUME PRINT QUEUE (ALL | qname)

Description

The RESUME PRINT QUEUE command reactivates a queue suspended with the SUSPEND PRINT QUEUE command.

ALL, the default, resumes all print queues.

qname is a the name of an individual print queue that you want to resume.

SUSPEND PRINT QUEUE command

Syntax

SUSPEND PRINT QUEUE (ALL | qname)

Description

The SUSPEND PRINT QUEUE command halts activity within a print queue. The queue enters the suspended state until all current activity has been complete. Use the RESUME PRINT QUEUE command to reactivate the print queue.

ALL, the default, suspends all print queues.

qname is a the name of an individual print queue that you want to suspend.

USE PRINT QUEUE command

Syntax

USE PRINT QUEUE qname (RETENTION n | NONE) DISCARD | PRINT PARTIAL FORMS fname

Description

The USE PRINT QUEUE command spools the print output to the specified print queue.

qname is the print queue to which the output is spooled.

RETENTION (optional) overrides any retention specified when the print queue was defined.

DISCARD PARTIAL indicates that if, during the spooling of a USE command, the print queue is closed or another problem occurs, then the partial output is purged. PRINT PARTIAL saves the partial output for printing.

fname specifies an alternative form name when you use the FORMS option.