printxchange command line interface guide (pdf, 1.33 · pdf fileprinted in the united states...
TRANSCRIPT
PrintXchangeCommand Line InterfaceReference Guide
Version 1.2613P07260May 1998
Xerox Corporation701 S. Aviation BoulevardEl Segundo, CA 90245
Publication 613P07260
May 1998
© Copyright 1997-1998 Xerox Corporation. All rights reserved. Portions of this software also include copywritten software modules from Sun Microsystems, Digital Equipment Corporation, and Raima Corporation.
Copyright protection claimed includes all forms and matters of copyrightable material and information now allowed by statutory or judicial law or hereinafter granted, including without limitation, material generated from the software programs which are displayed on the screen, such as icons, screen displays, looks, etc.
Xerox, The Document Company, the stylized X, and all Xerox product names mentioned in this publication are trademarks of Xerox Corporation. Sun, SPARCstation, NIS, NIS+, OpenWindows, and Solaris are registered trademarks of Sun Microsystems, Inc. Microsoft, Windows NT, Windows 95, and LAN Manager are registered trademarks of Microsoft Corporation. IBM is a registered trademark of Internation Business Machines Corporation. Digital is a registered trademark of Digital Equipment Corporation. Apple and Macintosh are registered trademarks of Adobe Systems Incorporated. NetWare is a registered trademark of Novell, Incorporated. Common Desktop Environment is a copyright of the Common Operating System Environment. Other product names used herein are trademarks of their respective owners.
Changes are periodically made to this document. Changes, technical inaccuracies, and typographic errors will be corrected in subsequent editions. Printed in the United States of America.
1. Overview
The PrintXchange Command Line Interface Reference Guide provides information on maintaining and operating the PrintXchange printing system. It consists of the following:
• Chapter 1, an overview of the command line interface
• Chapters 2 through 18, PrintXchange commands
• Appendix A, Attributes
• Appendix B, Filters
• Appendix C, Attribute mapping
• Appendix D, Events
• Appendix E, -r verbose & -r brief attributes
Related documentation
In addition to this guide, the following PrintXchange publications are available:
• Command Line Interface User Guide. A guide available to CLI users that provides information on submitting jobs to your printer using the command line on your workstation.
• System Administration and Operations Guide. A guide intended to be used by PrintXchange administrators and operators when performing the tasks related to day-to-day management of the system.
• UNIX man pages. A quick reference for information on PrintXchange commands. They are available to all UNIX CLI users.
• On-line help files. An on-line guide, available to Windows NT users, that provides information on PrintXchange functionality.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 3
OVERVIEW
Notation conventions
This guide uses the following command line notation conventions:
• Attribute names and actual values of variables are presented in bold text. For example, class =job .
• Variable information is presented in italic text. For example, filename, option_argument, object_instance, class =class_name.
• Square brackets ( [ ] ) indicate that the information within the brackets is optional. The brackets themselves are not part of the option/operand and should not be included in the command line.
• Ellipses ( ... ) denote that one or more occurrences of an option or operand is allowed. When an option or operand followed by ellipses is enclosed in square brackets, then zero or more options or operands are allowed.
Examples:
— command_name -a option_argument ... [operand ... ]
One or more instances of option_argument can be present for a single instance of the -a option. Zero or more operands can be present.
— command_name [-b option_argument] ... [operand ... ]
Zero or more instances of the -b option can be present. Each instance of the -b option has one instance of option_argument. Zero or more operands can be present.
About the CLI
This chapter describes the syntax and behavior of the command line interface (CLI). The CLI is accessible through the UNIX workstation and through the Windows NT and Windows95 console mode (via the DOS command prompt).
The CLI gives you access to all of the PrintXchange functionality. The CLI consists of commands that you may invoke either directly or by scripts.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 4
OVERVIEW
CLI for Windows NT
For Windows NT users, the CLI provides the PrintXchange administrator with a programmable interface that enables batch and off-hours processing as well as integration with other script-enabled applications. It also provides access to PrintXchange processing information that enables the administrator to better manage the printing system.
Depending on the administrator's system knowledge as well as the goals of the printing system, the CLI for Windows NT can reside in any of the following three environments:
• Windows NT Command Interpreter + Resource Kit
This environment is recommended for administrators who want to use simple scripts and who are familiar with DOS batch scripts.
• Bourne Again Shell (BASH)
This environment is recommended for administrators who are familiar with the UNIX shell environment.
• Practical Extraction and Report Language (Perl)
This environment is recommended for administrators who want to use complicated text processing scripts.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 5
OVERVIEW
CLI user privileges
PrintXchange users are classified by privilege level. The ability to access PrintXchange commands depends on the privilege level assigned. The three privilege levels are:
• End user
• Operator
• Administrator
The user privilege levels have an access order. An administrator can configure objects in addition to performing all operator tasks. An operator can control printing and perform all end user tasks.
End user
As an end user, you can:
• Submit a print job to a printer supported by the print server.
• List the names and values of print object attributes.
• Request the status of print jobs.
• Modify or set job and document attributes of your previously submitted jobs.
• Remove (cancel) your previously submitted print jobs or particular documents within a multi-document job.
• Request that your print jobs be resubmitted to another specified printer.
• Pause and resume printing of your jobs.
Operator
In addition to accessing all of the commands available to the end user, an operator can:
• Delete previously submitted print jobs or particular documents within a multi-document job.
• Cause a specified print job to be moved forward to print next on the physical printer to which it was submitted.
• Request that specified print jobs that have been accepted by a print server be resubmitted to another specified printer.
• Enable the acceptance of new print jobs by the specified printer, queue, or server.
• Disable the acceptance of new print jobs by the specified printer, queue, or server.
• Set xxx-ready attributes on physical printers.
• Pause pending jobs, currently printing jobs, printers, queues or spoolers.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 6
OVERVIEW
• Resume paused jobs, printers, queues, or spoolers.
• Delete all jobs residing on a spooler.
• Delete all jobs in a queue.
• Shut down a spooler or supervisor.
Administrator
In addition to those commands performed by end users and operators, an administrator can:
• Create initial-value-documents, initial-value-jobs, printers, or queues, and set their attributes to the values specified in the options.
• Delete document, job, initial-value-document, initial-value-job, printer, server, and queue objects.
• Set the attribute values for all print objects.
• Set event notification and access rights for all print objects.
• Generate data for a print job accounting report.
• Display attributes in the object identifier database and add attributes to the database.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 7
OVERVIEW
CLI syntax and elements
The syntax for all PrintXchange commands has the following format:
Figure 1-1. Command syntax
The four syntax elements are:
• Command
• Option
• Option argument
• Operand
Commands
There are many PrintXchange commands that control printing system operations. The commands include parameters that specify print objects and options.
The command name must always be the first element on the command line, If no options are specified, the default options for the operand are applied when the command executes. If no operand is specified, the default operand for the command is used when the command executes.
The following tables describe the CLI commands available to the three classes of PrintXchange users. The descriptions in each table pertain to the privilege level of the user. For instance, the pdset capabilities of an administrator extend beyond the support permitted for an operator. Similarly, the pdmod capabilities of an operator extend beyond those of an end user.
The CLI user privileges section and individual command sections further describe the user privilege differences.
Table 1-1 lists the CLI commands an administrator is permitted to use to create and set up PrintXchange systems. In addition to the commands shown, an administrator has access rights to all operator and end user commands.
command_name [-a] [-b option_argument] [object_instance . . .]
Options
Option argumentCommand
Operand
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 8
OVERVIEW
Table 1-1. CLI administrator commands
Table 1-2 lists the CLI commands an operator is allowed to use to maintain PrintXchange systems. In addition to the commands shown, an operator has access rights to all end user commands
Table 1-2. CLI operator commands
Command Description
pdcreate Create an object and set its attributes.
pddelete Delete an object.
pdset Set the attributes of all supported printing objects.
pdaccount Generate data for a print job accounting report.
Command Description
pdclean Remove all jobs scheduled on a specified server or queue.
pddisable Stop acceptance of print jobs by servers, printers, or queues.
pdenable Allow acceptance of print jobs by servers, printers, or queues.
pdpause Pause jobs, physical printers, queues, and spoolers.
pdpromote Promote a job to print next on a logical printer.
pdresubmit Resubmit queue and job objects.
pdresume Resume paused jobs, physical printers, queues, and spoolers.
pdset Set xxx-ready attributes of physical printer objects.
pdshutdown Shut down servers.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 9
OVERVIEW
Table 1-3 lists the CLI commands an end user is authorized to use to submit jobs and obtain the status of those jobs on PrintXchange systems.
Table 1-3. CLI end user commands
Options
Options and option arguments modify the default behavior of PrintXchange commands. As shown in Figure 1-2, options are preceded by a hyphen character ( - ).
Figure 1-2. Options and argument syntax
In addition,
• Option names consist of a single lowercase or uppercase letter.
• All options must precede the operand.
• Commands interpret options and option arguments in the order in which they appear on the command line.
• Not all options work with all commands. Be sure to look at the detailed description of each command in Chapters 2-18 to determine which options are valid for that command.
Command Description
pdls List attributes of print objects such as jobs and documents.
pdmod Modify user's previously submitted jobs.
pdpause Pause user's jobs.
pdpr Submit a print job.
pdq Report or obtain status of print jobs.
pdresubmit Resubmit print jobs to another logical printer.
pdresume Resume user's jobs.
pdrm Remove (cancel) user's print jobs.
pdset Set attributes of user’s print jobs
command_name [-a] [-b option_argument] [object_instance . . .]
Options
Option argument
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 10
OVERVIEW
Table 1-4 lists the options available for the various CLI commands.
Table 1-4. Common options and arguments
Option/Argument Used with these commands
Description
-c class_name pdclean pdpausepdcreate pdresubmitpddelete pdresumepddisable pdsetpdenable pdshutdownpdls
Identifies the object class of the operand.
-f filename pdpr Identifies a file that is to be printed as a document in a print job.
-f filter_text pdls pdq Specifies the selection criteria to be used among candidate objects. (Refer to Appendix B of the PrintXchange Command Line Interface Reference Guide for information on filters.)
-F pdls pdq Turns off all filtering, including any default filtering provided when the -f option is unspecified.
This option takes precedence over any -f filter_expression options that are specified.
-g pdcreate pdprpdls pdqpdmod pdset
Turns off column headings on output of requested attributes specified with the-r option.
-h All commands Displays help information about the command.
-m message_text pdclean pdpausepdcreate pdpromotepddelete pdresumepddisable pdrmpdenable pdsetpdmod pdshutdown
Attaches a message to the specified object.
-n copies pdmod pdpr Specifies the number of copies of the print job that should be printed.
-N notification_method pdmod pdpr Specifies how a user wishes to be notified of events that occur during print job processing. (Refer to Appendix D of the PrintXchange Command Line Interface Reference Guide for a list of events and messages.)
-p printer_name pdpr pdq Specifies the printer to which the print job is to be submitted.
-r requested_attributes pdcreate pdprpdls pdqpdmod pdset
Specifies those attributes the command writes to standard output. (Refer to Appendix E of the PrintXchange Command Line Interface Reference Guide for a list of attributes written to output when this option is used.)
-r retention_period pdrm Specifies the amount of time a server should keep a job in the retained state before deleting the job.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 11
OVERVIEW
Option arguments
As shown in Table 1-4, many options require arguments. Options and their associated arguments modify the default behavior of PrintXchange commands.
For example, the following command does not include an option or argument. It submits a document called report.txt to the default printer.
pdpr report.txt
However, to indicate a specific printer, you may use the -p option and its required printer_name argument. The following command submits report.txt to the printer named joes-printer .
pdpr -p joes-printer report.txt
An option argument always follows the option, separated by at least one space. When an option includes several arguments, each argument must be separated with a space or a comma.
Operands
Operands identify the object a command affects when executed. In this guide, the operand is referred to as the object_instance.
For example, the following command lists the attribute of the printer named LP2.
pdls -c printer LP2
In the above example, object_instance is the printer named LP2. The pdls command affects this object when the command is executed.
-s style_name pdcreate pdprpdls pdqpdmod pdset
Determines the style (format) in which output is written to standard output.
-t job_name pdmod pdpr Assigns a name to a new print job.
-w when_time pdshutdown Specifies when you want the server to shut down.
-x extended_attribute_string All commands Identifies one or more attribute=value pairs to be used by the command. (Refer to Appendix A of the PrintXchange Command Line Interface Reference Guide for detailed information on attributes.)
-X attribute_filename All commands Identifies a file that contains attribute=value pairs to be used by the command.
Option/Argument Used with these commands
Description
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 12
OVERVIEW
Figure 1-3. Operand syntax
The syntax of object_instance is:
• object_name
Where object_name is the name of a spooler, supervisor, queue, logical printer, or physical printer. Since these objects have their names registered with the PrintXchange Name Service, their unique names are known after creation.
• [spooler_name:] object_name
Where object_name is the name of a non-registered object, such as a job identifier, document identifier, initial-value-document, or initial-value-job.
The optional [spooler_name:] portion of the object_instance refers to the name of the spooler the object was created on. If the spooler name is omitted, the default spooler name is assumed.
The following conditions apply to object_instance:
• The object_instance specified in the command line must correspond to the default class for that command or to the class specified with the -c class_name option. Table 1-5 lists PrintXchange object classes.
• When using the pdls or pdq command, the object_instance may be omitted. The object_name that the command affects is either the default spooler, default queue, or default logical printer (depending on the object class specified).
• The order of multiple operands specified in the command line may be important, depending on the command.
command_name [-a] [-b option_argument] [object_instance. . .]
Operand
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 13
OVERVIEW
Table 1-5. Object classes
Object class Definition
server The name of the server the command affects. *
printer The name of the printer the command affects. *
queue The name of the queue the command affects. *
job The system-assigned number that uniquely identifies the job the command affects.
document The system-assigned number that uniquely identifies the job, and the number that identifies the position of the specific document within the job, that the command affects.
initial-value-job The name of the specific initial-value-job the command affects. *
initial-value-document The name of the specific initial-value-document the command affects. *
* = These object names are assigned by the administrator when the object is created.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 14
OVERVIEW
Attributes
The -r requested_attributes and -x extended_attribute_string options include attributes as arguments.This chapter discusses two types of attributes:
• Object attributes
• Client attributes
Object attributes are properties or characteristics of print objects. Client attributes specify parameters for the operation of CLI commands.
Object attributes
PrintXchange objects are defined by a set of object attributes. Each object attribute has values associated with it. In this guide, attributes are referred to as:
• Not settable - you cannot change the value of these attributes.
An example of an attribute that is not settable is printer-state . This attribute indicates the current state of a printer. Its values include idle , printing , needs-attention , and paused . PrintXchange automatically sets the value of this attribute when the printer state changes. You cannot set the value yourself.
• Settable - you can change the value of these attributes. By doing so, you change the characteristics of the print object associated with the attribute.
An example of a settable attribute is sides . This attribute specifies if a job should be printed on one or two sides of the paper. You can set the attribute to 1 or 2, depending on your needs.
• Settable only at object creation - you can set the value of these attributes only at the time you create the object.
An example of an attribute that is settable only at object creation is printer-name . This attribute specifies a unique name for an individual printer. You can set this attribute only when creating the printer object. Thereafter, you cannot modify the attribute.
Attributes can be applied to a print object in one or all of the following ways:
• As system defaults.
• By including the -x extended_attribute_string option and argument in the command line. This specifies a series of attributes and their corresponding values.
• By including -X attribute_filename option and argument in the command line. This identifies an attribute file to be read by a command. The attribute file contains attributes and their corresponding values.
Note: Refer to Appendix A of the PrintXchange Command Line Interface Reference Guide for a listing of all supported object attributes.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 15
OVERVIEW
Client attributes
Client attributes modify the action of CLI commands entered at the client.
Client attributes are mainly used to allow what would normally be an option to be entered as an argument to the -x option. For example:
-c server is identical to -x "class=server "
-X attribute_filename is identical to-X "attributes =attribute_filename"
-s line is identical to -x "style=line "
Client attributes are used to:
• Format output regarding print object status and properties.
• Copy attributes from one object to another.
• Specify the length of time a server should keep a job in the retained state after it has been terminated.
PrintXchange supports the following client attributes:
• attributes
• class
• copy-from
• count-limit
• document-filename
• filter
• headings
• requested-attributes
• retention-period
• scope
• style
• time-limit
• when
Note: Refer to Appendix A of the PrintXchange Command Line Interface Reference Guide for an explanation of the above client attributes.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 16
OVERVIEW
Attribute value string syntax
The representation for both object and client attributes is the following:
• The attribute name, which identifies the specific attribute.
• An operator, the equal ( = ) sign, which indicates that the attribute is to be set to a new value.
• The new attribute value.
For example,
When creating a new printer, the administrator sets the followingattribute to identify the physical location of the printer:
"printer-locations = 'LabA, BldgM1' "
Most of the CLI commands accept the -x option followed by a list of attributes and their values. This list is called an attribute value string.
Table1-6 defines quoting rules for attribute value strings. The rules in the table apply to the POSIX shell as well as the Bourne and Korn shells. Special rules for the C shell are explained later in this chapter. Since the POSIX shell is not generally available, PrintXchange supports only scripts written for the Bourne shell.
Table 1-6. Quoting rules for attribute value strings
Rule Rule example
Use of quotes
You can always surround the entire attribute value string in double quotes.
-x "attribute = value"
Multiple attributes in a single command
You can enter multiple attribute value strings by using either
multiple instances of the -x option
or by
a single -x option followed by multiple attribute value strings enclosed in double quotes.
-x "attribute1 = value1" -x "attribute2 = value2"
is the same as
-x "attribute1 = value1 attribute2 = value2"
However, the following is incorrect:
-x attribute1=value1 attribute2=value2
Multiple values for an attribute
Specify attributes with multiple values by
enclosing the entire attribute value string with double quotes
or
enclosing only the value with double quotes.
The following examples are both correct:
-x attribute = "value1 value2 value3"
-x "attribute = value1 value2 value3"
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 17
OVERVIEW
Special rules for the C shell
The C shell and the Bourne shell handle input differently. Because of these differences, when using the C shell, you must enter attributes and values according to the following rules:
• Do not use double quotes within double quotes or single quotes within single quotes.
This rule is true, regardless of the use of escape characters ('\').
Incorrect:
pdpr -x "message = "hey man" "pdpr -x "message = \"hey man\" "
Correct:
pdpr -x 'message = "hey man" '
• You must enclose the NOT operator ('!') in quotes.
Incorrect:
pdls -f !(job-name*)
Correct:
pdls -f "!(job-name*)"
Text attributes with spaces
Specify attributes with text type syntax that includes spaces by surrounding it with two levels of quotes.
Note that single-quote (') notation is not available in Windows NT Command Interpreter and PERL.
The following examples are all correct:
-x attribute = " 'single valued string with spaces' "
-x 'attribute = "single valued string with spaces" '
-x attribute = " 'value1 with spaces' 'value2 with spaces' "
-x "attribute = value attribute = 'a text attribute with spaces' "
Text with internal quotes
You must precede quotes or apostrophes within an attribute value by a backslash.
Note that a backslash is not needed in Windows NT Command Interpreter.
The following examples are all correct:
-x attribute = " 'It\'s time to retire' "
-x "attribute = 'Bob\'s printer' "
-x "attribute = 'Quote of the day: \"It ain\'t over till it\'s over\" ' "
White space (spaces, tabs) within attribute strings
White space is parsed out if you do not enclose it within the value string.
Note that single-quote (') notation is not available in Windows NT Command Interpreter and PERL.
The following two examples are identical:
-x " attribute= 'Hello World' "
-x "attribute='Hello World' "
Complex attributes
These are specified using braces { }. Each component of the complex attribute is enclosed with these braces as if it were itself an attribute.
-x "results-profile = {delivery-method=pickup results-set-comment=" 'As soon as possible' " job-copies=3 output-bin=top}"
Rule Rule example
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 18
OVERVIEW
• You must enclose the asterisk ('*') in quotes.
Incorrect:
pdls -f job-name*pdls -f message*=" 'Initial String' "
Correct:
pdls -f "job-name*"pdls -f "message*='Initial String' "
Special rules for the Windows NT Command Interpreter
The following special rules apply to the Windows NT Command Interpreter:
• You cannot use single quote (') notation.
The Command Interpreter cannot interpret single quote (') notation. If you need to specify text attributes with space, you must specify attributes separately. For example:
— POSIX shell
pdpr -x attribute=" 'value1 with spaces''value2 with spaces' "
— Command Interpreter
pdpr -x attribute="value1 with spaces" -x attribute+="value2 with spaces"
• You cannot use a back quote (‘)
The Command Interpreter does not have a back quote (‘) function. You must use file redirection or the FOR /F command. For example:
— File Redirection
pdpr -c printer SERVER_spl:>tmpfile.txt
— FOR /F command
SET printers=
FOR /F "skip=2" %i IN ('pdls -c printer SERVER_spl:') DO pdenable -c printer SERVER_spl:%i
• Escape character
If you need to use a special character of the Command Interpreter (&,(,),|) as a value string, you must precede the character with a caret (^) character or use a double quote ("). For example:
— pdpr -x message=Bye^&Bye hello.ps
or
— pdpr -x message="Bye&Bye"
If you need to use a double quote (") character as a value string, you must precede it with a backslash (\) character. For example:
— pdpr -x message=\"Hello\" hello.ps
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 19
OVERVIEW
• No unfolding wildcard character
The Command Interpreter does not unfold the wildcard character. For example:
— pdpr -p Printer1 *.ps
causes
— Client File System Error - directory or file not found <*.ps>
• You cannot use block sentence
The Command Interpreter does not have block sentence. Instead, use the parentheses ((,)) characters and the ampersand (&) character to group multiple commands. For example:
— IF "%1" == "SPL" (ECHO - enable spooler - & pdenable -c server %COMPUTERNAME%_SPL)
The CALL command is also available to execute another script. For example:
— IF "%1" == "SPL" CALL enablespooler.bat %COMPUTERNAME%_spl
Clearing attribute values
There may be cases in which you need to clear an attribute of all values.
For instance, you might have set the media-ready attribute as follows:
pdset -c printer -x media-ready=na-letter-white myprinter_PP
However, all trays on your printer may be out of service. In this case, you can clear the media-ready attribute of all values by entering:
pdset -c printer -x media-ready="{}" myprinter_PP
For information on using the +, -, and = operators to modify attributes, refer to Chapter 9, pdmod.
Attribute files
An attribute file is a file containing multiple attributes and their values. You can use attribute files with the -X attribute_filename option and argument. You use a text editor to create an attribute file.
When a command executes, the data included in an attribute file is processed at the current point in the command line as if it had been specified with the -x extended_attribute_string option and argument.
Attribute files are useful for storing frequently used options. For instance, instead of specifying -x "sides=2 " and -x "document-format=PostScript " when submitting print requests, you can include these options in an attribute file.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 20
OVERVIEW
You can use an attribute file in the following ways:
• Use the -X option and specify the attribute file name. For example:
pdset -X AttrFilePP2 PhysPtr2
• Use the -x option and the client attribute attributes . For example:
pdset -x “attributes=AttrFilePP2” PhysPtr2
• Both of the above
The attribute file in the preceding two examples might look like this:
# Physical Printer Attribute File# AttrFilePP2document-formats-supported =PCL PostScriptmaximum-copies-supported =3document-sheets-supported =none doc-set-start-copies-separateprinter-timeout-period =05
The following command is equivalent to using a pdset command that references the preceding attribute file with the -X or -x option:
pdset -x “document-formats-supported=PCL PostScript maximum-copies-supported=3 document-sheets-supported=none doc-set-start-copies-separate printer-timeout-period=05” PhysPtr2
Special rules for attribute files
Attribute files contain extended attribute strings comparable to those you specify in the command line with the -x option. The following rules apply to the use of attribute files:
• An attribute value string must reside in one line only. Even if the line seems too long, you cannot split a value string into multiple lines.
• The maximum length for a line in an attribute file is 1024 characters.
• Each line in the file can contain one or more strings.
• An attribute file can reference another attribute file by specifying the attribute value string "attributes=attribute_filename." There is no limit to how many attribute files you can nest; however, you must not exceed your system limits for the number of open files.
• If the path to the attribute file is included in the attribute_filename, the command uses the specified path. If the path is not included, PrintXchange uses the path designated by the PDPATH environment variable.
• Using the comment character ( # ) in an attribute file causes everything that appears after it on the line to be ignored.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 21
OVERVIEW
Environment variables
You can use environment variables to hold information specific to your system and site configuration. For example, you can use environment variables to set defaults, determine paths to locate files, provide numeric, character, and date and time format information, and the language to be used.
The CLI commands use the current value of an environment value as the default, unless you specify a different value in the command line. Table 1-7 lists environment variables that, based on their value, may affect CLI commands.
Table 1-7. Environment variables that affect CLI commands
Variable Description
NLSPATH Specifies the directory path for CLI message files only if the files do not reside in the standard directory. Standard directories are listed in the PrintXchange System Administration and Operations Guide.
PDDOMAIN(Windows NT only)
Specifies the domain name used on operations that do not specify the domain-name attribute for cross-domain or cross-platform requests. For cross-platform objects, the UNIX domain name must be prefixed by nis:
PD_OID_DB_PATH Specifies the path to the directory containing the object identification (OID) database files only if the OID database does not reside in the default location. Default directory locations are listed in the PrintXchange System Administration and Operations Guide.
PDPATH Consists of a colon-separated list of directories (paths) that are successively tried for the file name specified in the -X attribute_filename option.
The PDPATH environment variable is processed for attribute_filename in the same way the PATH environment variable is processed for logical command names.
PDPRINTER Determines the default logical printer when the printer-name-requested attribute or the -p printer_name option is unspecified.
Also determines the default server when you do not specify a server. The default server is the server associated with the default logical printer.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 22
OVERVIEW
In addition to the environment variables listed in the preceding table, the following environment variables used for localization may affect the behavior of the CLI.
In the UNIX environment:
• LANG
• LC_ALL
• LC_COLLATE
• LC_CTYPE
• LC_MESSAGES
• LC_NUMERIC
• LC_TIME
In the Windows NT environment:
• NS_LM_LF
• PX_ROOT
Refer to the PrintXchange System Administration and Operations Guide for a detailed description of environment variables.
Exit values
When a PrintXchange command has completed, it returns one of the following:
0 A zero value indicates the command completed successfully.
>0 A non-zero value indicates that an error occurred.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 23
OVERVIEW
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 24
2. pdaccount
Name
pdaccount - format data for a print job accounting report.
Synopsis
pdaccount [-o outfile] [-s start_date] [-e end_date] [-d] [-a] [-g][-p accounting_log_path] [-O oid_database_path] spooler_name
Description
Use this command to access and report print job accounting information when a job terminates for any reason (canceled, aborted, or printing completed). The output from this command is a tab-delimited file that can be presented in a spreadsheet format.
Use this command to display help about pdaccount.
pdaccount -h
access level Administrator and operator
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 25
PDACCOUNT
Options
The following options are supported for pdaccount.
-o output
Specifies the name of the output file. If not specified, the report is written to standard output.
-s start_date
Specifies the beginning date for the log files. The format for start_date is yyyymmdd. If this option is omitted, the start date becomes the earliest file found.
-e end_date
Specifies the ending date for the log files. The format for end_date is yyyymmdd. If this option is omitted, the end date becomes the most recent file found.
-d
Deletes the accounting files after the pdaccount command has completed. Note that this option only deletes files that have been processed by this run of pdaccount, not any other accounting files.
-a
Indicates the output file should include both job and document attributes. If this option is not specified, the output file includes job attributes only.
-g
Indicates the output file should not include header lines. If this option is not specified, a header line is included whenever the attributes logged for a job differ from the previous job’s attributes.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 26
PDACCOUNT
-p accounting_log_path
Specifies the path to the account log data. When the database for the spooler is initially set up using the pdmakedb command, an optional switch (-p accounting_log_path) can be used to tell the server where to store accounting log files. When the server is first started, the directories that make up this path will be created.
Note: If the -p switch is not included in the command, the accounting log directory defaults to /var/pd/acct/.
-O oid_database_path
Specifies the path to the object identifier database (OID).
spooler_name
The name of the spooler that collects the accounting data.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 27
PDACCOUNT
Usage
By default, the spooler automatically collects job information, writes it to the accounting file, and keeps the file for three days. The administrator can disable or enable this feature for a specific physical printer by using the pdset command on the supervisor to set the printer's accounting-enabled attribute to no (accounting-enabled=no ).
A PrintXchange administrator can send a set (pdset) command to a spooler to construct an accounting profile with the accounting-profile attribute. The accounting profile identifies the job and document attributes that the spooler collects for the accounting log.
If the accounting-profile attribute is not specified, the spooler collects data for the attributes contained in the attribute default-accounting-profile . (Refer to Appendix A of the PrintXchange Command Line Interface Reference Guide for further details on accounting attributes.)
Table 2-1 describes the content of the default accounting data record collected for each job. The attributes that are logged may differ from those shown in the table if the administrator set values for the accounting-profile attribute.
Table 2-1. pdaccount output
Object Attribute name Description
Job accounting-information The account to be charged for any services rendered.
Job completion-time The time at which the job completed printing.
Job document-sheets The auxiliary sheets the server inserts in the job.
Job impressions-completed The total number of impressions the printer placed on the media for the job, including repeated impressions due to multiple copies.
Job job-comment Text associated with the job that is meant to print on separator pages.
Job job-copies-completed The number of copies of the job that have been printed.
Job job-fault-count The counter which increments each time the job is returned by the supervisor due to a crash of the spooler or supervisor.
Job job-finishing The finishing process applied to each job copy of the printed output.
Job job-identifier A number, generated by the spooler, that uniquely identifies the job.
Job job-name Text supplied by the user that is intended to print on separator sheets and used for notification and logging of the job.
Job job-originator The name of the human or programmatic originator of the print job.
Job job-owner The name of the human owner of the print job.
Job job-sheets The auxiliary sheets the supervisor prints with the job.
Job job-state-reasons The reasons for the job's held, terminated, retained, or completed state. If blank, the job is not in any of these states.
Job job-to-be-billed The department or group to be charged for the job.
Job media-consumed Billing information (such as type of color print and medium size) for each medium consumed for the job.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 28
PDACCOUNT
Job media-sheets-completed The total number of media sheets the printer completed printing for the job, including repeated pages due to multiple copies.
Job number-of-documents The number of documents contained in the job.
Job pages-completed The total number of pages the printer completed printing, including repeated pages due to multiple copies.
Job printer-name-requested The logical printer that was used for the print request.
Job printers-assigned The physical printer that printed the job.
Job results-delivery-method The delivery method for notification results and output results.
Job started-printing-time The time the job started printing.
Job submission-time The time the last print request was made for the job.
Job total-job-octets The size of the job, in bytes, including all copies.
Job user-name The person requesting access to the pdpr command.
Document copies-completed The number of complete copies of the document that were printed.
Document document-file-name The name of the document file, if any, with complete path.
Document document-format The data syntax used to encode the final printed form of a document.
Document document-type Indicates if the document processed by the print operation was a printable document, a font, or a resource.
Document finishing The finishing process applied to the document.
Document number-up The number of page images imposed on a single instance of a selected medium.
Document plex Indicates if page images were conditioned for one or two sided printing.
Document print-colour-type-used The color specified in the document.
Object Attribute name Description
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 29
PDACCOUNT
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 30
3. pdclean
Name
pdclean - remove jobs from a queue or spooler.
Synopsis
pdclean-c class_name [-m message_text][-x extended_attribute_string ... ] [-X attribute_filename ... ]object_instance ...
Use this command to display help about pdclean.
pdclean -h
Description
Use the pdclean command to remove (delete) all the jobs on any specified spooler or queue. Consider the following items when using this command:
• Before the command can be executed, the queue or spooler to be cleaned must be disabled.
• The queue or spooler cannot be enabled during the clean process.
• The pdclean command is equivalent to entering a pdls command on the queue or spooler followed by a pddelete of all the jobs found.
• Back up any jobs that should not be deleted as follows:
— Resubmit all the jobs to another queue or spooler.
— If resubmitting is not possible, notify all users to retain a copy of their job.
• The pdclean command deletes all jobs, including those in a retained state.
• Jobs cannot be removed from a supervisor.
• Removing a particular job may be rejected if the job is already printing at the associated physical printer.
• If a notification-profile was set up for the spooler, a "clean complete" event is delivered to the client when the pdclean command is complete.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 31
PDCLEAN
access level Operator
Note: An administrator uses this command as an emergency measure to fix a problem.
Options
The following options are supported for pdclean.
-c class_name
Specifies the class, or type, of object from which you are removing jobs.
argument The following values are allowed for class_name.
• server
• queue
Note: There is no default; either queue or server must be specified. If you do not specify class_name, PrintXchange returns an error (can't find printer).
If you use the -x extended_attribute_string string option or the -X attribute_filename file option, the comparable client attribute type and value is the following:
class =class_name
-m message_text
Use this option to include a message about the queue or spooler that you are cleaning. For example, when a spooler is to be cleaned the message attached to the spooler might be:
-m "Cleaning. Big-Spooler down for 10 minutes"
If you use the -x extended_attribute_string option or the -X attribute_filename option in the pdclean command, the comparable client attribute type and value is the following:
message =message_text
The option will look like this:
-x "message='Cleaning. Big-Spooler down for 10 minutes' PF"
To retrieve a message of this type, use the pdls command, specify the queue or spooler, and include the following option:
-r message
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 32
PDCLEAN
-x extended_attribute_string
Use this option to specify a series of attribute=value pairs on the command line that will be processed by the pdclean command.
attributes Object attributes cannot be used in the -x option.
You can specify the following client attributes:
• attributes
• class
• message
syntax Follow the syntax rules for attribute value strings, listed in the Overview chapter of the PrintXchange Command Line Interface Reference Guide.
Note: You can produce the same result by including the extended_attribute_string in an attributes file and identifying that file as the attribute_filename in the -X option.
-X attribute_filename
The -X option identifies an attribute file to be read by the command. When the pdclean command executes, the attribute data included in the file is processed at the current point in the command line as though it had been specified with the -x option.
attributes Object attributes cannot be used in the -X option. Refer to the -x section for a list of the client attributes that may be used.
Note: Refer to the Overview chapter of the PrintXchange Command Line Interface Reference Guide for information on developing an attribute file.
Operands
The value of the object_instance in the operand is based on the value of the -c class_name option or the class =class_name attribute.
spooler_name When the class of the object is server , the value of spooler_name is the name of the specific spooler to be cleaned.
queue_name When class of the object is queue , the value of queue_name is the name of the specific queue to be cleaned.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 33
PDCLEAN
Examples
1. Remove all jobs from the spooler named bob .
pdclean -c server bob
2. Delete all jobs from the spooler named bob, using the class attribute instead of the class option.
pdclean -x "class=server" bob
3. Remove all jobs currently in the queue named central, on the spooler named big-spooler .
pdclean -c queue big-spooler:central
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 34
4. pdcreate
Name
pdcreate - create a printer, queue, initial-value-job, or initial-value-document.
Synopsis
pdcreate [-c class_name] [-g] [-m message_text][-r requested_attributes] [-s style_name][-x extended_attribute_string ... ] [-X attribute_filename ... ]object_instance ...
Use this command to display help about pdcreate.
pdcreate -h
Description
Use the pdcreate command to create a logical printer, physical printer, queue, initial value job, or initial value document object. Consider the following items when using this command:
• The new object is permanent and remains in place after shutdown and restart operations.
• NameSpace considerations:
— When creating printers or queues, the command will fail if an object of the same name already exists in the Name Service, even if the object is of a different class.
— In the Windows NT environment:
— For PrintXchange Name Service, the name is automatically registered with the Name Service.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 35
PDCREATE
— In the UNIX environment:
— In the Local File environment, the administrator must propagate the change throughout the network since the object name is only added to the Local File NameSpace of the current host issuing the pdcreate command.
— In the NIS environment, the administrator must manually add a new printer to the NIS NameSpace database (printers.conf.byname) and communicate this change throughout all the NIS servers operating in the same domain.
• You can set the values of attributes in the pdcreate command.
Note: You can also use the pdset command to assign values to attributes.
• When creating a physical printer :
— The new printer is created within a supervisor and initialized as disabled (enabled=no ).
— A supervisor must be available that can support the connectivity attributes of the new printer. Refer to the PrintXchange System Administration and Operations Guide for details on connectivity support for the Xerox and Reference Supervisors.
— Use a printer attribute file (paf) which contains the connectivity attributes required for the new printer. For example, use the following command to create a physical printer object for an HP LaserJet IIISi printer:
— pdcreate -c printer -X HP_LaserJetIIISi_Level1PS.paf supervisor_name:printer_name
— The two attributes required when creating a physical printer are: printer-model and printer-name .
— The associated-queue and printer-address attributes are required in order to enable the physical printer. If not specified during pdcreate, they need to be added via pdset before pdenable.
— The supervisor automatically updates its physical-printers-supported attribute to acknowledge the new printer.
— The pdcreate command fails if the command line includes the associated-queue attribute and the queue specified by the attribute does not exist.
— If you include the copy-from= copy_object_instance attribute, the attribute values of the copied physical printer are used as the initial values of the new physical printer. Both the copied object and the new object must reside on the same supervisor.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 36
PDCREATE
• When creating a logical printer :
— The new printer is created within a spooler and initialized as disabled (enabled=no ). Perform a pdenable on the printer to start accepting print requests.
— The spooler automatically updates its logical-printers-supported attribute to acknowledge the new printer.
— The command fails if the command line includes the printer-initial-value-job or the printer-initial-value-document attribute and the object specified by the attribute does not exist.
— If you include the copy-from =copy_object_instance attribute, the attribute values of the copied logical printer are used as the initial values of the new logical printer. Both the copied object and the new object must reside on the same spooler.
• When creating a queue :
— The initial state of the new queue is disabled and new jobs are not accepted. Use the pdenable command to enable the new queue to start accepting jobs.
— The queues-supported attribute for the spooler is updated to acknowledge the presence of the new queue.
— If you include the copy-from= copy_object_instance attribute, the attribute values of the copied queue are used as the initial values of the new queue. Both the copied object and the new object must reside on the same spooler.
• When creating an initial-value-job :
— A new object is created within the default spooler if a specific spooler name is not included in the object instance.
— An initial-value-job is used by a logical printer. It can also be used as part of a pdpr command.
— If you include the copy-from= copy _object_instance attribute, the attribute values of the copied object are used as the initial values of the new object. Both must reside on the same spooler.
— After the initial-value-job has been created, one of the following commands must be used to associate it with a logical printer:
— If the logical printer already exists, perform a pdset on the printer to set the printer-initial-value-job attribute to the initial-value-job that you just created.
— If the logical printer does not exist, use pdcreate to create a new one. Include the printer-initial-value-job attribute, with the values set to the name of the initial-value-job that you just created.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 37
PDCREATE
• When creating an initial-value-document :
— The new object is created within the default spooler if a specific spooler name is not included in the object instance.
— An initial-value-document can be used as part of the pdpr command.
— If you include the copy-from= copy_object_instance attribute, the attribute values of the copied object are used as the initial values of the new object. Both must reside on the same spooler.
— After the object has been created, one of the following commands must be used to associate it with a logical printer:
— If the logical printer already exists, perform a pdset on the printer to set the printer-initial-value-document attribute to the initial-value-document that you just created.
— If the logical printer does not exist, use pdcreate to create a new one. Include the printer-initial-value-document attribute, with the value set to the name of the initial-value-document that you just created.
access level Administrator
Options
The following options are supported for pdcreate.
-c class_name
Specifies the class, or type, of object you are creating.
arguments The values allowed for class_name are the following:
• printer (This is the default.)
• queue
• initial-value-job
• initial-value-document
The OPERANDS section describes the specific object_instance that is associated with each class.
If you use the -x string option or the -X file option, the comparable client attribute type and value is the following:
class =class_name
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 38
PDCREATE
-g
Use this option to omit line or column headings.
If you use the -x string option or the -X file option, the comparable client attribute is the following:
headings =no
-m message_text
Use this option to include a message about the object that you are creating. For example, when a queue is to be created, the message attached to the new queue might be:
-m "Queue2 will soon be accepting jobs."
If you use the -x extended-attribute-string option or the -X attribute_filename option in the pdcreate command, the comparable client attribute type and value is the following:
message =message_text
The option will look like this:
-x "message = 'Queue2 will soon be accepting jobs.' "
To retrieve a message of this type, use the pdls command, specify the object, and include the following option:
-r message
-r requested_attributes
Use this option to specify the attributes that you want pdcreate to write to standard output to generate an attribute report.
arguments The values allowed for requested_attributes are the following:
• verboseThis value specifies that an expanded set of attributes is written to output.
• briefThis value specifies that a subset of the verbose list of attributes is written to output.
• allThis value specifies that all attributes with values are written to output.
• noneThis value specifies that no attributes are written to output. This is the default.
Note: Refer to Appendix E of the PrintXchange Command Line Interface Reference Guide for the attributes that are included in the verbose and a brief listing for each print object.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 39
PDCREATE
If you use the -x string option or the -X file option, the comparable attribute is the following:
requested-attributes =requested_attributes
-s style_name
Use this option to define how the output requested with the -r requested_attributes option is to be formatted.
arguments The values allowed for style_name are the following:
• columnThe output displays a separate column for each requested attribute. This is the default for every value of the -r requested_attributes option except all .
• lineThe output displays a separate line for each requested attribute. This is the default for the all value of the -r requested_attributes option.
If you use the -x string option or the -X file option, the comparable attribute is the following:
style =style_name
-x extended_attribute_string
Use this option to specify a series of attribute=value pairs on the command line that will be processed by the pdcreate command.
attributes All attributes identified as settable may be used:
Note: Refer to Appendix A of the PrintXchange Command Line Interface Reference Guide for a complete listing of all supported object attributes.
The following client attributes may be used with the -x and the -X option:
• attributes
• requested-attributes
• class
• message
• headings
• style
• copy-from= copy_object_instance
The pdcreate command makes a copy of the copy_object_instance value for the new object, which takes on the attribute values of the copied object for its initial values. The new object and the copied object must be the same class and reside on the same server.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 40
PDCREATE
syntax When you specify the string of attribute=value pairs, follow the syntax rules for attribute value strings listed in the Overview chapter of the PrintXchange Command Line Interface Reference Guide.
Note: You can produce the same result by including the extended_attribute_string in an attribute file and identifying that file as the attribute_filename in the -X option.
-X attribute_filename
The -X option identifies an attribute file to be read by the command. When the pdcreate command executes, the attribute data included in the file is processed at the current point in the command line as though it had been specified with the -x option.
attributes Object attributes cannot be used in the -X option. Refer to the -x section for a list of the client attributes that may be used.
Note: Refer to the Overview chapter of the PrintXchange Command Line Interface Reference Guide for information on developing an attribute file.
Operands
The value of the object_instance in the operand is based on the value of the -c class_name option or the class =class_name attribute.
Note: If [spooler_name:] is not specified, the pdcreate command is performed on the default spooler.
[spooler_name:]printer_name When class equals printer , the value of printer_name is the name of the printer to be created. For logical printers, the spooler associated with the new printer assigns the value logical to the printer attribute printer-realization . For physical printers, the supervisor associated with the new printer assigns the value physical to the printer attribute printer-realization .
[spooler_name:]queue_name When class equals queue , the value of queue_name is the name of the queue to be created.
[spooler_name:]ivj_name When class equals initial-value-job , the value of ivjob_name is the name of the initial-value-job object to be created. The object sets default attributes for the jobs that pass through an associated logical printer. A specific job can identify an initial-value-job object to be used for attribute defaults.
[spooler_name:]ivdoc_name When class equals initial-value-document , the value of ivdoc_name is the name of the initial-value-document object to be created. The object sets default attributes for the documents that pass through an associated logical printer. A specific document can identify an initial-value-document object to be used for attribute defaults.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 41
PDCREATE
Note: If [server_name:] is not specified, the pdcreate command is performed on the server that supports the printer named in the PDPRINTER environment variable.
Examples
1. Create a logical printer named dngbat on the default spooler. The media supported by this printer is iso-a4-white and a-white .
pdcreate -x "media-supported=iso-a4-white a-white" dngbat
2. Create a physical printer named X4517PS.pp on the supervisor named big-super .
pdcreate -c printer -X /usr/pd/cap/Xerox4517-Level2ps.paf big-super:X4517PS.pp
3. Create a logical printer named dngbat on the default spooler with two supported document formats, PostScript and PCL.
pdcreate -c printer -x "document-formats-supported='PostScriptPCL'" dngbat
4. Create a physical printer named X4517PS_rm3520.pp from the existing printer X4517PS.pp on the supervisor named big-super .
pdcreate -c printer -x copy-from=big_super:X4517PS.pp X4517PS_rm3520.pp
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 42
5. pddelete
Name
pddelete - delete a print object.
Synopsis
pddelete [-c class_name] [-m message_text][-x extended_attribute_string ... ] [-X attribute_filename ... ]object_instance ...
Use this command to display help about pddelete.
pddelete -h
Description
Use the pddelete command to delete a logical printer, physical printer, job, queue, initial-value-job, initial-value-document, or server. The following items should be considered when using this command:
• When multiple objects are specified, they must all be the same class.
• Spoolers, supervisors, queues, logical and physical printers must be disabled before they can be deleted.
• The deleted object is removed from the object database.
• NameSpace database considerations when deleting spoolers, supervisors,queues, logical and physical printers:
— In the Windows NT environment:
— For PrintXchange Name Service, the object entry is automatically removed from the Name Service.
— In the UNIX environment:
— For Local File and NIS, you must propagate the change throughout the network.
— In the NIS environment, the network administrator must remove the object from the NIS NameSpace database (printers.conf.byname) and propagate the information throughout the NIS servers operating in that domain.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 43
PDDELETE
• Deletion of spoolers, supervisors, queues, logical and physical printers performs immediate updates on the server that controls the object to be deleted. Updates to associated objects that are controlled by a different server occur immediately if the associated server is running; otherwise, the updates occur when the server is started.
• When the object to be deleted is a logical printer :
— The printer-associated-printers attributes for the associated physical printers are updated.
— The logical-printers-supported attributes for the associated server and queue are updated.
• When the object to be deleted is a physical printer ,
— The spooler associated with the physical printer must be running.
— All currently active jobs must be deleted or you must wait for them to complete.
— An unregister-printer event is sent to the associated spooler, which updates all affected queues and logical printers.
— The physical-printers-supported attributes for the supervisor, spooler, and queue are updated.
— The printers-ready and printer-associated-printers attributes for the associated logical printers are updated.
— If the specified printer is the only physical printer associated with a queue, the spooler stops scheduling jobs in that queue until it is associated with another physical printer.
— Jobs in the spooler specifying the deleted printer via the physical-printers-requested attribute will remain in a pending state. These jobs must have the physical-printers-requested attribute modified before they can be rescheduled for a different printer.
• When the object to be deleted is a spooler :
— All jobs currently on the spooler must be deleted (i.e., disable and then clean the spooler).
— All associated spooler objects (queues, logical printers, initial-value-jobs, initial-value-documents, and the spooler itself) are deleted.
— The spooler is disassociated from its supervisors. (The associated supervisors set the associated-queue and printer-associated-printers attributes to empty on all physical printers associated with the spooler.)
— All dynamic data files associated with the spooler are deleted.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 44
PDDELETE
• When the object to be deleted is a supervisor :
— All jobs currently in the supervisor must be deleted.
— An unregister-printer event is sent to the associated spooler for each affected physical printer. The spooler removes the printers from all mapping attributes, updating the affected queues and logical printers.
— All physical printers are deleted.
— All dynamic data files that are created and maintained by the supervisor, such as the temporary job data file and object data files, are deleted.
• When the object to be deleted is a job :
— The specified job (and all documents contained in the job) is deleted, regardless of its state.
— The specified job is canceled if it was already delivered to the supervisor and the job stops printing as soon as possible.
— The value of the job-retention-period attribute is set to zero, overriding its previous value, if any. The value of default-job-completion-period is ignored. (This differs from the pdrm command which honors the value of these attributes.)
— The job is removed from the system.
• When the object to be deleted is a queue :
— All jobs must be removed from the queue (i.e.,disable and then clean the queue) or wait until the queue empties.
— The queue is disassociated from its logical and physical printers (the logical and physical printer attributes associated-queue , printer-associated-printers , and printers-read y are set to empty).
— All associated printers are disabled.
— The queue is disassociated with its spooler. (The spooler removes the queue from its queues-supported attribute.)
• When the object to be deleted is an initial-value-job :
— The object is not removed from the printer-initial-value-job attribute on the logical printers. To manually remove the logical printer associations:
— Issue a pdls command for all logical printers on the same spooler to determine the associated logical printers.
— For each associated logical printer, issue a pdset command to associate the logical printer with an existing initial-value-job (set the logical printer’s printer-initial-value-job attribute).
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 45
PDDELETE
• When the object to be deleted is an initial-value-document :
— The object is not removed from the printer-initial-value-document attribute on the logical printers. To manually remove the logical printer associations:
— Issue a pdls command for all logical printers on the same spooler to determine the associated logical printers.
— For each associated logical printer, issue a pdset command to associate the logical printer with an existing initial-value-document (set the logical printer’s printer-initial-value-document attribute).
access level Administrator
Options
The following options are supported for pddelete.
-c class_name
Specifies the class, or type, of object you are deleting.
arguments The values allowed for class_name are the following:
• printer (This is the default.)
• job
• queue
• initial-value-document
• initial-value-job
• server
Note: The Operands section describes the specific object_instance associated with each class.
If you use the -x string option or the -X file option, the comparable attribute type and value is the following:
class type =class_name value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 46
PDDELETE
-m message_text
Use this option to include a message about the object that you are deleting. For example, when a printer is to be deleted the message attached to the printer might be:
-m "Printer1 no longer available"
If you use the -x extended_attribute_string option or the -X attribute_filename option in the pddelete command, the comparable client attribute type and value is the following:
For printers, queues, servers, initial value jobs and initial value documents:
message =message_text
For jobs:
job-message-from-administrator =message_text
The option will look like this:
-x "message='Printer1 no longer available' "
To retrieve a message of this type, use the pdls command, specify the object, and include the following option:
-r message
-x extended_attribute_string
Use this option to specify a series of attribute=value pairs on the command line that will be processed by the pddelete command.
attributes Object attributes cannot be used in the -x option.
The following client attributes can be used:
• attributes
• class
• message (The message will be deleted along with the object.)
syntax Follow the syntax rules for attribute value strings, listed in the Overview chapter of the PrintXchange Command Line Interface Reference Guide.
Note: You can produce the same result by including the extended_attribute_string in an attribute file and identifying that file as the attribute_filename in the -X option.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 47
PDDELETE
-X attribute_filename
The -X option identifies an attribute file to be read by the command. When the pddelete command executes, the attribute data included in the file is processed at the current point in the command line as though it had been specified with the -x option.
attributes Object attributes cannot be used in the -X option. Refer to the -x section for a list of the client attributes that may be used.
Note: Refer to the Overview chapter of the PrintXchange Command Line Interface Reference Guide for information on developing an attribute file.
Operands
The value of the object_instance in the operand is based on the value of the -c class_name option or the class =class_name attribute.
Note: Before you delete the object, run a report on every object that is associated with it so that you can document all of the setup and initialization requirements. You can use this information if you need to create the object again.
printer_name ... When class equals printer , the value of printer_name is the name of the printer to be deleted. The printer to be deleted can be a logical or physical printer.
server_name ... When class equals server , the value of server_name is the name of the server to be deleted. The server to be deleted can be a supervisor or spooler.
[spooler_name:]job_id ... When class equals job , the value of job_id is the unique identifier that points to the job to be deleted.
queue_name ... When class equals queue , the value of queue_name is the name of the specific queue to be deleted.
[spooler_name:]ivjob_name ... When class equals initial-value-job , the value of ivjob_name is the name of the initial-value-job object to be deleted.
[spooler_name:]ivdoc_name ... When class equals initial-value-document , the value of ivdoc_name is the name of the initial-value-document object to be deleted.
Note: When class equals job , initial-value-job , or initial-value-document and [spooler_name:] is not specified, the pddelete command is performed on the default spooler.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 48
PDDELETE
Examples
1. Delete the printer named sams-printer . Notice the -c class_name option is not needed since the default class is printer.
pddisable sams-printer
pddelete sams-printer
2. Delete the initial-value-job called ivj1 from big-spooler .
pddelete -c initial-value-job big-spooler:ivj1
3. Delete the queue called centralq from the default spooler.
pddisable -c queue centralq
pddelete -c queue centralq
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 49
PDDELETE
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 50
6. pddisable
Name
pddisable - disable a printer, server, or queue.
Synopsis
pddisable [-c class_name] [-m message_text][-x extended_attribute_string ... ] [-X attribute_filename ... ]object_instance ...
Use this command to display help about pddisable.
pddisable -h
Description
Use the pddisable command to disable the acceptance of new print jobs on the specified printers, queues, or servers.
Until the pdenable command is used, print jobs submitted by the pdpr or pdresubmit commands are not accepted by that object. The specified object continues to respond to other commands.
You can invoke pddisable on printer, queue, and server objects only. If you specify any other object or an invalid object, an error results. Specifying an object that is already disabled also results in an error.
Note: The state of a disabled server, printer, or queue will still be indicated as ready because enabled/disabled is not a state.
• When the object to be disabled is a printer ,
— If it is a logical printer, new print job requests are not accepted and the name of the printer is removed from the logical-printers-ready attribute for the associated queue and spooler.
— If it is a physical printer, the printer will not request new print jobs; however, any jobs currently printing or processing are completed. The name of the printer is removed from the physical-printers-ready attribute on the supervisor. If a queue is associated with the printer, the physical-printers-ready attributes for the queue and spooler are also updated, as well as the printers-ready attribute on all associated logical printers.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 51
PDDISABLE
• When the object to be disabled is a queue ,
— The printer-state attribute of associated logical printers is not changed.
— A pdpr command for any logical printer associated with the queue returns an error.
• When the object to be disabled is a server ,
— When the server is a spooler, all new jobs are rejected, but previously submitted jobs are scheduled and delivered to physical printers.
— When the server is a supervisor, the supervisor will no longer request jobs from the spooler. Jobs already being processed by the supervisor are allowed to complete.
access level Operator
Options
The following options are supported for pddisable.
-c class_name
Specifies the class, or type, of object you are disabling.
arguments The values allowed for class_name are the following:
• printer (This is the default.)
• server
• queue
Note: The Operands section describes the object_instance that is associated with each class.
If you use the -x string option or the -X file option, the comparable attribute type and value is the following:
class =class_name
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 52
PDDISABLE
-m message_text
Use this option to include a message about the printer, queue, or server that you are disabling. For example, when a printer is to be disabled the message attached to the printer might be:
-m "Printer1 not accepting jobs."
If you use the -x extended_attribute_string option or the -X attribute_filename option in the pddisable command, the comparable client attribute type and value is the following:
message =message_text
The option will look like this:
-x "message='Printer1 not accepting jobs' "
To retrieve a message of this type, use the pdls command, specify the printer, queue, or server, and include the following option:
-r message
-x extended_attribute_string
Use this option to build a series, or string, of attribute=value pairs on the command line that will be implemented when pddisable is executed.
attributes Object attributes cannot be used in the -x option.
The following client attributes can be used:
• attributes
• class
• message
syntax Follow the syntax rules for attribute value strings, listed in the Overview chapter of the PrintXchange Command Line Interface Reference Guide.
Note: You can produce the same result by including the extended_attribute_string in an attribute file and identifying that file as the attribute_filename in the -X option.
-X attribute_filename
The -X option identifies an attribute file to be read by the command. When the pddisable command executes, the attribute data included in the file is processed at the current point in the command line as though it had been specified with the -x option.
attributes Object attributes cannot be used in the -X option. Refer to the -x section for a list of the client attributes that may be used.
Note: Refer to the Overview chapter of the PrintXchange Command Line Interface Reference Guide for information on developing an attribute file.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 53
PDDISABLE
Operands
The value of the object_instance in the operand is based on the value of the -c class_name option or the class =class_name attribute.
printer_name ... When class is printer , the value of printer_name is the name of the logical or physical printer to be disabled.
queue_name ... When
class is queue , the value of queue_name is the name of the queue to be disabled.
server_name ... When class is server , the value of [server_name:] is the name of the spooler or supervisor to be disabled.
Examples
1. Disable both printer1 and printer2 printers. The printers can be physical and/or logical printers.
pddisable printer1 printer2
2. Disable the server called big-spooler and attach a message that can be retrieved using the pdls command.
pddisable -c server -m "server not available" big-spooler
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 54
7. pdenable
Name
pdenable - enable a printer, server, or queue.
Synopsis
pdenable [-c class_name] [-m message_text][-x extended_attribute_string ... ] [-X attribute_filename ... ]object_instance ...
Use this command to display help about pdenable.
pdenable -h
Description
Use the pdenable command to enable a printer, server, or queue to accept jobs for printing.
You can invoke pdenable on printer, queue, and server objects only. If you specify any other object or an invalid object, an error results. Specifying an object that is already enabled also results in an error.
• When the object to be enabled is a logical printer :
— The associated-queue attribute must be set to an existing queue prior to invoking the pdenable command or an error results.
— The printer is added to the logical-printers-ready attribute for the associated queue and spooler.
— The printer is added to the printer-ready attribute of all associated physical printers.
• When the object to be enabled is a physical printer :
— The queue named in the associated-queue attribute must already exist. The spooler that supports this queue must be running in order for the command to succeed.
— The printer is added to the supervisor's physical-printers-ready attribute.
— The printer is added to the physical-printers-ready attribute of the associated queue and spooler.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 55
PDENABLE
• When the enabled object is a spooler , it begins to accept jobs on its enabled logical printers, if the associated queue is enabled as well.
• When the enabled object is a supervisor , it begins to accept jobs on its enabled physical printers.
• A queue may be enabled without being attached to printers.
access level Operator
Options
The following options are supported for pdenable.
-c class_name
Specifies the class, or type, of object you are enabling.
arguments The values allowed for class_name are the following:
• printer
• server
• queue
Note: The Operands section describes of the object_instance that is associated with each class.
If you use the -x string option or the -X file option, the comparable attribute type and value is the following:
class =class_name
-m message_text
Use this option to include a message about the printer, queue, or server that you are enabling. For example, when a printer is to be enabled the message attached to the printer might be:
-m "Printer1 now accepting jobs."
If you use the -x extended_attribute_string option or the -X attribute_filename option in the pdenable command, the comparable client attribute type and value is the following:
message =message_text
The option will look like this:
-x "message='Printer1 now accepting jobs.' "
To retrieve a message of this type, use the pdls command, specify the printer, queue or server, and include the following option:
-r message
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 56
PDENABLE
-x extended_attribute_string
Use this option to specify a series of attribute=value pairs on the command line that will be processed by the pdenable command.
attributes Object attributes cannot be used in the -x option.
The following client attributes can be used:
• attributes
• class
• message
syntax Follow the syntax rules for attribute value strings, listed in the Overview chapter of the PrintXchange Command Line Interface Reference Guide.
Note: You can produce the same result by including the extended_attribute_string in an attribute file and identifying that file as the attribute_filename in the -X option.
-X attribute_filename
The -X option identifies an attribute file to be read by the command. When the pdenable command executes, the attribute data included in the file is processed at the current point in the command line as though it had been specified with the -x option.
attributes Object attributes cannot be used in the -X option. Refer to the -x section for a list of the client attributes that may be used.
Note: Refer to the Overview chapter of the PrintXchange Command Line Interface Reference Guide for information on developing an attribute file.
Operands
The value of the object_instance in the operand is based on the value of the -c class_name option or the class =class_name attribute.
printer_name ... The system default. When class is printer , the value of printer_name is the name of the logical or physical printer to be enabled.
server_name ... When class is server , the server_name is the name of the spooler or supervisor to be enabled.
queue_name ... When class is queue , the value of queue_name is the name of the queue to be enabled.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 57
PDENABLE
Examples
1. Enable the printer named printer1.
pdenable printer1
Note: The command determines what server to send the enabled request to by looking up printer1 in the NameSpace database.
2. Enable the server called big-spooler and include a message included that can be retrieved by the pdls command.
pdenable -x class=server -x message="Ready to go" big-spooler
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 58
8. pdls
Name
pdls - list the attributes of a print object.
Synopsis
pdls [-c class_name] [-f filter_text] [-F] [-g][-r requested_attributes] [-s style_name][-x extended_attribute_string ... ] [-X attribute_filename ... ] [object_instance ... ]
Use this command to display help about pdls.
pdls -h
Description
Use the pdls command to display an object's attributes and values. You can use this command to list the attributes of the following:
• A specified object.
• All objects of a specified class. If the class is server, only the attributes for the default server are listed.
• A subset of all objects and values as constrained by a filter.
access level End user. The command lists only information about objects for which the user has the appropriate access control level.
When an end user displays information about other users’ jobs, the attributes returned are limited to those included on the server’s job-attributes-visible-to-all attribute.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 59
PDLS
Options
The following options are supported for pdls.
-c class_name
Specifies the class, or type, of object that will have its attributes displayed.
arguments The values allowed for class_name are the following:
• document
• initial-value-document
• initial-value-job
• job (This is the default.)
• printer
• queue
• server
Note: The Operands section describes the specific object_instance associated with each class.
If you use the -x string option or the -X file option, the comparable client attribute type and value is the following:
class =class_name
-f filter_text
Use a filter to select a template of requirements, in the form of a logical expression or text string, through which a subset of a group of object values can pass. The command returns only those object values that match the value of the filter expression.
default values The default value for the filter text is based on the class of the object and is one of the following:
• When the object is job , the default value for the filter_text is the following:
— job-owner ==userName
• When the object is anything other than job, the default is no filter expression.
If you use the -x string option or the -X file option, the comparable client attribute is the following:
filter =filter_text
Note: Appendix B of the PrintXchange Command Line Interface Reference Guide contains filter item and recursive filter syntax information.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 60
PDLS
-F
Use this option to turn off all filtering, including any default filtering provided when the -f filter_text option is unspecified.
Note: -F takes precedence over any -f filter_text options specified in the command line.
-g
Use this option to omit column headings.
If you use the -x string option or the -X file option, the comparable client attribute is the following:
headings =no
-r requested_attributes
Use this option to specify the attributes that you want pdls to write to output when generating an attribute report.
arguments The values allowed for requested_attributes are the following:
• verboseThis value specifies that an expanded set of attributes is written to output.
• briefThis value specifies that a subset of the verbose list of attributes is written to output. This is the default.
• allThis value specifies that all attributes with values are written to output.
• none This value specifies that no attributes are written to output.
• "attributes_list"You can specify the set of attributes you want displayed. Make sure that you enclose the attribute line in quotes. Separate attributes in the list with a space. For example,
-r "descriptor physical-printers-ready locales-supported"
specifies that you want only the above three attribute values displayed.
Refer to Appendix E of the PrintXchange Command Line Interface Reference Guide for the attributes that are included in the verbose and brief listings for each print object.
If you use the -x string option or the -X file option, the comparable attribute is the following:
requested-attributes =requested_attributes
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 61
PDLS
-s style_name
Use this option to define how the output requested with the -r requested_attributes option is to be formatted.
arguments The values allowed for style_name are the following:
• columnThe output displays a separate column for each requested attribute. This is the default for every value of the -r requested_attributes option except all .
• lineThe output displays a separate line for each requested attribute. This is the default for the all value of the -r requested_attributes option.
If you use the -x string option or the -X file option, the comparable attribute is the following:
style =style_name
-x extended_attribute_string
Use this option to specify a series of attribute=value pairs on the command line that will be processed by the pdls command.
attributes Object attributes cannot be used in the -x option.
The following client attributes can be used:
• attributes
• class
• filter
• headings
• requested-attributes
• style
• time-limit
— time-limit= nThis attribute displays information every n seconds. Use this attribute to break a long request into several smaller ones.
• count-limit
— count-limit= nThis attribute allows you to display information for every n objects. Use this attribute to break a long request into several smaller ones.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 62
PDLS
• scope (This attribute applies only when class =job.)
— scope=0 Only the job attributes are listed. This is the default.
— scope=1The job and the document attributes are listed.
syntax Follow the syntax rules for attribute value strings, listed in the Overview chapter of the PrintXchange Command Line Interface Reference Guide.
Note: You can produce the same result by including the extended_attribute_string in an attribute file and identifying that file as the attribute_filename in the -X option.
-X attribute_filename
The -X option identifies an attribute file to be read by the command. When the pdls command executes, the attribute data included in the file is processed at the current point in the command line as though it had been specified with the -x option.
attributes Object attributes cannot be used in the -X option. Refer to the -x section for a list of the client attributes that may be used.
Note: Refer to the Overview chapter of the PrintXchange Command Line Interface Reference Guide for information on developing an attribute file.
Operands
The value of the object_instance in the operand is based on the value of the -c class_name option or the class =class_name attribute. Multiple object instances can be specified.
If object_instance is omitted, all objects of the requested class on the default spooler are listed.
If the spooler_name or server_name is specified alone, all objects of the requested class are listed.
[spooler_name:][job_id] When class_name equals job , the command will list the requested attributes (-r requested_attributes) of a job. This is the default. The value of job_id is the unique identifier of that job. For example,
big-spooler:120
identifies the job with an id of 120 on the big-spooler server.
Note: You can include the scope attribute in the -x option to list attributes of documents that are a part of the job (-x “scope=1”).
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 63
PDLS
[spooler_name:][job_id.doc_int] When class_name equals document , the command will list the requested attributes (-r requested_attributes) of the document named in job_id.doc_int. The document identifier (doc_int ) is the number that represents the document's position in the job. For example,
big-spooler:120.2
identifies the second document in the job with an id of 120 on the big-spooler server.
[spooler_name:][ivdoc_name] When class_name equals initial-value-document , the command will list the requested attributes (-r requested_attributes) of the initial-value-document named in ivdoc_name.
[spooler_name:][ivjob_name] When class_name equals initial-value-job , the command will list the requested attributes (-r requested_attributes) of the initial-value-job named in ivjob_name.
Note: For job_id, job_id.doc_int, ivdoc_name, and ivjob_name, if spooler_name is not specified, the default spooler is assumed.
[server_name:][printer_name] When class_name equals printer , the command will list the requested attributes (-r requested_attributes) of the printer named in printer_name.
• The value for printer_name can be the name of a logical or physical printer.
• If the server_name refers to the spooler, the printer_name must refer to the logical printer.
• If the server_name refers to the supervisor, the printer_name must refer to the physical printer.
• If printer_name is omitted, the command displays information about all printers on the server.
[spooler_name:][queue_name] When class_name equals queue , the command will list the requested attributes (-r requested_attributes) of the queue named in queue_name.
Note: For printer_name and queue_name, the server_name or spooler_name is not necessary when specifying individual printer and queue names.
[server_name] When class_name equals server , the command will list the requested attributes (-r requested_attributes) of the spooler or supervisor in [server_name:].
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 64
PDLS
Examples
1. List all jobs belonging to you on the default spooler.
pdls
2. List all jobs belonging to everyone on the default spooler.
pdls -F
3. List all queues on the default spooler.
pdls -c queue
4. List the attributes for the printers named LP1 and PP2.
pdls -c printer LP1 PP2
Since brief is the default value for the -r requested-attributes option, the above command is equivalent to:
pdls -c printer -r brief LP1 PP2
5. List the job and document attributes for job3 .
pdls -c job -x "scope=1" spooler1:job3
6. List all logical and physical printers ready for queue1 on the default spooler and queue2 on spooler2 .
pdls -c queue -r "logical-printers-ready physical-printers-ready" queue1 spooler2:queue2
7. List all queues on the spooler myspooler .
pdls -c queue myspooler
8. List all jobs in the printer LP1.
pdls -c job -f "printer-name-requested==LP1"
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 65
PDLS
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 66
9. pdmod
Name
pdmod - modify the attributes of a job.
Synopsis
pdmod [-g] [-m message_text] [-n copies][-N notification_method] [-r requested_attributes][-s style_name] [-t job_name][-x extended_attribute_string ... ] [-X attribute_filename ... ] [spooler_name:job_id[.doc_int] ...
Use this command to display help about pdmod.
pdmod -h
Description
Use the pdmod command to modify job and document attributes of a job that has already been submitted for printing but has not yet started to print. Changes made to the job are retained through server restarts.
Note: The modified job will not lose its position in the queue. However, the entire job is subject to the same attribute validation as when the job was created. If the modification would result in a job that is not valid for the queue, the pdmod command is rejected.
access level End user. An end user cannot modify other users’ jobs. Operators and administrators can modify other users’ jobs.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 67
PDMOD
Options
The following options are supported for pdmod.
-g
When this option is used, any output is displayed without column headings.
If you use the -x string option or the -X file option, the equivalent attribute is the following:
headings =no
-m message_text
Use this option to include a message about the job or document that you are modifying. For example, when a job is to be modified, the message attached to the job might be:
-m "Copies required changed to 1000"
If you use the -x extended_attributes_string option or the -X attribute_filename option in the pdmod command, the equivalent client attribute type and value is the following:
For documents: message =message_text
For jobs: job-message-from-administrator =message_text
The option will look like this:
-x "job-message-from-administrator='Copies required changedto1000' "
To retrieve a message of this type, use the pdls command, specify the job or document, and include the following option:
-r message
-n copies
Use this option to specify the new number of copies of the print job or document that should be printed.
If you use the -x string option or the -X file option, the equivalent attribute is the following:
job-copies =number
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 68
PDMOD
-N notification_method
Use this option to specify how you want to be notified of the completion of your job.
arguments In the UNIX environment, allowable values for notification_method are:
smtp-mail [:address]
email [:address]
notification-service [:address]
message [:address]
socket-event
In the Windows NT environment, allowable values for notification_method are:
smtp-mail :address
email :address
ms-mail :address
socket-event :address
message :address
notification-service :address
If you use the -x string option or the -X file option, specify the delivery-method field of the following attribute:
notification-profile =profile
Refer to the PrintXchange System Administration and Operations Guide for address syntax examples.
-r requested_attributes
Use this option to define the group of attributes that you want pdmod to write to standard output to generate an attribute report.
arguments The values allowed for requested_attributes are the following:
• verboseThis value specifies that an expanded set of attributes are written to output.
• briefThis value specifies that a subset of the verbose list attributes are written to output.
• allThis value specifies that the verbose list plus attributes specified by the user are written to output. Specified attributes without values are not displayed.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 69
PDMOD
• noneThis value specifies that no attributes are written to output. This is the default.
Note: Refer to Appendix E of the PrintXchange Command Line Interface Reference Guide for the attributes that are included in the verbose and brief listings for each print object.
If you use the -x string option or the -X file option, the equivalent attribute is the following:
requested-attributes =requested_attributes
-s style_name
Use this option to define how the standard output requested with the -r requested_attributes option is to be formatted.
arguments The values allowed for style_name are the following:
• columnThe output displays a separate column for each requested attribute. This is the default for every value of the -r requested_attributes option except all .
• lineThe output displays a separate line for each requested attribute. This is the default for the all value of the -r requested_attributes option.
If you use the -x string option or the -X file option, the equivalent attribute is the following:
style =style_name
-t job_name
Use this option to specify the new name of the job that is being modified.
arguments The value allowed for job_name is a text string.
If you use the -x string option or the -X file option, the equivalent attribute is the following:
job-name =name
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 70
PDMOD
-x extended_attribute_string
Use this option to specify a series of attribute=value pairs on the command line that will be processed by the pdmod command.
attributes Settable job and document object attributes may be used with the -x and -X options, except for the following:
• Job attributes (attribute names are shown in bold text; attribute categories are shown in regular text)
— job-identifier
— job-originator
— job-owner
— initial-value-job
— printer-name-requested
— job security attributes
— job status attributes
— job access attributes
— accounting attributes
• Document attributes
— initial-value-document
— transfer-method
— document status attributes
Note: Refer to Appendix A of the PrintXchange Command Line Interface Reference Guide for a complete listing of all supported object attributes.
Client attributes that may be used are the following:
• attributes
• class
• filter
• headings
• message
• style
syntax Follow the syntax rules for attribute value strings, listed in the Overview chapter of the PrintXchange Command Line Interface Reference Guide.
Note: You can produce the same result by including the extended_attribute_string in an attribute file and identifying that file as the attribute_filename in the -X option.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 71
PDMOD
Modification operators
You can include an operator with attribute=value pairs to indicate the type of modification to be done to the specified attribute. The three modification operators are:
• + (add value)
When you use attribute+=value, you add a value to the attribute. This can only be used with multi-valued attributes. If you add a value that already exists, the attribute contains the same value twice.
• - (remove value)
When you use attribute-=value, you remove a value from the attribute. If the value is not present, pdmod ignores the command. If you remove the last value for an attribute, pdmod sets the value to the server default. If a value to be removed occurs more than once, pdmod removes all occurrences.
• = (reset to default value)
When you use attribute==, you set the attribute value to its default. Do not include a value when resetting to the default value.
-X attribute_filename
The -X option identifies an attribute file to be read by the command. When the pdmod command executes, the attribute data included in the file is processed at the current point in the command line as though it had been specified with the -x option.
attributes Settable job and document object attributes, except those listed in the -x extended_attribute_string section of this chapter, may be used with the -X option. Refer to the -x section for a list of the client attributes that may be used.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 72
PDMOD
Operands
The following operand is supported for pdmod. Multiple instances of the operand can be specified.
[spooler_name:]job_id[.doc_int] ... [spooler_name:]
Optional. Identifies the specific server on which the job to be modified resides. If the server is not specified, the default spooler is assumed.
job_id
Required. The job_id identifies the specific job to be modified.
[.doc_int]
Optional. A number that must be at least 1 or at most the total number of documents in the job. This number identifies the specific document in the job to be modified. For example, big-spooler:116.3 identifies the third document in the job with an identity of 116 on the spooler named big-spooler .
• If [.doc_int] is not specified, any document attribute modifications included in the command are made on all documents in the job. Specified job attributes are applied to the job.
• If [.doc_int] is specified, any document attribute modifications included in the command are made only on the specified document. An error is returned if you include modifications to job attributes.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 73
PDMOD
Examples
1. Change the copy count to 4 for the job with an id of 10 on spooler1 .
pdmod -n 4 spooler1:10
2. Change the job retention period to 60 minutes (1 hour) for job 3 on the default spooler.
pdmod -x "job-retention-period=60" 3
3. Change the default medium for the third document of job 1 on the default spooler.
pdmod -x "default-medium=a" 1.3
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 74
10. pdpause
Name
pdpause - pause a job, physical printer, queue, or spooler.
Synopsis
pdpause [-c class_name] [-m message_text][-x extended_attribute_string ... ] [-X attribute_filename ... ] object_instance ...
Use this command to display help about pdpause.
pdpause -h
Description
Use the pdpause command to pause a pending or held print job, a physical printer, a queue, or a spooler. The following items should be considered when using this command:
• If you specify any other object or an invalid object, such as a logical printer or a supervisor, an error results. Specifying an object that is already paused also results in an error.
• The current state of the object is changed to paused . Using the pdls or the pdq command will list the state of the object.
• You may pause both enabled and disabled objects.
• A paused object can be resumed using the pdresume command.
• Although paused physical printers, queues, and spoolers do not process jobs, they can continue to accept and respond to requests such as pdls.
• When the paused object is a job :
— Only pending or held jobs can be paused
— A specific document within the job cannot be paused.
— There is no time limit for how long a job can be paused. A paused job will not print until it is resumed.
— A job cannot be rescheduled until it is resumed.
— The command fails if the job was already submitted to the supervisor for printing.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 75
PDPAUSE
• When the paused object is a physical printer :
— When paused, it stops printing as soon as possible. When resumed, it continues printing from where it left off.
— Some printing devices can stop printing in the middle of a job when the printer is paused. When the printer is resumed, the job continues printing. There is no need to resubmit the job.
— Some printing devices cannot stop printing in the middle of a job when the printer is paused. Even though the printer is paused, the current job finishes printing before the pdpause command takes effect.
— While it is in the paused state, the spooler associated with the printer will not schedule new jobs.
— If the printer is not printing when paused, it still needs to be resumed in order to start printing again.
— Jobs sent to a paused printer will not be scheduled until the printer resumes printing.
• When the paused object is a queue :
— A paused queue will not submit jobs to associated physical printers.
— The state of each logical printer associated with the queue does not change, but jobs submitted will be in a pending state.
— The state of each job currently in the paused queue does not change.
• When the paused object is a spooler :
— It will not submit jobs to supervisors.
— The logical printers associated with the spooler continue to accept new jobs.
access level End user. End users can use pdpause to pause their own jobs.
Operator. Operators can use pdpause on jobs, physical printers, queues, and spooler objects.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 76
PDPAUSE
Options
The following options are supported for pdpause.
-c class_name
This option specifies the class, or type, of object that is to be paused.
arguments The values allowed for class_name are the following:
• printer (Physical printer only.) The default value.
• job
• queue
• server (Spooler only.)
Note: The OPERANDS section describes the specific object_instance that is associated with each class.
If you use the -x string option or the -X file option, the comparable attribute type and value is the following:
class =class_name
-m message_text
Use this option to include a message about the object that you are pausing. For example, when a physical printer is to be paused, the message attached to the printer might be:
-m "Printer1 paused, not currently printing jobs."
If you use the -x extended-attribute-string option or the -X attribute_filename option in the pdpause command, the comparable client attribute type and value is the following:
For physical printers, queues, and spoolers:
message =message_text
For jobs:
job-message-from-administrator =message_text
The option will look like this:
-x "message= 'Printer1 paused, not currently printing jobs' "
To retrieve a message of this type, use the pdls command, specify the job or document, and include the following option:
-r message
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 77
PDPAUSE
-x extended_attribute_string
Use this option to specify a series of attribute=value pairs on the command line that will be processed by the pdpause command.
attributes Object attributes cannot be used in the -x option.
You can specify the following client attributes:
• attributes
• class
• message
syntax Follow the syntax rules for attribute value strings listed in the Overview chapter of the PrintXchange Command Line Interface Reference Guide.
Note: You can produce the same result by including the extended_attribute_string in an attribute file and identifying that file as the attribute_filename in the -X option.
-X attribute_filename
The -X option identifies an attribute file to be read by the command. When the pdpause command executes, the attribute data included in the file is processed at the current point in the command line as though it had been specified with the -x option.
attributes Object attributes cannot be used in the -X option. Refer to the -x section for a list of the client attributes that may be used.
Note: Refer to the Overview chapter of the PrintXchange Command Line Interface Reference Guide for information on developing an attribute file.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 78
PDPAUSE
Operands
The value of the object_instance in the operand is based on the value of the -c class_name option or the class =class_name attribute.
Note: Multiple objects of the same class can be paused simultaneously by specifying multiple object instances.
printer_name ... When class equals printer , the value of printer_name is the name of the physical printer to be paused.
Note: Although you cannot pause a logical printer, you can use the pddisable command to prevent a job from being submitted through a logical printer.
[spooler_name:]job_id ... When class equals job , the value of job_id is the unique identifier that points to the job that is to be paused.
Note: If [spooler_name:] is not specified, the default spooler is assumed.
queue_name ... When class equals queue , the value of queue_name is the name of the queue to be paused.
spooler_name ... When class is server , the value of spooler_name is the name of the spooler to be paused.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 79
PDPAUSE
Examples
1. Pause printer1 for service on the printer.
pdpause -m "fixing jam" printer1
2. Pause printer1 and printer2 .
pdpause printer1 printer2
3. Pause job 123, which has not yet been scheduled, on spooler sp11 . Other jobs will continue to print.
pdpause -c job -m "print this later" sp11:123
4. Pause a queue called q2. Jobs will be accepted but not sent to the printer. Use this when you need to stop every physical printer that is associated with a queue.
pdpause -c queue -m "pausing queue2" q2
Note: This process produces the same results as performing a pddisable on each physical printer associated with the queue.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 80
11. pdpr
Name
pdpr - submit a job for printing.
Synopsis
pdpr [-f filename] [-g] [-n copies] [-N notification_method][-p printer_name] [-r requested_attributes] [-s style_name][-t job_name] [-x extended_attribute_string ... ] [-X attribute_filename ... ][filename ... ]
Use this command to display help about pdpr.
pdpr -h
Description
Use the pdpr command to print files. The pdpr command submits the print job to a logical printer. The spooler associated with the logical printer validates your access privileges, creates a job object by attaching attribute data, identifies a physical printer that can support the job's requirements, and inserts the job into a queue. The job is then scheduled and sent to the physical printer.
Consider the following items when using this command:
• A print job consists of one or more documents.
• When you specify filenames for printing in a single command line, pdpr creates:
— A document object for each filename specified.
— A print job object containing all the documents that were created. A unique job identifier is assigned to the job so that it can be accessed by other commands.
• Job attributes apply to all documents in the job. They can be specified anywhere on the command line but must be included before the operands.
• Unless it is used again, a document attribute applies to all documents that appear after it on the command line.
• If one document in a multi-document job fails, the pdpr command fails.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 81
PDPR
• If a printer is not specified, pdpr uses the value of the default logical printer. The command fails if the PDPRINTER environment variable has no value.
access level End user
Options
The following options are supported for pdpr.
-f filename
Use this option to specify the file that you want printed as one document in a print job. The command creates a document for each filename you include in the command line, and all of the documents become the job. Use this option when you submit a job of multiple files that require different document attributes.
• On the command line, all the document attributes that you include before you add the filename apply to the document.
• All document attributes that follow the filename on the command line do not apply to the document. They apply either to the next file specified or to the file specified as the operand.
Note: This also applies to attributes included in the -x string option or the -X file option.
If you omit the -f filename option and omit the operand, pdpr reads from standard input.
If you specify a hyphen (-) for the operand, the filenames specified with the -f filename option are honored in the print submission, followed by standard input.
If you use the -x string option or the -X file option, the comparable attribute is the following:
document-filename =filename
-g
Use this option to omit line or column headings.
If you use the -x string option or the -X file option, the comparable attribute is the following:
headings =no
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 82
PDPR
-n copies
Use this option to specify the number of copies of the print job that you want printed.
If you use the -x string option or the -X file option, the comparable attribute is the following:
job-copies =number
-N notification_method
Use this option to specify how you want to be notified when your job has completed.
In the UNIX environment, allowable values for notification_method are:
smtp-mail [:address]
email [:address]
notification-service [:address]
message [:address]
socket-event
In the Windows NT environment, allowable values for notification_method are:
smtp-mail :address
email :address
ms-mail :address
socket-event :address
message :address
notification-service :address
If you use the -x string option or the -X file option, specify the delivery-method field of the following attribute:
notification-profile =profile
Refer to the PrintXchange System Administration and Operations Guide for address syntax examples.
-p printer_name
Use this option to specify the name of the logical printer to which you are submitting the print job.
arguments The allowable value is the name of a specific logical printer.
Note: The command fails if this option is omitted and no printer is specified in the PDPRINTER environment variable.
If you use the -x string option or the -X file option, the comparable attribute is the following:
printer-name-requested =printer_name
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 83
PDPR
-r requested_attributes
Use this option to specify the attributes that you want pdpr to write to standard output to generate an attribute report.
arguments The values allowed for requested_attributes are the following:
• verboseThis value specifies that an expanded set of attributes is written to output.
• briefThis value specifies that a subset of the verbose list of attributes is written to output.
• allThis value specifies that all attributes with values are written to output.
• noneThis value specifies that no attributes are written to output. This is the default.
Note: Refer to Appendix E in the PrintXchange Command Line Interface Reference Guide for the attributes that are included in the verbose and brief listings for each print object.
If you use the -x string option or the -X file option, the comparable attribute is the following:
requested-attributes =requested_attributes
-s style_name
Use this option to define how the output requested with the -r requested_attributes option is to be formatted.
arguments The values allowed for style_name are the following:
• columnThe output displays a separate column for each requested attribute. This is the default for every value of the -r requested_attributes option except all .
• lineThe output displays a separate line for each requested attribute. This is the default for the all value of the -r requested_attributes option.
If you use the -x string option or the -X file option, the comparable attribute is the following:
style =style_name
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 84
PDPR
-t job_name
Use this option to specify a new name for the job that is being submitted. If this option is omitted, the name of the first file becomes the name of the job.
arguments The value allowed for job_name is a text string.
If you use the -x string option or the -X file option, the comparable attribute is the following:
job-name =name
-x extended_attribute_string
Use this option to specify a series of attribute=value pairs on the command line that will be processed by the pdpr command. The assignment operator ( = ) can be used to set the value of an attribute. For example:
-x "document-formats=PCL".
attributes All job and document settable attributes may be used with the -x and the -X option.
Client attributes that may be used are the following:
• attributes
• requested-attributes
• document-filename
• headings
• style
Note: Refer to Appendix A of the PrintXchange Command Line Interface Reference Guide for a complete listing of all supported object and client attributes.
syntax Follow the syntax rules for attribute value strings, listed in the Overview chapter of the PrintXchange Command Line Interface Reference Guide, when you specify your string of attribute=value pairs. You can produce the same result by including the extended_attribute_string in an attribute file and identifying that file as the attribute_filename in the -X option.
Note: Refer to the Notes section in this chapter for information about file transfer and event notification features that are available using the -x or -X option.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 85
PDPR
-X attribute_filename
The -X option identifies an attribute file to be read by the command. When the pdpr command executes, the attribute data included in the file is processed at the current point in the command line as though it had been specified with the -x option.
attributes Settable job and document attributes may be used with the -X option. Refer to the -x section for a list of the client attributes that may be used.
Note: Refer to the Overview chapter of the PrintXchange Command Line Interface Reference Guide for information on developing an attribute file.
Operands
The following object_instance in the operand is supported for pdpr:
[filename ... ] • Optional; Identifies the specific file(s) to be printed.
— Each file becomes a document within the job. Separate filenames with at least one space. If any file does not exist, the job is rejected.
— If filename is omitted, and the -f option is not specified, pdpr reads from standard input.
— If a hyphen ( - ) is given as the filename, pdpr reads from standard input. Any filenames specified with the -f filename option or as the object_instance are also honored in the same print submission
Examples
1. Submit the file called semantics.txt to the default printer.
pdpr semantics.txt
2. Submit the file quote.ps to the logical printer called joes-printer .
pdpr -p joes-printer quote.ps
3. Submit the file q1.ps as one-sided and file q2.ps as two-sided to the default printer.
pdpr -x "sides=1" -f q1.ps -x "sides=2" q2.ps
4. Submit the file ken to the default printer and request 25 copies.
pdpr -n 25 ken
5. Submit the file quote.ps to the default printer and request that electronic mail be delivered to you when the job has completed printing or if the job is aborted:
pdpr -N email quote.ps
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 86
PDPR
6. Submit the file quote.ps to the default logical printer and request brief information about the job, including the job id and position in the queue, before it is assigned to a physical printer.
pdpr -r brief quote.ps
Notes
File transfer
The process of moving a document file to a spooler during job submission can occur several ways. PrintXchange supports three transfer methods. You specify one by including the transfer-method attribute in the -x extended_attribute_string or the -X attribute_filename option when you submit a job using pdpr. The file transfer methods supported by PrintXchange are:
• with-request (Default if document data less than 10,000 bytes)
• socket (Default if document data more than 10,000 bytes)
• file-reference
with-request -x "transfer-method=with-request"
During a with-request transfer, the document data is sent to the spooler as part of the print request. The spooler receives the data and copies it to its spool directory. The pdpr command does not finish until all document data has been transferred to the spooler.
Note: The with-request transfer method is the system default if the document data is less than 10,000 bytes.
socket -x "transfer-method=socket"
During a socket transfer, the spooler provides socket information that the pdpr command uses to write the document data to the specific socket. The spooler reads the information from the socket and writes it to the spool directory. The pdpr command does not finish until all the document data has been transferred from the socket to the spooler. Control does not return to the client until the transfer is complete.
Note: The socket transfer method is the system default if the document data is more than 10,000 bytes.
file-reference -x "transfer-method=file-reference"
During a file-reference transfer, the pdpr command sends the document data path to the spooler. In this case, the data file is not copied. The spooler verifies the path and uses it to access the print data directly. If the spooler cannot reach the data, the print request is rejected.
Note: The file-reference method is useful for printing very large documents. However, since the job is not copied, you cannot modify or delete the file until the print job is complete.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 87
PDPR
Event notification
You can include the event notification feature when you prepare to submit a job using the pdpr command. By doing so, status data is provided as the job moves through the system to the printer. The following methods are available:
• -x notification-profile =profile_attribute
• -N notification-method option
Note: Refer to Appendix D of the PrintXchange Command Line Interface Reference Guide for a list of events.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 88
12. pdpromote
Name
pdpromote - move a job to the head of a queue.
Synopsis
pdpromote [-m message_text][-x extended_attribute_string...][-X attribute_filename...][spooler_name:]job_id
Use this command to display help about pdpromote.
pdpromote -h
Description
Use the pdpromote command to move a specified print job to the top of the queue to which it was submitted. Consider the following items when using this command:
• Jobs that are already printing are not affected by the command.
• Only jobs that are held, paused, or pending can be promoted.
• If there are multiple promoted jobs, the first one to print will be the most recent one promoted.
• A promoted job can be promoted again.
• The promote command sets the job attribute job-promote-time to the current time.
access level Operator
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 89
PDPROMOTE
Options
The following options are supported for pdpromote.
-m message_text
Use this option to include a message about the job that you are promoting.
If you use the -x extended-attribute-string option or the -X attribute_filename option in the pdpromote command, the comparable client attribute type and value is the following:
job-message-from-administrator =message_text
To request this message about the job using the pdls command, identify the job or document, and include the following option:
-r job-message-from-administrator
-x extended_attribute_string
Use this option to specify a series of attribute=value pairs on the command line that will be processed by the pdpromote command.
attributes Object attributes cannot be used in the -x option, including job-message-from-administrator .
The following client attributes can be used:
• attributes
• message
syntax Follow the syntax rules for attribute value strings listed in the Overview chapter of the PrintXchange Command Line Interface Reference Guide.
Note: You can produce the same result by including the extended_attribute_string in an attribute file and identifying that file as the attribute_filename in the -X option.
-X attribute_filename
The -X option identifies an attribute file to be read by the command. When the pdpromote command executes, the attribute data included in the file is processed at the current point in the command line as though it had been specified with the -x option.
attributes Object attributes cannot be used in the -X option. Refer to the -x section for a list of the client attributes that may be used.
Note: Refer to the Overview chapter of the PrintXchange Command Line Interface Reference Guide for information on developing an attribute file.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 90
PDPROMOTE
Operands
The following object_instance in the operand is supported for pdpromote:
[spooler_name:]job_id The value of job_id is the unique identifier of the specific job to be promoted.
• Job_id must have a value.
• You can specify only one job in job_id.
• If [spooler_name:] is omitted, the default spooler is assumed.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 91
PDPROMOTE
Examples
1. Promote job 123 on the big-spool spooler to be printed next. Commands include a message explaining why the job is being promoted.
pdpromote -m "I need this right away" big-spool:123
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 92
13. pdq
Name
pdq - display information about all print jobs in a specific queue or jobs specified by their job id.
Synopsis
pdq [-f filter_text] [-F] [-g] [-p printer_name][-r requested_attributes] [-s style_name][-x extended_attribute_string ... ] [-X attribute_filename ... ] [object_instance] ...
Use this command to display help about pdq.
pdq -h
Description
Use the pdq command to query and report a list of jobs that have been submitted to the queue associated with a specific logical printer. This information covers all jobs currently residing in the queue associated with the printer. The data is displayed in the order in which the jobs are scheduled to print.
The pdq command also displays completed jobs. Completed jobs are shown in reverse order of their completion time. For example, if job1 , job2 , and job3 completed in the said order, they will be displayed as: job3 , job2 , job1 .
The following items should be considered when using this command:
• pdq displays the report on the screen.
• If a logical printer is not specified, pdq lists jobs for the default queue.
• If specific jobs are not requested as an object_instance, the information reported covers all jobs in the queue associated with the logical printer specified in the -p printer_name option.
access level End user. End users can see their own jobs. When an end user displays information about other users’ jobs, the attributes returned are limited to those included on the server’s job-attributes-visible-to-all attributes.
Operator & Administrator. Operators and administrators can see all jobs.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 93
PDQ
Note: For more information on attributes visible to end users, refer to the server attribute job-attributes-visible-to-all in Appendix A of the PrintXchange Command Line Interface Reference Guide.
Options
The following options are supported for pdq.
-f filter_text
A filter provides a template of requirements, in the form of a logical expression or text string, through which a subset of a group of object values can pass. pdq returns only those object values that match the value of the filter expression.
default value The default value for the filter_text is the following:
job-owner ==userName
syntax The filter_text can be represented as a filter item or a filter.
Note: Refer to Appendix B of the PrintXchange Command Line Interface Reference Guide for syntax information.
If you use the -x string option or the -X file option, the comparable attribute is the following:
filter =filter_text
-F
Use this option to turn off all filtering, including any default filtering.
Note: -F takes precedence over any -f filter_expression options specified in the command line.
-g
When this option is used, any output is displayed without column headings.
If you use the -x string option or the -X file option, the equivalent attribute is the following:
headings =no
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 94
PDQ
-p printer_name
Use this option to specify the name of the logical printer for which you are listing print jobs.
arguments The value allowed for printer_name is the name of a specific logical printer. This value is ignored if an object_instance is specified.
If you use the -x string option or the -X file option, the comparable attribute is the following:
printer-name-requested =printer_name
-r requested_attributes
Use this option to specify the attributes that you want pdq to write to standard output to generate an attribute report.
arguments The values allowed for requested_attributes are the following:
• verbose This value specifies that an expanded set of attributes is written to output.
• briefThis value specifies that a subset of the verbose list of attributes is written to output.
• allThis value specifies that all attributes with values are written to output.
• noneThis value specifies that no attributes are written to output. This is the default.
• "attributes_list"You can list the specific attributes you want to be displayed. Make sure that you enclose the attribute line in quotes. Separate attributes in the list with a space. For example,
-r "job-owner job-name"
specifies that you want only the above two attribute values displayed.
Refer to Appendix E of the PrintXchange Command Line Interface Reference Guide for the attributes that are included in the verbose and brief listings for each print object.
If you use the -x string option or the -X file option, the comparable attribute is the following:
requested-attributes= requested_attributes
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 95
PDQ
-s style_name
Use this option to define how the output requested with the -r requested_attributes option is to be formatted.
arguments The values allowed for style_name are the following:
• columnThe output displays a separate column for each requested attribute. This is the default for every value of the -r requested_attributes option except all .
• lineThe output displays a separate line for each requested attribute. This is the default for the all value of the -r requested_attributes option.
If you use the -x string option or the -X file option, the comparable attribute is the following:
style =style_name
-x extended_attribute_string
Use this option to specify a series of attribute=value pairs on the command line that will be processed by the pdq command.
attributes Object attributes cannot be used in the -x option.
The following client attributes can be used:
• attributes
• count-limit
• filter
• headings
• requested-attributes
• style
• time-limit
syntax Follow the syntax rules for attribute value strings listed in the Overview chapter of the PrintXchange Command Line Interface Reference Guide.
Note: You can produce the same result by including the extended_attribute_string in an attribute file and identifying that file as the attribute_filename in the -X option.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 96
PDQ
-X attribute_filename
The -X option identifies an attribute file to be read by the command. When the pdq command executes, the attribute data included in the file is processed at the current point in the command line as though it had been specified with the -x option.
Note: Refer to the Overview chapter of the PrintXchange Command Line Interface Reference Guide for information on developing an attribute file.
attributes Object attributes cannot be used in the -X option. Refer to the -x section for a list of the client attributes that may be used.
Operands
The following object_instance in the operand is supported for pdq:
[spooler_name:]job_id[.doc_int]... [spooler_name:]
Optional. Identifies the specific server on which the job(s)to be listed resides.
Note: If [spooler_name:] is not specified, the pdq command is performed on the default spooler.
job_id
Required. The value for job_id is the unique identifier thatpoints to a specific job that is to be listed.
[.doc_int]
Optional. A number that identifies the position of thespecific document in the job to be listed.
• If included, the requested document attributes for only that document are listed, along with any requested job attributes.
• If not included, the requested document attributes and job attributes are listed for all documents in the job.
Note: If more than one object instance is included in the command line, the first object instance indicates the scope (job attributes and/or document attributes) of the query.
no [object_instance] included When no [object_instance] is specified, pdq lists all the print jobs for the logical printer specified by the -p printer_name option. If the -p printer_name option and the object_instance are omitted, pdq lists the print jobs for the default queue. The jobs are listed in the order that they are currently scheduled to print.
Note: To list all your jobs on a specific spooler, use the pdls command.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 97
PDQ
Examples
1. List the jobs you submitted to the queue associated with the default logical printer.
pdq
2. List all of your jobs in the queue fed by the logical printer named gary .
pdq -p gary
3. List the jobs you submitted to the queue associated with the default logical printer and show the value of their printer-name-requested attribute.
pdq -r "job-identifier job-name printer-name-requested"
4. List job and document information about jobs 123 and 124 on the default spooler.
pdq 123.1 124
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 98
14. pdresubmit
Name
pdresubmit - resubmit a print job.
Synopsis
pdresubmit [-c class_name] [-x extended_attribute_string ... ][-X attribute_filename ... ]target_printer_name[spooler_name:]job_id ...
or
pdresubmit [-c class_name] [-x extended_attribute_string ... ][-X attribute_filename ... ]target_printer_name queue_name ...
Use this command to display help about pdresubmit.
pdresubmit -h
Description
Use pdresubmit to request that one or more jobs already submitted for printing (and currently in a pending, held, paused, or retained state) be resubmitted to another printer on the same spooler. The command fails if the job (or jobs) to be resubmitted is in a printing, processing, preprocessing, or completed state.
Note: When all jobs in a queue are resubmitted to another logical printer, a revalidation takes place. If a job fails this process, a warning is returned. The requirements of the failed job can be adjusted to meet the printer's capabilities or the job can be resubmitted to a printer that provides the correct features. The jobs returning a warning remain in the original queue.
access level End user. End users can only resubmit jobs that they own.
Operator. Operators can perform a resubmit on any job or on all jobs in a queue. The queue must be disabled (enabled=no ) for the command to succeed. The server may take up to 20 minutes to send a response to a pdresubmit queue command. (For all other PrintXchange commands, the server returns a response within two minutes.)
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 99
PDRESUBMIT
Options
The following options are supported for pdresubmit.
-c class_name
This option specifies the class, or type, of the operand.
arguments The values allowed for class_name are the following:
• queue
• job (The default value.)
Note: The OPERANDS section describes the specific object_instance that is associated with each class.
If you use the -x string option or the -X file option, the comparable attribute type and value is the following:
class= class_name
-x extended_attribute_string
Use this option to specify a series of attribute=value pairs on the command line that will be processed by the pdresubmit command.
attributes Object attributes cannot be used in the -x option.
You can specify the following client attributes:
• attributes
• class
syntax Follow the syntax rules for attribute value strings, listed in the Overview chapter of the PrintXchange Command Line Interface Reference Guide.
Note: You can produce the same result by including the extended_attribute_string in an attribute file and identifying that file as the attribute_filename in the -X option.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 100
PDRESUBMIT
-X attribute_filename
The -X option identifies an attribute file to be read by the command. When the pdresubmit command executes, the attribute data included in the file is processed at the current point in the command line as though it had been specified with the -x option.
attributes Object attributes cannot be used in the -X option. Refer to the -x section for a list of the client attributes that may be used.
Note: Refer to the Overview chapter of the PrintXchange Command Line Interface Reference Guide for information on developing an attribute file.
Operands
Two operands must be specified with the pdresubmit command,
• target_printer_name
• object_instance
target_printer_name The value identifies the logical printer to which the job(s) specified in the object_instance of the operand are to be resubmitted.
object_instance The value of the object instance of the operand is based on the value of the -c class_name option or the class =class_name attribute.
[spooler_name]job_id ... The system default. When class equals job , the value of job_id is the unique identifier that points to the specific job to be resubmitted. If [spooler_name:] is omitted, the default spooler is assumed.
Note: Jobs from multiple queues on the same spooler can be simultaneously resubmitted to the logical printer by listing multiple queue_names.
Note: Multiple jobs on the same spooler can be simultaneously resubmitted by listing multiple job_ids.
queue_name ... When class equals queue , the value of queue_name is the name of the specific queue that contains the jobs to be resubmitted. The command removes all jobs that are in a pending or held state on the specified queue and submits them to the specified logical printer.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 101
PDRESUBMIT
Examples
1. Resubmit jobs 2000 and 2001 on the default spooler to the logical printer named ginger .
pdresubmit ginger 2000 2001
2. Resubmit all jobs currently pending or on hold in the queue called jose_q to the logical printer named luke .
pdresubmit -c queue luke jose_q
3. Resubmit all jobs from the jose_q and mary_q queues to the logical printer named luke .
pdresubmit -c queue luke jose_q mary_q
Note: Ensure that all jobs, queues, and destination logical printers reside on the same spooler or the command will fail.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 102
15. pdresume
Name
pdresume - resume an object that has been paused using the pdpause command.
Synopsis
pdresume [-c class_name] [-m message_text][-x extended_attribute_string ... ] [-X attribute_filename ... ] object_instance ...
Use this command to display help about pdresume.
pdresume -h
Description
Use the pdresume command to resume paused print jobs, physical printers, queues, and spoolers. This command causes the specified print object to continue normal operations.
Consider the following when using this command:
• If you specify an invalid object, such as a logical printer or a supervisor, an error results. Specifying an object that is already resumed also results in an error.
• A resumed job is available for scheduling and printing.
• The state of a resumed queue is changed from paused to ready. The queue resumes distributing print jobs to all associated physical printers.
• The state of a resumed spooler is changed from paused to ready. The spooler begins distributing jobs for printing.
• The state of a resumed physical printer is changed from paused to ready. The physical printer resumes printing its currently assigned print job, if any, from the point where it was paused.
access level End user. End users can use pdresume to resume their own jobs.
Operator. Operators can use pdresume on jobs, physical printers, queues, and spooler objects.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 103
PDRESUME
Options
The following options are supported for pdresume.
-c class_name
This option specifies the class, or type, of object to be resumed.
arguments The values allowed for class_name are the following:
• printer (Physical printer only.) The default value.
• job
• queue
• server (Spooler only.)
Note: The Operands section describes the specific object_instance that is associated with each class.
If you use the -x string option or the -X file option, the comparable attribute type and value is the following:
class =class_name
-m message_text
Use this option to include a message about the object that you are resuming. For example, when a physical printer is to be resumed, the message attached to the printer might be:
-m "Resuming Printer1"
If you use the -x extended-attribute-string option or the -X attribute_filename option in the pdresume command, the comparable client attribute type and value is the following:
For physical printers, queues, and spoolers:
message =message_text
For jobs:
job-message-from-administrator =message_text
The option will look like this:
-x "message='Resuming Printer1' "
To retrieve a message of this type, use the pdls command, specify the job or document, and include the following option:
-r message
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 104
PDRESUME
-x extended_attribute_string
Use this option to specify a series of attribute=value pairs on the command line that will be processed by the pdresume command.
attributes Object attributes cannot be used in the -x option.
You can specify the following client attributes:
• attributes
• class
• message
syntax Follow the syntax rules for attribute value strings, listed in the Overview chapter of the PrintXchange Command Line Interface Reference Guide.
Note: You can produce the same result by including the extended_attribute_string in an attribute file and identifying that file as the attribute_filename in the -X option.
-X attribute_filename
The -X option identifies an attribute file to be read by the command. When the pdresume command executes, the attribute data included in the file is processed at the current point in the command line as though it had been specified with the -x option.
attributes Object attributes cannot be used in the -X option. Refer to the -x section for a list of the client attributes that may be used.
Note: Refer to the Overview chapter of the PrintXchange Command Line Interface Reference Guide for information on developing an attribute file.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 105
PDRESUME
Operands
The value of the object_instance in the operand is based on the value of the -c class_name option or the class =class_name attribute.
Note: Multiple objects of the same class can be paused simultaneously by specifying multiple object instances.
printer_name ... The system default. When class is printer , the value of printer_name is the name of the specific physical printer to be resumed.
Note: Although you cannot pause a logical printer, you can use the pddisable command to prevent a job from being submitted through a logical printer.
[spooler_name:]job_id ... When class equals job , the value of job_id is the unique identifier that points to the specific job to be resumed.
Note: If [spooler_name:] is not specified, the default spooler is assumed.
queue_name ... When class equals queue , the value of queue_name is the name of the specific queue to be resumed.
spooler_name ... When class is server , the value of spooler_name is the name of the specific spooler server to be resumed.
Examples
1. Resume printing jobs at the physical printer named samantha and set a message that can be displayed using the pdls command.
pdresume -m "Back online" samantha
2. Resume the queue named daniel to begin submitting jobs to physical printers.
pdresume -c queue daniel
3. Resume the spooler named ginger to begin distributing jobs to physical printers.
pdresume -c server ginger
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 106
16. pdrm
Name
pdrm - remove (cancel) a print job.
Synopsis
pdrm [-m message_text] [-r retention_period][-x extended_attribute_string ... ] [-X attribute_filename ... ][spooler_name:]job_id ...
Use this command to display help about pdrm.
pdrm -h
Description
Use the pdrm command to cancel or delete a job that was submitted for printing. The following items should be considered when using this command:
• Use pdrm when you need to stop a job that is printing or queued. If the job has reached the supervisor, the spooler forwards the remove command to the supervisor and the job is canceled as soon as possible.
• The job is placed in a retained state if the -r retention_period option is included in the command line or if the job-retention-period attribute has a non-zero value. Otherwise, the job is placed in a completed state with job-state-reasons set to canceled-by-user or canceled-by-operator and the document data is deleted.
access level End user. End users can remove only their own jobs.
Operator. Operators can remove any jobs.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 107
PDRM
Options
The following options are supported for pdrm.
-m message_text
Use this option to include a message about the job that you are canceling.
If you use the -x extended_attribute_string option or the -X attribute_filename option in the pdpr command, the comparable client attribute type and value is the following:
job-message-from-administrator =message_text
To request this message about the job using the pdls command, identify the job or document, and include the following option:
-r job-message-from-administrator
-r retention_period
Use this option to define the length of time the spooler server should keep the removed job in the retained state before finally deleting the job.
arguments The values allowed for retention_period are the following:
• 0 (zero) The job is deleted immediately.
• non-zero The job is placed in the retained state for the amount of time specified. Enter time values in the format [HH:]mm[:SS]. For example, use this value to retain a job for one hour:
-r 1:00
To use in the -x string option or the -X file option, the comparable attribute is the following:
job-retention-period =retention_period
-x extended_attribute_string
Use this option to specify a series of attribute=value pairs on the command line that will be processed by the pdrm command.
attributes Object attributes cannot be used in the -x option. The following client attributes can be used:
• attributes
• message
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 108
PDRM
syntax Follow the syntax rules for attribute value strings listed in the Overview chapter of the PrintXchange Command Line Interface Reference Guide.
Note: You can produce the same result by including the extended_attribute_string in an attribute file and identifying that file as the attribute_filename in the -X option.
-X attribute_filename
The -X option identifies an attribute file to be read by the command. When the pdrm command executes, the attribute data included in the file is processed at the current point in the command line as though it had been specified with the -x option.
attributes Object attributes cannot be used in the -X option. Refer to the -x section for a list of the client attributes that may be used.
Note: Refer to the Overview chapter of the PrintXchange Command Line Interface Reference Guide for information on developing an attribute file.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 109
PDRM
Operands
The following object_instance in the operand is supported for pdrm:
[spooler_name:]job_id... [spooler_name:]
Optional. Identifies the specific spooler on which the job to be removed resides. The command is only valid on a spooler; it fails if the server named in the [spooler_name:] component of the object_instance is a supervisor.
Note: If [spooler_name:] is not specified, the pdrm command is performed on the default spooler.
job_id
Required. The value of job_id is the unique identifier that points to the specific job to be removed.
Multiple jobs on multiple spoolers may be cancelled by specifying multiple object_instances.
Examples
1. Cancel and delete job 2000 from the default spooler server.
pdrm 2000
2. Cancel job 2001 and retain the document data for one hour before deleting it from the spooler server named ginger .
pdrm -r 1:00 ginger:2001
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 110
17. pdset
Name
pdset - set the attributes of a print object.
Synopsis
pdset [-c class_name] [-g] [-m message_text][-r requested_attributes] [-s style_name][-x extended_attribute_string ... ] [-X attribute_filename ... ]object_instance ...
Use this command to display help about pdset.
pdset -h
Description
Use the pdset command to set the object, job, and document attribute values of specified print objects. The following items should be considered when using this command:
• Changes in the attribute values of an object remain in place even after the system is restarted.
• The specified attributes will be set for every object that is included on the command line.
• This command can be used to change job submission attributes for retained jobs.
access level Administrator. The administrator can set the attribute values of any object in the system.
Operator. The operator can set xxx-ready attributes for physical printers only.
End user. An end user can set attributes for their own jobs only.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 111
PDSET
Options
The following options are supported for pdset.
-c class_name
Specifies the class, or type, of object for which you are setting attribute values.
arguments The values allowed for class_name are the following:
• document
• job
• printer (This is the default.)
• queue
• server
• initial-value-document
• initial-value-job
Note: The Operands section describes the specific object_instance that is associated with each class.
If you use the -x string option or the -X file option, the comparable attribute type and value is the following:
class =class_name
-g
When this option is used, any output is displayed without column headings.
To use in the -x string option or the -X file option, the equivalent attribute is the following:
headings =no
-m message_text
Use this option to include a message about the print object that you are modifying. For example, when an attribute of a printer is to be set the message attached to the printer might be:
-m "printer1 supporting bound jobs"
If you use the -x extended-attributes-string option or the -X attribute_filename option, the equivalent client attribute type and value is the following:
For server, printer, queue, initial-value-job, initial-value-document, and document objects:
message =message_text
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 112
PDSET
For jobs:
job-message-from-administrator =message_text
The option will look like this:
-x "message='printer1 supporting bound jobs.' "
To retrieve a message of this type, use the pdls command, specify the print object, and include the following option:
-r message
-r requested_attributes
Use this option to specify the attributes that you want pdset to write to standard output to generate an attribute report.
arguments The values allowed for requested_attributes are the following:
• verboseThis value specifies that an expanded set of attributes is written to output.
• briefThis value specifies that a subset of the verbose list of attributes is written to output.
• allThis value specifies that all attributes with values are written to output.
• none This value specifies that no attributes are written to output. This is the default.
Note: Refer to Appendix E of the PrintXchange Command Line Interface Reference Guide for the attributes that are included in the verbose and brief listings.
If you use the -x string option or the -X file option, the comparable attribute is the following:
requested-attributes =requested_attributes
-s style_name
Use this option to define how the output requested with the -r requested_attributes option is to be formatted.
arguments The values allowed for style_name are the following:
• columnThe output displays a separate column for each requested attribute. This is the default for every value of the -r requested_attributes option except all .
• lineThe output displays a separate line for each requested attribute. This is the default for the all value of the -r requested_attributes option.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 113
PDSET
If you use the -x string option or the -X file option, the comparable attribute is the following:
style =style_name
-x extended_attribute_string
Use this option to specify a series of attribute=value pairs on the command line that will be processed by the pdset command.
attributes All settable attributes may be used with the -x option, except for the following:
• Job attributes (attribute names are shown in bold text; attribute categories are shown in regular text).
— job-identifier
— job-originator
— job-owner
— initial-value-job
— printer-name-requested
— job security attributes
— job status attributes
— job access attributes
— accounting attributes
• Document attributes
— initial-value-document
— transfer-method
— document status attributes
• Object identifier and state attributes
— current-job-state
— document-name
— document-state
— initial-value-document-identifier
— initial-value-job-identifier
— printer-name
— printer-state
— queue-name
— queue-state
— server-name
— server-state
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 114
PDSET
Note: Refer to Appendix A of the PrintXchange Command Line Interface Reference Guide for a complete listing of all supported object attributes.
Client attributes that may be used are the following:
• attributes
• class
• message
• headings
• style
• requested-attributes
syntax Follow the syntax rules for attribute value strings listed in the Overview chapter of the PrintXchange Command Line Interface Reference Guide.
Note: You can produce the same result by including the extended_attribute_string in an attribute file and identifying that file as the attribute_filename in the -X option.
Modification operators
You can include an operator with attribute=value pairs to indicate the type of modification to be done to the specified attribute. The three modification operators are:
• + (add value)
When you use attribute+=value, you add a value to the attribute. This can only be used with multi-valued attributes. If you add a value that already exists, the attribute contains the same value twice.
• - (remove value)
When you use attribute-=value, you remove a value from the attribute. If the value is not present, pdset ignores the command. If you remove the last value for an attribute, pdset sets the value to the server default. If a value to be removed occurs more than once, pdset removes all occurrences.
• = (reset to default value)
When you use attribute==, you set the attribute value to its default. Do not include a value when resetting to the default value.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 115
PDSET
-X attribute_filename
The -X option identifies an attribute file to be read by the command. When the pdset command executes, the attribute data included in the file is processed at the current point in the command line as though it had been specified with the -x option.
attributes All settable attributes may be used with the -X option. Refer to the -x section for a list of the client attributes that may be used.
Note: Refer to the Overview chapter of the PrintXchange Command Line Interface Reference Guide for information on developing an attribute file.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 116
PDSET
Operands
The value of the object_instance in the operand is based on the value of the -c class_name option or the class =class_name attribute.
[spooler_name:]job_id ... When class equals job , the required value of job_id is the unique identifier that points to the specific job whose attributes are to be set.
[spooler_name:]job_id.doc_int ... When class equals document , the value for job_id.doc_int is the position of the document in the job. For example, big-spooler:116.3 , is the third document in the job with an id of 116 on the spooler called big-spooler .
printer_name ... When class equals printer , the value of printer_name is the name of the specific physical or logical printer whose attributes are to be set. To set any of the following printer attributes, the new value must refer to an object that already exists:
• associated-queue
• printer-initial-value-job
• printer-initial-value-document
server_name ... When class equals server the value of server_name: is the name of the specific spooler or supervisor whose attributes are to be set.
queue_name ... When class equals queue , the value of queue_name is the name of the specific queue whose attributes are to be set.
[spooler_name:]ivjob_name ... When class equals initial-value-job , the value of ivjob_name is the name of the specific initial-value-job whose attributes are to be set.
[spooler_name:]ivdoc_name ... When class equals initial-value-document , the value of ivdoc_name is the name of the specific initial-value-document whose attributes are to be set.
Note: For job_id, job_id.doc.int, ivjob_name, and ivdoc_name, if [spooler_name:] is not specified, the pdset command is performed on the default spooler.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 117
PDSET
Examples
1. Set the media-supported attribute for the printer named samantha. The object instance of the operand is a printer since this is the default value for the -c option.
pdset -x "media-supported=a" samantha
2. Set the message for the queue called daniel .
pdset -c queue -m "this queue connects dave to les" daniel
3. Release a job with an id of 21 that was placed in a held state when it was submitted for printing.
pdset -c job -x "job-hold=no" sp1:21
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 118
18. pdshutdown
Name
pdshutdown - shut down a server.
Synopsis
pdshutdown [-c class_name] [-m message_text] [-w when_time][-x extended_attribute_string ... ] [-X attribute_filename ... ]server_name ...
Use this command to display help about pdshutdown.
pdshutdown -h
Description
Use the pdshutdown command to shut down a specified spooler or supervisor server.
• If the server is a spooler , this command causes the spooler to temporarily disable itself so that no new jobs can be accepted. The value of the when_time argument determines exactly when and how the spooler shuts down. When the spooler is restarted, it has the same objects and attributes that it had before shutdown.
• If the server is a supervisor , this command causes the spooler to temporarily disable itself and reject new jobs. The value of the when_time argument determines exactly when and how the supervisor shuts down.
access level Operator
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 119
PDSHUTDOWN
Options
The following options are supported for pdshutdown.
-c class_name
This option specifies the class, or type, of object to be shut down. If you use the -x string option or the -X file option, the comparable attribute type and value is the following:
class =class_name
arguments server (The pdshutdown command is only supported for the server class.)
Note: The Operands section describes the specific object_instance associated with the class.
-m message_text
Use this option to include a message about the server that you are shutting down. For example, when a spooler is to be shut down, the message attached to it might be:
-m "Big-spool is shut down"
If you use the -x extended-attribute-string option or the -X attribute_filename option in the pdshutdown command, the comparable client attribute type and value is the following:
message =message_text
The option will look like this:
-x "message='Big-spool is shut down' "
To retrieve a message of this type, use the pdls command, specify the server, and include the following option:
-r message
-w when_time
Use this option to specify how much processing can occur before the server can be shut down.
arguments The values allowed for when_time are:
• now
— If the server is a spooler, it is shut down immediately. Jobs already submitted to supervisors complete printing. The states of the jobs are not updated until the spooler is restarted.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 120
PDSHUTDOWN
— If the server is a supervisor, it is shut down as soon as all jobs on all associated physical printers are deleted. These jobs are restarted when the physical printers are operational again.
• after-current (This is the default.)
— Waits for all processing and printing jobs to complete.
— If the server is a spooler, it stops accepting new jobs, stops submitting new jobs to supervisors, and shuts down after jobs that are currently printing have completed.
— If the server is a supervisor, it stops accepting new jobs and shuts down after all currently printing jobs are completed.
• after-all
— Waits for all pending, processing, and printing jobs to complete.
— If the server is a spooler, it stops accepting new jobs but continues submitting jobs to supervisors. The spooler shuts down after all pending jobs are accepted by supervisors and all have completed printing.
— If the server is a supervisor, it stops accepting new jobs and shuts down after all currently printing jobs are completed. Note that this is the same as after-current .
If you use the -x string option or the -X file option, the comparable attribute type and value is the following:
when =when_time
-x extended_attribute_string
Use this option to specify a series of attribute=value pairs on the command line that will be processed by the pdshutdown command.
attributes Object attributes cannot be used in the -x option.
The following client attributes can be used:
• attributes
• class
• message
• when
syntax Follow the syntax rules for attribute value strings listed in the Overview chapter of the PrintXchange Command Line Interface Reference Guide.
Note: You can produce the same result by including the extended_attribute_string in an attribute file and identifying that file as the attribute_filename in the -X option.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 121
PDSHUTDOWN
-X attribute_filename
The -X option identifies an attribute file to be read by the command. When the pdshutdown command executes, the attribute data included in the file is processed at the current point in the command line as though it had been specified with the -x option.
attributes Object attributes cannot be used in the -X option. Refer to the -x section for a list of the client attributes that may be used.
Note: Refer to the Overview chapter of the PrintXchange Command Line Interface Reference Guide for information on developing an attribute file.
Operands
server_name ... The value of server_name is the name of the specific spooler or supervisor to be shut down.
Examples
1. Shut down the server named ginger .
pdshutdown -c server ginger
2. Shut down the server named ginger . This produces the same effect as example 1 since server is the default class.
pdshutdown ginger
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 122
A. Attributes
Introduction
This appendix lists and describes all attributes supported by PrintXchange. To assist the reader in understanding how to use various attributes, the appendix includes:
• Lists of attributes grouped by object class. Within each object class, settable attributes are indicated with an asterisk (*).
• A detailed attribute directory, organized alphabetically. Each attribute entry includes the following components:
— Brief description of the attribute
— Objects with which the attribute is associated
— Whether the attribute can contain one value (single value) or multiple values (multi-value)
— Whether the attribute is settable
— Commands with which the attribute may be used
— Valid values for the attribute
— Default value, if any, for the attribute
— Comments, including practical examples for using the attribute
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 123
ATTRIBUTES
Attributes grouped by object class
Server attributes
Settable attributes are indicated with an asterisk (*).
Spooler and supervisor
access-control-list *
add-document-operations
availability
cancel-individual-document-supported
cancel-job-operations
close-job-operations
conformance-levels-supported
create-job-operations
create-operations
delete-operations
descriptor *
disable-operations
domain-name* (Windows NT only)
enable-operations
enabled * (settable via pdenable/pddisable)
events-supported
file-reference-is-local-only
job-attributes-visible-to-all *
list-of-managers *
loa-abort-operations
loa-cont-operations
loa-operations
locale
locales-supported
max-number-of-system-logs *
message *
modify-individual-document-supported
multiple-documents-supported
notification-delivery-methods-ready
notification-delivery-methods-supported
notification-profile *
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 124
ATTRIBUTES
object-class
object-classes-supported
pause-operations
physical-printers-ready
physical-printers-supported
preprocessor-definition *
preprocessor-list *
proxy-submit-supported * (Windows NT only)
resume-operations
send-event-operations
server-hostname *
server-name * (settable only at server creation)
server-operating-system
server-state
server-type
server-version
set-operations
shutdown-operations
system-log-file-path *
system-log-severity *
system-log-size *
system-logging-enabled *
transfer-methods-supported
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 125
ATTRIBUTES
Spooler only
clean-operations
days-to-keep-acct-logs *
default-accounting-profile *
default-document-format *
default-job-completion-period *
driver-server * (Windows NT only)
goj-cont-operations
goj-operations
hold-jobs-interrupted-by-printer-failure *
logical-printers-ready
logical-printers-supported
modify-job-operations
pause-job-operations
promote-job-operations
queues-supported
resubmit-job-operations
resume-job-operations
Supervisor only
maximum-number-of-printers-supported
number-of-printers-supported *
printer-connection-methods-supported
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 126
ATTRIBUTES
Printer attributes
Settable attributes are indicated with an asterisk (*).
Logical and physical printer (applicable to Xerox and Reference supervisors)
access-control-list *
associated-queue *
associated-server
availability
binding-edge-image-shift-max-supported *
binding-edges-supported *
character-sets-supported *
content-orientations-supported *
descriptor *
document-formats-supported *
document-sheets-supported *
domain-name* (Windows NT only)
enabled * (settable via pdenable/pddisable)
excluded-preprocessors *
fax-resolutions-supported *
finishings-supported *
fonts-supported *
highlight-colour-rendering-algorithms-supported *
highlight-colours-supported *
highlight-mapping-colours-supported *
ignore-preprocessing-failure *
input-trays-supported *
job-finishings-supported *
job-offsets-supported *
job-result-set-delivery-methods-supported *
job-sheets-supported *
list-of-managers *
maximum-copies-supported *
media-supported *
message *
no-preprocessing *
notification-profile *
numbers-up-supported *
object-class
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 127
ATTRIBUTES
output-bins-supported *
outputs-supported *
plexes-supported *
preprocessor-list *
print-colour-types-supported *
printer-associated-printers
printer-error-sheets-supported *
printer-locations *
printer-name * (settable only at printer creation)
printer-problem-message*
printer-realization
printer-state
printers-ready
sides-supported *
thickening-supported *
x-image-shift-range-supported *
y-image-shift-range-supported *
Logical printer only
default-document-format *
default-user-job-priority *
jobs-pending
max-user-job-priority *
preferred-printer-drivers * (Windows NT only)
printer-initial-value-document *
printer-initial-value-job *
Physical printer only (applicable to Xerox and Reference supervisor)
accounting-enabled *
accounting-profile *
asynch-events-supported * (settable only at printer creation)
character-sets-ready *
document-formats-ready *
document-sheets-ready
fax-resolutions-ready *
finishings-ready *
fonts-ready *
highlight-colours-ready *
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 128
ATTRIBUTES
hold-jobs-interrupted-by-printer-failure *
input-trays-medium *
input-trays-ready *
job-finishings-ready *
job-offsets-ready *
job-result-set-delivery-methods-ready *
job-sheets-ready *
maximum-printer-speed *
media-ready *
native-document-formats-ready *
output-bin-sorter-available-count *
output-bins-ready *
outputs-ready *
print-colour-types-ready *
printer-connect-timeout-period *
printer-address *
printer-connection-method *
printer-drum-level *
printer-drum-threshold *
printer-error-sheets-ready *
printer-ink-or-toner-level *
printer-ink-or-toner-threshold *
printer-model * (settable only at printer creation)
printer-paper-level *
printer-paper-threshold *
printer-resource-warning-raised
printer-tcpip-port-number *
sides-ready *
sys-up-date-and-time
Physical printer only (applicable to Xerox supervisor)
device-query-channel-ready *
device-query-channels-supported * (settable only at printer creation)
device-query-interval *
device-query-library-name * (settable only at printer creation)
device-status-query-supported *
docuprint-job-pool-version *
job-cancel-channel-ready *
job-cancel-channels-supported * (settable only at printer creation)
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 129
ATTRIBUTES
job-cancellation-supported *
job-cancel-library-name * (settable only at printer creation)
job-query-channel-ready *
job-query-channels-supported * (settable only at printer creation)
job-query-interval *
job-query-library-name * (settable only at printer creation)
job-status-query-supported *
job-submission-channel-ready *
job-submission-channels-supported * (settable only at printer creation)
job-submission-library-name * (settable only at printer creation)
max-concurrent-job-processing *
mib-library-name * (settable only at printer creation)
mib-type * (settable only at printer creation)
number-job-on-device *
snmp-req-community-string *
wait-for-all-document-preprocessing-to-complete *
Physical printer only (applicable to Reference supervisor)
printer-baud-rate *
printer-connection-level *
printer-data-bits *
printer-input-flow-control *
printer-output-flow-control *
printer-parity *
printer-stop-bits *
printer-timeout-period *
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 130
ATTRIBUTES
Queue attributes
Settable attributes are indicated with an asterisk (*).
access-control-list *
associated-server
availability
descriptor *
disable-backlogged-queue *
domain-name* (Windows NT only)
enabled * (settable via pdenable/pddisable)
jobs-pending
list-of-managers *
logical-printers-ready
logical-printers-supported
message *
notification-profile *
object-class
physical-printers-ready
physical-printers-supported
queue-backlog-lower-limit *
queue-backlog-upper-limit *
queue-name * (settable only at queue creation)
queue-problem-message
state
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 131
ATTRIBUTES
Job attributes
Settable attributes are indicated with an asterisk (*).
accounting-information *
assigned-queue
completion-time
current-job-state
document-sheets *
domain-name * (Windows NT only)
impressions-completed
initial-value-job * (settable only at job submission)
intervening-jobs
job-collate-preserved *
job-comment *
job-completion-period *
job-copies *
job-copies-completed
job-discard-time *
job-fault-count
job-finishing *
job-hold *
job-identifier
job-identifier-for-monitor
job-identifier-on-client * (settable only at job submission)
job-identifiers-on-device
job-message-from-administrator *
job-message-to-operator *
job-name *
job-offset *
job-originating-host
job-originator * (settable only at job submission)
job-owner * (settable only at job submission)
job-page-count * (settable only at job submission)
job-print-after *
job-priority *
job-promote-time
job-retention-period *
job-sheets *
job-state-message
job-state-reasons
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 132
ATTRIBUTES
job-submission-channel-used
job-submission-complete
job-submission-timeout * (settable only at job submission)
job-to-be-billed *
media-consumed
media-sheets-completed
notification-profile *
number-of-documents
object-class
output-bin *
pages-completed
physical-printers-requested *
previous-job-state
printer-error-sheet *
printer-name-requested * (settable only at job submission)
printers-assigned
results-delivery-address *
results-delivery-method *
results-profile * (settable via job-copies and output-bin attributes)
results-set-comment *
started-printing-time
submission-time
total-job-octets
user-name
wait-for-all-document-preprocessing-to-complete *
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 133
ATTRIBUTES
Document attributes
Settable attributes are indicated with an asterisk (*).
binding-edge *
binding-edge-image-shift *
bottom-margin *
content-orientation *
copies-completed
copy-count *
default-character-set *
default-font *
default-input-tray *
default-medium *
document-file-name * (settable only at job submission.)
document-format *
document-name *
document-sequence-number
document-state
document-type *
domain-name * (Windows NT only)
fax-resolution *
finishing *
footer-text *
header-text *
highlight-colour *
highlight-colour-mismatch-action *
highlight-colour-rendering-algorithm *
highlight-mapping-colour *
initial-value-document * (settable only at job submission)
left-margin *
length *
no-preprocessing *
number-pages *
number-up *
object-class
octet-count
original-document-format
output *
page-count *
page-media-select *
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 134
ATTRIBUTES
page-order-received *
page-select *
plex *
print-colour-type-used *
repeated-tab-stops *
reset-printer *
right-margin *
sides *
spooler-preprocessor-list *
supervisor-preprocessor-list *
thickening-specification *
top-margin *
transfer-method * (settable only at job submission)
width *
x-image-shift *
y-image-shift *
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 135
ATTRIBUTES
Initial-value-job attributes
Settable attributes are indicated with an asterisk (*).
access-control-list *
associated-server
descriptor *
document-sheets *
domain-name * (Windows NT only)
initial-value-job-identifier * (settable only at initial-value-job creation)
job-collate-preserved *
job-comment *
job-completion-period *
job-copies *
job-discard-time *
job-finishing *
job-hold *
job-message-to-operator *
job-name *
job-offset *
job-print-after *
job-priority *
job-retention-period *
job-sheets *
job-to-be-billed *
list-of-managers *
message *
object-class
output-bin *
physical-printers-requested *
printer-error-sheet *
results-delivery-address *
results-delivery-method *
results-set-comment *
results-profile *
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 136
ATTRIBUTES
Initial-value-document attributes
Settable attributes are indicated with an asterisk (*).
access-control-list *
associated-server
binding-edge *
binding-edge-image-shift *
bottom-margin *
content-orientation *
copy-count *
default-character-set *
default-font *
default-input-tray *
default-medium *
descriptor *
document-format *
document-name *
document-type *
domain-name * (Windows NT only)
finishing *
footer-text *
header-text *
highlight-colour *
highlight-colour-mismatch-action *
highlight-colour-rendering-algorithm *
highlight-mapping-colour *
initial-value-document-identifier * (settable only at initial-value-document creation)
left-margin *
length *
list-of-managers *
message *
no-preprocessing *
number-pages *
number-up *
object-class
output *
page-media-select *
page-order-received *
page-select *
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 137
ATTRIBUTES
plex *
repeated-tab-stops *
reset-printer *
right-margin *
sides *
spooler-preprocessor-list *
supervisor-preprocessor-list *
thickening-specification *
top-margin *
width *
x-image-shift *
y-image-shift *
Client attributes
Settable attributes are marked with an asterisk (*).
attributes *
class *
copy-from *
count-limit *
document-filename *
domain-name *
filter *
headings *
requested-attributes *
retention-period *
scope *
style *
time-limit *
when *
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 138
ATTRIBUTES
Attribute directory
This directory contains detailed information on every PrintXchange attribute. However, not all attributes in the directory apply to all PrintXchange configurations.
Each attribute entry includes a brief description. In addition, every entry in the directory includes the following fields:
• Objects - Lists all objects with which the attribute is associated.
• M/S - Indicates if the attribute can contain one value (single value) or multiple values (multi-value).
• Settable - Indicates if the user can set or modify the attribute. Some attributes are settable only at object creation.
• Commands - Lists commands used for setting the attribute value with the -x or -X switch. Attributes that are not settable contain N/A in this field.
Note: The pdls command may be used with the -r requested_attributes option to display an attribute’s value.
• Valid values - Lists allowable values for the attribute. For complex attributes, valid values for each element are shown.
• Default value - Lists the default value(s), if any, for the attribute. Generally, default values apply to settable attributes. In most cases, there is no default value.
• Comments - Where appropriate, explanation or clarification of attribute usage.
This directory includes client attributes. These attributes specify parameters for the operation of CLI commands at the client. Client attributes are:
• attributes
• class
• copy-from
• count-limit
• document-filename
• domain-name
• filter
• headings
• requested-attributes
• retention-period
• scope
• style
• time-limit
• when
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 139
ATTRIBUTES
access-control-list
The access-control-list attribute specifies the privilege level of specified authorized PrintXchange users within and across domains.
Objects Initial-value-document
Initial-value-job
Printer (logical and physical)
Queue
Server (spooler and supervisor)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values The access-control-list attribute contains four elements. Values must be entered differently for each element, according to the table below. In addition, curly braces must be used when entering values, as in the following:
{[name][domain=[name-syntax:]name] [name-type] [privilege-level]}
Table A-1. access-control-list elements
Element Valid values
name Text string of up to 255 characters
domain
name-syntax ntsecurity
win95
winnt
nis
dns
file
any
name Text string of up to 4095 characters
name-type all-users
user
group (default if name and name-type not specified)
netgroup
privilege-level end-user (default if privilege-level not specified)
operator
administrator
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 140
ATTRIBUTES
Default value For server object:
access-control-list={name-type=all-users privilege-level=end-user}{name=Administrators name-type=groupprivilege-level=administrator}
For other objects:
No values (access-control-list attribute is empty)
Comments The name element value must be omitted when name-type=all-users .
If the domain element, or its name-syntax , is not specified, the servers uses its (the server's) default domain. The domain element is valid only when the name-type element is user or all-users . The domain name may identify a parent domain, a specific sub-domain, or a specific host.
If the name-type element is not specified, the server uses group as the default.
If the privilege-level element is not specified, the server uses end-user as the default.
Table A-2. access-control-list value examples with CLI syntax
access-control-list value Description
General examples
{name-type=all-users}
{domain=' 'name-type=all-users privilege-level=end-user}
{name-type=all-users privilege-level=end-user}
Equivalent values. They provide end-user authorization to all users from the server's default domain.
{name=odyssey name-type=netgroup privilege-level=end-user}
Netgroups can be stored in NIS. If the name-type=netgroup, the domain-type/domain-name is not looked at by the server. To use a netgroup, the /etc/nsswitch.conf is consulted. In the nsswitch.conf file, there is an item called netgroup whose value will state where the netgroup is located (e.g., NIS).
General domain examples
{domain=nis:CP10WS name-type=all-usersprivilege-level=end-user}
Provides end-user authorization to all users from the CP10WS domain, which is an NIS domain.
{domain=CP10WS name-type=all-usersprivilege-level=end-user}
Provides end-user authorization to all users from the CP10WS domain of the server's default domain type (since name-syntax is not specified).
{domain=dns:xerox.com name-type=all-usersprivilege-level=end-user}
Provides end-user authorization to all users from any host in a sub-domain of the DNS domain xerox.com.
(Since DNS is a hierarchical NameSpace, sub-domain matching takes place from right to left.)
{domain=dns:cp10.es.xerox.com name-type=all-usersprivilege-level=end-user}
This value provides end-user authorization to all users from the DNS domain cp10.es.xerox.com.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 141
ATTRIBUTES
{domain=dns:elijah.cp10.es.xerox.com name-type=all-usersprivilege-level=end-user}
Provides end-user authorization to all users in the DNS domain elijah.cp10.es.xerox.com.
This domain happens to specify a single host (elijah).
Null string domain name examples
{domain=nis: name-type=all-usersprivilege-level=end-user}
Provides end-user authorization to all users from all NIS domains. (The null string domain name with the specified name-syntax indicates that all domains of the specified name-syntax have access.)
{domain=any: name-type=all-users privilege-level=end-user} Provides end-user authorization to all users from all domains (i.e., to every possible user). The null string domain name with name-syntax set to any indicates that all domains of all domain types have access.
Local file (file) domain type examples
{name=nesbitt domain=file: name-type=userprivilege-level=end-user}
Provides end-user authorization to the local file(/etc/passwd) account nesbitt when the operation is submitted from any host (since domain name is empty).
Note: This ACL value presents a large security hole in environments where users have local-root passwords to their workstations. In areas where there is a concern, the client host should be specified as the domain name , as in the following examples.
{name=nesbitt domain=file:elijahname-type=user privilege-level=end-user}
Provides end-user authorization to the local file(/etc/passwd) account nesbitt when the operation is submitted from a host named elijah. This case assumes that "elijah" is returned when the hostname(1) command is run on the client machine. In other environments, the return from hostname(1) may be of a different format (e.g. "elijah.cp10.es.xerox.com").
Note: Matching of the domain name takes place against the host domain information, not the user domain information, because the type value is user .
NT Security domain type examples
{domain=ntsecurity: name-type=all-usersprivilege-level=end-user}
Provides end-user authorization to all users authenticated by NT Security.
{domain=ntsecurity:XEROXCSG name-type=all-usersprivilege-level=end-user}
Provides end-user authorization to all users authenticated by the XEROXCSG domain controller.
{domain=ntsecurity:TULIP name-type=all-usersprivilege-level=end-user}
Provides end-user authorization to all users authenticated by the Local User Manager on the PrintXchange server computer named TULIP.
access-control-list value Description
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 142
ATTRIBUTES
{name=nesbitt domain=ntsecurity:XEROXCSGname-type=user privilege-level=end-user}
Provides end-user authorization to user nesbitt authenticated by the XEROXCSG domain controller.
{name=nesbitt domain=ntsecurity:TULIPname-type=user privilege-level=end-user}
Provides end-user authorization to user nesbitt authenticated by the Local User Manager on the PrintXchange computer named TULIP.
WinNT domain type examples (this domain type exists for PrintXchange cross-domain submission)
{domain=winnt: name-type=all-usersprivilege-level=end-user}
Provides end-user authorization to all Windows NT users from any domain that differs from the server's domain.
{domain=winnt:XEROXCSG name-type=all-usersprivilege-level=end-user}
Provides end-user authorization to all Windows NT users logged in to the XEROXCSG NTDomain
{domain=winnt:XEROXCSG\\TULIP name-type=all-usersprivilege-level=end-user}
Provides end-user authorization to all Windows NT users logged in to the XEROXCSG NTDomain from the computer named TULIP.
Note: When using the CLI, \\ may be required to specify \ (depending on the shell used).
{domain=winnt:\\TULIP name-type=all-usersprivilege-level=end-user}
Provides end-user authorization to all Windows NT users from the computer named TULIP.
Note: When using the CLI, \\ may be required to specify \ (depending on the shell used).
{domain=winnt:TULIP name-type=all-usersprivilege-level=end-user}
Provides end-user authorization to all Windows NT users who are authenticated by the Local User Manager of the computer named TULIP.
{name=nesbitt domain=winnt:XEROXCSG name-type=userprivilege-level=end-user}
Provides end-user authorization to Windows NT user nesbitt from the XEROXCSG NTDomain.
{name=nesbitt domain=winnt:XEROXCSG\\TULIPname-type=user privilege-level=end-user}
Provides end-user authorization to Windows NT user nesbitt logged in to the XEROXCSG NTDomain from the computer named TULIP.
Note: When using the CLI, \\ may be required to specify \ (depending on the shell used).
{name=nesbitt domain=winnt:\\TULIP name-type=userprivilege-level=end-user}
Provides end-user authorization to Windows NT user nesbitt from the computer named TULIP.
Note: When using the CLI, \\ may be required to specify \ (depending on the shell used).
{name=nesbitt domain=winnt:TULIPname-type=user privilege-level=end-user}
Provides end-user authorization to Windows NT user nesbitt who is authenticated by the Local User Manager of the computer named TULIP.
Win95 domain type examples
access-control-list value Description
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 143
ATTRIBUTES
accounting-enabled
The accounting-enabled attribute determines if accounting data is collected for jobs printed on this physical printer.
By default, PrintXchange spoolers log accounting data. However, you can disable accounting data logging for a specific physical printer by changing the value of the accounting-enabled attribute.
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values true|yes
false|no
Default value true|yes
{domain=win95: name-type=all-usersprivilege-level=end-user}
Provides end-user authorization to all Windows95 users from any Windows95 host.
In Windows95, it is possible for the user not to be logged in. Setting name-type to all-users and the domain name-syntax to win-95 is one way to authorize a Windows95 user that is not logged in. The other way is to set the name_type to user and the name to PXCGuest .
{domain=win95:TULIP name-type=all-usersprivilege-level=end-user}
This value provides end-user authorization to all Windows95 users from the computer named TULIP.
Note: Windows95 does not provide a way to get the user's domain name. Therefore, the domain name cannot be set in a Win95 domain type ACL. In this case, the computer name is used instead of the domain name.
{name=nesbitt domain=win95:TULIP name-type=userprivilege-level=end-user}
Provides end-user authorization to Windows95 user nesbitt from the computer named TULIP.
Note: Windows95 does not provide a way to get the user's domain name. Therefore, the domain name cannot be set in a Win95 domain type ACL. In this case, the computer name is used instead of the domain name.
access-control-list value Description
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 144
ATTRIBUTES
Comments Refer to the default-accounting-profile attribute description for a list of default job and document attributes collected by the spooler.
You can set the accounting-enabled attribute with the Windows NT GUI and the CLI pdcreate and pdset commands. You cannot change the value of the accounting-enabled attribute with the UNIX CDE GUI.
To disable logging of accounting data for a specific physical printer:
pdset -c printer -x "accounting-enabled=no" physical_printer_name
To enable logging of accounting data for a specific physical printer:
pdset -c printer -x "accounting-enabled=yes" physical_printer_name
accounting-information
The accounting-information attribute specifies information required by the accounting facility, such as the account to be charged for any services rendered.
Objects Job
M/S Single value
Settable Yes
Commands pdmod
pdpr
pdset
Valid values A hex or human readable string of up to 255 characters.
Default value No default value
Comments
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 145
ATTRIBUTES
accounting-profile
The accounting-profile attribute specifies the job and document attributes that the accounting facility collects for jobs printed on this physical printer.
Objects Printer (physical only)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values Any job or document attribute names
Default value See comments
Comments The attribute accounting-profile has no default. However, if accounting-profile is not specified, the accounting facility collects data for the job and document attributes contained in default-accounting-profile on the associated spooler.
add-document-operations
The add-document-operations attribute contains the total number of add document object operations that have taken place since the server was last started.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable No
Commands N/A
Valid values
Default value No default value
Comments Add document operations take place as part of a multi-document job submission (pdpr). For example:
add-document-operations=53
document:53
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 146
ATTRIBUTES
assigned-queue
The queue to which the spooler assigned the job.
Objects Job
M/S Single value
Settable No
Commands N/A
Valid values Text string of up to 255 characters
Default value No default value
Comments
associated-queue
For logical printers, the associated-queue attribute identifies the single queue the logical printer feeds.
For physical printers, this attribute identifies the single queue (and, therefore, the single spooler) from which the physical printer receives jobs.
This attribute is checked when the printer is enabled, but can be set to any value at any time.
Objects Printer (logical and physical)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values Text string of up to 255 characters
Default value No default value
Comment You must first disable the relevant logical or physical printer before setting the corresponding value for associated-queue .
When you modify a logical or physical printer's associated-queue attribute, the printer's printer-associated-printers attribute is updated automatically.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 147
ATTRIBUTES
If you specify the associated-queue attribute via the pdcreate or pdset command, the specified queue must exist or the command fails.
associated-server
Name of the server with which the object is associated. It is set by object on object creation.
Objects Initial-value-document
Initial-value-job
Printer (logical and physical)
Queue
M/S Single value
Settable No
Commands N/A
Valid values Text string of up to 4095 characters
Default value No default value
Comments Spoolers are the valid servers for initial-value-document, initial-value-job, logical printer, and queue objects. Supervisors are the valid servers for physical printer objects.
asynch-events-supported
The asynch-events-supported attribute indicates if the output device can support asynchronous events to update its status.
Objects Printer (physical only)
M/S Single value
Settable Yes (only at printer creation)
Commands pdcreate
Valid values true|yes
false|no
Default value false|no
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 148
ATTRIBUTES
Comments This attribute should be set to true|yes only if the output device you are creating supports SNMP or if the output device supports real-time statusing.
attributes
This client attribute identifies one or more attributes that are to be included in a command.
Using this attribute is the same as specifying attributes with the -x extended_attribute_string option or the -X attribute_filename option.
Objects N/A
M/S Multi-value
Settable Yes
Commands pdclean
pdcreate
pddelete
pddisable
pdenable
pdls
pdmod
pdpause
pdpr
pdpromote
pdq
pdresubmit
pdresume
pdrm
pdset
pdshutdown
Valid values Text string of up to 4095 characters
Default value No default value
Comments Client attributes are mainly used to allow what would normally be an option to be entered as an argument to the -x option.
For example,
-X attribute_filename
is the same as
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 149
ATTRIBUTES
-x attributes= attribute_filename
availability
Indicates the general availability of an object. It is set to none if the object is disabled and normal if the object is enabled.
Objects Printer (logical and physical)
Queue
Server (spooler and supervisor)
M/S Single value
Settable No
Commands N/A
Valid values normal
none (not available)
Default value No default value
Comments
binding-edge
The binding-edge attribute specifies the edge of the sheet on which binding will occur from the perspective of the first sheet imaged.
The attribute determines the edge to which the binding-edge-image-shift attribute is applied.
Destination logical and physical printers must contain the specified document's binding-edge as a value of their binding-edges-supported attribute.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 150
ATTRIBUTES
Valid values bottom-edge
right-edge
top-edge
left-edge
Default value No default value
Comments If the client specifies a document (or range of pages) where the first page is a back side of a sheet, the client must specify the binding-edge from the perspective of that "first" page. That is, on a document to be bound on the left edge, the user would specify right-edge because the back page would be bound on its right edge.
binding-edge-image-shift
The binding-edge-image-shift attribute determines the amount to shift the image away from the binding edge in a direction that is perpendicular to the binding edge (see binding-edge attribute).
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values 0 to plus-infinity
(must be non-negative and may be a non-integer value)
Default value 0.0
Comments
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 151
ATTRIBUTES
binding-edge-image-shift-max-supported
The binding-edge-image-shift-max-supported attribute identifies the maximum binding-edge shift supported by this printer.
Objects Printer (logical and physical)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values Minus-infinity to plus-infinity
(may be a non-integer value)
Default value 0.0
Comments
binding-edges-supported
The binding-edges-supported attribute identifies the binding-edge values supported by this printer.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values bottom-edge
right-edge
top-edge
left-edge
Default value No default value
Comments Refer to the binding-edge attribute description for additional information.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 152
ATTRIBUTES
bottom-margin
The bottom-margin attribute provides you with more control over the placement of text in a document with simple-text format. Specifically, the attribute specifies the distance in lines between the bottom edge of the logical page and the bottom edge of the text area when held in the intended reading orientation.
(Some document formats, such as PostScript, specify the margin as part of the document content; simple-text does not.)
Figure A-1. bottom-margin
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values Minus-infinity to plus-infinity
(may be a non-integer value)
Default value No default value
Comments The value bottom-margin=6 specifies a bottom margin of six lines. The actual distance is dependent on the size of the character set specified for the document.
Because of its use with simple-text format, bottom-margin is typically part of a simple-text translation filter as defined with the attribute preprocessor-definition .
bottom-margin
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 153
ATTRIBUTES
cancel-individual-document-supported
Indicates if the server can cancel printing of an individual document within a job.
Objects Server (spooler and supervisor)
M/S Single value
Settable No
Commands N/A
Valid values false|no
Default value false|no
Comments This attribute is set to false|no when the system initializes, since PrintXchange does not support canceling individual documents within a job.
cancel-job-operations
The cancel-job-operations attribute contains the total number of cancel job object operations that have taken place since the server was last started.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable No
Commands N/A
Valid values
Default value No default value
Comments A cancel job operation takes place when invoking a pdrm command on a job that has a non-zero value for its job-retention-period . The spooler does not delete the job, but retains it for subsequent printing.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 154
ATTRIBUTES
The cancel-job-operations attribute lists the total cancel job operations as well as the number of cancel job operations on each object. For example:
character-sets-ready
The character-sets-ready attribute identifies the character set encodings ready to be used on the printer.
Objects Printer (physical only)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values See default-character-set
Default value No default value
Comments On job submission, the spooler checks the character set specified for a document against the logical printer's character-sets-supported attribute. In addition, the spooler checks for a match with the physical printer's character-sets-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the character set specified for a document after the job was accepted, the spooler again checks the character set specified for a document against the physical printer's character-sets-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
character-sets-supported
The character-sets-supported attribute identifies the character set encodings supported by the printer
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
cancel-job-operations=6
job:6
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 155
ATTRIBUTES
Commands pdcreate
pdset
Valid values See default-character-set
Default value No default value
Comments On job submission, the spooler checks the character set specified for a document against the logical printer's character-sets-supported attribute. In addition, the spooler checks for a match with the physical printer's character-sets-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the character set specified for a document after the job was accepted, the spooler again checks the character set specified for a document against the physical printer's character-sets-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
class
This client attribute identifies the object class of the operand.
Objects N/A
M/S Single value
Settable Yes
Commands pdclean
pdcreate
pddelete
pddisable
pdenable
pdls
pdmod
pdresubmit
pdresume
pdset
pdshutdown
Valid values
Default value Varies by command
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 156
ATTRIBUTES
Comments Client attributes are mainly used to allow what would normally be an option to be entered as an argument to the -x option.
For example,
-c server
is the same as
-x "class=server"
clean-operations
The clean-operations attribute contains the total number of clean object operations that have taken place on the spooler and its associated queues since the spooler was last started.
Objects Server (spooler only)
M/S Multi-value
Settable No
Commands N/A
Valid values
Default value No default value
Comments The clean operation takes place when invoking the pdclean command.
The clean-operations attribute lists the total clean operations as well as the number of clean operations on each object. For example:
close-job-operations
The close-job-operations attribute contains the total number of close job object operations that have taken place since the server was last started.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable No
clean-operations=6
server:4
queue:2
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 157
ATTRIBUTES
Commands N/A
Valid values
Default value No default value
Comments Close job object operations indicate the end of a job submission (pdpr). For example:
completion-time
Time at which the job completed printing.
Objects Job
M/S Single value
Settable No
Commands N/A
Valid values
Default value No default value
Comments If job end sheets are in use via the job-sheets attribute, the value of the completion-time attribute prints on job end sheets.
conformance-levels-supported
Specifies the Document Printing Application (DPA) standard conformance levels supported.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable No
Commands N/A
close-job-operation=45job:45
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 158
ATTRIBUTES
Valid values level-1
level-1M (M=multiple documents supported)
level-2
level-2M (M=multiple documents supported)
Default value No default value
Comments The DPA Standard defines the functionality a server must provide to obtain a particular conformance level. PrintXchange is at level-2M (the highest level).
content-orientation
The content-orientation attribute provides you with more control over the placement of text in a document with simple-text format. Specifically, the attribute enables you to specify the most significant orientation of the document.
(Some document formats, such as PostScript, specify the document orientation as part of the document content; simple-text does not.)
A document's orientation (whether specified via content-orientation or as part of the document content) works together with the value of the number-up attribute to determine the orientation and number of images that will print on the output page.
The following figure shows the content orientation with number-up=0 . The figure shows the four orientations after manually rotating the medium to its natural viewing orientation after the page prints. (The folded corner is always in the upper right corner after the page prints. In the diagram, the folded corners indicate the manual rotation, if any, performed by the user in order to view the page.)
Figure A-2. content-orientation
Objects Document
Initial-value-document
M/S Single value
Settable Yes
portrait reverse-portrait landscape reverse-landscape
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 159
ATTRIBUTES
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values portrait
landscape
reverse-portrait
reverse-landscape
Default value No default value
Comments Destination logical and physical printers must contain the specified document's content-orientation value as a value of their content-orientations-supported attribute.
Because of its use with simple-text format, content-orientation is typically a part of a simple-text translation filter as defined with the attribute preprocessor-definition .
content-orientations-supported
The content-orientations-supported attribute specifies the document content orientations supported by the printer. This attribute’s values must include any content orientation for a document directed to the printer.
If content-orientations-supported for the logical printer does not contain a value match to the document's orientation, the spooler rejects the print request. If content-orientations-supported for the physical printer does not contain a value match to the document's orientation, the spooler leaves the job pending.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values portrait
landscape
reverse-portrait
reverse-landscape
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 160
ATTRIBUTES
Comments Refer to the content-orientation attribute for illustrations of the valid values.
copies-completed
The copies-completed attribute indicates the number of complete copies of this document that have been printed.
Objects Document
M/S Single value
Settable No
Commands N/A
Valid values Integer equal to or greater than 0
Default value No default value
Comments
copy-count
The copy-count attribute specifies the number of copies of the document to be printed.
The product of job-copies and copy-count should not exceed the value of the logical printer’s maximum-copies-supported attribute. If it does, the spooler rejects the job.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values Integer greater than 0
Default value No default value
Comments
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 161
ATTRIBUTES
copy-from
This client attribute identifies the object from which initial attribute values are copied to create a new object.
Objects N/A
M/S Single value
Settable Yes
Commands pdcreate
Valid values
Default value No default value
Comments Use copy-from= copy_object_instance when creating a new object. The pdcreate command makes a copy of the object specified by copy_object_instance. The command uses the attribute values of the copied object as the initial values for the new object.
Both the new object and the copy_object_instance must be of the same object type (class) and they must both reside on the same server.
count-limit
This client attribute specifies the number of objects to be included in groupings for pdls and pdq output.
Objects N/A
M/S Single value
Settable Yes
Commands pdls
pdq
Valid values Integer greater than 0
Default value No default value
Comments Use this attribute to break a long output request into several smaller ones. For example, if there are 100 entries to list and count=limit is set to 10, the server returns 10 items at a time. You don’t have to wait for the server to return all 100 entries. (Note that you do not need to press Enter after each group of 10 is displayed.)
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 162
ATTRIBUTES
create-job-operations
The create-job-operations attribute contains the total number of create job object operations that have taken place since the server was last started.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable No
Commands N/A
Valid values
Default value No default value
Comments Create job object operations take place as part of a job submission (pdpr). For example:
create-operations
The create-job-operations attribute contains the total number of create operations that have taken place since the server was last started.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable No
Commands N/A
Valid values
Default value No default value
create-operations=79job:79
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 163
ATTRIBUTES
Comments Create operations take place as part of a pdcreate command. For example:
current-job-state
Identifies the current state of the job.
Objects Job
M/S Single value
Settable No
Commands N/A
Valid values Table A-3. current-job-state
Default value No default value
Comments If a job's job-print-after attribute is set for a date or time in the future, its current-job-state attribute is set to held . When the specified time has elapsed, current-job-state is set to pending so the job becomes a candidate for being scheduled for printing.
If a job's job-hold attribute is set to true|yes , its current-job-state attribute is set to held .
create-operations=10queue:3printer:7
Values
completed printing
held processing
paused retained
pending terminating
pre-processing unknown
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 164
ATTRIBUTES
days-to-keep-acct-logs
Indicates the number of most recent accounting logs allowed to exist. Any accounting log created beyond this value causes the server to delete the oldest log.
Objects Server (spooler only)
M/S Single value
Settable Yes
Commands pdset
Valid values Integer equal to or greater than 0
Default value 3 (days)
Comments
default-accounting-profile
The default-accounting-profile attribute specifies the job and document attributes that the spooler collects for the accounting log. The spooler uses the value of this attribute as the default if the physical printer attribute accounting-profile is not specified.
Changing the value of default-accounting-profile changes the list of default attributes.
Objects Server (spooler only)
M/S Multi-value
Settable Yes
Commands pdset
Valid values Any job or document attribute names
Default value See comments
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 165
ATTRIBUTES
Comments The following job and document attributes are collected by default in the following predefined ordering of values. An administrator may change the default-accounting-profile value, removing or adding job/document attributes, in which case the ordering of the values will be different.
• job-name
• user-name
• job-copies-completed
• submission-time
• started-printing-time
• completion-time
• number-of-documents
• printer-name-requested
• printers-assigned
• total-job-octets
• job-comment
• job-fault-count
• job-state-reasons
• pages-completed
• impressions-completed
• media-sheets-completed
• accounting-information
• job-to-be-billed
• job-originator
• job-owner
• job-sheets
• media-consumed
• job-finishing
• results-delivery-method (element of results-profile )
• print-colour-type-used
• document-file-name
• copies-completed
• document-format
• document-type
• number-up
• finishing
• plex
• document-sheets
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 166
ATTRIBUTES
default-character-set
The default-character-set attribute identifies a coded character set that the spooler uses as the coded character set default for document pages not otherwise specifying a character set.
If the document data itself specifies a character set, such specification overrides the default-character-set in use by the spooler.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 167
ATTRIBUTES
Valid values Table A-4. default-character-set
Values
Adobe-Standard-Encoding ISO-Latin-Cyrillic PC8-Turkish
ASCII ISO-Latin-Greek PC-page-850-Multilingual
Big5 ISO-Latin-Hebrew PC-page-852-Latin2
DEC-MCS ISO-Latin1 PC-page-862-Latin-Hebrew
EUC-Fixed-Width-Japanese ISO-Latin2 Shift-JIS
EUC-KR ISO-Latin3 UCS4
EUC-Packed-Format-Japanese
ISO-Latin4 Unicode
GB-2312 ISO-Latin5 Unicode-ASCII
Half-Width-Katakana ISO-Latin6 Unicode-IBM-1264
HP-Desktop ISO-reg11-Swedish-for-Names
Unicode-IBM-1265
HP-Legal ISO-reg15-Italian Unicode-IBM-1268
HP-Math8 ISO-reg17-Spanish Unicode-IBM-1276
HP-PiFont ISO-reg21-German Unicode-IBM-1261
HP-PS-Math ISO-reg4-United-Kingdom Unicode-IBM-2039
HP-Roman8 ISO-reg60-Danish-Norwegian
Unicode-Latin1
IBM-Symbols ISO-reg69-French Ventura-International
IBM-Thai ISO-Text-Communication Ventura-Math
ISO-2022-CN iso-ucs-2-level2 Ventura-US
ISO-2022-CN-EXT JIS-Encoding Windows30-Latin1
ISO-2022-JP Microsoft-Publishing Windows31-Latin1
ISO-2022-JP-2 other Windows31-Latin2
ISO-2022-KR PC8-Danish-Norwegian Windows31J
ISO-Latin-Arabic PC8-page-437-US Windows31-Latin5
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 168
ATTRIBUTES
Default value No default value
Comments On job submission, the spooler checks the character set specified for a document against the logical printer's character-sets-supported attribute. In addition, the spooler checks for a match with the physical printer's character-sets-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the character set specified for a document after the job was accepted, the spooler again checks the character set specified for a document against the physical printer's character-sets-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
default-document-format
The default-document-format attribute specifies the value of the document-format attribute that the spooler sets for a document if the PDL guesser cannot guess the document's format.
The spooler sets document-format as specified for the logical printer's default-document-format . If default-document-format is not present for the logical printer, the spooler uses the value for its own default-document-format attribute.
If administrators do not want document-format set, they must set the value for the logical printer's default-document-format to none . This tells the spooler not to set document-format based on the spooler's default-document-format value.
Objects Printer (logical only)
Server (spooler only)
M/S Single value
Settable Yes
Commands pdcreate, pdset (for logical printer objects)
pdset (for server objects)
Valid values none plus values listed in document-format attribute description
Default value No default value
Comments
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 169
ATTRIBUTES
default-font
The default-font attribute identifies the font to be used for document pages not otherwise specifying a font.
If the document data itself specifies a font, such specification overrides the default-font in use by the spooler.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values Text string of up to 255 characters
Default value No default value
Comments On job submission, the spooler checks the font specified for a document against the logical printer's fonts-supported attribute. In addition, the spooler checks for a match with the physical printer's fonts-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the font specified for a document after the job was accepted, the spooler again checks the font specified for a document against the physical printer's fonts-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
default-input-tray
The default-input-tray attribute specifies the input tray that the supervisor sets as the default before the document begins printing.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 170
ATTRIBUTES
Valid values top, middle, bottom, envelope, default, manual, manual-2, manual-3, large-capacity, main, side, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10
Default value No default value
Comments Destination logical and physical printers input-trays-supported attributes must contain a value corresponding to the value of the default-input-tray attribute of a document to be printed. The physical printer's input-trays-ready attribute must also contain a value corresponding to the value of the default-input-tray attribute of the document to be printed.
default-job-completion-period
Specifies the period of time the spooler keeps a job in the completed state (current-job-state=completed ). The spooler uses this value if the attribute job-completion-period has not been set for the job. This attribute is useful if displaying completed jobs is important.
Objects Server (spooler only)
M/S Single value
Settable Yes
Commands pdset
Valid values Values entered in the format [HH:]mm[:SS]
HH = 0 - 99 hours
mm = 0 - 59 minutes
SS = 0 - 59 seconds
Default value No default value; implies job will not be kept in completed state and you will not be able to list information for the job.
Comments
default-medium
The default-medium attribute specifies the medium used for pages that require specification.
If the page-media-select attribute is specified, its value overrides the default-medium value on a page-by-page basis.
Objects Document
Initial-value-document
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 171
ATTRIBUTES
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values Table A-5. default-medium
Values
a iso-b0-white jis-b4-coloured
b iso-b10-white jis-b4-white
c iso-b1-white jis-b5-coloured
d iso-b2-white jis-b5-white
default iso-b3-white jis-b6-white
e iso-b4-coloured jis-b7-white
executive iso-b4-envelope jis-b8-white
folio iso-b4-white jis-b9-white
hagaki-white iso-b5-coloured ledger
invoice iso-b5-envelope monarch-envelope
iso-a0-white iso-b5-white na-10x13-envelope
iso-a10-white iso-b6-white na-10x14-envelope
iso-a1-white iso-b7-white na-10x15-envelope
iso-a2-white iso-b8-white na-6x9-envelope
iso-a3-coloured iso-b9-white na-7x9-envelope
iso-a3-white iso-c3-envelope na-9x11-envelope
iso-a4-coloured iso-c4-envelope na-9x12-envelope
iso-a4-transparent iso-c5-envelope na-legal-coloured
iso-a4-white iso-c6-envelope na-legal-white
iso-a5-coloured iso-designated-long-envelope
na-letter-coloured
iso-a5-white jis-b0-white na-letter-transparent
iso-a6-white jis-b10-white na-letter-white
iso-a7-white jis-b1-white na-number-10-envelope
iso-a8-white jis-b2-white na-number-9-envelope
iso-a9-white jis-b3-white quarto
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 172
ATTRIBUTES
Default value No default value
Comments The values a through e correspond to the following paper sizes:
a=8.5" x 11"b=11" x 17"c=17" x 22"d=22" x 34"e=34" x 44"
Specifying the value called default will cause the job to print from whatever medium is currently loaded in the printer.
On job submission, the spooler checks the medium specified for a document against the logical printer's media-supported attribute. In addition, the spooler checks for a match with the physical printer's media-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the medium specified for a document after the job was accepted, the spooler again checks the medium specified for a document against the physical printer's media-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
default-user-job-priority
The default-user-job-priority attribute specifies the default value for job priority for all print requests submitted to the logical printer. If the job’s job-priority attribute is not specified, this default value is used.
Objects Printer (logical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values 1 - 100
(a higher value indicates a higher priority)
Default value max-user-job-priority /2(see comments)
Comments The default value for this attribute is half the value of the attribute max-user-job-priority if the user does not set default-user-job-priority on printer creation, or if the user removes the value (by using the - = operator with pdset) or resets it to default (by using the = = operator with pdset).
An error occurs if the user attempts to set default-user-job-priority to a value greater than the value set for max-user-job-priority .
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 173
ATTRIBUTES
The following are two examples of setting default-user-job-priority :
pdset -c printer -x default-user-job-priority=<value> <logical-printer>pdset -c printer -x default-user-job-priority=15 color-printer
delete-operations
The delete-operations attribute contains the total number of delete object operations that have taken place since the server was last started.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable No
Commands N/A
Valid values
Default value No default value
Comments Delete operations take place when invoking the pddelete command. A deletion causes the server to remove the object completely from its database.
The delete-operations attribute lists the total delete operations as well as the number of delete operations on each object. For example:
descriptor
The descriptor attribute supplies a textual description of the specified object.
Objects Initial-value-document
Initial-value-job
Printer (logical and physical)
Queue
Server (spooler and supervisor)
delete-operations=6printer:4queue:2
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 174
ATTRIBUTES
M/S Single value
Settable Yes
Commands pdcreate, pdset (for all objects)
Valid values Text string of up to 4095 characters
Default value No default value
Comments
device-query-channel-ready
The device-query-channel-ready attribute identifies the device query channel that is ready to be used in the Xerox supervisor back end (BE) shared library. The value has to be one of the values of device-query-channels-supported .
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values docusp_xppqxrs_snmp
Default value No default value
Comments This attribute applies only to PrintXchange configurations that include Xerox DocuTech 6135 or 6180 production printers or SNMP-based printers. The value for this attribute is specified in the printer attribute file (paf) for those printers.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 175
ATTRIBUTES
device-query-channels-supported
The device-query-channels-supported attribute lists the device query channels supported by the Xerox supervisor back end (BE) shared library.
Objects Printer (physical only)
M/S Multi-value
Settable Yes (only at printer creation)
Commands pdcreate
Valid values docusp_xppqxrs_snmp
Default value No default value
Comments This attribute applies only to PrintXchange configurations that include Xerox DocuTech 6135 or 6180 production printers or SNMP-based printers. The value for this attribute is specified in the printer attribute file (paf) for those printers.
device-query-interval
The device-query-interval attribute specifies the amount of time between each status query to the print server or output device. This attribute is used by the Xerox supervisor only.
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values Values entered in the format [HH:]mm[:SS]
HH = 0 - 99 hours
mm = 0 - 59 minutes
SS = 0 - 59 seconds
Default value 00:05:00 (300 seconds)
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 176
ATTRIBUTES
Comments Administrators can maximize job flow and improve performance by the values they set for the job-query-interval and device-query-interval attributes. These two attributes determine how frequently PrintXchange queries a device for job or device status.
Each time PrintXchange queries a device, the device slows its job processing cycle to respond to the query. Therefore, frequent queries could noticeably slow job processing at the output device.
The following guidelines may help administrators determine values for job-query-interval and device-query-interval :
• The query interval for a low capacity printer, such as a desktop printer, should be long to avoid affecting the printer performance.
• The query interval may be long for a desktop printer that is within sight of the user, since the user can easily see the state of the device.
• The query interval for a high capacity printer depends on the importance of the real time status to the administrator. If real time status is important, a shorter interval is warranted for more frequent queries (a value of 0 means to query now). Otherwise, a longer interval is acceptable.
The query interval for an SNMP printer should be the default value specified in the corresponding printer attribute file (paf). Even though SNMP printers send asynchronous events to PrintXchange, the printer can not report all of its changes. For example: If an operator pauses an SNMP printer control panel, the printer has to rely on the device query to update the physical printer object in the supervisor.
It is the administrator's responsibility to determine the interval values for a maximized job flow.
device-query-library-name
The device-query-library-name attribute identifies the name of the Xerox supervisor back end (BE) shared library used to query the print server or output device. This is the library that is used to do device status queries.
Objects Printer (physical only)
M/S Single value
Settable Yes (only at printer creation)
Commands pdcreate
Valid values xrssnmp (used for snmp printers)
xppq (used for DocuTech 6135 and 6180 and DocuPrint NPS printers)
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 177
ATTRIBUTES
Comments This attribute applies only to PrintXchange configurations that include Xerox DocuTech 6135 or 6180 production printers or SNMP-based printers. The value for this attribute is specified in the printer attribute file (paf) for those printers.
In the Windows NT environment, the xrssnmp value implies the xrssnmp.dll library. The xppq value implies the xppq.dll library.
In the UNIX environment, the xrssnmp value is not applicable. The xppq value implies the libxppq.so library.
device-status-query-supported
The device-status-query-supported attribute indicates whether the Xerox supervisor can obtain the device status from the printer.
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values true|yes
false|no
Default value No default value
Comments If this is set to true|yes , the values for device-query-channel-ready , device-query-channels-supported , and device-query-library-name must be present.
disable-backlogged-queue
The disable-backlogged-queue attribute determines whether the spooler automatically disables the queue if the number of its pending jobs exceeds the value of the queue-backlog-upper-limit attribute.
The attribute also determines whether the spooler automatically enables the queue when the queue is no longer backlogged. The spooler can automatically enable a queue only when it previously automatically disabled that queue (an operator did not disable the queue via a disable operation).
Objects Queue
M/S Single value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 178
ATTRIBUTES
Settable Yes
Commands pdcreate
pdset
Valid values true|yes
false|no
Default value false|no
Comments
disable-operations
The disable-operations attribute contains the total number of disable object operations that have taken place since the server was last started.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable No
Commands N/A
Valid values
Default value No default value
Comments Disable operations take place when invoking the pddisable command.
The disable-operations attribute lists the total disable operations as well as the number of disable operations on each object. For example:
disable-operations=6server:4queue:1printer:1
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 179
ATTRIBUTES
document-file-name
The document-file-name attribute specifies the name of the file, if any, with complete path.
Do not confuse this attribute with the client attribute document-filename .
Objects Document
M/S Single value
Settable Yes (For a document object, only at job submission. For an initial-value-document object, only at initial-value-document creation or modification.)
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values Text string of up to 4095 characters
Default value No default value
Comments If document start sheets are in use via the document-sheets attribute, the value of the document-file-name attribute prints on document start sheets.
document-filename
This client attribute identifies the input file name to be printed as a document in a print job. The name may or may not include the complete path specification.
Do not confuse this attribute with the document object attribute document-file-name .
Objects N/A
M/S Single value
Settable Yes
Commands pdpause
pdpr
Valid values Text string of up to 4095 characters
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 180
ATTRIBUTES
Comments Client attributes are mainly used to allow what would normally be an option to be entered as an argument to the -x option.
For example,
-f myfile
is the same as
-x "document-filename=myfile"
document-format
The document-format attribute identifies the data syntax used to encode the final printed form of a document.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values The document-format attribute contains three elements, two of which are optional. Values must be entered differently for each element, according to the table below. In addition, curly braces must be used when entering values, as in the following:
{document-format document-format-variants document-format-version}
Table A-6. document-format elements
Element Value range
document-format (See list of valid values)
document-format-variants (optional) Text string of up to 4095 characters
document-format-version (optional) Text string of up to 255 characters
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 181
ATTRIBUTES
Table A-7. document-format values
Default value No default value
Values
201PL HPGL PJL
ART IGP plot
automatic imPRESS PostScript
CaPSL Interpress PPDS
CCITT IPDS PPT
cif ISO6429 PSPrinter
CodeV LCDS QUIC
CPAP line-data raster
DDIF LIPS ReGIS
DEC-PPL LN03 SCS
Diagnostic MODCA simple-text
ditroff MS-Word SPDL
DOC NPAP Tek4014
DSC-DSE NPDL TIFF
dvi other troff
Epson PAGES unknown
EscapeP PCL WPL
ESCPage PCL-XL WPS
EXCEL PDF XES
EXCL PDS
fortran Pinwriter
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 182
ATTRIBUTES
Comments The spooler will set this attribute during job submission if the print request does not specify a document format.
Destination logical and physical printers must contain the specified document's document-format value as a value of their document-formats-supported attribute. The physical printer must also contain the document's document-format value as a value of its document-formats-ready attribute.
Examples:
document-format=PostScript
document-format=”{document-format=PostScript document-format-variants='level2' document-format-version='48.13'}”
Note: If the optional elements are not included, the value does not require the braces {} (document-format=PostScript).
Note: If you submit a multi-document job containing both PostScript and PCL and there is not a single physical printer that prints both PostScript and PCL, the job is accepted but not scheduled. Therefore, multi-document jobs should not contain a mix of PostScript and PCL.
document-formats-ready
The document-formats-ready attribute specifies the document formats that can be handled by the printer and any associated translators. For example, on a LaserWriter with the reference supervisor, the value of this attribute is PostScript and simple-text .
Objects Printer (physical only)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values See document-format
Default value No default value
Comments The values set for the document-formats-ready attribute determine the document types that can be submitted to this printer.
Also, checking takes place comparing the values of document-formats-ready with the printer's native-document-formats-ready attribute to determine whether the job can be printed by the physical printer. This is done at the supervisor. If the check fails, the job is aborted.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 183
ATTRIBUTES
document-formats-supported
The document-formats-supported attribute specifies the document formats supported by the printer.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values See document-format
Default value No default value
Comments The values set for the document-formats-supported attribute determine the document types that can be submitted to this printer.
document-name
The document-name attribute specifies a meaningful or base name for the document. This attribute is set to be the file name, if not otherwise specified by the submitter.
A path specification is not included in the value of this attribute.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values Text string of up to 255 characters
Default value No default value
Comments If document start sheets are in use via the document-sheets attribute, the value of the document-name attribute prints on document start sheets.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 184
ATTRIBUTES
document-sequence-number
Specifies the sequence number of this document within a job.
Objects Document
M/S Single value
Settable No
Commands N/A
Valid values Integer equal to or greater than 0
Default value No default value
Comments
document-sheets
The document-sheets attribute specifies the auxiliary sheets the server should insert into the job.
If you specify a value of doc-set-start-copies-separate , a separator sheet precedes every copy of the document.
Objects Initial-value-job
Job
M/S Single value
Settable Yes
Commands pdcreate, pdset (for initial-value-job objects)
pdmod, pdpr, pdset (for job objects)
Valid values none
doc-set-start-copies-separate
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 185
ATTRIBUTES
Comments The names and values of the following attributes are printed on a document start sheet:
• document-name
• document-sequence-number
• job-name
• job-owner
• document-file-name
• document-format
• default-font
• default-input-tray
• number-up
• sides
• reset-printer
Destination logical and physical printers must contain the specified job's document-sheets value as a value of their document-sheets-supported attribute. The physical printer must also contain the specified job's document-sheets value as a value of its document-sheets-ready attribute.
document-sheets-ready
The document-sheets-ready attribute specifies the auxiliary sheets ready for use on the printer.
Objects Printer (physical only)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values none
doc-set-start-copies-separate
Default value No default value
Comments The document-sheets-ready attribute must contain a value corresponding to the value of the document-sheets attribute of a job to be printed on this printer.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 186
ATTRIBUTES
document-sheets-supported
The document-sheets-supported attribute specifies the auxiliary sheets supported by this printer.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values none
doc-set-start-copies-separate
Default value No default value
Comments The document-sheets-supported attribute must contain a value corresponding to the value of the document-sheets attribute of a job submitted to this printer.
document-state
Identifies the state of the document.
Objects Document
M/S Single value
Settable No
Commands N/A
Valid values transfer-pending, pending, processing, completed, printing
Default value No default value
Comments
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 187
ATTRIBUTES
document-type
The document-type attribute indicates that the document being passed by the current print operation is either a printable document, a font, or a resource. A font or resource value indicates that the document is a font resource or contains resource data other than font that may be required for the printer to print one or more of the printable documents associated with the print job.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values printable
font
resource
Default value No default value
Comments
docuprint-job-pool-version
The docuprint-job-pool-version attribute specifies the version number of the DocuPrint NPS API used to build the DocuPrint NPS Back End (BE).
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values Positive or negative integer
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 188
ATTRIBUTES
Comments Caution: This attribute should not be changed unless a new version of a DocuPrint NPS printer is put into use.
domain-name (Windows NT only)
The domain-name attribute indicates the domain where an operation is to be invoked on an object. The specified domain is external to the domain where the user initiates the operation.
Objects Initial-value-document
Initial-value-job
Printer (logical and physical)
Queue
Server (spooler and supervisor)
M/S Single value
Settable Yes
Commands All
Valid values Text string of up to 4095 characters
Default value No default value
Comments If domain-name is not specified, the client may use the value in the PDDOMAIN environment variable, if present.
For cross-platform objects, the UNIX domain name must be prefixed by nis :
driver-server (Windows NT only)
The driver-server attribute contains the name of the driver server (repository server of printer driver files) associated with this spooler.
Objects Server (spooler only)
M/S Single value
Settable Yes
Commands pdset
Valid values Text string of up to 255 characters
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 189
ATTRIBUTES
Default value No default value
enable-operations
The enable-operations attribute contains the total number of enable object operations that have taken place since the server was last started.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable No
Commands N/A
Valid values
Default value No default value
Comments Enable operations take place when invoking the pdenable command.
The enable-operations attribute lists the total enable operations as well as the number of enable operations on each object. For example:
enabled
The enabled attribute indicates whether the specified object is enabled to accept print requests. This attribute is set with pdenable/pddisable. When an object is created, it is disabled by default.
In order for a server to accept print requests, both the server's and the specified printer's enabled attributes must be set to true|yes .
Objects Printer (logical and physical)
Queue
Server (spooler and supervisor)
M/S Single value
Settable Yes (via pdenable/pddisable)
clean-operations=6server:4queue:2
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 190
ATTRIBUTES
Commands N/A (set via pdenable/pddisable)
Valid values true|yes (enabled)
false|no (disabled)
Default value false|no (disabled)
Comments When you enable a logical or physical printer, its associated-queue attribute is checked to determine the appropriate queue for the printer.
events-supported
Specifies the event types and event classes supported by the server.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable No
Commands N/A
Valid values See Appendix D
Default value No default value
Comments When a user specifies events in the notification-profile attribute, the events requested are validated against the values in the events-supported attribute. If a value is not found, the server rejects the request.
excluded-preprocessors
The excluded-preprocessors attribute contains names of preprocessors that a spooler or supervisor disallows on the specified associated printer.
This attribute is ignored if the printer's preprocessor-list , the document’s spooler-preprocessor-list or the supervisor-preprocessor-list have values. It is available only when the server's preprocessor-list is used.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 191
ATTRIBUTES
Commands pdcreate
pdset
Valid values name values (see preprocessor-definition attribute description)
Default value No default value
Comments pdset -c printer -x excluded-preprocessors=<preprocessor_name> <printer_name>
fax-resolution
The fax-resolution attribute specifies the resolution for an outgoing fax. The actual resolution may be up to the fax itself.
Objects Document
M/S Single value
Settable Yes
Commands pdmod
pdpr
pdset
Valid values super-high
high
standard
Default value No default value
Comments Currently, this attribute applies only to Fuji Xerox multi_function printers. The destination logical and physical printer's fax-resolutions-supported attribute must contain a value specified for fax-resolution in order for the job to be accepted. For the job to be scheduled, the printer's fax-resolutions-ready attribute must contain the value specified for fax-resolution .
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 192
ATTRIBUTES
fax-resolutions-ready
The fax-resolutions-ready attribute specifies the resolutions ready to be used by this printer for an outgoing fax.
Objects Printer (physical only)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values super-fine-resolution
fine-resolution
standard
Default value
Comments Currently, this attribute applies only to Fuji Xerox multi-function printers. The destination logical and physical printer's fax-resolutions-supported attribute must contain a value specified for fax-resolution in order for the job to be accepted. For the job to be scheduled, the printer's fax-resolutions-ready attribute must contain the value specified for fax-resolution .
fax-resolutions-supported
The fax-resolutions-supported attribute specifies the resolutions supported by this printer for an outgoing fax.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values super-fine-resolution
fine-resolution
standard
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 193
ATTRIBUTES
Comments Currently, this attribute applies only to Fuji Xerox multi-function printers. The destination logical and physical printer's fax-resolutions-supported attribute must contain a value specified for fax-resolution in order for the job to be accepted. For the job to be scheduled, the printer's fax-resolutions-ready attribute must contain the value specified for fax-resolution .
file-reference-is-local-only
Specifies whether the server using the file-reference transfer method is allowed to access only local document files.
Objects Server (spooler and supervisor)
M/S Single value
Settable No
Commands N/A
Valid values false|no
Default value false|no
Comments This attribute is set to false|no when the system initializes, since PrintXchange supports accessing non-local document files.
filter
This client attribute specifies the selection criteria to be used among candidate object_instances in the operand.
Objects N/A
M/S Single value
Settable Yes
Commands pdls
pdmod
pdq
Valid values Text string
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 194
ATTRIBUTES
Comments Client attributes are mainly used to allow what would normally be an option to be entered as an argument to the -x option.
For example,
pdls -f job-owner==mary spooler_name:
is the same as
pdls -x filter="job-owner==mary" spooler_name:
finishing
The finishing attribute specifies a finishing process to be applied to the document.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values Table A-8. finishing
Default value No default value
Comments On job submission, the spooler checks the finishing specified for a document against the logical printer's finishings-supported attribute. In addition, the spooler checks for a match with the physical printer's finishings-ready attribute. If there is no match, the spooler rejects the print request.
Values
bind staple-bottom-right
cover staple-dual-bottom
edge-stitch staple-dual-left
none staple-dual-right
punch staple-dual-top
saddle-stitch staple-top-left
staple staple-top-right
staple-bottom-left
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 195
ATTRIBUTES
Since the user may have modified the finishing specified for a document after the job was accepted, the spooler again checks the finishing specified for a document against the physical printer's finishings-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
Various finishings (such as stapling) are supported on Xerox DocuTech and DocuPrint printers. However, since finishing is a document attribute, it is generally difficult to apply finishing to a job. For example, if each document in your print job is a chapter in a book, the only way to apply finishing to the entire book is to:
1) Submit the job without specifying job-collate-preserved .
2) Set job-copies=1 for the job.
3) Set copy-count=1 for documents within the job.
finishings-ready
The finishings-ready attribute identifies the per-document finishings ready on the printer.
Objects Printer (physical only)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values See finishing
Default value No default value
Comments On job submission, the spooler checks the finishing specified for a document against the logical printer's finishings-supported attribute. In addition, the spooler checks for a match with the physical printer's finishings-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the finishing specified for a document after the job was accepted, the spooler again checks the finishing specified for a document against the physical printer's finishings-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 196
ATTRIBUTES
finishings-supported
The finishings-supported attribute identifies the per-document finishings supported on the printer.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values See finishing
Default value No default value
Comments On job submission, the spooler checks the finishing specified for a document against the logical printer's finishings-supported attribute. In addition, the spooler checks for a match with the physical printer's finishings-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the finishing specified for a document after the job was accepted, the spooler again checks the finishing specified for a document against the physical printer's finishings-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
fonts-ready
The fonts-ready attribute identifies the font resources ready on the printer.
Objects Printer (physical only)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values Text string of up to 255 characters
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 197
ATTRIBUTES
Comments On job submission, the spooler checks the font specified for a document against the logical printer's fonts-supported attribute. In addition, the spooler checks for a match with the physical printer's fonts-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the font specified for a document after the job was accepted, the spooler again checks the font specified for a document against the physical printer's fonts-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
fonts-supported
The fonts-supported attribute identifies the font resources supported by the printer.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values Text string of up to 255 characters
Default value No default value
Comments On job submission, the spooler checks the font specified for a document against the logical printer's fonts-supported attribute. In addition, the spooler checks for a match with the physical printer's fonts-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the font specified for a document after the job was accepted, the spooler again checks the font specified for a document against the physical printer's fonts-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 198
ATTRIBUTES
footer-text
The footer-text attribute provides you with more control over the placement of text in a document with simple-text format. Specifically, the attribute specifies the text that is to be printed on the last line of each page.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-documents)
Valid values Text string of up to 4095 characters
Default value No default value
Comments Because of its use with simple-text format, footer-text is typically part of a simple-text to PostScript translation filter as defined with the attribute preprocessor-definition .
goj-cont-operations
The goj-cont-operations attribute contains the total number of get ordered jobs (goj) continuation operations that have taken place since the spooler was last started.
On listing the job queue (getting ordered jobs) with a count or time limit, the server returns the first set of ordered jobs via goj-operations . After the first set of ordered jobs is received, the client automatically sends a goj continue operation to request the next set.
Objects Server (spooler only)
M/S Multi-value
Settable No
Commands N/A
Valid values
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 199
ATTRIBUTES
Comments Get ordered jobs continuation operations take place as part of the pdq command.
goj-operations
The goj-operations attribute contains the total number of get ordered jobs (goj) operations that have taken place since the spooler was last started.
See the description for goj-cont-operations for additional information.
Objects Server (spooler only)
M/S Multi-value
Settable No
Commands N/A
Valid values
Default value No default value
Comments Get ordered jobs operations take place when invoking the pdq command.
header-text
The header-text attribute provides you with more control over the placement of text in a document with simple-text format. Specifically, the attribute specifies the text that is to be printed on the first line of each page.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values Text string of up to 4095 characters
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 200
ATTRIBUTES
Comments Because of its use with simple-text format, header-text is typically part of a simple-text translation filter as defined with the attribute preprocessor-definition .
headings
This client attribute specifies whether column headings should be included on output of requested attributes.
Objects N/A
M/S Single value
Settable Yes
Commands pdcreate
pdls
pdmod
pdpr
pdq
pdset
Valid values false|no
true|yes
Default value true|yes
Comments Client attributes are mainly used to allow what would normally be an option to be entered as an argument to the -x option.
For example,
-g (the option to turn off column headings on output of requested attributes)
is the same as
-x "headings=no"
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 201
ATTRIBUTES
highlight-colour
The highlight-colour attribute sets the highlight printing color for the document.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values red, blue, green, cyan, magenta, yellow, cardinal, royalblue, ruby, violet, black, or name
Default value No default value
Comments Destination logical and physical printers must contain the specified document's highlight-colour value as a value of their highlight-colours-supported attribute. The physical printer must also contain the specified document's highlight-colour value as a value of its highlight-colours-ready attribute.
The job can be forced to print whatever color is currently ready on the printer by setting highlight-colour-mismatch-action to ignore .
highlight-colour-mismatch-action
The highlight-colour-mismatch-action attribute determines how PrintXchange handles highlight color jobs when there is a mismatch between the color specified for the document and the highlight color supported or ready at the printer (highlight-colours-supported and highlight-colours-ready attributes).
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 202
ATTRIBUTES
Valid values abort
ignore
operator
Default value No default value
Comments When the value is abort , the spooler rejects the document/job if the:
• Matching highlight color is not supported.
• Matching highlight color is supported but is not ready.
When the value is ignore , the spooler ignores the highlight color mismatch and continues to accept and schedule the document/job for printing.
When the value is operator , operator intervention is required to resolve the mismatch. The spooler:
• Rejects the document/job if the matching highlight color is not supported.
• Accepts but does not schedule the document/job if the matching highlight color is supported but is not ready. The job is scheduled for printing as soon as the matching highlight color is ready.
When no value is specified, the spooler:
• Rejects the document/job if the matching highlight color is not supported.
• Accepts but does not schedule the document/job if the matching highlight color is supported but is not ready. The job is scheduled for printing as soon as the matching highlight color is ready.
highlight-colour-rendering-algorithm
The highlight-colour-rendering-algorithm attribute sets the highlight color rendering algorithm for the document.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values automatic, colourToHighlight, colourTables, presentation, pictorial
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 203
ATTRIBUTES
Default value No default value
Comments Destination logical and physical printers must contain the specified document's highlight-colour-rendering-algorithm value as a value of their highlight-colour-rendering-algorithms-supported attribute.
Highlight color attributes apply to Xerox DocuPrint 4850/4890NPS printers. The following paragraphs describe the values for this attribute:
automatic : This option chooses a mapping method on an object-by-object basis, for example, it applies the pictorial mapping for other objects (filled areas, strokes, and text).
colourToHighlight : This mapping option discards the hue information and preserves the saturation and value of the color application.
colourTables : This mapping option uses preset color tables to perform the mapping and is provided for compatibility reasons. This attribute has no effect with cyan.
presentation : Refers to the ability to distinguish between different colors. This option is a good choice for charts and diagrams as the typically use distinctly different colors.
pictorial : Refers to maintaining the pictorial quality:
• Colors with a hue matching the map color are not changed
• Colors with a hue close to the map color are rendered with color, but with a saturation level that decreases as the hue shifts away from the map color.
• Colors with a hue complementary to the map color are produced in shades of gray.
highlight-colour-rendering-algorithms-supported
The highlight-colour-rendering-algorithms-supported attribute indicates the highlight color rendering algorithms supported on this printer.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values automatic, colourToHighlight, colourTables, presentation, pictorial
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 204
ATTRIBUTES
Comments The highlight-colour-rendering-algorithms-supported attribute must contain a value corresponding to the value of the highlight-colour-rendering-algorithm of a document submitted to this printer.
Highlight color attributes apply to Xerox DocuPrint 4850/4890NPS printers. The following paragraphs describe the values for this attribute:
automatic : This option chooses a mapping method on an object-by-object basis, for example, it applies the pictorial mapping for other objects (filled areas, strokes, and text).
colourToHighlight : This mapping option discards the hue information and preserves the saturation and value of the color application.
colourTables : This mapping option uses preset color tables to perform the mapping and is provided for compatibility reasons. This attribute has no effect with cyan.
presentation : Refers to the ability to distinguish between different colors. This option is a good choice for charts and diagrams as the typically use distinctly different colors.
pictorial : Refers to maintaining the pictorial quality:
• Colors with a hue matching the map color are not changed
• Colors with a hue close to the map color are rendered with color, but with a saturation level that decreases as the hue shifts away from the map color.
• Colors with a hue complementary to the map color are produced in shades of gra
highlight-colours-ready
The highlight-colours-ready attribute indicates the values of highlight colors ready on this printer.
Objects Printer (physical only)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values red, blue, green, cyan, magenta, yellow, cardinal, royalblue, ruby, violet, black, or name
Default value No default value
Comments The highlight-colours-ready attribute must contain a value corresponding to the value of the highlight-colour attribute of a document to be printed on this printer.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 205
ATTRIBUTES
highlight-colours-supported
The highlight-colours-supported attribute indicates the values of highlight colors supported on this printer.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values red, blue, green, cyan, magenta, yellow, cardinal, royalblue, ruby, violet, black, or name
Default value No default value
Comments The highlight-colours-supported attribute must contain a value corresponding to the value of the highlight-colour attribute of a document submitted to this printer.
highlight-mapping-colour
The highlight-mapping-colour attribute sets the specified color to be the reference color.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values red, blue, green, cyan, magenta, yellow cardinal, royalblue, ruby, violet, black, or name
Default value No default value
Comments Destination logical and physical printers must contain the specified document's highlight-mapping-colour value as a value of their highlight-mapping-colours-supported attribute.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 206
ATTRIBUTES
This attribute specifies the colored parts of the document that convert to the available highlight color. The map color option determines which parts of the document print in color and which in shades of gray.
For example, if you specify the map color as red , all the red parts of your document (including portions of composite colors such as purple) print in the available highlight color. The other colored parts of the document print in shades of gray.
This option is required only if you want the highlight-mapping-colour and highlight-colour values to differ. By default, the map color is assumed to be the same as the highlight color.
highlight-mapping-colours-supported
The highlight-mapping-colours-supported attribute indicates the values of highlight colors supported on this printer that can be used as reference colors.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values red, blue, green, cyan, magenta, yellow, cardinal, royalblue, ruby, violet, black, or name
Default value No default value
Comments The highlight-mapping-colours-supported attribute must contain a value corresponding to the value of the highlight-mapping-colour attribute of a document submitted to this printer.
This attribute specifies the colored parts of the document that convert to the available highlight color. The map color option determines which parts of the document print in color and which in shades of gray.
For example, if you specify the map color as red , all the red parts of your document (including portions of composite colors such as purple) print in the available highlight color. The other colored parts of the document print in shades of gray.
This option is required only if you want the highlight-mapping-colour and highlight-colour values to differ. By default, the map color is assumed to be the same as the highlight color.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 207
ATTRIBUTES
hold-jobs-interrupted-by-printer-failure
The hold-jobs-interrupted-by-printer failure attribute specifies whether jobs returned to the spooler after a restart should be put in the held (true|yes) or pending (false|no ) state.
Jobs in the held state are retained by the spooler until you set the job-hold attribute to false|no .
Jobs in the pending state are candidates for being scheduled for printing at the next available printer.
Objects Printer (physical only)
Server (spooler only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values true|yes
false|no
Default value No default value
Comments The spooler uses the hold-jobs-interrupted-by-printer-failure attribute from the physical printer object if the attribute is specified there. Otherwise, the spooler uses the attribute specified for itself (the spooler).
If the value of hold-jobs-interrupted-by-printer-failure is true|yes or unspecified, jobs returned to the supervisor due to crashes are put in the held state. The job's job-state-reasons attribute contains job-interrupted-by-printer-failure and job-hold-set .
If the value of hold-jobs-interrupted-by-printer-failure is false|no , jobs returned to the supervisor due to crashes are put in the pending state. The job's job-state-reasons attribute is empty in this case.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 208
ATTRIBUTES
ignore-preprocessing-failure
The ignore-preprocessing-failure attribute determines the appropriate action that occurs on a job when a preprocessor fails for any reason.
Objects Document
Initial-value-document
Printer (logical and physical)
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document and printer objects)
Valid values true|yes (ignore the failure)
false|no (do not ignore the failure)
Default value false|no
Comments For logical and physical printers:
• If ignore-preprocessing-failure=true and preprocessing fails, the job continues printing using the original unpreprocessed document data.
For logical printers:
• If ignore-preprocessing-failure=false (or ignore-preprocessing-failure is not present) and preprocessing fails, the server sets the current-job-state=held with job-state-reasons=preprint-failed . The spooler rolls back the data for the offending document to the original document data. If you wish to print the job using original data, release the job.
For physical printers:
• If ignore-preprocessing-failure=false (or ignore-preprocessing-failure is not present) and preprocessing fails, the job is aborted, the spooler puts the job in a held state, and sets job-state-reasons to aborted-by-system , preprint-failed .
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 209
ATTRIBUTES
impressions-completed
The impressions-completed attribute indicates the total number of impressions that the printer placed on the media for the job, including repeated impressions due to multiple copies. The value for the attribute is 0 if printing has not started for the job.
Objects Job
M/S Single value
Settable No
Commands N/A
Valid values Integer equal to or greater than 0
Default value No default value
Comments
initial-value-document
The initial-value-document attribute identifies an initial-value-document object that contains default document attributes to be used when constructing the document object during print job submission.
Objects Document
M/S Single value
Settable Yes (only at job submission)
Commands pdpr
Valid values Name of existing initial-value-document residing on the same spooler as the requested logical printer.
Default value No default value
Comments The document's initial-value-document attributes take precedence over a logical printer's printer-initial-value-document attributes.
To obtain a list of initial-value-document objects, use the following command:
pdls -c initial-value-document <spooler_name:>
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 210
ATTRIBUTES
initial-value-document-identifier
The initial-value-document-identifier attribute uniquely identifies an initial-value-document object.
Objects Initial-value-document
M/S Single value
Settable Yes (only at initial-value-document creation)
Commands pdcreate
Valid values
Default value No default value
Comments
initial-value-job
The initial-value-job attribute identifies an initial-value-job object that contains default job attributes to be used when constructing the job object during print job submission.
Objects Job
M/S Single value
Settable Yes (only at job submission)
Commands pdpr
Valid values Name of existing initial-value-job residing on the same spooler as the requested logical printer.
Default value No default value
Comments The job's initial-value-job attributes take precedence over a logical printer's printer-initial-value-job attributes.
To obtain a list of initial-value-document objects, use the following command:
pdls -c initial-value-job <spooler_name:>
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 211
ATTRIBUTES
initial-value-job-identifier
The initial-value-job-identifier attribute uniquely identifies an initial-value-job object.
Objects Initial-value-job
M/S Single value
Settable Yes (only at initial-value-job creation)
Commands pdcreate
Valid values
Default value No default value
Comments
input-trays-medium
The input-trays-medium attribute identifies the medium in each input tray of the printer. Each input tray object identifier should appear only once in the values of the attribute (one medium per tray). However, medium identifiers may appear several times (same medium in multiple trays).
Objects Printer (physical only)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values The input-trays-medium attribute contains two elements. Enter the values as follows:
input-tray:medium
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 212
ATTRIBUTES
Table A-9. input-trays-medium elements
Default value No default value
Comments Destination logical and physical printers must contain the specified document's input-trays-medium value as a value of their input-trays-supported and media-supported attributes. The physical printer must also contain the specified document's input-trays-medium value as a value of its input-trays-ready and media-ready attributes.
Examples:
input-trays-medium=top:a
"input-trays-medium=top:na-letter-white bottom:na-legal-white"
input-trays-ready
The input-trays-ready attribute identifies the input tray ready to be used on this printer.
Objects Printer (physical only)
M/S Multi-value
Settable Yes
Element Value range
input-tray 12345678910topmiddlebottomenvelopemanualmanual-2manual-3large-capacitymainside
medium Any valid value for default-medium attribute
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 213
ATTRIBUTES
Commands pcreate
pdset
Valid values top, middle, bottom, envelope, default, manual, manual-2, manual-3, large-capacity, main, side, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10
Default value No default value
Comments The input-trays-ready attribute must contain a value corresponding to the value of the default-input-tray attribute of a document to be printed on this printer.
input-trays-supported
The input-trays-supported attribute identifies the input trays supported on this printer.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values top, middle, bottom, envelope, default, manual, manual-2, manual-3, large-capacity, main, side, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10
Default value No default value
Comments The input-trays-supported attribute must contain a value corresponding to the value of the default-input-tray attribute of a document submitted to this printer.
intervening-jobs
Indicates an approximation of the number of pending jobs to be printed before this job will be scheduled. It is set to 0 when the job begins printing.
Objects Job
M/S Single value
Settable No
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 214
ATTRIBUTES
Commands N/A
Valid values Integer equal to or greater than 0
Default value No default value
Comments
job-attributes-visible-to-all
The job-attributes-visible-to-all attribute specifies the list of job and document attributes that a non-owner of a job will be able to see with the pdls or pdq command. This can be set by an administrator. By default, only jobs in the queue ahead of the user’s jobs are visible.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values
Default value intervening-jobs (the attribute)
Comments The results-profile client pseudo-attributes (results-delivery-method , results-set-comment , results-delivery-address , job-copies , and output-bin ) should never be set as values for the job-attributes-visible-to-all server attribute. The results-profile attribute should be set instead. If you set the pseudo-attributes as values for job-attributes-visible-to-all , their values will not display when using the pdls or pdq command.
If you are not the owner of a job and you use the pdls or pdq command to request attribute values not contained in the server's job-attributes-visible-to-all attribute, the command does not fail. It simply returns empty values.
To assist users in locating their jobs if misplaced or misfiled after printing at a departmental printer, job-owner and job-identifier should be included as information seen by non-owners of a job.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 215
ATTRIBUTES
job-cancel-channel-ready
The job-cancel-channel-ready attribute identifies the job cancellation channel ready to be used in the Xerox supervisor back end (BE) shared library. The value has to be one of the values in job-cancel-channels-supported .
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values 1179_lprm
fxops_lprm
Default value No default value
Comments This attribute applies only to PrintXchange configurations that include Xerox production printers or SNMP-based printers. The value for this attribute is specified in the printer attribute file (paf) for each Xerox production printer.
job-cancel-channels-supported
The job-cancel-channels-supported attribute lists the job cancellation channels supported by the Xerox supervisor back end (BE) shared library.
Objects Printer (physical only)
M/S Multi-value
Settable Yes (only at printer creation)
Commands pdcreate
Valid values 1179_lprm
fxops_lprm
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 216
ATTRIBUTES
Comments This attribute applies only to PrintXchange configurations that include Xerox production printers or SNMP-based printers. The value for this attribute is specified in the printer attribute file (paf) for each Xerox production printer.
job-cancellation-supported
The job-cancellation-supported attribute indicates if the printer supports job cancellations. This attribute applies to the Xerox supervisor only.
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values true|yes
false|no
Default value No default value
Comments
job-cancel-library-name
The job-cancel-library-name attribute identifies the name of the Xerox supervisor back end (BE) shared library used to cancel the job.
Objects Printer (physical only)
M/S Single value
Settable Yes (only at printer creation)
Commands pdcreate
Valid values xrslpqrm
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 217
ATTRIBUTES
Comments This attribute applies only to PrintXchange configurations that include Xerox production printers or SNMP-based printers. The value for this attribute is specified in the printer attribute file (paf) for each Xerox production printer. The xrslpqrm value is used if the output device supports cancelling jobs via RFC1179 (i.e., lprm).
In the Windows NT environment, the xrslpqrm value implies the xrslpqrm.dll library.
In the UNIX environment, the xrslpqrm value implies the libxrslpqrm.so library.
job-collate-preserved
The job-collate-preserved attribute indicates if job collation should be preserved.
Objects Initial-value-job
Job
M/S Single value
Settable Yes
Commands pdcreate, pdset (for initial-value-job objects)
pdmod, pdpr, pdset (for job objects)
Valid values true|yes
false|no
Default value false|no
Comments The Xerox supervisor uses this attribute when sending jobs to the Xerox DocuTech 6135 and 6180 and DocuPrint NPS printers.
If the printer is not specified, the Xerox supervisor sends the job to the printer that minimizes network traffic.
job-comment
The job-comment attribute supplies a human readable string for a print job.
Objects Initial-value-job
Job
M/S Single value
Settable Yes
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 218
ATTRIBUTES
Commands pdcreate, pdset (for initial-value-job objects)
pdmod, pdpr, pdset (for job objects)
Valid values Text string of up to 4095 characters
Default value No default value
Comments If job start sheets are in use via the job-sheets attribute, the value of the job-comment attribute prints on job start sheets.
job-completion-period
The job-completion-period attribute specifies the period of time the spooler keeps the job in the completed state (current-job-state=completed ). Setting the attribute enables users to query for the job status long after the job completes printing (up to the time specified via job-completion-period ).
If a user does not set job-completion-period , the spooler keeps the job in the completed state for the duration specified by default-job-completion-period .
Objects Initial-value-job
Job
M/S Single value
Settable Yes
Commands pdcreate, pdset (for initial-value-job objects)
pdmod, pdpr, pdset (for job objects)
Valid values Values entered in the format [HH:]mm[:SS]
HH = 0 - 99 hours
mm = 0 - 59 minutes
SS = 0 - 59 seconds
Default value No default value
Comments Once a job is in the completed state, you cannot resubmit it. Also, you can view its attributes but cannot modify them.
If a job has values set for the attributes job-completion-period and job-retention-period , the job completion period begins at the expiration of the job-retention-period.
Jobs with a job completion period differ from jobs with a job retention period in that, for jobs with a job completion period, the spooler does not save the job attributes or data.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 219
ATTRIBUTES
job-copies
The job-copies client attribute specifies the number of copies of the job to be printed.
The product of job-copies and copy-count should not exceed the value of the logical printer's maximum-copies-supported attribute. If it does, the spooler rejects the job.
Objects Initial-value-job
Job
M/S Single value
Settable Yes
Commands pdcreate (for initial-value-job objects)
pdpr (for job objects)
Valid values Integer greater than 0
Default value No default value
Comments The job-copies client attribute is part of the results-profile attribute. The results-profile attribute is supported but is not visible to the user. Its value is specified via the job-copies , output-bin , results-delivery-method , results-set-comment , and results-delivery-address attributes.
job-copies-completed
Indicates the number of job copies that have been printed.
Objects Job
M/S Single value
Settable No
Commands N/A
Valid values Integer equal to or greater than 0
Default value No default value
Comments
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 220
ATTRIBUTES
job-discard-time
The job-discard-time attribute specifies the calendar date and time of day at which a job should be discarded, regardless of whether it has printed. When the job-discard-time arrives, the spooler sets the job's job-retention-period attribute to zero, regardless of the job state. The spooler then cancels the job, changing the job state to completed.
Objects Initial-value-job
Job
M/S Single value
Settable Yes
Commands pdcreate, pdset (for initial-value-job objects)
pdmod, pdpr, pdset (for job objects)
Valid values Values entered in the format dd:mm:yyyy:HH:MM:SS
Default value No default value
Comments To specify that job "budget" be deleted by 5:00 pm on August 25, 1997, use:
pdmod -x "job-discard-time=25:08:1997:17:00:00" budget
job-fault-count
Indicates the number of times the job is returned by the supervisor due to a crash of the spooler or supervisor.
Objects Job
M/S Single value
Settable No
Commands N/A
Valid values Integer equal to or greater than 0
Default value No default value
Comments
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 221
ATTRIBUTES
job-finishing
The job-finishing attribute specifies a finishing process to be applied to each job copy of the printed output.
Objects Initial-value-job
Job
M/S Single value
Settable Yes
Commands pdcreate, pdset (for initial-value-job objects)
pdmod, pdpr, pdset (for job objects)
Valid values Table A-10. finishing
Default value No default value
Comments On job submission, the spooler checks the finishing specified for a job against the logical printer's job-finishings-supported attribute. In addition, the spooler checks for a match with the physical printer's job-finishings-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the finishing specified for a job after the job was accepted, the spooler again checks the finishing specified for a job against the physical printer's job-finishings-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
Values
bind staple-bottom-right
cover staple-dual-bottom
edge-stitch staple-dual-left
none staple-dual-right
punch staple-dual-top
saddle-stitch staple-top-left
staple staple-top-right
staple-bottom-left
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 222
ATTRIBUTES
job-finishings-ready
The job-finishings-ready attribute identifies the job-level finishing ready to be used on this printer.
Objects Printer (physical only)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values See job-finishing
Default value No default value
Comments On job submission, the spooler checks the finishing specified for a job against the logical printer's job-finishings-supported attribute. In addition, the spooler checks for a match with the physical printer's job-finishings-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the finishing specified for a job after the job was accepted, the spooler again checks the finishing specified for a job against the physical printer's job-finishings-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
job-finishings-supported
The job-finishings-supported attribute identifies the job-level finishing supported by this printer.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values See job-finishing
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 223
ATTRIBUTES
Comments On job submission, the spooler checks the finishing specified for a job against the logical printer's job-finishings-supported attribute. In addition, the spooler checks for a match with the physical printer's job-finishings-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the finishing specified for a job after the job was accepted, the spooler again checks the finishing specified for a job against the physical printer's job-finishings-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
job-hold
The job-hold attribute specifies whether a print job is a candidate for being scheduled for printing. The default value of this attribute is false|no .
When the value is false|no , the spooler does not hold the job from being scheduled for printing, unless there are other reasons (see the current-job-state and job-state-reasons attributes).
When the value is true|yes , the spooler holds the job from being scheduled for printing. Specifically:
• the value job-hold-set is added to the job's job-state-reasons attribute, and
• the value held is added to the job's current-job-state attribute.
If the job-hold attribute is set to true|yes , it remains on hold indefinitely until one of following events takes place:
• You set the job-hold attribute to false|no
• The job-discard-time that you previously set passes
• You cleaned the associated queue or spooler. The spooler deletes all jobs in the queue or spooler, including jobs in the held state.
Objects Initial-value-job
Job
M/S Single value
Settable Yes
Commands pdcreate, pdset (for initial-value-job objects)
pdmod, pdpr, pdset (for job objects)
Valid values true|yes
false|no
Default value false|no
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 224
ATTRIBUTES
Comments The pdpause and pdresume commands may be used independently of the value of the job-hold attribute.
job-identifier
A spooler-generated value unique to the spooler (not necessarily unique in a distributed environment).
Objects Job
M/S Single value
Settable No
Commands N/A
Valid values Text string of up to 255 characters
Default value No default value
Comments If job start or end sheets are in use via the job-sheets attribute, the value of the job-identifier attribute prints on job start or end sheets.
job-identifier-for-monitor
The job-identifier-for-monitor attribute identifies the job identifier that the Xerox supervisor determined on job submission. The value of this attribute will be shown in a list of jobs on the printer. Also, the query and cancellation channels use the value to compare the Xerox supervisor job identifier with the job identifier on the remote print server or device.
Objects Job
M/S Single value
Settable No
Commands N/A
Valid values See comments
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 225
ATTRIBUTES
Comments Valid values depend on the job submission channel:
• 11795x_lpr job submission channel:
— Valid values are text string (4095 characters max.) in the format:
HostId.SequenceNo.MicroSec.SupervisorName.TimeStamp
• 11794x_lpr and fxops_lpr job submission channels:
— Valid values are text string (32 characters max.) in the format:
HostId.SequenceNo.MicroSec.SupervisorName
Example (given the following values):
HostId = 72308adf (8-byte IP address; in hex)SequenceNo = 123MicroSec = 451333SupervisorName = foo_supTimeStamp = 1997-11-30 11:45:51 pm
For 11795x_lpr :job-identifier-for-monitor =
72308adf.123.451333.foo_sup.514511301111997
For 11794x_lpr and fxops_lpr :job-identifier-for-monitor =72308adf.123.451333.foo_sup
For 11794x_lpr and fxops_lpr submission channels, PrintXchange truncates the SupervisorName if the attribute value exceeds the 32-character maximum.
job-identifier-on-client
The job-identifier-on-client attribute uniquely identifies a job on the client submitting the job. The value of this attribute is assigned by that client.
This attribute is intended for jobs submitted from legacy servers that have their own job-identifer for a job.
Objects Job
M/S Single value
Settable Yes (only at job submission)
Commands pdpr
Valid values Text string of up to 255 characters
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 226
ATTRIBUTES
Comments If a job passes through a chain of servers between the client initiating the job and the output device, the value of this attribute is the value of the job's job-identifer on the immediate upstream server.
job-identifiers-on-device
The job-identifiers-on-device attribute lists the job identifiers used by a remote print server that correspond to the documents of a PrintXchange multi-document job.
Some print servers (for example, an lp/lpr print server) do not recognize document objects. Such print servers recognize each document of a multi-document job as a separate job and therefore assign a job identifier for each document. This attribute serves to collect all of the job identifiers that the remote print server uses for a single PrintXchange multi-document job.
Objects Job
M/S Single value
Settable No
Commands N/A
Valid values Job object identifiers
Default value No default value
Comments This attribute is set by the Xerox supervisor only.
job-message-from-administrator
The job-message-from-administrator attribute supplies a human readable string intended to indicate to users the reason for some action taken on a job.
Objects Job
M/S Single value
Settable Yes
Commands pdmod
pdpr
pdset
Valid values Text string of up to 4095 characters
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 227
ATTRIBUTES
Default value No default value
Comments The -m option can also be used to attach a human readable message to a job. Users can retrieve the message with the pdls command.
The -m option is equivalent to including the job-message-from-administrator attribute with a job.
If job start sheets are in use via the job-sheets attribute, the value of the job-message-from-administrator attribute prints on job start sheets.
job-message-to-operator
The job-message-to-operator attribute carries a message from the end user to the operator to indicate something about the processing of the job. The spooler makes the message available to the operator when it has accepted the job.
Objects Job
Initial-value-job
M/S Single value
Settable Yes
Commands pdpr, pdmod, pdset (for job objects)
pdcreate, pdset (for initial-value-job objects)
Valid values Text string of up to 4095 characters
Default value No default value
Comments
job-name
The job-name attribute supplies a human readable string for a print job. This string may be printed on job start sheets or used in notification and logging messages. If you do not specify a job-name, it defaults to the file name or to the name of the first file in a multi-document job.
Objects Initial-value-job
Job
M/S Single value
Settable Yes
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 228
ATTRIBUTES
Commands pdcreate, pdset (for initial-value-job objects)
pdmod, pdpr (for job objects)
Valid values Text string of up to 255 characters
Default value File name or name of the first file in a multi-document job
Comments If job start or end sheets are in use via the job-sheets attribute, the value of the job-name attribute prints on job start or end sheets.
job-offset
The job-offset attribute specifies the type of offsetting for the job.
Objects Initial-value-job
Job
M/S Single value
Settable Yes
Commands pdcreate, pdset (for initial-value-job objects)
pdmod, pdpr, pdset (for job objects)
Valid values per-job
per-copy
none
Default value none
Comments On job submission, the spooler checks the offset specified for a job against the logical printer's job-offsets-supported attribute. In addition, the spooler checks for a match with the physical printer's job-offsets-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the offset specified for a job after the job was accepted, the spooler again checks the offset specified for a job against the physical printer's job-offsets-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 229
ATTRIBUTES
job-offsets-ready
The job-offsets-ready attribute identifies the offsetting capability ready to be used on this printer.
Objects Printer (physical only)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values per-job
per-copy
none
Default value none
Comments On job submission, the spooler checks the offset specified for a job against the logical printer's job-offsets-supported attribute. In addition, the spooler checks for a match with the physical printer's job-offsets-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the offset specified for a job after the job was accepted, the spooler again checks the offset specified for a job against the physical printer's job-offsets-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
job-offsets-supported
The job-offsets-supported attribute identifies the offsetting capability supported by this printer.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 230
ATTRIBUTES
Valid values per-job
per-copy
none
Default value none
Comments On job submission, the spooler checks the offset specified for a job against the logical printer's job-offsets-supported attribute. In addition, the spooler checks for a match with the physical printer's job-offsets-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the offset specified for a job after the job was accepted, the spooler again checks the offset specified for a job against the physical printer's job-offsets-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
job-originating-host
Contains the name of the host from which the print job originated. The BSD inbound gateway uses this attribute.
Objects Job
M/S Single value
Settable No
Commands N/A
Valid values Text string of up to 255 characters
Default value No default value
Comments If job start sheets are in use via the job-sheets attribute, the value of the job-originating-host attribute prints on job start sheets.
job-originator
The job-originator attribute supplies the name of the human or programmatic originator of the print job.
In many cases, the value of this attribute is the same as job-owner . They may differ when:
• a program submits a print job on behalf of a user
• an operator resubmits a misprinted job on behalf of the original job owner
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 231
ATTRIBUTES
Objects Job
M/S Single value
Settable Yes (only at job submission)
Commands pdpr
Valid values Text string of up to 4095 characters
Default value No default value
Comments You cannot change the value of this attribute with the pdmod or pdset commands.
job-owner
The job-owner attribute supplies the name of the human owner of the print job.
The value of job-owner will often be the same as job-originator . Job-owner is different from job-originator when a job is submitted by the originator on behalf of the owner.
During the authentication process, the spooler determines job ownership with the job-owner attribute.
Objects Job
M/S Single value
Settable Yes (only at job submission)
Commands pdpr
Valid values Text string of up to 4095 characters
Default value No default value
Comments If job start or end sheets are in use via the job-sheets attribute, the value of the job-owner attribute prints on job start or end sheets.
You cannot change the value of this attribute with the pdmod or pdset commands.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 232
ATTRIBUTES
job-page-count
The job-page-count attribute contains the number of source pages in the job that the spooler expects will be imaged.
The spooler computes the value as follows:
1. For each document in the job, multiply the value of the document's page-count attribute by the value of the document's copy-count attribute.
2. Add all results of Step 1 for all documents in the job.
3. For each job-result-set, multiply the result of Step 2 by the value of the job's job-copies attribute.
4. Add all results of Step 3 for all job-result-sets.
Note that the hardcopy output of a job consists of one or more job-result-sets, each of which may be specified to be delivered to, or held for, one particular recipient who is not necessarily the job creator. Each job-result-set may be specified to contain one or more job copies. Each job copy contains one or more copies of each document in the job.
Objects Job
M/S Single value
Settable Yes (only at job submission)
Commands pdpr
Valid values Integer equal to or greater than 0
Default value No default value
Comments The accuracy of the job-page-count value is dependent on the accuracy of the page-count attribute for each document. If some documents have a page-count value of 0, the spooler may set the value of job-page-count to 0 and not use it for scheduling.
job-print-after
The job-print-after attribute specifies the calendar date and time after which the job can be scheduled. If the date is in the future:
• the job's current-job-state is set to held
• job-print-after-specified is added to the job's job-state-reasons
When the specified time has passed:
• the job's current-job-state is set to pending so the job becomes a candidate for being scheduled for printing
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 233
ATTRIBUTES
Objects Initial-value-job
Job
M/S Single value
Settable Yes
Commands pdcreate, pdset (for initial-value-job objects)
pdmod, pdpr, pdset (for job objects)
Valid values Values entered in the format dd:mm:yyyy:HH:MM:SS
Default value No default value
Comments To specify that a job print after 5:00 pm on March 2, 1998, use:
pdpr -x "job-print-after=02:03:1998:17:00:00" [filename]
or
pdmod -x "job-print-after=02:03:1998:17:00:00" [[spooler_name:]jobID
or
pdset -c job -x "job-print-after=02:03:1998:17:00:00" [[spooler_name:]jobID
job-priority
The job-priority attribute specifies a priority for scheduling the print job. A higher value indicates a higher priority. The spooler passes over lower priority jobs in favor of higher priority jobs when scheduling the jobs for printing.
Objects Initial-value-job
Job
M/S Single value
Settable Yes
Commands pdcreate, pdset (for initial-value-job objects)
pdmod, pdpr, pdset (for job objects)
Valid values 1 - 100
(a higher value indicates a higher priority)
Default value See comments
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 234
ATTRIBUTES
Comments The default value for job-priority is determined by the relevant logical printer's default-user-job-priority attribute.
job-promote-time
The job-promote-time attribute identifies the time when the job was promoted.
Objects Job
M/S Single value
Settable No
Commands N/A
Valid values
Default value No default value
Comments
job-query-channel-ready
The job-query-channel-ready attribute identifies the job query channel ready to be used in the Xerox supervisor back end (BE) shared library. The value has to be one of the values in job-query-channels-supported .
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values 1179_lpq
docuprint_xppq
docusp_xppq
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 235
ATTRIBUTES
Comments This attribute applies only to PrintXchange configurations that include Xerox production printers or SNMP-based printers. The value for this attribute is specified in the printer attribute file (paf) for each Xerox production printer.
job-query-channels-supported
The job-query-channels-supported attribute lists the job query channels supported by the Xerox supervisor back end (BE) shared library.
Objects Printer (physical only)
M/S Multi-value
Settable Yes (only at printer creation)
Commands pdcreate
Valid values 1179_lpq
docuprint_xppq
docusp_xppq
xrs_snmp
Default value No default value
Comments This attribute applies only to PrintXchange configurations that include Xerox production printers or SNMP-based printers. The value for this attribute is specified in the printer attribute file (paf) for each Xerox production printer.
job-query-interval
The job-query-interval attribute specifies the minimum amount of time to query the job status periodically.
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 236
ATTRIBUTES
Valid values Values entered in the format [HH:]mm[:SS]
HH = 0 - 99 hours
mm = 0 - 59 minutes
SS = 0 - 59 seconds
Default value 00:01:00 (60 seconds)
Comments Administrators can maximize job flow and improve performance by the values they set for the job-query-interval and device-query-interval attributes. These two attributes determine how frequently PrintXchange queries a device for job or device status.
Each time PrintXchange queries a device, the device slows its job processing cycle to respond to the query. Therefore, frequent queries could noticeably slow job processing at the output device.
The following guidelines may help administrators determine values for job-query-interval and device-query-interval :
• The query interval for a low capacity printer, such as a desktop printer, should be long to avoid affecting the printer performance.
• The query interval may be 0 for a desktop printer that is within sight of the user, since the user can easily see the state of the device.
• The query interval for a high capacity printer depends on the importance of the real time status to the administrator. If real time status is important, a shorter interval is warranted. Otherwise, a longer interval is acceptable.
• The query interval for an SNMP printer may be very long (for example, ten hours), since SNMP printers send asynchronous events to PrintXchange.
It is the administrator's responsibility to determine the interval values for a maximized job flow.
job-query-library-name
The job-query-library-name attribute identifies the name of the Xerox supervisor back end (BE) shared library used to query the job.
Objects Printer (physical only)
M/S Single value
Settable Yes (only at printer creation)
Commands pdcreate
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 237
ATTRIBUTES
Valid values xrssnmp (used for snmp printers)
xppq (used for DocuPrint and DocuTech printers)
xrslpqrm (used for lp/lpr)
Default value No default value
Comments This attribute applies only to PrintXchange configurations that include Xerox production printers or SNMP-based printers. The value for this attribute is specified in the printer attribute file (paf) for each Xerox production printer.
In the Windows NT environment, the xrssnmp value implies the xrssnmp.dll library. The xppq value implies the xppq.dll library. The xrslpqrm value implies the xrslpqrm.dll library.
In the UNIX environment, the xrssnmp value is not applicable. The xppq value implies the libxppq.so library. The xrslpqrm value implies the libxrslpqrm.dll library.
job-result-set-delivery-methods-ready
The job-result-set-delivery-methods-ready attribute identifies the delivery methods ready to be used on this printer for specifying job result sets in the results-profile attribute.
Objects Printer (physical only)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values pick-up
fax
Default value No default value
Comments
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 238
ATTRIBUTES
job-result-set-delivery-methods-supported
The job-result-set-delivery-methods-supported attribute identifies the delivery methods supported by this printer for specifying job result sets in the results-profile attribute.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values pick-up
fax
Default value No default value
Comments Because the job attribute results-delivery-method defaults to pick-up , printers are required to include pick-up as a valid value for job-results-set-delivery-methods-supported .
job-retention-period
The job-retention-period attribute specifies the period of time following completion of a job that the spooler will retain a job, its attributes, and data.
In addition to providing status information to a user after a job has printed, the job-retention-period attribute provides the mechanism for retaining the job's document data after it has been printed. This enables the job to be printed again, possibly with modified attributes.
Objects Initial-value-job
Job
M/S Single value
Settable Yes
Commands pdcreate, pdset (for initial-value-job objects)
pdmod, pdpr, pdset (for job objects)
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 239
ATTRIBUTES
Valid values Values entered in the format [HH:]mm[:SS]
HH = 0 - 99 hours
mm = 0 - 59 minutes
SS = 0 - 59 seconds
Default value No default value
Comments If a job has values set for the attributes job-retention-period and job-completion-period , the job retention period takes place before the job completion period.
Jobs with a job retention period differ from jobs with a job completion period in that, for jobs with a job retention period, the spooler saves the job attributes and data.
If a job has a value specified for its job-discard-time attribute, the spooler sets the job-retention-period to zero when the job-discard-time arrives.
If a job is deleted via the pddelete command, the value of the job-retention-period attribute is ignored and the job is deleted. If a job is canceled via the pdrm command and the job-retention-period attribute has a non-zero value, the job is placed in a retained state.
job-sheets
The job-sheets attribute specifies the auxiliary sheets the supervisor will print with the job.
If you specify a value of job-copy-start , a start sheet prints in front of every copy of the job.
If you specify a value of job-copy-wrap , a start sheet and end sheet prints for every copy of the job.
Objects Initial-value-job
Job
M/S Single value
Settable Yes
Commands pdcreate, pdset (for initial-value-job objects)
pdmod, pdpr, pdset (for job objects)
Valid values none
job-copy-start
job-copy-end
job-copy-wrap
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 240
ATTRIBUTES
Comments The values of the following attributes are printed on a job start sheet:
• job-name
• job-identifier
• job-owner
• job-originating-host
• printer-name-requested
• printers-assigned
• submission-time
• job-comment
• job-message-from-administrator
The values of the following attributes are printed on a job end sheet:
• job-name
• job-identifier
• job-owner
• completion-time (the Xerox supervisor will not show this)
Destination logical and physical printers must contain the specified job's job-sheets value as a value of their job-sheets-supported attribute. The physical printer must also contain the specified job's job-sheets value as a value of its job-sheets-ready attribute.
job-sheets-ready
The job-sheets-ready attribute specifies the auxiliary sheets ready on this printer.
Objects Printer (physical only)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values none
job-copy-start
job-copy-end
job-copy-wrap
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 241
ATTRIBUTES
Comments The job-sheets-ready attribute must contain a value corresponding to the value of the job-sheets attribute of a job to be printed on this printer.
job-sheets-supported
The job-sheets-supported attribute specifies the auxiliary sheets supported by this printer.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values none
job-copy-start
job-copy-end
job-copy-wrap
Default value No default value
Comments The job-sheets-supported attribute must contain a value corresponding to the value of the job-sheets attribute of a job submitted to this printer.
job-state-message
Supplies additional text information about a job's state. The reference supervisor places user-readable text in this attribute when a job is completed with errors or is aborted.
Objects Job
M/S Single value
Settable No
Commands N/A
Valid values
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 242
ATTRIBUTES
Comments
job-state-reasons
The job-state-reasons attribute identifies the reasons that the job is in held, terminating, retained, or completed state. If the job is not in any of these states, this attribute is set to empty.
Objects Job
M/S Multi-value
Settable No
Commands N/A
Valid values Table A-11. job-state-reasons
Default value No default value
Comments If a job's job-print-after attribute is set for a date or time in the future, its job-state-reasons attribute is set to job-print-after-specified .
If a job's job-hold attribute is set to true|yes , its job-state-reasons attribute is set to job-hold-set .
Values
aborted-by-system completed-with-errors
bad-job completed-with-warnings
canceled-by-shutdown documents-needed
printer-unavailable job-hold-set
wrong-printer job-print-after-specified
canceled-by-operator preprint-failed
canceled-by-user successful-completion
cascaded
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 243
ATTRIBUTES
job-status-query-supported
The job-status-query-supported attribute indicates if the printer supports job status query.
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values true|yes
false|no
Default value false|no
Comments
job-submission-channel-ready
The job-submission-channel-ready attribute identifies the job submission channel ready to be used in the Xerox supervisor back end (BE) shared library. The value has to be one of the values in job-submission-channels-supported .
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values 11794_lpr
11795_lpr
docuprint_xppr
docusp_xppr
fxops_lpr
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 244
ATTRIBUTES
Comments This attribute applies only to PrintXchange configurations that include Xerox production printers or SNMP-based printers. The value for this attribute is specified in the printer attribute file (paf) for each Xerox production printer.
job-submission-channels-supported
The job-submission-channels-supported attribute lists the job submission channels supported by the Xerox supervisor back end (BE) shared library.
Objects Printer (physical only)
M/S Multi-value
Settable Yes (only at printer creation)
Commands pdcreate
Valid values 11794_lpr
11795_lpr
docuprint_xppr
docusp_xppr
fxops_lpr
Default value No default value
Comments This attribute applies only to PrintXchange configurations that include Xerox production printers or SNMP-based printers. The value for this attribute is specified in the printer attribute file (paf) for each Xerox production printer.
job-submission-channel-used
The job-submission-channel-used attribute identifies the job submission channel used to submit the job. The Xerox supervisor uses the value to check the compatibility of the job query channel and job cancellation channel.
Objects Job
M/S Single value
Settable No
Commands N/A
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 245
ATTRIBUTES
Valid values 11794_lpr
11795_lpr
docuprint_xppr
docusp_xppr
fxops_lpr
Default value No default value
Comments This attribute applies only to PrintXchange configurations that include Xerox production printers or SNMP-based printers. The value for this attribute is specified in the printer attribute file (paf) for each Xerox production printer.
job-submission-complete
Specifies whether all documents in the print job have been submitted to the spooler, indicating the job has been closed.
Objects Job
M/S Single value
Settable No
Commands N/A
Valid values true|yes
false|no
Default value No default value
Comments
job-submission-library-name
The job-submission-library-name attribute identifies the name of the Xerox supervisor back end (BE) shared library used to submit the job.
Objects Printer (physical only)
M/S Single value
Settable Yes (only at printer creation)
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 246
ATTRIBUTES
Commands pdcreate
Valid values Text string of up to 4095 characters
Default value No default value
Comments This attribute applies only to PrintXchange configurations that include Xerox production printers or SNMP-based printers. The value for this attribute is specified in the printer attribute file (paf) for each Xerox production printer.
job-submission-timeout
The job-submission-timeout attribute defines the period after which, if there is no activity reported on the job (that is, no more documents added or the job is not closed), the spooler closes the job and places it in the held state. After the job-submission-timeout period elapses, the spooler cannot add more documents to the job.
If the timeout period elapses before the spooler has added any documents to the job (that is, the spooler has created the job but the job has zero documents), the spooler aborts the job.
If the attribute value set is 0, the job remains open indefinitely until the spooler receives the client request to close the job.
Objects Job
M/S Single value
Settable Yes (only at job submission)
Commands pdpr
Valid values Values entered in the format [HH:]mm[:SS]
HH = 0 - 99 hours
mm = 0 - 59 minutes
SS = 0 - 59 seconds
00:00:00 denotes infinity (keep the job open forever)
Default value No default value (see comments)
Comments There is no attribute default. However, the PrintXchange system defaults its behavior to 00:20:00 (1200 seconds).
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 247
ATTRIBUTES
job-to-be-billed
The job-to-be-billed attribute specifies the department or group to be charged for the job.
Objects Initial-value-job
Job
M/S Single value
Settable Yes
Commands pdcreate, pdset (for initial-value-job objects)
pdmod, pdpr, pdset (for job objects)
Valid values Text string of up to 4095 characters
Default value No default value
Comments
jobs-pending
The jobs-pending attribute specifies the number of outstanding jobs in the queue. Outstanding jobs are jobs with a current-job-state value of pending , held , and paused .
Objects Queue
Printer (logical only)
M/S Single value
Settable No
Commands N/A
Valid values Integer equal to or greater than 0
Default value No default value
Comments
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 248
ATTRIBUTES
left-margin
The left-margin attribute provides you with more control over the placement of text in a document with simple-text format. Specifically, the attribute specifies the distance in characters between the left edge of the logical page and the left edge of the text area when held in the intended reading position.
(Some document formats, such as PostScript, specify the margin as part of the document content; simple-text does not.)
Figure A-3. left-margin
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values Minus-infinity to plus-infinity
(may be a non-integer value)
Default value No default value
Comments The value left-margin=12 specifies a left margin of twelve characters.
Because of its use with simple-text format, left-margin is typically part of a simple-text translation filter as defined with the attribute preprocessor-definition .
left-margin
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 249
ATTRIBUTES
length
The length attribute provides you with more control over the placement of text in a document with simple-text format. Specifically, the attribute specifies the length of the text area in characters.
(Some document formats, such as PostScript, specify the length as part of the document content; simple-text does not.)
Figure A-4. length
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values Minus-infinity to plus-infinity
(may be a non-integer value)
Default value No default value
Comments The value length=60 specifies a text area length of sixty lines.
Because of its use with simple-text format, length is typically part of a simple-text translation filter as defined with the attribute filter-definition .
text area length
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 250
ATTRIBUTES
list-of-managers
The list-of-managers attribute lists the managers responsible for the maintenance of the object. The attribute can identify individuals who can resolve problems.
Objects Initial-value-document
Initial-value-job
Printer (logical and physical)
Queue
Server (spooler and supervisor)
M/S Multi-value
Settable Yes
Commands pdcreate, pdset (for initial-value-document, initial-value-job, printer, and queue objects)
pdset (for server objects)
Valid values Text string of up to 4095 characters
Default value No default value
Comments
loa-abort-operations
The loa-abort-operations attribute contains the total number of list object attributes (loa) abort operations that have taken place since the server was last started.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable No
Commands N/A
Valid values
Default value No default value
Comments
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 251
ATTRIBUTES
loa-cont-operations
The loa-cont-operations attribute contains the total number of list object attributes (loa) continuation operations that have taken place since the server was last started.
On listing object attributes with a count or time limit (as specified with attributes cfg-loa-count-limit and cfg-loa-time-limit ), the server returns the first set of object attributes via loa-operations . An loa continuation operation returns sets of object attributes subsequent to the count or time limit.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable No
Commands N/A
Valid values
Default value No default value
Comments List object attributes continuation operations take place as part of the pdls command.
loa-operations
The loa-operations attribute contains the total number of list object attributes (loa) operations that have taken place since the server was last started.
See the description for loa-cont-operations for additional information.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable No
Commands N/A
Valid values
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 252
ATTRIBUTES
Comments List object attributes operations take place when invoking the pdls command.
The loa-operations attribute lists the total loa operations as well as the number of loa operations on each object. For example:
locale
Contains a locale specification that the server uses when performing internationalization tasks such as constructing error/notification/logging messages. It is set by the server from the locale environment variable.
Objects Server (spooler and supervisor)
M/S Single value
Settable No
Commands N/A
Valid values
Default value No default value
Comments
locales-supported
Contains the list of locales supported by the server. It is set when the server's database is created.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable No
Commands N/A
loa-operations=10server:2queue:2job:2document:2initial-value-document:2
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 253
ATTRIBUTES
Valid values
Default value No default value
Comments
logical-printers-ready
Identifies the enabled logical printers associated with this queue or spooler; it is empty on a supervisor. This attribute is updated whenever a logical printer is enabled or disabled.
Objects Queue
Server (spooler only)
M/S Multi-value
Settable No
Commands N/A
Valid values Text string of up to 4095 characters
Default value No default value
Comments
logical-printers-supported
Lists all logical printers associated with a particular queue or spooler, regardless of whether the logical printers are enabled or disabled.
This attribute is updated when a logical printer is created or deleted and when the associated-queue attribute of a logical printer is set (either by pdset or, implicitly, by pdcreate).
Objects Queue
Server (spooler only)
M/S Multi-value
Settable No
Commands N/A
Valid values Text string of up to 4095 characters
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 254
ATTRIBUTES
Default value No default value
Comments
max-concurrent-job-processing
The max-concurrent-job-processing attribute indicates the maximum number of jobs that this output device can process.
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values Integer equal to or greater than 0
Default value The default value is specified in the printer attribute files (paf) for applicable printers.
Comments The Xerox supervisor provides load balancing based on the number of jobs that users claim the output device can process concurrently. Administrators specify the maximum number of jobs that a device can process concurrently with the physical printer attribute max-concurrent-job-processing .
The document processor uses the values of max-concurrent-job-processing and number-job-on-device to determine whether or not to request a job (via the front end) from the spooler. The spooler does not send a job to a supervisor without first receiving a job request from the supervisor.
On a job status query, the back end determines, if possible, the number of jobs queued on the device (including non-PrintXchange jobs) and sets the value of number-job-on-device . The document processor compares the value of number-job-on-device with the value of max-concurrent-job-processing .
• If number-job-on-device is less than max-concurrent-job-processing , the document processor requests another job from the spooler (via the front end). Note that this applies if the device is in a state capable of processing the job.
• If number-job-on-device is equal to or greater than max-concurrent-job-processing , the document processor does not request another job.
Note, however, that the value of max-concurrent-job-processing for a specific physical printer should account for jobs that other physical printers (or non-PrintXchange systems) are sending to the same output device.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 255
ATTRIBUTES
For example: A Xerox DocuTech 6135 may process up to 50 jobs at a time. If two physical printers are associated with the same DocuTech 6135 and if a non-PrintXchange system also feeds jobs into the DocuTech 6135, then the sum of jobs from all sources should be no more than 50.
The specific value used for max-concurrent-job-processing depends on the relative load expected from the source physical printer. If the two PrintXchange physical printers are expected to carry 80% of the load, then the value of max-concurrent-job-processing for each might be 20 if the load is expected to be evenly distributed between them:
• For physical printer 1, max-concurrent-job-processing=20
• For physical printer 2, max-concurrent-job-processing=20
• For the non-PrintXchange source, 10
In this example, if one physical printer is expected to carry a greater load than the other, then the load distribution might be:
• For physical printer 1, max-concurrent-job-processing=10
• For physical printer 1, max-concurrent-job-processing=30
• For the non-PrintXchange source, 10
The sum of jobs from all sources remains no more than 50, the capacity of the DocuTech 6135 in the example.
It is the administrator's responsibility to determine the relative load from each job source for an output device.
max-number-of-system-logs
The max-number-of-system-logs attribute specifies the maximum number of logs that are to be present. If the maximum is reached, the server will delete the oldest log.
Objects Server (spooler and supervisor)
M/S Single value
Settable Yes
Commands pdset
Valid values Integer equal to or greater than 0
Default value 0
Comments The value 0 indicates to keep all service logs. This attribute is ignored if stdout , stderr , or syslog is the value set for the system-log-file-path attribute.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 256
ATTRIBUTES
max-user-job-priority
The max-user-job-priority attribute indicates the maximum value that end users may set for the job-priority attribute (administrators and operators may use the full range of job-priority values).
Objects Printer (logical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values 1 - 100
(a higher value indicates a higher priority)
Default value 50
Comments The spooler uses the value of max-user-job-priority divided by two to set the default value of default-user-job-priority if the user does not set default-user-job-priority on printer creation, or if the user removes the value (by using the - = operator with pdset) or resets to default (by using the = = operator with pdset).
An error occurs if the user attempts to set max-user-job-priority to a value less than the value set for default-user-job-priority .
maximum-copies-supported
The maximum-copies-supported attribute indicates the maximum number of copies of a document that can be printed on this printer.
The product of job-copies and copy-count should not exceed the value of the logical printer’s maximum-copies-supported attribute. If it does, the spooler rejects the job.
Objects Printer (logical and physical)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values Integer equal to or greater than 0
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 257
ATTRIBUTES
Default value No default value
Comments A value of zero or empty means no limit.
maximum-number-of-printers-supported
Specifies how many actual printers the supervisor will drive. Attempts to create physical printers on the supervisor after this limit has been met will fail.
Objects Server (supervisor only)
M/S Single value
Settable No
Commands N/A
Valid values Integer equal to or greater than 0
Default value 300 (Xerox supervisor)
50 (Reference supervisor)
Comments The value for this attribute is set by the system at startup.
The maximum number of printers possible is a software imposed upper limit. A practical maximum number of printers and the number of supervisors to handle the printers depends on many factors, including:
• Frequency of use of the printers. For example, 30 printers constantly used throughout the day may be best served by three supervisors handling 10 printers each, whereas 50 printers rarely used at the same time could well be served by a single supervisor.
• CPU speed and system memory.
• System disk speed and system disk sizes.
• Network speed, number of users on the system, and the required response time of users on the system.
• Printer availability requirements, system cost, and total printers to be serviced.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 258
ATTRIBUTES
maximum-printer-speed
The maximum-printer-speed attribute specifies the maximum speed of the printer. The values of this attribute are expressed in simplex pages per minute (to the nearest integer value).
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values Integer greater than 0
Default value No default value
Comments
media-consumed
The media-consumed attribute contains information (for billing purposes) for each medium consumed for the job. The information includes:
• Type of color print (black-and-white, highlight-colour, or full-color)
• Medium size
• Number of impressions
• Number of media sheets
Objects Job
M/S Single value
Settable No
Commands N/A
Valid values
Default value No default value
Comments
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 259
ATTRIBUTES
media-ready
The media-ready attribute identifies the media currently ready to be used on this printer.
Objects Printer (physical only)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values See default-medium
Default value No default value
Comments On job submission, the spooler checks the medium specified for a document against the logical printer's media-supported attribute. In addition, the spooler checks for a match with the physical printer's media-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the medium specified for a document after the job was accepted, the spooler again checks the medium specified for a document against the physical printer's media-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
media-sheets-completed
The media-sheets-completed attribute indicates the total number of sheets of media that the printer completed printing for the job, including repeated pages due to multiple copies. The value of the attribute is 0 if printing has not started on the job.
Objects Job
M/S Single value
Settable No
Commands N/A
Valid values Integer equal to or greater than 0
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 260
ATTRIBUTES
Comments
media-supported
The media-supported attribute identifies the media supported by the printer
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values See default-medium
Default value No default value
Comments On job submission, the spooler checks the medium specified for a document against the logical printer's media-supported attribute. In addition, the spooler checks for a match with the physical printer's media-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the medium specified for a document after the job was accepted, the spooler again checks the medium specified for a document against the physical printer's media-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
message
The message attribute supplies a human readable string intended to indicate to users something about an object's state. This attribute may be used to indicate to users why an object is unavailable or when it is expected to be ready.
Objects Initial-value-document
Initial-value-job
Printer (logical and physical)
Queue
Server (spooler and supervisor)
M/S Single value
Settable Yes
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 261
ATTRIBUTES
Commands pdcreate, pdset (for initial-value-document, printer, queue, and server objects)
pdcreate (for initial-value-job objects)
Valid values Text string of up to 4095 characters
Default value No default value
Comments The -m option can also be used to attach a human readable message to a job. Users can retrieve the message with the pdls command.
The -m option is equivalent to including the message attribute with initial-value-document, initial-value-job, printer, queue, and server objects.
mib-library-name
The mib-library-name attribute identifies the name of the library used by the SNMP status monitoring feature. The Xerox supervisor refers to this value to determine the library to load.
Objects Printer (physical only)
M/S Single value
Settable Yes (only at printer creation)
Commands pdcreate
Valid values fx1759mm
fxopsmm
fxlwomm
Default value No default value
Comment This attribute only applies to PrintXchange configurations that include SNMP based printers.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 262
ATTRIBUTES
mib-type
The mib-type attribute identifies the type of MIB database that the printer has. This value should correspond to the MIB library whose name is given for the attribute mib-library-name .
Objects Printer (physical only)
M/S Single value
Settable Yes (only at printer creation)
Commands pdcreate
Valid values fx-ops
rfc-1759
xerox-common
Default value No default value
Comments This attribute only applies to PrintXchange configurations that include SNMP based printers.
modify-individual-document-supported
Indicates whether a server is capable of modifying individual documents in a multiple document job.
Objects Server (spooler and supervisor)
M/S Single value
Settable No
Commands N/A
Valid values true|yes
false|no
Default value true|yes
Comments The value for this attribute is set by the system at startup. The default value for this attribute is true|yes, meaning a user can modify individual documents in a multi-document job via the pdmod command.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 263
ATTRIBUTES
modify-job-operations
The modify-job-operations attribute contains the total number of modify job object operations that have taken place since the spooler was last started.
Objects Server (spooler only)
M/S Multi-value
Settable No
Commands N/A
Valid values
Default value No default value
Comments Modify job operations take place when invoking the pdmod command.
multiple-documents-supported
Indicates if the object is capable of handling multiple document jobs.
Objects Server (spooler and supervisor)
M/S Single value
Settable No
Commands N/A
Valid values true|yes
false|no
Default value true|yes
Comments The value for this attribute is set by the system at startup.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 264
ATTRIBUTES
native-document-formats-ready
The native-document-formats-ready attribute identifies the document formats supported directly by printer hardware.
Objects Printer (physical only)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values The native-document-formats-ready attribute contains three elements, two of which are optional. Values must be entered differently for each element, according to the table below. In addition, curly braces must be used when entering values, as in the following:
{document-format document-format-variants document-format-version}
Table A-12. native-document-formats-ready elements
Element Value range
document-format (See list of valid values)
document-format-variants (optional) Text string of up to 4095 characters
document-format-version (optional) Text string of up to 255 characters
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 265
ATTRIBUTES
Table A-13. document-format values
Default value No default value
Comments
Values
201PL fortran Pinwriter
ART HPGL PJL
automatic IGP plot
CaPSL imPRESS PostScript
CCITT Interpress PPDS
cif IPDS PSPrinter
CodeV ISO6429 QUIC
CPAP LCDS raster
DDIF line-data ReGIS
DEC-PPL LIPS SCS
Diagnostic LN03 simple-text
ditroff MODCA SPDL
DOC NPAP Tek4014
DPC NPDL TIFF
DSC-DSE other troff
dvi PAGES unknown
Epson PCL WPL
EscapeP PCL-XL WPS
EXCL PDS XES
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 266
ATTRIBUTES
no-preprocessing
The no-preprocessing attribute disables preprocessing of a document on a spooler and supervisor.
Objects Document
Initial-value-document
Printer (logical and physical)
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document and printer objects)
Valid values true|yes
false|no
Default value No default value
Comments
notification-delivery-methods-ready
Identifies the delivery methods ready on this server for event notification.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable No
Commands N/A
Valid values For Windows NT:
electronic-mail
ms-mail
notification-service (for cross-platform support only)
smtp-mail
socket-event
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 267
ATTRIBUTES
For UNIX:
electronic-mail
notification-service
smtp-mail
socket-event
Default value No default value
Comments The value for this attribute is set by the system at startup.
notification-delivery-methods-supported
Identifies the delivery methods supported on this object for event notification.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable No
Commands N/A
Valid values For Windows NT:
electronic-mail
ms-mail
notification-service (for cross-platform support only)
smtp-mail
socket-event
For UNIX:
electronic-mail
notification-service
smtp-mail
socket-event
Default value No default value
Comments The value for this attribute is set by the system at startup.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 268
ATTRIBUTES
notification-profile
Specifies the events on whose occurrence users will be notified. Also specifies how the notifications are to be delivered.
Objects Job
Printer (logical and physical)
Queue
Server (spooler and supervisor)
M/S Multi-value
Settable Yes
Commands pdmod, pdpr, pdset (for job objects)
pdcreate, pdset (for printer, queue, and server objects)
Valid values The notification-profile attribute contains five elements, all of which are optional. Values must be entered differently for each element, according to the table below.
Although all five elements are optional, if delivery-address is specified, then delivery-method must also be specified. The delivery-method and delivery-address components may also be specified by setting them explicitly with the -x flag. For example:
-x "notification-profile=email:[email protected]"
Table A-14. notification-profile elements
Element Value range
event-identifiers (optional) (Refer to Appendix D, Events)
delivery-method (optional) On UNIX servers:
smtp-mail or CLI alias email
notification-service or CLI alias message (Default)
socket-event
On Windows NT servers:
smtp-mail or CLI alias email
ms-mail
socket-event or CLI alias message
notification-service (for cross-platform support only)
Both the UNIX and the Windows NT platforms support the delivery method electronic-mail for PrintXchange 1.0 backward compatibility. The notification server handles the electronic-mail delivery method in the same way as smtp-mail .
event-comment (optional) 4095 characters maximum
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 269
ATTRIBUTES
Default value No default value
delivery-address (optional) For smtp-mail (email or electronic-mail ), the format for the address is:
<user>@<mail domain name>
For example, "[email protected]"
On UNIX, if no address is specified for smtp-mail , the current user is the default
On Windows NT, there is no default address for smtp-mail . The user must provide an appropriate delivery-address in the command line.
On Windows NT, for ms-mail notification, the format for the address is:
<Network>/<Postoffice>/<Mailbox>
For example, "Windows/PXCAdmin/PXCAdmin"
There is no default address for ms-mail . The user must provide an appropriate delivery-address in the command line.
For notification-service , the format for the address is:
"<ip address>" or the host name
For example, "13.1.97.25" or "huffalump"
On UNIX, if no address is specified for notification-service , the local host (current node) is the default.
On Windows NT, there is no default address for notification-service . The user must provide an appropriate delivery-address in the command line.
This address type is only for cross-platform support to allow a UNIX system to receive notification.
On Windows NT, for socket-event (message ) notification, the format for the address is:
"<host name>:<port>" or "<ip address>:<port>"
For example, "galiolus:2000" or "13.240.96.194:2000"
There is no default address for socket-event . The user must provide an appropriate delivery-address in the command line.
locale (optional) ---
Element Value range
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 270
ATTRIBUTES
Comments Only administrators can specify notification-profile for printer, queue, and server objects as part of the create (pdcreate/pdpr) or set attribute (pdset/pdmod) commands. End users can specify notification-profile for a job at job submission time via the pdpr command.
Example:-x "notification-profile +={event-identifiers=aborted state-changed-serverdelivery-method=smtp-mailevent-comment='Something\'s up'delivery-address=gbrown@ospreylocale=en_US.ASCII}"
Events can be specified by class, by specific events, or both. If the notification-profile attribute specifies a class, the corresponding notification service reports all events of that class. Refer to Appendix D for a list of classes and events.
In-depth use of the notification-profile attribute is geared for the PrintXchange administrator. For more detailed information on using the notification-profile attribute, refer to the PrintXchange System Administration and Operations Guide.
number-job-on-device
The number-job-on-device attribute indicates the number of jobs that are currently pending in the print server or the output device. Note that this number includes jobs not submitted via PrintXchange.
Objects Printer (physical only)
M/S Single value
Settable No
Commands N/A
Valid values Integer equal to or greater than 0
Default value No default value
Comments The Xerox supervisor provides load balancing based on the number of jobs that users claim the output device can process concurrently. Administrators specify the maximum number of jobs that a device can process concurrently with the physical printer attribute max-concurrent-job-processing .
The document processor uses the values of max-concurrent-job-processing and number-job-on-device to determine whether or not to request a job (via the front end) from the spooler. The spooler does not send a job to a supervisor without first receiving a job request from the supervisor.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 271
ATTRIBUTES
On a job status query, the back end determines, if possible, the number of jobs queued on the device (including non-PrintXchange jobs) and sets the value of number-job-on-device . The document processor compares the value of number-job-on-device with the value of max-concurrent-job-processing .
• If number-job-on-device is less than max-concurrent-job-processing , the document processor requests another job from the spooler (via the front end). Note that this applies if the device is in a state capable of processing the job.
• If number-job-on-device is equal to or greater than max-concurrent-job-processing , the document processor does not request another job.
Note, however, that the value of max-concurrent-job-processing for a specific physical printer should account for jobs that other physical printers (or non-PrintXchange systems) are sending to the same output device.
For example: A Xerox DocuTech 6135 may process up to 50 jobs at a time. If two physical printers are associated with the same DocuTech 6135 and if a non-PrintXchange system also feeds jobs into the DocuTech 6135, then the sum of jobs from all sources should be no more than 50.
The specific value used for max-concurrent-job-processing depends on the relative load expected from the source physical printer. If the two PrintXchange physical printers are expected to carry 80% of the load, then the value of max-concurrent-job-processing for each might be 20 if the load is expected to be evenly distributed between them:
• For physical printer 1, max-concurrent-job-processing=20
• For physical printer 2, max-concurrent-job-processing=20
• For the non-PrintXchange source, 10
In this example, if one physical printer is expected to carry a greater load than the other, then the load distribution might be:
• For physical printer 1, max-concurrent-job-processing=10
• For physical printer 1, max-concurrent-job-processing=30
• For the non-PrintXchange source, 10
The sum of jobs from all sources remains no more than 50, the capacity of the DocuTech 6135 in the example.
It is the administrator's responsibility to determine the relative load from each job source for an output device.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 272
ATTRIBUTES
number-of-documents
Indicates the number of documents in the job.
Objects Job
M/S Single value
Settable No
Commands N/A
Valid values Integer equal to or greater than 0
Default value No default value
Comments
number-of-printers-supported
The number-of-printers-supported attribute specifies the number of printers the supervisor controls.
This attribute allows a system administrator to set the number of printers per supervisor to a number lower than that specified via the maximum-number-of-printers-supported attribute.
Objects Server (supervisor only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values Integer equal to or greater than 0
Default value No default value
Comments Attempts to set the value of number-of-printers-supported to a value exceeding the limit set by maximum-number-of-printers-supported will fail.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 273
ATTRIBUTES
number-pages
The number-pages attribute provides you with more control over the placement of text in a document with simple-text format. Specifically, this attribute indicates whether to print page numbers on a document’s logical pages.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values true|yes
false|no
Default value No default value
Comments Because of its use with simple-text format, number-pages is typically part of a simple-text translation filter as defined with the attribute preprocessor-definition .
number-up
The number-up attribute specifies the number of page images to impose on a single instance of a selected medium.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values none (or 0)
simple-1-up (or 1)
simple-2-up (or 2)
simple-4-up (or 4)
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 274
ATTRIBUTES
Default value No default value
Comments An empty attribute value is the same as a value of none or 0.
Together with a document's orientation, number-up controls the translation, scaling, and rotation of page images. Content orientation refers to the orientation of the actual print data, given the relative dimensions of the area for the page image on the medium. Portrait orientation specifies that, from a human reader's point of view, the height of the image area is longer than the width; in landscape orientation, the width is longer than the height.
For example: For 8-1/2-inches wide x 11-inches high media and with number-up=2 in portrait orientation, the image area for the medium is divided into two along the short axis and then rotated 90 degrees or 270 degrees, such that two page images appear side by side. The height of each image area is longer than the width. The physical orientation of the medium, however, has a landscape orientation (11-inches wide x 8-1/2-inches high).
For number-up=2 in landscape orientation, the image area is also divided into two along the short axis but with no rotation (or 180 degree rotation), such that the two image areas appear one on top of the other. The height of each image area is shorter than the width. The physical orientation of the medium has a portrait orientation (8-1/2-inches wide x 11-inches high).
numbers-up-supported
The numbers-up-supported attribute identifies the number-up values supported by this printer.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values none (or 0)
simple-1-up (or 1)
simple-2-up (or 2)
simple-4-up (or 4)
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 275
ATTRIBUTES
Comments An empty attribute value is the same as a value of none or 0.
Though you may enter name or cardinal values, the server considers them to be separate values. For example, the server considers simple-2-up and 2 to be different values. Therefore, a printer must be configured to support both value representations for the following settings to be equivalent:
numbers-up-supported=1 2 4
numbers-up-supported=simple-1-up simple-2-up simple-4-up
When a printer is configured to support cardinal values, you may enter a cardinal value range such as:
numbers-up-supported=1:4
object-class
Identifies the object class for this object.
Objects Document
Initial-value-document
Initial-value-job
Job
Printer (logical and physical)
Queue
Server (spooler and supervisor)
M/S Single value
Settable No
Commands N/A
Valid values
Default value No default value
Comments
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 276
ATTRIBUTES
object-classes-supported
Identifies the object classes supported by this server.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable No
Commands N/A
Valid values
Default value No default value
Comments
octet-count
Specifies the size of the document in bytes.
Objects Document
M/S Single value
Settable No
Commands N/A
Valid values
Default value No default value
Comments
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 277
ATTRIBUTES
original-document-format
The original-document-format attribute identifies the data syntax used to encode the final printed form of a document. It is set by the spooler when a document is received. This attribute is useful if the document goes through preprocessing which may change the document-format attribute.
Objects Document
M/S Single value
Settable No
Commands N/A
Valid values The original-document-format attribute contains three elements, two of which are optional.
Table A-15. original-document-format elements
Element Value range
document-format (See list of valid values)
document-format-variants (optional) Text string of up to 4095 characters
document-format-version (optional) Text string of up to 255 characters
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 278
ATTRIBUTES
Table A-16. original-document-format values
Default value No default value
Comments
Values
201PL HPGL PJL
ART IGP plot
automatic imPRESS PostScript
CaPSL Interpress PPDS
CCITT IPDS PPT
cif ISO6429 PSPrinter
CodeV LCDS QUIC
CPAP line-data raster
DDIF LIPS ReGIS
DEC-PPL LN03 SCS
Diagnostic MODCA simple-text
ditroff MS-Word SPDL
DOC NPAP Tek4014
DSC-DSE NPDL TIFF
dvi other troff
Epson PAGES unknown
EscapeP PCL WPL
ESCPage PCL-XL WPS
EXCEL PDF XES
EXCL PDS
fortran Pinwriter
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 279
ATTRIBUTES
output
The output attribute identifies the output processing for the media on which the document is to be printed.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values page-collate
no-page-collate
Default value No default value
Comments The page-collate value specifies that the pages of the document are to be in sequence when multiple copies of the document are requested. For example, if 3 copies are requested, one copy of page one is printed, then one copy of page two, then one copy of page three, etc.
The no-page-collate value specifies that the copies of the pages of a document are to follow one another when multiple copies of the document are requested. For example, if 3 copies are requested, three copies of page 1 are printed, then three copies of page 2, etc.
Using the value named default causes the job to use the default output type specified by the physical printer device.
On job submission, the spooler checks the output specified for a document against the logical printer's outputs-supported attribute. In addition, the spooler checks for a match with the physical printer's outputs-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the output specified for a document after the job was accepted, the spooler again checks the output specified for a document against the physical printer's outputs-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 280
ATTRIBUTES
output-bin
The output-bin client attribute specifies the printer output bin into which the job is placed.
Objects Initial-value-job
Job
M/S Single value
Settable Yes
Commands pdcreate (for initial-value-job objects)
pdpr (for job objects)
Valid values Table A-17. output-bin
Default value No default value
Comments The output-bin client attribute is part of the results-profile attribute. The results-profile attribute is supported but is not visible to the user. Its value is specified via the job-copies , output-bin , results-delivery-method , results-set-comment , and results-delivery-address attributes.
The mailbox- n and stacker- n values apply only to Fuji Xerox printers.
Values
1234567891011121314151617181920
2122232425bottomcentercollatorface-downface-uplargeleftmailbox-1mailbox-2mailbox-3mailbox-4mailbox-5mailbox-6mailbox-7mailbox-8
mailbox-9mailbox-10mailbox-11mailbox-12mailbox-13mailbox-14mailbox-15mailbox-16mailbox-17mailbox-18mailbox-19mailbox-20middleprivaterightsidestacker-1stacker-2stacker-3top
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 281
ATTRIBUTES
output-bin-sorter-available-count
The output-bin-sorter-available-count attribute specifies the number of available bins in the sorter.
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pdcreate, pdset
Valid values Integer equal to or greater than 0
Default value 1
Comments Only administrators may change the value of this attribute.
output-bins-ready
The output-bins-ready attribute identifies the output bins ready to be used on this printer. The value of this attribute may be an OID, a name, or a number.
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values See output-bin
Default value No default value
Comments The output-bins-ready attribute must contain a value corresponding to the value of the output-bin attribute of a job to be printed on this printer.
Although this attribute is single-valued, it behaves like a multi-valued attribute. This attribute can contain more than one value. Users can add or remove values using the - = and + = set pdset operators.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 282
ATTRIBUTES
output-bins-supported
The output-bins-supported attribute identifies the output bins supported on this printer. The value of this attribute may be an OID, a name, or a number.
Objects Printer (logical and physical)
M/S Single value
Settable Yes
Commands pcreate
pdset
Valid values See output-bin
Default value No default value
Comments The output-bins-supported attribute must contain a value corresponding to the value of the output-bins attribute of a job submitted to this printer.
Although this attribute is single-valed, it behaves like a multi-valued attribute. This atribute can contain more than one value. Users can add or remove values using the - = and + = set pdset operators.
outputs-ready
The outputs-ready attribute identifies the output methods currently ready to be used on this printer.
Objects Printer (physical only)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values page-collate
no-page-collate
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 283
ATTRIBUTES
Comments On job submission, the spooler checks the output specified for a document against the logical printer's outputs-supported attribute. In addition, the spooler checks for a match with the physical printer's outputs-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the output specified for a document after the job was accepted, the spooler again checks the output specified for a document against the physical printer's outputs-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
outputs-supported
Identifies the output methods currently supported on this printer.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values page-collate
no-page-collate
Default value No default value
Comments On job submission, the spooler checks the output specified for a document against the logical printer's outputs-supported attribute. In addition, the spooler checks for a match with the physical printer's outputs-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the output specified for a document after the job was accepted, the spooler again checks the output specified for a document against the physical printer's outputs-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 284
ATTRIBUTES
page-count
The page-count attribute specifies the size of the document in pages. The value is the number of pages in the source document that will be imaged. In computing page-count , the spooler ignores any document copies (it uses the value copy-count=1 ).
The value may be smaller than the actual number of pages in the source document if the user specifies the page-select document attribute.
Objects Document
M/S Single value
Settable Yes
Commands pdpr
pdmod
pdset
Valid values Integer equal to or greater than 0
Default value No default value
Comments The spooler uses page-count to compute job-page-count . The NT transparent client sets this value when submitting print requests.
page-media-select
The page-media-select attribute indicates that the specified pages will be printed on the identified media. Any page not specified in this attribute will be printed as per the default-media attribute.
PrintXchange supports this attribute only for certain printers.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 285
ATTRIBUTES
Comments Available media is set via the input-trays-medium attribute, provided the PrintXchange administrator sets this attribute.
page-order-received
The page-order-received attribute specifies the page order for pages in the document that have been formatted.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values unknown
first-to-last (the order normally viewed by a reader)
last-to-first (reverse order)
Default value No default value
Comments The Xerox supervisor supports this attribute for Xerox DocuPrint and DocuTech printers only. It is mainly used to print documents in reverse order. This attribute applies to PostScript files only.
page-select
The page-select attribute specifies one or more sequences of pages to be printed.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for intial-value-document objects)
Valid values Integer greater than 0
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 286
ATTRIBUTES
Default value No default value
Comments You may enter page identifiers only in positive integer values:
• Numeric (positive integer values - numbers greater than 0) to specify the nominal page number identifying the in-sequence number in the document in the order that the pages are presented to the spooler, starting with 1.
Examples:
page-select=15
page-select=15:21
PrintXchange ignores values other than positive integer values.
pages-completed
The pages-completed attribute indicates the total number of pages of the job that the printer has completed printing, including repeated pages due to multiple copies. The value for this attribute is 0 if printing has not started for the job.
Objects Job
M/S Single value
Settable No
Commands N/A
Valid values No default value
Default value
Comments
pause-job-operations
The pause-job-operations attribute contains the total number of pause job operations that have taken place since the spooler was last started.
Objects Server (spooler only)
M/S Multi-value
Settable No
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 287
ATTRIBUTES
Commands N/A
Valid values
Default value No default value
Comments Pause job operations take place when invoking the pdpause command for a job.
pause-operations
The pause-operations attribute contains the total number of pause object (other than job object) operations that have taken place since the server was last started.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable No
Commands N/A
Valid values
Default value No default value
Comments The pause-operations attribute lists the total pause operations as well as the number of pause operations on each object. For example:
physical-printers-ready
Identifies the enabled physical-printers associated with this object. On a spooler, it refers to physical printers that are associated with all the spooler's queues. On a supervisor, it refers to all the supervisor's printers. On a queue, it refers to printers associated with the queue. This attribute is only used for scheduling on queues. It is maintained by the system and updated when physical printers are enabled/disabled.
Objects Queue
Server (spooler and supervisor)
pause-operations=6server:4queue:2
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 288
ATTRIBUTES
M/S Multi-value
Settable No
Commands N/A
Valid values Text string of up to 4095 characters
Default value No default value
Comments
physical-printers-requested
The physical-printers-requested attribute identifies the physical printer or printers that can be the only candidates for printing the job.
Objects Initial-value-job
Job
M/S Multi-value
Settable Yes
Commands pdcreate, pdset (for initial-value-job objects)
pdmod, pdpr, pdset (for job objects)
Valid values Text string of up to 255 characters
Default value No default value
Comments The destination logical printer must contain the specified job's physical-printers-requested values as values of its physical-printers-supported attribute.
You can list the physical printers associated with a specific queue by entering:
pdls -c queue -r verbose <queue_name>
PrintXchange does not check a physical printer object’s access-control-list when users specify physical-printers-requested on a print submision (pdpr).
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 289
ATTRIBUTES
physical-printers-supported
Identifies the physical-printers supported on this object. See physical-printers-ready .
Objects Queue
Server (spooler and supervisor)
M/S Multi-value
Settable No
Commands N/A
Valid values Text string of up to 4095 characters
Default value No default value
Comments
plex
The plex attribute indicates whether the page images should be conditioned for eventual one or two sided printing. In other words, printing that will take into account extra space for binding margins.
The attribute also specifies whether the relative orientation between consecutive page images is to be altered (as with tumble , or head-to-toe printing).
PrintXchange supports this attribute only for certain printers. Ask your system administrator for details.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values simplex
duplex
tumble
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 290
ATTRIBUTES
Comments Destination logical and physical printers must contain the specified document's plex value as a value of their plexes-supported attribute.
Duplex and tumble imply two-sided printing. The difference between the two is (for portrait or landscape orientation):
• For duplex , the binding edge is parallel to the y-axis
• For tumble , the binding edge is parallel to the x-axis
The figure below illustrates the difference between plex and tumble two-sided printing.
Figure A-5. plex
Back Side Front Side
Binding edge on right
Binding edge on left
y=o y=0
Duplex(Head-to-head pr inting)
Binding edge on top
Binding edge on top
y=o
Tumble(Head-to-toe pr inting)
Back Side Front Sidey=0
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 291
ATTRIBUTES
plexes-supported
The plexes-supported attribute identifies the plexes supported by this printer.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values simplex
duplex
tumble
Default value No default value
Comments Refer to the plex attribute description for additional information.
preferred-printer-drivers (Windows NT only)
The preferred-printer-drivers attribute contains information about printer drivers that are defined as preferred for this logical printer. The NT client administration application obtains the driver information for this attribute from the printer driver server specified with the driver-server attribute.
Objects Printer (logical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 292
ATTRIBUTES
Valid values Table A-18. Preferred-printer-drivers elements
Default value No default value
Comments To ensure that users load the appropriate printer driver for PrintXchange printers, PrintXchange includes a feature that enables administrators to customize the driver installation process on the user's machine when the logical printer is added to the user's desktop.
The administrator may choose one of the following processes for installing printer drivers for PrintXchange logical printers:
1. Remote download of drivers on a Windows NT 4.0 system to the client systems
2. Local media loading of drivers to the client systems (driver name predetermined)
3. Local media loading of driver to the client system (driver name determined by user)
Remote download of drivers to the client systems
For each spooler, a default driver server can be specified as the primary host where the printer drivers reside. This value is specified via the CLI driver-server attribute for a spooler.
Element Valid values
version Integer greater than or equal to 0
name Text string of up to 255 characters
environment winntx86win40
driver-path Text string of up to 4095 characters
data-file Text string of up to 4095 characters
config-file Text string of up to 4095 characters
help-file Text string of up to 4095 characters
dependent-files Text string of up to 4095 characters
monitor-name Text string of up to 255 characters
default-data-type Text string of up to 4095 characters
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 293
ATTRIBUTES
Using a script program in the CLI, all preferred driver values for the specific driver must be determined by the administrator. The CLI command to download the Windows NT 4.0 Docutech PostScript level 2 driver for the logical printer named DocutechPS_lp is as follows:
pdset -c printer -x preferred-printer-drivers={name="Xerox DocuTech 90 PS2"version=2 environment=winntx86
driver-path=\\\\\\\\PXC-NT\\\\print$\\\\W32X86\\\\2\\\\PSCRIPT.DLL
data-file=\\\\\\\\PXC-NT\\\\print$\\\\W32X86\\\\2\\\\XRDT0904.PPD
config-file=\\\\\\\\PXC-NT\\print$\\\\W32X86\\\\2\\\\PSCRPTUI.DLL
help-file=\\\\\\\\PXC-NT\\\\print$\\\\W32X86\\\\2\\\\PSCRIPT.HLP
dependent-files=\\\\\\\\PXC-NT\\\\print$\\\\W32X86\\\\2\\\\XRDT0904.PPD
\\\\\\\\PXC-NT\\\\print$\\\\W32X86\\\\2\\\\PSCRIPT.DLL
\\\\\\\\PXC-NT\\\\print$\\\\W32X86\\\\2\\\\PSCRPTUI.DLL
\\\\\\\\PXC-NT\\\\print$\\\\W32X86\\\\2\\\\PSCRIPT.HLP} DocutechPS_lp
It is best to place the entire preferred-printer-drivers portion of the command into an attribute file and have the pdset command access the attribute file. For example, place the attribute in the file called ppd.x in the directory path c:/path and use the following command to enable downloading of the driver to the client system:
pdset -c printer -X c:/path/ppd.x DocutechPS_lp
To create additional logical printers with the same attributes (including the printer driver specification), the copy-from attribute can be used in the pdcreate command. Refer to the PrintXchange Command Line Interface Reference Guide pdcreate chapter for an example.
Local media loading of drivers to the client systems (driver name pre-determined)
Note: The driver-server attribute is not applicable for this process.
Using the CLI, the driver name, environment and version should be specified. The CLI command for the user to load the Windows NT 4.0 Docutech PostScript level 2 driver for the logical printer named DocutechPS_lp is as follows:
pdset -c printer -x preferred-printer-drivers={name="Xerox DocuTech 90 PS2"version=2 environment=winntx86} DocutechPS_lp
For Windows NT 4.0,
environment = winntx86version = 2
For Windows 95,
environment = win40version = 0
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 294
ATTRIBUTES
Local media loading of driver to the client system (driver name determined by user)
This option requires no setup by the administrator. When the user creates the logical printer on their desktop, they load the driver they deem to be appropriate.
preprocessor-definition
The preprocessor-definition attribute defines a program as a preprocessor and contains the information needed to invoke the program. The function of a preprocessor is to perform one or more operations on a document before job submission to the spooler or before the supervisor sends the job to the output device. Operations include translating document data from simple-text to PostScript.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable Yes
Commands pdset
Valid values The preprocessor-definition attribute contains eight elements. Values must be entered differently for each element, according to the table below. In addition, curly braces must be used when entering values, as in the following:
{preprocessor-namepreprocessor-typeexecutable-typecommandattributes-to-settime-outinput-formatsoutput-formats}
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 295
ATTRIBUTES
Table A-19. preprocessor-definition elements
Default value No default value
Comments Examples:
pdset - c server -x preprocessor-definition= \
{ \
name=text-to-ps \
preprocessor-type=translation-filter \
executable-type=executable \
command=" trn_textps -N\${number-up,0} -O\${content-orientation} \
-a\${top-margin} -b\${bottom-margin} -c\${left-margin} \
-d\${right-margin} -l\${length} -w\${width} \
-P\${number-pages} -t\${repeated-tab-stops}" \
attributes-to-set='disable-attribute-mapping=true' \
time-out=1:00
input-formats=simple-text \
output-formats=PostScript \
} \
SupervisorName
Element Valid values
name Text string of up to 255 characters
preprocessor-type modification-filter
translation-filter
executable-type executable
command Text string of up to 4095 characters denoting path to preprocessor and attribute substitution patterns
attributes-to-set Set of document attributes; optional
time-out [HH:]mm[:SS]; optional. Determines how long PrintXchange waits for a preprocessor to complete. If time-out occurs, preprocessing is cancelled.
input-formats Set of one or more document formats; optional. If the value is empty, it indicates the filter can take any format as input.
output-formats One document format
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 296
ATTRIBUTES
preprocessor-list
The preprocessor-list attribute contains names of preprocessors that a spooler or supervisor can invoke on a document. If there is no value for a logical or physical printer preprocessor-list attribute, the associated spooler or supervisor uses the value of the corresponding server preprocessor-list attribute. If the server preprocessor-list also has no value, the server does no preprocessing on the document.
The server determines if a given preprocessor is appropriate for a document by using the following rule:
• Check if the document’s document-format attribute is included in the input-formats element of the first preprocessor in the list.
• Check if the input-formats element of the interim preprocessor in the list is included in the output-formats element of the previous one.
• Check if the output-formats element of the last preprocessor in the list is included in the printers document-formats-supported (for spooler) or document-formats-ready (for supervisor) attribute.
The order of preprocessor names in the list determines the order in which the server invokes the preprocessors.
Objects Printers (logical and physical)
Server (spooler and supervisor)
M/S Multi-value
Settable Yes
Commands pdcreate, pdset (for printer objects)
pdset (for server objects)
Valid values name values as defined with the preprocessor-definition attribute
Default value No default value
Comments
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 297
ATTRIBUTES
previous-job-state
Identifies the state of the job before the last state change.
Objects Job
M/S Single value
Settable No
Commands N/A
Valid values unknown, pre-processing, pending, processing, retained, held, paused, terminating, completed, printing
Default value No default value
Comments
print-colour-types-ready
The print-colour-types-ready attribute identifies the colors that are ready to be used on this printer.
Objects Printer (physical only)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values black-and-white
highlight-colour
full-colour
Default value black-and-white
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 298
ATTRIBUTES
Comments On job submission, the spooler checks the print color types specified for a document against the logical printer's print-colour-types-supported attribute. In addition, the spooler checks for a match with the physical printer's print-colour-types-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the print color types specified for a document after the job was accepted, the spooler again checks the print color types specified for a document against the physical printer's print-colour-types-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
print-colour-types-supported
The print-colour-types-supported attribute identifies the colors that are supported on this printer.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values black-and-white
highlight-colour
full-colour
Default value black-and-white
Comments On job submission, the spooler checks the print color types specified for a document against the logical printer's print-colour-types-supported attribute. In addition, the spooler checks for a match with the physical printer's print-colour-types-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the print color types specified for a document after the job was accepted, the spooler again checks the print color types specified for a document against the physical printer's print-colour-types-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 299
ATTRIBUTES
print-colour-type-used
The print-colour-type-used attribute identifies the color specified in the document.
Objects Document
M/S Single value
Settable Yes
Commands pdmod
pdpr
pdset
Valid values black-and-white
highlight-colour
full-colour
Default value black-and-white
Comments On job submission, the spooler checks the print color types specified for a document against the logical printer's print-colour-types-supported attribute. In addition, the spooler checks for a match with the physical printer's print-colour-types-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the print color types specified for a document after the job was accepted, the spooler again checks the print color types specified for a document against the physical printer's print-colour-types-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 300
ATTRIBUTES
printer-address
The printer-address attribute specifies a unique address for a connected printer. This address tells the supervisor how to connect to the printer.
The following table lists the general forms of the printer-address attribute that the supervisor recognizes. The forms indicate a null, serial, parallel, or IP network socket connection. IP network socket ports may be simple node names with or without dotted domain syntax, and with or without port numbers. The syntax for printer-address is text. However, the port number is a decimal integer.
Table A-20. Valid forms for printer-address attribute
Objects Printer (physical only)
M/S Single value
Settable Yes
Form Description
For Windows NT: LPT<n>: (case insensitive)
For UNIX: /dev/bpp/<n>
/dev/mcpp/<n>
Parallel port n. Examples for locally-connected parallel port:LPT1:
dev/bpp0
For Windows NT: COM<n>: (case insensitive)
For UNIX: dev/pts/<n>
Serial port n. Examples for locally-connected serial port:
COM2:
/dev/pts/1
For UNIX: /dev/tty/<x>
Serial port x. This form of the printer-address attribute requires that attribute printer-connection-level=1 . Serial port x must have an alphabetical value such as "a" or "b."
Example for a locally-connected serial port:
/dev/ttya:
name[:port] Host name without domain and, optionally, port.
Example: foobar
name.abc.def.hij[:port] Host name with domain and, optionally, port.
Example: topper.mro1.dec.com
nnn.nnn.nnn.nnn[:port] Numeric IP address and, optionally, port.
Example: 16.34.144.119:9100
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 301
ATTRIBUTES
Commands pdcreate
pdset
Valid values Text string or positive or negative integer
Default value No default value
Comments The printer-address attribute must have a value when a physical printer is enabled or the pdenable command fails.
If the port number is not specified, the supervisor derives it from the printer-tcpip-port-number attribute or its default (as may be specified in the printer attribute file). If the port number is specified as part of printer-address , it supersedes the value of printer-tcpip-port-number , if any.
printer-associated-printers
Identifies the physical/logical printers associated with this logical/physical printer. This attribute is updated when the printer's associated-queue attribute is modified. It is checked for end-to-end consistency when the printer is enabled.
Objects Printer (logical and physical)
M/S Multi-value
Settable No
Commands N/A
Valid values Text string of up to 4095 characters
Default value No default value
Comments
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 302
ATTRIBUTES
printer-baud-rate
The printer-baud-rate attribute is a communications parameter attribute required to connect a printer to a serial port. It specifies the baud rate for the connected printer.
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values 110, 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200
Default value No default value
Comments If the printer-baud-rate attribute is not specified, PrintXchange assumes the port was correctly set up in advance. However, if you specify a value for printer-baud-rate , other serial communications parameter attributes are set to the values you specify or to the values listed in the following table if the attributes are initially empty.
Table A-21. Serial parameter attributes
Attribute Valid values
Value used if attribute is initially empty
printer-baud-rate 300, 1200, 2400, 4800, 9600, 19200, 38400
none
printer-data-bits 5, 6, 7, 8 8
printer-stop-bits 0, 1, 2 1
printer-input-flow-control nonexoffctsdtr
xoff
printer-output-flow-control nonexoffctsdtr
xoff
printer-parity noneevenoddmarkspace
none
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 303
ATTRIBUTES
printer-connect-timeout-period
The printer-connect-timeout-period attribute indicates the length of time the supervisor remains waiting while it is "connecting to printer." At the end of the timeout period, the supervisor generates an event that invokes a warning message indicating that the printer resource needs attention.
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values Values entered in the format [HH:]mm[:SS]
HH = 0 - 99 hours
mm = 0 - 59 minutes
SS = 0 - 59 seconds
Default value No default value
Comments
printer-connection-level
The printer-connection-level attribute indicates the level of connectivity supported by the connected printer.
PrintXchange uses this attribute to provide support for a broad class of printers, since some printer models use more features offered by a connection than others. For example, some printers provide status messages on a serial back channel while others do not.
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 304
ATTRIBUTES
Valid values Table A-22. Attribute values for printer-connection-level
Default value No default value
Comments Printer attribute files that accompany the PrintXchange clients contain the appropriate connection level definition for each supported printer. Most likely, you will not change the value of printer-connection-level from its printer attribute file setting.
However, use of terminal servers or other intermediate boxes affect the level of support that PrintXchange can provide. Use of these devices may require that you lower the connection level in order to get reliable, though less capable, support for a printer.
Value Description
0 Not specified
Supervisor uses method-dependent default attributes. If those attributes are not specified, supervisor defaults to the following:
For serial and IP socket - 1 (output only data - unidirectional)
For parallel Centronics and Dataproducts - 2 (output only data - status bits returned)
1 Output only data - unidirectional
Printers that are unidirectional only cannot report conditions (such as paper-out, jammed, or off-line) to the supervisor process. The supervisor relies on flow control (if that is available) to prevent the flow of document data when the printer is powered down or unavailable.
2 Output only data - status bits returned
Printers that report status in the form of status bits can supply the supervisor with some status information, such as when the printer is off-line or when an engine error occurs.
3 Bidirectional - without synchronized session control
PostScript printers that exploit a bidirectional data connection send a wide variety of more detailed printer status messages to the host. The PrintXchange supervisor converts many such printer messages to events and problem text, which is available for display by clients.
4 Bidirectional - with synchronized session control
See above note on PostScript printers.
5 Printer session protocol
Employs a printer session protocol that imposes no restrictions on data contents (such as Apple PAP, CPAP, NPAP, etc.).
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 305
ATTRIBUTES
printer-connection-method
The printer-connection-method attribute indicates how a printer is attached to a server.
Objects Printer (physical only)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values Table A-23. Reference supervisor printer-connection-method values
Table A-24. Xerox supervisor printer-connection-method values
Default value No default value
Comments Printer attribute files that accompany the PrintXchange clients contain the appropriate connection method definition for each supported printer. Most likely, you will not change the value of printer-connection-method from its printer attribute file setting.
Users with appropriate access authorization may modify this and other physical printer attributes at any time. However, such modifications take effect only when the printer transitions from disabled to enabled.
Reference supervisor values
digital-printserver ip-socket
parallel serial
Xerox supervisor values
1179-job-cancel snmp-job-status
1179-job-status user-defined-method
1179-job-submission xpp-device-status
snmp-device-status xpp-job-status
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 306
ATTRIBUTES
printer-connection-methods-supported
Indicates the connection methods supported by the connected printer.
Objects Server (supervisor only)
M/S Multi-value
Settable No
Commands N/A
Valid values See printer-connection-method
Default value No default value
Comments
printer-data-bits
The printer-data-bits attribute is a communications parameter attribute required to connect a printer to a serial port. It identifies the data bits for a connected printer.
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values 5, 6, 7, 8
Default value No default value
Comments Refer to the printer-baud-rate attribute description for details on this and other serial communications parameter attributes.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 307
ATTRIBUTES
printer-drum-level
The printer-drum-level attribute indicates the current ratio of the wear of the drum.
Objects Printer (physical only)
M/S Multi-value
Settable No
Commands N/A
Valid values Table A-25. Printer-drum-level elements
Default value No default value
Comments
printer-drum-threshold
The printer-drum-threshold attribute indicates the threshold of the wear of the drum to raise the attention of users or key operators.
Objects Printer (physical only)
M/S Multi-value
Settable Yes
Commands pdcreate, pdset
Element Valid values
printer-drum 1234default
level 0 - 1000-worn out100=new
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 308
ATTRIBUTES
Valid values Table A-26. Printer-drum-threshold elements
Default value 0
Comments
printer-error-sheet
The printer-error-sheet attribute specifies the type of error sheet for the job.
Objects Initial-value-job
Job
M/S Single value
Settable Yes
Commands pdcreate, pdset (for initial-value-job objects)
pdmod, pdpr, pdset (for job objects)
Valid values none
brief
Default value No default value
Comments On job submission, the spooler checks the printer error sheets specified for a job against the logical printer's printer-error-sheets-supported attribute. In addition, the spooler checks for a match with the physical printer's printer-error-sheets-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the printer-error-sheets specified for a job after the job was accepted, the spooler again checks the printer-error-sheets specified for a job against the physical printer's printer-error-sheets-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
Element Valid values
printer-drum 1234default
level 0 - 1000-worn out100=new
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 309
ATTRIBUTES
printer-error-sheets-ready
The printer-error-sheets-ready attribute specifies the type of error sheets ready on this printer.
Objects Printer (physical only)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values none
brief
Default value No default value
Comments On job submission, the spooler checks the printer error sheets specified for a job against the logical printer's printer-error-sheets-supported attribute. In addition, the spooler checks for a match with the physical printer's printer-error-sheets-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the printer-error-sheets specified for a job after the job was accepted, the spooler again checks the printer-error-sheets specified for a job against the physical printer's printer-error-sheets-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
printer-error-sheets-supported
The printer-error-sheets-supported attribute specifies the type of error sheets supported by this printer.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values none
brief
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 310
ATTRIBUTES
Default value No default value
Comments On job submission, the spooler checks the printer error sheets specified for a job against the logical printer's printer-error-sheets-supported attribute. In addition, the spooler checks for a match with the physical printer's printer-error-sheets-ready attribute. If there is no match, the spooler rejects the print request.
Since the user may have modified the printer-error-sheets specified for a job after the job was accepted, the spooler again checks the printer-error-sheets specified for a job against the physical printer's printer-error-sheets-ready attribute before scheduling the job. If there is no match, the spooler leaves the job pending.
printer-initial-value-document
The printer-initial-value-document attribute identifies an initial-value-document on the spooler for use with this logical printer. A document submitted through the logical printer will use the attributes specified in the printer-initial-value-document if the corresponding attributes are not specified for the document at the time of submission.
Objects Printer (logical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values Name of an existing initial-value-document object residing on the same spooler as the logical printer.
Default value No default value
Comments The printer-initial-value-document is used if the document does not specify an initial-value-document .
To display a list of initial-value-document objects available on the server, enter:
pdls -c printer -r printer-initial-value-document <log-ptr-name>
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 311
ATTRIBUTES
printer-initial-value-job
The printer-initial-value-job attribute identifies a job attribute file for this logical printer. The job attribute set in the job attributes file define default job characteristics for the associated logical printer.
Objects Printer (logical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values Name of an existing initial-value-job object on the same spooler as the logical printer.
Default value No default value
Comments The printer-initial-value-job is used if the job does not specify an initial-value-job .
printer-ink-or-toner-level
The printer-ink-or-toner-level attribute indicates the current capacity of the toner or ink cartridge.
Objects Printer (physical only)
M/S Multi-value
Settable No
Commands N/A
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 312
ATTRIBUTES
Valid values Table A-27. Printer-ink-or-toner-level elements
Default value No default value
Comments
printer-ink-or-toner-threshold
The printer-ink-or-toner-threshold attribute indicates the threshold of capacity of the toner or ink cartridge to raise the attention of users or key operators.
Objects Printer (physical only)
M/S Multi-value
Settable Yes
Commands pdcreate, pdset
Element Valid values
printer-cartridge defaultblackredblueyellowcyanmagentalightcyanlightmagenta1234
level 0 - 1000=empty100=full
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 313
ATTRIBUTES
Valid values Table A-28. Printer-ink-or-toner-threshold elements
Default value No default value
Comments
printer-input-flow-control
The printer-input-flow-control attribute is a communications parameter attribute required to connect a printer to a serial port. It indicates the type of input flow control used by the connected printer.
Objects Printer (physical only)
M/S Single value
Settable No
Commands N/A
Valid values none, xoff, cts, dtr
Default value No default value
Comments Refer to the printer-baud-rate attribute description for details on this and other serial communications parameter attributes.
Element Valid values
printer-cartridge defaultblackredblueyellowcyanmagentalightcyanlightmagenta1234
level 0 - 1000=empty100=full
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 314
ATTRIBUTES
printer-locations
The printer-locations attribute identifies the location of the printer.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values Text string of up to 4095 characters
Default value No default value
Comments For a logical printer associated with multiple physical printers, more than one location should be specified if the physical printers reside in different locations.
printer-model
The printer-model attribute identifies the make and model of the printer.
PrintXchange requires this attribute when you create a physical printer via the pdcreate command. However, the requirement is satisfied by specifying the name of a printer attribute file since the printer attribute file contains the value of the printer-model attribute.
Objects Printer (physical only)
M/S Single value
Settable Yes (only at printer creation)
Commands pdcreate
Valid values Text string of up to 4095 characters
Default value No default value
Comments If a printer attribute file does not exist for your new printer, you can use a printer attribute file for a printer similar to your new one. However, the printer model in the attribute file will not correspond to your new printer. You must edit the printer attribute file itself to change the printer model.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 315
ATTRIBUTES
printer-name
The printer-name attribute specifies a unique name for a printer.
Objects Printer (logical and physical)
M/S Single value
Settable Yes (only at printer creation)
Commands pdcreate
Valid values Text string of up to 255 characters
Default value No default value
Comments The printer name serves several purposes. If represents:
• A process whose name is in the Name Service. Users send requests to the printer process based on its name.
• The name of an object database. Each PrintXchange printer has an object database associated with it.
printer-name-requested
The printer-name-requested attribute identifies the logical printer to which you are submitting a job. You may specify a logical printer via this attribute or via the -p switch in the pdpr command.
If you do not specify the -p switch, pdpr uses the logical printer identified by the value of the printer-name-requested attribute. If printer-name-requested is also not specified, pdpr uses the logical printer identified with the PDPRINTER environment variable.
If you specify both -p and printer-name-requested on the command line, pdpr uses the last logical printer name specified in the command line syntax.
Objects Job
M/S Single value
Settable Yes (only at job submission)
Commands pdpr
Valid values Text string of up to 255 characters
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 316
ATTRIBUTES
Comments If job start sheets are in use via the job-sheets attribute, the value of the printer-name-requested attribute prints on job start sheets.
printer-output-flow-control
The printer-output-flow-control attribute is a communications parameter attribute required to connect a printer to a serial port. It identifies the output flow control used by the connected printer.
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pcreate
pdset
Valid values none, xoff, cts, dtr
Default value No default value
Comments Refer to the printer-baud-rate attribute description for details on this and other serial communications parameter attributes.
printer-paper-level
The printer-paper-level attribute indicates the current capacity of the paper tray.
Objects Printer (physical only)
M/S Multi-value
Settable No
Commands N/A
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 317
ATTRIBUTES
Valid values Table A-29. Printer-paper-level elements
Default value No default value
Comments
printer-paper-threshold
The printer-paper-threshold attribute indicates the threshold of capacity of the paper tray to raise the attention of users or key operators.
Objects Printer (physical only)
M/S Multi-value
Settable Yes
Commands pdcreate, pdset
Element Valid values
input-tray 12345678910topmiddlebottomenvelopedefaultmanualmanual-2manual-3large-capacitymainside
level 0 - 1000=empty100=full
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 318
ATTRIBUTES
Valid values Table A-30. Printer-paper-threshold elements
Default value No default value
Comments
printer-parity
The printer-parity attribute is a communications parameter attribute required to connect a printer to a serial port. It identifies the parity used by the connected printer.
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values none, even, odd, mark, space
Default value No default value
Element Valid values
input-tray 12345678910topmiddlebottomenvelopedefaultmanualmanual-2manual-3large-capacitymainside
level 0 - 1000=empty100=full
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 319
ATTRIBUTES
Comments Refer to the printer-baud-rate attribute description for details on this and other serial communications parameter attributes.
printer-problem-message
Some printers produce a text string describing a problem. In these cases, the supervisor places the text string in this attribute.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values Text string of up to 4095 characters
Default value No default value
Comments
printer-realization
Identifies if the printer is logical or physical. A printer created on a spooler is logical. A printer created on a supervisor is physical.
Objects Printer (logical and physical)
M/S Single value
Settable No
Commands N/A
Valid values logical
physical
Default value No default value
Comments
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 320
ATTRIBUTES
printer-resource-warning-raised
Indicates if printer resource warnings have been raised for the user.
Objects Printer (physical only)
M/S Single value
Settable No
Commands N/A
Valid values true|yes
false|no
Default value No default value
Comments
printer-state
Identifies the current state of the printer.
Objects Printer (logical and physical)
M/S Single value
Settable No
Commands N/A
Valid values (See comments)
Default value No default value
Comments The saturated value is set if the value of number-job-on-device exceeds the value of max-concurrent-job-processing .
The following table lists the valid printer states and indicates the values supported by the reference and Xerox supervisor.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 321
ATTRIBUTES
Table A-31. Valid printer-states
printer-stop-bits
The printer-stop-bits attribute is a communications parameter attribute required to connect a printer to a serial port. It identifies the stop bits used by the connected printer.
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid Value 0
1
2
Default value No default value
Comments Refer to the printer-baud-rate attribute description for details on this and other serial communications parameter attributes.
Xerox Supervisor
Reference Supervisor
SNMP Device Status
XPP Device Status
No DeviceStatus
connecting-to-printer x x --- ---
idle x x x x
needs-attention x x x ---
needs-key-operator --- x --- ---
paused x x x x
printing x x x x
saturated ---- x x x
shutdown x x x x
timed-out x x --- ---
unknown x x x x
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 322
ATTRIBUTES
printer-tcpip-port-number
The printer-tcpip-port-number attribute identifies the port number to be used when connecting to a printer on an IP socket connection.
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values 1024 through 65535
Default value 9100
Comments Printer attribute files that accompany the PrintXchange clients contain the appropriate TCP/IP port number whenever a printer has a prevailing network connection option, such as HP's JetDirect printer.
Most likely, you will not change the value of printer-tcpip-port-number from its printer attribute file setting.
printer-timeout-period
The printer-timeout-period attribute Identifies the time period (in seconds) for which the supervisor waits for a response from a printer before setting the printer's printer-state attribute to timed-out .
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values Values entered in the format [HH:]mm[:SS]
HH = 0 - 99 hours
mm = 0 - 59 minutes
SS = 0 - 59 seconds
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 323
ATTRIBUTES
Comments After the supervisor makes an initial connection to the printer, the printer-timeout-period value is used to determine when the supervisor will set the printer state to "timed-out" if the printer does not respond to an operation request.
Although the printer-timeout-period attribute does not have a default value, the reference supervisor uses 300 seconds if no value has been specified. If an administrator enters 0 for the attribute value, then the supervisor does not monitor input/output activity on the printer.
printers-assigned
Indicates the physical printer to which the job was assigned. This attribute is set by the spooler at the time the job is sent to the supervisor.
Objects Job
M/S Multi-value
Settable No
Commands N/A
Valid values Text string of up to 4095 characters
Default value No default value
Comments If job start sheets are in use via the job-sheets attribute, the value of the printers-assigned attribute prints on job start sheets.
printers-ready
For a logical printer object, identifies the physical printers ready to be used with the logical printer.
For a physical printer object, identifies the logical printers ready to be used with the physical printer.
Objects Printer (logical and physical)
M/S Multi-value
Settable No
Commands N/A
Valid values Text string of up to 4095 characters
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 324
ATTRIBUTES
Default value No default value
Comments When you enable a logical printer with the pdenable command, the associated spooler adds the name of the logical printer to the printers-ready attribute for all associated physical printers.
promote-job-operations
The promote-job-operations attribute contains the total number of promote job object operations that have taken place since the spooler was last started.
Objects Server (spooler only)
M/S Multi-value
Settable No
Commands N/A
Valid values
Default value No default value
Comments Promote job operations take place when invoking the pdpromote command.
proxy-submit-supported (Windows NT only)
The proxy-submission-supported attribute indicates whether there is support for cross-domain proxy submission. This attribute is used if the client’s domain is not trusted (i.e., the client’s domain is not liested as trusted in the Primary Domain Controller). Once this attribute is set to true|yes , a user from a non-trusted domain can submit requests to the server.
Objects Server (spooler and supervisor)
M/S Single value
Settable Yes
Commands pdset
Valid values true|yes
false|no
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 325
ATTRIBUTES
Default value No default value
Comments This attribute is set to true|yes if cross-domain submission is allowed. After setting this attribute, the server must be restarted.
queue-backlog-lower-limit
The queue-backlog-lower-limit attribute defines the lower bound queue limit for pending jobs. The attribute value triggers event notification when the queue is no longer backlogged, enables the queue if the attribute disable-backlogged-queue is true and the queue is disabled, and causes the queue to clear the queue-problem-message attribute.
Objects Queue
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values Integer equal to or greater than 0
Default value 1000
Comments The value of queue-backlog-lower-limit cannot be greater than the value of queue-backlog-upper-limit .
queue-backlog-upper-limit
The queue-backlog-upper-limit attribute defines the upper bound queue limit for pending jobs. Reaching the attribute value triggers event notification that the queue is backlogged, disables the queue if the attribute disable-backlogged-queue is true , and causes the queue to set the value of queue-problem-message with the message "Queue is currently backlogged, please investigate."
Objects Queue
M/S Single value
Settable Yes
Commands pdcreate
pdset
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 326
ATTRIBUTES
Valid values Integer equal to or greater than 0
Default value 1000
Comments The value of queue-backlog-upper-limit can be equal to or greater than, but not less than, the value of queue-backlog-lower-limit .
queue-name
The queue-name attribute specifies an identifier for a queue. An administrator specifies queue-name when creating the queue.
After the queue is created and this attribute is specified, you cannot change it.
Objects Queue
M/S Single value
Settable Yes (only at queue creation)
Commands pdcreate
Valid values Text string of up to 255 characters
Default value No default value
Comments Queue names must be unique within their domain.
The queue name serves several purposes. It represents:
• A process whose name is in the Name Service. Users send requests to the queue process based on its name.
• The name of an object database. Each PrintXchange queue has an object database associated with it.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 327
ATTRIBUTES
queue-problem-message
The queue-problem-message attribute is used by the queue to indicate whether the queue is backlogged.
If the queue is backlogged (the number of pending jobs reaches the value of queue-backlog-upper-limit ), the queue sets the attribute value to the message "Queue is currently backlogged, please investigate."
When the queue is no longer backlogged (the number of pending jobs is less than the queue-backlog-lower-limit ), the queue clears the attribute value.
Objects Queue
M/S Single value
Settable No
Commands N/A
Valid values "Queue is currently backlogged, please investigate."(or empty)
Default value No default value
Comments
queues-supported
Lists the queues supported by the spooler. Automatically updated by creation and deletion of queues.
Objects Server (spooler only)
M/S Multi-value
Settable No
Commands N/A
Valid values Text string of up to 255 characters
Default value No default value
Comments
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 328
ATTRIBUTES
repeated-tab-stops
The repeated-tab-stops attribute provides you with more control over the placement of text in a document with simple-text format. Specifically, the attribute specifies the number of character spaces between tab stops.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values Positive or negative integer
Default value No default value
Comments Because of its use with simple-text format, repeated-tab-stops is typically part of a simple-text translation filter as defined with the attribute preprocessor-definition .
requested-attributes
This client attribute identifies the attributes that should be included in a command.
Objects N/A
M/S Multi-value
Settable Yes
Commands pdcreate
pdls
pdpause
pdpr
pdq
pdset
Valid values
Default value No default value
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 329
ATTRIBUTES
Comments Client attributes are mainly used to allow what would normally be an option to be entered as an argument to the -x option.
For example,
-r printer-name-requested
is the same as
-x "requested-attributes=printer-name-requested"
reset-printer
The reset-printer attribute indicates whether the printer's interpreter should be reset between documents within a job (the printer is always reset between jobs).
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values true|yes
false|no
Default value true|yes
Comments This attribute causes the reset sequence to be sent to the printer after the document with which it is associated. For example, to condition a PostScript printer with font data, use a command such as the following:
pdpr -p lp1 -x "reset-printer=no" -f fonts.dat -x "reset-printer=yes" file.ps
Printing document auxiliary sheets requires a printer reset. So, if the job has a value for the attribute document-sheets , the printer will always be reset between documents regardless of the value of reset-printer .
Also, attributes that would cause the printer to be reconfigured (such as sides , default-input-tray , and output-bin ) also require that the printer be reset. Therefore, if the document following a document with reset-printer=no specifies document attributes that are different, the server ignores the reset-printer=no and performs a reset.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 330
ATTRIBUTES
resubmit-job-operations
The resubmit-job-operations attribute contains the total number of resubmit job object operations that have taken place since the spooler was last started.
Objects Server (spooler only)
M/S Multi-value
Settable No
Commands N/A
Valid values
Default value No default value
Comments Resubmit job operations take place when invoking the pdresubmit command.
results-delivery-address
The results-delivery-address client attribute specifies the delivery address for output results.
Objects Initial-value-job
Job
M/S Single value
Settable Yes
Commands pdcreate, pdset (for initial-value-job objects)
pdmod, pdpr, pdset (for job objects)
Valid values See comments
Default value No default value
Comments If the value of results-delivery-method is fax , valid values for results-delivery-address are octet strings.
The results-delivery-address client attribute is part of the results-profile attribute. The results-profile attribute is supported but is not visible to the user. Its value is specified via the job-copies , output-bin , results-delivery-method , results-set-comment , and results-delivery-address attributes.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 331
ATTRIBUTES
results-delivery-method
The results-delivery-method client attribute specifies the delivery method for output results.
Objects Initial-value-job
Job
M/S Single value
Settable Yes
Commands pdcreate, pdset (for initial-value-job objects)
pdmod, pdpr, pdset (for job objects)
Valid values fax
pick-up
Default value See comments
Comments When specifying results-profile without specifying results-delivery-method , results-delivery-method defaults to pick-up . For results-profile attribute validation, if results-delivery-method is fax , the results-delivery-address must be present.
The results-delivery-method client attribute is part of the results-profile attribute. The results-profile attribute is supported but is not visible to the user. Its value is specified via the job-copies , output-bin , results-delivery-method , results-set-comment , and results-delivery-address attributes.
results-profile
The results-profile attribute specifies the job set that composes a job's output and specifies the disposition of the job set.
The results-profile attribute is supported but is not visible to the user. Its value is specified via the job-copies , output-bin , results-delivery-method , results-set-comment , and results-delivery-address attributes.
Objects Initial-value-job
Job
M/S Multi-value
Settable Yes
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 332
ATTRIBUTES
Commands pdcreate, pdset (for initial-value-job objects)
pdmod, pdpr, pdset (for job objects)
Valid values The results-profile attribute contains five elements, four of which are optional. Values must be entered differently for each element, according to the table below. In addition, curly braces must be used when entering values, as in the following:
{[delivery-method] [results-set-comment] [delivery-address] job-copies [output-bin]}
Table A-32. results-profile elements
Default value pick-up (for delivery-method element)
Comments Users may specify values for results-profile elements by specifying the results-profile attribute or by specifying the representative client (pseudo) attributes for corresponding elements. The client attributes for each element are:
Element Value range
results-delivery-method (optional)
pick-up
fax
results-set-comment (optional) Text string of up to 4095 characters
results-delivery-address (optional)
Text string of up to 4095 characters
job-copies 1 to about 2 billion
output-bin (optional) 1234567891011121314151617181920
2122232425topmiddlebottomsideface-upleftrightlargeprivateface-downcollatorcentermailbox-1mailbox-2mailbox-3
mailbox-4mailbox-5mailbox-6mailbox-7mailbox-8mailbox-9mailbox-10mailbox-11mailbox-12mailbox-13mailbox-14mailbox-15mailbox-16mailbox-17mailbox-18mailbox-19mailbox-20stacker-1stacker-2stacker-3
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 333
ATTRIBUTES
Table A-33. Client attributes for results-profile elements
For example:
-x "results-profile={delivery-method=pick-up job-copies=3 output-bin=center}"
is equivalent to:
-x "results-delivery-method=pick-up"-x "job-copies=3"-x "output-bin=center"
results-set-comment
The results-set-comment client attribute provides a means for users to convey information regarding the output results set.
Objects Initial-value-job
Job
M/S Single value
Settable Yes
Commands pdcreate, pdset (for initial-value-job objects)
pdmod, pdpr, pdset (for job objects)
Valid values Text string of up to 4095 characters
Default value No default value
Comments The results-set-comment client attribute is part of the results-profile attribute. The results-profile attribute is supported but is not visible to the user. Its value is specified via the job-copies , output-bin , results-delivery-method , results-set-comment , and results-delivery-address attributes.
results-profile element Client attribute
delivery-method results-delivery-method
results-set-comment results-set-comment
delivery-address results-delivery-address
job-copies job-copies
output-bin results-output-bin
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 334
ATTRIBUTES
resume-job-operations
The resume-job-operations attribute contains the total number of resume job object operations that have taken place since the spooler was last started.
Objects Server (spooler only)
M/S Multi-value
Settable No
Commands N/A
Valid values
Default value No default value
Comments Resume job operations take place when invoking the pdresume command on job objects.
resume-operations
The resume-operations attribute contains the total number of resume object (other than job object) operations that have taken place since the server was last started.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable No
Commands N/A
Valid values
Default value No default value
Comments Resume operations take place when invoking the pdresume command on objects other than job objects.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 335
ATTRIBUTES
retention-period
This client attribute specifies the amount of time a server should keep a job in the retained state after the job has been cancelled.
Objects N/A
M/S Single value
Settable Yes
Commands pdrm
Valid values Values entered in the format [HH:]mm[:SS]
HH = 0 - 99 hours
mm = 0 - 59 minutes
SS = 0 - 59 seconds
Default value No default value
Comments This is equivalent to using the job object attribute job-retention-period with the pdset and pdmod commands.
right-margin
The right-margin attribute provides you with more control over the placement of text in a document with simple-text format. Specifically, the attribute specifies the distance in characters between the right edge of the logical page and the right edge of the text area when held in the intended reading position.
(Some document formats, such as PostScript, specify the margin as part of the document content; simple-text does not.)
Figure A-6. right-margin
right-margin
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 336
ATTRIBUTES
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values Minus-infinity to plus-infinity
(may be a non-integer value)
Default value No default value
Comments The value right-margin=12 specifies a right margin of twelve characters. The actual distance is dependent on the size of the character set specified for the document.
Because of its use with simple-text format, right-margin is typically part of a simple-text translation filter as defined with the attribute preprocessor-definition .
scope
This client attribute indicates whether document attributes are to be included on a job attributes list command.
Objects N/A
M/S Single value
Settable Yes
Commands pdls
Valid values 0 = List only job attributes
1 = List job and document attributes
Default value 0
Comments You may also use the client attributes count-limit and time-limit to control pdls output.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 337
ATTRIBUTES
send-event-operations
The send-event-operations attribute contains the total number of send event operations that have taken place since the server was last started.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable No
Commands N/A
Valid values
Default value No default value
Comments Send event operations take place internally to the server. These operations take place when the spooler and supervisor communicate with each other, such as when a job completes processing on a supervisor.
server-hostname
Specifies the name of the host machine on which the server (spooler or supervisor) is running.
Objects Sever (spooler and supervisor)
M/S Single value
Settable No
Commands N/A
Valid values Text string of up to 4095 characters.
Default value No default value
Comments
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 338
ATTRIBUTES
server-name
The server-name attribute specifies a unique identifier for a server. An administrator specifies server-name when creating the server.
After the server is created and this attribute is specified, you cannot change it.
Objects Server (spooler and supervisor)
M/S Single value
Settable Yes (only at server creation)
Commands pdcreate
Valid values Text string of up to 255 characters
Default value No default value (server name is required)
Comments The server name serves several purposes. It represents:
• A process whose name is in the Name Service. Users send requests to the server process based on its name.
• The name of an object database. Each PrintXchange server has an object database associated with it.
server-operating-system
The server-operating-system attribute shows the name and version of the operating system on the server host machine.
Objects Server (spooler and supervisor)
M/S Single value
Settable No
Commands N/A
Valid values Text string of up to 4095 characters
Default value No default value
Comments Examples of values for this attribute include:
SUN OS 5.5.1
Windows NT 4.0
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 339
ATTRIBUTES
server-state
The current state of the specified server.
Objects Server (spooler and supervisor)
M/S Single value
Settable No
Commands N/A
Valid values ready
paused
terminating
Default value No default value
Comments
server-type
Specifies the type of server.
Objects Server (spooler and supervisor)
M/S Single value
Settable No
Commands N/A
Valid values spooler, supervisor, notification-server
Default value No default value
Comments
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 340
ATTRIBUTES
server-version
The server-version contains the version number of the PrintXchange software product.
Objects Server (spooler and supervisor)
M/S Single value
Settable No
Commands N/A
Valid values Text string of up to 4095 characters
Default value No default value (server name is required)
Comments
set-operations
The set-operations attribute contains the total number of set object attribute operations that have taken place since the server was last started.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable No
Commands N/A
Valid values
Default value No default value
Comments Set operations take place when invoking the pdset command.
The clean operation takes place when invoking the pdclean command.
The set-operations attribute lists the total set operations as well as the number of set operations on each object. For example:
set-operations=6server:4queue:2
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 341
ATTRIBUTES
shutdown-operations
The shutdown-operations attribute contains the total number of shutdown server object operations that have taken place since the server was last started.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable No
Commands N/A
Valid values
Default value No default value
Comments Shutdown operations take place when invoking the pdshutdown command.
Typically, the value of shutdown-operations would be 1. However, the value would be 0 if the server were shut down with a kill operation. The value might be greater than 1 if one of the following conditions occurred:
• The command
pdshutdown -c server -w now server_name
• followed the command
pdshutdown -c server -w after-all server_name
• The server received some shutdown operations with invalid syntax or authorization.
sides
The sides attribute specifies if the job should be printed on one or two sides of the paper.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 342
ATTRIBUTES
Valid values 1
2
Default value Printer default
Comments Destination logical and physical printers must contain the value of the specified document's sides attribute as a value of their sides-supported attribute. The physical printer must also contain the value of the specified document's sides attribute as a value of its sides-ready attribute.
sides-ready
The sides-ready attribute Indicates the values of sides ready on this printer.
Objects Printer (physical only)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
Valid values 1
2
Default value Printer default
Comments The sides-ready attribute must contain a value corresponding to the value of the sides attribute of a document to be printed on this printer.
sides-supported
The sides-supported attribute indicates the values of sides supported by this printer.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 343
ATTRIBUTES
Commands pdcreate
pdset
Valid values 1
2
Default value Printer default
Comments The sides-supported attribute must contain a value corresponding to the value of the sides attribute of a document submitted to this printer.
snmp-req-community-string
The snmp-req-community-string attribute identifies the string that the SNMP status monitoring feature specifies in SNMP requests. The Xerox supervisor uses this value when requesting MIB objects to agents residing in the remote printer.
A value should be entered for this attribute only if the printer has SNMP device and/or SNMP job status enabled.
Objects Printer (physical only)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values Text string of up to 4095 characters
Default value No default value
Comments This attribute only applies to PrintXchange configurations that include SNMP based printers.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 344
ATTRIBUTES
spooler-preprocessor-list
The spooler-preprocessor-list attribute identifies the preprocessors that may be invoked on a document at the spooler.
Objects Document
Initial-value-document
M/S Multi-value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values name value(s) as defined with the preprocessor-definition attribute.
Default value No default value
Comments If the spooler-preprocessor-list is not specified, the logical printer’s preprocessor-list is consulted. If that does not exist, the server’s preprocessor-list is used.
started-printing-time
Indicates the time at which this job started printing.
Objects Job
M/S Single value
Settable No
Commands N/A
Valid values
Default value No default value
Comments
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 345
ATTRIBUTES
state
Identifies the current state of the queue.
Objects Queue
M/S Single value
Settable No
Commands N/A
Valid values ready
paused
Default value No default value
Comments If you unsuccessfully try to submit a print job to a queue whose state is ready , check the value of the queue's enabled attribute. It is likely set to disabled.
style
This client attribute indicates the style (format) in which output specified with the -r requested_attributes option is written to standard output.
Objects N/A
M/S Single value
Settable Yes
Commands pdcreate
pdls
pdmod
pdpause
pdpr
pdq
pdset
Valid values column (for all values of -r except the all value)
line (for the -r all option)
Default value Depends on the value specified for the -r option.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 346
ATTRIBUTES
Comments Client attributes are mainly used to allow what would normally be an option to be entered as an argument to the -x option.
For example,
-s line
is the same as
-x "style=line"
submission-time
Indicates the time at which the latest print request for this job was submitted. This value is changed by pdresubmit .
Objects Job
M/S Single value
Settable No
Commands N/A
Valid values
Default value No default value
Comments If job start sheets are in use via the job-sheets attribute, the value of the submission-time attribute prints on job start sheets.
supervisor-preprocessor-list
The supervisor-preprocessor-list attribute identifies the preprocessors that may be invoked on a document at the supervisor.
Objects Document
Initial-value-document
M/S Multi-value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values name value(s) as defined with the preprocessor-definition attribute.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 347
ATTRIBUTES
Default value No default value
Comments If the supervisor-preprocessor-list is not specified, the printer’s preprocessor-list is consulted. If that does not exist, the server’s preprocessor-list is used.
sys-up-date-and-time
The sys-up-date-and-time attribute identifies the time at which the remote printer was last reset. To get object status, the Xerox supervisor has to know whether the remote printer was reset since it last got object status.
Objects Printer (physical only)
M/S Single value
Settable No
Commands N/A
Valid values
Default value No default value
Comments
system-log-file-path
The system-log-file-path attribute specifies the path for the log file. The service log facility uses the value of system-log-file-path to create a log file. The facility concatenates the value with the date, seconds past midnight, and microseconds to form a unique file name in the format:
value.mmdd.ssssss.uuuuuuvalue = value of system-log-file-pathmm = month 01 - 12dd = day 01 -31ssssss = seconds past midnightuuuuuu = microseconds
Objects Server (spooler and supervisor)
M/S Single value
Settable Yes
Commands pdset
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 348
ATTRIBUTES
Valid values Text string of up to 4095 characters
Default value syslog
Comments The valid values are:
• stdout - This value causes all service logging to be written to the standard output file.
• stderr - This value causes all service logging to be written to the standard error file.
• syslog - This value causes all service logging to be written using the standard system logging facility:
— In UNIX, the log messages appear in the file specified in the /etc/syslog.conf file (systlogd). A typical entry would look like: lpr.alert;lpr.err;lpr.info /var/adm/messages.
— In Windows NT, the messages appear in the Event Viewer, if so configured.
• Absolute path
• Relative path (relative paths are offset from the server runtime directory specified with the server’s cfg-server-runtime-dir attribute).
system-log-severity
The system-log-severity attribute indicates the levels of severity used for logging.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable Yes
Commands pdset
Valid values error (lowest level of severity)
warning
status
audit
debug (highest level of severity)
Default value error, warning, status
Comments
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 349
ATTRIBUTES
system-log-size
The system-log-size attribute specifies the size (in bytes) of a service log. When the log size reaches the value specified in this attribute, a new log is generated.
Objects Server (spooler and supervisor)
M/S Single value
Settable Yes
Commands pdset
Valid values Integer equal to or greater than 0
Default value 0
Comments The value 0 indicates that the current log is allowed to grow unbounded. This attribute is ignored if stdout , stderr , or syslog is the value set for the system-log-file-path attribute.
system-logging-enabled
The system-logging-enabled attribute indicates whether logging is activated for the entire server.
Objects Server (spooler and supervisor)
M/S Single value
Settable Yes
Commands pdset
Valid values true|yes
false|no
Default value true|yes
Comments If the value is false|no, the server does not log messages of any severity level.
If the value is true|yes, the server logs the messages of severity levels specified with the system-log-severity attribute.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 350
ATTRIBUTES
thickening-specification
The thickening-specification attribute sets the darkening parameter for the entire document or for bitmap images in the document.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values entire-document (darkens all text and images on each page of the job)
bitmap-images (darkens only bitmaps included in a job)
Default value No default value
Comments This attribute applies only to Xerox DocuPrint printers. Thickening is performed at the physical printer.
Destination logical and physical printers must contain the specified document's thickening-specification value as a value of their thickening-supported attribute.
thickening-supported
The thickening-supported attribute indicates darkening specification algorithms supported on this printer.
Objects Printer (logical and physical)
M/S Multi-value
Settable Yes
Commands pdcreate
pdset
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 351
ATTRIBUTES
Valid values entire-document (darkens all text and images on each page of a job)
bitmap-images (darkens only bitmaps included in a job)
Default value No default value
Comments This attribute applies only to Xerox DocuPrint printers. Thickening is performed at the physical printer.
The thickening-supported attribute must contain a value corresponding to the value of the thickening-specification attribute of a document submitted to this printer.
time-limit
This client attribute specifies the frequency in seconds in which pdls and pdq writes output.
Objects N/A
M/S Single value
Settable Yes
Commands pdls
pdq
Valid values Values entered in the format [HH:]mm[:SS]
HH = 0 - 99 hours
mm = 0 - 59 minutes
SS = 0 - 59 seconds
Default value No default value
Comments If there are 100 entries to list and time-limit is set to 30 seconds (00:30), the server returns items every 30 seconds. You don’t have to wait for the server to return all 100 entries. (Note that you don’t need to press Enter after each group is displayed every 30 seconds.)
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 352
ATTRIBUTES
top-margin
The top-margin attribute provides you with more control over the placement of text in a document with simple-text format. Specifically, the attribute specifies the distance in lines between the top edge of the logical page and the top edge of the text area when held in the intended reading orientation.
(Some document formats, such as PostScript, specify the margin as part of the document content; simple-text does not.)
top-margin
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values Minus-infinity to plus-infinity
(may be a non-integer value)
Default value No default value
Comments The value top-margin=6 specifies a top margin of six character lines. The actual distance is dependent on the size of the character set specified for the document.
Because of its use with simple-text format, top-margin is typically part of a simple-text translation filter as defined with the attribute preprocessor-definition .
top-margin
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 353
ATTRIBUTES
total-job-octets
Indicates the size of the job in bytes (including copies). This is computed by the spooler from the document attribute octet-count .
Objects Job
M/S Single value
Settable No
Commands N/A
Valid values
Default value No default value
Comments
transfer-method
The transfer-method attribute indicates how the document will be transferred to or acquired by the server.
If the transfer method is with-request or socket , the print job submission does not complete until the client completely transfers the document data to the spooler.
Objects Document
M/S Single value
Settable Yes (only at job submission)
Commands pdpr
Valid values with-request (for jobs up to 1 Mb)
socket
file-reference
(See Comments section for a detailed description of these values.)
Default value If the print request does not specify a transfer method, the spooler uses the following algorithm to determine the default:
• If the file size is less than 10,000 bytes, the spooler uses the with-request transfer method.
• If the file size is greater than 10,000 bytes, the spooler uses the socket transfer method.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 354
ATTRIBUTES
Comments The following table describes the three values for transfer-method :
Table A-34. transfer-method values
transfer-methods-supported
Indicates the transfer methods supported by the server.
Objects Server (spooler and supervisor)
M/S Multi-value
Settable No
Commands N/A
Valid values with-request (for jobs up to 1 Mb)
socket
file-reference
Default value No default value
Comments Refer to the transfer-method attribute description for details on the three transfer methods.
Value Description Example
with-request The client sends the document data directly to the spooler as part of the print request. The spooler copies the document data to its spool directory. The with-request transfer method is valid only for jobs up to 1 Mb in size.
To set a with-request transfer method:
pdpr -x "transfer-method=with-request " filename
socket When the spooler first receives the print request, the spooler returns socket information. The client then connects and writes the document data to this socket. The spooler reads from the socket and writes the data to a file in the spooler's spool directory.
To set a socket transfer method:
pdpr -x "transfer-method=socket " filename
file-reference The client sends a file path reference for the document to the spooler. Before returning from the print request, the spooler determines if it can reference the document. If the spooler cannot reference the document, the print request fails.
To set a file-reference transfer method:
pdpr -x "transfer-method=file-reference " filename
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 355
ATTRIBUTES
user-name
The name of the user requesting access to print service commands.
As part of the authentication process, the spooler compares a user's name against entries in the spooler's access-control-list attribute. On a print command, the spooler writes the user name that it retrieved during authentication into the job's user-name attribute.
Objects Job
M/S Single value
Settable No
Commands N/A
Valid values Text string of up to 4095 characters
Default value No default value
Comments
wait-for-all-document-preprocessing-to-complete
The wait-for-all-document-preprocessing-to-complete attribute indicates whether the supervisor sends the job to the printer before preprocessing completes on all documents of the job. If true , the supervisor does not send the job to the printer until preprocessing for all documents is complete.
Objects Job
Printer (physical only)
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for job objects)
pdcreate, pdset (for printer objects)
Valid values true|yes
false|no
Default value No default value
Comments
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 356
ATTRIBUTES
when
This client attribute specifies how much processing can occur before a server shutdown can take place.
Objects N/A
M/S Single value
Settable Yes
Commands pdshutdown
Valid values now
after-current
after-all
Default value No default value
Comments Client attributes are mainly used to allow what would normally be an option to be entered as an argument to the -x option.
For example,
-w after-current
is the same as
-x "when=after-current"
Refer to Chapter 18, pdshutdown, for more information on using the pdshutdown command.
width
The width attribute provides you with more control over the placement of text in a document with simple-text format. Specifically, the attribute specifies the width of the text area in characters. This is the maximum line width before wrapping.
(Some document formats, such as PostScript, specify the width as part of the document content; simple-text does not.)
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 357
ATTRIBUTES
Figure A-7. width
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values Minus-infinity to plus-infinity
(may be a non-integer value)
Default value No default value
Comments The value width=80 specifies a text area width of eighty characters.
Because of its use with simple-text format, width is typically part of a simple-text translation filter as defined with the attribute filter-definition .
x-image-shift
The x-image-shift attribute causes page images to be shifted in position with respect to the medium on which the page images are to be rendered. The direction of shift is parallel to the x-axis of the Reference Coordinate System (RCS).
The attribute enables requests for a different margin, possibly to correct a misalignment.
PrintXchange supports this attribute only for certain printers. Ask your system administrator for details.
Objects Document
Initial-value-document
text area width
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 358
ATTRIBUTES
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values Minus infinity to plus infinity (may be a non-integer value)
Default value No default value
Comments The physical and logical printer attribute x-image-shift-range-supported identifies the range supported by the printer. The value of the x-image-shift attribute must be in this range for the job to be accepted and scheduled.
The sign of the attribute value indicates the direction of shift. A positive value indicates that the shift is in the positive x- direction. A negative value indicates that the shift is in the negative x- direction. The shift direction is the same for all pages, regardless of the value of the plex attribute.
x-image-shift-range-supported
The x-image-shift-range-supported attribute identifies the x-image-shift range supported by the printer.
PrintXchange supports this attribute only for certain printers. Ask your system administrator for details.
Objects Printer (logical and physical)
M/S Single value
Settable Yes
Commands pdcreate
pdset
Valid values A range specified by any two negative or positive numbers (may be non-integer values)
Default value No default value
Comments Example:
x-image-shift-range-supported=0:1.25
Refer to the x-image-shift attribute description for additional information.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 359
ATTRIBUTES
y-image-shift
The y-image-shift attribute causes page images to be shifted in position with respect to the medium on which the page images are to be rendered. The direction of shift is parallel to the y-axis of the Reference Coordinate System (RCS).
The attribute enables requests for a different margin, possibly to correct a misalignment.
PrintXchange supports this attribute only for certain printers. Ask your system administrator for details.
Objects Document
Initial-value-document
M/S Single value
Settable Yes
Commands pdmod, pdpr, pdset (for document objects)
pdcreate, pdset (for initial-value-document objects)
Valid values Minus-infinity to plus-infinity
(may be a non-integer value)
Default value No default value
Comments The physical and logical printer attribute y-image-shift-range-supported identifies the range supported by the printer. The value of the y-image-shift attribute must be in this range for the job to be accepted and scheduled.
The sign of the attribute value indicates the direction of shift. A positive value indicates that the shift is in the positive y- direction. A negative value indicates that the shift is in the negative y- direction. The shift direction is the same for all pages, regardless of the value of the plex attribute.
y-image-shift-range-supported
The y-image-shift-range-supported attribute identifies the y-image-shift range supported by the printer.
PrintXchange supports this attribute only for certain printers. Ask your system administrator for details.
Objects Printer (logical and physical)
M/S Single value
Settable Yes
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 360
ATTRIBUTES
Commands pdcreate
pdset
Valid values A range specified by any two negative or positive numbers (may be non-integer values)
Default value No default value
Comments Example:
y-image-shift-range-suppored=0:1.25
Refer to the y-image-shift attribute description for additional information.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 361
ATTRIBUTES
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 362
B. Filters
Filter operations
The syntax for a filter used with the pdls or pdq command can be defined as a filter item or as a recursive filter. The syntax for a filter item is as follows:
attribute operator attribute_value
Table B-1. Allowable filter-item operators
examples List all jobs with a job-commen t that includes the substring "Budget" at the beginning of the string:
pdls -f "job-comment=*Budget" <spooler_name>:
List all jobs with a job-comment that includes the substring "budget" anywhere in the string:
pdls -f "job-comment*=*budget" <spooler_name>:
List all jobs belonging to "Bob" on a particular spooler:
pdls -x filter="job-owner==Bob" <spooler_name>:
Note: Filtering of client attributes is not supported.
Operator Description
= = Match string for equality (string, integer, etc.).
= * Match string for first part of a value using exact match criterion.
*= Match string for last part of a value using exact match criterion.
*=* Match string for any part of a value (i.e., a substring) using exact match criterion.
> = Match for a value greater than or equal to that specified.
< = Matches for a value less than or equal to that specified.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 363
FILTERS
There is one unary filter operator with the following syntax:
attribute operator
Table B-2. Allowable unary filter-item operator
examples List all jobs with a notification-profile attribute.
pdls -f "notification-profile*"
Recursive filter
The following operators can be used to define a filter recursively:
Table B-3. Allowable filter operators
Table B-4 lists the order of precedence for the allowable operators. Each attribute-value in a filter text must be a single value. You can use && and || to include multiple values. Remember that you can use the parentheses to group items for precedence.
Table B-4. Operator order of precedence
examples To list all of John's print jobs on a specific server that use anything other than North American letter white paper, specify the following filter text:
pdls -f "(user-name==John) && !(media-used==na-letter-white)" <server=name>:
Operator Description
* Match for attribute being present (any value).
Operator Description
filter-item && filter && = the “and” operator
filter-item || filter || = the “or” operator
!(filter) ! = the “not” operator
(filter) Use parentheses to group items for precedence.
Precedence Operator
1 ()
2 <=, >=, ==, =*, *=* , *=, *
3 !
4 &&
5 ||
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 364
C. Attribute mapping
The following tables list the job/document and supported/ready attribute comparisons that are made by the spooler in order to determine if a job should be accepted when it is submitted for printing, or scheduled for printing.
For a job to be accepted, the requested logical printer must be enabled. The job and document characteristics requested in the job submission must be supported by the logical printer. If there is no match, the spooler rejects the print request.
For a job to be scheduled for printing, a physical printer associated with the same queue as the logical printer must have the requested job and document attributes available and ready. If not, the spooler leaves the job pending. You can use the pddiagjob command to determine why the job is not being scheduled.
Table C-1. Job attributes matched to printer attributes
*job-copies , output-bin and results-delivery-method are elements of the attribute results-profile .
**The spooler does not do acceptance checking for printer-error-sheet even though there is a corresponding printer attribute (printer-error-sheets-supported ).
Job attribute Logical printer attribute used for accepting/rejecting a job submission
Physical printer attribute used for scheduling a job to print
document-sheets document-sheets-supported document-sheets-ready
job-copies* maximum-copies-supported maximum-copies-supported
job-finishing job-finishings-supported job-finishings-ready
job-offset job-offsets-supported job-offsets-ready
job-sheets job-sheets-supported job-sheets-ready
output-bin* output-bins-supported output-bins-ready
physical-printers-requested printer-associated-printers printer-associated-printers
printer-error-sheet ** printer-error-sheets-ready
results-delivery-method* job-result-set-delivery-methods-supported
job-result-set-delivery-methods-supported
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 365
ATTRIBUTE MAPPING
Table C-2. Document attributes matched to printer attributes
Document attribute Logical printer attribute used for accepting/rejecting a job submission
Physical printer attribute used for scheduling a job to print
binding-edge binding-edges-supported binding-edges-supported
binding-edge-image-shift binding-edge-image-shift-max-supported
binding-edge-image-shift-max-supported
copy-count maximum-copies-supported maximum-copies-supported
content-orientation content-orientations-supported content-orientations-supported
default-character-set character-sets-supported character-sets-ready
default-font fonts-supported fonts-ready
default-input-tray input-trays-supported input-trays-ready
default-medium media-supported media-ready
document-format document-formats-supported document-formats-ready
fax-resolution fax-resolutions-supported fax-resolutions-ready
finishing finishings-supported finishings-ready
gamut-mapping-method-used gamut-mapping-methods-supported gamut-mapping-methods-ready
highlight-colour highlight-colours-supported highlight-colours-ready
highlight-colour-rendering-algorithm
highlight-colour-rendering-algorithms-supported
highlight-colour-rendering-algorithms-supported
highlight-colour-mismatch-action highlight-colour-mismatch-actions-supported
highlight-colour-mismatch-actions-supported
highlight-mapping-colour highlight-mapping-colours-supported
highlight-mapping-colours-supported
number-up numbers-up-supported numbers-up-supported
output outputs-supported outputs-ready
page-select page-select-supported page-select-supported
plex plexes-supported plexes-supported
print-colour-type-used print-colour-types-supported print-colour-types-ready
sides sides-supported sides-ready
thickening-specification thickening-supported thickening-supported
x-image-shift x-image-shift-range-supported x-image-shift-range-supported
y-image-shift y-image-shift-range-supported y-image-shift-range-supported
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 366
D. Events
Table D-1 lists events, their classes, the print objects to which they apply, and the associated messages that are supported.
Table D-1. Events
Class/Event Object Message
aborted
document-aborted-by-server Document The server aborted the document.
job-aborted-by-server Job The server aborted the print job.
job-canceled-by-operator Job The operator canceled the print job.
job-canceled-by-user Job The user canceled the print job.
document-status
report-object-created Document The object was created.
report-object-deleted Document The object was deleted.
report-object-modified Document The object was modified.
error
error-job-submission-not-complete Job The server did not fully receive the job.
error-job-timed-out Job The spooler cannot communicate with the printer.
error-no-document Server A document for this print job is not accessible to the server.
error-past-discard-time Job The discard time for the print job passed.
error-other All The server encountered some uncategorized error condition.
job-attention
document-aborted-by-server Document The server aborted the document.
error-job-submission-not-complete Job The server did not fully receive the job.
error-job-timed-out Job The spooler cannot communicate with the printer.
error-no-document Server A document for this print job is not accessible to the server.
error-past-discard-time Job The discard time for the print job passed.
job-aborted-by-server Job The server aborted the print job.
job-canceled-by-operator Job The operator canceled the print job.
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 367
EVENTS
job-canceled-by-user Job The user canceled the print job.
warning-assigned-printer-needs-attention
Job The printer assigned to the job requires attention.
warning-close-to-discard-time Job The retention period is close to expiring.
warning-job-modified Job The print job was modified.
warning-job-paused Job The print job was paused.
warning-job-requeued Job The server requeued the job.
warning-printer-shutdown-job-requeued
Printer The printer shut down after this job started processing. The job will be requeued.
job-status
report-checkpoint-taken Job The server saved a checkpoint for the job.
report-file-transferred Document The client or server completed a file transfer.
report-job-assigned-to-queue Job The job was assigned to a queue.
report-job-completed Job The print job completed.
report-job-data-change Job The job encountered a data change on the following data:
printers-assignednotification-profilecurrent-job-statejob-namejob-priorityjob-discard-time
report-job-promoted Job The print job was promoted.
report-job-resubmitted Job The print job was resubmitted.
report-job-resumed Job The print job was resumed.
report-object-created Job The object was created.
report-object-deleted Job The object was deleted.
report-object-modified Job The object was modified.
report-object-paused Job The object was paused.
report-object-resumed Job The object was resumed.
report-printing-started Job The server began printing the job.
report-processing-started Job The server began processing the job.
state-changed-job Job The job state changed to '...'.
printer-attention
warning-assigned-printer-needs-attention
Job The printer assigned to the job requires attention.
Class/Event Object Message
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 368
EVENTS
warning-printer-needs-attention Printer The printer needs attention. The message will include additional information on the problem:
cover-openduplex-failinput-tray-failjammedno-cassetteno-drumoutput-bin-fulloutput-tray-failservice-requestedother
warning-printer-shutdown-job-requeued
Printer The printer shut down after this job started processing. The job will be requeued.
warning-printer-timed-out Printer The physical printer timed out.
warning-printer-unable-to-register Printer The physical printer could not register with the queue.
warning-resource-needs-attention Printer A resource needs the attention of a key operator.
printer-status
report-object-created Printer The object was created.
report-object-deleted Printer The object was deleted.
report-object-modified Printer The object was modified.
report-object-paused Printer The object was paused.
report-object-resumed Printer The object was resumed.
report-printer-data-change Printer The printer encountered a data change on the following data:
printer-nameprinter-locationsprinter-statemaximum-printer-speed
report-printer-received-attention Printer A previous problem with the printer was resolved.
report-printer-registered Printer The printer registered with the spooler.
report-printer-unregistered Printer The printer unregistered with the spooler.
state-changed-printer Printer The printer state changed to '...'.
queue-attention
warning-queue-backlogged Queue The queue is backlogged.
warning-queue-clean-aborted Queue The queue aborted a clean command.
warning-queue-resubmit-aborted Queue The queue aborted a resubmit command.
queue-status
report-object-cleaned Queue The object was cleaned.
report-object-created Queue The object was created.
Class/Event Object Message
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 369
EVENTS
report-object-deleted Queue The object was deleted.
report-object-modified Queue The object was modified.
report-object-paused Queue The object was paused.
report-object-resumed Queue The object was resumed.
report-queue-clean-completed Queue The queue completed a clean command.
report-queue-not-backlogged Queue The queue is no longer backlogged.
report-queue-resubmit-completed Queue The print jobs in the queue were resubmitted.
state-changed-queue Queue The queue state changed to '...'.
report
report-checkpoint-taken Job The server saved a checkpoint for the job.
report-file-transferred Document The client or server completed a file transfer.
report-job-assigned-to-queue Job The job was assigned to a queue.
report-job-completed Job The print job completed.
report-job-data-change Job The job encountered a data change on the following data:
printers-assignednotification-profilecurrent-job-statejob-namejob-priorityjob-discard-time
report-job-discarded Job The server discarded the job. The retention period expired.
report-job-promoted Job The print job was promoted.
report-job-resubmitted Job The print job was resubmitted.
report-job-resumed Job The print job was resumed.
report-object-cleaned QueueServer
The object was cleaned.
report-object-created DocumentJobPrinterQueue
The object was created.
report-object-deleted DocumentJobPrinterQueueServer
The object was deleted.
report-object-modified DocumentJobPrinterQueueServer
The object was modified.
Class/Event Object Message
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 370
EVENTS
report-object-paused JobPrinterQueueServer
The object was paused.
report-object-resumed JobPrinterQueueServer
The object was resumed.
report-printer-data-change Printer The printer encountered a data change on the following printer data:
printer-nameprinter-locationsprinter-statemaximum-printer-speed
report-printer-received-attention Printer A previous problem with the printer was resolved.
report-printer-registered Printer The printer registered with the spooler.
report-printer-unregistered Printer The printer unregistered with the spooler.
report-printing-started Job The server began printing the job.
report-processing-started Job The server began processing the job.
report-queue-clean-completed Queue The queue completed a clean command.
report-queue-not-backlogged Queue The queue is no longer backlogged.
report-queue-resubmit-completed Queue The print jobs in the queue were resubmitted.
report-server-clean-completed Server The server completed a clean command.
report-server-data-change Server The server encountered a data change.add-logical-printerset-logical-printerdelete-logical-printeradd-physical-printerset-physical-printerdelete-physical-printeradd-jobset-jobdelete-job
report-server-shutdown-started Server The server started a shutdown command.
report-server-startup-complete Server The server started.
server-attention
error-other All The server encountered some uncategorized error condition.
warning-server-clean-aborted Server The server aborted a clean command.
warning-other All The server encountered some uncategorized warning condition.
server-status
report-object-cleaned Server The object was cleaned.
Class/Event Object Message
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 371
EVENTS
report-object-deleted Server The object was deleted.
report-object-modified Server The object was modified.
report-object-paused Server The object was paused.
report-object-resumed Server The object was resumed.
report-server-clean-completed Server The server completed a clean command.
report-server-data-change Server The server encountered a data change.add-logical-printerset-logical-printerdelete-logical-printeradd-physical-printerset-physical-printerdelete-physical-printeradd-jobset-jobdelete-job
report-server-shutdown-started Server The server started a shutdown command.
report-server-startup-complete Server The server started.
state-changed-server Server The server state changed to '...'.
state-changed
state-changed-job Job The job state changed to '...'.
state-changed-printer Printer The printer state changed to '...'.(when printer-state changed)
The printer was enabled(when printer enabled)
The printer was disabled(when printer disabled)
state-changed-queue Queue The queue state changed to '...'.(when state changed)
The queue was enabled(when queue enabled)
The queue was disabled(when queue disabled)
state-changed-server Server The server state changed to '...'.(when server-state changed)
The server was enabled(when server enabled)
The server was disabled(when server disabled)
warning
warning-assigned-printer-needs-attention
Job The printer assigned to the job requires attention.
warning-close-to-discard-time Job The retention period is close to expiring.
Class/Event Object Message
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 372
EVENTS
warning-job-modified Job The print job was modified.
warning-job-paused Job The print job was paused.
warning-job-requeued Job The server requeued the job.
warning-other All The server encountered some uncategorized warning condition.
warning-printer-needs-attention Printer The printer needs attention. The message includes additional information on the problem:
cover-openduplex-failinput-tray-failjammedno-cassetteno-drumoutput-bin-fulloutput-tray-failservice-requestedother
warning-printer-shutdown-job-requeued
Printer The printer shut down after this job started processing. The job will be requeued.
warning-printer-timed-out Printer The physical printer timed out.
warning-printer-unable-to-register Printer The physical printer could not register with the queue.
warning-queue-backlogged Queue The queue is backlogged.
warning-queue-clean-aborted Queue The queue aborted a clean command.
warning-queue-resubmit-aborted Queue The queue aborted a resubmit command.
warning-resource-needs-attention Printer A resource needs attention.
warning-server-clean-aborted Server The server aborted a clean command.
Class/Event Object Message
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 373
EVENTS
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 374
E. -r verbose and -r brief attributes
The brief and verbose values for the -r option cause specific attributes to be printed to standard output. For each object, all attributes in the associated column appear in the verbose listing, while only the attributes shown in bold appear in the brief listing.
Table E-1. Verbose and brief listing for server, printer, queue, and job objects
Table E-2. Verbose and brief listing for document, initial-value-job, and initial-value-document objects
Server Printer Queue Job
server-name printer-name queue-name job-identifier
server-state printer-realization logical-printers-ready job-name
enabled printer-state logical-printers-supported current-job-state
logical-printers-supported
enabled physical-printers-ready job-state-reasons
physical-printers-supported
associated-server physical-printers-supported
intervening-jobs
printer-locations printer-name-requested
printer-associated-printers printers-assigned
total-job-octets
job-owner
Document Initial-value-job Initial-value-document
document-sequence-number
initial-value-job-identifier initial-value-document-identifier
document-format associated-server associated-server
document-state job-retention-period copy-count
copy-count printer-locations-requested sides
sides printer-models-requested document-format
document-type logical-printers-ready logical-printers-ready
octet-count physical-printers-ready physical-printers-ready
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 375
-R VERBOSE AND -R BRIEF ATTRIBUTES
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 376
Index
A
aborted events, 367access-control-list
attribute, 140 to 144domain examples, 141elements, 140local file (onc-file) domain type examples, 142NT Security domain type examples, 142null string domain name examples, 142value examples, 141 to 144Win95 domain type examples, 143 to 144WinNT domain type examples, 143
accountingdata record, 28 to 29deleting files, 26profile, 28spooler name, 27
accounting_log_path, pdaccount, 27accounting-enabled attribute, 144 to 145accounting-information attribute, 145accounting-profile attribute, 146add-document-operations attribute, 146administrator
commands, 9user privileges, 7
after-all, 121after-current, 121arguments
options, 12syntax, 10
assigned-queue attribute, 147associated-queue attribute, 147associated-server attribute, 148asynch-events-supported attribute, 148attribute=value pairs
pdclean, 33pdcreate, 40 to 41pddelete, 47pddisable, 53pdenable, 57pdls, 62pdmod, 71pdpr, 85pdpromote, 90pdq, 96pdresubmit, 100pdresume, 105pdrm, 108
pdset, 114pdshutdown, 121
attribute_filenamepdclean, 33pdcreate, 41pddelete, 48pddisable, 53pdenable, 57pdls, 63pdmod, 72pdpause, 78pdpr, 86pdpromote, 90pdq, 97pdresubmit, 101pdresume, 105pdrm, 109pdset, 116pdshutdown, 122
attributesclearing values, 20directory, 139displaying, 59 to 65files, 20 to 21files, special rules, 21mapping, 45, 365 to 366objects, 15quoting rules, 17 to 20-r brief, 375-r verbose, 375setting, 111 to 118types, 15value string syntax, 17 to 20
attributes attribute, 149availability attribute, 150
B
BASH, 5binding-edge attribute, 150binding-edge-image-shift attribute, 151binding-edge-image-shift-max-supported attribute,
152binding-edges-supported attribute, 152bottom-margin attribute, 153Bourne Again Shell, see BASHBourne shell, 17brief values, 375
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 377
INDEX
C
C shell, quoting rules, 18cancel-individual-document-supported attribute, 154cancel-job-operations attribute, 154 to 155character-sets-ready attribute, 155character-sets-supported attribute, 155 to 156class attribute, 156class_name
pdclean, 32pdcreate, 38pddelete, 46pddisable, 52pdenable, 56pdls, 60pdpause, 77pdresubmit, 100pdresume, 104pdset, 112pdshutdonw, 120
clean-operations attribute, 157client attributes, 16, 138
pdls, 62pdpause, 78pdpr, 85pdresubmit, 100pdresume, 105pdrm, 108pdset, 115
close-job-operations attribute, 157 to 158column headings, omitting, 39, 61, 112commands, 8 to 10comment character, 21completion-time attributes, 158conformance-levels-supported attribute, 158 to 159connectivity attributes, printer, 36content-orientation attribute, 159 to 160content-orientations-supported attribute, 160copies
pdmod, 68pdpr, 83
copies-completed attribute, 161copy-count attribute, 161copy-from attribute, 162count-limit attribute, 162create operations attribute, 163create-job-operations attribute, 163current-job-state attribute, 164
D
date, specifying, 26days-to-keep-acct-logs attribute, 165default-accounting-profile attribute, 165 to 166default-character-set attribute, 167 to 169default-document-format attribute, 169default-font attribute, 170
default-input-tray attribute, 170default-job-completion-period attribute, 171default-medium attribute, 171 to 173default-user-job-priority attribute, 173delete-operations attribute, 174descriptor attribute, 174device-query-channel-ready attribute, 175device-query-channels-supported attribute, 176device-query-interval attribute, 176 to 177device-query-library-name attribute, 177 to 178device-status-query-supported attribute, 178disable-backlogged-queue attribute, 178 to 179disable-operations attribute, 179document
attributes, 71, 134 to 135modifying attributes, 67setting attributes, 111
document-file-name attribute, 180document-filename attribute, 180document-format attribute, 181 to 183document-formats-ready attribute, 183document-formats-supported attributes, 184document-name attribute, 184document-sequence-number attribute, 185document-sheets attribute, 185 to 186document-sheets-ready attribute, 186document-sheets-supported attribute, 187document-state attribute, 187document-status events, 367document-type attribute, 188docuprint-job-pool-version attribute, 188 to 189domain examples, access control, 141domain-name attribute, 189DPA (Document Printing Application), 158driver-server attribute, 189 to 190
E
enabled attribute, 190 to 191enable-operations attribute, 190end user
commands, 10privileges, 6
end_date, pdaccount, 26environment variables, 22error events, 367event notification
job submissions, 88messages, 367 to 373
events-supported attribute, 191excluded-preprocessors attribute, 191 to 192exit values, 23extended_attribute_string
pdclean, 33pdcreate, 40 to 41pddelete, 47pddisable, 53
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 378
INDEX
pdenable, 57pdls, 62pdmod, 71pdpause, 78pdpr, 85pdpromote, 90pdq, 96pdresubmit, 100pdresume, 105pdrm, 108pdset, 114pdshutdonw, 121
F
fax-resolution attribute, 192fax-resolutions-ready attribute, 193fax-resolutions-supported attribute, 193filename, pdpr, 82, 86file-reference transfer, 87file-reference-is-local-only attribute, 194files
attributes, 20 to 21attributes, special rules, 21transfer methods, 87
filter attribute, 194filter_text
pdls, 60pdq, 94
filtering, turning off, 61filters, 363 to 364finishing attribute, 195 to 196finishings-ready attribute, 196finishings-supported attribute, 197fonts-ready attribute, 197fonts-supported attribute, 198footer-text attribute, 199formatting output, 62
G
goj-cont-operations attribute, 199goj-operations attribute, 200
H
header lines, 26header-text attribute, 200headings attribute, 201highlight-colour attribute, 202highlight-colour-mismatch-action attribute, 202 to 203highlight-colour-rendering-algorithm attribute, 203 to
204highlight-colour-rendering-algorithms-supported
attribute, 204 to 205highlight-colours-ready attribute, 205highlight-colours-supported attribute, 206
highlight-mapping-colour attribute, 206 to 207highlight-mapping-colours-supported attribute, 207hold-jobs-interrupted-by-printer failure attribute, 208
I
ignore-preprocessing-failure attribute, 209impressions-completed attribute, 210initial-value-document
attributes, 137 to 138creating, 35 to 42deleting, 43 to 49
initial-value-document attribute, 210initial-value-document-identifier attribute, 211initial-value-job
attributes, 136creating, 35 to 42deleting, 43 to 49
initial-value-job attribute, 211initial-value-job-identifier attribute, 212input-trays-medium attribute, 212 to 213input-trays-ready attribute, 213input-trays-supported attribute, 214intervening-jobs attribute, 214ivdoc_name
creating, 41listing attributes, 64pddelete, 48pdset, 117
ivj_name, creating, 41ivjob_name
listing attributes, 64pddelete, 48pdset, 117
J
job_idlisting attributes, 63pddelete, 48pdq, 97pdresubmit, 101pdresume, 106pdrm, 110pdset, 117promoting, 91unique identifier, 79
job_namepdmod, 70pdpr, 85
job-attention events, 367job-attributes-visible-to-all attribute, 215job-cancel-channel-ready attribute, 216job-cancel-channels-supported attribute, 216job-cancellation-supported attribute, 217job-cancel-library-name attribute, 217job-collate-preserved attribute, 218
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 379
INDEX
job-comment attribute, 218job-completion-period attribute, 219job-copies attribute, 220job-copies-completed attribute, 220job-discard-time attribute, 221job-fault-count attribute, 221job-finishing attribute, 222job-finishings-ready attributes, 223job-finishings-supported attribute, 223 to 224job-hold attribute, 224 to 225job-identifier attributes, 225job-identifier-for-monitor attribute, 225 to 226job-identifier-on-client attribute, 226 to 227job-identifiers-on-device attribute, 227job-message-from-administrator attribute, 227 to 228job-message-to-operator attribute, 228job-name attribute, 228 to 229job-offset attribute, 229job-offsets-ready attribute, 230job-offsets-supported attribute, 230 to 231job-originating-host attribute, 231job-originator attribute, 231 to 232job-owner attribute, 232job-page-count attribute, 233job-print-after attribute, 233 to 234job-priority attribute, 234job-promote-time attribute, 235job-query-channel-ready attribute, 235job-query-channels-supported attribute, 236job-query-interval attribute, 236 to 237job-query-library-name attribute, 237job-result-set-delivery-methods-ready attribute, 238job-result-set-delivery-methods-supported attribute,
239job-retention-period attribute, 239jobs
acceptance criteria, 365attributes, 71, 132 to 133backing up, 31cleaning spooler, 31 to 34completed, notification, 83completion notification, 69deleting, 45identifying, 97, 110listing, 93modifying attributes, 67 to 74new name, 70pausing, 75promoting to first, 89 to 92removing, 107 to 110resubmitting, 99 to 102resuming, 103setting attributes, 111stopping, 107submission notification, 88submitting, 81 to 87
job-sheets attribute, 240 to 241
job-sheets-ready attribute, 241job-sheets-supported attribute, 242jobs-pending attribute, 248job-state-message attribute, 242job-state-reasons attribute, 243job-status events, 368job-status-query-supported attribute, 244job-submission-channel-ready attribute, 244 to 245job-submission-channels-supported attribute, 245job-submission-channel-used attribute, 245job-submission-complete attribute, 246job-submission-library-name attribute, 246job-submission-timeout attribute, 247job-to-be-billed attribute, 248
K
Korn shell, 17
L
left-margin attribute, 249length attribute, 250line length, attribute file, 21list-of-managers attribute, 251loa-abort-operations attribute, 251loa-cont-operations attribute, 252load balancing, 255loa-operations attribute, 252 to 253local file (onc-file) domain type examples, 142Local File environment, 36Local File, pddelete, 43locale attribute, 253locales-supported attribute, 253 to 254logical printer
see also printerattributes, 127 to 128creating, 37deleting, 44enabling, 55identifying, 101selecting, 83specifying, 95
logical-printers-ready attribute, 254logical-printers-supported attribute, 254
M
mapping attributes, 45, 204 to 205, 365 to 366max-concurrent-job-processing attribute, 255 to 256maximum-copies-supported attribute, 257maximum-number-of-printers-supported attribute,
258maximum-printer-speed attribute, 259max-number-of-system-logs attribute, 256max-user-job-priority attribute, 257media-consumed attribute, 259
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 380
INDEX
media-ready attribute, 260media-sheets-completed attribute, 260media-supported attribute, 261message attribute, 261 to 262message_text
pdclean, 32pdcreate, 39pddelete, 47pddisable, 53pdenable, 56pdmod, 68pdpause, 77pdpromote, 90pdresume, 104pdrm, 108pdset, 112pdshutdown, 120
messagescanceled jobs, 108events, 367 to 373paused objects, 77pdpromote, 90queue, 32resuming operation, 104setting, 112shutting down, 120spooler, 32
mib-library-name attribute, 262mib-type attribute, 263modification operators
pdmod, 72pdset, 115
modify-individual-document-supported attribute, 263modify-job-operations attribute, 264multiple-documents-supported attribute, 264
N
Name Service, 35native-document-formats-ready attribute, 265 to 266NIS
environment, 36pddelete, 43
NIS NameSpace database, 36, 43no-preprocessing attribute, 267notification_method
pdmod, 69pdpr, 83
notification-delivery-methods-ready attribute, 267 to 268
notification-delivery-methods-supported attribute, 268
notification-profile attribute, 269 to 271NT Security domain type examples, 142null string domain name examples, 142number-job-on-device attribute, 271 to 272
number-of-documents attribute, 273number-of-printers-supported attribute, 273number-pages attribute, 274numbers-up-supported attribute, 275 to 276number-up attribute, 274 to 275
O
objectattributes, 15classes, 14
object identifier database, see OIDobject_instance, pdresubmit, 101object-class attribute, 276object-classes supported attribute, 277objects
identifying class/type, 104, 120pausing, 75 to 80resuming operation, 103 to 106setting attributes, 111 to 118
octet-count attribute, 277OID path, 27oid_database_path, pdaccount, 27operands, 12 to 14
syntax, 13operator
commands, 9user privileges, 6
operators, filters, 363 to 364option arguments, 12options, 10 to 12orientation, see content-orientationoriginal-document-format attribute, 278 to 279output
column headings, 94formatting, 62pdaccount, 26
output attribute, 280output file
naming, 26specifying attributes, 26
output-bin attribute, 281output-bin-sorter-available-count attribute, 282output-bins-ready attribute, 282output-bins-supported attribute, 283outputs-ready attribute, 283outputs-supported attribute, 284
P
paf, 36page-count attribute, 285page-media-select attribute, 285page-order-received attribute, 286pages-completed attribute, 287page-select attribute, 286
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 381
INDEX
pathaccounting log data, 27attribute file, 21OID, 27
pause-job-operations attribute, 287pause-operations attribute, 288pddiagjob, 365PDPRINTER environment variable, 42, 82, 83Perl, 5PGR name service, 35, 43physical printer
attributes, 127 to 128, 128 to 130creating, 36deleting, 44enabling, 55pausing, 76resuming, 103, 106see also printers
physical/logical printers attribute, 302physical-printers-ready attribute, 288physical-printers-requested attribute, 289physical-printers-supported attribute, 290plex attribute, 290 to 291plexes-supported attribute, 292POSIX shell, 17Practical Extraction and Report Language, see Perlpreferred-printer-drivers attribute, 292preprocessor-definition attribute, 295 to 296preprocessor-list attribute, 297preprocessors, sequencing, 297previous-job-state attribute, 298print job accounting, 25 to 29print job, see jobsprint-colour-types-ready attribute, 298 to 299print-colour-types-supported attribute, 299print-colour-type-used attribute, 300printer
attributes, 127 to 130connectivity attributes, 36creating, 35 to 42enabling, 55 to 58
printer attribute file, see pafprinter_name
creating, 41enabling, 57listing attributes, 64pausing physical printer, 79pddelete, 48pddisable, 54pdpr, 83pdq, 95pdresume, 106pdset, 117
printer-address attribute, 301 to 302printer-associated-printers attribute, 302printer-attention events, 368
printer-baud-rate attribute, 303printer-connection-level attribute, 304 to 305printer-connection-method attribute, 306printer-connection-methods-supported attribute, 307printer-connect-timeout-period attribute, 304printer-data-bits attribute, 307printer-drum-level attribute, 308printer-drum-threshold attribute, 308printer-error-sheet attribute, 309printer-error-sheets-ready attribute, 310printer-error-sheets-supported attribute, 310printer-initial-value-document attribute, 311printer-initial-value-job attribute, 312printer-ink-or-toner-level attribute, 312printer-ink-or-toner-threshold attribute, 313 to 314printer-input-flow-control attribute, 314printer-locations attribute, 315printer-model attribute, 315printer-name attribute, 316printer-name-requested attribute, 316 to 317printer-output-flow-control attribute, 317printer-paper-level attribute, 317 to 318printer-paper-threshold attribute, 318 to 319printer-parity attribute, 319printer-problem-message attribute, 320printer-realization attribute, 320printer-resource-warning-raised attribute, 321printers
deleting, 43 to 49disabling, 51 to 54
printers-assigned attribute, 324printers-ready attribute, 324 to 325printer-state attribute, 321printer-status events, 369printer-stop-bits attribute, 322printer-tcpip-port-number attribute, 323printer-timeout-period attribute, 323 to 324printing jobs, 81 to 87privileges, user, 6promote-job-operations attribute, 325proxy-submit-supported attribute, 325 to 326
Q
queueattributes, 131creating, 35 to 42deleting, 45displaying, 93 to 98enabling, 37, 55 to 58filtering objects, 94name, 33pausing, 76promoting jobs, 89 to 92resuming, 103see also spooler
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 382
INDEX
queue_namecreating, 41enabling, 57identifying, 79listing attributes, 64pddelete, 48pddisable, 54pdresubmit, 101pdresume, 106pdset, 117
queue-attention events, 369queue-backlog-lower-limit attribute, 326queue-backlog-upper-limit attribute, 326 to 327queue-name attribute, 327queue-problem-message attribute, 328queues
deleting, 43 to 49disabling, 51 to 54
queues-supported attribute, 328queue-status events, 369quoting rules, 17 to 20quoting rules, attribute value strings, 17 to 20
R
recursive filter, 364repeated-tab-stops attribute, 329report events, 370 to 371reports
formats, 84, 96formatting, 40, 70, 113new name, 85print job accounting, 25 to 29selecting attributes, 69, 84specifying attributes, 39, 61, 95, 113
requested_attributespdcreate, 39pdls, 61pdmod, 69pdpr, 84pdq, 95pdset, 113
requested-attributes attribute, 329reset-printer attribute, 330resubmit-job-operations attribute, 331results-delivery-address attribute, 331results-delivery-method attribute, 332results-profile attribute, 332 to 334results-set-comment attribute, 334resume-job-operations attribute, 335resume-operations attribute, 335retention_period, pdrm, 108retention-period attribute, 336right-margin attribute, 336
S
scope attribute, 337send-event-operations attribute, 338server
attributes, 124 to 130disabling, 51 to 54enabling, 55 to 58processing before shutdown, 120resuming operation, 106shutting down, 119 to 122
server_nameenabling, 57listing attributes, 64pddelete, 48pddisable, 54pdset, 117pdshutdown, 122
server-attention events, 371server-hostname attribute, 338server-name attribute, 339server-operating-system attribute, 339server-state attribute, 340server-status events, 371server-type attribute, 340server-version attribute, 341set-operations attribute, 341shutdown-operations attribute, 342sides attribute, 342sides-ready attribute, 343sides-supported attribute, 343snmp-req-community-string attribute, 344socket transfer, 87spooler
accounting, 28accounting data, 27attributes, 124 to 125, 126deleting, 44enabling, 56jobs, retention period, 108logical printer, 37moving documents, 87name, 33pausing, 76removing jobs, 31 to 34resuming, 103shutting down, 119see also queue
spooler_namepausing, 79pdresume, 106
spooler-preprocessor-list attribute, 345start_date, pdaccount, 26started-printing-time attribute, 345state attribute, 346state-changed events, 372style attribute, 346 to 347
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 383
INDEX
style_namepdcreate, 40pdls, 62pdmod, 70pdpr, 84pdq, 96pdset, 113
submission-time attribute, 347supervisor
attributes, 124 to 126deleting, 45physical printer, 36shutting down, 119
supervisor-preprocessor-list attribute, 347 to 348syntax elements, 8 to 14system-log-file-path attribute, 348system-logging-enabled attribute, 350system-log-severity attribute, 349system-log-size attribute, 350sys-up-date-and-time attribute, 348
T
target_printer_name, pdresubmit, 101thickening-specification attribute, 351thickening-supported attribute, 351time-limit attribute, 352top-margin attribute, 353total-job-octets attribute, 354transfer methods, 87transfer-method attribute, 354 to 355transfer-methods-supported attribute, 355
U
UNIX workstation, 4user privileges, 6user-name attribute, 356
V
value string syntax, attributes, 17 to 20values, exit, 23variables, environment, 22verbose values, 375
W
wait-for-all-document-preprocessing-to-complete attribute, 356
warning events, 372when attribute, 357when_time, pdshutdown, 120width attribute, 357 to 358Win95 domain type examples, 143 to 144WindowsNT Command Interpreter, quoting rules, 19
to 20WinNT domain type examples, 143with-request transfer, 87
X
x-image-shift attribute, 358 to 359x-image-shift-range-supported attribute, 359
Y
y-image-shift attribute, 360y-image-shift-range-supported attribute, 360 to 361
PRINTXCHANGE COMMAND LINE INTERFACE REFERENCE GUIDE 384