Standard For Internet Printing Protocol '-actual' …ftp.pwg.org/pub/pwg/mfd/wd/wd-mfdcopymodel10-20090914.d… · Web viewThe details of each subunit are detailed in 8.2.3. To see

September 14, 2009wd-mfdCopymod10-2009 Working Draft

The Printer Working Group

Copy ServiceSemantic Model and Service Interface

Status: Interim

Abstract: Network print devices have evolved to support additional multifunction services, in particular Copy Service. When Copy Devices are installed in local office or enterprise networks, they need remote service, device, and job management capabilities so that administrators, operators, and end users can monitor their health and status. In addition, such Copy Devices need remote job submission capabilities so that operators and end users can create Copy Jobs without depending entirely on local console interfaces. This document defines a semantic model for service, device, and job management and job submission for these Copy Devices.

Copyright © 2007-2009, Printer Working Group. All rights reserved.

1

2

3

4

5

6

7

8

9

10

11121314151617181920

2122232425

2627

28

29

3031

32

MFD: Copy Service June 22, 2009

Copyright (C) 2007-2009, The Printer Working Group. All rights reserved. This document may be copied and furnished to others, and derivative works that comment on, or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice, this paragraph and the title of the Document as referenced below are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to the Printer Working Group, a program of the IEEE-ISTO.

Title: Network Copy Service Semantic Model and Service Interface

The IEEE-ISTO and the Printer Working Group DISCLAIM ANY AND ALL WARRANTIES, WHETHER EXPRESS OR IMPLIED INCLUDING (WITHOUT LIMITATION) ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

The Printer Working Group, a program of the IEEE-ISTO, reserves the right to make changes to the document without further notice. The document may be updated, replaced or made obsolete by other documents at any time.

The IEEE-ISTO and the Printer Working Group, a program of the IEEE-ISTO take no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights.

The IEEE-ISTO and the Printer Working Group, a program of the IEEE-ISTO invite any interested party to bring to its attention any copyrights, patents, or patent applications, or other proprietary rights, which may cover technology that may be required to implement the contents of this document. The IEEE-ISTO and its programs shall not be responsible for identifying patents for which a license may be required by a document and/or IEEE-ISTO Industry Group Standard or for conducting inquiries into the legal validity or scope of those patents that are brought to its attention. Inquiries may be submitted to the IEEE-ISTO by e-mail at:

[email protected]

The Printer Working Group acknowledges that the IEEE-ISTO (acting itself or through its designees) is, and shall at all times, be the sole entity that may authorize the use of certification marks, trademarks, or other special designations to indicate compliance with these materials.

Use of this document is wholly voluntary. The existence of this document does not imply that there are no other ways to produce, test, measure, purchase, market, or provide other goods and services related to its scope.

Copyright © 2007-2009, Printer Working Group. All rights reserved. Page 2 of 41

333435363738

39

404142

4344

45464748

495051525354

55

565758

596061


About the IEEE-ISTO

The IEEE-ISTO is a not-for-profit corporation offering industry groups an innovative and flexible operational forum and support services. The IEEE Industry Standards and Technology Organization member organizations include printer manufacturers, print server developers, operating system providers, network operating systems providers, network connectivity vendors, and print management application developers. The IEEE-ISTO provides a forum not only to develop standards, but also to facilitate activities that support the implementation and acceptance of standards in the marketplace. The organization is affiliated with the IEEE (http://www.ieee.org/) and the IEEE Standards Association (http://standards.ieee.org/).

For additional information regarding the IEEE-ISTO and its industry programs visit:http://www.ieee-isto.org.

About the Printer Working Group

The Printer Working Group (or PWG) is a Program of the IEEE-ISTO. All references to the PWG in this document implicitly mean “The Printer Working Group, a Program of the IEEE ISTO.” The PWG is chartered to make printers and the applications and operating systems supporting them work together better. In order to meet this objective, the PWG will document the results of their work as open standards that define print related protocols, interfaces, data models, procedures and conventions. Printer manufacturers and vendors of printer related software would benefit from the interoperability provided by voluntary conformance to these standards.

In general, a PWG standard is a specification that is stable, well understood, and is technically competent, has multiple, independent and interoperable implementations with substantial operational experience, and enjoys significant public support.

Contact information:

The Printer Working Groupc/o The IEEE Industry Standards and Technology Organization445 Hoes LanePiscataway, NJ 08854USA

MFD Web Page: http://www.pwg.org/mfd MFD Mailing List: [email protected]

Instructions for subscribing to the MFD mailing list can be found at the following link: http://www.pwg.org/mailhelp.htmlMembers of the PWG and interested parties are encouraged to join the PWG and MFD WG mailing lists in order to participate in discussions, clarifications and review of the WG product.


62

63646566676869

70717273

747576777879

808182

83

848586878889909192939495

http://www.pwg.org/mailhelp.html

mailto:[email protected]

http://www.ieee-isto.org/

http://standards.ieee.org/)

http://www.ieee.org/


Contents1 Outstanding Issues........................................................................................................................................ 8

2 Introduction.................................................................................................................................................... 8

3 Summary....................................................................................................................................................... 8

4 Terminology................................................................................................................................................... 94.1 Conformance Terminology................................................................................................................................... 94.2 Content Specific Terminology.............................................................................................................................. 9

5 Rationale..................................................................................................................................................... 105.1 Rationale for this Copy Service Specification.....................................................................................................105.2 Out of Scope for Copy Service........................................................................................................................... 105.3 Model mapping conventions............................................................................................................................... 10

6 MFD Model Overview.................................................................................................................................. 11

7 Copy Service Model Overview..................................................................................................................... 117.1 Default Copy JobTicket...................................................................................................................................... 127.2 Copy Service Capabilities.................................................................................................................................. 137.3 Copy Service Description................................................................................................................................... 137.4 Copy Service Status........................................................................................................................................... 14

8 Copy Job Model........................................................................................................................................... 168.1 Job Receipt........................................................................................................................................................ 178.2 Job Status.......................................................................................................................................................... 178.3 Job Ticket........................................................................................................................................................... 19

8.3.1 Document Processing....................................................................................................198.3.2 Job Description..............................................................................................................228.3.3 Job Processing...............................................................................................................23

9 Copy Service Configuration......................................................................................................................... 24

10 Copy Service Theory of Operation..............................................................................................................24

11 Copy Service Interfaces............................................................................................................................... 2511.1 Basic Copy Service Operations..........................................................................................................................26

11.1.1 Cancel Copy Job............................................................................................................2611.1.2 Create Copy Job............................................................................................................2611.1.3 Get Active Copy Jobs.....................................................................................................2711.1.4 Get Copy Job Elements.................................................................................................2811.1.5 Get Copy Job History.....................................................................................................2911.1.6 Get Copy Service Elements...........................................................................................3011.1.7 Validate Copy Ticket......................................................................................................31

11.2 Administrative Copy Service Operations............................................................................................................3211.2.1 Disable Copy Service.....................................................................................................3211.2.2 Enable Copy Service......................................................................................................3311.2.3 Hold Copy Job...............................................................................................................3311.2.4 PauseCopyService.........................................................................................................3411.2.5 Release Copy Job..........................................................................................................3511.2.6 Resume Copy Service...................................................................................................3611.2.7 Restart Copy Service.....................................................................................................3611.2.8 Shutdown Copy Service.................................................................................................3711.2.9 Startup Copy Service.....................................................................................................38

12 Conformance Requirements........................................................................................................................38


96

97

98

99

100101102

103104105106

107

108109110111112

113114115116117118119

120

121

122123124125126127128129130131132133134135136137138139140

141


13 PWG and IANA Registration Considerations...............................................................................................38

14 Internalization Considerations..................................................................................................................... 38

15 Security Considerations............................................................................................................................... 38

16 References.................................................................................................................................................. 3916.1 Normative References........................................................................................................................................ 3916.2 Informative References...................................................................................................................................... 40

17 Author’s Address......................................................................................................................................... 40

FiguresFigure 1 High Level Copy Service Schema......................................................................................................................... 11

Figure 2 Default Copy JobTicket......................................................................................................................................... 13

Figure 3 Copy Service Description...................................................................................................................................... 14

Figure 4 Copy Service Status.............................................................................................................................................. 15

Figure 5 JobTable............................................................................................................................................................... 16

Figure 6 High Level Copy Job View.................................................................................................................................... 17

Figure 7 Copy Job Status.................................................................................................................................................... 18

Figure 8 Copy Job Ticket..................................................................................................................................................... 19

Figure 9 Copy Document Processing (Input).......................................................................................................................20

Figure 10 Copy Document Processing (Output)..................................................................................................................21

Figure 11 Copy Job Description.......................................................................................................................................... 22

Figure 12 Copy Job Processing.......................................................................................................................................... 23

Figure 13 Copy Service Configuration................................................................................................................................. 24

Figure 14 Cancel Copy Job Request................................................................................................................................... 26

Figure 15 Cancel Copy Job Response................................................................................................................................ 26

Figure 16 Create Copy Job Request................................................................................................................................... 27

Figure 17 Create Copy Job Response................................................................................................................................ 27

Figure 18 Get Active Copy Jobs Request............................................................................................................................ 27

Figure 19 Get Active Copy Jobs Response......................................................................................................................... 28

Figure 20 Get Copy Job Elements Request........................................................................................................................ 28

Figure 21 Get Copy Job Elements Response.....................................................................................................................29

Figure 22 GetCopyJobHistoryRequest................................................................................................................................ 29

Figure 23 Get Copy Job History Response......................................................................................................................... 30


142

143

144

145146147

148149150

151152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174


Figure 24 Get Copy Service Elements Request.................................................................................................................. 30

Figure 25 Get Copy Service Elements Response...............................................................................................................31

Figure 26 Validate Copy Job Ticket Request...................................................................................................................... 32

Figure 27 Validate Copy JobTicket Response..................................................................................................................... 32

Figure 28 Disable Copy Service Request............................................................................................................................ 32

Figure 29 Disable Copy Service Response......................................................................................................................... 33

Figure 30 Enable Copy Service Request............................................................................................................................. 33

Figure 31 Enable Copy Service Response..........................................................................................................................33

Figure 32 Hold Copy Job Request...................................................................................................................................... 34

Figure 33 Hold Copy Job Response.................................................................................................................................... 34

Figure 34 Pause Copy Service Request.............................................................................................................................. 35

Figure 35 Pause Copy Service Response........................................................................................................................... 35

Figure 36 Release Copy Job Request................................................................................................................................. 35

Figure 37 Release Copy Job Response.............................................................................................................................. 35

Figure 38 Resume Copy Service Request.......................................................................................................................... 36

Figure 39 Resume Copy Service Response........................................................................................................................36

Figure 40 Restart Copy Service Request............................................................................................................................ 36

Figure 41 Restart Copy Service Response.........................................................................................................................37

Figure 42 Shutdown Copy Service Request........................................................................................................................ 37

Figure 43 Shutdown Copy Service Response..................................................................................................................... 37

Figure 44 Startup Copy Service Request............................................................................................................................ 38

Figure 45 Startup Copy Service Response.........................................................................................................................38

TablesTable 1 MFD Service Status Elements................................................................................................................................ 15

Table 2 MFD Job Status Elements...................................................................................................................................... 19


175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199200

201

202

203

MFD: CopyService September 14, 2009

1 Outstanding Issues To be resolved and deleted before publication

1) Is a copy controller externalized if it is a separate subsystem from the scanner/printer controller or system controller?

