pdmod command: modifies attributes of submitted print jobs

Syntax

pdmod [-H host:port] [-g] [-m "MessageText"] [-n CopyCount]
[-r attribute …] [-s StyleName] [-t JobName]
[-x "attribute=value …"] [-X AttributesFileName]
{LocalJobID … | GlobalJobID …}

pdmod -h

Description

Use the pdmod command to modify the values of job and document attributes of previously submitted jobs.

You can specify any resettable job and document attributes. See the pd_att_job and pd_att_document man pages for descriptions of all job and document attributes.

You can only modify preprocessing, pending, held, paused, or retained jobs. In general, you cannot modify processing or printing jobs. The only exception is if you modify only job-hold=true, the job will be canceled from the printer and then modified.

Modifying an existing job might affect the scheduling of the job.

The next table lists the four modification operators.

pdmod operators

Operator Syntax Description
Replace attribute=value Replaces the entire value of the attribute with value, or if not already present, adds the attribute-value pair to the job.
Add values attribute+=value Adds the value value to the attribute. You cannot add values to single-valued attributes. An add request that duplicates values on a multi-valued attribute has no effect on the job.
Remove values attribute-=value Removes the value value from the attribute. A remove request for a nonexistent value has no effect on the object. A remove request for the last or only value of an attribute is equivalent to a reset-to-default request.
Reset to default attribute== Sets the attribute to the default values according to the job-defaulting hierarchy. If you supply values with a reset request, InfoPrint ignores them.

If you do not specify a value with a replace, add, or remove request, InfoPrint issues an error and rejects the request to change the attribute value for the object.

Note: If InfoPrint does not accept a modification, InfoPrint rejects the whole request and the job continues as before.

Use the global job identifier to identify jobs belonging to another person.

If the ignore-ivo-values attribute is set to true on the server and the request is to default or remove a value and there are no values left for that attribute, InfoPrint Manager ignores the value of the job and document default attribute when setting its value. See the ignore-ivo-values attribute.

Flags

You can use these flags with the pdmod command:

-H host: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.

-g
Turns off headings.

Using this flag is equivalent to specifying the command attribute headings=false.

-m "MessageText"
Specifies the message you want to store in the job-message-from-administrator attribute. You can use the message to give the reason why you are modifying 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.

-n CopyCount
Specifies the number of document copies.

Using this flag is equivalent to specifying the object attribute copy-count.

-r {none | brief | verbose} DEFAULT=none
Specifies the attribute values you want to display for the specified object.
none
Displays no attributes.
brief
Displays a small subset of important attributes for each object.
verbose
Displays a larger subset of important attributes for each object.

Using this flag is equivalent to specifying the command attribute requested-attributes.

-s {column | doccol | line} DEFAULT=column
When combined with the -r flag or the requested-attributes command attribute, specifies the format in which you want InfoPrint to display the attributes.
column
Attribute values are displayed in tabular format, so that values of the same attribute for multiple objects line up in columns.
doccol
For jobs only, job attribute values and the document attribute values for the first document in the job are displayed in column format on the same line.
line
Each attribute is displayed on a separate line.

Using this flag is equivalent to specifying the command attribute style.

-t JobName
Specifies the new name you want for the job.

Using this flag is equivalent to specifying the object attribute job-name.

-x "attribute=value …"
Consists of an attribute string, containing one or more attribute-value pairs. Prefix the attribute value with the replace operator, =, to replace a value, with the add-values operator, +=, to add a value, or the remove-values operator, with no attribute value to set the attribute to its default value.
-X AttributesFileName
Specifies the name of a file containing attribute and value pairs 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:

  1. Server host and server port specified with the -H parameter.
  2. Server host and server port specified with the PDHOST and PD_SOCKET envirnonment variables.
  3. Uses the defaults for PDHOST=localhost and PD_SOCKET=6874.
Note: This configuration logic enables multiple commands to run on a single machine communicating with one or more InfoPrint Manager servers.

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.
headings={true | false} DEFAULT=true
Specifies if you want InfoPrint to display headings on the output.
message="MessageText"
Specifies the message you want to store in the job-message-from-administrator attribute. You can use the message to give the reason why you are modifying the 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.

requested-attributes={none | brief verbose} DEFAULT=none
Specifies which attributes you want displayed.
none
Displays no attributes.
brief
Displays a small subset of important attributes for each object.
verbose
Displays a larger subset of important attributes for each object.
style={column | doccol | line} DEFAULT=column
Specifies the presentation format that you want for the displayed output.
column
Attribute values are displayed in tabular format, so that values of the same attribute for multiple objects line up in columns.
doccol
For jobs only, job attribute values and the document attribute values for the first document in the job are displayed in column format on the same line.
line
Each attribute is displayed on a separate line.

Arguments

Use the argument value to identify the specific object that you want to modify. If you specify multiple objects, separate the object names with spaces.

LocalJobID or GlobalJobID
Specifies the local or global job identifier.

Examples

  • Modify content orientation

    To modify the job with a local ID of 10 and change the orientation to landscape, enter the command:

    pdmod -x "content-orientation=landscape" 10

  • Modify job hold condition

    To modify the job attribute job-hold to false for job 10 so that InfoPrint can schedule the job (previously submitted with job-hold set to true), enter the command:

    pdmod -x "job-hold=false" 10

  • Modify job comment

    To modify the job attribute job-comment to Test Results 100 for job 10, enter the command:

    pdmod -x "job-comment='Test Results 100'" 10

  • Modify the number of sides that print

    To modify the document attribute sides to specify that all documents in the job with global identifier DivSpool2:1011222243 should print on both sides, enter the command:

    pdmod -x "sides=2" DivSpool2:1011222243

  • Add a destination location request

    To add a destination location request to job 10, enter the command:

    pdmod -x "destination-locations-requested+='bldg.10 room 1-15'" 10

  • Remove a destination location request

    To remove a destination location request from job 10, enter the command:

    pdmod -x "destination-locations-requested-='bldg.25 room 3-22'" 10

  • Remove all destination location requests

    To remove all destination locations requested from job 10, enter the command:

    pdmod -x "destination-locations-requested==" 10

  • Combining modifications

    To modify job 17, by changing the content-orientation and removing the hold on the job, enter the command:

    pdmod -x "content-orientation=landscape job-hold=false" 17

Suggested reading in hardcopy

For information about: