PWG WORKING DRAFT ISSUES are highlighted like this. Tom Hastings, Harry Lewis, Ron Bergman July 6, 1998 Proposed Job Progress Attributes for IPP Version 0.1 Abstract This white paper proposes six new Job Description attributes to be registered for use with IPP/1.0 [ipp-mod]. These attributes are drawn from the PWG Job Monitoring MIB [jmp-mib]. They were contained in the long notification proposal [ipp-not-long], and have been placed in a separate more manageable-sized specification. These attributes are be used with the IPP notification event report. They may also be used by themselves as useful job progress monitoring attributes. The six new attributes are: "output-bin" (1setOf text(63)) "sheet-completed-copy-number" (integer(-2:MAX)) "sheet-completed-document-number" (integer(-2:MAX)) "job-collation-type" (enum) "impressions-interpreted" (integer(-2:MAX)) "impressions-completed-current-copy" (integer(-2:MAX)) TABLE OF CONTENTS 1 Job Attributes for Monitoring Job Progress...........2 1.1Job Collation: Document Collation and Sheet Collation 2 2 New IPP attributes...................................6 2.1"output-bin" (1setOf text(63)).......................6 2.2"sheet-completed-copy-number" (integer(-2:MAX))......6 2.3"sheet-completed-document-number" (integer(-2:MAX))..6 2.4"job-collation-type" (enum)..........................7 2.5"impressions-interpreted" (integer(-2:MAX))..........7 2.6"impressions-completed-current-copy" (integer(-2:MAX))7 3 References...........................................7 1 1 Job Attributes for Monitoring Job Progress There are a number of objects and attributes for monitoring the progress of a job. These objects and attributes count the number of K octets, impressions, sheets, and pages requested or completed. For impressions and sheets, "completed" SHALL mean stacked, unless the implementation is unable to detect when each sheet is stacked, in which case stacked is approximated when processing of each sheet completes. There are objects and attributes for the overall job and for the current copy of the document currently being stacked. For the latter, the rate at which the various objects and attributes count depends on the sheet and document collation of the job. 1.1 Job Collation: Document Collation and Sheet Collation Job Collation included sheet collation and document collation. Sheet collation is defined to be the ordering of sheets within a document copy. Document collation is defined to be ordering of document copies within a multi-document job. There are three types of job collation: 1.uncollatedSheets(3) - No collation of the sheets within each document copy, i.e., each sheet of a document that is to produce multiple copies is replicated before the next sheet in the document is processed and stacked. If the device has an output bin collator, the uncollatedSheets(3) value may actually produce collated sheets as far as the user is concerned (in the output bins). However, when the job collation is the 'uncollatedSheets(3)' value, job progress is indistinguishable to a monitoring application between a device that has an output bin collator and one that does not. 2.collatedDocuments(4) - Collation of the sheets within each document copy is performed within the printing device by making multiple passes over either the source or an intermediate representation of the document. In addition, when there are multiple documents per job, the i'th copy of each document is stacked before the j'th copy of each document, i.e., the documents are collated within each job copy. For example, if a job is submitted with documents, A and B, the job is made available to the end user as: A, B, A, B, .. The 'collatedDocuments(4)' value corresponds to the IPP [ipp-model] 'separate-documents-collated-copies' value of the "multiple- document-handling" attribute. If jobCopiesRequested or documentCopiesRequested = 1, then jobCollationType is defined as 4. 2 3.uncollatedDocuments(5) - Collation of the sheets within each document copy is performed within the printing device by making multiple passes over either the source or an intermediate representation of the document. In addition, when there are multiple documents per job, all copies of the first document in the job are stacked before the any copied of the next document in the job, i.e., the documents are uncollated within the job. For example, if a job is submitted with documents, A and B, the job is mad available to the end user as: A, A, ., B, B, .. The 'uncollatedDocuments(5)' value corresponds to the IPP [ipp- model] 'separate-documents-uncollated-copies' value of the "multiple-document-handling" attribute. Consider the following four variables that are used to monitor the progress of a job's impressions: 1.jmJobImpressionsCompleted - counts the total number of impressions stacked for the job 2.impressionsCompletedCurrentCopy - counts the number of impressions stacked for the current document copy 3.sheetCompletedCopyNumber - identifies the number of the copy for the current document being stacked where the first copy is 1. 4.sheetCompletedDocumentNumber - identifies the current document within the job that is being stacked where the first document in a job is 1. NOTE: this attribute SHOULD NOT be implemented for implementations that only support one document per job. 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 impressions, the four variables have the following values as each sheet is stacked for one-sided printing: 3 "job-collation-type" = uncollated-sheets(3) "job- "impressions- "sheet- "sheet- impressions- completed- completed- completed- completed" current-copy" copy-number" document- number" 0 0 0 0 1 1 1 1 2 1 2 1 3 1 3 1 4 2 1 1 5 2 2 1 6 2 3 1 7 3 1 1 8 3 2 1 9 3 3 1 10 1 1 2 11 1 2 2 12 1 3 2 13 2 1 2 14 2 2 2 15 2 3 2 16 3 1 2 17 3 2 2 18 3 3 2 4 "job-collation-type" = collated-documents(4) "job- "impressions- "sheet- "sheet- impressions- completed- completed- completed- completed" current-copy" copy-number" document- number" 0 0 0 0 1 1 1 1 2 2 1 1 3 3 1 1 4 1 1 2 5 2 1 2 6 3 1 2 7 1 2 1 8 2 2 1 9 3 2 1 10 1 2 2 11 2 2 2 12 3 2 2 13 1 3 1 14 2 3 1 15 3 3 1 16 1 3 2 17 2 3 2 18 3 3 2 5 "job-collation-type" = uncollated-documents(5) "job- "impressions- "sheet- "sheet- impressions- completed- completed- completed- completed" current-copy" copy-number" document- number" 0 0 0 0 1 1 1 1 2 2 1 1 3 3 1 1 4 1 2 1 5 2 2 1 6 3 2 1 7 1 3 1 8 2 3 1 9 3 3 1 10 1 1 2 11 2 1 2 12 3 1 2 13 1 2 2 14 2 2 2 15 3 2 2 16 1 3 2 17 2 3 2 18 3 3 2 2 New IPP attributes The following IPP Job Description attributes are proposed to be added to IPP through the type2 registration procedures. They are useful for monitoring the progress of a job. They are also used at attributes in the notification content in a notification report [ipp-not]. 2.1 "output-bin" (1setOf text(63)) The name or number (represented as ASCII digits) of the output bin to which all or part of the job is placed in. 2.2 "sheet-completed-copy-number" (integer(-2:MAX)) 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 copy for each document is being stacked and is equal to n where n is the nth sheet stacked in the current document copy. See section 1.1. ISSUE 1: Should we change the lower limit to 0 and use the IPP out-of- bound values: 'unknown' for -2? Same issue as [ipp-mib] for the mapping of IPP attributes to the Printer MIB integer objects. 6 2.3 "sheet-completed-document-number" (integer(-2:MAX)) 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 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. Implementations that only support one document jobs SHOULD NOT implement this attribute. ISSUE 1: Should we change the lower limit to 0 and use the IPP out-of- bound values: 'unknown' for -2? 2.4 "job-collation-type" (enum) The type of job collation. See section 1.1, Standard values are: other(1), unknown(2), uncollatedSheets(3), -- sheets within each document copy -- are not collated: 1 1 ..., 2 2 ..., collatedDocuments(4), -- internal collated sheets, -- documents: A, B, A, B, ... uncollatedDocuments(5) -- internal collated sheets, -- documents: A, A, ..., B, B, ... 2.5 "impressions-interpreted" (integer(-2:MAX)) The number of impressions interpreted for the job so far. ISSUE 1: Should we change the lower limit to 0 and use the IPP out-of- bound values: 'unknown' for -2? 2.6 "impressions-completed-current-copy" (integer(-2:MAX)) The number of impressions completed by the device for the current copy of the current document so far. For printing, the impressions completed includes interpreting, marking, and stacking the output. For other types of job services, the number of impressions completed includes the number of impressions processed. This value SHALL be reset to 0 for each document in the job and for each document copy. ISSUE 1: Should we change the lower limit to 0 and use the IPP out-of- bound values: 'unknown' for -2? 7 3 References [ipp-mib] Isaacson, S., Hastings, T., Herriot, R., Schoff, K., "IPP Device Object and MIB Access", , work in progress, June 20, 1998. [ipp-mod] deBry, R., , Hastings, T., Herriot, R., Isaacson, S., Powell, P., "Internet Printing Protocol/1.0: Model and Semantics", < draft- ietf-ipp-model-10.txt>, work in progress, June 30, 1998. [ipp-not-long] Hastings, T., Isaacson, S., Lewis, H., "Event notifications for the IPP print protocol [and JMP]", , work in progress, May 12, 1998. [ipp-not-short Isaacson, S., deBry, R., Martin, J., Hastings, T., " IPP Event Notifications (Very Short) ", , work in progress, July 1, 1998.. [ipp-sub] Isaacson, S., Martin, J., deBry, R., Hastings, T., "Job Independent Subscriptions for IPP", , work in progress, July 1, 1998. [jmp-mib] Bergman, R., Hastings, T., Isaacson, S., Lewis, H. "PWG Job Monitoring MIB - V1", , work in progress, Feb 3, 1998. 8