2 IntroductionThis document specifies the PWG abstract model for Copy services of a Multifunction Device (MFD). Included in this document is the content specific terminology, data model, the theory of operation, the Copy service interfaces and the conformance requirements. The MFD Copy service abstract models include the functional models and interfaces of the associated Copy services for a local network or enterprise-connected multifunction device.

3 SummaryThe MFD service addressed in this specification is the Copy Service. The Copy Service responds to queries about its capabilities, configuration and descriptive information. It responds to queries for information about the Copy Jobs and their associated Documents. It manages and processes Copy Jobs with its associated Copy Job Ticket.

The Copy Service, by definition, takes an input Hardcopy Document and produces an output Hardcopy Document. Although the Copy Service usually has some internal representation for the digital form of the document that is being copied (i.e. Internal Copy Document) the Internal Copy Document is never externalized. The result of this is that a Copy Service contains zero or more Jobs and the Jobs do not contain any Documents.

Each Copy Job can contain a CopyJobTicket which provides descriptive information as well as JobProcessing and DocumentProcessing instructions. The Job Processing instructions apply to the Job as a whole. The DocumentProcessing instructions specify processing instructions applied to either the input or output Hardcopy Document. The input processing semantics are based on Scan Service Semantics while the output processing semantics are based on Print Service Semantics.

A Copy client application contains a Copy Client. A Copy client application interacts with the end user to obtain the end user’s Copy Intent and uses the Copy Client to communicate with the Copy Service that will execute the end user’s Copy Intent.

Copy Templates contain instructions representing preconfigured Copy intent that can be used as is or modified by the end user. Once the end user is satisfied with the Copy Template the Copy client application passes the Copy Job Template to the Copy Job Client for submission to the Copy Service. Copy templates may be obtained in a number of ways. Those methods are outside the scope of this specification.The Copy scenarios addressed in this specification range from walk-up users that use MFD’s front panel to initiate a Copy Job to remote users that use their computers to initiate a Copy Job. The assumption is that it is possible to implement a Network Connected Copy Client that is accessible via the device’s front panel. The model also supports external security services that protects against unauthorized use of the Copy services and access of Copy digital data.

Copyright © 2007-2009, Printer Working Group. All rights reserved. Page 7 of

204

205206207208209

210

211212213214215

216

217218219220221222223224225226227228229230231232233234235236237238239240241242243244245


4 Terminology

4.1 Conformance TerminologySee [MFD] for conformance terminology used. There are no Copy specific conformance terms.

4.2 Content Specific TerminologySee [MFD] for common MFD terminology used. The Copy specific terms are listed below.

Term Definition

Internal Copy Document The data object managed by a Copy Service that contains an implementation specific representation of control information and the associated DigitalDocument. This data object is not externalized and is not visible to End Users or Administrators.


246

247

248

249

250251

252253


5 Rationale

5.1 Rationale for this Copy Service Specification

In order to support common functionality for copying using multifunction devices, there is a clear need to develop a semantic model and a set of abstract operations and elements for Copy related services. In order to implement an abstract model of the operations and elements for Copy related services, there is need to map them onto implementable applications and communication protocols that support interactions between Copy Clients and Copy Services. There is a clear need to define a binding of the abstract model into Web Service Schema and Web Service protocol stack.

5.2 Out of Scope for Copy ServiceThe basic Copy service model defined in this document is targeted to support enterprise Copy applications. However this document does not specify any application specific semantics. The MFD Working Group charter defines the following as out of scope:

1. Semantics of any compound service such as Copy-And-Email.2. Semantics of any workflow protocol, i.e., sequencing and coordination of Copy jobs across multiple

services.3. Semantics of any Copy service management operations for MFDs that are not network connected.

5.3 Model mapping conventionsThe Copy Service model is described in this document as an XML schema. This is for the sake of convenience and does not require a protocol mapping involving XML. The top level objects such as the Subunits, the Services, and their associated Jobs and Documents can be represented in any number of ways. Abstractly they are objects which contain attributes or properties that express characteristics of the object. For the remainder of this document references to Attribute or Element refer to XML Attributes and XML Elements respectively. Either of these can be abstractly considered to be attributes or properties of abstract objects.


254

255

256257258259260261262

263

264265266267268269270271272

273

274275276277278279


6 MFD Model OverviewSee [MFD] for the overall MFD model. The Copy Service fits within the MFD model as one of a number of services that can be hosted on a multifunction device (i.e. System). The critical MFD container object with regard to describing the Copy service is Services.

One of the MFD’s services is the Copy Service. There can be multiple instances of a Copy Service hosted on a Multifunction Device. This allows an implementation to expose multiple queues each with its own set of defaults and capabilities.

The System has a SystemConfiguration object that contains all the subunits that comprise the MFD. Each Copy Service instance contains a service specific view of the subunits used by that service instance. The Copy service element CopyServiceConfiguration contains the service specific view of the associated Subunits.

7 Copy Service Model OverviewBelow is the top level view of the Copy Service schema.

Figure 1 High Level Copy Service Schema

The PWG semantic model supports zero or more Copy Services. A Copy Service is hosted locally on an MFD or remotely on another computer. The Copy Service model has an Active Job queue, a Job History and a set of Elements which includes Copy Service status, configuration, description, defaults, and processing capabilities. Copyright © 2007-2009, Printer Working Group. All rights reserved. Page 10 of

280

281

282283284

285286287

288289290

291

292

293294

295

296

297298299300


The CopyServiceStatus Group Element is an extension of the PWG service status class that includes elements such as ID, state, service counters, state messages and state reasons. State messages are localized state reasons. The only Copy Service specific status extensions are the Copy Service specific counters. The details of the Elements in the CopyServiceStatus group are specified in §7.4.

The CopyServiceDescription Group Element includes descriptive information such as service name and information, and has extension point for vendor specific information. These Description Elements are settable by Administrators. Similar to Copy Service state elements, there are localized Description Elements for each supported Description Element. The details of the CopyServiceDescription Elements are specified in §7.3.

