draft-ietf-ipp-job-prog-02.txt   rfc3381.txt 
INTERNET-DRAFT Network Working Group T. Hastings
<draft-ietf-ipp-job-prog-02.txt> T. Hastings Request for Comments: 3381 Xerox Corporation
Category: standards track Xerox Corporation Updates: 2910 H. Lewis
H. Lewis Category: Standards Track IBM Printing Company
IBM Printing Company
R. Bergman R. Bergman
Hitachi Koki Imaging Solutions Hitachi Koki Imaging Solutions
January 23, 2001 September 2002
Internet Printing Protocol (IPP): Internet Printing Protocol (IPP):
Job Progress Attributes Job Progress Attributes
Copyright (C) The Internet Society (2001). All Rights Reserved.
Status of this Memo: Status of this Memo
This document is an Internet-Draft and is in full conformance with
all provisions of Section 10 of [RFC2026]. Internet-Drafts are
working documents of the Internet Engineering Task Force (IETF), its
areas, and its working groups. Note that other groups may also
distribute working documents as Internet-Drafts.
Internet-Drafts are draft documents valid for a maximum of six months This document specifies an Internet standards track protocol for the
and may be updated, replaced, or obsoleted by other documents at any Internet community, and requests discussion and suggestions for
time. It is inappropriate to use Internet-Drafts as reference improvements. Please refer to the current edition of the "Internet
material or to cite them other than as "work in progress". Official Protocol Standards" (STD 1) for the standardization state
and status of this protocol. Distribution of this memo is unlimited.
The list of current Internet-Drafts can be accessed at Copyright Notice
http://www.ietf.org/ietf/1id-abstracts.txt
The list of Internet-Draft Shadow Directories can be accessed as Copyright (C) The Internet Society (2002). All Rights Reserved.
http://www.ietf.org/shadow.html.
Abstract Abstract
This document defines four new Job Description attributes for This document defines four new Job Description attributes for
monitoring job progress to be registered as extensions to IPP/1.0 monitoring job progress to be registered as OPTIONAL extensions to
[RFC2566] and IPP/1.1 [RFC2911]. These attributes are drawn from the the Internet Printing Protocol (IPP/1.0 and IPP/1.1). These
PWG Job Monitoring MIB [rfc2707]. The new Job Description attributes attributes are drawn from the PWG Job Monitoring MIB. This document
are: also defines a new "sheet-collate" Job Template attribute to control
sheet collation and to help with the interpretation of the job
progress attributes.
"job-collation-type" (type2 enum) Table of Contents
"sheet-completed-copy-number" (integer(0:MAX))
"sheet-completed-document-number" (integer(0:MAX)) 1 Introduction.....................................................2
"impressions-completed-current-copy" (integer(0:MAX)) 2 Terminology......................................................2
2.1 Conformance Terminology........................................4
2.2 Other terminology..............................................4
3 Job Template attributes..........................................4
3.1 sheet-collate (type2 keyword)..................................4
4 IPP Job Description attributes for monitoring Job Progress.......6
4.1 job-collation-type (type2 enum)................................9
4.2 sheet-completed-copy-number (integer(0:MAX))..................11
4.3 sheet-completed-document-number (integer(0:MAX))..............11
4.4 impressions-completed-current-copy (integer(0:MAX))...........11
5 Conformance Requirements........................................11
6 IANA Considerations.............................................12
6.1 Attributes....................................................
6.2 Keyword Attribute Values......................................
6.3 Enum Attribute Values.........................................
7 Internationalization Considerations.............................12
8 Security Considerations.........................................12
9 References......................................................12
10 Description of the Base IPP Documents..........................13
11 Authors' Addresses.............................................15
12 Full Copyright Statement.......................................16
1 Introduction
This document defines four new Job Description attributes for
monitoring job progress to be registered as OPTIONAL extensions to
IPP/1.0 [RFC2566] and IPP/1.1 [RFC2911]. These attributes are drawn
from the PWG Job Monitoring MIB [RFC2707]. See section 10 for a
description of the base IPP documents. The new Job Description
attributes are:
"job-collation-type" (type2 enum)
"sheet-completed-copy-number" (integer(0:MAX))
"sheet-completed-document-number" (integer(0:MAX))
"impressions-completed-current-copy" (integer(0:MAX))
This document also defines a new "sheet-collate" Job Template This document also defines a new "sheet-collate" Job Template
attribute to control sheet collation and to help with the attribute to control sheet collation and to help with the
interpretation of the job progress attributes. These new attributes interpretation of the job progress attributes. These new attributes
may also be used by themselves in combination with the IPP/1.1 "job- may also be used by themselves in combination with the IPP/1.1 "job-
impressions-completed" attribute as useful job progress monitoring impressions-completed" attribute, as useful job progress monitoring
attributes and/or may be passed in an IPP Notification (see [ipp- attributes and/or may be passed in an IPP Notification (see [ipp-
ntfy]). ntfy]).
The full set of IPP documents includes: 2 Terminology
Design Goals for an Internet Printing Protocol [RFC2567]
Rationale for the Structure and Model and Protocol for the Internet
Printing Protocol [RFC2568]
Internet Printing Protocol/1.1: Model and Semantics [RFC2911]
Internet Printing Protocol/1.1: Encoding and Transport [RFC2910]
Internet Printing Protocol/1.1: Implementer's Guide [ipp-iig]
Mapping between LPD and IPP Protocols [RFC2569]
Internet Printing Protocol/1.0 & 1.1: Event Notification
Specification [ipp-ntfy]
The "Design Goals for an Internet Printing Protocol" document takes a
broad look at distributed printing functionality, and it enumerates
real-life scenarios that help to clarify the features that need to be
included in a printing protocol for the Internet. It identifies
requirements for three types of users: end users, operators, and
administrators. It calls out a subset of end user requirements that
are satisfied in IPP/1.0. A few OPTIONAL operator operations have
been added to IPP/1.1.
The "Rationale for the Structure and Model and Protocol for the
Internet Printing Protocol" document describes IPP from a high level
view, defines a roadmap for the various documents that form the suite
of IPP specification documents, and gives background and rationale
for the IETF working group's major decisions.
The "Internet Printing Protocol/1.1: Model and Semantics" document
describes a simplified model with abstract objects, their attributes,
and their operations that are independent of encoding and transport.
It introduces a Printer and a Job object. The Job object optionally
supports multiple documents per Job. It also addresses security,
internationalization, and directory issues.
The "Internet Printing Protocol/1.1: Encoding and Transport" document
is a formal mapping of the abstract operations and attributes defined
in the model document onto HTTP/1.1 [RFC2616]. It defines the
encoding rules for a new Internet MIME media type called
"application/ipp". This document also defines the rules for
transporting over HTTP a message body whose Content-Type is
"application/ipp". This document defines a new scheme named 'ipp'
for identifying IPP printers and jobs.
The "Internet Printing Protocol/1.1: Implementer's Guide" document
gives insight and advice to implementers of IPP clients and IPP
objects. It is intended to help them understand IPP/1.1 and some of
the considerations that may assist them in the design of their client
and/or IPP object implementations. For example, a typical order of
processing requests is given, including error checking. Motivation
for some of the specification decisions is also included.
The "Mapping between LPD and IPP Protocols" document gives some
advice to implementers of gateways between IPP and LPD (Line Printer
Daemon) implementations.
The "Event Notification Specification" document defines OPTIONAL
operations that allow a client to subscribe to printing related
events. Subscriptions include "Per-Job subscriptions" and "Per-
Printer subscriptions". Subscriptions are modeled as Subscription
objects. Four other operations are defined for subscription objects:
get attributes, get subscriptions, renew a subscription, and cancel a
subscription.
TABLE OF CONTENTS
1 New Job Template attribute......................................5
1.1 sheet-collate (type2 keyword) ................................5
2 IPP Job Description attributes for monitoring Job Progress......8
2.1 job-collation-type (type2 enum) .............................11
2.2 sheet-completed-copy-number (integer(0:MAX)) ................12
2.3 sheet-completed-document-number (integer(0:MAX)) ............13
2.4 impressions-completed-current-copy (integer(0:MAX)) .........13
3 Conformance Requirements.......................................13
4 IANA Considerations............................................13
4.1 Attribute Registrations .....................................14
5 Internationalization Considerations............................14 This section defines terminology used throughout this document.
6 Security Considerations........................................14 2.1 Conformance Terminology
7 References.....................................................15 Capitalized terms, such as MUST, MUST NOT, REQUIRED, SHOULD, SHOULD
NOT, MAY, NEED NOT, and OPTIONAL, have special meaning relating to
conformance, as defined in RFC 2119 [RFC2119] and [RFC2911] section
12.1. If an implementation supports the extension defined in this
document, then these terms apply; otherwise, they do not. These
terms define conformance to this document only; they do not affect
conformance to other documents, unless explicitly stated otherwise.
8 Author's Addresses.............................................16 2.2 Other terminology
9 Full Copyright Statement.......................................16 This document uses terms such as Job object (or Job), IPP Printer
object (or Printer), "operation", "attribute", "keyword", "support",
and "impression". These terms have special meaning and are defined
in the model terminology [RFC2911], section 12.2.
1 New Job Template attribute 3 Job Template attributes
1.1 sheet-collate (type2 keyword) 3.1 sheet-collate (type2 keyword)
+===================+======================+=====================+ +===================+======================+=====================+
| Job Attribute |Printer: Default Value| Printer: Supported | | Job Attribute |Printer: Default Value| Printer: Supported |
| | Attribute | Values Attribute | | | Attribute | Values Attribute |
+===================+======================+=====================+ +===================+======================+=====================+
| sheet-collate | sheet-collate-default| sheet-collate- | | sheet-collate | sheet-collate-default| sheet-collate- |
| (type2 keyword) | (type2 keyword) | supported (1setOf | | (type2 keyword) | (type2 keyword) | supported (1setOf |
| | | type2 keyword) | | | | type2 keyword) |
+-------------------+----------------------+---------------------+ +-------------------+----------------------+---------------------+
This attribute specifies whether or not the media sheets of each copy This attribute specifies whether or not the media sheets of each copy
of each printed document in a job are to be in sequence, when of each printed document in a job are to be in sequence, when
multiple copies of the document are specified by the 'copies' multiple copies of the document are specified by the 'copies'
attribute. attribute.
Standard keyword values are: Standard keyword values are:
'uncollated': each print-stream sheet is printed a number of times 'uncollated': each print-stream sheet is printed a number of
in succession equal to the value of the 'copies' attribute, times in succession equal to the value of the 'copies'
followed by the next print-stream sheet. attribute, followed by the next print-stream sheet.
'collated': each copy of each document is printed with the print- 'collated': each copy of each document is printed with the
stream sheets in sequence, followed by the next document copy. print-stream sheets in sequence, followed by the next document
copy.
For example, suppose a document produces two media sheets as output, For example, suppose a document produces two media sheets as output,
and "copies" is equal to '6', For the 'uncollated' case, six copies and "copies" is equal to '6'. For the 'uncollated' case, six copies
of the first media sheet are printed followed by six copies of the of the first media sheet are printed, followed by six copies of the
second media sheet. For the 'collated' case, one copy of each of the second media sheet. For the 'collated' case, one copy of each of the
six sheets are printed followed by another copy of each of the six six sheets is printed, followed by another copy of each of the six
media sheets. media sheets.
Whether the effect of sheet collation is achieved by placing copies Whether the effect of sheet collation is achieved by placing copies
of a document in multiple output bins or in the same output bin with of a document in multiple output bins, or in the same output bin with
implementation defined document separation is implementation implementation defined document separation, is implementation
dependent. Also whether it is achieved by making multiple passes dependent. Also whether it is achieved by making multiple passes
over the job or by using an output sorter is implementation over the job or by using an output sorter, is implementation
dependent. dependent.
Note: IPP/1.0 [RFC2566] and IPP/1.1 [RFC2911] is silent on whether Note: IPP/1.0 [RFC2566] and IPP/1.1 [RFC2911] are silent on whether
or not sheets within documents are collated. The "sheet-collate- or not sheets within documents are collated. The "sheet-collate-
supported" Printer attribute permits a Printer object to indicate supported" Printer attribute permits a Printer object to indicate
whether or not it collates sheets with each document and whether it whether or not it collates sheets with each document and whether it
allows the client to control sheet collation. An implementation is allows the client to control sheet collation. An implementation is
able to indicate that it supports uncollated sheets, collated sheets, able to indicate that it supports uncollated sheets, collated sheets,
or both, using the 'uncollated', 'collated', or both 'uncollated' and or both, using the 'uncollated', 'collated', or both 'uncollated' and
'collated' values, respectively. 'collated' values, respectively.
This attribute is affected by "multiple-document-handling." The This attribute is affected by "multiple-document-handling". The
"multiple-document-handling" attribute describes the collation of "multiple-document-handling" attribute describes the collation of
documents, and the "sheet-collate" attribute describes the semantics documents, and the "sheet-collate" attribute describes the semantics
of collating individual pages within a document. To better explain of collating individual pages within a document. To better explain
the interaction between these two attributes the term "set" is the interaction between these two attributes, the term "set" is
introduced. A "set" is a logical boundary between the delivered introduced. A "set" is a logical boundary between the delivered
media sheets of a printed job. For-example, in the case of a ten media sheets of a printed job. For example, in the case of a ten
page single document with collated pages and a request for 50 copies, page single document with collated pages and a request for 50 copies,
each of the 50 printed copies of the document constitutes a "set." each of the 50 printed copies of the document constitutes a "set".
In the above example if the pages were uncollated, then 50 copies of In the above example if the pages were uncollated, then 50 copies of
each of the individual pages within the document would represent each each of the individual pages within the document would represent each
"set". "set".
The following table describes the interaction of "sheet-collate" with The following table describes the interaction of "sheet-collate" with
multiple document handling. multiple document handling.
"sheet- "multiple- Semantics "sheet- "multiple- Semantics
collate" document- collate" document-
handling" handling"
'collated' 'single- Each copy of the concatenated 'collated' 'single- Each copy of the concatenated
document' documents, with their pages in document' documents, with their pages in
sequence, represents a "set." sequence, represents a "set".
'collated' 'single- Each copy of the concatenated 'collated' 'single- Each copy of the concatenated
document-new- documents, with their pages in document-new- documents, with their pages in
sheet' sequence, represents a "set." sheet' sequence, represents a "set".
'collated' 'separate- Each copy of each separate 'collated' 'separate- Each copy of each separate
documents- document, with its pages in documents- document, with its pages in
collated- sequence, represents a "set." collated- sequence, represents a "set".
copies' copies'
'collated' 'separate- Each copy of each separate 'collated' 'separate- Each copy of each separate
documents- document, with its pages in documents- document, with its pages in
uncollated- sequence, represents a "set." uncollated- sequence, represents a "set".
copies copies
'uncollated' 'single- Each media sheet of the document 'uncollated' 'single- Each media sheet of the document
document' is printed a number of times equal document' is printed a number of times equal
to the "copies" attribute; which to the "copies" attribute; which
constitutes a "set." constitutes a "set".
'uncollated' 'single- Each media sheet of the 'uncollated' 'single- Each media sheet of the
document-new- concatenated documents is printed document-new- concatenated documents is printed
sheet' a number of times equal to the sheet' a number of times equal to the
"copies" attribute; which "copies" attribute; which
constitutes a "set." constitutes a "set".
'uncollated' 'separate- This is a degenerate case, and the 'uncollated' 'separate- This is a degenerate case, and the
documents- printer object MUST reject the job documents- printer object MUST reject the job
collated- and return the status, "client- collated- and return the status, "client-
copies' error-conflicting-attributes." copies' error-conflicting-attributes".
'uncollated' 'separate- This is a degenerate case, and the 'uncollated' 'separate- This is a degenerate case, and the
documents- printer object MUST reject the job documents- printer object MUST reject the job
uncollated- and return the status "client- uncollated- and return the status "client-
copies error-conflicting-attributes." copies error-conflicting-attributes".
From the above table it is obvious that the implicit value of the From the above table it is obvious that the implicit value of the
"sheet-collate" attribute in a printer that does not support the "sheet-collate" attribute in a printer that does not support the
"sheet-collate" attribute, is 'collated.' The semantics of "sheet-collate" attribute, is 'collated.' The semantics of
"multiple-document-handling" are otherwise nonsensical in the case "multiple-document-handling" are otherwise nonsensical in the case
of separate documents. of separate documents.
2 IPP Job Description attributes for monitoring Job Progress 4 IPP Job Description attributes for monitoring Job Progress
The following IPP Job Description attributes are proposed to be added The following IPP Job Description attributes are proposed to be added
to IPP through the type2 registration procedures. They are useful to IPP through the type2 registration procedures. They are useful
for monitoring the progress of a job. They are also used at for monitoring the progress of a job. They are also used as
attributes in the notification content in a notification report [ipp- attributes in the notification content in a notification report
ntfy]. [ipp-ntfy].
There are a number of Job Description attributes for monitoring the There are a number of Job Description attributes for monitoring the
progress of a job. These objects and attributes count the number of progress of a job. These objects and attributes count the number of
K octets, impressions, sheets, and pages requested or completed. For K octets, impressions, sheets, and pages requested or completed. For
impressions and sheets, "completed" means stacked, unless the impressions and sheets, "completed" means stacked, unless the
implementation is unable to detect when each sheet is stacked, in implementation is unable to detect when each sheet is stacked, in
which case stacked is approximated when processing of each sheet which case, stacked is approximated when the processing of each sheet
completes. There are objects and attributes for the overall job and is completed. There are objects and attributes for the overall job
for the current copy of the document currently being stacked. For and for the current copy of the document currently being stacked.
the latter, the rate at which the various objects and attributes For the latter, the rate at which the various objects and attributes
count depends on the sheet and document collation of the job. count, depends on the sheet and document collation of the job.
Consider the following four Job Description attributes that are used Consider the following four Job Description attributes that are used
to monitor the progress of a job's impressions: to monitor the progress of a job's impressions:
1."job-impressions-completed" - counts the total number of 1. "job-impressions-completed" - counts the total number of
impressions stacked for the job (see [RFC2911] section 4.3.18.2) impressions stacked for the job (see [RFC2911] section
4.3.18.2).
2."impressions-completed-current-copy" - counts the number of 2. "impressions-completed-current-copy" - counts the number of
impressions stacked for the current document copy impressions stacked for the current document copy.
3."sheet-completed-copy-number" - identifies the number of the 3. "sheet-completed-copy-number" - identifies the number of the
copy for the current document being stacked where the first copy copy for the current document being stacked, where the first
is 1. copy is 1.
4."sheet-completed-document-number" - identifies the current 4. "sheet-completed-document-number" - identifies the current
document within the job that is being stacked where the first document within the job that is being stacked, where the first
document in a job is 1. NOTE: this attribute SHOULD NOT be document in a job is 1. NOTE: this attribute SHOULD NOT be
implemented for implementations that only support one document implemented for implementations that only support one document
per job. per job.
For each of the three types of job collation, a job with three copies For each of the three types of job collation, a job with three copies
of two documents (1, 2), where each document consists of 3 of two documents (1, 2), where each document consists of 3
impressions, the four variables have the following values as each impressions, the four variables have the following values, as each
sheet is stacked for one-sided printing: sheet is stacked for one-sided printing:
"job-collation-type" = 'uncollated-sheets(3)' "job-collation-type" = 'uncollated-sheets(3)'
"job- "impressions- "sheet- "sheet- "job- "impressions- "sheet- "sheet-
impressions- completed- completed- completed- impressions- completed- completed- completed-
completed" current-copy" copy-number" document- completed" current-copy" copy-number" document-
number" number"
0 0 0 0 0 0 0 0
1 1 1 1 1 1 1 1
2 1 2 1 2 1 2 1
3 1 3 1 3 1 3 1
4 2 1 1 4 2 1 1
5 2 2 1 5 2 2 1
6 2 3 1 6 2 3 1
7 3 1 1 7 3 1 1
8 3 2 1 8 3 2 1
skipping to change at page 10, line 5 skipping to change at page 8, line 5
10 1 1 2 10 1 1 2
11 1 2 2 11 1 2 2
12 1 3 2 12 1 3 2
13 2 1 2 13 2 1 2
14 2 2 2 14 2 2 2
15 2 3 2 15 2 3 2
16 3 1 2 16 3 1 2
17 3 2 2 17 3 2 2
18 3 3 2 18 3 3 2
"job-collation-type" = 'collated-documents(4)' "job-collation-type" = 'collated-documents(4)'
"job- "impressions- "sheet- "sheet- "job- "impressions- "sheet- "sheet-
impressions- completed- completed- completed- impressions- completed- completed- completed-
completed" current-copy" copy- document- completed" current-copy" copy- document-
number" number" number" number"
0 0 0 0 0 0 0 0
1 1 1 1 1 1 1 1
2 2 1 1 2 2 1 1
3 3 1 1 3 3 1 1
skipping to change at page 11, line 5 skipping to change at page 9, line 5
10 1 2 2 10 1 2 2
11 2 2 2 11 2 2 2
12 3 2 2 12 3 2 2
13 1 3 1 13 1 3 1
14 2 3 1 14 2 3 1
15 3 3 1 15 3 3 1
16 1 3 2 16 1 3 2
17 2 3 2 17 2 3 2
18 3 3 2 18 3 3 2
"job-collation-type" = 'uncollated-documents(5)' "job-collation-type" = 'uncollated-documents(5)'
"job- "impressions- "sheet- "sheet- "job- "impressions- "sheet- "sheet-
impressions- completed- completed- completed- impressions- completed- completed- completed-
completed" current-copy" copy- document- completed" current-copy" copy-t document-
number" number" number" number"
0 0 0 0 0 0 0 0
1 1 1 1 1 1 1 1
2 2 1 1 2 2 1 1
3 3 1 1 3 3 1 1
4 1 2 1 4 1 2 1
5 2 2 1 5 2 2 1
6 3 2 1 6 3 2 1
7 1 3 1 7 1 3 1
skipping to change at page 11, line 32 skipping to change at page 9, line 32
10 1 1 2 10 1 1 2
11 2 1 2 11 2 1 2
12 3 1 2 12 3 1 2
13 1 2 2 13 1 2 2
14 2 2 2 14 2 2 2
15 3 2 2 15 3 2 2
16 1 3 2 16 1 3 2
17 2 3 2 17 2 3 2
18 3 3 2 18 3 3 2
2.1 job-collation-type (type2 enum) 4.1 job-collation-type (type2 enum)
Job Collation includes sheet collation and document collation. Sheet Job Collation includes sheet collation and document collation. Sheet
collation is defined to be the ordering of sheets within a document collation is defined to be the ordering of sheets within a document
copy. Document collation is defined to be ordering of document copy. Document collation is defined to be the ordering of document
copies within a multi-document job. The value of the "job-collation- copies within a multi-document job. The value of the "job-
type" is affected by the value of the "sheet-collate" Job Template collation-type" is affected by the value of the "sheet-collate" Job
attribute (see section 1.1), if supplied and supported. Template attribute (see section 3.1), if supplied and supported.
The Standard enum values are: The Standard enum values are:
'1' 'other': not one of the defined values '1' 'other': not one of the defined values
'2' 'unknown': the collation type is unknown '2' 'unknown': the collation type is unknown
'3' 'uncollated-sheets': No collation of the sheets within each '3' 'uncollated-sheets': No collation of the sheets within each
document copy, i.e., each sheet of a document that is document copy, i.e., each sheet of a document that
to produce multiple copies is replicated before the is to produce multiple copies, is replicated before
next sheet in the document is processed and stacked. the next sheet in the document is processed and
stacked. If the device has an output bin collator,
If the device has an output bin collator, the the 'uncollated-sheets(3)' value may actually
'uncollated-sheets(3)' value may actually produce produce collated sheets as far as the user is
collated sheets as far as the user is concerned (in concerned (in the output bins). However, when the
the output bins). However, when the job collation is job collation is the 'uncollated-sheets(3)' value,
the 'uncollated-sheets(3)' value, job progress is job progress is indistinguishable from a monitoring
indistinguishable to a monitoring application between application between a device that has an output bin
a device that has an output bin collator and one that collator and one that does not.
does not.
'4' 'collated-documents': Collation of the sheets within each '4' 'collated-documents': Collation of the sheets within each
document copy is performed within the printing device document copy is performed within the printing
by making multiple passes over either the source or device by making multiple passes over, either the
an intermediate representation of the document. In source or an intermediate representation of the
addition, when there are multiple documents per job, document. In addition, when there are multiple
the i'th copy of each document is stacked before the documents per job, the i'th copy of each document is
j'th copy of each document, i.e., the documents are stacked before the j'th copy of each document, i.e.,
collated within each job copy. For example, if a job the documents are collated within each job copy.
is submitted with documents, A and B, the job is made For example, if a job is submitted with documents, A
available to the end user as: A, B, A, B, .... The and B, the job is made available to the end user as:
'collated-documents(4)' value corresponds to the IPP A, B, A, B, .... The 'collated-documents(4)' value
[RFC2911] 'separate-documents-collated-copies' corresponds to the IPP [RFC2911] 'separate-
keyword value of the "multiple-document-handling" documents-collated-copies' keyword value of the
attribute. "multiple-document-handling" attribute.
If the job's "copies" attribute is '1' (or not If the job's "copies" attribute is '1' (or not
supplied), then the "job-collation-type" attribute is supplied), then the "job-collation-type" attribute
defined to be '4'. is defined to be '4'.
'5' 'uncollated-documents': Collation of the sheets within each '5' 'uncollated-documents': Collation of the sheets within each
document copy is performed within the printing device document copy is performed within the printing
by making multiple passes over either the source or device by making multiple passes over either the
an intermediate representation of the document. In source or an intermediate representation of the
addition, when there are multiple documents per job, document. In addition, when there are multiple
all copies of the first document in the job are documents per job, all copies of the first document
stacked before the any copied of the next document in in the job are stacked before any copied of the next
the job, i.e., the documents are uncollated within document in the job, i.e., the documents are
the job. For example, if a job is submitted with uncollated within the job. For example, if a job is
documents, A and B, the job is mad available to the submitted with documents, A and B, the job is made
end user as: A, A, ..., B, B, .... The 'uncollated- available to the end user as: A, A, ..., B, B, ....
documents(5)' value corresponds to the IPP [RFC2911] The 'uncollated-documents(5)' value corresponds to
'separate-documents-uncollated-copies' keyword value the IPP [RFC2911] 'separate-documents-uncollated-
of the "multiple-document-handling" attribute. copies' keyword value of the "multiple-document-
handling" attribute.
2.2 sheet-completed-copy-number (integer(0:MAX)) 4.2 sheet-completed-copy-number (integer(0:MAX))
The number of the copy being stacked for the current document. This The number of the copy being stacked for the current document. This
number starts at 0, is set to 1 when the first sheet of the first number starts at 0, is set to 1 when the first sheet of the first
copy for each document is being stacked and is equal to n where n is copy for each document is being stacked and is equal to n where n is
the nth sheet stacked in the current document copy. If the value is the nth sheet stacked in the current document copy. If the value is
unknown, the Printer MUST return the 'unknown' out-of-band value (see unknown, the Printer MUST return the 'unknown' out-of-band value (see
[RFC2911] section 4.1), rather than the -2 value used in some MIBs [RFC2911] section 4.1), rather than the -2 value used in some MIBs
[rfc2707]. [RFC2707].
2.3 sheet-completed-document-number (integer(0:MAX)) 4.3 sheet-completed-document-number (integer(0:MAX))
The ordinal number of the document in the job that is currently being The ordinal number of the document in the job that is currently being
stacked. This number starts at 0, increments to 1 when the first stacked. This number starts at 0, increments to 1 when the first
sheet of the first document in the job is being stacked, and is equal sheet of the first document in the job is being stacked, and is equal
to n where n is the nth document in the job, starting with 1. If the to n where n is the nth document in the job, starting with 1. If the
value is unknown, the Printer MUST return the 'unknown' out-of-band value is unknown, the Printer MUST return the 'unknown' out-of-band
value (see [RFC2911] section 4.1), rather than the -2 value used in value (see [RFC2911] section 4.1), rather than the -2 value used in
some MIBs [rfc2707]. some MIBs [RFC2707].
Implementations that only support one document jobs SHOULD NOT Implementations that only support one document job SHOULD NOT
implement this attribute. implement this attribute.
2.4 impressions-completed-current-copy (integer(0:MAX)) 4.4 impressions-completed-current-copy (integer(0:MAX))
The number of impressions completed by the device for the current The number of impressions completed by the device for the current
copy of the current document so far. For printing, the impressions copy of the current document so far. For printing, the impressions
completed includes interpreting, marking, and stacking the output. completed includes interpreting, marking, and stacking the output.
For other types of job services, the number of impressions completed For other types of job services, the number of impressions completed
includes the number of impressions processed. If the value is includes the number of impressions processed. If the value is
unknown, the Printer MUST return the 'unknown' out-of-band value (see unknown, the Printer MUST return the 'unknown' out-of-band value (see
[RFC2911] section 4.1), rather than the -2 value used in some MIBs [RFC2911] section 4.1), rather than the -2 value used in some MIBs
[rfc2707]. [RFC2707].
This value SHALL be reset to 0 for each document in the job and for This value MUST be reset to 0 for each document in the job and for
each document copy. each document copy.
3 Conformance Requirements 5 Conformance Requirements
This section summarizes the Conformance Requirements detailed in the This section summarizes the Conformance Requirements detailed in the
definitions in this document. In general each of the attributes definitions in this document. In general each of the attributes
defined in this document are OPTIONAL for a Printer to support, so defined in this document are OPTIONAL for a client and/or a Printer
that Printer implementers MAY implement any combination of to support, so that client and Printer implementers MAY implement any
attributes. combination of these attributes.
4 IANA Considerations 6 IANA Considerations
This section contains the exact information for IANA to add to the This section contains registration information for IANA to add to the
IPP Registries according to the procedures defined in RFC 2911 IPP Registry according to the procedures defined in RFC 2911
[RFC2911] section 6. [RFC2911], section 6. The resulting registrations will be published
in the http://www.iana.org/assignments/ipp-registrations registry.
Note to RFC Editors: Replace RFC NNNN below with the RFC number for 6.1 Attributes
this document, so that it accurately reflects the content of the
information for the IANA Registry.
4.1 Attribute Registrations Job Template attributes: Ref. Section:
sheet-collate (type2 keyword) RFC 3381 3.1
sheet-default (type2 keyword) RFC 3381 3.1
sheet-supported (1setOf type2 keyword) RFC 3381 3.1
The attributes defined in this document will be published by IANA Job Description attributes: Ref. Section:
according to the procedures in RFC 2911 [RFC2911] section 6.2 with job-collation-type (type2 enum) RFC 3381 4.1
the following path: sheet-completed-copy-number (integer(0:MAX)) RFC 3381 4.2
sheet-completed-document-number (integer(0:MAX))RFC 3381 4.3
impressions-completed-current-copy (integer(0:MAX))
RFC 3381 4.4
6.2 Keyword Attribute Values
ftp.isi.edu/iana/assignments/ipp/attributes/ The following table provides registration information for all of the
attributes defined in this document that have keyword values. These
keywords are to be registered according to the procedures defined in
RFC 2911 [RFC2911] section 6.1.
The registry entry will contain the following information: sheet-collate (type2 keyword) RFC 3381 3.1
'uncollated' RFC 3381 3.1
'collated' RFC 3381 3.1
sheet-collate-default (type2 keyword) RFC 3381 3.1
See "sheet-collate" attribute
sheet-collate-supported (1setOf type2 keyword) RFC 3381 3.1
See "sheet-collate" attribute
Job Template attributes: Ref. Section: 6.3 Enum Attribute Values
sheet-collate (type2 keyword) RFC NNNN 1.1
Job Description attributes: Ref. Section: The following table provides registration information for all of the
job-collation-type (type2 enum) RFC NNNN 2.1 attributes defined in this document that have enum values. These
sheet-completed-copy-number (integer(0:MAX)) RFC NNNN 2.2 enums are to be registered according to the procedures defined in RFC
sheet-completed-document-number (integer(0:MAX))RFC NNNN 2.3 2911 [RFC2911] section 6.1.
impressions-completed-current-copy (integer(0:MAX))
RFC NNNN 2.4
5 Internationalization Considerations job-collation-type (type2 enum) RFC 3381 4.1
'1' 'other' RFC 3381 4.1
'2' 'unknown' RFC 3381 4.1
'3' 'uncollated-sheets' RFC 3381 4.1
'4' 'collated-documents' RFC 3381 4.1
'5' 'uncollated-documents' RFC 3381 4.1
7 Internationalization Considerations
The IPP extensions defined in this document require the same The IPP extensions defined in this document require the same
internationalization considerations as any of the Job Template and internationalization considerations as any of the Job Template and
Job Descriptions attributes defined in IPP/1.1 [RFC2911]. Job Description attributes defined in IPP/1.1 [RFC2911].
6 Security Considerations 8 Security Considerations
The IPP extensions defined in this document require the same security The IPP extensions defined in this document require the same security
considerations as any of the Job Template attributes and Job considerations as any of the Job Template attributes and Job
Descriptions attributes defined in IPP/1.1 [RFC2911]. Description attributes defined in IPP/1.1 [RFC2911].
7 References 9 References
[ipp-iig] 9.1 Normative References
Hastings, T., Manros, C., "Internet Printing Protocol/1.1: draft- [RFC2910] Herriot, R., Butler, S., Moore, P. and R. Turner,
ietf-ipp-implementers-guide-v11-01.txt, work in progress, May 9, "Internet Printing Protocol/1.1: Encoding and Transport",
2000. RFC 2910, September 2000.
[ipp-ntfy] [RFC2911] Hastings, T., Herriot, R., deBry, R., Isaacson, S. and P.
Powell, "Internet Printing Protocol/1.1: Model and
Semantics", RFC 2911, September 2000.
Isaacson, S., Martin, J., deBry, R., Hastings, T., Shepherd, M., 9.2 Informative References
Bergman, R., " IPP Event Notification Specification", <draft-ietf-
ipp-not-spec-04.txt>, work in progress, August 30, 2000.
[RFC2565] [RFC2565] Herriot, R., Butler, S., Moore, P. and R. Turner,
"Internet Printing Protocol/1.0: Encoding and Transport",
RFC 2565, April 1999.
Herriot, R., Butler, S., Moore, P., Tuner, R., "Internet Printing [RFC2566] deBry, R., Hastings, T., Herriot, R., Isaacson, S. and P.
Protocol/1.0: Encoding and Transport", RFC 2565, April 1999. Powell, "Internet Printing Protocol/1.0: Model and
Semantics", RFC 2566, April 1999.
[RFC2566] [RFC2567] Wright, F.D., "Design Goals for an Internet Printing
Protocol", RFC 2567, April 1999.
deBry, R., , Hastings, T., Herriot, R., Isaacson, S., Powell, P., [RFC2568] Zilles, S., "Rationale for the Structure and Model and
"Internet Printing Protocol/1.0: Model and Semantics", RFC 2566, Protocol for the Internet Printing Protocol", RFC 2568,
April 1999. April 1999.
[RFC2567] [RFC2569] Herriot, R., Hastings, T., Jacobs, N. and J. Martin,
"Mapping between LPD and IPP Protocols", RFC 2569, April
1999.
Wright, D., "Design Goals for an Internet Printing Protocol", RFC [RFC2707] Bergman, R., Hastings, T., Isaacson, S. and H. Lewis, "PWG
2567, April 1999. Job Monitoring MIB - V1", RFC 2707, November 1999.
[RFC2568] [RFC3196] Hastings, T., Manros, C., Zehler, P., Kugler, C. and H.
Holst, "Internet Printing Protocol/1.1: Implementor's
Guide", RFC 3196, November 2001.
Zilles, S., "Rationale for the Structure and Model and Protocol for [ipp-ntfy] Herriot, R., Hastings, T., et. al., "Internet Printing
the Internet Printing Protocol", RFC 2568, April 1999. Protocol (IPP): Event Notification and Subscriptions",
Work in Progress.
[RFC2569] 10 Description of the Base IPP Documents
Herriot, R., Hastings, T., Jacobs, N., Martin, J., "Mapping between The base set of IPP documents includes:
LPD and IPP Protocols", RFC 2569, April 1999.
[RFC2707] Design Goals for an Internet Printing Protocol [RFC2567]
Rationale for the Structure and Model and Protocol for the
Internet Printing Protocol [RFC2568]
Internet Printing Protocol/1.1: Model and Semantics [RFC2911]
Internet Printing Protocol/1.1: Encoding and Transport [RFC2910]
Internet Printing Protocol/1.1: Implementer's Guide [RFC3196]
Mapping between LPD and IPP Protocols [RFC2569]
Bergman, R., Hastings, T., Isaacson, S., Lewis, H. "PWG Job The "Design Goals for an Internet Printing Protocol" document takes a
Monitoring MIB - V1", RFC 2707, November, 1999. broad look at distributed printing functionality, and enumerates
real-life scenarios that help to clarify the features that need to be
included in a printing protocol for the Internet. It identifies
requirements for three types of users: end users, operators, and
administrators. It calls out a subset of end user requirements that
are satisfied in IPP/1.0 [RFC2566, RFC2565]. A few OPTIONAL operator
operations have been added to IPP/1.1 [RFC2911, RFC2910].
[RFC2910] The "Rationale for the Structure and Model and Protocol for the
Internet Printing Protocol" document describes IPP from a high level
view, defines a roadmap for the various documents that form the suite
of IPP specification documents, and gives background and rationale
for the IETF IPP working group's major decisions.
Herriot, R., Butler, S., Moore, P., Tuner, R., "Internet Printing The "Internet Printing Protocol/1.1: Model and Semantics" document
Protocol/1.1: Encoding and Transport", RFC 2910, September, 2000. describes a simplified model with abstract objects, their attributes,
and their operations. The model introduces a Printer and a Job. The
Job supports multiple documents per Job. The model document also
addresses how security, internationalization, and directory issues
are addressed.
[RFC2911] The "Internet Printing Protocol/1.1: Encoding and Transport" document
is a formal mapping of the abstract operations and attributes defined
in the model document onto HTTP/1.1 [RFC2616]. It also defines the
encoding rules for a new Internet MIME media type called
"application/ipp". This document also defines the rules for
transporting over HTTP a message body whose Content-Type is
"application/ipp". This document defines the 'ipp' scheme for
identifying IPP printers and jobs.
deBry, R., , Hastings, T., Herriot, R., Isaacson, S., Powell, P., The "Internet Printing Protocol/1.1: Implementer's Guide" document
"Internet Printing Protocol/1.1: Model and Semantics", RFC 2911, gives insight and advice to implementers of IPP clients and IPP
September, 2000. objects. It is intended to help them understand IPP/1.1 and some of
the considerations that may assist them in the design of their client
and/or IPP object implementations. For example, a typical order of
processing requests is given, including error checking. Motivation
for some of the specification decisions is also included.
8 Author's Addresses The "Mapping between LPD and IPP Protocols" document gives some
advice to implementers of gateways between IPP and LPD (Line Printer
Daemon) implementations.
Tom Hastings In addition to the base IPP documents, the "Event Notification
Xerox Corporation Specification" document [ipp-ntfy] defines OPTIONAL operations that
737 Hawaii St. ESAE 231 allow a client to subscribe to printing related events.
El Segundo, CA 90245 Subscriptions include "Per-Job subscriptions" and "Per-Printer
Phone: 310-333-6413 subscriptions". Subscriptions are modeled as Subscription objects.
Fax: 310-333-5514 Four other operations are defined for subscription objects: get
e-mail: hastings@cp10.es.xerox.com attributes, get subscriptions, renew a subscription, and cancel a
subscription.
Harry Lewis 11 Authors' Addresses
IBM
P.O. Box 1900
Boulder, CO 80301-9191
Phone: (303) 924-5337 Tom Hastings
FAX: Xerox Corporation
e-mail: harryl@us.ibm.com 737 Hawaii St. ESAE 231
El Segundo, CA 90245
Ron Bergman (Editor) Phone: 310-333-6413
Hitachi Koki Imaging Solutions Fax: 310-333-5514
1757 Tapo Canyon Road EMail: hastings@cp10.es.xerox.com
Simi Valley, CA 93063-3394
Phone: 805-578-4421 Harry Lewis
Fax: 805-578-4001 IBM
Email: rbergma@hitachi-hkis.com 6300 Diagonal Hwy
Boulder, CO 80301-9191
9 Full Copyright Statement Phone: (303) 924-5337
EMail: harryl@us.ibm.com
Copyright (C) The Internet Society (2001). All Rights Reserved. Ron Bergman (Editor)
Hitachi Koki Imaging Solutions
1757 Tapo Canyon Road
Simi Valley, CA 93063-3394
Phone: 805-578-4421
Fax: 805-578-4001
EMail: rbergma@hitachi-hkis.com
IPP Web Page: http://www.pwg.org/ipp/
IPP Mailing List: ipp@pwg.org
To subscribe to the ipp mailing list, send the following email:
1) send it to majordomo@pwg.org
2) leave the subject line blank
3) put the following two lines in the message body:
subscribe ipp
end
Implementers of this specification document are encouraged to join
the IPP Mailing List in order to participate in any discussions of
clarification issues and review of registration proposals for
additional attributes and values. In order to reduce spam, the
mailing list rejects mail from non-subscribers, so you must subscribe
to the mailing list in order to send a question or comment to the
mailing list.
12 Full Copyright Statement
Copyright (C) The Internet Society (2002). All Rights Reserved.
This document and translations of it may be copied and furnished to This document and translations of it may be copied and furnished to
others, and derivative works that comment on or otherwise explain it others, and derivative works that comment on or otherwise explain it
or assist in its implementation may be prepared, copied, published or assist in its implementation may be prepared, copied, published
and distributed, in whole or in part, without restriction of any and distributed, in whole or in part, without restriction of any
kind, provided that the above copyright notice and this paragraph are kind, provided that the above copyright notice and this paragraph are
included on all such copies and derivative works. However, this included on all such copies and derivative works. However, this
document itself may not be modified in any way, such as by removing document itself may not be modified in any way, such as by removing
the copyright notice or references to the Internet Society or other the copyright notice or references to the Internet Society or other
Internet organizations, except as needed for the purpose of Internet organizations, except as needed for the purpose of
developing Internet standards in which case the procedures for developing Internet standards in which case the procedures for
copyrights defined in the Internet Standards process must be copyrights defined in the Internet Standards process must be
followed, or as required to translate it into languages other than followed, or as required to translate it into languages other than
English. English.
The limited permissions granted above are perpetual and will not be The limited permissions granted above are perpetual and will not be
revoked by the Internet Society or its successors or assigns. revoked by the Internet Society or its successors or assigns.
This document and the information contained herein is provided on an This document and the information contained herein is provided on an
"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Acknowledgement
Funding for the RFC Editor function is currently provided by the
Internet Society.
 End of changes. 114 change blocks. 
344 lines changed or deleted 399 lines changed or added

This html diff was produced by rfcdiff 1.41. The latest version is available from http://tools.ietf.org/tools/rfcdiff/