draft-ietf-ipp-model-05.txt   draft-ietf-ipp-model-06.txt 
INTERNET-DRAFT INTERNET-DRAFT
draft-ietf-ipp-model-05.txt draft-ietf-ipp-model-06.txt
R. deBry R. deBry
IBM Corporation IBM Corporation
T. Hastings T. Hastings
Xerox Corporation Xerox Corporation
R. Herriot R. Herriot
Sun Microsystems Sun Microsystems
S. Isaacson S. Isaacson
Novell, Inc. Novell, Inc.
P. Powell P. Powell
San Diego State University San Diego State University
September 3, 1997 October 14, 1997
Internet Printing Protocol/1.0: Model and Semantics Internet Printing Protocol/1.0: Model and Semantics
Status of this Memo Status of this Memo
This document is an Internet-Draft. Internet-Drafts are working This document is an Internet-Draft. Internet-Drafts are working
documents of the Internet Engineering Task Force (IETF), its areas, documents of the Internet Engineering Task Force (IETF), its areas,
and its working groups. Note that other groups may also distribute and its working groups. Note that other groups may also distribute
working documents as Internet-Drafts. working documents as Internet-Drafts.
skipping to change at page 1, line 44 skipping to change at page 1, line 44
munnari.oz.au (Pacific Rim), ds.internic.net (US East Coast), or munnari.oz.au (Pacific Rim), ds.internic.net (US East Coast), or
ftp.isi.edu (US West Coast). ftp.isi.edu (US West Coast).
Abstract Abstract
This document is one of a set of documents, which together describe This document is one of a set of documents, which together describe
all aspects of a new Internet Printing Protocol (IPP). IPP is an all aspects of a new Internet Printing Protocol (IPP). IPP is an
application level protocol that can be used for distributed printing application level protocol that can be used for distributed printing
using Internet tools and technology. The protocol is heavily using Internet tools and technology. The protocol is heavily
influenced by the printing model introduced in the Document Printing influenced by the printing model introduced in the Document Printing
Application (ISO/IEC 10175 DPA) standard. Although DPA specifies both Application (DPA) [ISO10175] standard. Although DPA specifies both
end user and administrative features, IPP version 1.0 is focused only end user and administrative features, IPP version 1.0 is focused only
on end user functionality. on end user functionality.
Expires April 14, 1998
The full set of IPP documents includes: The full set of IPP documents includes:
deBry, Hastings, Herriot, Isaacson, Powell Requirements for an Internet Printing Protocol [IPP-REQ]
Expires March3, 1998
Internet Printing Protocol: Requirements
Internet Printing Protocol/1.0: Model and Semantics Internet Printing Protocol/1.0: Model and Semantics
Internet Printing Protocol/1.0: Security Internet Printing Protocol/1.0: Protocol Specification [IPP-PRO]
Internet Printing Protocol/1.0: Protocol Specification Rationale for the Structure and Model and Protocol for the Internet
Internet Printing Protocol/1.0: Directory Schema Printing Protocol [IPP-RAT]
The requirements document takes a broad look at distributed printing
functionality, and it enumerates real-life scenarios that help to
clarify the features that need to be included in a printing protocol
for the Internet. It identifies requirements for three types of
users: end users, operators, and administrators. The requirements
document calls out a subset of end user requirements that MUST be
satisfied in the first version of IPP. Operator and administrator
requirements are out of scope for v1.0. The model and semantics
document describes a simplified model with abstract objects, their
attributes, and their operations. The model introduces a Printer
object and a Job object. The Job object supports multiple documents
per job. The security document covers potential threats and proposed
counters to those threats. The protocol specification is formal
document which incorporates the ideas in all the other documents into
a concrete mapping using clearly defined data representations and
transport protocol mappings that real implementers can use to develop
interoperable client and server side components. Finally, the
directory schema document shows a generic schema for directory service
entries that represent instances of IPP Printers.
This document is the "Internet Printing Protocol/1.0: Model and The requirements document, "Requirements for an Internet Printing
Semantics" document. Protocol", takes a broad look at distributed printing functionality,
and it enumerates real-life scenarios that help to clarify the
features that need to be included in a printing protocol for the
Internet. It identifies requirements for three types of users: end
users, operators, and administrators. The requirements document calls
out a subset of end user requirements that MUST be satisfied in the
first version of IPP. Operator and administrator requirements are out
of scope for v1.0. This document, "Internet Printing Protocol/1.0:
Model and Semantics", describes a simplified model with abstract
objects, their attributes, and their operations. The model introduces
a Printer object and a Job object. The Job object supports multiple
documents per job. The model document also addresses how security,
internationalization, and directory issues are addressed. The protocol
specification, " Internet Printing Protocol/1.0: Protocol
Specification", is a formal mapping of the abstract operations and
attributes defined in the model document onto HTTP/1.1. The protocol
specification defines the encoding rules for a new Internet media type
called "application/ipp".
deBry, Hastings, Herriot, Isaacson, Powell Expires April 14, 1998
Expires February xx, 1998
Table of Contents Table of Contents
1. Simplified Printing Model .......................................7 1. Simplified Printing Model .......................................8
2. IPP Objects .....................................................9 2. IPP Objects ....................................................10
2.1 Printer Object..................................................9 2.1 Printer Object................................................10
2.2 Job Object.....................................................12 2.2 Job Object....................................................13
2.3 Document Object................................................12 2.3 Object Relationships..........................................14
2.4 Object Relationships...........................................12 2.4 Object Identity...............................................14
2.5 Object Identity................................................13
3. IPP Operations .................................................15 3. IPP Operations .................................................15
3.1 General Semantics..............................................16 3.1 General Semantics.............................................16
3.1.1 Operation Targets........................................16 3.1.1 Operation Characteristics................................16
3.1.2 Operation Status Codes and Messages......................16 3.1.2 Operation Targets........................................18
3.1.3 Security Concerns for IPPOperations......................17 3.1.3 Character Set and Natural Language Operation Attributes..19
3.1.3.1 Authenticated Requester Identity .......................17 3.1.3.1 Request Operation Attributes ..........................19
3.1.3.2 Restricted Queries .....................................17 3.1.3.2 Response Operation Attributes .........................20
3.1.4 Versions.................................................18 3.1.4 Operation Status Codes and Messages......................21
3.1.5 Job Creation Operations..................................18 3.1.5 Security Concerns for IPP Operations.....................22
3.2 Printer Operations.............................................20 3.1.5.1 Authenticated Requester Identity ......................22
3.2.1 Print-Job Operation......................................20 3.1.5.2 Restricted Queries ....................................23
3.2.1.1 Print-Job Request ......................................20 3.1.6 Versions.................................................23
3.2.1.2 Print-Job Response .....................................22 3.1.7 Job Creation Operations..................................24
3.2.2 Print-URI Operation......................................23 3.2 Printer Operations............................................26
3.2.3 Validate-Job Operation...................................23 3.2.1 Print-Job Operation......................................26
3.2.4 Create-Job Operation.....................................23 3.2.1.1 Print-Job Request .....................................26
3.2.5 Get-Attributes Operation.................................24 3.2.1.2 Print-Job Response ....................................28
3.2.5.1 Get-Attributes Request .................................24 3.2.2 Print-URI Operation......................................30
3.2.5.2 Get-Attributes Response ................................25 3.2.3 Validate-Job Operation...................................31
3.2.6 Get-Jobs Operation.......................................25 3.2.4 Create-Job Operation.....................................31
3.2.6.1 Get-Jobs Request .......................................25 3.2.5 Get-Attributes Operation.................................31
3.2.6.2 Get-Jobs Response ......................................26 3.2.5.1 Get-Attributes Request ................................32
3.3 Job Operations.................................................27 3.2.5.2 Get-Attributes Response ...............................33
3.3.1 Send-Document Operation..................................27 3.2.6 Get-Jobs Operation.......................................34
3.3.1.1 Send-Document Request ..................................27 3.2.6.1 Get-Jobs Request ......................................34
3.3.1.2 Send-Document Response .................................28 3.2.6.2 Get-Jobs Response .....................................35
3.3.2 Send-URI Operation.......................................29 3.3 Job Operations................................................36
3.3.3 Cancel Job Operation.....................................29 3.3.1 Send-Document Operation..................................37
3.3.3.1 Cancel-Job Request .....................................29 3.3.1.1 Send-Document Request .................................37
3.3.3.2 Cancel-Job Response ....................................29 3.3.1.2 Send-Document Response ................................39
3.3.4 Get-Attributes Operation.................................29 3.3.2 Send-URI Operation.......................................39
3.3.4.1 Get-Attributes Request .................................30 3.3.3 Cancel Job Operation.....................................39
3.3.4.2 Get-Attributes Response ................................30 3.3.3.1 Cancel-Job Request ....................................40
4. Object Attributes ..............................................31 3.3.3.2 Cancel-Job Response ...................................40
4.1 Attribute Syntaxes.............................................31 3.3.4 Get-Attributes Operation.................................41
4.2 Job Template Attributes........................................33 3.3.4.1 Get-Attributes Request ................................41
4.2.1 job-sheets (type4 keyword)...............................37 3.3.4.2 Get-Attributes Response ...............................41
4.2.2 notify-events (1setOf type2 keyword).....................38 4. Object Attributes ..............................................42
4.2.2.1 Event Notification Content .............................38 4.1 Attribute Syntaxes............................................42
4.1.1 'text'...................................................43
deBry, Hastings, Herriot, Isaacson, Powell Expires April 14, 1998
Expires February xx, 1998 4.1.2 'name'...................................................44
4.2.3 notify-addresses (1setOf uri)............................39 4.1.3 'keyword'................................................44
4.2.4 job-priority (integer(1:100))............................39 4.1.4 'enum'...................................................45
4.2.5 job-hold-until (type4 keyword)...........................40 4.1.5 'uri'....................................................45
4.2.6 multiple-document-handling (type2 keyword)...............40 4.1.6 'uriScheme'..............................................45
4.2.7 media (type4 keyword)....................................41 4.1.7 'charSet'................................................46
4.2.8 number-up (type3 keyword)................................42 4.1.8 'naturalLanguage'........................................46
4.2.9 sides (type2 keyword)....................................42 4.1.9 'mimeType'...............................................47
4.2.10 printer-resolution (resoultion)..........................43 4.1.10 'octetString'............................................48
4.2.11 print-quality (type2 enum)...............................43 4.1.11 'boolean'................................................48
4.2.12 finishings (1setOf type2 enum)...........................43 4.1.12 'integer'................................................48
4.2.13 copies (integer(1:2**31 - 1))............................44 4.1.13 'rangeOfInteger'.........................................48
4.2.14 page-range (rangeOf integer).............................44 4.1.14 'dateTime'...............................................48
4.2.15 orientation (type2 enum).................................45 4.1.15 'resolution'.............................................48
4.2.16 document-format (mimeType)...............................45 4.1.16 '1setOf X'..............................................49
4.2.17 compression (type3 keyword)..............................45 4.2 Job Template Attributes.......................................49
4.2.18 job-k-octets (integer(0:2**31 - 1))......................46 4.2.1 job-sheets (type4 keyword, name).........................53
4.2.19 job-impressions (integer(0:2**31 - 1))...................46 4.2.2 job-priority (integer(1:100))............................54
4.2.20 job-media-sheets (integer(0:2**31 - 1))..................46 4.2.3 job-hold-until (type4 keyword, name).....................55
4.3 Job Description Attributes.....................................46 4.2.4 multiple-document-handling (type2 keyword)...............56
4.3.1 job-uri (uri)............................................47 4.2.5 media (type4 keyword, name)..............................57
4.3.2 job-id (32bit unsigned integer)..........................48 4.2.6 number-up (integer)......................................57
4.3.3 job-uri-user (uri).......................................48 4.2.7 sides (type2 keyword)....................................58
4.3.4 job-name (name)..........................................48 4.2.8 printer-resolution (resolution)..........................59
4.3.5 job-originating-user (name)..............................48 4.2.9 print-quality (type2 enum)...............................59
4.3.6 job-originating-host (name)..............................48 4.2.10 finishings (1setOf type2 enum)...........................59
4.3.7 user-human-language (human-language).....................49 4.2.11 copies (integer(1:2**31 - 1))............................60
4.3.8 job-state (type1 enum)...................................49 4.2.12 page-ranges (1setOf rangeOfInteger)......................60
4.3.9 job-state-reasons (1setOf type2 keyword)................51 4.2.13 orientation (type2 enum).................................61
4.3.10 job-state-message (text).................................53 4.2.14 document-format (mimeType)...............................61
4.3.11 output-device-assigned (name)............................53 4.2.15 compression (type3 keyword)..............................62
4.3.12 time-since-pending (integer).............................53 4.2.16 job-k-octets (integer(0:2**31 - 1))......................62
4.3.13 time-since-processing (integer)..........................53 4.2.17 job-impressions (integer(0:2**31 - 1))...................62
4.3.14 time-since-completed (integer)...........................53 4.2.18 job-media-sheets (integer(0:2**31 - 1))..................63
4.3.15 number-of-intervening-jobs (integer(0:2**31 - 1))........53 4.3 Job Description Attributes....................................63
4.3.16 job-message-from-operator (text).........................54 4.3.1 job-uri (uri)............................................64
4.3.17 job-k-octets-processed (integer(0:2**31 - 1))............54 4.3.2 job-id (integer(1:MAX))..................................65
4.3.18 job-impressions-completed (integer(0:2**31 - 1))........54 4.3.3 job-more-info (uri)......................................65
4.3.19 job-media-sheets-completed (integer(0:2**31 - 1))........54 4.3.4 job-name (name)..........................................65
4.4 Document Attributes............................................54 4.3.5 job-originating-user (octetString).......................65
4.4.1 document-name (name).....................................55 4.3.6 job-state (type1 enum)...................................66
4.4.2 document-uri (uri).......................................55 4.3.7 job-state-reasons (1setOf type2 keyword)................68
4.5 Printer Description Attributes.................................56 4.3.8 job-state-message (text).................................70
4.5.1 printer-uri (uri)........................................58 4.3.9 number-of-documents (integer(0:2**31 - 1))...............70
4.5.2 printer-name (name)......................................58 4.3.10 output-device-assigned (name)............................71
4.5.3 printer-location (text)..................................58 4.3.11 time-of-creation (integer)...............................71
4.5.4 printer-description (text)...............................58 4.3.12 time-at-processing (integer).............................71
4.5.5 printer-more-info (uri)..................................58 4.3.13 time-at-completed (integer)..............................71
4.5.6 printer-driver-installer (uri)...........................59
deBry, Hastings, Herriot, Isaacson, Powell Expires April 14, 1998
Expires February xx, 1998 4.3.14 number-of-intervening-jobs (integer(0:2**31 - 1))........71
4.5.7 printer-make-and-model (text)............................59 4.3.15 job-message-from-operator (text).........................71
4.5.8 printer-more-info-manufacturer (uri).....................59 4.3.16 job-k-octets-processed (integer(0:2**31 - 1))............72
4.5.9 printer-state (type1 enum)...............................59 4.3.17 job-impressions-completed (integer(0:2**31 - 1))........72
4.5.10 printer-state-reasons (1setOf type2 keyword).............60 4.3.18 job-media-sheets-completed (integer(0:2**31 - 1))........72
4.5.11 printer-state-message (text).............................62 4.3.19 attributes-charset (charSet).............................72
4.5.12 operations-supported (1setOf type2 enum).................62 4.3.20 attributes-natural-language (naturalLanguage)............73
4.5.13 printer-is-accepting-jobs (boolean)......................63 4.4 Printer Description Attributes................................73
4.5.14 queued-job-count (integer(0:2**31 - 1))..................63 4.4.1 printer-uri (uri)........................................75
4.5.15 printer-message-from-operator (text).....................63 4.4.2 printer-name (name)......................................75
4.5.16 printer-human-language (human-language)..................63 4.4.3 printer-location (text)..................................75
4.5.17 printer-human-language-supported (1setOf human-language).63 4.4.4 printer-info (text)......................................75
4.5.18 color-supported (boolean)................................64 4.4.5 printer-more-info (uri)..................................75
4.5.19 pdl-override (type2 keyword).............................64 4.4.6 printer-driver-installer (uri)...........................76
4.5.20 Security Related Attributes..............................64 4.4.7 printer-make-and-model (text)............................76
4.5.20.1 message-protection-supported (keyword) .................65 4.4.8 printer-more-info-manufacturer (uri).....................76
4.5.20.2 authentication-authorization-supported (keyword) .......65 4.4.9 printer-state (type1 enum)...............................76
4.5.21 printer-up-time (seconds)................................65 4.4.10 printer-state-reasons (1setOf type2 keyword).............77
4.5.22 printer-current-time (dateTime)..........................65 4.4.11 printer-state-message (text).............................80
5. Conformance ....................................................66 4.4.12 operations-supported (1setOf operation)..................80
5.1 Client Conformance Requirements................................66 4.4.13 printer-charset (charSet)................................81
5.2 Printer Object Conformance Requirements........................67 4.4.14 charsets-supported (1setOf charSet)......................81
5.2.1 Objects..................................................67 4.4.15 printer-natural-language (naturalLanguage)...............81
5.2.2 Operations...............................................67 4.4.16 natural-languages-supported (1setOf naturalLanguage).....81
5.2.3 Attributes...............................................67 4.4.17 printer-is-accepting-jobs (boolean)......................82
5.2.4 Printer extensions.......................................68 4.4.18 queued-job-count (integer(0:2**31 - 1))..................82
5.2.5 Attribute Syntaxes.......................................68 4.4.19 printer-message-from-operator (text).....................82
5.3 Security Conformance Requirements..............................68 4.4.20 color-supported (boolean)................................82
6. IANA Considerations (registered and private extensions) ........68 4.4.21 reference-uri-schemes-supported (1setOf uriScheme).......83
6.1 Typed Extensions...............................................68 4.4.22 pdl-override (type2 keyword).............................83
6.2 Registration of MIME types/sub-types for document-formats......70 4.4.23 security-mechanisms-supported (1setOf keyword)...........83
6.3 Attribute Extensibility........................................70 4.4.24 printer-up-time (integer(1:MAX)).........................84
6.4 Attribute Syntax Extensibility.................................70 4.4.25 printer-current-time (dateTime)..........................84
7. Internationalization Considerations ............................70 4.4.26 multiple-operation-time-out (integer)....................84
8. Security Considerations ........................................71 5. Conformance ....................................................84
9. References .....................................................71 5.1 Client Conformance Requirements...............................85
10.Author's Address ...............................................73 5.2 Printer Object Conformance Requirements.......................85
11.APPENDIX A: Terminology ........................................76 5.2.1 Objects..................................................86
11.1 Conformance Terminology........................................76 5.2.2 Operations...............................................86
11.1.1 MUST.....................................................76 5.2.3 Attributes...............................................86
11.1.2 MUST NOT.................................................76 5.2.4 Printer extensions.......................................87
11.1.3 SHOULD...................................................76 5.2.5 Attribute Syntaxes.......................................87
11.1.4 SHOULD NOT...............................................76 5.3 Security Conformance Requirements.............................87
11.1.5 MAY......................................................76 6. IANA Considerations (registered and private extensions) ........87
11.1.6 NEED NOT.................................................77 6.1 Typed Extensions..............................................88
11.2 Model Terminology..............................................77 6.2 Registration of MIME types/sub-types for document-formats.....89
11.2.1 Keyword..................................................77 6.3 Attribute Extensibility.......................................89
11.2.2 Attributes...............................................77 6.4 Attribute Syntax Extensibility................................89
11.2.2.1 Attribute Name .........................................77
deBry, Hastings, Herriot, Isaacson, Powell Expires April 14, 1998
Expires February xx, 1998 7. Internationalization Considerations ............................89
11.2.2.2 Attribute Group Name ...................................78 8. Security Considerations ........................................91
11.2.2.3 Attribute Value ........................................78 8.1 Client and Printer in the Same Security Domain................92
11.2.2.4 Attribute Syntax .......................................78 8.2 Client and Printer in Different Security Domains..............92
11.2.3 Supports.................................................78 8.3 Print by Reference............................................93
12.APPENDIX B: Status Codes ......................................80 8.3.1 Unprotected Documents....................................93
12.1 Status Codes (type2 keyword)...................................80 8.3.2 Protected Documents......................................93
12.1.1 Informational............................................81 8.4 Common Security Scenarios.....................................93
12.1.2 Successful Status Codes..................................81 8.4.1 No Security..............................................93
12.1.2.1 successful-ok (0x00) ...................................81 8.4.2 Message Protection During Transmission...................94
12.1.2.2 successful-ok-ignored-or-substituted-attributes (0x01) .81 8.4.3 Client Authentication and Authorization..................94
12.1.3 Redirection Status Codes.................................81 8.4.4 Mutual Authentication, Authorization and Message Protection
12.1.4 Client Error Status Codes................................81 94
12.1.4.1 client-error-bad-request (0x400) .......................81 8.5 Recommended Security Mechanisms...............................94
12.1.4.2 client-error-forbidden (0x401) .........................82 9. References .....................................................95
12.1.4.3 client-error-not-authenticated (0x402) .................82 10.Copyright Notice ...............................................99
12.1.4.4 client-error-not-authorized (0x403) ....................82 11.Author's Address ...............................................99
12.1.4.5 client-error-not-possible (0x404) ......................82 12.APPENDIX A: Terminology .......................................102
12.1.4.6 client-error-timeout (0x405) ...........................82 12.1 Conformance Terminology......................................102
12.1.4.7 client-error-not-found (0x406) .........................83 12.1.1 MUST....................................................102
12.1.4.8 client-error-gone (0x407) ..............................83 12.1.2 MUST NOT................................................102
12.1.4.9 client-error-request-entity-too-large (0x408) ..........83 12.1.3 SHOULD..................................................102
12.1.4.10 client-error-request-URI-too-long (0x409) ..............84 12.1.4 SHOULD NOT..............................................102
12.1.4.11 client-error-unsupported-document-format (0x40A) .......84 12.1.5 MAY.....................................................102
12.1.4.12 client-error-attribute-not-supported (0x40B) ...........84 12.1.6 NEED NOT................................................103
12.1.5 Server Error Status Codes................................84 12.2 Model Terminology............................................103
12.1.5.1 server-error-internal- error (0x500) ...................85 12.2.1 Keyword.................................................103
12.1.5.2 server-error-operation-not-supported (0x501) ...........85 12.2.2 Attributes..............................................103
12.1.5.3 server-error-service-unavailable (0x502) ...............85 12.2.2.1 Attribute Name .......................................103
12.1.5.4 server-error-version-not-supported (0x503) .............85 12.2.2.2 Attribute Group Name .................................104
12.1.5.5 server-error-device-error (0x504) ......................85 12.2.2.3 Attribute Value ......................................104
12.1.5.6 server-error-temporary-error (0x505) ...................86 12.2.2.4 Attribute Syntax .....................................104
12.2 Status Keywords for IPP Operations.............................87 12.2.3 Supports................................................104
13.APPENDIX C: "document-format" values ...........................87 12.2.4 print-stream page.......................................106
14.APPENDIX D: "media" keyword values ............................90 12.2.5 imposed page............................................106
15.APPENDIX E: Processing IPP Attributes ..........................95 13.APPENDIX B: Status Codes .....................................106
15.1 Fidelity.......................................................95 13.1 Status Codes.................................................107
15.2 Page Description Language (PDL) Override.......................97 13.1.1 Informational...........................................107
15.3 Suggested Attribute Processing Algorithm.......................98 13.1.2 Successful Status Codes.................................107
16.APPENDIX F: Relationship to SNMP MIBs .........................101 13.1.2.1 successful-ok (0x0000) ...............................107
13.1.2.2 successful-ok-ignored-or-substituted-attributes (0x0001)
108
13.1.3 Redirection Status Codes................................108
13.1.4 Client Error Status Codes...............................108
13.1.4.1 client-error-bad-request (0x0400) ....................108
13.1.4.2 client-error-forbidden (0x0401) ......................108
13.1.4.3 client-error-not-authenticated (0x0402) ..............108
13.1.4.4 client-error-not-authorized (0x0403) .................109
deBry, Hastings, Herriot, Isaacson, Powell Expires April 14, 1998
Expires February xx, 1998 13.1.4.5 client-error-not-possible (0x0404) ...................109
13.1.4.6 client-error-timeout (0x0405) ........................109
13.1.4.7 client-error-not-found (0x0406) ......................109
13.1.4.8 client-error-gone (0x0407) ...........................110
13.1.4.9 client-error-request-entity-too-large (0x0408) .......110
13.1.4.10 client-error-request-URI-too-long (0x0409) ...........110
13.1.4.11 client-error-unsupported-document-format (0x040A) ....110
13.1.4.12 client-error-attribute-not-supported (0x040B) ........111
13.1.4.13 client-error-uri-scheme-not-supported (0x040C) .......111
13.1.4.14 client-error-charset-not-supported (0x040D) ..........111
13.1.4.15 client-error-natural-language-not-supported (0x040E) .111
13.1.5 Server Error Status Codes...............................111
13.1.5.1 server-error-internal- error (0x0500) ................112
13.1.5.2 server-error-operation-not-supported (0x0501) ........112
13.1.5.3 server-error-service-unavailable (0x0502) ............112
13.1.5.4 server-error-version-not-supported (0x0503) ..........112
13.1.5.5 server-error-device-error (0x0504) ...................112
13.1.5.6 server-error-temporary-error (0x0505) ................113
13.2 Status Codes for IPP Operations..............................114
14.APPENDIX C: "media" keyword values ...........................114
15.APPENDIX D: Processing IPP Attributes .........................119
15.1 Fidelity.....................................................119
15.2 Page Description Language (PDL) Override.....................121
15.3 Suggested Operation Processing Algorithm.....................122
15.4 Using Job Template Attributes During Document Processing.....126
16.APPENDIX E: Generic Directory Schema ..........................127
Expires April 14, 1998
1. Simplified Printing Model 1. Simplified Printing Model
In order to a achieve its goal of realizing a workable printing In order to achieve its goal of realizing a workable printing protocol
protocol for the Internet, the Internet Printing Protocol (IPP) is for the Internet, the Internet Printing Protocol (IPP) is based on a
based on a simplified printing model which abstracts the many simplified printing model that abstracts the many components of real
components of real world printing solutions. The Internet is a world printing solutions. The Internet is a distributed computing
distributed computing environment where requesters of print services environment where requesters of print services (clients,
(clients, applications, printer drivers, etc.) cooperate and interact applications, printer drivers, etc.) cooperate and interact with print
with print service providers. This model and semantics document service providers. This model and semantics document describes a
describes a simple, abstract model for IPP even though the underlying simple, abstract model for IPP even though the underlying
configurations may be complex "n-tier" client/server systems. An configurations may be complex "n-tier" client/server systems. An
important simplifying step in the IPP model is to expose only the key important simplifying step in the IPP model is to expose only the key
objects and interfaces required for printing. The model does not objects and interfaces required for printing. The model does not
include features, interfaces, and relationships that are beyond the include features, interfaces, and relationships that are beyond the
scope of IPP [20]. scope of IPP/1.0. IPP incorporates many of the relevant ideas and
lessons learned from other specification and development efforts
[HTPP] [LDPA] [P1387.4] [PSIS] [RFC1179] [SWP].
The IPP model encapsulates the important components of distributed The IPP model encapsulates the important components of distributed
printing into three object types: printing into two object types:
- Printer (Section 2.1) - Printer (Section 2.1)
- Job (Section 2.2) - Job (Section 2.2)
- Document (Section 2.3)
Each object type has an associated set of operations (see section 3) Each object type has an associated set of operations (see section 3)
and attributes (see section 4). and attributes (see section 4).
The terminology used in the remainder of this document is defined in The terminology used in the remainder of this document is defined in
Appendix A (section 11) . Terms such as "attributes", "keywords", and (section 12). In the remainder of this document, terms such as
"supports" have special meaning in this document and are defined in "attributes", "keywords", and "supports" have special meaning and are
the model terminology section. . Terms such as "MANDATORY", "MUST", defined in the model terminology section. Capitalized terms such as
and "OPTIONAL" have special meaning relating to conformance. These MANDATORY, SHALL, and OPTIONAL have special meaning relating to
terms are defined in the section on conformance terminology, most of conformance. These terms are defined in the section on conformance
which is taken from RFC 2119 [25]. terminology, most of which is taken from RFC 2119 [RFC2119].
It is important, however, to understand that in real system It is important, however, to understand that in real system
implementations (which lie underneath the abstracted IPP model), there implementations (which lie underneath the abstracted IPP model), there
are other components of a print service which are not explicitly are other components of a print service which are not explicitly
defined in the IPP model. The following figure illustrates where IPP defined in the IPP model. The following figure illustrates where IPP
fits with respect to these other components. fits with respect to these other components.
deBry, Hastings, Herriot, Isaacson, Powell Expires April 14, 1998
Expires February xx, 1998
+--------------+ +--------------+
| Application | | Application |
o +. . . . . . . | o +. . . . . . . |
\|/ | Spooler | \|/ | Spooler |
/ \ +. . . . . . . | +---------+ / \ +. . . . . . . | +---------+
End-User | Print Driver |---| File | End-User | Print Driver |---| File |
+-----------+ +-----+ +------+-------+ +----+----+ +-----------+ +-----+ +------+-------+ +----+----+
| Browser | | GUI | | | | Browser | | GUI | | |
+-----+-----+ +--+--+ | | +-----+-----+ +--+--+ | |
| | | | | | | |
skipping to change at page 8, line 42 skipping to change at page 9, line 43
| Output Device(s)| | Output Device(s)|
+-----------------+ +-----------------+
An IPP Printer encapsulates the functions normally associated with An IPP Printer encapsulates the functions normally associated with
physical output devices along with the spooling, scheduling and physical output devices along with the spooling, scheduling and
multiple device management functions often associated with a print multiple device management functions often associated with a print
server. IPP Printers are optionally registered as entries in a server. IPP Printers are optionally registered as entries in a
directory where end users find and select them based on some sort of directory where end users find and select them based on some sort of
filtered and context based searching mechanism. The directory is used filtered and context based searching mechanism. The directory is used
to store relatively static information about the Printer, allowing end to store relatively static information about the Printer, allowing end
users to search for and find Printers that match their search criteria users to search for and find Printers that match their search
(name, context, printer capabilities, etc.). The more dynamic criteria, for example: name, context, printer capabilities, etc. (see
information associated with a Printer includes state, currently loaded section 16). The more dynamic information is directly associated with
and ready media, number of jobs at the Printer, errors, warnings, and the IPP Printer itself. This information includes state, currently
so forth. loaded and ready media, number of jobs at the Printer, errors,
warnings, and so forth.
IPP clients implement the IPP protocol on the client side, and give IPP Clients implement the IPP protocol on the client side, and give
end users (or programs) the ability to query an IPP Printer and submit end users (or programs) the ability to query an IPP Printer and submit
and manage print jobs. An IPP server is just that part of the IPP and manage print jobs. An IPP server is just that part of the IPP
Printer that implements the server-side protocol. The rest of the IPP
deBry, Hastings, Herriot, Isaacson, Powell Expires April 14, 1998
Expires February xx, 1998 Printer that implements the server-side protocol. The rest of the IPP
Printer implements the application semantics of the print service Printer implements the application semantics of the print service
itself. The IPP Printer may be embedded in an output device or may be itself. The IPP Printer may be embedded in an output device or may be
implemented on a host on the network that communicates with the output implemented on a host on the network that communicates with the output
device. device.
When a job is submitted to the Printer and the Printer validates the When a job is submitted to the Printer object and the Printer object
data in the submission request, the Printer creates a Job object. The validates the attributes in the submission request, the Printer object
end user then interacts with this new Job to query its status and creates a new Job object. The end user then interacts with this new
monitor the progress of the job. End users may also cancel the Job. Job object to query its status and monitor the progress of the job.
The end user is able to register to receive certain events that are End users may also cancel print job by using the Job object's Cancel-
then routed using the specified notification service(s). Job operation. The end user is able to register to receive certain
events that are then routed using the specified notification
service(s).
2. IPP Objects 2. IPP Objects
The IPP model introduces objects of type Printer, Job, and Document. The IPP model introduces objects of type Printer and Job. Each type
Each object type is defined as a set of possible attributes that may of object models relevant aspects of a real-world entity such as a
be supported by each instance of an object of that type. For each real printer or print job. Each object type is defined as a set of
object instance, the actual set of supported attributes and values possible attributes that may be supported by instances of that object
describe the specific implementation. The object's attributes and type. For each object, the actual set of supported attributes and
values describe its capabilities, realizable features, job processing values describe a specific implementation. The object's attributes
functions, and default behaviors and characteristics. For example, the and values describe its state, capabilities, realizable features, job
object type "Printer" is defined as a set of attributes that each processing functions, and default behaviors and characteristics. For
instance of a Printer object might potentially support. In the same example, the object type Printer is defined as a set of attributes
manner, the object type "Job" is defined as a set of attributes that that each Printer object potentially supports. In the same manner,
are potentially supported by each instance of a Job object. the object type Job is defined as a set of attributes that are
potentially supported by each Job object.
Each attribute included in the set of attributes defining an object Each attribute included in the set of attributes defining an object
type is labeled as: type is labeled as:
- "MANDATORY": each object instance MUST support the attribute. - "MANDATORY": each object SHALL support the attribute.
- "OPTIONAL": each object instance MAY support the attribute. - "OPTIONAL": each object OPTIONALLY supports the attribute.
There is no such similar labeling of attribute values. However, if an There is no such similar labeling of attribute values. However, if an
implementation supports an attribute, it must support at least one implementation supports an attribute, it MUST support at least one of
(and possibly all) of the possible values for that attribute. the possible values for that attribute.
2.1 Printer Object 2.1 Printer Object
A major component of the IPP model is the Printer object. An instance A major component of the IPP model is the Printer object (also called
of a Printer object implements the IPP protocol. Using the protocol, the IPP Printer). A Printer object implements the IPP protocol.
end users may query the attributes of the Printer and submit Jobs to Using the protocol, end users may query the attributes of the Printer
the Printer (section 3 describes each of the Printer specific and submit Jobs to the Printer. The actual implementation components
operations in detail). The actual implementation components behind
the Printer abstraction may take on different forms and different
configurations. However, the model abstraction allows the details of
deBry, Hastings, Herriot, Isaacson, Powell Expires April 14, 1998
Expires February xx, 1998 behind the Printer abstraction may take on different forms and
the configuration of real components to remain transparent to the end different configurations. However, the model abstraction allows the
user. details of the configuration of real components to remain opaque to
the end user. Section 3 describes each of the Printer operations in
detail.
The capabilities and state of an IPP Printer are described by its The capabilities and state of a Printer object are described by its
attributes. Printer attributes are grouped as follows: attributes. Printer attributes are grouped into two groups:
"job-template" attributes (section 4.2) - "job-template" attributes: These attributes the describe job
"printer-description" attributes (section 4.5) processing capabilities and defaults for the Printer object. (See
section 4.2)
- "printer-description" attributes: These attributes describe the
Printer object's identification, state, location, references to
other sources of information about the Printer object, etc. (see
section 4.4)
Since a Printer object is an abstraction of a generic document output Since a Printer object is an abstraction of a generic document output
device and print service provider, an IPP Printer object could be used device and print service provider, a Printer object could be used to
to represent any real or virtual device with semantics consistent with represent any real or virtual device with semantics consistent with
the Printer object, such as a fax-out device, an imager, or even a CD the Printer object, such as a fax device, an imager, or even a CD
writer. writer.
Some examples of configurations supporting a Printer object include: Some examples of configurations supporting a Printer object include:
1) An output device, with no spooling capabilities 1) An output device, with no spooling capabilities
2) An output device, with a built-in spooler 2) An output device, with a built-in spooler
3) A print server supporting IPP with one or more associated output 3) A print server supporting IPP with one or more associated output
devices devices
3a) The associated output devices might or might not be capable 3a) The associated output devices might or might not be capable
of spooling jobs of spooling jobs
3b) The associated output devices might or might not support IPP 3b) The associated output devices might or might not support IPP
See the following figures for some examples on how to view IPP Printer The following figures show some examples of how Printer objects can be
objects implemented on top of various print system configurations. realized on top of various distributed printing configurations. The
The embedded case below represents configurations 1 and 2. The hosted embedded case below represents configurations 1 and 2. The hosted and
and fan-out figures below represent configuration 3. fan-out figures below represent configuration 3.
deBry, Hastings, Herriot, Isaacson, Powell Expires April 14, 1998
Expires February xx, 1998
Legend: Legend:
##### indicates a Printer object which is ##### indicates a Printer object which is
either embedded in an output device or is either embedded in an output device or is
hosted in a server. The implementation hosted in a server. The implementation
might or might not be capable of queuing/spooling. might or might not be capable of queuing/spooling.
any indicates any network protocol or direct any indicates any network protocol or direct
connect, including IPP connect, including IPP
skipping to change at page 11, line 43 skipping to change at page 12, line 44
+-->| output device | +-->| output device |
any/ | | any/ | |
O +--------+ ########### / +---------------+ O +--------+ ########### / +---------------+
/|\ | client |-IPP-># Printer #--* /|\ | client |-IPP-># Printer #--*
/ \ +--------+ # Object # \ +---------------+ / \ +--------+ # Object # \ +---------------+
########### any\ | | ########### any\ | |
+-->| output device | +-->| output device |
| | | |
+---------------+ +---------------+
It is assumed that URIs for IPP Printers are available to end users or A Printer object is identified with a Uniform Resource Identifier
programs that wish to interact with the Printer. Although NOT (URI) [RFC1630]. Often, the URI is a Uniform Resource Locator (URL)
MANDATORY, it is RECOMMENDED that Printers be registered in a [RFC1738] [RFC1808]..
directory service which end users and programs can interrogate.
"Internet Printing Protocol: Directory Schema"[24] defines the
deBry, Hastings, Herriot, Isaacson, Powell Expires April 14, 1998
Expires February xx, 1998 Note: The IPP protocol specification [IPP-PRO] defines a mapping of
attributes to be associated with a Printer entry in a directory IPP onto HTTP/1.1. Therefore, all conforming Printer objects SHALL
service. support HTTP schemed URIs to identify themselves. For example, a
Printer object's URI could be "http://www.some-domain.org/printer-
one". A Printer object's URI could not be "ftp://ftp.some-
domain.org/printer-one".
IPP does not specify how the URI is obtained, but it is RECOMMENDED
that a Printer object is registered in a directory service which end
users and programs can interrogate. Section 16 defines a generic
schema for Printer object entries in the directory service.
2.2 Job Object 2.2 Job Object
A Job object is used to model a job. A Job can contain one or more A Job object is used to model a print job. A Job can contain one or
Documents. The information required to create a Job object is sent in more documents. The information required to create a Job object is
a create request from the end user via an IPP client to an IPP sent in a create request from the end user via an IPP Client to the
Printer. Section 3 describes each of the Job specific operations in Printer object. Section 3 describes each of the Job operations in
detail. detail.
The characteristics and state of an IPP Job are described by its The characteristics and state of a Job object are described by its
attributes. Job attributes are grouped as follows: attributes. Job attributes are grouped into two groups as follows:
"job-template" attributes (optionally supplied by the client/end - "job-template" attributes: These attributes are optionally
user, section 4.2) supplied by the client or end user and include job processing
"job-description" attributes (set by the Printer, section 4.3) instructions which are intended to override any Printer object
defaults and/or instructions embedded within the document data.
(See section 4.2)
- "job-description" attributes: These attributes describe the Job
object's identification, state, size, etc. The client does not
supply values for these attributes, they are set by the Printer
object. (See section 4.3)
2.3 Document Object A Job object contains at least one document, but may contain multiple
documents. A document consists of either:
A Document object is used to model a document. A Document consists of - a stream of data in a format supported by the Printer object, or
either printable data or a URI reference to printable data An - a URI reference to a stream of data in a format supported by the
instance of a Document object is a set of attributes which describe Printer
the document data. Document Attributes (see section 4.4). Document
attributes only describe the data to be printed; they do not include
any specialized document processing instructions. All processing
instructions are at the Job level and are called called Job Template
attributes and they apply equally to all Documents within a Job.
2.4 Object Relationships A document is not modeled as an IPP object, therefore it has no object
identifier or associated attributes. All job processing instructions
are modeled as Job object attributes. These attributes are called Job
Template attributes and they apply equally to all documents within a
Job.
Instances of objects within the system have relationships that MUST be Expires April 14, 1998
maintained persistently along with the persistent storage of the 2.3 Object Relationships
object attributes. An instance of a Printer object usually represents
one or more output devices. A Printer object may represent a logical
device which "processes" jobs but never actually uses a physical
output device to put marks on paper (for example a Web page publisher
or an interface into an online document archive or repository). A
Printer can contain zero or more Job objects. An instance of a Job
object is contained in exactly one Printer object, however the
identical Job data could be sent to either the same or a different
Printer. In this case, the new Job would be an identical, but
different Jobsince it each would have a different Job identifier. A
deBry, Hastings, Herriot, Isaacson, Powell IPP objects have relationships that MUST be maintained persistently
Expires February xx, 1998 along with the persistent storage of the object attributes. A Printer
Job object contains one or more Documents. If the Document is simply object may represent one or more output devices. A Printer object may
a reference to some print data stream, the referenced document may be represent a logical device which "processes" jobs but never actually
used in multiple Documents in the same Job or even in different Jobs, uses a physical output device to put marks on paper (for example a Web
though each Document contains its own copy of the reference. If the page publisher or an interface into an online document archive or
Document is not just a reference, but an actual stream of print data, repository). A Printer object contains zero or more Job objects. A
the stream is contained in only one Document, although there can be Job object is contained by exactly one Printer object, however the
copies of the same document data in other Documents in the same or identical document data associated with a Job object could be sent to
different Jobs. either the same or a different Printer object. In this case, a new
Job object would be created which would be almost identical to the
existing Job object, however it would have a new (different) Job
object identifier. A Job object contains one or more documents. If
the contained document is a stream of printer-ready data, that stream
can be contained in only one document. However, there can be copies
of the stream in other documents in the same or different Job objects.
If the contained document is a reference to a stream of printer-ready
data, other documents (in the same or different Job object(s)) may
reference the same stream.
2.5 Object Identity 2.4 Object Identity
All instances of Printer and Job objects have a URI so that they can All Printer and Job objects have an identifier so that they can be
persistently and unambiguously referenced. The IPP model requires persistently and unambiguously referenced. The IPP model requires
that these values be URIs as defined by RFC 1738 [11] and RFC 1808 that these identifiers be URIs. Often, the URI is a URL [RFC1738]
[34]. In addition to an identifier, instances of Printers, Jobs, and [RFC1808].
Documents may have a name. An object name need not be unique across
all instances of all objects. The Printer name is chosen and set by an
administrator through some mechanism outside the scope of IPP itself.
If the client does not supply Job name or a Document name, the Printer
generates a name. In all cases, the name only has local meaning, and
it is not constrained to be unique.
To summarize:
- Each Printer will be uniquely identified with a URI. The
Printer's "printer-uri" attribute contains the URI.
- Each Job will be uniquely identified with a URI. The Job's "job-
uri" attribute contains the URI.
- Each Printer has name (which is not necessarily unique). The
administrator chooses and sets this name through some mechanism
outside the scope of IPP itself. The Printer's "printer-name"
attribute contains the name.
- Each Job has name (which is not necessarily unique). The client
optionally supplies this name in the create request. If the
client does not supply this name, the Printer generates a name
for the Job. The Job's "job-name" attribute contains the name.
- Each Document has name (which is not necessarily unique). The
client optionally supplies this name in the request which creates
the Document. If the client does not supply this name, the
Printer generates a name for the Document. The Document's
"document-name" attribute contains the name.
Note: If Documents are printed by reference, the corresponding Allowing Job objects to have URIs allows for flexibility and
Document object contains a "document-uri" attribute. The value of scalability. In some implementations, the Printer object might create
this attribute is a reference to the document data to be printed; it Jobs that are processed in the same local environment as the Printer
is not a unique identifier of the Document object itself. object itself. In this case, the Job URI might just be a composition
of the Printer's URI and some unique component for the Job object. In
other implementations, the Printer object might be a central clearing-
house for validating all Job object creation requests, and the Job
object itself might be created in some environment that is remote from
the Printer object. In this case, the Job object's URI may have no
relationship at all to the Printer object's URI.
deBry, Hastings, Herriot, Isaacson, Powell However, many existing printing systems have local models or interface
Expires February xx, 1998 constraints that force Job objects to be identified using only a 32-
Proposal: bit positive integer rather than a URI. This numeric Job ID is only
unique within the context of the Printer object to which the create
request was originally submitted. In order to allow both types of
client access to Jobs (either Job URI or numeric Job ID), when the
Printer object successfully processes a create request and creates a
All instances of Printer objects have a URI so that they can Expires April 14, 1998
persistently and unambiguously referenced. The IPP model requires new Job, the Printer object SHALL generate both a Job URI and a Job ID
that these values be URIs as defined by RFC 1738 [11] and RFC 1808. for the new Job object. This requirement allows all clients to access
All Printer operations are directed to the Printer's URI. All Printer objects and Job objects no matter the local constraints
instances of Job objects have an opaque identifier that when used in imposed on the client implementation.
combination with its Printer URI, allow it to be persistently and
unambiguously referenced. Instances of Document objects have no
identifier since they are always created and queried using Job
operations; that is the model does not define semantics for querying
the attributes of just one Document within a multi-Document Job.
In addition to these identifier attributes, instances of Printer, Job, In addition to a unique identifier, Printer objects and Job objects
and Document objects may have a name. An object name need not be may have names. An object name need not be unique across all
unique across all instances of all objects. The Printer name is chosen instances of all objects. A Printer object's name is chosen and set by
and set by an administrator. A client optionally supplies Job and an administrator through some mechanism outside the scope of IPP. A
Document names in the operations that create Jobs and Documents. If a Job object's name is optionally chosen and supplied by the IPP Client
client does not supply a name, the Printer generates a name. In all submitting the job. If the client does not supply a Job object name,
cases, the name only has local meaning, and it is not in any way the Printer object generates a name for the new Job object. In all
constrained to be unique. cases, the name only has local meaning, and it is not constrained to
be unique.
To summarize: To summarize:
- Each Printer will be uniquely identified with a URI. The - Each Printer object is uniquely identified with a URI. The
Printer's "printer-uri" attribute contains this URI. Printer's "printer-uri" attribute contains the URI.
- Each Job will be uniquely identified with a Job ID and a Printer - Each Job object is uniquely identified with a URI. The Job's
URI. The Job's "job-id" attribute contains the Job ID. The "job-uri" attribute contains the URI.
Printer's "printer-uri" attribute contains the Printer's URI. - Each Job object is also uniquely identified with a combination of
- Each Printer has name (which is not necessarily unique). The the URI of the Printer object to which the create request was
administrator chooses and sets this name through some mechanism originally submitted along with a Job ID (a 32-bit, positive
outside the scope of IPP itself. The Printer's "printer-name" number) that is unique within the context of that Printer object.
The Printer object's "printer-uri" contains the Printer URI. The
Job object's "job-id" attribute contains the numeric Job ID.
- Each Printer object has a name (which is not necessarily unique).
The administrator chooses and sets this name through some
mechanism outside the scope of IPP itself. The Printer object's
"printer-name" attribute contains the name.
- Each Job object has a name (which is not necessarily unique).
The client optionally supplies this name in the create request.
If the client does not supply this name, the Printer object
generates a name for the Job object. The Job object's "job-name"
attribute contains the name. attribute contains the name.
- Each Job has name (which is not necessarily unique). The client
optionally supplies this name in the create request. If the
client does not supply this name, the Printer generates a name
for the Job. The Job's "job-name" attribute contains the name.
- Each Document has name (which is not necessarily unique). The
client optionally supplies this name in the request that creates
the Document. If the client does not supply this name, the
Printer generates a name for the Document. The Document's
"document-name" attribute contains the name.
Note: If Documents are printed by reference, the corresponding 3. IPP Operations
Document object contains a "document-uri" attribute. The value of
deBry, Hastings, Herriot, Isaacson, Powell IPP objects have associated operations. An operation consists of a
Expires February xx, 1998 request and a response. When a client communicates with an IPP
this attribute is a reference to the document data to be printed; it object, it issues an operation request to the URI for that object.
is not a unique identifier of the Document object itself. Operations have attributes that supply information about the operation
itself. These attributes are called operation attributes (as compared
to object attributes such as Printer attributes or Job attributes).
Each request carries along with it any operation attributes and/or
document data required by the object to perform the operation. Each
3. IPP Operations Expires April 14, 1998
request requires a response from the object. Each response indicates
success or failure of the operation with a status code. The response
contains any operation attributes, object attributes, and/or status
messages generated by the execution of the operation request.
Jobs and Printers each have a set of associated operations. This section describes the semantics of the IPP operations, both
Operations consist of requests and responses. When a client requests and responses, in terms of the attributes and other data
communicates with an IPP object, it issues an operation request to the associated with each operation.
URI for that object. Each request carries along with it any operation
attributes and data required by the object to perform the operation.
Each request requires a response from the object. Each response
indicates success or failure of the operation with a status code, and
may include operation attributes and an optional status message. The
representation and encoding of IPP operations is described in
"Internet Printing Protocol: Protocol Specification" [23]. This
section describes the IPP operations in terms of their semantics and
contents, including both the request and the response for each
operation.
The Printer operations are fully defined in section 3.2: Note: The IPP protocol specification [IPP-PRO] describes a mapping and
encoding of IPP operations onto HTTP/1.1 POST commands. Other
mappings for IPP operations to additional transport mechanisms are
possible.
The Printer operations are:
Print-Job (section 3.2.1) Print-Job (section 3.2.1)
Print-URI (section 3.2.2) Print-URI (section 3.2.2)
Validate-Job (section 3.2.3) Validate-Job (section 3.2.3)
Create-Job (section 3.2.4) Create-Job (section 3.2.4)
Get-Attributes (section 3.2.5) Get-Attributes (section 3.2.5)
Get-Jobs (section 3.2.6) Get-Jobs (section 3.2.6)
The Job operations are fully defined in section 3.3: The Job operations are:
Send-Document (section 3.3.1) Send-Document (section 3.3.1)
Send-URI (section 3.3.2) Send-URI (section 3.3.2)
Cancel-Job (section 3.3.3) Cancel-Job (section 3.3.3)
Get-Attributes (section 3.3.4) Get-Attributes (section 3.3.4)
There are no explicit Document operations. However, there are Job The Send-Document and Send-URI Job operations are used to add a new
operations that are used to create and query Document objects document to an existing multi-document Job object created with the
contained within a Job object. The Send-Document and Send-URI Job Create-Job operation.
operations are used to add a new Document to an existing multi-
Document Job. If requested, the Get-Attribute operation used for a
Job also returns any Document object attributes. If the Job is a
single Document Job, only a single set of Document attributes is
returned. If however, the Job contains multiple Documents, the Get-
Attribute Response contains multiple sets of Document attributes, one
set for each Document.
deBry, Hastings, Herriot, Isaacson, Powell
Expires February xx, 1998
3.1 General Semantics 3.1 General Semantics
3.1.1 Operation Targets 3.1.1 Operation Characteristics
All IPP operations are directed at an instance of an IPP object. For Each IPP operation is defined as both a request and a response. Both
Printer operations, the operation is directed at an IPP Printer using requests and responses are composed of groups of attributes and/or
its URI. That is, all Printer operations must somehow contain the document data. Attributes are grouped into the following groups:
target attribute "printer-uri" indicating the target of the operation.
In the mapping of IPP over HTTP, the "printer-uri" attribute is
actually encoded as the "request-URI" component of the HTTP operation.
In other mappings, the target URI might be encoded using some other
transport specific mechanism.
For Job operations, the operation is directed at an IPP Job using its - Operation Attributes: These are attributes that are only passed
URI. Like Printer operations, all Job operations must somehow contain in the operation itself, and usually do not persist beyond the
the target attribute "job-uri" indicating the target of the operation. life of the operation. Operation attributes may also affect
Also, like Printer operations, in the mapping of IPP over HTTP, the other attributes or groups of attributes since values in the
"job-uri" attribute is actually encoded as the "request-URI" component operation attributes usually affect the behavior of the object
of the HTTP operation. In other mappings, the target URI might be
encoded using some other transport specific mechanism.
Propsal: Expires April 14, 1998
that processes the operation. All IPP objects that accept IPP
operation request MUST support all operation attributes. Some
operation attributes are OPTIONAL for the client to supply, but
the IPP object MUST support the attribute by being prepare to
handle the client supplied operation attribute by realizing the
corresponding feature or function.
- Job Template Attributes: These attributes affect the processing
of a job. They are OPTIONALLY supplied by a client in a create
request, and the receiving object MUST be prepared to received
all supported attributes. The Job object can later be queried to
find out what was originally requested in the create request.
The Printer object can be queried to find out what type of job
processing capabilities are supported and/or what the default job
processing behaviors are.
- Job Object Attributes: These attributes are returned in response
to query operation directed at a Job object.
- Printer Object Attributes: These attributes are returned in
response to a query operation directed at a Printer object.
- Unsupported Attributes: In a create request, the client supplies
an optional set of Job Template attributes. If any of these are
unsupported by the Printer object, the Printer object returns
them in the response. Section 15 gives a full description of how
Job Template attributes supplied by the client in a create
request are processed by the Printer object and how unsupported
attributes are returned to the client.
For Job operations, the the operation is directed at the Printer's URI Later in this section, each operation is formally defined by
and it is accompanied by the Job ID . This allows the IPP Printer identifying the allowed and expected groups of attributes for request
implementation to find the correct Job object. That is, both the and response. The model identifies a specific order for each group in
"printer-uri" attribute and the "job-id" attribute must both be each request or response, but the attributes within each group may be
supplied as the target of every Job operation. Like Printer in any order.
operations, in the mapping of IPP over HTTP, the "printer-uri"
attribute is encoded in the "request-URI" component of the HTTP
operation. However, the "job-id" attribute is supplied as an
operation attribute within the operation data itself. If a Printer
receives an IPP operation, it must check to see if the "job-id"
attribute is included among the operation attributes. If it is there,
the operation is being directed at the Job identified by the value of
"job-id". If it is not there, the operation is being directed at the
Printer itself.
3.1.2 Operation Status Codes and Messages Note: Document data included in the operation is not strictly an
attribute, but it is treated as a special attribute group for ordering
purposes. The only operations that support supplying the document
data within an operation request are Print-Job and Send-Document.
There are no operations responses that include document data.
Since some operations are MANDATORY and some are OPTIONAL, a client
SHOULD first use the MANDATORY Get-Attributes operation to query the
Printer's "operations-supported" attribute before using any
unsupported operation. A client SHOULD NOT attempt to use an
unsupported operation. When a Printer object receives a request to
perform an operation it does not support, it returns the error code
'server-error-operation-not-supported' (see section 13.1.5.2).
Expires April 14, 1998
3.1.2 Operation Targets
All IPP operations are directed at IPP objects. For Printer
operations, the operation is always directed at a Printer object using
its URI (the "printer-uri" attribute).
For Job operations, the operation is directed at either:
- the Job object itself using the Job object's URI ("job-uri")
assigned by the Printer object, or
- the Printer object to which the job was originally submitted
using the URI of the Printer ("printer-uri") in combination with
and the 32-bit numeric Job ID ("job-id") assigned by the Printer
object.
If the operation is directed at the Job object directly using the Job
object's URI, the client SHOULD NOT include the redundant "job-id"
operation attribute.
Note: In the mapping of IPP over HTTP/1.1, the object's URI is
actually encoded as the "request-URI" field of the HTTP POST
operation. In the case of Printer operations directed at a Printer
object, the Printer object's "printer-uri" attribute is mapped to the
"request-URI" attribute in the HTTP header. In the case of Job
operations directed at the Job object, the Job object's "job-uri"
attribute is mapped to the "request-URI" attribute in the HTTP header.
In the case of Job operations directed at the Printer object that
created the Job, the Printer object's "printer-uri" attribute is sent
in the HTTP header, and the "job-id" attribute is sent as an
operational attribute in the request body. In other mappings of IPP
operations onto some other transport mechanism, the target URI is
encoded using some other transport specific addressing mechanism.
The following rules apply to the use of port numbers in URIs that
identify IPP objects:
1. If the protocol scheme for the URI allows the port number to be
explicitly included in the URI string, and an explicit port
number is specified in the published URI, then that port number
MUST be used by the client to contact the IPP server.
2. If the protocol scheme for the URI does not allow an explicit
port number specification, then the default port number for the
protocol should be used.
3. Consult the appropriate IPP protocol mapping document to
determine alternate port numbers for the protocol specified in
the server URI.
Expires April 14, 1998
3.1.3 Character Set and Natural Language Operation Attributes
Some Job and Printer attributes have values that are text strings and
names intended for human understanding rather than machine
understanding (see the 'text' and 'name' attribute syntax descriptions
in section 4.1). The following sections describe two MANDATORY
attributes for every IPP operation request and response. These
attributes are "attributes-charset" and "attributes-natural-language".
For the sake of brevity in this document, these operation attribute
descriptions are not repeated with every operation request and
response, but have a reference back to this section instead.
3.1.3.1 Request Operation Attributes
The client SHALL supply and the Printer object SHALL support the
following MANDATORY operation attributes in every IPP operation
request:
"attributes-charset" (charSet):
This operation attribute identifies the charset (coded character
set and encoding method) used by any 'text' and 'name' attributes
that the client is supplying in this request and that the Printer
object SHALL return in this operation response. See Sections
4.1.1 and 4.1.2 for the specification of the 'text' and 'name'
attribute syntaxes.
The Printer object SHALL support the 'utf-8' charset [RFC2044]
and MAY support additional charsets provided that they are
registered with IANA [IANA-CS]. If the Printer object does not
support the supplied charset value, the Printer object SHALL
reject the request and return status code 'client-error-charset-
not-supported'. The Printer object SHALL indicate the charset(s)
supported as the values of the "charsets-supported" Printer
attribute (see Section 4.4.14), so that the client MAY query
which charset(s) are supported.
See the 'charSet' attribute syntax description in Section 4.1.7
for the syntax and semantic interpretation of the values of this
attribute and for example values.
"attributes-natural-language" (naturalLanguage):
This operation attribute identifies the natural language used by
any 'text' and 'name' attributes that the client is supplying in
this request. A Printer SHOULD do its best to respond in the
same natural language.
Expires April 14, 1998
There are no MANDATORY natural languages required for the Printer
object to support. However, the Printer's "natural-language-
supported" attribute SHALL list the natural languages supported,
so that the client MAY query which natural language(s) are
supported. For any of the attributes for which the Printer
generates messages, i.e., for the "job-state-message", "printer-
state-message" attributes ", and Status Messages (see Section
3.1.4) in operation responses, the Printer object SHALL be able
to generate messages in any of its supported natural languages.
If the client requests a natural language that is not supported,
the Printer object SHALL return these generated messages in the
Printer's configured natural language as specified by the
Printer's "printer-natural-language " attribute" (see Section
4.4.15).
For other Printer 'text' and 'name' attributes supplied by the
operator, system administrator, or manufacturer, i.e., for
"printer-name" (name), "printer-location" (text), "printer-info"
(text), and "printer-make-and-model" (text), the Printer object
is only required to support the configured natural language of
the Printer identified by the Printer's "printer-natural-language
" attribute, though support of additional natural languages for
these attributes is permitted
If the Printer object does not support the natural language value
supplied by the client, the Printer object SHALL either (1)
reject the request and return status code ' client-error-natural-
language-not-supported' or (2) accept the natural language rather
than returning an error, depending on implementation. In the
latter case, the Printer object SHALL use the method for
representing exception natural languages in attribute values as
described for the 'text' attribute syntax in Section 4.1.1 for
any such 'text' or 'name' attributes that the Printer (1) accepts
from or (2) returns to a client.
See the 'naturalLanguage' attribute syntax description in Section
4.1.8 for the syntax and semantic interpretation of the values of
this attribute and for example values.
3.1.3.2 Response Operation Attributes
The Printer object SHALL supply and the client SHALL support the
following MANDATORY operation attributes in every IPP operation
response:
"attributescharset" (charSet):
This operation attribute identifies the charset used by any
'text' and 'name' attributes that the Printer object is returning
Expires April 14, 1998
in this response. The value in this response SHALL be the same
value as the "attributes-charset" operation attribute supplied by
the client in the request. See "attributes-charset" described in
Section 3.1.3.1 above.
If the Printer object supports more than just the 'utf-8'
charset, the Printer object SHALL be able to code convert between
each of the charsets supported on a highest fidelity possible
basis in order to return the 'text' and 'name' attributes in the
charset requested by the client. However, some information loss
MAY occur during the charset conversion depending on the charsets
involved. For example, the Printer object may convert from a
UTF-8 'a' to a US-ASCII 'a' (with no loss of information), from
an ISO Latin 1 CAPITAL LETTER A WITH ACUTE ACCENT to US-ASCII 'A'
(losing the accent), or from a UTF-8 Japanese Kanji character to
some ISO Latin 1 error character indication such as '?', decimal
code equivalent, or to the absence of a character, depending on
implementation.
"attributes-natural-language" (naturalLanguage):
This is a MANDATORY Job Template attribute for the Printer object
to return. This attribute specifies the natural language used by
'text' and 'name' attributes with empty tags in this response and
SHALL be the same value as supplied by the client in the request,
whether the Printer object supports that value or not. Any
'text' or 'name' values in this response that have a different
natural language SHALL have a fully specified natural language
tag pre-pended to each such attribute value.
In a subsequent query request (Get-Attributes or Get-Jobs), the
Printer object NEED NOT convert any 'text' or 'name' attribute
values to the natural language of the requester when it is
different from that specified (and subsequently stored) in the
original create request.. In such cases, the Printer object
SHALL return an explicit natural language indicator for each such
attribute value. See the 'text' attribute syntax description in
Section 4.1.1.
3.1.4 Operation Status Codes and Messages
Every operation response returns a MANDATORY status code and an Every operation response returns a MANDATORY status code and an
OPTIONAL status message. A status code provides information on the OPTIONAL status message. A status code provides information on the
processing of a request. A status message provides a short textual processing of a request. A status message provides a short textual
description of the status of the operation. The status code is description of the status of the operation. The status code is
intended for use by automata and the status message is intended for intended for use by automata and the status message is intended for
the human user. If a response does include a status message,an IPP the human user. If a response does include a status message,an IPP
application is not required to examine or display the status message. client is not required to examine or display the status message,
Status codes and suggested corresponding status messages are described however it SHOULD do so in some implementation specific manner.
deBry, Hastings, Herriot, Isaacson, Powell Expires April 14, 1998
Expires February xx, 1998 Section 13 describes the status codes and suggests a corresponding
in section 12. In most cases, if the status code indicates an error, status message for each status code. In some cases, if the status
there are additional attributes in the response that are not returned code indicates an error, there may be additional attributes in the
in the successful case. One such example is the group of unsupported response that are not returned in the successful case. One such
attributes and values. This set of attributes is returned in response example is the set of unsupported attributes in the Print-Job response
to an operation request that includes attributes that are not (see section 3.2.1.2).
supported by the object.
3.1.3 Security Concerns for IPPOperations The status code is a numeric value that has semantic meaning. The
status code is similar to a "type2 enum" (see section 4.1 on
"Attribute Syntaxes") except that values can range only from 0x0000 to
0xFFFF.
3.1.3.1 Authenticated Requester Identity A client implementation of IPP could convert status code values into
any localized string that has semantic meaning to the end user. The
Printer object SHALL be able to generate this message in any of the
natural languages identified by the Printer's "natural-language-
supported" attribute (see the "attributes-natural-language" operation
attribute specified in Section 3.1.3.1). If the charset requested by
the client in the "attributes-charset" operation attribute is not
supported by the Printer object, the Printer object SHALL represent
the status message, if returned, in the charset specified by the
Printer's "printer-charset" attribute (which the client MAY not be
able to interpret).
3.1.5 Security Concerns for IPP Operations
3.1.5.1 Authenticated Requester Identity
IPP is layered on top of security services that supply the requester's IPP is layered on top of security services that supply the requester's
identity. It is assumed that identity supplied by the authentication identity. It is assumed that the identity supplied by the
service is the most authenticated identity required by a given site's authentication service is the most authenticated identity required by
configuration and current policy. It is also assumed that the a given site's configuration and current policy. It is also assumed
layering allows for a single IPP implementation to be run over a that the layering allows for a single IPP implementation to be run
consistent interface that supplies the authenticated identity. The over a consistent interface that supplies the authenticated identity.
authentication interface should allow for various modular and The authentication interface should allow for various modular and
extensible authentication service implementations without requiring extensible authentication service implementations without requiring
changes to the IPP implementation. changes to the IPP implementation.
Once the authenticated identity of the requester has been supplied to Once the authenticated identity of the requester has been supplied to
the IPP implementation, the implementation uses that identity to the IPP implementation, the implementation uses that identity to
enforce any authorization policy(ies) that might be in place. When a enforce any authorization policy(ies) that might be in place. When a
Job is created, the identity of the requester of the create operation Job is created, the identity of the requester from the create request
is persistently stored in the Job's "job-originating-user" attribute. is persistently stored in the Job's "job-originating-user" attribute.
This attribute can be used to match the requester's identity of This attribute can be used to match the requester's identity of
subsequent operations on that Job in order to enforce the local subsequent operations on that Job in order to enforce the local
authorization policy(ies), if any. There are operation status codes authorization policy(ies), if any. For example, a one site's policy
that allow an implementation to return information back to the might be that only the job owner is allowed to cancel a job. There
operation requester about what has been forbidden, not allowed, or not are operation status codes that allow an implementation to return
authorized.
For example, a site security policy might be that only the job owner Expires April 14, 1998
is allowed to cancel a job using the Cancel-Job operation. information back to the operation requester about what has been
forbidden, not allowed, or not authorized. The details of and
mechanisms to set up authorization policy(ies) are not part of IPP,
and must be established via some mechanism outside the scope of IPP.
3.1.3.2 Restricted Queries 3.1.5.2 Restricted Queries
In many of these IPP operations, a client supplies a list of In many of these IPP operations, a client supplies a list of
attributes to be returned in the response. A Printer may be attributes to be returned in the response. A Printer may be
configured, for security reasons, not to return all attributes that a configured, for security reasons, not to return all attributes that a
client requests. It may even return none of the requested attributes. client requests. It may even return none of the requested attributes.
In such cases, the status returned is the same as if the Printer had In such cases, the status returned is the same as if the Printer had
returned all requested attributes. The client cannot tell by such a returned all requested attributes. The client cannot tell by such a
response whether the requested attribute was present or absent on the response whether the requested attribute was present or absent on the
Printer. Printer or Job.
deBry, Hastings, Herriot, Isaacson, Powell 3.1.6 Versions
Expires February xx, 1998
3.1.4 Versions
Each operation request carries with it a version number. Each version Each operation request carries with it a version number. Each version
number is in the form X.Y where X is the major version number and Y is number is in the form "X.Y" where X is the major version number and Y
the minor version number. is the minor version number. By including a version number in the
client request, it allows the client (the requester) to identify which
version of IPP it is interested in using. If the Printer does not
support that version, the Printer responds with a status code of
'server-error-version-not-supported'.
By including a version number in the client request, it allows the There is no version negotiation per se. However, if after receiving a
client (the requester) to identify which version of IPP it is version not supported status code from the Printer, there is nothing
interested in using. If the Printer does not support that version, that prevents a client from trying again with a different version
the Printer responds with a status code of 'server-error-version-not- number. For example, a client might be configured to support IPP
supported'. There is no version negotiation per se. However, if version 3.0, 2.5, 2.0 and 1.0 (hypothetically speaking). A client
after receiving a version not supported status code from the Printer, might first try to speak version 3.0. If after receiving a version not
there is nothing that prevents a client from trying again with a supported, it might successively try version 2.5, then 2.0, and then
different version number. For example, a client might be configured 1.0. All implementations MUST support version 1.0.
to support IPP version 3.0, 2.5, 2.0 and 1.0 (hypothetically
speaking). A client might first try to speak version 3.0. If after
receiving a version not supported, it might successively try version
2.5, then 2.0, then 1.0. All implementations MUST support version
1.0.
Items that might affect the changing of the major version number There is only one version number that covers both IPP Model and the
include any changes to the protocol specification itself such as: IPP Protocol changes. Thus the version number MUST change when
introducing a new version of the Model document or a new version of
the Protocol document.
Changes to the major version number indicate structural or syntactic
changes that make it impossible for older version IPP processors to
correctly parse and interpret the new or changed attributes,
operations and responses. If the major version number changes, the
minor version numbers is set to zero. One example that would have
required a change to the major version number would have been adding
the "ipp-attribute-fidelity" attribute if it had not been part of
version 1.0. Items that might affect the changing of the major version
Expires April 14, 1998
number include any changes to the protocol specification itself such
as:
- reordering of ordered attributes or attribute sets - reordering of ordered attributes or attribute sets
- changes to the syntax of existing attributes - changes to the syntax of existing attributes
- changing OPTIONAL to MANDATORY and vice versa - changing OPTIONAL to MANDATORY and vice versa
Changes to the minor version number indicate the addition of new
features, attributes and attribute values that may not be understood
by all IPP processors, but which can be ignored if not understood.
Items that might affect the changing of the minor version number Items that might affect the changing of the minor version number
include any changes to the model objects and attributes but not the include any changes to the model objects and attributes but not the
protocol specification itself, such as: protocol specification itself, such as:
- grouping all extensions not included in a previous version into a - grouping all extensions not included in a previous version into a
new version new version
- formally adding in new attribute values - formally adding in new attribute values
- changing any of the type1 attributes - changing any of the type1 attributes
3.1.5 Job Creation Operations 3.1.7 Job Creation Operations
In order to create a new Job object, a client issues a create request. In order to "submit a print job" and create a new Job object, a client
A create request is any one of following three operation requests: issues a create request. A create request is any one of following
three operation requests:
- The Print-Job Request: A client that wants to create a Job with - The Print-Job Request: A client that wants to submit a print job
only a single Document uses the Print-Job operation. . The with only a single document uses the Print-Job operation. . The
operation allows for the client to "push" the document data to operation allows for the client to "push" the document data to
the Printer by including the document data in the request itself. the Printer by including the document data in the request itself.
deBry, Hastings, Herriot, Isaacson, Powell - The Print-URI Request: A client that wants to submit a print job
Expires February xx, 1998 with only a single document where the Printer "pulls" the
- The Print-URI Request: A client that wants to create a Job with document data uses the Print-URI operation. In this case, the
only a single Document where the Printer "pulls" the document client includes only a URI reference to the document data (not
data uses the Print-URI operation. In this case, the client the document data itself).
includes only a URI reference to the document data (not the
document data itself).
- The Create-Job Request: A client that wants to create a Job with - The Create-Job Request: A client that wants to submit a print job
multiple Documents uses the Create-Job operation. . This with multiple documents uses the Create-Job operation. . This
operation is followed by an arbitrary number of Send-Document or operation is followed by an arbitrary number of Send-Document or
Send-URI operations (each creating another Document for this Send-URI operations (each creating another document for the newly
Job). The Send-Document operation includes the document data in create Job object). The Send-Document operation includes the
the request (the client "pushes" the document data to the document data in the request (the client "pushes" the document
printer), and the Send-URI operation includes only a URI data to the printer), and the Send-URI operation includes only a
reference to the document data in the request (the Printer URI reference to the document data in the request (the Printer
"pulls" the document data from the referenced location). The "pulls" the document data from the referenced location). The
last Send-Document or Send-URI request includes a "last-document" last Send-Document or Send-URI request for a given Job object
attribute set to 'true' indicating that this is the last includes a "last-document" operation attribute set to 'true'
Document for this Job. indicating that this is the last document.
Expires April 14, 1998
Throughout this model specification, the term "create request" is used Throughout this model specification, the term "create request" is used
to refer to any of these three operation requests. to refer to any of these three operation requests.
A Create-Job operation followed by only one Send-Document operation is A Create-Job operation followed by only one Send-Document operation is
semantically equivalent to a Print-Job operation, however, for semantically equivalent to a Print-Job operation, however, for
performance reasons, the client SHOULD use the Print-Job operation for performance reasons, the client SHOULD use the Print-Job operation for
all single Document Jobs. Also, Print-Job is a MANDATORY operation all single Document Jobs. Also, Print-Job is a MANDATORY operation
(all implementations MUST support it) whereas Create-Job is an (all implementations MUST support it) whereas Create-Job is an
OPTIONAL operation, hence some implemations might not support it. OPTIONAL operation, hence some implementations might not support it.
Appendix E: Processing IPP Attributes (see Section 15) describes the Section 15 describes the rules and issues surrounding the processing
rules and issues surrounding either the acceptance or rejection of a and either the acceptance or rejection of a create request.
create request.
At job submission time, the Printer does not need to validate the Job submission time is the point in time when a client issues a create
document data or the actual contents of the URI reference to document request. The initial state of every Job object is the 'pending' or
data (in the case of a Print-URI). The Printer SHOULD check the 'pending-held' state. Later, the Printer object begins processing the
syntax of the URI to make sure that it appears to be a valid URI. job. At this point in time, the Job object's state moves to
However, other checks are essentially useless,since they require 'processing'. This is known as job processing time. There are
actually parsing and interpreting all of the print data, or in the validation checks that must be done at job submission time and others
case of a URI, checking for availability at Job submission time does that must be performed at job processing time.
not guarantee availability at Job processing time. In other words,
even if the checks were made a Job submission time, they MUST also be
done later at Job processing time, since at job processing time, the
Printer might discover any of the following conditions:
- additional runtime errors in the document data, At job submission time and at the time a Validate-Job operation is
- some nested document data is in an unsupported format, received, the Printer MUST do the following:
deBry, Hastings, Herriot, Isaacson, Powell 1. Process the client supplied attributes using the rules supplied
Expires February xx, 1998 in section 15 and either accept or reject the request
2. Validate the syntax of and support for the scheme of any client
supplied URI
At job submission time the Printer SHOULD NOT perform the validation
checks reserved for job processing time such as:
1. Validate the document data
2. Validate the actual contents of any client supplied URI (resolve
the reference and follow the link to the document data)
At job submission time, these additional job processing time
validation checks are essentially useless, since they require actually
parsing and interpreting the document data, are not guaranteed to be
100% accurate, and must yet be done again at job processing time.
Also, in the case of a URI, checking for availability at job
submission time does not guarantee availability at job processing
time. In addition, at job processing time, the Printer object might
discover any of the following conditions that were not detectable at
job submission time:
- runtime errors in the document data,
Expires April 14, 1998
- nested document data that is in an unsupported format,
- the URI reference is no longer valid (i.e., the server hosting - the URI reference is no longer valid (i.e., the server hosting
the data might be down), or the document might be down), or
- any other run-time job processing error - any other job processing error
At this point, the Printer is unable to return an error status code in At job processing time, since the Printer has already responded with a
the create response, since it had already sent the create response successful status code in the response to the create request, if the
with a successful status code. In this case, the Printer, depending Printer object detects an error, the Printer object in unable to
on the error, can set the "job-state", "job-state-reasons", or "job- inform the end user of the error with an operational status code. In
state-message" attributes to the appropriate value(s) so that later this case, the Printer, depending on the error, can set the "job-
queries can report the correct job status. Also, if the client has state", "job-state-reasons", or "job-state-message" attributes to the
requested notification for 'job-problems', the Printer could notify appropriate value(s) so that later queries can report the correct job
the client via the address(es) in the "notify-addresses" attribute. status.
3.2 Printer Operations 3.2 Printer Operations
All Printer operations are directed at Printer objects. A client MUST
always supply the "printer-uri" attribute in order to identify the
correct target of the operation. In HTTP/1.1 mapping of IPP, this
attribute is not supplied in the body of the operation as other
operation attributes are. It is supplied in the "request-URI" field
in the HTTP header.
3.2.1 Print-Job Operation 3.2.1 Print-Job Operation
When an end user desires to submit a print job with only one Document, When an end user desires to submit a print job with only one document
the client uses a Print-Job operation. A Print-Job operation differs and the client supplies the document data (rather than just a
from a Print-URI operation in that a Print-Job operation contains the reference to the data), the client uses a Print-Job operation.
document data to be printed and a Print-URI operation only contains a
reference to the document data. A Validate-Job operation contains no
data, only a set of Job Template and Document attributes whose values
can be validated for consistency. A Create-Job operation is similar
as well, however the Create-Job Request is used to create a multi-
Document Job.
3.2.1.1 Print-Job Request 3.2.1.1 Print-Job Request
The following sets of attributes are supplied as as part of the The following groups of attributes are supplied as part of the Print-
Print-Job Request: Job Request:
Operation Attributes Group1: Operation Attributes
"job-name" (name): Target:
This OPTIONAL attribute identifies the client supplied Job name. The "printer-uri" target for this operation as described in
If this attribute is supplied, its value it used for the "job- section 3.1.2.
name" attribute of the newly created Job object. If this
attribute is not supplied by the client, the Printer generates a
name to use in the "job-name" attribute of the newly created Job
object (see Section 4.3.4).
"ipp-attribute-fidelity" (boolean): Natural Language and Character Set:
This is an OPTIONAL attribute. If not supplied, the Printer The "attributes-charset" and "attributes-natural-language"
assumes the value is 'false'. The value 'true' indicates that attributes as described in section 3.1.3.1.
total fidelity to client supplied attributes and values is
required. The value 'false' indicates that a reasonable attempt
deBry, Hastings, Herriot, Isaacson, Powell "job-name" (name):
Expires February xx, 1998 This attribute is OPTIONALLY supplied by the client, and it
to print the Job is acceptable. All implementations support both contains the client supplied Job name. If this attribute is
types of job processing. See section 15 for a full description
of "ipp-attribute-fidelity" and its relationship to other Expires April 14, 1998
attributes, especially the Printer's "pdl-override" attribute. supplied, its value it used for the "job-name" attribute of the
newly created Job object. If this attribute is not supplied by
the client, the Printer generates a name to use in the "job-name"
attribute of the newly created Job object (see Section 4.3.4).
"document-name" (name): "document-name" (name):
This OPTIONAL attribute identifies the client supplied Document This attribute is OPTIONALLY supplied by the client, and it
name. If this attribute is supplied, its value it used for the contains the client supplied document name. The document name
"document-name" attribute of the newly created Document object. MAY be different than the Job name. Typically, the client
If this attribute is not supplied by the client, the Printer software automatically supplies the document name on behalf of
optionally generates a name to use in the "document-name" the end user by using a file name or an application generated
attribute of the newly created Document object (see Section 4.4). name. If this attribute is supplied, its value can be used in a
manner defined by each implementation. Examples include: printed
along with the Job (banner page, page adornments, etc.), used by
accounting or resource tracking management tools, or even stored
along with the document as a document level attribute. IPP/1.0
does not support the concept of document level attributes,
however, a vendor specific extension to IPP/1.0 might support the
document level attributes. In this case, the "document-name"
attribute could be persistently stored along with the document
and queried using a Get-Attributes operation on the Job object
that includes a request for document level attributes or some
other private extension mechanism.
ISSUE: Since this is part of a Print-Job that creates only a "ipp-attribute-fidelity" (boolean):
single Document, should we This attribute is OPTIONALLY supplied by the client. If not
not allow this attribute? supplied, the Printer object assumes the value is 'false'. The
value 'true' indicates that total fidelity to client supplied
attributes and values is required. The value 'false' indicates
that a reasonable attempt to print the Job is acceptable. All
Printer objects MUST support both types of job processing. See
section 15 for a full description of "ipp-attribute-fidelity"
and its relationship to other attributes, especially the Printer
object's "pdl-override" attribute.
Job Template Attributes "document-charset" (charSet):
This attribute is OPTIONALLY supplied by the client. A Printer
object SHALL support this attribute if it supports a document-
format that requires a character set to be identified in order to
unambiguously interpret the document, such as 'text/plain'.
There are no particular values required for the Printer object to
support. This attribute specifies the charset of the document
for those document-formats that require a specification of the
charset in order to image the document unambiguously. If the
value of the "document-format" attribute contains a charset
parameter (see 'mimeType' attribute syntax in Section 4.1.9), the
client SHALL also supply the "document-charset" attribute and its
value SHALL be the same.
An optional set of Job Template attributes as defined in section Expires April 14, 1998
4.2. If the client supplies no Job Template attributes in the "document-natural-language" (naturalLanguage):
Print-Job Request, the Printer uses the values set in its default This attribute is OPTIONALLY supplied by the client. There are
value attributes at job processing time (not job submission no particular values are required for the Printer object to
time). support. This attribute specifies the natural language of the
document for those document-formats that require a specification
of the natural language in order to image the document
unambiguously.
Document Attributes: Group2: Job Template Attributes
An optional set of Document Attributes as defined in section 4.4. The client OPTIONALLY supplies a set of Job Template attributes
If "document-format" is not supplied, the Printer assumes that as defined in section 4.2. See section 15 for a full description
the document data is in a format that this acceptable to the of Job Template attributes.
Printer. If the "document-format" is unknown for a certain
document, the client SHALL NOT supply the attribute in the create
request or the Send-Document Request.
Document Content Group 3: Document Content
The client MUST supply the document data to be processed. The client MUST supply the document data to be processed.
Note: Since all Print-Job Request attributes are OPTIONAL, the Note: The simplest Print-Job Request consists of just the Document
simplest Print-Job Request consists of just the Document Content and Content and nothing else. In this case, the Printer object:
nothing else. In this case, the Printer creates a new Job object and
stores a generated Job name in the "job-name" attribute. The Job
contains a single Document. The Printer optionally generates a name
deBry, Hastings, Herriot, Isaacson, Powell - creates a new Job object (the Job object contains a single
Expires February xx, 1998 document),
the Document and stores it in the "document-name" attribute. The - stores a generated Job name in the "job-name" attribute,
Printer assumes that the document data is in a format supported by the - assumes that the document data is in a supported format, and
Printer. When the Printer processes the Job, it uses all of its - uses its corresponding default value attributes for missing Job
default values for the missing Job Template attributes. Template attributes and embedded instructions in the document
data.
3.2.1.2 Print-Job Response 3.2.1.2 Print-Job Response
The Printer SHALL return to the client the following sets of The Printer SHALL return to the client the following sets of
attributes as part of the Print-Job Response: attributes as part of the Print-Job Response:
Operation Attributes Group 1: Operation Attributes
"job-uri" (uri): Status Code and Message:
A URI which the client SHALL use for all other operations on this The response includes the MANDATORY status code and an OPTIONAL
Job. This is the MANDATORY "job-uri" attribute. "status-message" (text) operation attribute as described in
section 3.1.4.
ISSUE: Can this just be a "Job Status Attribute"? Natural Language and Character Set:
The "attributes-charset" and "attributes-natural-language"
attributes as described in section 3.1.3.2.
Job Status Attributes Expires April 14, 1998
Group 2: Job Object Attributes
"job-name": "job-uri" (uri):
This is the Job's "job-name" attribute. The Printer object MUST return the Job object's MANDATORY "job-
uri" attribute.
"job-id":
The Printer object MUST return the Job object's MANDATORY "job-
id" attribute.
"job-state": "job-state":
This is the Job's "job-state" attribute. The value of this The Printer object MUST return the Job object's MANDATORY "job-
attribute is taken from a "snapshot" of the new Job object state" attribute. The value of this attribute (along with the
sometime after the time the Printer receives the print request value of the next attribute "job-state-reasons") is taken from a
until just prior to returning the response to the client. "snapshot" of the new Job object at some meaningful point in time
(implementation defined) between when the Printer object receives
the Print-Job Request and when the Printer object returns the
response.
"job-state-reasons": "job-state-reasons":
This is the Job's "job-state-reasons" attribute. The value of The Printer object OPTIONALLY returns the Job object's OPTIONAL
this attribute is taken from a "snapshot" of the new Job object "job-state-reasons" attribute. If the Printer object supports
sometime after the time the Printer receives the print request this attribute then it MUST be returned in the response. If
until just prior to returning the response to the client. this attribute is not returned in the response, the client can
assume that the "job-state-reasons" attribute is not supported
and will not be returned in a subsequent Job object query.
"job-state-message": "job-state-message":
This is the Job's "job-state-message" attribute. Since the "job- The Printer object OPTIONALLY returns the Job object's OPTIONAL
state-message" attribute is OPTIONAL Job attribute, itis "job-state-message" attribute. If the Printer object supports
OPTIONALLY included in the response. this attribute then it MUST be returned in the response. If this
attribute is not returned in the response, the client can assume
that the "job-state-message" attribute is not supported and will
not be returned in a subsequent Job object query.
"number-of-intervening-jobs":
The Printer object OPTIONALLY returns the Job object's OPTIONAL
"number-of-intervening-jobs" attribute. If the Printer object
supports this attribute then it MUST be returned in the response.
If this attribute is not returned in the response, the client can
assume that the "number-of-intervening-jobs" attribute is not
supported and will not be returned in a subsequent Job object
query.
Note: Since any printer state information which affects a job's Note: Since any printer state information which affects a job's
state is reflected in the "job-state" and "job-state-reasons" state is reflected in the "job-state" and "job-state-reasons"
attributes, it is sufficient to return only these attributes and attributes, it is sufficient to return only these attributes and
no specific printer status attributes. no specific printer status attributes.
deBry, Hastings, Herriot, Isaacson, Powell Expires April 14, 1998
Expires February xx, 1998 Group 3: Unsupported Attributes
Unsupported Attributes:
This is a set of attributes and attribute values that are This is an OPTIONAL set of attributes. It is a set of Job
unsupported. This output parameter is only returned in the Template attributes supplied by the client (in the request) that
response if the status code indicates that there was such an are not supported by the Printer object. When the Printer object
error. rejects the request because of more than one unsupported
attribute (see section 15), it SHOULD return all of the
unsupported attributes. Some implementations may choose to only
return the first unsupported attribute that is encountered during
the processing of the attributes, but that may lead to additional
requests with only one "fixed" attribute from the set of problem
attributes. In the case where the Printer object accepts the
request and creates a Job object, the Printer MUST return the set
of unsupported attributes where substitutions were made or the
attribute was completely ignored.
Note: The simplest response consists of the just the job URI ("job- Unsupported attributes fall into two categories:
uri") and the Job Status attributes with a status code of "successful-
ok". 1. The Printer object does not support the named attribute (no
matter what the value), or
2. The Printer object does supports the attribute, but not the
particular value supplied by the client (i.e., the Printer does
not have that value in the corresponding supported values
attribute).
In the case of an unsupported attribute name, the Printer object
returns the client supplied attribute with a substituted special
value of 'unsupported' indicating no support for the attribute
itself. In the case of a supported attribute with an unsupported
value, the Printer object simply returns the client-supplied
attribute. This indicates support for the attribute, but no
support for that particular value.
Note: The simplest response consists of the just the MANDATORY Job
Attributes and a status code of "successful-ok".
3.2.2 Print-URI Operation 3.2.2 Print-URI Operation
This operation is identical to the Print-Job operation (section 3.2.1) This operation is identical to the Print-Job operation (section 3.2.1)
except that a client supplies a URI reference to the document data except that a client supplies a URI reference to the document data
using the "document-uri" (uri) operation attribute rather than using the "document-uri" (uri) operation attribute rather than
including the document data itself. It is up to the IPP server to including the document data itself. It is up to the IPP server to
interpret the URI and subsequently "pull" the document from the source interpret the URI and subsequently "pull" the document from the source
referenced by the URI string. referenced by the URI string. At job submission time, the Printer
MUST validate the fact that it supports the retrieval method (e.g.,
http, ftp, etc.) implied by the URI. If the Printer object supports
Expires April 14, 1998
this operation, it MUST support the "reference-uri-schemes-supported"
attribute (see section 4.4.21).
3.2.3 Validate-Job Operation 3.2.3 Validate-Job Operation
This operation is similar to the Print-Job operation (section 3.2.1) This operation is similar to the Print-Job operation (section 3.2.1)
except that a client supplies no document data and the Printer except that a client supplies no document data and the Printer
allocates no resources (i.e., it does not create a new Job object). allocates no resources (i.e., it does not create a new Job object).
This operation is used only to verify capabilities of a printer object This operation is used only to verify capabilities of a printer object
against whatever attributes are supplied by the client in the against whatever attributes are supplied by the client in the
Validate-Job request. There is no "job-uri" attribute returned in the Validate-Job request. There are no Job Object Attributes returned in
Validate-Job Response neither are there any Job Status attributes the Validate-Job Response. If the Printer supports either the Print-
returned in the response. The client MAY include a "document-uri" URI or Send-URI operations, the client MAY include a "document-uri"
attribute in the request. In this case, the Printer SHOULD only attribute in the request. In this case, the Printer MUST validate
validate the syntax of the URI rather than follow the reference and that the Printer supports the retrieval method implied by the URI, and
validate the contents of the reference. If all is well, the Printer SHOULD check for validate URI syntax. The Printer NEED NOT follow the
returns the status code "successful-ok". Otherwise, the Printer reference and validate the contents of the reference. If all is well,
returns a set of unsupported attributes and the appropriate error the Printer returns the status code "successful-ok". Otherwise, the
status code. Printer returns a set of unsupported attributes and/or the appropriate
error status code. If the client supplies the "ipp-attribute-
fidelity" attribute set to false (or does not supply the attribute at
all) and if the Printer object returns a "successful-ok-ignored-or-
substituted-attributes", the Printer object SHOULD return all ignored
or substituted in the Unsupported Attributes group. In such a case,
the Printer object MUST return at least one attribute indicating an
unsupported attribute value or an ignored attribute.
3.2.4 Create-Job Operation 3.2.4 Create-Job Operation
This operation is similar to the Print-Job operation (section 3.2.1) This operation is similar to the Print-Job operation (section 3.2.1)
except that a client supplies no document data or any reference to except that in the Create-Job request , a client does not supply
document data in the Create-Job request. This operation is followed document data (or any reference to document data). Also, the client
by one or more Send-Document or Send-URI operations. If a Printer does not supply any of the "document-name", "content-charset", or
object supports the Create-Job operation, it MUST also support either "content-natural-language" attributes. This operation is followed by
the Send-Document operation or the Send-URI operation or both. Since one or more Send-Document or Send-URI operations. In each of these
a client can query the Printer's "operations-supported" attribute, a operation requests, the client OPTIONALLY supplies the "document-
client SHOULD NOT attempt to use an unsupported optional operation. name", "content-charset", or "content-natural-language" attributes for
each document in the multi-document Job. If a Printer object supports
the Create-Job operation, it MUST also support the Send-Document
operation and also MAY support the Send-URI operation.
deBry, Hastings, Herriot, Isaacson, Powell
Expires February xx, 1998
3.2.5 Get-Attributes Operation 3.2.5 Get-Attributes Operation
The Printer Get-Attributes operation allows a client to obtain The Printer Get-Attributes operation allows a client to obtain
information from a Printer object. In the operations attributes in a information from a Printer object. In the operations attributes in a
request, the client supplies the set of attribute names and/or request, the client supplies the set of attribute names and/or
attribute group names in which the requester is interested. In the attribute group names in which the requester is interested. In the
operation attribute in the response, the Printer returns a operation attribute in the response, the Printer returns a
Expires April 14, 1998
corresponding attribute set with the appropriate attribute values corresponding attribute set with the appropriate attribute values
filled in. filled in.
For Printers, the attribute groups include: For Printers, the possible names of attribute groups are:
- 'job-template': all of the Job Template attributes that apply to - 'job-template': all of the Job Template attributes that apply to
a Printer object (the last two columns of the table in Section a Printer object (the last two columns of the table in Section
4.2). 4.2).
- 'printer-description': the attributes specified in Section 4.5. - 'printer-description': the attributes specified in Section 4.4.
There is also the special group 'all' which includes all supported There is also the special group 'all' that includes all supported
attributes. attributes. Since a client MAY request specific attributes or named
groups, there is a potential that there is some overlap. For example,
if a client requests, 'printer-name', 'printer-description', and
'all', client is actually requesting the "printer-group, and once by
inclusion in the 'all' group. In all cases, the Printer SHALL only
return the attribute once in the response.
It is NOT REQUIRED that a Printer support all attributes belonging to It is NOT REQUIRED that a Printer support all attributes belonging to
a group, however it is MANDATORY that each Printer implementation a group, however it is MANDATORY that each Printer implementation
understand all group names. understand all group names.
3.2.5.1 Get-Attributes Request 3.2.5.1 Get-Attributes Request
The following sets of attributes are part of the Get-Attributes The following sets of attributes are part of the Get-Attributes
Request when the request is directed to a Printer object: Request when the request is directed to a Printer object:
Operation Attributes"requested-attributes" (1setOf keyword) : Group 1: Operation Attributes
An optional set of attribute names (without values) or attribute
group names in whose values the requester is interested. If the Target:
client omits this input parameter, the Printer SHALL respond as The "printer-uri" target for this operation as described in
if this input parameter had been supplied with a value of 'all'. section 3.1.2.
Natural Language and Character Set:
The "attributes-charset" and "attributes-natural-language"
attributes as described in section 3.1.3.1.
"requested-attributes" (1setOf keyword) :
The client OPTIONALLY supplies a set of attribute names and/or
attribute group names in whose values the requester is
interested. If the client omits this attribute, the Printer
SHALL respond as if this attribute had been supplied with a value
of 'all'.
"document-format" (mimeType) : "document-format" (mimeType) :
This input parameter is useful for determining the set of The client OPTIONALLY supplies this attribute. This attribute is
supported attribute values which relate to the requested document useful for a Printer to determine the set of supported attribute
format. The Printer SHALL return only (1) those attributes that values that relate to the requested document format. The Printer
are supported and (2) the attribute values that are supported for
Expires April 14, 1998
SHOULD return only (1) those attributes that are supported for
that format and (2) the attribute values that are supported for
the specified document format. By specifying the document the specified document format. By specifying the document
format, the client can get the Printer to eliminate the format, the client can get the Printer to eliminate the
attributes and values that are not supported for a specific attributes and values that are not supported for a specific
document format. For example, a Printer might have multiple document format. For example, a Printer might have multiple
interpreters to support both 'application/postscript' (for interpreters to support both 'application/postscript' (for
PostScript) and 'text/plain' (for text) documents. However, for PostScript) and 'text/plain' (for text) documents. However, for
only one of those interpreters might the Printer be able to only one of those interpreters might the Printer be able to
support "number-up" with values of 'one', 'two', and 'four'. For support "number-up" with values of '1', '2', and '4'. For the
other interpreter it might be able to only support "number-up"
deBry, Hastings, Herriot, Isaacson, Powell with a value of '1'.
Expires February xx, 1998
the other interpreter it might be able to only support "number-
up" with a value of 'one'.
If the client omits this input parameter, the Printer SHALL If the client omits this attribute, the Printer SHALL respond as
respond as if the input parameter had been set to the value of if the attribute had been supplied with a value set to the
the Printer's default value "document-format" attribute were Printer object's "document-format-default" default value
supplied. It is recommended that the client always supply a attribute. It is recommended that the client always supply a
value for document-format, since the Printer's default value for value for "document-format", since the Printer object's
document-format may be 'langAutomatic', in which case the "document-format-default" may be 'application/octet-stream', in
returned attributes and values are for the union of the document which case the returned attributes and values are for the union
formats that the Printer can automatically sense. of the document formats that the Printer can automatically sense.
For more details, see the description of the 'mimeType' attribute
syntax in section 4.1.9.
ISSUE: What about MIME types. NOTE: The "document-format" operation attribute is a fairly
sophisticated filtering notion that is not supported by many
existing print systems or devices.
3.2.5.2 Get-Attributes Response 3.2.5.2 Get-Attributes Response
The Printer returns the following sets of attributes as part of the The Printer object returns the following sets of attributes as part of
Get-Attributes Response: the Get-Attributes Response:
Requested Attributes Group 1: Operation Attributes
Status Code and Message:
The response includes the MANDATORY status code and an OPTIONAL
"status-message" (text) operation attribute as described in
section 3.1.4.
Natural Language and Character Set:
The "attributes-charset" and "attributes-natural-language"
attributes as described in section 3.1.3.2.
Group 2: Requested Printer Object Attributes
Expires April 14, 1998
This is the set of requested attributes and their current values. This is the set of requested attributes and their current values.
The Printer ignores (does not respond with) any requested The Printer object ignores (does not respond with) any requested
attribute which is not supported. attribute which is not supported.
3.2.6 Get-Jobs Operation 3.2.6 Get-Jobs Operation
The Get-Jobs operation allows a client to retrieve the list of Jobs The Get-Jobs operation allows a client to retrieve the list of Jobs
belonging to the target Printer object. The client may also supply a belonging to the target Printer object. The client may also supply a
list of Job attribute names or attribute group names. These Job list of Job attribute names or attribute group names. These Job
attributes will be returned for each Job that is returned. attributes will be returned for each Job that is returned.
This operation is like Get-Attributes, except that Get-Jobs operation This operation is similar Get-Attributes, except that this Get-Jobs
returns attributes from possibly more than one object (see the operation returns attributes from possibly more than one object (see
description of attribute groups in section 3.3.4). the description of attribute group names in section 3.3.4).
3.2.6.1 Get-Jobs Request 3.2.6.1 Get-Jobs Request
The client submits the Get-Jobs request to a Printer URI. The client submits the Get-Jobs request to a Printer object.
The following sets of attributes are part of the Get-Jobs Request: The following groupsof attributes are part of the Get-Jobs Request:
Operation Attributes Group 1: Operation Attributes
"limit" (integer): Target:
This is an integer value that indicates a limit to the number of The "printer-uri" target for this operation as described in
Jobs returned. The limit is a "stateless limit" in that if the section 3.1.2.
deBry, Hastings, Herriot, Isaacson, Powell Natural Language and Character Set:
Expires February xx, 1998 The "attributes-charset" and "attributes-natural-language"
limit is n then only the first n jobs are returned in the Get- attributes as described in section 3.1.3.1.
Jobs Response; there is no mechanism to allow for the "next" n
jobs. The limit applies across all Job States requested. For "limit" (integer):
example, if the limit if 50, and there are 75 spooled jobs, only The client OPTIONALLY supplies this attribute. It is an integer
the first 50 jobs are returned; the other 25 jobs are not value that indicates a limit to the number of Job objects
returned. returned. The limit is a "stateless limit" in that if the value
supplied by the client is 'n', then only the first 'n' jobs are
returned in the Get-Jobs Response. There is no mechanism to
allow for the next 'm' jobs after the first 'n' jobs. If the
client does not supply this attribute, the Printer object
responds will all applicable jobs.
"requested-attributes" (1setOf keyword): "requested-attributes" (1setOf keyword):
An optional set of Job attribute names or attribute groups names The client OPTIONALLY supplies this attribute. It is a set of Job
in whose values the requester is interested. This set of attribute names or attribute groups names in whose values the
attributes is returned for each Job that is returned.. The requester is interested. This set of attributes is returned for
attribute group names are the same as for the Get-Attributes each Job that is returned. The allowed attribute group names are
operation for the Job object. If the client omits this input the same as those defined in the Get-Attributes operation for Job
parameter, the Printer SHALL respond as if this input parameter objects. If the client does not supply this attribute, the
had been supplied with a value of " 'job-uri'.
Expires April 14, 1998
Printer SHALL respond as if the client had supplied values of
'job-uri' and 'job-id'.
"which-jobs" (keyword):
The client OPTIONALLY supplies this attribute. It indicates which
Jobs should be returned by the Printer object. The values for
this attribute are:
'completed': This includes any Job object whose state is
'completed', 'cancelled', or 'aborted'.
'not-completed': This includes any Job object whose state is
'pending', 'processing', 'processing-stopped', 'pending-
held', 'unknown'.
If the client does not supply the attribute, the Printer object
SHALL respond as if the client had supplied the value of 'not-
completed'.
3.2.6.2 Get-Jobs Response 3.2.6.2 Get-Jobs Response
The Printer returns zero or more Job objects each with zero or more The Printer object returns all of the Job objects that match the
attributes. There is a set of requested attributes for each Job. criteria as defined by the attribute values supplied by the client in
After each Job, there is a set of requested attributes for each the request. It is possible that no Job objects are returned since
Document in the Job. For example: there may literally be no Job objects at the Printer, or there may be
no Job objects that match the criteria supplied by the client. If the
client requests any Job attributes at all, there is a set of Job
Object Attributes returned for each Job object.
Job 1 Group 1: Operation Attributes
Document 1A
Job 2
Document 2A
Document 2B
Document 2C
Job 3
Document 3A
Job 4
Job 5
Document 5A
Document 5B
Jobs are returned in the following order: First all active Jobs (Jobs Status Code and Message:
in the 'pending', 'processing', 'pending-held', and 'processing- The response includes the MANDATORY status code and an OPTIONAL
stopped' states) are returned oldest to newest (with respect to "status-message" (text) operation attribute as described in
expected completion time). Next, all completed Jobs (Jobs in the section 3.1.4.
'completed', 'aborted', or 'canceled' states) newest to oldest (with
respect to actual completion time). Jobs that are in the 'pending-
held' state SHALL appear in their position as if they were 'pending'
(otherwise, a user might be confused by Jobs that move from 'pending-
held' to 'pending' as seeming to jump ahead in the queue). Note: Jobs
are returned in the following order:
deBry, Hastings, Herriot, Isaacson, Powell Natural Language and Character Set:
Expires February xx, 1998 The "attributes-charset" and "attributes-natural-language"
First, all active Jobs (Jobs in the 'pending', 'processing', attributes as described in section 3.1.3.2.
'pending-held', and 'processing-stopped' states) are returned
oldest to newest (with respect to expected completion time), Groups 2 to N: Job Object Attributes
followed by
Second, all completed Jobs (Jobs in the 'completed', 'aborted', or The Printer object responds with one set of Job Object Attributes
'canceled' states) newest to oldest (with respect to actual for each returned Job object.
completion time). Jobs that are in the 'pending-held' state
SHALL appear in their position as if they were 'pending' For any job submitted in a different natural language than the
(otherwise, a user might be confused by Jobs that move from natural language that the client is requesting in the Get-Jobs
'pending-held' to 'pending' as seeming to jump ahead in the request, the Printer SHALL indicate the submitted natural
queue). language by returning the "job-natural-language" as the first Job
Expires April 14, 1998
object attribute, which overrides the "attributes-natural-
language" operation attribute value being returned by the
Printer. If any returned 'text' or 'name' attribute includes an
exception natural language as described in the 'text' attribute
syntax (see Section 4.1.1), the exception natural language
overrides the "job-natural-language" value (for the immediately
following attribute value only).
Jobs are returned in the following order:
- If the client requests all 'completed' Jobs (Jobs in the
'completed', 'aborted', or 'cancelled' states), then the Jobs are
returned newest to oldest (with respect to actual completion
time)
- If the client requests all 'non-completed' Jobs (Jobs in the
'pending', 'processing', 'pending-held', 'processing-stopped',
and 'unknown' states), then Jobs are returned in relative
chronological order of expected time to complete (based on
whatever scheduling algorithm is configured for the Printer
object).
3.3 Job Operations 3.3 Job Operations
The target of Job operations are Job objects. Since Job objects are All Job operations are directed at Job objects. A client MUST always
identified with both the Printer's URI and the "job-id" attribute, the supply some means of identifying the Job object in order to identify
following applies rules apply to all Job operations: the correct target of the operation. Since Job objects can be
identified with either a single Job URI or a combination of a Printer
URI with a local Job ID, the following rules apply to all Job
operation requests mapped onto HTTP/1.1:
- The Printer's URI is encoded at the transport level the same as - If the client chooses to identify Job objects with just the Job
all Printer operations URI, this "job-uri" attribute is not supplied in the body of the
- The "job-id" attribute is included as an operation attribute for operation as other operation attributes are. It is supplied in
all Job operations. the "request-URI" field in the HTTP header. - If the client
chooses to identify Job objects with both a Printer URI and a
local Job ID, the "printer-uri" attribute is not supplied in the
body of the operation, but it is supplied in the "request-URI"
field in the HTTP header. The "job-id" attribute is included as
an operation attribute.
Since the Get-Attributes operation can be both a Printer operation and
a Job operation, if a Printer object receives a Get-Attributes
request, the Printer object must check for the existence of the "job-
id" operation attribute. If present, the operation is intended to be
a Job operation on the corresponding Job object. If absent, the
operation is intended to be a Printer operation.
Expires April 14, 1998
3.3.1 Send-Document Operation 3.3.1 Send-Document Operation
Once a Job object has been created using a Create-Job operation A client uses a Create-Job operation to create a multi-document Job
(returning a "job-uri"), a client directs a Send-Document operation to object that is initially "empty" (contains no documents). In the
the newly create Job object. The operation adds a new Document to the Create-Job response, the Printer object returns the Job object's URI
Job object. An entire document MUST be sent in a single Send-Document (the "job-uri" attribute) and the Job object's 32-bit identifier (the
Request. "job-id" attribute). For each new document that the client desires to
add, the client uses a Send-Document operation. Each Send-Document
Request contains the entire stream of document data for one document.
3.3.1.1 Send-Document Request Since the Create-Job and the Send-Documents that follow can occur over
arbitrarily long periods of time, each Printer object must decide how
long to "wait" for the next Send-Document operation. The Printer
object OPTIONALLY supports the "multiple-operation-timeout" attribute.
This attribute indicates the maximum number of seconds the Printer
object will wait for the next Send-Document operation. If the Printer
object times-out waiting for the next Send-Document operation, the
Printer object MAY decide on any of the following semantic actions:
The client submits the request to a Job URI. 1. Assume that the Job is an invalid job, start the process of
changing the job state to 'aborted', and clean up all resources
associated with the Job. In this case, if another Send-Document
operation is finally received, the Printer responds with an
"client-error-not-possible" or "client-error-not-found" depending
on whether or not the Job object is still around when it finally
arrives.
2. Assume that the last Send-Document received was in fact the last
document (as if the "last-document" flag had been set to 'true'),
close the Job, and proceed to process it (i.e., move the Job's
state to 'pending').
3. Assume that the last Send-Document received was in fact the last
document, close the Job, but move it to the 'pending-held' to
allow an operator to determine whether or not to continue
processing the Job by moving it back to the 'pending' state.
Each implementation is free to decide the "best" action to take
depending on local policy, the value of "ipp-attribute-fidelity",
and/or any other piece of information available to it. If the choice
is to abort the Job, it is possible that the Job may already have been
processed to the point that some pages have been printed.
3.3.1.1 Send-Document Request
The following attribute sets are part of the Send-Document Request: The following attribute sets are part of the Send-Document Request:
Operation Attributes: Group 1: Operation Attributes
Expires April 14, 1998
Target:
Either the "printer-uri" plus "job-id" or "job-uri" target for
this operation as described in section 3.1.2.
Natural Language and Character Set:
The "attributes-charset" and "attributes-natural-language"
attributes as described in section 3.1.3.1.
"document-name" (name): "document-name" (name):
This OPTIONAL attribute identifies the client supplied Document The client OPTIONALLY supplies this attribute, and it contains
name. If this attribute is supplied, its value it used for the the client supplied document name. The document name MAY be
"document-name" attribute of the newly created Document object. different than the Job name. It might be helpful, but NEED NOT
If this attribute is not supplied by the client, the Printer be unique across multiple documents in the same Job. Typically,
optionally generates a name to use in the "document-name" the client software automatically supplies the document name on
attribute of the newly created Document object (see Section ??). behalf of the end user by using a file name or an application
generated name. See the description of the "document-name"
operation attribute in the Print-Job Request (section 3.2.1.1)
for more information about this attribute.
"last-document" (boolean): "last-document" (boolean):
The client MUST supply this attribute. It is a boolean flag that
is set to 'true' if this is the last document for the Job,
'false' otherwise.
deBry, Hastings, Herriot, Isaacson, Powell "document-charset" (charSet):
Expires February xx, 1998 This attribute is OPTIONALLY supplied by the client. A Printer
This is a boolean flag that is set to 'true' if this is the last object SHALL support this attribute if it supports a document-
Document for the Job. format that requires a character set to be identified in order to
Document Attributes: unambiguously interpret the document, such as 'text/plain'.
There are no particular values required for the Printer object to
support. This attribute specifies the charset of the document
for those document-formats that require a specification of the
charset in order to image the document unambiguously. If the
value of the "document-format" attribute contains a charset
parameter (see 'mimeType' attribute syntax in Section 4.1.9), the
client SHALL also supply the "document-charset" attribute and its
value SHALL be the same.
An optional set of Document Attributes as defined in section 4.4. "document-natural-language" (naturalLanguage):
If "document-format" is not supplied, the Printer assumes that This attribute is OPTIONALLY supplied by the client. There are
the document data is in a format that this acceptable to the no particular values required for the Printer object to support.
Printer. If the "document-format" is unknown for a certain This attribute specifies the natural language of the document for
document, the client SHALL NOT supply the attribute in the create those document-formats that require a specification of the
request or the Send-Document Request. natural language in order to image the document unambiguously,
such as proper glyph selection..
Document Content Group 2: Document Content
The client MUST supply the document data to be processed. Expires April 14, 1998
The client MUST supply the document data if the "last-document"
flag is set to 'false'. However, since a client might not know
that the previous document sent with a Send-Document operation
was the last document (i.e., the "last-document" attribute was
set to 'false'), it is legal to send a Send-Document request with
no document data where the "last-document" flag is set to 'true'.
3.3.1.2 Send-Document Response 3.3.1.2 Send-Document Response
The following sets of attributes are part of the Send-Document The following sets of attributes are part of the Send-Document
Response: Response:
Job Status Attributes Group 1: Operation Attributes
"job-name":
This is the Job's "job-name" attribute.
"job-state":
This is the Job's "job-state" attribute. The value of this
attribute is taken from a "snapshot" of the new Job object
sometime after the time the Printer receives the print request
until just prior to returning the response to the client.
"job-state-reasons":
This is the Job's "job-state-reasons" attribute. The value of
this attribute is taken from a "snapshot" of the new Job object
sometime after the time the Printer receives the print request
until just prior to returning the response to the client.
"job-state-message": Status Code and Message:
This is the Job's "job-state-message" attribute. Since the "job- The response includes the MANDATORY status code and an OPTIONAL
state-message" attribute is OPTIONAL Job attribute, itis "status-message" (text) operation attribute as described in
OPTIONALLY included in the response. section 3.1.4.
Unsupported Attributes: Natural Language and Character Set:
The "attributes-charset" and "attributes-natural-language"
attributes as described in section 3.1.3.2.
This is a set of attributes and attribute values that are Group 2: Job Object Attributes
unsupported. This output parameter is only returned in the
deBry, Hastings, Herriot, Isaacson, Powell This is the same set of attributes as described in the Print-Job
Expires February xx, 1998 response (see section 3.2.1.2).
response if the status code indicates that there was such an
error.
3.3.2 Send-URI Operation 3.3.2 Send-URI Operation
This operation is identical to the Send-Document operation (see This operation is identical to the Send-Document operation (see
section 3.3.1) except that a client supplies a URI reference section 3.3.1) except that a client supplies a URI reference
("document-uri" operation attribute) rather than the document data ("document-uri" operation attribute) rather than the document data
itself. It is up to the IPP server to interpret the URI and itself. If a Printer object supports this operation, clients can use
subsequently "pull" the document from the source referenced by the URI both Send-URI or Send-Document operations to add new documents to an
string. existing multi-document Job object.
The Printer object MUST validate the syntax of the supplied URI before
returning a response. If the Printer object supports this operation,
it MUST support the URI types defined under the Print-URI operation
(see section 3.2.2)
3.3.3 Cancel Job Operation 3.3.3 Cancel Job Operation
This operation allows a client to cancel a Print Job any time after This operation allows a client to cancel a Print Job any time after a
the print job has been submitted to the Printer. Since a Job might create job operation.. Since a Job might already be printing by the
already be printing by the time a Cancel-Job is received, some pages
may be printed before the job is actually terminated. Expires April 14, 1998
time a Cancel-Job is received, some pages may be printed before the
job is actually terminated.
3.3.3.1 Cancel-Job Request 3.3.3.1 Cancel-Job Request
The client submits the request to a Job URI. The following groups of attributes are part of the Cancel-Job Request:
The following attribute sets are part of the Cancel Job Request: Group 1: Operation Attributes
Operation Attributes Target:
Either the "printer-uri" plus "job-id" or "job-uri" target for
this operation as described in section 3.1.2.
Natural Language and Character Set:
The "attributes-charset" and "attributes-natural-language"
attributes as described in section 3.1.3.1.
"message" (text): "message" (text):
Optional message to the operator OPTIONAL message to the operator. This is not the same as the
"job-message-from-operator" attribute. This attribute is used to
send a message along with the operation request. It is an
implementation decision of how or where to display this message
(if at all).
3.3.3.2 Cancel-Job Response 3.3.3.2 Cancel-Job Response
There are no attributes in the Cancel Job Response other than the The following sets of attributes are part of the Cancel-Job Response:
Status Code and optional Status Message. Once a successful response
has been sent, the implementation guarantees that the Job will Group 1: Operation Attributes
eventually end up in the 'cancelled' state. If the implementation is
forced to leave the job in the some other state, the "job-state- Status Code and Message:
reasons" SHOULD contain the 'processing-to-stop-point' value which The response includes the MANDATORY status code and an OPTIONAL
indicates to later queries that although the Job may still be "status-message" (text) operation attribute as described in
'processing', it will eventually end up in the 'cancelled' state, not section 3.1.4.
the 'completed' state.
Natural Language and Character Set:
The "attributes-charset" and "attributes-natural-language"
attributes as described in section 3.1.3.2.
Once a successful response has been sent, the implementation
guarantees that the Job will eventually end up in the 'cancelled'
state. If the implementation is forced to leave the job in the some
other state, the "job-state-reasons" SHOULD contain the ' processing-
to-stop-point ' value which indicates to later queries that although
the Job may still be 'processing', it will eventually end up in the
'cancelled' state, not the 'completed' state.
Expires April 14, 1998
3.3.4 Get-Attributes Operation 3.3.4 Get-Attributes Operation
The Job Get-Attributes operation allows a client to obtain information The Job Get-Attributes operation allows a client to obtain information
from a Job object and it is almost identical to the Get-Attributes from a Job object and it is almost identical to the Get-Attributes
deBry, Hastings, Herriot, Isaacson, Powell
Expires February xx, 1998
operation for a Printer object (see section 3.2.5). The only operation for a Printer object (see section 3.2.5). The only
differences are that the operation is directed at a Job rather than a differences are that the operation is directed at a Job rather than a
Printer and there is no "document-format" operation attribute used Printer and there is no "document-format" operation attribute used
when querying a Job object. when querying a Job object.
For Jobs, the attribute groups include: For Jobs, the attribute groups include:
- 'job-template': all of the Job Template attributes that apply to - 'job-template': all of the Job Template attributes that apply to
a Job object (the first column of the table in Section 4.2). a Job object (the first column of the table in Section 4.2).
- 'job-description': the attributes specified in Section 4.3. - 'job-description': the attributes specified in Section 4.3.
There is also the special group 'all' which includes all supported There is also the special group 'all' that includes all supported
attributes. attributes. If for some reason, the client includes an attribute two
or more times in the request (e.g., the client supplies values of
There is another special group named 'document-attributes' which 'all', 'job-template', and 'sides' in the "requested-attributes"
consists of the Document Attributes described in section 4.4. If any attribute), the Printer SHALL only return one occurrence of the
Document Attributes are requested, the response contains a separate attribute in the response.
set of Document attributes for each Document in the Job.
3.3.4.1 Get-Attributes Request 3.3.4.1 Get-Attributes Request
The following attribute sets are part of the Get-Attributes Request The following groups of attributes are part of the Get-Attributes
when the request is directed to a Job object: Request when the request is directed at a Job object:
Operation Attributes: Group 1: Operation Attributes
Target:
Either the "printer-uri" plus "job-id" or "job-uri" target for
this operation as described in section 3.1.2.
Natural Language and Character Set:
The "attributes-charset" and "attributes-natural-language"
attributes as described in section 3.1.3.1.
"requested-attributes" (1setOf keyword) : "requested-attributes" (1setOf keyword) :
An optional set of attribute names (without values) or attribute An OPTIONAL set of attribute names and/or attribute group names
group names in whose values the requester is interested. If the in whose values the requester is interested. If the client omits
client omits this attribute, the Printer SHALL respond as if this this attribute, the Printer SHALL respond as if this attribute
input parameter had been supplied with a value of 'all'. had been supplied with a value of 'all'.
3.3.4.2 Get-Attributes Response 3.3.4.2 Get-Attributes Response
The implementation returns the following response attributes as part The Printer object returns the following sets of attributes as part of
of the Get-Attributes Response: the Get-Attributes Response:
Job Attributes: Expires April 14, 1998
Group 1: Operation Attributes
This is the set of requested attributes and their current values. Status Code and Message:
The implementation ignores (does not respond with) any requested The response includes the MANDATORY status code and an OPTIONAL
attribute which is not supported. "status-message" (text) operation attribute as described in
section 3.1.4.
Document Attributes: Natural Language and Character Set:
The "attributes-charset" and "attributes-natural-language"
attributes as described in section 3.1.3.2.
Group 2: Requested Job Object Attributes
deBry, Hastings, Herriot, Isaacson, Powell
Expires February xx, 1998
This is the set of requested attributes and their current values. This is the set of requested attributes and their current values.
The implementation ignores (does not respond with) any requested The Printer object ignores (does not respond with) any requested
attribute which is not supported. One set is returned for each attribute which is not supported.
Document in the Job.
4. Object Attributes 4. Object Attributes
This section describes the attributes with their corresponding This section describes the attributes with their corresponding
syntaxes and values that are part of the IPP model. The sections below syntaxes and values that are part of the IPP model. The sections below
show the objects and their associated attributes which are included show the objects and their associated attributes which are included
within the scope of this protocol. Many of these attributes are within the scope of this protocol. Many of these attributes are
derived from other relevant specifications: derived from other relevant specifications:
- ISO/IEC 10175 DPA (Final, June 1996) [5] - Document Printing Application (DPA) [ISODPA]
- RFC 1759 Printer MIB (Proposed Standard, May 1995) [1] - RFC 1759 Printer MIB [RFC1759]
- Internet-Draft: Printer MIB (Draft Standard in progress, July
1997) [29]
- Internet-Draft: Job Monitoring MIB (I-D in progress, June 1997)
[27]
Each attribute is uniquely identified in this document using a Each attribute is uniquely identified in this document using a
"keyword" (see section 11.2.1). The keyword is included in the "keyword" (see section 12.2.1). The keyword is included in the
section header describing that attribute. Not only are attributes section header describing that attribute. All attributes are uniquely
uniquely identified with keywords, some attributes are defined to have identified with a keyword as its name. In addition, some attributes
a syntax which is a set of keywords. are defined having a syntax that is a set of keywords.
4.1 Attribute Syntaxes 4.1 Attribute Syntaxes
This section defines the basic syntax types that a client and server This section defines the basic attribute syntax types that a client
SHALL be able to handle. These are considered to be a set of type2 and server SHALL be able to handle. Each attribute description in
enum values. The values are: sections 3 and 4 includes the name of attribute syntax(es) in the
heading (in parentheses). A conforming implementation of an attribute
SHALL include the semantics of the attribute syntax(es) so identified.
Section 6 describes how the protocol can be extended with new
attribute syntaxes.
'1' 'text': a sequence of characters, length: 0 to 4095, where Most attributes are defined to have a single attribute syntax.
each character is a member of the ISO 10646 [??] coded However, a few attributes (e.g., "job-sheet", "media", "job-hold-
character set using the UTF-8 character encoding scheme until") are defined to have several attribute syntaxes, depending on
[28].. This syntax type is used for free form human
readable text intended for human consumption.
'2' 'name': this is the same a "text" except that the sequence
of characters is of length 1 to 255 This syntax type
is used for referencing some object or entity via a
user-friendly string, such as a Printer name, a
document name, a user name, or a host name.
'3' 'keyword': a sequence of characters, length: 1 to 255,
containing only the characters ASCII lowercase letters
("a" - "z"), ASCII digits ("0" - "9"), hyphen ("-"),
dot ("."), and underscore ("_"). The first character
deBry, Hastings, Herriot, Isaacson, Powell Expires April 14, 1998
Expires February xx, 1998 the value. Since each value SHALL be tagged as to its attribute
MUST be an ASCII lowercase letter. This syntax type is syntax in the protocol, a single-valued attribute instance may have
used for enumerating semantic identifiers of entities any one of its attribute syntaxes and a multi-valued attribute
in the abstract protocol (specified in this document). instance may have a mixture of its defined attribute syntaxes.
These entities can be attribute names or values of
attributes. When a keyword is used to represent an
attribute (its name), it MUST be unique within the full
scope of IPP objects and attributes. When a keyword is
used to represent a value of an attribute, it MUST be
unique just within the scope of that attribute. That
is, the same keyword can not be used for two different
values within the same attribute to mean two different
semantic ideas. However, the same keyword can be used
across two or more attributes, representing different
semantic ideas for each attribute.
'4' 'enum': an enumerated integer value that is in the range
from -2**31 to 2**31 - 1. Each value has an
associated keyword name. Each attribute (whose syntax
is enum) enumerates the values that are defined for the
attribute. The enum type is used for attributes for
which there are enum values assigned by other
standards, such as SNMP MIBs. A number of attribute
enum values in this specification are also used for
corresponding attributes in the IETF Printer MIB [1]
and the Job Monitoring MIB [27]. Enums are not used
for attributes to which the system administrator may
assign values. Values in the range 2**30 to 2**31 - 1
are reserved for private or experimental use.
Implementers are warned that use of such values may
conflict with other implementations. Implementers are
encouraged to request registration of enum values
following the procedures in Section 6.
'5' 'uri': a sequence of characters as defined in rfc1738 and
rfc1808. This syntax type is used for carrying
Universal Resource Identifiers.
'6' 'uriScheme': a sequence of characters representing the URI
Scheme. These include 'http' for HTTP schemed URIs
(e.g., http://...), and 'ftp' for FTP schemed URIs
(e.g., ftp://...).
'7' 'human-language': a standard identifier for human language
and optionally a country. The values for this syntax
type are taken from RFC 1766 [26]. Independent of the
human language, all text strings are strings of
characters where each character is a member of the ISO
10646 [??] coded character set. Text strings are
encoded using the UTF-8 character encoding scheme [28]
'8' 'octetString:' a sequence of octets. This syntax type is
used for opaque data, such as the document-content.
deBry, Hastings, Herriot, Isaacson, Powell The attribute syntaxes are specified in the following sub-sections,
Expires February xx, 1998 where the sub-section heading is the name of the attribute syntax
'9' 'boolean': two values of 'true' and 'false'. This syntax inside the single quotes:
type is like a keywordSet, but there are only two
values. Note: An application might use a checkbox for
an attribute with this syntax type.
'10' 'integer': an integer value that is in the range from -
2**31 to 2**31 - 1. Each attribute specifies the range
constraint explicitly if the range is different from
the full range of possible integer values (e.g., 0 -
100 for the "job-priority" attribute).
'11' 'dateTime': a standard, fixed length representation of date
and time as defined in RFC 1514 [32] and RFC 1903 [33].
'12' 'resolution': a special syntax used only for "printer-
resolution" and "printer-resolution-supported" It
consists of 3 parts: a cross feed direction resolution
(positive integer value), a feed direction resolution
(positive integer value) and a units value. All these
are taken from the Printer MIB [1] suggested values.
'13' 'mimeType': MIME type values as defined by RFC 2045 [??].
'14' '1setOf X': 1 or more values of type X. This syntax type
is used for multi-valued attributes, whose value is a
set of values. Note: The syntax type is called
"1setOf" to indicate that set of values SHALL NOT be
empty (a set of size 0).
'15' 'rangeOf X': a range of value of type X. This syntax type 4.1.1 'text'
is used for ordered values (numeric, lexical, etc.)
such as integers. The 'text' attribute syntax is a sequence of one or more characters
with a limit of 1 to 4095 octets. The Printer object SHALL support
UTF-8 [RFC2044] and MAY support additional charsets provided that they
are registered with IANA [IANA-CS]. See Section 4.1.7 for the
specification of the 'charSet' attribute syntax, including restricted
semantics and examples of charsets.
If the client needs to pass or the Printer object needs to return a
'text' attribute in a different natural language than the rest of the
'text' attributes in the request or response as indicated by the
"attributes-natural-language" operation attribute (see Section 3.1.3),
the client or Printer object SHALL immediately precede that attribute
value with a 'naturalLanguage' attribute value that indicates the
differing natural language. Thus the attribute becomes multi-valued
with two values. This additional values is called an "exception"
natural language value. In a create operation, the Printer object
SHOULD accept and store an exception natural language value. If the
Printer object does not store an exception natural language value, the
Printer SHALL ignore it and SHALL store the immediately following
'text' value only. The Printer SHALL not reject the request no matter
what value the client supplies as an exception natural language.
If the attribute is multi-valued (1setOf text), then the exception
natural language value applies only to the next 'text' value.
Subsequent values in a multi-valued 'text' attribute in a request or a
response revert to the natural language of the operation attribute or
the "job-natural-language" job attribute, if present, in the case of a
Get-Jobs response.
Example: If the client supplies the "attributes-natural-language"
operation attribute with the value: 'en' indicating English, but the
values of the "job-name" attribute is in French, the values of the
normally single-valued "job-name" attribute supplied by the client in
any request or returned by the Printer object in any response would be
the following two values, each tagged with the appropriate attribute
syntax ('naturalLanguage' and 'text') in the protocol:
Expires April 14, 1998
'fr': exception natural language indicating French with attribute
syntax 'naturalLanguage'
'Rapport Mensuel': the job name in French with attribute syntax
'name'.
4.1.2 'name'
The 'name' attribute syntax is the same as 'text', including the
MANDATORY support of UTF-8 and the exception natural language
mechanism, except that the sequence of characters is limited so that
its encoded form is of length 1 to 255 octets. This syntax type is
used for user-friendly strings, such as a Printer name, that, for
humans, are more meaningful than identifiers.
Note: Only the 'text' and 'name attribute syntaxes permit the
exception natural language mechanism.
Example: If the client supplies the "attributes-natural-language"
operation attribute with the value: 'en' indicating English, but the
"printer-name" attribute is in German, the values of the normally
single-valued "printer-name" attribute returned by the Printer in any
operation response would be the following two values, each tagged with
the appropriate attribute syntax ('naturalLanguage' and 'name') in the
protocol:
'de': exception natural language indicating German with the
attribute syntax 'naturalLanguage'
'Farbdrucker': the Printer name in German with attribute syntax
'name'
4.1.3 'keyword'
The 'keyword' attribute syntax is a sequence of characters, length: 1
to 255, containing only the US-ASCII [ASCII] encoded values for
lowercase letters ("a" - "z"), digits ("0" - "9"), hyphen ("-"), dot
("."), and underscore ("_"). The first character MUST be a lowercase
letter. Furthermore, keywords SHALL be in U.S. English.
This syntax type is used for enumerating semantic identifiers of
entities in the abstract protocol, i.e., entities identified in this
document. Keywords are used as attribute names or values of
attributes. Unlike 'text' and 'name' attribute values, 'keyword'
values SHALL NOT use the exception natural language mechanism, since
they SHALL always be US-ASCII and U.S. English. When accepting
keywords from users and displaying keywords to users, clients SHOULD
localize the keywords to the charset and natural language of the user.
Expires April 14, 1998
In the definition for each attribute of this syntax type, the full set
of defined keyword values for that attribute are listed.
When a keyword is used to represent an attribute (its name), it MUST
be unique within the full scope of all IPP objects and attributes.
When a keyword is used to represent a value of an attribute, it MUST
be unique just within the scope of that attribute. That is, the same
keyword SHALL not be used for two different values within the same
attribute to mean two different semantic ideas. However, the same
keyword MAY be used across two or more attributes, representing
different semantic ideas for each attribute. Section 6 describes how
the protocol can be extended with new keyword values. Examples of
attribute name keywords:
"job-name"
"attributes-charset "
4.1.4 'enum'
The 'enum' attribute syntax is an enumerated integer value that is in
the range from -2**31 to 2**31 - 1. Each value has an associated
'keyword' name. In the definition for each attribute of this syntax
type, the full set of possible values for that attribute are listed..
This syntax type is used for attributes for which there are enum
values assigned by other standards, such as SNMP MIBs. A number of
attribute enum values in this specification are also used for
corresponding attributes in other standards [RFC1759].. This syntax
type is not used for attributes to which the system administrator may
assign values. Section 6 describes how the protocol can be extended
with new enum values. Though this document includes a symbolic name
for each enum value (in U.S. English), when accepting enum names from
users and displaying enum names to users, clients SHOULD localize the
names to the charset and natural language of the user.
4.1.5 'uri'
The 'uri' attribute syntax is any valid Uniform Resource Identifier or
URI [RFC1630]. Most often, URIs are simply Uniform Resource Locators
or URLs [RFC1738] [RFC1808].
4.1.6 'uriScheme'
The 'uriScheme' attribute syntax is a sequence of characters
representing a URI scheme according to RFC 1738 [RFC1738]. Standard
values for this syntax type are the following keywords:
'http': for HTTP schemed URIs (e.g., "http://...")
'ftp': for FTP schemed URIs (e.g., "ftp://...")
Expires April 14, 1998
'mailto': for SMTP schemed URIs (e.g., "mailto:...")
'file': for file schemed URIs (e.g., "file:...")
4.1.7 'charSet'
The 'charSet' attribute syntax is a standard identifier of a coded
character set and encoding scheme for labeling certain document
contents and 'text' and 'name' attribute values. The syntax and
semantics of this attribute syntax are specified in RFC 2046 [RFC2046]
and contained in the IANA character-set Registry [IANA-CS] according
to the IANA procedures [IANA-CSa]. As specified in RFC 2046, the
values SHALL be case-insensitive and SHALL be in US-ASCII. When a
character-set in the IANA registry has more than one name (alias), the
name labeled as "(preferred MIME name)" SHALL be used.
Some examples are:
'utf-8': ISO 10646 Universal Multiple-Octet Coded Character Set
(UCS) represented as the UTF-8 [RFC2044] transfer encoding scheme
in which US-ASCII is a subset charset. The 'utf-8' charset value
supplied in the "attributes-charset" operation attribute (see
Section 3.1.3), which is used to identify the charset of 'text'
and 'name' attributes, SHALL be restricted to conformance level 2
of ISO 10646 [ISO10646-1], so that accented letters SHALL NOT be
represented with non-spacing accents. This same 'utf-8' value
supplied in the "document-format" operation attribute (see
Sections 3.2.1.1 and 3.3.1.1), MAY include level 3 of ISO 10646.
'US-ASCII': 7-bit American Standard Code for Information
Interchange (ASCII), ANSI X3.4-1986 [ASCII]. This standard
defines US-ASCII, but RFC 2045 [46] eliminates most of the
control characters from conformant usage in MIME and IPP.
'iso-8859-1': 8-bit One-Byte Coded Character Set, Latin Alphabet
Nr 1 [ISO8859-1]. This defines a coded character set that is
used by Latin languages in the Western Hemisphere and Western
Europe. US-ASCII is a subset charset.
Some attribute descriptions MAY place additional requirements on
charset values that may be used, such as MANDATORY values the MUST be
supported or additional restrictions, such as requiring that the
charset have US-ASCII as a subset charset.
4.1.8 'naturalLanguage'
The 'naturalLanguage' attribute syntax is a standard identifier for a
natural language and optionally a country. The values for this syntax
type are taken from RFC 1766 [RFC1766]. As specified in RFC 1766, the
values SHALL be case-insensitive and SHALL be in US-ASCII. Examples
include:
Expires April 14, 1998
'en': for English
'en-us': for US English
'FR': for French
'de': for German
4.1.9 'mimeType'
The 'mimeType' attribute syntax is the standard defined Internet Media
Type (sometimes called MIME type) as defined by RFC 2046 [RFC2046] and
registered according to the procedures of RFC 2048 [RFC2048] for
identifying a document format. The value MAY include a charset
parameter, depending on the specification of the Media Type in the
IANA Registry [IANA-MT]. Examples:
'text/html': An HTML document
'text/plain': A plain text document in US-ASCII (RFC 2046 indicates
that in the absence of the charset parameter SHALL mean US-ASCII
rather than simply unspecified) [RFC2046].
'text/plain; charset=US-ASCII': A plain text document in US-ASCII
[52, 56].
'text/plain; charset=ISO-8859-1': A plain text document in ISO
8859-1 (Latin 1) [ISO8859-1].
'text/plain; charset=utf-8': A plain text document in ISO 10646
represented as UTF-8 [RFC2044]
'text/plain, charset=iso-10646-ucs-2': A plain text document in
ISO 10646 represented in two octets (UCS-2) [ISO10646-1]
'application/postscript': A PostScript document [RFC2046]
'application/vnd.hp-PCL': A PCL document [IANA-MT] (charset escape
sequence embedded in the document data)
'application/octet-stream': Auto-sense - see below
One special type is 'application/octet-stream'. If the Printer
object supports this value, the Printer object or the device SHALL be
capable of auto-sensing the format of the document data. If the
Printer object's default value attribute is set to 'application/octet-
stream' the Printer object not only supports auto-sensing of the
document format, but will depend on the result of applying its auto-
sensing algorithm in the case of missing information not supplied by
the client. If the client supplies a document format value, the
Printer SHOULD rely on the supplied attribute, rather than trust its
auto-sensing algorithm. To summarize:
1. If the client does not supply a document format value, the
Printer MUST rely on its default value setting (which may be
'application/octet-stream' indicating an auto-sensing mechanism).
2. If the client supplies a value other than 'application/octet-
stream', the client is supplying valid information about the
format of the document data and the Printer object SHOULD trust
Expires April 14, 1998
the client supplied value more than the outcome of applying an
automatic format detection mechanism. For example, the client
may be requesting the printing of a PostScript file as a
'text/plain' document. The Printer object SHOULD print a text
representation of the PostScript commands rather than interpret
the stream of PostScript commands and print the result.
3. If the client supplies a value of 'application/octet-stream',
the client is indicating that the Printer object SHOULD use its
auto-sensing mechanism whether auto-sensing is the Printer
object's default or not.
4.1.10 'octetString'
The 'octetString' attribute syntax is a sequence of octets. This
syntax type is used for opaque data
4.1.11 'boolean'
The 'boolean' attribute syntax is like a keyword with only two values
'true' and 'false'.
4.1.12 'integer'
The 'integer' attribute syntax is an integer value that is in the
range from -2**31 to 2**31 - 1. Each individual attribute may specify
the range constraint explicitly if the range is different from the
full range of possible integer values (e.g., 0 - 100 for the "job-
priority" attribute), however, the enforcement of that additional
constraint is up to the IPP objects, not the protocol.
4.1.13 'rangeOfInteger'
The 'rangeOfInteger' attribute syntax is an ordered set of two
integers, the smallest first, followed by the largest. The pair of
integers identifies an inclusive range of integer values.
4.1.14 'dateTime'
The 'dateTime' attribute syntax is a standard, fixed length
representation of the "DateAndTime" syntax as defined in RFC 1514
[RFC1514] and RFC 1903 [RFC1903]. When accepting 'dateTime' values
from users and displaying 'dateTime' values to users, clients SHOULD
localize the values to the charset and natural language of the user.
4.1.15 'resolution'
The 'resolution' attribute syntax specifies a two-dimensional
resolution in the indicated units. It consists of 3 integers: a cross
Expires April 14, 1998
feed direction resolution (positive integer value), a feed direction
resolution (positive integer value), and a units value. The semantics
of these three components are taken from the Printer MIB [RFC1759]
suggested values. That is, the cross feed direction component
resolution component is the same as the
prtMarkerAddressabilityXFeedDir object in the Printer MIB, the feed
direction component resolution component is the same as the
prtMarkerAddressabilityFeedDir in the Printer MIB, and the units
component is the same as the prtMarkerAddressabilityUnit object in the
Printer MIB (namely dots per inch and dots per centimeter). All three
values MUST be present even if the first two values are the same.
Example: '300', '600', '3' indicates a 300 dpi cross-feed direction
resolution, a 600 dpi feed direction resolution, since a '3' indicates
dots per inch.
4.1.16 '1setOf X'
The '1setOf X' attribute syntax is 1 or more values of attribute
syntax type X. This syntax type is used for multi-valued attributes.
The syntax type is called '1setOf' rather than just 'setOf' as a
reminder that the set of values SHALL NOT be empty (i.e., a set of
size 0). Sets are normally unordered, however each attribute
description of this type may specify that the values MUST be in a
certain order for that attribute.
4.2 Job Template Attributes 4.2 Job Template Attributes
Job Template attributes describe job processing behavior. Job Job Template attributes describe job processing behavior. Support for
Template attributes are OPTIONAL (see section 11.2.3 for a description Job Template attributes by a Printer object is OPTIONAL (see section
of support for OPTIONAL attributes). 12.2.3 for a description of support for OPTIONAL attributes). Also,
clients OPTIONALLY supply Job Template attributes in create requests.
Job Template attributes conform to the following rules. For each Job Job Template attributes conform to the following rules. For each Job
Template attribute called "foo": Template attribute called "foo":
1. The Printer supports a "foo-supported" attribute that describes 1. The Printer object OPTIOINALLY supports a "foo-supported"
which job processing behaviors are supported by a Printer. A attribute that describes which job processing behaviors are
client can query the Printer and find out what behaviors are supported by that Printer object. A client can query the Printer
supported by inspecting the values of the "foo-supported" object to find out what foo-related behaviors are supported by
attribute. inspecting the returned values of the "foo-supported" attribute.
2. The Printer also supports a default value attribute named "foo". 2. The Printer also OPTIONALLY supports a default value attribute
This default value attribute describes what will be done when no named "foo-default". This default value attribute describes what
other job processing information is supplied by the client will be done when no other job processing information is supplied
by the client (either explicitly as an IPP attribute in the
create request or implicitly as an embedded instruction within
the document data). If the Printer supports either the "foo-
deBry, Hastings, Herriot, Isaacson, Powell Expires April 14, 1998
Expires February xx, 1998 default" default value attribute or the "foo-supported"
(either explicitly as an IPP attribute in the create request or attribute, the Printer MUST support both.
implicitly as an embedded instruction within the job data).
However, if the Printer supports either the "foo" default value
attribute or the "foo-supported" attribute, the Printer MUST
support both.
3. "foo" is also optionally supplied by the client in a create 3. "foo" is OPTIOINALLY supplied by the client in a create request.
request. If "foo" is supplied, the client is specifying that the If "foo" is supplied, the client is specifying that the Printer
Printer SHALL apply thecorresponding job processing behavior to SHALL apply the corresponding job processing behavior to this Job
this Job while processing the Job. When "foo" is not supplied, while processing the Job. When "foo" is not supplied, the client
the client is specifying that the Printer apply the default job is specifying that the Printer apply the default job processing
processing behavior. Since an administrator could change the behavior.
default value after the Job has been submitted (while it is
waiting to be processed), the default value in affect a job NOTE: Since an administrator MAY change the default value
processing time is used for processing a Job with no client attribute after a Job has been submitted but before it has been
supplied attribute. processed, the default value used by the Printer object at job
processing time may be different that the default value in effect
at job submission time.
If an application wishes to present an end user with a list of If an application wishes to present an end user with a list of
supported values from which to choose, the application SHOULD query supported values from which to choose, the application SHOULD query
the Printer for the supported values. The application SHOULD also the Printer for the supported values. The application SHOULD also
query the default value attributes. If the application then limits query the default value attributes. If the application then limits
selectable values to only those value that are supported, application selectable values to only those value that are supported, the
guarantees that the values supplied by the client in the create application can guarantee that the values supplied by the client in
request all fall within the set of supported values at the Printer. the create request all fall within the set of supported values at the
When querying the Printer, the client MAY enumerate each attribute by Printer. When querying the Printer, the client MAY enumerate each
name in the Get-Attributes Request, or the client MAY just name the attribute by name in the Get-Attributes Request, or the client MAY
"job-template" group in order to get the complete set supported just name the "job-template" group in order to get the complete set of
attributes (both supported value and default value attributes). supported attributes (both supported and default attributes).
The "job-priority" attribute is an example of a Job Template The "finishings" attribute is an example of a Job Template attribute.
attribute. It is an integer in the range from 1 to 100. A client can It can take on a set of values such as 'staple', 'punch', and/or
query the Printer for the "job-priority-supported" attribute and the 'cover'. A client can query the Printer object for the "finishings-
"job-priority" default value attribute. The supported attribute supported" attribute and the "finishings-default" attribute. The
contains a range of supported priority values which is equal to or supported attribute contains a set of supported values. The default
smaller than the maximum range of 1 to 100. The default value value attribute contains the finishing value(s) that will be used for
attribute contains the job priority value that will be used for a new a new Job if the client does not supply a "finishings" attribute in
job if the client does not supply a value in the create request. If the create request. If the client does supply the "finishings"
the client does supply the "job-priority" attribute, the Printer attribute in the create request, the Printer validates the value or
validates the value to make sure that it falls within the range of values to make sure that they are a subset of the supported values.
supported values. If the client-supplied value is supported, the Job If the client-supplied values are all supported, the Job object is
object is created and the "job-priority" attribute is populated with created with a "finishings" attribute that is populated with the
that value. The Job object, when queried, returns the value supplied values supplied by the client. Subsequently, when the Job object is
by the client. If the client does not supply a "job-priority" value queried, it returns the values supplied by the client. If the client
in the create request, the Job object is created, but no "job- does not supply a "finishings" attribute in the create request, the
priority" attribute is associated with the Job. The client queries Job object is created, but no "finishings" attribute is associated
the Printer's default value "job-priority" value to find out at what with the new Job object. A subsequent query of the Job object will
priority the job will be processed. return no "finishings" attribute. In this case, the querying client
knows that there were was no client supplied "finishings" attribute.
If the client is interested to know what the default value is that the
Expires April 14, 1998
Printer will use for the missing attribute, the client can query the
Printer object's default value "finishings-default" attribute to find
out how the Job will be finished.
deBry, Hastings, Herriot, Isaacson, Powell
Expires February xx, 1998
The table below summarizes the names and relationships for all Job The table below summarizes the names and relationships for all Job
Template attributes. The first column of the table (labled "Job") Template attributes. The first column of the table (labeled "Job")
shows the name and syntax for each Job Template attribute in the Job shows the name and syntax for each Job Template attribute in the Job
object. These are the attributes that can optionally be supplied by object. These are the attributes that can optionally be supplied by
the client in a create request. The last two columns (labled the client in a create request. The last two columns (labeled
"Printer: Default Value" and "Printer: Supported Values") shows the "Printer: Default Value" and "Printer: Supported Values") shows the
name and syntax for each Job Template attribute in the Printer object name and syntax for each Job Template attribute in the Printer object
(the default value attribute and the supported values attribute). A (the default value attribute and the supported values attribute). A
"No" in the table means the Printer SHALL NOT support the attribute "No" in the table means the Printer SHALL NOT support the attribute
(the attribute is simply not applicable). The second part of the (that is the attribute is simply not applicable).
table lists Document level attributes. Document level attributes have
the same semantics as Job Template
deBry, Hastings, Herriot, Isaacson, Powell Expires April 14, 1998
Expires February xx, 1998
+===================+======================+======================+ +===================+======================+======================+
| Job Attribute |Printer: Default Value| Printer: Supported | | Job Attribute |Printer: Default Value| Printer: Supported |
| | Attribute | Values Attribute | | | Attribute | Values Attribute |
+===================+======================+======================+ +===================+======================+======================+
| job-sheets | job-sheets |job-sheets-supported | | job-sheets | job-sheets-default |job-sheets-supported |
| (type4 keyword) | (type4 keyword) |(1setOf type4 keyword)| | (type4 keyword, | (type4 keyword, |(1setOf type4 keyword,|
| name) | name) | name) |
| | | | | | | |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| notify-events | notify-events | notify-events- | | job-priority | job-priority-default |job-priority-supported|
|(1setOf |(1setOf type2 keyword)| supported | | (integer 1:100) | (integer 1:100) |(integer 1:100) |
| type2 keyword) | |(1setOf type2 keyword)| | | | |
+-------------------+----------------------+----------------------+
|notify-addresses | No |notify-addresses |
|(1setOf uri) | |-supported |
| | |(1setOf uriScheme) |
+-------------------+----------------------+----------------------+
| job-priority | job-priority |job-priority-supported|
| (integer 1-100) | (integer 1-100) |(rangeOf integer |
| | | 1-100) |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| job-hold-until | job-hold-until | job-hold-until- | | job-hold-until | job-hold-until- |job-hold-until- |
| (type4 keyword) | (type4 keyword) | supported | | (type4 keyword, | default | supported |
| | |(1setOf type4 keyword)| | name) | (type4 keyword, |(1setOf type4 keyword,|
| name) | name) | name) |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
|multiple-document- |multiple-document- |multiple-document- | |multiple-document- |multiple-document- |multiple-document- |
| handling | handling |handling-supported | | handling | handling-default |handling-supported |
| (type2 keyword) | (type2 keyword) |(1setOf type2 keyword)| | (type2 keyword) | (type2 keyword) |(1setOf type2 keyword)|
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| media | media | media-supported | | media | media-default | media-supported |
| (type4 keyword) | (type4 keyword) |(1setOf type4 keyword)| | (type4 keyword, | (type4 keyword, |(1setOf type4 keyword,|
| name) | name) | name) |
| | | |
| | | media-ready |
| | |(1setOf type4 keyword,|
| | | name) |
| | | | | | | |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| number-up | number-up | number-up-supported | | number-up | number-up-default | number-up-supported |
| (type3 keyword) | (type3 keyword) |(1setOf type3 keyword)| | (integer) | (integer) |(1setOf integer) |
| | | | | | | |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| sides | sides | sides-supported | | sides | sides-default | sides-supported |
| (type2 keyword) | (type2 keyword) |(1setOf type2 keyword)| | (type2 keyword) | (type2 keyword) |(1setOf type2 keyword)|
| | | | | | | |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| printer-resolution| printer-resolution | printer-resolution- | | printer-resolution| printer-resolution- | printer-resolution- |
| (type2 enum) | (type2 enum) | supported | | (resolution) | default | supported |
| | |(1setOf type2 enum) | | | (resolution) |(1setOf resolution) |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| print-quality | print-quality | print-quality- | | print-quality | print-quality-default| print-quality- |
| (type2 enum) | (type2 enum) | supported | | (type2 enum) | (type2 enum) | supported |
| | |(1setOf type2 enum) | | | |(1setOf type2 enum) |
deBry, Hastings, Herriot, Isaacson, Powell
Expires February xx, 1998
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| finishings | finishings | finishings-supported | | finishings | finishings-default | finishings-supported |
Expires April 14, 1998
|(1setOf type2 enum)|(1setOf type2 enum) |(1setOf type2 enum) | |(1setOf type2 enum)|(1setOf type2 enum) |(1setOf type2 enum) |
| | | | | | | |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| copies | copies | copies-supported | | copies | copies-default | copies-supported |
| (integer: 1 - MAX)| (2setOf integer | (2rangeOf integer | | (integer: 1:MAX) | (integer: 1:MAX) | (integer: 1:MAX) |
| | 1 - MAX) | 1- MAX) |
+-------------------+----------------------+----------------------+
| page-range | No | page-range- |
| (rangeOf integer) | | supported (boolean) |
| | | | | | | |
+===================+======================+======================+ | | | collated-copies- |
| | | | | supported |
| Note: The following attributes are Document attributes, they | | | | (integer: 1:MAX) |
| have the same semantics a Job Template attributes, | | | | |
| however they apply to each Document object rather than | +-------------------+----------------------+----------------------+
| at the Job level as Job object attributes. | | page-ranges | No | page-ranges- |
| | | (1setOf | | supported (boolean) |
+===================+======================+======================+ | rangeOfInteger) | | |
| Document |Printer: Default Value| Printer: Supported | +-------------------+----------------------+----------------------+
| Attribute | Attribute | Values Attribute | | orientation | orientation-default | orientation- |
+===================+======================+======================+ | (type2 enum) | (type2 enum) | supported |
| document-format | document-format | document-format- | | | | (1setOf type2 enum) |
| (mimeType) | (mimeType) | supported | +-------------------+----------------------+----------------------+
| | |(1setOf mimeType) | | document-format | document-format- | document-format- |
| (mimeType) | default | supported |
| | (mimeType) |(1setOf mimeType) |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| compression | No | compression-supported| | compression | No | compression-supported|
| (type3 keyword) | |(1setOf type3 keyword)| | (type3 keyword) | |(1setOf type3 keyword)|
| | | | | | | |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| document-k-octets | No |job-k-octets-supported| | job-k-octets | No |job-k-octets-supported|
| (integer) | | (rangeOf integer) | | (integer) | | (rangeOf integer) |
| | | | | | | |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| document- | No | job-impressions- | | job- | No | job-impressions- |
| impressions | | supported | | impressions | | supported |
| (integer) | | (rangeOf integer) | | (integer) | | (rangeOf integer) |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| document-media- | No | job-media-sheets- | | job-media- | No | job-media-sheets- |
| sheets | | supported | | sheets | | supported |
| (integer) | | (rangeOf integer) | | (integer) | | (rangeOf integer) |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
4.2.1 job-sheets (type4 keyword) 4.2.1 job-sheets (type4 keyword, name)
This attribute determines which if any banner page(s) SHALL be printed This attribute determines which if any banner page(s) SHALL be printed
with a job. with a job.
deBry, Hastings, Herriot, Isaacson, Powell
Expires February xx, 1998
Standard values are: Standard values are:
Expires April 14, 1998
'none': no job sheet is printed 'none': no job sheet is printed
'standard': one or more site specific standard job sheets are 'standard': one or more site specific standard job sheets are
printed, e.g. a single start sheet or both start and end sheet is printed, e.g. a single start sheet or both start and end sheet is
printed printed
To force no job sheets, the system administrator SHALL set the An administrator MAY define additional values using the 'name' or
supported value to only 'none'. To force the use of banner pages, the 'keyword' attribute syntax, depending on implementation.
supported values SHALL not include 'none'. In this case, if a client
requests 'none', the create request is rejected.
Note: The effect of this attribute on jobs with multiple documents is Note: The effect of this attribute on jobs with multiple documents is
controlled by the "multiple-document-handling" job attribute (section controlled by the "multiple-document-handling" job attribute (section
4.2.6). 4.2.4).
4.2.2 notify-events (1setOf type2 keyword)
This attribute specifies the events for which the end user desires
some sort of notification. The "notify-addresses" attribute is used
to describe the destination addresses for these events.
Standard values are:
'none': the Printer SHALL not notify.
'all': the Printer SHALL notify when any of the events occur.
'job-completion': the Printer SHALL notify when the job containing
this value completes (i.e., enters the 'completed', 'canceled',
or 'aborted' state) with or without errors.
'job-problems': the Printer SHALL notify when this job has a
problem (i.e., when the job leaves the 'processing' state and
enters the 'processing-stopped' state).
'job-started-processing': the Printer SHALL notify when the
Printer starts processing the Job (i.e., when the job leaves the
'pending' state and enters the 'processing' state).
'printer-problems': the Printer SHALL notify when this job is
affected by a Printer problem. This happens when the printer
enters the 'stopped' state while this job is in the 'pending',
'pending-held', 'processing', or 'processing-stopped' state.
ISSUE: Need to add generic alerts from the Printer MIB.
4.2.2.1 Event Notification Content
The content of each event notification is:
deBry, Hastings, Herriot, Isaacson, Powell
Expires February xx, 1998
*time: <US ASCII string representing the absolute time
of the event>CRLF
event: <keyword for the event>CRLF
printer-uri: <Printer's URI>CRLF
printer-state: <keyword for printer state>CRLF
*printer-state-reason: <set of comma separated keywords>CRLF
*job-id: <US ASCII string representing the Job Id>CRLF
*job-state: <keyword for job state>CRLF
*job-state-reason: <set of comma separated keywords>CRLF
*message: <US ASCII string>CRLF
The contents of the event notification are intended for machine
consumption more than human consumption, however the use of US ASCII
enables humans to retrieve some semantics from the event report
itself. Items above marked with and asterisk ('*') are optional. If
the implementation does not support any notion of time, then field is
not present in the notification body. If the event is Printer
related, only the Printer related fields are included. If the event
is Job related, all of the Job fields SHOULD be included.
4.2.3 notify-addresses (1setOf uri)
This attribute describes both where (the address) and how (the
mechanism for delivery ) events are to be delivered. The Printer SHALL
use this attribute as the set of addresses and methods for sending
messages when an event occurs that the end user (job submitter) has
registered an interest in.
Standard uriScheme values are:
'mailto': the Printer sends a text message via email to the
specified email address
'http': the Printer sends an HTML formatted message via an HTTP
POST method to the specified URI
'ftp': the Printer sends a text message via an FTP `append' command
to the specified remote file.
4.2.4 job-priority (integer(1:100)) 4.2.2 job-priority (integer(1:100))
This attribute specifies a priority for scheduling the Job. A higher This attribute specifies a priority for scheduling the Job. A higher
value specifies a higher priority. The value 1 indicates the lowest value specifies a higher priority. The value 1 indicates the lowest
possible priority. The value 100 indicates the highest possible possible priority. The value 100 indicates the highest possible
priority. Among those jobs that are ready to print, a Printer SHALL priority. Among those jobs that are ready to print, a Printer SHALL
print all jobs with a priority value of n before printing those with a print all jobs with a priority value of n before printing those with a
priority value of n-1 for all n. The mapping of vendor-defined priority value of n-1 for all n.
priority over this range is implementation-specific.
deBry, Hastings, Herriot, Isaacson, Powell The syntax for the "job-priority-supported" is an integer(1:100).
Expires February xx, 1998 This single integer value indicates the number of priority levels
4.2.5 job-hold-until (type4 keyword) supported. For example, if the value of "job-priority-supported" is
'3', then the Printer object supports 3 levels of job priorities
(let's call them 'high', 'medium', and 'low'). In this case, a client
MUST assume the following:
A client supplied value in the range 1-33 is the same as any other
value in the range 1-33 and any one of those values corresponds
to the 'low' priority.
A client supplied value in the range 34-66 is the same as any other
value in the range 34-66 and any one of those values corresponds
to the 'medium' priority.
A client supplied value in the range 67-100 is the same as any
other value in the range 67-100 and any one of those values
corresponds to the 'high' priority.
For another example, if the value of "job-priority-supported" is '10',
then the Printer object supports 3 levels of job priorities, (let's
call them 'one', 'two', ..., and 'ten' with 'one' being the lowest
priority and 'ten' being the highest). In this case, a client MUST
assume the following:
A client supplied value in the range 1-10 is the same as any other
value in the range 1-10 and any one of those values corresponds
to the 'one' priority.
Expires April 14, 1998
A client supplied value in the range 11-20 is the same as any other
value in the range 11-20 and any one of those values corresponds
to the 'two' priority.
...
A client supplied value in the range 91-100 is the same as any
other value in the range 91-100 and any one of those values
corresponds to the 'ten' priority.
4.2.3 job-hold-until (type4 keyword, name)
This job attribute specifies the named time period during which the This job attribute specifies the named time period during which the
Job print job SHALL become a candidate for printing. Job SHALL become a candidate for printing.
Standard values for named time periods are: Standard values for named time periods are:
'no-hold': immediately, if there are not other reasons to hold the 'no-hold': immediately, if there are not other reasons to hold the
job. job.
'day-time': during the day. 'day-time': during the day.
'evening': evening 'evening': evening
'night': night 'night': night
'weekend': weekend 'weekend': weekend
'second-shift': second-shift 'second-shift': second-shift
'third-shift': third-shift (after midnight) 'third-shift': third-shift (after midnight)
An administrator SHALL associate allowable print times with a named An administrator SHALL associate allowable print times with a named
time period (by means outside IPP 1.0). An administrator is time period (by means outside IPP 1.0). An administrator is
encouraged to pick names that suggest the type of time period. encouraged to pick names that suggest the type of time period. An
administrator MAY define additional values using the 'name' or
'keyword' attribute syntax, depending on implementation.
If the value of this attribute specifies a time period that is in the If the value of this attribute specifies a time period that is in the
future, the Printer SHALL add the 'job-hold-until-specified' value to future, the Printer SHALL add the 'job-hold-until-specified' value to
the job's "job-state-reasons" attribute, move the job to the 'pending- the job's "job-state-reasons" attribute, move the job to the 'pending-
held' state, and SHALL NOT schedule the job for printing until the held' state, and SHALL NOT schedule the job for printing until the
specified time-period arrives. When the specified time period specified time-period arrives. When the specified time period
arrives, the Printer SHALL remove the 'job-hold-until-specified' value arrives, the Printer SHALL remove the 'job-hold-until-specified' value
from the job's "job-state-reason" attribute and, if no other job from the job's "job-state-reason" attribute and, if no other job
reasons that keep it in the 'pending-held' state remain, the Printer reasons that keep it in the 'pending-held' state remain, the Printer
SHALL consider the job as a candidate for processing by moving the job SHALL consider the job as a candidate for processing by moving the job
to the 'pending' state. to the 'pending' state.
If this job attribute value is the named value 'no-hold', or specified If this job attribute value is the named value 'no-hold', or specified
time period is in effect has already started , the job SHALL be a time period is in effect has already started , the job SHALL be a
candidate for processing immediately. candidate for processing immediately.
4.2.6 multiple-document-handling (type2 keyword) Expires April 14, 1998
4.2.4 multiple-document-handling (type2 keyword)
This job attribute is relevant only if a job consists of two or more This job attribute is relevant only if a job consists of two or more
documents. It controls finishing operations, and job-sheet placement. documents. The attribute controls finishing operations and the
When the copies attribute exceeds 1, it also controls the order of placement of print-stream pages into imposed pages and onto media
documents.. sheets. When the value of the "copies" attribute exceeds 1, it also
controls the order in which the copies that result from processing the
documents are produced. For the purposes of this explanations, if "a"
represents an instance of document data, then the result of processing
the data in document "a" is a sequence of media sheets represented by
"a(*)".
Standard values are: Standard values are:
'single-document': If the files for the job are a and b, then files 'single-document': If a Job object has multiple documents, say the
a and b SHALL be treated as a single document for finishing document data is called a and b, then the result of processing
operations. Also, there SHALL be no slip sheets between files a all the document data (a and then b) SHALL be treated as a single
sequence of media sheets for finishing operations; that is,
finishing would be performed on the concatenation of the
seqeunces a(*),b(*). The Printer SHALL NOT force the data in
each document instance to be formatted onto a new print-stream
page, nor to start a new imposed page or a new media sheet. If
more than one copy is made, the ordering of the sets of media
sheets resulting from processing the document data SHALL be a(*),
b(*), a(*), b(*),...., and the Printer SHALL force each copy to
start on a new media sheet.
'separate-documents-uncollated-copies': If a Job object has
multiple documents, say the document data is called a and b, then
the result of processing the data in each document instance SHALL
be treated as a single sequence of media sheets for finishing
operations; that is, the sets a(*) and b(*) would each be
finished separately. The Printer SHALL force each copy of the
result of process the data in a single document to start on a new
media sheet. If more than one copy is made, the ordering of the
sets of media sheets resulting from processing the document data
SHALL be a(*), a(*), b(*), b(*) ....
'separate-documents-collated-copies': If a Job object has multiple
documents, say the document data is called a and b, then the
result of processing the data in each document instance SHALL be
treated as a single sequence of media sheets for finishing
operations; that is, the sets a(*) and b(*) would each be
finished separately. If more than one copy is made, the ordering
of the sets of media sheets resulting from processing the
document data SHALL be a(*), b(*), a(*), b(*), ...., and the
Printer SHALL force each document copy to start on a new sheet .
deBry, Hastings, Herriot, Isaacson, Powell 'separate-documents-collated-copies' is the same as 'single-document'
Expires February xx, 1998 with respect to ordering of pages, but not media sheet generation,
and b and the Printer SHALL NOT force each document to start on a
new page or new media sheet. If more than one copy is made, the
ordering SHALL be a, b, a, b, ...., and the Printer SHALL force
each copy to start on a new sheet.
'separate-documents-uncollated-copies': If the files for the job
are a and b, then each file SHALL be treated as a single document
for finishing operations. Also, a client may specify that a slip
sheet be placed between files a and b and the Printer shall force
each document copy to start on a new sheet. If more than one
copy is made, the ordering SHALL be a, a, b, b, ....
'separate-documents-collated-copies': If the files for the job are
a and b, then each file SHALL be treated as a single document for
finishing operations. Also, a client may specify that a slip
sheet be placed between files a and b. If more than one copy is
made, the ordering SHALL be a, b, a, b, ...., and the Printer
shall force each document copy to start on a new sheet
4.2.7 media (type4 keyword) Expires April 14, 1998
since the latter will put the first page of the next document on the
back side of a sheet if an odd number of pages have been produced so
far for the job, while the former case always force the next document
or document copy on to a new sheet.
4.2.5 media (type4 keyword, name)
This job attribute identifies the medium that the Printer uses for all This job attribute identifies the medium that the Printer uses for all
pages of the Job. pages of the Job.
The values for "media" include medium-names, medium-sizes, input-trays The values for "media" include medium-names, medium-sizes, input-trays
and electronic forms so that one attribute specifies the media. If a and electronic forms so that one attribute specifies the media. If a
printer allows a client to specify a medium name as the value of this printer allows a client to specify a medium name as the value of this
attribute, such a medium name implicitly selects an input-tray that attribute, such a medium name implicitly selects an input-tray that
contains the specified medium. If a printer allows a client to contains the specified medium. If a printer allows a client to
specify a medium size as the value of this attribute, such a medium specify a medium size as the value of this attribute, such a medium
size implicitly selects a medium name that in turn implicitly selects size implicitly selects a medium name that in turn implicitly selects
an input-tray that contains the medium with the specified size. If a an input-tray that contains the medium with the specified size. If a
printer allows a client to specify an input-tray as the value of this printer allows a client to specify an input-tray as the value of this
attribute, such an input-tray implicitly selects the medium that is in attribute, such an input-tray implicitly selects the medium that is in
that input-tray at the time the job prints. This case includes manual- that input-tray at the time the job prints. This case includes manual-
feed input-trays. If a printer allows a client to specify an feed input-trays. If a printer allows a client to specify an
electronic form as the value of this attribute, such an electronic electronic form as the value of this attribute, such an electronic
form implicitly selects a medium-name that in turn implicitly selects form implicitly selects a medium-name that in turn implicitly selects
an input-tray that contains the medium specified by the electronic an input-tray that contains the medium specified by the electronic
form. The electronic form also implicitly selects an image that the form. The electronic form also implicitly selects an image that the
Printer SHALL merge with the data from the document as its prints each Printer SHALL merge with the document data as its prints each page.
page.
ISSUE: What should we do about "media-ready"?
Standard values are (taken from ISO DPA and the Printer MIB) and are Standard values are (taken from ISO DPA and the Printer MIB) and are
listed in section 14. listed in section 14. An administrator MAY define additional values
using the 'name' or 'keyword' attribute syntax, depending on
implementation.
deBry, Hastings, Herriot, Isaacson, Powell There is also an additional attribute named "media-ready" which
Expires February xx, 1998 differs from "media-supported" in that legal values only include the
4.2.8 number-up (type3 keyword) subset of "media-supported" values that are physically loaded and
ready for printing with no operator intervention required.
This job attribute specifies the number of source page-images to The relationship of this attribute and the other attributes that
impose upon a single side of an instance of a selected medium. control document processing is described in section 15.4.
Standard values are: 4.2.6 number-up (integer)
'none': The Printer SHALL not include any embellishments and SHALL This job attribute specifies the number of source page-images to
place one logical page on a single side of an instance of the impose upon a single side of an instance of a selected medium. For
selected medium without any translation, scaling, or rotation. example, if the value is
'one': The Printer SHALL place one logical page on a single side of
Expires April 14, 1998
'1': The Printer SHALL place one logical page on a single side of
an instance of the selected medium (MAY add some sort of an instance of the selected medium (MAY add some sort of
translation, scaling, or rotation). translation, scaling, or rotation).
'two': The Printer SHALL place two logical pages on a single side '2': The Printer SHALL place two logical pages on a single side of
of an instance of the selected medium (MAY add some sort of an instance of the selected medium (MAY add some sort of
translation, scaling, or rotation). translation, scaling, or rotation).
'four': The Printer SHALL place four logical pages on a single side '4': The Printer SHALL place four logical pages on a single side of
of an instance of the selected medium (MAY add some sort of an instance of the selected medium (MAY add some sort of
translation, scaling, or rotation). translation, scaling, or rotation).
This attribute primarily controls the translation, scaling and This attribute primarily controls the translation, scaling and
rotation of page images, but a site may choose to add embellishments, rotation of page images, but a site may choose to add embellishments,
such as borders to each logical page. such as borders to each logical page.
4.2.9 sides (type2 keyword) Note: The effect of this attribute on jobs with multiple documents is
controlled by the "multiple-document-handling" job attribute (section
4.2.4) and the relationship of this attribute and the other attributes
that control document processing is described in section 15.4.
ISSUE: Steve Z.: should this section be changed to include "print-
stream page" and "layout page"?? rather than "source page" and
"logical page"?
4.2.7 sides (type2 keyword)
This attribute specifies how source page-images are to be imposed upon This attribute specifies how source page-images are to be imposed upon
the sides of an instance of a selected medium. the sides of an instance of a selected medium.
The standard values are: The standard values are:
'one-sided': imposes each consecutive source page-image upon the 'one-sided': imposes each consecutive source page-image upon the
same side of consecutive media sheets. same side of consecutive media sheets.
'two-sided-long-edge': imposes each consecutive pair of source 'two-sided-long-edge': imposes each consecutive pair of source
page-image upon front and back sides of consecutive media sheets, page-image upon front and back sides of consecutive media sheets,
such that the orientation of each pair of source-pages on the such that the orientation of each pair of source-pages on the
medium would be correct for the reader as if for binding on the medium would be correct for the reader as if for binding on the
long edge. This imposition is sometimes called 'duplex'. long edge. This imposition is sometimes called 'duplex' or
'head-to-head'.
'two-sided-short-edge': imposes each consecutive pair of source 'two-sided-short-edge': imposes each consecutive pair of source
page-image upon front and back sides of consecutive media sheets, page-image upon front and back sides of consecutive media sheets,
such that the orientation of each pair of source-pages on the such that the orientation of each pair of source-pages on the
medium would be correct for the reader as if for binding on the medium would be correct for the reader as if for binding on the
short edge. This imposition is sometimes called 'tumble' or short edge. This imposition is sometimes called 'tumble' or
'head-to-toe'. 'head-to-toe'.
'two-sided-long-edge', 'two-sided-short-edge', 'tumble', and 'duplex' 'two-sided-long-edge', 'two-sided-short-edge', 'tumble', and 'duplex'
all work the same for portrait or landscape. However 'head-to-toe' is all work the same for portrait or landscape. However 'head-to-toe' is
'tumble' in portrait but 'duplex' in landscape. 'head-to-head' also 'tumble' in portrait but 'duplex' in landscape. 'head-to-head' also
deBry, Hastings, Herriot, Isaacson, Powell Expires April 14, 1998
Expires February xx, 1998
switches between 'duplex' and 'tumble' when using portrait and switches between 'duplex' and 'tumble' when using portrait and
landscape modes. landscape modes.
4.2.10 printer-resolution (resoultion) Note: The effect of this attribute on jobs with multiple documents is
controlled by the "multiple-document-handling" job attribute (section
4.2.4) and the relationship of this attribute and the other attributes
that control document processing is described in section 15.4.
4.2.8 printer-resolution (resolution)
This attribute identifies the resolution that Printer uses for a This attribute identifies the resolution that Printer uses for a
certain Job. certain Job.
The value is a special type consisting of a pair of integers and a 4.2.9 print-quality (type2 enum)
value which specifies the units for the two integers. The three
values are the same as those specified in the draft-ietf-
printmib-mib-info-02.txt as prtMarkerAddressabilityFeedDir (the
resolution in the feed direction),
prtMarkerAddressabilityXFeedDir (the resolution in the cross feed
direction), and prtMarkerAddressabilityUnit (the units of the
first two values, namely dots per inch and dots per centimeter).
4.2.11 print-quality (type2 enum)
This attribute specifies the print quality that the Printer uses for a This attribute specifies the print quality that the Printer SHALL use
certain Job. for a certain Job.
The standard values are: The standard values are:
'3' 'draft': lowest quality available on the printer '3' 'draft': lowest quality available on the printer
'4' 'normal': normal or intermediate quality on the printer '4' 'normal': normal or intermediate quality on the printer
'5' 'high': highest quality available on the printer '5' 'high': highest quality available on the printer
4.2.12 finishings (1setOf type2 enum) 4.2.10 finishings (1setOf type2 enum)
This attribute identifies the finishing operations that the Printer This attribute identifies the finishing operations that the Printer
uses for each copy of each printed document in a particular Job. For uses for each copy of each printed document in a particular Job. For
Jobs with multiple documents, the "multiple-document-handling" Jobs with multiple documents, the "multiple-document-handling"
attribute determines what constitutes a _copy_ for purposes of attribute determines what constitutes a _copy_ for purposes of
finishing. finishing.
Standard values are: Standard values are:
'3' 'none': Perform no finishing '3' 'none': Perform no finishing
'4' 'staple': Bind the document(s) with one or more staples. '4' 'staple': Bind the document(s) with one or more staples.
The exact number and placement of the staples is site- The exact number and placement of the staples is site-
defined. defined.
'5' 'staple-top-left': Place one or more staples on the top '5' 'punch': This value indicates that holes are required in
left corner of the document(s).
'6' 'staple-bottom-left': Place one or more staples on the
bottom left corner of the document(s).
'7' 'staple-top-right': Place one or more staples on the top
right corner of the document(s).
deBry, Hastings, Herriot, Isaacson, Powell
Expires February xx, 1998
'8' 'staple-bottom-right': Place one or more staples on the
bottom right corner of the document(s).
'9' 'saddle-stitch': Bind the document(s) with one or more
staples (wire stitches) along the middle fold. The
exact number and placement of the stitches is site-
defined.
'10' 'edge-stitch': Bind the document(s) with one or more
staples (wire stitches) along one edge. The exact
number and placement of the staples is site-defined.
'11' 'punch': This value indicates that holes are required in
the finished document. The exact number and placement the finished document. The exact number and placement
of the holes is site-defined The punch specification of the holes is site-defined The punch specification
MAY be satisfied (in a site- and implementation- MAY be satisfied (in a site- and implementation-
specific manner) either by drilling/punching, or by specific manner) either by drilling/punching, or by
substituting pre-drilled media. substituting pre-drilled media.
'12' 'cover': This value is specified when it is desired to '6' 'cover': This value is specified when it is desired to
select a non-printed (or pre-printed) cover for the select a non-printed (or pre-printed) cover for the
document. This does not supplant the specification of a document. This does not supplant the specification of a
Expires April 14, 1998
printed cover (on cover stock medium) by the document printed cover (on cover stock medium) by the document
itself. itself.
'13' 'bind': This value indicates that a binding is to be '7' 'bind': This value indicates that a binding is to be
applied to the document; the type and placement of the applied to the document; the type and placement of the
binding is site-defined." binding is site-defined."
4.2.13 copies (integer(1:2**31 - 1)) Note: The effect of this attribute on jobs with multiple documents is
controlled by the "multiple-document-handling" job attribute (section
4.2.4).
If the client supplies a value of 'none' along with any other
combination of values, it is the same as if only that other
combination of values had been supplied (that is the 'none' value has
no effect).
4.2.11 copies (integer(1:2**31 - 1))
This attribute specifies the number of copies to be printed. On many This attribute specifies the number of copies to be printed. On many
devices the supported number of collated copies will be limited by the devices the supported number of collated copies will be limited by the
number of physical output bins on the device, and may be different number of physical output bins on the device, and may be different
from the number of uncollated copies which can be supported. Therefore from the number of uncollated copies which can be supported. The
the copies-supported attribute specifies a set of ranges; the first "copies-supported" attribute is the limit on the number of uncollated
defines the supported range of values for uncollated copies, and the copies supported. The "collated-copies-supported" attribute is the
second the supported range of values for collated printing. The set limit on the number of collated copies supported. The value in the
of default values for copies specify the default number of uncollated "copies-default" default value attribute applies to either collated or
copies followed by the default number of collated copies. uncollated as determined by the value in the "multiple-document-
handling-default" attribute.
The effect of this attribute is controlled by the "multiple-documents- Note: The effect of this attribute on jobs with multiple documents is
handling" attribute (section 4.2.6).This attribute specifies the controlled by the "multiple-document-handling" job attribute (section
number of copies of the job to be printed. 4.2.4) and the relationship of this attribute and the other attributes
that control document processing is described in section 15.4.
4.2.14 page-range (rangeOf integer) 4.2.12 page-ranges (1setOf rangeOfInteger)
This attribute specifies the pages of a document which are to be This attribute specifies the pages of a document which are to be
printed. In most cases, the exact pages to be printed will be printed. In most cases, the exact pages to be printed will be
generated by a device driver and this attribute would not be required. generated by a device driver and this attribute would not be required.
However, when printing an archived document which has already been However, when printing an archived document which has already been
formatted, the end user may elect to print just a subset of the pages formatted, the end user may elect to print just a subset of the pages
contained in the document. In this case, if page-range = n.m is contained in the document. In this case, if page-range = n.m is
deBry, Hastings, Herriot, Isaacson, Powell
Expires February xx, 1998
specified, the first page to be printed will be page n. All subsequent specified, the first page to be printed will be page n. All subsequent
pages of the document will be printed through and including page m. pages of the document will be printed through and including page m.
Page-range supported is a boolean value indicating whether or not the "page-ranges-supported" is a boolean value indicating whether or not
printer is capable of supporting the printing of page ranges. This the printer is capable of supporting the printing of page ranges.
capability may differ from one PDL to another. The page-range default This capability may differ from one PDL to another. There is no "page-
value is always zero (0) and indicates that all pages of the document
will be printed if a page-range is not specified.
4.2.15 orientation (type2 enum) Expires April 14, 1998
ranges-default" attribute. If the "page-ranges" attribute is not
supplied by the client, all pages of the document will be printed.
4.2.13 orientation (type2 enum)
This attribute specifies the orientation of the content on the output This attribute specifies the orientation of the content on the output
pages to be printed. In most cases, the orientation of the content is pages to be printed. In most cases, the orientation of the content is
specified within the document format generated by the device driver at specified within the document format generated by the device driver at
print time. However, some document formats (such as "text") do not print time. However, some document formats (such as 'text/plain') do
support the notion of page orientation, and it is possible to bind the not support the notion of page orientation, and it is possible to bind
orientation after the document content has been generated. This the orientation after the document content has been generated. This
attribute provides an end user with the means to specify orientation attribute provides an end user with the means to specify orientation
for such documents. for such documents.
Standard values are: Standard values are:
'1' 'portrait': The content will be printed across the short '1' 'portrait': The content will be imaged across the short
edge of the media. edge of the medium.
'2' 'landscape': The content will be printed across the long '2' 'landscape': The content will be imaged across the long
edge of the media. edge of the medium. Landscape is defined to be a
rotation of the logical page to be imaged by +90
degrees with respect to the medium (i.e. anti-
clockwise) from the portrait orientation. Note: The
+90 direction was chosen because simple finishing on
the long edge is the same edge whether portrait or
landscape
'3' 'reverse-landscape': The content will be imaged across the
long edge of the medium. Reverse-landscape is defined
to be a rotation of the logical page to be imaged by -
90 degrees with respect to the medium (i.e. clockwise)
from the portrait orientation. Note: The 'reverse-
landscape' value was added because some applications
rotate landscape -90 degrees from portrait, rather than
+90 degrees.
4.2.16 document-format (mimeType) Note: The effect of this attribute on jobs with multiple documents is
controlled by the "multiple-document-handling" job attribute (section
4.2.4) and the relationship of this attribute and the other attributes
that control document processing is described in section 15.4.
This attribute defines the document format of the data to be printed. 4.2.14 document-format (mimeType)
The standard values for this attribute are MIME types. Since the
complete list is rather long, the full enumeration of standard values
is found in section 13 APPENDIX C: "document-format" values.
If the "document-format" is unknown for a certain document, the client This attribute identifies the document format of the data to be
does not supply the attribute in the create request or the Send- printed. The standard values for this attribute are Internet Media
Document Request. types which are sometimes called MIME types. See the description of
the 'mimeType' attribute syntax in Section 4.1.9.
4.2.17 compression (type3 keyword) Expires April 14, 1998
4.2.15 compression (type3 keyword)
This attribute identifies compression algorithms used for compressed This attribute identifies compression algorithms used on compressed
document data (not the operation data). document data. The value of this attribute does not apply the
encoding of the IPP operation itself.
Standard values are : Standard values are :
'none': no compression is used. 'none': no compression is used.
'zip':ZIP (inflate/deflate) compression technology 'deflate': ZIP public domain inflate/deflate) compression
technology
`gzip' GNU zip compression technology described in RFC 1952. `gzip' GNU zip compression technology described in RFC 1952.
deBry, Hastings, Herriot, Isaacson, Powell
Expires February xx, 1998
'compress': UNIX compression technology 'compress': UNIX compression technology
ISSUE: Look what HTTP defines. 4.2.16 job-k-octets (integer(0:2**31 - 1))
4.2.18 job-k-octets (integer(0:2**31 - 1)) This attribute specifies the total size of the document data in K
octets, i.e., in units of 1024 octets requested to be processed in
the job. The value SHALL be rounded up, so that a job between 1 and
1024 octets SHALL be indicated as being 1, 1025 to 2048 SHALL be 2,
etc.
This attribute specifies the total size of the job in K octets, i.e., This value SHALL not include the multiplicative factors contributed by
in units of 1024 octets. The value SHALL be rounded up, so that a job the number of copies specified by the "copies" attribute, independent
between 1 and 1024 octets SHALL be indicated as being 1, 1025 to 2048 of whether the device can process multiple copies without making
SHALL be 2, etc. multiple passes over the document data and independent of whether the
output is collated or not. Thus the value is independent of the
implementation.
Note: This attribute and the following two attributes ("job- Note: This attribute and the following two attributes ("job-
impressions" and "job-media-sheets") are not intended to be counters; impressions" and "job-media-sheets") are not intended to be counters;
they are intended to be useful routing and scheduling information if they are intended to be useful routing and scheduling information if
known. For these three attributes, the Printer may try to compute the known. For these three attributes, the Printer may try to compute the
value if it is not supplied in the create request. Even if the client value if it is not supplied in the create request. Even if the client
does supply a value for this attribute in the create request, the does supply a value for this attribute in the create request, the
Printer may choose to change the value if the Printer is able to Printer may choose to change the value if the Printer is able to
compute a value which is more accurate than the client supplied value. compute a value which is more accurate than the client supplied value.
The Printer may be able to determine the correct value for this The Printer may be able to determine the correct value for this
attribute either right at job submission time or at any later point in attribute either right at job submission time or at any later point in
time. If the value of this attribute is unknown, the Printer may time. If the value of this attribute is unknown, the Printer may
choose to respond with a value of '-2' (which signifies "unknown") choose to respond with a value of '-2' (which signifies "unknown")
rather than choose to not support the attribute at all. rather than choose to not support the attribute at all.
4.2.19 job-impressions (integer(0:2**31 - 1)) 4.2.17 job-impressions (integer(0:2**31 - 1))
This attribute specifies the total number of impressions for this job. This attribute specifies the total number of impressions of the
document(s) being requested by this job to produce.
4.2.20 job-media-sheets (integer(0:2**31 - 1)) Expires April 14, 1998
This value SHALL not include the multiplicative factors contributed by
the number of copies specified by the "copies" attribute, independent
of whether the device can process multiple copies without making
multiple passes over the document data and independent of whether the
output is collated or not. Thus the value is independent of the
implementation.
This attribute specifies the total number of media sheets used by this 4.2.18 job-media-sheets (integer(0:2**31 - 1))
job.
This attribute specifies the total number of media sheets to be
processed for this job.
Unlike the "job-k-octets" and the "job-impressions" attributes, this
value SHALL include the multiplicative factors contributes by the
number of copies specified by the "copies" attribute
4.3 Job Description Attributes 4.3 Job Description Attributes
The attributes in this section form the attribute group called "job- The attributes in this section form the attribute group called "job-
description". The following table summarizes these attributes. The description". The following table summarizes these attributes. The
third column indicates whether the attribute is a MANDATORY attribute. third column indicates whether the attribute is a MANDATORY attribute
If it is not MANDATORY, then it is OPTIONAL. that MUST be supported by Printer objects. If it is not MANDATORY,
then it is OPTIONAL.
deBry, Hastings, Herriot, Isaacson, Powell Expires April 14, 1998
Expires February xx, 1998
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| Attribute | Syntax | MANDATORY? | | Attribute | Syntax | MANDATORY? |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-uri | uri | MANDATORY | | job-uri | uri | MANDATORY |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-id | 32bit unsigned | MANDATORY | | job-id | integer(1:MAX) | MANDATORY |
| (this or job-uri) | | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-more-info | uri | | | job-more-info | uri | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-name | name | MANDATORY | | job-name | name | MANDATORY |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-originating-user | name | MANDATORY | | job-originating-user | octetString | MANDATORY |
+----------------------------+----------------------+----------------+
| job-originating-host | name | |
+----------------------------+----------------------+----------------+
| user-human-language | human-language | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-state | type1 enum | MANDATORY | | job-state | type1 enum | MANDATORY |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-state-reasons | 1setOf type2 keyword | | | job-state-reasons | 1setOf type2 keyword | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-state-message | text | | | job-state-message | text | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| number-of-documents | integer | |
+----------------------------+----------------------+----------------+
| output-device-assigned | name | | | output-device-assigned | name | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| time-at-pending | seconds | | | time-of-creation | integer | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| time-at-processing | seconds | | | time-at-processing | integer | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| time-at-completed | seconds | | | time-at-completed | integer | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| number-of-intervening-jobs | integer | | | number-of-intervening-jobs | integer | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-message-from-operator | text | | | job-message-from-operator | text | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-k-octets-processed | integer | | | job-k-octets-processed | integer | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-impressions-completed | integer | | | job-impressions-completed | integer | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-media-sheets-completed | integer | | | job-media-sheets-completed | integer | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| attributes-charset | charSet | MANDATORY |
+----------------------------+----------------------+----------------+
| attributes-natural-language| naturalLanguage | MANDATORY |
+----------------------------+----------------------+----------------+
4.3.1 job-uri (uri) 4.3.1 job-uri (uri)
Expires April 14, 1998
This attribute contains the URI for the job. The Printer, on receipt This attribute contains the URI for the job. The Printer, on receipt
of a new job, generates a URI which identifies the new Job on that of a new job, generates a URI which identifies the new Job on that
Printer. The Printer returns the value of the "job-uri" attribute as Printer. The Printer returns the value of the "job-uri" attribute as
part of the response to a create request. This MUST be an HTTP
schemed URI, however the precise format of a Job URI is implementation
dependent.
deBry, Hastings, Herriot, Isaacson, Powell For a description of this attribute and its relationship to the
Expires February xx, 1998 following "job-id" attribute, see the discussion in section 2.4 on
part of the response to a create request. The precise format of a "Object Identity".
job URI is implementation dependent.
4.3.2 job-id (32bit unsigned integer) 4.3.2 job-id (integer(1:MAX))
This attribute contains the ID of the job. The Printer, on receipt of This attribute contains the ID of the job. The Printer, on receipt of
a new job, generates an ID which identifies the new Job on that a new job, generates an ID which identifies the new Job on that
Printer. The Printer returns the value of the "job-id" attribute as Printer. The Printer returns the value of the "job-id" attribute as
part of the response to a create request. part of the response to a create request.
ISSUE: job-uri or job-id? For a description of this attribute and its relationship to the
previous "job-uri" attribute, see the discussion in section 2.4 on
"Object Identity".
4.3.3 job-uri-user (uri) 4.3.3 job-more-info (uri)
Similar to "job-uri", this attribute contains the URI referencing an Similar to "printer-more-info", this attribute contains the URI
HTML page containing information about the Job. referencing some resource with more information about this Job object,
perhaps an HTML page containing information about the Job.
4.3.4 job-name (name) 4.3.4 job-name (name)
This attribute is the name of the job. It is a name that is more user This attribute is the name of the job. It is a name that is more user
friendly than the "job-uri" attribute value. It does not need to be friendly than the "job-uri" attribute value. It does not need to be
unique. The Job's "job-name" attribute is set to the value supplied unique between Jobs. The Job's "job-name" attribute is set to the
by the client in the "job-name" operation attribute in the create value supplied by the client in the "job-name" operation attribute in
request. If, however, if it is not supplied by the client in the the create request. If, however, if the "job-name" operation
create request, the Printer, on creation of the Job, SHALL generate a attribute is not supplied by the client in the create request, the
name. The Printer can generate the name using any method convenient Printer, on creation of the Job, SHALL generate a name. The printer
to the application. The Printer MAY choose to use the value of the SHOULD generate the value of the Job's "job-name" attribute from the
"document-name" attribute of the first (or only) Document (or any first of the following sources that produces a value: 1) the
other piece of Job specific information) as a basis for generating a "document-URI" attribute of the first (or only) document, 2) the
Job name. "document-name" operation attribute of the first (or only) document,
or 3) any other piece of Job specific information.
ISSUE: There has been some suggestion to add a "job-user-label". The
idea for this attribute was to allow a client to supply some
meaningful label to be applied to the Job independent of the Job URI
or the Job ID. However, after reviewing the semantics of "job-name",
the two sound identical.
4.3.5 job-originating-user (name)
This attribute specifies the user name of the person submitting the
print job. The Printer sets this attribute to the most authenticated
name that it can obtain from the protocol over which the operation was
received from the client.
4.3.6 job-originating-host (name)
This attribute identifies the originating host of the job. The Printer
sets this attribute to the most authenticated host name it can obtain
deBry, Hastings, Herriot, Isaacson, Powell
Expires February xx, 1998
from the protocol over which the operation was received from the
client.
4.3.7 user-human-language (human-language)
This attribute identifies the human language and optionally the 4.3.5 job-originating-user (octetString)
country of the end user. The Printer sets this attribute to the most
reliable value it can obtain from the protocol over which the Print
operation was received from the client.
The Printer uses this attribute to determine the human language it This attribute contains the identity of the end user that submitted
SHOULD use for translating ALL text strings that it sends back to the the print job. The Printer object sets this attribute to the most
end user. The Printer has a "human-languages-supported" supported
values attribute and a "human-language" default value attribute.
ISSUE: This should be a Job Template attribute. Expires April 14, 1998
authenticated name that it can obtain from the authentication service
over which the IPP operation was received.
4.3.8 job-state (type1 enum) 4.3.6 job-state (type1 enum)
This attribute identifies the current state of the job. Even though This attribute identifies the current state of the job. Even though
the IPP protocol defines eight values for job states, implementations the IPP protocol defines eight values for job states, implementations
only need to support those states which are appropriate for the only need to support those states which are appropriate for the
particular implementation. In other words, a Printer supports only particular implementation. In other words, a Printer supports only
those job states implemented by the output device and available to the those job states implemented by the output device and available to the
Printer object implementation. Printer object implementation.
Standard values are: Standard values are:
'unknown'(2): The job state is not known, or its state is 'unknown'(2): The job state is not known, or its state is
indeterminate. indeterminate.
'pending'(3): The job is a candidate to start processing, but is 'pending'(3): The job is a candidate to start processing, but is
not yet processing. not yet processing.
'pending-held'(4): The job is not a candidate for processing for 'pending-held'(4): The job is not a candidate for processing for
any number of reasons but will return to the 'pending' state as any number of reasons but will return to the 'pending' state as
soon as the reasons are no longer present. The job's "job-state- soon as the reasons are no longer present. The job's "job-state-
reason" attribute SHALL indicate why the job is no longer a reason" attribute SHALL indicate why the job is no longer a
candidate for processing. candidate for processing.
'processing'(5): Either: 'processing'(5): One or more of:
1. the job is using, or is attempting to use, one or more 1. the job is using, or is attempting to use, one or more purely
document transforms which include (1) purely software software processes that are analyzing, creating, or
processes that are interpreting a PDL, and (2) hardware interpreting a PDL, etc.,
devices that are interpreting a PDL, making marks on a medium, 2. the job is using, or is attempting to use, one or more
and/or performing finishing, such as stapling OR hardware devices that are interpreting a PDL, making marks on
2. the server has made the job ready for printing, but the a medium, and/or performing finishing, such as stapling, etc.,
output device is not yet printing it, either because the job
hasn't reached the output device or because the job is queued
in the output device or some other spooler, awaiting the
output device to print it.
deBry, Hastings, Herriot, Isaacson, Powell
Expires February xx, 1998
ISSUE: Suggested change to (but this must be synchronized with JMP)
'processing'(5): One of:
1. the job is using, or is attempting to use hardware devices
that are making marks on a medium, and/or performing
finishing, such as stapling OR
2. the job is using, or is attempting to use software processes
that are analyzing or interpreting a PDL without making marks
on a medium.
3. the server has made the job ready for printing, but the output 3. the server has made the job ready for printing, but the output
device is not yet printing it, either because the job hasn't device is not yet printing it, either because the job hasn't
reached the output device or because the job is queued in the reached the output device or because the job is queued in the
output device or some other spooler, awaiting the output output device or some other spooler, awaiting the output
device to print it. device to print it.
Implementations MAY, though they NEED NOT, include additional
values in the job's "job-state-reasons" attribute to indicate the
progress of the job, such as adding the 'job-printing' value to
indicate when the device is actually making marks on a medium.
When the job is in the 'processing' state, the entire job state When the job is in the 'processing' state, the entire job state
includes the detailed status represented in the printer's includes the detailed status represented in the printer's
"printer-state", "printer-state-reasons", and "printer-state- "printer-state", "printer-state-reasons", and "printer-state-
message" attributes. message" attributes.
Implementations MAY include additional values in the job's "job- Implementations MAY include additional values in the job's "job-
state-reasons" attribute to indicate the progress of the job, state-reasons" attribute to indicate the progress of the job,
such as adding the 'job-printing' value to indicate when the such as adding the 'job-printing' value to indicate when the
output device is actually making marks on paper. Most output device is actually making marks on paper and/or the
implementations won't bother with this nuance.
Expires April 14, 1998
'processing-to-stop-point' value to indicate that the server or
device is in the process of canceling or aborting the job. Most
implementations won't bother with this nuance.
'processing-stopped'(6): The job has stopped while processing for 'processing-stopped'(6): The job has stopped while processing for
any number of reasons and will return to the 'processing' state any number of reasons and will return to the 'processing' state
as soon as the reasons are no longer present. as soon as the reasons are no longer present.
The job's "job-state-reason" attribute MAY indicate why the job The job's "job-state-reason" attribute MAY indicate why the job
has stopped processing. For example, if the output device is has stopped processing. For example, if the output device is
stopped, the 'printer-stopped' value MAY be included in the job's stopped, the 'printer-stopped' value MAY be included in the job's
"job-state-reasons" attribute. "job-state-reasons" attribute.
NOTE - When an output device is stopped, the device usually
Note: When an output device is stopped, the device usually
indicates its condition in human readable form locally at the indicates its condition in human readable form locally at the
device. A client can obtain more complete device status remotely device. A client can obtain more complete device status remotely
by querying the printer's "printer-state", "printer-state- by querying the printer's "printer-state", "printer-state-
reasons" and "printer-state-message" attributes. reasons" and "printer-state-message" attributes.
'canceled'(7): The job has been canceled by a Cancel-Job operation 'canceled'(7): The job has been canceled by a Cancel-Job operation
and is either (1) in the process of terminating or (2) has and the Printer has completed canceling the job and all job
completed terminating. The job's "job-state-reasons" attribute status attributes have reached their final values for the job.
SHOULD contain either the 'canceled-by-user' or 'canceled-by- While the Printer is canceling the job, the job's "job-state-
operator' value. reasons" attribute SHOULD contain the 'processing-to-stop-point'
value and one of the 'canceled-by-user', 'canceled-by-operator',
or 'canceled-at-device' value.
'aborted'(8): The job has been aborted by the system, usually 'aborted'(8): The job has been aborted by the system, usually
while the job was in the 'processing' or 'processing-stopped' while the job was in the 'processing' or 'processing-stopped'
state. state and the Printer has completed aborting the job and all job
status attributes have reached their final values for the job.
deBry, Hastings, Herriot, Isaacson, Powell While the server or device is aborting the job, the job's "job-
Expires February xx, 1998 state-reasons" attribute MAY contain the 'processing-to-stop-
point' and 'aborted-by-system' values. If supported, the
'aborted-by-system' value SHALL remain while the job is in the
'aborted' state.
'completed'(9): The job has completed successfully or with 'completed'(9): The job has completed successfully or with
warnings or errors after processing and all of the job media warnings or errors after processing and all of the job media
sheets have been successfully stacked in the appropriate output sheets have been successfully stacked in the appropriate output
bin(s). The job's "job-state-reasons" attribute SHOULD contain bin(s). The job's "job-state-reasons" attribute SHOULD contain
one of: 'completed-successfully', 'completed-with-warnings', or one of: 'completed-successfully', 'completed-with-warnings', or
'completed-with-errors' values. 'completed-with-errors' values.
The final value for this attribute SHALL be one of: 'completed', The final value for this attribute SHALL be one of: 'completed',
'canceled', or 'aborted' before the Printer removes the job 'canceled', or 'aborted' before the Printer removes the job
altogether. The length of time that jobs remain in the 'canceled', altogether. The length of time that jobs remain in the 'canceled',
'aborted', and 'completed' states depends on implementation. 'aborted', and 'completed' states depends on implementation.
The following figure shows the normal job state transitions. The following figure shows the normal job state transitions.
Expires April 14, 1998
+----> canceled +----> canceled
/ /
+----> pending --------> processing ---------+------> completed +----> pending --------> processing ---------+------> completed
| ^ ^ \ | ^ ^ \
--->+ | | +----> aborted --->+ | | +----> aborted
| v v / | v v /
+----> pending-held processing-stopped ----+ +----> pending-held processing-stopped ---+
Normally a job progresses from left to right. Other state transitions Normally a job progresses from left to right. Other state transitions
are unlikely, but are not forbidden. Not shown are the transitions to are unlikely, but are not forbidden. Not shown are the transitions to
the 'canceled' state from the 'pending', 'pending-held', 'processing', the 'canceled' state from the 'pending', 'pending-held', and
and 'processing-stopped' states. 'processing-stopped' states.
4.3.9 job-state-reasons (1setOf type2 keyword) Jobs reach one of the three terminal states: 'completed', 'canceled',
or 'aborted', after the jobs have completed all activity, including
stacking output media, after the jobs have completed all activity, and
all job status attributes have reached their final values for the job.
4.3.7 job-state-reasons (1setOf type2 keyword)
This attribute provides additional information about the job's current This attribute provides additional information about the job's current
state, i.e., information that augments the value of the job's "job- state, i.e., information that augments the value of the job's "job-
state" attribute. state" attribute.
Implementation of these values is OPTIONAL, i.e., a Printer NEED NOT Implementation of these values is OPTIONAL, i.e., a Printer NEED NOT
implement them, even if (1) the output device supports the implement them, even if (1) the output device supports the
functionality represented by the reason and (2) is available to the functionality represented by the reason and (2) is available to the
Printer object implementation. These values MAY be used with any job Printer object implementation. These values MAY be used with any job
state or states for which the reason makes sense. Furthermore, when state or states for which the reason makes sense. Furthermore, when
implemented, the Printer SHALL return these values when the reason implemented, the Printer SHALL return these values when the reason
applies and SHALL NOT return them when the reason no longer applies applies and SHALL NOT return them when the reason no longer applies
whether the value of the job's "job-state" attribute changed or not. whether the value of the Job's "job-state" attribute changed or not.
When the job does not have any reasons for being in its current state, When the Job does not have any reasons for being in its current state,
the Printer shall set the value of the job's "job-state-reasons" the Printer MAY set the value of the Job's "job-state-reasons"
attribute to 'none'. attribute to 'none'.
NOTE - While values cannot be added to the 'job-state' attribute NOTE - While values cannot be added to the 'job-state' attribute
without impacting deployed clients that take actions upon receiving without impacting deployed clients that take actions upon receiving
deBry, Hastings, Herriot, Isaacson, Powell
Expires February xx, 1998
"job-state" values, it is the intent that additional "job-state- "job-state" values, it is the intent that additional "job-state-
reasons" values can be defined and registered without impacting such reasons" values can be defined and registered without impacting such
deployed clients. In other words, the "job-state-reasons" attribute deployed clients. In other words, the "job-state-reasons" attribute
is intended to be extensible. is intended to be extensible.
The following standard values are defined: The following standard values are defined. For ease of understanding,
the values are presented in the order in which the reasons are likely
to occur (if implemented), starting with the 'job-incoming' value:
'none': There are no reasons for the job's current state. 'none': There are no reasons for the job's current state.
Expires April 14, 1998
'job-incoming': The CreateJob operation has been accepted by the 'job-incoming': The CreateJob operation has been accepted by the
Printer, but the Printer is expecting additional SendDocument Printer, but the Printer is expecting additional Send-Document
operations and/or is accessing/accepting document data. and/or Send-URI operations and/or is accessing/accepting document
data.
'submission-interrupted': The job was not completely submitted for
some unforeseen reason, such as: (1) the Printer has crashed
before the job was closed by the client, (2) the Printer or the
document transfer method has crashed in some non-recoverable way
before the document data was entirely transferred to the Printer,
(3) the client crashed or failed to close the job before the
time-out period.
'job-outgoing': The Printer is transmitting the job to the output 'job-outgoing': The Printer is transmitting the job to the output
device. device.
'job-hold-until-specified-time': The value of the job's "job-hold- 'job-hold-until-specified': The value of the job's "job-hold-
until" attribute specifies a time period that is still in the until" attribute was specified with a time period that is still
future. The job SHALL NOT be a candidate for processing until in the future. The job SHALL NOT be a candidate for processing
this reason is removed and there are no other reasons to hold the until this reason is removed and there are no other reasons to
job. hold the job.
'job-hold-until-resources-are -ready': At least one of the 'resources-are-not-ready': At least one of the resources needed by
resources needed by the job, such as media, fonts, resource the job, such as media, fonts, resource objects, etc., is not
objects, etc., is not ready on any of the physical printer's for ready on any of the physical printer's for which the job is a
which the job is a candidate. This condition MAY be detected candidate. This condition MAY be detected when the job is
when the job is accepted, or subsequently while the job is accepted, or subsequently while the job is pending or processing,
pending or processing, depending on implementation. depending on implementation.
'printer-stopped-partly': The value of the Printer's "printer- 'printer-stopped-partly': The value of the Printer's "printer-
state-reasons" attribute contains the value 'stopped-partly'. state-reasons" attribute contains the value 'stopped-partly'.
'printer-stopped': The value of the Printer's "printer-state" 'printer-stopped': The value of the Printer's "printer-state"
attribute is 'stopped'. attribute is 'stopped'.
'job-interpreting': Job is in the 'processing' state, but more
specifically, the Printer is interpreting the document data.
'job-queued': Job is in the 'processing' state, but more
specifically, the Printer has queued the document data.
'job-transforming': Job is in the 'processing' state, but more
specifically, the Printer is interpreting document data and
producing another electronic representation.
'job-printing': The output device is marking media. This value is 'job-printing': The output device is marking media. This value is
useful for Printers which spend a great deal of time processing useful for Printers which spend a great deal of time processing
when no marking is happening and then want to show that marking (1) when no marking is happening and then want to show that
is now happening. marking is now happening or (2) when the job is in the process of
'job-cancelled-by-user': The job was cancelled by the user using being canceled or aborted while the job remains in the
the CancelJob request, i.e., by a user whose name is the same as 'processing' state, but the marking has not yet stopped so that
the value of the job's "job-originating-user" attribute. impression or sheet counts are still increasing for the job.
'job-cancelled-by-operator': The job was cancelled by the operator 'job-canceled-by-user': The job was canceled by the owner of the
using the CancelJob request, i.e., by a user whose name is job using the Cancel-Job request, i.e., by a user whose name is
different than the value of the job's "job-originating-user" the same as the value of the job's "job-originating-user"
attribute. attribute, or by some other authorized end-user, such as a member
of the job owner's security group.
Expires April 14, 1998
'job-canceled-by-operator': The job was canceled by the operator
using the Cancel-Job request, i.e., by a user who has been
authenticated as having operator privileges (whether local or
remote).
'job-canceled-at-device': The job was canceled by an unidentified
local user, i.e., a user at a console at the device.
'aborted-by-system': The job (1) is in the process of being
aborted, (2) has been aborted by the system and placed in the
'aborted' state, or (3) has been aborted by the system and placed
in the 'pending-held' state, so that a user or operator can
manually try the job again.
'processing-to-stop-point': The requester has issued a Cancel-job
operation or the Printer object has aborted the job, but is still
performing some actions on the job until a specified stop point
occurs or job termination/cleanup is completed.
This reason is recommended to be used in conjunction with the
'processing' job state to indicate that the Printer object is
still performing some actions on the job while the job remains in
the 'processing' state. After all the job's job description
attributes have stopped incrementing, the Printer object moves
the job from the 'processing' state to the 'canceled' or
'aborted' job states.
'service-off-line': The Printer is off-line and accepting no jobs.
All 'pending' jobs are put into the 'pending-held' state. This
situation could be true if the service's or document transform's
input is impaired or broken.
'job-completed-successfully': The job completed successfully. 'job-completed-successfully': The job completed successfully.
'job-completed-with-warnings': The job completed with warnings. 'job-completed-with-warnings': The job completed with warnings.
'job-completed-with-errors': The job completed with errors (and 'job-completed-with-errors': The job completed with errors (and
possibly warnings too). possibly warnings too).
'job-interpreting': Job is in the 'processing' state, but more
specifically, the Printer is interpreting the data.
'job-printing': Job is in the 'processing' state, but more
specifically, the Printer is actually printing (making marks on
the media).
deBry, Hastings, Herriot, Isaacson, Powell 4.3.8 job-state-message (text)
Expires February xx, 1998
'job-queued': Job is in the 'processing' state, but more
specifically, the Printer is queuing the data.
'job-transforming': Job is in the 'processing' state, but more
specifically, the Printer is transforming the data.
ISSUE: Show a partitioning of which "job-state-reasons" are valid or This attributes specifies supplemental information about the Job State
expected for each "job-state" value. in human readable text. The Printer object SHALL be able to generate
this message in any of the natural languages identified by the
Printer's "natural-language-supported" attribute (see the "attributes-
natural-language" operation attribute specified in Section 3.1.3.1).
4.3.10 job-state-message (text) 4.3.9 number-of-documents (integer(0:2**31 - 1))
This attributes specifies supplemental information about the Job State This attribute indicates the number of documents in the job, i.e, the
in human readable text. number of Send-Document, Send-URI, Print-Job, or Print-URI operations
that the Printer has accepted for this job, regardless of whether the
document data has reached the Printer or not.
4.3.11 output-device-assigned (name) Expires April 14, 1998
Implementations supporting the OPTIONAL Create-Job/Send-Document/Send-
URI operations SHOULD support this attribute.
4.3.10 output-device-assigned (name)
This attribute identifies the Output Device to which the Printer has This attribute identifies the Output Device to which the Printer has
assigned this job. If an output device implements an embedded IPP assigned this job. If an output device implements an embedded IPP
Printer, the Printer NEED NOT set this attribute. If a Print Server Printer, the Printer NEED NOT set this attribute. If a Print Server
implements a Printer, the value MAY be empty until the Printer assigns implements a Printer, the value MAY be empty until the Printer assigns
an output device to the job. an output device to the job.
4.3.12 time-since-pending (integer) 4.3.11 time-of-creation (integer)
This attribute indicates the amount of time in milliseconds that has This attribute indicates the point in time at which the Job object was
passed since the Job was first put into the pending state.. created. In order to populate this attribute, the Printer object uses
the value in its "printer-up-time" attribute at the time the Job
object is created.
4.3.13 time-since-processing (integer) 4.3.12 time-at-processing (integer)
This attribute indicates the amount of time in milliseconds that has This attribute indicates the point in time at which the Job object
passed since the Job first entered the processing state. began processing. In order to populate this attribute, the Printer
object uses the value in its "printer-up-time" attribute at the time
the Job object is moved into the 'processing' state for the first
time.
4.3.14 time-since-completed (integer) 4.3.13 time-at-completed (integer)
This attribute indicates the amount of time in milliseconds that has This attribute indicates the point in time at which the Job object
passed since the Job was completed. completed (or was cancelled or aborted). In order to populate this
attribute, the Printer object uses the value in its "printer-up-time"
attribute at the time the Job object is moved into the 'completed' or
'canceled' or 'aborted' state.
4.3.15 number-of-intervening-jobs (integer(0:2**31 - 1)) 4.3.14 number-of-intervening-jobs (integer(0:2**31 - 1))
This attribute indicates the number of jobs that are "ahead" of this This attribute indicates the number of jobs that are "ahead" of this
job in the current scheduled order. For efficiency, it is only job in the relative chronological order of expected time to complete
(i.e., the current scheduled order). For efficiency, it is only
necessary to calculate this value when an operation is performed that necessary to calculate this value when an operation is performed that
requests this attribute. requests this attribute.
Note: This attribute is necessary since an end user may request just 4.3.15 job-message-from-operator (text)
their own jobs and they need some relative position indicator if there
are other jobs interspersed in the waiting list which are not returned
deBry, Hastings, Herriot, Isaacson, Powell
Expires February xx, 1998
in the response or cannot be because of site security policy
restrictions.
4.3.16 job-message-from-operator (text)
This attribute provides a message from an operator, system This attribute provides a message from an operator, system
administrator or "intelligent" process to indicate to the end user the administrator or "intelligent" process to indicate to the end user the
reasons for modification or other management action taken on a job. reasons for modification or other management action taken on a job.
4.3.17 job-k-octets-processed (integer(0:2**31 - 1)) Expires April 14, 1998
4.3.16 job-k-octets-processed (integer(0:2**31 - 1))
This attribute specifies the number of octets completed in K octets, This attribute specifies the number of octets processed in K octets,
i.e., in units of 1024 octets. The value SHALL be rounded up, so that i.e., in units of 1024 octets. The value SHALL be rounded up, so that
a job between 1 and 1024 octets SHALL be indicated as being 1, 1025 to a job between 1 and 1024 octets SHALL be indicated as being 1, 1025 to
2048 SHALL be 2, etc. 2048 SHALL be 2, etc.
For implementations where multiple copies are produced by the
interpreter with only a single pass over the data, the final value
SHALL be equal to the value of the "job-k-octets" attribute. For
implementations where multiple copies are produced by the interpreter
by processing the data for each copy, the final value SHALL be a
multiple of the value of the "job-k-octets" attribute.
Note: This attribute and the following two attributes ("job- Note: This attribute and the following two attributes ("job-
impressions-completed" and "job-sheets-completed") are intended to be impressions-completed" and "job-sheets-completed") are intended to be
counters (as described in the Job Monitoring MIB [27]). That is, if counters. That is, if the "job-state" is 'processing' or 'processing-
the "job-state" is 'processing' or 'processing-stopped', this value is stopped', this value is intended to contain the amount of the job that
intended to contain the amount of the job that has been processed to has been processed to the time at which the attributes are requested.
the time at which the attributes are requested. For any of these For any of these three attributes, the Printer may choose to return
three attributes, the Printer may choose to return the value '-2' the value '-2' (which represents "unknown") rather than choose to not
(which represents "unknown") rather than choose to not support the support the attribute at all.
attribute at all.
4.3.18 job-impressions-completed (integer(0:2**31 - 1))
This job attribute specifies the number of impressions completed. This
attribute is intended to be a counter as in the Job Monitoring MIB.
4.3.19 job-media-sheets-completed (integer(0:2**31 - 1)) 4.3.17 job-impressions-completed (integer(0:2**31 - 1))
This job attribute specifies the media-sheets completed. This This job attribute specifies the number of impressions completed for
the job so far. For printing devices, the impressions completed