The CopyServiceCapabilities Group Element represents the allowed values supported by the Copy Service for a CopyJobTicket. The Element includes two sub Elements: the CopyDocumentCapabilities Group Element has all processing Elements for Copy Documents, and the CopyJobCapabilites Group Element includes all supported processing Elements for Copy Jobs. The details of each processing Element are specified in §7.2.

The DefaultCopyTicket Group Element contains Copy description and job and document processing default values. The values contained in the Default CopyJobTicket are the values that that will be used by the Copy Service when processing a CopyJobTicket which does not specify a different value. The values for this are populated in an implementation specific manner. The details of the DefaultCopyTicket are specified in §7.1

The CopyService Configuration provides a Copy Service specific view into the Subunits that are associated with this service instance. Only Subunits that are used by the Copy Service will appear in this element. The details of each subunit are detailed in §Error: Reference source not found. To see all the subunits for the MFD the System element provides an all encompassing view.

A Copy Service contains zero or more jobs. Each job has exactly zero Documents. The Copy Service organizes its Copy Jobs in a minimum of two job queues: (1) ActiveJobs, (2) JobHistory. ActiveJobs is a queue maintaining a list of jobs that are pending or processing. The JobHistory queue maintains a log of Copy Jobs that have reached a terminating state (i.e. Completed, Aborted, and Canceled). The retention period for jobs in the JobHistory list is implementation specific but MUST NOT be less than 300 seconds. Each Copy Job can contain a CopyJobTicket which provides descriptive information as well as JobProcessing and DocumentProcessing instructions. The Job Processing instructions apply to the Job as a whole while the DocumentProcessing instructions specify processing instructions applied to either the input or output Hardcopy Documents. The input processing semantics are based on Scan Service Semantics while the output processing semantics are based on Print Service Semantics.

7.1 Default Copy JobTicketThe DefaultCopyTicket provides the values that will be used if the element is omitted in a Copy Job’s CopyJobTicket. Note that the processing instructions are not bound to the Copy Job until the Copy Job is actually processed. The values from the DefaultCopyJobTicket are not copied to the Job’s CopyJobTicket. If the CopyJobReceipt is supported, the combined elements from the user supplied CopyJobTicket and the applied values from the DefaultCopyJobTicket are copied to the CopyJobReceipt.


301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337

338

339340341342343344


Figure 2 Default Copy JobTicket

For descriptions of the elements that comprise CopyJobDescription, CopyJobProcessing and CopyDocumentProcessing see §8.3 on CopyJobTicket below.

7.2 Copy Service Capabilities

NOTE: Please ignore this section for now. This section will be updated for review when the CopyTicket becomes stable..

7.3 Copy Service Description

Below is a view of the Description elements for the Copy Service. The Description elements provide Descriptive information for the Copy Service. The elements are administratively set. The element values can be directly or modified indirectly through an operation.


345

346

347348349350

351

352

353354355356

357

358359360361362363


Figure 3 Copy Service Description

The elements common to all Service Descriptions are described in the MFD specifications [MFD]. Those elements are identified in the above diagram as being included in the yellow box. There are no elements specific to the Copy Service Description except the usual extension point (i.e. Any).

7.4 Copy Service Status

Below is a view of the Status elements for the Copy Service. The Status elements provide state information for the Copy Service. The elements are maintained by automata and cannot be directly set. The element values can be modified indirectly through an operation. For example PauseCopyService operation on the Copy Service may result in the change of the State and StateReasons elements.


364

365

366367368369370

371

372373374375376377378

Peter Zehler, 09/14/09,

Add section reference


Figure 4 Copy Service Status

The elements common to all Service Statuses are described in the MFD specifications [MFD]. Those elements are identified in the above diagram as being included in the yellow box. The elements specific to the Copy Service Status are described below.

MFD Element name DescriptionIsAcceptingJobs Indicates if the Service is able to accept new jobs. (EnableCopyService

& DisableCopyService sets the value of this element)CopyServiceCounters The usage counters for the Copy service.( See [PWG5106.1-2007])QueuedJobCount The number of jobs that this Printer has accepted but has not yet

completed.Any This element provides extension points for vendor differentiation and

implementation specific extensions while maintaining interoperability.

Table 1 MFD Service Status Elements


379

380

381382383384385

386





387


8 Copy Job Model Below is the top level view of the Copy Job. The jobs appear in one of two lists. Pending and active jobs appear in the ActiveJobs list.. Jobs that have reached a terminal state (i.e. Completed, Aborted, Canceled) appear in the JobHistory list. The amount of time a Job is retained in the JobHistory list is implementation specific but MUST NOT be less than 300 seconds..

Figure 5 JobTable

As indicated below Copy Jobs can contain zero documents. This is because the Copy Service takes as input a Hardcopy Document and produces a Hardcopy Document as output. Any internal Digital Document control or storage is not externalized. The state of the job is described in the CopyJobStatus element. The CopyJobTicket contains descriptive information about the Job and processing instructions for the Job. The CopyJobTicket also contains DocumentProcessing instructions. The Document processing instructions are broken into two set. The Input set applies to image acquisition (i.e. scanning) and the Output set applied to the production of the output Hardcopy Document (i.e. printing). The CopyJobTicket represent the End User’s intent while the JobReceipt represent what the Copy Service actually did.


388

389390391392

393

394

395

396397398399400401402403


Figure 6 High Level Copy Job View

8.1 Job ReceiptThis element has exactly the same structure as the CopyJobTicket. For each processing element of a Copy Job, it records the actual value used by the Copy Service for processing the Copy Job. It contains the elements supplied by the Copy Clientand applied to the job, any element or values substitutions made by the Copy Service and any default elements or values applied by the Copy Service. See §8.3 for element descriptions.

8.2 Job Status

Below is a view of the Status elements for the Copy Job. The Status elements provide state information for the Copy Job. The elements are maintained by automata and cannot be directly set. The element values can be


404

405

