Action Code 14 Clear Queue and SP-CLEAR

Deletes all print jobs in the specified job file from a specified formqueue.

Prompts

Form Queue -

TCL syntax

SP-CLEAR {job-file} queue-name {(options}}

Prompt/Syntax elements

queue-name (Form Queue -)
The name of the formqueue to be cleared.

job-file Specifies the job file to be used for the duration of the command execution. If you specify job-file you must also use the F option.

Options

F Specifies that the first parameter after the verb is the required job file.

U Determines the job files containing all print jobs in the formqueue from their PRINT.JOB.CONTROL items. This means all jobs in the formqueue are deleted irrespective of job file.

D Removes the records older than the specified date and allows the jobs to be copied to archive files if required.

Restrictions

Print jobs with 'Open' and 'Edit' status cannot be cleared.

Comments

Both 'Queued' and 'Print' jobs can be deleted.  Print jobs being printed are killed, then deleted from the formqueue.

Only print jobs from the specified job file are cleared, unless you use the U option, in which case all print jobs are cleared from the queue.

Example 1

To delete all print jobs from the formqueue FINANCE regardless of job file, enter:

SP-CLEAR FINANCE (U

Alternatively, enter:

SP-JOBS (U

then select Action Code 14 on the Print Jobs screen.

At the next prompt, enter the formqueue name, as follows:

Form Queue - FINANCE

The formqueue FINANCE is now empty.

If the jobs to be deleted are in the job file INVOICES which is not currently the specified job file, enter:

SP-CLEAR INVOICES FINANCE (F

This will then clear all jobs in file INVOICES from formqueue FINANCE.

Example 2

The first time the D option is used, two new files will be created. These files are named SPOOL.JOBS.ARCHIVE and PRINT.JOB.CONTROL.ARCHIVE.

This new feature may only be used from TCL. The following example describes the use of the D switch.

To delete the spool jobs from the formqueue STANDARD and to add the spool jobs to archive files:

Enter

SP-CLEAR (D

Enter the name of the spool queue to clear.

Form Queue - STANDARD

Enter the date after which the spool jobs would not be cleared.

Enter date (dd/mm/yy) - 03/04/23

Specify whether the spool jobs should be copied to archive files.

Archive jobs (Y/N) - Y

Records will be archived to SPOOL.JOBS.ARCHIVE and PRINT.JOB.CONTROL.ARCHIVE.

If the Archive by date switch has been used as above the spool jobs will be removed from SPOOL.JOBS and PRINT.JOB.CONTROL and will be copied to the archive files from where they may be retrieved if required.