pdpromote command: advances a job to the top of a queue
Syntax
pdpromote [-H host:port] [-m "MessageText"] [-x "attribute=value …"]
[-X AttributesFileName] {LocalJobID | GlobalJobID}
pdpromote -h
Description
Use the pdpromote administrative command to move a pending job before any currently-queued jobs. The job becomes the first job in the queue. If you then promote another job, it becomes the first job in the queue ahead of the job previously promoted.
A move to the beginning of the queue does not necessarily guarantee that the job is the next job to be printed or sent. The jobs currently printing on each of the actual destinations associated with the queue continue printing. The server assigns the promoted job to the first actual destination that:
- Becomes available
- Uses the job-priority scheduler
- Is capable of handling the promoted job
You can change the priority level of a job by setting the job-priority attribute with the pdmod or the pdset command. However, InfoPrint promotes a job regardless of its priority to the top of the queue when you use the pdpromote command.
Flags
You can use these flags with the pdpromote command:
- -Hhost:port
-
Identifies the host and port of the InfoPrint Manager server used for communication. When not specified, the command follows the Configuration logic to define the host and socket.
- -m"MessageText"
- Specifies the message you want to store in the job-message-from-administrator attribute. You can use this message to indicate why you want to promote the job or
to provide any other comments. If you do not specify the -m flag, the message already stored with the job remains unchanged.
You can list this message by specifying requested-attributes=job-message-from-administrator with the pdls command.
Using this flag is equivalent to specifying the command attribute message.
- -x"attribute=value …"
- A single attribute string, consisting of one or more attribute and value pairs.
- -XAttributesFileName
- Specifies the name of a file containing attribute and value pairs that you want InfoPrint to insert at the current point in the command.
Using this flag is equivalent to specifying the command attribute attributes.
- -h
- Displays a command-specific help message containing information about command syntax and flags. If you use this flag with any other flag or attribute, InfoPrint recognizes only the -h flag.
Configuration logic
The command determines which server host and server port to use based on this sequence:
- Server host and server port specified with the -H parameter.
- Server host and server port specified with the PDHOST and PD_SOCKET envirnonment variables.
- Uses the defaults for PDHOST=localhost and PD_SOCKET=6874.
Command attributes
You can specify these attributes in a -x "attribute=value …" string or in an attributes file designated with the -X AttributesFileName flag.
- attributes=AttributesFileName
- Specifies the designated attributes file that InfoPrint reads and inserts at the current point in the command. This file contains attribute and value pairs that InfoPrint uses to expand the command.
- message="MessageText"
- Specifies a message you want to store in the job-message-from-administrator attribute. You can use this message to indicate why you want to promote this job
or to provide any other comments. If you do not specify the message attribute, the message already stored with the job remains unchanged.
You can list this message by specifying requested-attributes=job-message-from-administrator with the pdls command.
Arguments
Use the argument value to identify the specific object that you want InfoPrint to promote. You can use these arguments with the pdpromote command:
- LocalJobID or GlobalJobID
- Specifies the job you want to promote. By default, end users do not have permission to promote jobs. Therefore, in most cases someone other than the job submitter will promote a job and must identify it by the global job ID. Job submitters who do have permission to promote jobs can identify their own jobs by the local job ID.
When you specify a job with the pdpromote command, it becomes the first job in the queue. If another job is then promoted, it becomes the first job in the queue (ahead of the job previously promoted).
Example
To promote job Serv1:1099600001 and add a job message from the administrator, enter the command:
pdpromote -m "This job must be printed in 10 minutes" Serv1:1099600001
Suggested reading
For more information, see Attributes file.