406407

408

409410411412413

414

415416417


modified indirectly through an operation. For example CancelCopyJob operation on the Copy Job may result in the change of the State and StateReasons elements

Figure 7 Copy Job Status

The elements common to all Job Statuses are described in the MFD specifications [MFD]. Those elements are identified in the above diagram as being included in the yellow box. The elements specific to the Copy Job Status are described below.


418419420

421

422

423424425426427428




MFD Element name DescriptionCopyJobCounters The usage counters for the Copy Job (See [PWG5106.1-2007]) Any This element provides extension points for vendor differentiation and

implementation specific extensions while maintaining interoperability.

Table 2 MFD Job Status Elements

8.3 Job TicketThe CopyJobTicket contains description and processing elements provided by the Copy client during Copy Job creation. This information is used by the Copy Service during the processing of a Copy Job. This information is made available to Copy Clients through the GetCopyJobElements operation and a subset is made available through the GetActiveCopyJobs and GetCopyJobHistory operations.

Figure 8 Copy Job Ticket

8.3.1 Document ProcessingThe CopyDocumentProcessing provides the document processing instructions that have been requested by the End User at the job level. Each element has a MustHonor attribute to indicate whether documents within the job must be processed according to what user has requested. The Document processing instructions are broken into two set. The Input set applies to image acquisition (i.e. scanning) and the Output set applied to the production of the output Hardcopy Document (i.e. printing).


429

430

431

432433434435436

437

438

439

440

441442443444445446


Figure 9 Copy Document Processing (Input)

The elements in the Input set are a subset of the DocumentProcessing element in the Scan Service and are described in the Scan Service specification [SCAN].


447

448

449

450451452




Figure 10 Copy Document Processing (Output)

The elements in the Output set are a subset of the DocumentProcessing element in the Print Service and are described in the Print Service specification [Print].


453

454

455

456457458459




8.3.2 Job DescriptionBelow is a view of the Description elements for the Copy Job. These elements are set by the Copy Client during job creation.

Figure 11 Copy Job Description

The elements common to all Job Descriptions are described in the MFD specifications [MFD]. Those elements are identified in the above diagram as being included in the yellow box. There are no elements specific to the Copy Job Description except the usual extension point (i.e. Any).


460461

462

463464465

466

467

468469470471472473




8.3.3 Job ProcessingThe Copy Job Processing element provides the job processing instructions that have been requested by the End User. Each element has a MustHonor attribute. When the value of MustHonor is true, the Copy Service does not process the job unless the element is supported, otherwise the Copy Service processes the job with its best effort.

Figure 12 Copy Job Processing

The elements common to all Job Descriptions are described in the MFD specifications [MFD]. Those elements are identified in the above diagram as being included in the yellow box. The remaining elements are taken primarily from Print Job Processing with some coming from Scan Job Processing. These elements are described in the MFD specifications [MFD] as well.


474

475476477478479

480

481

482483484485486487488






9 Copy Service ConfigurationThe Subunits defined in [MFD] that are applicable to a Copy service are Console, Cover, Finisher, InputChannel, InputTray, Interface, Interpreter, Marker, MediaPath, OutputChannel, OutputTray, Processor, ScanMediaPath, Scanner, and Storage. There are no subunits specific to the only the Copy Service

Figure 13 Copy Service Configuration

10 Copy Service Theory of OperationThe Copy Service operates autonomously through three phases: initialization, online, and offline.

At power-up the Copy Service enters its initialization phase that initializes all its service attributes, connected subunits, may perform a self-test. After the initialization is successful, the Copy Service enters the “Down” state (an offline state) and performs a start-up operation that brings the service online, authenticates and registers its service with a service directory or announces its service to the network domain in which it resides. The Copy


489

490491492493494

495

496

497498

499

500501502503504505




Service then enters the “Idle” state and becomes ready for service discovery and accepting service requests from Copy Clients.

The Copy Service accepts new requests as long as it’s not disabled and is in one of the four states: Idle, Processing, Stopped, or Testing. Performing an administrative Disable() operation while in any state will stop the Copy Service from accepting new jobs. Performing an Enable() operation in any state while the Copy Service is disabled will enable new jobs to be accepted again.

A user submits a Copy Job through a local (via MFD UI) or remote (via local network or Internet) Copy Client to a selected target Copy Service that has the desired Copy capabilities. While the service is enabled, a Copy Client can request any Copy Service operations specified in Section 11. A Copy Client uses the CreateCopyJob operation to initiate a Copy Job on behalf of a user. The Copy Service places all submitted jobs in the ActiveJobs queue and schedules jobs for processing immediately or when a StartJob event is signaled based on job priority. A user may specify a JobHoldUntilTime for a remotely submitted job to allow ample time for user to walk up to the Scanner for placing his/her Hardcopy originals on the Scanner. An administrator can also put a job in the ActiveJobs queue on hold via a HoldCopyJob() operation preventing it being scheduled and a ReleaseJob() operation will release the job for scheduling again.

When a Copy Job is released for scheduling and reached the top of ActiveJobs queue, the Copy Service immediately enters its Processing state. During job processing, the Copy Service can be interrupted by a “PauseCopyService()” operation to enter the “Stopped” state. This allows a user to submit and process an urgent Copy Job or a job for another service, and a Resume() operation resumes previous Copy Job processing afterwards.

When there are critical conditions impacting Copy Serviceability during “Idle” or “Processing” state, either a C.Critical event is generated or an Administrative PauseCopyService() is performed to bring the service to the Stopped state. From there the condition can be fixed by user’s intervention. Then either the Copy Service generates a ~C.Critical event or an administrator performs a Resume() operation to bring the Copy Service back to “Idle” or “Processing” state. Otherwise, if the Copy Service needs a ShutdownCopyService() operation followed by a restart or ShutdownCopyService() for testing, both will require a StartupCopyService() operation to bring the service back to “Idle” state and then restart job processing again.

