SP-JOBS

Displays and maintains print jobs in the Spooler's formqueues.

TCL Syntax

SP-JOBS {job-file} {(options}

Syntax Elements

job-file is the specified job file for which print jobs are to be listed. If you specify job-file you must also use the F option.

The specified job file can be changed using SP-JOBS Action Code 18. Refer to the topic Specified Job File.

Options

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

U Determines the job file of each print job from its PRINT.JOB.CONTROL item. This means that all print jobs in the Spooler are displayed.

Print Jobs Screen

Entering SP-JOBS at TCL displays the following:

08:09:07  19 Oct 2002                    6 Print Jobs            Page    1/   1

Job-Id    Queue Name     Port  Status    User       Job Created CP OP Size Prtd

1         STANDARD         18  No ProcessSYSMAN    14 Oct 12:11  1  A    5    0
2         INVOICES          3  Print     ACCOUNTS  19 Oct 15:03  2      12    6
3         RECEIPTS          9  Queued    ACCOUNTS  19 Oct 15:15  1      14    0
4         LABELS           31  Hold      ADMIN     19 Oct 15:15 10  H    6   23
5         INVOICES          7  Queued    ACCOUNTS  19 Oct 15:17  2      13    0 
6         INVOICES         12  Queued    ACCOUNTS  19:Oct 15:18  2      15    0






1. Switch All Jobs 6. Stop Printing   11. SP-STATUS       16. Detail Display
2. Switch One Job  7. Resume Printing 12. Kill Printing   17. Reset Selection
3. Change Options  8. Edit Print Job  13. Align Printer   18. Change Job File
4. Change #Copies  9. Suspend Print   14. Clear Queue     19. Requeue Hold File
5. Delete Job     10. Top Priority    15. FQ/System Jobs  99. Exit
Enter action code / Option (P#;PT#;A acctname;U Userid;Q quename;S status)

Note: The Print Jobs screen only shows the status of print jobs in the Reality formqueues. To obtain information about print jobs in the system queue, select Action Code 15.

Specified Job File

When you enter an SP-JOBS action code or TCL command that references print jobs, the command operates on print jobs in one job file only, unless you use the command with the U option. This file is designated the "specified job file". The Spooler software determines the specified job file, as follows:

At logon the SPOOL.JOBS file is the system default job file for all formqueues, unless the default is redefined. See step 2.
If the default job file is defined in the formqueue's definition item in the FORM.QUEUES file (FQM Option 10), this overrides the system default (SPOOL.JOBS). See Spooling System Maintenance.
If you enter an SP-ASSIGN command and specify the job file using the syntax FILE=job-file, that becomes the specified job file, overriding the default job file, and remains so, as long as it is not re-specified by another SP-ASSIGN, or job-file is not specified explicitly in any other Spooler command, as described in steps 4 and 5.
If you enter SP-JOBS, or any other Spooler command that references print jobs, and specify a job file name with the F option, then job-file entered in the command statement becomes the specified job file and remains so for the duration of command execution, unless step 6 is carried out.
If you enter a command such as SP-JOBS, SP-SWITCH, SP-DELETE, etc. and specify the U option, all job files are used and all print jobs are recognised by the command. The job file for each print job is determined from its PRINT.JOB.CONTROL item. This option is maintained until the command exits, when the specified job file reverts to what it was before the command was entered. In SP-JOBS the U option cannot be overridden by Action Code 18 (Step 6 below).
If during the execution of SP-JOBS, you select Action Code 18 and enter a job file name, that becomes the specified job file, overriding the job file specified in the initial SP-JOBS command, unless the U option has been used (Step 5). This remains the specified job file throughout the current execution of SP-JOBS, unless you enter a new job file name at an action code prompt or you select Action Code 18 again. When SP-JOBS is exited, the specified job file reverts to whatever it was when SP-JOBS was entered.

Selecting an Action Code

To select an action code, enter the appropriate number at the Print Jobs screen prompt. For example, to create a new formqueue, enter 1 at the prompt, as shown below:

Enter action code / Option (P#;PT#;A acctname;U Userid;Q quename;S status)1

On entering the number, you are prompted for the parameters required to execute the command. In the above example (Action Code 1), you are prompted for:

From-Form-Queue

where you enter the name of the queue containing the print jobs you wish to move. Then:

To-Form-Queue

where you enter the name of the formqueue you wish to move them to.

Selecting an Option

Instead of an action code, you can select one of the following options:

P# Skips to a specified screen page of the Print Jobs display. The number of pages and the current page are indicated in the top right corner of the screen. To page through the display, press RETURN. To skip directly to a particular page, for example to page 3, enter:

P3

PT# Displays print jobs queued from a specified port only. For example, to display all jobs spooled from port 7, enter:

PT7

A acctname Displays print jobs queued from a specified account only. For example, to display all print jobs from the PUBLICATIONS account, enter:

A PUBLICATIONS

U userid Displays print jobs queued from a specified user-id only. For example, to display all print jobs from the user-id personnel, enter:

U personnel

Q queuename Displays print jobs queued in the same formqueue only. For example, to display all print jobs in the formqueue INVOICES, enter:

Q INVOICES

S status Displays all print jobs with the same specified status only. See Status Conditions and Values for a list of valid status conditions. For example, to display all jobs being edited, enter:

S EDIT

Use of the Equivalent TCL Command

Instead of selecting the action code on the Print Jobs screen, you can enter the equivalent TCL command with appropriate parameters. For example, instead of Action Code 1 you can enter SP-MOVEQ with parameters from-form-queue and to-form-queue. Action Codes 1 to 14 and 16 have equivalent TCL commands.

TCL Command without Parameters

If you enter a TCL command without the necessary parameters, it prompts you for them. The prompts are the same as those which appear when you select the associated action code.

Exiting to TCL

To exit to the TCL prompt, select Action Code 99.

Print Jobs Screen Fields

Job-id Identity of print job.

Queue Name Name of the formqueue to which the print job is assigned.

Port Port from which the print job originates.

Status Status condition of the print job. See Status Conditions and Values for a description of status conditions.

User User-id under which the print job was created.

Job Created Date and time at which the print job was created.

CP Number of copies requested.

OP Options assigned to the print job.

Size Number of frames the print job occupies.

Prtd Number of frames that have been despooled. This is updated every 20 frames and at the end of the job.