RFC 8011
Internet Printing Protocol/1.1: Model and Semantics
Part 1 of 49 💖
Internet Printing Protocol/1.1: Model and Semantics 🖨️✨
okay bestie, this is RFC 8011, and it's a full Standards Track doc, so it's an official Internet standard, no cap 💅 It was published in January 2017 with ISSN 2070-1721. The authors are M. Sweet from Apple Inc. and I. McDonald from High North, Inc. 🎀 It obsoletes RFCs 2911, 3381, and 3382, so those older docs are retired now 👋 The title block doesn't list anything this one updates.
Abstract 🌸
okay so IPP (the Internet Printing Protocol) is an application-level protocol for distributed printing that runs on Internet tools and technologies 🖨️ This doc lays out a simplified model made of abstract objects, attributes, and operations, and the whole model is independent of encoding and transport, which is so iconic 🧚 The model has several objects, including Printers and Jobs, and Jobs optionally support multiple Documents 📄
IPP semantics let End Users and Operators query Printer capabilities, submit Print Jobs, check the status of Print Jobs and Printers, and cancel, hold, and release Print Jobs 💜 Operators also get to pause and resume Jobs and Printers, main character energy 👑
Security, internationalization, and directory issues are covered by the model and semantics too 🔐 The IPP message encoding and transport are described in "Internet Printing Protocol/1.1: Encoding and Transport" (RFC 8010) 🦋
This document obsoletes RFCs 2911, 3381, and 3382. 💀
Status of This Memo 🎀
This is an Internet Standards Track document. ⭐
This document is a product of the Internet Engineering Task Force (IETF). It represents the consensus of the IETF community, and it got public review and was approved for publication by the Internet Engineering Steering Group (IESG). If you want more on Internet Standards, check Section 2 of RFC 7841 🫶
Info about the current status of this doc, any errata, and how to send feedback is at http://www.rfc-editor.org/info/rfc8011 🔗
Copyright Notice 🌈
Copyright (c) 2017 IETF Trust and the persons identified as the document authors. All rights reserved. ✨
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) as in effect on the date of publication. Please read these carefully, because they describe your rights and restrictions for this document 📜 Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions, and they're provided without warranty as described in the Simplified BSD License 💖
Table of Contents 📚
1. Introduction ....................................................9
1.1. Simplified Printing Model .................................12
2. Conventions Used in This Document ..............................15
2.1. Requirements Language .....................................15
2.2. Printing Terminology ......................................15
2.3. Model Terminology .........................................16
2.3.1. Administrator ......................................16
2.3.2. Attributes .........................................16
2.3.2.1. Attribute Group Name ......................16
2.3.2.2. Attribute Name ............................16
2.3.2.3. Attribute Syntax ..........................16
2.3.2.4. Attribute Value ...........................17
2.3.3. End User ...........................................17
2.3.4. Impression .........................................17
2.3.5. Input Page .........................................17
2.3.6. Job Creation Operation .............................17
2.3.7. Keyword ............................................17
2.3.8. Media Sheet ........................................18
2.3.9. Operator ...........................................18
2.3.10. Set ...............................................18
2.3.11. Support of Attributes .............................18
2.3.12. Terminating State .................................21
2.4. Abbreviations .............................................21
3. IPP Objects ....................................................22
3.1. Printer Object ............................................22
3.2. Job Object ................................................25
3.3. Object Relationships ......................................25
3.4. Object Identity ...........................................26
4. IPP Operations .................................................29
4.1. Common Semantics ..........................................30
4.1.1. Required Parameters ................................30
4.1.2. Operation IDs and Request IDs ......................31
4.1.3. Attributes .........................................31
4.1.4. Character Set and Natural Language
Operation Attributes ...............................33
4.1.4.1. Request Operation Attributes ..............34
4.1.4.2. Response Operation Attributes .............38
4.1.5. Operation Targets ..................................39
4.1.6. Operation Response Status-Code Values and
Status Messages ....................................41
4.1.6.1. "status-code" (type2 enum) ................41
4.1.6.2. "status-message" (text(255)) ..............42
4.1.6.3. "detailed-status-message" (text(MAX)) .....43
4.1.6.4. "document-access-error" (text(MAX)) .......43
4.1.7. Unsupported Attributes .............................44
4.1.8. Versions ...........................................45
4.1.9. Job Creation Operations ............................48
4.2. Printer Operations ........................................50
4.2.1. Print-Job Operation ................................51
4.2.1.1. Print-Job Request .........................51
4.2.1.2. Print-Job Response ........................56
4.2.2. Print-URI Operation ................................58
4.2.3. Validate-Job Operation .............................59
4.2.4. Create-Job Operation ...............................59
4.2.5. Get-Printer-Attributes Operation ...................60
4.2.5.1. Get-Printer-Attributes Request ............61
4.2.5.2. Get-Printer-Attributes Response ...........63
4.2.6. Get-Jobs Operation .................................64
4.2.6.1. Get-Jobs Request ..........................65
4.2.6.2. Get-Jobs Response .........................66
4.2.7. Pause-Printer Operation ............................68
4.2.7.1. Pause-Printer Request .....................71
4.2.7.2. Pause-Printer Response ....................71
4.2.8. Resume-Printer Operation ...........................72
4.2.9. Purge-Jobs Operation ...............................73
4.3. Job Operations ............................................73
4.3.1. Send-Document Operation ............................74
4.3.1.1. Send-Document Request .....................75
4.3.1.2. Send-Document Response ....................77
4.3.2. Send-URI Operation .................................78
4.3.3. Cancel-Job Operation ...............................78
4.3.3.1. Cancel-Job Request ........................80
4.3.3.2. Cancel-Job Response .......................81
4.3.4. Get-Job-Attributes Operation .......................81
4.3.4.1. Get-Job-Attributes Request ................82
4.3.4.2. Get-Job-Attributes Response ...............83
4.3.5. Hold-Job Operation .................................84
4.3.5.1. Hold-Job Request ..........................86
4.3.5.2. Hold-Job Response .........................87
4.3.6. Release-Job Operation ..............................87
4.3.7. Restart-Job Operation ..............................89
4.3.7.1. Restart-Job Request .......................91
4.3.7.2. Restart-Job Response ......................92
5. Object Attributes ..............................................92
5.1. Attribute Syntaxes ........................................92
5.1.1. Out-of-Band Values - 'unknown',
'unsupported', and 'no-value' ......................93
5.1.2. 'text' .............................................93
5.1.2.1. 'textWithoutLanguage' .....................94
5.1.2.2. 'textWithLanguage' ........................94Okay bestie, the table of contents keeps going and it's giving very organized energy 🎀✨
5.1.3. 'name' .............................................95
5.1.3.1. 'nameWithoutLanguage' .....................96
5.1.3.2. 'nameWithLanguage' ........................96
5.1.3.3. Matching 'name' Attribute Values ..........97
5.1.4. 'keyword' ..........................................98
5.1.5. 'enum' .............................................99
5.1.6. 'uri' .............................................100
5.1.7. 'uriScheme' .......................................100
5.1.8. 'charset' .........................................101
5.1.9. 'naturalLanguage' .................................102
5.1.10. 'mimeMediaType' ..................................102
5.1.10.1. 'application/octet-stream' -
Auto-Sensing the Document Format ........103
5.1.11. 'octetString' ....................................104
5.1.12. 'boolean' ........................................104
5.1.13. 'integer' ........................................104
5.1.14. 'rangeOfInteger' .................................105
5.1.15. 'dateTime' .......................................105
5.1.16. 'resolution' .....................................105
5.1.17. 'collection' .....................................105
5.1.18. '1setOf X' .......................................106
5.2. Job Template Attributes ..................................106
5.2.1. job-priority (integer(1:100)) .....................109
5.2.2. job-hold-until (type2 keyword | name(MAX)) ........111
5.2.3. job-sheets (type2 keyword | name(MAX)) ............112
5.2.4. multiple-document-handling (type2 keyword) ........113
5.2.5. copies (integer(1:MAX)) ...........................115
5.2.6. finishings (1setOf type2 enum) ....................115
5.2.7. page-ranges (1setOf rangeOfInteger(1:MAX)) ........118
5.2.8. sides (type2 keyword) .............................119
5.2.9. number-up (integer(1:MAX)) ........................120
5.2.10. orientation-requested (type2 enum) ...............120
5.2.11. media (type2 keyword | name(MAX)) ................123
5.2.12. printer-resolution (resolution) ..................124
5.2.13. print-quality (type2 enum) .......................124
5.3. Job Description and Status Attributes ....................124
5.3.1. job-id (integer(1:MAX)) ...........................126
5.3.2. job-uri (uri) .....................................126
5.3.3. job-printer-uri (uri) .............................127
5.3.4. job-more-info (uri) ...............................127
5.3.5. job-name (name(MAX)) ..............................127
5.3.6. job-originating-user-name (name(MAX)) .............128
5.3.7. job-state (type1 enum) ............................128
5.3.7.1. Forwarding Servers .......................132
5.3.7.2. Partitioning of Job States ...............132
5.3.8. job-state-reasons (1setOf type2 keyword) ..........133
5.3.9. job-state-message (text(MAX)) .....................138
5.3.10. job-detailed-status-messages (1setOf text(MAX)) ..139
5.3.11. job-document-access-errors (1setOf text(MAX)) ....139
5.3.12. number-of-documents (integer(0:MAX)) .............139
5.3.13. output-device-assigned (name(127)) ...............139
5.3.14. Event Time Job Status Attributes .................140
5.3.14.1. time-at-creation (integer(MIN:MAX)) .....140
5.3.14.2. time-at-processing (integer(MIN:MAX)) ...141
5.3.14.3. time-at-completed (integer(MIN:MAX)) ....141
5.3.14.4. job-printer-up-time (integer(1:MAX)) ....141
5.3.14.5. date-time-at-creation
(dateTime|unknown) ......................141
5.3.14.6. date-time-at-processing
(dateTime|unknown|no-value) .............141
5.3.14.7. date-time-at-completed
(dateTime|unknown|no-value) .............141
5.3.15. number-of-intervening-jobs (integer(0:MAX)) ......142
5.3.16. job-message-from-operator (text(127)) ............142
5.3.17. Job Size Attributes ..............................142
5.3.17.1. job-k-octets (integer(0:MAX)) ...........142
5.3.17.2. job-impressions (integer(0:MAX)) ........143
5.3.17.3. job-media-sheets (integer(1:MAX)) .......143
5.3.18. Job Progress Attributes ..........................144
5.3.18.1. job-k-octets-processed
(integer(0:MAX)) ........................144
5.3.18.2. job-impressions-completed
(integer(0:MAX)) ........................144
5.3.18.3. job-media-sheets-completed
(integer(0:MAX)) ........................144
5.3.19. attributes-charset (charset) .....................144
5.3.20. attributes-natural-language (naturalLanguage) ....145
5.4. Printer Description and Status Attributes ................145
5.4.1. printer-uri-supported (1setOf uri) ................147
5.4.2. uri-authentication-supported (1setOf type2
keyword) ..........................................148
5.4.3. uri-security-supported (1setOf type2 keyword) .....149
5.4.4. printer-name (name(127)) ..........................150
5.4.5. printer-location (text(127)) ......................150
5.4.6. printer-info (text(127)) ..........................151
5.4.7. printer-more-info (uri) ...........................151
5.4.8. printer-driver-installer (uri) ....................151
5.4.9. printer-make-and-model (text(127)) ................151
5.4.10. printer-more-info-manufacturer (uri) .............151
5.4.11. printer-state (type1 enum) .......................152
5.4.12. printer-state-reasons (1setOf type2 keyword) .....152
5.4.13. printer-state-message (text(MAX)) ................157
5.4.14. ipp-versions-supported (1setOf type2 keyword) ....157
5.4.15. operations-supported (1setOf type2 enum) .........157
5.4.16. multiple-document-jobs-supported (boolean) .......159
5.4.17. charset-configured (charset) .....................159
5.4.18. charset-supported (1setOf charset) ...............159
5.4.19. natural-language-configured (naturalLanguage) ....160
5.4.20. generated-natural-language-supported
(1setOf naturalLanguage) .........................160
5.4.21. document-format-default (mimeMediaType) ..........160
5.4.22. document-format-supported (1setOf
mimeMediaType) ...................................161
5.4.23. printer-is-accepting-jobs (boolean) ..............161
5.4.24. queued-job-count (integer(0:MAX)) ................161
5.4.25. printer-message-from-operator (text(127)) ........161
5.4.26. color-supported (boolean) ........................161
5.4.27. reference-uri-schemes-supported (1setOf
uriScheme) .......................................162
5.4.28. pdl-override-supported (type2 keyword) ...........162
5.4.29. printer-up-time (integer(1:MAX)) .................162
5.4.30. printer-current-time (dateTime|unknown) ..........163
5.4.31. multiple-operation-time-out (integer(1:MAX)) .....164
5.4.32. compression-supported (1setOf type2 keyword) .....164
5.4.33. job-k-octets-supported (rangeOfInteger(0:MAX)) ...165
5.4.34. job-impressions-supported
(rangeOfInteger(0:MAX)) ..........................165
5.4.35. job-media-sheets-supported
(rangeOfInteger(1:MAX)) ..........................165
5.4.36. pages-per-minute (integer(0:MAX)) ................165
5.4.37. pages-per-minute-color (integer(0:MAX)) ..........165
6. Conformance ...................................................166
6.1. Client Conformance Requirements ..........................166
6.2. IPP Object Conformance Requirements ......................168
6.2.1. Objects ...........................................168
6.2.2. Operations ........................................168
6.2.3. IPP Object Attributes .............................170
6.2.4. Versions ..........................................170
6.2.5. Extensions ........................................171
6.2.6. Attribute Syntaxes ................................171
6.2.7. Security ..........................................172
6.3. Charset and Natural Language Requirements ................172
7. IANA Considerations ...........................................173
7.1. Object Extensions ........................................174
7.2. Attribute Extensibility ..................................174
7.3. Keyword Extensibility ....................................175
7.4. Enum Extensibility .......................................176
7.5. Attribute Group Extensibility ............................176
7.6. Out-of-Band Attribute Value Extensibility ................176
7.7. Attribute Syntax Extensibility ...........................177
7.8. Operation Extensibility ..................................177
7.9. Status-Code Extensibility ................................1781. Introduction ✨
okay so IPP (the Internet Printing Protocol) is an application-level protocol for distributed printing that's built on Internet tools and technologies 🖨️🌸 basically, printing over the internet, but make it a whole protocol. IPP version 1.1 (IPP/1.1) is all about End User stuff, with a few admin operations sprinkled in 💅 and IPP versions 2.0, 2.1, and 2.2 come along later with a bunch of new operations and get their own separate docs 🦋
this document is just one piece of a whole suite that fully defines IPP 🧩 here's the full IETF IPP lineup:
- Design Goals for an Internet Printing Protocol [RFC2567]
- Rationale for the Structure of the Model and Protocol for the Internet Printing Protocol [RFC2568]
- Internet Printing Protocol/1.1: Model and Semantics (this document)
- Internet Printing Protocol/1.1: Encoding and Transport [RFC8010]
- Internet Printing Protocol/1.1: Implementor's Guide [RFC3196]
- Internet Printing Protocol/1.1: IPP URL Scheme [RFC3510]
- Internet Printing Protocol (IPP) over HTTPS Transport Binding and the 'ipps' URI Scheme [RFC7472]
- Internet Printing Protocol (IPP): Requirements for Job, Printer, and Device Administrative Operations [RFC3239]
- Internet Printing Protocol (IPP): Job and Printer Set Operations [RFC3380]
- Internet Printing Protocol (IPP): Job and Printer Administrative Operations [RFC3998]
- Internet Printing Protocol (IPP): Requirements for IPP Notifications [RFC3997]
- Internet Printing Protocol (IPP): Event Notifications and Subscriptions [RFC3995]
- Internet Printing Protocol (IPP): The 'ippget' Delivery Method for Event Notifications [RFC3996]
- Mapping between LPD and IPP Protocols [RFC2569]
bestie, if you're reading these for the first time, please read the IPP docs in the order above 🫶 it's genuinely the easiest way in ✨ and the IEEE-ISTO Printer Working Group's IPP Workgroup [PWG-IPP-WG] has published extra IPP specs too 💜 the following standards are highly recommended reading (no cap, they're bangin' 🔥):
- PWG Media Standardized Names 2.0 (MSN2) [PWG5101.1]
- IPP Finishings 2.0 (FIN) [PWG5100.1]
- Internet Printing Protocol (IPP): "output-bin" attribute extension [PWG5100.2]
- Internet Printing Protocol (IPP): Production Printing Attributes - Set 1 [PWG5100.3] (for "media-col" Job Template attribute)
- Standard for The Internet Printing Protocol (IPP): Document Object [PWG5100.5]
- Standard for The Internet Printing Protocol (IPP): Page Overrides [PWG5100.6]
- Standard for The Internet Printing Protocol (IPP): Job Extensions [PWG5100.7]
- Standard for Internet Printing Protocol (IPP): "-actual" attributes [PWG5100.8]
- Internet Printing Protocol (IPP): Printer State Extensions v1.0 [PWG5100.9]
- Internet Printing Protocol (IPP): Job and Printer Extensions - Set 2 (JPS2) [PWG5100.11]
- IPP Version 2.0, 2.1, and 2.2 [PWG5100.12]
- IPP: Job and Printer Extensions - Set 3 (JPS3) [PWG5100.13]
- IPP Everywhere [PWG5100.14]
- IPP FaxOut Service [PWG5100.15]
- IPP Transaction-Based Printing Extensions [PWG5100.16]
- IPP Scan Service (SCAN) [PWG5100.17]
- IPP Shared Infrastructure Extensions (INFRA) [PWG5100.18]
- IPP Implementor's Guide v2.0 (IG) [PWG5100.19]
okay here's how this doc is laid out, so you know where you're going 🗺️
- the rest of Section 1 is an intro to the IPP simplified model for distributed printing 🌈
- Section 2 defines the terminology and conventions used in this doc 📚
- Section 3 introduces the object types covered here, with their basic behaviors, attributes, and interactions 🧚
- Section 4 defines the core operations for IPP/1.1 📮 IPP operations are synchronous, meaning each operation has both a request and a response 🔁
- Section 5 defines the core attributes (and their syntaxes) used in the model 🎀
- Sections 6 and 7 summarize the implementation conformance requirements for objects that support the protocol, and the IANA considerations, respectively 📝
- Sections 8 and 9 cover the internationalization and security considerations for IPP 🌍 (the security one is seriously important, bestie 😭🔒)
- the appendices give a reference for status-code values, processing of IPP attributes, and the generic directory schema 💜
1.1. Simplified Printing Model ✨
okay so the whole point of IPP is to make a printing protocol that actually works on the Internet 🖨️💖 and to do that it uses a simplified printing model that hides all the messy real-world printer stuff. The Internet is a distributed place where print requesters (Clients, apps, Printer drivers, etc.) team up with print service providers 🤝 This document (sometimes called the "Model and Semantics" document) describes a simple, abstract model for IPP even when the actual setup is a complicated "n-tier" client/server mess 🌸 The big glow-up move is that it only exposes the key objects and interfaces needed for printing 💅 Anything beyond the scope of IPP/1.1 is just not in the model, bestie. IPP/1.1 borrows a bunch of good ideas and lessons from other efforts [HTPP] [ISO10175] [LDPA] [P1387.4] [PSIS] [RFC1179] [SWP] 🧚 IPP is heavily influenced by the printing model from the Document Printing Application (DPA) [ISO10175] standard. DPA covers both End User and administrative features, but IPP/1.1 mostly focuses on End User stuff, with a few extra OPTIONAL operations for Administrators and Operators 👑
The IPP Model wraps the important parts of distributed printing into these IPP object types:
- Printer (Section 3.1)
- Job (Section 3.2)
- Document (see [PWG5100.5])
- Subscription (see [RFC3995])
Each object type has its own set of operations (see Section 4) and attributes (see Section 5) 🎀
Real systems have other stuff going on underneath the abstracted IPP Model that isn't explicitly defined in it, so here's a little picture of where IPP fits in 🦋
+----------------+
| Application |
o + . . . . . . . |
\|/ | Spooler |
/ \ + . . . . . . . | +---------+
End User | Printer Driver |---| File |
+-----------+ +-----+ +-------+--------+ +----+----+
| Browser | | GUI | | |
+-----+-----+ +--+--+ | |
| | | |
| +---+-------------+--+ |
N D S | | IPP Client |--------------+
O I E | +---------+----------+
T R C | |
I E U |
F C R -------------- Transport -------------------
I T I
C O T | --+
A R Y +--------+--------+ |
T Y | IPP Server | |
I +--------+--------+ |
O | |
N +-----------------+ | IPP Printer
| Print Service | |
+-----------------+ |
| --+
+-----------------+
| Output Device(s)|
+-----------------+
Figure 1: IPP ModelAn IPP Printer object ("Printer") packs in the stuff usually tied to physical Output Devices, plus the spooling, scheduling, and multiple device management stuff you'd normally find on a print server 🖨️✨ Printers can optionally be registered as entries in a directory, where End Users find and pick them using some kind of filtered, context-based search (see Appendix D) 🔍 The directory stores relatively static info about the Printer, so End Users can search for Printers that match what they want, like name, location, context, Printer capabilities, etc. The more dynamic info (state, media that's loaded and ready, number of Jobs at the Printer, errors, warnings, and so on) lives on the Printer itself, not on the directory entry, which just points to the Printer 💜
IPP Clients ("Clients") implement IPP on the Client side and let End Users (or programs acting for them) query Printers and submit and manage Print Jobs 🫶 An IPP server is just the server-side part of the Printer object. The rest of the Printer object implements (or gateways into) the application semantics of the print service itself 🧚 Printers can be embedded in an Output Device, or they can run on a host on the network that talks to an Output Device 🌈
When a Job gets submitted and the Printer has validated the attributes in the submission request, the Printer creates a new IPP Job object ("Job") 🎉 The End User then interacts with that Job to check its status and watch it progress. End Users can also cancel their Print Jobs with the Job's Cancel-Job operation. They can also hold, release, and restart their Print Jobs using the Job's OPTIONAL Hold-Job, Release-Job, and Restart-Job operations, if implemented 🍓
A privileged Operator or Administrator of a Printer can cancel, hold, release, and restart any user's Job, using the REQUIRED Cancel-Job and the OPTIONAL Hold-Job, Release-Job, and Restart-Job operations 👑 Admins and Operators can also pause, resume, or purge (Jobs from) a Printer using the OPTIONAL Pause-Printer, Resume-Printer, and Purge-Jobs operations, if implemented 💅
The notification service is defined in "Internet Printing Protocol (IPP): Event Notifications and Subscriptions" [RFC3995]. With it, the End User can register for and receive Printer-specific and Job-specific events asynchronously 🔔 Without it, an End User can still check how Printers are doing and follow Jobs by polling with the Get-Printer-Attributes, Get-Jobs, and Get-Job-Attributes operations 🫠
2. Conventions Used in This Document 🌷
2.1. Requirements Language 📜
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC2119] 🎀
The key word "DEPRECATED" in this document refers to an operation, attribute, or value that SHOULD NOT be used or supported in new implementations 🙈
2.2. Printing Terminology 🖨️
Client: Initiator of outgoing IPP session requests and sender of outgoing IPP operation requests (Hypertext Transfer Protocol (HTTP/1.1) user agent, as defined in [RFC7230]) 🦋
Document: An object created and managed by a Printer that contains description, processing, and status information. A Document object can have attached data and is bound to a single Job [PWG5100.5] 📄
'ipp' URI: An IPP URI as defined in [RFC3510] 🔗
'ipps' URI: An IPP URI as defined in [RFC7472] 🔐
Job: An object created and managed by a Printer that contains description, processing, and status information. The Job also contains zero or more Document objects 💖
Logical Device: A print server, software service, or gateway that processes Jobs and either forwards or stores the processed Job, or uses one or more Physical Devices to render output 🧚
Output Device: A single Logical or Physical Device 🌈
Physical Device: A hardware implementation of an endpoint device, e.g., a marking engine, a fax modem, etc. ⚙️
Printer: Listener for incoming IPP session requests and receiver of incoming IPP operation requests (HTTP/1.1 server, as defined in [RFC7230]) that represents one or more Physical Devices or a Logical Device 👑
2.3. Model Terminology 💜
2.3.1. Administrator 🛠️
An End User who is also authorized to manage all aspects of an Output Device or Printer, including creating the Printer instances and controlling the authorization of other End Users and Operators [RFC2567] 👑
2.3.2. Attributes 🏷️
An attribute is an item of information associated with an instance of an IPP object (Printer, Job, etc.). An attribute consists of an attribute name and one or more attribute values. Each attribute has a specific attribute syntax. All object attributes are defined in Section 5, and all operation attributes are defined in Section 4 ✨
Job Template attributes are described in Section 5.2. The Client optionally supplies Job Template attributes in a Job Creation request (operation requests that create Job objects). The Printer object has associated attributes that define supported and default values for the Printer 🎀
2.3.2.1. Attribute Group Name 🗂️
Related attributes are grouped into named groups. The name of the group is a keyword. The group name can be used in place of naming all the attributes in the group explicitly. Attribute groups are defined in Section 4 🌸
2.3.2.2. Attribute Name 🔤
Each attribute is uniquely identified in this document by its attribute name. An attribute name is a keyword. The keyword attribute name is given in the section title in this document that describes that attribute. In running text in this document, attribute names are indicated inside double quotation marks (") where the quotation marks are not part of the keyword itself 💅
2.3.2.3. Attribute Syntax 🧩
Each attribute is defined using an explicit syntax type. In this document, each syntax type is defined as a keyword with specific meaning. The "Encoding and Transport" document [RFC8010] indicates the actual "on-the-wire" encoding rules for each syntax type. Attribute syntax types are defined in Section 5.1 🦋
2.3.2.4. Attribute Value 🍬
Each attribute has one or more values. Attribute values are represented in the syntax type specified for that attribute. In running text in this document, attribute values are indicated inside single quotation marks ('), whether their attribute syntax is keyword, integer, text, etc., where the quotation marks are not part of the value itself 🫶
2.3.3. End User 🙋
An End User is a person or software process that is authorized to perform basic printing functions, including finding/locating a Printer, creating a local instance of a Printer, viewing Printer status, viewing Printer capabilities, submitting a Print Job, viewing Print Job status, and altering the attributes of a Print Job [RFC2567] 💖
2.3.4. Impression 🖼️
An Impression is the content imposed upon one side of a Media Sheet by a marking engine, independent of the number of times that the sheet side passes any marker. An Impression contains one or more Input Pages that are imposed (scaled, translated, and/or rotated) during processing of the Document data 🌈
2.3.5. Input Page 📃
An Input Page is a page according to the definition of "pages" in the language used to express the Document data 🌸
2.3.6. Job Creation Operation 🚀
A Job Creation operation is any operation that causes the creation of a Job object, e.g., the Create-Job, Print-Job, and Print-URI operations defined in this document 🧚
2.3.7. Keyword 🔑
Okay bestie, keywords are the special name tags we use for semantic entities in the abstract model (peep Section 5.1.4 for the full scoop 💅). Attribute names, some attribute values, attribute syntaxes, and attribute group names all get keyword treatment ✨.
2.3.8. Media Sheet 📄
A Media Sheet is one single instance of a medium, whether it's printed on one side or both sides 🦋. Roll media counts too, since Media Sheets also cover sections of roll media 🌸.
2.3.9. Operator 👑
An Operator is an End User who also has special rights on the Output Device or Printer 👑. The Operator usually keeps an eye on the Printer's status and manages and controls the Jobs at the Output Device [RFC2567] 🫶. The Operator is allowed to query and control the Printer, Jobs, and Documents based on site policy 💜.
2.3.10. Set 🧚
A Set is a logical boundary between the delivered Media Sheets of a printed Job ✨. Say you've got a ten-page single Document with collated pages and a request for 50 copies. Each of those 50 printed copies of the Document is its own Set 🍓. If the pages were uncollated, then 50 copies of each individual page within the Document would be the Sets instead 🙈. Finishing processes operate on Sets, so Sets are kind of a big deal 💅.
2.3.11. Support of Attributes 🎀
Okay, the definition is that a Printer supports an attribute only if it accepts that attribute in a request, or it responds with the matching attribute populated with some value(s) when someone queries for it 🎀. A Printer supports an attribute value if that value shows up in one of the Printer's "supported values" attributes 💜. The device behind a Printer can act out a behavior that matches some IPP attribute, but if the Printer doesn't respond with that attribute when queried, then as far as IPP is concerned, that implementation does not support the feature 😭. And if the Printer's xxx-supported attribute isn't populated with a particular value (even when that value is legal for the attribute), then that Printer does not support that value 💀.
A conforming implementation supports all REQUIRED attributes ✅. Still, even for REQUIRED attributes, conformance to IPP doesn't force every implementation to support every possible value that represents every possible Job processing behavior and feature 🌈. For example, if a Printer only supports certain Document formats, it responds with the document-format-supported attribute populated with a set of values, or maybe just one value, picked from the entire set of possible values defined for that attribute. That limited set is the Printer's set of supported Document formats 📑. Supporting an attribute and some set of values for it lets IPP End Users know about those features and use them 🦋. If an implementation skips an attribute or some specific value, IPP End Users have no way to use that feature within IPP itself. Still, because of existing practice and legacy systems that aren't IPP aware, there might be some other mechanism outside IPP's scope to control or request the "unsupported" feature (like embedded instructions inside the Document data itself) 🙃.
Let's look at the finishings-supported attribute as an example 🧵:
- If a Printer is not physically capable of stapling, the
finishings-supportedattribute MUST NOT be populated with the value of'staple'🚫. - A Printer is physically capable of stapling, but an implementation chooses not to support stapling in the IPP
finishingsattribute. In this case,'staple'MUST NOT be a value in thefinishings-supportedPrinter Description attribute. Without support for the value'staple', an IPP End User has no way within the protocol itself to request that a Job be stapled 😤. However, an existing Document data formatter might be able to request that the Document be stapled directly with an embedded instruction inside the Document data. In this case the IPP implementation does not "support" stapling, but the End User still gets some control over stapling the completed Job 🤷♀️. - A Printer is physically capable of stapling, and an implementation chooses to support stapling in the IPP
finishingsattribute. In this case,'staple'MUST be a value in thefinishings-supportedPrinter attribute. Doing that lets End Users know about the stapling feature and use it through IPP attributes 🎉.
Even though support for Job Template attributes by a Printer is OPTIONAL in IPP/1.1, Printers whose associated device(s) can realize any feature or function that corresponds to an IPP attribute and some associated value SHOULD support that IPP attribute and value 🫶.
The set of values in any supported value attribute gets populated by some administrative process or automatic sensing mechanism that's outside this document's scope 🔧. For administrative policy and control reasons, an Administrator can choose to show only a subset of the possible values to the End User. In that case, the real Output Device behind the IPP Printer abstraction might be capable of a certain feature, but the Administrator is specifying that the End User not get access to that feature through IPP 🙅♀️. Also, since a Printer can represent a logical print device (not just a Physical Device), the actual process for supporting a value is undefined and left up to the implementation. Still, if a Printer supports a value, some manual human action might be needed to make the semantic action associated with that value happen, but no End User action is required 💁♀️.
For example, if 'staple' is one of the values in the finishings-supported attribute, the actual process might be an automatic staple action by a Physical Device, controlled by some command sent to the device. Or the actual stapling might be a manual action by an Operator at an Operator-attended Printer 🧑🔧.
Here's another example of how supported attributes work 🍭. Imagine an Administrator who wants to control all Print Jobs so that no Job sheets get printed, to save paper. To force no Job sheets, the Administrator sets the only supported value for the job-sheets-supported attribute to 'none'. In this case, if a Client requests anything other than 'none', the Job Creation request is rejected or the job-sheets value is ignored, depending on the value of ipp-attribute-fidelity 🙅. Now, to force Job start/end sheets on all Jobs, the Administrator leaves the value 'none' out of the job-sheets-supported attribute. In this case, if a Client requests 'none', the Job Creation request is rejected or the job-sheets value is ignored (again depending on the value of ipp-attribute-fidelity) 🧾.
Job Template attributes will typically have corresponding xxx-supported and xxx-default Printer Description attributes that hold the supported and default values for the attribute 📋. For capabilities that aren't tied to a Job, the convention is to have an xxx-supported Printer Description attribute that lists the supported values, and an xxx-configured Printer Description attribute that holds the value the Printer is actually using ⚙️. For example, the charset-supported Printer Description attribute (Section 5.4.18) lists the supported character sets for the Printer, while the charset-configured Printer Description attribute (Section 5.4.17) specifies the character set the Printer is using 🔤.
2.3.12. Terminating State 🏁
The final state for a Job or other object is called its Terminating State 🏁. For example, the 'aborted', 'canceled', and 'completed' Job states are Terminating States 🌈.
2.4. Abbreviations 🔤
- ABNF: Augmented Backus-Naur Form [RFC5234]
- ASCII: American Standard Code for Information Interchange [RFC20]
- HTTP: Hypertext Transfer Protocol [RFC7230]
- HTTPS: HTTP over TLS [RFC2818]
- IANA: Internet Assigned Numbers Authority
- IEEE: Institute of Electrical and Electronics Engineers
- IESG: Internet Engineering Steering Group
- IPP: Internet Printing Protocol (this document, [RFC8010], and [PWG5100.12])
- ISTO: IEEE Industry Standards and Technology Organization
- LPD: Line Printer Daemon Protocol [RFC1179]
- PWG: IEEE-ISTO Printer Working Group
- RFC: Request for Comments
- TCP: Transmission Control Protocol [RFC793]
- TLS: Transport Layer Security [RFC5246]
- URI: Uniform Resource Identifier [RFC3986]
- URL: Uniform Resource Locator [RFC3986]
- UTF-8: Unicode Transformation Format - 8-bit [RFC3629]
3. IPP Objects ✨
This document defines IPP objects of the types Printer and Job 🖨️. Each type of object models the relevant aspects of a real-world entity, like a real Printer or a real Print Job 🌸. Each object type is defined as a set of possible attributes that instances of that object type can support. For each object (instance), the actual set of supported attributes and values describes a specific implementation 💜. An object's attributes and values describe its state, capabilities, realizable features, Job processing functions, and default behaviors and characteristics 🧠. For example, the Printer object type is defined as a set of attributes that each Printer object potentially supports. In the same way, the Job object type is defined as a set of attributes that each Job object potentially supports 🫶.
Each attribute in the set defining an object type is labeled as one of the following 🏷️:
- "REQUIRED": each object MUST support the attribute.
- "RECOMMENDED": each object SHOULD support the attribute.
- "OPTIONAL": each object MAY support the attribute.
Some definitions of attribute values indicate that an object MUST or SHOULD support the value. Otherwise, support of the value is OPTIONAL 🎀. However, if an implementation supports an attribute, it MUST support at least one of the possible values for that attribute 💅.
3.1. Printer Object 🖨️✨
okay so the Printer object is literally the main character of the whole IPP Model 💅 It's the server side of the IPP/1.1 protocol, so when an End User wants to check the attributes of a Printer or send in a Print Job, this is who they're talking to 🫶 Section 4 breaks down every single Printer operation if you want the deep dive 🔥
The real stuff behind the Printer abstraction can be set up in all kinds of ways 🌈 but the model is giving "the End User doesn't need to know the messy details" energy, so those configuration details stay opaque to them 🙈
The capabilities and state of a Printer object are described by its attributes. Printer attributes come in two groups:
- "job-template" attributes: These describe the Job processing capabilities supported by the Printer object and its defaults (see Section 5.2) 💖
- "printer-description" attributes: These describe the Printer's identification, state, location, references to other sources of information about the Printer object, etc. (see Section 5.4) 🦋
Since a Printer object is an abstraction of a generic Document Output Device and print service provider, a Printer object could represent any real or virtual device with Printer-consistent semantics, like a fax device, an imager, or even a CD writer 🧚 no cap, that's so iconic
Some examples of configurations that support a Printer object include:
- An Output Device with no spooling capabilities
- An Output Device with a built-in spooler
- A print server supporting IPP with one or more associated Output Devices
- 3a. The associated Output Devices are or are not capable of spooling Jobs
- 3b. The associated Output Devices possibly support IPP
Figure 2 shows how Printers can be realized on top of various distributed printing configurations 👑 The embedded case covers configurations 1 and 2 above. The "hosted Printer" and "fan out" items cover configurations 3a and 3b, respectively.
In this document, the term "Client" refers to a software entity that sends IPP operation requests to an IPP Printer and accepts IPP operation responses. A Client MAY be:
- contained within software controlled by an End User, e.g., activated by the "Print" menu item in an application, or
- the print server component that sends IPP requests to either an Output Device or another "downstream" print server.
The term "IPP Printer" is a network entity that accepts IPP operation requests and returns IPP operation responses. As such, an IPP Printer object MAY be:
- an (embedded) device component that accepts IPP requests and controls the device, or
- a component of a print server that accepts IPP requests (where the print server controls one or more networked devices using IPP or other protocols).
Legend:
##### indicates a Printer object that is
either embedded in an Output Device or
hosted in a server. The Printer object
might or might not be capable of queuing/spooling.
any indicates any network protocol or direct
connect, including IPP
embedded Printer:
Output Device
+---------------+
O +--------+ | ########### |
/|\ | Client |------------IPP------------># Printer # |
/ \ +--------+ | # Object # |
| ########### |
+---------------+
hosted Printer:
+---------------+
O +--------+ ########### | |
/|\ | Client |--IPP--># Printer #-any->| Output Device |
/ \ +--------+ # Object # | |
########### +---------------+
+---------------+
fan out: | |
+-->| Output Device |
any/ | |
O +--------+ ########### / +---------------+
/|\ | Client |-IPP-># Printer #--*
/ \ +--------+ # Object # \ +---------------+
########### any\ | |
+-->| Output Device |
| |
+---------------+
Figure 2: IPP Printer Object Architecture3.2. Job Object ✨
A Job object is used to model a Print Job 🎀 A Job object contains zero or more Documents. The info needed to create a Job object gets sent in a Job Creation request from the End User, through an IPP Client, to the Printer. The Printer checks the Job Creation request, and if it accepts the request, the Printer creates the new Job object. Section 4 describes each of the Job operations in detail.
The characteristics and state of a Job object are described by its attributes. Job attributes are grouped into two groups as follows:
- "job-template" attributes: These attributes can be supplied by the Client or End User and include Job processing instructions that are intended to override any Printer defaults and/or instructions embedded within the Document data (see Section 5.2) 💜
- "job-description" attributes: These attributes describe the Job's identification, state, size, etc. The Client supplies some of these attributes, and the Printer generates others (see Section 5.3) 🌸
An implementation MUST support at least one Document per Job object. An implementation MAY support multiple Documents per Job object. A Document is either:
- a stream of Document data in a format supported by the Printer (typically a Page Description Language -- PDL), or
- a reference to such a stream of Document data.
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 object 🍓
3.3. Object Relationships ✨
IPP objects have relationships that stay persistently saved along with the persistent storage of the object attributes 🔒
A Printer object can represent either one or more physical Output Devices, or a Logical Device that "processes" Jobs but never actually uses a physical Output Device to put marks on paper. Examples of Logical Devices include a web page publisher or a gateway into an online Document archive or repository. A Printer contains zero or more Job objects 🧁
A Job object is contained by exactly one Printer. However, the identical Document data associated with a Job could be sent to either the same or a different Printer. In that case, a second Job object would be created that would be almost identical to the first Job. It would, though, have new (different) Job object identifiers (see Section 3.4) 🪞
A Job either is empty (before any Documents have been added) or contains one or more Documents. If the contained Document is a stream of Document data, that stream can be contained in only one Document. However, there can be identical copies of the stream in other Documents in the same or different Jobs. If the contained Document is just a reference to a stream of Document data, other Documents (in the same or different Job(s)) contain the same reference 💅
3.4. Object Identity ✨
All IPP objects (Printers, Jobs, etc.) get identified by a Uniform Resource Identifier (URI) [RFC3986], so they can be persistently and unambiguously referenced 🎀. Every URL is a specialized form of a URI, so even though this document says "URI" everywhere, it means "URL" too 🔗.
An Administrator configures Printers to either support or not support authentication and/or message privacy using Transport Layer Security (TLS) [RFC5246] 🔐. The mechanism for security configuration is outside the scope of this document, so that's a whole other tea ☕. Sometimes both types of connections (authenticated and unauthenticated) can run over a single communication channel that has some sort of negotiation mechanism 🦋. Other times there are multiple channels, one for each type of security configuration 🌈. Section 9 has the full rundown on all security considerations and configurations, and it's seriously important 💀.
If a Printer supports more than one communication channel, some or all of those channels might support and/or require different security mechanisms 👑. In that case, an Administrator could show off the simultaneous support for those channels as multiple URIs for one Printer, where each URI represents one channel to the Printer 💅. So the IPP Printer object type defines a multi-valued identification attribute called the printer-uri-supported attribute, which MUST contain at least one URI 🍓. The printer-uri-supported attribute has two companion attributes: the uri-security-supported attribute and the uri-authentication-supported attribute ✨. Both have the same cardinality as printer-uri-supported. The uri-security-supported attribute tells you which security mechanisms (if any) are used for each URI listed in printer-uri-supported 🔒. The uri-authentication-supported attribute tells you which authentication mechanisms (if any) are used for each URI listed in printer-uri-supported 🙋. All three of these attributes get the full treatment in Sections 5.4.1, 5.4.2, and 5.4.3 📚.
When a Job gets submitted to the Printer through a Job Creation request, the Client only supplies a single Printer URI 💖. That Client-supplied Printer URI MUST be one of the values in the printer-uri-supported Printer attribute 🫶.
IPP/1.1 doesn't say how the Client gets that Client-supplied URI, but it is RECOMMENDED that a Printer be registered as an entry in a directory service 📒. Then End Users and programs can poke around the directory and search for Printers 🔍. Appendix D defines a generic schema for Printer object entries in the directory service, and it explains how that entry acts as a bridge to the actual IPP Printer 🌉. The directory entry for the IPP Printer holds the possibly many URIs for that Printer as values in one of its attributes 🧚.
When a Client sends a Job Creation request to the Printer, the Printer validates the request and creates a brand new Job object 🎉. The Printer gives the new Job a numeric identifier, which gets stored in the job-id Job attribute, and a URI, which gets stored in the job-uri Job attribute 🪪. Clients can use either the numeric identifier or the URI as the target for later Job operations, but the numeric identifier is preferred 🥇. The Printer generates the Job numeric identifier and URI based on its configured security policy and the URI the Client used in the Job Creation request 🧠.
Here's an example, because examples slay 💜. Imagine a Printer that supports a channel secured with TLS (using HTTP over TLS with an "https" schemed URI) and another open channel that isn't secured with TLS (using a plain "http" schemed URI) 🦋. If a Client submits a Job using the secure URI, the Printer gives the new Job a secure URI too 🔐. If a Client submits a Job using the open-channel URI, the Printer might give the new Job an open-channel URI 🌸. But Clients SHOULD use the printer-uri and job-id attributes to target a Job, so there's zero ambiguity about the security of the communication channel 🙈.
The Printer also fills in the Job's job-printer-uri attribute 📍. This is a reference back to the Printer that created the Job 🔙. If a Client only has access to a Job's job-uri identifier, the Client can query the Job's job-printer-uri attribute to figure out which Printer made the Job 🕵️. If the Printer supports more than one URI, the Printer picks the one URI the Client supplied when creating the Job, and uses it to build and populate the Job's job-printer-uri attribute 💅.
IPP objects also have names, not just identifiers 🏷️. Printers have a printer-name and Jobs have a job-name 🎀. An object name isn't guaranteed to be unique across all instances of all objects, so don't count on it being one-of-a-kind 🙃. An Administrator chooses and sets a Printer's name through some mechanism outside the scope of this document 🛠️. A Client can choose and supply a Job's name when it submits the Job 📝. If the Client doesn't supply a Job name, the Printer generates one for the new Job 🤖. Either way, the name only has local meaning 🏠.
To summarize, because recaps are everything 💖:
- Each Printer is identified by one or more URIs. The Printer's
printer-uri-supportedattribute contains the URI(s) 🪪. - The Printer's
uri-security-supportedattribute identifies the communication channel security protocols that have been configured for the various Printer URIs (e.g.,'tls'or'none') 🔒. - The Printer's
uri-authentication-supportedattribute identifies the authentication mechanisms that have been configured for the various Printer URIs (e.g.,'digest','none', etc.) 🙋. - Each Job is identified by a numeric identifier, which is a 32-bit positive integer. The Job's
job-idattribute contains the Job ID. The Job ID is only unique within the context of the Printer that created the Job 🔢. - Each Job is also identified by a URI. The Job's
job-uriattribute contains the URI, although its use by Clients is DEPRECATED 🚫. - Each Job has a
job-printer-uriattribute, which contains the URI of the Printer that was used to create the Job. This attribute is how you find out which Printer created a Job when all you've got is the Job's URI. This linkage is needed to determine the languages, charsets, and operations supported on that Job (the basis for that support comes from the creating Printer) 🧩. - Each Printer has a name, which isn't necessarily unique. The Administrator chooses and sets this name through some mechanism outside the scope of this IPP/1.1 document. The Printer's
printer-nameattribute contains the name 🏷️. - Each Job has a name, which isn't necessarily unique. The Client optionally supplies this name in the Job Creation request. If the Client doesn't supply it, the Printer generates a name for the Job. The Job's
job-nameattribute contains the name 🎀.
4. IPP Operations 🎬
IPP objects (Printers, Jobs, etc.) support operations 💪. An operation is made of a request and a response 🔁. When a Client talks to a Printer or its Jobs, the Client issues an operation request to the Printer URI and, if it's needed, the object's numeric identifier 📮. Operation requests and responses have parameters that identify the operation 🪧. Operations also have attributes that change the runtime characteristics of the operation, like the intended target and localization information 🌍. These operation-specific attributes are called "operation attributes", which is different from object attributes like Printer attributes or Job attributes 🧾. Each request carries along any operation attributes, object attributes, and/or Document data needed to perform the operation 📦. Every request gets a response from the object 📬. Each response shows success or failure of the operation with a status-code as a response parameter ✅❌. The response can contain any operation attributes, object attributes, and/or status messages generated while the operation request ran 💬.
This section describes the semantics of the IPP operations, both requests and responses, in terms of the parameters, attributes, and other data tied to each operation 🧠.
The Printer operations defined in this document are:
Print-Job(Section 4.2.1) 🖨️Print-URI(Section 4.2.2) 🌐Validate-Job(Section 4.2.3) ✔️Create-Job(Section 4.2.4) 🆕Get-Printer-Attributes(Section 4.2.5) 👀Get-Jobs(Section 4.2.6) 📋Pause-Printer(Section 4.2.7) ⏸️Resume-Printer(Section 4.2.8) ▶️Purge-Jobs(Section 4.2.9) 🧹
The Job operations defined in this document are:
Send-Document(Section 4.3.1) 📄Send-URI(Section 4.3.2) 🔗Cancel-Job(Section 4.3.3) ❌Get-Job-Attributes(Section 4.3.4) 🔍Hold-Job(Section 4.3.5) ✋Release-Job(Section 4.3.6) 🕊️Restart-Job(Section 4.3.7) 🔄
The Send-Document and Send-URI Job operations are used to add Documents to an existing Job that was created with the Create-Job operation 📎.
4.1. Common Semantics 🧈
All IPP operations need some common parameters and operation attributes 🤝. These common elements and their semantic characteristics are defined and described in more detail in the following sections 📖.
4.1.1. Required Parameters 🫧
Every operation request contains the following REQUIRED parameters:
- a
version-number, - an
operation-id, - a
request-id, and - the attributes that are REQUIRED for that type of request.
Every operation response contains the following REQUIRED parameters:
- a
version-number, - a
status-code, - the
request-idthat was supplied in the corresponding request, and - the attributes that are REQUIRED for that type of response.
The Encoding and Transport document [RFC8010] defines special rules for encoding these parameters 🔐. All the other operation elements are represented using the more generic encoding rules for attributes and groups of attributes 🧩.
4.1.2. Operation IDs and Request IDs ✨
Okay bestie, every IPP operation request carries an identifying operation-id value 🎀. The valid values are listed in the operations-supported Printer attribute section (see Section 5.4.15) 💅. So the Client tells the server which operation it wants by sending the right operation-id 🫶.
But wait, there's more! Every single invocation of an operation also gets its own request-id value 🦋. The Client picks that one itself, and it MUST be an integer (possibly unique, depending on Client requirements) in the range from 1 to 2**31 - 1 (inclusive) 🔢. This is how Clients keep track of multiple outstanding requests at once ✨. The receiving IPP object (Printer, Job, etc.) copies all 32 bits of the Client-supplied request-id attribute into the response, so the Client can match each response to the correct outstanding request, even if the request-id is out of range 🙈. And if the request gets terminated before the complete request-id is received, the IPP object rejects the request and returns a response with a request-id of 0 😭.
📝 Note: In some cases, the transport protocol under IPP might be a connection-oriented protocol that makes it impossible for a Client to receive responses in any order other than the order in which the corresponding requests were sent. In those cases, therequest-idattribute would not be essential for correct protocol operation. But in other transport mappings the operation responses could come back in any order, and then therequest-idis essential 💜.
4.1.3. Attributes 🌸
Operation requests and responses are both made up of groups of attributes and/or Document data. The attribute groups are:
- Operation Attributes: These are passed in the operation and affect how the IPP object behaves while processing the operation request. They can also affect other attributes or groups of attributes. Some operation attributes describe the Document data associated with the Print Job and are linked to new Job objects, but most of them don't stick around beyond the life of the operation 🧚. Each operation attribute's description has conformance statements saying which operation attributes are REQUIRED and which are OPTIONAL for an IPP object to support, plus which attributes a Client MUST supply in a request and which an IPP object MUST supply in a response 📋.
- Job Template Attributes: These affect how a Job gets processed 🍓. A Client MAY supply Job Template attributes in a Job Creation request, and the receiving object MUST be prepared to receive all supported attributes. The Job object can be queried later to find out which Job Template attributes were originally requested in the Job Creation request, and those come back in the response as Job object attributes ✨. The Printer object can be queried about its Job Template attributes to see what kinds of Job processing it supports and/or what the default Job processing behaviors are, though those come back in the response as Printer object attributes 💅. The
ipp-attribute-fidelityoperation attribute affects processing of all Client-supplied Job Template attributes. See Section 4.2.1.1 and Appendix C for the full story onipp-attribute-fidelityand how it relates to other attributes 🦋. - Job Object Attributes: These come back in response to a query operation aimed at a Job object 🎀.
- Printer Object Attributes: These come back in response to a query operation aimed at a Printer object 🖨️.
- Unsupported Attributes: In a Job Creation request, the Client supplies a set of operation and Job Template attributes. If any of those attributes or their values are unsupported by the Printer object, the Printer object SHOULD return the set of unsupported attributes in the response 🙈. Section 4.1.7, Section 4.2.1.2, and Appendix C give the full breakdown of how the Printer object processes Job Template attributes supplied in a Job Creation request and how unsupported attributes get sent back to the Client 💜. Because of extensibility, any IPP object might receive a request containing new or unknown attributes or values it has no support for. In that case, the IPP object processes what it can and returns the unsupported attributes in the response 🌈. The Unsupported Attributes group is defined for all operation responses so unsupported attributes the Client sent can come back to it ✨.
Later in this section, each operation is formally defined by identifying the allowed and expected groups of attributes for each request and response. The model sets a specific order for each group in each request or response, but the attributes inside each group can be in any order, unless specified otherwise 🧩.
The attributes within a group MUST be unique. If an attribute with the same name shows up more than once, the group is malformed 🚨. Clients MUST NOT submit such malformed requests, and Printers MUST NOT return such malformed responses 😭. If a malformed request is submitted to a Printer, the Printer MUST either (1) reject the request with the client-error-bad-request status-code (RECOMMENDED -- see Appendix B.1.4.1) or (2) process the request normally after selecting only one of the attribute instances, depending on implementation. Which attribute gets selected when there are duplicates depends on implementation. The IPP Printer MUST NOT use the values from more than one such duplicate attribute instance 🙅♀️.
Each attribute definition includes the attribute's name followed by the name of its attribute syntax(es) in parentheses. Each integer attribute can also be followed by its allowed range in parentheses, (m:n), for values of that attribute. Each text or name attribute can be followed by its maximum size in octets in parentheses, (size), for values of that attribute. For more details on attribute syntax notation, see the descriptions of those attribute syntaxes in Section 5.1 📖.
📝 Note: Document data included in the operation isn't strictly an attribute, but it gets treated as a special attribute group for ordering purposes. The only operations defined in this document that support supplying Document data within an operation request arePrint-JobandSend-Document. No operations defined in this document have responses that include Document data 🌸.
Some operations are REQUIRED for IPP objects to support, and the others are OPTIONAL (see Section 6.2.2). So before using an OPTIONAL operation, a Client SHOULD first use the REQUIRED Get-Printer-Attributes operation to query the Printer's operations-supported attribute and figure out which OPTIONAL operations are actually supported 🕵️♀️. The Client SHOULD NOT use an OPTIONAL operation that isn't supported. When an IPP object receives a request to perform an operation it doesn't support, it MUST return the server-error-operation-not-supported status-code (see Appendix B.1.5.2) 🚫. An IPP object is non-conformant if it does not support a REQUIRED operation 💀.
4.1.4. Character Set and Natural Language Operation Attributes 🌍
Some Job and Printer attributes have values that are text strings and names meant for human understanding rather than machine understanding (see the text and name attribute syntax descriptions in Section 5.1) 💬. The following sections describe two special operation attributes called attributes-charset and attributes-natural-language. Their values are used when interpreting other attributes that use the text and name attribute syntaxes 🎀. For Job Creation operations, the IPP Printer implementation also saves these two attributes with the new Job object as Job Status attributes 🧁.
The attributes-charset and attributes-natural-language attributes MUST be the first two attributes in every IPP request and response, as part of the initial Operation Attributes group of the IPP message 👑. The attributes-charset attribute MUST be the first attribute in the group, and the attributes-natural-language attribute MUST be the second attribute in the group 🥇🥈.
To keep this document brief, these operation attribute descriptions aren't repeated with every operation request and response. Instead, they point back to this section 🫶✨.
4.1.4.1. Request Operation Attributes ✨
Okay so the Client MUST supply these, and the Printer object MUST support them, in every single IPP operation request 💅. They're REQUIRED, no cap:
"attributes-charset" (charset):
This operation attribute tells everyone which charset (the coded character set plus its encoding method) is used by any 'text' and 'name' attributes the Client is sending in this request 🎀. It also says which charset the Printer object MUST use (if it's supported) for all the 'text' and 'name' attributes and status messages it sends back in the response. Check Sections 5.1.2 and 5.1.3 for the definitions of the 'text' and 'name' attribute syntaxes 🧚.
All Clients and IPP objects MUST support the 'utf-8' charset [RFC3629], and they MAY support additional charsets as long as those are registered with IANA [RFC2978] [IANA-CS] 🌸. If the Printer object doesn't support the Client-supplied charset value, the Printer object MUST reject the request 💀. It sets "attributes-charset" to 'utf-8' in the response and returns the 'client-error-charset-not-supported' status-code, plus any 'text' or 'name' attributes using the 'utf-8' charset. The Printer MAY return any attributes in the Unsupported Attributes group (see Sections 4.1.7 and 4.2.1.2). And the Printer object MUST indicate the charset(s) it supports as the values of the "charset-supported" Printer attribute (see Section 5.4.18), so the Client can ask which ones work 🔥.
Note to Client implementors: bestie, listen up 🫶. IPP objects are only required to support'utf-8', so to play nicely with lots of different IPP object implementations, a Client SHOULD supply'utf-8'in the"attributes-charset"operation attribute. This is true even if the Client can only show a simpler charset like US-ASCII [RFC20] or ISO-8859-1 [ISO8859-1]. Then the Client has to filter out, convert, or replace the characters in the response that it can't show its user 😭. On the flip side, if both the Client and the IPP objects support some other charset in common besides'utf-8', the Client can use that one to skip conversion and avoid data loss ✨.
See the 'charset' attribute syntax description in Section 5.1.8 for the syntax and semantic interpretation of this attribute's values, plus example values 💖.
"attributes-natural-language" (naturalLanguage):
This operation attribute identifies the natural language [RFC5646] used by any 'text' and 'name' attributes the Client is supplying in this request. It also tells the Printer object which natural language it SHOULD use for all the 'text' and 'name' attributes and status messages it returns in the response to this request 🌈. See the 'naturalLanguage' attribute syntax description in Section 5.1.9 for the syntax and semantic interpretation of the values, plus example values.
There are no REQUIRED natural languages required for the Printer object to support 🙈. But the Printer's "generated-natural-language-supported" attribute lists the natural languages the Printer object and any contained Jobs support for all text strings the IPP object generates. A Client MAY query this attribute to see which natural language(s) work for generated messages ⭐.
For any attributes where the Printer object generates text ("job-state-message", "printer-state-message", and status messages, see Section 4.1.6), the Printer object MUST be able to generate those text strings in any of its supported natural languages 🦋. If the Client requests a natural language that isn't supported, the Printer object MUST return these generated messages in the Printer's configured natural language, as given by its "natural-language-configured" attribute (see Section 5.4.19) 💅.
For the other 'text' and 'name' attributes supplied by the Client, authentication system, Operator, Administrator, or manufacturer (that is, "job-originating-user-name", "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 identified by its "natural-language-configured" attribute. Supporting extra natural languages for these attributes is permitted, though 🍓.
For any 'text' or 'name' attribute in the request that's in a different natural language from the value supplied in "attributes-natural-language", the Client MUST use the Natural Language Override mechanism (see Sections 5.1.2.2 and 5.1.3.2) for each such attribute value 🫶. The Client MAY use the Natural Language Override mechanism redundantly too, meaning it can use it even when the value is in the same natural language as the "attributes-natural-language" value of the request.
The IPP object MUST accept any natural language and any Natural Language Override, whether or not it supports that natural language (and no matter what "ipp-attribute-fidelity" is set to 👑). Basically, the IPP object accepts all Client-supplied values, whatever is in "generated-natural-language-supported". That attribute only applies to generated messages, not Client-supplied ones. The IPP object MUST remember that natural language for all Client-supplied attributes, and when it returns those attributes in response to a query, it MUST indicate that natural language.
Each value whose attribute syntax type is 'text' or 'name' (see Sections 5.1.2 and 5.1.3) has an Associated Natural Language. This document doesn't specify how that association is stored in a Printer or Job object 🤷. When such a value is encoded in a request or response, the natural language is either implicit or explicit:
- Implicit: the value contains only the text/name value, and the language is specified by the
"attributes-natural-language"operation attribute in the request or response (see Sections 5.1.2.1 and 5.1.3.1). - Explicit (also known as the Natural Language Override case): the value contains both the language and the text/name value (see Sections 5.1.2.2 and 5.1.3.2).
For example, the "job-name" attribute MAY be supplied by the Client in a Job Creation request 🎀. The text value for this attribute is in the natural language identified by "attribute-natural-language", or, if it's different, the natural language identified by the Natural Language Override mechanism. If it's supplied, the IPP object uses the value of "job-name" to populate the Job's "job-name" attribute. Whenever any Client queries the Job's "job-name" attribute, the IPP object returns the attribute as stored and uses the Natural Language Override mechanism to specify the natural language, if it's different from the one reported in the "attributes-natural-language" operation attribute of the response. The IPP object MAY use the Natural Language Override mechanism redundantly too, meaning it can use it even when the value is in the same natural language as the "attributes-natural-language" value of the response.
An IPP object MUST NOT reject a request based on a supplied natural language in an "attributes-natural-language" operation attribute, or in any attribute that uses the Natural Language Override 🙅.
Note: supplying'text'or'name'attributes with an incompatible combination of natural language and charset can cause undesired behavior. For example, suppose a Printer supports charsets'utf-8','iso-8859-1', and'iso-8859-7'. Suppose also that it supports natural languages'en'(English),'fr'(French), and'el'(Greek). Although the Printer supports the charset'iso-8859-1'and the natural language'el', it probably does not support the combination of Greek text strings using the'iso-8859-1'charset. The Printer handles this apparent incompatibility differently, depending on the context in which it occurs:
- In a Job Creation request: if the Client supplies a
'text'or'name'attribute (for example, the"job-name"operation attribute) that uses an apparently incompatible combination, it's a Client choice that doesn't affect the Printer or its correct operation. So the Printer simply accepts the Client-supplied value, stores it with the Job, and responds with the same combination whenever the Client (or any Client) queries that attribute 🍑. - In a query-type operation, like Get-Printer-Attributes: if the Client requests an apparently incompatible combination, the Printer responds (as described in Section 4.1.4.2) using the Printer's configured natural language rather than the natural language requested by the Client 🧁.
In either case, the Printer does not reject the request because of the apparent incompatibility. The potential incompatible combination of charset and natural language can occur either at the global operation level or at the Natural Language Override attribute-by-attribute level. And since the response always includes explicit charset and natural language information, there is never any question or ambiguity about how the Client interprets the response 💜.
4.1.4.2. Response Operation Attributes 💖
okay so bestie, every single IPP/1.1 operation response has to carry these REQUIRED operation attributes, and the Printer MUST supply them while the Client MUST support them. no cap, these are not optional 🫶
"attributes-charset" (charset): 🎀
This operation attribute tells you which charset is being used for any 'text' and 'name' attributes the Printer object sends back in the response. The value in the response MUST be the same as the "attributes-charset" the Client sent in the request. If that's not possible (like, the requested charset isn't supported), then the request would have been rejected already, so it never gets this far 💅. See "attributes-charset" back in Section 4.1.4.1 above.
okay now the code conversion part is lowkey the most intense bit 😭. If the Printer object supports more than just the 'utf-8' charset, it MUST be able to do code conversion between each of the supported charsets on a "highest fidelity possible" basis, so it can return the 'text' and 'name' attributes in whatever charset the Client asked for. BUT, some info can get lost during conversion, depending on which charsets are involved 💀. For example, depending on the implementation, the Printer object can turn a UTF-8 'a' into a US-ASCII 'a' with zero info lost 🌸. It can turn an ISO Latin 1 CAPITAL LETTER A WITH ACUTE ACCENT into US-ASCII 'A', which means the accent just gets dropped 🥲. Or it can turn a UTF-8 Japanese Kanji character into some ISO Latin 1 error character indication, like '?', a decimal code equivalent, or just no character at all 😭🧚.
Whether an implementation that supports more than one charset stores the data in the charset the Client supplied, or converts to one of the other supported charsets, is up to the implementation 🦋. The strategy should try to minimize loss of information during code conversion ✨. And on each response, that kind of implementation converts from its internal charset to the one that was requested 💜.
"attributes-natural-language" (naturalLanguage): 🌈
This operation attribute identifies the natural language used by any 'text' and 'name' attributes that the IPP object is sending back in this response. Here's the twist: unlike "attributes-charset", the IPP object MAY return the natural language of the Job object, or the Printer's configured natural language as identified by the Printer's "natural-language-configured" attribute, instead of the one the Client supplied. Main character energy from the printer, honestly 👑.
Now, for any 'text' or 'name' attribute or status message in the response that is in a different natural language than the value returned in "attributes-natural-language", the IPP object MUST use the Natural Language Override mechanism (see Sections 5.1.2.2 and 5.1.3.2) on each attribute value it returns 🔥. The IPP object MAY also use the Natural Language Override mechanism redundantly, meaning it can use it even when the value is already in the same natural language as the "attributes-natural-language" value in the response 🙈✨.
4.1.5. Operation Targets 🎯
okay bestie, every IPP operation is directed at IPP objects 🦋. For Printer operations, the operation is always aimed at a Printer object using one of its URIs, which means one of the values in the Printer's "printer-uri-supported" attribute 💖. Even if the Printer object supports more than one URI, the Client only supplies ONE URI as the target of the operation 🫶. The Client picks out the target object by putting the correct URI in the "printer-uri" operation attribute 💅.
For Job operations, the operation is directed at either:
- The Printer object that created the Job object, using the Printer object's URI and the Job's numeric identifier (Job ID) 🌸. Since that Printer generated the Job ID, it MUST be able to correctly match the Client-supplied Job ID with the correct Job object 🧚. The Client supplies the Printer's URI in "printer-uri" and the Job ID in "job-id" 💜.
- The Job object itself, using the Job's URI 🎀. In this case, the Client identifies the target by supplying the correct URI in the "job-uri" (uri) operation attribute (Section 5.3.2) ✨.
Clients SHOULD send the "printer-uri" and "job-id" operation attributes in Job operations 💅.
If the operation is aimed at the Job object directly using the Job's URI, the Client MUST NOT include the redundant "job-id" operation attribute 🙅♀️. Not me including redundant stuff 💀.
The operation target attributes are REQUIRED operation attributes that get included in every operation request 🌈. Like the charset and natural language attributes (see Section 4.1.4), the operation target attributes are specially ordered 👑. In all cases, they immediately follow "attributes-charset" and "attributes-natural-language" within the Operation Attributes group 🦋. The specific ordering rules are:
- If there's only one operation target attribute (so either only "printer-uri" or only "job-uri"), that attribute MUST be the third attribute in the Operation Attributes group 🫶.
- If Job operations use two operation target attributes (that's "printer-uri" and "job-id"), then "printer-uri" MUST be the third attribute and "job-id" MUST be the fourth attribute 🔥.
In all cases, the target URIs in the body of IPP operation requests and responses MUST be in absolute format rather than relative format 💖. (A relative URL identifies a resource within the scope of the HTTP server, but doesn't include scheme, host, or port 🙄.)
The following rules apply to port numbers in URIs that identify IPP objects 🧚:
- If the URI scheme allows the port number to be explicitly included in the URI string, and a port number IS specified within the URI, then the Client MUST use that port number to contact the IPP object 🌸.
- If the URI scheme allows the port number to be explicitly included in the URI string, and a port number is NOT specified within the URI, then the Client MUST use the default port number implied by that URI scheme to contact the IPP object 💜.
- If the URI scheme does NOT allow an explicit port number to be specified within the URI, then the Client MUST use the default port number implied by that URI to contact the IPP object 🎀.
Note: "Internet Printing Protocol/1.1: IPP URL Scheme" [RFC3510] and "Internet Printing Protocol (IPP) over HTTPS Transport Binding and the 'ipps' URI Scheme" [RFC7472] define the mapping of IPP onto HTTP and HTTPS, respectively, and define and register a default port number 🌈✨.
4.1.6. Operation Response Status-Code Values and Status Messages 💌
Every operation response includes a REQUIRED "status-code" parameter 🫶. It SHOULD include the "status-message" operation attribute 💅, and it MAY include the "detailed-status-message" operation attribute 🦋. The Print-URI and Send-URI response MAY also include the "document-access-error" operation attribute 🌸.
4.1.6.1. "status-code" (type2 enum) 🚦
The REQUIRED "status-code" parameter gives information on how the processing of a request went 💖.
The status-code is meant for automata (aka machines, not humans, bestie 🤖). A Client implementation of IPP SHOULD convert status-code values into any localized message that has semantic meaning to the End User 🌍✨.
The "status-code" value is a numeric value that has semantic meaning 🔢. Its syntax is similar to a "type2 enum" (see Section 5.1 ("Attribute Syntaxes")), except that values can only range from 0x0000 to 0x7fff 🎀. Appendix B describes and assigns the status-code values, and suggests a corresponding status message for each one, for the Client to use when the user's natural language is English 💜.
If the Printer performs an operation with no errors and runs into no problems, it MUST return the status-code 'successful-ok' in the response 🥰. See Appendix B 🧚.
If the Client supplies unsupported values for the following parameters or operation attributes, the Printer object MUST reject the operation 🙅♀️. It MAY return the unsupported attribute value in the Unsupported Attributes group, and it MUST return the indicated status-code 💀:
+---------------------+---------------------------------------------+
| Parameter/Attribute | Status-Code |
+---------------------+---------------------------------------------+
| version-number | server-error-version-not-supported |
+---------------------+---------------------------------------------+
| operation-id | server-error-operation-not-supported |
+---------------------+---------------------------------------------+
| attributes-charset | client-error-charset-not-supported |
+---------------------+---------------------------------------------+
| compression | client-error-compression-not-supported |
+---------------------+---------------------------------------------+
| document-format | client-error-document-format-not-supported |
+---------------------+---------------------------------------------+
| document-uri | client-error-uri-scheme-not-supported, |
| | client-error-document-access-error |
+---------------------+---------------------------------------------+
Table 1: Status-Code Values for All RequestsIf the Client supplies unsupported values for other attributes, or unsupported attributes, the Printer returns the status-code defined in Section 4.1.7 ("Unsupported Attributes") 🌟✨.
4.1.6.2. "status-message" (text(255)) 💬
okay so the RECOMMENDED status-message operation attribute is a tiny one-liner that tells you what happened with the operation 💅. Its syntax is text(255), so it maxes out at 255 octets (peep Section 5.1.2 if you want the deets) 🎀. It's for the human End User, not for code 🙈. If a response includes one, an IPP Client gets to show or examine it however its implementation likes ✨. It's honestly so useful for a newer Printer, because it can add a friendly explanation for a status-code that an older Client might not recognize 🦋.
If the Printer supports the status-message operation attribute, it MUST be able to generate this message in any natural language listed in the Printer's generated-natural-language-supported attribute 🌍. It also MUST honor any supported value of the attributes-natural-language operation attribute (Section 4.1.4.1) from the Client request 🫶. Appendix B has suggested English wording for the status message 📝.
As Section 4.1.4.1 explains, for any returned 'text' attribute where there's a choice of language, the Printer uses the language in attributes-natural-language from the Client request if it's supported 💖. If it isn't, the Printer falls back to the value in its own natural-language-configured attribute 🌸.
If the Printer supports the status-message operation attribute, it SHOULD use the REQUIRED 'utf-8' charset to return a status message for these error status-codes (see Appendix B) 🔥:
- 'client-error-bad-request'
- 'client-error-charset-not-supported'
- 'server-error-internal-error'
- 'server-error-operation-not-supported'
- 'server-error-version-not-supported'
In that case, it MUST set the value of the attributes-charset operation attribute to 'utf-8' in the error response 👑.
4.1.6.3. "detailed-status-message" (text(MAX)) 🧠
The OPTIONAL detailed-status-message operation attribute is the deep-dive one 🤓. It has the nitty-gritty technical and implementation-specific info about the operation, meant for Administrators and other experienced technical people 🛠️. Its syntax is text(MAX), so the maximum length is 1023 octets (see Section 5.1.2) ✨.
If the Printer supports this attribute, it SHOULD localize the message 🌈, unless localizing it would blur the technical meaning 🙅♀️. Clients MUST NOT attempt to parse the value of this attribute 💀. If you need errors a program can actually process, go check the document-access-error operation attribute (Section 4.1.6.4) instead 🧚.
4.1.6.4. "document-access-error" (text(MAX)) 🚪
This OPTIONAL operation attribute gives extra info about any Document access errors the Printer ran into before it sent back a response to the Print-URI (Section 4.2.2) or Send-URI (Section 4.3.2) operation 📦. For errors in the protocol named by the URI scheme in the document-uri operation attribute (like 'http:' or 'ftp:'), the error code shows up in parentheses, followed by the URI. Here's an example 👀:
(404) http://www.example.com/filename.pdfMost Internet protocols use decimal error codes (unlike IPP), so the ASCII error code representation is in decimal 🔢. Just a fun little difference, bestie 🎀.
4.1.7. Unsupported Attributes 🚫
The Unsupported Attributes group is where the Printer lists the attributes it doesn't support for the operation 🙃. It's mainly for the Job Creation operations, but honestly any operation can return it 💅.
A Printer MUST include an Unsupported Attributes group in a response if the status-code is one of these four 🥺:
- 'successful-ok-ignored-or-substituted-attributes'
- 'successful-ok-conflicting-attributes'
- 'client-error-attributes-or-values-not-supported'
- 'client-error-conflicting-attributes'
When the status-code is one of those four, the Unsupported Attributes group MUST contain all of those attributes and only those attributes that are:
a. an operation or Job Template attribute supplied in the request, and
b. unsupported by the Printer. Keep reading for the three categories of "unsupported" attributes 🔍.
If the status-code is one of the ones in Table 1 in Section 4.1.6.1, the OPTIONAL Unsupported Attributes group contains the unsupported parameter or attribute named in that table 📋.
If the Printer isn't returning any unsupported attributes, it SHOULD omit the Unsupported Attributes group instead of sending an empty one 🧹. Still, a Client MUST be able to accept an empty group, no drama 💖.
Unsupported attributes fall into three categories 🎀:
- The Printer doesn't support the supplied attribute at all (no matter the attribute syntax or value).
- The Printer does support the attribute, but not some or all of the attribute syntaxes or values the Client sent. In other words, those syntaxes or values aren't in its matching "xxx-supported" attribute 🧐.
- The Printer supports the attributes and values individually, but the values clash with each other because they break a constraint, like trying to staple transparencies 📎.
For an unsupported attribute name, the Printer sends back the Client's attribute with a substituted value of 'unsupported' 🙅. That value has the "out-of-band" syntax type, and its encoding follows the special rules for "out-of-band" values in the Encoding and Transport document [RFC8010]. It means the Printer doesn't support the attribute itself, so check the beginning of Section 5.1 in this document 📚.
For a supported attribute with one or more unsupported syntaxes or values, the Printer returns the Client's attribute with just those unsupported syntaxes or values, exactly as the Client sent them 🌸. This says the attribute is supported, but that particular syntax or value isn't. If the Client sends a multi-valued attribute and the Printer only supports some of those values, the Printer MUST return only the values that are unsupported 🎯.
For two or more supported values that conflict when requested together in the same Job (each one works fine alone, but not together), the Printer MUST return all the values it ignores or substitutes to resolve the conflict, and none of the values it's still using 🫶. How it resolves the conflict is up to the implementation 🤷♀️. See Section 4.2.1.2 and Appendix C 👑. For examples, check the Implementor's Guides [RFC3196] [PWG5100.19] ✨.
4.1.8. Versions 🎀
okay so every operation request and response carries a version-number parameter 💅 Each value looks like X.Y, where X is the major version number and Y is the minor version number. When the Client includes a version number in its request, it's basically saying which version of IPP it wants to use, aka the version whose conformance requirements the Client can count on the Printer to meet 🫶
If the IPP object doesn't support the major version number the Client sent (so the "major version number" part of "version-number" doesn't match any of the values in the Printer's "ipp-versions-supported" attribute, see Section 5.4.14), the object MUST respond with a status-code of 'server-error-version-not-supported' along with the closest version number it does support (see Appendix B.1.5.4). If the major version number is supported but the minor version number isn't, the IPP object SHOULD accept the request and try to perform it (or reject the request if the operation isn't supported). Otherwise it rejects the request and returns the 'server-error-version-not-supported' status-code. In every case, the IPP object MUST return the "version-number" value it supports that's closest to the version number the Client supplied in the request 💖
There's no version negotiation per se 🙈 However, if a Client has received a 'server-error-version-not-supported' status-code from an IPP object, the Client SHOULD try again with a different version number. A Client MAY also figure out which versions are supported, either from a directory that conforms to Appendix D or by querying the Printer's "ipp-versions-supported" attribute (see Section 5.4.14).
An IPP/1.1 object implementation MUST support version '1.1', i.e., meet the conformance requirements for IPP/1.1 as specified in this document and [RFC8010]. IPP implementations SHOULD accept any request with the major version '1' or '2', or reject the request if the operation isn't supported ✨
There's only one notion of "version number" that covers both IPP Model and IPP protocol changes, so pay attention 🧚 Changes to the major version number of the Model and Semantics document can signal structural or syntactic changes that make it impossible for older IPP Clients and Printers to correctly parse and correctly process the new or changed attributes, operations, and responses. When the major version number changes, the minor version number gets set back to zero. For example, adding the REQUIRED "ipp-attribute-fidelity" attribute to version '1.1' (if it hadn't been part of version '1.0') would have required a change to the major version number, because an IPP/1.0 Printer wouldn't process a request with the correct semantics that contained the "ipp-attribute-fidelity" attribute it didn't know about. Things that might affect a change to the major version number include any changes to the Model and Semantics document (this document) or to the Encoding and Transport document [RFC8010] itself, such as:
- reordering of ordered attributes or attribute sets
- changes to the syntax of existing attributes
- adding REQUIRED (for an IPP object to support) Operation Attributes groups
- adding values to existing REQUIRED operation attributes
- adding REQUIRED operations
Changes to the minor version number indicate the addition of new features, attributes, and attribute values that might not be understood by all IPP objects, but that can be ignored if they aren't understood 🌸 Things that might affect a change to the minor version number include any changes to the model objects and attributes, but not the encoding and transport rules [RFC8010] (except adding attribute syntaxes). Examples of these changes are:
- grouping all extensions not included in a previous version into a new version
- adding new attribute values
- adding new object attributes
- adding OPTIONAL (for an IPP object to support) operation attributes (i.e., those attributes that an IPP object can ignore without confusing Clients)
- adding OPTIONAL (for an IPP object to support) Operation Attributes groups (i.e., those attributes that an IPP object can ignore without confusing Clients)
- adding new attribute syntaxes
- adding OPTIONAL operations
- changing Job attributes or Printer attributes from OPTIONAL to REQUIRED or vice versa
- adding OPTIONAL attribute syntaxes to an existing attribute
The encoding [RFC8010] of the "version-number" parameter MUST NOT change over any version number, major or minor. This rule guarantees that all future versions will stay backwards compatible with all previous versions (at least for checking the "version-number" parameter) 🔥 Also, any protocol elements (attributes, error codes, tags, etc.) that aren't carried forward from one version to the next are DEPRECATED, so they can never be reused with new semantics 💀
Implementations that support a certain version SHOULD support all previous Standards Track versions. As each new version is defined (through the release of a new IPP specification document), that version will specify which previous versions MUST and which versions SHOULD be supported in compliant implementations 👑
4.1.9. Job Creation Operations ✨
Okay so, to "submit a Print Job" and make a brand new Job, a Client sends a Job Creation request 🖨️💖. A Job Creation request is any one of these three operation requests:
- The Print-Job Request: If a Client wants to submit a Print Job with just one Document, it can use the Print-Job operation 🎀. This one lets the Client "push" the Document data to the Printer by putting the Document data right in the request itself. Note that Clients SHOULD instead use the Create-Job and Send-Document requests, if the Printer supports them, since they let you monitor and control the Job while the Document data is being submitted 👑.
- The Print-URI Request: If a Client wants a single-Document Print Job, and the Printer "pulls" the Document data instead of the Client "pushing" it, it uses the Print-URI operation 🦋. In this case, the Client only includes a URI reference to the Document data in the request, not the Document data itself 🧚.
- The Create-Job Request: If a Client wants a Print Job with zero or more Documents, it uses the Create-Job operation 🍓. After that come any number of Send-Document and/or Send-URI operations, each adding another Document to the brand new Job. Send-Document includes the Document data in the request (the Client "pushes" it), and Send-URI includes only a URI reference (the Printer "pulls" the data from that location). The last Send-Document or Send-URI request for a given Job includes a "last-document" operation attribute set to
'true', which basically means "this is the last one, bestie" 🫶.
Throughout this doc, "Job Creation request" means any of these three operation requests 💅.
A Create-Job followed by only one Send-Document is semantically equivalent to a Print-Job operation 🤝. BUT the Client SHOULD use the Create-Job and Send-Document operations (when supported) for all Jobs with a single Document, because that's how you get reliable Job control and monitoring 🔥. Real talk: Print-Job is a REQUIRED operation, so all implementations MUST support it 😭. Create-Job is a RECOMMENDED operation, though, so some implementations might not support it 💀.
Job submission time is the point when a Client issues a Job Creation request ⏰. The initial state of every Job is 'pending', 'pending-held', or 'processing' (see Section 5.3.7) 🌸. When the Printer begins processing the Print Job, the Job's state moves to 'processing', and that's called Job processing time ✨.
At Job submission time and at the time a Validate-Job operation is received, the Printer MUST do the following:
- Process the Client-supplied attributes and either accept or reject the request
- Validate the syntax of and support for the scheme of any Client-supplied URI
At Job submission time, the Printer MUST validate whether the supplied attributes, attribute syntaxes, and values are supported by matching them against the Printer's corresponding "xxx-supported" attributes. See Section 4.1.7 for details. See the Implementor's Guides [RFC3196] [PWG5100.19] for guidance on processing Job Creation requests 📚.
At Job submission time, the Printer MAY also do the validation checks that are reserved for Job processing time, such as:
- Validating the format of the Document data
- Validating the actual contents of any Client-supplied URI (resolve the reference and follow the link to the Document data)
At Job submission time, these extra Job processing time checks are kinda useless 🙈. They require actually parsing and interpreting the Document data, they aren't guaranteed to be 100% accurate, and they MUST be done, yet again, at Job processing time. Also, with a URI, checking that it's available at Job submission time doesn't guarantee it'll still be available at Job processing time 😩. On top of that, at Job processing time, the Printer might discover any of these conditions that weren't detectable at Job submission time:
- runtime errors in the Document data,
- nested Document data that is in an unsupported format,
- the URI reference is no longer valid (i.e., the server hosting the Document might be down), or
- any other Job processing error.
At Job submission time, a Printer, especially a non-spooling Printer, MAY accept Jobs for which it does not have enough space 🫠. In that situation, a Printer MAY stop reading data from a Client for an indefinite period of time. A Client MUST be prepared for a write operation to block for an indefinite period of time (see Section 6.1 ("Client Conformance Requirements")) 🥲.
When a Printer has too little space to start a new Job, it MAY reject a new Job Creation request 🚫. In this case, a Printer MUST return a response (in reply to the rejected request) with a status-code of 'server-error-busy' (see Appendix B.1.5.8), and it MAY close the connection before receiving all the bytes of the operation. A Printer SHOULD indicate that it's temporarily unable to accept Jobs by setting the 'spool-space-full' value in its "printer-state-reasons" attribute, and then removing that value when it can accept another Job (see Section 5.4.12) 🍭.
When a Client receives a 'server-error-busy' status-code in an operation response, it MUST be prepared for the Printer to close the connection before the Client has sent all of the data (especially for the Print-Job operation) 😬. A Client MUST be prepared to keep submitting a Job Creation request until the Printer accepts it 💪.
At Job processing time, the Printer has already responded with a successful status-code to the Job Creation request, so if the Printer detects an error, it can't tell the End User about it with an operation status-code 😭. Instead, depending on the error, the Printer can set the Job's "job-state", "job-state-reasons", and/or "job-state-message" attributes to the appropriate value(s), so later queries can report the correct Job status 📋.
Note: Asynchronous notification of events is defined in "Internet Printing Protocol (IPP): Event Notifications and Subscriptions" [RFC3995] 🔔.
4.2. Printer Operations 🖨️
All Printer operations are directed at Printers. A Client MUST always supply the "printer-uri" operation attribute so the correct target of the operation is identified 🎯.
4.2.1. Print-Job Operation 🎀
This REQUIRED operation lets a Client submit a Print Job with only one Document and supply the Document data itself (rather than just a reference to the data) 💅. See Appendix C for the suggested steps for processing Job Creation requests and their operation and Job Template attributes 🧚.
4.2.1.1. Print-Job Request
okay so the Print-Job request is basically a bundle of stuff split into three groups 🎀 let's go through them bestie 💅
Group 1: Operation Attributes ✨
- Natural Language and Character Set 🌸: the
attributes-charsetandattributes-natural-languageattributes, as described in Section 4.1.4.1. The Printer MUST copy these values to the matching Job Status attributes described in Sections 5.3.19 and 5.3.20. the Printer is literally copying your vibe over 🫶 - Target 🎯: the
printer-uri(uri) operation attribute. It's the target for this operation, as described in Section 4.1.5. - Requesting User Name 🙈: the
requesting-user-name(name(MAX)) attribute SHOULD be supplied by the Client, as described in Section 9.3. it's the who-asked-for-this energy 👑 job-name(name(MAX)) 🍓: the Client MAY supply it and the Printer MUST support it. It holds the Client-supplied Job name. If the Client sends it, its value gets used for thejob-nameattribute of the brand new Job. The Client MAY automatically include anything that helps the End User tell their Jobs apart, like the name of the application program plus info from the Document (the Document name, Document subject, or source file name). if the Client doesn't send one, the Printer makes up a name for thejob-nameattribute of the new Job (see Section 5.3.5). iconic 🧚ipp-attribute-fidelity(boolean) 💖: the Client MAY supply it and the Printer MUST support it. The value'true'means total fidelity to the Client-supplied Job Template attributes and values is required. otherwise, the Printer MUST reject the Print-Job request. The value'false'means a reasonable attempt to print the Job is totally fine, and the Printer MUST accept the Print-Job request. if it's not supplied, the Printer assumes'false'. ALL Printers MUST support both types of Job processing (yes, both, no exceptions 😤). See Appendix C for the full tea onipp-attribute-fidelityand how it links to other attributes, especially the Printer'spdl-override-supportedattribute 🔥document-name(name(MAX)) 🦋: the Client MAY supply it and the Printer MUST support it. It holds the Client-supplied Document name. The Document name MAY be different from the Job name. usually the Client software fills this in for the End User, using a file name or an application-generated name. if it's supplied, its value can be used however each implementation likes. examples include: printing it along with the Job (a Job start sheet, page adornments, etc.), using it in accounting or resource-tracking management tools, or even storing it with the Document as a Document-level attribute 📄✨compression(type2 keyword) 🗜️: the Client MAY supply it and the Printer MUST support it. The Client-suppliedcompressionoperation attribute says which compression algorithm was used on the Document data. here's how the cases shake out:- a. If the Client leaves this attribute out, the Printer MUST assume the data is not compressed. basically the Printer acts like the Client sent
compressionwith a value of'none'and follows the rules below that way 🌿 - b. If the Client sends this attribute but the value isn't supported by the Printer (meaning it's not one of the values of the Printer's
compression-supportedattribute), the Printer MUST reject the request and return the'client-error-compression-not-supported'status-code. See Section 4.1.7 for the details on returning unsupported attributes and values. 💀 - c. If the Client sends the attribute and the Printer supports that value, the Printer uses the matching decompression algorithm on the Document data. ✅
- d. If the decompression algorithm fails before the Printer returns an operation response, the Printer MUST reject the request and return the
'client-error-compression-error'status-code. 😭 - e. If the decompression algorithm fails after the Printer has already returned an operation response, the Printer MUST abort the Job and add the
'compression-error'value to the Job'sjob-state-reasonsattribute. the drama is real here 🎭 - f. If the decompression algorithm succeeds, the Document data MUST then have the format specified by the Job's
document-formatattribute, if one was supplied (see thedocument-formatoperation attribute definition below). ✨
- a. If the Client leaves this attribute out, the Printer MUST assume the data is not compressed. basically the Printer acts like the Client sent
document-format(mimeMediaType) 📜: the Client MAY supply it and the Printer MUST support it. The value identifies the format of the Document data that was sent. here's the breakdown:- a. If the Client doesn't supply this attribute, the Printer assumes the Document data is in the format defined by the Printer's
document-format-defaultattribute. it's like the Printer follows the rules below as if the Client had sent thedocument-formatattribute with the Printer's default value 🌈 - b. If the Client sends this attribute but the value isn't supported by the Printer (not one of the values of the Printer's
document-format-supportedattribute), the Printer MUST reject the request and return the'client-error-document-format-not-supported'status-code. nope nope nope 🙅♀️ - c. If the Client sends this attribute with the value
'application/octet-stream'(meaning it's to be auto-sensed; see Section 5.1.10.1), AND the format isn't one of the Document formats the Printer can auto-sense, AND this check happens before the Printer returns an operation response, then the Printer MUST reject the request and return the'client-error-document-format-not-supported'status-code. 🙈 - d. If the Client sends this attribute and the value is supported by the Printer, the Printer is able to interpret the Document data. 🧠
- e. If interpreting the Document data fails before the Printer returns an operation response, the Printer MUST reject the request and return the
'client-error-document-format-error'status-code. 💔 - f. If interpreting the Document data fails after the Printer has returned an operation response, the Printer MUST abort the Job and add the
'document-format-error'value to the Job'sjob-state-reasonsattribute. tragic, honestly 😭
- a. If the Client doesn't supply this attribute, the Printer assumes the Document data is in the format defined by the Printer's
document-natural-language(naturalLanguage) 🗣️: the Client MAY supply it and the Printer SHOULD support it. The value specifies the natural language of the Document content, for those Document formats that need a natural language specified in order to image the Document properly. 🌍job-k-octets(integer(0:MAX)) 📏: the Client MAY supply it and the Printer SHOULD support it. The Client-suppliedjob-k-octetsoperation attribute says the total size of the Document(s) being submitted, in K octets (see Section 5.3.17.1 for the complete semantics). If the Client supplies it and the Printer supports it, the value is used to fill in the Job'sjob-k-octetsJob Description attribute.
For this attribute and the next two (job-impressions and job-media-sheets), here's the rule of thumb: if the Client supplies the attribute but the Printer doesn't support it, the Printer ignores the Client's value. If the Client supplies it and the Printer supports it, AND the value is within the range of the matching Printer's xxx-supported attribute, the Printer MUST use the value to fill in the Job's xxx attribute. If the Client supplies it and the Printer supports it, BUT the value is outside the range of the matching Printer's xxx-supported attribute, the Printer MUST copy the attribute and its value into the Unsupported Attributes group, reject the request, and return the 'client-error-attributes-or-values-not-supported' status-code. 🚫 If the Client doesn't supply the attribute, the Printer SHOULD fill in the matching Job attribute, as long as it supports the attribute and can work out or figure out the right value. 🧮
job-impressions(integer(0:MAX)) 🖨️: the Client MAY supply it and the Printer SHOULD support it. The Client-suppliedjob-impressionsoperation attribute identifies the total size, in number of Impressions, of the Document(s) being submitted (see Section 5.3.17.2 for the complete semantics).
See the last paragraph under "job-k-octets" for the rules, same vibe 💅
job-media-sheets(integer(1:MAX)) 📄: the Client MAY supply it and the Printer SHOULD support it. The Client-suppliedjob-media-sheetsoperation attribute identifies the total number of Media Sheets to be produced for this Job (see Section 5.3.17.3 for the complete semantics).
See the last paragraph under "job-k-octets" for the rules 🫶
Group 2: Job Template Attributes 🎨
The Client MAY supply a set of Job Template attributes, as defined in Section 5.2. If the Client isn't sending any Job Template attributes in the request, the Client SHOULD omit Group 2 rather than sending an empty group. HOWEVER, a Printer MUST be able to accept an empty group, so it's all good either way 🥰
Group 3: Document Data 📦
The Client MUST supply the Document data to be processed. no data, no print, bestie 🖨️💨
The simplest Print-Job request is just the attributes-charset and attributes-natural-language operation attributes, the printer-uri target operation attribute, and the Document data. in this minimal case, the Printer:
- creates a new Job containing a single Document,
- stores a generated Job name in the
job-nameattribute, in the natural language and charset that were requested (see Section 4.1.4.1). (if those are supported; otherwise, it uses the Printer's default natural language and charset), and - at Job processing time, uses its matching default value attributes for the supported Job Template attributes that the Client didn't supply as an IPP attribute or as embedded instructions in the Document data. main character energy from the Printer, no notes 🌸👑
4.2.1.2. Print-Job Response 🎀
okay so the Printer MUST send the Client these sets of attributes in the Print-Job response 💖
Group 1: Operation Attributes
Natural Language and Character Set: ✨ the attributes-charset and attributes-natural-language attributes, as described in Section 4.1.4.2.
Status Message: 💅 every response has a REQUIRED status-code, and on top of that the response MAY include a status-message (text(255)) and/or a detailed-status-message (text(MAX)) operation attribute. Those are explained in Appendix B and Section 4.1.6. Now the drama 😭: if the Client sends unsupported or conflicting Job Template attributes or values, the Printer MUST either reject or accept the Print-Job request. Which one depends on whether the Client set ipp-attribute-fidelity to 'true' or 'false'. For help with handling Job Creation requests, check the Implementor's Guides [RFC3196] [PWG5100.19] 📚🫶
Group 2: Unsupported Attributes
🧚 Section 4.1.7 explains how to return unsupported attributes.
the value of ipp-attribute-fidelity that the Client sends does not change which attributes the Printer puts in this group 🙈 it only decides whether the Print-Job operation gets accepted or rejected. If the Job is accepted, the Client can ask about it with the Get-Job-Attributes operation. It should request the unsupported attributes that came back in the Print-Job response. That way it can see which ones were ignored (not stored in the Job) and which ones were stored with other, substituted values 🔍💜
Group 3: Job Attributes
job-id (integer(1:MAX)): 🆔 the Printer MUST return the Job's ID in the REQUIRED job-id Job attribute. The Client pairs this job-id with the printer-uri from the Print-Job request whenever it talks to the Job 🎯
job-uri (uri): 🔗 the Printer MUST return the Job's URI, which means sending back the contents of the REQUIRED job-uri Job attribute.
job-state (type1 enum): 🚦 the Printer MUST return the REQUIRED job-state attribute. This attribute together with job-state-reasons makes a "snapshot" of the new Job's state at the moment the Printer sends the response 📸
job-state-reasons (1setOf type2 keyword): 🧾 the Printer MUST return the REQUIRED job-state-reasons attribute.
job-state-message (text(MAX)): 💬 the Printer SHOULD return the RECOMMENDED job-state-message attribute. If the Printer supports this attribute, it MUST come back in the response. If it doesn't show up in the response, the Client can assume the attribute isn't supported and won't show up in a later Job query 🙅♀️
number-of-intervening-jobs (integer(0:MAX)): 🔢 the Printer SHOULD return the RECOMMENDED number-of-intervening-jobs attribute. If the Printer supports it, it MUST be returned in the response. If it's missing from the response, the Client can assume the attribute isn't supported and won't be in a later Job query 🫠
Note: any Printer state that affects a Job's state already shows up injob-stateandjob-state-reasons. So it's enough to return just those two, with no extra Printer Status attributes. Iconic efficiency 👑
Note: the simplest response has just theattributes-charsetandattributes-natural-languageoperation attributes, plus thejob-uri,job-id, andjob-stateJob attributes. In that simplest case the status-code issuccessful-ok, and there's nostatus-messageordetailed-status-messageoperation attribute. Minimal and perfect 🌸
4.2.2. Print-URI Operation 🦋
this operation is OPTIONAL 🫧 It works exactly like the Print-Job operation (Section 4.2.1), with one difference: instead of sending the Document data itself, the Client gives a URI reference to the Document data using the document-uri (uri) operation attribute, which lives in Group 1. Before the Printer sends its response, it MUST check that it supports the retrieval method implied by the URI (like 'http', 'ftp', and so on), and it MUST check that the URI syntax is valid 🕵️♀️ If the Client's URI scheme isn't supported (meaning it isn't in the Printer's referenced-uri-scheme-supported attribute), the Printer MUST reject the request and return the client-error-uri-scheme-not-supported status-code 🚫
The Printer MAY check whether the Document can be accessed, either during the operation or later on 👀 If the Printer finds an access problem before it sends an operation response, it MUST reject the request and return the client-error-document-access-error status-code. The Printer MAY also return a specific Document access error code in the document-access-error operation attribute (see Section 4.1.6.4) 🥺
Now, if the Printer finds this Document access problem after it already accepted the request and sent back a response with one of the successful status-code values, it MUST add the document-access-error value to the Job's job-state-reasons attribute. It MAY also fill in the Job's job-document-access-errors Job Status attribute (see Section 5.3.11). For help with handling Job Creation requests, check the Implementor's Guides [RFC3196] [PWG5100.19] 📚
If the Printer supports this operation, it MUST support the reference-uri-schemes-supported Printer attribute (see Section 5.4.27) 🧩
Last bit: it's up to the Printer to read the URI and then "pull" the Document data from whatever source the URI points to 🧲✨
4.2.3. Validate-Job Operation 🔍
this one is REQUIRED 💜 It's similar to Print-Job (Section 4.2.1), except the Client sends no Document data, and the Printer allocates no resources. That means it doesn't create a new Job at all. The whole point is to check the Printer's capabilities against whatever attributes the Client supplies in the Validate-Job request. With Validate-Job, a Client can find out whether an identical Job Creation request (one that includes the Document data) would be accepted. Validate-Job also runs the same security negotiation as Print-Job, Print-URI, and Create-Job (see Section 9), so the Client can confirm that its security requirements and the Printer's can be met before it sends a Job Creation request 🔐🫶
Validate-Job doesn't accept a document-uri attribute. That lets a Client check whether the same Print-URI operation would be accepted, since with Print-URI the Client doesn't send the data either 🙃 The Client SHOULD just send the Print-URI request.
The Printer returns the same status-code values, Operation Attributes (Group 1), and Unsupported Attributes (Group 2) as Print-Job does. The only difference is that no Job Attributes (Group 3) come back, because no Job gets created 🫧
4.2.4. Create-Job Operation 🧚
this operation is RECOMMENDED 💅 It's similar to Print-Job (Section 4.2.1), except that in a Create-Job request the Client sends neither Document data nor any reference to Document data. The Client also leaves out the document-name, document-format, compression, and document-natural-language operation attributes. After Create-Job, the Client follows up with one or more Send-Document or Send-URI operations. In each of those requests, the Client MAY supply the document-name, document-format, and document-natural-language attributes for each Document in the Job 📄
If a Printer supports Create-Job, it MUST also support Send-Document. If it supports both Create-Job and Print-URI, it MUST also support Send-URI 🔁
If the Printer supports this operation, it MUST support the multiple-operation-time-out Printer attribute (see Section 5.4.31) ⏰
If the Printer supports this operation, it MUST support the multiple-document-jobs-supported Printer Description attribute (see Section 5.4.16) and say whether it supports multiple Documents in a Job 📚
If the Printer supports this operation and supports multiple Documents in a Job, it MUST support the multiple-document-handling Job Template attribute with at least one value (see Section 5.2.4). It also has to support the associated multiple-document-handling-default and multiple-document-handling-supported Printer attributes (see Section 5.2) 🎀
After Create-Job finishes, the job-state value is similar to what you'd get after a Print-Job, even though no Document data has shown up yet 🫠 A Printer MAY set the job-data-insufficient value of the Job's job-state-reasons attribute, which says processing can't start until enough data arrives. When it does that, it can set job-state to either 'pending' or 'pending-held'. A non-spooling Printer that doesn't implement the 'pending' Job state can set job-state to 'processing', even though there's no data to process yet. See Sections 5.3.7 and 5.3.8 🌈
4.2.5. Get-Printer-Attributes Operation 💖
this one is REQUIRED and it's the "tell me about yourself" request 🪞 The Client asks for the values of a Printer's attributes. In the request, it lists the Printer attribute names and/or attribute group names it wants. The Printer answers with a matching attribute set, with the right values filled in ✨
For Printers, the possible attribute group names are:
- 'job-template': the subset of Job Template attributes that apply to a Printer (the last two columns of Table 8 in Section 5.2) that the implementation supports for Printers.
- 'printer-description': the subset of the attributes specified in Section 5.4 that the implementation supports for Printers.
- 'all': the special group 'all', which includes every attribute the implementation supports for Printers.
Since a Client MAY ask for specific attributes or named groups, some requests will overlap 👯 For example, if a Client asks for 'printer-name' and 'all', it's actually requesting the printer-name attribute twice: once by name, and once because it's in the 'all' group. In cases like that, the Printer sends each attribute back only once, even if it was requested more than once 🙌 The Client SHOULD NOT ask for the same attribute in multiple ways 🙅♀️
Printers MUST support all group names and MUST return every supported attribute that belongs to the group 💅👑
4.2.5.1. Get-Printer-Attributes Request
okay bestie, here's everything that goes into the Get-Printer-Attributes request 💅✨ the sets of attributes are organized into groups 🎀
Group 1: Operation Attributes 🌸
Natural Language and Character Set: the "attributes-charset" and "attributes-natural-language" attributes, described in Section 4.1.4.1 🗣️
Target: the "printer-uri" (uri) operation attribute. it's the target for this operation, as described in Section 4.1.5 🎯
Requesting User Name: the "requesting-user-name" (name(MAX)) attribute SHOULD be supplied by the Client, as described in Section 9.3 🫶
"requested-attributes" (1setOf keyword): the Client MAY supply a set of attribute names and/or attribute group names whose values the requester is interested in 👀 the Printer MUST support this attribute. if the Client leaves it out, the Printer MUST respond as if it had been supplied with a value of 'all' 🌈
"document-format" (mimeMediaType): this one is so useful, no cap 🧚 the Client MAY supply it and the Printer MUST support it. it helps a Client figure out which supported attribute values relate to the Document format it's asking about. the Printer MUST return the attributes and values it uses to validate a Job in a Job Creation or Validate-Job operation where this Document format is supplied. the Printer SHOULD return only (1) the attributes that are supported for the specified format and (2) the attribute values that are supported for that Document format 💖 so the Client can basically get the Printer to filter out the stuff that doesn't work for one specific format, which is iconic ✨
for example, a Printer might have multiple interpreters, one for 'application/postscript' (PostScript) and one for 'text/plain' (text) Documents. but only one of those interpreters might support the "number-up" Job Template attribute with values of '1', '2', and '4'. the other interpreter might only handle '1' 🙈 so a Client can use Get-Printer-Attributes to see the attributes and values that will be used to accept or reject a Job Creation request. main character energy 👑
if the Printer does NOT distinguish between different sets of supported values for each Document format when validating Jobs in the Create-Job, Print-Job, Print-URI, and Validate-Job operations, then it MUST NOT distinguish between Document formats in the Get-Printer-Attributes operation. wait, I mean, the MUST NOT is there for a reason, so keep it consistent 😭 hmm, let me say it cleanly: if the Printer does distinguish between sets of supported values per Document format, that specialization applies ONLY to these Printer attributes:
- Printer attributes that are Job Template attributes (
"xxx-default","xxx-supported", and"xxx-ready") (see Table 8 in Section 5.2) 🍓 "pdl-override-supported"🎀"compression-supported"🦋"job-k-octets-supported"🌸"job-impressions-supported,🧚"job-media-sheets-supported"💜"printer-driver-installer"⭐"color-supported", and 🌈"reference-uri-schemes-supported"
the values of ALL other Printer attributes (including "document-format-supported") stay the same no matter what Document format the Client supplies. the only exception is new Printer Description attributes registered according to Section 7.2 🔥
if the Client leaves out the "document-format" operation attribute, the Printer MUST respond as if the attribute had been supplied with the value of the Printer's "document-format-default" attribute 🫠 clients SHOULD always supply a value for "document-format", bestie, because the Printer's "document-format-default" value can be 'application/octet-stream'. in that case the returned attributes and values are for the union of the Document formats the Printer can automatically sense 🌀 for more details, check the description of the 'mimeMediaType' attribute syntax in Section 5.1.10 📖
if the Client supplies a "document-format" value that the Printer does NOT support (aka it's not among the values of the Printer's "document-format-supported" attribute), the Printer MUST reject the operation and return the 'client-error-document-format-not-supported' status-code. rip to that request 💀
4.2.5.2. Get-Printer-Attributes Response
the Printer returns these sets of attributes as part of the Get-Printer-Attributes response 📬
Group 1: Operation Attributes 🌷
Natural Language and Character Set: the "attributes-charset" and "attributes-natural-language" attributes, described in Section 4.1.4.2 🌍
Status Message: on top of the REQUIRED status-code that comes back in every response, the response MAY include a "status-message" (text(255)) and/or a "detailed-status-message" (text(MAX)) operation attribute, as described in Appendix B and Section 4.1.6 💬
Group 2: Unsupported Attributes 🙅♀️
see Section 4.1.7 for details on returning unsupported attributes 📚
the response MAY contain the "requested-attributes" operation attribute with any supplied values (attribute keywords) that the Client asked for but that the Printer doesn't support 🫣 if the Printer DOES return unsupported attributes referenced in "requested-attributes", and that attribute included group names (like 'all'), then the unsupported attributes MUST NOT include attributes that are described in this document but not supported by the implementation. no sneaky padding allowed 🙅♀️✨
Group 3: Printer Attributes 🖨️
this is the set of requested attributes and their current values 💕 the Printer ignores (doesn't respond with) any requested attribute that isn't supported. the Printer MAY respond with a subset of the supported attributes and values, depending on the security policy in force 🔐 but the Printer MUST respond with the 'unknown' value for any supported attribute (including ALL REQUIRED attributes) whose value it doesn't know. and the Printer MUST respond with 'no-value' for any supported attribute (including all REQUIRED attributes) that the Administrator hasn't configured a value for 🙈 see the description of the "out-of-band" values at the beginning of Section 5.1 for more 🧚
4.2.6. Get-Jobs Operation
this REQUIRED operation lets a Client retrieve the list of Jobs that belong to the target Printer 📋 the Client can also supply a list of Job attribute names and/or attribute group names, and a group of Job attributes gets returned for each Job that comes back 🎀
this is basically similar to the Get-Job-Attributes operation, except Get-Jobs returns attributes from possibly MORE than one Job 🌈
⚠️ tiny reminder: "REQUIRED" here means this operation is one the Printer has to have, so don't skip it when you're building your implementation 🫶
4.2.6.1. Get-Jobs Request
the Client submits the Get-Jobs request to a Printer 📨
the following groups of attributes are part of the Get-Jobs request:
Group 1: Operation Attributes 🌸
Natural Language and Character Set: the "attributes-charset" and "attributes-natural-language" attributes, described in Section 4.1.4.1 🗣️
Target: the "printer-uri" (uri) operation attribute. it's the target for this operation, as described in Section 4.1.5 🎯
Requesting User Name: the "requesting-user-name" (name(MAX)) attribute SHOULD be supplied by the Client, as described in Section 9.3 🫶
"limit" (integer(1:MAX)): the Client MAY supply it and the Printer MUST support it 🧮 this is an integer that sets the maximum number of Jobs a Client will receive from the Printer, even if "which-jobs" or "my-jobs" (described below) already constrain which Jobs get returned. it's a "stateless limit", which means if the Client supplies 'N', then only the first 'N' Jobs come back in the Get-Jobs response ✂️ if the Client doesn't supply this attribute, the Printer responds with all applicable Jobs 💖
"requested-attributes" (1setOf type2 keyword): the Client MAY supply it and the Printer MUST support it 👀 it's a set of Job attribute names and/or attribute group names whose values the requester cares about. this set gets returned for EACH Job that comes back. the allowed attribute group names are the same ones defined in the Get-Job-Attributes operation in Section 4.3.4 🍓 if the Client doesn't supply this attribute, the Printer MUST respond as if the Client had supplied it with two values: "job-uri" and "job-id" 🦋
"which-jobs" (type2 keyword): the Client MAY supply it and the Printer MUST support it 🔍 this one says which Jobs MUST be returned by the Printer. the values include:
'completed': any Job whose state is'completed','canceled', or'aborted'✅'not-completed': any Job whose state is'pending','processing','processing-stopped', or'pending-held'⏳
a Printer MUST support BOTH values 🫶 however, if the implementation doesn't keep Jobs in the 'completed', 'canceled', and 'aborted' states, then it returns no Jobs when 'completed' is supplied 🤷♀️
if a Client supplies some OTHER value that the Printer doesn't support, the Printer MUST copy the attribute and the unsupported value to the Unsupported Attributes group, reject the request, and return the 'client-error-attributes-or-values-not-supported' status-code 😭 that's a lot of steps, but the Printer has to do all of them 🫠
if the Client does NOT supply this attribute, the Printer MUST respond as if the Client had supplied it with a value of 'not-completed' 🌙
"my-jobs" (boolean): the Client MAY supply it and the Printer MUST support it 🧑💻 this one says whether Jobs from ALL users or just the Jobs submitted by the requesting user of this request MUST be considered as candidate Jobs to be returned by the Printer. if the Client doesn't supply it, the Printer MUST respond as if the Client had supplied it with a value of 'false', meaning Jobs from all users 🌍 the means for authenticating the requesting user and matching the Jobs is described in Section 9 🔐 iykyk, security is always the final boss 👑
4.2.6.2. Get-Jobs Response 💅
okay so the Printer sends back all the Jobs up to the number set in the limit attribute that match what the Client asked for in the request 🎀 it's totally possible to get zero Jobs back, bestie, because there can literally be no Jobs at the Printer, or there can be no Jobs that fit the criteria the Client gave. if the Client requests any Job attributes at all, you get one set of Job Attributes for each Job 🫶
zero Jobs is NOT an error 😭 if you get 0 Jobs because nothing matches, and the request would have returned some Jobs with a status-code of successful-ok if there had been matches, then the status-code for 0 Jobs MUST be successful-ok 💖
Group 1: Operation Attributes 🌸
Natural Language and Character Set:
The attributes-charset and attributes-natural-language attributes, as described in Section 4.1.4.2. ✨
Status Message:
okay this one's giving extra info 💅 on top of the REQUIRED status-code that shows up in every response, the response MAY include a status-message (text(255)) and/or a detailed-status-message (text(MAX)) operation attribute, as described in Appendix B and Section 4.1.6 🦋
Group 2: Unsupported Attributes 🙈
See Section 4.1.7 for the details on returning unsupported attributes 🍓
the response MAY contain the requested-attributes operation attribute with any supplied values (attribute keywords) that the Client asked for but the Printer doesn't support 💜 and if the Printer does return unsupported attributes referenced in requested-attributes, and that attribute included group names like all, then the unsupported attributes MUST NOT include attributes described in this document but not supported by the implementation. no cap, that's a whole rule 👑
Groups 3 to N: Job Attributes 🧚
the Printer responds with one set of Job Attributes for each returned Job 🌈 it ignores (doesn't respond with) any requested attribute or value that isn't supported, or that's restricted by the security policy in force, including whether the requesting user is the user who submitted the Job (Job-originating user) or not (see Section 9) 🔥 BUT the Printer MUST respond with the unknown value for any supported attribute (including all REQUIRED attributes) whose value it doesn't know, unless that would violate the security policy. see the description of the "out-of-band" values at the beginning of Section 5.1 ⭐
the Jobs come back in this order:
- If the Client requests all
completedJobs (Jobs in thecompleted,aborted, orcanceledstates), then the Jobs are returned newest to oldest (with respect to actual completion time). 💖 - If the Client requests all
not-completedJobs (Jobs in thepending,processing,pending-held, andprocessing-stoppedstates), then Jobs are returned in relative chronological order of expected time to complete (based on whatever scheduling algorithm is configured for the Printer). 🫶
4.2.7. Pause-Printer Operation ⏸️💅
this OPTIONAL operation lets a Client stop the Printer from scheduling Jobs on all its devices 🦋 depending on the implementation, the Pause-Printer operation MAY also stop the Printer from processing the current Job or Jobs. any Job that's currently printing is either (1) stopped as soon as the implementation permits or (2) completed, depending on the implementation 🌸 the Printer MUST still accept Job Creation requests to create new Jobs, but it MUST prevent any Jobs from entering the processing state 🙅♀️
if the Pause-Printer operation is supported, then the Resume-Printer operation MUST be supported too, and vice versa. two-way street, periodt 💜
the IPP Printer stops the current Job(s) on its device or devices that were in the processing or processing-stopped state as soon as the implementation permits 🔥 if the implementation will take appreciable time to stop, the IPP Printer adds the moving-to-paused value to the Printer's printer-state-reasons attribute (see Section 5.4.12) ⭐ when the device or devices have all stopped, the IPP Printer transitions the Printer to the stopped state, removes the moving-to-paused value if it's present, and adds the paused value to the Printer's printer-state-reasons attribute 🎀
when the current Job or Jobs that were in the processing state complete, the IPP Printer transitions them to the completed state 🌈 when the current Job or Jobs stop in mid-processing (they were in the processing state), the IPP Printer transitions them to the processing-stopped state and adds the printer-stopped value to the Jobs' job-state-reasons attribute 🧚
for any Jobs that are pending or pending-held, the printer-stopped value of the Jobs' job-state-reasons attribute also applies. HOWEVER, the IPP Printer MAY update those Jobs' job-state-reasons values when those Jobs are queried (so-called "lazy evaluation") 🦥💖
the IPP Printer MUST accept the request in any state, and transition the Printer to the indicated new printer-state before returning, as shown in Table 2 📊✨
Access Rights: the authenticated user (see Section 9.3) performing this operation MUST be an Operator or Administrator of the Printer (see Sections 1 and 9.5) 👑 otherwise, the IPP Printer MUST reject the operation and return client-error-forbidden, client-error-not-authenticated, or client-error-not-authorized, as appropriate 🚫
+--------------+--------------+-----------------+-------------------+
| Current | New | "printer-state- | IPP Printer's |
| "printer- | "printer- | reasons" | response status- |
| state" | state" | | code and action: |
+--------------+--------------+-----------------+-------------------+
| 'idle' | 'stopped' | 'paused' | 'successful-ok' |
+--------------+--------------+-----------------+-------------------+
| 'processing' | 'processing' | 'moving-to- | Option 1: |
| | | paused' | 'successful-ok'; |
| | | | Later, when all |
| | | | output has |
| | | | stopped, the |
| | | | "printer-state" |
| | | | becomes |
| | | | 'stopped', and |
| | | | the 'paused' |
| | | | value replaces |
| | | | the 'moving-to- |
| | | | paused' value in |
| | | | the "printer- |
| | | | state-reasons" |
| | | | attribute |
+--------------+--------------+-----------------+-------------------+
| 'processing' | 'stopped' | 'paused' | Option 2: |
| | | | 'successful-ok'; |
| | | | all device output |
| | | | stopped |
| | | | immediately |
+--------------+--------------+-----------------+-------------------+
| 'stopped' | 'stopped' | 'paused' | 'successful-ok' |
+--------------+--------------+-----------------+-------------------+
Table 2: Pause-Printer State Transitions4.2.7.1. Pause-Printer Request 📨
these are the groups of attributes that make up the Pause-Printer request 💌
Group 1: Operation Attributes 🎀
Natural Language and Character Set:
The attributes-charset and attributes-natural-language attributes, as described in Section 4.1.4.1. ✨
Target:
The printer-uri (uri) operation attribute, which is the target for this operation as described in Section 4.1.5. 🎯
Requesting User Name:
The requesting-user-name (name(MAX)) attribute SHOULD be supplied by the Client, as described in Section 9.3. 🫶
4.2.7.2. Pause-Printer Response 📬
these are the groups of attributes that make up the Pause-Printer response 🌷
Group 1: Operation Attributes 🎀
Natural Language and Character Set:
The attributes-charset and attributes-natural-language attributes, as described in Section 4.1.4.2. ✨
Status Message:
on top of the REQUIRED status-code returned in every response, the response MAY include a status-message (text(255)) and/or a detailed-status-message (text(MAX)) operation attribute, as described in Appendix B and Section 4.1.6 🦋
Group 2: Unsupported Attributes 🙈
See Section 4.1.7 for details on returning unsupported attributes 🍓
4.2.8. Resume-Printer Operation ✨
okay so this one is the "unpause" button bestie 💖 This operation is OPTIONAL 🎀, and it lets a Client tell the Printer to start scheduling Jobs again on all its devices. The Printer MUST remove the paused and moving-to-paused values from the Printer's printer-state-reasons attribute, if they're there 🌸. If there are no other reasons to keep a device paused (like a media jam 😭), the IPP Printer is free to switch itself to the processing or idle state, depending on whether there are Jobs waiting or not, and the device(s) get back to work 💅.
If the Pause-Printer operation is supported, then the Resume-Printer operation MUST be supported too, and vice versa 🫶. They're a matching set, no exceptions 👑.
The IPP Printer removes the printer-stopped value from any Job's job-state-reasons attributes contained in that Printer 🦋.
The IPP Printer MUST accept the request in any state and transition the Printer to the indicated new state as shown in Table 3 🔥. The table is the whole tea ☕:
+-----------------+-----------------+-------------------------------+
| Current | New "printer- | IPP Printer's response |
| "printer-state" | state" | status-code and action: |
+-----------------+-----------------+-------------------------------+
| 'idle' | 'idle' | 'successful-ok' |
+-----------------+-----------------+-------------------------------+
| 'processing' | 'processing' | 'successful-ok' |
+-----------------+-----------------+-------------------------------+
| 'stopped' | 'processing' | 'successful-ok', when there |
| | | are Jobs to be processed |
+-----------------+-----------------+-------------------------------+
| 'stopped' | 'idle' | 'successful-ok', when there |
| | | are no Jobs to be processed |
+-----------------+-----------------+-------------------------------+Table 3: Resume-Printer State Transitions 📋
Access Rights: The authenticated user (see Section 9.3) performing this operation MUST be an Operator or Administrator of the Printer (see Sections 1 and 9.5) 🔐. Otherwise, the IPP Printer MUST reject the operation and return client-error-forbidden, client-error-not-authenticated, or client-error-not-authorized, whichever fits 🙅♀️. Not everyone gets to hit resume, babe 💀.
The Resume-Printer request and Resume-Printer response have the same attribute groups and attributes as the Pause-Printer operation (see Sections 4.2.7.1 and 4.2.7.2) 🧚. Same vibe, same outfit ✨.
4.2.9. Purge-Jobs Operation 🗑️
okay this one is giving DEPRECATED energy 💀, and it's a bit of a drama queen. This operation lets a Client remove all Jobs from a Printer, no matter what their Job states are, including the ones sitting in the Printer's Job History (see Section 5.3.7.2) 🌪️. After a Purge-Jobs operation has been performed, a Printer MUST return no Jobs in subsequent Get-Job-Attributes and Get-Jobs responses (until new Jobs are submitted) 🫥. Totally wiped, no cap 🧹.
Note: This operation SHOULD NOT be supported in new implementations, since it destroys Printer accounting information 🚫📊. Bestie, don't be the one who nukes the accounting data 😭.
Whether the Purge-Jobs (and Get-Jobs) operation affects Jobs that were submitted to the device from sources other than the IPP Printer in the same way that the Purge-Jobs operation affects Jobs submitted to the IPP Printer using IPP depends on implementation 🤷♀️. It's about whether IPP is being used as a universal management protocol or just to manage IPP Jobs, respectively 🧐. Implementation-dependent, babe 🌈.
Note: If an Operator wants to cancel all Jobs without clearing out the Job History, the Operator uses the Cancel-Job operation on each Job instead of using the Purge-Jobs operation 🙌. Main character move, keeping the history 📜.
If this OPTIONAL operation is supported, the Printer MUST accept this operation in any state and transition the Printer to the idle state 💜.
Access Rights: The authenticated user (see Section 9.3) performing this operation MUST be an Operator or Administrator of the Printer (see Sections 1 and 9.5) 🔐. Otherwise, the Printer MUST reject the operation and return client-error-forbidden, client-error-not-authenticated, and client-error-not-authorized as appropriate 🙅♀️.
The Purge-Jobs request and Purge-Jobs response have the same attribute groups and attributes as the Pause-Printer operation (see Sections 4.2.7.1 and 4.2.7.2) 🧚.
4.3. Job Operations 🎀
okay the Job operations are all about the Jobs 🧁 ngl. Every single one is directed at a Job, so a Client MUST always supply some way of identifying the Job object 🔍, so the Printer knows exactly what to target. That Job identification SHOULD be the combination of a Printer URI with a Job ID 💖, but it MAY be the (single) Job URI 🦋. The IPP implementation MUST support both forms of identification for every Job 👑. Both ways, every time 💅.
4.3.1. Send-Document Operation 📄
This RECOMMENDED operation lets a Client add a Document to a Job that was created using the Create-Job operation 💌. In the Create-Job response, the Printer hands back the Job's URI (the "job-uri" attribute) and the Job's 32-bit identifier (the "job-id" attribute) 🪪. For each new Document the Client wants to add, the Client uses a Send-Document operation 📨. Each Send-Document request carries the entire stream of Document data for one Document 🌊.
If the Printer supports this operation but does not support multiple Documents per Job, the Printer MUST reject subsequent Send-Document operations supplied with data and return the server-error-multiple-document-jobs-not-supported status-code 🙅♀️. However, the Printer MUST accept the first Document with a 'true' or 'false' value for the "last-document" operation attribute (see below) ✨, so that Clients MAY always submit one Document Job with a 'false' value for "last-document" in the first Send-Document and a 'true' value for "last-document" in the second Send-Document (with no data) 🧩. Little trick, big brain 🧠.
Since the Create-Job and the send operations (Send-Document or Send-URI operations) that follow could happen over an arbitrarily long period of time for a particular Job ⏳, a Client MUST send another send operation within a minimum time interval, as defined by the IPP Printer, after receiving the previous request for the Job ⏰. If a Printer supports the Create-Job and Send-Document operations, the Printer MUST support the "multiple-operation-time-out" attribute (see Section 5.4.31) ⏱️. This attribute shows the minimum number of seconds the Printer will wait for the next send operation before taking some recovery action 🫡. Don't ghost the Printer, bestie 👻.
A Printer MUST recover from an errant Client that doesn't supply a send operation, sometime after the minimum time interval set by the Printer's "multiple-operation-time-out" attribute 🧹. Such recovery MAY include any of the following actions or other recovery actions 🛠️:
- Assume that the Job is an invalid Job, start the process of changing the Job state to 'aborted', add the 'aborted-by-system' value to the Job's "job-state-reasons" attribute (see Section 5.3.8), and clean up all resources tied to the Job 🗑️. In this case, if another send operation finally shows up, the Printer responds with a 'client-error-not-possible' or 'client-error-not-found' status-code, depending on whether the Job is still around when that send operation arrives 👀. Too late, babe 💀.
- Assume that the last send operation received was in fact the last Document (as if the "last-document" flag had been set to 'true'), close the Job, and go ahead and process it (i.e., move the Job's state to 'pending') 🚀. Vibes say it's done 💅.
- Assume that the last send operation received was in fact the last Document and close the Job, but move it to the 'pending-held' state and add the 'submission-interrupted' value to the Job's "job-state-reasons" attribute (see Section 5.3.8) 🫧. This gives the user or an Operator the chance to decide: keep processing by moving the Job back to the 'pending' state with the Release-Job operation (see Section 4.3.6), or cancel it with the Cancel-Job operation (see Section 4.3.3) 🤔. Their call, queen 👑.
Each implementation is free to decide the "best" action to take 🧠, depending on the following: local policy, whether any Documents have been added, whether the implementation spools Jobs or not, and/or any other piece of information it has access to 📚. If the choice is to abort the Job, it's possible that the Job has already been processed to the point that some Media Sheet pages have been printed 🖨️😬. Oof, those poor pages 📄💔.
Access Rights: The authenticated user (see Section 9.3) performing this operation must be either the Job owner (as determined in the Create-Job operation) or an Operator or Administrator of the Printer (see Sections 1 and 9.5) 🔐. Otherwise, the Printer MUST reject the operation and return client-error-forbidden, client-error-not-authenticated, or client-error-not-authorized as appropriate 🙅♀️.
4.3.1.1. Send-Document Request ✨
okay so the Send-Document request is made up of these attribute groups, bestie 💅
Group 1: Operation Attributes 🎀
Natural Language and Character Set: 🌸
The attributes-charset and attributes-natural-language attributes, described in Section 4.1.4.1.
Target: 🦋
Either the printer-uri (uri) plus job-id (integer(1:MAX)), or the job-uri (uri) operation attribute(s). These define the target for this operation, as described in Section 4.1.5. 🎯
Requesting User Name: 🫶
The requesting-user-name (name(MAX)) attribute SHOULD be supplied by the Client, as described in Section 9.3. Like, you really should send it 🙈
"document-name" (name(MAX)): 💖
The Client MAY supply this one, and the Printer MUST support it. It holds the Client-supplied Document name. The Document name MAY be different from the Job name, and it is not guaranteed to be unique across multiple Documents in the same Job. Usually the Client software fills this in for the End User by using a file name or an application-generated name. For more on this attribute, check out the Print-Job request in Section 4.2.1.1, where it's described in more detail. 📄
"compression" (type2 keyword): 🗜️
See the description of "compression" for the Print-Job operation in Section 4.2.1.1. Same vibe, different op 🔁
"document-format" (mimeMediaType): 📑
See the description of "document-format" for the Print-Job operation in Section 4.2.1.1. Again, go look there 👀
"document-natural-language" (naturalLanguage): 🌍
The Client MAY supply this, and the Printer MAY support it. It specifies the natural language of the Document content, for those Document formats that need the natural language specified in order to image the Document properly. ✨
"last-document" (boolean): 🏁
The Client MUST supply this, and the Printer MUST support it. It's a boolean flag. It is set to 'true' if this is the last Document for the Job, and otherwise it is set to 'false'. This one is non-negotiable, bestie 😤
Group 2: Document Data 📦
The Client MUST supply the Document data if the "last-document" flag is set to 'false'. BUT, since a Client might not know that the previous Document sent with a Send-Document (or Send-URI) operation was the last one (meaning its "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'. A request like that MUST NOT increment the value of the Job's "number-of-documents" attribute, since no real Document was added to the Job. 🙅♀️ It's not an error for a Client to submit a Job with no actual Document data. Like, you can literally just send a single Create-Job and Send-Document request, with a "last-document" operation attribute set to 'true' and no Document data at all. Wild, but valid 💀🌈
4.3.1.2. Send-Document Response 🎀
The following sets of attributes are part of the Send-Document response:
Group 1: Operation Attributes 🌷
Natural Language and Character Set: 🌸
The attributes-charset and attributes-natural-language attributes, described in Section 4.1.4.2.
Status Message: 💬
In addition to the REQUIRED status-code that comes back in every response, the response MAY include a "status-message" (text(255)) and/or a "detailed-status-message" (text(MAX)) operation attribute, as described in Appendix B and Section 4.1.6. Extra info, if you want it 🧚
Group 2: Unsupported Attributes 🚫
See Section 4.1.7 for details on returning unsupported attributes. 🔍
Group 3: Job Object Attributes 🍓
This is the same set of attributes as the ones described in the Print-Job response (see Section 4.2.1.2). No need to reinvent the wheel, iykyk 🛞
4.3.2. Send-URI Operation 🦋
This RECOMMENDED operation is identical to the Send-Document operation (see Section 4.3.1), except that a Client MUST supply a URI reference ("document-uri" operation attribute) instead of the Document data itself. If a Printer supports this operation, Clients can use both Send-URI and Send-Document operations to add new Documents to an existing Job. 🧩 However, if a Client needs to indicate that the previous Send-URI or Send-Document was the last Document, the Client MUST use the Send-Document operation with no Document data and the "last-document" flag set to 'true'. It MUST NOT be done with a Send-URI operation that has no "document-uri" operation attribute. Not that 🙅♀️
If a Printer supports this operation, it MUST also support the Print-URI operation (see Section 4.2.2). Bestie rule, no exceptions 📜
The Printer MUST validate the syntax and URI scheme of the supplied URI before returning a response, just like in the Print-URI operation. The Printer MAY validate the accessibility of the Document as part of the operation, or do it later (see Section 4.2.2). Timing is flexible, but the syntax check is not 🕰️✨
4.3.3. Cancel-Job Operation 🛑
This REQUIRED operation lets a Client cancel a Print Job from the time the Job is created up until it is completed, canceled, or aborted. 💅 Since a Job might already be printing by the time a Cancel-Job arrives, some Media Sheet pages might still get printed before the Job is actually terminated. Oops 🙈🖨️
The Printer MUST accept or reject the request based on the Job's current state, and transition the Job to the indicated new state as shown in Table 4. 📊
Access Rights: The authenticated user (see Section 9.3) performing this operation must be either the Job owner, or an Operator or Administrator of the Printer (see Sections 1 and 9.5). 👑 Otherwise, the Printer MUST reject the operation and return 'client-error-forbidden', 'client-error-not-authenticated', or 'client-error-not-authorized', whichever is appropriate. No access, no cancel, period 🔒
+-------------------+--------------------+--------------------------+
| Current "job- | New "job-state" | Printer's response |
| state" | | status-code and action: |
+-------------------+--------------------+--------------------------+
| 'pending' | 'canceled' | 'successful-ok' |
+-------------------+--------------------+--------------------------+
| 'pending-held' | 'canceled' | 'successful-ok' |
+-------------------+--------------------+--------------------------+
| 'processing' | 'canceled' | 'successful-ok' |
+-------------------+--------------------+--------------------------+
| 'processing' | 'processing' | 'successful-ok' (note 1) |
+-------------------+--------------------+--------------------------+
| 'processing' | 'processing' | 'client-error-not- |
| | | possible' (note 2) |
+-------------------+--------------------+--------------------------+
| 'processing- | 'canceled' | 'successful-ok' |
| stopped' | | |
+-------------------+--------------------+--------------------------+
| 'processing- | 'processing- | 'successful-ok' (note 1) |
| stopped' | stopped' | |
+-------------------+--------------------+--------------------------+
| 'processing- | 'processing- | 'client-error-not- |
| stopped' | stopped' | possible' (note 2) |
+-------------------+--------------------+--------------------------+
| 'completed' | 'completed' | 'client-error-not- |
| | | possible' |
+-------------------+--------------------+--------------------------+
| 'canceled' | 'canceled' | 'client-error-not- |
| | | possible' |
+-------------------+--------------------+--------------------------+
| 'aborted' | 'aborted' | 'client-error-not- |
| | | possible' |
+-------------------+--------------------+--------------------------+
Table 4: Cancel-Job State TransitionsNote 1: If the implementation needs some measurable time to cancel the Job in the 'processing' or 'processing-stopped' Job state, the Printer MUST add the 'processing-to-stop-point' value to the Job's "job-state-reasons" attribute, and then transition the Job to the 'canceled' state when processing ceases (see Section 5.3.8). ⏳
Note 2: If the Job already has the 'processing-to-stop-point' value in its "job-state-reasons" attribute, then the Printer MUST reject a Cancel-Job operation. Already on its way out, so no double-cancels 🚫✋
4.3.3.1. Cancel-Job Request 📝
The following groups of attributes are part of the Cancel-Job request:
Group 1: Operation Attributes 🎀
Natural Language and Character Set: 🌸
The attributes-charset and attributes-natural-language attributes, described in Section 4.1.4.1.
Target: 🦋
Either the printer-uri (uri) plus job-id (integer(1:MAX)), or the job-uri (uri) operation attribute(s). These define the target for this operation, as described in Section 4.1.5.
Requesting User Name: 🫶
The requesting-user-name (name(MAX)) attribute SHOULD be supplied by the Client, as described in Section 9.3. Please don't skip this, it's giving accountability 💅
"message" (text(127)): 💌
The Client MAY supply this, and the Printer MAY support it. It's a message to the Operator. This "message" attribute is NOT the same as the "job-message-from-operator" attribute. That one is used to report a message from the Operator to the End User who queries it. This "message" operation attribute is used to send a message from the Client to the Operator along with the operation request. Whether or where it gets displayed to the Operator (if at all) is an implementation decision. Totally up to whoever built it 🤷♀️
4.3.3.2. Cancel-Job Response 🎀
The following sets of attributes are part of the Cancel-Job response:
Group 1: Operation Attributes 🌷
Natural Language and Character Set: 🌸
The attributes-charset and attributes-natural-language attributes, described in Section 4.1.4.2.
Status Message: 💬
In addition to the REQUIRED status-code that comes back in every response, the response MAY include a "status-message" (text(255)) and/or a "detailed-status-message" (text(MAX)) operation attribute, as described in Appendix B and Section 4.1.6. 🧚
Group 2: Unsupported Attributes 🚫
See Section 4.1.7 for details on returning unsupported attributes. 🔍
Once a successful response has been sent, the implementation guarantees that the Job will eventually end up in the 'canceled' state. 🫶 Between the time the Cancel-Job operation is accepted and the time the Job enters the 'canceled' job-state (see Section 5.3.7), the "job-state-reasons" attribute SHOULD contain the 'processing-to-stop-point' value. That value tells later queries that although the Job might still be 'processing', it will eventually end up 'canceled' and NOT 'completed' 🥺✨
4.3.4. Get-Job-Attributes Operation ✨
This REQUIRED operation lets a Client ask for the values of a Job's attributes 💅 It's basically the same vibe as Get-Printer-Attributes (see Section 4.2.5)! The differences: it's aimed at a Job instead of a Printer, there's no document-format operation attribute when you're querying a Job, and the group that comes back is a set of Job attributes instead of Printer attributes.
For Jobs, the possible attribute group names are:
job-template: the subset of the Job Template attributes that apply to a Job (the first column of Table 8 in Section 5.2) that the implementation supports for Jobs. 🎀job-description: the subset of the Job Description and Status attributes specified in Section 5.3 that the implementation supports for Jobs. 🌸all: the special groupallthat includes all attributes that the implementation supports for Jobs. 👑
Since a Client MAY request specific attributes or named groups, there's a potential for some overlap 🙈 For example, if a Client requests job-name and job-description, it's actually asking for the job-name attribute twice: once by naming it directly, and once because it's inside the job-description group. In that case the Printer returns the attribute only once in the response, even if it was requested multiple times. The Client SHOULD NOT request the same attribute in multiple ways. Don't be extra, bestie 😭
Jobs MUST support all group names and MUST return all supported attributes belonging to the group. No excuses, periodt 💖
4.3.4.1. Get-Job-Attributes Request
The following groups of attributes are part of the Get-Job-Attributes request when the request is directed at a Job:
Group 1: Operation Attributes
Natural Language and Character Set:
The attributes-charset and attributes-natural-language attributes as described in Section 4.1.4.1. 🌈
Target:
Either the printer-uri (uri) plus job-id (integer(1:MAX)), or the job-uri (uri) operation attribute(s), which define the target for this operation as described in Section 4.1.5. 🎯
Requesting User Name:
The requesting-user-name (name(MAX)) attribute SHOULD be supplied by the Client as described in Section 9.3. 🫶
requested-attributes (1setOf keyword):
The Client MAY supply and the Printer MUST support this attribute. It's 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 MUST respond as if this attribute had been supplied with a value of all. Main character energy 👑
4.3.4.2. Get-Job-Attributes Response
The Printer returns the following sets of attributes as part of the Get-Job-Attributes response:
Group 1: Operation Attributes
Natural Language and Character Set:
The attributes-charset and attributes-natural-language attributes as described in Section 4.1.4.2. The attributes-natural-language MAY be the natural language of the Job, rather than the one requested. 🦋
Status Message:
In addition to the REQUIRED status-code returned in every response, the response MAY include a status-message (text(255)) and/or a detailed-status-message (text(MAX)) operation attribute as described in Appendix B and Section 4.1.6. ✨
Group 2: Unsupported Attributes
See Section 4.1.7 for details on returning unsupported attributes.
The response MAY contain the requested-attributes operation attribute with any supplied values (attribute keywords) that were requested by the Client but are not supported by the Printer. If the Printer does return unsupported attributes referenced in the requested-attributes operation attribute and that attribute included group names, such as all, the unsupported attributes MUST NOT include attributes described in this document but not supported by the implementation. Not the over-sharing 🙅♀️
Group 3: Job Attributes
This is the set of requested attributes and their current values. The Printer ignores (does not respond with) any requested attribute or value that is not supported or that is restricted by the security policy in force, including whether the requesting user is the user that submitted the Job (Job-originating user) or not (see Section 9). However, the Printer MUST respond with the unknown value for any supported attribute (including all REQUIRED attributes) for which the Printer does not know the value, unless it would violate the security policy. See the description of the "out-of-band" values in the beginning of Section 5.1. 🔥
4.3.5. Hold-Job Operation
This OPTIONAL operation lets a Client hold a pending Job in the queue so it's not eligible for scheduling 🧚 It's like putting a Job on a little "wait, not yet" list. If the Hold-Job operation is supported, then the Release-Job operation MUST be supported, and vice versa. The OPTIONAL job-hold-until operation attribute lets a Client specify whether to hold the Job indefinitely or until a specified time period, if supported. ⭐
The Printer MUST accept or reject the request based on the Job's current state, and transition the Job to the indicated new state as shown in Table 5. 💜
Note: In order to keep the Hold-Job operation simple, such a request is rejected when the Job is in theprocessingorprocessing-stoppedstate. If an operation is needed to hold Jobs while in either of these states, it will be added as an additional operation, rather than overloading the Hold-Job operation. Then it is clear to Clients by querying the Printer'soperations-supported(see Section 5.4.15) and the Job'sjob-state(see Section 5.3.7) attributes which operations are possible. 🙈
Access Rights: The authenticated user (see Section 9.3) performing this operation must be either the Job owner or an Operator or Administrator of the Printer (see Sections 1 and 9.5). Otherwise, the Printer MUST reject the operation and return client-error-forbidden, client-error-not-authenticated, or client-error-not-authorized as appropriate. 🔒
+-------------------+--------------------+--------------------------+
| Current "job- | New "job-state" | Printer's response |
| state" | | status-code and action: |
+-------------------+--------------------+--------------------------+
| 'pending' | 'pending-held' | 'successful-ok' (note 1) |
+-------------------+--------------------+--------------------------+
| 'pending' | 'pending' | 'successful-ok' (note 2) |
+-------------------+--------------------+--------------------------+
| 'pending-held' | 'pending-held' | 'successful-ok' (note 1) |
+-------------------+--------------------+--------------------------+
| 'pending-held' | 'pending' | 'successful-ok' (note 2) |
+-------------------+--------------------+--------------------------+
| 'processing' | 'processing' | 'client-error-not- |
| | | possible' |
+-------------------+--------------------+--------------------------+
| 'processing- | 'processing- | 'client-error-not- |
| stopped' | stopped' | possible' |
+-------------------+--------------------+--------------------------+
| 'completed' | 'completed' | 'client-error-not- |
| | | possible' |
+-------------------+--------------------+--------------------------+
| 'canceled' | 'canceled' | 'client-error-not- |
| | | possible' |
+-------------------+--------------------+--------------------------+
| 'aborted' | 'aborted' | 'client-error-not- |
| | | possible' |
+-------------------+--------------------+--------------------------+
Table 5: Hold-Job State TransitionsNote 1: If the implementation supports multiple reasons for a Job to be in the pending-held state, the Printer MUST add the job-hold-until-specified value to the Job's job-state-reasons attribute. 🍓
Note 2: If the Printer supports the job-hold-until operation attribute, but the specified time period has already started (or is the no-hold value) and there are no other reasons to hold the Job, the Printer MUST make the Job be a candidate for processing immediately (see Section 5.2.2) by putting the Job in the pending state. Let it go, let it flow 🌊
4.3.5.1. Hold-Job Request
The groups and operation attributes are the same as those defined for a Cancel-Job request (see Section 4.3.3.1), with the addition of the following Group 1 operation attribute:
job-hold-until (type2 keyword | name(MAX)):
The Client MAY supply and the Printer MUST support this operation attribute in a Hold-Job request if it supports the job-hold-until Job Template attribute in Job Creation requests. See Section 5.2.2. The Printer SHOULD support the job-hold-until Job Template attribute for use in Job Creation requests with at least the indefinite value, if it supports the Hold-Job operation. Otherwise, a Client cannot create a Job and hold it immediately (without picking some supported time period in the future). 🥹
If supplied and supported as specified in the Printer's job-hold-until-supported attribute, the Printer copies the supplied operation attribute to the Job, replacing the Job's previous job-hold-until attribute, if present, and makes the Job a candidate for scheduling during the supplied named time period. 📅
If supplied but either the job-hold-until operation attribute itself or the value supplied is not supported, the Printer accepts the request, returns the unsupported attribute or value in the Unsupported Attributes group according to Section 4.1.7, returns the successful-ok-ignored-or-substituted-attributes status-code, and holds the Job indefinitely until a Client performs a subsequent Release-Job operation. 💅
If (1) the Client supplies either a value that specifies a time period that has already started or the no-hold value (meaning don't hold the Job) and (2) the Printer supports the job-hold-until operation attribute and there are no other reasons to hold the Job, the Printer MUST accept the operation and make the Job be a candidate for processing immediately (see Section 5.2.2). 🚀
If the Client does not supply a job-hold-until operation attribute in the request, the Printer MUST populate the Job with a job-hold-until attribute with the indefinite value (if the Printer supports the job-hold-until attribute) and hold the Job indefinitely, until a Client performs a Release-Job operation. Hold that thought, bestie 🧸
4.3.5.2. Hold-Job Response
The groups and attributes are the same as those defined for a Cancel-Job response (see Section 4.3.3.2). 🦋
4.3.6. Release-Job Operation ✨
okay so this one is OPTIONAL 💅 It lets a Client release a Job that was previously held, so it's eligible for scheduling again 🦋 If the Hold-Job operation is supported, then Release-Job MUST be supported, and vice versa 🫶
This operation removes the "job-hold-until" Job attribute (if it's there) from the Job that was supplied in the Create-Job or most recent Hold-Job or Restart-Job operation, and it also removes that attribute's effect on the Job 🌸 The Printer MUST remove the "job-hold-until-specified" value from the Job's "job-state-reasons" attribute, if it's present ✨ See Section 5.3.8.
The Printer MUST accept or reject the request based on the Job's current state, and move the Job to the new state shown in Table 6 💖
Access Rights: the authenticated user (see Section 9.3) doing this operation has to be either the Job owner or an Operator or Administrator of the Printer (see Sections 1 and 9.5) 🔒 Otherwise, the Printer MUST reject the operation and return 'client-error-forbidden', 'client-error-not-authenticated', or 'client-error-not-authorized', whichever fits 🙈
The Release-Job request and Release-Job response have the same attribute groups and attributes as the Cancel-Job operation (see Sections 4.3.3.1 and 4.3.3.2) 🎀
+-------------------+--------------------+--------------------------+
| Current "job- | New "job-state" | Printer's response |
| state" | | status-code and action: |
+-------------------+--------------------+--------------------------+
| 'pending' | 'pending' | 'successful-ok'. No |
| | | effect on the Job. |
+-------------------+--------------------+--------------------------+
| 'pending-held' | 'pending-held' | 'successful-ok' (note 1) |
+-------------------+--------------------+--------------------------+
| 'pending-held' | 'pending' | 'successful-ok' |
+-------------------+--------------------+--------------------------+
| 'processing' | 'processing' | 'successful-ok'. No |
| | | effect on the Job. |
+-------------------+--------------------+--------------------------+
| 'processing- | 'processing- | 'successful-ok'. No |
| stopped' | stopped' | effect on the Job. |
+-------------------+--------------------+--------------------------+
| 'completed' | 'completed' | 'client-error-not- |
| | | possible' |
+-------------------+--------------------+--------------------------+
| 'canceled' | 'canceled' | 'client-error-not- |
| | | possible' |
+-------------------+--------------------+--------------------------+
| 'aborted' | 'aborted' | 'client-error-not- |
| | | possible' |
+-------------------+--------------------+--------------------------+
Table 6: Release-Job State TransitionsNote 1: if there are other reasons to keep the Job in the 'pending-held' state, like 'resources-are-not-ready', the Job stays in 'pending-held' 🧸 So 'pending-held' isn't just for Jobs with the "job-hold-until" attribute applied. It's also used for any reason that keeps the Job from being a candidate for scheduling and processing, such as 'resources-are-not-ready'. See the "job-hold-until" attribute (Section 5.2.2) 💜
4.3.7. Restart-Job Operation 🍓
This DEPRECATED operation lets a Client restart a Job that's kept in the queue after processing has completed (see Section 5.3.7.2) 🕰️
Note: this operation SHOULD NOT be supported in new implementations, because it destroys Printer accounting information 💀 The Resubmit-Job operation [PWG5100.11] is the safe replacement. It makes a copy of the Job, gives the copy a new "job-uri" and "job-id", and resets the Job progress attributes in the new copy only 🫶
The Restart-Job operation moves the Job to the 'pending' or 'pending-held' Job state and restarts it from the beginning, on the same Printer, with the same attribute values ✨ If any of the Documents in the Job were passed by reference (Print-URI or Send-URI), the Printer MUST refetch the data, since Restart-Job means repeating all Job processing 🔁 The Job Status attributes that track Job progress, like "job-impressions-completed", "job-media-sheets-completed", and "job-k-octets-processed", MUST be reset to 0, so they give an accurate record of the Job from its restart point 📊 The Job MUST continue to use the same "job-uri" and "job-id" attribute values 🎀
The Printer MUST accept or reject the request based on the Job's current state, and move the Job to the new state shown in Table 7 💅
Note: to stop a user from accidentally restarting a Job in the middle, the Restart-Job request gets rejected when the Job is in the 'processing' or 'processing-stopped' state 🙅♀️ If an operation is ever needed to hold or restart Jobs in either of those states, it'll be added as a separate operation instead of overloading Restart-Job. That way it's clear the user intended for the current Job not to be completed 🌈
Access Rights: the authenticated user (see Section 9.3) doing this operation has to be either the Job owner or an Operator or Administrator of the Printer (see Sections 1 and 9.5) 🔒 Otherwise, the Printer MUST reject the operation and return 'client-error-forbidden', 'client-error-not-authenticated', or 'client-error-not-authorized', whichever fits 🙈
+-------------------+--------------------+--------------------------+
| Current "job- | New "job-state" | Printer's response |
| state" | | status-code and action: |
+-------------------+--------------------+--------------------------+
| 'pending' | 'pending' | 'client-error-not- |
| | | possible' |
+-------------------+--------------------+--------------------------+
| 'pending-held' | 'pending-held' | 'client-error-not- |
| | | possible' |
+-------------------+--------------------+--------------------------+
| 'processing' | 'processing' | 'client-error-not- |
| | | possible' |
+-------------------+--------------------+--------------------------+
| 'processing- | 'processing- | 'client-error-not- |
| stopped' | stopped' | possible' |
+-------------------+--------------------+--------------------------+
| 'completed' | 'pending' or | 'successful-ok' - Job is |
| | 'pending-held' | started over. |
+-------------------+--------------------+--------------------------+
| 'completed' | 'completed' | 'client-error-not- |
| | | possible' - see Rule 1. |
+-------------------+--------------------+--------------------------+
| 'canceled' | 'pending' or | 'successful-ok' - Job is |
| | 'pending-held' | started over. |
+-------------------+--------------------+--------------------------+
| 'canceled' | 'canceled' | 'client-error-not- |
| | | possible' - see Rule 1. |
+-------------------+--------------------+--------------------------+
| 'aborted' | 'pending' or | 'successful-ok' - Job is |
| | 'pending-held' | started over. |
+-------------------+--------------------+--------------------------+
| 'aborted' | 'aborted' | 'client-error-not- |
| | | possible' - see Rule 1. |
+-------------------+--------------------+--------------------------+
Table 7: Restart-Job State TransitionsRule 1: if the Job Retention Period has expired for the Job in this state, the Printer rejects the operation 🕐 See Section 5.3.7.2.
4.3.7.1. Restart-Job Request 📬
The groups and attributes are the same as the ones defined for a Cancel-Job request (see Section 4.3.3.1), plus this Group 1 operation attribute:
"job-hold-until" (type2 keyword | name(MAX)):
The Client MAY supply this operation attribute in a Restart-Job request, and if the Printer supports the "job-hold-until" Job Template attribute in Job Creation requests, the Printer MUST support it too 🌷 See Section 5.2.2.
If it's supplied and supported as specified in the Printer's "job-hold-until-supported" attribute, the Printer copies the supplied operation attribute to the Job. It replaces the Job's previous "job-hold-until" attribute, if there is one, and makes the Job a candidate for scheduling during the supplied named time period 🗓️ See Section 5.2.2.
If it's supplied but the value isn't supported, the Printer accepts the request, returns the unsupported attribute or value in the Unsupported Attributes group according to Section 4.1.7, returns the 'successful-ok-ignored-or-substituted-attributes' status-code, and holds the Job indefinitely until a Client does a later Release-Job operation 😬
If it's supplied but the "job-hold-until" operation attribute itself isn't supported, the Printer accepts the request, returns the unsupported attribute with the out-of-band 'unsupported' value in the Unsupported Attributes group according to Section 4.1.7, returns the 'successful-ok-ignored-or-substituted-attributes' status-code, and restarts the Job. In other words, it ignores the "job-hold-until" attribute 🫧
If (1) the Client supplies either a value that specifies a time period that has already started, or the 'no-hold' value (meaning don't hold the Job), and (2) the Printer supports the "job-hold-until" operation attribute and there are no other reasons to hold the Job, the Printer makes the Job a candidate for processing right away (see Section 5.2.2) ⚡
If the Client doesn't supply a "job-hold-until" operation attribute in the request, the Printer removes the "job-hold-until" attribute from the Job, if it's there. If there are no other reasons to hold the Job, the Restart-Job operation makes the Job a candidate for processing right away (see Section 5.2.2) 🏃♀️
4.3.7.2. Restart-Job Response 💌
The groups and attributes are the same as the ones defined for a Cancel-Job response (see Section 4.3.3.2) 🥰
5. Object Attributes ✨
okay bestie, this is where we get into the actual attributes 💅 this section covers the attributes, their attribute syntaxes, and their values that make up the IPP Model. the sections below list the objects and their attributes that are in scope for this protocol. a lot of these come from other docs, so no cap, we're borrowing from:
- Document Printing Application (DPA) [ISO10175]
- Printer MIB v2 [RFC3805]
every attribute gets a unique ID in this doc called a "keyword" (see Section 2.3.7), which is literally just the attribute's name 🎀 the keyword is in the section title for that attribute, so you can find it right away.
Note: keywords aren't the only thing used to identify attributes 👀 one of the attribute syntaxes below is "keyword" itself, so some attributes have keyword values. that means those attributes get defined with an attribute syntax that's a set of keywords. iykyk 🫶
5.1. Attribute Syntaxes
okay so this part defines the basic attribute syntax types. every Client and IPP object MUST be able to accept them, with Clients handling responses and IPP objects handling requests 🧚 each attribute description in Sections 4 and 5 puts the attribute's name and its syntax(es) in parentheses in the section title. A conforming implementation of an attribute MUST include the semantics of the attribute syntax(es) so identified. Section 7.7 explains how the protocol can be extended with new attribute syntaxes 🌈
the attribute syntaxes are specified in the subsections below, where each subsection title is the keyword name of the attribute syntax inside single quotes. in operation requests and responses, each attribute value MUST be represented as one of the attribute syntaxes in the subsection title for that attribute. on top of that, the value of an attribute in a response (but not in a request) MAY be one of the "out-of-band" values (Section 5.1.1), whose special encoding rules live in the Encoding and Transport document [RFC8010] 🦋
the attribute count rules are next, and they're a whole vibe 🍓 All attributes in a request MUST have one or more values as defined in Sections 5.2, 5.3, and 5.4. All attributes in a response MUST have either (1) one or more values as defined in Sections 5.2, 5.3, and 5.4 or (2) a single "out-of-band" value.
most attributes only have one attribute syntax 💖 but a few, like job-sheet, media, and job-hold-until, have several, depending on the value. those multiple syntaxes are separated by the | character in the subsection title to show the choice. since each value MUST be tagged with its attribute syntax in the protocol, a single-valued attribute instance can use any one of its syntaxes, and a multi-valued attribute instance can mix and match its defined syntaxes. main character energy ✨
5.1.1. Out-of-Band Values - 'unknown', 'unsupported', and 'no-value'
this document defines three "out-of-band" values that get used in place of an attribute's defined syntax 🫧
'unknown': the attribute is supported by the IPP object, but the IPP object doesn't know the value for some reason. this one is for attributes with an intrinsic, physical value that the IPP object can't figure out at a given time, like sheet count or geo-location, etc. 📄'unsupported': the attribute is unsupported by the IPP object. this value MUST be returned only as the value of an attribute in the Unsupported Attributes group 🙅♀️'no-value': the attribute is supported by the Printer, but the Administrator hasn't configured a value yet ⏳
5.1.2. 'text'
a 'text' attribute is an attribute whose value is a sequence of zero or more characters, encoded in a maximum of 1023 ('MAX') octets. MAX is the max length for each value of any 'text' attribute. BUT if an attribute will always have values way shorter than MAX, its definition gets a qualifier that sets the max length for that attribute's values 🎀 for example, printer-location is specified as printer-location (text(127)). in that case, text values for printer-location MUST NOT exceed 127 octets. if a longer text string comes in through some external interface (not the protocol), implementations are free to truncate it to the shorter limit ✂️
in this doc, every 'text' attribute uses the 'text' syntax 💅 but 'text' is just shorthand. its formal meaning is textWithoutLanguage | textWithLanguage. so for any attribute defined here with the 'text' syntax, all IPP objects and Clients MUST support both the textWithoutLanguage and textWithLanguage attribute syntaxes. in real life though, IPP objects and Clients only accept and return one of the two per attribute 🌸 and the syntax 'text' never shows up "on-the-wire" 🙈
both textWithoutLanguage and textWithLanguage exist so sites and systems that use different natural languages can actually talk to each other 🌍 usually one natural language covers all 'text' attributes in a given request or response. that language is set by the "attributes-natural-language" operation attribute (defined in Section 4.1.4) or the "attributes-natural-language" Job attribute (defined in Section 5.3.20), so you don't need to tag the language on every string. in those cases, the textWithoutLanguage syntax is used for 'text' attributes. but sometimes the Client needs to send, or the Printer needs to return, a text value in a different language than everything else. then the Client or Printer uses textWithLanguage for that 'text' attribute. this is the Natural Language Override mechanism, described in Section 4.1.4 🦋
the textWithoutLanguage and textWithLanguage syntaxes get the full breakdown in the subsections below 👑
5.1.2.1. 'textWithoutLanguage'
the textWithoutLanguage syntax is a value made of zero or more characters, encoded in a maximum of 1023 (MAX) octets. the text strings are encoded using the rules of some charset 🔤 The Printer MUST support the UTF-8 charset [RFC3629] and MAY support additional charsets to represent 'text' values, as long as those charsets are registered with IANA [IANA-CS]. See Section 5.1.8 for the definition of the 'charset' attribute syntax, including restricted semantics and examples of charsets 🌈
5.1.2.2. 'textWithLanguage'
the textWithLanguage syntax is a compound syntax with two parts: a textWithoutLanguage part (encoded in a maximum of 1023 (MAX) octets) plus a 'naturalLanguage' part (see Section 5.1.9) that overrides the natural language in force 🫶 the 'naturalLanguage' part names the natural language that applies to the text part of that one value and no other. for any given 'text' attribute, the textWithoutLanguage part is capped at that attribute's max length, and the 'naturalLanguage' part is always capped at 63 (additional) octets. using textWithLanguage instead of plain textWithoutLanguage is the so-called "Natural Language Override mechanism", and it MUST be supported by all IPP objects and Clients 💜
if the attribute is multi-valued (1setOf text), then textWithLanguage MUST be used to explicitly specify each attribute value whose natural language needs overriding 🍓 any other values in a multi-valued 'text' attribute in a request or response just go back to the natural language of the operation attribute.
In a Job Creation request, the Printer MUST accept and store with the Job any natural language in the "attributes-natural-language" operation attribute, whether the Printer supports that natural language or not. Furthermore, the Printer MUST accept and store any textWithLanguage attribute value, whether the Printer supports that natural language or not. These requirements are independent of the value of the "ipp-attribute-fidelity" operation attribute that the Client MAY supply. 🙌
example time 🧚 say the Client sends the "attributes-natural-language" operation attribute with the value en (English), but the "job-name" attribute is in French. then the Client MUST use the textWithLanguage attribute syntax with these two values:
'fr': Natural Language Override indicating French
'Rapport Mensuel': the Job name in FrenchSee the Encoding and Transport document [RFC8010] for the encoding of the two parts and a detailed example of the textWithLanguage attribute syntax 📚
5.1.3. 'name'
this syntax is for user-friendly strings, like a Printer name, that mean more to humans than identifiers do 🎀 names are never translated from one natural language to another, period 🙅♀️ the 'name' syntax is basically the same as 'text', including the REQUIRED support of UTF-8, except the character sequence is limited so its encoded form MUST NOT exceed 255 (MAX) octets.
like 'text', 'name' is also shorthand, this time for either nameWithoutLanguage or nameWithLanguage. so all IPP objects and Clients MUST support both the nameWithoutLanguage and nameWithLanguage attribute syntaxes. in actual usage and protocol execution, though, IPP objects and Clients only accept and return one of the two per attribute. the syntax 'name' never appears "on-the-wire" ✨
only the 'text' and 'name' syntaxes get to use the Natural Language Override mechanism 🌸
some attributes are defined as type2 keyword | name. these attributes support values that are either type2 keywords or names. this dual-syntax trick lets a site Administrator extend these attributes to legally include values the site Administrator defines locally 🧁 those names are not registered with IANA, so they're local-only.
5.1.3.1. 'nameWithoutLanguage'
the nameWithoutLanguage syntax is a value made of zero or more characters, encoded in a maximum of 255 (MAX) octets 🦋
5.1.3.2. 'nameWithLanguage' 🎀
okay so 'nameWithLanguage' is a compound syntax, bestie, which means it has two parts 💅. First there's the 'nameWithoutLanguage' part (check Section 5.1.3.1), and then there's an extra 'naturalLanguage' part (see Section 5.1.9) that overrides whatever natural language is in force. That 'naturalLanguage' part names the language for that one name value and only that name value ✨. For any given 'name' attribute, the 'nameWithoutLanguage' part is capped at the max length defined for that attribute, and the 'naturalLanguage' part is always capped at 63 (additional) octets 🌸. Using 'nameWithLanguage' instead of the regular 'nameWithoutLanguage' syntax is the Natural Language Override mechanism, and it MUST be supported by all IPP objects and Clients 🫶.
'nameWithLanguage' acts exactly like the 'textWithLanguage' syntax 💖. So if a name is in a different language from the rest of the object or operation, you use this 'nameWithLanguage' syntax instead of the generic 'nameWithoutLanguage' one 🦋.
If the attribute is multi-valued (1setOf name), then the 'nameWithLanguage' attribute syntax MUST be used to explicitly specify each attribute value whose natural language needs to be overridden 🔥. Any other values in a multi-valued 'name' attribute, in a request or a response, go back to the natural language of the operation attribute 🧚.
In a Job Creation request, the Printer MUST accept and store with the Job any natural language in the "attributes-natural-language" operation attribute, whether or not the Printer supports that natural language 💅. Also, the Printer MUST accept and store any 'nameWithLanguage' attribute value, whether or not it supports that natural language 👑. These requirements don't depend on the value of the "ipp-attribute-fidelity" operation attribute, which the Client MAY supply ✨.
Example: say the Client supplies the "attributes-natural-language" operation attribute with the value 'en' (English), but the "printer-name" attribute is in German 🇩🇪. Then the Client MUST use the 'nameWithLanguage' attribute syntax like this 🎀:
'de': Natural Language Override indicating German
'Farbdrucker': the Printer name in GermanCheck the Encoding and Transport document [RFC8010] for how the two parts get encoded, plus a detailed example of the 'nameWithLanguage' attribute syntax 🦋.
5.1.3.3. Matching 'name' Attribute Values 💜
okay, so when you're checking whether two 'name' attribute values are equal, like during Job validation (where a Client-supplied value for attribute "xxx" gets checked against the values in the Printer's matching "xxx-supported" attribute), these match rules apply 🔍:
- 'keyword' values never match 'name' values. 🙅♀️
- 'name' values ('nameWithoutLanguage' and 'nameWithLanguage') match if (1) the name parts match and (2) the Associated Natural Language parts (see Section 4.1.4.1) match. Here's how that works 🌈:
2a. The name parts match if the two names are identical character by character, except that it is RECOMMENDED that case be ignored as defined in "i;unicode-casemap - Simple Unicode Collation Algorithm" [RFC5051]. For example, 'Ajax-letter-head-white' MUST match 'Ajax-letter-head-white' and SHOULD match 'ajax-letter-head-white' and 'AJAX-LETTER-HEAD-WHITE' 💖.
2b. The Associated Natural Language parts match if the shorter of the two meets the syntactic requirements defined in Section 2.1 of RFC 5646 [RFC5646] and matches (byte for byte, since IPP language tags are lowercase) the longer one. For example, 'en' matches 'en', 'en-us', and 'en-gb' but matches neither 'fr' nor 'e' 🌸.
5.1.4. 'keyword' 🔑
The 'keyword' attribute syntax is a sequence of characters, 1 to 255 long, made only of US-ASCII [RFC20] encoded values for lowercase letters ("a"-"z"), digits ("0"-"9"), hyphen ("-"), dot ("."), and underscore ("_"). The first character MUST be a lowercase letter. Also, keywords MUST be in US English 🇺🇸💅.
This syntax type is for enumerating semantic identifiers of entities in the abstract protocol, meaning entities identified in this document 🧚. Keywords are used as attribute names or as values of attributes ✨. Unlike 'text' and 'name' attribute values, 'keyword' values MUST NOT use the Natural Language Override mechanism, because they MUST always be US-ASCII and US English 🙈.
Keywords are for use in the protocol 🤓. A user interface will likely map protocol keywords to displayable, user-friendly words and phrases that are localized to the user's natural language. The keywords in this document MAY be displayed to users whose natural language is US English, and they MAY be mapped to other US English words for US English users, since the user interface is outside the scope of this document 🦋.
In the definition for each attribute of this syntax type, the full set of 'keyword' values defined for that attribute is listed 📋. The IANA IPP registry will always hold the complete and current list of 'keyword' values for the attribute 💜.
When a keyword represents an attribute (its name), it MUST be unique across the full scope of all IPP objects and attributes 💅. When a keyword represents a value of an attribute, it MUST be unique just within the scope of that attribute 🎀. That means the same keyword MUST 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 7.3 describes how the protocol can be extended with new 'keyword' values 🧚. Examples of attribute name keywords are:
"job-name"
"attributes-charset"Note: This document uses "type1" and "type2" prefixes on the "keyword" basic syntax to indicate different levels of review for extensions (see Section 7.3) 🔍.
5.1.5. 'enum' 🔢
The 'enum' attribute syntax is an enumerated integer value in the range from 1 to 2**31 - 1 (MAX) ✨. 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 is listed 📋. This syntax type is used for attributes that have enum values assigned by other standards, such as SNMP MIBs 🦋. A number of attribute enum values in this document are also used for corresponding attributes in other standards [RFC3805] 🌸. This syntax type is not used for attributes that the Administrator can assign values to 🙅♀️. Section 7.4 describes how the protocol can be extended with new enum values 🧚.
Enum values are for use in the protocol 💅. A user interface will provide a mapping between protocol enum values and displayable, user-friendly words and phrases that are localized to the user's natural language 🫶. The enum symbols in this document MAY be displayed to users whose natural language is US English, and they MAY be mapped to other US English words for US English users, since the user interface is outside the scope of this document 🇺🇸.
Note: Some SNMP MIBs use '2' for 'unknown', which corresponds to the IPP "out-of-band" value 'unknown'. See the description of the "out-of-band" values at the beginning of Section 5.1. That's why attributes of type 'enum' typically start at '3' 🙈.
Note: This document uses "type1" and "type2" prefixes on the "enum" basic syntax to indicate different levels of review for extensions (see Section 7.4) 🔍.
5.1.6. 'uri' 🌐
The 'uri' attribute syntax is any valid Uniform Resource Identifier (URI) [RFC3986] 🦋. Most often, URIs are simply Uniform Resource Locators (URLs) 💜. The maximum length of URIs used as values of IPP attributes is 1023 octets 📏. Most other IPP attribute syntax types only allow lowercase values, but this one follows the case-sensitive and case-insensitive rules in [RFC3986] 🌈. See also [RFC3196] for a discussion of case in URIs 📚.
5.1.7. 'uriScheme' 🧁
The 'uriScheme' attribute syntax is a sequence of characters representing a URI scheme according to RFC 3986 [RFC3986] 🎀. Even though RFC 3986 says scheme values are case insensitive, IPP requires all lowercase values in IPP attributes, which makes things simpler for IPP Clients and Printers to compare 💅.
Standard values for this syntax type include these keywords 🌸:
'ipp': for IPP schemed URIs, e.g.,"ipp://example.com/ipp/..."[RFC3510]'ipps': for IPPS schemed URIs, e.g.,"ipps://example.com/ipp/..."[RFC7472]'http': for HTTP schemed URIs, e.g.,"http://example.com/path/to/filename"[RFC7230]'https': for HTTPS schemed URIs, e.g.,"https://example.com/path/to/filename"[RFC7230]'ftp': for FTP schemed URIs, e.g.,"ftp://example.com/path/to/filename"[RFC1738]'mailto': for SMTP schemed URIs, e.g.,"mailto:user@example.com"[RFC6068]'file': for file schemed URIs, e.g.,"file:///path/to/filename"[RFC1738]'urn': for Uniform Resource Name schemed URIs, e.g.,"urn:uuid:01234567-89ab-cdef-fedc-ba9876543210"[RFC4122]
A Printer MAY support any URI 'scheme' that has been registered with IANA [IANA-MT] 🧚. The maximum length of URI 'scheme' values used to represent IPP attribute values is 63 octets 📏.
5.1.8. 'charset' 🔤
The 'charset' attribute syntax is a standard identifier for a charset 🌈. A charset is a coded character set and encoding scheme ✨. Charsets are used for labeling certain Document contents, 'text' attribute values, and 'name' attribute values 🦋. The syntax and semantics of this attribute syntax are specified in RFC 2046 [RFC2046] and listed in the IANA "Character Sets" registry [IANA-CS], following the IANA procedures [RFC2978] 📚. Even though RFC 2046 requires these values to be case-insensitive US-ASCII [RFC20], IPP requires all lowercase values in IPP attributes, to keep comparisons easy for IPP Clients and Printers 💅. When a character set in the IANA registry has more than one name (alias), the name labeled "(preferred MIME name)", if present, MUST be used 👑.
The maximum length of 'charset' values used to represent IPP attribute values is 63 octets 📏.
Some examples are 🧁:
'utf-8': ISO 10646 Universal Multiple-Octet Coded Character Set (UCS) [ISO10646] represented as the UTF-8 [RFC3629] transfer encoding scheme, in which US-ASCII [RFC20] is a subset charset 💖.'us-ascii': 7-bit American Standard Code for Information Interchange (ASCII) [RFC20] 🌸.'iso-8859-1': 8-bit One-Byte Coded Character Set, Latin Alphabet No. 1 [ISO8859-1]. That standard defines a coded character set 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 which charset values can be used, such as REQUIRED values that MUST be supported, or additional restrictions, such as requiring that the charset have US-ASCII as a subset charset 🔥.
5.1.9. 'naturalLanguage' 🌍💕
okay so 'naturalLanguage' is the attribute syntax for a standard identifier for a natural language and, if you want, a country or region too 🗣️✨ the values come from RFC 5646 [RFC5646]. RFC 5646 says they're case-insensitive US-ASCII, but IPP goes with all lowercase values in IPP attributes so Clients and Printers can compare them easily 🧠💅 here are some examples:
'en': for English'en-us': for US English'fr': for French'de': for German
the maximum length of a 'naturalLanguage' value used to represent IPP attribute values is 63 octets 📏
Note: While any standard natural language identifier defined in RFC 5646 can be used, Clients typically only support a subset of these identifiers. When comparing two identifiers or performing lookups, Printers SHOULD be prepared to match legacy identifiers with their corresponding modern equivalents and vice versa. 🫶 so basically Printers should be ready to match old-school codes with the modern ones, and the other way around, bestie 🔁
5.1.10. 'mimeMediaType' 📄🦋
the 'mimeMediaType' attribute syntax is the Internet media type (sometimes called "MIME type") defined by RFC 2046 [RFC2046] and registered through the procedures of RFC 6838 [RFC6838], used for identifying a Document format 📑 the value MAY include a charset parameter, or some other parameter, depending on how the media type is specified in the IANA "Media Types" registry [IANA-MT] 🎀 most other IPP syntax types only allow lowercase values, but this one lets you use mixed case as long as it's case insensitive, which is kinda iconic 🌈
here are the 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 MUST mean US-ASCII rather than simply unspecified) [RFC2046] 📝'text/plain; charset = US-ASCII': A plain text Document in US-ASCII'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 [RFC3629] 💜'application/postscript': A PostScript Document [RFC2046] ✨'application/vnd.hp-PCL': A PCL Document [IANA-MT] (charset escape sequence embedded in the Document data) 🖨️'application/pdf': Portable Document Format [ISO32000] 📕'application/octet-stream': Auto-sense - see Section 5.1.10.1 🧚
the maximum length of a 'mimeMediaType' value used to represent IPP attribute values is 255 octets 📏💖
5.1.10.1. 'application/octet-stream' - Auto-Sensing the Document Format 🕵️♀️
okay this one is the special main character of the bunch 👑 'application/octet-stream' means the Printer is in charge of figuring out the format itself. If the Printer supports this value, the Printer MUST be capable of auto-sensing the format of the Document data using an implementation-dependent method that examines some number of octets of the Document data, either as part of the Job Creation request and/or at Document processing time. During auto-sensing, a Printer can determine that the Document data has a format that the Printer doesn't recognize. If the Printer determines this problem before returning an operation response, it rejects the request and returns the client-error-document-format-not-supported status-code. If the Printer determines this problem after accepting the request and returning an operation response with one of the successful status-code values, the Printer adds the unsupported-document-format value to the Job's "job-state-reasons" attribute 🚨
if the Printer's default value attribute "document-format-default" is set to 'application/octet-stream', the Printer doesn't just support auto-sensing, it also relies on the result of that auto-sensing whenever the Client doesn't supply the "document-format" attribute 🔍 but if the Client does supply a Document format value, the Printer MUST rely on the supplied attribute, rather than trust its auto-sensing algorithm. Client wins, always 💅 to sum it all up:
- If the Client does not supply a Document format value, the Printer MUST rely on its default value setting (which can be 'application/octet-stream' indicating an auto-sensing mechanism).
- 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 MUST trust the Client-supplied value more than the outcome of applying an automatic format detection mechanism. For example, the Client can request the printing of a PostScript file as a 'text/plain' Document. The Printer MUST print a text representation of the PostScript commands rather than interpret the stream of PostScript commands and print the result. 🤓
- If the Client supplies a value of 'application/octet-stream', the Client is indicating that the Printer MUST use its auto-sensing mechanism on the Client-supplied Document data whether auto-sensing is the Printer's default or not. 🔮
Note: Since the auto-sensing algorithm is probabilistic, if the Client requests both auto-sensing ("document-format" set to 'application/octet-stream') and true fidelity ("ipp-attribute-fidelity" set to 'true'), the Printer might not be able to guarantee exactly what the End User intended (the auto-sensing algorithm might mistake one Document format for another), but it is able to guarantee that its auto-sensing mechanism will be used. 😭 so the vibe is: the Printer can promise it'll use auto-sensing, but it can't promise a perfect guess!
5.1.11. 'octetString' 🧃
the 'octetString' attribute syntax is a sequence of octets encoded in a maximum of 1023 octets, and it's written in syntax definitions as 'octetString(MAX)' 📦 it's used for opaque data, so it's basically a little sealed box 🎁
5.1.12. 'boolean' ✅❌
the 'boolean' attribute syntax has only two values: 'true' and 'false'. that's it, that's the tweet 🌟
5.1.13. 'integer' 🔢
the 'integer' attribute syntax is an integer value in the range from -231 (MIN) to 231 - 1 (MAX) 💫 each individual attribute can set its own range constraint if the range is different from the full range of possible integers. for example, job-priority (integer(1:100)) for the "job-priority" attribute, as shown in the title of Section 5.2.1. however, enforcing that extra constraint is up to the IPP objects, not the protocol 🧚♀️
5.1.14. 'rangeOfInteger' 📐
the 'rangeOfInteger' attribute syntax is an ordered pair of integers that defines an inclusive range of integer values 🎀 the first integer is the lower bound and the second is the upper bound. if a range constraint is specified in the attribute definition, meaning 'rangeOfInteger(X:Y)' with X as the minimum and Y as the maximum, then the constraint applies to both integers 💕
5.1.15. 'dateTime' 🗓️⏰
the 'dateTime' attribute syntax is a standard, fixed-length, 11-octet representation of the "DateAndTime" syntax defined in RFC 2579 [RFC2579] 🕰️ RFC 2579 also describes an 8-octet representation of a "DateAndTime" value, but IPP objects MUST use the 11-octet representation. a user interface will map protocol dateTime values to displayable, user-friendly words or presentation values and phrases that are localized to the End User's natural language and date format, including time zone 🌏✨
5.1.16. 'resolution' 🖨️🌸
the 'resolution' attribute syntax specifies a two-dimensional resolution in the indicated units 📏 it has three values: a cross-feed direction resolution (positive integer value), a feed direction resolution (positive integer value), and a units value. the meanings of these three parts come from the suggested values in the Printer MIB [RFC3805] 🧠 specifically:
- the cross-feed direction resolution is the same as the
prtMarkerAddressabilityXFeedDirobject in the Printer MIB, - the feed direction resolution is the same as the
prtMarkerAddressabilityFeedDirin the Printer MIB, and - the units component is the same as the
prtMarkerAddressabilityUnitobject in the Printer MIB (namely,'3'indicates dots per inch and'4'indicates dots per centimeter).
All three values MUST be present even if the first two values are the same. For example, '300', '600', '3' indicates a 300-dpi cross-feed direction resolution and a 600-dpi feed direction resolution, since a '3' indicates dots per inch (dpi) 💖 so yeah, you need all three, even when the first two match 🙈
5.1.17. 'collection' 🧺💜
the 'collection' attribute syntax is a container holding one or more named values (aka attributes), which are called "member attributes" 🫧 each 'collection' attribute definition Document lists the mandatory and optional member attributes of each collection value. a collection value is kinda like an IPP attribute group in a request or a response, such as the Operation Attributes group, since they both hold a set of attributes 👑 and yes, collections can nest, so a collection can live inside a collection, which is very Russian doll energy 🪆
a collection value has three separate parts:
- a
begCollectionvalue with an optional octet string value starting the collection, - zero or more member attributes defined using a series of unnamed values starting with a
memberAttrNamevalue that specifies the member attribute name, and - an
endCollectionvalue with an optional name plus octet string value finishing the collection. 🎀
5.1.18. '1setOf X' 🍓
the '1setOf X' attribute syntax is one or more values of attribute syntax type X 🧃 it's used for multi-valued attributes. it's called '1setOf' instead of just 'setOf' as a reminder that the set of values MUST NOT be empty (i.e., a set of size 0) 🙅♀️ sets are normally unordered, but each attribute description of this type can say that the values MUST be in a certain order for that attribute 🔁✨
5.2. Job Template Attributes ✨
Okay so Job Template attributes are all about Job processing intent 🎀 basically what the Client wants the Job to do. Clients MAY supply them in Job Creation requests, and Printers SHOULD support them too. For how support works for OPTIONAL attributes, check out Section 2.3.11 🧚
Every Job Template attribute follows these rules, and for each one called "xxx", the rules go like this 💅
- If the Printer supports
xxx, then it MUST support both anxxx-defaultattribute (unless there is a "No" in Table 8 below) and anxxx-supportedattribute. If the Printer doesn't supportxxx, then it MUST support neither anxxx-defaultattribute nor anxxx-supportedattribute, and it MUST treat an attributexxxsupplied by a Client as unsupported. An attributexxxcan be supported for some Document formats and not supported for other Document formats. For example, it is expected that a Printer would only supportorientation-requestedfor some Document formats (such as'text/plain'or'text/html') but not others (such as'application/postscript'). Format-specific support is so real 🌸 - Clients MAY supply
xxxin a Job Creation request. Ifxxxis supplied, the Client is indicating a desired Job processing behavior for this Job. Whenxxxis not supplied, the Client is indicating that the Printer apply its default Job processing behavior at Job processing time if the Document content does not contain an embedded instruction indicating an xxx-related behavior.
Since an Administrator MAY change the default value attribute after a Job has been submitted but before it has been processed, the default value used by the Printer at Job processing time can be different than the default value in effect at Job submission time. 🙈 Plot twist energy, bestie.
- The
xxx-supportedattribute is a Printer attribute that describes which Job processing behaviors are supported by that Printer. A Client can query the Printer to find out what xxx-related behaviors are supported by inspecting the returned values of thexxx-supportedattribute.
Note: The xxx in each xxx-supported attribute name is singular, even though an xxx-supported attribute usually has more than one value, such as print-quality-supported, unless the xxx Job Template attribute is plural, such as finishings or sides. In such cases, the xxx-supported attribute names are finishings-supported and sides-supported. 🫶
- The
xxx-defaultdefault value attribute describes what will be done at Job processing time when no other Job processing information is supplied by the Client (either explicitly as an IPP attribute in the Job Creation request or implicitly as an embedded instruction within the Document data).
If an application wants to show an End User a list of supported values to pick from, the application SHOULD query the Printer for its supported value attributes. The application SHOULD also query the default value attributes. If the application then limits selectable values to only the supported ones, the application can guarantee that the values the Client supplies in the Job Creation request all fall within the set of supported values at the Printer. ✨ When querying the Printer, the Client MAY enumerate each attribute by name in the Get-Printer-Attributes request, or the Client MAY just name the "job-template" group to get the complete set of supported attributes (both supported and default attributes). Either way works, iykyk 💖
The finishings attribute is an example of a Job Template attribute. It can take on a set of values such as '4' ('staple'), '5' ('punch'), and/or '6' ('cover'); see Table 10 in Section 5.2.6. A Client can query the Printer for the finishings-supported attribute and the finishings-default attribute. The supported attribute contains a set of supported values. The default value attribute contains the finishing value(s) that will be used for a new Job if the Client does not supply a finishings attribute in the Job Creation request and the Document data does not contain any corresponding finishing instructions. If the Client does supply the finishings attribute in the Job Creation request, the Printer validates the value or values to make sure that they are a subset of the supported values identified in the Printer's finishings-supported attribute. See Section 4.1.7. Validation is giving main character energy 👑
Table 8 below summarizes the names and relationships for all Job Template attributes. The first column of the table (labeled "Job Attribute") shows the name and syntax for each Job Template attribute in the Job. These are the attributes that can optionally be supplied by the Client in a Job Creation request. The last two columns (labeled "Printer: Default Value Attribute" and "Printer: "Supported Values" Attribute") show the name and syntax for each Job Template attribute in the Printer (the default value attributes and the "supported values" attributes). A "No" in the table means the Printer MUST NOT support the attribute (that is, the attribute is simply not applicable). For brevity in the table, the 'text' and 'name' entries do not show the maximum length for each attribute. 📋
+------------------+----------------------+-------------------------+
| Job Attribute | Printer: Default | Printer: "Supported |
| | Value Attribute | Values" Attribute |
+------------------+----------------------+-------------------------+
| job-priority | job-priority-default | job-priority-supported |
| (integer 1:100) | (integer 1:100) | (integer 1:100) |
+------------------+----------------------+-------------------------+
| job-hold-until | job-hold-until- | job-hold-until- |
| (type2 keyword | | default (type2 | supported (1setOf |
| name) | keyword | name) | (type2 keyword | name)) |
+------------------+----------------------+-------------------------+
| job-sheets | job-sheets-default | job-sheets-supported |
| (type2 keyword | | (type2 keyword | | (1setOf (type2 keyword |
| name) | name) | | name)) |
+------------------+----------------------+-------------------------+
| multiple- | multiple-document- | multiple-document- |
| document- | handling-default | handling-supported |
| handling (type2 | (type2 keyword) | (1setOf type2 keyword) |
| keyword) | | |
+------------------+----------------------+-------------------------+
| copies | copies-default | copies-supported |
| (integer(1:MAX)) | (integer(1:MAX)) | (rangeOfInteger(1:MAX)) |
+------------------+----------------------+-------------------------+
| finishings | finishings-default | finishings-supported |
| (1setOf type2 | (1setOf type2 enum) | (1setOf type2 enum) |
| enum) | | |
+------------------+----------------------+-------------------------+
| page-ranges | No | page-ranges-supported |
| (1setOf | | (boolean) |
| rangeOfInteger | | |
| (1:MAX)) | | |
+------------------+----------------------+-------------------------+
| sides (type2 | sides-default (type2 | sides-supported (1setOf |
| keyword) | keyword) | type2 keyword) |
+------------------+----------------------+-------------------------+
| number-up | number-up-default | number-up-supported |
| (integer(1:MAX)) | (integer(1:MAX)) | (1setOf |
| | | (integer(1:MAX) | |
| | | rangeOfInteger(1:MAX))) |
+------------------+----------------------+-------------------------+
| orientation- | orientation- | orientation-requested- |
| requested (type2 | requested-default | supported (1setOf type2 |
| enum) | (type2 enum) | enum) |
+------------------+----------------------+-------------------------+
| media (type2 | media-default (type2 | media-supported (1setOf |
| keyword | name) | keyword | name) | (type2 keyword | name)) |
| | | media-ready (1setOf |
| | | (type2 keyword | name)) |
+------------------+----------------------+-------------------------+
| printer- | printer-resolution- | printer-resolution- |
| resolution | default (resolution) | supported (1setOf |
| (resolution) | | resolution) |
+------------------+----------------------+-------------------------+
| print-quality | print-quality- | print-quality-supported |
| (type2 enum) | default (type2 enum) | (1setOf type2 enum) |
+------------------+----------------------+-------------------------+
Table 8: Job Template Attributes5.2.1. job-priority (integer(1:100)) 💖
okay so this attribute is how you set a priority for scheduling the Job 🎀 a higher number means a higher priority, so 1 is the lowest possible and 100 is the highest possible 👑. Among the Jobs that are ready to print, a Printer MUST print all Jobs with a priority value of n before printing those with a priority value of n - 1, for all n 💅.
If the Printer supports this attribute, it MUST always support the full range from 1 to 100 🌈. No administrative restrictions are permitted, bestie 🙅♀️. That way an End User can always use the whole range on any Printer ✨. If privileged Jobs are implemented outside IPP, they MUST have priorities higher than 100, instead of shrinking the range End Users get 🫶.
If the Client doesn't supply this attribute and the Printer supports it, the Printer MUST use the value of the Printer's job-priority-default at Job submission time 🧚. This is different from most Job Template attributes, which get used when needed at Job processing time, so it's kind of a main character moment 💜.
The syntax for job-priority-supported is also integer(1:100) 🍓. This one integer tells you how many priority levels the Printer supports. The Printer MUST take the value the Client sent and map it to the closest integer in a sequence of n integer values that are spread evenly over the range from 1 to 100, using this formula:
roundToNearestInt((100x + 50) / n)where n is the value of job-priority-supported and x goes from 0 through (n - 1) 🔥.
Here's how it plays out. If n = 1, the sequence is 50. If n = 2, it's 25 and 75. If n = 3, it's 17, 50, and 83. If n = 10, it's 5, 15, 25, 35, 45, 55, 65, 75, 85, and 95. And if n = 100, the sequence is 1, 2, 3, ... 100 🦋.
Table 9 shows how a Printer maps Client-supplied job-priority values for some example values of n 👀.
+--------------+-------+-------+--------+
| job-priority | n = 1 | n = 2 | n = 10 |
+--------------+-------+-------+--------+
| 1 | 50 | 17 | 5 |
+--------------+-------+-------+--------+
| 10 | 50 | 17 | 5 |
+--------------+-------+-------+--------+
| 20 | 50 | 17 | 15 |
+--------------+-------+-------+--------+
| 30 | 50 | 17 | 25 |
+--------------+-------+-------+--------+
| 40 | 50 | 50 | 35 |
+--------------+-------+-------+--------+
| 50 | 50 | 50 | 45 |
+--------------+-------+-------+--------+
| 60 | 50 | 50 | 55 |
+--------------+-------+-------+--------+
| 70 | 50 | 50 | 65 |
+--------------+-------+-------+--------+
| 80 | 50 | 83 | 75 |
+--------------+-------+-------+--------+
| 90 | 50 | 83 | 85 |
+--------------+-------+-------+--------+
| 100 | 50 | 83 | 95 |
+--------------+-------+-------+--------+
Table 9: "job-priority" Values5.2.2. job-hold-until (type2 keyword | name(MAX)) ⏳
This attribute specifies the named time period during which the Job MUST become a candidate for printing 🌸.
Standard 'keyword' values for named time periods are:
'no-hold': immediately, if there are no other reasons to hold the job'indefinite': the Job is held indefinitely, until a Client performs a Release-Job (Section 4.3.6) 🥲'day-time': during the day ☀️'evening': evening 🌆'night': night 🌙'weekend': weekend 🎉'second-shift': second shift (after close of business) 💼'third-shift': third shift (after midnight) 🌃
An Administrator MUST associate allowable print times with a named time period, and that happens by means outside the scope of this IPP/1.1 document 🕰️. An Administrator is encouraged to pick names that suggest the type of time period, which is honestly such a good idea 🧠. 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 future, the Printer SHOULD add the "job-hold-until-specified" value to the Job's "job-state-reasons" attribute, MUST move the Job to the 'pending-held' state, and MUST NOT schedule the Job for printing until the specified time period arrives 🛑.
When the specified time period arrives, the Printer MUST remove the "job-hold-until-specified" value from the Job's "job-state-reasons" attribute, if it's there 🫧. If no other Job state reasons are keeping the Job in the 'pending-held' state, the Printer MUST consider the Job as a candidate for processing by moving it to the 'pending' state 🚀.
If this Job attribute value is the named value 'no-hold', or the specified time period has already started, the Job MUST be a candidate for processing immediately ⚡.
If the Client doesn't supply this attribute and the Printer supports it, the Printer MUST use the value of the Printer's "job-hold-until-default" at Job submission time 🧚. Again, this is different from most Job Template attributes, which get used at Job processing time 🙈.
5.2.3. job-sheets (type2 keyword | name(MAX)) 🎀
This attribute decides which Job start/end sheet(s), if any, MUST be printed with a Job 📄.
Standard 'keyword' values are:
'none': no Job sheet is printed 🚫'standard': one or more site-specific standard Job sheets are printed, e.g., a single start sheet or both start and end sheets 📑
An Administrator MAY define additional values using the 'name' or 'keyword' attribute syntax, depending on implementation 🍒.
The effect of this attribute on Jobs with multiple Documents MAY be affected by the "multiple-document-handling" Job attribute (Section 5.2.4), depending on the Job sheet semantics 🔗.
5.2.4. multiple-document-handling (type2 keyword) 🧩
This RECOMMENDED attribute controls which Impressions and Media Sheets count as a Set for copy generation and finishing processes 💅. When the value of the "copies" attribute goes above '1', it also controls the order in which the copies that come out of processing the Documents get produced 🖨️. For the sake of this explanation, if "a" is an instance of Document data, then processing the data in Document "a" gives you a sequence of Media Sheets, which is written as "a(*)". This attribute MUST be supported with at least one value if the Printer supports multiple Documents per Job (see Sections 4.2.4 and 4.3.1) 🫶.
Standard 'keyword' values are:
'single-document': If a Job has multiple Documents, say the Document data is called "a" and "b", then processing all of the Document data (a and then b) MUST be treated as one single sequence of Media Sheets for finishing processes. That means finishing happens on the concatenation of the sequences a(),b() 🧵. The Printer MUST NOT force the data in each Document instance onto a new Impression, nor start a new Impression on a new Media Sheet. If more than one copy is made, the ordering of the sets of Media Sheets MUST be a(), b(), a(), b(), ..., and the Printer MUST force each copy (a(),b()) to start on a new Media Sheet 🌀.'separate-documents-uncollated-copies': If a Job has multiple Documents, say "a" and "b", then processing the data in each Document instance MUST be treated as a single sequence of Media Sheets for finishing processes. So the sets a() and b() each get finished separately 🗂️. The Printer MUST force each copy of the result of processing 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 MUST be a(), a(), ..., b(), b(), ... 🌷.'separate-documents-collated-copies': If a Job has multiple Documents, say "a" and "b", then processing the data in each Document instance MUST be treated as a single sequence of Media Sheets for finishing processes, so the sets a() and b() each get finished separately 📚. The Printer MUST force each copy of the result of processing 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 MUST be a(), b(), a(), b(), ... 💖.'single-document-new-sheet': Same as'single-document', except the Printer MUST ensure that the first Impression of each Document instance in the Job is placed on a new Media Sheet 🎁. This value lets you staple multiple Documents together with a single staple, with each Document starting on a new Media Sheet 📎.
The 'single-document' value matches 'separate-documents-collated-copies' when it comes to the ordering of Input Pages, but not Media Sheet generation 🧐. That's because 'single-document' will put the first page of the next Document on the back side of a Media Sheet if an odd number of pages have been produced so far for the Job. 'separate-documents-collated-copies', on the other hand, always forces the next Document or Document copy onto a new Media Sheet 🙌. Also, if the "finishings" attribute specifies 'staple', then with 'single-document', Documents a and b get stapled together as a single Set with no regard to a new Media Sheet. With 'single-document-new-sheet', Documents a and b get stapled together as a single Set, but Document b starts on a new Media Sheet 🪡. With 'separate-documents-uncollated-copies' and 'separate-documents-collated-copies', Documents a and b are stapled separately 🫰.
Note: The value'separate-documents-uncollated-copies'produces uncollated Media Sheets within a Set. For example, when"copies"is'2', a two-Document Job prints asa(1), a(1), a(2), a(2), ... a(n), a(n), b(1), b(1), ..., b(n), b(n). Every other value produces collated Media Sheets within a Set 🥹.
The relationship between this attribute and the other attributes that control Document processing is described in Appendix C.3 🗺️.
5.2.5. copies (integer(1:MAX)) 🐣
This RECOMMENDED attribute specifies the number of copies to be printed 🖨️✨.
On a lot of devices, the supported number of collated copies is limited by the number of physical output bins on the device. That number can be different from the number of uncollated copies the device can support 📦.
Note: The effect of this attribute on Jobs with multiple Documents is controlled by the "multiple-document-handling" Job attribute (Section 5.2.4) 💕. The relationship between this attribute and the other attributes that control Document processing is described in Appendix C.3 🌟.
5.2.6. finishings (1setOf type2 enum) ✨
okay so this one is RECOMMENDED 💅 and it's basically the bestie that tells the Printer which finishing stuff to do on each copy of each printed Document in the Job 🎀. When a Job has multiple Documents, the multiple-document-handling attribute is the one that decides what counts as a "copy" for finishing, so keep that in your back pocket 🦋
Standard enum values are listed in Table 10 🌸. The staple-xxx values are written as if the Document is in portrait orientation, with the origin of each Media Sheet at the top left corner 🧚. If the Document is actually landscape or reverse-landscape, the Client has to supply the transformed value 💖. Like, if you want a staple in the upper left-hand corner of a landscape Document (held for reading), you send staple-bottom-left, because landscape is a +90 degree rotation of the image relative to portrait, which is counterclockwise 🔄. And if it's reverse-landscape and you want that same upper left-hand corner, you send staple-top-right, because reverse-landscape is a -90 degree rotation, which is clockwise 🌈. The vibe is: rotate your brain, not the staple 🙈
The angle of each staple (vertical, horizontal, angled) relative to the Document depends on the implementation, and that can depend on the attribute value too 🦋
Note: Who controls multiple-Document behavior? The multiple-document-handling Job attribute (Section 5.2.4) 👑. The relationship between this attribute and the other Document processing attributes is in Appendix C.3 📚.
Note: The value'3'('none') has no effect when combined with any other values 💀. It's a lone wolf 🐺
Note: Thefinishings-colattribute [PWG5100.1] is the alternative tofinishingsif you want to give the Printer more detailed finishing intent 🎀
Here's Table 10, the full menu of finishing vibes 💜:
+-----------+-------------------------------------------------------+
| Value | Symbolic Name and Description |
+-----------+-------------------------------------------------------+
| '3' | 'none': Perform no finishing. |
+-----------+-------------------------------------------------------+
| '4' | 'staple': Bind the Document(s) with one or more |
| | staples. The exact number and placement of the |
| | staples are site defined. |
+-----------+-------------------------------------------------------+
| '5' | 'punch': This value indicates that holes are required |
| | in the finished Document. The exact number and |
| | placement of the holes are site defined. The punch |
| | specification MAY be satisfied (in a site-specific |
| | and implementation-specific manner) either by |
| | drilling/punching or by substituting pre-drilled |
| | media. |
+-----------+-------------------------------------------------------+
| '6' | 'cover': This value is specified when it is desired |
| | to select a non-printed (or pre-printed) cover for |
| | the Document. This does not supplant the |
| | specification of a printed cover (on cover stock |
| | medium) by the Document itself. |
+-----------+-------------------------------------------------------+
| '7' | 'bind': This value indicates that a binding is to be |
| | applied to the Document; the type and placement of |
| | the binding are site defined. |
+-----------+-------------------------------------------------------+
| '8' | 'saddle-stitch': Bind the Document(s) with one or |
| | more staples (wire stitches) along the middle fold. |
| | The exact number and placement of the staples and the |
| | middle fold are implementation defined and/or site |
| | defined. |
+-----------+-------------------------------------------------------+
| '9' | 'edge-stitch': Bind the Document(s) with one or more |
| | staples (wire stitches) along one edge. The exact |
| | number and placement of the staples are |
| | implementation defined and/or site defined. |
+-----------+-------------------------------------------------------+
| '10'-'19' | reserved for future generic finishing enum values. |
+-----------+-------------------------------------------------------+
| '20' | 'staple-top-left': Bind the Document(s) with one or |
| | more staples in the top left corner. |
+-----------+-------------------------------------------------------+
| '21' | 'staple-bottom-left': Bind the Document(s) with one |
| | or more staples in the bottom left corner. |
+-----------+-------------------------------------------------------+
| '22' | 'staple-top-right': Bind the Document(s) with one or |
| | more staples in the top right corner. |
+-----------+-------------------------------------------------------+
| '23' | 'staple-bottom-right': Bind the Document(s) with one |
| | or more staples in the bottom right corner. |
+-----------+-------------------------------------------------------+
| '24' | 'edge-stitch-left': Bind the Document(s) with one or |
| | more staples (wire stitches) along the left edge. |
| | The exact number and placement of the staples are |
| | implementation defined and/or site defined. |
+-----------+-------------------------------------------------------+
| '25' | 'edge-stitch-top': Bind the Document(s) with one or |
| | more staples (wire stitches) along the top edge. The |
| | exact number and placement of the staples are |
| | implementation defined and/or site defined. |
+-----------+-------------------------------------------------------+
| '26' | 'edge-stitch-right': Bind the Document(s) with one or |
| | more staples (wire stitches) along the right edge. |
| | The exact number and placement of the staples are |
| | implementation defined and/or site defined. |
+-----------+-------------------------------------------------------+
| '27' | 'edge-stitch-bottom': Bind the Document(s) with one |
| | or more staples (wire stitches) along the bottom |
| | edge. The exact number and placement of the staples |
| | are implementation defined and/or site defined. |
+-----------+-------------------------------------------------------+
| '28' | 'staple-dual-left': Bind the Document(s) with two |
| | staples (wire stitches) along the left edge, assuming |
| | a portrait Document (see above). |
+-----------+-------------------------------------------------------+
| '29' | 'staple-dual-top': Bind the Document(s) with two |
| | staples (wire stitches) along the top edge, assuming |
| | a portrait Document (see above). |
+-----------+-------------------------------------------------------+
| '30' | 'staple-dual-right': Bind the Document(s) with two |
| | staples (wire stitches) along the right edge, |
| | assuming a portrait Document (see above). |
+-----------+-------------------------------------------------------+
| '31' | 'staple-dual-bottom': Bind the Document(s) with two |
| | staples (wire stitches) along the bottom edge, |
| | assuming a portrait Document (see above). |
+-----------+-------------------------------------------------------+
Table 10: "finishings" Enum Values5.2.7. page-ranges (1setOf rangeOfInteger(1:MAX)) 🌟
okay this one is also RECOMMENDED 🎀 and it tells the Printer which range(s) of Input Pages to print for each Set, before those pages get imposed onto Impressions 🦋. If a page doesn't exist in the Set or Document(s), nothing gets printed for it, so no ghost pages, bestie 👻
Ranges MUST be in ascending order (like 1-3, 5-7, 15-19, etc.) and they MUST NOT overlap 💅. Why? So a non-spooling Printer can process the Job in a single pass 🧚. If the ranges are out of ascending order or they overlap, the Printer MUST reject the request and return the client-error-bad-request status-code 💀. Not it 🙅♀️
This attribute is about Input Pages, not application-numbered pages like the page numbers in the headers or footers of certain word processing apps 📄. Those are a different situation 🌸
For Jobs with multiple Documents, multiple-document-handling decides what counts as a Set for the page range(s) 👑. When it's single-document, the Printer MUST apply each supplied page range once to the concatenation of the Input Pages 💖. Example: 8 Documents of 10 pages each, and the page range 41-60 prints the pages in the 5th and 6th Documents as a single Document, and none of the other Documents' pages get printed 🙈
When it's separate-documents-uncollated-copies or separate-documents-collated-copies, the Printer MUST apply each supplied page range repeatedly to each Document copy 🔁. Same Job, page range 1-3, 10-10 would print the first 3 pages and the 10th page of each of the 8 Documents, as 8 separate Sets 🌈
page-ranges-supported is a boolean that says whether the Printer can support page ranges at all 🦋. That capability can vary from one PDL to another 🌸. There is no page-ranges-default attribute 🙅♀️. If the Client doesn't supply page-ranges, all pages of the Document get printed ✨
Note: Usually the Client only sends the Input Pages that need printing in the Document data, sopage-rangesisn't used 💅. But if a Client submits already-generated Document data (static content from a website, or something the End User wants to reprint), it can use this attribute to print just a subset 🎀. In that case, apage-rangesvalue ofn-mmeans the first page printed is page n, and every page after that is printed through and including page m 🫶
Note: The effect of this attribute on multi-Document Jobs is controlled by the multiple-document-handling Job attribute (Section 5.2.4) 👑. The relationship with the other Document processing attributes is in Appendix C.3 📚
5.2.8. sides (type2 keyword) 🦋
okay so this RECOMMENDED attribute is all about how Impressions get placed on the two sides of a Media Sheet 🎀 it's giving layout queen energy 💅
The standard 'keyword' values are:
'one-sided': imposes each consecutive Impression upon the same side of consecutive Media Sheets.'two-sided-long-edge': imposes each consecutive pair of Impressions upon front and back sides of consecutive Media Sheets, such that the orientation of each pair of Impressions on the medium would be correct for the reader as if for binding on the long edge. This imposition is sometimes called'duplex'or'head-to-head'. 📖'two-sided-short-edge': imposes each consecutive pair of Impressions upon front and back sides of consecutive Media Sheets, such that the orientation of each pair of Impressions on the medium would be correct for the reader as if for binding on the short edge. This imposition is sometimes called'tumble'or'head-to-toe'. 🔄
Note: The effect of this attribute on Jobs with multiple Documents is controlled by the "multiple-document-handling" Job attribute (Section 5.2.4). The relationship of this attribute and the other attributes that control Document processing is described in Appendix C.3. 🧚
5.2.9. number-up (integer(1:MAX)) 🌸
this attribute says how many Input Pages get squished onto one single Impression 🍓 for example, if the value is:
'1': the Printer MUST place one Input Page on a single Impression.'2': the Printer MUST place two Input Pages on a single Impression.'4': the Printer MUST place four Input Pages on a single Impression.
In all cases, the Printer MAY add some sort of translation, scaling, or rotation of Input Pages when imposing them. ✨
Note: The effect of this attribute on Jobs with multiple Documents is controlled by the "multiple-document-handling" Job attribute (Section 5.2.4). The relationship of this attribute and the other attributes that control Document processing is described in Appendix C.3. 💜
5.2.10. orientation-requested (type2 enum) 🧭
This RECOMMENDED attribute tells the Printer which orientation the printed Input Pages should end up in. It does NOT describe the orientation of the Client-supplied Input Pages 🙈 that's a totally different thing, bestie.
For some Document formats (such as 'application/postscript'), the desired orientation of the Input Pages is sometimes written right inside the Document data. A Printer driver generates that info before the Print Job gets submitted. Other Document formats, such as 'text/plain', have no concept of desired orientation inside the Document data. In that case, the Printer can attach the desired orientation to the Document data after it's been submitted 🫶
Printers MAY only support "orientation-requested" for some Document formats (e.g., 'text/plain' or 'text/html') but not others (e.g., 'application/postscript'). This is no different than any other Job Template attribute, since Section 5.2, item 1, points out that a Printer can support or not support any Job Template attribute based on the Document format supplied by the Client. However, a special mention is made here, since it is very likely that a Printer will support "orientation-requested" for only a subset of the supported Document formats. 😭 main character drama, but make it formatting.
Standard enum values are listed in Table 11. 📋
Note: The effect of this attribute on Jobs with multiple Documents is controlled by the "multiple-document-handling" Job attribute (Section 5.2.4). The relationship of this attribute and the other attributes that control Document processing is described in Appendix C.3. 🎀
+-------+-----------------------------------------------------------+
| Value | Symbolic Name and Description |
+-------+-----------------------------------------------------------+
| '3' | 'portrait': The content will be imaged across the short |
| | edge of the medium. |
+-------+-----------------------------------------------------------+
| '4' | 'landscape': The content will be imaged across the long |
| | edge of the medium. Landscape is defined to be a |
| | rotation of the Input Page to be imaged by +90 degrees |
| | with respect to the medium (i.e., counterclockwise) 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. |
+-------+-----------------------------------------------------------+
| '5' | 'reverse-landscape': The content will be imaged across |
| | the long edge of the medium. Reverse-landscape is |
| | defined to be a rotation of the Input 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. |
+-------+-----------------------------------------------------------+
| '6' | 'reverse-portrait': The content will be imaged across the |
| | short edge of the medium. Reverse-portrait is defined to |
| | be a rotation of the Input Page to be imaged by 180 |
| | degrees with respect to the medium from the portrait |
| | orientation. Note: The 'reverse-portrait' value was |
| | added for use with the "finishings" attribute in cases |
| | where the opposite edge is desired for finishing a |
| | portrait Document on simple finishing devices that have |
| | only one finishing position. Thus, a 'text'/plain' |
| | portrait Document can be stapled "on the right" by a |
| | simple finishing device, as is common use with some |
| | Middle Eastern languages such as Hebrew. |
+-------+-----------------------------------------------------------+
Table 11: "orientation-requested" Enum Values5.2.11. media (type2 keyword | name(MAX)) 🍰
This RECOMMENDED attribute tells the Printer which medium to use for every single Impression in the Job 🧁
ngl the "media" attribute has a messy history 🙃 it has held medium names, medium sizes, input trays, and electronic forms, so one attribute can pick the media. Still, the Client SHOULD only use the media attribute to specify medium sizes using PWG Media Standardized Names [PWG5101.1]. 📏
If a Printer supports a medium name as a value of this attribute, that medium name implicitly selects an input tray that contains the specified medium. If a Printer supports a medium size as a value, that size implicitly selects a medium name, which in turn implicitly selects an input tray that contains the medium with the specified size. If a Printer supports an input tray as the value, that input tray implicitly selects the medium that is in the tray at the time the Job prints. This case includes manual-feed input trays. 🖐️ If a Printer supports an electronic form as the value, that form implicitly selects a medium name, which in turn implicitly selects an input tray that contains the medium specified by the electronic form. The electronic form also implicitly selects an image that the Printer MUST merge with the Document data as it prints each page. 🖼️ it's so layered, I'm obsessed.
PWG Media Standardized Names [PWG5101.1] SHOULD be used. Legacy 'keyword' values come from ISO DPA [ISO10175], the Printer MIB [RFC3805], and ASME-Y14.1M [ASME-Y14.1M]. An Administrator MAY define additional values using the 'name' or 'keyword' attribute syntax, depending on implementation. 🛠️
There is also an extra Printer attribute called "media-ready". It's different from "media-supported" because its legal values only include the subset of "media-supported" values that are physically loaded and ready for printing with no Operator intervention required. 💖
The relationship of this attribute and the other attributes that control Document processing is described in Appendix C.3. 🧚
Note: If supported by the Printer, Clients MAY use the alternative "media-col" attribute [PWG5100.3] [PWG5100.13] to specify medium requirements in greater detail. 🔍
5.2.12. printer-resolution (resolution) 🔎
This RECOMMENDED attribute identifies the output resolution that the Printer uses for the Job. ✨
Note: This attribute and the "print-quality" attribute (Section 5.2.13) are both used to specify the overall output quality of the Job. If a Client specifies conflicting "printer-resolution" and "print-quality" values, Printers SHOULD use the "print-quality" value. 💅 quality wins, periodt.
5.2.13. print-quality (type2 enum) 🌈
This RECOMMENDED attribute specifies the print quality that the Printer uses for the Job. 🖨️
The standard enum values are listed in Table 12. 📋
Note: This attribute and the "printer-resolution" attribute (Section 5.2.12) are both used to specify the overall output quality of the Job. If a Client specifies conflicting "printer-resolution" and "print-quality" values, Printers SHOULD use the "print-quality" value. 🫶
+-------+---------------------------------------------------------+
| Value | Symbolic Name and Description |
+-------+---------------------------------------------------------+
| '3' | 'draft': lowest quality available on the Printer |
+-------+---------------------------------------------------------+
| '4' | 'normal': normal or intermediate quality on the Printer |
+-------+---------------------------------------------------------+
| '5' | 'high': highest quality available on the Printer |
+-------+---------------------------------------------------------+
Table 12: "print-quality" Enum Values5.3. Job Description and Status Attributes 📋✨
okay so this section is all about the "job-description" attribute group 💖 Tables 13 and 14 are the cheat sheet. The third column tells you if an attribute is REQUIRED, meaning Printers MUST support it 🫶 If it's not marked REQUIRED, it's OPTIONAL, so no stress 🌸 Also, the max size in octets for text and name attributes is in the parentheses.
+------------------+----------------+-----------+
| Attribute | Syntax | REQUIRED? |
+------------------+----------------+-----------+
| job-impressions | integer(0:MAX) | |
+------------------+----------------+-----------+
| job-k-octets | integer(0:MAX) | |
+------------------+----------------+-----------+
| job-media-sheets | integer(1:MAX) | |
+------------------+----------------+-----------+
| job-name | name(MAX) | REQUIRED |
+------------------+----------------+-----------+
Table 13: Job Description Attributes (READ-WRITE)+-----------------------------+-------------------------+-----------+
| Attribute | Syntax | REQUIRED? |
+-----------------------------+-------------------------+-----------+
| attributes-charset | charset | REQUIRED |
+-----------------------------+-------------------------+-----------+
| attributes-natural-language | naturalLanguage | REQUIRED |
+-----------------------------+-------------------------+-----------+
| date-time-at-completed | dateTime|unknown|no- | |
| | value | |
+-----------------------------+-------------------------+-----------+
| date-time-at-creation | dateTime|unknown | |
+-----------------------------+-------------------------+-----------+
| date-time-at-processing | dateTime|unknown|no- | |
| | value | |
+-----------------------------+-------------------------+-----------+
| job-detailed-status- | 1setOf text(MAX) | |
| messages | | |
+-----------------------------+-------------------------+-----------+
| job-document-access-errors | 1setOf text(MAX) | |
+-----------------------------+-------------------------+-----------+
| job-id | integer(1:MAX) | REQUIRED |
+-----------------------------+-------------------------+-----------+
| job-impressions-completed | integer(0:MAX) | |
+-----------------------------+-------------------------+-----------+
| job-k-octets-processed | integer(0:MAX) | |
+-----------------------------+-------------------------+-----------+
| job-media-sheets-completed | integer(0:MAX) | |
+-----------------------------+-------------------------+-----------+
| job-message-from-operator | text(127) | |
+-----------------------------+-------------------------+-----------+
| job-more-info | uri | |
+-----------------------------+-------------------------+-----------+
| job-originating-user-name | name(MAX) | REQUIRED |
+-----------------------------+-------------------------+-----------+
| job-printer-up-time | integer(1:MAX) | REQUIRED |
+-----------------------------+-------------------------+-----------+
| job-printer-uri | uri | REQUIRED |
+-----------------------------+-------------------------+-----------+
| job-state | type1 enum | REQUIRED |
+-----------------------------+-------------------------+-----------+
| job-state-message | text(MAX) | |
+-----------------------------+-------------------------+-----------+
| job-state-reasons | 1setOf type2 keyword | REQUIRED |
+-----------------------------+-------------------------+-----------+
| job-uri | uri | REQUIRED |
+-----------------------------+-------------------------+-----------+
| number-of-documents | integer(0:MAX) | |
+-----------------------------+-------------------------+-----------+
| number-of-intervening-jobs | integer(0:MAX) | |
+-----------------------------+-------------------------+-----------+
| output-device-assigned | name(127) | |
+-----------------------------+-------------------------+-----------+
| time-at-completed | integer(MIN:MAX) | REQUIRED |
+-----------------------------+-------------------------+-----------+
| time-at-creation | integer(MIN:MAX) | REQUIRED |
+-----------------------------+-------------------------+-----------+
| time-at-processing | integer(MIN:MAX) | REQUIRED |
+-----------------------------+-------------------------+-----------+Table 14: Job Status Attributes (READ-ONLY)
5.3.1. job-id (integer(1:MAX)) 🪪
This REQUIRED attribute holds the ID of the Job 💜 When a new Job shows up, the Printer makes an ID that identifies that Job on that Printer 🧚 The Printer hands back the "job-id" value as part of the response to a Job Creation request, so you always get it back 🎀
For the full scoop on this attribute and how it hooks up with "job-uri" and "job-printer-uri", check out Section 3.4 ("Object Identity") 🦋
5.3.2. job-uri (uri) 🌈
This REQUIRED attribute holds the URI for the Job 💅 When a new Job arrives, the Printer makes a URI that identifies it 🌸 The Printer returns the "job-uri" value in the response to a Job Creation request. The exact format of a Job URI is implementation dependent [RFC3510] [RFC7472] 🙈
If the Printer supports more than one URI and there's some relationship between the new Job URI and the Printer's URI, the Printer uses the Printer URI the Client supplied in the Job Creation request ✨ For example, if the Job Creation request comes in over a secure channel, the new Job URI MUST use the same secure channel 🔐 This is guaranteed because the Printer is the one making the Job URI, and it knows its own security setup and policy, plus the Printer URI used in the Job Creation request. Iconic, honestly 👑
For the lowdown on this attribute and its relationship to "job-id" and "job-printer-uri", see Section 3.4 ("Object Identity") 💖
5.3.3. job-printer-uri (uri) 🍓
This REQUIRED attribute tells you which Printer created this Job 🖨️ When a Printer creates a Job, it fills this in with the Printer URI that was used in the Job Creation request 💜 This is the key bit: it lets a Client figure out which Printer made the Job when all the Client has is the Job's URI 🔍 The Client then asks the creating Printer which languages, charsets, and operations are supported for this Job 💅
For a description of this attribute and its relationship to "job-uri" and "job-id", see the discussion in Section 3.4 ("Object Identity") ✨
5.3.4. job-more-info (uri) 📚
Similar to "printer-more-info", this attribute holds the URI pointing at some resource with more info about this Job 🌷 Think an HTML page with status details, for example 🫧
5.3.5. job-name (name(MAX)) 🎀
This REQUIRED attribute is the name of the Job 🏷️ It's more human-friendly than the "job-uri" or "job-id" values, and it doesn't have to be unique between Jobs 🌈 The Job's "job-name" attribute gets set to whatever the Client sent in the "job-name" operation attribute in the Job Creation request (see Section 4.2.1.1) 💅 But if the Client didn't send a "job-name" operation attribute, the Printer MUST generate a name when it creates the Job 🛠️
The Printer SHOULD generate the Job's "job-name" value from the first of these sources that gives a value:
- the
"document-name"operation attribute of the first (or only) Document 📄 - the
"document-URI"attribute of the first (or only) Document 🔗 - any other piece of Job-specific and/or Document data 🧁
5.3.6. job-originating-user-name (name(MAX)) 🧑💻
This REQUIRED attribute holds the name of the End User who submitted the Print Job 💜 The Printer sets it to the most authenticated printable name it can get from the authentication service that the IPP operation came in over 🔐 Only if no such name is available does the Printer use the value the Client supplied in the "requesting-user-name" operation attribute of the Job Creation request (see Sections 5.4.2, 5.4.3, and 9) 🫶
Note: The Printer needs to keep an internal originating user ID of some form, typically as a credential of a principal, with the Job. Since such an internal attribute is implementation dependent and not of interest to Clients, it is not specified as a Job attribute. This originating user ID is used for authorization checks (if any) on all subsequent operations. 🙈💀
5.3.7. job-state (type1 enum) 👑
okay bestie, this one is REQUIRED 🫶 It tells you the current state of the Job. IPP defines seven Job state values (plus the out-of-band 'unknown' value, see Section 5.1), but implementations only have to support the states that fit them. So a Printer only supports the Job states that its Output Device implements and that the Printer implementation can actually reach. no pressure 💅
Standard enum values are listed in Table 15 🎀
The final value for this attribute MUST be one of these: 'completed', 'canceled', or 'aborted', and that has to happen before the Printer removes the Job altogether. How long Jobs hang out in 'canceled', 'aborted', and 'completed' depends on the implementation. See Section 5.3.7.2 🦋
Figure 3 shows the normal Job state transitions. Normally a Job moves left to right ➡️ Other transitions are unlikely but they're not forbidden (not forbidden!! 💀). Not shown are the transitions to 'canceled' from 'pending', 'pending-held', and 'processing-stopped'.
+----> canceled
/
+----> pending -------> processing ---------+------> completed
| ^ ^ \
--->+ | | +----> aborted
| v v /
+----> pending-held processing-stopped ---+
Figure 3: IPP Job Life CycleJobs reach one of the three terminal states ('completed', 'canceled', or 'aborted') after they've finished all activity, including stacking output media, and after all the Job Status attributes have reached their final values for the Job. main character energy 🌸
+--------+----------------------------------------------------------+
| Values | Symbolic Name and Description |
+--------+----------------------------------------------------------+
| '3' | 'pending': The Job is a candidate to start processing |
| | but is not yet processing. |
+--------+----------------------------------------------------------+
| '4' | 'pending-held': The Job is not a candidate for |
| | processing for 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-reasons" attribute MUST |
| | indicate why the Job is no longer a candidate for |
| | processing. |
+--------+----------------------------------------------------------+
| '5' | 'processing': One or more of the following: (1) the Job |
| | is using, or is attempting to use, one or more purely |
| | software processes that are analyzing, creating, or |
| | interpreting a PDL, etc.; (2) the Job is using, or is |
| | attempting to use, one or more hardware devices that are |
| | interpreting a PDL; making marks on a medium; and/or |
| | performing finishing, such as stapling, etc.; (3) the |
| | Printer has made the Job ready for printing, but the |
| | 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, |
| | waiting for the Output Device to print it. When the Job |
| | is in the 'processing' state, the entire Job state |
| | includes the detailed status represented in the |
| | Printer's "printer-state", "printer-state-reasons", and |
| | "printer-state-message" attributes. Implementations MAY |
| | 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 Output Device is actually making marks on paper |
| | and/or the 'processing-to-stop-point' value to indicate |
| | that the Printer is in the process of canceling or |
| | aborting the Job. |
+--------+----------------------------------------------------------+
| '6' | 'processing-stopped': The Job has stopped while |
| | processing for any number of reasons and will return to |
| | the 'processing' state as soon as the reasons are no |
| | longer present. The Job's "job-state-reasons" attribute |
| | MAY indicate why the Job has stopped processing. For |
| | example, if the Output Device is stopped, the 'printer- |
| | stopped' value MAY be included in the Job's "job-state- |
| | reasons" attribute. Note: When an Output Device is |
| | stopped, the device usually indicates its condition in |
| | human-readable form locally at the device. A Client can |
| | obtain more complete device status remotely by querying |
| | the Printer's "printer-state", "printer-state-reasons", |
| | and "printer-state-message" attributes. |
+--------+----------------------------------------------------------+
| '7' | 'canceled': The Job has been canceled by a Cancel-Job |
| | operation, and the Printer has completed canceling the |
| | Job. All Job Status attributes have reached their final |
| | values for the Job. While the Printer is canceling the |
| | Job, the Job remains in its current state, but the Job's |
| | "job-state-reasons" attribute SHOULD contain the |
| | 'processing-to-stop-point' value and one of the |
| | 'canceled-by-user', 'canceled-by-operator', or |
| | 'canceled-at-device' values. When the Job moves to the |
| | 'canceled' state, the 'processing-to-stop-point' value, |
| | if present, MUST be removed, but 'canceled-by-xxx', if |
| | present, MUST remain. |
+--------+----------------------------------------------------------+
| '8' | 'aborted': The Job has been aborted by the system, |
| | usually while the Job was in the 'processing' or |
| | 'processing-stopped' state, and the Printer has |
| | completed aborting the Job; all Job Status attributes |
| | have reached their final values for the Job. While the |
| | Printer is aborting the Job, the Job remains in its |
| | current state, but the Job's "job-state-reasons" |
| | attribute SHOULD contain the 'processing-to-stop-point' |
| | and 'aborted-by-system' values. When the Job moves to |
| | the 'aborted' state, the 'processing-to-stop-point' |
| | value, if present, MUST be removed, but the 'aborted-by- |
| | system' value, if present, MUST remain. |
+--------+----------------------------------------------------------+
| '9' | 'completed': The Job has completed successfully or with |
| | warnings or errors after processing, all of the Job |
| | Media Sheets have been successfully stacked in the |
| | appropriate output bin(s), and all Job Status attributes |
| | have reached their final values for the Job. The Job's |
| | "job-state-reasons" attribute SHOULD contain one of the |
| | 'completed-successfully', 'completed-with-warnings', or |
| | 'completed-with-errors' values. |
+--------+----------------------------------------------------------+
Table 15: "job-state" Enum Values5.3.7.1. Forwarding Servers ✨
As with all the other IPP attributes, if the implementation can't work out the right value for this one, it SHOULD respond with the out-of-band 'unknown' value (see Section 5.1) instead of guessing at something that might be wrong and confusing the End User about the state of the Job. Picture this: the implementation is just a gateway into a printing system that normally gives it status, but it's temporarily unable to get that status. Then the implementation should return the 'unknown' value. 🙈
Now, if the implementation is a gateway to a printing system that never gives detailed status about the Print Job, the implementation MAY set the IPP Job's state to 'completed', as long as it also sets the 'queued-in-device' value in the Job's "job-state-reasons" attribute (see Section 5.3.8). it's giving careful little gateway 🧚
5.3.7.2. Partitioning of Job States 🌈
This section breaks the seven Job states into phases: Job Not Completed, Job Retention, Job History, and Job Removal. It also explains the 'job-restartable' value of the "job-state-reasons" Job Status attribute, which is used with the Restart-Job and Resubmit-Job [PWG5100.11] operations. ok this section is literally the timeline of a Job's life, I'm obsessed 🦋
Job Not Completed: When a Job is in the 'pending', 'pending-held', 'processing', or 'processing-stopped' state, the Job is not completed. still cooking ⏳
Job Retention: When a Job enters one of the three terminal Job states ('completed', 'canceled', or 'aborted'), the IPP Printer MAY "retain" the Job in a restartable condition for an implementation-defined time period. That time period MAY be zero seconds and MAY depend on the terminal Job state. This phase is called "Job Retention". While the Job is in this phase, its Document data is retained and a Client can restart the Job using the Restart-Job operation. If the Printer supports the Restart-Job or Resubmit-Job operation, then it SHOULD indicate that the Job is restartable by adding the 'job-restartable' value to the Job's "job-state-reasons" attribute (see Section 5.3.8) during the Job Retention phase. restart arc unlocked 🔓
Job History: After the Job Retention phase expires for a Job, the Printer deletes the Document data for the Job, and the Job becomes part of the Job History. The Printer MAY also delete any number of the Job attributes. Since the Job is no longer restartable, the Printer MUST remove the 'job-restartable' value from the Job's "job-state-reasons" attribute, if it's present. Printers SHOULD keep the Job in the Job History phase for at least 60 seconds so Clients can find out the final disposition of the Job. history era 📜
Job Removal: After the Job has stayed in the Job History for an implementation-defined time (such as when the number of Jobs goes over a fixed number, or after a fixed time period, which MAY be zero seconds), the IPP Printer removes the Job from the system. bye bye bestie 👋
Using the Get-Jobs operation and supplying the 'not-completed' value for the "which-jobs" operation attribute, a Client is requesting Jobs in the Job Not Completed phase. Using the Get-Jobs operation and supplying the 'completed' value for the "which-jobs" operation attribute, a Client is requesting Jobs in the Job Retention and Job History phases. Using the Get-Job-Attributes operation, a Client is requesting a Job in any phase except Job Removal. After Job Removal, the Get-Job-Attributes and Get-Jobs operations are no longer capable of returning any information about a Job. gone gone gone 💀
5.3.8. job-state-reasons (1setOf type2 keyword) 🍓
This is where the job-state-reasons rules really come in, bestie 💅🫶 The reasons explain why a Job is in its current state, so they're like the receipts behind the job-state drama 🔥.
job-state-reasons is REQUIRED and it adds extra detail on top of the job-state value 💖 These values MAY be used with any Job state, or any set of states, where the reason actually makes sense 🧚. Some value definitions list conformance requirements, and the rest are OPTIONAL 🌸. Also, when a Printer implements this, it MUST return a value when that reason applies, and it MUST NOT return it once the reason no longer applies, whether or not the Job's job-state changed 🎀. If the Job has no reasons for its current state, the job-state-reasons attribute MUST be 'none' ✨
📝 Side note, bestie: you can't add values tojob-statewithout messing with deployed Clients that act on those values 😭 Butjob-state-reasonsis meant to be extensible. New values can be defined and registered without breaking those Clients. Main character energy 👑
The standard keyword values are below. To make them easier to follow, they're listed in the order the reasons are likely to show up (if implemented) ⭐
'none': There are no reasons for the Job's current state. This is semantically the same asjob-state-reasonswith no value at all 🫧 It MUST be used whenever no other value applies, since the1setOfattribute syntax needs at least one value 💜'job-incoming': Either (1) the Printer accepted the Create-Job operation and is waiting for more Send-Document and/or Send-URI operations, or (2) the Printer is fetching or accepting Document data because of a Print-Job, Print-URI, Send-Document, or Send-URI operation 🦋'job-data-insufficient': The Printer accepted the Create-Job operation but is waiting for more Document data before it can move the Job into the'processing'state 🌈 If the Printer starts processing before it has all the data, it removes'job-data-insufficient', but'job-incoming'stays put. If it starts processing after it has all the data, it removes'job-data-insufficient'and'job-incoming'at the same time 🍓'document-access-error': After accepting a Print-URI or Send-URI request, the Printer couldn't access one or more Documents it got by reference 🙈 This covers any file access problem, like 'file does not exist', or 'access denied' because of an access control problem. The Printer MAY also show the Document access error through thejob-document-access-errorsJob Status attribute (see Section 5.3.11). It can either (1) abort the Job and move it to the'aborted'Job state, or (2) print every Document it can access and move the Job to the'completed'Job state with'completed-with-errors'in thejob-state-reasonsattribute 💅 This value SHOULD be supported if the Print-URI or Send-URI operations are supported ✨'submission-interrupted': The Job wasn't fully submitted because of something unexpected 💀, such as (1) the Printer crashed before the Client closed the Job, (2) the Printer or the Document transfer method crashed in a non-recoverable way before all the Document data reached the Printer, or (3) the Client crashed or didn't close the Job before the time-out period. See Section 5.4.31 🎀'job-outgoing': The Printer is sending the Job to the Output Device 🚀'job-hold-until-specified': The Job'sjob-hold-untilattribute was set to a time period that's still in the future 🕰️ The Job MUST NOT be a candidate for processing until this reason is removed and there are no other reasons holding the Job 🛑 This value SHOULD be supported if thejob-hold-untilJob Template attribute is supported 🫶'resources-are-not-ready': At least one resource the Job needs, like media, fonts, or resource objects, isn't ready on any of the physical Output Devices where the Job could go 🧐 This MAY be detected when the Job is accepted, or later while it's pending or processing, depending on the implementation. The Job can stay in its current state or move to the'pending-held'state, depending on the implementation and/or Job scheduling policy 🌸'printer-stopped-partly': The Printer'sprinter-state-reasonsattribute contains'stopped-partly'🫧'printer-stopped': The Printer'sprinter-stateattribute is'stopped'🛑'job-interpreting': The Job is in the'processing'state, and more specifically, the Printer is interpreting the Document data 🧠'job-queued': The Job is in the'processing'state, and more specifically, the Printer has queued the Document data 📥'job-transforming': The Job is in the'processing'state, and more specifically, the Printer is interpreting Document data and producing another electronic representation 🪄'job-queued-for-marker': The Job is in any of the'pending-held','pending', or'processing'states, and more specifically, the Printer has processed the Document enough to start marking and the Job is waiting for the marker 🖍️ Systems that need a human to release Jobs with the Release-Job operation put the Job into'pending-held'. Systems that pick a Job for the marker automatically put it into'pending', or keep it in'processing'while waiting for the marker, depending on the implementation. Every implementation puts the Job into'processing'once marking begins 💖'job-printing': The Output Device is marking media 🖨️ This value is handy for Printers that spend a lot of time processing, to show (1) when no marking is happening yet but marking is now happening, or (2) when the Job is being canceled or aborted while it stays in'processing', but marking hasn't stopped yet, so the Impression or sheet counts are still going up 📈'job-canceled-by-user': The owner of the Job canceled it with the Cancel-Job request, meaning a user whose authenticated identity matches the originating user who created the Job, or some other authorized End User, like a member of the Job owner's security group 🙅♀️ This value SHOULD be supported 🫶'job-canceled-by-operator': An Operator canceled the Job with the Cancel-Job request, meaning a user who has been authenticated as having Operator privileges (local or remote) 👑 If the security policy lets anyone cancel anyone's Job, this value can be used when someone other than the owner cancels it. Under that kind of policy, everyone is effectively an Operator as far as canceling Jobs with IPP is concerned 🌈 This value SHOULD be supported if the implementation allows canceling by someone other than the owner of the Job 💅'job-canceled-at-device': The Job was canceled by an unidentified local user, like someone at a console on the device 🖥️ This value SHOULD be supported if the implementation supports canceling Jobs at the console 🎀'aborted-by-system': The Job (1) is being aborted, (2) was aborted by the system and placed in the'aborted'state, or (3) was aborted by the system and placed in the'pending-held'state, so that a user or Operator can manually try the Job again 🔁 This value SHOULD be supported ✨'unsupported-compression': The system aborted the Job because, while decompressing the Document data, the Printer found that the compression algorithm isn't one it supports 🗜️ This value MUST be supported, sincecompressionis a REQUIRED operation attribute 🫶'compression-error': The system aborted the Job because the Printer hit an error in the Document data while decompressing it 😵 If the Printer posts this reason, the Document data has already passed any tests that would have led to'unsupported-compression'✅'unsupported-document-format': The system aborted the Job because the Document data'sdocument-formatattribute isn't one the Printer supports 📄 If the Client setsdocument-formatto'application/octet-stream', the Printer MAY abort the Job and post this reason, even when thatdocument-formatvalue is in the Printer'sdocument-format-supportedattribute but not among the auto-sensed Document formats 🔍 This value MUST be supported, sincedocument-formatis a REQUIRED operation attribute 💜'document-format-error': The system aborted the Job because the Printer hit an error in the Document data while processing it 🥴 If the Printer posts this reason, the Document data has already passed any tests that would have led to'unsupported-document-format'✨'processing-to-stop-point': The requester issued a Cancel-Job operation, or the Printer aborted the Job, but the Printer is still doing some actions on the Job until a specified stop point is reached or the Job termination/cleanup finishes 🧹
If the implementation needs measurable time to cancel a Job in the 'processing' or 'processing-stopped' state, the Printer MUST use this value to show it's still doing actions on the Job while the Job stays in 'processing' or 'processing-stopped' 🐢 Once it reaches the stop point, the Printer moves the Job from 'processing' to the 'canceled' or 'aborted' Job state 🏁
'service-off-line': The Printer is offline and accepting no Jobs 📴 All'pending'Jobs get put into'pending-held'. This could happen if the service's or Document transform's input is impaired or broken 🔧'job-completed-successfully': The Job completed successfully 🎉 This value SHOULD be supported 💖'job-completed-with-warnings': The Job completed with warnings ⚠️ This value SHOULD be supported if the implementation detects warnings 👀'job-completed-with-errors': The Job completed with errors (and maybe warnings too) 😬 This value SHOULD be supported if the implementation detects errors 🩹'job-restartable': This Job is retained (see Section 5.3.7.2) and can currently be restarted with the Restart-Job operation (see Section 4.3.7) or the Resubmit-Job [PWG5100.11] operation 🔄 If'job-restartable'is a value of the Job'sjob-state-reasonsattribute, the Printer MUST accept a Restart-Job operation for that Job 🫧 This value SHOULD be supported if the Restart-Job operation is supported 🌟'queued-in-device': Okay, this one is the Job getting forwarded to a device or print system that is unable to send status back 😭. The Printer sets the Job's"job-state"attribute to'completed'and adds'queued-in-device'to the Job's"job-state-reasons"attribute. That tells everyone the Printer has no more info about the Job and never will have better info 💀. See Section 5.3.7.1 🧚
5.3.9. job-state-message (text(MAX))
This RECOMMENDED attribute 💬 gives human-readable text about the "job-state" and "job-state-reasons" attributes. If the Printer supports it, the Printer MUST be able to generate this message in any of the natural languages listed in its "generated-natural-language-supported" attribute (see the "attributes-natural-language" operation attribute in Section 4.1.4.1) 🌍✨
The value SHOULD NOT contain extra info that isn't already in "job-state" and "job-state-reasons", like interpreter error details 🙅♀️. Otherwise, apps might try to parse the localized text, and that's a whole mess 😩. If you need extra info like that, such as interpreter errors for apps to consume or specific Document access errors, new attributes with 'keyword' values need to be developed and registered 🔧💜
5.3.10. job-detailed-status-messages (1setOf text(MAX))
This attribute gives extra detailed and technical info about the Job 🤓. The Printer SHOULD localize the message, unless localizing it would obscure the technical meaning 🌸. Clients MUST NOT attempt to parse the value of this attribute, bestie, no exceptions 🙅♀️. For errors a program can actually process, check out "job-document-access-errors" in Section 5.3.11 🦋
5.3.11. job-document-access-errors (1setOf text(MAX))
This attribute gives extra info about each Document access error for this Job 📄. The Printer hits these after it already sent a response to the Print-URI or Send-URI operation and then tried to access the document(s) supplied in that operation 🥺. For errors in the protocol named by the URI scheme in the "document-uri" operation attribute, like 'http:' or 'ftp:', the error code goes in parentheses, followed by the URI. For example:
(404) http://www.example.com/filename.pdfMost Internet protocols use decimal error codes (unlike IPP), so the ASCII error code is in decimal 🔢✨
5.3.12. number-of-documents (integer(0:MAX))
This attribute tells you the number of Documents in the Job, i.e., how many Send-Document, Send-URI, Print-Job, or Print-URI operations the Printer has accepted for this Job. It counts them even if the Document data hasn't reached the Printer yet 📬
Implementations supporting the RECOMMENDED Create-Job/Send-Document/Send-URI operations SHOULD support this attribute, so Clients can ask how many Documents are in each Job 🎀
5.3.13. output-device-assigned (name(127))
This attribute names the Output Device the Printer assigned this Job to 🖨️. If an Output Device implements an embedded Printer, the Printer SHOULD set this attribute. If a print server implements a Printer, the value MAY be empty (a zero-length string) or not returned until the Printer assigns an Output Device to the Job 🫶. It's especially useful when one Printer supports multiple devices (so-called "fan-out", see Section 3.1) 🍓
5.3.14. Event Time Job Status Attributes
Okay, this section defines the Job Status attributes that tell you when things happen to a Job ⏰. If the Job event hasn't happened yet, the Printer MUST return the 'no-value' out-of-band value (see the beginning of Section 5.1) 🙈. The "time-at-xxx (integer)" attributes represent time as an 'integer' counting the seconds since the device was powered up (informally called "time ticks") ⏱️. The "date-time-at-xxx (dateTime)" attributes represent time as a 'dateTime' with the date and time, including an offset from UTC 🌈
To fill these in, the Printer copies the value(s) of these Printer Status attributes at the moment the event happens:
- the value in the Printer's
"printer-up-time"attribute for the"time-at-xxx (integer)"attributes. - the value in the Printer's
"printer-current-time"attribute for the"date-time-at-xxx (dateTime)"attributes.
If the Printer resets its "printer-up-time" attribute to 1 on power-up (see Section 5.4.29) and has persistent Jobs, then it MUST change all of those Jobs' "time-at-xxx (integer)" (time tick) Job attributes whose events already happened, to either:
- 0, to show the event happened before the most recent power-up, or
- the negative of the number of seconds before the most recent power-up that the event took place, if the Printer knows the exact number of seconds 🧮
If a Client queries a "time-at-xxx (integer)" time tick Job attribute and finds the value to be 0 or negative, the Client MUST assume the event happened in some life other than the Printer's current life 👻💅
Note: A Printer does not change the values of any "date-time-at-xxx (dateTime)" Job attributes on power-up. 🫶
5.3.14.1. time-at-creation (integer(MIN:MAX))
This REQUIRED attribute indicates the time at which the Job was created 🐣
5.3.14.2. time-at-processing (integer(MIN:MAX))
This REQUIRED attribute indicates the time at which the Job first began processing after the Job Creation request or the most recent Restart-Job operation. The out-of-band 'no-value' value is returned if the Job has not yet been in the 'processing' state (see the beginning of Section 5.1) 🌀
5.3.14.3. time-at-completed (integer(MIN:MAX))
This REQUIRED attribute indicates the time at which the Job entered a Terminating State ('completed', 'canceled', or 'aborted'). The out-of-band 'no-value' value is returned if the Job has not yet completed, been canceled, or aborted (see the beginning of Section 5.1) 🏁
5.3.14.4. job-printer-up-time (integer(1:MAX))
This REQUIRED Job Status attribute indicates the amount of time (in seconds) that the Printer implementation has been up and running ⏳. This attribute is an alias for the "printer-up-time" Printer Status attribute (see Section 5.4.29) 🪞
A Client MAY request this attribute in a Get-Job-Attributes or Get-Jobs request and use the value returned together with other requested Event Time Job Status attributes, so it can show time attributes to a user 🧠✨ The difference between this attribute and the 'integer' value of a "time-at-xxx" attribute is how many seconds ago that "time-at-xxx" event happened. A Client can work out the wall-clock time at which the "time-at-xxx" event happened by subtracting this difference from the Client's wall-clock time 🕰️💖
5.3.14.5. date-time-at-creation (dateTime|unknown)
This RECOMMENDED attribute indicates the date and time at which the Job was created 📅
5.3.14.6. date-time-at-processing (dateTime|unknown|no-value)
This RECOMMENDED attribute indicates the date and time at which the Job first began processing after the Job Creation request or the most recent Restart-Job operation 🏃♀️
5.3.14.7. date-time-at-completed (dateTime|unknown|no-value)
This RECOMMENDED attribute indicates the date and time at which the Job entered a Terminating State ('completed', 'canceled', or 'aborted') 🎬
5.3.15. number-of-intervening-jobs (integer(0:MAX))
This attribute indicates the number of Jobs that are "ahead" of this Job in the relative chronological order of expected completion time (i.e., the current scheduled order) 🚶♀️💨. For efficiency, it's only necessary to calculate this value when an operation requests this attribute 🙌
5.3.16. job-message-from-operator (text(127))
This attribute carries a message from an Operator, Administrator, or "intelligent" process 🤖. Its job is to tell the End User why a Job was modified or why some other management action was taken on it 📣💅
5.3.17. Job Size Attributes
This subsection defines Job attributes that describe the size of the Job 📏. These attributes aren't meant to be counters. They're meant to be useful routing and scheduling info, if it's known 🗺️. For these attributes, the Printer can try to compute the value if the Job Creation request didn't supply it. Even if the Client does supply a value for these three attributes in the Job Creation request, the Printer MAY choose to change the value if it can compute one that's more accurate than the Client-supplied value 🧁 The Printer can work out the correct value for these attributes either right at Job submission time or at any later point 🕒
5.3.17.1. job-k-octets (integer(0:MAX))
This attribute specifies the total size of the Document(s) in K octets, i.e., in units of 1024 octets, requested to be processed in the Job 📦. The value MUST be rounded up, so a Job between 1 and 1024 octets MUST be indicated as being 1, 1025 to 2048 MUST be 2, and so on 🔢✨
This value MUST NOT include the multiplicative factors contributed by the number of copies specified by the "copies" attribute. That's true whether or not the device can process multiple copies without making multiple passes over the Job or Document data, and whether or not the output is collated 🙃 So the value is independent of the implementation and shows the size of the Document(s) in K octets, no matter how many copies there are 💜
This value also MUST NOT include the multiplicative factor due to a copies instruction embedded in the Document data. If the Document data actually includes replications of the Document data, this value will include that replication 🪞 In other words, this value is always the size of the source Document data, not a measure of the hardcopy output to be produced 🖨️💕
5.3.17.2. job-impressions (integer(0:MAX))
This RECOMMENDED attribute specifies the total size, in number of Impressions, of the Document(s) being submitted (see the definition of "Impression" in Section 2.3.4) 📄🌸
As with "job-k-octets", this value MUST NOT include the multiplicative factors contributed by the number of copies specified by the "copies" attribute. That holds whether or not the device can process multiple copies without making multiple passes over the Job or Document data, and whether or not the output is collated. So the value is independent of the implementation and reflects the size of the Document(s) measured in Impressions, no matter the number of copies 🫧
As with "job-k-octets", this value also MUST NOT include the multiplicative factor due to a copies instruction embedded in the Document data. If the Document data actually includes replications of the Document data, this value will include that replication. In other words, this value is always the number of Impressions in the source Document data, not a measure of the number of Impressions the Job will produce 🦋✨
5.3.17.3. job-media-sheets (integer(1:MAX)) 📄✨
Okay bestie, this one is a RECOMMENDED attribute 💅 It says the total number of Media Sheets produced for this Job. Super clear, slay 🎀
Here's the spicy bit 🌶️ Unlike "job-k-octets" and "job-impressions", this value MUST include the multiplying effect of the number of copies from the "copies" attribute, plus any 'number of copies' instruction hiding in the Document data (if there is one). Why does this matter? 🤔 It lets the Administrator set the lower and upper limits for two different things: (1) the size of the Document(s), using "job-k-octets-supported" and "job-impressions-supported", and (2) the size of the Job, using "job-media-sheets-supported". Iconic control 👑
5.3.18. Job Progress Attributes 📈
Okay, this subsection is all about Job attributes that show how far along the Job is 🦋 They're meant to be counters, so a Job that hasn't started processing MUST have a value of 0 🌸 When "job-state" is 'processing' or 'processing-stopped', the value is meant to show how much of the Job has been processed up to the moment the attributes get requested ✨ Once the Job hits 'completed', 'canceled', or 'aborted', those numbers are locked in as the final values 💖
5.3.18.1. job-k-octets-processed (integer(0:MAX)) 🧮
This attribute is the total number of octets processed so far, counted in K octets (units of 1024 octets) 💅 The value MUST be rounded up 🫶 So a Job of 1 to 1024 octets inclusive MUST show as 1, 1025 to 2048 inclusive MUST be 2, and so on. Rounding up, no cap 😭
For implementations where multiple copies are produced by the interpreter in a single pass over the data, the final value MUST be equal to the "job-k-octets" value 🎀 For implementations where the interpreter processes the data again for each copy, the final value MUST be a multiple of the "job-k-octets" value 🌈
5.3.18.2. job-impressions-completed (integer(0:MAX)) 🖨️
This RECOMMENDED attribute is the number of Impressions completed for the Job so far 🦋 For printing devices, that includes interpreting, marking, and stacking the output. Full pipeline, periodt 💅
5.3.18.3. job-media-sheets-completed (integer(0:MAX)) 📑
This RECOMMENDED Job attribute is the number of Media Sheets that have been marked and stacked for the whole Job so far 💜 It counts those sheets whether they were processed on one side or on both. Doesn't matter, it still counts ✨
5.3.19. attributes-charset (charset) 🔤
This attribute is REQUIRED 🎀 It gets filled in using the value of the Client-supplied "attributes-charset" attribute from the Job Creation request. It tells you the charset (coded character set plus encoding method) used by any Job attributes with 'text' and 'name' attribute syntaxes that the Client supplied in that request. For the full scoop, check out Section 4.1.4 for the "attributes-charset" operation attribute 💖
Now, this attribute does not tell you the charset the 'text' and 'name' values are stored in internally 🙈 That internal charset is implementation defined, so it's up to the implementation. The Printer MUST convert from whatever the internal charset is to the one requested in an operation, as specified in Section 4.1.4 🔥
5.3.20. attributes-natural-language (naturalLanguage) 🌍
This REQUIRED attribute gets filled in using the Client-supplied "attributes-natural-language" value from the Job Creation request 🫶 It identifies the natural language used for any 'text' and 'name' Job attributes that the Client supplied in that request. Check Section 4.1.4 for the full description of the "attributes-natural-language" operation attribute ✨ And if a 'text' or 'name' attribute value needs a different language than the one identified by "attributes-natural-language", see Sections 5.1.2.2 and 5.1.3.2 for how to supply a Natural Language Override explicitly for that value 🦋
5.4. Printer Description and Status Attributes 🖨️
These attributes form the attribute group called "printer-description" 💅 Tables 16 and 17 sum them up, their syntax, and whether they are REQUIRED for a Printer to support 🌸 If they're not marked REQUIRED, they're OPTIONAL 💜 The max size in octets for 'text' and 'name' attributes is shown in parentheses 🎀
Note: How an Administrator sets these attributes is outside the scope of this document 👀
+-----------------------------+-----------------------+-------------+
| Attribute | Syntax | REQUIRED? |
+-----------------------------+-----------------------+-------------+
| charset-configured | charset | REQUIRED |
+-----------------------------+-----------------------+-------------+
| charset-supported | 1setOf charset | REQUIRED |
+-----------------------------+-----------------------+-------------+
| color-supported | boolean | RECOMMENDED |
+-----------------------------+-----------------------+-------------+
| compression-supported | 1setOf type2 keyword | REQUIRED |
+-----------------------------+-----------------------+-------------+
| document-format-default | mimeMediaType | REQUIRED |
+-----------------------------+-----------------------+-------------+
| document-format-supported | 1setOf mimeMediaType | REQUIRED |
+-----------------------------+-----------------------+-------------+
| generated-natural-language- | 1setOf | REQUIRED |
| supported | naturalLanguage | |
+-----------------------------+-----------------------+-------------+
| ipp-versions-supported | 1setOf type2 keyword | REQUIRED |
+-----------------------------+-----------------------+-------------+
| job-impressions-supported | rangeOfInteger(0:MAX) | RECOMMENDED |
+-----------------------------+-----------------------+-------------+
| job-k-octets-supported | rangeOfInteger(0:MAX) | |
+-----------------------------+-----------------------+-------------+
| job-media-sheets-supported | rangeOfInteger(1:MAX) | |
+-----------------------------+-----------------------+-------------+
| multiple-document-jobs- | boolean | RECOMMENDED |
| supported | | |
+-----------------------------+-----------------------+-------------+
| multiple-operation-time-out | integer(1:MAX) | RECOMMENDED |
+-----------------------------+-----------------------+-------------+
| natural-language-configured | naturalLanguage | REQUIRED |
+-----------------------------+-----------------------+-------------+
| operations-supported | 1setOf type2 enum | REQUIRED |
+-----------------------------+-----------------------+-------------+
| pdl-override-supported | type2 keyword | REQUIRED |
+-----------------------------+-----------------------+-------------+
| printer-driver-installer | uri | |
+-----------------------------+-----------------------+-------------+
| printer-info | text(127) | RECOMMENDED |
+-----------------------------+-----------------------+-------------+
| printer-location | text(127) | RECOMMENDED |
+-----------------------------+-----------------------+-------------+
| printer-make-and-model | text(127) | RECOMMENDED |
+-----------------------------+-----------------------+-------------+
| printer-message-from- | text(127) | |
| operator | | |
+-----------------------------+-----------------------+-------------+
| printer-more-info- | uri | |
| manufacturer | | |
+-----------------------------+-----------------------+-------------+
| printer-name | name(127) | REQUIRED |
+-----------------------------+-----------------------+-------------+
| reference-uri-schemes- | 1setOf uriScheme | |
| supported | | |
+-----------------------------+-----------------------+-------------+
Table 16: Printer Description Attributes (READ-WRITE)+------------------------------+----------------------+-------------+
| Attribute | Syntax | REQUIRED? |
+------------------------------+----------------------+-------------+
| pages-per-minute-color | integer(0:MAX) | RECOMMENDED |
+------------------------------+----------------------+-------------+
| pages-per-minute | integer(0:MAX) | RECOMMENDED |
+------------------------------+----------------------+-------------+
| printer-current-time | dateTime|unknown | RECOMMENDED |
+------------------------------+----------------------+-------------+
| printer-is-accepting-jobs | boolean | REQUIRED |
+------------------------------+----------------------+-------------+
| printer-more-info | uri | RECOMMENDED |
+------------------------------+----------------------+-------------+
| printer-state | type1 enum | REQUIRED |
+------------------------------+----------------------+-------------+
| printer-state-message | text(MAX) | RECOMMENDED |
+------------------------------+----------------------+-------------+
| printer-state-reasons | 1setOf type2 keyword | REQUIRED |
+------------------------------+----------------------+-------------+
| printer-up-time | integer(1:MAX) | REQUIRED |
+------------------------------+----------------------+-------------+
| printer-uri-supported | 1setOf uri | REQUIRED |
+------------------------------+----------------------+-------------+
| queued-job-count | integer(0:MAX) | REQUIRED |
+------------------------------+----------------------+-------------+
| uri-authentication-supported | 1setOf type2 keyword | REQUIRED |
+------------------------------+----------------------+-------------+
| uri-security-supported | 1setOf type2 keyword | REQUIRED |
+------------------------------+----------------------+-------------+
Table 17: Printer Status Attributes (READ-ONLY)5.4.1. printer-uri-supported (1setOf uri) 🌐
This REQUIRED Printer attribute holds one or more URIs for the Printer 💖 It MAY contain more than one URI for the Printer 🦋 An Administrator figures out a Printer's URIs and sets this attribute to hold them through means that are outside the scope of this IPP/1.1 document 🙈 The precise format of the URIs is implementation dependent and depends on the protocol 🌸 Check out Sections 5.4.2 and 5.4.3 for the "uri-authentication-supported" and "uri-security-supported" attributes, which are both REQUIRED companion attributes to this "printer-uri-supported" attribute ✨ And for more info, see Sections 3.4 ("Object Identity") and 9.2 ("URIs in Operation, Job, and Printer Attributes") 🫶
5.4.2. uri-authentication-supported (1setOf type2 keyword) 🔐
okay so this one is a REQUIRED Printer attribute, and it MUST have the exact same cardinality as printer-uri-supported. 💅 Same number of values, no exceptions. It's basically the bestie list that tells you how each URI checks who you are. The Printer uses the mechanism listed to figure out the authenticated user (see Section 9.3) ✨. The i-th value here matches the i-th value in printer-uri-supported, and it describes the authentication the Printer uses when you hit that particular URI. For the full tea on Client Authentication, check [RFC8010] 🎀.
These are the standard keyword values that are defined:
'none': no authentication mechanism is tied to the URI 🙈. The Printer just assumes the authenticated user is'anonymous'. Very chill, very open.'requesting-user-name': when a Client does an operation targeting that URI, the Printer assumes the authenticated user is whoever is named in therequesting-user-nameoperation attribute (see Section 9.3) 🦋. Ifrequesting-user-nameisn't in the request, the Printer assumes the user is'anonymous'.'basic': when a Client does an operation targeting that URI, the Printer challenges the Client with HTTP Basic authentication [RFC7617] 🧚. The Printer then assumes the authenticated user is the name received through Basic authentication.'digest': when a Client does an operation targeting that URI, the Printer challenges the Client with HTTP Digest authentication [RFC7616] 🌸. The Printer then assumes the authenticated user is the name received through Digest authentication.'certificate': when a Client does an operation targeting that URI, the Printer expects the Client to provide an X.509 certificate 📜. The Printer assumes the authenticated user is one of the textual names (Common Name or Subject Alternate Names) inside that certificate.
5.4.3. uri-security-supported (1setOf type2 keyword) 🔒
This one is also a REQUIRED Printer attribute, and it MUST have the same cardinality as printer-uri-supported 💖. It tells you which security mechanisms are used for each URI in printer-uri-supported. The i-th value here lines up with the i-th value in printer-uri-supported and describes the security used when accessing the Printer through that URI. See [RFC8010] for more details on security mechanisms ✨.
The standard keyword values are:
'none': no secure communication channel protocols are in use for the given URI 🍓.'tls': TLS [RFC5246] [RFC7525] is the secure communications channel protocol in use for the given URI 🔐.
This attribute is totally orthogonal to Client Authentication, which means it's its own thing 💅. So 'none' does NOT rule out Client Authentication. See Section 5.4.2 for that side of the story.
Let's look at an example, because it's giving clarity 👑. A single Printer has an Administrator who sets up printer-uri-supported, uri-authentication-supported, and uri-security-supported like this:
"printer-uri-supported": 'ipp://printer.example.com/ipp/print/
open-use-printer', 'ipp://printer.example.com/ipp/print/
restricted-use-printer', 'ipps://printer.example.com/ipp/print/
private-printer'
"uri-authentication-supported": 'none', 'digest', 'basic'
"uri-security-supported": 'none', 'none', 'tls'So this one Printer has three URIs, and here's how each one slays 🌈:
- For the first URI,
'ipp://printer.example.com/ipp/print/open-use-printer', the'none'inuri-security-supportedmeans there's no secure channel protocol set up to run under HTTP 🦋. The'none'inuri-authentication-supportedmeans everyone is'anonymous'. No challenge happens, and the Printer just ignoresrequesting-user-name🙈. - For the second URI,
'ipp://printer.example.com/ipp/print/restricted-use-printer', the'none'inuri-security-supportedagain means no secure channel protocol is configured under HTTP 🌸. The'digest'inuri-authentication-supportedmeans the Printer issues a challenge and uses the name from the Digest mechanism to figure out the authenticated user (see Section 9.3) 🧁. - For the third URI,
'ipps://printer.example.com/ipp/print/private-printer', the'tls'inuri-security-supportedmeans TLS is securing the channel 🔐. The Client SHOULD be prepared to use TLS framing to negotiate an acceptable ciphersuite for talking to the Printer 💜. Here the name hints at a secure channel, but the'tls'value makes it explicit, and that's the important part ✨. The Client doesn't need to guess what security to use from naming conventions or by parsing the URI 🙌. The'basic'inuri-authentication-supportedmeans the Printer issues a challenge and uses the name from the Basic mechanism to figure out the authenticated user (see Section 9.3) 🎀. And because the challenge happens inside a TLS session, the channel is secure 🔒.
Some Printers only support one channel (TLS or not) and only one authentication mechanism, so they only list one URI in printer-uri-supported 🍓. No matter how the Printer is set up, whether it has one URI or several, a Client MUST supply only one URI in the target printer-uri operation attribute 🫶.
5.4.4. printer-name (name(127)) 🌷
This REQUIRED Printer attribute holds the name of the Printer ✨. It's a name that's way more End User friendly than a URI 🧚. An Administrator picks the Printer's name and sets this attribute to it. The name can be the last part of the Printer's URI, or it can be totally unrelated 🙃. In non-US-English locales, a name can contain characters that aren't allowed in a URI 🌈.
5.4.5. printer-location (text(127)) 📍
This RECOMMENDED Printer attribute tells you where the device is located 🗺️. Something like 'in Room 123A, second floor of building XYZ' would be a perfect example 🏢.
5.4.6. printer-info (text(127)) 💬
This RECOMMENDED Printer attribute gives descriptive info about the Printer 📝. Examples include 'This printer can be used for printing color transparencies for HR presentations', or 'Out of courtesy for others, please print only small (1-5 page) jobs at this printer', or even 'This printer is going away on July 1; please find a new printer' 😭.
5.4.7. printer-more-info (uri) 🔗
This RECOMMENDED Printer attribute holds a URI for getting more info about this specific Printer 🌸. For example, it could be an HTTP URI pointing to an HTML page a web browser can open 💻. The info is meant for End Users, and features outside the scope of IPP can be reached from this URI ✨. It's meant to be specific to this Printer instance and any site-specific services, like Job pricing, services offered, and End User assistance 💅. The device manufacturer can fill this in initially 🏭.
5.4.8. printer-driver-installer (uri) 💿
This Printer attribute holds a URI to find the driver installer for this Printer 🤖. It's intended for automata to consume, not humans 🙈. The mechanics of Printer driver installation are outside the scope of this document, so we're not getting into that here 🫠. The device manufacturer can initially populate this attribute too 🏭.
5.4.9. printer-make-and-model (text(127)) 🖨️
This RECOMMENDED Printer attribute identifies the make and model of the device 💖. The device manufacturer can initially fill this in 🏭.
5.4.10. printer-more-info-manufacturer (uri) 🌐
This Printer attribute holds a URI for getting more info about this type of device 💜. The info is meant for End User consumption, and features outside the scope of IPP can be accessed from it, like latest firmware, upgrades, Printer drivers, optional features available, and details on color support ✨. The info is meant to apply to this Printer without caring about site-specific modifications or services 🎀. The device manufacturer can initially populate this attribute 🏭.
5.4.11. printer-state (type1 enum) 🚦
This REQUIRED Printer attribute tells you the device's current state 🫶. The printer-state-reasons attribute backs up printer-state by giving more detailed info about the Printer in its current state 🧠.
A Printer keeps updating this attribute continually if asynchronous event notification [RFC3995] is supported ⚡.
The standard enum values are defined in Table 18. Values of printer-state-reasons, such as 'spool-area-full' and 'stopped-partly', MAY be used to give further info 🌈.
+-------+-----------------------------------------------------------+
| Value | Symbolic Name and Description |
+-------+-----------------------------------------------------------+
| '3' | 'idle': Indicates that new Jobs can start processing |
| | without waiting. |
+-------+-----------------------------------------------------------+
| '4' | 'processing': Indicates that Jobs are processing; new |
| | Jobs will wait before processing. |
+-------+-----------------------------------------------------------+
| '5' | 'stopped': Indicates that no Jobs can be processed and |
| | intervention is required. |
+-------+-----------------------------------------------------------+
Table 18: "printer-state" Enum Values5.4.12. printer-state-reasons (1setOf type2 keyword) ✨
This REQUIRED Printer attribute is where the device spills the tea on its state 💅 It gives extra detail, and some of the values come with conformance rules. The rest are OPTIONAL, so you get to pick 🌸
Each keyword value MAY have a suffix that tells you how serious it is. There are three levels: report (the least dramatic), warning, and error (the full drama queen) 🎀
-report: This means the reason is a "report" 📝 An implementation can choose to omit some or all reports. Some reports give finer detail about the Printer's state, and others are the warm-up before a warning. A report MUST contain nothing that could affect the printed output. Reports line up with theothervalue of the prtAlertSeverityLevel property in the Printer MIB [RFC3805] 💜-warning: This means the reason is a "warning" ⚠️ An implementation can choose to omit some or all warnings. Warnings are the precursor to an error. A warning MUST contain nothing that prevents a Job from completing, though in some cases the output can come out lower quality 🥲 Warnings line up with thewarningvalue of the prtAlertSeverityLevel property in the Printer MIB [RFC3805] ✨-error: This means the reason is an "error" 🚨 An implementation MUST include all errors. If this attribute has one or more errors, the Printer MUST be in thestoppedstate. Errors line up with thecriticalvalue of the prtAlertSeverityLevel property in the Printer MIB [RFC3805] 💀
If the implementation doesn't add any of the three suffixes and the value isn't none, Clients can assume it's an "error" if the Printer is stopped, and a "warning" if the Printer is in any other state. It's giving logic 🧠
If a Printer controls more than one Output Device, each value of this attribute MAY apply to one or more of those Output Devices. An error on one Output Device that doesn't stop the whole Printer MAY show up as a warning in the Printer's "printer-state-reasons" attribute 🦋 If "printer-state" for such a Printer is stopped, then there MUST be an error reason among the values in the "printer-state-reasons" attribute. No exceptions, bestie 😭
The following standard keyword values are defined:
none: There are no reasons. This is semantically the same as "printer-state-reasons" with no value at all, and it MUST be used, since the1setOfattribute syntax requires at least one value 🫶other: The device has detected a condition that isn't listed in this document 🌈connecting-to-device: The Printer has scheduled a Job on the Output Device and is connecting to a shared network Output Device. It might not actually start printing the Job for an arbitrarily long time, depending on how other servers on the network are using the Output Device. Hurry up and wait 🙈cover-open: One or more covers on the device are open. This is equivalent to a prtCoverStatus [RFC3805] of 3 (coverOpen) 🌸- `developer-empty: The device is out of developer. 💀
developer-low: The device is low on developer 🥀door-open: One or more doors on the device are open. This is equivalent to a prtCoverStatus [RFC3805] of 3 (coverOpen) 🚪fuser-over-temp: The fuser temperature is above normal. This is equivalent to a prtMarkerStatus [RFC3805] of 19 (the sum of "Unavailable because Broken" (3) and "Critical Alerts" (16)) 🔥fuser-under-temp: The fuser temperature is below normal. This is equivalent to a prtMarkerStatus [RFC3805] of 19 (the sum of "Unavailable because Broken" (3) and "Critical Alerts" (16)) 🥶input-tray-missing: One or more input trays aren't in the device. This is equivalent to a prtInputStatus [RFC3805] of 19 (the sum of "Unavailable because Broken" (3) and "Critical Alerts" (16)) 🍓interlock-open: One or more interlock devices on the Printer are unlocked. This is equivalent to a prtCoverStatus [RFC3805] of 5 (interlockOpen) 🔓interpreter-resource-unavailable: An interpreter resource is unavailable (for example, a font or a form) 🧚- `marker-supply-empty: The device is out of at least one marker supply, like toner, ink, or ribbon. 😱
marker-supply-low: The device is low on at least one marker supply, like toner, ink, or ribbon 🖍️marker-waste-almost-full: The device's marker supply waste receptacle is almost full 🗑️marker-waste-full: The device's marker supply waste receptacle is full 🗑️💀media-empty: At least one input tray is empty. This is equivalent to a prtInputStatus [RFC3805] of 19 (the sum of "Unavailable because Broken" (3) and "Critical Alerts" (16)) 📄media-jam: The device has a media jam. This is equivalent to a prtInputStatus [RFC3805] of 19 (the sum of "Unavailable because Broken" (3) and "Critical Alerts" (16)) 🙃media-low: At least one input tray is low on media. This is equivalent to a prtInputStatus [RFC3805] of 8 (Non-Critical Alerts) 📉media-needed: A tray has run out of media. This is equivalent to a prtInputStatus [RFC3805] value of 17 (the sum of "Unavailable and OnRequest" (1) and "Critical Alerts" (16)) 🫠moving-to-paused: Someone has paused the Printer using the Pause-Printer operation (see Section 4.2.7) or some other means, but the device(s) is taking an appreciable time to stop. Later, once all output has stopped, "printer-state" becomesstopped, and thepausedvalue replaces themoving-to-pausedvalue in the "printer-state-reasons" attribute. This value MUST be supported if the Pause-Printer operation is supported and the implementation takes significant time to pause a device in certain circumstances. Slow and steady 🐢opc-life-over: The optical photo conductor is no longer functioning. This is equivalent to a prtMarkerStatus [RFC3805] of 19 (the sum of "Unavailable because Broken" (3) and "Critical Alerts" (16)) 💔opc-near-eol: The optical photo conductor is near its end of life. This is equivalent to a prtMarkerStatus [RFC3805] of 8 (Non-Critical Alerts) 🕰️output-area-almost-full: One or more output areas are almost full (for example, a tray, stacker, or collator). This is equivalent to a prtOutputStatus [RFC3805] of 8 (Non-Critical Alerts) 📚output-area-full: One or more output areas are full (for example, a tray, stacker, or collator). This is equivalent to a prtInputStatus [RFC3805] of 19 (the sum of "Unavailable because Broken" (3) and "Critical Alerts" (16)) 📦output-tray-missing: One or more output trays aren't in the device. This is equivalent to a prtOutputStatus [RFC3805] of 19 (the sum of "Unavailable because Broken" (3) and "Critical Alerts" (16)) 🧺paused: Someone has paused the Printer using the Pause-Printer operation (see Section 4.2.7) or some other means, and the Printer's "printer-state" isstopped. In this state, a Printer MUST NOT produce printed output, but it MUST perform other operations requested by a Client. If a Printer was printing a Job when it got paused, the Printer MUST resume printing that Job once it's no longer paused, and it MUST leave no evidence of the pause in the printed output 🧘 This value MUST be supported if the Pause-Printer operation is supported.shutdown: Someone has removed a Printer from service, and the device can be powered down or physically removed. In this state, a Printer MUST NOT produce printed output. Unless the Printer is realized by a print server that is still active, the Printer MUST perform no other operations requested by a Client, including returning this value. If a Printer was printing a Job when it got shut down, the Printer MAY resume printing that Job when it's restarted. If it does resume, it can leave evidence in the printed output of the shutdown. For example, the part printed before the shutdown can be printed a second time after it 😵💫spool-area-full: The limit of persistent storage allocated for spooling has been reached, so the Printer is temporarily unable to accept more Jobs. The Printer will remove this value once it can accept more Jobs again. This value SHOULD be used by a non-spooling Printer that only accepts one or a small number of Jobs at a time, or by a spooling Printer that has filled its spool space 🗂️stopped-partly: When a Printer controls more than one Output Device, this reason means one or more of those Output Devices are stopped. If the reason is a report, fewer than half of the Output Devices are stopped. If the reason is a warning, fewer than all of the Output Devices are stopped 🌗stopping: The Printer is in the process of stopping the device and will be stopped in a bit. Once the device is stopped, the Printer will change its state tostopped. Thestopping-warningreason is never an error, even for a Printer with a single Output Device. When an Output Device stops accepting Jobs, the Printer will have this reason while the Output Device finishes printing 🛑timed-out: The server was able to connect to the Output Device (or is always connected) but couldn't get a response from it. Ghosted 👻toner-empty: The device is out of toner 🖤toner-low: The device is low on toner 🩶
5.4.13. printer-state-message (text(MAX)) 💬
This RECOMMENDED Printer attribute shares information about the "printer-state" and "printer-state-reasons" attributes in human-readable text. If the Printer supports this attribute, the Printer MUST be able to generate this message in any of the natural languages listed in its "generated-natural-language-supported" attribute (see the "attributes-natural-language" operation attribute specified in Section 4.1.4.1). Multilingual queen behavior 🌍
5.4.14. ipp-versions-supported (1setOf type2 keyword) 🎀
This REQUIRED attribute identifies the IPP version(s) this Printer supports, including major and minor versions. In other words, it lists the version numbers for which this Printer implementation meets the conformance requirements. For version number validation, the Printer matches the (2-octet binary) "version-number" parameter that the Client sends in each request (see Sections 4.1.1 and 4.1.8) against the (US-ASCII) keyword values of this attribute. Matching vibes only 💜
The following standard keyword values are defined in this document:
1.0: Meets the conformance requirements of IPP version 1.0 as specified in RFC 2566 [RFC2566] and RFC 2565 [RFC2565], including any extensions registered according to Section 7 and any extension defined in this version or any future version of the IPP Model and Semantics document (this document) or the IPP Encoding and Transport document [RFC8010] following the rules, if any, when the "version-number" parameter is1.0. 🦖1.1: Meets the conformance requirements of IPP version 1.1 as specified in this document and [RFC8010], including any extensions registered according to Section 7 and any extension defined in any future versions of this document or [RFC8010] following the rules, if any, when the "version-number" parameter is1.1. 🌟
Additional values are defined in "IPP Version 2.0, 2.1, and 2.2" [PWG5100.12]. Keep scrolling for the rest 📜✨
5.4.15. operations-supported (1setOf type2 enum) ✨
This REQUIRED Printer attribute specifies the set of supported operations for this Printer and contained Jobs. 💅
This attribute is encoded as any other enum attribute syntax according to [RFC8010] as 32 bits. 🦋 However, all 32-bit enum values for this attribute MUST NOT exceed 0x00007fff, since these same values are also passed in two octets in the "operation-id" field (see Section 4.1.1) in each Protocol request with the two high-order octets omitted in order to indicate the operation being performed [RFC8010]. okay so the top two octets have to be zero, bestie, or the operation ID gets messed up 🫶
Table 19 lists the "operations-supported" attribute and "operation-id" parameter (see Section 4.1.2) enum values that are defined in this document. 🌸
+---------------+---------------------------------------------------+
| Value | Operation Name |
+---------------+---------------------------------------------------+
| 0x0000 | reserved, not used |
+---------------+---------------------------------------------------+
| 0x0001 | reserved, not used |
+---------------+---------------------------------------------------+
| 0x0002 | Print-Job |
+---------------+---------------------------------------------------+
| 0x0003 | Print-URI |
+---------------+---------------------------------------------------+
| 0x0004 | Validate-Job |
+---------------+---------------------------------------------------+
| 0x0005 | Create-Job |
+---------------+---------------------------------------------------+
| 0x0006 | Send-Document |
+---------------+---------------------------------------------------+
| 0x0007 | Send-URI |
+---------------+---------------------------------------------------+
| 0x0008 | Cancel-Job |
+---------------+---------------------------------------------------+
| 0x0009 | Get-Job-Attributes |
+---------------+---------------------------------------------------+
| 0x000a | Get-Jobs |
+---------------+---------------------------------------------------+
| 0x000b | Get-Printer-Attributes |
+---------------+---------------------------------------------------+
| 0x000c | Hold-Job |
+---------------+---------------------------------------------------+
| 0x000d | Release-Job |
+---------------+---------------------------------------------------+
| 0x000e | Restart-Job |
+---------------+---------------------------------------------------+
| 0x000f | reserved for a future operation |
+---------------+---------------------------------------------------+
| 0x0010 | Pause-Printer |
+---------------+---------------------------------------------------+
| 0x0011 | Resume-Printer |
+---------------+---------------------------------------------------+
| 0x0012 | Purge-Jobs |
+---------------+---------------------------------------------------+
| 0x0013-0x3fff | additional registered operations (see the IANA |
| | IPP registry and Section 7.8) |
+---------------+---------------------------------------------------+
| 0x4000-0x7fff | reserved for vendor extensions (see Section 7.8) |
+---------------+---------------------------------------------------+Table 19: "operations-supported" Enum Values
5.4.16. multiple-document-jobs-supported (boolean) 🍓
This RECOMMENDED Printer attribute indicates whether the Printer supports more than one Document per Job, i.e., more than one Send-Document operation with Document data and/or Send-URI operations. If the Printer supports the Create-Job and Send-Document operations (see Sections 4.2.4 and 4.3.1), it MUST support this attribute. no cap, this one is a must if you do Create-Job and Send-Document 🔥
5.4.17. charset-configured (charset) 🎀
This REQUIRED Printer attribute identifies the charset that the Printer has been configured to represent 'text' and 'name' Printer attributes that are set by the Operator, Administrator, or manufacturer, i.e., for "printer-name" (name), "printer-location" (text), "printer-info" (text), and "printer-make-and-model" (text). Therefore, the value of the Printer's "charset-configured" attribute MUST also be among the values of the Printer's "charset-supported" attribute. 💜
5.4.18. charset-supported (1setOf charset) 🧚
This REQUIRED Printer attribute identifies the set of charsets that the Printer and contained Jobs support in attributes with attribute syntaxes 'text' and 'name'. At least the value 'utf-8' MUST be present, since IPP objects MUST support the UTF-8 [RFC3629] charset. If a Printer supports a charset, it means that for all attributes of syntaxes 'text' and 'name' the Printer MUST (1) accept the charset in requests and (2) return the charset in responses as needed. the UTF-8 one is non-negotiable, bestie 😭
If more charsets than UTF-8 are supported, the Printer MUST perform charset conversion between the charsets as described in Section 4.1.4.2. 🦋
5.4.19. natural-language-configured (naturalLanguage) 🌈
This REQUIRED Printer attribute identifies the natural language that the Printer has been configured to represent 'text' and 'name' Printer attributes that are set by the Operator, Administrator, or manufacturer, i.e., for "printer-name" (name), "printer-location" (text), "printer-info" (text), and "printer-make-and-model" (text). When returning these Printer attributes, the Printer MAY return them in the configured natural language specified by this attribute, instead of the natural language requested by the Client in the "attributes-natural-language" operation attribute. See Section 4.1.4.1 for the specification of the OPTIONAL support for multiple natural languages. Therefore, the value of the Printer's "natural-language-configured" attribute MUST also be among the values of the Printer's "generated-natural-language-supported" attribute. ✨
5.4.20. generated-natural-language-supported (1setOf naturalLanguage) 👑
This REQUIRED Printer attribute identifies the natural language(s) that the Printer and contained Jobs support in attributes with attribute syntaxes 'text' and 'name'. The natural language(s) supported depends on implementation and/or configuration. Unlike charsets, Printers MUST accept requests with any natural language or any Natural Language Override whether the natural language is supported or not. 🙈
If a Printer supports a natural language, it means that for any of the attributes for which the Printer or Job generates messages, i.e., for the "job-state-message" and "printer-state-message" attributes and operation messages (see Section 4.1.5) in operation responses, the Printer and Job MUST be able to generate messages in any of the Printer's supported natural languages. See Sections 4.1.4, 5.1.2, and 5.1.3 for the definitions of 'text' and 'name' attributes in operation requests and responses. 🌸
Note: A Printer that supports multiple natural languages often has separate catalogs of messages, one for each natural language supported. 💖
5.4.21. document-format-default (mimeMediaType) 🦋
This REQUIRED Printer attribute identifies the Document format that the Printer has been configured to assume if the Client does not supply a "document-format" operation attribute in any of the operation requests that supply Document data. The standard values for this attribute are Internet media types (sometimes called "MIME media types"). For further details, see the description of the 'mimeMediaType' attribute syntax in Section 5.1.10. 🎀
5.4.22. document-format-supported (1setOf mimeMediaType) 🌸
This REQUIRED Printer attribute identifies the set of Document formats that the Printer and contained Jobs can support. For further details, see the description of the 'mimeMediaType' attribute syntax in Section 5.1.10. 💅
5.4.23. printer-is-accepting-jobs (boolean) 🫶
This REQUIRED Printer attribute indicates whether the Printer is currently able to accept Jobs, i.e., is accepting Print-Job, Print-URI, and Create-Job requests. If the value is 'true', the Printer is accepting Jobs. If the value is 'false', the Printer is currently rejecting any Jobs submitted to it. In this case, the Printer returns the 'server-error-not-accepting-jobs' status-code. 🙅♀️
This value is independent of the "printer-state" and "printer-state-reasons" attributes because its value does not affect the current Job; rather, it affects future Jobs. This attribute, when 'false', causes the Printer to reject Jobs even when "printer-state" is 'idle' or, when 'true', causes the Printer to accept Jobs even when "printer-state" is 'stopped'. this one is kinda sneaky, it only cares about FUTURE jobs, not the one that's already running 👀
5.4.24. queued-job-count (integer(0:MAX)) ⭐
This REQUIRED Printer attribute contains a count of the number of Jobs that are either 'pending', 'processing', 'pending-held', or 'processing-stopped' and is set by the Printer. 🍓
5.4.25. printer-message-from-operator (text(127)) 🧚
This Printer attribute provides a message from an Operator, Administrator, or "intelligent" process to indicate to the End User information or status of the Printer, such as why it is unavailable or when it is expected to be available. 💜
5.4.26. color-supported (boolean) 🌈
This RECOMMENDED Printer attribute identifies whether the device is capable of any type of color printing at all, including highlight color. All Document instructions having to do with color are embedded within the Document PDL, although IPP attributes can affect the rendering of those colors. 🎨
Note: End Users are able to determine the nature and details of the color support by querying the "printer-more-info-manufacturer" Printer attribute. 🔍
5.4.27. reference-uri-schemes-supported (1setOf uriScheme) 👑
This Printer attribute specifies which URI schemes are supported for use in the "document-uri" operation attribute of the Print-URI or Send-URI operations. If a Printer supports these OPTIONAL operations, it MUST support the "reference-uri-schemes-supported" Printer attribute with at least the following URI scheme value: 💖
'ftp': The Printer will use an FTP 'get' operation as defined in [RFC959] using FTP URLs as defined by [RFC3986].
The Printer MAY support other URI schemes (see Section 5.1.7). 🦋
Okay, so picking up right where we left off with the Printer attributes, bestie! 🎀✨
5.4. Printer Object Attributes (continued) 💅
5.4.28. pdl-override-supported (type2 keyword) 🔥
Okay so this one is a REQUIRED Printer attribute, and it's all about whether a Printer can make your IPP attribute values beat the instructions baked into the Document data itself. Main character energy for the IPP settings 👑. The defined keyword values are:
attempted: the Printer tries to make the IPP attribute values win over embedded instructions in the Document data, but there's no guarantee 🤞.not-attempted: the Printer makes no attempt at all to let the IPP attribute values win over embedded instructions in the Document data 💀.
Appendix C has the full tea on how this attribute interacts with other IPP attributes, especially "ipp-attribute-fidelity" 🦋.
5.4.29. printer-up-time (integer(1:MAX)) ⏰
This is a REQUIRED Printer attribute that tracks how many seconds this Printer instance has been up and running 🌸. It's a monotonically increasing value that starts at 1 when the Printer boots up (initialized, booted, etc.). It's also what fuels the Event Time Job Status attributes "time-at-creation", "time-at-processing", and "time-at-completed" (see Section 5.3.14) 🧚.
Now, if the Printer goes down at some value 'n' and comes back, the implementation MAY:
- know how long it was down and resume at some value greater than 'n', or
- restart from 1.
So basically, if the device gets restarted or power-cycled, the Printer MAY keep counting OR MAY reset to 1, depending on the implementation 🔄. BUT if the Printer software stops running and restarts without knowing the last "printer-up-time" value, the implementation MUST reset this value to 1 🚨. And if it resets and the Printer has persistent Jobs, the Printer MUST reset the "time-at-xxx (integer)" Event Time Job Status attributes according to Section 5.3.14 💜. An implementation MAY use both alternatives, depending on warm versus cold start, respectively ✨.
5.4.30. printer-current-time (dateTime|unknown) 🕰️
This is a RECOMMENDED Printer attribute that gives the current date and time 💖. It populates the Event Time Job Status attributes "date-time-at-creation", "date-time-at-processing", and "date-time-at-completed" (see Section 5.3.14) 🎀.
This value is a "best effort" thing, and honestly it doesn't have to be precise to be useful 🙈. A Printer implementation sets it through some implementation-dependent means, like a network time server, being initialized at manufacture, or an Administrator setting it. See [RFC3196] and [PWG5100.19] for examples 📚. If an implementation supports this attribute and knows it hasn't been set yet, it MUST return the out-of-band 'unknown', meaning the value is not yet known. See the beginning of Section 5.1 🌈.
The time zone of this attribute might not be the one people near the Printer or device are using 🌍. The Client MUST NOT expect the time zone of any received 'dateTime' value to be the Client's time zone or the time zone of people near the Printer 🙅♀️.
The Client SHOULD display any dateTime attributes in the Client's local time by converting the 'dateTime' value from the server into the Client's time zone, rather than using the time zone the Printer returns in attributes that use the 'dateTime' attribute syntax 🫶.
Note: Prior versions of this document incorrectly specified the use of the'no-value'out-of-band value when the current date and time had not been set. The correct out-of-band value is'unknown', since there is always an intrinsic current date and time 😭.
5.4.31. multiple-operation-time-out (integer(1:MAX)) ⏳
This is a RECOMMENDED Printer attribute that identifies the minimum time (in seconds) the Printer waits for additional Send-Document or Send-URI operations to follow a still-open Job before taking any recovery actions, like the ones in Section 4.3.1 🛑. If the Printer supports the Create-Job and Send-Document operations (see Sections 4.2.4 and 4.3.1), it MUST support this attribute 💅.
Printers SHOULD use a value between '60' and '240' (seconds) 🦋. An implementation MAY let an Administrator set this attribute by means not defined in this document. If so, the Administrator MAY be able to set values outside this range 🌸.
5.4.32. compression-supported (1setOf type2 keyword) 🗜️
This is a REQUIRED Printer attribute listing the supported compression algorithms for Document data 🧃. Compression only applies to the Document data; it does NOT apply to the encoding of the IPP operation itself 🙅♀️. The supported values are used to validate the Client-supplied "compression" operation attributes in Print-Job and Send-Document requests 🔍.
The standard keyword values defined in this document are:
'none': no compression is used 🫥.'deflate': ZIP inflate/deflate compression technology described in RFC 1951 [RFC1951] 🤓.'gzip': GNU zip compression technology described in RFC 1952 [RFC1952] 🍓.'compress': UNIX compression technology described in RFC 1977 [RFC1977] 🦖.
5.4.33. job-k-octets-supported (rangeOfInteger(0:MAX)) 📦
This Printer attribute specifies the upper and lower bounds of total Job sizes in K octets, i.e., in units of 1024 octets 📏. The supported values are used to validate the Client-supplied "job-k-octets" operation attribute in Job Creation requests 🎯. The matching Job Description attribute "job-k-octets" is defined in Section 5.3.17.1 ✨.
5.4.34. job-impressions-supported (rangeOfInteger(0:MAX)) 🖨️
This is a RECOMMENDED Printer attribute that specifies the upper and lower bounds for the number of Impressions per Job 📄. The supported values are used to validate the Client-supplied "job-impressions" operation attribute in Job Creation requests 💫. The corresponding Job Description attribute "job-impressions" is defined in Section 5.3.17.2 🌟.
5.4.35. job-media-sheets-supported (rangeOfInteger(1:MAX)) 🧾
This Printer attribute specifies the upper and lower bounds for the number of Media Sheets per Job 📑. The supported values are used to validate the Client-supplied "job-media-sheets" operation attribute in Job Creation requests 🫧. The corresponding Job attribute "job-media-sheets" is defined in Section 5.3.17.3 🩷.
5.4.36. pages-per-minute (integer(0:MAX)) 🏃♀️
This is a RECOMMENDED Printer attribute giving the nominal number of pages per minute, to the nearest whole number, that this Printer can generate (e.g., simplex, black-and-white) 📃. It's informative, NOT a service guarantee 🙃. Generally, it's the number the marketing literature uses to describe the device's speed 📣.
A value of 0 indicates a device that takes more than two minutes to process a page 🐌.
5.4.37. pages-per-minute-color (integer(0:MAX)) 🌈
This is a RECOMMENDED Printer attribute giving the nominal number of pages per minute, to the nearest whole number, that this Printer can generate when printing color (e.g., simplex, color) 🎨. For this attribute, "color" means the same thing as in the "color-supported" attribute: the device can do any type of color printing at all, including highlight color 🫶. It's informative, NOT a service guarantee, and it's usually the number the marketing literature uses for the device's color skills 💅.
A value of 0 indicates a device that takes more than two minutes to process a page in color 🐢.
If a color device has several color modes, it MAY use the "pages-per-minute" value that corresponds to the mode producing the highest number 🏆.
Printers that are black-and-white only MUST NOT support this attribute 🚫. If this attribute is present, then the "color-supported" Printer Description attribute MUST be present and have a 'true' value 🎀.
The values of the "pages-per-minute" and "pages-per-minute-color" attributes returned by the Get-Printer-Attributes operation MAY be affected by the "document-format" attribute the Client supplies in the Get-Printer-Attributes request 📄. In other words, the implementation MAY have different speeds depending on the Document format being processed 🧠. See Section 4.2.5.1 ("Get-Printer-Attributes Request") 🔎.
6. Conformance 📜
This section covers conformance issues and requirements 🎓. This document introduces model entities such as objects, operations, attributes, attribute syntaxes, and attribute values 🧩. The following sections describe the conformance requirements that apply to these model entities 💜.
6.1. Client Conformance Requirements 🎀
okay so this part is about what a Client needs to do to be conformant (see Section 3.1) 💅. There are two kinds of Client we're talking about:
- stuff living inside software an End User controls, like the "Print" menu item in an app that sends IPP requests 🖨️, or
- the print server piece that sends IPP requests to either an Output Device or another "downstream" print server 🌸
A conforming Client supports all REQUIRED operations as defined in this document ✨, so that's the baseline. For each attribute in an operation request, a conforming Client MUST supply a value whose type and value syntax conforms to the requirements in Sections 4 and 5 of this document 🫶. It MAY also toss in any Standards Track extensions and/or vendor extensions in an operation request, as long as they meet the requirements in Section 7 💜.
This doc doesn't set conformance rules for the user interfaces IPP Clients or their apps show people, but the best practices for UIs live in [PWG5100.19] 🦋.
A Client MUST be able to accept any of the attribute syntaxes defined in Section 5.1, including their full range, that can come back to it in a response from a Printer 💖. For attributes with a 'text' syntax that the Client supports, the Client MUST accept and process both the 'textWithoutLanguage' and 'textWithLanguage' forms 🍓. Same deal for 'name' attributes: the Client MUST accept and process both the 'nameWithoutLanguage' and 'nameWithLanguage' forms 🌈. For presentation purposes, truncation of long attribute values is not recommended 🙈. A recommended approach would be to let the user scroll through long attribute values, which is very main character energy 🎀.
A response MAY contain attribute groups, attributes, attribute syntaxes, values, and status-code values that the Client doesn't expect 🧚. So a Client implementation MUST gracefully handle those responses and not refuse to interoperate with a conforming Printer that returns Standards Track extensions or vendor extensions. That includes attribute groups, attributes, attribute syntaxes, attribute values, status-code values, and out-of-band attribute values that conform to Section 7 🔥. Clients can choose to ignore any parameters, attribute groups, attributes, attribute syntaxes, or values they don't understand, honestly iconic 👑.
While a Client is sending data to a Printer, it SHOULD do its best to stop a channel from being closed by a lower layer when the channel is blocked (flow-controlled off) for whatever reason 😭. Think 'out of paper' or 'Job ahead hasn't freed up enough memory' 💀. However, the layer that launched the print submission (for example, an End User) MAY close the channel to cancel the Job 🫠. When a Client closes a channel, a Printer MAY print all or part of the received portion of the Document ✨. For more details, check the Encoding and Transport document [RFC8010] 📖.
A Client MUST support Client Authentication as defined in [RFC8010] 🔐. A Client SHOULD support Operation Privacy and Server Authentication as defined in [RFC8010] 🫶. See also Section 9 of this document 💜.
6.2. IPP Object Conformance Requirements 🦋
this section lays out the conformance requirements for conforming implementations of IPP objects (see Section 3) 💅. They apply to an IPP object whether it is:
- an (embedded) device component that accepts IPP requests and controls the device, or
- a component of a print server that accepts IPP requests (where the print server controls one or more networked devices using IPP or other protocols) 🌸
6.2.1. Objects
Conforming implementations MUST implement all of the model objects as defined in this document in the indicated sections 🎀:
Section 3.1 - Printer Object
Section 3.2 - Job Object
6.2.2. Operations
Conforming IPP object implementations MUST implement all of the REQUIRED model operations, including REQUIRED responses, as defined in this document in the indicated sections ✨. Table 20 lists the operations for a Printer, and Table 21 lists the operations for a Job 🍓.
+----------------------------------------+-------------+
| Operation | Conformance |
+----------------------------------------+-------------+
| Print-Job (Section 4.2.1) | REQUIRED |
+----------------------------------------+-------------+
| Print-URI (Section 4.2.2) | OPTIONAL |
+----------------------------------------+-------------+
| Validate-Job (Section 4.2.3) | REQUIRED |
+----------------------------------------+-------------+
| Create-Job (Section 4.2.4) | RECOMMENDED |
+----------------------------------------+-------------+
| Get-Printer-Attributes (Section 4.2.5) | REQUIRED |
+----------------------------------------+-------------+
| Get-Jobs (Section 4.2.6) | REQUIRED |
+----------------------------------------+-------------+
| Pause-Printer (Section 4.2.7) | OPTIONAL |
+----------------------------------------+-------------+
| Resume-Printer (Section 4.2.8) | OPTIONAL |
+----------------------------------------+-------------+
| Purge-Jobs (Section 4.2.9) | SHOULD NOT |
+----------------------------------------+-------------+Table 20: Conformance Requirements for Printer Operations
+------------------------------------+-------------+
| Operation | Conformance |
+------------------------------------+-------------+
| Send-Document (Section 4.3.1) | RECOMMENDED |
+------------------------------------+-------------+
| Send-URI (Section 4.3.2) | RECOMMENDED |
+------------------------------------+-------------+
| Cancel-Job (Section 4.3.3) | REQUIRED |
+------------------------------------+-------------+
| Get-Job-Attributes (Section 4.3.4) | REQUIRED |
+------------------------------------+-------------+
| Hold-Job (Section 4.3.5) | OPTIONAL |
+------------------------------------+-------------+
| Release-Job (Section 4.3.6) | OPTIONAL |
+------------------------------------+-------------+
| Restart-Job (Section 4.3.7) | SHOULD NOT |
+------------------------------------+-------------+Table 21: Conformance Requirements for Job Operations
Conforming IPP objects MUST support all REQUIRED operation attributes, and all values of such attributes if the description says so 💖. Conforming IPP objects MUST ignore all unsupported or unknown operation attributes or Operation Attributes groups received in a request 🙈, but MUST reject a request that contains a supported operation attribute with an unsupported value 💀. Conforming IPP objects MAY return operation responses with attribute groups, attribute names, attribute syntaxes, attribute values, and status-code values that are extensions to this specification 🧚. The additional attribute groups MAY occur in any order 🌈.
The following section on object attributes specifies the support required for object attributes 🎀.
6.2.3. IPP Object Attributes
Conforming IPP objects MUST support all of the REQUIRED object attributes, as defined in this document in the indicated sections 🔥.
If an object supports an attribute, it MUST support only those values specified in this document or through the extension mechanism described in Section 6.2.5 💅. It MAY support any non-empty subset of these values 🦋. That is, it MUST support at least one of the specified values and at most all of them 👑.
6.2.4. Versions
IPP/1.1 Clients MUST meet the conformance requirements for Clients specified in this document and [RFC8010] 💅. IPP/1.1 Clients MUST be capable of sending requests containing a "version-number" parameter with a value of '1.1' ✨.
IPP/1.1 Printer and Job objects MUST meet the conformance requirements for IPP objects specified in this document and [RFC8010] 🫶. IPP/1.1 objects MUST accept requests containing a "version-number" parameter with a '1.1' value, or reject the request if the operation isn't supported 🍓.
It is beyond the scope of this specification to mandate conformance with other IPP versions 🌸. However, IPP was deliberately designed to make supporting different versions easy 💖. IPP/1.1 Printer implementations MUST:
- decode and process any well-formed IPP/1.1 request, and
- respond appropriately with a response containing the same "version-number" parameter value used by the Client in the request
IPP/1.1 Client implementations MUST:
- decode and process any well-formed IPP/1.1 response
IPP Clients SHOULD try supplying alternate version numbers if they receive a 'server-error-version-not-supported' error in a response 🔄.
6.2.5. Extensions
A conforming IPP object MAY support Standards Track extensions and vendor extensions, as long as the extensions meet the requirements specified in Section 7 🧚.
For each attribute included in an operation response, a conforming IPP object MUST return a value whose type and value syntax conforms to the requirements specified in Sections 4 and 5 of this document 💜.
6.2.6. Attribute Syntaxes
An IPP object MUST be able to accept any of the attribute syntaxes defined in Section 5.1, including their full range, in any operation where a Client can supply attributes or the Administrator can configure attributes (by means outside the scope of this IPP/1.1 document) 🌈. For 'text' attributes the IPP object supports, the IPP object MUST accept and process both the 'textWithoutLanguage' and 'textWithLanguage' forms 🍓. Similarly, for 'name' attributes it supports, the IPP object MUST accept and process both the 'nameWithoutLanguage' and 'nameWithLanguage' forms 🎀. Furthermore, an IPP object MUST return attributes to the Client in operation responses that conform to the syntaxes specified in Section 5.1, including their full range if a Client supplied them previously ✨.
6.2.7. Security
An IPP Printer implementation SHOULD contain support for Client Authentication as defined in the IPP/1.1 Encoding and Transport document [RFC8010] 🔐. A Printer implementation MAY allow an Administrator to configure the Printer so that all, some, or none of the users are authenticated 👑. See also Section 9 of this document 💜.
An IPP Printer implementation SHOULD contain support for Operation Privacy and Server Authentication as defined in [RFC8010] 🛡️. A Printer implementation MAY allow an Administrator to configure the degree of support for Operation Privacy and Server Authentication 🎀. See also Section 9 of this document 💅.
Security MUST NOT be compromised when a Client supplies a lower "version-number" parameter in a request 😭. For example, if a Printer conforming to IPP/1.1 accepts version '1.0' requests and is configured to enforce Digest Authentication, it MUST do the same for a version '1.0' request 🔥. Security is not a vibe you can downgrade, bestie 💀.
6.3. Charset and Natural Language Requirements 🌸
okay bestie, every Client AND every IPP object MUST support the 'utf-8' charset, as defined in Section 5.1.8 💖
IPP objects MUST be able to accept any Client request that correctly uses the "attributes-natural-language" operation attribute, or the Natural Language Override mechanism on any individual attribute, even if the IPP object doesn't support that natural language 🫶 If an IPP object DOES support a natural language, then it MUST be able to translate (perhaps by table lookup) all generated 'text' or 'name' attribute values into one of the supported languages (see Section 4.1.4) ✨
7. IANA Considerations 🦋
this section is all about how new stuff gets added to the IANA IPP registry, like extensions for Standards Track and vendor stuff 📋 it touches these subregistries:
- Objects
- Attributes
- Keyword Attribute Values
- Enum Attribute Values
- Attribute Group Tags
- Out-of-Band Attribute Value Tags
- Attribute Syntaxes
- Operations
- Status-Code Values
extensions registered for use with IPP are OPTIONAL for Client and IPP object conformance to the IPP/1.1 Model and Semantics document (this document) 💅
these extension procedures follow "Guidelines for Writing an IANA Considerations Section in RFCs" [RFC5226] 📚 Appendix A is where you learn how to propose new registrations. IANA will reject proposals that leave out required information or don't follow the format in Appendix A, so don't skip it 😭 The IPP/1.1 Model and Semantics document can also be extended by an appropriate Standards Track document that specifies any of the above extensions 🌈
the IANA policy (using terms defined in [RFC5226]) for all extensions is Specification Required, Expert Review, or First Come First Served, depending on the subsection below 🎀 Registrations go to the IPP Designated Expert(s), who reviews the proposal on a mailing list they keep for this purpose. At first, that list is the mailing list used by the PWG IPP WG:
ipp@pwg.orgthe IPP Designated Expert(s) is appointed by the IESG Area Director responsible for IPP, according to [RFC5226] 👑
and the IANA-PRINTER-MIB [RFC3805] has been updated to reference this document. the current version is available from <http://www.iana.org> 🖨️
7.1. Object Extensions 🧚
the IANA policy (using terms defined in [RFC5226]) for object extensions used to be Expert Review, but this document changes it to Specification Required 🔥
7.2. Attribute Extensibility 💜
attribute names are type2 keywords (see Section 5.1.4), so the IANA policy (using terms defined in [RFC5226]) for attribute extensions is Expert Review 🫧
for vendor attribute extensions, implementors SHOULD use keywords with a suitable distinguishing prefix, like 'smiNNN-', where NNN is an SMI Private Enterprise Number (PEN) [IANA-PEN]. for example, if Example Corp. had obtained the SMI PEN 32473, then a vendor attribute 'foo' would be 'smi32473-foo' 🎀
Note: Prior versions of this document recommended using a fully qualified domain name [RFC1035] as the prefix (e.g.,'example.com-foo'), and many IPP implementations have also used reversed domain names (e.g.,'com.example-foo'). Domain names have proven problematic due to the length of some domain names, parallel use of country-specific domain names (e.g.,'example.co.jp-foo'), and changes in ownership of domain names. 🙈
if a new Printer attribute is defined and its values can be affected by a specific Document format, its specification needs to contain the following sentence (keep it exactly like this, bestie 💅):
"The value of this attribute returned in a Get-Printer-Attributes
response MAY depend on the "document-format" attribute supplied
(see Section 4.2.5.1) of the IPP/1.1 Model and Semantics
document."if the specification does NOT say that, then its value in the Get-Printer-Attributes response MUST NOT depend on the "document-format" attribute supplied in the request 🚫
when a new Job Template attribute is registered, the value of the Printer attributes MAY vary with "document-format" supplied in the request, and the specification doesn't have to say so 🍓
7.3. Keyword Extensibility 🌈
the IANA policy (using terms defined in [RFC5226]) for type1 keyword extensions is Specification Required. the IANA policy for type2 keyword extensions is Expert Review. the IANA policy for vendor keyword extensions is First Come First Served. ONLY attributes using the type1 and type2 keyword syntax can be registered in the IANA IPP registry 💖
Note: The type1 or type2 prefix on the basic attribute syntax is provided only to communicate the IANA policy required for registration and is not represented in IPP messages. Both type1 and type2'keyword'values are represented using the same'keyword'value tag. 🧠
for type1 and type2 keywords, the proposer includes the name of the keyword in the registration proposal, and the name is part of the technical review ✨
for vendor keyword extensions, implementors SHOULD do one of these:
a. follow attribute-specific guidance, such as the guidance defined in [PWG5101.1], or
b. use keywords with a suitable distinguishing prefix, such as 'smiNNN-', where NNN is an SMI Private Enterprise Number (PEN) [IANA-PEN].
for example, if Example Corp. had obtained the SMI PEN 32473, then a vendor keyword 'foo' would be 'smi32473-foo' 🫶
Note: Prior versions of this document recommended using a fully qualified domain name [RFC1035] as the prefix (e.g.,'example.com-foo'), and many IPP implementations have also used reversed domain names (e.g.,'com.example-foo'). Domain names have proven problematic due to the length of some domain names, parallel use of country-specific domain names (e.g.,'example.co.jp-foo'), and changes in ownership of domain names. 🙈
when a type2 keyword extension is approved, the IPP Designated Expert(s) becomes the point of contact for any future maintenance that might be required for that registration 📮
7.4. Enum Extensibility 🍓
the IANA policy (using terms defined in [RFC5226]) for type1 enum extensions is Specification Required. the IANA policy for type2 enum extensions is Expert Review. the IANA policy for vendor enum extensions is First Come First Served. ONLY attributes using the type1 and type2 enum syntax can be registered in the IANA IPP registry 💅
Note: The type1 or type2 prefix on the basic attribute syntax is provided only to communicate the IANA policy required for registration and is not represented in IPP messages. Both type1 and type2 enum values are represented using the same enum value tag. 🧠
for vendor enum extensions, implementors MUST use values in the reserved integer range, which is 0x40000000 to 0x7fffffff. implementors SHOULD check with the IPP Designated Expert(s) to reserve vendor extension value(s) for their usage 🔒
when a type1 or type2 enum extension is approved, the IPP Designated Expert(s), in consultation with IANA, assigns the next available enum number for each enum value 🔢
when a type2 enum extension is approved, the IPP Designated Expert(s) becomes the point of contact for any future maintenance that might be required for that registration 🌸
7.5. Attribute Group Extensibility 🎀
the IANA policy (using terms defined in [RFC5226]) for attribute group extensions used to be Expert Review, but this document changes it to Specification Required 🔥
for attribute groups, the IPP Designated Expert(s), in consultation with IANA, assigns the next attribute group tag code in the appropriate range as specified in [RFC8010] 🧚
7.6. Out-of-Band Attribute Value Extensibility 🦋
the IANA policy (using terms defined in [RFC5226]) for out-of-band attribute value extensions used to be Expert Review, but this document changes it to Specification Required 💜
for out-of-band attribute value tags, the IPP Designated Expert(s), in consultation with IANA, assigns the next out-of-band attribute value tag code in the appropriate range as specified in [RFC8010] 🫧
7.7. Attribute Syntax Extensibility 👑
the IANA policy (using terms defined in [RFC5226]) for attribute syntax extensions used to be Expert Review, but this document changes it to Specification Required. the IANA policy for vendor attribute syntax extensions (tags 0x40000000 to 0x7fffffff) is First Come First Served. ONLY attribute syntaxes in the range of 0x00000000 to 0x3fffffff can be registered in the IANA IPP registry 🌈
for vendor attribute syntax extensions, implementors MUST use values in the reserved integer range, which is 0x40000000 to 0x7fffffff. implementors SHOULD check with the IPP Designated Expert(s) to reserve vendor extension value(s) for their usage 💖
for registered attribute syntaxes, the IPP Designated Expert(s), in consultation with IANA, assigns the next attribute syntax tag in the appropriate range as specified in [RFC8010] ✨
7.8. Operation Extensibility 🧚
the IANA policy (using terms defined in [RFC5226]) for operation extensions is Expert Review. the IANA policy for vendor operation extensions (values 0x4000 to 0x7fff) is First Come First Served. ONLY operation codes in the range of 0x0000 to 0x3fff can be registered in the IANA IPP registry 🍓
for vendor operation extensions, implementors MUST use values in the reserved integer range, which is 0x4000 to 0x7fff. implementors SHOULD check with the IPP Designated Expert(s) to reserve vendor extension value(s) for their usage 🔒
for registered operation extensions, the IPP Designated Expert(s), in consultation with IANA, assigns the next "operation-id" code as specified in Section 5.4.15 🫶
7.9. Status-Code Extensibility 🔥
the IANA policy (using terms defined in [RFC5226]) for status-code extensions is Expert Review. the IANA policy for vendor status-code extensions (codes 0x0n80 to 0x0nff, for n = 0 to 5) is First Come First Served. ONLY status-code values in the range of 0x0n00 to 0x0n7f can be registered in the IANA IPP registry 💅
status-code values are allocated in ranges, as specified in Appendix B, for each status-code class:
"informational": Request received, continuing process 🌤️"successful": The action was successfully received, understood, and accepted ✅"redirection": Further action is taken in order to complete the request 🔀"client-error": The request contains bad syntax or cannot be fulfilled 🙅"server-error": The IPP object failed to fulfill an apparently valid request 💀
for vendor operation status-code extensions, implementors MUST use the top of each range (0x0n80 to 0x0nff), as specified in Appendix B. implementors SHOULD check with the IPP Designated Expert(s) to reserve vendor extension value(s) for their usage 🌈
for registered operation status-code values, the IPP Designated Expert(s), in consultation with IANA, assigns the next status-code in the appropriate class range, as specified in Appendix B 🎀
8. Internationalization Considerations ✨
Okay bestie, so some attributes hold text strings and names that are meant for humans to read, not machines 🫶 (peep the 'text' and 'name' attribute syntaxes in Sections 5.1.2 and 5.1.3 if you want the deets 💅).
In every operation request, the Client:
- identifies the charset and natural language of the request that affects each supplied 'text' and 'name' attribute value, and
- requests the charset and natural language for attributes returned by the IPP object in operation responses (as described in Section 4.1.4.1).
Lowkey, the Client MAY also separately and individually identify the Natural Language Override of a supplied 'text' or 'name' attribute using the textWithLanguage and nameWithLanguage techniques described in Sections 5.1.2.2 and 5.1.3.2, respectively. 🌸
All IPP objects MUST support the UTF-8 [RFC3629] charset in all 'text' and 'name' attributes supported. 💖 If an IPP object supports more than the UTF-8 charset, the object MUST convert between them in order to return the requested charset to the Client according to Section 4.1.4.2. ✨ If an IPP object supports more than one natural language, the object SHOULD return 'text' and 'name' values in the natural language requested where those values are generated by the Printer (see Section 4.1.4.1).
For Printers that support multiple charsets and/or multiple natural languages in 'text' and 'name' attributes, different Jobs might have been submitted in differing charsets and/or natural languages. 🦋 All responses MUST be returned in the charset requested by the Client. However, the Get-Jobs operation uses the textWithLanguage and nameWithLanguage mechanisms to identify the differing natural languages with each Job attribute returned. 🧚
The Printer also has configured charset and natural language attributes. The Client can query the Printer to determine the list of charsets and natural languages supported by the Printer and what the Printer's configured values are. See the charset-configured, charset-supported, natural-language-configured, and generated-natural-language-supported Printer Description attributes for more details. 💅
The charset-supported attribute identifies the supported charsets. If a charset is supported, the IPP object MUST be capable of converting to and from that charset into any other supported charset. In many cases, an IPP object will support only one charset, and it MUST be the UTF-8 charset. 👑
The charset-configured attribute identifies the one supported charset that is the native charset, given the current configuration of the IPP object (Administrator defined). 🎀
The generated-natural-language-supported attribute identifies the set of supported natural languages for generated messages. It is not related to the set of natural languages that MUST be accepted for Client-supplied 'text' and 'name' attributes. For Client-supplied 'text' and 'name' attributes, an IPP object MUST accept ALL supplied natural languages. 🌈 For example, if a Client supplies a Job name that is in 'fr-ca' but the Printer only generates 'en-us', the Printer object MUST still accept the Job name value. 🙈
The natural-language-configured attribute identifies the one supported natural language for generated messages that is the native natural language, given the current configuration of the IPP object (Administrator defined). 🍓
Attributes of types 'text' and 'name' are populated from different sources. 😭 These attributes can be categorized into the following groups (depending on the source of the attribute):
- Some attributes are supplied by the Client (e.g., the Client-supplied
job-name,document-name, andrequesting-user-nameoperation attributes along with the corresponding Job'sjob-nameandjob-originating-user-nameattributes). The IPP object MUST accept these attributes in any natural language no matter what the set of supported languages for generated messages. 🔥 - Some attributes are supplied by the Administrator (e.g., the Printer's
printer-nameandprinter-locationattributes). These can also be in any natural language. If the natural language for these attributes is different than what a Client requests, then they MUST be reported using the Natural Language Override mechanism. 🫶 - Some attributes are supplied by the device manufacturer (e.g., the Printer's
printer-make-and-modelattribute). These can also be in any natural language. If the natural language for these attributes is different than what a Client requests, then they MUST be reported using the Natural Language Override mechanism. 💜 - Some attributes are supplied by the Operator (e.g., the Job's
job-message-from-operatorattribute). These can also be in any natural language. If the natural language for these attributes is different than what a Client requests, then they MUST be reported using the Natural Language Override mechanism. ⭐ - Some attributes are generated by the IPP object (e.g., the Job's
job-state-messageattribute, the Printer'sprinter-state-messageattribute, and thestatus-messageoperation attribute). These attributes can only be in one of thegenerated-natural-language-supportednatural languages. If a Client requests some natural language for these attributes other than one of the supported values, the IPP object SHOULD respond using the value of thenatural-language-configuredattribute (using the Natural Language Override mechanism if needed). 🦋
The 'text' and 'name' attributes specified in this version of this document (additional ones will be registered according to the procedures in Section 7) are shown in Table 22. 🎀
+-----------------------------------+-------------------------------+
| Attributes | Source |
+-----------------------------------+-------------------------------+
| Operation Attributes: | |
| | |
| job-name (name) | Client |
| document-name (name) | Client |
| requesting-user-name (name) | Client |
| status-message (text) | Job or Printer |
| detailed-status-message (text) | Job or Printer (note 1) |
| document-access-error (text) | Job or Printer (note 1) |
| | |
| Job Template Attributes: | |
| | |
| job-hold-until (keyword | name) | Client matches Administrator- |
| | configured |
| job-hold-until-default (keyword | | Client matches Administrator- |
| name) | configured |
| job-hold-until-supported (keyword | Client matches Administrator- |
| | name) | configured |
| job-sheets (keyword | name) | Client matches Administrator- |
| | configured |
| job-sheets-default (keyword | | Client matches Administrator- |
| name) | configured |
| job-sheets-supported (keyword | | Client matches Administrator- |
| name) | configured |
| media (keyword | name) | Client matches Administrator- |
| | configured |
| media-default (keyword | name) | Client matches Administrator- |
| | configured |
| media-supported (keyword | name) | Client matches Administrator- |
| | configured |
| media-ready (keyword | name) | Client matches Administrator- |
| | configured |
| | |
| Job Description Attributes: | |
| | |
| job-name (name) | Client or Printer |
| job-originating-user-name (name) | Printer |
| job-state-message (text) | Job or Printer |
| output-device-assigned | Administrator |
| (name(127)) | |
| job-message-from-operator | Operator |
| (text(127)) | |
| job-detailed-status-messages | Job or Printer (note 1) |
| (1setOf text) | |
| job-document-access-errors | Job or Printer (note 1) |
| (1setOf text) | |
| | |
| Printer Description Attributes: | |
| | |
| printer-name (name(127)) | Administrator |
| printer-location (text(127)) | Administrator |
| printer-info (text(127)) | Administrator |
| printer-make-and-model | Administrator or manufacturer |
| (text(127)) | |
| printer-state-message (text) | Printer |
| printer-message-from-operator | Operator |
| (text(127)) | |
+-----------------------------------+-------------------------------+
Table 22: 'text' and 'name' AttributesNote 1: Neither the Printer nor the Client localizes these message attributes, since they are intended for use by the Administrator or other experienced technical persons. 🧐💅
9. Security Considerations 🔐✨
Okay bestie, real talk: it's genuinely hard to predict what security risks might show up in any given IPP environment 🤔. Like, if IPP is running inside a small business over a private LAN with physical security, the risk of exposing Document data can be low enough that the business just decides not to bother with encryption 🙈. But if the connection between the Client and the IPP object goes over a public network, the Client can protect the content while it's traveling through the network by using encryption 🔒.
The value of whatever's being printed also changes from one IPP environment to the next 💰. Printing payroll checks is a whole different vibe from printing public info from a file 💸. There's also the possibility of denial-of-service attacks 😬, but honestly, denial-of-service attacks against printing resources aren't well understood, and there are no published precedents for this scenario 🫠.
Once the authenticated identity of the requester is handed to the IPP object, the object uses it to enforce whatever authorization policy is in place 👑. Like, one site's policy might be that only the Job owner can cancel a Job 🙅♀️. The details and mechanisms for setting up a particular access control policy aren't part of this document, since they're usually set up through some other administrative or access control framework 🛠️. Still, there are operation status-code values that let an IPP server tell a Client about potential access control violations for an IPP object 🚨.
During a Job Creation request, the Client's identity gets recorded in the Job object in an implementation-defined attribute 📝. That info can be used to verify a Client's identity for later operations on that Job object, so the access control policy can be enforced 🔍. See Section 9.3 below for more details 👀. This and other info stored in the Job object can also be seen as personal or sensitive 🫣, and it can be filtered out as part of a configured privacy policy (Section 9.4) 🧹.
Since the security levels or specific threats an Administrator might care about can't be predicted, IPP implementations MUST be capable of operating with different security mechanisms and security policies as required by the individual installation 💅. Security policies can range from very strong to very weak, or to none at all, and the matching security mechanisms will be required 🌈.
This is the part where the stakes are real. Every installation has to be able to plug in its own security setup, so don't assume one size fits all 💀.
9.1. Security Scenarios
The following sections describe specific security attacks for IPP environments 🕵️♀️. Where examples are given, they're illustrative of the environment, not an exhaustive set 🧐.
9.1.1. Client and Server in the Same Security Domain
This is the typical vibe for internal networks, where office workers print output from personal productivity apps on shared workgroup Printers, or where batch apps print to big production Printers 🖨️. Even though the user's identity has been authenticated and can be trusted here, a user might still want to protect the content of a Document from attacks like eavesdropping, replaying, or tampering by using a secure transport such as TLS [RFC5246] 🔐.
9.1.2. Client and Server in Different Security Domains
Examples include printing a Document the Client made on a publicly available Printer, like at a commercial print shop, or printing a Document remotely on a business associate's Printer 🏪. The second one is basically the same as faxing the Document to the business associate 📠. Printing sensitive info on a Printer in a different security domain needs strong security measures 🚨. In this setup, authentication of the Printer is required, plus protection against unauthorized use of print resources 🛡️. Since the Document crosses security domains, protection against eavesdropping and Document tampering is also required 🙀. It's also important here to protect Printers against "spamming" and malicious Document content -- authentication and Document data pre-scanning can be used to minimize those threats 🧼.
9.1.3. Print by Reference
When the Document isn't stored on the Client, printing can be done by reference 📎. Basically, the print request can contain a reference, or pointer, to the Document instead of the Document itself -- see Sections 4.2.2 and 4.3.2 👉. Standard methods don't currently exist for remote entities to "assume" a Client's credentials when forwarding requests to a third party 🙅. It's anticipated that print by reference will be used to access "public" Documents 📖. Note that sophisticated methods for authenticating "proxies" are beyond the scope of this IPP/1.1 document 📌. Because Printers typically process Jobs serially, print by reference isn't seen as a serious denial-of-service threat to the referenced servers 😌.
9.2. URIs in Operation, Job, and Printer Attributes
So printer-uri-supported holds the Printer's URI(s) 🔗, and its buddy uri-security-supported tells you which security mechanism is used for each URI listed in printer-uri-supported 🔐. For each Printer operation request, a Client MUST supply only one URI in the printer-uri operation attribute 🫵. Even though the Printer supports more than one URI, the Client only talks to the Printer using one of them 💬. This duality isn't needed for Job objects, since Printers act as the "factory" for Job objects, and a given Printer will, depending on its security configuration, generate the correct URI for new Job objects 🏭.
9.3. URIs for Each Authentication Mechanism
Each URI has an authentication mechanism attached to it 🪪. If the URI is the "i-th" element of printer-uri-supported, then the authentication mechanism is the "i-th" element of uri-authentication-supported 🔢. For a list of possible authentication mechanisms, see Section 5.4.2 📋.
The Printer uses an authentication mechanism to figure out the name of the user performing an operation 🕵️. This user is called the "authenticated user" ✅. How credible the authentication is depends on the mechanism the Printer uses to get the user's name 🤨. When the authentication mechanism is none, all authenticated users are anonymous 👻.
During Job Creation requests, the Printer initializes the value of the job-originating-user-name attribute (see Section 5.3.6) to be the authenticated user 📛. In this case, the authenticated user is called the "Job owner" 👑.
If an implementation can be configured to support more than one authentication mechanism (see Section 5.4.2), then it MUST implement rules for determining equality of authenticated user names that have been authenticated via different authentication mechanisms 🧩. One possible policy is that identical names authenticated via different mechanisms are different 🙅♀️. For example, a user can cancel his Job only if he uses the same authentication mechanism for both Cancel-Job and Print-Job 🚫. Another policy is that identical names authenticated via different mechanisms are the same if the authentication mechanism for the later operation is not less strong than the authentication mechanism for the earlier Job Creation operation 💪. For example, a user can cancel his Job only if he uses the same or stronger authentication mechanism for Cancel-Job and Print-Job 🏋️. With this second policy, a Job submitted via requesting-user-name authentication could be canceled via digest authentication 🔓. With the first policy, the Job could not be canceled in this way 🙅.
A Client is able to determine the authentication mechanism used to create a Job 🕵️♀️. It's the "i-th" value of the Printer's uri-authentication-supported attribute (see Section 5.4.2), where "i" is the index of the element of the Printer's printer-uri-supported attribute (see Section 5.4.1) equal to the Job's job-printer-uri attribute (see Section 5.3.3) 🧠.
9.4. Restricted Queries
In lots of IPP operations, a Client gives a list of attributes to be returned in the response 📜. For security reasons, an IPP object can be configured not to return all attributes (or all values) a Client asks for 🙈. The Job attributes returned MAY depend on whether the requesting user is the same as the user who submitted the Job 🫣. The IPP object MAY even return none of the requested attributes 🫥. In such cases, the status returned is the same as if the object had returned all requested attributes 🎭. The Client can't tell from that response whether the requested attribute was present or absent in the object 🤷♀️.
9.5. Operations Performed by Operators and Administrators
For the three Printer operations Pause-Printer, Resume-Printer, and Purge-Jobs (see Sections 4.2.7, 4.2.8, and 4.2.9), the requesting user is intended to be an Operator or Administrator of the Printer (see Section 1) 🧑💼. Otherwise, the IPP Printer MUST reject the operation and return client-error-forbidden, client-error-not-authenticated, or client-error-not-authorized as appropriate 🚫. For operations on Jobs, the requesting user is intended to be the Job owner or can be an Operator or Administrator of the Printer 🧾. The means for authorizing an Operator or Administrator of the Printer are not specified in this document 🤐.
9.6. Queries on Jobs Submitted Using Non-IPP Protocols
If the device an IPP Printer represents can accept Jobs through other Job submission protocols besides IPP 🔀, such an implementation SHOULD at least allow those "foreign" Jobs to be queried using Get-Jobs, returning job-id and job-uri as unknown 🔍. Such an implementation MAY support all of the same IPP Job attributes as IPP Jobs do 🧩. The IPP object returns the unknown out-of-band value for any requested attribute of a foreign Job that is supported for IPP Jobs but not for foreign Jobs 👻.
IPP Printers SHOULD also generate job-id and job-uri values for such foreign Jobs, if possible, so they can be targets of other IPP operations, such as Get-Job-Attributes and Cancel-Job 🎯. Such an implementation also needs to deal with authentication of such foreign Jobs 🔐. One approach would be to treat all such foreign Jobs as belonging to users other than the user of the IPP Client 🙅. Another approach would be for the foreign Job to belong to anonymous -- then only authenticated Operators or Administrators of the IPP Printer could query the foreign Jobs with an IPP request 👮♀️. Alternatively, if the security policy is to allow users to query other users' Jobs, then the foreign Jobs would also be visible to an End User IPP Client using Get-Jobs and Get-Job-Attributes 👀.
10. Changes since RFC 2911 💅
okay bestie, this is the glow-up list 🦋 here's everything that changed since RFC 2911 ✨
- Errata ID 364: we fixed the range of "redirection" status-code values, which is now
0x03xx🔥 - Errata ID 694: we fixed the range of vendor status-code values, which is now
0x0n80to0x0nff🎀 - Errata ID 3072: we reworded the multiple-document-handling definition 🌸 It applies to Jobs with a single Document too, and it's the only interoperable way to ask for uncollated copies, so it had to be said properly 💖
- Errata ID 3365: the
nameWithLanguagemaximum length was wrong 😭 It now points to thenameWithoutLanguagesection (Section 5.1.3.1) so the two stay in sync 🧚 - Errata ID 4173: the range of vendor operation codes is fixed, and it's now
0x4000to0x7fff👑 - Obsoleted RFC references got updated 💅
- The IPP/1.1 Implementor's Guide reference now points to RFC 3196 🌈
- Create-Job, Send-Document, and Send-URI are now RECOMMENDED ✨ (main character energy for these three 💜)
- The
collectionattribute content from RFC 3382 got incorporated 🦋 - All attributes and values from RFC 3381 are obsoleted 💀 They don't play nicely with the "finishings" attribute and were never widely implemented, so bye bye 👋
- The Purge-Jobs and Restart-Job operations are deprecated 😭 They destroy accounting information, which is a no-go 🙈
- Type3 registration procedures got dropped 🍓
- Vendor attribute and keyword naming recommendations now use SMI Private Enterprise Numbers (
smiNNN-foo) instead of domain names 🧚 (so much cleaner, ngl 💜) - READ-ONLY Job Description and Printer Description attributes got split into Job Status and Printer Status attributes 🌸 This matches the current IANA IPP registry organization, so everything lines up 🎀
- All IETF and PWG IPP standards are referenced now 🔥
- OPTIONAL operations, attributes, and values are now RECOMMENDED 💖 This keeps things consistent with IPP 2.0, IPP Everywhere, and the IPP Implementor's Guide v2.0 👑
- The appendix on media names is removed ✨ Go read "PWG Media Standardized Names 2.0 (MSN2)" [PWG5101.1] instead 🌈
11. References
11.1. Normative References ✨
okay bestie, these are the docs the spec leans on so hard that you can't really get the full picture without them 📚💅 here's the whole list, same as the original, with every label, title, date, and link intact 🫶
[ASME-Y14.1M]ASME Y14.1M-2012, "Metric Drawing Sheet Size and Format", March 2013.[ISO10175]ISO/IEC 10175, "Information technology -- Text and office systems -- Document Printing Application (DPA) -- Part 1: Abstract service definition and procedures", September 1996.[ISO10646]ISO/IEC 10646:2014, JTC1/SC2, "Information technology -- Universal Coded Character Set (UCS)", September 2014.[ISO8859-1]ISO/IEC 8859-1:1998, "Information technology -- 8-bit single-byte coded graphic character sets -- Part 1: Latin alphabet No. 1", April 1998.[PWG5100.1]Sweet, M., "IPP Finishings 2.0 (FIN)", December 2014,<http://ftp.pwg.org/pub/pwg/candidates/cs-ippfinishings20-20141219-5100.1.pdf>.[PWG5100.11]Hastings, T. and D. Fullman, "Internet Printing Protocol (IPP): Job and Printer Extensions -- Set 2 (JPS2)", October 2010,<http://ftp.pwg.org/pub/pwg/candidates/cs-ippjobprinterext10-20101030-5100.11.pdf>.[PWG5100.12]Sweet, M. and I. McDonald, "IPP Version 2.0, 2.1, and 2.2", October 2015,<http://ftp.pwg.org/pub/pwg/standards/std-ipp20-20151030-5100.12.pdf>.[PWG5100.13]Sweet, M., McDonald, I., and P. Zehler, "IPP: Job and Printer Extensions -- Set 3 (JPS3)", July 2012,<http://ftp.pwg.org/pub/pwg/candidates/cs-ippjobprinterext3v10-20120727-5100.13.pdf>.[PWG5100.14]Sweet, M., McDonald, I., Mitchell, A., and J. Hutchings, "IPP Everywhere", January 2013,<http://ftp.pwg.org/pub/pwg/candidates/cs-ippeve10-20130128-5100.14.pdf>.[PWG5100.15]Sweet, M., "IPP FaxOut Service", June 2014,<http://ftp.pwg.org/pub/pwg/candidates/cs-ippfaxout10-20140618-5100.15.pdf>.[PWG5100.16]Sweet, M., "IPP Transaction-Based Printing Extensions", November 2013,<http://ftp.pwg.org/pub/pwg/candidates/cs-ipptrans10-20131108-5100.16.pdf>.[PWG5100.17]Zehler, P. and M. Sweet, "IPP Scan Service (SCAN)", September 2014,<http://ftp.pwg.org/pub/pwg/candidates/cs-ippscan10-20140918-5100.17.pdf>.[PWG5100.18]Sweet, M. and I. McDonald, "IPP Shared Infrastructure Extensions (INFRA)", June 2015,<http://ftp.pwg.org/pub/pwg/candidates/cs-ippinfra10-20150619-5100.18.pdf>.[PWG5100.19]Kennedy, S., "IPP Implementor's Guide v2.0 (IG)", August 2015,<http://ftp.pwg.org/pub/pwg/candidates/cs-ippig20-20150821-5100.19.pdf>.[PWG5100.2]Hastings, T. and R. Bergman, "Internet Printing Protocol (IPP): "output-bin" attribute extension", February 2001,<http://ftp.pwg.org/pub/pwg/candidates/cs-ippoutputbin10-20010207-5100.2.pdf>.[PWG5100.3]Ocke, K. and T. Hastings, "Internet Printing Protocol (IPP): Production Printing Attributes -- Set1", February 2001,<http://ftp.pwg.org/pub/pwg/candidates/cs-ippprodprint10-20010212-5100.3.pdf>.[PWG5100.5]Carney, D., Hastings, T., and P. Zehler, "Standard for The Internet Printing Protocol (IPP): Document Object", October 2003,<http://ftp.pwg.org/pub/pwg/candidates/cs-ippdocobject10-20031031-5100.5.pdf>.[PWG5100.6]Zehler, P., Herriot, R., and K. Ocke, "Standard for The Internet Printing Protocol (IPP): Page Overrides", October 2003,<http://ftp.pwg.org/pub/pwg/candidates/cs-ipppageoverride10-20031031-5100.6.pdf>.[PWG5100.7]Hastings, T. and P. Zehler, "Standard for The Internet Printing Protocol (IPP): Job Extensions", October 2003,<http://ftp.pwg.org/pub/pwg/candidates/cs-ippjobext10-20031031-5100.7.pdf>.[PWG5100.8]Carney, D. and H. Lewis, "Standard for Internet Printing Protocol (IPP): "-actual" attributes", March 2003,<http://ftp.pwg.org/pub/pwg/candidates/cs-ippactuals10-20030313-5100.8.pdf>.[PWG5100.9]McDonald, I. and C. Whittle, "Internet Printing Protocol (IPP): Printer State Extensions v1.0", July 2009,<http://ftp.pwg.org/pub/pwg/candidates/cs-ippstate10-20090731-5100.9.pdf>.[PWG5101.1]Sweet, M., Bergman, R., and T. Hastings, "PWG Media Standardized Names 2.0 (MSN2)", March 2013,<http://ftp.pwg.org/pub/pwg/candidates/cs-pwgmsn20-20130328-5101.1.pdf>.[RFC20]Cerf, V., "ASCII format for network interchange", STD 80, RFC 20, DOI 10.17487/RFC0020, October 1969,<http://www.rfc-editor.org/info/rfc20>.[RFC793]Postel, J., "Transmission Control Protocol", STD 7, RFC 793, DOI 10.17487/RFC0793, September 1981,<http://www.rfc-editor.org/info/rfc793>.[RFC1035]Mockapetris, P., "Domain names - implementation and specification", STD 13, RFC 1035, DOI 10.17487/RFC1035, November 1987,<http://www.rfc-editor.org/info/rfc1035>.[RFC1951]Deutsch, P., "DEFLATE Compressed Data Format Specification version 1.3", RFC 1951, DOI 10.17487/RFC1951, May 1996,<http://www.rfc-editor.org/info/rfc1951>.[RFC1952]Deutsch, P., "GZIP file format specification version 4.3", RFC 1952, DOI 10.17487/RFC1952, May 1996,<http://www.rfc-editor.org/info/rfc1952>.[RFC1977]Schryver, V., "PPP BSD Compression Protocol", RFC 1977, DOI 10.17487/RFC1977, August 1996,<http://www.rfc-editor.org/info/rfc1977>.[RFC2046]Freed, N. and N. Borenstein, "Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types", RFC 2046, DOI 10.17487/RFC2046, November 1996,<http://www.rfc-editor.org/info/rfc2046>.[RFC2119]Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997,<http://www.rfc-editor.org/info/rfc2119>.[RFC2818]Rescorla, E., "HTTP Over TLS", RFC 2818, DOI 10.17487/RFC2818, May 2000,<http://www.rfc-editor.org/info/rfc2818>.[RFC3196]Hastings, T., Manros, C., Zehler, P., Kugler, C., and H. Holst, "Internet Printing Protocol/1.1: Implementor's Guide", RFC 3196, DOI 10.17487/RFC3196, November 2001,<http://www.rfc-editor.org/info/rfc3196>.[RFC3380]Hastings, T., Herriot, R., Kugler, C., and H. Lewis, "Internet Printing Protocol (IPP): Job and Printer Set Operations", RFC 3380, DOI 10.17487/RFC3380, September 2002,<http://www.rfc-editor.org/info/rfc3380>.[RFC3510]Herriot, R. and I. McDonald, "Internet Printing Protocol/1.1: IPP URL Scheme", RFC 3510, DOI 10.17487/RFC3510, April 2003,<http://www.rfc-editor.org/info/rfc3510>.[RFC3629]Yergeau, F., "UTF-8, a transformation format of ISO 10646", STD 63, RFC 3629, DOI 10.17487/RFC3629, November 2003,<http://www.rfc-editor.org/info/rfc3629>.[RFC3805]Bergman, R., Lewis, H., and I. McDonald, "Printer MIB v2", RFC 3805, DOI 10.17487/RFC3805, June 2004,<http://www.rfc-editor.org/info/rfc3805>.[RFC3986]Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform Resource Identifier (URI): Generic Syntax", STD 66, RFC 3986, DOI 10.17487/RFC3986, January 2005,<http://www.rfc-editor.org/info/rfc3986>.[RFC3995]Herriot, R. and T. Hastings, "Internet Printing Protocol (IPP): Event Notifications and Subscriptions", RFC 3995, DOI 10.17487/RFC3995, March 2005,<http://www.rfc-editor.org/info/rfc3995>.[RFC3996]Herriot, R., Hastings, T., and H. Lewis, "Internet Printing Protocol (IPP): The 'ippget' Delivery Method for Event Notifications", RFC 3996, DOI 10.17487/RFC3996, March 2005,<http://www.rfc-editor.org/info/rfc3996>.[RFC3998]Kugler, C., Lewis, H., and T. Hastings, Ed., "Internet Printing Protocol (IPP): Job and Printer Administrative Operations", RFC 3998, DOI 10.17487/RFC3998, March 2005,<http://www.rfc-editor.org/info/rfc3998>.[RFC5051]Crispin, M., "i;unicode-casemap - Simple Unicode Collation Algorithm", RFC 5051, DOI 10.17487/RFC5051, October 2007,<http://www.rfc-editor.org/info/rfc5051>.[RFC5234]Crocker, D., Ed., and P. Overell, "Augmented BNF for Syntax Specifications: ABNF", STD 68, RFC 5234, DOI 10.17487/RFC5234, January 2008,<http://www.rfc-editor.org/info/rfc5234>.[RFC5246]Dierks, T. and E. Rescorla, "The Transport Layer Security (TLS) Protocol Version 1.2", RFC 5246, DOI 10.17487/RFC5246, August 2008,<http://www.rfc-editor.org/info/rfc5246>.[RFC5646]Phillips, A., Ed., and M. Davis, Ed., "Tags for Identifying Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646, September 2009,<http://www.rfc-editor.org/info/rfc5646>.[RFC6838]Freed, N., Klensin, J., and T. Hansen, "Media Type Specifications and Registration Procedures", BCP 13, RFC 6838, DOI 10.17487/RFC6838, January 2013,<http://www.rfc-editor.org/info/rfc6838>.[RFC7230]Fielding, R., Ed., and J. Reschke, Ed., "Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing", RFC 7230, DOI 10.17487/RFC7230, June 2014,<http://www.rfc-editor.org/info/rfc7230>.[RFC7472]McDonald, I. and M. Sweet, "Internet Printing Protocol (IPP) over HTTPS Transport Binding and the 'ipps' URI Scheme", RFC 7472, DOI 10.17487/RFC7472, March 2015,<http://www.rfc-editor.org/info/rfc7472>.[RFC7612]Fleming, P. and I. McDonald, "Lightweight Directory Access Protocol (LDAP): Schema for Printer Services", RFC 7612, DOI 10.17487/RFC7612, June 2015,<http://www.rfc-editor.org/info/rfc7612>.[RFC7616]Shekh-Yusef, R., Ed., Ahrens, D., and S. Bremer, "HTTP Digest Access Authentication", RFC 7616, DOI 10.17487/RFC7616, September 2015,<http://www.rfc-editor.org/info/rfc7616>.[RFC7617]Reschke, J., "The 'Basic' HTTP Authentication Scheme", RFC 7617, DOI 10.17487/RFC7617, September 2015,<http://www.rfc-editor.org/info/rfc7617>.[RFC8010]Sweet, M. and I. McDonald, "Internet Printing Protocol/1.1: Encoding and Transport", RFC 8010, DOI 10.17487/RFC8010, January 2017,<http://www.rfc-editor.org/info/rfc8010>.
that's the whole normative list, lovely work 🌸
11.2. Informative References
Okay bestie, now we're at the extra reading list 📚✨ These are the informative references, the background docs that give you context. Every single one is here with all its details:
- [HTPP] Barnett, J., Carter, K., and R. deBry, "Internet Print Protocol Proposal: HTPP -- Hypertext Print Protocol (HTPP/1.0 Initial Draft)", October 1996,
<ftp://ftp.pwg.org/pub/pwg/ipp/historic/htpp/overview.ps.gz>. - [IANA-CS] IANA, "Registry of Coded Character Sets",
<http://www.iana.org/assignments/character-sets/>. - [IANA-MT] IANA, "Media Types",
<http://www.iana.org/assignments/media-types/>. - [IANA-PEN] IANA, "Private Enterprise Numbers",
<http://www.iana.org/assignments/enterprise-numbers/>. - [ISO32000] "Document management -- Portable document format -- Part 1: PDF 1.7", July 2008,
<http://www.adobe.com/devnet/acrobat/pdfs/PDF32000_2008.pdf>. - [LDPA] Isaacson, S., Taylor, D., MacKay, M., Zehler, P., Hastings, T., and C. Manros, "LDPA - Lightweight Document Printing Application", Proposed Internet-Draft, October 1996,
<ftp://ftp.pwg.org/pub/pwg/ipp/historic/ldpa/ldpa8.pdf.gz>. - [P1387.4] Kirk, M., "POSIX Systems Administration - Part 4: Printing Interfaces, POSIX 1387.4 D8", 1998.
- [PSIS] Herriot, R., Ed., "X/Open: A Printing System Interoperability Specification (PSIS)", August 1995.
- [PWG-IPP-WG] IEEE-ISTO Printer Working Group, "Internet Printing Protocol Workgroup",
<http://www.pwg.org/ipp>. - [RFC959] Postel, J. and J. Reynolds, "File Transfer Protocol", STD 9, RFC 959, DOI 10.17487/RFC0959, October 1985,
<http://www.rfc-editor.org/info/rfc959>. - [RFC1179] McLaughlin, L., "Line printer daemon protocol", RFC 1179, DOI 10.17487/RFC1179, August 1990,
<http://www.rfc-editor.org/info/rfc1179>. - [RFC1738] Berners-Lee, T., Masinter, L., and M. McCahill, "Uniform Resource Locators (URL)", RFC 1738, DOI 10.17487/RFC1738, December 1994,
<http://www.rfc-editor.org/info/rfc1738>. - [RFC2565] Herriot, R., Ed., Butler, S., Moore, P., and R. Turner, "Internet Printing Protocol/1.0: Encoding and Transport", RFC 2565, DOI 10.17487/RFC2565, April 1999,
<http://www.rfc-editor.org/info/rfc2565>. - [RFC2566] deBry, R., Hastings, T., Herriot, R., Isaacson, S., and P. Powell, "Internet Printing Protocol/1.0: Model and Semantics", RFC 2566, DOI 10.17487/RFC2566, April 1999,
<http://www.rfc-editor.org/info/rfc2566>. - [RFC2567] Wright, F., "Design Goals for an Internet Printing Protocol", RFC 2567, DOI 10.17487/RFC2567, April 1999,
<http://www.rfc-editor.org/info/rfc2567>. - [RFC2568] Zilles, S., "Rationale for the Structure of the Model and Protocol for the Internet Printing Protocol", RFC 2568, DOI 10.17487/RFC2568, April 1999,
<http://www.rfc-editor.org/info/rfc2568>. - [RFC2569] Herriot, R., Ed., Hastings, T., Jacobs, N., and J. Martin, "Mapping between LPD and IPP Protocols", RFC 2569, DOI 10.17487/RFC2569, April 1999,
<http://www.rfc-editor.org/info/rfc2569>. - [RFC2579] McCloghrie, K., Ed., Perkins, D., Ed., and J. Schoenwaelder, Ed., "Textual Conventions for SMIv2", STD 58, RFC 2579, DOI 10.17487/RFC2579, April 1999,
<http://www.rfc-editor.org/info/rfc2579>. - [RFC2978] Freed, N. and J. Postel, "IANA Charset Registration Procedures", BCP 19, RFC 2978, DOI 10.17487/RFC2978, October 2000,
<http://www.rfc-editor.org/info/rfc2978>. - [RFC3239] Kugler, C., Lewis, H., and T. Hastings, "Internet Printing Protocol (IPP): Requirements for Job, Printer, and Device Administrative Operations", RFC 3239, DOI 10.17487/RFC3239, February 2002,
<http://www.rfc-editor.org/info/rfc3239>. - [RFC3997] Hastings, T., Ed., deBry, R., and H. Lewis, "Internet Printing Protocol (IPP): Requirements for IPP Notifications", RFC 3997, DOI 10.17487/RFC3997, March 2005,
<http://www.rfc-editor.org/info/rfc3997>. - [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally Unique IDentifier (UUID) URN Namespace", RFC 4122, DOI 10.17487/RFC4122, July 2005,
<http://www.rfc-editor.org/info/rfc4122>. - [RFC5226] Narten, T. and H. Alvestrand, "Guidelines for Writing an IANA Considerations Section in RFCs", BCP 26, RFC 5226, DOI 10.17487/RFC5226, May 2008,
<http://www.rfc-editor.org/info/rfc5226>. - [RFC6068] Duerst, M., Masinter, L., and J. Zawinski, "The 'mailto' URI Scheme", RFC 6068, DOI 10.17487/RFC6068, October 2010,
<http://www.rfc-editor.org/info/rfc6068>. - [RFC7525] Sheffer, Y., Holz, R., and P. Saint-Andre, "Recommendations for Secure Use of Transport Layer Security (TLS) and Datagram Transport Layer Security (DTLS)", BCP 195, RFC 7525, DOI 10.17487/RFC7525, May 2015,
<http://www.rfc-editor.org/info/rfc7525>. - [SWP] Moore, P. and S. Butler, "Simple Web Printing (SWP/1.0)", May 1997,
<ftp://ftp.pwg.org/pub/pwg/ipp/new_PRO/swp9705.pdf>.
Appendix A. Formats for IPP Registration Proposals 🎀
So if you want to propose an IPP extension for registration, here's the drill 💅 You've got to send an application to IANA, either by emailing "iana@iana.org" or by filling out the form on the IANA web pages (http://www.iana.org). This appendix lists the info you need and the formats for proposing registrations of extensions to IPP, as described in Section 7, for:
- attributes
- type2 'keyword' attribute values
- type2 'enum' attribute values
- operations
- status-code values
A.1. Attribute Registration
Here's the attribute template 🦋 copy it and fill in the blanks:
Type of registration: attribute
Proposed keyword name of this attribute:
Types of attributes (Document Description, Document Status, Document
Template, Event Notifications, Job Description, Job Status, Job
Template, Operation, Printer Description, Printer Status,
Subscription Description, Subscription Status, Subscription
Template):
Operations to be used if the attribute is an operation attribute:
Object (Document, Job, Printer, Subscription, etc. if bound to an
object):
Attribute syntax(es) (include '1setOf' and range; see Section 5.2):
If attribute syntax is 'keyword' or 'enum', is it type1 or type2?
If this is a Printer attribute, MAY the value returned depend on
"document-format"? (See Section 7.2.)
If this is a Job Template attribute, how does its specification
depend on the value of the "multiple-document-handling" attribute?
Specification of this attribute (follow the style of Section 5.2):
Name of proposer:
Email address of proposer:For attributes, the IPP Designated Expert is the point of contact and change controller for the approved registration specification, if any maintenance of that spec is needed. 🫶
A.2. type2 'keyword' Attribute Value Registration
Next up is the template for adding a type2 'keyword' value 🌸
Type of registration: type2 keyword attribute value
Name of attribute to which this keyword specification is to be added:
Proposed keyword name of this 'keyword' value:
Specification of this 'keyword' value (follow the style of
Section 5.1.4):
Name of proposer:
Email address of proposer:For type2 keywords, the Designated Expert is the point of contact and change controller for the approved registration specification, if any maintenance of that spec is needed. 💜
A.3. type2 'enum' Attribute Value Registration
Now the type2 'enum' template 🧚
Type of registration: type2 enum attribute value
Name of attribute to which this enum specification is to be added:
Keyword symbolic name of this enum value:
Numeric value (to be assigned by the IPP Designated Expert in
consultation with IANA):
Specification of this enum value (follow the style of Section 5.1.5):
Name of proposer:
Email address of proposer:For type2 enums, the Designated Expert is the point of contact and change controller for the approved registration specification, if any maintenance of that spec is needed. 🍓
A.4. Operation Registration
Operations get their own template 👑
Type of registration: operation
Proposed name of this operation:
Numeric "operation-id" value according to Section 5.4.15 (to be
assigned by the IPP Designated Expert in consultation with IANA):
Object Target (Document, Job, Printer, Subscription, etc. that
operation is upon):
Specification of this operation (follow the style of Section 4):
Name of proposer:
Email address of proposer:For operations, the IPP Designated Expert is the point of contact and change controller for the approved registration specification, if any maintenance of that spec is needed. ⭐
A.5. Status-Code Registration
And last but not least, the status-code template 🌈
Type of registration: status-code
Keyword symbolic name of this status-code value:
Numeric value (to be assigned by the IPP Designated Expert in
consultation with IANA):
Operations that this status-code can be used with:
Specification of this status-code (follow the style of Appendix B):
Name of proposer:
Email address of proposer:For status-code values, the Designated Expert is the point of contact and change controller for the approved registration specification, if any maintenance of that spec is needed. 🦋
Appendix B. Status-Code Values and Suggested Status-Code Messages ✨
okay bestie, this is the status-code section 💅 and it's giving "how the printer tells you what happened" 🖨️. every operation response MUST include a status-code 🫶 and it MAY also have a status message 💬. the status-code is for the robots (automata) 🤖 and the status message is for the actual human End User 🙈
the prefix of the status keyword tells you the class of response 🎀:
informational- request received, still going 🌸successful- the action got received, understood, and accepted ✨redirection- more action needed to finish the request 🦋client-error- the request has bad syntax or can't be fulfilled 😭server-error- the IPP object messed up on a request that looked totally valid 💀
ok so as with type2 enums, IPP status-code values are extensible 🧚. even if you don't recognize every single status-code, IPP Clients MUST understand the class of any status-code from the prefix 👑, and treat anything unrecognized like the first status-code of that class. the one exception: an unrecognized response MUST NOT be cached 🙅♀️. so for example, if a Client gets client-error-xxx-yyy, it can safely assume something was wrong with its request and treat it like client-error-bad-request 💖. the name of the enum is the suggested status message for US English 🇺🇸
see [PWG5100.19] for guidelines on presenting status messages to End Users 📚
the status-code values range from 0x0000 to 0x7fff 🌈. here's the range for each class:
- "successful" - 0x0000 to 0x00ff
- "informational" - 0x0100 to 0x01ff
- "redirection" - 0x0300 to 0x03ff
- "client-error" - 0x0400 to 0x04ff
- "server-error" - 0x0500 to 0x05ff
the top half (128 values) of each range (0x0n80 to 0x0nff, for n = 0 to 5) is reserved for vendor use within each status-code class 🏷️. and values 0x0600 to 0x7fff are reserved for future assignment by Standards Track documents and MUST NOT be used 🚫
B.1. Status-Code Values
each status-code is described below 👀. Appendix B.2 has a table showing which status-code values apply to which operations 📋. the Implementor's Guides [RFC3196] [PWG5100.19] give guidance on processing IPP attributes for all operations, including status-code values 📖
B.1.1. Informational
this class is for provisional responses and is to be used for informational purposes only 🌸
there are no values defined in this document for this class 🫠
B.1.2. Successful Status-Code Values
this class means the Client's request was successfully received, understood, and accepted 🎉
B.1.2.1. successful-ok (0x0000)
the request has succeeded, and no request attributes were substituted or ignored ✅. for a response to a Job Creation request, successful-ok means the request was received and validated and the Job object has been created 🧁. BUT it does NOT mean the Job has been processed 😤. the only thing that tells you the Job has been printed is the Job object moving into the completed state 🖨️✨
B.1.2.2. successful-ok-ignored-or-substituted-attributes (0x0001)
the request has succeeded, but some supplied (1) attributes were ignored or (2) unsupported values were substituted with supported values or ignored so the operation could go through without being rejected 🥹. unsupported attributes, attribute syntaxes, or values MUST be returned in the Unsupported Attributes group of the response for all operations 📦. there's one exception for the query operations Get-Printer-Attributes, Get-Jobs, and Get-Job-Attributes, but only for the "requested-attributes" operation attribute 👀. when the supplied values of "requested-attributes" are asking for attributes that aren't supported, the IPP object SHOULD return the "requested-attributes" operation attribute in the Unsupported Attributes group (with just the unsupported values) 🫶. see Sections 4.1.7 and 4.2.1.2 📎
B.1.2.3. successful-ok-conflicting-attributes (0x0002)
the request has succeeded, but some supplied attribute values conflicted with the values of other supplied attributes ⚡. either (1) those conflicting values got swapped for (supported) values, or (2) the attributes got removed so the Job could still be processed without being rejected 🪄. attributes or values that conflict and got substituted or ignored MUST be returned in the Unsupported Attributes group of the response for all operations, as supplied by the Client 📬. see Sections 4.1.7 and 4.2.1.2 💕
B.1.3. Redirection Status-Code Values
this class means more action needs to be taken to fulfill the request 🦋
there are no values defined in this document for this class either 🫠
B.1.4. Client Error Status-Code Values
this class is for when the Client seems to have erred 🙈. the IPP object SHOULD return a message explaining the error and whether it's a temporary or permanent condition 💌
B.1.4.1. client-error-bad-request (0x0400)
the request couldn't be understood by the IPP object because of malformed syntax 🤯. for example, a fixed-length attribute whose length doesn't match the prescribed length for that attribute (see the Implementor's Guides [RFC3196] [PWG5100.19]) 📏. the IPP application SHOULD NOT repeat the request without modifications 🚫🔁
B.1.4.2. client-error-forbidden (0x0401)
the IPP object understood the request but is refusing to fulfill it 🙅♀️. extra authentication info or authorization credentials won't help, and the request SHOULD NOT be repeated 🛑. this status-code is commonly used when the IPP object doesn't want to reveal exactly why the request was refused, or when no other response fits 🤐
B.1.4.3. client-error-not-authenticated (0x0402)
the request needs user authentication 🔐. the IPP Client can repeat the request with suitable authentication information 🔑. if the request already included authentication info, this status-code means authorization was refused for those credentials 🚪. if this response has the same challenge as the prior response and the user agent already tried authenticating at least once, the response message can include relevant diagnostic information 🔍. this one reveals MORE info than client-error-forbidden 👀
B.1.4.4. client-error-not-authorized (0x0403)
the requester isn't authorized to perform the request 🚷. extra authentication info or authorization credentials won't help, and the request SHOULD NOT be repeated 🛑. this is used when the IPP object wants to reveal that the authentication info is understandable, but the requester is explicitly not authorized to do the thing 🙃. it reveals more info than both client-error-forbidden and client-error-not-authenticated 💅
B.1.4.5. client-error-not-possible (0x0404)
this one's for when the request is for something that just cannot happen 🌀. like, maybe someone tries to cancel a Job that was already canceled or aborted by the system 😵. the IPP Client SHOULD NOT repeat the request 🙅♀️
B.1.4.6. client-error-timeout (0x0405)
the Client didn't produce a request within the time the IPP object was prepared to wait ⏰. for example, a Client issued a Create-Job operation and then, after a long time, issued a Send-Document operation 😬. this error was returned in response to the Send-Document request (see Section 4.3.1) 📨. the IPP object might have had to clean up resources it was holding for the Documents it was waiting on 🧹. it was also forced to close the Job, because the Client took too long 🔒. the Client SHOULD NOT repeat the request without modifications ✋
B.1.4.7. client-error-not-found (0x0406)
the IPP object hasn't found anything matching the request URI 🔎. there's no indication of whether the condition is temporary or permanent 🤷♀️. for example, a Client with an old reference to a Job (a URI) tries to cancel it, but in the meantime the Job might have been completed and all record of it at the Printer deleted 🗑️. so this client-error-not-found status-code comes back to say the referenced Job can't be found 🥲. this error is also used when a Client gives a URI as a reference to the Document data in a Print-URI or Send-URI operation but the Document can't be found 📄
in practice, an IPP application should avoid a "not found" situation by first querying and presenting a list of valid Printer URIs and Job URIs to the End User 💡
B.1.4.8. client-error-gone (0x0407)
the requested object is no longer available and no forwarding address is known 💀. this condition should be considered permanent 🪦. Clients with link-editing capabilities should delete references to the request URI after user approval ✂️. if the IPP object doesn't know or has no way to figure out whether the condition is permanent, client-error-not-found should be used instead 🔄
this response is mainly there to help with maintenance 🛠️. it tells the recipient the resource is intentionally unavailable and that the IPP object Administrator wants remote links to that resource removed 🧹. you don't have to mark every permanently unavailable resource as "gone", and you don't have to keep the mark for any length of time, since that's left up to the IPP object Administrator and/or Printer implementation 🫶
B.1.4.9. client-error-request-entity-too-large (0x0408)
the IPP object is refusing to process a request because the request entity is bigger than it's willing or able to handle 📦💥. an IPP Printer returns this when it limits the size of Print Jobs and gets a Print Job over that limit 🖨️, or when there are so many attributes that their encoding pushes the request entity past the IPP object's capacity 🫠
B.1.4.10. client-error-request-value-too-long (0x0409) 🎀
okay so this one is about a request that's got a value that's way too long for the attribute it's in 😭 the IPP object is like "nope, not servicing this" because one or more of the client-supplied attributes has a variable-length value that's longer than the max length for that attribute. the object might not have enough resources (memory, buffers, etc.) to even handle, interpret, or ignore a value that big, even for a sec. 💀 there's also a second situation: the object can handle a big value that's still under the max, but while it's processing the whole request, it passes that value along to some other system component that can't take a value that large. for more details, check the Implementor's Guides [RFC3196] [PWG5100.19] ✨
Note: for URI values, this is a rare one. it mostly happens when a client sent a request with a super long query (like an IPP app letting an End User type in a bad URI 🙈), when the client got stuck in a URI "black hole" of redirection (like a redirected URI prefix that points to a suffix of itself, so it just loops forever 🌀), or when the IPP object is under attack by a client trying to exploit security holes in some IPP objects that use fixed-length buffers for reading or manipulating the request URI. yikes 😭🔥
B.1.4.11. client-error-document-format-not-supported (0x040a) 🦋
the IPP object is refusing to service the request because the Document data is in a format (as specified in the document-format operation attribute) that the Printer doesn't support 💅 this error gets returned no matter what the client set for ipp-attribute-fidelity. the Printer MUST return this status-code, even if there are other Job Template attributes that aren't supported too, because this error is a way bigger problem than unsupported Job Template attributes. see Sections 4.1.6.1, 4.1.7, and 4.2.1.1 🌸
B.1.4.12. client-error-attributes-or-values-not-supported (0x040b) 🍓
okay this one's a bit of a juggling act 🤹♀️ in a Job Creation request, if the Printer doesn't support one or more attributes, attribute syntaxes, or attribute values the client sent, AND the client set ipp-attribute-fidelity to true, the Printer MUST return this status-code. the Printer MUST ALSO return, in the Unsupported Attributes group, all the attributes and/or values the client sent that aren't supported. see Section 4.1.7 ✨ examples: the request asks for iso-a4 media but the Printer doesn't support that media type, or the client sends a Job Template attribute that the Printer doesn't support at all 📄
but if ipp-attribute-fidelity is false, the Printer MUST ignore or substitute values for unsupported Job Template attributes and values, instead of rejecting the request and returning this status-code. so it's basically "be flexible, babe" 🫶
now for requests where the client is asking for attributes (like a Get-Jobs, Get-Printer-Attributes, or Get-Job-Attributes operation): if the IPP object doesn't support one or more of the requested attributes, it just ignores those and processes the request like they were never asked for. no error here 🙌 in that case, the IPP object MUST return the successful-ok-ignored-or-substituted-attributes status-code, and SHOULD return the unsupported attributes as values of the requested-attributes operation attribute in the Unsupported Attributes group (see Appendix B.1.2.2) 💜
B.1.4.13. client-error-uri-scheme-not-supported (0x040c) 🌈
the scheme of the client-supplied URI in a Print-URI or Send-URI operation isn't supported. see Sections 4.1.6.1 and 4.1.7 🔗
B.1.4.14. client-error-charset-not-supported (0x040d) 💖
for any operation, if the IPP Printer doesn't support the charset the client sent in the attributes-charset operation attribute, the Printer MUST reject the operation and return this status-code. that also covers any 'text' or 'name' attributes that use the 'utf-8' charset (Section 4.1.4.1). see Sections 4.1.6.1 and 4.1.7 🌷
B.1.4.15. client-error-conflicting-attributes (0x040e) ⚡
the request gets rejected because some attribute values clashed with the values of other attributes, and this document doesn't allow those to be swapped out or ignored 🙅♀️ the Printer MUST ALSO return, in the Unsupported Attributes group, the conflicting attributes the client supplied. see Sections 4.1.7 and 4.2.1.2 💅
B.1.4.16. client-error-compression-not-supported (0x040f) 🗜️
the IPP object is refusing to service the request because the Document data, as specified in the compression operation attribute, is compressed in a way the Printer doesn't support. this error gets returned no matter what the client set for ipp-attribute-fidelity. the Printer MUST return this status-code, even if there are other Job Template attributes that aren't supported as well, since this error is a bigger problem than Job Template attributes are. see Sections 4.1.6.1, 4.1.7, and 4.2.1.1 🫧
B.1.4.17. client-error-compression-error (0x0410) 🥀
the IPP object is refusing to service the request because the Document data can't be decompressed using the algorithm the compression operation attribute names. this error is returned independent of ipp-attribute-fidelity (so it doesn't matter what the client picked there 🙃). the Printer MUST return this status-code, even if there are Job Template attributes that aren't supported too, because this error is a bigger deal. see Sections 4.1.7 and 4.2.1.1 ✨
B.1.4.18. client-error-document-format-error (0x0411) 🧚
the IPP object is refusing to service the request because the Printer ran into an error in the Document data while it was interpreting it 🤯 this error is returned independent of the client-supplied ipp-attribute-fidelity attribute. the Printer MUST return this status-code, even if there are Job Template attributes that aren't supported, since this error is a bigger problem than those. see Sections 4.1.7 and 4.2.1.1 💜
B.1.4.19. client-error-document-access-error (0x0412) 🔐
the IPP object is refusing to service the Print-URI or Send-URI request because the Printer ran into an access error while trying to check that the Document data in the document-uri operation attribute is accessible (or that it can be accessed at all) 🚪 the Printer MAY ALSO return a specific Document access error code using the document-access-error operation attribute (see Section 4.1.6.4). this error is returned independent of the client-supplied ipp-attribute-fidelity attribute. the Printer MUST return this status-code, even if there are Job Template attributes that aren't supported as well, since this error is a bigger problem than those. see Sections 4.1.6.1 and 4.1.7 🌟
B.1.5. Server Error Status-Code Values 🖥️💥
this class of status-codes is for when the IPP object knows it messed up or just can't do the request. the IPP object SHOULD include a message that explains what went wrong, and whether it's a temporary or permanent situation 🫶
B.1.5.1. server-error-internal-error (0x0500) 🚨
the IPP object ran into an unexpected condition that stopped it from fulfilling the request. this one differs from 'server-error-temporary-error' because it implies a more permanent type of internal error 🪨 it also differs from 'server-error-device-error' because that one is an expected kind of problem (like a paper jam or running out of toner, which is annoying but normal), whereas this one is a genuinely unexpected condition. this status-code means a knowledgeable human probably needs to step in 🧑🔧👑
B.1.5.2. server-error-operation-not-supported (0x0501) 🙅♀️
the IPP object doesn't support the functionality it would need to fulfill the request. this is the right response when the IPP object doesn't recognize an operation or can't support it. see Sections 4.1.6.1 and 4.1.7 🌸
B.1.5.3. server-error-service-unavailable (0x0502) ⏳
the IPP object can't handle the request right now, either because it's overloaded for the moment or because it's under maintenance 🛠️ the idea is that this is a temporary thing that'll get better after some delay. if the length of the delay is known, it can be included in the message. if no delay is given, the IPP application should handle the response the same way it would for a 'server-error-temporary-error' response. and if the situation is more permanent, the 'client-error-gone' or 'client-error-not-found' error status-code could be used instead 🍂
B.1.5.4. server-error-version-not-supported (0x0503) 🔢
the IPP object doesn't support the IPP version the client put in the version-number operation parameter, or it's refusing to. the IPP object is basically saying it can't or won't finish the request using the same major and minor version number the client sent, other than with this error message 🙅♀️ the error response SHOULD contain a status-message attribute (see Section 4.1.6.2) that explains why that version isn't supported and which other versions this IPP object does support 📝 see Sections 4.1.6.1, 4.1.7, and 4.1.8.
the error response MUST identify, in the version-number operation parameter, the closest version number that the IPP object does support 🎯 for example: if a client sends version '1.0' and an IPP/1.1 object supports version '1.0', then it responds with version '1.0' in all responses to that request ✨ if the IPP/1.1 object doesn't support version '1.0', it should accept the request and respond with version '1.1', or it can reject the request and respond with this error code and version '1.1'. if a client sends version '1.2', the IPP/1.1 object should accept the request and return version '1.1', or it can reject the request and respond with this error code and version '1.1'. see Sections 4.1.8 and 5.3.14 🌈
B.1.5.5. server-error-device-error (0x0504) 🖨️💔
a Printer error, like a paper jam, happens while the IPP object is processing a Print or Send operation. the response contains the true Job status (the values of the job-state and job-state-reasons attributes) 📊 extra info can be returned in the OPTIONAL job-state-message attribute value, or in the OPTIONAL status message that describes the error in more detail 🔍 this error status-code is only returned when the Printer can't accept the Job Creation request because of a device error like that. for example, if the Printer can only spool and accept one Job at a time, it might reject a Job Creation request because it currently has a paper jam 😬 but in lots of cases, where the Printer can still accept the request even with some error condition, the successful-ok status-code gets returned instead ✨ in that case, the Client would look at the returned Job object attributes, or query the Printer later to figure out its state and state reasons 💅
B.1.5.6. server-error-temporary-error (0x0505) 💥
Okay so this one is about a temporary hiccup 🥺 like a buffer-full write error, a memory overflow (aka the Document data is bigger than the Printer's memory 😭), or a disk-full situation, happening while the IPP Printer is processing an operation. The Client MAY try the unmodified request again later, with the expectation that the temporary internal error condition has been cleared 💅. Alternatively, as an implementation option, a Printer MAY delay the response until the temporary condition is cleared, so no error is returned at all ✨. Iconic patience energy 🧚.
B.1.5.7. server-error-not-accepting-jobs (0x0506) 🙅♀️
This is a temporary error saying the Printer is not currently accepting Jobs, because the Administrator has set the Printer's "printer-is-accepting-jobs" attribute to 'false' (by means outside the scope of this IPP/1.1 document) 🫠. Not the Printer's fault, bestie, it's just on pause 🌸.
B.1.5.8. server-error-busy (0x0507) 🐝
This is a temporary error meaning the Printer is too busy processing Jobs and/or other requests 💀. The Client SHOULD try the unmodified request again at some later point in time, with the expectation that the temporary busy condition will have been cleared 🎀. Give it a little breather, then try again, periodt 💖.
B.1.5.9. server-error-job-canceled (0x0508) 🚫
This is an error saying the Job got canceled by an Operator or the system while the Client was still transmitting the data to the IPP Printer 😭. If a "job-id" attribute and a "job-uri" attribute had already been created, they get returned in the Print-Job, Send-Document, or Send-URI response as usual 🦋. Otherwise, no "job-id" and "job-uri" attributes are returned in the response, so don't go looking for them 🙈.
B.1.5.10. server-error-multiple-document-jobs-not-supported (0x0509) 📄
The IPP object does not support multiple Documents per Job, and a Client tried to supply Document data with a second Send-Document or Send-URI operation 🙃. Not it, bestie 💅.
B.2. Status-Code Values for IPP Operations 📊
Okay, this is the big table moment 🍓. Here's the key for the operation abbreviations: PJ = Print-Job, PU = Print-URI, CJ = Create-Job, SD = Send-Document, SU = Send-URI, V = Validate-Job, GA = Get-Job-Attributes and Get-Printer-Attributes, GJ = Get-Jobs, C = Cancel-Job 🔑.
IPP Operations
IPP Status Keyword PJ PU CJ SD SU V GA GJ C
------------------ -- -- -- -- -- - -- -- -
successful-ok x x x x x x x x x
successful-ok-ignored-or-substituted- x x x x x x x x x
attributes
successful-ok-conflicting-attributes x x x x x x x x x
client-error-bad-request x x x x x x x x x
client-error-forbidden x x x x x x x x x
client-error-not-authenticated x x x x x x x x x
client-error-not-authorized x x x x x x x x x
client-error-not-possible x x x x x x x x x
client-error-timeout x x
client-error-not-found x x x x x x x x x
client-error-gone x x x x x x x x x
client-error-request-entity-too-large x x x x x x x x x
client-error-request-value-too-long x x x x x x x x x
client-error-document-format-not- x x x x x x
supported
client-error-attributes-or-values-not- x x x x x x x x x
supported
client-error-uri-scheme-not-supported x x
client-error-charset-not-supported x x x x x x x x x
client-error-conflicting-attributes x x x x x x x x x
client-error-compression-not-supported x x x x x
client-error-compression-error x x x x
client-error-document-format-error x x x x
client-error-document-access-error x x
server-error-internal-error x x x x x x x x x
server-error-operation-not-supported x x x x
server-error-service-unavailable x x x x x x x x x
server-error-version-not-supported x x x x x x x x x
server-error-device-error x x x x x
server-error-temporary-error x x x x x
server-error-not-accepting-jobs x x x x
server-error-busy x x x x x x x x x
server-error-job-canceled x x x
server-error-multiple-document-jobs- x x
not-supportedHJ = Hold-Job, RJ = Release-Job, RS = Restart-Job, PP = Pause-Printer, RP = Resume-Printer, PJ = Purge-Jobs 🧹
IPP Operations (cont.)
IPP Status Keyword HJ RJ RS PP RP PJ
------------------ -- -- -- -- -- --
successful-ok x x x x x x
successful-ok-ignored-or-substituted- x x x x x x
attributes
successful-ok-conflicting-attributes x x x x x x
client-error-bad-request x x x x x x
client-error-forbidden x x x x x x
client-error-not-authenticated x x x x x x
client-error-not-authorized x x x x x x
client-error-not-possible x x x x x x
client-error-timeout
client-error-not-found x x x x x x
client-error-gone x x x x x x
client-error-request-entity-too-large x x x x x x
client-error-request-value-too-long x x x x x x
client-error-document-format-not-
supported
client-error-attributes-or-values-not- x x x x x x
supported
client-error-uri-scheme-not-supported
client-error-charset-not-supported x x x x x x
client-error-conflicting-attributes x x x x x x
client-error-compression-not-supported
client-error-compression-error
client-error-document-format-error
client-error-document-access-error
server-error-internal-error x x x x x x
server-error-operation-not-supported x x x x x x
server-error-service-unavailable x x x x x x
server-error-version-not-supported x x x x x x
server-error-device-error
server-error-temporary-error x x x x x x
server-error-not-accepting-jobs
server-error-busy x x x x x x
server-error-job-canceled
server-error-multiple-document-jobs-
not-supportedAppendix C. Processing IPP Attributes 🧠
Okay, this is where it gets spicy 🌶️. When a Client submits a Print Job to a Printer, the IPP Model lets the Client supply operation and Job Template attributes along with the Document data 💜. These Job Template attributes in the Job Creation request affect the rendering, production, and finishing of the Documents in the Job 🎨. Similar instructions can also live inside the Document data itself ✨. On top of that, the Printer has its own set of attributes describing which rendering and finishing processes it supports 🖨️. This model is super flexible and powerful, but it also means Client-supplied attributes can conflict with either:
o what the implementation is capable of realizing (i.e., what the Printer supports), or
o the instructions embedded within the Document data itself.
The following sections describe how these two types of conflicts get handled in the IPP Model 🫶.
C.1. Fidelity 🎀
If there's a conflict between what the Client requests and what a Printer supports, the Client can request one of two possible conflict-handling mechanisms 💅:
- either reject the Job, since the Job cannot be processed exactly as specified, or
- allow the Printer to make any changes necessary to proceed with processing the Job the best it can.
In the first case, the Client is basically saying: "Print the Job exactly as specified with no exceptions, and if that can't be done, don't even bother printing the Job at all." 😤 In the second case, the Client is saying: "It is more important to make sure the Job is printed rather than be processed exactly as specified; just make sure the Job is printed even if some Client-supplied attributes need to be changed or ignored." 🥹
The IPP Model handles this situation by introducing an "ipp-attribute-fidelity" attribute 🔥.
In a Job Creation request, "ipp-attribute-fidelity" is a boolean operation attribute that MAY be supplied by the Client 🦋. The value 'true' means total fidelity to Client-supplied Job Template attributes and values is required. The Client is requesting that the Job be printed exactly as specified, and if that is not possible, then the Job MUST be rejected rather than processed incorrectly 🚫. The value 'false' means a reasonable attempt to print the Job is acceptable. If a Printer does not support some of the Client-supplied Job Template attributes or values, the Printer MUST ignore or replace them with supported values 🔄. The Printer can choose to substitute the default value associated with that attribute, or use some other supported value that is similar to the unsupported requested value. For example, if a Client supplies a "media" value of 'na_letter_8.5x11in', the Printer can choose to substitute 'iso_a4_210x297mm' rather than a default value of 'na_personal_3.625x6.5in' 📄. If the Client doesn't supply the "ipp-attribute-fidelity" attribute, the Printer assumes a value of 'false' 🙂.
Each Printer implementation MUST support both types of "fidelity" printing (that is, whether the Client supplies a value of 'true' or 'false') 💖:
o If the Client supplies 'false' or doesn't supply the attribute, the Printer MUST always accept the request by ignoring unsupported Job Template attributes and by substituting unsupported values of supported Job Template attributes with supported values 🌈.
o If the Client supplies 'true', the Printer MUST reject the request if the Client supplies unsupported Job Template attributes 🙅♀️.
Since a Client can always query a Printer to find out exactly what is and isn't supported, "ipp-attribute-fidelity" set to 'false' is useful when:
- The End User uses a command line interface to request attributes that might not be supported 💻.
- In a GUI context, if the End User expects the Job might be moved to another Printer and prefers a suboptimal result to nothing at all 🧚.
- The End User just wants something reasonable in lieu of nothing at all ✨.
C.2. Page Description Language (PDL) Override ✨
Okay bestie, so if an IPP Job Template attribute and an instruction inside the Document data are fighting, the IPP attribute SHOULD take precedence over the Document instruction 👑. Picture this: someone sends a previously formatted file of Document data to an IPP Printer. If the Client includes any attributes at Job submission time, the Client totally wants those attributes to override the embedded instructions 🎀.
Now the iconic example 💅: a formatted Document has commands baked in to load 'iso-a4' media. But the Document gets passed to an End User whose only Printer has 'na-letter' media loaded 🥲. That End User most likely wants to submit it to an IPP Printer with the "media" Job Template attribute set to 'na-letter' ✨. Attributes supplied at Job submission time should take precedence over the embedded PDL instructions. ngl though, until the companies that make Document data interpreters allow a way for external IPP attributes to beat embedded Job production instructions, a Printer might not be able to support that semantic 😭.
The IPP Model handles this with a "pdl-override-supported" attribute 🦋. It describes the Printer's capabilities for overriding instructions embedded in the PDL data stream. The value of this attribute is configured by means outside the scope of this IPP/1.1 document, so that's a problem for another day 💜.
This REQUIRED Printer attribute takes on the following values:
'attempted': This value means the Printer attempts to make the IPP attribute values take precedence over embedded instructions in the Document data. There is no guarantee, though 🙈.'not-attempted': This value means the Printer makes no attempt to make the IPP attribute values take precedence over embedded instructions in the Document data 💀.
At Job processing time, an implementation that supports 'attempted' might do one of several different actions:
- Generate an Output-Device-specific command sequence to realize the feature represented by the IPP attribute value.
- Parse the Document data itself and replace the conflicting embedded instruction with a new embedded instruction that matches the intent of the IPP attribute value.
- Indicate to the Printer that external supplied attributes take precedence over embedded instructions, and then pass the external IPP attribute values to the Document data interpreter.
- Anything else that allows for the semantics that IPP attributes override embedded Document data instructions.
Since 'attempted' doesn't offer any kind of guarantee, a Printer might not do a super "good" job of making IPP attributes win over the Document data, and it would still be a conforming implementation 🌸.
At Job processing time, an implementation that supports 'not-attempted' might do one of the following:
- Simply prepend the Document data with the PDL instruction that corresponds to the Client-supplied PDL attribute. If the Document data also has the same PDL instruction, it overrides what the Printer prepended. In other words, this implementation uses the same semantics for the Client-supplied IPP attributes as it does for the Printer defaults 🧚.
- Parse the Document data and replace the conflicting embedded instruction with a new embedded instruction that approximates, but does not match, the semantic intent of the IPP attribute value.
Note: The "ipp-attribute-fidelity" attribute applies to the Printer's ability to either accept or reject other unsupported Job Template attributes. So if "ipp-attribute-fidelity" is set to 'true', a Job is accepted if and only if the Client-supplied Job Template attributes and values are supported by the Printer 🫶. Whether those attributes actually affect Job processing when the Document data contains embedded instructions depends on whether the Printer can override the embedded instructions with the semantics of the IPP attributes. If the Document data attributes can be overridden ("pdl-override-supported" set to 'attempted'), the Printer tries to use the IPP attributes when processing the Job. If they can't be overridden ("pdl-override-supported" set to 'not-attempted'), the Printer makes no attempt to override the embedded Document data instructions with the IPP attributes. That means the IPP attributes can fail to affect Job processing and output when the corresponding instruction is embedded in the Document data 😭.
C.3. Using Job Template Attributes during Document Processing 🧚
The Printer uses some of the Job's Job Template attributes while it processes the Document data for that Job. These include, but aren't limited to, "orientation-requested", "number-up", "sides", "media", and "copies" 🍓. The processing of each Document in a Job object MUST follow the steps below. These steps only exist to show when and how attributes get used in processing Document data. Any alternative steps that achieve the same effect can be used to implement this specification document ✨.
- Using the Client-supplied
"document-format"attribute, or some form of Document format detection algorithm (if the value of"document-format"isn't specific enough), figure out whether the Document data has already been formatted for printing. If it has, go to step 2. Otherwise, the Document data MUST be formatted. The formatting detection algorithm is implementation defined and isn't specified by this document. The formatting of the Document data uses the"orientation-requested"attribute to decide how the formatted print data should be placed on an Input Page. See Section 5.2.10 for details 🌈. - The Document data is a set of Input Pages in a known media type. The
"page-ranges"attribute is used to select, as specified in Section 5.2.7, a sub-sequence of the pages in the print-stream that are to be processed and imaged 🦋. - The input for this step is a sequence of Input Pages. This step is controlled by the
"number-up"attribute. If the value of"number-up"is N, then during processing each N Input Pages are positioned, as specified in Section 5.2.9, to create a single Impression. If a given Document doesn't have N more Input Pages, then the completion of the Impression is controlled by the"multiple-document-handling"attribute as described in Section 5.2.4. When that attribute's value is'single-document'or'single-document-new-sheet', the Input Pages of Document data from subsequent Documents are used to complete the Impression 💖.
The size (scaling), position (translation), and rotation of the Input Pages on the Impression are implementation defined. Note that during this process the Input Pages can be rendered to a form suitable for placing on the Impression. This rendering is controlled by the values of the "printer-resolution" and "print-quality" attributes, as described in Sections 5.2.12 and 5.2.13 🔥. When N = 1, the Impression is nearly the same as the Input Page. The only differences would be in the size, position, and rotation of the Input Page and/or any decoration, like a frame for the page, that the implementation adds ✨.
- The collection of Impressions is placed, in sequence, onto sides of the Media Sheets. This placement is controlled by the
"sides"attribute and the orientation of the Input Page, as described in Section 5.2.8. The orientation of the Input Pages affects the orientation of the Impression. For example, if"number-up"equals 2, then, typically, two portrait Input Pages become one landscape Impression. Note that the placement of Impressions onto Media Sheets is also controlled by the"multiple-document-handling"attribute, as described in Section 5.2.4 👑. - The
"copies"and"multiple-document-handling"attributes are used to determine how many copies of each Media Sheet are printed and in what order. See Sections 5.2.4 and 5.2.5 for details 🎀. - When the correct number of copies is created, the Media Sheets are finished according to the values of the
"finishings"attribute, as described in Section 5.2.6. Sometimes finishing processes need manual intervention, especially for uncollated copies, so this is one to watch 😭. This document allows any or all of the processing steps to be performed automatically or manually, at the discretion of the Printer 💅.
Appendix D. Generic Directory Schema
Okay so this appendix is where IPP gets to be a total team player 💖 It defines a generic schema for an entry in a directory service, and the actual implementations of that schema live in "Lightweight Directory Access Protocol (LDAP): Schema for Printer Services" [RFC7612] and "IPP Everywhere" [PWG5100.14]. 🎀 A directory service is basically how service users find service providers, bestie. In IPP land, IPP Printers can get registered as entries of type Printer in the directory, either automatically or with some help from an Administrator 🧚, using whatever implementation-specific mechanism fits (entry attributes, entry type fields, specific branches, etc.). Directory Clients can search or browse for those Printer entries, based on naming, organizational contexts, or filtered searches on attribute values. For example, a Client can find all Printers in the "Local Department" context ✨ Authentication and authorization are also usually part of the directory service, so an Administrator can limit End Users so they only find entries they actually have access rights to. Main character access control 👑 IPP itself does not require any specific directory service protocol or provider, so it's totally chill about which one you pick 🌸
Note: Some directory implementations allow for the notion of "aliasing". That means one directory entry object can show up as multiple directory entry objects with different names, but every alias still points to the same directory entry object, which refers to a single IPP Printer. Alias energy 🦋
The generic schema is a subset of IPP Printer Job Template and Printer Description attributes (Sections 5.2 and 5.4). These attributes are labeled as either RECOMMENDED or OPTIONAL for the directory entry itself. This conformance labeling is NOT the same as the conformance labeling applied to the attributes of IPP Printer objects 🙈 The labels in this appendix are meant for directory templates and for IPP Printer implementations that subscribe by adding one or more entries to a directory. RECOMMENDED attributes SHOULD be associated with each directory entry. OPTIONAL attributes MAY be associated with the directory entry (if known or supported). And also, all directory entry attributes SHOULD reflect the current attribute values for the corresponding Printer 💅
As much as possible, the names of attributes in directory schema and entries SHOULD be the same as the IPP Printer attribute names as shown. Consistency is everything 🍓
To bridge between the directory service and the IPP Printer, one of the RECOMMENDED directory entry attributes is the Printer's "printer-uri-supported" attribute. The directory Client queries "printer-uri-supported" (or its equivalent) in the directory entry, and then the IPP Client addresses the IPP Printer using one of its URIs. 🔥 The "uri-security-supported" attribute tells you which protocol (if any) is used to secure a channel 🔐
The attributes in Table 23 define the generic schema for directory entries of type Printer. Here's the whole lineup 👇
+------------------------------------+-------------+----------------+
| Attribute | Conformance | Section |
+------------------------------------+-------------+----------------+
| charset-supported | OPTIONAL | Section 5.4.18 |
+------------------------------------+-------------+----------------+
| color-supported | RECOMMENDED | Section 5.4.26 |
+------------------------------------+-------------+----------------+
| compression-supported | RECOMMENDED | Section 5.4.32 |
+------------------------------------+-------------+----------------+
| document-format-supported | RECOMMENDED | Section 5.4.22 |
+------------------------------------+-------------+----------------+
| finishings-supported | OPTIONAL | Section 5.2.6 |
+------------------------------------+-------------+----------------+
| generated-natural-language- | OPTIONAL | Section 5.4.20 |
| supported | | |
+------------------------------------+-------------+----------------+
| ipp-versions-supported | RECOMMENDED | Section 5.4.14 |
+------------------------------------+-------------+----------------+
| media-supported | RECOMMENDED | Section 5.2.11 |
+------------------------------------+-------------+----------------+
| multiple-document-jobs-supported | OPTIONAL | Section 5.4.16 |
+------------------------------------+-------------+----------------+
| number-up-supported | OPTIONAL | Section 5.2.9 |
+------------------------------------+-------------+----------------+
| pages-per-minute-color | OPTIONAL | Section 5.4.37 |
+------------------------------------+-------------+----------------+
| pages-per-minute | OPTIONAL | Section 5.4.36 |
+------------------------------------+-------------+----------------+
| print-quality-supported | OPTIONAL | Section 5.2.13 |
+------------------------------------+-------------+----------------+
| printer-info | OPTIONAL | Section 5.4.6 |
+------------------------------------+-------------+----------------+
| printer-location | RECOMMENDED | Section 5.4.5 |
+------------------------------------+-------------+----------------+
| printer-make-and-model | RECOMMENDED | Section 5.4.9 |
+------------------------------------+-------------+----------------+
| printer-more-info | OPTIONAL | Section 5.4.7 |
+------------------------------------+-------------+----------------+
| printer-name | RECOMMENDED | Section 5.4.4 |
+------------------------------------+-------------+----------------+
| printer-resolution-supported | OPTIONAL | Section 5.2.12 |
+------------------------------------+-------------+----------------+
| printer-uri-supported | RECOMMENDED | Section 5.4.1 |
+------------------------------------+-------------+----------------+
| sides-supported | RECOMMENDED | Section 5.2.8 |
+------------------------------------+-------------+----------------+
| uri-authentication-supported | RECOMMENDED | Section 5.4.2 |
+------------------------------------+-------------+----------------+
| uri-security-supported | RECOMMENDED | Section 5.4.3 |
+------------------------------------+-------------+----------------+Table 23: Attributes in Directory Entries 🧾
Acknowledgements ✨
The authors would like to give a shout-out to these people for their contributions to the original IPP/1.1 specifications 🫶
Roger deBry, Tom Hastings (original RFC 2911 editor), Robert Herriot, Scott A. Isaacson, Kirk Ocke, Patrick Powell, and Peter Zehler 🌈
Authors' Addresses 💌
Michael Sweet Apple Inc. 1 Infinite Loop MS 111-HOMC Cupertino, CA 95014 United States of America
Email: msweet@apple.com
Ira McDonald High North, Inc. PO Box 221 Grand Marais, MI 49839 United States of America
Phone: +1 906-494-2434 Email: blueroofmusic@gmail.com
That's the whole doc, bestie 🎉 Thanks for riding through all 49 parts with me 💜 Go touch grass ☀️🦋
📦 where this page comes from
- ietf: rfc8011 2017-01
- 💖 girlified by claude-haiku-5-5 on : a language model's rewrite of the original, under its terms