At any time all jobs in the ActiveJobs queue, whether being held, pending for scheduling, in processing, or being temporarily stopped from processing, can be canceled via a CancelCopyJob() operation by an authorized user. A canceled job, completed job, or an aborted job due to processing errors can be placed back into ActiveJobs queue and restarted via the administrative RestartJob() operation and be processed along with its Copy Documents again.[TBD]

11 Copy Service InterfacesThe Copy Service provides a set of service interfaces that is the same for a co-located local Copy Client or a Remote Copy Client via a local interface, a local area network, or the Internet. A user makes a Copy Service request by interacting directly with the Copy Service or indirectly through a local Copy Client via the MFD UI or a Remote Copy Client via its software application UI.

The requests below that are expected to have no parameters are defined as containing an extension point indicating that vendors may extend the request with additional information. Responses to operations that fail are expected to return a fault. Responses that are expected to have no parameters are defined as containing an extension point indicating that vendors may extend the request with additional information.

The semantics for these operations are the same as the operations specified in [MFD]. The only exception is for Create Copy Job (see below).


506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542

543

544545546547548549550551552553554555


This does not make sense. Pausing the service may allow other types of jobs to be processed but not a more urgent copy job. Do we intent to add a pause job operation?


11.1 Basic Copy Service Operations11.1.1 Cancel Copy Job This REQUIRED operation allows a client to cancel a Copy Job from the time the job is created up to the time it is completed, canceled, or aborted. Since a Job might already be Copying by the time a CancelCopyJob is received, some impressions might be printed before the job is actually terminated.

The Copy Service MUST follows the rules for accepting or rejecting the request based on the job's current state as described in [MFD].

Figure 14 Cancel Copy Job Request

Figure 15 Cancel Copy Job Response

11.1.2 Create Copy Job This REQUIRED operation allows a Copy Client to initiate a Copy Job on the Copy Service. Upon completion the Copy Job is available for scheduling unless a Job Processing instruction (e.g. JobHoldUntil) explicitly prevents it. Since a Copy Job does not contain any Copy Documents there is no need for any Send Document or Add URI operations and also no need to issue a Close Job operation to make the Copy Job available for scheduling. This is a slight change to the Create Job operations of other services.


556

557

558559560561562563564

565

566

567

568

569

570

571572573574575


Add reference


Figure 16 Create Copy Job Request

Figure 17 Create Copy Job Response

11.1.3 Get Active Copy JobsThis REQUIRED operation provides summary information on all Pending and Processing Copy Jobs.

Figure 18 Get Active Copy Jobs Request


576

577

578

579

580

581

582

583

584

585

586

587


Should the signature be specific and not allow extension


Figure 19 Get Active Copy Jobs Response

11.1.4 Get Copy Job Elements This REQUIRED operation allows a Copy Client to obtain detailed information on the specified Copy Job. The Client can request specific groups of elements contained within the Copy Job. The allowed values for RequestedElements are CopyJobReceipt, CopyJobStatus, or CopyJobTicket. Vendors may extend the allowed values.

Figure 20 Get Copy Job Elements Request


588

589

590

591

592593594595

596

597

598

599


Figure 21 Get Copy Job Elements Response

11.1.5 Get Copy Job HistoryThis OPTIONAL operation provides summary information on all Copy Jobs that have reached a terminating state (i.e. Completed, Canceled, Aborted).

Figure 22 GetCopyJobHistoryRequest


600

601

602603

604

605606

607

608

609

610


Figure 23 Get Copy Job History Response

11.1.6 Get Copy Service Elements This REQUIRED operation allows a Copy Client to obtain detailed information on the Copy Service. The Client can request specific group of elements contained within the Copy Service. The allowed values for Requested Elements are CopyServiceCapabilities, CopyServiceConfiguration, CopyServiceDescription, CopyServiceStatus or DefaultCopyJobTicket. Vendors may extend the allowed values.

Figure 24 Get Copy Service Elements Request


611

612

613

614

615616617618619

620

621

622


Figure 25 Get Copy Service Elements Response

11.1.7 Validate Copy TicketThis OPTIONAL operation is used to verify capabilities of a Copy Service against whatever CopyJobTicket elements are supplied by the client in the ValidateTicket request. By using the ValidateCopyTicket operation a client can validate that a CreateCopyJob with a CopyJobTicket would be accepted.The response indicates if there are any unsupported elements or values. An element returned without the supplied value indicates the element is not supported by the Copy Service. An element returned with the supplied value indicates that the specific value is not supported by the Copy Service. A fault is returned for requests that are not well formed or valid.


623

624

625

626

627

628629630631632633634


Figure 26 Validate Copy Job Ticket Request

Figure 27 Validate Copy JobTicket Response

11.2 Administrative Copy Service Operations11.2.1 Disable Copy ServiceThis operation prevents the Copy Service from accepting any new Copy Jobs (i.e. CreateCopyJob operation). The Copy Service is still able to process other operations. The Copy Service MUST follows the rules for accepting or rejecting the request based on the service’s current state as described in [MFD].

Figure 28 Disable Copy Service Request


635

636

637

638

639

640

641

642

643

644645646647648

649

650

651


Add reference


Figure 29 Disable Copy Service Response

11.2.2 Enable Copy ServiceThis operation allows a previously disabled Copy Service to accepting new Copy Jobs (i.e. CreateCopyJob operation). The Copy Service MUST follows the rules for accepting or rejecting the request based on the service’s current state as described in [MFD].

Figure 30 Enable Copy Service Request

Figure 31 Enable Copy Service Response

11.2.3 Hold Copy Job This OPTIONAL operation allows a client to hold a pending job in the queue so that it is not eligible for scheduling. If the HoldCopyJob operation is supported, then the ReleaseJob operation MUST be supported, and vice-versa. The OPTIONAL "JobHoldUntil" or "JobHoldUntilTime" parameter allows a client to specify whether to hold the job until a specified time, indefinitely or until a specified time period, if supported. The Copy Service MUST follows the rules for accepting or rejecting the request based on the job’s current state as described in [MFD]. .


652

653

654

655656657658

659

660

661

662

663

664

665

666667668669670671672


Add reference


Do we need HoldCopyJob givern the natur of Copying (i.e. usually only a single job queue depth) and the fact that hold can be specified at job creatioin?


Add reference


Figure 32 Hold Copy Job Request

Figure 33 Hold Copy Job Response

11.2.4 PauseCopyService This OPTIONAL operation allows a client to stop the Copy Service from scheduling jobs. Depending on implementation, the PauseCopyService operation MAY also stop the Copy Service from processing the current job. Any job that is currently being copied is either stopped as soon as the implementation permits or is completed, depending on implementation. The Copy Service MUST still accept CreateCopyJob operations to create new jobs, but MUST prevent any jobs from entering the 'Processing' state. If the PauseCopyService operation is supported, then the ResumeCopyService operation MUST be supported, and vice-versa.

The Copy Service stops the current job that is in the 'Processing' or 'ProcessingStopped' states as soon as the implementation permits. If the implementation will take appreciable time to stop, the Copy Service adds the ' MovingToPaused ' value to the Copy Service’s "StateReasons" element. When the Copy Service transitions to the 'Stopped' state, it removes the 'MovingToPaused' value, if present, and adds the 'Paused' value to the Copy Service’s "StateReasons" elemet. If the implementation permits the current job to stop in mid processing, the Copy Service transitions the Copy Job to the 'ProcessingStopped' state and adds the 'Stopped' value to the job's "JobStateReasons" element.

For any jobs that are 'pending' or 'pending-held', the ‘Stopped' value of the jobs' "JobStateReasons" element also applies. However, the Copy Service NEED NOT update those jobs' "JobStateReasons" element and only need return the 'Stopped' value when those jobs are queried (so-called "lazy evaluation").

The Copy Service MUST follows the rules for accepting or rejecting the request based on the service’s current state as described in [MFD]. .


673

674

675676

677

678

679

680

681682683684685686

687688689690691692693

694695696

697698699700


Add reference


Figure 34 Pause Copy Service Request

Figure 35 Pause Copy Service Response

11.2.5 Release Copy JobThis OPTIONAL operation allows a client to release a previously held job in the queue so that it is now eligible for scheduling. If the “ReleaseJob” operation is supported, then the “HoldCopyJob” operation MUST be supported, and vice-versa. The Copy Service MUST follows the rules for accepting or rejecting the request based on the job’s current state as described in [MFD]. .

Figure 36 Release Copy Job Request

Figure 37 Release Copy Job Response


701

702

703704

705

706

707

708

709710711712713

714

715

716717

718

719

720


Add reference


11.2.6 Resume Copy ServiceThis OPTIONAL operation allows a client to cause the Copy Service to begin scheduling jobs after it has been paused. If the ResumeCopyService operation is supported, then the PauseCopyService operation MUST be supported, and vice-versa.

Figure 38 Resume Copy Service Request

Figure 39 Resume Copy Service Response

11.2.7 Restart Copy ServiceThis OPTIONAL operation causes a Service in any state to be initialized and set to the Idle state, provided that no errors occur or conditions exist that would prevent normal operation.

Figure 40 Restart Copy Service Request


721

722723724

725

726

727

728

729

730

731

732

733734

735

736

737

738


Figure 41 Restart Copy Service Response

11.2.8 Shutdown Copy ServiceThis operation forces the Service to the ‘Down’ state from any state that it is in, in an orderly manner. The Service will stop accepting any further client requests, and it will complete the processing of any currently processing jobs as soon as the implementation allows but will stop scheduling jobs for processing immediately. Once down, the Service will no longer respond to any Client requests other than Restart Copy Service request.

Figure 42 Shutdown Copy Service Request

Figure 43 Shutdown Copy Service Response


739

740

741

742743

744

745746747748

749

750

751

752753

754

755

756


11.2.9 Startup Copy ServiceThis administrative operation causes a new instance of the Copy Service to begin initialization and then to move through the Down state to the Idle state, provided that no errors occur or conditions exist that would prevent normal operation

Figure 44 Startup Copy Service Request

Figure 45 Startup Copy Service Response

12 Conformance Requirements[TBD]

13 PWG and IANA Registration Considerations[TBD]

14 Internalization Considerations[TBD]

15 Security Considerations[TBD]


757

758759760

761

762

763

764

765

766

767

768

769

770

771

772

773

774


16 References

16.1 Normative References [PWG5100.5]

PWG 5100.5-2003, "Internet Printing Protocol (IPP): Document Object", October 31, 2003, D. Carney, T. Hastings, and P. Zehler, ftp://ftp.pwg.org/pub/pwg/candidates/cs-ippdocobject10-20031031-5100.5.pdf

[PWG5101.1] PWG 5101.1-2002 Media Standardized Names, February 26, 2002 ftp://ftp.pwg.org/pub/pwg/candidates/cs-pwgmsn10-20020226-5101.1.pdf

[PWG5100.3] PWG 5100.3-2001, "Internet Printing Protocol (IPP): Production Printing Attributes - Set1", February 12, 2001, K. Ocke, T. Hastings, ftp://ftp.pwg.org/pub/pwg/candidates/cs-ippprodprint10-20010212-5100.3.pdf

[PWG5100.5] PWG 5100.5-2003, "Internet Printing Protocol (IPP): Document Object", October 31, 2003, D. Carney, T. Hastings, and P. Zehler, ftp://ftp.pwg.org/pub/pwg/candidates/cs-ippdocobject10-20031031-5100.5.pdf

[PWG5106.1-2007] PWG 5106.1-2007, "The Printer Working Group (PWG) Standardized Imaging System Counters 1.1", April 27, 2007, H. Lewis, I. McDonald, J. Thrasher, W. Wagner, and P. Zehler, ftp://ftp.pwg.org/pub/pwg/candidates/cs-wimscount11-20070427-5106.1.pdf

[RFC 1696] J. Barnes, L. Brown, R. Royston, S. Waldbusser, “Modem Management Information Base (MIB) using SMIv2”, RFC 1696, August 1994.

[RFC2119] S. Bradner, “Key words for use in RFCs to Indicate Requirement Levels”, RFC 2119, March 1997.

[RFC 3712]P. Fleming, I. McDonald, “Lightweight Directory Access Protocol (LDAP): Schema for Printer Services”, RFC 3712, February 2004.

[RFC 2782]A. Gulbrandsen, P. Vixie, L. Esibov, ” A DNS RR for specifying the location of services (DNS SRV)”, RFC 2782, February 2000.

[rfc2911] RFC 2911 “Internet Printing Protocol/1.1 Model and Semantics”, September 2000, T. Hastings, R. Herriot, R. deBry, S. Isaacson, P. Powell, ftp://ftp.rfc-editor.org/in-notes/rfc2911.txt

[RFC 3805]R. Bergman, H. Lewis, I. McDonald, “Printer MIB v2”, RFC 3805, June 2004.

[rfc3066] RFC 3066 “Tags for the Identification of Languages”, January 2001, H. Alvestrand, http://www.ietf.org/rfc/rfc3066.txt

[rfc4395] RFC 4395 “Guidelines and Registration Procedures for New URI Schemes”, February 2006, T. Hansen, T. Hardie, L. Masinter, http://www.rfc-editor.org/rfc/rfc4395.txt


775

776

777778779

780781782

783784785

786787788789

790791792793

794795796

797798

799800801

802803804

805806807

808809

810811812

813814815

http://www.rfc-editor.org/rfc/rfc4395.txt

ftp://ftp.rfc-editor.org/in-notes/rfc2911.txt

ftp://ftp.pwg.org/pub/pwg/candidates/cs-ippdocobject10-20031031-5100.5.pdf


ftp://ftp.pwg.org/pub/pwg/candidates/cs-ippprodprint10-20010212-5100.3.pdf

ftp://ftp.pwg.org/pub/pwg/candidates/cs-pwgmsn10-20020226-5101.1.pdf



[WS-Copy] “Standard For Internet Printing Protocol "-actual" attributesVersion 1.0 For Web Services on Devices”, November 2006, Microsoft, M Fenelon, http://www.microsoft.com/whdc/connect/rally/wsdspecs.mspx

[Others TBD]

16.2 Informative References[prod-print2]

T. Hastings, and D. Fullman, “Internet Printing Protocol (IPP): Production Printing Attributes - Set 2”, August 21, 2002, ftp://ftp.pwg.org/pub/pwg/ipp/new_PPE/pwg-ipp-prod-print-set2-draft-v0_1-020821.pdf

[DES]FIPS PUB 46-3 Federal Information Processing Standards Publication “Data Encryption Standard

(DES)”, October 1999, http://csrc.nist.gov/publications/fips/fips46-3/fips46-3.pdf

[AES]FIPS PUB 197 Federal Information Processing Standards Publication 197 “Advanced Encryption

Standard (AES)”, November 2001, http://csrc.nist.gov/publications/fips/fips197/fips-197.pdf

[ECC] RFC 1321 “TLS Elliptic Curve Cipher Suites with SHA-256/384 and AES Galois Counter Mode”, May 2008, E. Rescorla, http://www.ietf.org/internet-drafts/draft-ietf-tls-ecc-new-mac-07.txt

[MD5] RFC 1321 “The MD5 Message-Digest Algorithm”, April 1992, R. Rivest, http://www.ietf.org/rfc/rfc1321.txt

[MD4] RFC 1320 “The MD4 Message-Digest Algorithm”, April 1992, R. Rivest, http://www.ietf.org/rfc/rfc1320.txt

[MD2] RFC 1319 “The MD2 Message-Digest Algorithm”, April 1992, B. Kaliski, http://www.ietf.org/rfc/rfc1319.txt

[SHA]FIPS PUB 180-1 Federal Information Processing Standards Publication 180-1 “Secure Hash

Standard”, April 1995, http://www.itl.nist.gov/fipspubs/fip180-1.htm

[CHMOD]The Open Group Base Specifications Issue 6 IEEE Std 1003.1 POSIX - chmod() function, 2004,

http://www.opengroup.org/onlinepubs/000095399/functions/chmod.html

[STAT]The Open Group Base Specifications Issue 6 IEEE Std 1003.1 POSIX - stat() function, 2004,

http://www.opengroup.org/onlinepubs/000095399/basedefs/sys/stat.h.html

17 Author’s AddressPeter ZehlerXerox Research Center WebsterEmail: [email protected]: (585) 265-8755


816817818

819

820

821

822823824

825826827

828829830

831832833

834835

836837

838839

840841842

843844845

846847848

849

850851852853

ftp://ftp.pwg.org/pub/pwg/ipp/new_PPE/pwg-ipp-prod-print-set2-draft-v0_1-020821.pdf

http://www.itl.nist.gov/fipspubs/fip180-1.htm

http://www.ietf.org/internet-drafts/draft-ietf-tls-ecc-new-mac-07.txt

http://csrc.nist.gov/publications/fips/fips197/fips-197.pdf

http://csrc.nist.gov/publications/fips/fips46-3/fips46-3.pdf

http://www.microsoft.com/whdc/connect/rally/wsdspecs.mspx


COPY: (585) 265-7441US Mail: Peter ZehlerXerox Corp.800 Phillips Rd.M/S 128-25EWebster NY, 14580-9701

Additional contributors: (Still to be updated)Nancy Chen – OkiDataLee Farrell – CannonIra McDonald – High NorthBill Wagner – TIC


854855856857858859860861862863864865866867