proj title of specification (acronym) - printer working...

The Printer Working Group

June 24, 2013Working Draft

PWG Semantic Model v2.0 (SM2)

Status: Interim DraftInitial

Abstract: This document is an update of the MFD Model and Common Semantics specification [PWG 5108.01-2011], extending the model from that of an MFD to a more generalized Imaging System. This specfiication describes the core attributes of all Imaging Services, with attributes unique to each Service discussed in Service specific separate sections. The Imaging Services addressed are Print, Scan, Fax-In, Fax-Out, Email-In, Email-Out, Transform, Resource and System Control.

This document is a PWG Working Draft. For a definition of a "PWG Working Draft", see: ftp://ftp.pwg.org/pub/pwg/general/pwg-process30.pdf This document is available electronically at: ftp://ftp.pwg.org/pub/pwg/mfd/wd/wd-pwgsemanticmodel20-20130624.pdf

Copyright © 2011-2013 The Printer Working Group. All rights reserved.

1

2

3

4

5

6

7

8

9

10

111213141516

17

18

19202122

ftp://ftp.pwg.org/pub/pwg/mfd/wd/wd-pwgsemanticmodel20-20120103.pdf

ftp://ftp.pwg.org/pub/pwg/mfd/wd/wd-pwgsemanticmodel20-20120103.pdf

ftp://ftp.pwg.org/pub/pwg/general/pwg-process30.pdf

Working Draft – PWG Semantic Model v2.0 June 24, 2013

Copyright © 2013 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 IEEE-ISTO and the Printer Working Group, a program of the IEEE-ISTO.

Title: PWG Semantic Model v2.0 (SM2)

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 takes 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 invites 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.

of 483 Copyright © 2011-2013 The Printer Working Group. All rights reserved.

1

23

24252627282930

31

32333435

363738

3940414243

44454647484950

51525354

555657

58

2


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-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 IEEE-ISTO PWG

The Printer Working Group (or PWG) is a Program of the IEEE Industry Standards and Technology Organization (ISTO) with member organizations including Printer manufacturers, Print server developers, operating system providers, network operating systems providers, network connectivity vendors, and Print management application developers. The group is chartered to make Printers and the applications and operating systems supporting them work together better. All references to the PWG in this document implicitly mean “The Printer Working Group, a Program of the IEEE ISTO.” In order to meet this objective, the PWG will document the results of their work as open standards that define Print related protocols, interfaces, procedures and conventions. Printer manufacturers and vendors of Printer related software will 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.

For additional information regarding the Printer Working Group visit:http://www.pwg.org

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


3

59

6061626364

65

66

67

6869707172737475767778

798081

8283

848586

8788

89

90

4

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

http://standards.ieee.org/)

http://www.ieee.org/


About the PWG Semantic Model Work Group

The Semantic Model Working Group is responsible for the modeling of the services - Print, Scan, Fax, Email, Resource, System Control, and Transform hosted on Imaging Systems . Standardization of the Imaging System model and semantics will support interoperability of devices and services in local, enterprise and cloud networks enabling improved Job submission, Job management, remote administration, and support. The goal of the PWG Semantic Model is to define a unified semantic model and set of abstract operations for common Service and device features of the Imaging System.

For additional information regarding PWG Semantic Model visit:http://www.pwg.org/mfd

Implementers of this specification are encouraged to join the Semantic Model mailing list in order to participate in any discussions of the specification. Suggested additions, changes, or clarification to this specification, should be sent to the [email protected] Mailing list for consideration.


5

91

92939495969798

99100

101102103104

6

Daniel Manchala, 06/03/13,

06/03/2013: Update the web site with this updated version of SM WG description.

mailto:[email protected]

http://www.pwg.org/mfd


Table of Contents

1. Introduction....................................................................................................................211.1 Scope.......................................................................................................................211.2 Background..............................................................................................................22

2. Terminology...................................................................................................................232.1 Conformance Terminology.......................................................................................232.2 Other Terminology...................................................................................................232.3 Acronyms and Organizations...................................................................................30

3. Requirements................................................................................................................313.1 Rationale..................................................................................................................313.2 Use Cases...............................................................................................................32

3.2.1 Basic Hardcopy Imaging Functions................................................................................323.2.2 Consideration of Subunits..............................................................................................323.2.3 Imaging Service Use Scenarios.....................................................................................33

3.2.3.1 Use Case 1: Create Job Template from a Remote Network Client Application.....................333.2.3.2 Use Case 2: Handling Multiple Hardcopy Documents from a Computer...............................343.2.3.3 Use Case 3: Walk-Up Batch-Scanned Input.........................................................................353.2.3.4 Use Case 4: Pause Service for Pre-emptive use of Subunits...............................................363.2.3.5 Use Case 5: Service Discovery.............................................................................................373.2.3.6 Use Case 6: Service Capability Discovery............................................................................383.2.3.7 Use Case 7: Cloud Imaging System Interfacing with Imaging Devices.................................39

3.3 Out of Scope............................................................................................................403.4 Design Requirements..............................................................................................40

3.4.1 Basic Operations............................................................................................................403.4.2 Requirements from Common Use of Subunits...............................................................413.4.3 Design Requirements from Use Cases..........................................................................42

3.4.3.1 System Requirements...........................................................................................................423.4.3.2 Service Requirements...........................................................................................................423.4.3.3 Service Related Requirements.............................................................................................423.4.3.4 Document Related Requirements.........................................................................................43

4. Model Concepts.............................................................................................................444.1 Model Notation.........................................................................................................44

4.1.1 Model Conventions.........................................................................................................444.1.1.1 Element, Operation and Attribute Name Representation......................................................444.1.1.2 “Any” Element and “Any” Attribute Extensions......................................................................444.1.1.3 Representation of Mandatory versus Optional Elements and Number of Instances...........454.1.1.4 Representation of Exclusive Or.............................................................................................45

4.1.2 Datatypes.......................................................................................................................454.2 System Object..........................................................................................................48

4.2.1 Overview of Services......................................................................................................494.2.2 SystemConfiguration......................................................................................................504.2.3 SystemDescription.........................................................................................................504.2.4 SystemStatus.................................................................................................................52

4.3 Primary Service Interfaces.......................................................................................564.4 Functional Overview of an Imaging System.............................................................584.5 Jobs, Documents, Tickets, Receipts and Templates...............................................604.6 Job and Job Ticket Life Cycle..................................................................................61


7

105

106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151

8


5. System Configuration....................................................................................................655.1 Common Subunit Elements.....................................................................................68

5.1.1 Common Subunit Status Elements................................................................................695.1.1.1 Power Counters.................................................................................................................... 705.1.1.2 Power Meters........................................................................................................................ 715.1.1.3 Power Monitor....................................................................................................................... 725.1.1.4 Power Support...................................................................................................................... 735.1.1.5 Power Transition................................................................................................................... 74

5.1.2 Common Subunit Description Elements.........................................................................755.1.2.1 Power Calendar.................................................................................................................... 765.1.2.2 Power Event.......................................................................................................................... 775.1.2.3 Power Timeout...................................................................................................................... 77

5.2 Consoles..................................................................................................................785.3 Covers......................................................................................................................815.4 FaxModems.............................................................................................................835.5 Finishers..................................................................................................................875.6 Input Channels.........................................................................................................935.7 Input Trays...............................................................................................................965.8 Interfaces...............................................................................................................1005.9 Interpreters.............................................................................................................1055.10 Marker..................................................................................................................1075.11 Media Paths.........................................................................................................1135.12 Output Channels..................................................................................................1155.13 Output Trays........................................................................................................1185.14 Processors...........................................................................................................1215.15 Scan Media Paths................................................................................................1225.16 Scanners..............................................................................................................1255.17 Storages...............................................................................................................1295.18 Vendor Subunits..................................................................................................131

6. Imaging Service Element Groups................................................................................1346.1 Job Table...............................................................................................................1356.2 Service Available Job Ticket..................................................................................1366.3 Service Capabilities and Service Capabilities Ready.............................................1376.4 Service Job and Document Ticket Document Processing Capabilities..................139

6.4.1.1 Media Collection Supported................................................................................................1486.4.2 Service Document Ticket Document Description Capabilities.....................................1516.4.3 Service Job Ticket Job Processing Capabilities...........................................................155

6.5 Service Configuration.............................................................................................1626.6 Service Defaults.....................................................................................................1626.7 Service Description................................................................................................164

6.7.1 OwnerURI.....................................................................................................................1676.7.2 OwnerVCard.................................................................................................................1676.7.3 MultipleOperationTimeoutAction..................................................................................167

6.8 Service Status........................................................................................................1716.8.1 Condition Table............................................................................................................1746.8.2 Relationship among Service State, Service State Reasons, Condition Table and Service State Message Elements.........................................................................................176


9

152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198

10


6.9 Service Counters and Timers................................................................................1776.9.1 Work Counters (WorkTotals, DataStream, Auxiliary, Waste and Maintenance)..........1796.9.2 MediaUsed Counters....................................................................................................182

6.10 Availability Counters............................................................................................1846.10.1 Monitoring Counters...................................................................................................184

7. Imaging Job Element Groups......................................................................................1867.1 Job Status..............................................................................................................187

7.1.1 JobOriginatingUri..........................................................................................................1917.2 Job Ticket...............................................................................................................194

7.2.1 Job Ticket Document Processing.................................................................................1947.2.1.1 Header Print........................................................................................................................ 2037.2.1.2 Media Collection (Specific)..................................................................................................208

7.2.2 Job Ticket Job Description...........................................................................................2117.2.3 JobTicket Job Processing............................................................................................216

7.2.3.1 Description of DestinationUris’ Elements............................................................................2187.2.3.2 Description of ConfirmationSheet Print Element.................................................................2197.2.3.3 Description of CoverSheetInfo’s Elements..........................................................................2197.2.3.4 Description of RetryInfo’s Elements....................................................................................220

7.3 Job Receipt............................................................................................................2297.4 Job Description......................................................................................................229

8. Imaging Document Element Groups............................................................................2308.1 Document Status...................................................................................................2308.2 Document Ticket....................................................................................................237

8.2.1 Document Description..................................................................................................2378.2.2 Document Processing..................................................................................................240

8.3 Document Receipt.................................................................................................2409. Imaging Service Operations and States......................................................................241

9.1 General Service Sequence of Operation...............................................................2419.1.1 Initialization and Startup...............................................................................................2429.1.2 Job Creation.................................................................................................................2429.1.3 Job Processing.............................................................................................................2439.1.4 Service Pause, Service Shutdown and Abnormal Job Termination.............................244

9.2 Service, Job and Document States........................................................................2449.2.1 Service States, Conditions and State Transitions........................................................244

9.2.1.1 Service States..................................................................................................................... 2459.2.1.2 Operations, Events and Conditions.....................................................................................2459.2.1.3 Service State Transition by Operations...............................................................................2489.2.1.4 Service State Transition and Condition Change by Events.................................................249

9.2.2 Job States and State Transitions.................................................................................2509.2.3 Document States and State Transitions.......................................................................251

9.3 Service Operations................................................................................................2539.3.1 Basic Service Operations.............................................................................................259

9.3.1.1 Add HardcopyDocument.....................................................................................................2599.3.1.2 CancelDocument................................................................................................................2599.3.1.3 Cancel Job.......................................................................................................................... 2609.3.1.4 CancelCurrent Job..............................................................................................................2619.3.1.5 CancelMy Jobs................................................................................................................... 2619.3.1.6 Close Job............................................................................................................................ 2629.3.1.7 Create Job.......................................................................................................................... 262


11

199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247

12


9.3.1.8 Get<Service>DocumentElements.......................................................................................2639.3.1.9 Get Documents................................................................................................................... 2649.3.1.10 Get JobElements..............................................................................................................2649.3.1.11 Get Jobs............................................................................................................................ 2649.3.1.12 Get ServiceElements........................................................................................................2649.3.1.13 GetActive Jobs.................................................................................................................. 2659.3.1.14 Hold Job............................................................................................................................ 2659.3.1.15 Release Job...................................................................................................................... 2669.3.1.16 Resubmit Job.................................................................................................................... 2669.3.1.17 ResumeJob....................................................................................................................... 2679.3.1.18 SendDocument................................................................................................................. 2679.3.1.19 SendUri............................................................................................................................. 2689.3.1.20 SetDocumentElements.....................................................................................................2699.3.1.21 SetJobElements................................................................................................................2709.3.1.22 SuspendCurrentJob..........................................................................................................271

9.3.2 Administrative Service Operations...............................................................................2729.3.2.1 CancelJobs......................................................................................................................... 2759.3.2.2 DisableService.................................................................................................................... 2759.3.2.3 EnableService..................................................................................................................... 2769.3.2.4 HoldNewJobs...................................................................................................................... 2769.3.2.5 PauseService...................................................................................................................... 2769.3.2.6 PauseServiceAfterCurrentJob.............................................................................................2779.3.2.7 PromoteJob......................................................................................................................... 2789.3.2.8 ReleaseNewJobs................................................................................................................2789.3.2.9 RestartService.................................................................................................................... 2799.3.2.10 ResumeService................................................................................................................. 2799.3.2.11 SetServiceElements..........................................................................................................2809.3.2.12 ShutdownService..............................................................................................................280

10. Print Service..............................................................................................................28210.1 Print Service Model..............................................................................................282

10.1.1 Print ServiceCapabilities............................................................................................28310.1.2 Print ServiceCapabilitiesReady..................................................................................28510.1.3 Print ServiceConfiguration..........................................................................................28510.1.4 Print ServiceDefaults..................................................................................................28510.1.5 Print ServiceDescription.............................................................................................28610.1.6 Print ServiceStatus.....................................................................................................28610.1.7 PrintJob Model...........................................................................................................28610.1.8 PrintJobReceipt..........................................................................................................28710.1.9 PrintJobStatus............................................................................................................28710.1.10 PrintJobTicket...........................................................................................................28710.1.11 PrintDocumentProcessing........................................................................................28710.1.12 PrintJobDescription..................................................................................................28810.1.13 PrintJobProcessing..................................................................................................28810.1.14 Print Service Interfaces............................................................................................289

10.2 Conformance.......................................................................................................28911. Scan Service.............................................................................................................290

11.1 ScanService Model Overview..............................................................................29011.1.1 ScanServiceDefaults..................................................................................................29011.1.2 ScanServiceCapabilities.............................................................................................29011.1.3 ScanServiceCapabilitiesReady..................................................................................29011.1.4 ScanServiceConfiguration..........................................................................................290


13

248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298

14


11.1.5 ScanServiceDescription.............................................................................................29011.1.6 ScanServiceStatus.....................................................................................................290

11.2 ScanJob Model....................................................................................................29011.2.1 ScanJobReceipt.........................................................................................................29011.2.2 ScanJobStatus...........................................................................................................29011.2.3 ScanJobTicket............................................................................................................29011.2.4 ScanDocumentProcessing.........................................................................................29011.2.5 ScanJobDescription...................................................................................................29011.2.6 ScanJobProcessing....................................................................................................290

11.3 ScanDocument Model..........................................................................................29011.3.1 ScanDocumentReceipt...............................................................................................29011.3.2 ScanDocumentStatus.................................................................................................29011.3.3 ScanDocumentTicket.................................................................................................29011.3.4 ScanDocumentDescription.........................................................................................29011.3.5 ScanDocumentProcessing.........................................................................................290

11.4 ScanService Interfaces........................................................................................29011.5 Conformance.......................................................................................................290

12. FaxIn..........................................................................................................................29112.1 FaxInService Model Overview.............................................................................291

12.1.1 AvailableFaxInJobTicket............................................................................................29312.1.2 FaxInServiceDefaults.................................................................................................29412.1.3 FaxInServiceCapabilities............................................................................................29512.1.4 FaxInServiceCapabilitiesReady.................................................................................29712.1.5 FaxInServiceConfiguration.........................................................................................29712.1.6 FaxInServiceDescription............................................................................................29812.1.7 FaxInServiceStatus....................................................................................................300

12.2 FaxInJob Model...................................................................................................30212.2.1 FaxInJob Lifecycle:.....................................................................................................30212.2.2 FaxInJobReceipt........................................................................................................30412.2.3 FaxInJobStatus..........................................................................................................30412.2.4 FaxInJobTicket...........................................................................................................30612.2.5 FaxInJobDescription...................................................................................................30612.2.6 FaxInJobProcessing...................................................................................................307

12.3 FaxInDocument Model.........................................................................................30812.3.1 FaxInDocumentReceipt..............................................................................................30912.3.2 FaxInDocumentStatus................................................................................................30912.3.3 FaxInDocumentTicket................................................................................................31112.3.4 FaxInDocumentDescription........................................................................................31112.3.5 FaxInDocumentProcessing........................................................................................312

12.4 FaxInService Subunits.........................................................................................31412.5 FaxInService Interfaces.......................................................................................31412.6 Conformance.......................................................................................................317

13. FaxOut.......................................................................................................................31813.1 FaxOutService Model Overview...........................................................................318

13.1.1 FaxOutServiceDefaults..............................................................................................32113.1.2 FaxOutServiceCapabilities.........................................................................................32113.1.3 FaxOutServiceCapabilitiesReady...............................................................................32413.1.4 FaxOutServiceConfiguration......................................................................................324


15

299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346

16


13.1.5 FaxOutServiceDescription..........................................................................................32513.1.6 FaxOutServiceStatus.................................................................................................327

13.2 FaxOutJob Model.................................................................................................32913.2.1 FaxOutJobReceipt......................................................................................................33013.2.2 FaxOutJobStatus........................................................................................................33013.2.3 FaxOutJobTicket........................................................................................................33213.2.4 FaxOutDocumentProcessing.....................................................................................33213.2.5 FaxOutJobDescription................................................................................................33313.2.6 FaxOutJobProcessing................................................................................................335

13.2.6.1 DestinationUris.................................................................................................................. 33613.3 FaxOutDocument Model......................................................................................337

13.3.1 FaxOutDocumentReceipt...........................................................................................33713.3.2 FaxOutDocumentStatus.............................................................................................33813.3.3 FaxOutDocumentTicket..............................................................................................34013.3.4 FaxOutDocumentDescription.....................................................................................34013.3.5 FaxOutDocumentProcessing.....................................................................................341

13.4 FaxOutService Interfaces....................................................................................34213.5 Conformance.......................................................................................................346

14. EmailIn Service..........................................................................................................34614.1 EmailInService Model Overview..........................................................................346

14.1.1 EmailInServiceDefaults..............................................................................................34614.1.2 EmailInServiceCapabilities.........................................................................................34614.1.3 EmailInServiceCapabilitiesReady..............................................................................34614.1.4 EmailInServiceConfiguration......................................................................................34614.1.5 EmailInServiceDescription.........................................................................................34614.1.6 EmailInServiceStatus.................................................................................................346

14.2 EmailInJob Model................................................................................................34614.2.1 EmailInJobReceipt.....................................................................................................34614.2.2 EmailInJobStatus.......................................................................................................34614.2.3 EmailInJobTicket........................................................................................................34614.2.4 EmailInDocumentProcessing.....................................................................................34614.2.5 EmailInJobDescription................................................................................................34614.2.6 EmailInJobProcessing................................................................................................346

14.3 EmailInDocument Model......................................................................................34614.3.1 EmailInDocumentReceipt...........................................................................................34614.3.2 EmailInDocumentStatus.............................................................................................34614.3.3 EmailInDocumentTicket.............................................................................................34614.3.4 EmailInDocumentDescription.....................................................................................34614.3.5 EmailInDocumentProcessing.....................................................................................346

14.4 EmailInService Interfaces....................................................................................34614.5 Conformance.......................................................................................................347

15. EmailOut Service.......................................................................................................34815.1 EmailOutService Model Overview........................................................................348

15.1.1 EmailOutServiceDefaults...........................................................................................34815.1.2 EmailOutServiceCapabilities......................................................................................34815.1.3 EmailOutServiceCapabilitiesReady............................................................................34815.1.4 EmailOutServiceConfiguration...................................................................................34815.1.5 EmailOutServiceDescription.......................................................................................348


17

347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394

18


15.1.6 EmailOutServiceStatus..............................................................................................34815.2 EmailOutJob Model..............................................................................................348

15.2.1 EmailOutJobReceipt...................................................................................................34815.2.2 EmailOutJobStatus.....................................................................................................34815.2.3 EmailOutJobTicket.....................................................................................................34815.2.4 EmailOutDocumentProcessing..................................................................................34815.2.5 EmailOutJobDescription.............................................................................................34815.2.6 EmailOutJobProcessing.............................................................................................348

15.3 EmailOutDocument Model...................................................................................34815.3.1 EmailOutDocumentReceipt........................................................................................34815.3.2 EmailOutDocumentStatus..........................................................................................34815.3.3 EmailOutDocumentTicket...........................................................................................34815.3.4 EmailOutDocumentDescription..................................................................................34815.3.5 EmailOutDocumentProcessing..................................................................................348

15.4 EmailOutService Interfaces.................................................................................34815.5 Conformance.......................................................................................................348

16. Transform Service.....................................................................................................35016.1.1 TransformServiceDefaults..........................................................................................35216.1.2 TransformServiceCapabilities....................................................................................35316.1.3 TransformServiceCapabilitiesReady..........................................................................35516.1.4 TransformServiceConfiguration..................................................................................35516.1.5 TransformServiceDescription.....................................................................................35616.1.6 TransformServiceStatus.............................................................................................358

16.2 TransformJob Model............................................................................................36016.2.1 TransformJobReceipt.................................................................................................36116.2.2 TransformJobStatus...................................................................................................36116.2.3 TransformJobTicket....................................................................................................363

16.2.3.1 TransformDocumentProcessing........................................................................................36316.2.3.2 TransformJobDescription..................................................................................................36516.2.3.3 TransformJobProcessing..................................................................................................367

16.3 TransformDocument Model.................................................................................36816.3.1 TransformDocumentReceipt......................................................................................36816.3.2 TransformDocumentStatus........................................................................................36916.3.3 TransformDocumentTicket.........................................................................................371

16.3.3.1 TransformDocumentDescription.......................................................................................37116.3.3.2 TransformDocumentProcessing........................................................................................372

16.4 TransformService Interfaces................................................................................37316.5 Conformance.......................................................................................................378

17. Resource...................................................................................................................37917.1 Resource Service Model Overview......................................................................38017.2 Resource Service Model Description...................................................................382

17.2.1 Data Types.................................................................................................................38217.2.2 Resource Service Configuration.................................................................................382

17.2.2.1 Storage............................................................................................................................. 38417.2.3 Resource Service Description....................................................................................386

17.2.3.1 OwnerURI......................................................................................................................... 38717.2.3.2 OwnerVCard..................................................................................................................... 38717.2.3.3 ResourcesSupported........................................................................................................38717.2.3.4 ServiceInfo........................................................................................................................ 387


19

395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443

20


17.2.3.5 ServiceLocation................................................................................................................38717.2.3.6 ServiceName.................................................................................................................... 38717.2.3.7 ServiceURISupported.......................................................................................................38717.2.3.8 Sequence of ##other.........................................................................................................38717.2.3.9 Attribute of ##other............................................................................................................387

17.2.4 Resource Service Capability......................................................................................38817.2.4.1 List of ##other................................................................................................................... 38817.2.4.2 Resource Description Capabilities....................................................................................388

17.2.5 Resource Service Status............................................................................................39017.2.6 Service State Transition Tables.................................................................................39317.2.7 Service State Transition By Operations.....................................................................39417.2.8 Service State Transition By Events............................................................................395

17.2.8.1 Detailed Service State Transition Diagram.......................................................................39617.2.9 Condition Table..........................................................................................................397

17.2.9.1 Active Conditions..............................................................................................................39817.2.9.2 Conditions History.............................................................................................................400

17.2.10 Resource List...........................................................................................................40118. System Control Service.............................................................................................408

18.1.1 SystemControlService Model.....................................................................................40818.1.2 SystemControlServiceDescription..............................................................................40918.1.3 SystemControlServiceStatus......................................................................................41118.1.4 SystemControlService Operations.............................................................................412

18.1.4.1 DeleteService.................................................................................................................... 41518.1.4.2 DisableAllServices............................................................................................................41518.1.4.3 EnableAllServices.............................................................................................................41518.1.4.4 GetSystemElements.........................................................................................................41518.1.4.5 ListAllServices................................................................................................................... 41718.1.4.6 PauseAllServices..............................................................................................................41718.1.4.7 PauseAllServicesAfterCurrentJob.....................................................................................41818.1.4.8 RestartAllServices.............................................................................................................41818.1.4.9 RestartService.................................................................................................................. 41818.1.4.10 ResumeAllServices.........................................................................................................41918.1.4.11 ShutdownAllServices......................................................................................................41918.1.4.12 ShutdownService............................................................................................................41918.1.4.13 StartupAllServices...........................................................................................................41918.1.4.14 StartupService................................................................................................................42018.1.4.15 SetSystemElements........................................................................................................420

19. Conformance Requirements......................................................................................42320. Internationalization Considerations............................................................................42321. Security Considerations.............................................................................................42322. IANA Considerations.................................................................................................42423. PWG Registration Considerations.............................................................................42424. References................................................................................................................424

24.1 Normative References.........................................................................................42424.2 Informative References........................................................................................430

25. Authors' Addresses....................................................................................................43026. Appendix A: PWG SMv2 Elements’ Semantic information........................................43227. Appendix B: Service Capabilities...............................................................................45928. Appendix C: Keyword Well-Known Values................................................................46229. Appendix D: Keyword Value extension patterns........................................................471


21

444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493

22


30. Appendix D – IPP Mapping........................................................................................47230.1 Changes to remove some IPP specific aspects...................................................47230.2 Attribute Group Mapping......................................................................................473

31. Image Terms and Conventions..................................................................................47531.1 Content Region and Images................................................................................475

31.1.1 Content Region..........................................................................................................47531.1.2 Job/Document Object and Digital Document Cardinality...........................................476

31.2 Coordinate Systems.............................................................................................47831.2.1 Coordinate Nomenclature..........................................................................................47831.2.2 Content Coordinate Systems.....................................................................................478

31.2.2.1 Scan and Marker Subunit Media Content Coordinates.....................................................47831.2.2.2 Service Coordinates..........................................................................................................48031.2.2.3 Document Format Coordinates.........................................................................................480

32. Change Log...............................................................................................................48332.1 January 3, 2012...................................................................................................48332.2 January 9, 2012...................................................................................................48332.3 June 3, 2013........................................................................................................48332.4 June 15, 2013......................................................................................................48332.5 June 24, 2013......................................................................................................483

List of Figures

Figure 1 Element Extension Symbol..................................................................................47Figure 2 Attribute Extension Symbol.................................................................................48Figure 3 Conditionally Mandatory Element........................................................................48Figure 4 Optional Element.................................................................................................48Figure 5 System Object.....................................................................................................53Figure 6 - Imaging System Services..................................................................................54Figure 7 SystemDescription...............................................................................................55Figure 8 SystemStatus......................................................................................................58Figure 9 Primary Interfaces with Services.........................................................................61Figure 10 Relationships within a Multifunction Device.......................................................63Figure 11 UML Diagram Showing Relationships Relative to Job Ticket............................67Figure 12 Elements in System Configuration....................................................................70Figure 13 SubunitStatus Elements....................................................................................73Figure 14 Power Counters Schema...................................................................................74Figure 15 Power Meters Schema......................................................................................76Figure 16 Power Monitor Schema.....................................................................................76Figure 17 Power Support Schema.....................................................................................78Figure 18 Power Transition Schema.................................................................................79Figure 19 Subunit Description Schema.............................................................................80Figure 20 Power Calendar Schema...................................................................................81Figure 21 Power Event Schema........................................................................................82Figure 22 Power Timeout Schema....................................................................................83


23

494495496497498499500501502503504505506507508509510511512513514

515

516517518519520521522523524525526527528529530531532533534535536537

24


Figure 23 Console Subunit Schema..................................................................................85Figure 24 Console Lights Schema.....................................................................................87Figure 25 Cover Subunit Schema......................................................................................88Figure 26 FaxModem........................................................................................................89Figure 27 FaxModem Description......................................................................................90Figure 28 FaxModem Status.............................................................................................92Figure 29 Finisher..............................................................................................................93Figure 30 FinisherDescription............................................................................................94Figure 31 FinisherStatus...................................................................................................95Figure 32 FinisherSupply...................................................................................................97Figure 33 FinisherSupplyMediaInput.................................................................................98Figure 34 Input Tray........................................................................................................102Figure 35 Input Tray Description.....................................................................................103Figure 36 Input Tray Status.............................................................................................105Figure 37 Interface..........................................................................................................106Figure 38 InterfaceDescription.........................................................................................107Figure 39 InterfaceStatus................................................................................................108Figure 40 Interpreter........................................................................................................111Figure 41 Marker Schema...............................................................................................113Figure 42 MarkerDescription Schema.............................................................................113Figure 43 MarkerStatus Schema.....................................................................................114Figure 44 Marker Colorant Schema.................................................................................116Figure 45 Marker Supply.................................................................................................117Figure 46 Media Path......................................................................................................118Figure 47 MediaPathDescription.....................................................................................119Figure 48 MediaPathStatus.............................................................................................119Figure 49 Output Channel...............................................................................................121Figure 50 Output Tray.....................................................................................................123Figure 51 Output Tray Description...................................................................................123Figure 52 Output Tray Status..........................................................................................124Figure 53 Processor........................................................................................................126Figure 54 Scan Media Path.............................................................................................128Figure 55 Scanner...........................................................................................................131Figure 56 Scanner Addressability....................................................................................132Figure 57 Scanner Margin...............................................................................................133Figure 58 Storage............................................................................................................135Figure 59 Vendor Subunit................................................................................................137Figure 60 Abstract Imaging Service Structure.................................................................140Figure 61 Imaging Job Table...........................................................................................141Figure 62 Imaging Job Model..........................................................................................141Figure 63 Imaging Service Available Job Ticket..............................................................142Figure 64 Imaging Service Capabilities...........................................................................144Figure 65 Imaging Document Processing Capabilities....................................................145Figure 66 Representative Service-Specific Document Processing Capabilities (Scan Service)...........................................................................................................................146


25

538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582

26


Figure 67 Print Document Capabilities............................................................................150Figure 68 Media Col Structure.........................................................................................155Figure 69 Imaging Service Job Description Capabilities.................................................157Figure 70 Print Service Specific Job Description Capabilities.........................................159Figure 71 Document Format Details Structure................................................................160Figure 72 Imaging Service Job Processing Capabilities..................................................161Figure 73 Representative Service-Specific JobProcessingCapabilities Elements (FaxOut Service Examples)...........................................................................................................163Figure 74 Imaging Service Defaults.................................................................................168Figure 75 Basic Document Ticket Default.......................................................................169Figure 76 Imaging Service Job Ticket Defaults...............................................................169Figure 77 Imaging Service Description............................................................................172Figure 78 Representative Service-Specific Service Description (FaxOut).......................174Figure 79 Detail of DocumentFormatDetailsDefault........................................................176Figure 80 Imaging Service Status....................................................................................178Figure 81 Condition Table...............................................................................................181Figure 82 System Counters.............................................................................................185Figure 83 Counters, Showing the Derivation of Service Totals and System Totals.........187Figure 84 Work Counter Counts Type.............................................................................188Figure 85 Media Used Counters......................................................................................190Figure 86 Availability Counters........................................................................................191Figure 87 Monitoring Counts...........................................................................................192Figure 88 Imaging Job.....................................................................................................195Figure 89 Imaging Job Status..........................................................................................196Figure 90 Job Originating User Authentication Info.........................................................199Figure 91 Representative Service-Specific Job Status Elements....................................200Figure 92 Imaging Job Ticket..........................................................................................202Figure 93 JobTicket Superclass DocumentProcessing...................................................203Figure 94 JobTicket DocumentProcessing - Image Output Services Sheet 1.................204Figure 95 JobTicket DocumentProcessing - Image Output Services Sheet 2.................205Figure 96 JobTicket DocumentProcessing - Image Output Services MediaBox.............206Figure 97 JobTicket DocumentProcessing - Impression Output Services Sheet 1.........211Figure 98 JobTicket DocumentProcessing – Impression Output Services Sheet 2.........211Figure 99 JobTicket DocumentProcessing – Impression Output Services Sheet 3.........211Figure 100 Media Col Structure Specific.........................................................................217Figure 101 ImagingJobDescription (Superclass).............................................................220Figure 102 Representative Service-Specific Job Ticket Job Description Elements ( Print Service)...........................................................................................................................222Figure 103 Superclass Job Processing Elements...........................................................225Figure 104 Representative Service-Specific Job Processing Elements (FaxOut Service) Sheet 1............................................................................................................................229Figure 105 Representative Service-Specific Job Processing Elements (FaxOut Service) Sheet 2............................................................................................................................230Figure 106 Representative Service-Specific Job Processing Elements (Copy Service) Sheet 1............................................................................................................................230


27

583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627

28


Figure 107 Representative Service-Specific Job Processing Elements (Copy Service) Sheet 2............................................................................................................................230Figure 108 Imaging Document Model..............................................................................236Figure 109 Imaging Document Status.............................................................................238Figure 110 Service-Specific Document Status Elements................................................241Figure 111 Imaging Document Ticket..............................................................................243Figure 112 Imaging Document Description.....................................................................243Figure 113 Service-Specific Document Description Elements.........................................244Figure 114 Service State Model......................................................................................247Figure 115 Service State Transitions and Causal Events...............................................252Figure 116 Job State Transition.......................................................................................257Figure 117 Document State Transition............................................................................258Figure 118 - High Level FaxInService Schema...............................................................295Figure 119 - AvailableFaxInJobTicket.............................................................................298Figure 120 - FaxInServiceDefaults..................................................................................298Figure 121 - FaxInServiceCapabilities.............................................................................300Figure 122 - FaxInServiceConfiguration..........................................................................302Figure 123 - FaxInServiceDescription.............................................................................304Figure 124 - FaxInServiceStatus.....................................................................................305Figure 125 - FaxInJobTable............................................................................................306Figure 126 – High Level FaxInJob View..........................................................................308Figure 127 - FaxInJobStatus...........................................................................................311Figure 128 - FaxInJobTicket............................................................................................311Figure 129 - FaxInJobDescription....................................................................................312Figure 130 - FaxInJobProcessing....................................................................................313Figure 131 – High Level FaxInDocument View...............................................................314Figure 132 - FaxInDocumentStatus.................................................................................315Figure 133 - FaxInDocumentTicket.................................................................................316Figure 134 - FaxInDocumentDescription.........................................................................317Figure 135 - FaxInDocumentProcessing.........................................................................318Figure 136 High Level FaxOutService Schema...............................................................324Figure 137 FaxOutServiceDefaults..................................................................................326Figure 138 FaxOutServiceCapabilities............................................................................327Figure 139 FaxOutServiceConfiguration.........................................................................330Figure 140 FaxOutServiceDescription.............................................................................332Figure 141 FaxOutServiceStatus.....................................................................................333Figure 142 JobTable........................................................................................................334Figure 143 High Level FaxOutJob View..........................................................................335Figure 144 FaxOutJobStatus...........................................................................................336Figure 145 FaxOutJobTicket...........................................................................................337Figure 146 FaxOutDocumentProcessing.........................................................................338Figure 147 FaxOutJobDescription...................................................................................340Figure 148 FaxOutJobProcessing...................................................................................341Figure 149 High Level FaxOutDocument View................................................................343Figure 150 FaxOutDocumentStatus................................................................................344


29

628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672

30


Figure 151 FaxOutDocumentTicket.................................................................................345Figure 152 FaxOutDocumentDescription........................................................................346Figure 153 High Level TransformService Schema..........................................................355Figure 154 TransformServiceDefaults.............................................................................358Figure 155 TransformServiceCapabilities........................................................................359Figure 156 TransformServiceConfiguration.....................................................................361Figure 157 TransformServiceDescription........................................................................362Figure 158 TransformServiceStatus................................................................................364Figure 159 JobTable........................................................................................................365Figure 160 High Level TransformJob View......................................................................366Figure 161 TransformJobStatus......................................................................................367Figure 162 TransformJobTicket.......................................................................................368Figure 163 TransformDocumentProcessing....................................................................369Figure 164 TransformJobDescription..............................................................................371. Figure 165 TransformJobProcessing.............................................................................372Figure 166 High Level TransformDocument View...........................................................373Figure 167 TransformDocumentStatus............................................................................374Figure 168 TransformDocumentTicket............................................................................375Figure 169 TransformDocumentDescription....................................................................376Figure 170 Resource Service Top Level Architecture................................................383Figure 171 High Level Resource Service Schema..........................................................385Figure 172 Resource Service Configuration Schema......................................................387Figure 173 Storage Subunit Schema...............................................................................388Figure 174 Resource Service Description Schema.........................................................391Figure 175 Resource Service Capability Schema...........................................................392Figure 176 Resource Service Status Schema.................................................................395Figure 177 Detailed Service Transition Diagram.............................................................401Figure 178 Condition Table.............................................................................................403Figure 179 Active Conditions...........................................................................................404Figure 180 Condition History...........................................................................................406Figure 181 ResourceList Top Level Schema...................................................................407Figure 182 Resource Description Schema......................................................................408Figure 183 Resource Status Schema..............................................................................411Figure 184 SystemControlService...................................................................................414Figure 185 SystemControlServiceDescription.................................................................415Figure 186 SystemControlServiceStatus.........................................................................416Figure 187 Association Types.........................................................................................421Figure 188 Scan Region Element....................................................................................471Figure 189 Hardcopy Document, Region, Image Relationsh...........................................472Figure 190 Document Cardinality....................................................................................473Figure 191 Scanner or Marker Coordinates....................................................................475Figure 192 Service Scan Coordinates.............................................................................476Figure 193 Document Format coordinates......................................................................477


31

673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715

716

32


List of Tables

Table 1 PWG Semantic Model Terminology......................................................................23Table 2 Imaging System Common Operations..................................................................43Table 2 Basic Element Datatypes......................................................................................49Table 1 SystemDescription Elements................................................................................56Table 2 Optimistic Status Roll-up......................................................................................56Table 3 SystemStatus Elements........................................................................................59Table 3 Subunits................................................................................................................70Table 4 Description of SubunitStatus Elements................................................................73Table 5 Power Counter Elements......................................................................................74Table 6 Power Meter Elements.........................................................................................76Table 7 Power Monitor Elements.......................................................................................76Table 8 Power Support Elements......................................................................................78Table 9 Power Transition Elements...................................................................................79Table 10 Description of Subunit Description Elements......................................................80Table 11 Power Calendar Elements..................................................................................81Table 12 Power Event Elements.......................................................................................82Table 13 Power Timeout Elements....................................................................................83Table 14 Console Elements..............................................................................................85Table 15 Cover Elements..................................................................................................88Table 16 Fax Modem Description Elements......................................................................90Table 17 Fax Modem Status Elements..............................................................................92Table 18 Finisher Subunit Elements..................................................................................95Table 19 FinisherSupply Elements....................................................................................97Table 20 FinisherSupplyMediaInput Elements..................................................................98Table 21 Input Tray Description Elements.......................................................................103Table 22 Input Tray Status Elements..............................................................................105Table 23 InterfaceDescription Elements..........................................................................107Table 24 InterfaceStatus Elements..................................................................................108Table 25 Interpreter Elements.........................................................................................111Table 26 Marker Elements..............................................................................................113Table 27 Marker Status Elements...................................................................................114Table 28 Market Colorant Elements................................................................................116Table 29 Marker Supply Elements...................................................................................117Table 30 Media Paths Elements......................................................................................119Table 31 Output Channel Elements.................................................................................122Table 32 Output Tray Elements.......................................................................................124Table 33 Processor Subunit Elements............................................................................127Table 34 Scan Media Path Elements..............................................................................128Table 35 Scanner Subunit Elements...............................................................................131Table 36 Scanner Addressability Elements.....................................................................132Table 37 Scanner Margin Elements................................................................................133


33

717

718

719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759

34


Table 38 Storage Elements.............................................................................................135Table 39 Vendor Subunit Elements.................................................................................137Table 40 Imaging Document Processing Capabilities.....................................................145Table 41 Service-Specific Document Processing Capabilities Image Output..................147Table 42 Service-Specific Document Processing Capabilities Impression Outputs........151Table 43 MediaCol Elements...........................................................................................155Table 44 Imaging Service Job Description Capabilities...................................................157Table 45 Service Specific Job Description Capabilities...................................................159Table 46 Document Format Detail Elements...................................................................160Table 47 Imaging Service Job Processing Capabilities...................................................161Table 48 Service-Specific JobProcessingCapabilities Elements.....................................163Table 49 Service Description Elements...........................................................................172Table 50 Service-Specific Service Description Elements................................................174Table 51 Constituent Elements of DocumentFormatDetailsDefault.................................176Table 52 Service Status Elements...................................................................................178Table 53 Service-Specific Service Status Elements........................................................180Table 54 Condition Table Elements.................................................................................181Table 77 Counter Elements Used in the Various Service and System Work Counters...188Table 78 Media Used Counter Elements.........................................................................190Table 79 Availability Counter Elements...........................................................................191Table 80 Monitoring Count Elements..............................................................................192Table 55 Job Status Elements.........................................................................................196Table 56 Job Originating User Authentication Info Elements..........................................199Table 57 Service-Specific Job Status Elements..............................................................200Table 58 JobTicket Superclass DocumentProcessing Elements.....................................203Table 59 Service-Specific Job Ticket Document Processing Elements - Image Output Services...........................................................................................................................206Table 60 Color Processing Elements..............................................................................210Table 61 Service-Specific Job Ticket Document Processing Elements - Impression Output Services...........................................................................................................................211Table 62 Media Collection Elements in Job Ticket..........................................................217Table 63 JobTicket ImagingJobDescription Elements (Superclass)................................220Table 64 Service-Specific JobTicketJobDescription Elements........................................222Table 65 Superclass JobProcessing Element Descriptions.............................................225Table 66 Service-Specific Job Processing Elements......................................................230Table 67 Document Status Elements..............................................................................238Table 68 Service-Specific Document Status Elements...................................................242Table 69 Document Description Elements......................................................................243Table 70 Service-Specific Document Description Elements............................................245Table 71 Conditions and Bounding Events......................................................................251Table 72 ServiceState Change by Operations................................................................253Table 73 Service State Change by Events......................................................................254Table 74 Imaging System Common Operations and Antecedents..................................259Table 75 Basic Imaging System Interface Requests and Responses.............................262Table 76 Administrative Operations.................................................................................278


35

760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804

36


Table 1 - FaxInServiceCapabilities Elements..................................................................300Table 2 - FaxInServiceDescription Elements...................................................................304Table 3 - Mandatory User Operations.............................................................................319Table 4 - Optional User Operations.................................................................................320Table 5 - Administrative Operations................................................................................321Table 1 FaxOutServiceCapabilities.................................................................................327Table 2 Mandatory User Operations................................................................................347Table 3 Optional User Operations...................................................................................348Table 4 Administrative Operations...................................................................................349Table 1 TransformServiceCapabilities.............................................................................359Table 2 Mandatory User Operations................................................................................377Table 3 Optional User Operations...................................................................................378Table 4 Administrative Operations...................................................................................380Table 4 Mandatory System Operations...........................................................................417Table 5 Optional System Operations...............................................................................418Table 6 SystemConfiguration sub-element associations.................................................421Table 7 SetSystemElements Contained/Referenced Datatypes.....................................425Table 81 PWG SMv2 Element Summary........................................................................436Table 82 ServiceCapabilities Syntax...............................................................................457Table 83 Keyword Value extension patterns...................................................................468


37

805806807808809810811812813814815816817818819820821822823824825

38


1. Introduction

1.1 Scope

This document specifies the core attributes of the PWG semantic model of an Imaging System and for the Imaging Services provided including Print, Scan, FaxIn, FaxOut, Transform, EmailIn, EmailOut, and Resource. Included in this document is the Service specific terminology, data model, the theory of operation, the Service interfaces and the conformance requirements. Each Service abstract model includes the functional models and interfaces of the associated Services for a local network, cloud or enterprise-connected multifunction device.

This specification is an update and extension of the general model presented in the MFD Model and Common Semantics Specification[PWG 5108.01-2011],

The purpose of the model is to fully describe, in an abstract context, the Service characteristics as observed from the outside. It is not intended to describe how the Imaging System is implemented internally, and it is expected that different implementations may use vastly different internal architectures. The models define semantics only for Elements that are accessible or about which information is somehow accessible via an interface. The models do not define a protocol or protocol specific encoding by which this access is achieved.

For purposes of this modeling, the Imaging Services that may be performed by an Imaging System are:

Print Scan FaxIn FaxOut EmailIn EmailOut Transform Resource

Note that Copy, which was treated as a separate Service in the MFD Model and Common Semantics Specification[PWG 5108.01-2011], is now considered a function of the Print Service.

This Document defines:

1. The overall MFD model including the terminology and concepts used in the Imaging Service models.

2. The models of an Imaging Service, Job and Document


39

826

827

828829830831832833834

835836

837838839840841842843

844845846847848849850851852853

854855856

857

858859860

40


3. “Imaging Service” complex Elements, representing structures appearing in several Services but because of XML Schema restrictions, not instantiated in any Service; the appropriate Services have parallel structures that include some Service-specific Elements

4. Elements common to several Services, eliminating the need to repeat these definitions in each Service specification.

5. The specific model of each Job-processing Imaging Service, the specific interfaces and operations, and the factors unique to each Service

1.2 Background

Office imaging functions were once limited to copying, formed letter Printing and primitive telephone-line based facsimile, each performed by a different device. Impact Printers gave way to high quality image Printers with complex interpreters and network communication. Optical copying devices were replaced by digital scanners driving image Printers. Facsimile matured to wed the digital scanners and image Printers with more complex encoding and transports. From the viewpoints of utility, functionality and efficiency, it made sense to integrate these imaging services in a multifunction device.

Although there was increasing commonality in technology, there were very different cultures supporting the manufacture, marketing and maintenance of the different office imaging functions. Slowly, copy and fax functions started appearing in Printers; Print functionality was added to copiers; and facsimile machines had copy functionality added. Eventually, manufacturers supplied equipment specifically designed to address multiple imaging functions. Utilization of the networking, the massive storage, and the internet capabilities that were brought to the office and home environments allowed further expansion of imaging device functionality and has made the Multifunction Device the primary hardcopy imaging equipment in enterprise and SOHO environments.

Despite the commonality of technology and the related functionality, the terminology, method of use, and anticipated user interaction of the office imaging functions has been tied to the different cultures associated with these functions and has been slow to coalesce. The PWG V2 Semantics effort defines an MFD model with consistent semantics for capabilities, configuration, operations and states for each of the Imaging Services. Recognizing the actual and historic distinctions, each Service model is described in a separate specification.


41

861862863864865866867868

869

870871872873874875876

877878879880881882883884885

886887888889890891892

893

42


2. TerminologyNew terms and terms used in a specific way for this modeling are described in the text of this Document and in the individual Service specifications. For convenience, the following table lists these terms with a summary definition.

The definitions below contain common definitions for Service qualified terms. The term ‘’ in any of the definitions below should be taken to be the name of the specific Service being considered (i.e., ‘Copy”, ‘EmailIn’, ‘EmailOut’, ‘FaxIn’, ‘FaxOut’, ‘ Print’, ‘Scan’, ‘Transform’ or ‘Resource’) when the term is used in the individual Service specification.

Multi-word terms are presented in this table with normal spacing between words. However, in some places in this specification, and in the individual Service model specifications, the term may be referring to a specific XML Element in an XML Schema. In that case, the spaces between words are omitted in accord with the XML Element tag. In either case, the definition of the term is the same.

2.1 Conformance Terminology

Capitalized terms, such as MUST, MUST NOT, REQUIRED, SHOULD, SHOULD NOT, MAY, and OPTIONAL, have special meaning relating to conformance as defined in RFC 2119 [RFC2119].

2.2 Other Terminology

New terms and terms used in a specific way for this modeling are described in the text of this Document and in the individual Service specifications. For convenience, the following table lists these terms with a summary definition.

The definitions below contain common definitions for Service qualified terms. The term ‘’ in any of the definitions below should be taken to be the name of the specific Service being considered (i.e., ‘Copy”, ‘EmailIn’, ‘EmailOut’, ‘FaxIn’, ‘FaxOut’, ‘ Print’, ‘Scan’, ‘Transform’ or ‘Resource’) when the term is used in the individual Service specification.

Multi-word terms are presented in this table with normal spacing between words. However, in some places in this specification, and in the individual Service model specifications, the term may be referring to a specific XML Element in an XML Schema. In that case, the spaces between words are omitted in accord with the XML Element tag. In either case, the definition of the term is the same.

Table 1 PWG Semantic Model Terminology


43

894

895896897

898899900901

902903904905906

907

908909910

911

912913914

915916917918

919920921922923

924

44


Term DefinitionAn identification of the specific Imaging Service involved, sometimes preceding (and sometimes embedded in) terms dealing with Devices, Clients, Jobs and Job Elements, Documents and Document Elements (e.g., Print Document Ticket, Scan Intent, FaxIn Job.) See definition of Service.

Active Jobs A Service instance specific queue containing all the Jobs that are waiting to be processed or are currently processing.

Automatic Document Feeder (ADF)

A mechanism for handling Hard Copy Documents for scanning. The mechanism selects a media sheet from its bin and passes it to the image acquisition subsystem of the Scan Device. After the Scan is complete the ADF transports the Hardcopy Document’s media sheet to its final destination (e.g., output bin, ADF bin.)

Capabilities Used in the context of Capabilities, this term refers to those Elements of a Service that can be used in the processing or description of a Job or Document. The models include Job Processing Capabilities, Job Description Capabilities and Document Processing Capabilities. Generally, a Service must be able to report its Capabilities and Job Tickets may include the desired values of these Capabilities Elements to describe the User’s Intent.

Client The local or remote software entity that interfaces with the Job Originator and interacts with an Imaging Service.

Content Region The area of a Hardcopy Document or Digital Document which is to be processed by an Imaging Service. Content Regions are applicable to Scan, FaxOut, Copy and, to an extent, Print Services. For example, a Scan Content Region is the portion of a Hardcopy Document media sheet side to be scanned and converted into a Digital Document. A Copy Content Region is the portion of a Hardcopy Document media sheet side to be Printed. Depending upon the Service and the implementation. There can be multiple Content Regions defined for a given media sheet side.

Cross Feed direction The direction perpendicular to the movement of the Hard Copy Document or the direction that the Print head or scanner light bar moves. For scanners that use a technology other that a light bar, this is the direction along which the image data is acquired most quickly. (Also called Fast Scan direction, X) This direction is sometimes referred to as X Feed direction.

Default Job Ticket,Default Job Ticket

A Job Ticket data object that is bound to an instance of an Imaging Service. The Job Ticket Default Job Ticket values are used by the Imaging Service when the Job Ticket for Job being processed does not specify a different value.

Destination The end point network address of a storage location for a Digital Document output from a Service.


45

46


Term DefinitionDestination URI A URI that specifies the recipient of a Digital Document transmission

for FaxOut or EmailOut services. It may also contain the URI for the routing to the recipient.

Device An abstract object representing a hardware component that implements one or more Imaging Services. The term may be preceded with the name of the specific Imaging Service (represented here by ). A Device exposes every Subunit on the associated host system involved in performing the functions of the indicated Imaging Service. For example a Print Device Scan Device.

Digital Document A Document in digitally encoded form as distinguished from a Hardcopy Document. The data input to or output from a Service containing the electronic representation a Hardcopy Document. The Digital Document may also include metadata relative to the Document. Digital Documents are the primary input to Print, FaxOut, EmailOut and Transform Services and the primary output from Scan, FaxIn, EmailIn and Transform services. The Print, EmailOut and FaxOut Services may also have a secondary Digital Document output. See Hardcopy Document.

Directory Service A software application or a set of applications that stores and organizes information about a computer network’s users and resources, and that allows network administrators to manage user’s accesses to the resources.

Discovery Client A software application that performs Service or resource discovery on a computer network.

Document An object created and managed by an Imaging Service that contains the description, processing, and status information of a data object submitted by a User. A Document object is bound to a single Job.

Document Data The digitized data submitted by a Job Originator as the Document or portion of a Document to be processed by an Imaging Service, or as the resulting data from the scanning of Hardcopy Document(s) in an MFD. The images from the scanned Hardcopy Document(s) are encoded in a specified format and stored at a Destination.

Document Repository A local or remote data store where Digital Documents are stored by or recovered from an Imaging Service

Document Resource A Resource associated with a Document within a Job of an Imaging Service is a Document Resource.

Document Ticket A data object that contains a User’s Intent for Document processing and descriptive properties of a Document in a Job. Any Document processing properties in the Document Ticket for a particular Job will override the values specified in the Job Ticket’s Document processing properties. The content of a Document Ticket is configured by a User through a Client.


47

48


Term DefinitionElement A term used to convey structure and relationships in XML Document

instances. An Element can contain both content and Elements. Complex Elements are composed, at least in part, of other Elements.

End User A User (Administrator, Job Owner, Operator, member of the Owner's group or other authenticated entity) for whom the Job output is intended.

Executable Resource Executable code that is installed in an MFD system and executed for performing a task. Executable Resource includes two types of resources: Firmware, and Software. (See Firmware, Software definitions below.) Executable resource is a category of resources that is served by the Resource Service.

Fast Scan direction Same as Cross Feed direction or X.Feed direction The direction along which the physical medium is moved or the

direction that the Print head or scanner light bar moves relative to the Hard copy Document. For scanners that use a technology other that a light bar this is the direction along which the image data is acquired most slowly. (Also called Slow Scan direction or Y)

Firmware Persistent computer instructions and data embedded in the MFD that perform the basic functions of that device. Firmware is only replaced during a specialized update process. [IEEE2600] Firmware is a type of resource that can be retrieved and stored by PWG MFD Resource Services.

Font A complete character set of a single size and style of a particular typeface. Most current computer fonts are based on fully scalable outlines. However, the term “Font” still refers to a single style. Times New Roman regular, italic, bold and bold italic are four fonts, but one typeface. Font is a type of resource that can be retrieved and stored by a MFD Resource Service.

Form A Document ( Printed or electronic) with spaces in which to write or enter data. Used in the context of the MFD specifications, the term “Form” refers to an electronic form, which is a type of resource that can be retrieved and stored by PWG MFD Resource Services.

Group Element A collection of Elements that constitutes a complex Element.Hardcopy Document A Document on physical media such as paper, transparency or film

that is the input source to Scan, Copy and FaxOut Services and the output from Print, Copy and FaxIn Services.


49

50


Term DefinitionICC Profile A set of data that characterizes a color input or output device, or a

color space, according to standards promulgated by the International Color Consortium (ICC). Profiles describe the color Elements of a particular device or viewing requirement by defining a mapping between the device source or target color space and a profile connection space (PCS) (see definition below). This PCS is either CIELAB or CIEXYZ. Mappings may be specified using tables, to which interpolation is applied, or through a series of parameters for transformations. Every device that captures or displays color can have its own profile. ICC profile is a type of resource that can be retrieved and stored by a PWG MFD Resource Service.

Image A digital electronic representation of the information captured by a Scan Device. One Image is produced as a result of a Scan Device scanning a Scan Region. One or more images are contained in the Digital Document produced by a Scan Service.

Imaging Client A Client interacting or seeking to interact with an Imaging Service. Imaging Device A hardware entity that supports one or more Imaging Services (as

defined below), including the System. A more general alternate term for Multifunction Device, which name suggests that more than one Imaging Service is supported.

Imaging Service One of the Services considered in the modeling of a Multifunction Device, including Print, Scan, Copy, FaxIn, FaxOut, EmailIn, EmailOut, Transform and Resource

Intent The User’s preferences for the processing and description properties of a Job or Document.

Job A data object, created and managed by a Service, that contains the description, processing, and status information of a Job submitted by a User. The Job can contain one or more Document objects.

Job History An Imaging Service instance specific queue containing all the Jobs that have reached a terminating state. The terminating states are defined as Completed, Aborted and Canceled. The length of this queue is determined by the implementer. The Jobs should remain in the Job History for a time sufficient for interested parties to obtain information on completed Jobs.

Job Originator The User that submits the initial request to create the Job.Job Owner (or Owner) Normally the User who submits a Job is the Job Owner, although

under certain circumstances an administrator can reassign ownership. The Job owner has certain administrative privileges with respect to his Jobs.

Job Receipt An Element of the Service that contains information on the actual values of processing Elements used by the Service for processing a Job. The content of a Job Receipt is populated by the Service when a Job is processed.


51

52


Term DefinitionJob Resource A Resource associated with a Job.Job Template A Job Ticket data object representing a User’s preconfigured Intent

that is not bound to a specific Service or Job.Job Ticket A data object that contains a User’s Job-level Intent for Document

processing, Job processing and descriptive Job properties of a Job, sent to an Imaging Service. Job Elements apply to the entire Job. Document processing Elements apply to all Documents within the Job unless overridden at the Document level (See Document Ticket). The content of a Job Ticket is configured by a User through a Client.

Local Client A software application entity that is co-located with the Service and interacts on behalf of a User. May also be referred to as Local client, where is one of the Services supported by the MFD.

Logo A graphical Element, (ideogram, symbol, emblem, icon, sign) that, together with its logotype (a uniquely set and arranged typeface) form a trademark or commercial brand. Logo is a type of resource that can be retrieved and stored by a PWG MFD Resource Service.

Multifunction Device (MFD) A hardware entity that supports one or more Imaging Services, including the System. Generally abbreviated MFD, this also includes Imaging Devices commonly called Multifunction Peripherals or Multifunction Printers (MFPs) and All-In-Ones.

Physical Document Ticket, Physical Document Ticket

A Printed, encoded Document Ticket submitted by the Job Originator with the Hardcopy Document to be scanned, which becomes a Document Ticket data object after being scanned and processed. This may be used for Scan, Copy and Fax-Out Services.

Physical Job Ticket, Physical Job Ticket

A Printed encoded Job Ticket, submitted by the Job Originator with the Hardcopy Document to be scanned, that becomes a Job Ticket data object after being scanned and processed. This may be used for Scan, Copy and Fax-Out Services.

Profile Connection Space (PCS) A standard device independent color space defined by the International Color Consortium (ICC) that is used for mapping the color space of one device to the color space of another by describing the relationship of each device’s color space to this device independent color space.

Region A rectangular area of a Digital Document that has been specified by an Administrator or End User as the bounding area for which a digital data representation will be output; or a rectangular area of a Hardcopy Document that has been specified by an Administrator or End User to be generated from a Digital Document

Remote Client The Remote Client is a Client external to the MFD that interfaces with the End User and interacts with a Service.


53

54


Term DefinitionResource A data object that can be served by the Resource Service when

required by an MFD system for performing a task or a Job. There are two categories of Resources required by an MFD: Executable Resource, and Static Resource. (See the definitions of Executable Resource and Static Resource).

Resource Client The local or remote software entity that interfaces with the Job Originator and interacts with a Resource Service.

Resource Service A software Service that provides the interfaces for storing, retrieving, and maintaining users’ Resources.

Retained Job A Retained Job is one which remains in the Service after it has been completed or canceled. This retention may be incidental or because the Job, is a Saved Job. A Retained Job is the only type of Job that can be referenced in a Resubmit Job operation.

Saved Job A Completed or Canceled Job with a “JobSaveDispostion” Element value indicating that the Job, including Document Data if any, should not be deleted or aged-out after the Job is completed.

Sequence A type of XML structure that represents an ordered list of Elements.Service An Imaging Service (or Imaging Service) that accepts and processes

requests to create, monitor and manage Jobs, or to directly support other Imaging Services in an imaging-specific way (i.e., the Resource Service). The Service accepts and processes requests to monitor and control the status of the Service itself and its associated Resources. A Service may be hosted either locally or remotely to the MFD.

Slow Scan direction Same as Feed Direction or Y Software Persistent computer instructions and data placed on the MFD, via

download, that are separate from, and not a part of, the base Firmware. Software supports features or applications that are in addition to those provided by the base Firmware. Software is a type of Executable Resource. Software is a type of resource that can be retrieved and stored by a PWG MFD Resource Service.

Static Resource A non-executable electronic data object that is required by an MFD system for performing a task. Static Resource includes the following types of resource: Font, Form, Images, Logo, and Template.

Subunit A physical entity contained within or controlled by an Imaging Device that performs a specific process necessary to support one or more Imaging Services; (e.g., Marker, Console, Covers, Interfaces, Input Channels, Output Channels, etc). Note that, for historical reasons, the term Scanner may refer to either a Subunit or a Scan Device.

System The object handling interaction that needs to be with the MFD as an entity rather than a specific Service. The System is modeled to include all of the Subunits of the MFD, as well as device identification and overall status.


55

56


Term DefinitionTemplate A data object that contains descriptive information and the pre-

configured content of a Job or Document Ticket for a specific Imaging Service. A Template is not bound to a specific Job or Document. It can be stored or retrieved from a Resource Service, collocated on the MFD or hosted on a remote system. Template is a type of Resource that can be retrieved and stored by a PWG MFD Resource Service.

User Users include the Administrators, Job Owners, Operators, members of the Job Owner's group and other authenticated entities.

Watermark A recognizable image or pattern when Printed on paper used to identify authenticity. Watermark is a type of resource that can be retrieved and stored by a PWG MFD Resource Service.

X An axis of the coordinate system. This axis is associated with the Fast Scan direction of the Scan Device. If the light bar or Hard Copy Document moves, they do not move in the X direction. They move in the Y direction. (See also Cross Feed direction, Fast Scan direction)

Y An axis of the coordinate system. This axis is associated with the slow Scan direction of the Scan Device. If the light bar or Hard Copy Document moves, they move in Y direction. (See also Feed direction, Slow Scan direction)

2.3 Acronyms and Organizations

IANA: Internet Assigned Numbers Authority, http://www.iana.org/

IETF: Internet Engineering Task Force, http://www.ietf.org/

ISO: International Organization for Standardization, http://www.iso.org/

PWG: Printer Working Group, http://www.pwg.org/


57

925

926

927

928

929

930

931

58


3. Requirements

3.1 Rationale

Office imaging functions were once limited to copying, formed letter-printing and PSTN facsimile, each performed by a different device. Impact Printers gave way to high quality image printers with complex interpreters and network communication. Optical copying devices were replaced by digital scanners driving image Printers. Facsimile matured to wed digital scanners and image Printers with more complex encoding and transports. From the viewpoints of utility, functionality and efficiency, it made sense to integrate these Imaging Services in a Multifunction Device. The wider access to data and the mobility of Users provided by the Internet and a plethora of access devices has prompted an abstraction of the PWG Model from an MFD to an Imaging System. An Imaging System may be contained within a Multifunction Device (MFD);it may be a distributed system spread over several devices; or it may be implemented by software with connections to hardcopy input and output devices.

Despite the commonality of technology and the related functionality, the terminology, method of use, and anticipated user interaction of the office imaging functions has been tied to the different cultures associated with these functions and has been slow to coalesce. Indeed, even within the industry, the Facsimile, Copier, Printer and scanner groups were usually separate and distinct with different manufacturing, marketing, sales and support, even when they were all nominally from the same company. The attempt to integrate the structures manufacturing and supporting the devices providing MFD Services has been much more difficult than the actual integration of those Services on an MFD.

But the modern user simply wants to deal with Documents, Hardcopy or digital versions, in a consistent way, using the Imaging Service most appropriate to his needs (perhaps not even considering which Service is most appropriate.) He wants to get Hardcopy and received Documents into his data system. He wants to put Documents out from his data system, whether via Hardcopy or by an appropriate means of transmission. He wants to make copies of Hardcopy Documents and perhaps copy Digital Documents into some other format or encoding. Furthermore, he needs intelligent user interfaces using a consistent terminology in doing these functions.

A consistent model of MFD Services is also useful to equipment manufacturers and software providers to allow a more efficient implementation of the devices and the use of a more standard set of drivers.

Considering this situation, there is a need to develop a semantic model and a set of abstract operations and Elements for each MFD Service and to ensure that these abstract operations and Elements exploit the inherent areas of commonality among the MFD Services.


59

932

933

934935936937938939940941942943944945

946947948949950951952953954

955956957958959960961962

963964965

966967968969

60


3.2 Use Cases

Because each of the basic Imaging Services have been provided for many years and most are well defined in practice. , there would be little new information in considering the capabilities Users want when they Print, Scan, Fax or Copy Documents. The significant considerations are that: to be considered in this Model are:

Users want Document handling and processing to be transparent. Once they have created or selected a Document, they do not want to be concerned with the specifics of how that Document gets pPrinted or faxed or copied; they just want the right people to get it in the right form at the right time. Because most of the complexity of pPrinting is hidden by applications, user interfaces and Print Devices, the typical user thinks pPrinting is simple. By extending Print consistent Semantics to all Imaging Services, all Document processing and handing should appear simple and intuitive to Users.

Administrators and operators want the setup, maintenance and monitoring of devices performing Imaging Services to be capable of supporting the Users’ requirements in an efficient and consistent way across all Services, especially when multiple Services are performed by a one device. A consistent modeling must support accounting of Service utilization, ensuring availability of consumables, and handing of problems in capacity, utilization, security issues and equipment malfunction.

Developers of applications, drivers and user interfaces need to support the user requirements. The developers want a consistent terminology and capability in operations and messages.

[3.2.1] Service Basic Hardcopy Imaging Functions

The basic functionality of scanning/ pPrinting/faxing/copying, although it must be covered in the Service models, is well established with the scenarios known and understood. Although IPP [RFC2911] specifically applies to the Print Service, a majority of the IPP operations and attributes are applicable to one or more of the other Imaging Services. By applying the IPP-like operations and attributes to structure the functionality of the other Imaging Services, much of the desired consistency across Services is achieved. The well defined IPP operations and attributes therefore form the basis for the modeling of the other Services.

3.2.1[3.2.2] Consideration of Subunits

In modeling the MFD Services after the IPP Print Service, the major areas of difference will be the form of the input and the form of the output. Input and output are both functions of the physical/functional modules that are termed Subunits.

1. Scan, Copy, FaxOut need a scanner subunit


61

970

971972973974

975976977978979980981982

983984985986987988989

990991992

993

994995996997998999

10001001

1002

100310041005

1006

62


2. Copy, Print, FaxIn, EmailIn need a marker subunit3. FaxIn and FaxOut need a FaxModem

3.2.2[3.2.3] Imaging Service Use Scenarios

The following scenarios deal with extended functionality of an MFD and the interaction of Services sharing common subunits. These scenarios are not intended to cover all ways in which the Imaging Services would be used.

3.2.2.1[3.2.3.1] Use Case 1: Create Job Template from a Remote Network Client Application

Imaging Services are often used in recurring ways: e.g., Printing company memos in a particular format; sending out orders via Facsimile; scanning accident reports and storing in a repository. Job Templates simplify these actions by providing the recurring parameters for Job Tickets.

[3.2.3.1.1] Scan TemplateFunction Example

Nancy, working in the human resource department, is conducting an “anonymous” employee survey. To preclude apprehensions of electronic input being traced, the survey sheets are provided in Hardcopy form. The completed forms must to be scanned and processed to analyze the survey results. Nancy wants to use the group MFD to Scan then store the scanned survey forms in the survey project directory. However, she does not want to set up the Job parameters for each filled-in form as the forms filter in. Therefore Nancy launches her Imaging Service Client application and requests the creation of a new Job Template. Nancy sets up her Job Template with her intent and the repository location for the Documents associated with this new activity. Finally, Nancy requests that her Job Template be stored on the group MFD under her account. Nancy closes her Imaging Service Client application.

[3.2.3.1.2] Copy Print Template Function Example

Joe, manager of a sales department, has dictated that internal memos must be distributed on recycled paper and, if more than one page, must be printed in duplex. He is tired of employees saying that they don’t know how to do this, or that they forgot. So he wants to set up the MFD with a Job Template so that Users need just select “internal memo” and number of copies. Therefore, Joe launches a Job Template Client that allows him to define a Job Template tag and the Copy print parameters to create a Job Template that is to be stored in the MFD Resource Service and that is readily accessible to walk-up Copy-Service Users.

3.2.2.1.1[3.2.3.1.3] FaxOut Template Example

Dick is a legal aid working on a commercial case that involves a series of contracts, with copies to be delivered via facsimile to a set of recipients. The contracts are generated by


63

10071008

1009

101010111012

10131014

1015101610171018

1019

10201021102210231024102510261027102810291030

1031

10321033103410351036103710381039

1040

10411042

64


several attorneys on their computers and Dick wants a reliable way to ensure that all intended recipients get their copies promptly and in the proper way, and that each record of transmission and successful reception be sent to the proper repository. Dick launches a Job Template Client that asks him to set up the facsimile parameters, the destinations, and the handling of the transmission and reception reports. He sets this up to be stored in a central location so that each attorney can call it up as needed.

3.2.2.1.2[3.2.3.1.4] Example Processing Steps

Listed below are processing flow requirements for the scenarios.

1. The User invokes a Template generation application.2. The User may select an Imaging Device to use to constrain their imaging function

Intent3. The User requests the creation of a new Job Template.4. If the specific Imaging Device has been identified in the User request, the

Template generation application may contact the appropriate Service in that Device to request the associated description attributes and the range of values for each attribute of the Service (i.e., the Capabilities).

5. The Template generation application presents the Job Template to the User.6. The User modifies the Job Template attributes to meet their specific Intent.7. The Template generation application validates the modified Job Template.8. The User designates storage of the modified Job Template to be at the specified

Resource Service.9. The Template generation application requests the Resource Service to store the

modified Job Template on behalf of the specified User(s).10.The Resource Service stores the modified Job Template. 11.The Template generation application informs the User that their modified Job

Template has been stored.12.The User exits the Template generation application.

3.2.2.2[3.2.3.2] Use Case 2: Handling Multiple Hardcopy Documents from a Computer

After the Hardcopy Document is placed on the platen or in the ADF of a Scanner Subunit, a User is to control scanning operations using the remote Imaging Service Client from the User’s desktop computer. The User continues to place the next set of Hardcopy originals on the scanner subunit when requested, and repeats the process until all sets of the User’s Hardcopy Documents have been scanned and processed according to the specified Intent. This use case can apply to all Imaging Services that use the Scanner Subunit.

3.2.2.2.1[3.2.3.2.1] Service Examples

Clara has to Scan, Copy, or FaxOut a multipage Document in a busy office environment. Every time she goes up to the MFD, either someone else is standing there or the machine is busy processing some long Job. Clara does not have the time to stand there and wait


65

104310441045104610471048

1049

1050

1051105210531054105510561057105810591060106110621063106410651066106710681069

1070

1071107210731074107510761077

1078

107910801081

66


for the machine to become available and then spend time setting up her Job Ticket. She needs to be able to set up the proper Job Ticket from her workstation, get a notice from the MFD when the Service she needs is available. She can then go to the machine, load her original, identify her Job Ticket and start the Job. Also, since her Job is very large, she will need to reload the ADF several times. She does not want to wait by the MFD, but needs a notice from the MFD when more input must be loaded.


The following are the processing steps for this scenario.

1. From the Resource Service Client application on their computer, the User obtains a local copy of the Job Template to use for their Intent.

2. The Imaging Service Client modifies the local copy of the Job Template to the user’s Intent for use as a Job Ticket. This modification may include noting the Job includes multiple Documents with the same or different destinations.

3. The Imaging Service Client application sends a Create Job operation including the Job Ticket to the Service.

4. The creates a Job but puts the Job into a ‘Hold’ state (inhibiting scheduling). 5. The Imaging Service Client application is monitoring the Job and the state of the

Imaging Device. It notifies the User of the Job Identification and notifies the User when the Imaging Device is free.

6. When the Imaging Device is free and the User is ready, the User comes to the Device, identifies their Job and requests that it be released from the ‘Hold” state. The Service schedules and begins to process the Job.

7. The Service requests the User to place the Hardcopy Document(s) in the Automatic Document Feeder.

8. The User provides the Document and presses the "Continue" button on the MFD.9. The Service scans the individual pages of the Hardcopy Document. If the entire

Document has not been placed on the MFD's ADF, the Service detects that more Hardcopy must be inserted and requests the User to put in the next sheet(s).

10.The User presses the "Stop" button when all of the Hardcopy Document's pages have been scanned.

11.The Service processes and delivers the Digital Document according to the nature of the Service and the Job Ticket instructions.

12.Repeat Steps 9 through 13 until the last Document is complete.13.The User presses the "Stop" button to indicate that there are no more Documents

for this Job.14.The notifies the Service Client application on the User’s computer that the Job is

complete based on the information in the Job Ticket.

3.2.2.3[3.2.3.3] Use Case 3: Walk-Up Batch-Scanned Input

This scenario can apply to any Imaging Service using the Scanner Subunit with an Automatic Document Feeder, although the Document boundaries may be lost with the FaxOut Service.


67

108210831084108510861087

1088

1089

10901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118

1119

112011211122

68


3.2.2.3.1[3.2.3.3.1] Service Example

Glen needs to Scan a stack of Hardcopy Documents. For each Document to be scanned, Glen prepares a Physical Document Ticket and places it in front of the corresponding Document. Glen then prepares a Physical Job Ticket and places it in front of the stack and places the stack in the MFD’s Automatic Document Feeder. Glen selects “batched” and presses the green button.


The following are the processing steps for this scenario.

1. Glen places the stack of Hardcopy Documents on the ADF.2. From the Local Client, Glen selects the “batch” mode of the Service. 3. The Local Client requests the Service to switch to “batch” mode.4. Glen pushes the Start button.5. The Local Client requests the Service to start “batch mode” operation.6. The Service creates a “batch mode” Job.7. The Service creates a Job Ticket from the Job Ticket Default Job Ticket.8. The Service schedules the Job.9. The Service executes the Job.10.The Service scans the first sheet, recognizes it as a Physical Job Ticket and

modifies the Job Ticket based on the information obtained from the digital image data of the Physical Job Ticket.

11.The Service scans the sheet at the start of the first Document and recognizes it as Physical Document Ticket.

12.The Service creates a Document within the Job, creates and fills in the Document Ticket based on the information obtained from the digital image data of the physical Document Ticket.

13.The Service scans the Hardcopy Document and stores the Digital Document at the specified Destination until the end of the Document is detected.

14. If another Physical Document Ticket is detected, the Service creates another Document within the Job, creates and fills in the Document Ticket based on the information obtained from the digital image data of the Physical Document Ticket.

15.Return to Step 13 until the scanning of all Documents in the Job, as identified on the Job Ticket, has been competed.

16.The Service completes processing of the scanned information and notifies the Local Client that the Job is complete.

17.The Local Client notifies the User that the Job is complete based on the information in the Job Ticket.

3.2.2.4[3.2.3.4] Use Case 4: Pause Service for Pre-emptive use of Subunits

Some Imaging Services have traditionally allowed a Job to be paused to allow a higher priority Job to go to completion. Because Services share subunits in an MFD, this pause


69

1123

11241125112611271128

1129

1130

1131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158

1159

11601161

70


capability must be extended to pausing a Service so that a different Service with a higher priority Job can use a common subunit. The following examples show how this may apply.

3.2.2.4.1[3.2.3.4.1] Pausing Scan Service

Anne urgently needs to Copy a few Documents while a long Scan Job is running. Since she has administrative rights, she pauses the Scan Service until she has copied her Documents and then resumes the Scan Service (which resumes the Job previously in progress).

3.2.2.4.2[3.2.3.4.2] Pausing Print Service

Joan needs to Scan some critical Documents but the MFD is tied up with a long Print Job. As the president’s executive assistant, Joan has admin rights. She pauses the Print Service and gives her Scan Job highest priority. Of course, she must remember to unpause the Print Service when she is done.

3.2.2.4.3[3.2.3.4.3] Processing Steps

The following processing flow steps apply to this use case:

1. The User walks up to the MFD with a Job and sees the Imaging Device engaged in a Service using the same subunit that they need. Using the Local Client, they bring up the Service configuration menu for the currently active Service and request that that Service Pause.

2. The Local Client requests that the currently active Service pause and the Service performs a ‘pause’ operation.

3. The Service notifies the Client the ‘paused’ status.4. The User removes any sheets from the ADF and from the output bin and puts the

Hardcopy Documents on the platen or the ADF. 5. The User initiates a Job for their Documents. Since no specific Job Ticket

information is added, the Service uses the Job Ticket Default Job Ticket.6. After the User’s Job is complete, the User removes their originals and any

copies, restores the previous Documents to the scanner subunit and brings up the Service configuration menu from the console to resume the paused Service.

7. The Local Client requests the paused Service to resume and that Service performs a ‘resume’ operation.

8. The resumed Service notifies the Local Client of the ‘resumed’ status.

3.2.2.5[3.2.3.5] Use Case 5: Service Discovery

This scenario applies to all Imaging Services. Bill wants to discover the Services available in his enterprise network, so that he knows what he can choose in the future when he wants to submit a Job. Bill wants to discover Services both statically (via enterprise directories) and dynamically (via discovery protocols).


71

11621163

1164

1165116611671168

1169

1170117111721173

1174

1175

11761177117811791180118111821183118411851186118711881189119011911192

1193

1194119511961197

72



For static discovery via a directory service, the following flow step requirements are identified:

1. At start-up, each Service authenticates with and connects (binds) to the Directory Service of the network domain of the MFD, then registers the Service information with the Directory Service.

2. At any time, a Discovery Client sends the Directory Service a “lookup” search request for the specific Service type in order to locate a Service.

3. The Directory Service returns an appropriate list of Services.

For dynamic discovery via a Service discovery protocol, the following processing requirements are identified:

1. At start-up, each Service announces its Service type and location to the multicast group in which all Services and discovery clients reside. Any listening Discovery Client will detect newly-available Services automatically.

2. To initiate a discovery at any time, a Discovery Client sends a “search-by-service-type” query to this multicast group.

3. Each Service responds to a search query with a “service-type-matched” message.

4. In a network environment where a discovery proxy server is preferred, the proxy server listens to this multicast group for Service announcements from all Services and announces its Service in response to each search query received.

5. If a discovery proxy server is preferred, the Client sends a “search-by-type” message to this proxy server to discover all available Services.

6. The discovery proxy server returns the list of Services that match the specific Service type to the client.

3.2.2.6[3.2.3.6] Use Case 6: Service Capability Discovery

An MFD is setup on the network. The MFD has been previously discovered and is known to the application software that will query the Imaging Device for capabilities. Ira wants to learn if the capabilities of various Services, such as whether the Scan Service is capable of sending his Document as a PDF file to his mailbox. He would also like to know if the Print Service is capable of duplex operation and whether the FaxOut Service accepts Digital Data input coded in PDF. From the application on his computer, Ira is able to select options available knowing that the application has determined what the capabilities of the Services are and that the indicated options will be supported.


From the Remote Client at User’s computer, the User selects a target Service and requests the list of capabilities of the Service.


73

1198

11991200

120112021203120412051206

12071208

12091210121112121213121412151216121712181219122012211222

1223

12241225122612271228122912301231

1232

12331234

74


1. The Remote Client requests the Service the list of capabilities of the Service.2. The Service returns the Service Capabilities to the Remote Client.[3.] The Remote Client requests the UI User interface to display the list of Service

Capabilities to the User.

3.2.2.7[3.2.3.7] Use Case 7: Cloud Imaging System Interfacing with Imaging Devices

The use of Cloud-based applications and services includes the use of distributed Imaging Systems, with software components in the Cloud interfaceing with User Devices (such as computers) and hardcopy devices on local networks. Although these networks typically allow User Client applications to access the Cloud (often with some identification/authentication steps), Cloud system access to imaging devices on a local network is typically restricted by a firewall.

3.2.2.7.1[3.2.3.7.1] Document Data to Remote Device

The User locates an appropriate Cloud Imaging Service, determines that his document format can be accepted, that it can be printed as he wishes and that the printed document will be available where he wants it. The User may check the status of the Cloud Imaging Service and of the Print Device. He then submits a document for printing. Later he may check the status of his request and ultimately of the printed document..

3.2.2.7.2[3.2.3.7.2] Scan Document Initiated from MFD

The User goes to an MFD in a hotel, enters identifying information, inserts the copy to be scanned in the ADF, and selects SCAN from the MFD control panel. In response to prompting from the panel, he enters scan parameters and intended destination of the digital image file.

The MFD sends the scan request to the Cloud Imaging System which checks that the User is authorized to received the desired service. Provided that he is, the Scan Service in the Cloud Imaging System instructs the MFD to scan the original and sends the resulting image file back to the Scan Service. The Scan Service reformats the data as directed and delivers it to the selected destination.

3.2.2.7.3[3.2.3.7.3] Document Copy Initiated from Tablet

The User's tablet computer has a 'copy app' configured to connect to his company's Cloud Imaging Service and to use the department MFD as the imaging device.. The application includes a client that identifies the User and allows the Cloud Imaging Service to impose restrictions on the number of copies and the use of color printing, as well as providing accounting functions. The User requests a copy job indicating number of copies and other parameters such as color and media, assuming they differ from defaults. The Cloud Imaging Service responds with a Job ID. User then goes to the department MFD, inserts his originals in the


75

1235123612371238

1239

124012411242124312441245

1246

124712481249125012511252

1253

1254125512561257

12581259126012611262

1263

12641265126612671268126912701271

76


ADF and enters his personal ID and Job ID. Alternatively, The originals are scanned and copies are printed.

3.3 Out of Scope

The following are out of scope for the Service modeling documents.

1. Semantics of any compound Service or workflow such as -To-EmailOut, FaxIn-To- Print, -To-Transform-to-FaxOut, Print-To-Copy.

2. Specifics related to the security of the Document or administrative information, protection of the communication mechanisms or the implementing Imaging Devices from abuse, or methods of usage accounting. However, the models structure must not inhibit addressing these requirements by other appropriate means.

3. Any semantics related to a specific protocol. Rather, it is intended to make the semantics protocol and transport agnostic.

4. Semantics of any workflow protocol, i.e., sequencing and coordination of Jobs across multiple Services.

3.4 Design Requirements

Consideration of the Use Cases results in certain common design requirements for the Service models. The following requirements are derived from the considerations and use cases.

3.4.1 Basic Operations

The operations in the following table, which are primarily based on those defined for the Printer Service in IPP (REF), are operations reasonably required to be supported in the modeling of MFD Services.

Table 2 Imaging System Common Operations

MDF Service Operation

AddHardcopyDocumentCancelCurrentJobCancelDocumentCancelJobCancelJobsCancelMyJobsCloseJobCreateJobDisableService


77

12721273

1274

1275

12761277127812791280128112821283128412851286

1287

128812891290

1291

129212931294

1295

78


MDF Service Operation

EnableServiceGetDocumentElementsGetDocumentsGetJobElementsGetJob HistoryGetActiveJobsGetServiceElementsGetServiceElementsHoldJobHoldNewJobsPauseServicePauseServiceAfterCurrentJobPromoteJobReleaseNewJobsReleaseJobRestartServiceResubmitJobResumeJobResumeServicePromoteJobSendDocumentSendURISetDocumentElementsSetJobElementsSetServiceElementsShutdownServiceStartupServiceSuspendCurrentJob

3.4.2 Requirements from Common Use of Subunits

An Imaging System includes many subunits, some of which are used by all Services, and some a subset of the supported Services. Indeed, there may be Imaging System implementations that include multiple subunits of a given type. (In use case 4 for example, multiple markers or multiple scanners would prevent the need for having to pause a currently active service.) In modeling the Imaging System Services, all of the Imaging System subunits that might be used by the Service must be identified.


79

1296

129712981299130013011302

80


3.4.3 Design Requirements from Use Cases

The Use Cases suggest certain requirements of the Service models and of the System model that go beyond having an operational capability analogous to IPP.

3.4.3.1 System Requirements

An Imaging System potentially supports several Services, and those Services share the Subunits constituting the Imaging System . One Subunit is the Console, with which a User interfaces to request Job creation in any of the Services, as well as to configure and control the individual Services. Therefore, there must be something starting and controlling the Services, managing the access to shared Subunits, and providing overall status and reporting information. That is, the set of Service models must include a System.

3.4.3.2 Service Requirements

Each Service must accommodate:

1. A consistent Job structure, including a Job Ticket defining the User Intent for the Service to act on the Job Document(s).

2. A Default Job Ticket, to be used when a Job Ticket does not specify the values of all necessary Elements.

3. A Job Template, containing the Elements characteristic of a recurring type of Job, to prevent the User having to make up a full Job ticket in all cases.

4. A repository for storing and recalling prepared Job Templates, with each Service having access to this repository.

3.4.3.3 Service Related Requirements

In this context, Status refers to characteristics of a Service which are not settable by an administrator. This generally includes capabilities and state. Description refers to Elements which are settable, and includes Elements such as name, and settable parameters. In being able to report Status and Description Elements, each Service shall make this information available, although it may in fact be the System that satisfies some of the requirements below.

1. For supporting dynamic Service discovery, the Service type, Service instance, and endpoint address information must be supplied to the multicast group in which it resides at start-up of the Service.

2. For supporting static Service discovery, an entry record must be sent to a specified Directory Service at Service start-up for registering Service information.

3. In response to a discovery or search query from a Discovery Client, the Service type, Service instance, and endpoint address information must be supplied to the client.


81

1303

13041305

1306

1307130813091310131113121313

1314

1315

13161317131813191320132113221323

1324

132513261327132813291330

13311332133313341335133613371338

82


4. A Service must respond to a Client’s query for Service status and descriptive Elements and the range of each descriptive Element. This response must include the capabilities supported by the Service and the default values of descriptive and processing Elements of a Job Ticket.

3.4.3.4 Document Related Requirements


83

1339134013411342

1343

1344

84


4. Model Concepts

4.1 Model Notation

4.1.1 Model Conventions

This specification describes the overall aspects of the Imaging System model in general. Furthermore, it describes in detail the Elements of the model that are common to multiple Services by presenting the graphic representation of the applicable Elements from the PWG MFD XML Schema [MFD_SCHEMA] and providing the datatype, a brief description and the reference for each of the constituent Elements in a table. The references identify the existing standard document, usually a MIB or IPP specification, where the Element is defined. In instances where an Element is newly defined in this specification, the Element definition is provided.

4.1.1.1 Element, Operation and Attribute Name Representation

In the text of this specification, the names of semantic Elements follow normal English format, with the individual words in a multi-word name initially capitalized (as are all defined terms) and the individual words separated by a space. However because the graphic representations are generated from the PWG MFD XML Schema [MFD_SCHEMA], the Elements in the figures and in the tables providing details of these Elements use the XML nomenclature. In the case of multi-word names, the words are concatenated (no spaces) with the first letter of the each word capitalized. For example, the complex Element ‘Subunit Status’ appears this way when being discussed in the text, but appears as ‘SubunitStatus’ in the schema diagrams and their associated tables.

However, multi-word Operation and Attribute names, which do not normally appear in the schema figures, are presented in the text concatenated (no spaces) with the first letter of the each word capitalized (e.g., CreateJob.)

4.1.1.2 “Any” Element and “Any” Attribute Extensions

The Imaging System model allows for vendor extensions to the model at various levels. Within the schema figures, an “Any” Element symbol is shown as an Element extension point to allow vendor product differentiation by implementation-specific Element extensions while maintaining interoperability. That is, one or more vendor extension Elements may be added where the schema shows an “Any” Element extension. Within the schema diagrams included in this specification, the Element extension is represented by “Any” in a rectangle, as shown in Figure 1.


85

1345

1346

1347

13481349135013511352135313541355

1356

135713581359136013611362136313641365

136613671368

1369

1370137113721373137413751376

86


Figure 1 Element Extension Symbol

In some cases, Attribute extensions are also allowed as Attributes associated with an Element. In the schema diagrams included in this specification, the Attribute extension is represented by “Any” in a five-sided, tab-like symbol as shown in Figure 2

Figure 2 Attribute Extension Symbol

4.1.1.3 Representation of Mandatory versus Optional Elements and Number of Instances

The line leading to an Element representation may be marked with the minimum and maximum number of instances of that Element. If there is no instance marking or if the minimum instance is greater than 0, that Element is mandatory to the extent that what precedes it is implemented. For example, Figure 3 shows that Copy Service Status is a mandatory element, but it is mandatory only if the preceding Element (which in this case is Copy Service) is implemented. However, because the schema figure segments in this specification are but small parts extracted from the overall model schema, considering the tags on one figure may give an incorrect impression. Since instances of an Element may occur at different places in the model, it is best to view the entire schema when considering these instance tags.

Figure 3 Conditionally Mandatory Element

A tag of 0.1 as in Figure 4 means that the Element is optional, but if it exists, no more than one may exist at that position in the model. A tag of 0.* as shown of the “Any” Element in Figure 1 means that the Element is optional but any number could exist in that position.

Figure 4 Optional Element

4.1.1.4 Representation of Exclusive Or

In this specification, an “or” condition may be represented by a vertical bar (|) not just in an Augmented Backus–Naur Form (ABNF) notation but also when listing parameters that are mutually exclusive, as in “IsAcceptingJobs|IsAcceptingResources”.


87

1379

138013811382

1383

1384

1385

1386138713881389139013911392139313941395

1396

1397

139813991400

1401

1402

1403

140414051406

88


4.1.2 Datatypes

The modeling of an Imaging System is schematically represented in PWG MFD XML Schema [MFD_SCHEMA], using a structured hierarchy of components eventually leading down to leaf Elements of simple XML datatypes. In this specification these components are defined in terms of their constituent Elements, and the leaf Elements are identified as being of one of the datatypes in Table 2 Basic Element Datatypes.

When the datatype is keyword or list of keywords (fixed or extensible), the description will identify the keyword group. A fixed keyword datatype is specified as a WKV (Well Known Values), i.e., an enumeration of the allowed values defined in the relevant specification - please refer to the keyword group (i.e., PwgWellKnownValues.xsd, MediaWellKnownValues) in the PWG MFD XML Schema [MFD_SCHEMA] for an explicit list of the applicable keyword values. An extensible keyword datatype is usually specified as a union of the WKV and a keyword extension pattern (e.g., KeywordNsExtensionPattern, MimeExtensionPattern). The WKV defines the values that are explicit in the specification and the keyword extension pattern defines the syntax for vendor extended values. Actual vendor extended values are outside the scope of this specification. There are several instances where extensible keywords are defined simply as keyword this is done when the set of explicit keywords is very large (e.g., the set of all the processing and description Element names) and the vendor extensions themselves must be specified as keywords.

While the abstract datatype “list of Xxx” may be unordered for some Elements, the concrete encoding defined is “sequence of Xxx” in XML Schema [W3C-XSD2] and “1setOf Xxx” in IPP/1.1 [RFC2911], both of which are ordered datatypes. Many PWG Semantic Model and IPP/1.1 Elements in fact do depend on ordered values, so implementations should preserve the ordering (e.g., in protocol gateways).

Table 3 Basic Element Datatypes

Abstract Datatype

XML DataType

XML Schema

Reference

Description and IPP Reference

any anyType [W3C-XSD1] 3.4.7

This datatype is used throughout the model to indicate the location of extension points in the model for the PWG or vendors to add Elements in a way consistent with the model. Those who wish to extend the model may do so only at these points.

boolean boolean [W3C-XSD2] 3.3.2

This datatype has two possible values: ‘true’ and ‘false’.See: Section 4.1.11 ‘boolean’ in IPP/1.1 [RFC2911]

base64binary base64binary [W3C-XSD2] 3.2.16

This datatype consists of a sequence of four characters representing a 24-bit value using an encoding processes defined in RFC 2045 [RFC2045]. The encoding process represents 24-bit groups of


89

1407

14081409141014111412

14131414141514161417141814191420142114221423142414251426

14271428142914301431

1432

90


Abstract Datatype

XML DataType

XML Schema

Reference


input bits as output strings of four encoded characters. Proceeding from left to right, a 24-bit input group is formed by concatenating three 8-bit input groups. These 24 bits are then treated as four concatenated 6-bit groups, each of which is translated into a single digit in the base64 alphabet.

Complex complexType [W3C-XSD1] 3.4.1

This datatype is used to indicate that the associated Element is a container for multiple Elements.

list of complex sequence of complexType

[W3C-XSD2] 3.4.1

This datatype is used to indicate the associated Element is an ordered set of containers for multiple Elements.See: Section 4.1.16 ‘1setOf X’ in IPP/1.1 [RFC2911]

dateTime dateTime [W3C-XSD2] 3.3.8

This datatype consists of a string of characters that represent a year, month, day, hour, minute, second and timezone. This datatype is derived from the ISO definition [ISO 8601:2000 Second Edition].See: Section 4.1.14 ‘dateTime’ in IPP/1.1 [RFC2911]

hexBinary hexBinary [W3C-XSD2] 3.3.16

This datatype consists of a sequence of binary octets encoded in a protocol binding-specific safe manner. This datatype is used for opaque data instead of text.See: Section 4.1.10 ‘octetString’ in IPP/1.1 [RFC2911]

Int int [W3C-XSD2] 3.4.17

This datatype consists of a 32-bit signed integer.See: Section 4.1.12 ‘integer’ in IPP/1.1 [RFC2911]

list of int sequence of int [W3C-XSD2] 3.4.17

This datatype consists of an ordered set of 32-bit signed integers.See: Section 4.1.16 ‘1setOf X’ in IPP/1.1 [RFC2911]

range of int restriction of int [W3C-XSD2] 3.4.17

This datatype is a complex type consisting of the Elements “upperBound” and “lowerBound” which are both 32-bit signed integers.See: Section 4.1.13 ‘rangeOfInteger’ in IPP/1.1 [RFC2911]

keyword restriction of NMTOKEN

[W3C-XSD2] 3.4.4

This datatype consists of a string of US-ASCII characters representing a single enumeration value. The legal characters that may be used in defining a keyword are uppercase and lowercase letters, decimal digits, hyphen(-), dot (.), and underscore(_). Colon (:) may also be used, but ONLY for distringuishing namespace prefixes. Vendor extension keywords must be qualified with a prefix of valid characters, followed by a colon (:), and then the vendor’s extended keyword. Note that IPP/1.1 [RFC2911] does not allow the use of uppercase


91

92


Abstract Datatype

XML DataType

XML Schema

Reference


letters. IPP keywords are transformed to XML Schema keywords by deleting hyphens and capitalizing the following letter.See: Section 4.1.3 ‘keyword’ in IPP/.1 [RFC2911]

list of keyword sequence of restriction of NMTOKEN

[W3C-XSD2] 3.4.4

This datatype consists of an ordered set of keywords.See: Section 4.1.16 ‘1setOf X’ in IPP/1.1 [RFC2911]

string string [W3C-XSD2] 3.3.1

This datatype consists of a UTF-8 [RFC3629] encoded human-readable string of Unicode characters as defined in [ISO646] [UNICODE].See: Section 4.1.1 ‘text’ in IPP/.1 [RFC2911]

list of string sequence of string

[W3C-XSD2] 3.3.1

This datatype consists of an ordered set of strings.See: Section 4.1.16 ‘1setOf X’ in IPP/1.1 [RFC2911]

anyURI anyURI [W3C-XSD2] 3.3.19

This datatype consists of a string containing a URI as defined in [RFC3986].See: Section 4.1.5 ‘uri’ in IPP/.1 [RFC2911]

list of anyURI sequence of anyURI

[W3C-XSD2] 3.3.18

This datatype consists of an ordered set of URIs.See: Section 4.1.16 ‘1setOf X’ in IPP/1.1 [RFC2911]

anyURI Scheme restriction of string

[W3C-XSD2] 3.3.1 and 3.3.18

This datatype consists of a URI scheme name as defined in [RFC3986] and registered in [RFC4395], followed by a colon and double slashes (where applicable).See: Section 4.1.6 ‘uriScheme’ in IPP/.1 [RFC2911]

list of anyURI scheme

sequence of restriction of string

[W3C-XSD2] 3.3.1 and 3.3.18

This datatype consists of an ordered set of URI schemes.See: Section 4.1.16 ‘1setOf X’ in IPP/1.1 [RFC2911]

4.2 System Object

The PWG MFD XML Schema [MFD_SCHEMA] is a concise description of an Imaging System , identifying all Elements in the model about which information may be communicated and/or to which operations may be addressed. In this model, the top Element of the Imaging System is the System object. As shown in Error: Referencesource not found, the System includes four mandatory Complex Elements which are basic to the perceived imaging functionality of the Imaging System, three optional Elements and an extension point.

1. Services: The group of Complex Elements performing the functional imaging services associated with an Imaging System . The Elements common to two or more Services are identified sections %% of this specification. Each Service and the Elements and characteristics unique to that Service are individually described in sections %-%


93

1433

1434143514361437143814391440

14411442144314441445

94


2. System Configuration: the set of Subunits contained in the Imaging System , certain of which are used by each Service to implement Service functionality., the Subunits are addressed in Section % of this specification.

3. System Description the Elements of the System object that are administrator settable (e.g., SystemName) constitute the System Description elements. These are described in Section %.

4. System Status: the Elements of the System object that are automatically determioned by the System itself (e.g.,SystemState) are considrered System Status elements.

5. Managers, Agents and Devices: The Elements involved in managing the Services and the actual or virtual devices implementing them. Although represented in the PWG MFD XML Schema [MFD_SCHEMA], these Elements are discussed in a separate specification. [PWG5106.2].

Figure 5 System Object

4.2.1[4.1.1] Overview of Services

The identified Imaging Services are modeled to reflect the typical users’ perception of imaging services; Print, Scan, Fax etc. These intuitive perceptions can be strengthened by considering the relation between each Service and the “outside world”, between other services, and between the Service and the Imaging System itself.

Note from Figure % that the only Service that an Imaging System MUSt include is the SystemControlService.


95

1446144714481449145014511452145314541455145614571458

1459

1460

1461

1462146314641465

14661467

96


Figure 6 - Imaging System Services

4.2.2[4.1.2] SystemConfiguration

The System Object has a SystemConfiguration element that contains all the Subunits configured onSubunit the Imaging Device. System Configuration is described in detail in Section 5. Note that each Service instance contains a Service specific view of the Subunits used by that Service instance. For example a PrintService has a Marker Subunit but ScanService does not.

4.2.3[4.1.3] SystemDescription

Figure 7 is a view of the Imaging Device’s SystemDescription. SystemDescription provides descriptive information for the entire Imaging Device. The element values are administratively set. The element values can be modified directly or modified indirectly through an operation. The SystemDescription group element includes descriptive information such as system name and location, and has an extension point for vendor


97

1468

1469

1470

14711472147314741475

1476

1477

14781479148014811482

98


specific information.. Table 4 lists the SystemControlService specific SystemDescription elements.

Figure 7 SystemDescription


99

14831484

1485

1486

1487

1488

100


Table 4 SystemDescription Elements

Element Name Multivalued Syntax Constraint Group Reference

Description (values) ServicesSupported

Yes List of Keywords

Description

The list of types of services that can be administratively configured to run on this system. (Contains ServiceType)

ServiceTypeNo Keyword Type 3 Description

The keyword for the type of configured service. Values: ServiceTypeWKV, KeywordNsExtensionPattern (e.g., Copy, EmailIn, EmailOut, FaxIn, FaxOut, Print, Resource, Scan, SystemControl, Transform, Vendor) (Included in ConfiguredServices)

4.2.4[4.1.4] SystemStatus

Figure 8 is a view of the Imaging Device’s SystemStatus. SystemStatus provides an optimistic roll-up of state information for the hosted services. What is meant by that is if any Service is ‘Processing’, the SystemStatus State element will be ‘Processing’. This is the case even if one or more of the services are in the ‘Stopped’ state. Table 5 shows the conditions for all SystemStatus “State” values.

The elements values are maintained by automata and cannot be directly set. The element values can be modified indirectly through an operation. For example the PauseAllSystemServices operation on the SystemControlService may result in the change of the State and StateReasons elements.

Table 5 Optimistic Status Roll-up

System Status

Condition

Unknown Initialization phase. State of hosted services are not knownDown All the hosted services are Down or Unknown. The System Service has completed

initializationTesting All the hosted services are Testing, Down or Unknown. At least one hosted Service state


101

1489

1490

1491

1492

1493

14941495149614971498

1499150015011502

15031504

102


is Testing. Stopped All the hosted services are Stopped, Testing, Down or Unknown. At least one Service

state is Stopped.Idle All the hosted services are Idle, Stopped, Testing, Down or Unknown. At least one Service

state is Idle.Processing All the hosted services are Processing, Idle, Stopped, Testing, Down or Unknown. At least

one Service state is Processing.


103

1505

104


Figure 8 SystemStatus


105

1506

1507

106


Table 6 SystemStatus Elements


Description (values) ConfiguredResources

Yes List of ResourceSummary

Status

The list of summary information for the available resources of the system. (Contains ResourceSummary)

ResourceSummaryNo

ComplexStatus [PWG5108.03] §

8.1.5.2, §7.4.2 (See also ResourceSourceUri below)

The summary information for the available resource. (Contains DateTimeAtLastUpdate, ElementsNaturalLanguage, ResourceCategory, ResourceFormat, ResourceId, ResourceName, ResourceSourceUri, ResourceType)

ResourceSourceUriNo URI Status

An identifier for the resource assigned by the creator/supplier of the resource. The value SHOULD be a URN.

ConfiguredServicesYes List of

ServiceSummaryStatus

The list of Service that have been administratively configured to run on this system instance. (Contains ServiceSummary)

ServiceSummaryYes Complex Status

Information about the services that have been administratively configured to run on this system instance. (Contains ServiceType, Id, ServiceXriSupported) (Included in ConfiguredServices)

ServiceTypeNo Keyword Type 3 Status

The keyword for the type of configured service. Values: ServiceTypeWKV, KeywordNsExtensionPattern (e.g., Copy, EmailIn, EmailOut, FaxIn, FaxOut, Print, Resource, Scan, SystemControl, Transform, Vendor) (Included in ServiceSummary)

SystemConfigChangeNumber No Integer Status [RFC3805] §6

Counts configuration changes within the System. A configuration change is defined to be an action that results in a change to any element other than those that reflect status or level, or those that act as counters. (Maps to Printer MIB’s prtGeneralConfigChanges)


107

1508

108



Description (values) SystemTotals

No Complex Status [PWG5106.1] §6.1The SystemTotals counters aggregates counters from all the services offered by the System.

4.3[4.2] Primary Service Interfaces

The Imaging Services and their primary interfaces are represented in Figure 6. All Imaging Services other than the Resource Service (and the System Control Service, which is not shown here) process Jobs that deal with Documents. The Documents may be in either Hardcopy Document form, processed by Scanner or Marker Subunits, or electronic (digital) form, communicated through a network, Fax or Email interface Subunit. All Imaging Services are integral in themselves, interfacing with an external client, repository or communication facility. (Note that “repository” in this context refers to an external Digital Document source or destination, such as a storage medium.) Although the PWG MFD XML Schema [MFD_SCHEMA] does not address work flow, it does define Service interfaces and operations in a manner which would allow the use of some established workflow methodology.


109

1509

1510

15111512151315141515151615171518151915201521

110


Figure 9 Primary Interfaces with Services

The Resource Service is intended to support the image-processing Imaging Services, although it could be used as an independent, but limited, storage/retrieval service. The Resource Service interfaces represented in the figure are those to enter and maintain resources, and those creating a Job Template for submission of a JobCreation request to a Document-processing Imaging Service. It would also be possible for the Document-processing Imaging Services to include or interface with clients which would directly access resources to be used in a Job, such as fonts or forms, from a Resource Service.

The Transform Service is modeled as an independent primary service, accepting Digital Documents from clients and delivering transformed Digital Documents to clients. It is analogous to the Copy Service that takes in a Hardcopy Document and outputs one or more Hardcopy Documents. The Transform Service may also be used in tandem with one or more other Imaging Services in a workflow mode.

All Services actually operate on Digital Documents, using the Scanner Subunit and/or Marker Subunit for the HardcopyDocument/Digital Document conversion. (Note that, for


111

1522

1523

1524152515261527152815291530

15311532153315341535

15361537

112


Copy Service, the Digital Document is totally internal and neither it nor its characteristics are accessible outside the service; therefore, for modeling purposes the Digital Documents is not included in the Copy Service.) Users’ hardcopy interface with a Service is either through a Scanner or Marker Subunit. Users’ “softcopy” and control interface is always through a Client, which may be a remote application or may be access via a local Console contained in the Imaging System . The Repository, which stores Digital Documents before and/or after servicing, may be either contained within the Imaging System or may be remote (such as a network file server), or may be some combination. The Fax transmission/reception facilities may be fully external (e.g., digital network Fax) or partially internal (e.g., PSTN Fax Modem). For functional modeling of the services, it makes no difference if these Subunits are facilities internal to the physical Imaging System or not.

4.4[4.3] Functional Overview of an Imaging System

The Semantic Model is very general, covering an Imaging System hosting anything from one to all of the Imaging Services as well as an Imaging System hosting multiple instances of one or more instances of a given Service. Hosting multiple instances of a Service allows an implementation to expose multiple queues for each Service instance, each with its own set of defaults and capabilities.

The top level relationship view of the Imaging System model is represented in Figure 7, which shows the relationship of Services and Subunits (i.e., System Configuration) within the Imaging System . The root of the model is the “System”, which is more appropriately described in a separate System specification.

System Configuration contains all the Subunits that comprise the Imaging System . These Subunits are the hardware and software entities used by Services to perform their tasks. While the System has a global view of the Subunits, the individual Services contain a Service specific view. The individual Service specifications describe the Service Configuration that may be applicable to that Service type. The Service Configuration identifies the Subunits of the System that are or may be used by that Service.

Each Service (except the Resource and System Control Services, which do not deal with Jobs) also includes a Service Defaults and a Service Capabilities Element. Service Defaults includes the Default Job Ticket and Default Document Ticket, each containing the default ticket values used by that Service. Service Capabilities contains the Job Ticket Capabilities and Document Ticket Capabilities. These provide the allowed values for the Job Ticket and Document Ticket respectively.

Each Service (except the Resource and System Control Services) may contain zero or more Jobs. Jobs reflect user intent as submitted via Job Tickets and possibly Document Tickets. Jobs waiting to be processed or currently being processed are considered Active Jobs. Jobs that have reached a terminated state (i.e., Completed, Aborted, or Canceled)


113

153815391540154115421543154415451546154715481549

1550

15511552155315541555

1556155715581559

156015611562156315641565

156615671568156915701571

1572157315741575

114


are under Job History. Whether or not the Job History list is implemented and how long Jobs remain on the Job History list is implementation specific.

Figure 10 Relationships within a Multifunction Device


115

15761577

1578

1579

116


4.5[4.4] Jobs, Documents, Tickets, Receipts and Templates

The Imaging System Semantic Model uses terms in a specific way that may not be familiar. Because these terms and the concepts they represent are integral to the definition of all Imaging Services, this section provides conceptual definitions

A Document is text and/or graphic information that initially and/or ultimately is displayed on hardcopy media or on some display device. Documents may be in hardcopy form (Hardcopy Document) or any number of electronic forms (Digital Document). Imaging Services handle Documents by:

1. Converting Documents between hardcopy and electronic forms (scan and Print)2. Duplicating Documents in hardcopy form, usually going through an electronic

form (Copy)3. Transmitting Documents electronically (Facsimile)4. Transforming Documents from one electronic form to another (Transform)

A Job is the work Element by which one or more Documents are submitted to a service. A Job includes:

1. The Document(s) or reference to the Document(s) which are the objects to be serviced (although, for some Services, there can be a time during Job creation where a Job does not yet have a Document.)

2. A Job Ticket, which contains instructions of how the Document(s) should be processed, identification information on the Documents, descriptive information about the Job and optionally one or more Documents, and associated metadata. The Job Ticket Document Processing instructions apply to all Documents within the Job unless overridden at the Document level with a Document Ticket.

Support of multi-Document Jobs is optional. Some services, such as FaxIn, cannot distinguish separate Documents and are effectively limited to one Document per Job. The Service’s support for multi-Document Jobs can be determined by examining the Service Capabilities.

Once a Job has been created, its Status may be updated with information about the servicing and the state of the Job. This provides useful for Job management, tracking and billing.

A Ticket is a data object created by a Service and bound to a Job or Document. The ticket contains an end user’s Intent for Job and Document processing and the descriptive properties of a Job and optionally one or more Documents.

1. A Job Ticket relates to the Job and all Documents in the Job, except those for which a Document Ticket is created.


117

1580

158115821583

1584158515861587

15881589159015911592

15931594

15951596159715981599160016011602

1603160416051606

160716081609

161016111612

16131614

118


2. A Document Ticket relates to a specific Document and any property specified in a Document Ticket overrides the value of that property that may be specified in the Job Ticket.

A Template, in this context, may be a Job Ticket Template or a Document Ticket Template. It is a partially filled out Ticket not yet bound to a specific Job or Document, but which represents an often-used (or preferred by policy) set of instructions. Templates are completed and/or modified within the Service to form specific Job or Document Tickets.

The Job Receipt is produced by a Service. It contains the actual values of processing Elements used by the Service for processing the Job, usually including some information from the Job Ticket.

The Document Receipt is produced by a Service for Documents for which the user has supplied a Document Ticket. The Document Receipt contains the actual values of processing Elements used by the Service for processing the Document, including information from the Job Ticket.

4.6[4.5] Job and Job Ticket Life Cycle

The relationships among the Elements associated with a Service are shown in Figure 14. This discussion is applicable to Scan, Print, Copy, FaxOut and Transform Imaging Services, although aspects of these relationships specific to each Service will be discussed in each specific Service specification. The Document and Document Ticket lifecycle is similar to the Job and Job Ticket lifecycle. The main differences are that:

1. A Document Ticket contains only Document Description and Processing Elements,

2. A Document Ticket is bound to a Document and, 3. The Document creation operations are Send Document and Add Document.

The Job Ticket is a data object that contains Job descriptions and Job and Document processing instructions. The Job Ticket life cycle is bound to the lifecycle of its associated Job. The Job is created when a Client initiates a Create Job operation. The Create Job can come from a Remote User interacting with an Application or by a Walkup User interacting with a User Interface and pressing the “START” button. In either case the user is able to communicate his Intent through the protocol. The general sets of operations available to the User and to the Administrator are described in Section 0.

Prior to the Create Job submission, a Job Template can be selected or created. If available, a preconfigured Job Template can be retrieved from a data store outside the scope of this specification. For example the Resource Service can be used to retrieve a Job Template from such a repository. Alternatively a Job Template can be created by instantiating the associated XML Schema or retrieving the Default Job Ticket from the Service.


119

161516161617

1618161916201621

162216231624

1625162616271628

1629

16301631163216331634

1635163616371638

1639164016411642164316441645

164616471648164916501651

120


A Job Template is a Job Ticket that is not bound to any Job or Service. It is used as a convenience or to standardize the submission of future Jobs. A Job Template can be created in a number of ways. Some examples are:

1. A walk-up end user uses the Local application and User Interface to create a Job Template by configuring a set of preferred values for Job and Document Processing and Job Description.

2. An end user uses a remote application (in a computer) to create a Job Template by configuring a set of preferred values for Job and Document Processing and Job Description.

3. A walk-up end user or Remote user creates a Job Template by retrieving the Services Default Ticket and optionally modifying the values.

4. A walk-up end user or Remote user retrieves a Job Template from a Resource Service and optionally modifies the values.

The Job Template can then be modified to meet the user’s Intent. The Service also makes available the Service Capabilities that list all the allowed values for a Job’s Job Ticket for that instance of the Service. Once the Job Template fully embodies the User’s Intent, it can be bound to a Create Job operation parameter to send to the Service.

The Service creates a Job based on the parameters in the Create Job operation. The Job’s Job Ticket is created based on the user supplied parameters. The Job Ticket remains bound to the Job until the Job is eventually deleted.

The Services’ Service Job Ticket Capabilities can be retrieved to provide the set of allowed values when modifying the Job Template

If an end user does not select a Job Template, then the processing instructions are the Default Job Ticket values. The Default Job Ticket can be administratively modified to control default behaviors for the associated Service.


121

165216531654

1655165616571658165916601661166216631664

1665166616671668

166916701671

16721673

167416751676

122


Figure 11 UML Diagram Showing Relationships Relative to Job Ticket


123

1677

1678

124


When a Job Ticket is created, it is bound to the end user’s Job by the Service. The Service manages and processes the Job according to the instructions supplied in the Job Ticket. If a processing instruction in the Job Ticket cannot be supported, the Service either returns an error or substitutes the instruction with another that best matches the user’s intent. The actual values used for processing the Job are captured in the Job Receipt of the Job in the Job History queue, which can be queried later.

After a Job is completed, it is moved to the Job History queue. A Job is deleted from the Service when it is deleted from the Job History according to a set of site-specific Job History retention rules.

The Job Ticket lifecycle ends as soon as the Job Ticket is deleted along with the Job.


125

167916801681168216831684

168516861687

1688

1689

126


5. System ConfigurationThe System Configuration represents device semantics in the Imaging System Model. The included Elements are semantically aligned with objects in the Printer MIB [RFC3805] and the Elements in the DMTF CIM Printing classes defined in [CIM-SCHEMA].

The System Configuration includes all of the Subunits used (or that could be used) by any of the Services in the Imaging System . For purposes of the model, Subunits are considered in terms of how they relate to Service functionality and Job processing, including configuration and statistics.

Figure 15 shows and Table 3 describes the Subunit Types that may be part of System Configuration and each Configuration. These types are derived primarily from the groups used in the Printer MIB [RFC3805] or the HR MIB [RFC2790] as referenced in the Printer MIB. The System may have 0 to 1 instances of each Subunit type. If a Subunit type exists, there may be one or more instances of the Subunit (although, in the case of some Subunits, such as Cover, that may not be applicable.) No Service uses all possible Subunits; rather, each Service instance has a Configuration which identifies the Subunits that may be used by an instance of that Service.


127

1690

169116921693

1694169516961697

16981699170017011702170317041705

128


Figure 12 Elements in System Configuration

Each instance of a Subunit has Status and Description complex Elements. The values of Status Elements are determined by the nature or state of the equipment and cannot be directly set by the user or administrator. Description Elements can be set by the users or administrator in Subunit or system configuration.

Table 7 Subunits

Subunits Reference DescriptionConsoles prtConsole User Interface Console(s) used to display and modify the


129

1706

1707

1708170917101711

1712

130


Subunits Reference Description[RFC3805] state of the Device, Service, and Job. It may also use for

setting configuration, generating and modifying Job Tickets and getting Service history and statistical information

Covers prtCover[RFC3805] covers, doors, housings and interlocks. FaxModems [RFC1696] PSTN modems used to transmit and receive Digital

DocumentsFinishers prtOutput and all of

RFC3806 [RFC3806]performs some operations on the media other than marking

InputChannels prtChannel [RFC3805]

source of Job (or Resource) control information and, for some services, the input of Digital Documents

InputTrays prtInput [RFC3805] mechanisms that feed media to be marked on into the Media Path

Interfaces RFC2863 [RFC2863] communication ports and associated protocol stacks into and out of the Server. The Input and Output Channels utilize the Interfaces.

Interpreters prtInterpreter [RFC3805]

conversion of Digital Documents into images that are to be marked on the media, of scanned images into Digital Documents of the desired format, and Digital Documents from one format to another.

Markers prtMarker [RFC3805] produces marks on media. Includes both the mechanism and the associated supplies

MediaPaths prtMediaPath [RFC3805]

the mechanisms that move the media which is to marked and connects all marking related Subunits: Input Trays, Output Trays, Markers and Finishers.

Output Channels prtChannel [RFC3805]

destination pathways for Service Request responses and, for Imaging Services with a Digital Document output; the destination pathways for these Documents.

OutputTrays prtOutput [RFC3805] general purpose trays capable of receiving Hard Copy Documents that have been Printed or scanned. This Element may not be applicable to Scanner Subunits equipped with an ADF that re-circulates the media if the ADF is the only destination of the Hard Copy Documents handled by the ADF.

Processors RFC2790[RFC2790] hrProcessorTable

computing and logical Elements of device, including associated operational memory, that typically execute the device software and/or firmware

ScanMediaPaths [PWG5108.2] encompasses the mechanisms that move the media to be scanned This can include an Automatic Document Feeder for Scanner Subunits so equipped.

Scanners [PWG5108.2] - mechanism that acquires the image of the selected Scan of a Hardcopy Document

Storages prtStorage and RFC2790[RFC2790] hrStorage

mechanism that stores and allows retrival of Digital Documents and/or resources


131

132


Subunits Reference DescriptionVendor Subunits Implementation-specific Elements for which status and

description information should be available

Many Status Elements and Description Elements are common to all Subunits. Other Elements reflect the specific nature of the Subunits type. In the subsequent paragraphs of this section, the Elements constituting each Subunit are outlined in Schema graphic segments and the Subunit-specific Elements are described in tables. Note that, at various levels, an “Any” Element is provided as an Element extension point to allow vendor product differentiation by implementation-specific Element extensions while maintaining interoperability. This Element of type “Any” appears through the models to provide vendor extensibility.

5.1 Common Subunit Elements

The Status and Description Elements common to most Subunits are grouped into the complex types Subunit Status and Subunit Description, respectively. Following the Imaging System modeling convention, Subunit Status contains Elements which define the basic characteristics, state or condition of the Subunit; the values of Status Elements are not subject to administrator modification or reset. Subunit Description contains Elements which are intended to be set by the administrator. The descriptions of these common Subunit Elements are presented once in this section rather than being repeated for each Subunit. The individual descriptions of Subunits that include these Subunit Status and Subunit Description complex Elements refer back to this section.

There will typically be Power Management Elements, derived from the PWG Power Management Model [PWG 5106.4] associated with and operating on the System (i.e., on the Imaging System as a unit). The description of these complex Elements is appropriate to the System specification. However, within the Imaging System model, the Subunits correlate most closely to the physical components of the Imaging System . Because the various Services in an Imaging System which employ the Subunits may be used at different times and under different circumstances, it may be desirable to have independent power control of the various Subunits. Therefore, the Subunit Status and Subunit Description complex Elements include Power Status and Management Elements. Because of this inclusion, the common Subunit Element groups are not constituent Elements of Subunits for which Power Management Elements are considered inapplicable, such as Covers and software-based Subunits including Interpreters, Input Channels and Output Channels.

5.1.1 Common Subunit Status Elements

The Subunit Status complex type is represented in Figure 16 and described in Table 4. Subsequent subsections describe the constituent power-related complex types. Subunit Status Elements are inherently read-only.


133

17131714171517161717171817191720

1721

172217231724172517261727172817291730

1731173217331734173517361737173817391740174117421743

1744

174517461747

134


Figure 13 SubunitStatus Elements

Table 8 Description of SubunitStatus Elements

Element DataType Description or Keyword Group

Reference

DeviceErrors int count of detected errors may or may not be power persistent

hrDeviceErrors [RFC2790]

ID int unique value for each instance of the Subunit in the Imaging System

hrDeviceIndex [RFC2790]

PowerCounters complex See 3.1.1.1PowerMeters complex See 3.1.1.2PowerMonitor complex See 3.1.1.3PowerSupport complex See 3.1.1.4PowerTransition complex See 3.1.1.5ProductID string manufacturer’s ID for the

SubunithrDeviceID [RFC2790]

SubunitStates keyword current operational state of the Subunit SubunitStateWKV

hrDeviceStatus [RFC2790]


135

1748

1749

1750

1751

136


5.1.1.1 Power Counters

Power Counters track major power state transitions. Hibernate, On, Standby and Suspend are stable power states, and are defined in an Imaging Device context in the PWG Power Management Model [PWG 5106.4]. The Power Counter Element is represented in Figure 17 and its Elements identified in Table 5. These counters are specified as persistent across power cycles and hardware reconfigurations.

Figure 14 Power Counters Schema

Table 9 Power Counter Elements

Element DataType Description Reference(PWG Power Management

Model [PWG 5106.4]Power Counters complex Para 5.4

HibernateTransitions int Para 5.4.1OnTransitions int Para 5.4.2StandbyTransitions int Para 5.4.3SuspendTransitions int Para 5.4.4Any Various Extensions to Power Counters

5.1.1.2 Power Meters

Power Meters includes a group of meter Elements concerned with keeping track of the power consumption of the Subunit. This complex Element is represented in Figure 18, with the component Elements identified in Table 6. The Power Meters Are Actual Element is a Boolean allowing the use of either measured or anticipated power consumption values. Power Peak Watts tracks the maximum energy drawn by the Subunit since the last reboot and is inherently not power persistent. The Power Current Month KWH Element accumulates power consumption values (or estimates) in real time. It may be expected to be continually increasing and to be power persistent during the month. At the end of each month the value is transferred to the Power Previous Month KWH Element


137

1752

17531754175517561757

1758

1759

1760

1761

1762

176317641765176617671768176917701771

138


value. Power Lifetime KWH is, of course, persistent over power and reconfiguration cycles.

Figure 15 Power Meters Schema

Table 10 Power Meter Elements


Reference(PWG Power Management

Model [PWG 5106.4]PowerMeters Complex the current power meters for each

System or Subunit

PowerMetersAreActualboolean power meter values are actual

measurement(true) or estimation (false)

Para 5.5 [PWG 5106.4]

PowerCurrentWatts int current power consumption in watts

Para 5.5.1 [PWG 5106.4]

PowerPeakWatts int peak power consumption in watts Para 5.5.2 [PWG 5106.4]

PowerCurrentMonthKWH

int current month's power consumption in kilowatt hours

Para 5.5.3 [PWG 5106.4]

PowerPreviousMonthKWH

int previous month's power consumption in kilowatt hours

Para 5.5.4 [PWG 5106.4]

PowerLifetimeKWH int lifetime power consumption in kilowatt hours

Para 5.5.5 [PWG 5106.4]

Any Various Extensions to PowerMeters


139

17721773

1774

1775

1776

140


5.1.1.3 Power Monitor

The Power Monitor Elements for a Subunit identifies the current power state of the Subunit. This complex Element consists of just a Power State Element and a Power State Message Element. The representation is Figure 19 and the Elements are identified in Table 7.

Figure 16 Power Monitor Schema

Table 11 Power Monitor Elements



Model)[PWG 5106.4]

Power Monitor complexPowerState keyword PowerStateWKV Para 5.2.1 [PWG 5106.4]PowerStateMessage string human-readable that

describes, explains, or qualifies the current power state

Para 5.2.2 [PWG 5106.4]

Any various Extensions for Power Monitor

5.1.1.4 Power Support

The Power Support complex Element lists the supported stable power states for the Subunit along with the functional and power consumption characteristics of the Subunit in each state. The complex Element is represented in Figure 20 and the constituent Elements identified in Table 8.

The Can Use Interfaces Element specifies the Interfaces, listed in a string, that are not inherently disabled when the Subunit is in the identified state, not necessarily that these interfaces can be used. That is, this Element does not report the disabled or down conditions of the Interfaces. Although identified as a string datatype, the value must be in the format “<ID1>,…,<IDn>” (e.g., 1,3,4) and must contain a comma-delimited list of Interface ID values (XML Schema) or corresponding if Index values (SNMP MIB). When this Element is instantiated on a Subunit, it must have the same value as corresponding Element in the System object.


141

1777

1778177917801781

1782

1783

1784

1785

1786178717881789

17901791179217931794179517961797

142


Figure 17 Power Support Schema

Table 12 Power Support Elements



Model) [PWG 5106.4]Support Entry Complex

CanAcceptJobs boolean Para 6.1.5 [PWG 5106.4]CanProcessJobs boolean Para 6.1.6 [PWG 5106.4]

CanRequestPowerStateboolean Para 6.1.7 [PWG 5106.4]

CanUseInterfaces string list of interfaces that can be used see 3.1.1.4

Para 6.1.8 [PWG 5106.4]

PowerActiveWatts int Para 6.1.3 [PWG 5106.4]PowerInactiveWatts int Para 6.1.2 [PWG 5106.4]PowerPeakWatts int Patra 6.1.4 [PWG 5106.4]PowerState keyword PowerStateWKV Para 6.1.1. [PWG 5106.4]Any various Extensions for Power

SupportEntry

5.1.1.5 Power Transition

This complex Element identifies the design value of the transition time between one stable power state and another. As shown in Figure 21 and listed in Table 9, it is constitued of three Elements: the Starting Power State, the Ending Powerstate and the Transition Time.


143

1798

1799

1800

1801

1802

180318041805

144


Figure 18 Power Transition Schema

Table 13 Power Transition Elements



Model [PWG 5106.4]TransitionEntry Complex

EndPowerState keyword PowerStateWKV Para 6.2.1 StartPowerState keyword PowerStateWKV Para 6.2.2StateChangeSeconds int Time in Seconds Para 6.2.3Any various Extensions to Power

TransitionEntry

5.1.2 Common Subunit Description Elements

The common description Elements for Subunits are identified in Figure 22 and Table 10. Following the convention, Description Elements are those which can be set. As with the common Subunit Status Elements, many of the common Subunit description Elements are power related, but these are settable power Elements. The Elements contained under Subunit Description are described in the following paragraphs.

Figure 19 Subunit Description Schema

Table 14 Description of Subunit Description Elements


145

1806

1807

1808

1809

18101811181218131814

1815

1816

1817

146



Reference

Description string textual description of the Subunit, possibly identifying manufacturer, revision and serial number

hrDeviceDescr (hrDeviceTable of [RFC2790]

PowerCalendar complex See 3.1.2.1PowerEvent complex See 3.1.2.2PowerTimeout complex See 3.1.2.3

5.1.2.1 Power Calendar

Figure 20 Power Calendar Schema

Table 15 Power Calendar Elements



Model [PWG 5106.4]CalendarEntry Complex

Id int Id of entry, policy Para 7.3.1 [PWG 5106.4]

RequestPowerStatekeyword PowerStateWKV Para 7.3.2 [PWG 5106.4]


147

1818

1819

1820

1821

1822

148




Model [PWG 5106.4]

CalendarRunOnceboolean Once vs recurring Para 7.3.3. [PWG 5106.4]

CalendarDayOfWeekkeyword Requested time of transition

to indicated power statePara 7.3.4 [PWG 5106.4]

CalendarMonth keyword Para 7.3.5 [PWG 5106.4]CalendarDay keyword Para 7.3.6 [PWG 5106.4]CalendarHour int Patra 7.3.7 [PWG 5106.4]CalendarMinute int Para 7.3.8 [PWG 5106.4]Any Various Extensions to

CalendarEntry

5.1.2.2 Power Event

The Power Event complex type defines administrator set policies requesting that the Subunit be placed in a specified power state on the occurrence of a specified event. For example, a Marker Subunit might be put in a Standby power state when the required media stock is determined to be not accessible. The Power Event complex Element is represented in Figure 24 and the constituent Elements of this complex Element are identified in Table 12.

Figure 21 Power Event Schema

Table 16 Power Event Elements


Reference (PWG Power Management

Model) [PWG 5106.4]EventEntry complex

id int Number of power event policy Para 7.4.1 [PWG 5106.4]EventName string See 3.1.2.2, above Para 7.4.2 [PWG 5106.4]


149

1823

1824

182518261827182818291830

1831

1832

1833

150


RequestPowerState keyword PowerStateWKV Para 7.4.3 [PWG 5106.4]Any Various Extensions to Power

EventEntryNote that the Event Name Element, identifying the event on which the power state is to be set, must be structured as either:(a) The exact case-sensitive label (starting with a lowercase character) of an enumerated value in the PrtAlertCodeTC textual convention in the IANA Printer MIB [IANAPRT] (e.g., ‘jam’); or (b) A case-sensitive keyword (starting with an uppercase character) vendor event name (e.g., ‘AcmeCrackedCrock’).

5.1.2.3 Power Timeout

This complex Element allows for specifying timeout polices by which a Subunit is to revert to a lower power state after some specified period. The complex Element is represented in Figure 25 and the constituent Elements are identified in Table 13.

Figure 22 Power Timeout Schema

Table 17 Power Timeout Elements



Model [PWG 5106.4]TimeoutEntry Complex

Id int Id of entry, policy Para 7.2.1 [PWG 5106.4]

RequestPowerStatekeyword PowerStateWKV Para 7.2.2 [PWG 5106.4]

StartPowerState keyword PowerStateWKV Para 7.2.3 [PWG 5106.4]TimeoutSeconds int Para 7.2.5 [PWG 5106.4]TimeoutPredicate keyword TimeoutPredicateWKV Para 7.2.4 [PWG 5106.4]


151

183418351836183718381839

1840

184118421843

1844

1845

1846

1847

152




Model [PWG 5106.4]Any Various Extensions to Power

TimeoutEntry

5.2 Consoles

This is a complex Element that represents a user or operator interface panel. It is technically aligned with the prtConsoleGroup [RFC3805]. The constituents of the Console Subunit complex Element are represented in Figure 26 and described in .Table 14.


153

1848

184918501851

154


Figure 23 Console Subunit Schema

Table 18 Console Elements


155

1852

1853

1854

156



Reference (all [RFC3805]*)

ConsoleDescription complexSubunitDescription complex See 3.1.2

ConsoleNumberOfDisplayChars

int number of characters per line displayed on the physical display.

prtConsoleNumberOfDisplayChars

ConsoleNumberOfDisplayLines

int number of lines on the Printer’s physical display.

prtConsoleNumberOfDisplayLines

Any various Extension point for ConsoleDescription

ConsoleStatusSubunitStatus complex See 3.1.1ConsoleDisable boolean input is accepted from the

operator console.prtConsoleDisable

ConsoleDisplayBuffer complex Physical display buffer for Printer console display or operator panel.

prtConsoleDisplayBufferTable

ConsoleDisplayText list of string

Contents of buffer associated with each physical line on the display or operator panel

prtConsoleDisplayBufferEntry

ConsoleLights complex Set of indicatorsConsoleLight list of

complex ConsoleLight

description and state information for each light present on the Printer console.

prtConsoleLightTable and prtConsoleLightEntry

ConsoleLightOnTimeint defines the current status of the

light in conjunction with ConsoleLightOffTime

prtConsoleOnTime

ConsoleLightOffTimeint defines the current status of the

light in conjunction with ConsoleLightOnTime,.

prtConsoleOffTime

ConsoleLightColorkeyword color of this light.

ConsoleLightColorWKV prtConsoleColor

ConsoleLightInfostring prtConsoleDescription

ConsoleNaturalLanguagestring language, country, and character

set to be used for the console. prtConsoleLocalization and [RFC3066]

Any various Extension point for ConsoleStatus

Error: Reference source not found is a detailed schema of the Console Lights Element. Note that four Elements are available to configure each console light. Console Light Color


157

18551856

158


and Console Light Info are self-explanatory. Console Light On Time and Console Light Off Time define the current status of the light. If both are non-zero, the lamp is blinking and the values presented define the on time and off time, respectively, in milliseconds. If Console Light On Time is zero and ConsoleLightOffTime is non-zero, the lamp is off. If Console Light Off Time is zero and Console Light On Time is non-zero, the lamp is on. If both values are zero, the lamp is off.

Figure 24 Console Lights Schema

5.3 Covers

This complex Element represents a device’s covers, doors, housings or interlocks. It is technically aligned with prtCoverTable [RFC3805]. The constituents of the Cover Subunit complex Element are represented in Figure 28 and described in Table 15.


159

185718581859186018611862

1863

1864

1865

186618671868

160


Figure 25 Cover Subunit Schema

Table 19 Cover Elements


Reference (All [RFC3805])

CoverDescription complex The Cover Subunit does not include the Power provisions in the standard Subunit Description and therefore uses a specific CoverDescriptionType.

[RFC3805]

Description string String description of coverAny various Extension point for

CoverDescriptionCoverStatus

CoverIsOpen boolean


161

1869

1870

1871

162


CoverSubunitTypekeyword Differentiates between cover,

interlock, etc. CoverSubunitTypeWKV

Any various Extension point for CoverStatusAny various Extension point for Cover

5.4 FaxModems

This complex Element models the Subunit that provides the interface of the FaxIn and FaxOut Services with the public switched telephone network. It is technically aligned with the mdmMib [RFC1696]. The FaxModem Subunit contains many Elements, with the top structure represented in Figure 29; the FaxModem Description structure represented in Figure 30 and described in Table 16 and the Fax Modem Status structure is represented in Figure 31 and described in Table 17.

Figure 26 FaxModem


163

1872

187318741875187618771878

1879

1880

1881

164


Figure 27 FaxModem Description

Table 20 Fax Modem Description Elements


Reference (All[RFC1696])

FaxModemDescription complex[RFC1696]SubunitDescription complex See 3.1.2

AudioVolume intCallSetUpFailTimer intDialingMethod keywordDTEInactivityTimeout int


165

1882

1883

1884

166




DTESyncAsyncMode keyword DTESynchModeWKVDTESyncTimingSource keyword DTESynchWKVEscapeAction keyword CCEscapeActionWKVFaxModemInfo stringFaxModemName stringFaxModemModel stringFaxModemVersion stringFaxModemSerialNumber stringFaxModemVendorName string

FaxModemLineCapabilitieslist of keywords

LineCapabilityWKV

FaxModemDTROnToOff keyword DTRToOffWKVFaxModemDTROffToOn keyword DTRToOnWKVNumberOfRetries intRingsBeforeAnswer intAny various Extension point for

FaxModemDescription


167

168


Figure 28 FaxModem Status

Table 21 Fax Modem Status Elements



FaxModemStatus complex [RFC1696]SubunitStatus complex See 3.1.1CompressionTypeUsed keyword CompressionType


169

1885

1886

1887

170


ConnectionFailReason keyword ConnectionFailReasonWKVCurrentLineReceiveRate intCurrentLineTransmitRate intErrorControlUsed keyword ErrorControlWKVLineCarrierLossTime intModulationSchemeUsed keyword ModulationSchemeUsedAny various Extension point for

FaxModemStatusAny various Extension point for FaxModem

5.5 Finishers

This complex Element represents the devices handling the Printed media as it emerges from the Marker Subunit. It is technically aligned with finDevice in the Finisher MIB [RFC3806] and the updates in the IANA Finisher MIB [IANA-FIN]. The constituents of the Finisher Subunit complex Element are represented in Figure 32 and described in Table 18.

Figure 29 Finisher


171

1888

18891890189118921893

1894

1895

172


Figure 30 FinisherDescription


173

1896

1897

1898

1899

174


Figure 31 FinisherStatus

Table 22 Finisher Subunit Elements

Element Datatype Description or Keyword Group

Reference

FinisherDescription complexSubunitDescription complex See 3.1.2FinisherType keyword FinisherTypeWKV FinDeviceTypeTC [RFC3806]

updated to [IANA-FIN] and finDeviceType [RFC3806]

FinisherCapacityUnit keyword SubunitCapacityUnitWKV finDeviceCapacityUnit [RFC3806] and PrtCapacityUnitTC [RFC3805]

FinisherMaxCapacityBasiskeyword ObjectCounterBasisWKV finDeviceMaxCapacity

[RFC3806]FinisherMaxCapacity counter finisher maximum capacity (in finDeviceMaxCapacity


175

1900

1901

1902

1903

176



Reference

units specified by FinisherCapacityUnit)

[RFC3806]

Any various Extension point for FinisherDescription

FinisherStatus complexSubunitStatus complex See 3.1.1FinisherPresentOnOff keyword SubunitPresentOnOffWKV PresentOnOff [RFC3805]

updated to [IANA-PRT] & finDevicePresentOnOff [RFC3806]

FinisherCurrentCapacity int finDeviceCurrentCapacity [RFC3806]

FinisherAssociatedMediaPaths

string finisher associated media paths (bit-mask of values of MediaPathId)

finDeviceAssociatedMediaPaths (bit-mask) [RFC3806]

FinisherAssociatedOutputTrays

string finisher associated output trays (bit-mask of values of OutputTrayId)

finDeviceAssociatedOutputs (bit-mask) [RFC3806

FinisherSupplies complex See Error: Reference source not found and Error: Reference source not found

Any various Extension point for FinisherStatus


177

178


Figure 32 FinisherSupply

Table 23 FinisherSupply Elements

Element DataType

Description or Keyword Group

Reference (RFC3805 and RFC3806)

FinisherSupplyStatus complexId int Index of finisher supplies for

finisherfinSupplyIndex in [RFC3806]

FinisherSupplyCurrentLevelBasis

keyword ObjectCounterBasisWKV finSupplyCurrentLevel [RFC3806]

FinisherSupplyCurrentLevelint finisher supply current level (in

units specified by FinisherSupplyCapacityUnit)

finSupplyCurrentLevel [RFC3806]

FinisherSupplyMediaInputscomplex See Error: Reference source not

found and Error: Reference source not found

Any various Extension point for FinisherSupplyStatus

FinisherSupplyDescription complexFinisherSupplyClass keyword MarkerSupplyClassWKV prtMarkerSuppliesClass

[RFC3805]


179

1904

1905

1906

180


Element DataType


Reference (RFC3805 and RFC3806)

FinisherSupplyType keyword MarkerSupplyTypeWKV prtMarkerSuppliesType [RFC3805]

FinisherSupplyInfo string prtMarkerSuppliesDescription [RFC3805]

FinisherSupplyColorName string prtMarkerSuppliesColorantIndex [RFC3805]

FinisherSupplyCapacityUnitkeyword MarkerSupplyCapacityUnitWKV prtMarkerSuppliesSupplyUnit

[RFC3805]

FinisherSupplyMaxCapacityBasis

keyword ObjectCounterBasisWKV

FinisherSupplyMaxCapacityint prtMarkerSuppliesMaxCapac

ity [RFC3805]Any various Extension point for

FinisherSupplyDescription

Figure 33 FinisherSupplyMediaInput

Table 24 FinisherSupplyMediaInput Elements


181

1907

1908

1909

182


Element DataType


Reference

FinisherSupplyMediaInputDescription

complex

FinisherSupplyMediaInputType keyword Input TrayTypeWKV PrtInputTypeTC in [RFC3805] & finSupplyMediaInputType [RFC3806]

FinisherSupplyMediaInputInfo string finSupplyMediaInputDescription [RFC3806]

FinisherSupplyMediaInputName string finSupplyMediaInputName [RFC3806]

Any various Extension point for FinisherSupplyMediaInputDescription

FinisherSupplyMediaInputStatus complexId int finisher supply media

input local unique integer key

finSupplyMediaInputIndex [RFC3806]

FinisherSupplyMediaInputStates keyword SubunitStateWKV

FinisherSupplyMediaInputSecuritykeyword SubunitPresentOnOff

WKVfinSupplyMediaInputSecurity (PresentOnOff) [RFC3806]

FinisherSupplyMediaInputMediaSizeName

string finisher supply media input current media size name

Media Size Self-Describing Names section 5 [PWG5101.1] & finSupplyMediaInputMediaName [RFC3806]

FinisherSupplyMediaInputMediaType

string finisher supply media input current media type

Media Type Names section 3 in [PWG5101.1] & finSupplyMediaInputMediaType [RFC3806]

FinisherSupplyMediaInputMediaInfostring finisher supply media

input current media info (weight, etc.)

finSupplyMediaInputMediaWeight & finSupplyMediaInputMediaThickness [RFC3806]

Any various Extension point for FinisherSupplyMediaInputStatus

5.6 Input Channels

This complex Element represents the source of Job control information, Resource Requests and Digital Documents input to Imaging Services. It is technically aligned with prtChannelTable [RFC3805]. The constituents of the Input Channel Subunit complex Element are represented in Figure 35. Input Channel Elements are identified in Table 21.


183

1910

1911191219131914

184




InputChannelDescription complex See Note 1 below.Description string prtChannelInformationInputChannelType keyword InputChannelTypeW

KVPrtChannelTypeTC

InputChannelProtocolVersion string input channel protocol version (refines InputChannelType)

prtChannelProtocolVersion

InputChannelAuxInfo string input channel auxiliary information in a structured string

PrtChannelTypeTC prtChannelInformation


185

1915

186




Any various Extension point to InputChannelDescription

InputChannelStatus complex See Note 1 below.DeviceErrors int hrDeviceErrors[RFC2790]Id int prtChannelIndex

InputChannelDefaultJobControlLanguage

complex Refers to instance of langage interpreter See Note 2 and Elements of an Interpreter, Error: Reference source not found

prtChannelCurrentJobCntlLangIndex

InputChannelDefaultPageDescriptioncomplex Refers to instance

of langage interpreter See Note 2 and Elements of an Interpreter, Error: Reference source not found

prtChannelDefaultPageDescLangIndex

InputChannelInterface complex Refers to instance of Interface- See Note 2 and Elements of an Interface, Error: Reference source not found

prtChannelIfIndex

InputChannelIsAcceptingJobs boolean input channel is accepting Jobs (if true)

PrtChannelStateTCprtChannelState

ProductID string hrDeviceID [RFC2790]SubunitStates keyword SubunitStateWKV prtChannelStatusAny various Extension point for

InputChannelStatusAny vario

usExtension point to InputChannel

Notes:Because the Input Channel Subunit is considered software, it does not include the Power Elements in the standard Subunit Description and Subunit Status complex Elements. Therefore, these common Subunit complex Elements are not constituent Elements of the Input Channel Subunit, although some of the constituent Elements of these common complex Elements (such as Product ID) are independently included.The Default Job Control Language, Default Page Description and Interface Elements of the Input Channel Subunit refer to instances of Interpreter and Interface Subunits and are composed of the


187

19161917191819191920192119221923

188


Elements defined those Subunits. Please see the corresponding Subunit paragraph for the description of these Elements.

*Unless otherwise indicated

5.7 Input Trays

This complex Element represents the mechanisms containing and supplying the Media to be marked in a Marker Subunit. It is technically aligned with prtInputTable [RFC3805]. As shown in Figure 36, the constituents of the Input Tray Subunit complex Element are Input Tray Description, Input Tray Status and Any These Elements are described in Table 22. Input Tray Description (Figure 37) and Input Tray Status (Figure 38) are shown with their Elements described in Table 23 and Table 24.

Figure 34 Input Tray


189

1924192519261927

1928

192919301931193219331934

1935

1936

190


Figure 35 Input Tray Description

Table 25 Input Tray Description Elements

Element DataType Description or Keyword Group Reference (all [RFC3805])

InputTrayDescription complexInputTrayType keyword InputTrayTypeWKV prtInputType InputTrayName string prtInputName InputTrayVendorName string prtInputVendorName InputTrayModel string input tray /vendor-supplied model

of SubunitprtInputModel


191

1937

1938

1939

192


Element DataType Description or Keyword Group Reference (all [RFC3805])

InputTrayVersion string input tray vendor-supplied version prtInputVersion InputTraySerialNumber string input tray vendor-supplied serial

number of SubunitprtInputSerialNumber

InputTrayCapacityUnit keyword SubunitCapacityUnitWKV PrtCapacityUnitTC InputTrayMaxCapacityBasis keyword ObjectCounterBasisWKV PrtCapacityUnitTC InputTrayMaxCapacity counter input tray maximum capacity (in

units specified by InputTrayCapacityUnit)

PrtCapacityUnitTC

Any various Extension point to InputTrayDescription


193

1940

1941

194


Figure 36 Input Tray Status

Table 26 Input Tray Status Elements

Element DataType


Reference (all [RFC3805])

InputTrayStatusInputTraySecurity keyword SubunitPresentOnOffWKV PresentOnOff

prtInputSecurity (PresentOnOff)

InputTrayMediaSizeName string input tray current media size name - see Media Size Self-Describing Names section 5 in [PWG5101.1]

prtInputMediaName

Input TrayMediaType string input tray current media type see Media Type Names section 3 in [PWG5101.1]

prtInputMediaType

Input TrayMediaInfo string input tray current media info (weight, color, etc.) see Media Type Names section 3 in [PWG5101.1]

prtInputMediaWeight prtInputMediaColor prtInputMediaFormParts

Input TrayCurrentLevelBasis

keyword input tray current level basis (i.e., accuracy) ObjectCounterBasisWKV

prtInputCurrentLevel

Input TrayCurrentLevel counter input tray current level (in units specified by Input TrayCapacityUnit)

prtInputCurrentLevel

Input TrayMediaLoadTimeoutBasis

keyword ObjectCounterBasisWKV prtInputMediaLoadTimeout

Input TrayMediaLoadTimeout

counter input tray media load timeout (in seconds)

prtInputMediaLoadTimeout

Input TrayNextInputTrayIdBasis

keyword ObjectCounterBasisWKV prtInputNextIndex in

Input TrayNextInputTrayId int input tray next input tray (after media load timeout) (a value of '0' means 'None', i.e., no input switching)

prtInputNextIndex in

FeedDirection keyword For example, ShortEdgeFeed or LongEdgeFeedFeedOrientationWKV

Any various Extension point to InputTrayStatus


195

1942

1943

196


5.8 Interfaces

This complex Element represents the communication ports into and out of the device. It is technically aligned with the ifTable defined in MIB-II [RFC2863] The major constituents of the Interface Subunit complex Element are represented in Figure 39; the Interface Description Elements are described in Table 25. Interface Status is modeled in Figure 40 and described in Table 26.

Figure 37 Interface

Figure 38 InterfaceDescription

Table 27 InterfaceDescription Elements


Reference(all [RFC2863])*

InterfaceDescription complexSubunitDescription complex See 3.1.2InterfaceName string textual name of the interface. The value of this

object should be the name of the interface as assigned by the local device and should be suitable for use in commands entered at the device’s ‘console’.

ifName


197

1944

19451946194719481949

1950

1951

1952

1953

1954

198



Reference(all [RFC2863])*

InterfaceType int type of interface. Values are assigned by the Internet Assigned Numbers Authority IANA, through updating the syntax of the IANAifType textual convention.

ifType and [IANA_NUMBERS]

Any various Extension point to InterfaceDescriptionInterfaceStatus complex See Error: Reference source not foundAny various Extension point to Interface


199

200


Figure 39 InterfaceStatus

Table 28 InterfaceStatus Elements


201

1955

1956

1957

202



Reference(all [RFC2863])

InterfaceStatus complexSubunitStatus complex See 3.1.1InterfaceAdminState keyword desired state of the interface.

InterfaceAdminStateWKV ifAdminStatus

InterfaceHighSpeed int estimate of the interface’s current bandwidth in units of 1,000,000 bits per second.

ifHighSpeed

InterfaceInDiscards int number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being deliverable to a higher-layer protocol.

ifInDiscards

InterfaceInErrors int For packet-oriented interfaces, the number of inbound packets that contained errors preventing them from being deliverable to a higher-layer protocol. For character-oriented or fixed-length interfaces, the number of inbound transmission units that contained errors preventing them from being deliverable to a higher-layer protocol.

ifInErrors

InterfaceInOctets int total number of octets received on the interface, including framing characters.

ifInOctets

InterfaceInUnicastPackets int number of packets delivered by this sub-layer to a higher sub-layer which were not addressed to a multicast or broadcast address at this sub-layer.

ifInUcastPkts

InterfaceInUnknownProtocolsint for packet-oriented interfaces, the

number of packets received via the interface which were discarded because of an unknown or unsupported protocol. For character-oriented or fixed-length interfaces that support protocol multiplexing, the number of transmission units received via the interface which were discarded because of an unknown or unsupported protocol.

ifInUnknownProtos

InterfaceLastChangeDate dateTime date/time the interface entered its current operational state NOTE: The syntax of this Element differs from its MIB counterpart int (i.e., seconds)

ifLastChange


203

204



Reference(all [RFC2863])

InterfaceMaxPacketSize int size of the largest packet which can be sent/received on the interface, specified in octets.

ifMtu

InterfaceOperState keyword current operational state of the interface.InterfaceOperStateWKV

for additional details on ifIndex.

InterfaceOutDiscards int number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted.

ifOutDiscards

InterfaceOutErrors int for packet-oriented interfaces, the number of outbound packets that could not be transmitted because of errors. For character-oriented or fixed-length interfaces, the number of outbound transmission units that could not be transmitted because of errors.

ifOutErrors

InterfaceOutUnicastPackets int total number of packets that higher-level protocols requested be transmitted, and which were not addressed to a multicast or broadcast address at this sub-layer, including those that were discarded or not sent.

ifOutUcastPkts

InterfaceOutOctets int total number of octets transmitted out of the interface, including framing characters.

ifOutOctets

InterfacePhysicalAddress string interface’s address at its protocol sub-layer.

ifPhysAddress

InterfaceSpeed int estimate of the interface’s current bandwidth in bits per second. If the bandwidth of the interface is greater than the maximum value reportable by this object then this object should report its maximum value 4,294,967,295 and InterfaceHighSpeed must be used to report the interface’s speed.

ifSpeed

Any various Extension point to InterfaceStatus

5.9 Interpreters

This complex Element represents the functions necessary to understand the control languages by which instructions and requests are input and/or to understand the Digital Document description languages by which Digital Documents are input. It is technically


205

1958

195919601961

206


aligned with prtInterpreter Table [RFC3805]. The constituents of the Interpreter Subunit complex Element are represented in Figure 41. The Elements are described in Table 27.

Figure 40 Interpreter

Table 29 Interpreter Elements

Element DataType



InterpreterDescription complex See note below.Description string


207

19621963

1964

1965

1966

208


Element DataType



InterpreterLanguageSupportedkeyword control languages which this interpreter

can interpret or emulate. The list of keywords is extensible. InterpreterLanguageFamilyWKV

prtInterpreterLangFamily

InterpreterLanguageLevel string level of the language which this interpreter is interpreting or emulating. This might contain a value like ’5e’for an interpreter which is emulating level 5e of the PCL language.

[prtInterpreterLangLevel]

InterpreterLanguageVersionstring date code or version of the language

which this interpreter is interpreting or emulating.

prtInterpreterLangVersion

InterpreterVersion string date code, version number, or other product specific information tied to this interpreter. This value is associated with the interpreter, rather than with the version of the language which is being interpreted or emulated.

prtInterpreterVersion

InterpreterLanguageFamily keyword family name of the control language which this interpreter is interpreting or emulating. The keyword values are extensible. InterpreterLanguageFamilyWKV

prtInterpreterLangFamily

Any various Extension point to InterpreterDescription

InterpreterStatus See note below.

InterpreterDefaultOrientationkeyword current orientation default for this

interpreter.InterpreterPageOrientationWKV

prtInterpreterDefaultOrientation

InterpreterAddressabilityUnitkeyword units used for Interpreter

Addressability. SubunitAddressabilityUnitWKV

prtMarkerAddressabilityUnits

InterpreterAddressabilityBasiskeyword confidence level of the addressability

information for the Interpreter. ObjectCounterBasisWKV

prtInterpreterFeedAddressability

InterpreterAddressabilityCrossFeed

int addressability in the cross feed direction i.e., fast Scan direction in InterpreterAddressabilityUnits.

prtInterpreterXFeedAddressability

InterpreterAddressabilityFeedint addressability in the feed direction i.e.,

slow –scan direction in InterpreterAddressabilityUnits



209

210


Element DataType



InterpreterDefaultCharsetIn string default coded character set for input octets encountered outside a context in which the Page Description Language establishes octet interpretation.

prtInterpreterDefaultCharSetIn

InterpreterDefaultCharsetOutstring default character set for data from

interpreter through output channel i.e., the ’backchannel’

prtInterpreterDefaultCharSetOut

InterpreterIsTwoWay boolean interpreter returns information to the host.

prtInterpreterTwoWay

Any various Extension point to InterpreterStatusAny various Extension point to Interpreter

Note: Because the Interpreter Subunit is considered software, the Power elements in the common. Subunit Status and Subunit Description base Elements are not applicable. The Interpreter Subunit therefore does not include these common complex base Elements, although it does include some lower level elements that are also in the common complex Subunit Status and Subunit Description Elements.

5.10 Marker

This complex Element represents the mechanisms by which marks are impressed upon the media. It is technically aligned with prtMarkerTable [RFC3805] The constituents of the Marker Subunit and Marker Subunit Description complex Elements are represented in Figure 42 and described in Table 28. Marker Status is represented in Figure 43 and Table 29. Two of the constituent Elements of Marker Status, Marker Colorants and Marker Supply are separately represented in Figure 44 and Figure 45, with their Elements described in Table 30 and Table 31.

Figure 41 Marker Schema


211

19671968196919701971

1972

1973197419751976197719781979

1980

1981

212


Figure 42 MarkerDescription Schema

Table 30 Marker Elements

Element DataType



MarkerDescription complexSubunitDescription complex See 3.1.2MarkerTechnology keyword MarkerTechnologyWKV PrtMarkerMarkTechTC MarkerProcessColorants counter prtMarkerProcessColorants MarkerSpotColorants counter prtMarkerSpotColorants Any various Extension point to

MarkerDescription


213

1982

1983

1984

1985

214


Figure 43 MarkerStatus Schema

Table 31 Marker Status Elements

Element DataType



SubunitStatus complex See 3.1.1MarkerAddressability complex

MarkerAddressabilityBasiskeyword ObjectCounterBasisWKV prtMarkerFeed/

xFeedAddressability out of band values


215

1986

1987

1988

216


Element DataType



MarkerAddressabilityCrossFeed

counter prtMarkerXFeedAddressability

MarkerAddressabilityFeedcounter prtMarkerFeedAddressability

MarkerAddressabilityUnitkeyword SubunitAddressabilityUni

tWKVPrtMarkerAddressabilityUnitTC

MarkerColorants complex See Error: Reference source not found

MarkerCounterUnit keyword SubunitCounterUnitWKV prtMarkerCounterUnit MarkerCounterLife counter marker usage over

Subunit lifetimeprtMarkerLifeCount

MarkerCounterPowerOn counter marker usage since last power on

prtMarkerPowerOnCount

MarkerMargins complexMarkerEastMargin counter prtMarkerEastMargin MarkerMarginBasis keyword ObjectCounterBasisWKV prtMarkerNorth/South/

East/WestMargin out of band value

MarkerNorthMargin counter prtMarkerNorthMargin MarkerSouthMargin counter prtMarkerSouthMargin MarkerWestMargin counter prtMarkerWestMargin

MarkerSupplies complex See Error: Reference source not found for Elements defining each marker supply

Any various Extension point for Marker Status

Any various Extension point for Marker


217

218


Figure 44 Marker Colorant Schema

Table 32 Market Colorant Elements



MarkerColorant complexMarkerColorantStatus complex

Id int prtMarkerColorantIndex Any various Extension point for

MarkerColorantStatusMarkerColorantDescription complex

MarkerColorantRole keyword MarkerColorantRoleWKV prtMarkerColorantRole MarkerColorantInfo string marker colorant vendor-

supplied description (in locale specified by SystemNaturalLanguage)

MarkerColorantName string marker colorant standard name see marker colorant vendor-supplied description (in locale specified by SystemNaturalLanguage)

prtMarkerColorantValue

MarkerColorantTonalitycounter marker colorant distinct

levels of tonality (levels of tonal difference available for rendering)

prtMarkerColorantTonality

Any various Extension point for MarkerColorantDescription

Any various Extension point for MarkerColorant


219

1989

1990

1991

220


Figure 45 Marker Supply

Table 33 Marker Supply Elements

Element DataType



MarkerSupplyStatus complexMarkerSupplyId int prtMarkerSuppliesIndex MarkerSupplyColorantId pointer prtMarkerSuppliesColoran

tIndex

MarkerSupplyCurrentLevelBasiskeyword ObjectCounterBasisWKV prtMarkerSuppliesLevel

MarkerSupplyCurrentLevel counter prtMarkerSuppliesLevel Any various Extension point for

MarkerSupplyStatusMarkerSupplyDescription complex

MarkerSupplyClass keyword MarkerSupplyClassWKV prtMarkerSuppliesClass MarkerSupplyType keyword MarkerSupplyTypeWKV prtMarkerSuppliesType MarkerSupplyInfo string prtMarkerSuppliesDescrip

tion MarkerSupplyCapacityUnit keyword MarkerSupplyCapacityUnit

WKVprtMarkerSuppliesSupplyUnit

MarkerSupplyMaxCapacityBasiskeyword ObjectCounterBasisWKV prtMarkerSuppliesMaxCa

pacity


221

1992

1993

1994

222


Element DataType



MarkerSupplyMaxCapacity counter prtMarkerSuppliesMaxCapacity

Any various Extension point for MarkerSupplyDescription

Any various Extension point for MarkerSupply

5.11 Media Paths

This is more fully identified as the Print Media Paths This complex Element represents the mechanisms by which the media is moved through a Printer Subunit, from Input Tray to Output Tray or Finisher. It is technically aligned with prtMediaPathTable [RFC3805]. The Elements of a Media Path Subunit are represented in Figure 46. The constituent Elements are described in Table 32. Note that Scan Media Paths are a separate Subunit described in paragraph3.15.

Figure 46 Media Path


223

1995

199619971998199920002001

2002

2003

2004

224


Figure 47 MediaPathDescription

Figure 48 MediaPathStatus

Table 34 Media Paths Elements

Element DataType



MediaPathDescription complexSubunitDescription complex See 3.1.2MediaPathMaxSpeed counter prtMediaPathMaxSpeed MediaPathMaxSpeedUnit keyword PrtMediaPathMaxSpeed

PrintUnitTC in [RFC3805] MediaPathMaxSpeedUnitWKV

prtMediaPathMaxSpeed PrintUnit

MediaPathMaxMediaSizeNamestring Media Size Self-Describing

Names section 5 in [PWG5101.1]

prtMediaPathMediaSizeUnit; prtMediaPathMaxMediaFeedDir prtMediaPathMaxMediaXFeed


225

2005

2006

2007

2008

226


Element DataType



Dir

MediaPathMinMediaSizeNamestring prtMediaPathMediaSizeUnit;

prtMediaPathMinMediaFeedDir prtMediaPathMinMediaXFeedDir

MediaPathType keyword PrtMediaPathTypeTC in [RFC3805] MediaPathTypeWKV;

prtMediaPathType

MediaTypesSupported list of keywords

Sequence of allowed mediatype valuesMediaTypeWKV

Any various Extension point for MediaPathDescription

MediaPathStatus complexSubunitStatus complex See 3.1.1 prtMediaPathStatusAny various Extension point for

MediaPathStatusAny various Extension point MediaPath

5.12 Output Channels

This complex Element represents the destination pathways for Digital Documents. It is technically aligned with prtChannelTable [RFC3805]. Output Channels are associated with an underlying Interface and are usually bound to a transport protocol or file system. The constituents of this complex Element are represented in Figure 47; the Elements are described in Table 33.


227

2009

20102011201220132014

228


Figure 49 Output Channel


229

2015

2016

230


Table 35 Output Channel Elements

Element DataType


Reference [RFC3805]*

OutputChannelDescription complex See Note below.Description string prtChannelInform

ationOutputChannelAuxInfo string additional protocol information needed to use

the Output Channel’s protocol. The information is protocol specific.

ifDescr [RFC1213]

OutputChannelProtocolVersion

string version of the protocol associated with an Output Channel instance in a protocol specific manner.

prtChannelProtocolVersion

OutputChannelType keyword This Element specifies the protocol associated with an Output Channel instance. OutputChannelTypeWKV

prtChannelType

Any various extension point for OutputChannelDescriptionOutputChannelStatus complex See Note below.

DeviceErrors int hrDeviceErrors [RFC2790]

Id intOutputChannelDefault

JobControlLanguagecomplex the Job Control Language i.e., Interpreter

associated with the channel. This defines the syntax used for Document control functions See 5.9 for constituent Elements

prtChannelDefaultPageDescLangIndex

OutputChannelInterfacecomplex This is the Interface instance associated with

this instance of an Output Channel. See 5.8 for constituent Elements.

prtChannelIfIndex

OutputChannelIsEnabledboolean indicates whether or not an Output Channel

instance is available for PrtChannelStateTC prtChannelState

Product Id string Human readable name hrDeviceID [RFC2790]

SubunitStates keyword SubunitStateWKV prtChannelStatusAny various Extension point for OutputChannelStatus

Any various Extension point for OutputChannelNote: Because the Output Channel Subunit is considered software, the Power elements in the common SubunitStatus and Subunit Description are not applicable. The Output Channel Subunit therefore does not include these common complex base Elements, although it does include some lower level elements that are also in the common complex Subunit Status and Subunit Description Elements.

*Unless otherwise indicated


231

2017

201820192020202120222023

232


5.13 Output Trays

This complex Element represents the trays or bins capable of receiving Hard Copy Documents that have been Printed or scanned. The definition of Output Trays is technically aligned with prtOutputTable [RFC3805]. The basic constituents of the Output Tray Subunit complex Element are represented in Figure 48, with Output Tray Description and Output Tray Status being pictured in Figure 49 and Figure 50 respectively and described in Table 34.

Figure 50 Output Tray

Figure 51 Output Tray Description


233

2024

202520262027202820292030

2031

2032

2033

2034

2035

234


Figure 52 Output Tray Status

Table 36 Output Tray Elements

Element DataType



OutputTrayDescription complexSubunitDescription complex See 3.1.2OutputTrayType keyword PrtOutputTypeTC in [RFC3805]

OutputTrayTypeWKV;prtOutputType

OutputTrayName string prtOutputName OutputTrayVendorName string prtOutputVendorName OutputTrayModel string prtOutputModel OutputTrayVersion string prtOutputVersion OutputTraySerialNumber string prtOutputSerialNumber OutputTrayCapacityUnit keyword PrtCapacityUnitTC in [RFC3805]

SubunitCapacityUnitWKV;prtOutputCapacityUnit

OutputTrayMaxCapacityBasiskeyword ObjectCounterBasisWKV prtOutputMaxCapacity


235

2036

2037

2038

236


Element DataType



OutputTrayMaxCapacity counter output tray maximum capacity (in units specified by OutputTrayCapacityUnit

OutputTrayMaxMediaSizeName

string see Media Size Self-Describing Names section 5 in [PWG5101.1]

prtOutputDimUnit; prtOutputMaxDimFeedDir prtOutputMaxDimXFeedDir

OutputTrayMinMediaSizeNamestring

Any various Extension point to OutputTrayDescription

OutputTrayStatus complexSubunitStatus complex See 3.1.1OutputTraySecurity keyword SubunitPresentOnOffWKV prtOutputSecurity

(PresentOnOff)

OutputTrayRemainingCapacityBasis

keyword ObjectCounterBasisWKV prtOutputRemainingCapacity

OutputTrayRemainingCapacitycounter in units specified by

OutputTrayCapacityUnit)prtOutputRemainingCapacity

OutputTrayStackingOrder keyword first to last or last to first. See PrtOutputStackingOrderTC in [RFC3805] OutputTrayStackingOrderWKV;

prtOutputStackingOrder

OutputTrayPageDeliveryOrientation

keyword face up or face down See PrtOutputPageDeliveryOrientationTC in [RFC3805] OutputTrayPageDeliveryOrientationWKV

prtOutputPageDeliveryOrientation

OutputTrayBursting keyword see PresentOnOff in [RFC3805] SubunitPresentOnOffWKV;

prtOutputBursting (PresentOnOff)

OutputTrayDecollating keyword prtOutputDecollating (PresentOnOff)

OutputTrayPageCollated keyword prtOutputPageCollated (PresentOnOff)

OutputTrayOffsetStacking keyword prtOutputOffsetStacking (PresentOnOff)

Any various Extension point to OutputTrayStatus

Any various Extension point to OutputTray


237

238


5.14 Processors

This complex Element represents the computing and logical Elements that, in conjunction with operational memory, execute the firmware and/or software providing the device functions and features. The Processor corresponds to the System Controller as defined in paragraph 2.2.8 of RFC3805 [RFC3805] It is modeled in Figure 51 with constituent Elements described in Table 35.

Figure 53 Processor


239

2039

20402041204220432044

2045

2046

240


Table 37 Processor Subunit Elements

Element DataType Description Reference (all [RFC2790])

ProcessorDescription complexSubunitDescription complex See 5.1.2ProcessorFirmwareID int product ID of the firmware

associated with the processor identifying manufacturer, model, and version

hrProcessorFrwID

ProcessorLoad int percentage of the last minute that processor was not idle

hrProcessorLoad

Any various Extension point to ProcessorDescription

ProcessorStatus complex Common Subunit StatusSubunitStatus complex See 5.1.1 prtChannelStatus

Any various Extension point to Processor

5.15 Scan Media Paths

This complex Element represents the media handling aspects of a Scanner Device. It is distinct from the Media Path Subunit (3.11), which refers to the media handling aspects of a Printer Device. Scan Media Paths can contain more than one Scan Media Path Subunit; for example, the platen of a flatbed scanner can be treated as a separate Scan Media Path Subunit from the auto Document feeder. The constituents of the Scan Media Path Subunit complex Element are represented in Figure 52. The Scan Media Path Elements are described in Table 36.


241

2047

2048

2049205020512052205320542055

242


Figure 54 Scan Media Path

Table 38 Scan Media Path Elements

Element Datatype


Reference

ScanMediaPathDescription complexSubunitDescription complex See 3.1.2


243

2056

2057

2058

244


Element Datatype


Reference

Recirculating boolean applicable to Scan Media Paths that are capable of feeding Hard Copy Documents. If value of this Element is ‘true’ then the Scan Media Path is both an input and output for the Hard Copy Documents. If the Element is missing or the value is set to ‘false’ then the Hard Copy Document is delivered to an Output Bin after scanning is complete.

[PWG5108.2]

ScanMediaPathMaxSpeed int

ScanMediaPathMaxSpeedUnitkeyword units used for the maximum

speed of Scan Media Path. MediaPathMaxSpeedUnitWKV

[RFC3805] prtMediaPathMaxSpeed PrintUnit

ScanMediaPathMaxMediaSizeName

keyword maximum size of media that can flow through the Scan Media Path in Media Self Describing Name see Media Size Self-Describing Names section 5 in [PWG5101.1]; MediaSizeNameType

. [PWG5101.1]prtScanMediaPathMediaSizeUnit prtScanMediaPathMaxMediaFeedDir prtScanMediaPathMaxMediaXFeedDir in [RFC3805]

ScanMediaPathMinMediaSizeName

keyword Minimum size of media that can flow through the Scan Media Path in Media Self Describing Name see Media Size Self-Describing Names section 5 in [PWG5101.1]; MediaSizeNameType

. [PWG5101.1]prtScanMediaPathMediaSizeUnit prtScanMediaPathMinMediaFeedDir prtScanMediaPathMinMediaXFeedDir in [RFC3805]

ScanMediaPathType keyword type of Scan Media Path.; ScanMediaPathTypeWKV

[RFC3805] prtMediaPathType

Sides keyword the ability of the ScanMediaPath to Scan multiple sides of an input media sheet. SidesWKV

[RFC2911] sides

Any various Extension point for ScanMediaPathDescription

ScanMediaPathStatus complex [PWG5108.2]SubunitStatus complex See 5.1.1


245

246


Element Datatype


Reference

SheetsCompleted int number of times a media sheets has passed through the ScanMediaPath.

[PWG5108.2]

Any various Extension point for ScanMediaPathStatus

Any various Extension point for ScanMediaPath

5.16 Scanners

This complex Element represents the image acquisition aspects of a Scanner Device. The constituents of a Scanner Subunit are represented in Figure 53 The constituent Elements are defined in Table 37. The constituent complex Elements Scanner Addressability and Scanner Margin are represented in Figure 54 and Figure 55, with the Elements within these complex Elements identified in Table 38 and Table 39.


247

2059

20602061206220632064

248


Figure 55 Scanner

Table 39 Scanner Subunit Elements


249

2065

2066

2067

250


Element Datatype


Reference [RFC3805] *

ScannerDescription complex

[PWG5108.2]

SubunitDescriptioncomplex

See 3.1.2

ScannerBitsPerPixelint number of bits per pixel used by the scanner’s

image acquisition subsystem. [PWG5108.2]

ScannerColorPlanesint number of color planes used by the scanner’s

image acquisition subsystem. [PWG5108.2]

Any various Extension point for ScannerDescription.ScannerStatus comple

x[PWG5108.2]

SubunitStatus complex

See 3.1.1

ScannerAddressabilities

complex

information on the available addressabilities i.e., resolution of the Scanning hardware. See Error: Reference source not found

prtMarkerAddressability

ScannerLifeCount int number of scans performed by the scanning hardware for the life of the device. The units are measured in ScannerCounterUnits.

prtMarkerLifeCount

ScannerPowerOnCount

int number of scans performed by the scanning hardware since the device was lasted turned on. The count is in ScannerCounterUnits.

prtMarkerPowerOnCount

ScannerCounterUnitkeyword

units for ScannerCounterLife and ScannerCounterPowerOn. SubunitCounterUnitWKV

prtMarkerCounterUnit objects

ScannerMargin complex

information on the Margin of the Scanning hardware. The margins provide a bounding box within which the Scanner hardware is capable of scanning. See Error: Reference source not found.

prtMarkerMargin objects

Any various Extension point for ScannerStatusAny various Extenstion point for Scanner Subunit

Figure 56 Scanner Addressability


251

2068

2069

252


Table 40 Scanner Addressability Elements

Element Datatype


Reference all [RFC3805]*

ScannerAddressabilityBasis keyword confidence level of the addressability information for the Scanning hardware ObjectCounterBasisWKV

prtMarkerFeed/XFeedAddressibility out of band values

ScannerAddressabilityCross Feed

int resolution in the cross feed direction i.e., fast Scan direction for the Scanning hardware. This is expressed in ScannerAddressabilityUnits.

prtInterpreterXFeedAddressability

ScannerAddressabilityFeed int resolution in the feed direction i.e., slow Scan direction for the Scanning hardware. This is expressed in ScannerAddressabilityUnits.


ScannerAddressabilityUnit keyword SubunitAddressabilityUnitWKV prtMarkerAddressabilityUnit

Figure 57 Scanner Margin

Table 41 Scanner Margin Elements

Element Datatype


Reference all [RFC3805]

ScannerMarginBasis keyword

confidence level of the Margin information for the Scanning hardware. ObjectCounterBasisWKV

prtMarkerNorth/South/East/West out of band values

ScannerNorthMargin int offset from the leading edge of the Scan hardware or platen where Image acquisition can occur. The units are given in ScannerAddressabilityUnit.

prtMarkerNorthMargin


253

2070

2071

2072

2073

254


ScannerSouthMargin int offset from the trailing edge of the Scan hardware or platen where Image acquisition can occur. The units are given in ScannerAddressabilityUnit.

prtMarkerSouthMargin

ScannerWestMargin int offset from the west edge of the Scan hardware or platen where Image acquisition can occur. The units are given in ScannerAddressabilityUnit.

prtMarkerWestMargin

ScannerEastMargin int This Element expresses the offset from the east edge of the Scan hardware or platen where Image acquisition can occur. The units are given in ScannerAddressabilityUnit.

prtMarkerEastMargin

5.17 Storages

This is a sequence of digital data storage Elements, each modeling a storage Subunit used by a Service that provides for digital data storage and recovery as a primary function. The constituents of the Storage Subunit complex Element are represented in Figure 56. A Storage complex Element contains the Elements described in Table 40.


255

2074

2075207620772078

256


Figure 58 Storage

Table 42 Storage Elements


Reference

StorageDescription complexSubunitDescription complex See 3.1.2


257

2079

2080

2081

258



Reference

StorageDataEncryption boolean Data encryption is supported

StorageMakeAndModelstring information on the manufacturer of

the storage Subunit including model name of the storage Subunit

[RFC 2790]

StorageName string name of the storage Subunit that is unique within a Service instance.

Values derived from IPPv1.1 ServiceStatus

StorageUri uri network location information of the storage Subunit. (applicable only to a NetworkStorage device)

Any various Extension point for StorageDescription

StorageStatus complexSubunitStatus complex See 3.1.1StorageFree int total bytes currently free for use by

the servicehrStorageSize minus hrStorageUsed [RFC 2790]

StorageIsRemovable boolean Storage Subunit is removable by the design of its manufacturer See Note.

hrDiskStorageRemoveble [RFC 2790]

StorageSize int total number of bytes allocated to the service

hrStorageSize [RFC 2790]

StorageType keyword type of the storage Subunit (expanded from HR MIB.)StorageTypeWKV

hrStorageType [RFC 2790]

Any various Extension point for StorageStatusAny various Extension point for Storage

5.18 Vendor Subunits

This complex Element allows the vendor to add one or more additional Subunits to his product model. These would be major hardware or software components that do not fit within the set of Subunits listed here, but which act to enhance or give additional functionality to a Imaging System product. Examples are a thumb Print or access card reader for security. It is modeled in Figure 57 and described in Table 41.


259

2082

20832084208520862087

260


Figure 59 Vendor Subunit

Table 43 Vendor Subunit Elements


VendorSubunitDescription complexSubunitDescription complex See 3.1.2

Any various Extension point for VendorSubunitDescription

VendorSubunitStatus complex


261

2088

2089

2090

262


SubunitStatus complex See 3.1.1SubunitCounterUnit keyword SubunitCounterUnitWKVSubunitLifeCount counter

SubunitPowerOnCountcounter

Any various Extension point for VendorSubunitStatus

Any various Extension point for VendorSubunit


263

2091

2092

264


6. Imaging Service Element GroupsAlthough the different Imaging Services have distinct detailed models, which are described in the Service-specific specifications, the models do have a common basic structure. Further, the unifying concepts described in Chapter 2 and the similarity of aspects of each Service produce some Element commonality. Each Imaging Service, and the complex Elements included in it, are composed of Elements which are:

1. common to all services (e.g., Service Description, Service Status)2. common to a subset of Services (e.g., Document Processing Capabilities, Job

Description Capabilities) and 3. unique to a given Service.

This Chapter presents the general model structure of a Service and describes the Elements which are common to all, or to several Services, thereby eliminating the need to repeat these descriptions in each Service specification.

Note that descriptions and schema diagrams in this Chapter refer to the abstract class “Imaging Service”. This class is included in the PWG MFD XML Schema [MFD_SCHEMA] to assist in understanding the model, but it is not a basic complex Element that is actually contained in any real Imaging Service. Rather, the schema representation of each individual Imaging Service includes Elements corresponding to those in the abstract Imaging Service that are applicable to that individual Imaging Service. The names of Elements in the abstract class are prefixed with string ”Imaging” while the names of corresponding Elements in the actual Imaging Service are prefixed with the Service name (e.g., “ Print”, “Scan”.) For example, “Imaging Service Capabilities” in the abstract class corresponds to “Copy Service Capabilities” in the Copy Service. The following descriptions should be read with the understanding that not all of the Elements described in the abstract Imaging Service are necessarily included in each actual Imaging Service.

The abstract Imaging Service is represented in Figure 58. It is composed of a Job Table and the Element groups in the Imaging Service type:

1. Available Job Ticket2. Service Capabilities3. Service Capabilities Ready 4. Service Configuration-5. Service Defaults 6. Service Description7. Service Status8. Any (for PWG or vendor extension)

Services that do not process Jobs (e.g., Resource Service) do not include a Job Table or Service Defaults. Those services do not process Jobs nor act on tickets; rather, they


265

2093

20942095209620972098

2099210021012102

210321042105

210621072108210921102111211221132114211521162117

21182119

21202121212221232124212521262127

21282129

266


simply process requests. Services to which a user typically supplies a Job Ticket do not include an Available FaxIn Job Ticket. That is, the Available Job Ticket is included only for those Services that have jobs created by inbound traffic (e.g., FaxIn, EmailIn).

Figure 60 Abstract Imaging Service Structure

6.1 Job Table

Each Job-handling Service includes a Job Table that is constituted of two lists, as represented in Figure 59:

9. Pending and Active Jobs appear in the Active Jobs list. 10.Jobs that have reached a terminal state (i.e., Completed, Aborted, and Canceled)

appear in the Job History list.


267

213021312132

2133

2134

2135

21362137

213821392140

268


Figure 61 Imaging Job Table

The Job History is optional and the amount of time a Job is retained in the Job History list is implementation specific.

The same Jobs model is used in Active Jobs and Job History and is represented in Figure 60.

Figure 62 Imaging Job Model

The Job Element is considered as including both overall Job Elements (Job Status, Job Ticket and Job Receipt, of which only Job Status is mandatory); and optionally, Documents, consisting of zero or more Document Elements. The Document is itself a complex Element.

Because the Job Element and the Document Element are each fairly complicated, their models are separately discussed in Chapters 5 and 6 respectively.

6.2 Service Available Job Ticket

Imaging Services that receive an implied Job Create request by an incoming FaxIn or EmailIn transmission typically do not received a Job Ticket with the request. However, there may be information in or associated with the transmission that contain implicit Job


269

2141

2142

21432144

21452146

2147

2148

2149215021512152

21532154

2155

215621572158

270


Ticket information, such as destination or origination address, or time of day. Therefore, a single Default Job Ticket would not be adequate. Such Services may therefore include a Service Available Job Ticket, formed as shown in Figure 61.

Figure 63 Imaging Service Available Job Ticket

The Available Job Ticket is composed of a basic ImagingJobTicket complex Element, itself of a form common to all Job Tickets and described in section 5.2, and an ImagingMetrics Element. This ImagingMetrics Element provides for the conditions associated with or contained with the transmission that may impact the values of Elements in the Job Ticket. The form and contents of ImagingMetrics are Service dependent, and are discussed in the specifications of the appropriate Services.

6.3 Service Capabilities and Service Capabilities Ready

The Service Capabilities provide information about the Elements that can be used in Job Tickets and Document Tickets to describe the desired processing of a Job and its Documents. Some Services also include a Service Capabilities Ready Element, of the same form and content as Service Capabilities. The Service Capabilities Ready Element provides information about the Elements that can be used in Job Tickets and Document Tickets without operator intervention. For example, a Printer that can accept media of a given size would have that media size listed under Print Service Capabilities Media Size Name. However, if use of that media size required a particular input tray that was not mounted, that media size would not be listed under Print Service Capabilities Ready Media Size Name.

The Imaging Service Capabilities (Figure 62)) and Imaging Service Capabilities Ready Elements are grouped into:

1. Document Ticket Capabilities2. Document Processing Capabilities: 3. Document Description Capabilities4. Job Ticket Capabilities 5. Document Processing Capabilities: 6. Job Description Capabilities7. Job Processing Capabilities

These names reflect that fact that Service Capabilities are the processing and description elements that can be requested (and presumably satisfied) in the Job and Document Tickets. Because Document Processing instructions can be in either Document or Job


271

215921602161

2162

2163

216421652166216721682169

2170

2171217221732174217521762177217821792180

21812182

2183218421852186218721882189

219021912192

272


Tickets, identical Document Processing Capabilities structures are included for both Document and Job Ticket Capabilities.

Note that the “Capabilities” Elements identified in this Chapter have the same names as the Elements that may be included in the Job or Document Ticket, identified in Chapter 5 and Chapter 6, respectively. However, a “capabilities” Element is typically multivalued because it must specify all allowable values, and this is reflected its syntax. The corresponding Job Ticket or Document Ticket Element has the specific value to be used for the Job. For example, the Input Source Capabilities Element is a sequence of keywords while the Input Source Ticket Element is a single keyword.

The following sections tabulate the Elements in each of the Service Capabilities Element groups, with the datatype and brief description of each Element. Where the datatype is keyword or list of keywords, the table identifies the keyword group. In general, the keywords will be either designated WKV (Well Known Value) or Extension Patterns WKV keyword groups contain “fixed” values defined by specification; please refer to the keyword group in the PWG MFD XML Schema [MFD_SCHEMA] for an explicit list of the applicable keyword values. Keyword groups that include Extension Patterns refer to a vendor’s extension keyword group. These are typically unions with a defined pattern assigned by vendors to extend the keyword value set.

The capabilities typically include both Elements inherited from the imaging Service class and Service dependent Elements, although there may be some commonality of these latter Elements among Services.


273

21932194

2195219621972198219922002201

220222032204220522062207220822092210

221122122213

274


Figure 64 Imaging Service Capabilities

6.4 Service Job and Document Ticket Document Processing Capabilities

Document Processing Capabilities are System Capabilities that identify the information about the Document Processing Elements that can be used in Job Tickets and Document Tickets. Document Processing Capabilities consists of two sequences:

1. Elements inherited from the Service super class as modeled in Figure 63, including Presentation Direction Number Up; Number Up. These elements are listed in Table 42.

2. Service specific Elements (a much larger set) that may be common to two or more Services. Generally, these elements are common among image-outputting Services such as Scan, FaxOut and EmailOut (Figure 64 and Table 43) , and among impression-outputting Services such as Print, FaxIn and EmailIn (Figure 65, Figure 66 and Figure 67 and Table 44).


275

2214

2215

2216

2217

221822192220

22212222222322242225222622272228

276


Figure 65 Imaging Document Processing Capabilities

Table 44 Imaging Document Processing Capabilities

Element DataType Description or Keyword GroupNumberUp list of int list of number of input “pages” that are included in a

single output “impression; or the number of input “images” that are included in an output image.

PresentationDirectionNumberUp

list of keywords

supported placement order of the input pages or images in the finished output. PresentationDirectionNumberUpWKV

Any various Extension point for ImagingDocumentProcessingCapabilities

The Service-specific Document Processing Capability elements for the Scan Service are representative of the Service-specific Document Processing Capability elements for image-outputting Services such as EmailOut and FaxOut. The elements are shown schematically in Figure 69 and Figure 69 and identified in Table 41.


277

2229

2230

2231

2232223322342235

278


Figure 66 Representative Service-Specific Document Processing Capabilities (Scan Service)


279

2236

22372238

280


Table 45 Service-Specific Document Processing Capabilities Image Output


Scaling complex the support for scaling.ScalingHeight range of int supported range of the Scaling in the fast Scan direction.

A value of ‘100’ specifies that no adjustments are made to the scanned Image. Scaling is expressed in 1 percent increments. Values below ‘100’ reduce the magnification and values above increase magnification.

ScalingWidth range of int supported range of the Scaling in the fast Scan direction. A value of ‘100’ specifies that no adjustments are made


281

2239

282



to the scanned Image. Scaling is expressed in 1 percent increments. Values below ‘100’ reduce the magnification and values above increase magnification.

AutoScaling boolean the support for automatically adjusting the Scaling of the image from the Hardcopy Document in an implementation specific manner

DocumentSizeAutoDetect boolean [WS-Scan] para.4.5.2.2.7.1 Scan Regions complex [WS-Scan] para. 4.5.2.2.11.1.1

Scan Region complex [WS-Scan] para. 4.5.2.2.11.1.1 Height range of int set of ranges of integers bound to the RegionUnitWidth range of intX-Offset range of intY-Offset range of intContentRegionUnits keyword RegionUnitWKV

Sides list of keywords

SidesWKV

Any various Extension point for DocumentProcessingCapabilities

The Service-specific Document Processing Capability elements for the Print Service are representative of the Service-specific Document Processing Capability elements for impression-outputting Services such as EmailIn and FaxIn. The elements are shown schematically in Figure 70, Figure 70 and Figure 67 and are identified in Table 42.

Note that, as a Document Processing Element, MediaCol (Collection of attributes characterizing the media upon which the impressions are made) is a complex element with many members. It appears in many places in the model. However, within capabilities, the Element of this name is a simple Boolean Element, indicating whether or not that MediaCol is supported in conjunction with defining the media to be used for some purpose. Capabilities also includes a MediaCol Supported complex element which includes all of the constituent elements of MediaCol and the values supported by the Service for each of these elements. The description of MediaCol Supported, including the constituent elements, is in 4.3.1.1.


283

2240224122422243

224422452246224722482249225022512252

284


Figure 67 Print Document Capabilities


285

2253

2254

286


Table 46 Service-Specific Document Processing Capabilities Impression Outputs


Copies range of intCoverBack complex

CoverType list of keywords

CoverTypeWKV, KeywordNsExtensionPattern

Media list of keywords

MediaSizeAliasNameWKV, MediaSizeLegacyNamesWKV, MediaSizeSelfDescribingNameWKV

MediaType list of keywords

MediaTypeWKV

MediaCol boolean Indicates whether feature is supportedAny various Extension point for CoverBack

CoverFront complexCoverType list of

keywords CoverTypeWKV, KeywordNsExtensionPattern




MediaTypeWKV

MediaCol boolean Indicates whether feature is supportedAny various Extension point for CoverFront

FeedOrientation list of keywords

FeedOrientationWKV KeywordNsExtensionPattern

Finishings list of keywords

FinishingsWKV, KeywordNsExtensionPattern

FinishingsCol complexFinishingTemplate booleanStitching complex

StitchingReferenceEdgelist of keywords

StitchingReferenceEdgeWKV, KeywordNsExtensionPattern

StitchingOffeset range of intStitchingLocation range of intAny various Extension point for Stiching

Any various Extension point for FinishingsColFontNameRequested list of stringsFontSizeRequestedSupported

range of int

ForceFrontSide range of intHeader Print list of Header PrintType (e.g., FaxOut and EmailOut)


287

2255

288



keywordsImpositionTemplate list of stringsInsertSheet complex

IsheetInsertAfterPage range of intInsertCount range of intMedia list of

keywordsMediaSizeAliasNameWKV, MediaSizeLegacyNamesWKV, MediaSizeSelfDescribingNameWKV


MediaTypeWKV

MediaCol boolean Indicates whether feature is supportedAny various Extension point for InsertSheet




MediaColSupported complex Zero or more instances of MediaCol. See 6.4.1.1MediaCol complex The Media Col complex element appears in several

places and is separately described. See Error: Referencesource not found

MediaInput TrayCheck list of keywords

MediaInput TrayCheckWKV, MediaNsExtensionPattern

OrientationRequested list of keywords

OrientationRequestedWKV

OutputBin list of keywords

OutputBinWKV, KeywordNsExtensionPattern

OutputDevice stringPageDelivery list of

keywordsPageDeliveryWKV, KeywordNsExtensionPattern

PageRanges boolean if true, Service supports this featurePagesPerSubset boolean if true, Service supports this featurePdlInitFile complex (Note: PdlInitFiles is an artifact of the XML encoding)

PdlInitFileLocation list of strings specifies the path(s) to the directory (directories) of the supported initialization file(s) [PWG5100.11] paragraph 7.10.1.1.1

PdlInitFileName list of strings name(s) of the supported initialization file(s) [PWG5100.11] para 7.10.1.2.1

boolean(attribute of

indicates whether or not the Printer will accept a FORWARD SLASH (“/”) character in the value of the


289

290



PdlInitFileNameSubdirectory PdlInitFileName

“PdlInitFileName” [PWG5100.11] paragraph 7.10.1.2.2

PdlInitFileEntry list of strings specifies the name(s) of the supported entry points within the initialization file(s) [PWG5100.11] paragraph 7.10.1.3.1

Any various Extension point for PdlInitFileColorMode list of

keywords PrintColorModeWKV

tContentOptimize list of keywords

PrintContentOptimizeWKV, KeywordNsExtensionPattern

Quality list of keywords

PrintQualityWKV, KeywordNsExtensionPattern

Resolutions complexResolution complex the supported sequence of resolutions in Cross Feed and

Feed direction for image capture.CrossFeedDir intFeedDir intUnits list of

keywordsUnitsWKV

SeparatorSheets complexSpreaderSheetsType list of

keywordsSeparatorSheetsTypeWKV, KeywordNsExtensionPattern




MediaTypeWKV

MediaCol boolean Indicates whether feature is supportedAny various Extension point for SeparatorSheets

SheetCollate list of keywords

SheetCollateWKV

Sides list of keywords

SidesWKV

XImagePosition list of keywords

See [PWG5100.3 ] XImagePositionWKV

XImageShift range of int See [PWG5100.3 ]]XSide1ImageShift range of intXSide2ImageShift range of intYImagePosition list of

keywordsSee [PWG5100.3 ]] YImagePositionWKV

YImageShift range of int See [PWG5100.3 ]


291

292



YSide1ImageShift range of intYSide2ImageShift range of intAny various Extension point for DocumentProcessingCapabilities

6.4.1.1 Media Collection Supported

The collection of media attributes, grouped in the Media Col complex element, appears both in Document Processing and Job Processing. Therefore, Media Col Supported appears in both Document Processing Capabilities and Job Processing Capabilities. The Media Col structure is shown in Figure 68 with the constituent capabilities elements listed in Table 45. As with other capabilities Element values, Media Col Supported elements are largely multivalued. Within an actual Job or Document Ticket, these elements would typically have a single value.

Media Col contains many member Elements. Therefore, unlike for other capabilities Elements, Services should not return Media Col Supported values in response to a general GetElements request. Rather, an explicit request for the specific Media Col elements desired is required.


293

2256

2257225822592260226122622263

2264226522662267

294


Figure 68 Media Col Structure

Table 47 MediaCol Elements

Element DataType Description or Keyword

Reference [PWG5100.

3]MediaCol

MediaBackCoating

list of keywords

supported pre-process coatings applied to the media MediaCoatingWKV, MediaColorExtensionPattern

para 3.13.10

MediaColor list of keywords

media color supported MediaColorWKV, MediaColorExtensionPattern

para 3.13.4

list of supported pre-process coating applied to the media para 3.13.10


295

2268

2269

2270

296



Reference [PWG5100.

3]MediaFrontCoating

keywords MediaCoatingWKV, MediaNsExtensionPattern

MediaGrain list of keywords

Supported grain of the media (affects curling and foldingMediaGrainWKV, MediaNsExtensionPattern

[PWG5100.11] para 11.5.2

MediaHoleCountrange of int Supported number of predrilled holes for the media para 3.13.6

MediaInfo boolean If true, descriptive information for the media is supported para 3.13.3MediaKey boolean If true, Service supports unique name of the media 1 para 3.13.

MediaOrderCountrange of int number of sheets, within an ordered sequence of sheets;

after which the sequence begins to repeat permitted by the Service

para 3.13.7

MediaPre Printed

list of keywords

Indicates supported pre- Printed characteristics of the media MediaPre PrintedWKV, MediaNsExtensionPattern

para 3.13.5

MediaRecycledlist of keywords

Indicates the supported recycled characteristics of the media MediaRecycledWKV, MediaNsExtensionPattern

para 3.13.11

MediaSize complex numerical media width and height dimensions supported by the Service

para 3.13.8

XDimensionrange of int para

3.13..8.1

YDimensionrange of int para

3.13..8.2

MediaSizeNamelist of keywords

Supported named sizes of the media MediaSizeNameWKV, MediaSizeNameExtensionPattern

[PWG5101.1] para 5

MediaThicknessrange of int Supported thickness of the media in hundredths of

millimeters] [PWG5100.11para 11.5.3

MediaTooth list of keywords

Supported “roughness” of the media MediaToothWKV, MediaNsExtensionPattern

[PWG5100.11] para 11.5.1


Supported types of media MediaTypeWKV, MediaTypeExtensionPattern

para 3.13.2

MediaWeightMetric

range of int Supported weight of the media in grams per square meter para 3.13.9

Any various


297

298


6.4.2 Service Document Ticket Document Description Capabilities

Document Description Capabilities group Elements provide descriptive information about the Document that can be used in Document Tickets.

Document Description Capabilities may consist of two sequences:

Elements inherited from the Imaging Document Description Capabilities (Figure 72) These are listed in the table in Table 44

Service specific Elements (but these are unique to the Print Service and are not covered here.

Figure 69 Imaging Service Job Description Capabilities

Table 48 Imaging Service Job Description Capabilities

Element DataType DescriptionElementsNaturalLanguage

list of keywords

supported natural languages for the Elements with a string syntax (See [RFC3066]NaturalLanguageWKV

JobAccountingID boolean Service’s support for Job Accounts.JobAccountingUserID boolean Service’s support for a User supplied Accounting ID associated with

Job.


299

2271

22722273

2274

22752276

22772278

2279

2280

2281

300


Element DataType DescriptionJobMandatoryElements

boolean Service’s support JobMandatoryElements which is an alternative method of encoding MustHonor flagged Elements. This Element is not valid in an XML encoding.

JobMessageFromOperator

boolean Service’s support of messages from the operator for Jobs.

JobMessageToOperator

boolean Service’s support of messages to the operator for Jobs.

JobMoreInfo boolean Service’s support for a User supplied URI referencing some resource with more information about the Job . [RFC2911] pargraph 4.3.4

JobName boolean Service’s support of a name for the Job.JobOriginatingUserName

boolean Service’s support of the name of the user submitting the Job

JobOriginatingUserUri boolean Service’s support of the URI for the user submitting the JobJobPassword int Indicates service’s support for holding a Job until the correct password

is entered. Value is the maximum password length accepted.JobPasswordEncryption

list of keywords

list of password encryption and hash methods supported by the Service. See [DES], [ECC], [AES], [MD2], [MD4], [MD5], [SHA]JobPasswordEncryptionWKV, KeywordNsExtensionPattern

KOctets boolean Service’s support for storing the size of the Job in integral units of 1024 octets.

TemplateCreatorUserName

boolean Service’s support for storing the user who created the template on which the Job Ticket was based.

TemplateId boolean Service’s support for storing the Id of the template on which the ScanJob Ticket was based.

TemplateInfo boolean Service’s support for storing information about the template on which Job Ticket was based.

TemplateName boolean Service’s support for storing the user friendly name of the template on which the Job Ticket was based.

TemplateType list of keywords

Service’s support for storing the type of the template on which the Job Ticket was based. The Service should only support Job and Document Templates. TemplateTypeWKV


301

302


Figure 70 Print Service Specific Job Description Capabilities

Table 49 Service Specific Job Description Capabilities

Element DataType DescriptionCompressionSupplied list of

keywordsCompressionWKV, KeywordNsExtensionPattern

DocumentCharsetSuppied list of keywords

CharsetWKV, KeywordNsExtensionPattern

DocumentDigitalSignatureSupplied

boolean True if supported

DocumentFormatDetailsSupplied

complex Service’s support of Document Format Details (See Error: Reference source not found and Error: Reference source not found)

DocumentFormatSupplied list of keywords

DocumentFormatWKV, KeywordNsExtensionPattern

DocumentFormatVersionSupplied

boolean Service’s support for Document Format Version

DocumentMessageSupplied boolean Service’s support for Document MessageDocumentNameSupplied boolean Service’s support for Document Name


303

2282

2283

2284

304


Element DataType DescriptionAny (service specific) various an extension point for JobDescriptionCapabilities

Figure 71 Document Format Details Structure

Table 50 Document Format Detail Elements

Element DataType

Description Reference


complex Service’s support for Document Format Details (See Error: Reference source not found) Following Elements may be supplied for each supported DocumentFormat

DocumentSourceApplicationName

string Name of the application that created the document [PWG5100.5] para 9.1.13

DocumentSourceApplicationVersion

string Version of the application that created the document [PWG5100.5] para 9.1.13

DocumentSourceOsName keyword Name of the operating system on which the document was generated para

[PWG5100.5] 9.1.13

DocumentSourceOsVersionstring Version of the operating system on which the

document was generated para [PWG5100.5] 9.1.13

DocumentFormat keyword Document format (i.e., PDL) for this Document [RFC2911] para 3.2.1.1

DocumentFormatDeviceId string Type of device for which the document was formatted

[PWG5100.5] para 9.1.13

DocumentFormatVersion string Level or version of the DocumentFormat [PWG5100.5] para 9.1.16


305

2285

2286

2287

306


Element DataType


DocumentNaturalLanguage keyword Primary Natural Language of this Document [RFC2911] para 3.2.1.1

6.4.3 Service Job Ticket Job Processing Capabilities

The Job Processing Capabilities group Element provides information about the Job processing Elements that can be used in Job Tickets. “Capabilities” values are often just a Boolean indicating whether or not the identified Job Processing Element is supported. In other instances, it may be a list of supported values.For descriptions of the Job Processing Elements themselves, see paragraph 5.2.3.

Job Processing Capabilities consists of two sequences:

Elements inherited from the Imaging Service super class Job Processing Capabilities Type, (Error: Reference source not found) including Elements such as Job Hold Until. These are listed in Error: Reference source not found.

Service specific Elements. The FaxOut Service’s Service Job Processing Capabilities shown in Figure 74, and the Copy Service Job Processing Capabilities shown in Figure 75 and Figure 76 include Service-specific capabilities applicable to several Services. Table 51 lists these Job Processing Capabilities Elements as well as some others that are not included in the example Service Schema illustrations.

Figure 72 Imaging Service Job Processing Capabilities

Table 51 Imaging Service Job Processing Capabilities

Element DataType Description orKeyword

Reference

JobDelayOutputUntil list of the named events for releasing the [PWG5100.11] para


307

2288

22892290229122922293

2294

229522962297

22982299230023012302

2303

2304

2305

308



Reference

keywords delayed output 7.4JobDelayOutputUntilTime

boolean Service allows a Job Ticket to specify a Date and Time when the output delay is to expire.

[PWG5100.11] para 7.5

JobHoldUntil list of keywords

the named events for releasing the held Job. JobHoldUntilWKV

[RFC2911] para 4.2.2

JobHoldUntilTime boolean Service allows a Job Ticket to specify a Date / Time when a Job that is on hold will be released.

[PWG5100.11] para 7.6

JobMandatoryElements

boolean The Service support sJobMandatoryElements.

[PWG5100.5] para 8.1

JobPhoneNumber boolean The Service supports storing the contact phone number for the Job

[PWG5100.11] para 7.7

JobPriority range of int [RFC2911] para 4.2.1JobRecipientName boolean The Service supports storing the name

of the recipient of a Job [PWG5100.11] para 7.8

Any various Extension point for JobProcessingCapabilities


309

310


Figure 73 Representative Service-Specific JobProcessingCapabilities Elements (FaxOut Service Examples)

Table 52 Service-Specific JobProcessingCapabilities Elements


Reference

BatchMode boolean True = Service supports the BatchMode element (Figure 75)

[PWG5108..2] para 7.1.2.3.5

ComfirmationSheet Print

boolean True = Service supports the ComfirmationSheet Print element. The format of the confirmation sheet is implementation specific. (Figure 74)


311

2306

23072308

2309

312



Reference

CoverSheetInfo complex (Figure 74)CompanyName boolean True = Service supports the Element

conaining the user-supplied name of the company for the cover sheet.

DateTime boolean True = Service supports the Element containing the user-supplied date and time for the cover sheet.

From boolean True = Service supports the Element containing user-supplied name of the person group or entity for the cover sheet

Logo boolean True = Service supports the Element containing user-supplied URL pointing to image used as the logo on the cover sheet.

Message boolean True = Service supports the Element containing user-supplied message on the cover sheet.

Subject boolean True = Service supports the Element containing user-supplied subject line on the cover sheet.

To boolean True = Service supports the Element containing user-supplied addressee line on the cover sheet.

Any various Extension point for CoverSheetInfoDestinationUris Complex feature is supported (Figfure 74)

DestinationUriSchemeslist of strings URI Schemes supported that can be

used to transfer a Digital Document to its Destination. See

DestinationUriSchemes [RFC4395]

PreDialString boolean True = Service supports the Element defining a Dial string to be entered before the DestinationUri is applied. See Error: Reference source not found.

PostDialString boolean True = Service supports the Element defining a Dial string to be entered after the DestinationUri is applied. See 7.2.3.1.3.

T33Subaddress boolean True = Service supports the Element allowing T33 subaddressing. See 7.2.3.1.4.

[RFC3192]

DocumentOutputMode list of keywords

(Scan, etc) DocumentOutputModeWKV, KeywordNsExtensionPattern

[PWG5108.2] para 8.1.3.3.6


313

314



Reference

JobAccountingSheets complex (Figure 75) [PWG5100.3] para 3.8

JobAccountingSheetsType

list of keywords

JobAccountingSheetsTypWKV [PWG5100.3] para 3.8.1

JobAccountingOutputBin

list of keywords

JobAccountingOutputBin [PWG5100.3] para 3.8.3


MediaSizeAliasNameWKV, MediaSizeLegacyNamesWKV, MediaSizeSelfDescribingNameWKV MediaSizeNameExtensionPattern

[RFC2911] para 4.2.11


MediaTypeWKV MediaTypeExtensionPattern

[PWG5100.3] para 3.13.2

MediaCol boolean Indicates if MediaCol is supported for JobAccountingSheets

[PWG5100.3] para 3.13

Any various Extension point for JobAccountingSheets

JobCopies range of int Numbers of copies supported (Figure 74)

[PWG5100.7] para 4.1.1

JobCoverBack complex (Figure 75) [PWG5100.7] para 4.1.2


[PWG5100.3] para 3.1.2



[RFC2911] para 4.2.11



[PWG5100.3] para 3.13.2

MediaCol boolean Indicates if MediaCol is supported for JobCoverBack

[PWG5100.3] para 3.13

Any various Extension point for JobCoverBackJobCoverFront complex (Figure 75) [PWG5100.7]para4.1.3


[PWG5100.3]para3.1.2



[RFC2911] para 4.2.11



[PWG5100.3] para 3.13.2


315

316



Reference

MediaCol boolean Indicates if MediaCol is supported for JobCoverFront

[PWG5100.3] para 3.13

Any various Extension point for JobCoverFrontJobErrorSheet complex (Figure 76)

JobErrorSheetType list of keywords

JobErrorSheetTypeWKV

JobErrorSheetWhenlist of keywords

JobErrorSheetWhenWKV



[RFC2911] para 4.2.11



[PWG5100.3] para 3.13.2

MediaCol Boolean Indicates if MediaCol is supported for JobErrorSheet

[PWG5100.3] para 3.13

Any various Extension point for JobErrorSheetJobFinishings list of

keywordsJobFinishingsWKV (Figure 76) [RFC2911] para 4.2.6

[PWG5100.1] para 2JobFinishingsCol complex (Figure 76) [PWG5100.3] para 3.2

FinishingTemplate list of string Allowed values [PWG5100.3] para 3.2.1

Stitching complex [PWG5100.3] para 3.2.2

StitchingReferenceEdge

list of keywords

StitchingReferenceEdgeWKV [PWG5100.3] para 3.2.2.1

StitchingOffset range of int [PWG5100.3] para 3.2.2.2

StitchingLocationsrange of int [PWG5100.3] para

3.2.2.3Any various Extension point for Stitching

Any various Extension point for JobFinishingsColJobSaveDisposition complex (Figure 76) [PWG5100.11] para

7.9SaveDisposition list of

keywordsSaveDispositionWKV [PWG5100.11] para

7.9.1.1SaveInfor complex [PWG5100.11] para

7.9.1.2

SaveDocumentFormat

list of keywords

SaveDocumentFormatType [PWG5100.11] para 7.9.1.2.3.3


317

318



Reference

SaveLocation list of strings URI Schemes supported that can be used to transfer a Digital Document to its Destination. See [RFC4395]

[PWG5100.11] para 7.9.1.2.3.1

SaveName boolean [PWG5100.11] para 7.9.1.2.3.2

Any various Extension point for SaveInformationAny various Extension point for JobSaveDisposition

JobSheetMessage boolean feature is supported (Figure 76) [PWG5100.3] para 3.12

JobSheets list of keywords

(Figure 76) JobSheetsWKV, KeywordNsExtensionPattern

[RFC2911] para 4.2.3[PWG5100.3] para 6.2

JobSheetsCol complex Error: Reference source not found [PWG5100.3] para 3.11

JobSheets list of keywords

JobSheetsWKV, KeywordNsExtensionPattern

[RFC2911] para 4.2.3[PWG5100.3] para 6.2



[RFC2911] para 4.2.11



[PWG5100.3] para 3.13.2

MediaCol boolean Indicates if MediaCol is supported for JobAccountingSheets

[PWG5100.3] para 3.13

Any various Extension point for JobSheetsColMultipleDocumentsHandling

list of keywords

MultipleDocumentsHandlingWKV, KeywordNsExtensionPattern

[RFC2911] para 4.2.4

MultipleSetOriginal boolean feature is supported (Figure 74) [PWG5108.2] para 7.1.2.3.7

OutputBin list of keywords

(Figure 74) OutputBinWKV, KeywordNsExtensionPattern

[PWG5100.2] para 2.1 [PWG5100.5] para 8.1

OutputDevice list of string Allowed values ( Print) [PWG5100.7] para 4.2.1 [PWG5100.5] para 8.1

Overrides llst of keywords

List of JobTicket elements that can be used in an override for this service

[PWG5100.6] para 4.1

PagesPerSubset boolean feature is supported ( Print) [PWG5100.4] para 5.3RetryInfo complex Supported capabilities of elements used

to control document transmission timeouts


319

320



Reference

NumberOfRetries range of int Allowed range of values for number of attempts to retransmit a document in the event of transmission failure s, before aborting the job

RetryInterval range of int Allowed range of values for time duration in seconds between transmission attempts

RetryTimeout range of int Allowed range of values for time duration in seconds before terminating a transmission attempt when no document data is being sent.

Any(service specific)

various an extension point for RetryInfo

Any (service specific) various an extension point for JobProcessingCapabilities

6.5 Service Configuration

The Service Configuration Element for each Service contains the subset of the Subunits identified in the System Configuration (Chapter 3) that may be necessary for that particular service. The Elements comprising each identified Subunit are described in Chapter 3.

The individual Service specific specifications define the subset of System Configuration Subunits applicable to each Service

6.6 Service Defaults

The Service Defaults (Error: Reference source not found) can include a Default Document Ticket (Error: Reference source not found) and a Default Job Ticket (Error: Referencesource not found.) These default tickets provide the values that will be used for Elements values omitted in the supplied Tickets. The processing instructions are not bound to the Job until the Job is actually processed nor are they bound to the Document until the Document is processed. The values from the Default Tickets are not copied to the Job’s Job Ticket or Document Ticket(s). If the Job Receipt is supported, the combined Elements from the user supplied Job Ticket and the applied values from the Default Job Ticket are copied to the Job Receipt.


321

2310

2311

2312231323142315

23162317

2318

231923202321232223232324232523262327

322


Figure 74 Imaging Service Defaults

Figure 75 Basic Document Ticket Default

Figure 76 Imaging Service Job Ticket Defaults

The Default Job Ticket may contain all of the Elements in a Job Ticket, as described in section 0. The Default Document Ticket may contain all of the Elements of a supplied Document Ticket, as described in Section 6.2


323

2328

2329

2330

2331

2332

2333

2334

233523362337

324


6.7 Service Description

The Service Description Elements of a Service provide descriptive information; that is, the values of the Elements can be administratively set and/or can be modified directly or indirectly through an operation. Service Description consists of two sequences.

3. Elements inherited from the Imaging Service super class. These are represented in Figure 80 with the constituent Elements listed in Table 52.

4. Service specific Elements. Service-specific Elements for the FaxOut Service, which are shared with some other Services, are represented in Error: Reference source not found. Service-specific Description Elements used by more than one Service are listed in Error: Reference source not found.


325

2338

233923402341

234223432344234523462347

326



327

2348

328


Figure 77 Imaging Service Description

Table 53 Service Description Elements


Reference

CharsetConfigured keyword CharsetWKV [RFC2911] Para 4.3.19

CharsetSupported list of keywords

CharsetWKV [RFC2911] Para 4.3.19

DeviceId string IEEE 1284 Device ID [PWG 5105.1] Para 11.1

MakeAndModel string [RFC2911] Para 4.4.9

MessageFromOperator string [RFC2911] Para 4.4.25

NaturalLanguageConfigured keyword NaturalLanguageWKV [RFC2911] Para 4.4.19

NaturalLanguageSupported * list of keywords

NaturalLanguageWKV [RFC2911] Para 4.4.20

OperationsSupported list of keywords

OperationsSupportedWKV [RFC2911] Para 4.4.15

OwnerURI anyUri URI that is an authoritative identifier(e.g., a 'mailto:' URI) of the authenticated Owner of this Service instance.

[RFC3986]

OwnerVCard string A MIME vCard that contains contact information (e.g., email, postal, telephone, etc.) for the authenticated Owner of this Service instance.

[RFC2426]

ServiceGeoLocation anyUri [RFC5870]ServiceInfo string [RFC2911] Para

4.4.6ServiceLocation string [RFC2911] Para

4.4.5ServiceName string [RFC2911] Para

4.4.4VersionsSupported list of strings [RFC2911] Para

4.4.14XriSupported complex Service transport ednpoint

XriUri anyURI [RFC2911] Para 4.4.1

XriAuthentication list of keywords

UriAuthenticationWKV [RFC2911] Para 4.4.2

XriSecurity list of UriSecurityWKV [RFC2911] Para


329

2349

2350

330



Reference

keywords 4.4.3Any various Extension point for

ServiceDescription

6.7.1 OwnerURI

This Service Description element is a URI [RFC3986] that is an authoritative identifier (e.g., a 'mailto:' URI) of the authenticated Owner of this Service instance. This element MAY be usable to deliver notifications to the Owner. The abstract syntax for this element is a string.

6.7.2 OwnerVCard

This Service Description element is a MIME vCard [RFC2426] that contains contact information (e.g., email, postal, telephone, etc.) for the authenticated Owner of this Service instance. This element SHOULD be usable to deliver notifications (e.g., security alerts) to the Service owner. The abstract syntax for this element is a string.

6.7.3 MultipleOperationTimeoutAction

This Service Description element specifies what action the Service should take when a Job times out. The datatype for this element is keyword. This element can be extended by adding new keywords. The defined keywords are:

5. ‘Abort’ – the Job is closed and aborted, 6. ‘Hold’ – The Job is closed and put on indefinite hold, 7. ‘Process’ – the Job is closed and queued for processing.


331

2351

2352235323542355

2356

2357235823592360

2361

236223632364

236523662367

332


Figure 78 Representative Service-Specific Service Description (FaxOut)

Table 54 Service-Specific Service Description Elements


333

2368

2369

2370

334


Element DataType Description ReferenceCompressionDefault keyword Default Compression algorithm assumed to be

used on the Document Data [RFC2911] Para 4.4.32

CompressionSupported list of keywords

Identifies the set of supported compression algorithms for Document content

[RFC2911] Para 4.4.32

DocumentFormatDefault keyword Default document format (i.e., PDL) assumed for a Document

[RFC2911] Para 3.2.1.1 [PWG5100.5] Para 9.1.12

DocumentFormatSupported list of keywords

Identifies the set of supported document format s

[RFC2911] Para 3.2.1.1 [PWG5100.5] Para 9.1.12

DocumentFormatDetailsDefault

complex the member attributes of Doc umentFormatDetails that the Service supports See Figure 82 and Table 54

[PWG5100.7] Para 7.6 –

DocumentFormatDetailsSupported

list of keyword

Default Compression algorithm assumed to be used on the Document Data

[RFC2911] Para 4.4.32

DocumentFormatVersionSupported

list of strings levels or versions of the DocumentFormats that the Service will accept

[PWG5100.7] Para 7.8

DocumentFormatVersionDefault

string level or version of the DocumentFormat that the Service will assume when none is provided by the client

[PWG5100.7] Para 7.7

MultipleDocumentJobsSupported

boolean

MultipleOperationTimeout int Identifies the minimum time (in seconds) that the Service will wait between actions on an open Job before timing out

[RFC2911] Para 4.4.31

MultipleOperationTimeoutAction

keyword value indicates what action the Service should take when a Job times out. This element can be extended by adding new keywords.Defined keywords are:‘Abort’ – the Job is closed and aborted, ‘Hold’ – The Job is closed and put on indefinite hold, ‘Process’ – the Job is closed and queued for processing.

ServiceChargeInfoUri anyURIServiceOrganizations complex

ServiceOrganization string


335

336


Element DataType Description ReferenceServiceOrganizationUnit stringAny various Extension point for ServiceOrganizations

Any various Extension point for ServiceDescription

Figure 79 Detail of DocumentFormatDetailsDefault

Table 55 Constituent Elements of DocumentFormatDetailsDefault

Element DataType ReferenceDocumentFormatDetailsDefault complex [PWG5100.7] section 7.6

DocumentSourceApplicationNamestring


string

DocumentSourceOsName keywordDocumentSourceOsVersion stringDocumentFormat keywordDocumentFormatDeviceId stringDocumentFormatVersion stringDocumentNaturalLanguage keyword


337

2371

2372

2373

338


6.8 Service Status

The Status Elements provide state information for the Service. The Elements are maintained by automata and cannot be directly set. The Element values may be modified indirectly through an operation. For example, a Pause operation may result in the change of the State and State Reasons Elements.

Service Status Elements consists of two sequences.

1. Elements inherited in the Service Status type from the Imaging Service super class including Elements such as Id and State. This includes work counters specific to output and input of the service; e.g.,Images vs Impressions; Jobs vs Resources. These are listed in Table 55 and illustrated in Figure 83.

2. Service specific Elements. The common Service-specific Elements for each image processing Service, are the Service-specific counters, as identified in Table 56.

The Service-specific elements are differentiated by each Service having a complex Counters Element which includes the counters applicable to that Service. Counters are discussed separately in Chapter 8, Counters & Timers.


339

2374

2375

2376237723782379

2380

2381238223832384238523862387

238823892390

340


Figure 80 Imaging Service Status

Table 56 Service Status Elements

Element DataType DescriptionAccessModes list of

keywordsbasic access control policy for authenticated users. This Element corresponds to the access mode property of a POSIX file and specifies the basic access control policy for the Service object, as set by the Owner. The AccessMode Element takes precedence over any externally specified access policy.ObjectAccessModeWKV

ConditionTable complex additional information on the current and past state of Services and


341

2391

2392

2393

342


Element DataType DescriptionSubunits. See Error: Reference source not found

CreateDate dateTime date and time that the Service was createdCurrentTime dateTime current date and time according the Service’s internal clockID int a32 bit Object Identifier for the Scan Service instance. It is unique

withinthe containing System.ServiceUuid anyUri An urn::uuid unique URI value [RFC4122]MessageDateTime dateTimeMessageTime intNaturalLanguage string local language currently used by the Service. This is the language used

unless the operation specifies a RequestedNaturalLanguage(example values: en-us, fr, de, ja) See [RFC3066].

SerialNumber string the serial number of the device hosting the service.State keyword current state of scanning service. The state is a unification of the Service

states from IPP and the Host Resource MIB. See [RFC2911] and [RFC2790]. See paragraph9.2.1 (ObjectStateWKV )

StateMessages list of string information about the Service State and StateReasons in human readable text. If the Service supports this Element, it must be able to generate the messages in any of the natural languages supported by the Service.

StateReasons list of keywords

additional detail about the service's state. The keywords are extensible. The standard keyword values are defined in paragraph 4.4.12 of [RFC2911] and paragraph 4.4.3.1 of [WS-Scan]. (StateReasonsWKVs)

UpTime int Time that the Service has been in the Operational UP state, in seconds.ImagesCompleted int Lifetime count count of what the Service has completed. See Counter

Spec [PWG5106.1 Images or impressions are in units of 1; KOctets are in units of 1024 octets.

ImpressionsCompleted

int

KOctetsProcessed intIsAcceptingJobs boolean If True, Service is currently able to accept CreateJob operation. Method

of configuring the value for this Element is implementation-specific, e.g., local console, web page.

IsAcceptingResources

boolean an extension point for vendor differentiation and implementation specific extensions while maintaining interoperability.

QueuedJobCount int Number of Jobs this Service has currently created but not yet completed

Table 57 Service-Specific Service Status Elements

Element DataType DescriptionServiceCounters complex the counters for the amount of work performed by the Service, timers

covering utilization and monitoring information covering errors, warnings, traffic, Job counts and configuration changes. See Chapter Error:


343

2394

2395

344


Element DataType DescriptionReference source not found and the PWG Counter Spec. [PWG5106.1]

6.8.1 Condition Table

The Condition Table Elements provide additional current and past state information for the Service and its associated Subunits. Note that the System’s Condition Table provides a global view of all conditions. The entries are maintained by automata and cannot be modified by users or administrators. This Element’s information maps to the Printer MIBs Alert Table [RFC3805]. One improvement is that a history may be kept for when Alerts (i.e., Conditions) are corrected.

Note that Condition Elements consists of two sequences.

1. A mandatory list of active conditions2. An optional Condition History.

Note that the only difference between the datatypes for Active Condition and Condition History entries is that Condition Histories contain an Element containing the time the condition was cleared. Condition Table Elements are shown in Figure 84 and are described in Table 57.


345

2396

2397

239823992400240124022403

2404

24052406

2407240824092410

346


Figure 81 Condition Table

Table 58 Condition Table Elements

Element DataType DescriptionComponent complex

Group keyword The type of Subunit/service for this conditionName string Instance identifier for the Subunit/service for this condition

ConditionId int Condition instance identifierName keyword The Condition Name: StateReasonsWKV, KeywordNsExtensionPatternSeverity keyword Severity level of the condition: Informational, Warning, CriticalTime dateTime Date and time the condition occurredClearTime dateTime Date and time the condition was removed


347

2411

2412

2413

348


6.8.2 Relationship among Service State, Service State Reasons, Condition Table and Service State Message Elements

There are a number of related elements in the Service Status group that describe the state of a Service, with the primary indicator being the Service State element. This element has a well-defined set of values that cannot be extended. The transitions between the values of Service State are also well defined. (See section 7.1 and 7.2.1 ). This permits interoperable interpretation of the state of a Service by independently developed automata.

However, although the Service State element allows for a high level representation of the state of a Service, it does not provide enough detail to understand the reason for the Service being in a particular state or what work (if any) is being performed. Therefore, Service State is augmented by the Service State Reasons element. Service State Reasons has a well-defined base set of values that can be extended. Extensions are permissible by the PWG, by a vendor, or even an instance of a Service. This permits interoperable interpretation of the state reason for a Service by independently developed automata with the caveat that vendor or site specific values will be treated as 'Other' values.

The Service State Reasons provides additional detail for the current state a Service. For example a Service might be in a ‘Stopped’ state as indicated by the value of Service State, but Service State Reasons might provide additional detail for the Service’s state. Service State Reasons could contain a value such as ‘Media Empty’. Note that both Service State and Service State Reasons are needed to interpret the affect of a Service State Reason on the state of a Service. For example. a “Media Empty” Service State Reason element value can indicate either a warning condition for a Service or the cause for the Service to move from a ‘Processing’ state to a ‘Stopped’ state. (i.e., the Service will only move to a Stopped state if the Service requires the media previously available in that tray to continue processing the current job.)

The information inherent in the Service State Reason value may be very limited; for example ‘Media Empty’ does not identity what tray is empty. Additional information may be available in the Condition Table element of Service Status (Error: Reference sourcenot found). The Condition Table element contains two tables that represent the current conditions and the previous conditions for the Device hosting the Service. With the example of the ‘MediaEmpty’ Service State Reason, the Current Condition table entry may contain details such s which tray is empty, the condition severity and when the condition occurred. When the condition is cleared the entry is moved to the Condition History table and the time the condition was cleared is added to the entry. Note however that there is not a one to one mapping between entries in the Condition Table and Service State Reasons entries. One condition may result in zero or more Service State Reasons and more than one Service may be affected by a single condition.


349

2414

24152416

241724182419242024212422

242324242425242624272428242924302431

2432243324342435243624372438243924402441

244224432444244524462447244824492450245124522453

350


While Service State and Service State Reason are intended for consumption by automata and can be localized for End User presentation by client software, State Messages is an optional status element that is intended to be presented for direct End User consumption. State Messages is derived from IPP Printer-state-message ( RFC2911, para 4,4,13 [RFC2911]) and is a Server side localized set of strings that summarize the state of the Service. This element is used to provide information on the state of a Service in one or more message strings. The content of the string(s) is vendor specific and is intended to augment the information contained in Service State and Service State Reasons.

6.9 Service Counters and Timers

Counters and timers provide necessary information relating to cost accounting, component wear, utilization efficiency, reliability and other factors. Some of the items being counted or periods being timed are specific to a particular Service or Subunit and are discussed in conjunction with that Service or Subunit. However, because Imaging System s are ultimately concerned with Hardcopy Documents and involve typical computing and communication components, many of the counter and timer types are common to several layers of Elements in the Imaging System Model as well as in the System. Counters and timers of a particular parameter may be with respect to the Imaging System , a Service, or Subunits. Many counters and timers may also apply to a Job or to a Document. The potential for a counter or timer to be present is indicated in the models of the System, Service, Subunit, Job and Document.

These counter types are defined in the PWG Standardized Imaging System Counters specification [PWG5106.1], and are briefly identified in this Chapter. Functionally, counters are classified according to four main areas, as shown below, with the major Work group being further divided.

Work Counters: This category measures work that is produced or processed by the imaging Service or System as its primary function. The Work counters are subdivided into six groups:

1. Work Totals: The sum total of counts in the remaining five Work group counters.2. Datastream: Counters associated with work performed directly in processing

datastream content. That is, these counters reflect the desired primary output of the Service or System.

3. Auxiliary: Counters associated with auxiliary content (e.g., banner sheets, confirmations, and separator sheets) or units of work generated internally by the system or Service (e.g., reports, start-up, calibration).

4. Waste Counters: Counters associated with non-productive work or waste generated by the Imaging System

5. Maintenance Counters: Counters associated with all work performed and waste generated while the system is in maintenance mode.

6. Other: Counts accumulated in a WorkTotals counters that are not otherwise discriminated as Datastream, Auxiliary, Waste or Maintenance.


351

24542455245624572458245924602461

2462

24632464246524662467246824692470247124722473

2474247524762477

247824792480

2481248224832484248524862487248824892490249124922493

352


Media Used Counters: Measure of the sheets of defined media types used by an imaging Service or consumed across multiple services during the imaging process.

Monitoring Counters: Measure of raw traffic and record of error and fault information associated with a Service used to determine workload and operating conditions at a high level.

Availability Counters: Measure of the number of times a Service is in a particular state. Availability counters are used to measure availability of a system or service.

The counter Elements associated with the System Status are represented in Error:Reference source not found. Although not evident from this diagram, the WorkTotals counter reflects the totals from only the “work” counters: DataStream, Auxiliary, Maintenance and Waste (and possibly some vendor specific “work” counters) Media Used, Monitoring and Availability counters (and possibly some vendor specific other counters.)are independent. This same ‘counters’ structure is used for System, Services, Subunits, Jobs and Documents.

This chapter describes this structure and that of each of the counter types in the structure.


353

24942495

249624972498

24992500

2501250225032504250525062507

2508

2509

354


Figure 82 System Counters

The counter structure can exist at different levels in the model and there should be a relationship between counters. For example, the summation of the Document Counters for all Documents in a Job should equal the values of the corresponding Job Counters. The summation of all Job Counters should equal the values of the corresponding Service Counters. The counters for the System are the accumulation of all counts of that type from all of the Services in the System. The WorkTotals values are a different summation, namely that of all of the Work Counters at the same level. These relationships are represented inError: Reference source not found.

The Counters in the Imaging System Model are all “lifetime” counters; that is, they are not settable or resettable but accumulate counts for the lifetime of the Document, Job, Service or System to which they apply.

6.9.1 Work Counters (WorkTotals, DataStream, Auxiliary, Waste and Maintenance)

The Work counters reflect an Imaging System, Service or Subunit in performing its primary function. For example, the Work done by a Service producing hardcopy output is measured primarily in terms of Impressions; the Work done by a Service producing Digital Documents is measured in terms of Images. Facsimile Services work is characterized by Messages. Because most Services deal with Digital Data communication, most include a count of Input and/or Output KOctets.

Note that:

1. An Impression is the content imposed upon a one side of a Media Sheet by a marking engine, independent of the number of times that the sheet side passes any marker.

2. A Blank Impression results when no content is imposed on a Media Sheet side, although the sheet side has passed though the Marker in a way that could have imposed content. The reverse side of a Media Sheet which has been Printed in a simplex [one sided] mode is not considered to have a blank impression.

3. An Image is the digital representation of a virtual media sheet side.4. A Message is a single application protocol request or response (that may consist

of multiple application protocol data units) received or sent by Service such as EmailIn or FaxOut.

5. KOctets is the unit of measurement of the amount of data (in 1024 octets) that was consumed (input) or produced (output) by the Service or System.

Each of the Work Counters (WorkTotals, DataStream, Auxiliary, Waste and Maintenance), at each level where counters may exist, has the same structure, shown in Error:Reference source not found, with constituent Elements listed in Error: Reference sourcenot found. Note however that all counter types are optional.


355

2510

25112512251325142515251625172518

251925202521

2522

252325242525252625272528

2529

2530

2531253225332534253525362537253825392540254125422543

2544254525462547

356


Figure 83 Counters, Showing the Derivation of Service Totals and System Totals


357

2548

2549

358


Figure 84 Work Counter Counts Type

Table 59 Counter Elements Used in the Various Service and System Work Counters

Element DataType

Description *

BlankImpressions int Total of blank impressions, simplex and duplexBlankImpressionsTwoSided int Number of instances where both sides of a sheet Printed

in duplex are blankFullColorImages int Number of Images requiring three or more pixel colors to

representFullColorImpressions int Number of Impression requiring three or more colorantsFullColorImpressionsTwoSided

int Number of instances where both sides of a sheet Printed in duplex are FullColorImpressions


359

2550

2551

2552

360


Element DataType

Description *

HighlightColorImpressions int Number of Impression requiring a black colorant plus one other colorant

HighlightColorImpressionsTwoSided

int Number of instances where both sides of a sheet Printed in duplex are HighlightColorImpressions

Images int Total images of all typesImpressions Int Total Impressions of all typesImpressionsTwoSided int Total number of instances of all types where both sides of

a sheet Printed in duplex InputKOctets int Quantity of incoming data In units of 1024 octetsInputMessages int Total number of messages received by the serviceMonochromeImages int Number of Images requiring one pixel color to representMonochromeImpressions int Number of Impression requiring one colorantMonochromeImpressionsTwoSided

int Number of instances where both sides of a sheet Printed in duplex are MonochromeImpressions

OutputKOctets int Quantity of outgoing data In units of 1024 octetsOutputMessages int Total number of messages sent by the serviceAny various Extension point for Counts

6.9.2 MediaUsed Counters

The Media Used counters track the number of sheets of defined media types used by an Imaging System, Service, Job or Document. These counts are necessary for billing and accounting, and for stock control. Media Counter structure is shown in Error: Referencesource not found with constituent Elements described in Error: Reference source notfound.


361

2553

25542555255625572558

362


Figure 85 Media Used Counters

Table 60 Media Used Counter Elements

Element Datatype

Description*

MediaUsedAccountingKey keyword non-localizable keyword ensuring machine readable, locally unique identification of the specific media. This Element MUST clearly distinguish different instances of the same media size (for example, by including specific media color, weight, etc.)

MediaUsedBlankSheets int Count of instances this media had blank impressionMediaUsedFullColorSheets int Count of instances this media had full color impressionMediaUsedHighlightColorSheets

int Count of instances this media had highlight color impression

MediaUsedMediaInfo string Human readable media descriptionMediaUsedMonochromeSheets

int Count of instances this media had monochrome impression

MediaUsedSizeName keyword See PWG Media Standardized Names [PWG 5101.1)MediaUsedTotalSheets int Count of all instancs that this media was used called

MediaUsedSheets in Counter Spec.[PWG5106.1]Any various Extension point for MediaUsed

6.10 Availability Counters

The Availability counters indicate the availability a System, Service or Subunit by measuring the Down Time, Processing Time, Time In, Maintenance Mode and Total Time.


363

2559

2560

2561

2562

25632564

364


Idle Time can be derived by subtracting the Down, Processing and Maintenance time values from Total Time.

The structure of Availability Counters is represented in Error: Reference source not found. The description of the constituent Elements is in Error: Reference source not found.

Figure 86 Availability Counters

Table 61 Availability Counter Elements

Element Datatype DescriptionDownTime int See PWG 5106.1-2007, "The Printer Working Group

(PWG) Standardized Imaging System Counters 1.1" for definitions. Units are in seconds. [PWG5106.1]

MaintenanceTimeProcessingTimeTotalTimeAny various Extension point for Availability

6.10.1 Monitoring Counters

Monitoring counters give a high level view of the imaging System, Service, and Subunit workload and conditions by recording data flow and warnings and errors conditions. The Monitoring counter structure is represented in Error: Reference source not found with the counter types listed in Error: Reference source not found .


365

25652566

25672568

2569

2570

2571

2572

2573257425752576

366


Figure 87 Monitoring Counts

Table 62 Monitoring Count Elements

Element Datatype DescriptionAbortedJobs int See PWG 5106.1-2007, "The Printer Working

Group (PWG) Standardized Imaging System Counters 1.1" [PWG5106.1]

CanceledJobs intCompletedFinisherJobs intCompletedJobs intConfigChanges intCriticalAlerts intLocalStorageKOctets intMemoryAllocErrors intMemoryAllocWarnings intRemoteStorageKOctets intStorageAllocErrors intStorageAllocWarnings intTotalAlerts intAny various Extension point for Monitoring Counts


367

2577

2578

2579

368


7. Imaging Job Element Groups The general Imaging Job model includes the Job Status, Job Ticket and Job Receipt Element groups and the Documents complex Element, as shown in Error: Referencesource not found. The individual Services each have their own Job model, paralleling this general Imaging Job model.

The state of the Job is described in the Job Status Element. The Job Ticket and the Job Receipt contain descriptive information about the Job and about the Job and Document processing instructions. The Job Ticket and the Job Receipt have the same structure, but the Element values in the Job Ticket are the information provided by the user in the CreateJob operation while the Element values in the Job Receipt reflect what was actually used in processing the Job.

Jobs can contain zero or more Documents. (During Job creation, it is possible that temporarily there are zero Documents.) Some Services do not expose the Document object. Therefore the Imaging Job model includes the optional Documents Element, which in turn may include zero or more Document Elements. It is possible to override the Job level Document Processing instructions on a Document by Document basis by supplying Document Processing Elements in Document Tickets for the affected Documents. The Document model (described in Chapter Error: Reference source not found) mirrors the Job model, consisting of Document Status, Document Ticket and Document Receipt. The Document Ticket like the Job Ticket represents the End User’s intent while the Document Receipt like the Job Receipt represents what the Service actually did.

Figure 88 Imaging Job


369

2580

2581258225832584

258525862587258825892590

2591259225932594259525962597259825992600

2601

2602

370


7.1 Job Status

Job Status Elements provide state information for the Job. The Job Status Elements typically include Elements from the generic Imaging Job Status as well as Service-specific Elements. Imaging Job Status is modeled in Figure 86, Figure 87 and Figure 88. The Elements are described in Error: Reference source not found, Table 59 and Table 60. The values of these Elements are maintained by automata and cannot be set directly by a User or Administrator, although Element values can be modified indirectly through an operation. For example, the CancelJob operation on a Job may result in the change in values of the State and State Reasons Elements.

Some Service-specific Job Status Elements are represented in Error: Reference sourcenot found and listed in Error: Reference source not found All Services include a Job Counters complex Element; the constituent counters are discussed in Chapter Error:Reference source not found. Most include an Images Completed or Impressions Completed Element. Some Services include substantially more Elements in Job Status.


371

2603

26042605260626072608260926102611

26122613261426152616

372


Figure 89 Imaging Job Status

Table 63 Job Status Elements


373

2617

2618

2619

374


Element DataType

Description or Keyword

Reference

DateTimeAtCompleted

dateTime

date and time at which the Job object processing was completed (or was canceled or aborted

[RFC2911] para. 4.3.14.7

DateTimeAtCreation dateTime

date and time at which the Job object was created. [RFC2911] para. 4.3.14.5

DateTimeAtProcessing

dateTime

date and time at which the Job object first began processing

[RFC2911] para. 4.3.14.6

DetailedStatusMessages

list of string

additional detailed and technical information about the Job. The Service MAY localize the message(s), since they are intended for use by the system administrator or other experienced technical persons. Localization might obscure the technical meaning of such messages. Clients MUST NOT attempt to parse the value of this Element.

[PWG5100.11] para. 10.8

DocumentAccessErrors

list of string

additional information about each Document access error for this Job encountered by the Service after it attempted to access or store the Image data at the locations supplied in the Job Ticket.

[RFC2911] para. 4.3.11

ErrorsCount int number of errors encountered during processing (e.g., for the Scan Service, while scanning the Hardcopy Document and generating and storing the Digital Document.)

[PWG5100.7] para. 5.1.1

JobId int uniquely identifies the Job within the Service. The Service is responsible for implementing a Job numbering scheme that will not allow two different Jobs to coexist with the same JobId.

[RFC2911] para. 4.3.2

JobUuid anyUri An urn::uuid unique URI value [RFC4122] [RFC4122]JobOriginatingUserAuthenticationInfo

complex See Table 59. [RFC2617], [RFC4556], [RFC2911]

JobOriginatingUserName

string Service sets this to the most authenticated Printable name that it can obtain (example: “John Doe”, \authDomain\John Doe”)

[RFC2911] para. 4.3.6

JobOriginatingUri anyUri the URL used in processing the job. For example this element would be populated with the source phone number for a FaxOut job.

See 7.1.1

JobState keyword current state of Job. The state values MUST NOT be extended by an implementation. From RFC2911, JobStateWKV

[RFC2911] para. 4.3.7


375

376


Element DataType


Reference

JobStateMessages string information about the Job State and StateReasons in human readable text. If the Service supports this Element, it MUST be able to generate the messages in any of the natural languages supported by the Service.

[RFC2911] para. 4.3.6

JobStateReasons list of keywords

additional detail about the Job state. The typical keyword values are listed below. Values specific to a Service are identified in the specification for that service.JobStateReason

para. 4.3.8 of [RFC2911] and para. 4.5.1.3 of [WS-Scan].

JobUri string globally unique identifier for a Job. [RFC2911] para. 4.3.1

KOctetsProcessed int total number of octets processed at that time, in integral units of 1024 octets

[RFC2911] para. 4.3.18.1

MoreInfo string URI used to obtain information intended for End User consumption about this specific Job.

[RFC2911] para. 4.3.4

NumberOfDocuments int number of Documents in this Job. [RFC2911] para. 4.3.12

NumberOfInterveningJobs

int number of Jobs that are "ahead" of this Job, assuming the current scheduled order.

[RFC2911] para. 4.3.15

TimeAtCompleted int time at which the Job completed in “UpTime” seconds. [RFC2911] para. 4.3.14.3

TimeAtCreation int time at which the Job was created in “UpTime” seconds. [RFC2911] para. 4.3.14.1

TimeAtProcessing int time at which the Job first began processing in “UpTime” seconds.

[RFC2911] para. 4.3.14.2

UpTime int time duration (in seconds) that the Service has been up and running

[RFC2911] para. 4.3.14.4

WarningsCount int total number of warnings that a Service has generated while processing and delivering the Job’s Document(s)

[PWG5100.4] para. 6.1

ImagesCompleted int Progress measure for Job in terms of output. Output may be Images for Hardcopy Document producers and/or Impressions for Hardcopy Document consumers. See PWG Counter Spec [PWG5106.1]

[PWG5106.1] para. 5.2.1


int [RFC2911] para. 4.3.18.2

Any various an extension point for JobStatus


377

378


7.1.1 JobOriginatingUri

This Job Status element is the URL used in processing the job. For example this element would be populated with the source phone number for a FaxOut job. The abstract datatype for this element is string.

Figure 90 Job Originating User Authentication Info

Table 64 Job Originating User Authentication Info Elements

Element DataType Description ReferenceAuthenticationType keyword Type of authentication used:

Basic, Digest: data in Token,Certificate: data in Cert,Kerberos: data in Token,Token: data in Token,RequestingUserName: data in AuthString,None: no associated dataAny vendor extended keyword: any of the fields below

RFC2617,e.g., RFC4158,RFC4556,Vendor specific contentRFC2911 No referenceVendor specific content

Token base64binary

Contains a transport safe encoded token RFC4648

Cert base64binary

Contains a transport safe encoded certificate RFC4648

AuthUri anyUri A sting with a URI syntax RFC2396AuthString string A stringAny various Vendor specific type other than one of the

above


379

2620

262126222623

2624

2625

2626

380


Figure 91 Representative Service-Specific Job Status Elements

Table 65 Service-Specific Job Status Elements

Element DataType


CompressionDetected keyword Compression type actually used on the Document

[PWG5100.5] para9.1.12

DocumentFormatDetailsDetected

complex Generated by the Service to indicate the actual document format details of the Document object

[PWG5100.5] para9.1.14

DocumentSourceApplicationName

string name of the application that created the document, without its version number

[PWG5100.5] para9.1.13


string version of the application that created the document, without its name

[PWG5100.5] para9.1.13

DocumentSourceOsName string name of the operating system, without version number, on which the document was generated

[PWG5100.5] para9.1.13


381

2627

2628

2629

382


Element DataType


DocumentSourceOsVersionstring version of the operating system, without its

name, on which the document was generated[PWG5100.5] para9.1.13

DocumentFormat keyword Document format (i.e., PDL) for the Document [RFC2911] para3.2.1.1[PWG5100.5] para9.1.12

DocumentFormatDeviceId string Identifies the type of device for which the document was formatted, including manufacturer and model, following the IEEE 1284-2000 Device ID string

[PWG5100.5] para9.1.13

DocumentFormatVersion string the level or version of the DocumentFormat. [PWG5100.5] para9.1.16

DocumentNaturalLanguage keyword Identifies the primary Natural Language of the Document.

[RFC2911] para3.2.1.1[PWG5100.5] para9.1.22

DocumentFormatDetected keyword Service sets this to the actual DocumentFormat detected when auto-sensing

[PWG5100.5] para9.1.15

DocumentFormatVersionDetected

string service sets this to the actual DocumentFormat level detected when auto-sensing

[PWG5100.5] para9.1.17

JobCounters complex Counters appropriate to the Service See Chapter Error: Reference source not found

[PWG5106.1]

Images (or Impressions)Completed

int Number of images (or impressions) processed by the service

[PWG5106.1]

Any various Extension point for JobStatus

7.2 Job Ticket

The generic Imaging Job Ticket (Error: Reference source not found) contains description and processing Elements provided by the client in the CreateJob request. This information is used by the Service during the processing of a Job and is made available to Clients through the GetJobElements operation. A subset of this information is made available through the GetActiveJobs and GetJobsHistory operations.


383

2630

26312632263326342635

384


Figure 92 Imaging Job Ticket

The general Imaging Job Ticket indicates the Elements that may be included in a Job Ticket. The Service-specific models may contain additional Elements. A Job Ticket supplied with a CreateJob request need not contain all permitted Elements. Elements that are necessary but not supplied with the CreateJob request are supplied the by the DefaultJob Ticket that is part of the Service model (see Error: Reference source notfound, section Error: Reference source not found.) The Default Job Ticket may contain all of the same Elements as are defined for the Job Ticket. However, the Element values within a Job Ticket are specific and single-valued.

7.2.1 Job Ticket Document Processing

The Document Processing complex Element provides the Document processing instructions that have been requested by the End User at the Job level. Each Element has a Must Honor Element to indicate whether Documents within the Job must be processed according to what user has requested or whether a “best effort” implementation is allowed. Note that the Document Processing Elements contained in the JobTicket follow the same general structure as Service Capabilities DocumentProcessing, but the Datatypes and values reflect specific instances reflecting the User’s intent.

Document Processing consists of two sequences:

6. Elements inherited from the Imaging Service super class (just Number Up and Presentation Direction Number Up, as shown in Figure 90 and described in Table 61.

7. Service specific Elements (a much larger set) that may be common to two or more Services. Generally, these elements are common among image-outputting Services such as Scan, FaxOut and EmailOut (Figure 91, Figure 92 and Figure 93 and Table 62), and among impression-outputting Services such as Print, FaxIn and EmailIn (Figure 94, Figure 95 and Figure 96 and Table 64). Some Services may have elements from both image and impression outputting groups.


385

2636

2637

26382639264026412642264326442645

2646

2647264826492650265126522653

2654

265526562657265826592660266126622663

386


Although the structure and names of constituent elements are generally the same as shown in the Service Model description (Chapter Error: Reference source not found), the datatypes and descriptions of these Elements in a Job Ticket are as described in this section.

Figure 93 JobTicket Superclass DocumentProcessing

Table 66 JobTicket Superclass DocumentProcessing Elements

Element DataType

Description or Keyword Group Reference

NumberUp fint number of input “pages” that are ro be included in a single output “impression; or the number of input “images” that areto be included in the output image.

[RFC2911] para 4.2.9

PresentationDirectionNumberUp

keyword placement order of the Images from the input Scan Regions or pdl pages on to the output Image or impression. Associated with the “NumberUp” Element PresentationDirectionNumberUpWKV

[PWG5100.3] para 3.17

Any various Extension point for ImagingDocumentProcessingCapabilities


387

2664266526662667

2668

2669

2670

388


Figure 94 JobTicket DocumentProcessing - Image Output Services Sheet 1


389

2671

2672

390


Figure 95 JobTicket DocumentProcessing - Image Output Services Sheet 2


391

2673

2674

392


Figure 96 JobTicket DocumentProcessing - Image Output Services MediaBox

Table 67 Service-Specific Job Ticket Document Processing Elements - Image Output Services

Element DataType

Description orKeyword

Reference

AutoSkewCorrection boolean detection and correction of small skew orientation error from the media loading from the ADF or placement on the platen by the user is to be applied.

[PWG5108.2] para 8.1.3.1.3

ColorEntry keyword color processing mode. Each keyword describes a color encoding, color space, bit depth and samples per pixel combination. See Error: Reference source not found for keywords Vendors may add additional keywords. ColorEntryWKV

[PWG5108.2] para 8.1.3.1.4

Compression keyword compression algorithm used on the Document Data, if any. CompressionWKV

[RFC2911] para 4.4.32

CompressionQualityFactor

int normalized integer value used by JPEG compression to determine the amount of acceptable image loss. JPEG compression can be lossy, some amount of data is lost (not reproducible) or lossless. The higher the requested compression factor the smaller the resulting file size. The value is normalized as an integer between 0 and 100.

[PWG5108.2] para 8.1.3.1.6

ContentType keyword main characteristics of the original Document. It is used as a hint to the Scan Service on how it should handle the scanning of the Hardcopy Document. ContentTypeWKV

[PWG5108.2] para 8.1.3.1.7

Destination complex destination to which output of the Job s to be delivered. Either a directory in which the Digital Document is stored or the URI to the Digital Document file.

[PWG5108.2] para 8.1.3.1.8

Destination anyURI [PWG5108.2] para 8.1.3.1.8.1


393

2675

2676

26772678

394


Element DataType


Reference

DestinationDirectoryanyURI used when the output of the Job is a set of Digital

Document files stored in a directory. [PWG5108.2] para 8.1.3.1.8.2

Any various Extension point for DestinationDocumentDigitalSignature

keyword type of digital signature, if any, used in the creation of the Digital Document. DocumentDigitalSignatureWKV, KeywordNsExtensionPattern

[PWG5100.7] para 3.2.3 [PWG5100.5] para 9.1.11

DocumentFormat keyword format used to save Digital Documents. This is given as an enumeration value of MIME type which is pwg:DocumentFormat type. DocumentFormatWKV

[RFC2911] para 3.2.1.1 and [PWG5100.5] para 9.1.12

DocumentSizeAutoDetect

boolean area within the input Hardcopy Document’s media sheet side boundaries to Scan are automatically determined by the device in an implementation specific manner. This Element is mutually exclusive with Scan Region.

[PWG5108.2] para 8.1.3.1.20

Exposure complex AutoExposure Element or a sequence of four Elements: Brightness, Contrast, Sharpness, and Any.

[PWG5108.2] para 8.1.3.1.11

AutoExposure boolean automatic background reduction will be performed on the input Document.

[PWG5108.2] para 8.1.3.1.11.1

Brightness int relative amount to enhance or reduce the brightness of the scanned Image. Negative values will darken the Image and positive values will lighten the Image. The value is normalized as an integer between -100 and 100.

[PWG5108.2] para 8.1.3.1.11.2

Contrast int relative amount to enhance or reduce the contrast of the scanned Image Negative values will reduce the apparent difference between light and dark pixels in the Image. Positive values will increase the apparent difference between light and dark pixels in the Image. The value is normalized as an integer between -100 and 100.

[PWG5108.2] para 8.1.3.1.11.3

Sharpness int relative amount to enhance or reduce object edges within a scanned Image. Positive values enhance object edges and negative values reduce object edges. The value is normalized as an integer between -100 and 100.

[PWG5108.2] para 8.1.3.1.11.4

Any extension point forExposureFilmScanMode keyword exposure type of the film to be scanned. The

Element is valid only if the InputSource Element is set to a value of ‘FilmReader’. FilmScanModeWKV, KeywordNsExtensionPattern

[PWG5108.2] para 8.1.3.1.12


395

396


Element DataType


Reference

ImagesToTransfer int number of Images to Scan from the Hardcopy Document.

[PWG5108.2] para 8.1.3.1.13

InputSource keyword source of the scanned Document. InputSourceWKV [PWG5108.2] para 8.1.3.1.14

MediaBox complex Applicable only when the Document format used to store the Digital Document has a similar construct that controls the placement and bounding of the scanned Image on the Document format specific page Image. Prior to applying all other processing Elements are assumed to have been applied.

[PWG5108.2] para 6.5.3

ImageBox complex region where the Image from the Scan of the Scan Region will be placed.

[PWG5108.2] para 6.5.3

Height int height of the image box in RegionUnits. [PWG5108.2] para 7.1.2.1.19.1

Width int width of the image box in RegionUnits. [PWG5108.2] para 7.1.2.1.19.2

X-Offset int offset, positive or negative, on the X axis from the origin of the MediaBox in RegionUnits.

[PWG5108.2] para 7.1.2.1.19.3

Y-Offset int offset, positive or negative, on the Y axis from the origin of the MediaBox in RegionUnits

[PWG5108.2] para 7.1.2.1.19.4

Any various extension point for ImageBoxRegionUnits keyword unit used for specifying all dimensions defining the

region. RegionUnitWKV[PWG5108.2] para 7.1.2.1.19.5

ImageCroppingPolicykeyword controls handling of mismatches in the size of the

Image and the intersection of the ImageBox and MediaBox where the Image will be placed. ImageCroppingPolicyWKV, KeywordNsExtensionPattern

[PWG5108.2] para 8.1.3.1.15.2

MediaSizeName keyword identifies the size of the canvas for an Image in the Digital Document expressed as a media size name. MediaSizeNameType

[PWG5101.1] para 5

OrientationRequestedkeyword identifies the orientation of the MediaBox

OrientationRequestedType[RFC2911] para 4.2.10

Any various Extension point for MediaBox


397

398


Element DataType


Reference

Resolution complex resolution in the Feed and Cross Feed directions at which to impress or capture the Image. The Resolution data structure does not limit the values. However, individual devices may limit the range of options to a predefined list or range. This information will be available as part of the Service Capabilities provided as a result of a Get,serevice>Elements query. Resolution is specified in pixels per inch or pixels per centimeter. Constituent elements of Resolution are described in Table 64.

RFC2911] para 4.2.12

Rotation keyword amount each Image of a scanned Document is to be rotated. Specified in limted set of values in degrees clockwise. Standard values are 90, 180, 270. Vendors may add more. RotationWKV

[PWG5108.2] para 8.1.3.1.17

Scaling complex scaling to be applied to the scanned Image. Isomorphic (i.e., the aspect ratio of the Image does not change) is accomplished by specifying the same values for ScalingWidth and ScalingHeight. A value of ‘100’ specifies that no adjustments are made to the scanned Image. Magnification is expressed in 1 percent increments. Values below ‘100’ reduce the magnification and values above increase magnification.

[PWG5108.2] para 8.1.3.1.18

ScalingHeight int scaling in the fast Scan direction expressed in 1 percent increments. Values below ‘100’ reduce the magnification and values above increase magnification.

[PWG5108.2] para 8.1.3.1.18.1

ScalingWidth int scaling in the slow Scan direction expressed in 1 percent increments. Values below ‘100’ reduce the magnification and values above increase magnification.

[PWG5108.2] para 8.1.3.1.18.2

AutoScaling boolean scaling of the image to be automatic, in an implementation specific manner.

[PWG5108.2] para 8.1.3.1.18.3

ScanRegions complex areas within the input Hardcopy Document’s media sheet side boundaries to scan. If Scan Region is not specified, the device should use 0 as the offsets and the width and height of the InputSize, if given. If Scan Region is not specified and InputSize is not specified or cannot be determined by the device, the implementation is up to the hardware vendor. Is mutually exclusive with DocumentSizeAutoDetect.

[PWG5108.2] para 8.1.3.1.19


399

400


Element DataType


Reference

ScanRegion complex See 31.1.1 [PWG5108.2] para 8.1.3.1.19.1

Height int height of the Scan Region in RegionUnits [PWG5108.2] para 8.1.3.1.19.1.1

Width int width of the Scan Region in RegionUnits Width corresponds to the fast Scan direction and Height corresponds to the slow Scan direction.

[PWG5108.2] para 8.1.3.1.19.1.2

X-Offset int offset, positive or negative, on the X axis from the West Margin of the Scanner Subunit in RegionUnits

[PWG5108.2] para 8.1.3.1.19.1.3

Y-Offset int offset, positive or negative, on the Y axis from the West Margin of the Scanner Subunit in RegionUnits

[PWG5108.2] para 8.1.3.1.19.1.4

ContentRegionUnits

keyword units used for specifying the region RegionUnitWKV

[PWG5108.2] para 8.1.3.1.19.1.5

Any various Extension point for ScanRegionDocumentSizeAutoDetect

boolean True= document size automatically determined

Sides keyword SidesWKVAny various extension point for JobTicketDocumentProcessing

Note: the ColorEntry Element describes the color processing mode. Each keyword describes a color encoding, color space, bit depth and samples per pixel combination. Vendors may add additional keywords.

Table 68 Color Processing Elements

Keyword Color Type Color Encoding

Bit Depth Samples per pixel

BlackandWhite1 Binary 1 1Grayscale4 Gray 4 4Grayscale8 Gray 8 8Grayscale16 Gray 16 16RGB24 color RGB 24 8RGB48 color RGB 48 16RGBa32 color RGB 32 8RGBa64 color RGB 64 16CMYK32 color CMYK 32 8CMYK64 color CMYK 64 16


401

267926802681

2682

402


7.2.1.1 Header Print

This Document Processing element specifies Indicates how a transmitted document header is added to the outbound transmission by a Service (e.g., FaxOut EmailOut). The datatype for this element is keyword. This element can be extended by adding new keywords. The corresponding Document Ticket Capabilities element is a list of keywords specifying the values supported by the implementation. The defined keywords are:

1. ‘Inside’ – the header is added within document image for transmission, 2. ‘Outside’ – The header is added outside the document image for transmission, 3. ‘No Print’ – the header is not added to the document image for transmission.

Figure 97 JobTicket DocumentProcessing - Impression Output Services Sheet 1

Figure 98 JobTicket DocumentProcessing – Impression Output Services Sheet 2

Figure 99 JobTicket DocumentProcessing – Impression Output Services Sheet 3

Table 69 Service-Specific Job Ticket Document Processing Elements - Impression Output Services


Reference

Copies int [RFC2911] para 4.2.5

CoverBack complex Note that all complex Elements referring to a sheet of physical media upon which an impression could be made, are of the same structure as illustrated for CoverBack. This applies to CoverFront, ISheetType, SeparatorSheet, eyc.

[PWG5100.3] para 3.1

CoverType keyword CoverTypeWKV, KeywordNsExtensionPattern [PWG5100.3] para 3.1.2

Media keyword MediaSizeAliasNameWKV, MediaSizeLegacyNamesWKV, MediaSizeSelfDescribingNameWKV

[RFC2911] para 4.2.11

MediaType keyword MediaTypeWKV [PWG5100.3] para 3.13.2

MediaCol complex See Error: Reference source not found [PWG5100.3] para 3.13

Any various Extension point for CoverBack [PWG5100.3] para 3.13.2


403

2683

26842685268626872688

268926902691

2692

2693

2694

2695

2696

2697

26982699

404



Reference

CoverFront complex [PWG5100.3] para 3.1

CoverType keyword CoverTypeWKV, KeywordNsExtensionPattern [PWG5100.3] para 3.1.2


[RFC2911] para 4.2.11


MediaCol complex See Error: Reference source not found [PWG5100.3] para 3.13

Any various Extension point for CoverFrontFeedOrientation keyword FeedOrientationWKV KeywordNsExtensionPattern [PWG5100.1

1] para 7.1

FilmScanMode keyword exposure type of the film to be scanned. The Element is valid only if the InputSource Element is set to a value of ‘FilmReader’. FilmScanModeWKV, KeywordNsExtensionPattern

[PWG5108.2] para 8.1.3.1.12

Finishings keyword FinishingsWKV, KeywordNsExtensionPattern [RFC2911] para 4.2.6[PWG5100.1] para 2

FinishingsCol complex [PWG5100.3] para 3.2

FinishingTemplate string A string specifying some particular finishing operation

[PWG5100.3] para 3.2.1

Stitching complex [PWG5100.3] para 3.2.2


keyword Specifies the stitching reference edge of the output media StitchingReferenceEdgeWKV, KeywordNsExtensionPattern

[PWG5100.3] para 3.2.2.1

StitchingOffeset int The perpendicular distance from the reference edge to the stitching axis in hundredths of a millimeter.

[PWG5100.3] para 3.2.2.2

StitchingLocations int The distance along the stitching axis where a stitch will be placed in hundredths of a millimeter

[PWG5100.3] para 3.2.2.3

Any various Extension point for StitchingAny various Extension point for FinishingsCol

FontNameRequested string Specifies the font name for a document format that does not have inherent font information

[PWG5100.11] para 7.2


405

406



Reference

FontSizeRequested int Specifies the font size for a document format that does not have inherent font information

[PWG5100.11] para 7.3

ForceFrontSide int Forces the specified pages to be Printed on the front side of a sheet of media.

[PWG5100.3] para 3.3

Header Print keyword Indicates how a transmitted document header is added to the outbound transmission by the Service (FaxOut EmailOut)Header PrintWKV, KeywordNsExtensionPattern

See 7.2.1.1

ImpositionTemplate string Specifies imposition method for laying out finished page images onto the surface of output media

[PWG5100.3] para 3.4

InsertSheet complex Specifies how Insert Sheets are to be inserted into the sequence of media sheets that are produced for each copy of the documents

[PWG5100.3] para 3.5

ISheetInsertAfterPage int Specifies the input page after which the Insert

Sheet will be placed. [PWG5100.3] para 3.5.1

InsertCount int Specifies the number of Insert Sheet to insert [PWG5100.3] para 3.5.2


[RFC2911] para 4.2.11


MediaCol complex See Figure 97, and Error: Reference source not found

[PWG5100.3] para 3.13

Any various Extension point for InsertSheetMedia keyword MediaSizeAliasNameWKV,

MediaSizeLegacyNamesWKV, MediaSizeSelfDescribingNameWKV

[RFC2911] para 4.2.11


MediaCol complex Figure 97, and Error: Reference source not found [PWG5100.3] para 3.13

MediaInputTrayCheck keyword characteristics of the media in the identified input tray must match the characteristics of the media identified by the "media" or "media-col" element. MediaInput TrayCheckWKV, MediaNsExtensionPattern

[PWG5100.3] para 3.14

OrientationRequested keyword The desired orientation for Printed pages for document formats that don’t have a built-in orientation. OrientationRequestedWKV

[RFC2911] para 4.2.10


407

408



Reference

OutputBin keyword Specifies the output bin where the Job is to be delivered. OutputBinWKV, KeywordNsExtensionPattern

[PWG5100.2] para 2.1 [PWG5100.5] para 8.1

OutputDevice string Specifies the device where the pages of of a Job/Document will be Printed

[PWG5100.7] para 4.2.1 [PWG5100.5] para 8.1

PageDelivery keyword Indicates whether the pages of the Job are to be delivered to the output bin or finisher in the same page order as the original document and face up or face down PageDeliveryWKV, KeywordNsExtensionPattern

[PWG5100.3] para 3.15

PageRanges range of int

Specifies a range of pages in the document data to be output

[RFC2911] para 4.2.7

PagesPerSubset int Combines all of the Pages of all of the Documents into a single stream of -Pages. Then the Printer partitions that single stream into contiguous subsets of -Pages according to the list of integers

[PWG5100.4] para 5.3

PdlInitFile complex (Note: PdlInitFiles is an artifact of the XML encoding)

[PWG5100.11] para 7.10

PdlInitFileLocation Uri Absolute URI that specifies the path to the directory where the initialization file to be sent to the Printer’s PDL interpreter will be found

[PWG5100.11] para 7.10.1.1

PdlInitFileName string specifies the name of the initialization file within the directory

[PWG5100.11] para 7.10.1.2

PdlInitFileEntry string specifies an entry point within the init file at which the PDL interpreter starts.

[PWG5100.11] para 7.10.1.2

PrintContentOptimize keyword PrintContentOptimizeWKV, KeywordNsExtensionPattern

[PWG5100.7] para 4.2.2 [PWG5100.5] para 8.1

Quality keyword PrintQualityWKV, KeywordNsExtensionPattern [RFC2911] para 4.2.13


409

410



Reference

Resolution complex resolution in the Feed and Cross Feed directions at which to impress or capture the Image. The Resolution data structure does not limit the values. However, individual devices may limit the range of options to a predefined list or range. This information will be available as part of the Service Capabilities provided as a result of a Get,serevice>Elements query. Resolution is specified in pixels per inch or pixels per centimeter.

RFC2911] para 4.2.12

CrossFeedDir int resolution in Units for the Cross Feed directions at which to capture the Image

RFC2911] para 4.1.15

FeedDir int resolution in Units for the Feed directions at which to capture the Image

RFC2911] para 4.1.15

Units keyword units used to express the resolution UnitsWKV

RFC2911] para 4.1.15

SeparatorSheets complex Specifies the separator sheets to be Printed with the Document

[PWG5100.3] para 3.18

SpreaderSheetsType keyword Specifies the separator sheets typeSeparatorSheetsTypeWKV, KeywordNsExtensionPattern

[PWG5100.3] para 3.18.1


[RFC2911] para 4.2.11


MediaCol complex See Figure 97 and Error: Reference source not found

[PWG5100.3] para 3.13

Any various Extension point for SeparatorSheetsSheetCollate keyword SheetCollateWKV [PWG5100.3

] para 3.18.1Sides keyword SidesWKVXImagePosition keyword XImagePositionWKV [PWG5100.3

] para 3.19.2XImageShift int Causes the Finished-Page Image to be shifted in

position with respect to the x-axis of the media[PWG5100.3] para 3.19.3

XSide1ImageShift int Causes each Finished-Page Image that would be placed on the front side of a sheet to be shifted in position with respect to the x-axis of the media

[PWG5100.3] para 3.19.4

XSide2ImageShift int Causes each Finished-Page Image that would be placed on the backside of a sheet to be shifted in position with respect to the x-axis of the media

[PWG5100.3] para 3.19.5

YImagePosition keyword YImagePositionWKV [PWG5100.3] para 3.19.6


411

412



Reference

YImageShift int Causes the Finished-Page Image to be shifted in position with respect to the y-axis of the media

[PWG5100.3] para 3.19.7

YSide1ImageShift int Causes each Finished-Page Image that would be placed on the front side of a sheet to be shifted in position with respect to the y-axis of the media

[PWG5100.3] para 3.19.8

YSide2ImageShift int Causes each Finished-Page Image that would be placed on the backside of a sheet to be shifted in position with respect to the y-axis of the media

[PWG5100.3] para 3.19.9

Any various extension point for JobTicketDocumentProcessing

7.2.1.2 Media Collection (Specific)

The collection of media attributes, grouped in the Media Col complex Element, appears many places where media is to be defined, or capabilities of handling media are identified. The Media Col capabilities structure was shown in Error: Reference source not found with the constituent capabilities elements listed in Error: Reference source not found. The Media Col structure when referring to a specific item of media (a medium) is represented in Error: Reference source not found, with the Elements listed in Error: Reference sourcenot found.

Media Col contains many member Elements. Therefore, unlike for other Job or Document Elements, Services should not return Media Col values in response to a GetJobElements or GetJobElements request. An explicit request for the specific Media Col elements is required.


413

2700

2701270227032704270527062707

2708270927102711

414


Figure 100 Media Col Structure Specific

Table 70 Media Collection Elements in Job Ticket


415

2712

2713

2714

416


Element DataType


Reference [PWG5100.

3]MediaCol

MediaBackCoatingkeyword

pre-process coatings applied to the media MediaCoatingWKV, MediaColorExtensionPattern

para 3.13.10

MediaColor keyword

color of the media MediaColorWKV, MediaColorExtensionPattern

para 3.13.4

MediaFrontCoatingkeyword

pre-process coatings applied to the media MediaCoatingWKV, MediaNsExtensionPattern

para 3.13.10

MediaGrain keyword

grain of the media (affects curling and folding)MediaGrainWKV, MediaNsExtensionPattern

[PWG5100.11] para 11.5.2

MediaHoleCountint number of predrilled holes for the media para 3.13.6

MediaInfo string information that helps describe the media instance para 3.13.3MediaKey string unique name of the media. The media that MediaKey

represents is a named collection of MediaCol elements and their values

para 3.13.1

MediaOrderCountint number of sheets, within an ordered sequence of sheets; after

which the sequence begins to repeat para 3.13.7

MediaPre Printed

keyword

pre- Printed characteristics of the media MediaPre PrintedWKV, MediaNsExtensionPattern

Para 3.13.5

MediaRecycledkeyword

recycled characteristics of the media MediaRecycledWKV, MediaNsExtensionPattern

para 3.13.1

MediaSize complex

numerical media width and height dimensions of media in hundredths of a millimeter

para 3.13.8

XDimensionint para

3.13..8.1

YDimensionint para

3.13..8.2

MediaSizeNamekeyword

Name of medium size that the Printer uses for all impressions of the Job MediaSizeNameWKV, MediaSizeNameExtensionPattern

[PWG5101.1] para 5

MediaThicknessint thickness of the media in .01 millimeters [PWG5100.1

1] para 11.5.3

MediaTooth keyword

The tooth (or roughness) of the media MediaToothWKV, MediaNsExtensionPattern

[PWG5100.11] para 11.5.1

MediaType keyword

t medium type used for all impressions of the JobMediaTypeWKV, MediaTypeExtensionPattern

para 3.13.2

MediaWeightMetricint weight of the desired media rounded to the nearest whole

number of grams per square meterpara 3.13.9


417

418


Any various Extension point for MediaCol

7.2.2 Job Ticket Job Description

Job Description as related to a specific Job has a structure like that described for Service JobDescriptionCapabilities para. Error: Reference source not found except that in a Ticket, the values of the simple Elements correspond to actual values for the given Job rather than describing the capabilities of the Service.

The Job Description complex Element consists of two sequences.

4. Elements inherited from the Imaging Job super class (i.e., Imaging Job Description), as represented in Figure 98 and listed in Table 66.

5. Service specific extensions to the super class including the extension point for vendors. Those specific to Print Service (and also largely applicable to EmailOut and FaxOut) are represented in Figure 99 and listed in Table 67.

The group of Job Description Elements common to more than one Service that may be included in a Job Ticket are described in Error: Reference source not found. This table includes both those Elements from the general Imaging Job Description and common Service-specific Elements. Note that, although the Element names are the same or similar to those in Chapter 4, the datatypes of the Elements are typically different.


419

2715

2716271727182719

2720

27212722272327242725

27262727272827292730

420


Figure 101 ImagingJobDescription (Superclass)

Table 71 JobTicket ImagingJobDescription Elements (Superclass)

Element DataType Description ReferenceElementsNaturalLanguage keyword natural language of the system-generated string

Elements, as set by the End User.NaturalLanguageWKV

[RFC3066].

JobAccountingID string accounting ID associated with this Job. PWG5100.3] para 3.6

JobAccountingUserID string This Element specifies the User ID associated with the “JobAccountId”.

[PWG5100.3] para 3.7


421

2731

2732

2733

422


Element DataType Description ReferenceJobMandatoryElements various List of PWG standard vendor-specified Elements

considred mandatory,with each Element of appropriatestatype. Identifies Ticket Elements the Scanner must honor. The Service rejects the request for Job creation if any of the listed Elements are unsupported or contain values that the Service does not support. All of the remaining supplied Elements are best effort.

attribute-fidelity [RFC2911] para 15.1 and [PWG5100.5] para 8.1.1

JobMessageFromOperator string message to the End User indicating the reasons for any management action taken on this Job

[RFC2911] para 4.3.16

JobMessageToOperator string message from the End User to indicate something about the processing of this Job.

[PWG5100.3] para 3.10

JobMoreInfo anyUri User supplied URI referencing some resource with more information about this Job

[RFC2911] para 4.3.4

JobName string Service sets this to the client-supplied, end-user friendly name for the Job. When it is not supplied by the client, the Service must generate a name from other information.

[RFC2911] para 4.3.5

JobOriginatingUserName string set to the most authenticated Printable name of the originating user that the Service can obtain

[RFC2911] para4.3.6

JobOriginatingUserUri anyUri URI of the User originating the JobJobPassword octetString password supplied by the client, encrypted

according to method specified by the client in the JobPasswordEncryption Element.

[PWG5100.11] para 6.1

JobPasswordEncryption keyword encryption the client is using for the supplied value of the JobPassword Element. JobPasswordEncryptionWKV, KeywordNsExtensionPattern

PWG5100.11] para 6.2

KOctets int total size of this Job’s Digital Document(s) in integral units of 1024 octets.

[RFC2911] para 4.3.17.1

TemplateCreatorUserName

string name of user who created the template used to create the Job Ticket (if any). Note: For a Job Template this is used to hold the most authenticated user name of the Template Creator.

[PWG5108.2] para 7.1.2.2.12

TemplateId URI ID of the template used to create the Job Ticket (if any).

[PWG5108.2] para 7.1.2.2.13

TemplateInfo string TemplateInfo for the template used to create the Job Ticket (if any).

[PWG5108.2] para 7.1.2.2.14


423

424


Element DataType Description ReferenceTemplateName string name of template used to create the Job Ticket

(if any). Note: For a Job Template this is used to hold the Template Repository wide unique Template name.

[PWG5108.2] para 7.1.2.2.15

TemplateType keyword type of the template used to create the Job Ticket (if any). The type of the template MUST be appropriate for the Service TemplateTypeWKV

[PWG5108.2] para 7.1.2.2.16

Any (service specific) various Extension point for JobTicketJobDescription

Figure 102 Representative Service-Specific Job Ticket Job Description Elements ( Print Service)

Table 72 Service-Specific JobTicketJobDescription Elements


425

2734

27352736

2737

426


Element DataType Description ReferenceCompressionSupplied keyword Default compression algorithm

used for the Documents Data , CompressionWKV, KeywordNsExtensionPattern

[PWG5100.7] para5.2.1

DocumentCharsetSupplied keyword The default charset of the Documents content , CharsetWKV, KeywordNsExtensionPattern

[PWG5100.7] para5.2.2

DocumentDigitalSignatureSupplied keyword The type of digital signature used in the Document Content , DigitalSignatureWKV, KeywordNsExtensionPattern

[PWG5100.7] para5.2.3

DocumentFormatDetailsSupplied complex Summarizes the default distinct contained document formats

[PWG5100.7] para5.2.4

DocumentSourceApplicationName string name of the application that created the document, without its version number

[PWG5100.5] para9.1.13

DocumentSourceApplicationVersion string version of the application that created the document, without its name

[PWG5100.5] para9.1.13

DocumentSourceOsName keyword name of the operating system, without version number, on which the document was generated

[PWG5100.5] para9.1.13

DocumentSourceOsVersion string version of the operating system, without its name, on which the document was generated

[PWG5100.5] para9.1.13

DocumentFormat keyword Document format (i.e., PDL) for this Document, DocumentFormatWKV, MimeExtensionPattern

[RFC2911] para3.2.1.1[PWG5100.5] para9.1.12

DocumentFormatDeviceId string type of device for which the document was formatted, following the IEEE 1284-2000 Device ID string

[PWG5100.5] para9.1.13

DocumentFormatVersion string level or version of the DocumentFormat

[PWG5100.5] para9.1.16

DocumentNaturalLanguage keyword primary Natural Language of the Document, NaturalLanguageWKV, NatLangExtensionPattern

[RFC2911] para3.2.1.1[PWG5100.5] para9.1.22


427

428


Element DataType Description ReferenceDocumentFormatSupplied keyword default Document format (i.e.,

PDL) for Documents in the Job , DocumentFormatWKV, KeywordNsExtensionPattern

[PWG5100.7] para5.2.5

DocumentFormatVersionSupplied string default level or version of the DocumentFormat

[PWG5100.7] para5.2.6

DocumentMessageSupplied string message from either (1) the user to the operator about the Documents or (2) from the operator, system administrator, or "intelligent" process to indicate to the end user the reasons for modification or other management action taken on the Documents

[PWG5100.7] para5.2.7

DocumentNameSupplied string default name for the Documents in the Job to be used in an implementation specific manner

[PWG5100.7] para5.2.8

Impressions int total size in number of impressions in all the Job’s Document(s)

[RFC2911] para4.3.17.2

MediaSheets int total number of media sheets to be produced for this Job’s Document(s)

[RFC2911] para4.3.17.3

PageOrderReceived keyword the order of pages in this Document data as supplied with the Job , PageOrdertWKV, KeywordNsExtensionPattern

[PWG5100.3] para3.16

Any (service specific) various Extension point for JobTicketJobDescription

7.2.3 JobTicket Job Processing

JobTicketJob Processing provides the Job processing instructions that have been requested by the End User. Each Element has a Must Honor Element. When the value of Must Honor is true, the Service does not process the Job unless the Element is supported; otherwise the Service processes the Job with its best effort.

The Job Processing consists of two sequences:


429

2738

2739274027412742

2743

430


6. Elements inherited from the Imaging Service super class (Error: Reference source not found) including Elements such as Job Hold Until. These Elements are described in Table 68.

7. Service-specific extensions to the super class. The FaxOut Service and the Copy Service include Job Processing Elements which are also applicable to other Services. These Elements represented in Figure 101, Figure 102, Figure 103 and Figure 104. Service-specific Job Processing Elements are described in Error: Reference source not found. Note that many of the complex Element structures also appear elsewhere.

Figure 103 Superclass Job Processing Elements

Table 73 Superclass JobProcessing Element Descriptions

Element DataType Description Reference

JobDelayOutputUntil keyword duration of time that a Job output is to be delayed..HoldUntilWKV

[PWG5100.11]para 7.4

JobDelayOutputUntilTime

dateTime absolute date and time a Job output delay is to expire. This Element allows delay of a Job output until a specific time

[PWG5100.11]para 7.5

JobHoldUntil keyword duration of time that a Job is put on hold.. HoldUntilWKV

[RFC2911] para 4.2.2

JobHoldUntilTime dateTime absolute date and time a Jos Element allows you to hold a remotely submitted Job until a specific time for processing.

[PWG5100.11] para 5.4

JobPhoneNumber uri contact phone number for the Job owner. Can be used to contact the owner in the event additional information is required

[PWG5100.11] para5.5, [ RFC3966], [RFC4355]


431

274427452746274727482749275027512752

2753

2754

2755

432


Element DataType Description Reference

JobMandatoryElements

various

JobPriority int JobPriorityType [RFC2911] para4.2.1

JobRecipientName string name of the intended recipient of the Job. [[PWG5100.11para 5.6

7.2.3.1 Description of DestinationUris’ Elements

This Job Processing complex element specifies destinations for the Job transmission (e.g., FaxOut). It is a sequence (type:complex) of DestinationUrisEntry each of which defines a single destination. Dial Strings were dropped when RFC3966 superseded RFC2806 [RFC2806], "Dial strings" are the actual numbers, symbols, and pauses entered by a user to place a phone call. We have added some elements to contain the Dial String information even though they could be encoded as RFC3966 compliant parameters.

7.2.3.1.1 DestinationUri

The DestinationUri is an RFC3966 [RFC3966] compliant URI. The abstract datatype is string. The corresponding Job Ticket Capabilities element for this element is DestinationUriSupported and is a set of strings. Each string contains the URI scheme supported fo use in DestinationUri.

7.2.3.1.2 PreDialString

The PreDialString is the Dial string entered before the DestinationUri is applied. The datatype for a dial string is a string. The ABNF that applies to a PreDialString is given below. The corresponding Job Ticket Capabilities element is of type Boolean that indicates whether or not this element is supported.

DialString = 1*(phonedigit / dtmf-digit / pause-character)pause-character = one-second-pause / wait-for-dial-toneone-second-pause = "p"wait-for-dial-tone = "w"dtmf-digit = "*" / "A" | "B" / "C" / "D" / “#”phonedigit = DIGIT / [ visual-separator ]visual-separator = "-" / "." / "(" / ")" / "'" / "(" / ")"

7.2.3.1.3 PostDialString

The PostDialString is the Dial string entered after the DestinationUri is applied. The datatype for a dial string is a string. The Dial Sting ABNF (abiove) also applies to a PostDialString. The corresponding Job Ticket Capabilities element is of type Boolean that indicates whether or not this element is supported.


433

2756

275727582759276027612762

2763

2764276527662767

2768

27692770277127722773277427752776277727782779

2780

2781278227832784

434


7.2.3.1.4 T33Subaddress

The T33 subaddressing can be specified by the T33Subaddress element. Because a T33 subaddress can only contain digits [RFC3192], the datatype for the T33Subaddress is an integer. Multiple T33 subaddresses are not supported in a single DestinationUrisEntry. If multiple mailboxes are to be addressed, each one requires its own entry. The corresponding Job Ticket Capabilities element is of type Boolean that indicates whether or not this element is supported.

7.2.3.1.5 Any

This is the extension point for the DestinationUris element.

7.2.3.2 Description of ConfirmationSheet Print Element

This optional Job Processing element specifies whether or not a confirmation sheet will be Printed upon Job completion. Services such as FaxOut offer such a feature. The datatype for this element is Boolean. If ConfirmationSheet Print is true, a confirmation sheet will be Printed when the Job reaches a terminating state. The format of the confirmation sheet is implementation specific. The content of the confirmation is outside the scope of this specification but is expected to conform to common practive and/or prevailing regulatory requirements. The corresponding Job Ticket Capabilities element is of type Boolean that indicates whether or not this element is supported.

7.2.3.3 Description of CoverSheetInfo’s Elements

This optional Job Processing element contains user supplied information to be put on a system generated Fax cover sheet. Note that the syntax for all the contained elements in the corresponding Job Ticket Capabilities elements are Boolean and represent the implementations support for the Job Processing elements.

7.2.3.3.1 CompanyName

This Job Processing element contains the user supplied string to place in the “Company Name” field of the system generated Fax Cover Sheet.

7.2.3.3.2 DateTime

This Job Processing element contains the date and time to place in the “Date” and “Time” fields of the system generated Fax Cover Sheet. Note this does not affect the date/time stamp contained in the Fax Protocol itself.

7.2.3.3.3 From

This Job Processing element contains a user supplied string to be placed in the “From” field of the system generated Fax Cover Sheet.


435

2785

278627872788278927902791

2792

2793

2794

27952796279727982799280028012802

2803

2804280528062807

2808

28092810

2811

281228132814

2815

28162817

436


7.2.3.3.4 Logo

This Job Processing element contains a URL of an image to be placed in an appropriate location of the system generated Fax Cover Sheet.

7.2.3.3.5 Message

This Job Processing element contains the user supplied string to place in the “Message” field of the system generated Fax Cover Sheet.

7.2.3.3.6 Subject

This Job Processing element contains the user supplied string to place in the “Subject” field of the system generated Fax Cover Sheet.

7.2.3.3.7 To

This Job Processing element contains the user supplied string to place in the “To” field of the system generated Fax Cover Sheet.

7.2.3.3.8 Any

This is the extension point for the CoverSheetInfo element.

7.2.3.4 Description of RetryInfo’s Elements

This Job Processing element contains user supplied information to be used to control the attempts to complete a Job after an initial failure to transmit a document.

7.2.3.4.1 NumberOfRetries

This Job Processing element specifies the number of attempts to retransmit a document in the event of transmission failure, before aborting the job. The datatype for this element is an integer. The corresponding Job Ticket Capabilities element is a range of integers specifying the allowed values for number of attempts.

7.2.3.4.2 RetryInterval

This Job Processing element specifies the time duration in seconds between transmission attempts. The datatype for this element is an integer. The corresponding Job Ticket Capabilities element is a range of integers specifying the allowed values for time duration in seconds between transmission attempts.

7.2.3.4.3 RetryTimeout

This Job Processing element specifies the time duration in seconds before terminating a transmission attempt when no document data is being sent. . The datatype for this


437

2818

28192820

2821

28222823

2824

28252826

2827

28282829

2830

2831

2832

28332834

2835

2836283728382839

2840

2841284228432844

2845

28462847

438


element is an integer. The corresponding Job Ticket Capabilities element is a range of integers specifying the allowed values for time duration in seconds before terminating a transmission attempt when no document data is being sent.

7.2.3.4.4 Any

This is the extension point for the RetryInfo element.


439

284828492850

2851

2852

440


Figure 104 Representative Service-Specific Job Processing Elements (FaxOut Service) Sheet 1


441

2853

28542855

2856

442


Figure 105 Representative Service-Specific Job Processing Elements (FaxOut Service) Sheet 2

Figure 106 Representative Service-Specific Job Processing Elements (Copy Service) Sheet 1

Figure 107 Representative Service-Specific Job Processing Elements (Copy Service) Sheet 2

Table 74 Service-Specific Job Processing Elements

Element DataType


Reference

BatchMode boolean job is to be processed in Batch Mode. Batch mode for each Service, if applicable, is defined in the specification of the Service.

[PWG5108.2] para 8.1.3.3.5

ConfirmationSheet Print boolean if true, confirmation sheet, for example for a FaxOut Job, will be Printed when the Job reaches a terminating state. The format of the confirmation sheet is implementation specific.

See 7.2.3.2

CoverSheetInfo complex Information entered by user to be put on Fax cover sheet.

See 7.2.3.3

CompanyName string user-supplied company name See 7.2.3.3.1

DateTime string user-supplied date and time See 7.2.3.3.2

From string user supplied name of the person group or entity for the cover sheet

See 7.2.3.3.3

Logo URI user supplied URL pointing to an image to use as the logo for the cover sheet

See 7.2.3.3.4

Message string user-supplied message for the cover sheet See 7.2.3.3.5

Subject boolean user-supplied subject entry for the cover sheet

See 7.2.3.3.6

To boolean user-supplied name of the intended recipient of the document

See 7.2.3.3.7

Any various extension point for CoverSheetInfo See 7.2.3.3.8

DestinationUris Complex

see para.7.2.3.1

DestinationUri URI URL used to transfer a Digital Document to its Destination.

See 7.2.3.1

PreDialString string dial string entered before the DestinationUri is applied

See Error: Reference source not found


443

28572858

2859

28602861

2862

28632864

2865

444


Element DataType


Reference

PostDialString string dial string entered after the DestinationUri is applied

See 7.2.3.1.3

T33Subaddress int For T33 subaddressing See 7.2.3.1.4

Any various extension point for DestinationUrisDocumentOutputMode keyword Way in which the output documents are

partitioned among files. See para 31.1.2DocumentOutputModeWKV, KeywordNsExtensionPattern

[PWG5108.2] para 8.1.3.3.6

JobAccountingSheets complex Specifies the accounting sheet for a job [PWG5100.3] para 3.8

JobAccountingSheetsType

keyword Specifies the accounting sheet format JobAccountingSheetTypeWKV, KeywordNsExtensionPattern

[PWG5100.3] para 3.8.1

Media keyword Name of media to be used for accounting sheet, MediaWKV, KeywordNsExtensionPattern

[RFC2911] para 4.2.11

MediaType keyword medium type used for the Job accounting sheet MediaTypeWKV, KeywordNsExtensionPattern

[PWG5100.3] para 3.13.2

MediaCol complex See Media Collection (Specific) 5.2.1.1 [PWG5100.3] para 3.13

JobAccountingOutputBin

keyword output bin where the accounting sheet is to be placed, OutputBinWKV, KeywordNsExtensionPattern

[PWG5100.3] para 3.8.3

Any various extension point for JobAccountingSheetsJobCopies int The number of copies of the Job to be

Printed[PWG5100.7] para 4.1.1

JobCoverBack complex Characteristics of back cover for this JobCoverType keyword Indicates if back cover is requested and

which sides will contain Print stream pages, CoverTypeWKV, KeywordNsExtensionPattern

[PWG5100.3]para3.1.2

Media keyword Name of mediato be used for back coverMediaSizeAliasNameWKV, MediaSizeLegacyNamesWKV, MediaSizeSelfDescribingNameWKV MediaSizeNameExtensionPattern

[RFC2911] para 4.2.11

MediaType keyword medium type to be used for back coverMediaTypeWKV, MediaTypeExtensionPattern

[PWG5100.3] para 3.13.2


445

446


Element DataType


Reference

MediaCol complex See 5.2.1.1 [PWG5100.3] para 3.13

Any various Extension point for JobCoverBackJobCoverFront complex Characteristics of front cover for this Job [PWG5100.7]para4.

1.3Coverype keyword Indicates if front cover is requested and

which sides will contain Print stream pages, CoverTypeWKV, KeywordNsExtensionPattern

[PWG5100.3]para3.1.2

Media keyword Name of mediato be used for front coverMediaSizeAliasNameWKV, MediaSizeLegacyNamesWKV, MediaSizeSelfDescribingNameWKV MediaSizeNameExtensionPattern

[RFC2911] para 4.2.11

MediaType keyword medium type to be used for front coverMediaTypeWKV, MediaTypeExtensionPattern

[PWG5100.3] para 3.13.2


Any various Extension point for JobCover FrontJobErrorSheet complex Characteristics of JobErrorSheet for this

Job[PWG5100.3] para 3.9

JobErrorSheetType keyword Indicates if JobErrorSheet is requested and which sides will contain Print

[PWG5100.3] para 3.9.1

JobErrorSheetWhenkeyword Indicatedsconditions to produce

JobErrorSheetJobErrorSheetTypeWKV, KeywordNsExtensionPattern

Media keyword Name of mediato be used for JobErrorSheetMediaSizeAliasNameWKV, MediaSizeLegacyNamesWKV, MediaSizeSelfDescribingNameWKV MediaSizeNameExtensionPattern

[RFC2911] para 4.2.11

MediaType keyword medium type to be used for front coverMediaTypeWKV, MediaTypeExtensionPattern

[PWG5100.3] para 3.13.2


Any various extension point for JobErrorSheet


447

448


Element DataType


Reference

JobFinishings keyword finishing that the Printer uses for each Job copy of the Job, FinishingsWKV, KeywordNsExtensionPattern

[RFC2911] para 4.2.6[PWG5100.1] para 2[PWG5100.7] para 4.1.4

JobFinishingsCol complex specify detailed finishing options not possible with the “JobFinishings”

[PWG5100.3] para 3.2

FinishingTemplate string string specifying some particular finishing operation

[PWG5100.3] para 3.2.1

Stiching complex detailed stitching parameters [PWG5100.3] para 3.2.2


keyword stitching reference edge of the output media StitchingReferenceEdgeWKV, KeywordNsExtensionPattern

[PWG5100.3] para 3.2.2.1

StitchingOffset int perpendicular distance from the reference edge to the stitching axis in hundredths of a millimeter.

[PWG5100.3] para 3.2.2.2

StitchingLocationsint distance along the stitching axis where a

stitch will be placed in hundredths of a millimeter

[PWG5100.3] para 3.2.2.3

Any various extension point for StichingAny various extension point for JobFinishingsCol

JobSaveDisposition complex used to archive/save the Document Data of a job

[PWG5100.11] para 7.9

SaveDisposition keyword specifies whether or not the Job MUST be Printed and/or saved, SaveDispositionWKV, KeywordNsExtensionPattern

[PWG5100.11] para 7.9.1

SaveInfo complex [PWG5100.11] para 7.9.1.2

SaveDocumentFormat

keyword SaveDocumentFormatType DocumentFormatWKV, MimeExtensionPattern

[PWG5100.11] para 7.9.1.2.3

SaveLocation uri path to the directory as a URI where the Service saves the Document Data and other information

[PWG5100.11] para 7.9.1.2.1

SaveName string name of the saved job [PWG5100.11] para 7.9.1.2.2

Any various Extension point for SaveInfoAny various Extension point for JobSaveDisposition


449

450


Element DataType


Reference

JobSheetMessage string a message that is delivered with the job [PWG5100.3] para 3.12

JobSheets Specifies which Job start/end sheet(s), will be Printed with a JobJobSheetsWKV, KeywordNsExtensionPattern

[RFC2911] para 4.2.3[PWG5100.3] para 6.2

JobSheetsCol complex specify the media for the JobSheet [PWG5100.3] para 3.11

JobSheets Specifies which Job start/end sheet(s), will be Printed with a Job JobSheetsWKV, KeywordNsExtensionPattern

[RFC2911] para 4.2.3[PWG5100.3] para 6.2

Media keyword Name of media to be sued for JobSheetsMediaWKV, KeywordNsExtensionPattern

[RFC2911] para 4.2.11

MediaType keyword medium type used for JobSheets MediaTypeWKV, KeywordNsExtensionPattern

[PWG5100.3] para 3.13.2

MediaCol complex See Media Collection (Specific) 5.2.1 [PWG5100.3] para 3.13

Any various Extension point for JobSheetsColMultipleDocumentsHandling

keyword MultipleDocumentsHandlingWKV, KeywordNsExtensionPattern

[RFC2911] para 4.2.4

MutipleSetOriginal boolean Service is required to intake multiple sets of originals from the selected inpb will be released after being put on hold. Thiut source.

[PWG5108.2] para 8.1.3.3.7

OutputBin keyword output bin where the Job is to be placedOutputBinWKV, KeywordNsExtensionPattern

[PWG5100.2] para 2.1 [PWG5100.5] para 8.1

OutputDevice string Requested OutputDevice [PWG5100.7] para 4.2.1 [PWG5100.5] para 8.1

Overrides complex Page processing overrides [PWG5100.6] para 4.1

Pages range of int

identifies one or more pages where the override will be applied

[PWG5100.6] para 4.1.1

DocumentNumbers range of int

identifies one or more documents in which the pages will have the override applied

[PWG5100.6] para 4.1.2

DocumentCopies range of int

identifies one or more copies of the document in which the pages will have the override applied

[PWG5100.6] para 4.1.3


451

452


Element DataType


Reference

OverridingElements list of document ticket elements

Document Ticket processing elements to apply to the specified Document pages

[PWG5100.6] para 4.1.4

Any various Extension point for OverridesPagesPerSubset int Combines all of the Pages of all of the

Documents into a single stream of -Pages. Then the Printer partitions that single stream into contiguous subsets of -Pages according to the value of this Element

[PWG5100.4] para 5.3

RetryInfo complex Supported capabilities of elements used to control document transmission timeouts

See 7.2.3.4

NumberOfRetries int number of retries before Job aborts See 7.2.3.4.1

RetryInterval int time duration in seconds between retry attempts

See 7.2.3.4.2

RetryTimeout int time duration in seconds before terminating a retry

See 7.2.3.4.3

Any (service specific)

various an extension point for RetryInfo See 7.2.3.4.4

Any various Extension point for Job Processing

7.3 Job Receipt

This Element has exactly the same structure as the Job Ticket. For each processing Element of a Job, it records the actual value used by the Service for processing the Job. It contains the Elements supplied by the Client and applied to the Job, any Element or values substitutions made by the Service and any default Elements or values applied by the Service. See paragraph 7.2 for Element descriptions.

7.4 Job Description


453

2866

28672868286928702871

2872

454


8. Imaging Document Element GroupsThe general Imaging Document model includes the Document Status, Document Ticket and Document Receipt Element groups, as shown in Error: Reference source not found. The individual Services that include accessible Document objects each have their own Document model, paralleling this general Imaging Document model. Jobs can contain zero or more Documents. During Job creation, it is possible that temporarily there are zero Documents. Note that some Services do not include accessible Documents.

The state of the Document is described in the Document Status Element. This contains descriptive information about the Document processing instructions. The Document Ticket and the Document Receipt have the same structure, but the Element values in the Document Ticket are the information provided by the user in the CreateJob operation while the Element values in the Document Receipt reflect what was actually used in processing the Document.

Document Tickets allow a User to supply Document Processing Elements to override the Document Processing instructions in the Job Ticket on a Document by Document basis. This Document model mirrors the Job model, described in Chapter 7.

Figure 108 Imaging Document Model

8.1 Document Status

Job Status consists of two sequences.

8. Elements inherited from the Imaging Document super class (i.e., Imaging Document Status) See Figure 106 for the structure and Table 70 for the Elements description.

9. Service specific extensions to the super class such as the Service counters. Representative Service-specific Elements are represented in Figure 107 and described in Table 71.


455

2873

287428752876287728782879

288028812882288328842885

288628872888

2889

2890

2891

2892

289328942895289628972898

456


Document Status Elements including both those from the abstract Imaging Status and representative Service-specific elements are described in The complex Elements in the table also occur elsewhere. Please refer to the reference sections for the details of these elements.


457

2899290029012902

458


Figure 109 Imaging Document Status

Table 75 Document Status Elements


459

2903

2904

2905

460


Element DataType


DateTimeAtCompleted

DateTime

date and time at which the Job object completed or was canceled or aborted

[RFC2911] para 4.3.14.7

DateTimeAtCreation

DateTime

date and time at which the Job object created. [RFC2911] para 4.3.14.5

DateTimeAtProcessing

DateTime

date and time at which the Job object first began processing

[RFC2911] para 4.3.14.6

DetailedStatusMessages

list of string

additional detailed and technical information about the Job. Element

[RFC2911] para 4.3.10

DocumentAccessErrors

list of string

additional information about each Document access error for this Job encountered by the Service after attempting to store or access Document Data at the locations supplied

[RFC2911] para 4.3.11

DocumentNumber int uniquely identifies a Document within a Job. [PWG5100.4] para 9.2, [PWG5100.5] para 9.1.23

DocumentUuid anyUri An urn::uuid unique URI value [RFC4122]DocumentState keyword current state of Document.

DocumentStateWKV [PWG5100.5] para 9.1.25

DocumentStateMessage

string information about the Document State and StateReasons in human readable text.Element.

[PWG5100.5] para 9.1.26

DocumentStateReasons

list of keywords

additional detail about the Document state. The specific keywords allowed are defined within the specification for the Service.DocumentStateReasonsWKV, KeywordNsExtensionPattern

[PWG5100.5] para 9.1.27 and {RFC2911] para 4.3.8 for standard values.

DocumentUri anyUri An urn::uuid unique URI value [RFC4122]ErrorsCount int number of errors encountered while processing

the Document [PWG5100.5] para 9.1.29

JobId int JobID of the Job to which this Document belongs.

[PWG5100.5] para 9.1.18

JobUuid anyUri An urn::uuid unique URI value [RFC4122]


461

462


Element DataType


JobUri URI globally unique ID of the Job to which this Document belongs

[PWG5100.5] para 9.1.19

KOctetsProcessed int total number of octets processed to that point, in integral units of 1024 octets

[RFC2911] para 4.3.17.1

MoreInfo string URI used to obtain information intended for End User consumption about this specific Job

[RFC2911] para 4.3.4

TimeAtCompleted int time at which the Document completed, in “UpTime” seconds

[RFC2911] para 4.3.14.3

TimeAtCreation int time at which the Document was created in “UpTime” seconds

[RFC2911] para 4.3.14.1

TimeAtProcessing int time at which the Document first began processing in “UpTime” seconds

[RFC2911] para 4.3.14.2

UpTime intWarningsCount int total number of warnings that a Scan Service

has generated while processing and storing the Job’s Documents).

[PWG5100.4 para 6.1

ImagesCompleted int Progress measure for Job in terms of output. Output may be Images for Hardcopy Document producers and/or Impressions for Hardcopy Document consumers. See PWG Counter Spec [PWG5106.1]


int

Any various Extension point for DocumentStatus


463

464


Figure 110 Service-Specific Document Status Elements


465

2906

2907

466


Table 76 Service-Specific Document Status Elements

Element DataType


CurrentPageOrder keyword the page order of the pages in the document data, PageOrderWKV

[PWG5100.3] para 4.1

DocumentFormatDetailsDetected

complex See breakdown of constituent elements in Table 67.

DocumentFormatDetected keyword The Service sets this to the actual DocumentFormat detected when auto-sensing, DocumentFormatWKV, MimeExtensionPattern

[PWG5100.5] para 9.1.15

DocumentFormatVersionDetected

string The Service sets this to the actual DocumentFormat level detected when auto-sensing

[PWG5100.5] para 9.1.17

Impressions (or Images) Completed

int Number of Impressions (for Impression output Services) or Images (for Image output Services) processed by the service

[PWG5106.1]

ImpressionsCompletedCurrentCopy

int number of impressions completed for the current iteration of this Document so far

MediaSheetsCompleted int media-sheets completed marking and stacking for this Document so far

[RFC3381] para 4.4

OutputDeviceAssigned string the output device to which the Service has assigned this Job

[RFC2911] para 4.3.18.3

SheetsCompletedCopyNumber

int Number of the copy being stacked for this Document

[RFC2911] para 4.3.13

Counters complex counters for the amount of work performed for this Document by the Service, including timers covering utilization, and monitoring information covering errors, warnings traffic, Job counts

[RFC3381] para 4.2

ServiceUri anyUri the URI of the Service containing the Job which contains this Document

[PWG5106.1]

Any various extension point forDocumentStatus PWG5100.5 para 9.1.24

8.2 Document Ticket

The Document Ticket contains description and processing Elements provided by the Client. The general Imaging Document Ticket is shown in Error: Reference source notfound. All Document Tickets follow this form, although the description and processing


467

2908

2909

2910

291129122913

468


elements may contain Service specific elements. Document Ticket information is used by the Service during the processing of a Document. The information is made available to Clients through the Get Document Elements operation.

Figure 111 Imaging Document Ticket

8.2.1 Document Description

Document Description consists of two sequences:

10.Elements inherited from the Imaging Document abstract class, represented in Error: Reference source not found with the Elements described in Error: Reference source not found.

11.Service specific extensions. Representative Service-specific elements are shown in Error: Reference source not found and described in Table 73. These Elements also appear in several other places in the Model and the structures of the complex Elements is described elsewhere, as referenced in the table.

Figure 112 Imaging Document Description

Table 77 Document Description Elements


469

291429152916

2917

2918

2919

2920

2921292229232924292529262927

2928

2929

2930

470


Element DataType


Reference

DocumentDigitalSignature

keyword type of digital signature that is used in the creation of the Digital Document. DocumentDigitalSignatureWKV, KeywordNsExtensionPattern

[PWG5100.7] para 3.2.3 [PWG5100.5] para 9.1.11

DocumentMessage string message from either 1) the user to the operator about the Document or 2) from the operator, system administrator, or "intelligent" process to indicate to the End User the reasons for modification or other management action taken on the Document.

[PWG5100.5] para 9.1.20

DocumentName string name for this Document to be used in an implementation specific manner.

[RFC2911] para 3.2.1.1

DocumentNaturalLanguage

keyword hint about the language used in Hard Copy Documents that contain text. This Element is not useful for Hard Copy Documents that do not contain text or are not intended to undergo Optical Character Recognition NaturalLanguageWKV

[RFC2911] para3.2.1.1, [PWG5100.5] para 9.1.22

LastDocument Boolean last Document in the Job. (Element set to false or omitted for Document which is not the last)

[RFC2911] para 3.3.1

Any various extension point for DocumentDescription

Figure 113 Service-Specific Document Description Elements


471

2931

2932

472


Table 78 Service-Specific Document Description Elements

Element DataType


Reference[PWG5100.

7]CompressionSupplied keyword compression algorithm used for the Documents

Data CompressionWKV, KeywordNsExtensionPattern

para 5.2.1

DocumentCharsetSupplied keyword default charset of the Documents content, CharsetWKV, StringExtensionPattern

para 5.2.2

DocumentDigitalSignatureSupplied

keyword type of digital signature, if any, used in the Document ContentDocumentDigitalSignatureWKV, KeywordNsExtensionPattern

para 5.2.3


complex Summarizes the distinct contained document format, See Figure 99 and Table 67

para 5.2.4

DocumentFormatSupplied keyword The Document format (i.e., PDL) for Document, DocumentFormat, MimeExtensionPattern

para 5.2.5

DocumentFormatVersionSupplied

string level or version of the DocumentFormat para 5.2.6

DocumentMessageSupplied string message from either (1) the user to the operator about the Documents or (2) from the operator, system administrator, or "intelligent" process to indicate to the end user the reasons for modification or other management action taken on the Document

para 5.2.7

DocumentNameSupplied string name for the Document to be used in an implementation specific manner

para 5.2.8

Any various Extension point for DocumentDescription

8.2.2 Document Processing

This group Element has exactly the same structure as the Document Processing Element of Job (See 7.2.1). It provides the Document processing instructions that have been requested by the End User at each Document level, overriding the Job level Document processing instructions.

8.3 Document Receipt

This Service-specific Element has exactly the same structure as the Document Ticket. For each processing Element of a Document, it records the actual value used by the Service for processing the Document. It contains the Elements supplied by the Client, any


473

2933

2934

2935293629372938

2939

294029412942

474


substitutions made by the Service and any Default Elements applied by the Service. See Section 8.2 for Element descriptions.


475

29432944

2945

476


9. Imaging Service Operations and States

9.1 General Service Sequence of Operation

A Service operates autonomously in one of three phases: Initial, Online, and Offline. As represented in Error: Reference source not found in the Initial Phase the Service is in an Unknown state. How this phase is entered and exited is implementation and largely device dependent. From the Initial phase, the Service can transition only to the Offline Phase. In the Offline Phase the Service can be in the Down or Testing states. Although there may be access to the Service via the Console Subunit in this phase, such access does not include creating or processing Jobs; there is no remote access. Although transitions from Online phase states to the Down state are defined in this model, the manner and modes of testing and therefore the paths to and from the Testing phase are implementation dependent.

The basic Job-handling functions of the Service are done in the Online phase, which includes Idle, Processing and Stopped. The following paragraphs describe the nature of these states. Service States as status Elements, and the operations, events and conditions involved in changing states are described in more detail in section 9.2.

Note that the Resource Service does not deal with Jobs and Documents but rather with Resources. Therefore, although it goes through similar states, the sequence of operations is linked to Client Resource activity rather than Job activity.


477

2946

2947

2948294929502951295229532954295529562957

2958295929602961

296229632964

478


Figure 114 Service State Model

9.1.1 Initialization and Startup

On creation, an Imaging Service enters its Initial phase during which all its Service Elements and connected Subunits are initialized. This phase may include test of the configured Subunit(s) and self-testing of the Service. After successful initialization, the Service performs a start-up operation that brings it to the Online phase. Once in this phase, it authenticates and registers its Service with an on-line Service directory or otherwise announces its Service to the network domain in which it resides. The Service is then in the “Idle” state, it is ready for Service discovery and it can accept Service requests from Clients.

The Service generally accepts new requests as long as it is in one of the three Online phase states: Idle, Processing or Stopped. However, performing an administrative Disable operation while in any state will stop the Service from accepting a CreateJob requests to start a new Job. (In the case of the Resource Service, a Disable operation will stop acceptance of any Resource “put” or “get” request.) Performing an Enable operation in any Online state while the Service is disabled will re-enable the Service to accept the disabled requests.

9.1.2 Job Creation

A user initiates a Job by submitting a CreateJob request through a local (via the Imaging System user interface) or remote (via local network or Internet) Client. The “intent” of the


479

2965

2966

2967

29682969297029712972297329742975

2976297729782979298029812982

2983

29842985

480


user in creating the Job, that is the processing and handling instructions, may be identified in a Job Template submitted with the CreateJob request, or aspects may be left to be determined by Service defaults. When the Job is created, the Service also creates a Job Ticket, a data object containing Job description and Job and Document processing instructions derived from the Job Template information. The Job Ticket remains bound to the Job until the Job is eventually deleted from the Service.

The Job Template has the form of a Job Ticket, but is unbound to any Job or Service. The Job Template for a specific Job can be created in several ways. (See Job and Job TicketLife Cycle, section 4.6.)

The Service Capabilities of the selected Service can be retrieved to provide the set of supported features and values to allow creating or modifying a template so that it is appropriate to the Service accepting the Job request. Once the Job Template fully embodies the Intent, it can be bound to a CreateJob request to send to the Service.

The Default Job Ticket is an Element of the Service. If a CreateJob request does not include a Job Template or if the Job Template did not include some required information, the applicable processing directive defaults to the Default Job Ticket values. The values from the Default Job Ticket are not copied to the Job’s Job Ticket rather the combined Elements from the user supplied Job Ticket and the applied values from the Default Job Ticket are used. The Default Job Ticket can be administratively modified to control default behaviors for the associated Service.

The Service places created Jobs in the Active Jobs queue. Created Jobs are in the Pending state until they are advanced to the Processing State. A Pending Job may be held to delay scheduling for processing by a Job Hold Until Time Element in the Job’s Ticket to allow time for user to walk up to the Printer or scanner Subunit to handle the hardcopy Document; a Pending Job may also be held by an administrator Hold Job operation. Held Jobs are released by a Job Hold Until Time timeout or a administrator Release Job operation. Jobs that are not in a “held” state are scheduled for processing immediately or when a StartJob event is signaled, based on Job priority relative to other Jobs in the Active Jobs queue.

9.1.3 Job Processing

When a Job is released for scheduling and reaches the top of Active Jobs queue, it enters the Job Processing state. If the Service is not already in the Service Processing state, it will now enter that state. The Service manages and processes the Job according to the instructions in the Job Ticket, supplemented where necessary by information in the Default Job Ticket. If a processing instruction in the Job Ticket cannot be supported, the Service either returns an error or substitutes the instruction with another that best matches the user’s intent. When Job processing is complete, the actual values used for processing the Job are captured in the Job Receipt, the Job is in the Completed state and it is entered into the Job History queue. The Service either returns to Idle or continues in the ServiceProcessing state with a subsequent Job.


481

298629872988298929902991

299229932994

2995299629972998

2999300030013002300330043005

300630073008300930103011301230133014

3015

3016301730183019302030213022302330243025

482


9.1.4 Service Pause, Service Shutdown and Abnormal Job Termination

During Job processing, an administrative “PauseService”or “PauseServiceAfterCurrentJob” operation will cause the Service to enter the “Stopped” state. This prevents further scheduling of Jobs for that Service. Depending on implementation, the Service transition to Stopped may be delayed to allow the processing of the current Job to be completed or suspended in a controlled way. Jobs that are in the Job Processing state when the Service is Stopped remain in the Active Jobs Queue but go into the ProcessingStopped Job state. A “PauseService” operation allows a user to interrupt the scheduled Jobs to submit and process an urgent Job or a Job for another service. A ServiceResume operation returns the Service to the Processing state and allows Job scheduling and processing to resume. Note that, if the Service Pause/Resume operations are to be used to allow a Job processing to be interrupted to allow another Job to be processed by the same service, then the inserted Job must have higher scheduling priority than a ProcessingStopped Job and the Service must readjust its schedule on receiving the Resume command.

When there are critical conditions impacting serviceability during “Idle” or “Processing” state, either a Critical Fault event is generated or an Administrative PauseService is performed to bring the Service to the Stopped state. From there the condition can be fixed by user’s intervention. Then either the Service generates a EndCritical event (removal of critical condition) or an administrator performs a Resume operation to bring the Service back to the “Idle” or “Processing” state. If the Service requires a ShutdownService operation before Service can be resumed or for testing, a RestartService must be issued to bring the Service to the On-Line phase again.

Any Job in the Active Jobs queue can be canceled via a CancelJob operation by an authorized user, a. The Job is then in the Cancelled state and entered into the Job History queue. Jobs that are terminated because of a Service fault are in the Aborted state and are also entered into the Job History queue.

9.2 Service, Job and Document States

The values of the Service, Jobs and Document states are critical Elements in the Service, Job and Document models. Moreover, understanding what these states are and what is involved in transitioning from one state to another is also critical in understanding the operations, processes and conditions that control the ability of the Service to execute a Job and process a Document.

9.2.1 Service States, Conditions and State Transitions

The states of a Service are identified below and in Error: Reference source not found. The states and the events (including client requests) that cause state transitions are represented Figure 112. Service State and condition transitions as a result of Operations


483

3026

30273028302930303031303230333034303530363037303830393040

30413042304330443045304630473048

3049305030513052

3053

30543055305630573058

3059

306030613062

484


and Events are summarized in Error: Reference source not found, Error: Referencesource not found and Error: Reference source not found.

9.2.1.1 Service States

The modeling of a Service is based on the following six states.

1. Unknown: This is a state in the initial phase when a Service has been just created. There is no outside interface with the Service. Within the Imaging System , the Service will be initialized and will transition to the Down state.

2. Down: The Service instance exists and has been initialized. The Service cannot accept any client operation request other than Start or Restart (which brings the Service to the Idle state, unless some error condition exists). The Service can also be put into a Test state via some implementation-dependent path that initiates testing.

3. Testing: An implementation-dependent state in which normal processing is not possible but the Service is operating in a test mode.

4. Idle: The Service is up and able to accept client requests, but is not currently processing a Job. There may be no unterminated Jobs, or Jobs may be in a PendingHeld Job state.

5. Processing: At least one Job is in the Processing Job state. 6. Stopped: The Service is unable to process Jobs because it has received a

Pause request or because an event signifying the existence of a critical condition has occurred.

9.2.1.2 Operations, Events and Conditions

Figure 112 illustrates the Service state transitions resulting from Operations and Events. The following notations are used.

Initial Caps = state; e.g., IdleInitial caps followed by argument parenthesis = operation; e.g., Startup Lower case = action; e.g., schedule, enable, etcC. prefix = a condition; e.g., C.isAcceptingJobs means the isAcceptingJobs condition exists or is affirmative E. prefix = an event; e.g., E.endJob means "Job completed"~ = logical NOT applied to condition (e.g., ~C.paused means the Pause condition does not exist or "not paused")

Service Conditions and their initiating and terminating events are listed in Error: Referencesource not found. In general, Conditions may exist in several states and are not necessarily associated with state changes. Administrative Operations that cause Service State changes are identified in Error: Reference source not found. Conditions and Events that characterize Service operation are identified in Error: Reference source not found. Note that although no specific Test operation or events are defined in this specification, the Test state is included to indicate that the transition to and from this Service state is made in a specific manner.


485

30633064

3065

3066

30673068306930703071307230733074307530763077307830793080308130823083

3084

30853086

308730883089309030913092309330943095

30963097309830993100310131023103

486


Table 79 Conditions and Bounding Events

Condition Initiating Event

Initiating Cause Terminating Event

Terminating Cause

C.testing E.testing Implementation dependent

E.testingCleared Implementation dependent

C.warning E.warning Some non critical equipment problem

E.warningCleared Clearing non critical equipment problem

C.critical E.critical A critical equipment problem

E.criticalCleared Clearing critical equipment problem

C.JobProcessing E.startJob A Created Job is scheduled

E.endJob All scheduled Jobs advanced to Terminating state (Completed, Canceled, Aborted)

C.isAcceptingJobs

E.enable Enable E.disable Disable

C.Pause E.pause Pause E.resume ResumeNote: C.isAcceptingJobs represents the ability of the Service to create new Jobs (i.e., CreateJob will fail if ~C.isAcceptingJobs). Other operations are not affected by this condition.


487

3104

310531063107

488


Figure 115 Service State Transitions and Causal Events


489

3108

3109

490


9.2.1.3 Service State Transition by Operations

Error: Reference source not found summarizes the effect of the primary Administrator operations on the Service state, depending upon the Service state when the operation request is received. The entry “error” indicates that sending in indicated operation when the Service is in the indicated state is invalid and an error response is returned to the requestor.

Table 80 ServiceState Change by Operations

StateDown Testing Idle Processing Stopped

Operation

Action(end state, condition)





PauseService (Note 2) error

pause(Testing, C.Pause)

pause(Stopped, C.Pause)

pause(Stopped, C.Pause)

pause(Stopped,C. Pause)

ResumeService error

resume(Testing, ~C.Pause)

resume(Idle, ~C.Pause)

resume(Processing, ~C.Pause)

resume(Idle, ~C.Pause)

RestartService(Note 1)

restart (Idle)

restart (Idle)

restart (Idle)

restart (Idle)

restart (Idle)

ShutdownService (Note 2) error

shutdown(Down)

shutdown(Down)

shutdown(Down)

shutdown(Down)

StartupService (Note 1)

restart (Idle) error error error error

test(Note 3)

test(Testing)

test(Testing) error error error

Notes StartupService is normally sent when the Service is first created. It prompts an E.startup event that initializes the Service and takes it through the Down state to Idle, assuming that there are no inhibiting conditions.RestartService can be sent with the Service in any state. It prompts a restart which initializes the Service and takes it through the Down state to Idle, assuming that there are no inhibiting conditions.StartupService sent when the Service is in the Down state has the same effect as a RestartService. StartupService is illegal in any other state.PauseService and ShutdownService. Depending upon implementation:A PauseService or ShutdownService received when the Service is in the Testing, Idle or Stopped states forces the Service immediately to the indicated state ( Stopped and Down respectively). ShutdownService when the Service is in the Processing state may initiate an E.shutdown event, leaving the Service in the Processing state while the Job in process is completed or otherwise terminated. The E.shutdown event will eventually cause the Service to go to the Down state.PauseService when the Service is in the Processing state may initiate an pause event, leaving the Service in the Processing state while the Job in process is completed or otherwise terminated. The pause event will eventually cause the Service to go to the Stopped state.


491

3110

31113112311331143115

3116

31173118311931203121312231233124312531263127312831293130313131323133

492


9.2.1.4 Service State Transition and Condition Change by Events

Error: Reference source not found summarizes the Service state and condition change as a result certain events, depending upon the Service state when the event occurred. The table should be read from top to bottom. Consecutive entries of the same event are differentiated by differing associated conditions. The last entry in the series is equivalent to the event with a condition other than the ones already covered.

An “error” entry indicates an invalid circumstance and that an error message should be logged indicating an implementation error.

Table 81 Service State Change by Events

InputState

Down Testing Idle Processing StoppedEvent(Condition)

Condition(end state)



Condition(endstate)


E.critical C.critical C.criticalC.critical(Stopped)

C.critical(Stopped) C.critical

E.criticalCleared(i.e., last C.Critical) ~C.critical ~C.critical error error

~C.critical (Idle or Processing)

E.endJob(C.shutdown)

Error shutdown(Down) error

shutdown(Down) error

E.endJob(C.paused) error

C.pausederror

C.paused(Stopped) error

E.endJoberror --- error

schedule(Idle or Processing) error

E. Warning C.warning C.warning C.warning C.warning C.warningE. warningCleared(i.e., last C.warning) ~C.warning ~C.warning ~C.warning ~C.warning ~C.warningE.startup(Note 1)

restart(Idle) error error error error

E.startJob(C.paused) error error error error errorE.startJob

error schedule schedule (Processing) schedule error

E.testing (Testing) error error errorE.testingCleared error (Down) error error error

Notes StartupService is normally sent when the Service is first created. It prompts an E.startup event that initializes the Service and takes it through the Down state to Idle, assuming that there are no inhibiting conditions.


493

3134

3135

31363137313831393140

31413142

3143

3144314531463147

494


RestartService can be sent with the Service in any state. It prompts a restart which initializes the Service and takes it through the Down state to Idle, assuming that there are no inhibiting conditions.StartupService sent when the Service is in the Down state has the same effect as a RestartService. StartupService is illegal in any other state.PauseService and ShutdownService. Depending upon implementation:A PauseService or ShutdownService received when the Service is in the Testing, Idle or Stopped states forces the Service immediately to the indicated state ( Stopped and Down respectively). ShutdownService when the Service is in the Processing state may initiate an E.shutdown event, leaving the Service in the Processing state while the Job in process is completed or otherwise terminated. The E.shutdown event will eventually cause the Service to go to the Down state.PauseService when the Service is in the Processing state may initiate an pause event, leaving the Service in the Processing state while the Job in process is completed or otherwise terminated. The pause event will eventually cause the Service to go to the Stopped state.

9.2.2 Job States and State Transitions

Jobs are created by a Service in response to a CreateJob request from a client. The Job will transition through several states under the control of the Service, and may be forced into several states by client Operations or equipment conditions. The possible Job states are listed below and the Job state transitions are diagramed in Error: Reference sourcenot found. [RFC2911]

Note that a “saved Job” is not in a distinct state. It is a Completed Job with certain processing instructions. If a saved Job is recalled a ResubmitJob operation, a new Job is created and submitted with an implicit CreateJob request. The “saved Job” remains as a Completed Job.

Aborted the Job was halted due to an error.

Canceled the Job was halted by a CancelJob operation.

Completed the Job has been successfully completed.

Pending the Job has been accepted by the system and is awaiting system resources before it can start processing. It is in a queue and is scheduled for processing.

PendingHeld the Job is not a candidate for processing for any number of reasons and will return to the Pending state when the reasons are no longer present.

Processing the Job is being processed by the Service according to the Job Ticket instructions.

ProcessingStopped the Job is sent to the ProcessingStopped state when it is in the Processing state and the Service has been sent to the Stopped state. The Service may go to the Stopped state because of a PauseService operation, a


495

3148314931503151315231533154315531563157315831593160

3161

31623163316431653166

3167316831693170

3171

3172

3173

3174

317531763177

31783179

31803181

318231833184

496


Critical Event, or because the Service is awaiting resources necessary to continue processing.

Figure 116 Job State Transition

9.2.3 Document States and State Transitions

Document states and state transitions largely parallel the states and state transitions of the Job that was created to process the Document. The states are listed below and the state transitions are diagrammed in Figure 114. [PWG5100.5].

Aborted The Document has been aborted by the system, usually while the Document was in the 'Processing' state and the Scan Service has completed aborting the Document and all Document status Elements have reached their final values for the Document. While the Scan Service is aborting the Document, the Document remains in its current state, but the Document’s "DocumentStateReasons” Element SHOULD contain the 'ProcessingToStopPoint' and 'AbortedBySystem' values. When the Document moves to the Aborted state, the 'ProcessingToStopPoint' value, if present, MUST be removed, but the 'AbortedBySystem' value, if present, MUST remain.

Canceled The Document has been canceled as a result of the Scan Job being cancelled by a CancelScanJob” operation prior to the Document reaching a ‘Completed’ or ‘Aborted’ state. While the Scan Service is canceling the Document, the Document remains in its current state, but the Document’s "DocumentStateReasons” Element SHOULD contain the 'ProcessingToStopPoint' value and one of the 'CanceledByUser',


497

31853186

3187

3188

3189

319031913192

319331943195319631973198319932003201

320232033204320532063207

498


'CanceledByOperator', or 'CanceledAtDevice' values. When the Document moves to the 'canceled' state, the 'ProcessingToStopPoint' value, if present, MUST be removed, but the 'CanceledByXxx', if present, MUST remain.

Completed The Document has completed successfully or with warnings or errors after processing and all of the Document’s Digital Documents have been sent to their Destination and all Document status Elements have reached their final values for the Document. The Document’s "DocumentStateReasons” Element SHOULD contain one of: 'CompletedSuccessfully', 'CompletedWithWarnings', or 'CompletedWithErrors' values.

Pending The Document has not started to be processed at all.

Processing The Job has begun using, or is attempting to use, one or more purely software processes that are analyzing, creating, or interpreting the Hard Copy Document or Digital Document. The Job has begun using, or is attempting to use, one or more hardware devices that are analyzing, creating, or interpreting the Hard Copy Document or Digital Document. The Digital Document is ready for sending to its Destination, but the Output Channel is not yet transferring it, either because the Digital Document hasn't reached the Output Channel or because the Document is queued in the Output Channel or some other spooler, awaiting the Output Channel to transfer it. The ‘processing’ state for the Document indicates that the Document has begun to be processed. Even if the Job stops being processed, the Document remains in the ‘processing’ state until it moves to one of the three terminal states. Implementations MAY include additional values in the Document’s ”DocumentStateReasons” Element to indicate the progress of the Document, such as adding the ’Scanning’ value to indicate when the Scanner device is actually acquiring the Image from the Scan Region of the Hard Copy Document.


499

320832093210

321132123213321432153216

3217

32183219322032213222322332243225322632273228322932303231323232333234

500


Figure 117 Document State Transition

9.3 Service Operations

This section defines normative semantics of Service operations and the behavior in response to these operation requests by a Service conformant to the Imaging System model.

A User makes a Service request by interacting through a local Client (via the Imaging System console) or through a remote Client via its software application user interface. Each Service provides the same set of Service interfaces for the co-located local Client or a Remote Client. The Client can operate via a local interface, a local area network, or the Internet.

The individual Service specifications identify all operations applicable to that Service, some of which may be unique to that Service. The Imaging System Operations described in this section are common to more than one Service, with the “” component in the operation name identifying the specific Service to which the operation request is addressed.

All operations consist of a Request issued by a client and a Response returned by the Service. All Requests are sent to the target Service except StartupService, which is sent to the Imaging System . Some responses may just indicate that the request was or was not honored, perhaps with explanation messages; others will contain requested or related information, perhaps with additional explanatory “reasons” information.


501

3235

3236

3237

323832393240

32413242324332443245

32463247324832493250

32513252325332543255

502


The MFP operations applicable to two or more Services are listed in Error: Referencesource not found along with references to their antecedent Printer operations. The operations are, for the most part, derived from IPP Print Service operations defined in RFC2911 [RFC2911], RFC3380[RFC3380] and RFC3998 [3998] and further discussed in the PWG IPP 2.0 specification [PWG5100.10] and the IPP Job and Printer Extensions-Set 2 specification [PWG5100.11]. The Print specific context has been extended to Imaging Services. Several Print operations have been omitted as inapplicable to Imaging Services as a whole, while a few operations have been added.

Table 82 Imaging System Common Operations and Antecedents

Client Request Antecedent IPP Operation Antecedent Reference Access*AddHardcopyDocument Send-URI** [RFC2911] UserCancelDocument Cancel-Document [PWG5100.5] 4.5 UserCancelJob Cancel-Job [RFC2911] 3.3.3 UserCancelJobs Cancel-Jobs [PWG5100.11] 5.1 AdminCancelCurrentJob Cancel-Current-Job [RFC3998] 4.2 UserCancelMyJobs Cancel-My-Jobs [PWG5100.11] 5.2 UserCloseJob Close-Job [PWG5100.11] 5.3 UserCreateJob Create-Job

Print-Job[RFC2911] 3.1.4

3.2.1User

DisableService Disable- Printer [RFC3998] 3.1.1 AdminEnableService Enable- Printer [RFC3998] 3.1.2 AdminGetDocumentElements Get-Document-Attributes [PWG5100.5] 4.3 UserGetDocuments Get-Documents [PWG5100.5] 3.3 User

GetJobElements Get-Job-Attributes [RFC2911] 3.3.4 UserGetJob History Get-Jobs (which-Jobs

Element = ‘completed’)[RFC2911] 3.2.6 User

GetServiceElements Get- Printer-Attributes, Get- Printer-Supported-Values

[RFC2911], [RFC3380]

3.2.5 User

GetActiveJobs Get-Jobs (which-Jobs Element = ‘not-completed’)

[RFC2911] 3.2.6 User

HoldJob Hold-Job [RFC2911] 3.3.5 UserHoldNewJobs Hold-New-Jobs [RFC3998] 3.3.1 AdminPauseService Pause- Printer [RFC2911] 3.2.7 AdminPauseServiceAfterCurrentJob Pause- Printer-After-Current-

Job[RFC3998] 3.2.1 Admin

PromoteJob Promote-JobSchedule-Job-After

[RFC3998] [RFC3998]

4.4.1 Admin

ReleaseJob Release-Job [RFC2911] 3.3.6 User


503

32563257325832593260326132623263

3264

3265

504


Client Request Antecedent IPP Operation Antecedent Reference Access*ReleaseNewJobs Release-Held-New-Jobs [RFC3998] 3.3.2 AdminRestartService Restart- Printer [RFC3998] 3.5.1 AdminResubmitJob Resubmit-Job [PWG5100.11] 5.4 UserResumeJob Resume-Job [RFC3998] 4.3.2 UserResumeService Resume- Printer [RFC2911] 3.2.8 AdminSendDocument Send-Document [RFC2911] 3.3.1 UserSendURI Send-URI [RFC2911] 3.3.2 UserSetDocumentElements Set-Document-Attributes [PWG5100.5] 4.4 UserSetJobElements Set-Job-Attributes [RFC3380] 4.2 UserSetServiceElements Set- Printer-Attributes [RFC3380] 4.1 AdminShutdownService Shutdown- Printer [RFC3998] 3.5.2 AdminStartupService Startup- Printer [RFC3998] 3.5.3 AdminSuspendCurrentJob Suspend-Current-Job [RFC3998] 4.3.1 User

Notes:* For operations where a User may set Job Elements or otherwise directly affect the state or parameters of a Job, the User must be either the Job owner of record or must be an Administrator or Operator. For operations where a User has access to Job or Service information (GetJobElement, GetJobHistory and GetJobs), site policy determines what information is made available to Users who are not Administrators or Operators and who do not own the Jobs about which the information is provided.** Although the AddHardcopyDocument operation is a “new” operation created to address the input to Services accepting Hardcopy versus Digital Documents, the purpose and form of the operation is parallel to the IPP Send-URL operation

The Imaging System operation definitions in this section are generic. Depending on the encoding used by the binding, the actual identification of the operation may be different. For example, IPP uses a numeric code. Further, depending on the addressing inherent in the transport, the operation requests might include an implicit rather than explicit identification of the Service. For example, IPP operations coming on the TCP port 631 are inherently Print Service operations.

The Imaging System Operation definitions are divided between basic or User (Job-oriented) operations and administrative operations. The basic Imaging System operations are listed in Error: Reference source not found. These operations are concerned primarily with creating, monitoring, modifying and canceling Jobs and Job-related Elements. Basic operations are available to Users including Administrators and Operators, although any operation affecting a Job or Document is restricted to the Job Owner or to an Administrator or Operator. Identification and authentication of the User as Job Owner depends upon the Service and binding, as well as the specific implementation. For example, the Copy Service may consider whoever is present at the machine to be the Job Owner.

Site Policy may cause a Service to restrict information provided to a User who is not an Administrator or Operator. Administrative Operations, accessible only to Administrators


505

3266326732683269327032713272327332743275

327632773278327932803281

3282328332843285328632873288328932903291

32923293

506


(and Operators), are concerned primarily with managing the Service and are listed in Error: Reference source not found. Note that for some Services where the User is present at the device (such as Copy), certain operations may consider any User that is present at the implementing device as having Administrator access

Table 83 Basic Imaging System Interface Requests and Responses

Operation Request Parameters (Notes 2)

Response Parameters (Note 3)

Note

AddHardcopyDocument InputSource, JobId, Document Ticket(optional), ElementsNaturalLanguage(optional), LastDocument(optional), RequestingUserName or RequestingUserUri

DocumentNumber, UnsupportedElements(optional)

CancelDocument DocumentNumber, ElementsNaturalLanguage(optional), JobId, Message (optional) RequestingUserName or RequestingUserUri

CancelJob ElementsNaturalLanguage(optional), JobId, Message (optional) RequestingUserName or RequestingUserUri

CancelCurrentJob ElementsNaturalLanguage(optional), JobId(optional), Message (optional) RequestingUserName or RequestingUserUri

CancelMyJobs JobIds (optional), Message (optional), ElementsNaturalLanguage(optional), RequestingUserName or RequestingUserUri

JobIds (optional) 1

CloseJob JobId, RequestingUserName or RequestingUserUri

CreateJob ElementsNaturalLanguage(optional), Job Ticket (optional) RequestingUserName or RequestingUserUri

JobId, UnsupportedElements(optional)

GetActiveJobs ElementsNaturalLanguageRequested(optional), Limit(optional) RequestingUserName or RequestingUserUri

ElementsNaturalLanguage(optional)JobSummaries (includes JobID, JobName, JobOriginatingUserName, JobState and perhaps JobStateReasons)(optional)


507

3294329532963297

3298

508




Note

GetDocumentElements Document Number, ElementsNaturalLanguageRequested(optional), JobId, RequestingUserName or RequestingUserUri

DocumentElements(optional), ElementsNaturalLanguage(optional)

GetDocuments ElementsNaturalLanguageRequested(optional), JobId, RequestingUserName or RequestingUserUri

Documents(list of DocumentSummaries)(optional), ElementsNaturalLanguage(optional)JobID, JobName

GetJobElements ElementsNaturalLanguageRequested(optional), JobId, RequestedElements (JobReceipt, JobStatus, or Job Ticket.)(optional) RequestingUserName or RequestingUserUri

JobElements, ElementsNaturalLanguage(optional)

GetJob History ElementsNaturalLanguageRequested(optional), Limit(optional) RequestingUserName or RequestingUserUri

ElementsNaturalLanguage(optional)JobSummaries (includes JobID, JobName, JobOriginatingUserName, JobState and perhaps JobStateReasons

GetServiceElements ElementsNaturalLanguageRequested(optional), RequestedElements (Service Capabilities, ServiceConfiguration, ServiceDescription, ServiceStatus or DefaultJob Ticket.)(optional) RequestingUserName or RequestingUserUri

ElementsNaturalLanguage(optional)ServiceElements(optional)

HoldJob ElementsNaturalLanguageRequested(optional), JobHoldUntil or JobHoldUntilTime, JobId, Message(optional), RequestingUserName or RequestingUserUri

ReleaseJob ElementsNaturalLanguageRequested(optional), JobId, Message(optional), RequestingUserName or RequestingUserUri

ResubmitJob ElementsNaturalLanguageRequested(optional), JobId, Job Ticket (optional) RequestingUserName or RequestingUserUri

JobId, UnsupportedElements(optional)


509

510




Note

ResumeJob ElementsNaturalLanguageRequested(optional), JobId, Message(optional)RequestingUserName or RequestingUserUri

SendDocument ElementsNaturalLanguageRequested(optional), Document Ticket (optional) JobId, LastDocument(optional), RequestingUserName or RequestingUserUri, DocumentData


SendUri DocumentUri, ElementsNaturalLanguageRequested(optional), Document Ticket (optional) JobId, LastDocument(optional), RequestingUserName or RequestingUserUri


SetDocumentElements DocumentNumber, ElementsNaturalLanguage(optional), SocumentTicket, JobId, Message(optional), RequestingUserName or RequestingUserUri

UnsupportedElements(optional)

SetJobElements ElementsNaturalLanguage(optional), Job Ticket, JobId, Message(optional), RequestingUserName or RequestingUserUri


SuspendCurrentJob ElementsNaturalLanguage(optional), JobId(optional), Message(optional), RequestingUserName or RequestingUserUri

ValidateDocument Ticket ElementsNaturalLanguageRequested(optional), Document Ticket RequestingUserName or RequestingUserUri


Validate Job Ticket ElementsNaturalLanguage(optional), Job Ticket, RequestingUserName or RequestingUserUri


Notes:Note 1: Response includes identified but un-cancellable Jobs Note 2: The RequestingUserName or RequestingUserUri, is used by the Service to determine whether the requestor is an Administrator, Operator or the Job Owner and is therefore authorized to make the request. Some implementations may require further authentication of the requestor’s identity. If the requestor is not determined to have access, the Service MUST reject the request.Note 3: All responses must include correlation to request and whether request was successful or failed.


511

3299330033013302330333043305

512


9.3.1 Basic Service Operations

The common Basic operations are listed in Error: Reference source not found; they are concerned with creating and controlling Jobs and Documents within Jobs. The Operations include those by which a client gets Service Elements to allow selection of Services and formulation of Job Tickets. Some of these operations do affect the state of a Job. However, none of these operations directly affect the state or configuration of the Service except to the extent that creating or canceling a Job may initiate a sequence that affects the Service.

9.3.1.1 Add HardcopyDocument

The Add HardcopyDocument operation allows a client to prepare a Service to accept a Hardcopy Document via a scanner Subunit and to add it to an identified Job. It is analogous to the Send Document and Send Uri operations except that it is applicable to Services for which input Documents are obtained by a Scan of a region of a media sheet side, such as FaxOut and EmailOut.

The Service MUST reject this request and send an appropriate message if:

7. The requestor is not the owner of the identified Job, or is not an Administrator or Operator;

8. The Service has already closed inputs to the identified Job, or 9. The Job is not found.

Otherwise, provided the request is properly constructed, complete and references valid objects, the Service MUST accept the request, MUST close the Job if the LastDocument Element is asserted, MUST be prepared to add Document Data from the identified input to the identified Job, and MUST respond to the request.

9.3.1.2 CancelDocument

The Cancel Document operation allows a client to cancel a specified Document in a specified Job of the specified Service any time from when the time the Document is created up to, but not including, the time that the Document is Completed, Canceled or Aborted. Because a Document might already be in Processing by the time a Cancel Document request is received, some portion of the Document processing might be completed before the Document is actually canceled.

The Cancel Document operation does not remove the Document from the Job or the Service, but does set the specified Document’s Document State Document Status Element to Canceled and the Document’s Document State Reasons Element to an appropriate value. If the Job containing the Document is again submitted using Resubmit Job, the canceled Document is also submitted for processing. Thus Cancel Document has the same semantics as Cancel Job which cancels only the processing of the Job but does not delete the Job object itself.


513

3306

3307330833093310331133123313

3314

33153316331733183319

3320

3321332233233324

3325332633273328

3329

333033313332333333343335

3336333733383339334033413342

514


The Cancel Document operation does not affect the states of any of the other Documents in the Job. If the Job is in the Processing state and there are more Documents to be processed, the Service does continue to process the un-canceled Documents. If there are no further Documents to process, the Job is advanced to the Completed state.

The Service MUST reject the operation and return an appropriate response message if the operation requestor is not either the Job owner or a Service or System operator or administrator. Otherwise the Service MUST accept or reject the Cancel Document request based on the Document's current state and, if the request is accepted, the Service MUST transition the Document to the indicated new state as follows:

Once a “success” response has been sent, the implementation guarantees that the Document will eventually end up in the Canceled state. Between the time that the Cancel Document request is accepted and when the Document enters the Canceled Document-state, the DocumentStateReasons Element MUST contain a value which indicates to any later query that, although the Document might still be Processing, it will eventually end up in the Canceled state.

9.3.1.3 Cancel Job

The Cancel Job operation changes the state of the identified Job to Canceled, provided that the Job is not already in or in a mode leading directly to a termination state. (i.e., Completed, Canceled, or Aborted.) Because a Job might already be active by the time a Cancel Job is received, a portion of the Job may be done before the Job is actually terminated.

The Service MUST accept or reject the request based on the Job's current state. If the request is accepted, the Job state is transitioned to Canceled and the Service will issue a success response. See the transition diagram under Job State (Error: Reference sourcenot found). If the implementation requires some significant time to cancel a Job in the Processing or ProcessingStopped states, the Service MUST set the Job's JobStateReasons to a value indicating that the Job is transitioning to a Canceled state. If the Job already has a JobStateReasons indicating that it is transitioning to a Canceled state, then the Service MUST reject a Cancel Job operation

9.3.1.4 CancelCurrent Job

The CancelCurrent Job operation allows a client to cause the Service to terminate processing on the currently processing Job and to move that Job to the Canceled state. As with any other Basic operation directly affecting a Job, this operation is accepted by the Service only if the originator is the Owner of the affected Job(s) or is an Administrator or Operator.

There is the potential that the current Job may have changed between the time a client requests this operation and the time the Service implements it. Therefore, if the intent is to cancel a particular Job the Client MAY include an optional JobId parameter in the request.


515

3343334433453346

33473348334933503351

335233533354335533563357

3358

33593360336133623363

33643365336633673368336933703371

3372

33733374337533763377

337833793380

516


10. If the JobId is included in the request and that Job is currently in the Processing or ProcessingStopped state and the operation requestor has access rights to that Job, the Service MUST accept the request and cancel the Job.

11. If no JobId is included in the request and the operation requestor has access rights to the Job currently in the Processing or ProcessingStopped state, the Service MUST accept the request and cancel that Job.

12. If more than one Job is in the Processing or ProcessingStopped state, all currently processing Jobs to which the request originator has access MUST be canceled unless the operation included the optional JobId, in which case only the identified Job is canceled.

13. If the JobId is included in the request and that Job is not currently in the Processing or ProcessingStopped state; or if the requestor does not have access rights to the identified Job, the Service MUST reject the request and return the appropriate error code.

14. If there is no Job currently in the Processing or ProcessingStopped state or if the requestor does not have access rights to any Job that is in the Processing or ProcessingStopped state, the Service MUST reject the request and return the appropriate error code.

9.3.1.5 CancelMy Jobs

The CancelMy Jobs operation permits a user to cancel all of their own identified non-Terminated Jobs or, if no specific Jobs are identified in the request, to cancel all of their own non-Terminated Jobs in the Service. This operation works like the Cancel-Job operation except that the operation can apply to multiple Jobs. The client specifies the set of candidate Jobs to be canceled by supplying and/or omitting the JobIds. The Service MUST check the access rights of the requesting user against all of the candidate Jobs. If any of the candidate Jobs are not owned by the requesting user, the Service MUST NOT cancel any Jobs and MUST return the appropriate error status code along with the list of any JobIds that were specifically identified in the operation request but to which the User is not authorized access.

If this check succeeds, then (and only then) the Service MUST accept or reject the request based on the current state of each of the candidate Jobs and must transition each Job to the indicated new state as shown for the antecedent Cancel-My-Jobs operation in the Standard for Internet Printing Protocol (IPP): Job and Printer Extensions Set 2 [PWG5100.11]. If any of the candidate Jobs that were not already in a Terminating state cannot be canceled, the Service MUST NOT cancel any Jobs and MUST return the appropriate error status code along with the list of JobIds for those Jobs which were specifically identified in the operation request but could not be canceled. If the requested Jobs include some Jobs that are already in a terminating state, this circumstance in itself MUST NOT interfere with the canceling of non-terminated candidate Jobs, but SHOULD result in the return of a warning message identifying the specifically identified Jobs that already were in a Terminating state.


517

338133823383338433853386338733883389339033913392339333943395339633973398

3399

3400340134023403340434053406340734083409

341034113412341334143415341634173418341934203421

518


9.3.1.6 Close Job

The Close Job operation allows a client to close Job inputs to those Services accepting Documents, even when the last Document input operation for the Job (Send Document, Send URI or Add Document) did not include the LastDocument Element with a 'true' value. This Close Job operation supersedes and, if supported by the Service, is preferable to the practice of using a Send Document with no Document Data but with a LastDocument Element containing a 'true' value to close inputs.

The Service MUST reject this operation request if the target Job is not found or if the requestor is not the Job Owner or an Administrator. Otherwise, the Service MUST accept this operation request even if the target Job is already closed and regardless of JobState. Closing the Job MUST cause the Service to reject any subsequent Document input operation for the target Job, but MUST NOT affect the execution of any previously accepted Document input operation.

9.3.1.7 Create Job

The Create Job operation allows a Client to request creation of a Job in the Service. Upon creation, the Job is in Pending state and available for scheduling unless a Job Processing instruction prevents this. (e.g., JobHoldUntil puts it in PendingHeld state) The Create Job operation MUST fail if the Service’s IsAcceptingJobs Element value is ‘false’.

Job Processing is done on one or more Documents. Unlike the antecedent IPP Print-Job operation, the Imaging System Create Job may involve more than one Document. Depending upon the type of Service, the input may be a Hardcopy Document or a Digital Document. In either case, the source(s) of the input Document(s) as well as the destination(s) of the output Document(s) are identified in the Job Ticket submitted in the Create Job Request,

Once a Job is created, Documents may be input as part of that Job by Send Document, Send URI or, for Services that accept hardcopy input, Add<Service>Document operations. In Service implementations that do not accept multiple Documents (i.e., MultipleDocumentJobsSupported = False), Document input is closed after one Document is accepted. In Service implementations that do accept multiple Documents (i.e., Multiple Document Jobs Supported = True), there may be multiple Send Document, Send URI or Add<Service>Document operations. There are two methods of indicating when all Documents have been sent:

15. issuing a Close Document request 16. issuing a Send Document, Send URI or, 17.Add<Service>Document request with the LastDocument Element = True

To avoid a possible hang condition, Service implementations supporting multiple Document Jobs must also support the Multiple Operation Time Out Element that indicates the minimum number of seconds the Service will wait for the next Send or Add operation


519

3422

342334243425342634273428

342934303431343234333434

3435

3436343734383439

344034413442344334443445

34463447344834493450345134523453

345434553456

345734583459

520


before taking some recovery action. If, for some reason, there is a longer period between Create Job and valid Send or Add operations, or between sequential Send or Add operations, the Client MUST send Send or Add requests, even if they are empty, to reset the timeout. If there is a multiple operation timeout, the Service will take remedial action according to the value that Service has indicated in its Multiple Operation Timeout Action Element.

9.3.1.8 Get<Service>DocumentElements

The Get<Service>DocumentElements operation allows a Client to obtain detailed information about the specified Document within the specified Job. This operation is parallel to the Get Job-Elements operation, but with the target and response Elements relating to a Document rather than a Job.

The Client requests specific groups of Elements (complex Elements) contained within the Document. The Document Data is not part of the Document and cannot be retrieved using this operation. However the location of the Document Data is available. The allowed values for Requested Elements are Document Receipt, Document Status and Document Ticket. Vendors may extend the allowed values.

The Service MUST return the Document Description Element values that a client supplied in the Document Creation operation (Create Job, Send Document or Send URI) or provided in Set DocumentElements operation a plus any additional Document Description Elements that the Service has generated, such as Document State. The Service MUST NOT return any Job level Elements that the Document inherits from the Job level but MUST return Document Elements specified at the Document level. It is NOT REQUIRED that a specific Document include all Elements belonging to a group (since some Elements are optional). However, it is REQUIRED that the Service support all these group names for the Document object.

9.3.1.9 Get Documents

The Get Documents operation allows a client to retrieve the list of Documents belonging to the identified Job. A Document summary containing a group of Document Element names with their values will be returned for each Document in the Job.

This operation is similar to the Get and Get operations except that it returns Elements from Documents rather than identified Jobs. As with the Get DocumentElements operation, the Service MUST return only those Elements that are in the Document Ticket.

9.3.1.10 Get JobElements

The Get<Service>JobElements operation allows a Client to obtain detailed information on the specified Job. Unlike the antecedent IPP Get-Job-Attributes operation, the Get<Service>JobElements request may not specify individual Elements. Rather, the Client requests specific groups of Elements contained within the Job. The allowed values


521

346034613462346334643465

3466

3467346834693470

34713472347334743475

347634773478347934803481348234833484

3485

348634873488

348934903491

3492

3493349434953496

522


for RequestedElements are Job Receipt, Job Status, or Job Ticket. Vendors may extend the allowed values.

The Service MUST reject this request if the requestor is not authorized access to the identified Job,

9.3.1.11 Get Jobs

The Get Jobs operation provides summary information on all Jobs that have reached a terminating state (i.e., Completed, Canceled Aborted). As such, it is similar to the antecedent Get-Jobs operation with the which-Jobs Element set to ‘completed’. Unlike Get-Jobs, Get Jobs may not include a Requested Elements argument; rather, it always returns a Job Summary for each terminated Job including JobId, JobName, JobOriginatingUserName, JobState and perhaps JobStateReasons and other Service specific information.

When the operation is exercised by a User that is not an Administrator, the Job summary may not include all of the summary information, depending upon site security policy.

9.3.1.12 Get ServiceElements

The Get ServiceElements operation allows a Client to obtain detailed information on the Elements and their values supported by the Service. Unlike the antecedent IPP Get- Printer-Attributes operation, the Get<Service>ServiceElements request may not specify individual Elements. Rather, the Client requests information on one or more specific group of Elements. The allowed values for Requested Elements are Service Capabilities, Service Configuration, Service Description, Service Status or DefaultJob Ticket. Vendors may extend the allowed values.

Some Services may accept an additional argument in a Get ServiceElements request to further filter the response, much as the antecedent IPP Get- Printer-Attributes operation accepted the Document-Format Element. The individual Service specifications identify such arguments if any, their effect and whether support is mandatory.

In addition to the status message, the Service response includes the set of requested Element names and their values for all supported Elements. The response need not contain the requested Element names for any Elements not supported by the Service.

9.3.1.13 GetActive Jobs

The GetActive Jobs operation provides summary information on all Jobs in the Pending or Processing state. As such, it is equivalent to the antecedent Get-Jobs operation with the which-Jobs Element set to ‘not-completed’. Unlike the antecedent Get-Jobs operation, GetActive Jobs may not include a RequestedElements argument; rather, it always returns a JobSummary for each Active Job with the summary including JobId, JobName,


523

34973498

34993500

3501

3502350335043505350635073508

35093510

3511

3512351335143515351635173518

3519352035213522

352335243525

3526

35273528352935303531

524


JobOriginatingUserName, JobState and perhaps JobStateReasons and other Service specific information.

When the operation is exercised by a User that is not an Administrator or Operator, the Job summary may not include all of the summary information, depending upon site security policy.

9.3.1.14 Hold Job

NOTE: The antecedent Hold-Job operation and the associated Release-Job operation, as defined in IPP/1.1: Model and Semantics [RFC2911], have been deprecated in later IPP specifications in favor of using the antecedent Set-Job-Attributes operation [RFC3380] to set the Hold-Job-Until or Hold-Job-Until-Time attributes.

The Hold Job operation allows a client acting for the Job Owner or an Administrator or Operator to hold a Pending Job in the queue so that it is not eligible for scheduling. The Job transitions as a result of a Hold Job operation depend upon the current Job state, as indicated for the antecedent Hold-Job operation in paragraph 3.3.5 of IPP/1.1: Model and Semantics [RFC2911] The Hold Job request can specify hold until a specific date-time (JobHoldUntilTime) or according to a keyword (JobHoldUntil), where the keyword can specify a period (such as “third-shift”) or be indefinite. A given Hold Job request can specify only one hold condition. In the case of multiple Hold Job requests, the last accepted request overrides the condition imposed by any previous Hold Request.

The restraint imposed by a Hold Job is removed by a Release Job operation directed to the same Job. If a Service implementation supports Hold Job, it must also support Release Job and vice-versa.

If the HoldJob 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. The Service MUST accept or reject the request based on the Job's current state and transition the Job to the indicated new state as follows. A HoldJob request is rejected when the identified Job is in the Processing or ProcessingStopped states.

9.3.1.15 Release Job

NOTE: The antecedent Release-Job operation and the associated Hold-Job operation, as defined in IPP/1.1: Model and Semantics [RFC2911], have been deprecated in later IPP specifications in favor of using the antecedent Set-Job-Attributes operation [RFC3380] to set Hold-Job-Until or Hold-Job-Until-Time attributes.

The Release Job operation allows a client acting for the Job Owner or an Administrator or Operator to release a previously held Job from the PendingHeld state so that it is eligible for scheduling, provided that there is no other reason to keep the Job in the PendingHeld state. That is, the restraint imposed by a Hold Job operation is removed by a Release Job


525

35323533

353435353536

3537

3538353935403541

354235433544354535463547354835493550

355135523553

3554355535563557355835593560

3561

3562356335643565

3566356735683569

526


operation directed to the same Job. If a Service implementation supports Hold Job, it must also support Release Job and vice-versa.

The Job Transitions as a result of a Release Job operation depend upon the current Job state, as indicated for the antecedent Release-Job operation in paragraph 3.3.6 of IPP/1.1: Model and Semantics [RFC2911]

9.3.1.16 Resubmit Job

The Resubmit Job operation allows a client acting for the Job Owner or an Administrator or Operator to resubmit a previously completed Job, but with the option of providing new Job Ticket information (other than input Document Data or input Document Data descriptive information.)

The Resubmit Job operation is applicable only to a RetainedJob. A Retained Job is one which remains in the Service after it has been completed or canceled. This may be incidentally or because it is a saved Job, which is a Completed or Canceled Job with a JobSaveDispostion Element value that indicates that the Job, including Document Data if any, should not be deleted or aged-out after the Job is completed.

If a ResubmitJob operation is accepted, the state of the retained Job is not changed; rather, a new Job is created from the identified retained Job and submitted with an implicit CreateJob request.

18. If the ResubmitJob request contains a processing Element that was in the retained Job but with a different value, the value supplied in the ResubmitJob operation MUST override the original value (if supported by the Service).

19. If the ResubmitJob request contains a processing Element that was not in the retained Job, the Element with the value supplied with the ResubmitJob operation MUST be applied (if supported by the Service)

20.For any processing Element in the original retained Job the value of which is not changed in the ResubmitJob request, that Element and its value MUST be applied to newly created Job except that a JobSaveDispostion Element value indicating that the Job should be saved, and certain other Service-specific Element values, MUST NOT be copied but are applied to the new Job only if they are in the ResubmitJob request.

The newly created Job is moved to the Pending or PendingHeld Job state with the same Element values as the original saved Job (except for the save Element). If any of the Documents in the saved Job were passed by reference (SendURI or Send>service>URI), the Service MUST re-fetch the data, since the semantics of RestartJob are to repeat all Job processing. The Service MUST assign new JobUri and JobId values to the newly created Job; the JobDescription Elements that accumulate Job progress, such as JobImpressionsCompleted, JobMediaSheetsCompleted, and JobKOctetsProcessed, MUST be an accurate record for the newly created Job.


527

35703571

357235733574

3575

3576357735783579

35803581358235833584

358535863587

358835893590359135923593359435953596359735983599

36003601360236033604360536063607

528


The Service MUST accept or reject the ResubmitJob Request based on the authority of the requester and the referenced Job's current state. The Requester must either be the Job owner or an operator or administrator of the Service. The target Job must be retained with a Completed or Canceled state.

9.3.1.17 ResumeJob

The ResumeJob operation allows a client acting for the Job Owner or an Administrator or Operator to resume the identified Job at the point where it was suspended. Provided that no other condition exists that forces the Job to the PendingStopped state, the Service moves the Job from the ProcessingStopped state to the Pending state and removes the JobSuspended value from the Job's StateReasons Element. If the identified Job is not in the ProcessingStopped state with the JobSuspended value in the Job's StateReasons Element, the Service MUST reject the request and return an appropriate status code, since the Job was not suspended.

If a Service supports SuspendJob or SuspendCurrentJob operations, it MUST support the ResumeJob operation, and vice-versa.

9.3.1.18 SendDocument

The SendDocument operation allows a client acting for the Job Owner or an Administrator or Operator to input a Digital Document to a Service as part of an already created Job. In response to the CreateJob, the Service will have returned the JobURI and the JobId. For each Document that the client desires to add to this Job, the client issues a SendDocument request which includes the JobId and contains the entire stream of Document Data for one Document.

If the Service supports this operation but does not support multiple Documents per Job, Document input is closed after the first Document is accepted and the Service MUST reject subsequent SendDocument requests associated with the same Job. Similarly, if the Service does support multiple Documents per Job, the Service MUST reject SendDocument requests associated with a given Job after inputs to that Job have been closed either a CloseJob operation or a previous SendDocument with a 'true' value for the LastDocument Element. Note that the Client may send and the Service must accept a SendDocument request with a 'true' value for the LastDocument Element to close input to that Job, even if that request includes no Document data.

See the Create<system>Job description for discussion of issues relating to excessive delay between multiple SendDocument requests.

The Service MUST reject a SendDocument request and send an appropriate message if:

21.The requestor is not the owner of the identified Job, or is not an Administrator or operator

22.The Service has already closed inputs to the identified Job,


529

3608360936103611

3612

36133614361536163617361836193620

36213622

3623

362436253626362736283629

363036313632363336343635363636373638

36393640

3641

364236433644

530


23.The Document size, format and/or compression are not supported by the Service, or

24.The Job is not found.

Otherwise, the Service MUST accept the request, MUST close the Job if the LastDocument Element is asserted, MUST add the supplied Document Data (if any) to the identified Job, and MUST respond to the request.

9.3.1.19 SendUri

The SendUri operation allows a client acting for the Job Owner or an Administrator or Operator to input a Digital Document to a Service as part of an already created Job. As such, the SendUri operation is identical to the SendDocument except that a client supplies a URI reference (DocumentUri Element) rather than the Document Data itself. If a Service supports both operations, clients can use both SendUri and SendDocument operations to add new Documents to an existing multi-Document Job.

As with SendDocument, if the Service supports SendUri but does not support multiple Documents per Job, the Service MUST reject subsequent SendUri requests associated with the same Job. Similarly, if the Service does support multiple Documents per Job, the Service MUST reject SendUri requests associated with a given Job after inputs to that Job have been closed. Job inputs can be closed either by a CloseJob operation or a SendDocument (NOT a SendUri) request with a 'true' value for the LastDocument Element. Note that the Client may send and the Service must accept a SendDocument request with a 'true' value for the LastDocument Element to close input to that Job even if that request includes no Document data.

The Service MUST reject this request and send an appropriate message if:

25.The requestor is not the owner of the identified Job, or is not an Administrator or operator

26.The Service has already closed inputs to the identified Job, 27.The Job is not found 28.The Document size, format and/or compression are not supported by the

Service, or29.The Service does not support the URI Scheme specified.

Otherwise, the Service MUST accept the request, MUST close the Job if the LastDocument Element is asserted, MUST add the Document Data (if any) to the identified Job, and MUST respond to the request. See the Create<system>Job description for discussion of issues relating to excessive delay between multiple SendUri requests.

9.3.1.20 SetDocumentElements

The SetDocumentElements operation allows a Client, operating for the Job Owner or an Administrator, to set the values of identified Elements of the specified Document within the


531

364536463647

364836493650

3651

365236533654365536563657

365836593660366136623663366436653666

3667

3668366936703671367236733674

3675367636773678

3679

36803681

532


specified Job. This operation is parallel to the SetJobElements and SetServiceElements operations and it follows the same rules for validation, but with the target and response Elements relating to a Document rather than a Job or the Service.

The Client must fully identify the Elements to be set as well as the set values. The only settable Elements are those within the Document Ticket. The Document Data is not part of the Document and cannot be changed using this operation. If a Document was originally submitted without a given settable Element that the SetDocumentElements request attempts to set, the Service adds the specified Element to the Document.

If the client identifies a Document Element but does not specify a value for that Element, then the Service MUST remove the Element and all of its values from the Document. The semantic effect of the client supplying the Element with no value in a SetDocumentElements operation MUST be the same as if the Element had not originally been supplied with the Document. This corresponds to the action of the out-of-band value “DeleteElement” in the antecedent IPP Set-Document-Attributes operation. Any subsequent GetDocumentElements or GetDocuments request MUST NOT return any Element that has been deleted. However, a client can re-establish such a deleted Document Element with any supported value(s) using a subsequent SetDocumentElements operation.

If the client supplies an Element in a SetDocumentElements request with no value and that Element is not present in the Document object, the Service ignores that supplied Element in the request, does not return the Element in the Unsupported Elements group, and returns the ‘success’ status code, provided that there are no other problems with the request.

The validation of the SetDocumentElements request is performed by the Service as if the Document had been submitted originally with the new Element values (and the deleted Elements removed); i.e., all modified Document Elements and values must be supported in combination with the Document Elements not modified. If such a Document Creation operation would have been accepted, then the SetDocumentElements MUST be accepted. If such a Document Creation operation would have been rejected, then the SetDocumentElements MUST be rejected and the Document MUST be unchanged. In addition, if any of the supplied Elements are not supported, are not settable, or the values are not supported, the Service MUST reject the entire operation; the Service MUST NOT set just some of the supplied Elements. That is, SetDocumentElements MUST be implemented as an atomic operation; after the operation, all the supplied Elements MUST be set or all of them MUST NOT be set.

The value of JobMandatoryElements supplied in the original CreateJob request, if any, MUST have no effect on the behavior of the SetDocumentElements operation. Rather, the Service must consider that any Element or Element value in a SetDocumentElements operation is mandatory. The Service MUST reject any request to set a Document Element to an unsupported value or to a value that would conflict with another Document Element value.


533

368236833684

36853686368736883689

3690369136923693369436953696369736983699

37003701370237033704

370537063707370837093710371137123713371437153716

371737183719372037213722

534


The Service MUST respond to the SetDocumentElements operation as defined for the antecedent Set-Document-Attributes operation in the Standard for IPP Document Objects [PWG5100.5]. Although the Document's current state affects whether the Service accepts or rejects the SetDocumentElements request, the operation MUST NOT change the state of the Document object (since the Document is a passive object and the Document state is a subset of the JobState). For example, if the operation creates a request for unavailable resources, the Job (but not the Document) transitions to a new state.

9.3.1.21 SetJobElements

The Set<Service>JobElements operation allows a Client operating for the Job Owner or an Administrator, to set the values of identified Elements of the specified Job. The Client must fully identify the Elements to be set as well as the set values. In the response, the Service returns success or rejects the entire request with indications of which Element or Elements could not be set to the specified values.

This operation is parallel to the SetDocumentElements and SetServiceElements operations and it follows the same rules for validation, but with the target and response Elements relating to a Job rather than a Document or the Service

If the client identifies a Job Element but does not specify a value for that Element,, then the Service MUST remove the Element and all of its values from the Job. The semantic effect of the client supplying the Element with no value in a SetJobElements operation MUST be the same as if the Element had not originally been supplied with the Job. This corresponds to the action of the out-of-band value “DeleteElement” in the antecedent IPP Set-Job-Attributes operation. Any subsequent GetJobElements or GetJobs request MUST NOT return any Element that has been deleted. However, a client can re-establish such a deleted Job Element with any supported value(s) using a subsequent SetJobElements operation.

If the client supplies an Element in a SetJobElements request with the DeleteElement value and that Element is not present on the Job object, the Service ignores that supplied Element in the request, does not return the Element in the Unsupported Elements group, and returns the ‘success’ status code, provided that there are no other problems with the request.

The validation of the SetJobElements request is performed by the Service as if the Job had been submitted originally with the new Element values (and the deleted Elements removed); i.e., all modified Job Elements and values must be supported in combination with the Job Elements not modified. If such a Job Creation operation would have been accepted, then the SetJobElements request MUST be accepted. If such a Creation operation would have been rejected, then the SetJobElements MUST be rejected and the Job MUST be unchanged. In addition, if any of the supplied Elements are not supported, are not settable, or the values are not supported, the Service MUST reject the entire operation; the Service MUST NOT partially set some of the supplied Elements. In other


535

3723372437253726372737283729

3730

37313732373337343735

373637373738

373937403741374237433744374537463747

37483749375037513752

375337543755375637573758375937603761

536


words, after the operation, all the supplied Elements MUST be set or none of them MUST be set, thus making the SetJobElements an atomic operation.

The value of JobMandatoryElements supplied in the original CreateJob request, if any, MUST have no effect on the behavior of the SetJobElements operation. Rather, the Service must consider that any Element or Element value in a SetJobElements operation is mandatory. The Service MUST reject any request to set a Job Element to an unsupported value or to a value that would conflict with another Job Element value.

The Service MUST accept or reject the SetJobElements operation according to the rules defined for the antecedent Set-Job-Attributes operation in Internet Printing Protocol (IPP):Job and Printer Set Operations [RFC3380].

9.3.1.22 SuspendCurrentJob

The SuspendCurrentJob operation allows a Client operating for the Job Owner or an Administrator, to suspend a Job by setting a condition in a Job that is currently in the Processing or ProcessingStopped state. This condition, reflected by the JobSuspended value in that Job’s JobStateReasons Element, causes that Job to be in the ProcessingStopped state. The Service is able to processes other Jobs normally, provided that no other inhibiting conditions exist. Note that a Job may be ProcessingStopped state for other reasons and that, once it has been suspended, the Job will remain in the ProcessingStopped state even after the other conditions have been removed.

There is the potential that the current Job may have changed between the time a client requests this operation and the time the Service implements it. Therefore, if the intent is to suspend a particular Job, the Client can include an optional JobId parameter in the request.

The target Job is:

The Job identified by the JobId, if included in the request

If the JobId is not included in the request, any Jobs in the Processing or ProcessingStopped state to which the requestor has access rights.

The Service MUST reject the request and send an appropriate message if:

30.There is no target Job in the Processing or ProcessingStopped state to which the requestor has access rights.

31.The target Job or all potential target Jobs have already been suspended.

The Service MUST accept the request, cancel any target Job(s) that have not been previously suspended, and return an appropriate message if:


537

37623763

37643765376637673768

376937703771

3772

37733774377537763777377837793780

3781378237833784

3785

3786

37873788

3789

379037913792

37933794

538


32.The target JobId is included in the request and that Job is currently in the Processing or ProcessingStopped state (but is not suspended), and the requestor has access rights,

33. If no JobId is included and the requestor has access rights to the Job that is currently in the Processing or ProcessingStopped state (but is not suspended), the Service MUST accept the request and suspend that Job.

34. If more than one Job is in the Processing or ProcessingStopped state (but are not suspended), all such Jobs MUST be suspended unless the operation request included the optional JobId, in which case only the identified target Job MUST be suspended.

35. If the JobId is included in the request and that Job is not currently in the Processing or ProcessingStopped state; or if the JobId is not included and there is no Job currently in the Processing or ProcessingStopped state, the Service MUST reject the request and return the appropriate error code.

36. If the JobId is included in the request and that Job has been suspended; or if no JobId is included and is currently in the Processing or ProcessingStopped state, the Service MUST reject the request and return the appropriate error code.

The ResumeJob operation causes a suspended Job to be released. If a Service supports SuspendCurrentJob operation, it MUST support the ResumeJob operation, and vice-versa.

9.3.2 Administrative Service Operations

Administrative Service operations directly affect the Service as a whole or affect the Jobs of multiple Job Owners. Access is reserved for Administrators or Operators. The Imaging System Administrative Service Operations are listed in Error: Reference source not found and are described below.

Table 84 Administrative Operations

Operation Request Parameters (Note 2) Response Parameters (Note 3)

Note

CancelJobs ElementsNaturalLanguage(optional), JobIds(optional), Message (optional) RequestingUserName or RequestingUserUri

JobIds (optional)

1

DisableService ElementsNaturalLanguage(optional) Message (optional), RequestingUserName or RequestingUserUri


539

37953796379737983799380038013802380338043805380638073808380938103811

381238133814

3815

3816381738183819

3820

540



Note

EnableService ElementsNaturalLanguage(optional),Message (optional) RequestingUserName or RequestingUserUri

-

HoldNewJobs ElementsNaturalLanguageRequested (optional), JobHoldUntil | JobHoldUntilTime, Message(optional), RequestingUserName or RequestingUserUri

PauseService ElementsNaturalLanguageRequested (optional), Message(optional), RequestingUserName or RequestingUserUri

PauseServiceAfterCurrentJob

ElementsNaturalLanguageRequested (optional), Message(optional), RequestingUserName or RequestingUserUri

PromoteJob ElementsNaturalLanguageRequested (optional), JobId, Message(optional), PredecessorJobID(optional), RequestingUserName or RequestingUserUri

ReleaseNewJobs ElementsNaturalLanguageRequested (optional), Message(optional), RequestingUserName or RequestingUserUri


541

542



Note

RestartService ElementsNaturalLanguageRequested (optional), IsAcceptingJobs| IsAcceptingResources (optional), Message(optional), RequestingUserName or RequestingUserUri

ResumeJob ElementsNaturalLanguageRequested(optional), JobId, Message(optional), RequestingUserName or RequestingUserUri

ResumeService ElementsNaturalLanguageRequested(optional), Message(optional), RequestingUserName or RequestingUserUri

SetServiceElements DefaultJob Ticket(optional), RequestingUserName or RequestingUserUri ElementsNaturalLanguageRequested (optional), Capabilities(optional), CapabilitiesReady(optional), Description(optional), Message(optional),

Unsupported Elements(optional)

ShutdownService ElementsNaturalLanguageRequested(optional), Message(optional), RequestingUserName or RequestingUserUri

4

Note 1: CancelJobs response includes identified but un-cancellable JobsNote 2: The RequestingUserName or RequestingUserUri, is used by the Service to determine whether the requestor is an Administrator, Operator or the Job Owner and is therefore authorized to make the request. Some implementations may require further authentication of the requestor’s identity. If the requestor is not determined to have access, the Service MUST reject the request.Note 3: All responses must correlate to request and indicate whether request was successful or failed.Note 4: Forcing Service Shutdown may also force the state of any active Jobs to Aborted.

9.3.2.1 CancelJobs

The CancelJobs operation allows the Operator or Administrator of the Service to cancel all identified non-Terminated Jobs or, if no specific Jobs are identified in the request, to cancel all non-Terminated Jobs in the Service. It differs from the CancelJob operation in


543

3821382238233824382538263827

3828

382938303831

544


that it works on a number of Jobs at once. If, following the legal Job state Transitions in Table, the Service cannot successfully cancel all explicitly or implicitly requested Jobs that are not already in the terminated state it MUST NOT cancel any Jobs but MUST return an error code. In this case, the Service MUST also return the list of JobIds for those Jobs that were explicitly identified in the request but could not be canceled.

The set of candidate Jobs to be canceled is specified by the supplied JobIds. If no JobIds are supplied, it is implicit that all Jobs that are not in a Terminating state are to be canceled. As with all Administrative operations, the Service MUST check the access rights of the requesting user. Provided that the requester has access rights, the Service MUST check the current state of each of the candidate Jobs. If any of the candidate Jobs cannot be canceled, the Service MUST NOT cancel any Jobs and MUST return the indicated error status code along with the list of offending JobId values. If there are no Jobs that cannot be canceled, the Service MUST transition each identified Job to the indicated new state as defined for the antecedent Cancel-Jobs operation in paragraph 6.1 of Standard for Internet Printing Protocol (IPP):9 Job and Printer Extensions Set 2 [PWG5100.11].

9.3.2.2 DisableService

The DisableService operation prevents the Service from creating any new Jobs by negating the IsAcceptingJobs Element. This operation has no effect upon the Service State and the Service is still able to process operations other than CreateJob. All previously created or submitted Jobs and all Jobs currently processing continue unaffected.

If the requestor is determined to have proper access, the Service MUST accept this request and MUST negate the IsAcceptingJobs Element.

The IsAcceptingJobs Element value is reaffirmed by the EnableService operation. If an implementation supports DisableService it must also support EnableService and vice-versa.

9.3.2.3 EnableService

The EnableService operation asserts the IsAcceptingJobs Element to allow the Service to accept new CreateJob requests. The operation has no effect upon the Service State or any other operation requests the Service may receive.

If the requestor is determined to have proper access, the Service MUST accept this request and MUST assert the IsAcceptingJobs Element. The Service MUST then be able to accept and implement Create<Service>Job requests, provided that no other inhibiting condition exists.

If a Service implementation supports the DisableService operation, then it must also support EnableService operation and vice-versa.


545

38323833383438353836

3837383838393840384138423843384438453846

3847

38483849385038513852

38533854

385538563857

3858

385938603861

3862386338643865

38663867

546


9.3.2.4 HoldNewJobs

The HoldNewJobs operation allows a client to prevent any new Jobs from being eligible for scheduling by forcing all newly-created Jobs to the PendingHeld state with a JobHoldUntil or JobHoldUntilTime Job Processing Element added, depending upon the Element supplied with the HoldNewJobs operation request. The operation has the same effect as a HoldJobs operation except that any Jobs in the Pending or Processing state when the HoldNewJobs request is accepted are allowed to go to completion, provided that no other conditions or operations prevent this.

The JobHoldUntil parameter allows a client to specify holding new Jobs indefinitely or until a specified named time period. The JobHoldUntilTime parameter allows a client to hold new Jobs until a specified time. Provided that the requestor is authorized and the operation and requested parameters are supported, a Service MUST accept a HoldNewJobs request and MUST add the supplied 'JobHoldUntil' or JobHoldUntilTime Element to the Jobs. This HoldNewJob condition may be cleared by a ReleaseNew<Service>Jobs operation.

If the HoldNewJobs operation is supported, then the ReleaseNew<Service>Jobs operation MUST be supported, and vice-versa

9.3.2.5 PauseService

The PauseService operation allows a client to send the Service to the Stopped state. In this Service state, the Service MUST NOT advance any Job to Job Processing state. Depending on implementation, the PauseService operation MAY also stop the Service from continuing to process any current Job, sending the Job to the ProcessingStopped state. That is, depending upon implementation, any Job that is currently in the Processing state may be sent to the ProcessingStopped state as soon as the implementation permits; or the Job may continue to a termination state as determined by other conditions. The Service MUST still accept CreateJob operations to create new Jobs, provided that there are no other conditions preventing it.

If the PauseService operation is supported, then the Resume operation MUST also be supported, and vice-versa.

Service State transitions resulting from a PauseService operation are the same as defined for the antecedent Pause- Printer operation in paragraph 3.2.7 of IPP/1.1: Model and Semantics [RFC29110. The PauseService action should be done as soon as the possible after the request is accepted. If the implementation will take more than negligible time to stop processing (perhaps to finish processing the current Job), the Service may remain in the ‘Processing’ state but MUST add the 'MovingToPaused' value to the Service’s StateReasons Element. When the Service transitions to the 'Stopped' state, it removes the 'MovingToPaused' value and adds the 'Paused' value to the Service’s StateReasons Element. If the implementation permits the current Job to stop in mid processing, the Service transitions directly to the ‘Stopped’ state with the Service’s StateReasons Element


547

3868

3869387038713872387338743875

3876387738783879388038813882

38833884

3885

388638873888388938903891389238933894

38953896

3897389838993900390139023903390439053906

548


set to the 'Paused' value and the current Job transitions to the 'ProcessingStopped' state with the JobStateReasons Element set to the 'Stopped' value.

For any Jobs in the 'Pending' or 'PendingHeld' state, the ‘Stopped' value of the Jobs' JobStateReasons Element also applies. However, the Service need not update those Jobs' JobStateReasons Element and need only return the 'Stopped' value when those Jobs are queried (so-called lazy evaluation).

Provided that the requestor is authorized, the Service MUST accept the PauseService request in any Service state and act as defined for the antecedent Pause- Printer operation in paragraph 3.2.7 of IPP/1.1: Model and Semantics [RFC29110].

9.3.2.6 PauseServiceAfterCurrentJob

The PauseServiceAfterCurrentJob operation allows a client to stop the Service from processing any Jobs once any Jobs currently in Processing are completed. This operation has no effect on the current Jobs and the Service MUST complete the processing of the current Jobs, provided that no other condition or operations preclude it. The Service MUST still accept CreateJob operations to create new Jobs, but MUST not cause any Jobs to enter 'Processing'. If the PauseServiceAfterCurrentJob operation is supported, then the ResumeService operation MUST also be supported.

Service State transitions resulting from a PauseServiceAfterCurrentJob operation are as identified for the antecedent Pause- Printer-After-Current-Job operation in IPP: Job and Printer Operations [RFC3998]. Note that, in implementations where the Service implementation is not able to pause Jobs currently in the Processing state, the response to the PauseServiceAfterCurrentJob request and the PauseService request are exactly the same.

If the implementation will take more than negligible time to finish processing the current Jobs, the Service will remain in the Processing state and must add the 'MovingToPaused' value to the Service’s StateReasons Element. When the Service transitions to the 'Stopped' state, it removes the 'MovingToPaused' value and adds the 'Paused' value to the Service’s StateReasons Element.

For any Jobs in the 'Pending' or 'PendingHeld' state, their state is unchanged but the JobStateReasons Element must be set to the ‘Stopped' value. However, the Service need not update those Jobs' JobStateReasons Element and only need return the 'Stopped' value when those Jobs are queried (so-called lazy evaluation).

Provided that the requestor is authorized, the Service MUST accept the request in any Service state and MUST transition the Service to the indicated new State as follows before returning the operation response as defined for the antecedent Pause- Printer-After-Current-Job operation in IPP: Job and Printer Operations [RFC3998].


549

39073908

3909391039113912

391339143915

3916

3917391839193920392139223923

392439253926392739283929

39303931393239333934

3935393639373938

3939394039413942

550


9.3.2.7 PromoteJob

The PromoteJob operation schedules the identified Job to be processed next, after the currently processing Jobs or, if the request includes the predecessor JobId, immediately after the identified predecessor Job. The PromoteJob operation is a combination of the IPP Promote-Job and Schedule-Job-After operations. If the predecessor Job is not specified, it acts in the same way as the antecedent IPP Promote-Job operation. If the predecessor Job is specified, it acts the same way as the antecedent IPP Schedule-Job-After operation.

The identified target Job must be in the 'Pending' state. If the identified target Job is not in the 'Pending' state or if the predecessor Job is identified and it is not in the ‘Pending’, ‘Processing’ or ‘ProcessingStopped’ state, the Service MUST reject the request and return an appropriate status code. If the PromoteJob request is accepted, the target Job MUST be processed immediately after the current Jobs or identified predecessor Job reaches a Termination state (Canceled, Completed or Aborted)

Note that the action of this operation is consistent even if a previous PromoteJob Request has caused some other Job to be scheduled after the current or predecessor Job; that is, within the rescheduling time limitations of the Service, the Job identified in the last PromoteJob Request accepted will be processed next.

9.3.2.8 ReleaseNewJobs

The ReleaseNewJobs operation allows a client to remove the condition initiated by HoldNewJobs and to release all Jobs previously forced to a PendingHeld state by the HoldNewJobs initiated condition so that these Jobs are eligible for scheduling. This is done by removing the 'JobHoldUntilSpecified' and ‘JobHeldByService’ values from the Job's JobStateReasons Element and changing the Jobs’ states to ‘Pending’.

Provided that the requestor is authorized, the Service MUST accept this request in any Service state and the Service MUST remove the 'JobHoldUntilSpecified' value from the Job's JobStateReasons Element for any Job previously forced to a PendingHeld state by the HoldNewJobs initiated condition.

If the ReleaseNewJobs operation is supported, then the HoldNewJobs operation MUST be supported, and vice-versa.

9.3.2.9 RestartService

The RestartService operation causes a Service in any state, even a previously shut down instance of a Service, to be initialized and set to the Idle state, provided that no errors occur or conditions exist that would prevent normal operation. The handling of Jobs that were in the Processing, Pending, PendingHeld, and ProcessingHeld states state prior to Restart is implementation dependent, but a Service Restart MUST be performed as gracefully as possible and in a way preserving the content and integrity of any non-


551

3943

3944394539463947394839493950

395139523953395439553956

3957395839593960

3961

39623963396439653966

3967396839693970

39713972

3973

397439753976397739783979

552


terminated Jobs. Job history data, if supported, SHOULD also be preserved; a particular Service may make this mandatory.

Provided that the requestor is authorized, the Service MUST accept the request RestartService regardless of its current state. Providing that no conditions exist that would normally prevent these actions, the Service MUST reinitialize its State to Idle, clear the StateReasons Element and set the IsAcceptingJobs Element to true.

9.3.2.10 ResumeService

The ResumeService operation allows a client to cause the Service to resume scheduling Jobs after scheduling has been paused. Provided that the requestor is authorized and the Service supports this operation, a Service MUST accept a ResumeService request regardless of the current Service state, corresponding to the actions defined for the antecedent Resume- Printer operation in Internet Printing Protocol/1.1: Model and Semantics [RFC2911]. If there are no other reasons why the Service is in the Stopped state, this operation returns the Service from the Stopped state to the Idle or Processing state from which it was paused, and removes the 'Paused' value to the Service’s StateReasons Element.

If the ResumeService operation is supported, then the PauseService operation MUST be supported, and vice-versa.

9.3.2.11 SetServiceElements

The SetServiceElements operation allows a Client to set the values of identified Elements in the Service, provided that they are settable. Settable Elements may be in Service Capabilities, Service Configuration, Service Description and DefaultJob Ticket but not in Service Status.

The Service MUST reject the entire request with indications of which Element or Elements could not be set if a client request attempts to:

Set a non-settable Element (including an Element not in the Service Capabilities, Service Configuration, Service Description or DefaultJob Ticket groups, a read-only Element, and an Element not supported or not supported as a writable Element in the specific Service implementation)Set a settable Element to an invalid value or to a value that conflicts with the values of other Service Elements, including Elements being set in the same request.Set a greater number of Elements in one operation than are supported by the Service implementation (a Service implementation need not support set of more than one Element at a time).

A SetServiceElements operation that specifies an Element but provides no value for that Element is not an error but rather a request to eliminate that Element and whatever value it has.


553

39803981

3982398339843985

3986

398739883989399039913992399339943995

39963997

3998

3999400040014002

40034004

40054006400740084009401040114012

401340144015

554


If there is no reason to reject setting all of the specified Elements to the specified values or elimination of the Element, the Service MUST accept this operation request when it is in the Idle or Stopped state, and SHOULD accept the request when it is in the Processing state.

If the Service accepts the request, only those Elements specified in the request are changed unless the definition of one or more of the set Elements explicitly specifies an effect upon some other Element.

9.3.2.12 ShutdownService

The ShutdownService operation forces the Service to the ‘Down’ state from any state that it is in, in an orderly manner. That is, the Service MUST stop accepting any further client requests, and MUST stop scheduling Jobs for processing as soon as the implementation allows, although it SHOULD complete the processing of any currently processing Jobs. Once down, the Service will no longer respond to any Client requests other than RestartService request. As with the antecedent IPP Shutdown- Printer operation all Jobs MUST be preserved. As with RestartService, Service shutdown must be performed as gracefully as possible and in a way in preserving the content and integrity of any non-terminated Jobs. Job history data, if supported, SHOULD also be preserved.

Once shut down, a Service can be roused from its Down state by a RestartService operation. If a Service implementation supports ShutdownService it must also support RestartService and vice-versa. In the down state, the only operation request that a Service will respond to is a RestartService operation.

Provided that the requestor is authorized, the Service MUST accept this operation and following an orderly progression, transition to the Down state regardless of the current state of the Service.


555

4016401740184019

402040214022

4023

402440254026402740284029403040314032

4033403440354036

403740384039

4040

556


10. Print Service

10.1 Print Service Model

Figure 1 is the top level view of the Print Service schema.

Figure 1 High Level Print Service Schema

The Imaging System supports zero or more Print Services. A Print Service is hosted locally on an Imaging System or remotely on another computer. The Print Service model has an Active Job queue, a Job History and a set of elements which includes Print Service status, configuration, description, defaults, and processing capabilities.

The Print ServiceCapabilities group element contains the PrintJobTicketCapabilities. The PrintJobTicketCapabilities represents the allowed values supported by the Print Service for a PrintJobTicket. The PrintJobTicketCapabilities includes three sub elements. The PrintJobDescriptionCapabilities element indicates what Job description elements are supported by the Service instance. The PrintDocumentProcessingCapabilities group element has all processing elements for scanning the input Hard Print Document and Printing the output Hard Print Document. The PrintJobProcessingCapabilites group element includes all supported processing elements for PrintJobs. The details of each processing element are specified in §6.1.

The Print ServiceCapabilitiesReady group element represents the allowed values for a PrintJobTicket that do not require operator intervention (e.g., the media that is actually loaded in an input tray). The details are specified in §6.77

Print ServiceConfiguration provides a Print Service specific view into the Subunits that are associated with this Service instance. Only Subunits that are used by the Print Service will appear in this element. The details of each subunit are detailed in §6.The System element provides an all-encompassing view of all the Subunits of the Imaging System ..

The Print ServiceDescription 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. The details of the Print ServiceDescription elements are specified in §6.5.

The Print ServiceDefaults group element contains the Default PrintJobTicket. The Default PrintJobTicket contains the PrintDescription, PrintJobProcessing and PrintDocumentProcessing default values. The values contained in Default PrintJobTicket


557

4041

4042

4043

4044

4045

4046

4047404840494050

405140524053405440554056405740584059

406040614062

4063406440654066

4067406840694070

407140724073

558


are the values that will be used by the Print Service when processing a PrintJobTicket which does not specify a different value. The values for this are populated in an implementation specific manner. The details of the Default PrintJobTicket are specified in §6.

The Print ServiceStatus group element is an extension of SystemServiceStatus class that includes elements such as ID, state, Service counters, state messages and state reasons. State messages are localized state reasons. The only Print Service specific status extensions are the Print Service specific counters. The details of the elements in the Print ServiceStatus group are specified in §6.6.

A Print Service contains zero or more jobs. Since the input and output of a Print Service is a Hard Print Document, there is no document object to represent an implementation specific internal Digital Document. The Print Service does not expose any Digital Document associated with a PrintJob. Therefore, each Job has exactly zero documents. The Print Service organizes its PrintJobs in a minimum of two Job queues: (1) ActiveJobs, (JobHistory. ActiveJobs is a queue maintaining a list of jobs that are pending or processing. The JobHistory queue maintains a log of PrintJobs 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 be at least seconds. Each PrintJob can contain a PrintJobTicket which provides descriptive information as well as Job processing and document processing instructions. PrintJobProcessing instructions apply to the Job as a whole while PrintDocumentProcessing instructions specify rocessing instructions applied to either the input or output Hard Print Documents. The input processing semantics are based on ScanService Semantics while the output processing semantics are based on Print Service Semantics.

10.1.1 Print ServiceCapabilities

The Print ServiceCapabilities is a container element containing PrintJobTicketCapabilities that provides information about the elements that can be used in PrintJobTickets. The values of the elements in PrintJobTicketCapabilities indicate all the supported values for a PrintJobTicket submitted to the Print Service instance (e.g., all the media loaded in the InputTrays or available in nearby storage locations). The names of the elements within the PrintJobTicketCapabilities are the same as those in the Default PrintJobTicket. See §7.or the names of the PrintDocumentProcessingCapabilities ( In and Out), PrintJobDescriptionCapabilities, and PrintJobProcessingCapabilities elements. lthough most of the elements have the same name as their PrintJobTicket counterparts the syntax is often different. For example an element such as InputSource that is a single keyword in PrintJobTicket, it is a sequence of keywords in Print ServiceCapabilities. The values list the allowed values for the PrintJobTicket element. Some elements that are of the data type integer in a PrintJobTicket are a range of integers in PrintJobTicketCapabilities. Other elements that are simple strings or predefined ranges in the PrintJobTicket are simply boolean values in PrintJobTicketCapabilities, indicating support for the associated PrintJobTicket elements. See [PWG5108.01] for details on the syntax.


559

4074407540764077

40784079408040814082

408340844085408640874088408940904091409240934094409540964097

4098

4099410041014102410341044105410641074108410941104111411241134114

560


Figure Print ServiceCapabilities

Table 1 Print ServiceCapabilities

Group

Elements described in [PWG5108.01]

PrintDocumentProcessingCapabilities

(In)

NumberUp, PresentationDirectionNumberUp, AutoSkewCorrection, ColorEntry, ColorType, ContentType, Exposure, FilmScanMode, ImagesToTransfer, InputSource, Resolutions1, Rotation, Scaling, DocumentSizeAutoDetect, ScanRegions, Sides

PrintDocumentProcessingCapabilities

(Out)

NumberUp, PresentationDirectionNumberUp, Copies, CoverBack, CoverFront, FinishingsCol, Finishings, ForceFrontSide, ImpositionTemplate, InsertSheet, Media, MediaType, MediaColSupportedMediaInputTrayCheck, OrientationRequested, OutputBin, OutputDevice, Overrides, PageDelivery, , PagesPerSubset, PageRanges PrintContentOptimized, PrintColorMode, Quality, Resolutions1, SeparatorSheets, SheetCollate, Sides, XImagePosition, XImageShift, XSide1ImageShift, XSideageShift, YImagePosition, YImageShift, YSide1ImageShift, YSideageShift,

PrintJobDescriptionCapabilities

ElementsNaturalLanguage, JobAccountingID, JobAccountingUserID, JobMandatoryElements, JobMessageFromOperator, JobMessageToOperator, JobMoreInfo JobName, JobOriginatingUserName, JobOriginatingUserUri, JobPassword, JobPasswordEncryption, KOctets, TemplateCreatorName, TemplateId, TemplateInfo, TemplateName, TemplateType

PrintJobProcessingCapabilities

JobDelayOutputUntil, JobDelayOutputUntilTime, JobHoldUntil, JobHoldUntilTime, JobMandatoryElements, JobPhoneNumber, JobPriority, JobRecipientName, BatchMode, JobAccountingSheets, JobCopies, JobCoverBack, JobCoverFront, JobErrorSheet, JobFinishings, JobFinishingsCol, JobSaveDisposition, JobSheetMessage, JobSheets, JobSheetsCol, MultipleSetOriginal, OutputBin, Overrides


561

4115

4116

4117

4118

4119

4120

412141224123

4124

4125

4126412741284129413041314132

4133

4134

41354136413741384139

4140

4141

41424143414441454146

562


1 Resolution in the PrintJobTicket.s PrintDocumentProcessing is a single instance of Resolution from the equence of Resolutions elements in PrintDocumentProcessingCapabilities. This applies to both In and ut. diaCol in the PrintJobTicket is a sequence (i.e., MediaColSupported) of MediaCol elements in PrintDocumentProcessingCapabilities

10.1.2 Print ServiceCapabilitiesReady

Print ServiceCapabilitiesReady is a container element containing PrintJobTicketCapabilities that provides information about the elements that can be used in PrintJobTickets. The values of the elements in PrintJobTicketCapabilities indicate all the values for a PrintJobTicket that can be submitted to the PrintServer instance and applied without operator intervention. (i.e., the Media currently loaded in the InputTrays) . The names of the elements within Print ServiceCapabilitiesReady are the same as those in Print ServiceCapabilities. See §6.1 for the names of the PrintDocumentProcessingCapabilities ( In and Out), PrintJobDescriptionCapabilities, and PrintJobProcessingCapabilities elements.

10.1.3 Print ServiceConfiguration

The types of Subunits defined in the MFD Model and Common Semantics specification [PWG5108.01] that are applicable to a Print Service are Console, Cover, Finisher, InputChannel, InputTray, Interface, Interpreter, Marker, MediaPath, OutputChannel, OutputTray, Processor, ScanMediaPath, Scanner, Storage and optionally VendorSubunits. There are no standard subunits unique to the Print Service

Figure Print ServiceConfiguration

10.1.4 Print ServiceDefaults

The Print ServiceDefaults is a Container element. It contains the Default PrintJobTicket that provides the values that will be used if the element is omitted in a PrintJob.s PrintJobTicket. Note that the processing instructions are not bound to the PrintJob until the PrintJob is actually processed. The values from Default PrintJobTicket are not copied to the Job.s PrintJobTicket. If PrintJobReceipt (See §7.1) is supported, the combined elements from the ser supplied PrintJobTicket and the applied values from the Default PrintJobTicket are copied to PrintJobReceipt.

Figure Print ServiceDefaults

For descriptions of the elements that comprise PrintJobDescription, PrintJobProcessing and PrintDocumentProcessing see §7.n PrintJobTicket.


563

4147

41484149415041514152

4153

415441554156415741584159416041614162

4163

41644165416641674168

4169

4170

4171417241734174417541764177

4178

41794180

564


10.1.5 Print ServiceDescription

Figure 5 is a view of the Print Service.s Print ServiceDescription. Print ServiceDescription provide descriptive information for the Print Service. The element values are administratively set. The element values can be odified directly or modified indirectly through an operation.

Figure 5 Print ServiceDescription

The elements common to all ServiceDescriptions are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 5 by being included in the yellow box. There are no elements specific to the Print ServiceDescription except the usual extension point (i.e., Any).

10.1.6 Print ServiceStatus

Figure 6 is a view of the Print Service.s Print ServiceStatus. Print ServiceStatus provide state information for the Print Service. The elements values are maintained by automata and cannot be directly set. The element values an be modified indirectly through an operation. For example Pause Print Service operation on the Print Service may result in the change of the State and StateReasons elements.

Figure 6 Print ServiceStatus

The elements common to all ServiceStatus are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 6 by being included in the yellow box. The remaining elements are taken from ServiceStatus. These elements are described in the MFD Model and Common Semantics specification [PWG5108.01].

10.1.7 PrintJob Model

Figure 7 is the top level view of PrintJob. The jobs appear in one of two lists. Pending and active jobs appear in ActiveJobs. Jobs that have reached a terminal state (i.e., Completed, Aborted, and Canceled) appear in JobHistory. The amount of time a Job is retained in the JobHistory is implementation specific but MUST be at least seconds.

Figure 7 JobTable

As indicated in Figure 8 PrintJobs MUST contain zero documents. This is because the Print Service takes as input a Hard Print Document and produces a Hard Print Document as output. Any internal digital document epresentation is not visible to the User and is handled in an implementation specific manner. The state of the Job is described in


565

4181

4182418341844185

4186

4187

4188

4189419041914192

4193

41944195419641974198

4199

42004201420242034204

4205

4206420742084209

4210

4211421242134214

566


PrintJobStatus. PrintJobTicket contains descriptive information about the Job (i.e., PrintJobDescription) and processing instructions for the Job (i.e., PrintJobProcessing). PrintJobTicket also contains document processing instructions (i.e., PrintDocumentProcessing). PrintDocumentProcessing are broken into two sets. The Input set applies to image acquisition (i.e., scanning) and the Output set applies to the production of the output Hard Print Document (i.e., Printing). PrintJobTicket represent the End User.s intent while PrintJobReceipt represent what the Print Service actually did.

Figure 8 High Level PrintJob View

10.1.8 PrintJobReceipt

This element has exactly the same structure as PrintJobTicket. For each processing element of a PrintJob, it records the actual value used by the Print Service for processing the PrintJob. It contains the elements supplied by the Print Client and applied to the job, any element or values substitutions made by the Print Service and any default elements or values applied by the Print Service. See §7.or element descriptions.

10.1.9 PrintJobStatus

Figure 9 is a view of the PrintJob.s PrintJobStatus. PrintJobStatus provides state information for the PrintJob. The elements are maintained by automata and cannot be directly set. The element values can be modified indirectly through an operation. For example, Cancel PrintJob operation on the PrintJob may result in the change f the State and StateReasons elements.

Figure 9 PrintJobStatus

The elements common to all JobStatus are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 9 by being included in the yellow box. The remaining elements are taken from JobProcessing. These elements are described in the MFD Model and Common Semantics specification [PWG5108.01].

10.1.10 PrintJobTicket

PrintJobTicket contains description and processing elements provided by the Print Client during PrintJob reation. This information is used by the Print Service during the processing of a PrintJob. This information is ade available to Print Clients through the Get PrintJobElements operation. igure 10 PrintJobTicket .

10.1.11 PrintDocumentProcessing

PrintDocumentProcessing provides the document processing instructions that have been requested by the Print lient at the Job level. Each element has a MustHonor attribute to


567

4215421642174218421942204221

4222

4223

4224

42254226422742284229

4230

42314232423342344235

4236

42374238423942404241

4242

4243424442454246

4247

42484249

568


indicate whether documents within the Job must rocessed according to what the user has requested. The PrintDocumentProcessing instructions are broken nto two sets. The PrintInput set applies to image acquisition (i.e., scanning) and the PrintOutput set applies to the roduction of the output Hard Print Document (i.e., Printing). igure 11 PrintDocumentProcessing ( PrintInput) he elements in the PrintInput set are a subset of the ScanDocumentProcessing element in the ScanService and are described in the MFD Model and Common Semantics specification [PWG5108.01].

Figure PrintDocumentProcessing ( PrintOutput, Sheet 1)

Figure PrintDocumentProcessing ( PrintOutput, Sheet

The elements in the Output set are a subset of the PrintDocumentProcessing element in the Print Service and are described in the MFD Model and Common Semantics specification [PWG5108.01].

10.1.12 PrintJobDescription

Figure 1s a view of the PrintJob.s PrintJobDescription . These elements are set by the Print Client during Job creation.

Figure PrintJobDescription

The elements common to all JobDescriptions are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 1y being included in the yellow box. There are no elements specific to the PrintJobDescription except the usual extension point (i.e., Any).

10.1.13 PrintJobProcessing

PrintJobProcessing provides the Job processing instructions that have been requested by the Print Client. Each lement has a MustHonor attribute. When the value of MustHonor is true, the Print Service does not process the ob unless the element is supported; otherwise the Print Service processes the Job with its best effort.

Figure 15 PrintJobProcessing

The elements common to all JobProcessing are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 15 by being included in the yellow box. The remaining elements are taken from PrintJobProcessing. These elements are described in the MFD Model and Common Semantics specification [PWG5108.019


569

4250425142524253425442554256

4257

4258

425942604261

4262

42634264

4265

4266

4267

4268426942704271

4272

4273427442754276

4277

42784279428042814282

570


10.1.14 Print Service Interfaces

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

The semantics for these operations are the same as the operations specified in the MFD Model and Common Semantics specification [PWG5108.01]. The exception is that since the Print Service does not expose a document o operations(e.g., Set PrintDocumentElements) or elements (e.g., PrintDocumentProcessing) associated with a ocument object are applicable to this service. In Table nd Table equired parameters are in bold and optional operations and parameters are in italic font.

Tables User Operations

10.2 Conformance


571

4283

42844285428642874288

428942904291429242934294

4295

4296

4297

572


11. Scan Service

11.1 ScanService Model Overview

11.1.1 ScanServiceDefaults

11.1.2 ScanServiceCapabilities

11.1.3 ScanServiceCapabilitiesReady

11.1.4 ScanServiceConfiguration

11.1.5 ScanServiceDescription

11.1.6 ScanServiceStatus

11.2 ScanJob Model

11.2.1 ScanJobReceipt

11.2.2 ScanJobStatus

11.2.3 ScanJobTicket

11.2.4 ScanDocumentProcessing

11.2.5 ScanJobDescription

11.2.6 ScanJobProcessing

11.3 ScanDocument Model

11.3.1 ScanDocumentReceipt

11.3.2 ScanDocumentStatus

11.3.3 ScanDocumentTicket

11.3.4 ScanDocumentDescription

11.3.5 ScanDocumentProcessing

11.4 ScanService Interfaces

11.5 Conformance


573

4298

4299

4300

4301

4302

4303

4304

4305

4306

4307

4308

4309

4310

4311

4312

4313

4314

4315

4316

4317

4318

4319

4320

574


12. FaxInThe FaxInService 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 Group Element with regard to describing the FaxInService is Services.

One of the MFD’s services is the FaxInService. There can be multiple instances of a FaxInService 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 Group Element that contains all the subunits that comprise the MFD. Each FaxInService instance contains a Service-specific view of the subunits used by that Service instance. The FaxInService element FaxInServiceConfiguration contains the Service-specific view of the associated Subunits.

12.1 FaxInService Model Overview

Below is the top level view of the FaxInService schema.

Figure 118 - High Level FaxInService Schema

The PWG Semantic Model supports zero or more FaxInServices. A FaxInService is hosted locally on an MFD or remotely on another computer. The FaxInService model has an Active Job queue, a Job History and a set of Elements which includes FaxInService status, configuration, description, defaults, and processing capabilities.


575

4321

432243234324

432543264327

4328432943304331

4332

4333

4334

4335

4336433743384339

576


The AvailableFaxInJobTicket Group Element contains pairs of FaxInMetrics and FaxInJobTicket elements. The criteria specified in FaxInMetrics are used to select a particular FaxInJobTicket to be used for processing a given FaxInJob.

The FaxInServiceCapabilities Group Element contains the FaxInJobTicketCapabilities which represents the allowed values supported by the FaxInService for a FaxInJobTicket. This element includes three Group Elements: the FaxInDocumentProcessingCapabilities Group Element has all the supported processing elements for FaxInDocuments; the FaxInJobDescriptionCapabilities Group Element has all the supported description elements for FaxInJobs; and the FaxInJobProcessingCapabilites Group Element includes all supported processing elements for FaxInJobs. The details of each of these Group Elements are specified in §6.3

The FaxInServiceCapabilitiesReady Group Element contains the FaxJobTicketCapabilities which represents the allowed values for a FaxInJobTicket that do not require operator intervention (e.g., the media that is actually loaded in an input tray). The details are specified in §13.1.3

The FaxInService Configuration provides a FaxInService-specific view into the Subunits that are associated with this Service instance. Only Subunits that are used by the FaxInService will appear in this element. The details of each subunit are detailed in §13.1.4. The System element provides an all encompassing view of all the Subunits of the MFD.

The FaxInServiceDefaults Group Element contains a DefaultFaxInJobTicket which consists of FaxIn Job description and Job and document processing default values. The values contained in the DefaultFaxInJobTicket are the values that that will be used by the FaxInService unless an alternative AvailableFaxInJobTicket is selected based on criteria in the FaxMetrics group.. The details of the AvailableFaxInJobTicket element are specified in §6.1. The details of the DefaultFaxInJobTicket element are specified in §6.2.

The FaxInServiceDescription Group Element is an extension of the ImagingServiceDescriptionType class that includes descriptive information such as Service name and information, and has an extension point for vendor specific information. These description elements are settable by Administrators. Similar to FaxInService state elements, there are localized description elements for each supported description element. The details of the FaxInServiceDescription element are specified in §13.1.5

The FaxInServiceStatus Group Element is an extension of the ImagingServiceStatusType class that includes elements such as ID, state, Service counters, state messages and state reasons. State messages are localized state reasons. The only FaxInService-specific status extensions are the FaxInService-specific counters. The details of the FaxInServiceStatus element are specified in §12.1.7.

A FaxInService contains zero or more jobs. Each Job has a zero or more Documents. The FaxInService organizes its FaxInJobs in two Job queues: (1) ActiveJobs, (2) JobHistory.


577

434043414342

43434344434543464347434843494350

4351435243534354

43554356435743584359

436043614362436343644365

436643674368436943704371

43724373437443754376

43774378

578


ActiveJobs is a queue maintaining a list of jobs that are pending or processing. The JobHistory queue maintains a log of FaxIn that have reached a terminating state (i.e. Completed, Aborted, or Canceled). The retention period for jobs in the JobHistory list is implementation specific but MUST NOT be less than 300 seconds. Before a Job can be deleted from the JobHistory, the Job metadata (e.g., JobId, DateTimeAtCompleted, JobOriginatingUserName, DestinationUris) MUST be durably logged.

Each FaxInJob can contain a FaxInJobTicket which provides descriptive information as well as JobProcessing and DocumentProcessing instructions. The DocumentProcessing instructions apply to all documents within the Job unless overridden at the document level with a FaxInDocumentTicket.

Each FaxInJob contains zero or more FaxInDocuments. There is a time between the creation of a Job and when the first document is added that the number of documents is zero. Support of multiple document jobs is OPTIONAL and implementation specific. The service’s support for multiple document jobs can be determined by examining the MultipleDocumentJobsSupported element in FaxInServiceDescription (if present).

Note: Multiple document jobs are inherently not applicable to PSTN FaxIn.

12.1.1 AvailableFaxInJobTicket

The AvailableFaxInJobTicket group provides the alternative (to the DefaultFaxInJobTicket) processing instructions that will be used if there is a matching set of FaxInMetrics configured. Note that the processing instructions are not bound to the FaxInJob until the FaxInJob is actually processed. The values from the selected AvailableFaxInJobTicket MUST NOT be copied to the Job’s FaxInJobTicket. If the FaxInJobReceipt is supported, the combined elements from any system supplied FaxInJobTicket and the applied values from the selected AvailableFaxInJobTicket are copied to the FaxInJobReceipt.

Note: There is no mechanism for an explicit FaxInJobTicket to be received with an incoming FaxInJob.


579

437943804381438243834384

4385438643874388

43894390439143924393

4394

4395

43964397439843994400440144024403

44044405

580


Figure 119 - AvailableFaxInJobTicket

12.1.2 FaxInServiceDefaults

The FaxInServiceDefaults group provides the values that will be used unless an AvailableFaxInJobTicket is selected instead based on matching FaxInMetrics. Note that the processing instructions are not bound to the FaxInJob until the FaxInJob is actually processed. The values from the DefaultFaxInJobTicket MUST NOT be copied to the Job’s FaxInJobTicket. If the FaxInJobReceipt is supported, the combined elements from any system supplied FaxInJobTicket and the applied values from the DefaultFaxInJobTicket are copied to the FaxInJobReceipt.

Figure 120 - FaxInServiceDefaults


581

4406

4407

4408

4409441044114412441344144415

4416

4417

582


For descriptions of the elements that comprise FaxInJobDescription, FaxInJobProcessing and FaxInDocumentProcessing see § on FaxInJobTicket below.

12.1.3 FaxInServiceCapabilities

The FaxInServiceCapabilities Group Element contains the FaxInJobTicketCapabilities and FaxInDocumentTicketCapabilities which provide information about the elements that can be used in FaxInJobTickets and FaxInDocumentTickets. The values of the elements in FaxInServiceCapabilities indicate all the supported values for a FaxInJobTicket or submitted to the FaxInService instance (e.g., all the media loaded in the InputTrays or available in nearby storage locations). The names of the elements within the FaxInServiceCapabilities are the same as those in the Default FaxInJobTicket. See Table 1 for the names of the FaxInDocumentDescriptionCapabilities, FaxInDocumentProcessingCapabilities, FaxInJobDescriptionCapabilities, and FaxInJobProcessingCapabilities elements.

Although most of the elements have the same name as their FaxInJobTicket or FaxInDocumentTicket counterparts the syntax is often different. For example an element such as InputSource that is a single keyword in FaxInJobTicket is a sequence of keywords in FaxInServiceCapabilities. The values list the allowed values for the FaxInJobTicket or FaxInDocumentTicket element. Some elements that are of the data type integer in a FaxInJobTicket or FaxInDocumentTicket are a range of integers in FaxInServiceCapabilities. Other elements that are simple strings or predefined ranges in the FaxInJobTicket or FaxInDocumentTicket are simply boolean values in FaxInServiceCapabilities, indicating supported FaxInJobTicket or FaxInDocumentTicket elements. See MFD Model and Common Semantics specification [PWG5108.01] for details on the syntax.


583

44184419

4420

4421442244234424442544264427442844294430

44314432443344344435443644374438443944404441

4442

584


Figure 121 - FaxInServiceCapabilities

Table 85 - FaxInServiceCapabilities Elements

Group Elements described in MFD Model and Common Semantics specification [PWG5108.01]

FaxInDocumentDescriptionCapabilities DocumentDigitalSignature, DocumentMessage, DocumentName, DocumentNaturalLanguage, LastDocument

FaxInDocumentProcessingCapabilities NumberUp, PresentationDirectionNumberUp,AutoSkewCorrection, Compression, CompressionQualityFactor, Destinationation, DestinationUris, DocumentDigitalSignature, DocumentFormat, DocumentFormatDetailsSupplied, DocumentFormatVersion, Exposure, PrintColorMode, Resolutions, Scaling

FaxInJobDescriptionCapabilities ElementsNaturalLanguage, JobAccountingID,


585

4443

4444

4445

4446

4447

586


JobAccountingUserID, JobMandatoryElements, JobMessageFromOperator, JobMessageToOperator, JobMoreInfo, JobName, JobOriginatingUserName, JobOriginatingUserUri, JobPassword, JobPasswordEncryption, KOctets, TemplateCreatorUserName, TemplateId, TemplateInfo, TemplateName, TemplateType

FaxInJobProcessingCapabilities JobDelayOutputUntil, JobDelayOutputUntilTime, JobHoldUntil, JobHoldUntilTime, JobMandatoryElements, JobPhoneNumber, JobPriority, JobRecipientName

.

12.1.4 FaxInServiceCapabilitiesReady

The FaxInServiceCapabilitiesReady Group Element contains the FaxInJobTicketCapabilities and FaxInDocumentTicketCapabilities which provides information about the elements that are ready to be used in FaxInJobTickets and FaxInDocumentTickets. The values of the elements in FaxInServiceCapabilitiesReady indicate all the values for a FaxInJobTicket or FaxInDocumentTicket that can be submitted to the FaxInService instance and applied without operator intervention. .(e.g., the Media currently loaded in the InputTrays). . The names of the elements within FaxInServiceCapabilitiesReady are the same as those in FaxInServiceCapabilities. See Table 1 for the names of the FaxInDocumentDescriptionCapabilities, FaxInDocumentProcessingCapabilities, FaxInJobDescriptionCapabilities, and FaxInJobProcessingCapabilities elements.

12.1.5 FaxInServiceConfiguration

The types of Subunits defined in the MFD Model and Overall Semantics specification MFD Model and Common Semantics specification [PWG5108.01] are shown in Figure 5 below (i.e., all possible subunits). The particular subunits that are applicable to the FaxInService are: Console, Cover, FaxModem, InputChannel, Interface, Interpreter, OutputChannel, Processor, Storage and optionally VendorSubunits. There are no standard subunits unique to the FaxInService.


587

4448

4449

44504451445244534454445544564457445844594460

4461

4462

446344644465446644674468

588


Figure 122 - FaxInServiceConfiguration

12.1.6 FaxInServiceDescription

Below is a view of the Description elements for the FaxInService. The Description elements provide Descriptive information for the FaxInService. The elements are


589

4469

4470

4471

44724473

590


administratively set. The element values can be directly or indirectly modified through an

operation.


591

4474

4475

592


Figure 123 - FaxInServiceDescription

The elements common to all ServiceDescriptions are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 6 above by being included in the base Imaging ServiceDescriptionType class. The remaining elements are common elements used by FaxIn. These elements are also described in the MFD Model and Common Semantics specification [PWG5108.01] and are listed below.

Note: FaxLogUri specifies the location of the durable log that is REQUIRED for all FaxInService implementations (see section 7).

Table 86 - FaxInServiceDescription Elements

Element Name Description

FaxLogUri The location of the FaxInService’s Fax Log. The contents of the Fax Log is implementation specific.

MultipleDocumentJobsSupported

Support for multiple documents (support is OPTIONAL in FaxInService).

ServiceChargeInfo Charge info for this FaxInService.

ServiceChargeInfoUri URI for charge info for this FaxInService.

ServiceOrganizations Organizations that provide this FaxInService.

Any This element provides extension points for vendor differentiation and implementation specific extensions while maintaining interoperability.

12.1.7 FaxInServiceStatus

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


593

4476

447744784479448044814482

44834484

4485

4486

44874488448944904491

594


Figure 124 - FaxInServiceStatus

The elements common to all ServiceStatus are described in the MFD Model and Common Semantics specification [PWG5108.01]. The remaining elements are common elements used by FaxIn. These elements are also described in the MFD Model and Overall Semantics specification MFD Model and Common Semantics specification [PWG5108.01].


595

4492

4493

44944495449644974498

596


12.2 FaxInJob Model

Below is the top level view of the FaxInJobTable. 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.

Conformance: The JobHistory list is REQUIRED and the retention period for jobs in the JobHistory list is implementation specific but MUST NOT be less than 300 seconds. Before a Job can be deleted from the JobHistory, the Job metadata (e.g., JobId, DateTimeAtCompleted, JobOriginatingUserName, JobReceivingUri, JobSendingUri, DestinationUris) MUST be durably logged to the location specified in FaxLogUri (see section 6.6).

Figure 125 - FaxInJobTable

FaxInJobs always contain zero or more documents. FaxInJobs are always created after a successful Fax Modem negotiation during an incoming Fax phone call or a successful protocol negotiation during an incoming Internet Fax connection. FaxInJobTicket contains descriptive information about the Job and the Job and Document processing instructions. The FaxInJobTicket represents the End User’s intent while the FaxInJobReceipt represents what the FaxInService actually did.

12.2.1 FaxInJob Lifecycle:

Incoming connection arrives on FaxModem, SMTP, or other InputChannel.- If connection negotiation fails, then Service event is promptly recorded in durable log specified in FaxLogUri but FaxInJob is NOT created.- If connection negotiation succeeds, then Service event is promptly recorded in durable log specified in FaxLogUri and new FaxInJob is created in steps 1 through 3 below.

System selects a FaxInJobTicket based on current FaxInService configuration.- If AvailableFaxInJobTickets is configured, then FaxInJobTicket is selected based on FaxInMetrics.- If AvailableFaxInJobTickets is not configured or all FaxInMetrics matches fail, then DefaultFaxInJobTicket is selected.System selects a RequestingUserName (for Job Owner) based on FaxInService configuration.- If JobOriginatingUserName is configured in the selected FaxInJobTicket, then System uses that value for RequestingUserName.- If JobOriginatingUserName is NOT configured in the selected FaxInJobTicket, then System uses an implementation-defined choice of a configured Adminstrator name for RequestingUserName (for protection of FaxInJob data integrity).System sends (internal) CreateFaxInJob to FaxInService with selected RequestingUserName and FaxInJobTicket.


597

4499

450045014502

4503

450445054506450745084509

4510

4511

451245134514451545164517

4518

45194520452145224523452445254526452745284529453045314532453345344535

598


- FaxInService assigns JobId and creates new FaxInJob in Pending state.- Job creation event is promptly recorded in durable log specified in FaxLogUri.System sends (internal) AddFaxInDocument to FaxInService.- FaxInService creates new FaxInDocument.- System sends image data by streaming or spooling to FaxInService.System sends (internal) CloseFaxInJob to FaxInService (FaxInJob might already be streaming and printing for classic PSTN model using FaxModem).- FaxInService closes new FaxInJob creation phase.- FaxInJob becomes eligible for scheduling.FaxInService schedules FaxInJob.- FaxInJob enters Processing state.- Job processing event is promptly recorded in durable log specified in FaxLogUri.- Images are transformed into specified output DocumentFormat.- Output document is sent to one or more destinations specified in DestinationUris.

FaxInService completes FaxInJob- If FaxInJob was successful, then terminal JobState is set to Completed.- If FaxInJob was aborted by the FaxInService, then terminal JobState is set to Aborted.- If FaxInJob was canceled by Job Owner, then terminal JobState is set to Canceled.- Job completion event is promptly recorded in durable log specified in FaxLogUri.- FaxInJob is moved from ActiveJobs to JobHistory.- Job metadata is promptly written to the durable Fax log (for security/integrity). FaxInService “ages” FaxInJob based on implementation-defined method.- FaxInJob is deleted from JobHistory.- FaxInJob remains permanently in the durable log specified in FaxLogUri.

Figure 126 – High Level FaxInJob View

Each FaxInJob contains zero or more FaxInDocuments. There is a time between the creation of a Job and when the first document is added that the number of documents is zero. Support of multiple document jobs is OPTIONAL and implementation specific. The service’s support for multiple document jobs can be determined by examining the MultipleDocumentJobsSupported element in FaxInServiceDescription (if present).


599

45364537453845394540454145424543454445454546

45484549455045514552455345544555

4556

4557

4558

4559

45604561456245634564

600


Note: Multiple document jobs are inherently not applicable to PSTN FaxIn.

12.2.2 FaxInJobReceipt

This element has exactly the same structure as the FaxInJobTicket. For each processing element of a FaxInJob, it records the actual value used by the FaxInService for processing the FaxInJob. It contains the elements supplied in the FaxInJobTicket and applied to the Job, any element or values substitutions made by the FaxInService, and any default elements or values applied by the FaxInService. See § for element names.

12.2.3 FaxInJobStatus

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


601

4565

4566

45674568456945704571

4572

45734574457545764577

602



603

4578

604


Figure 127 - FaxInJobStatus

The elements common to all JobStatus are described in the MFD Model and Common Semantics specification [PWG5108.01]. The remaining elements are common elements used by FaxIn. These elements are also described in the MFD Model and Common Semantics specification [PWG5108.01].

12.2.4 FaxInJobTicket

The FaxInJobTicket group contains description and processing elements provided by the FaxIn Client during FaxInJobTicket creation. This information is used by the FaxInService during the processing of a FaxInJob. This information is made available to FaxIn Clients through the GetFaxInJobElements operation and a subset is made available through the GetActiveFaxInJobs and GetFaxInJobHistory operations.

Figure 128 - FaxInJobTicket

12.2.5 FaxInJobDescription

The FaxInJobDescription group provides the descriptive elements of the FaxInJob, which are set by the FaxIn Client during FaxInJobTicket creation.


605

4579

4580458145824583

4584

45854586458745884589

4590

4591

4592

45934594

4595

606


Figure 129 - FaxInJobDescription

The elements common to all Job Descriptions are described in the MFD Model and Common Semantics specification [PWG5108.01]. There are no elements specific to the FaxInJobDescription except the usual extension point (i.e. Any).

12.2.6 FaxInJobProcessing

The FaxInJobProcessing group provides the Job processing instructions, which are set by the FaxIn Client during FaxInJobTicket creation. Each element has a MustHonor attribute. When the value of MustHonor is true, the FaxInService does not process the Job unless


607

4596

4597

459845994600

4601

460246034604

608


the element is supported; otherwise the FaxInService processes the Job with its best effort.

Figure 130 - FaxInJobProcessing

The elements common to all JobProcessing are described in the MFD Model and Common Semantics specification [PWG5108.01]. There are no elements specific to the FaxInJobProcessing except the usual extension point (i.e. Any).

12.3 FaxInDocument Model

Below is the top level view of the FaxInDocument. FaxInDocuments are associated with one Job. Conforming implementations MAY support multiple document jobs. The state of the Document is described in the FaxInDocumentStatus element. FaxInJobTicket contains descriptive information about the Job and the Job and Document processing instructions. It is possible to override the DocumentProcessing instructions on a document by document basis by supplying a FaxInDocumentTicket with the FaxInDocument. The FaxInJobTicket and FaxInDocumentTicket represent the End User’s intent while the


609

46054606

4607

4608

4609

461046114612

4613

4614461546164617461846194620

610


FaxInJobReceipt and FaxInDocumentReceipt represent what the FaxInService actually did.

Figure 131 – High Level FaxInDocument View

12.3.1 FaxInDocumentReceipt

This element has exactly the same structure as the FaxInDocumentTicket. For each processing element of a FaxInDocument, it records the actual value used by the FaxInService for processing the FaxInDocument. It contains the elements supplied in the FaxInDocumentTicket, Any substitutions made by the FaxInService, and any Default elements applied by the FaxInService.. See §13.3.3 for element names.

12.3.2 FaxInDocumentStatus

Below is a view of the Status elements for the FaxInDocument. The Status elements provide state information for the FaxInDocument. The elements are maintained by automata and cannot be directly set.


611

46214622

4623

4624

4625

46264627462846294630

4631

463246334634

612


Figure 132 - FaxInDocumentStatus


613

4635

4636

614


The elements common to all DocumentStatus are described in the MFD specifications MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in the above diagram by being included in the yellow box. The remaining elements are common elements used by FaxIn. These elements are described in the MFD Model and Common Semantics specification [PWG5108.01]

12.3.3 FaxInDocumentTicket

The FaxInDocumentTicket contains description and processing elements, which are set by the FaxIn Client during FaxInDocumentTicket creation. This information is used by the FaxInService during the processing of a FaxInDocument. This information is made available to FaxIn Clients through the GetFaxInDocumentElements operation.

Figure 133 - FaxInDocumentTicket

12.3.4 FaxInDocumentDescription

Below is a view of the Description elements for the FaxInDocumentTicket. These elements are set by the FaxIn Client during FaxInDocumentTicket creation.


615

4637

46384639464046414642

4643

4644464546464647

4648

4649

4650

4651

46524653

616


Figure 134 - FaxInDocumentDescription

The elements common to all DocumentDescription are described in the MFD specifications MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in the above diagram by being included in the yellow box. The only other element included is the standard extension point.

12.3.5 FaxInDocumentProcessing

The FaxInDocumentProcessing group provides the document processing instructions, which are set by the FaxIn Client during FaxInJobTicket creation. Each element has a MustHonor attribute to indicate whether the FaxIn data received within the Job must be processed according to what the FaxInJobTicket has requested.


617

4654

4655

4656

4657465846594660

4661

4662466346644665

4666

618


Figure 135 - FaxInDocumentProcessing

The elements common to all DocumentProcessing are described in the MFD Model and Common Semantics specification [PWG5108.01]. The remaining elements are common elements used by FaxIn. These elements are also described in the MFD Model and Common Semantics specification [PWG5108.01].

FaxInDocumentProcessing


619

4667

4668

4669467046714672

4673

4674

620


This Group Element has exactly the same structure as the FaxInDocumentProcessing element of FaxInJob (see section 7.2.1). It provides the document processing instructions that have been requested by the End User at each Document level, overriding the Job level document processing instructions.

12.4 FaxInService Subunits

Both the FaxInService and the FaxOutService use the FaxModem subunit which is described in the MFD Model and Common Semantics specification [PWG5108.01]. See section 6.5 of this specification for more information about FaxInConfiguration (i.e., the set of Subunits that are applicable to a FaxInService).

12.5 FaxInService Interfaces

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

The requests parameters are summarized in Table 3, Table 4, and Table 5. Responses to operations that fail are expected to return a fault.

The semantics for these operations are the same as the operations specified in the MFD Model and Common Semantics specification [PWG5108.01]. In the table below required parameters are in bold and optional parameters are in italic font.

Note: In order to preserve high-fidelity traditional PSTN behavior, the FaxInService does not support SetFaxInJobElements, SetFaxInDocumentElements, or ResubmitFaxInJob operations or the Job save feature.

Table 87 - Mandatory User Operations

User Operation Name

Input Parameters Output Parameters

CancelFaxInJob ElementsNaturalLanguage, JobId, Message, RequestingUserName

GetActiveFaxInJobs ElementsNaturalLanguageRequested, Limit, RequestingUserName

ActiveJobs(list of JobSummary), ElementsNaturalLanguag


621

4675467646774678

4679

4680

4681468246834684

4685

46864687468846894690

46914692

469346944695

469646974698

4699

622


User Operation Name


e

GetFaxInJobElements ElementsNaturalLanguageRequested, JobId, RequestedElements, RequestingUserName

FaxInJobElements, ElementsNaturalLanguage

GetFaxInJobHistory ElementsNaturalLanguageRequested, Limit, RequestingUserName

JobHistory(list of JobSummary), ElementsNaturalLanguage

GetFaxInServiceElements

ElementsNaturalLanguageRequested, RequestedElements, RequestingUserName

ElementsNaturalLanguage, FaxInServiceElements

ValidateFaxInJobTicket ElementsNaturalLanguage, FaxInJobTicket, RequestingUserName

UnsupportedAttributes

Table 88 - Optional User Operations

User Operation Name


CancelCurrentFaxInJob ElementsNaturalLanguage, JobId, Message, RequestingUserName

GetFaxInDocumentElements

DocumentNumber, ElementsNaturalLanguageRequested, JobId, RequestedElements, RequestingUserName

FaxInDocumentElements, ElementsNaturalLanguage

GetFaxInDocuments ElementsNaturalLanguageRequested, JobId, RequestingUserName

Documents(List of DocumentSummary),ElementsNaturalLanguage, JobId, JobName


623

4700

4701

4702

624


User Operation Name


HoldFaxInJob ElementsNaturalLanguage, JobHoldUntil | JobHoldUntilTime JobId, Message, RequestingUserName

ReleaseFaxInJob ElementsNaturalLanguage, JobId, Message, RequestingUserName

ResumeFaxInJob ElementsNaturalLanguage, JobId, Message, RequestingUserName

SuspendCurrentFaxInJob ElementsNaturalLanguage, JobId, Message, RequestingUserName

ValidateFaxInDocumentTicket

ElementsNaturalLanguage, FaxInDocumentTicket, RequestingUserName


Table 89 - Administrative Operations

Administrative Operation Name


CancelFaxInJobs ElementsNaturalLanguage, JobIds, Message, RequestingUserName

JobIds

DisableFaxInService ElementsNaturalLanguage, Message, RequestingUserName

EnableFaxInService ElementsNaturalLanguage, Message, RequestingUserName

HoldNewFaxInJobs ElementsNaturalLanguage, JobHoldUntil | JobHoldUntilTime,


625

4703

4704

626




Message, RequestingUserName

PauseFaxInService ElementsNaturalLanguage, Message, RequestingUserName

PauseFaxInServiceAfterCurrentJob ElementsNaturalLanguage, Message, RequestingUserName

PromoteFaxInJob ElementsNaturalLanguage, JobId, Message, PredecessorJobId, RequestingUserName

ReleaseNewFaxInJobs ElementsNaturalLanguage, Message, RequestingUserName

RestartFaxInService ElementsNaturalLanguage, IsAcceptingJobs, Message, RequestingUserName, StartServicePaused

ResumeFaxInService ElementsNaturalLanguage, Message, RequestingUserName

ShutdownFaxInService ElementsNaturalLanguage, Message, RequestingUserName

12.6 Conformance


627

4705

4706

4707

628


13. FaxOutSee [PWG5108.01] for the MFD model. The FaxOutService 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 Group Element with regard to describing the FaxOutService is Services.

One of the MFD’s services is the FaxOutService. There can be multiple instances of a FaxOutService 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 Group Element that contains all the subunits that comprise the MFD. Each FaxOutService instance contains a Service-specific view of the subunits used by that Service instance. The FaxOutService element FaxOutServiceConfiguration contains the Service-specific view of the associated Subunits.

13.1 FaxOutService Model Overview

Figure 136 is the top level view of the FaxOutService schema.


629

4708

4709471047114712

471347144715

47164717471847194720

4721

4722

630


Figure 136 High Level FaxOutService Schema

The PWG semantic model supports zero or more FaxOutServices. A FaxOutService is hosted locally on an MFD or remotely on another computer. The FaxOutService model has an Active Job queue, a Job History and a set of Elements which includes FaxOutService status, configuration, description, defaults, and processing capabilities.

The FaxOutServiceCapabilities Group Element represents the allowed values supported by the FaxOutService for a FaxOutJobTicket and FaxOutDocumentTicket. The details of each FaxOutServiceCapabilities Elements are specified in §13.1.2

The FaxOutServiceCapabilitiesReady Group Element represents the allowed values for a FaxOutJobTicket/FaxOutDocumentTicket that do not require operator intervention (e.g., the media that is actually loaded in an input tray). The details are specified in §13.1.3

The FaxOutService Configuration provides a FaxOutService-specific view into the Subunits that are associated with this Service instance. Only Subunits that are used by the FaxOutService will appear in this element. The details of each subunit are detailed in


631

4723

4724

4725472647274728

472947304731

473247334734

473547364737

632


§13.1.4. The System element provides an all-encompassing view of all the Subunits of the MFD.

The FaxOutServiceDefaults Group Element contains FaxOutJobTicket and FaxOutDocumentTicket default values. The values contained in the default tickets are the values that that will be used by the FaxOutService when processing a FaxOutJobTicket/FaxOutDocumentTicket which does not explicitly specify a different value. The values for this are populated in an implementation specific manner. The details of the DefaultFaxOutTicket are specified in §13.1.1.

The FaxOutServiceDescription Group Element includes descriptive information such as Service name and information, and has an extension point for vendor specific information. These Description Elements are can be set by Administrators. Similar to FaxOutService state elements, there are localized Description Elements for each supported Description Element. The details of the FaxOutServiceDescription Elements are specified in §13.1.5.

The FaxOutServiceStatus Group Element is an extension of the SystemServiceStatus class that includes elements such as ID, state, Service counters, state messages and state reasons. State messages are localized state reasons. The only FaxOutService-specific status extensions are the FaxOutService-specific counters. The details of the Elements in the FaxOutServiceStatus group are specified in §13.1.6.

A FaxOutService contains zero or more jobs. Each Job has a zero or more Documents which reference a Destination where the Digital Document(s) are stored as files. The FaxOutService organizes its FaxOutJobs in 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 FaxOut that have reached a terminating state (i.e., Completed, Aborted, or Canceled). The retention period for jobs in the JobHistory list is implementation specific but MUST NOT be less than 300 seconds. Before a Job can be deleted from the JobHistory, the Job metadata (e.g., JobId, DateTimeAtCompleted, JobOriginatingUserName, DestinationUris) MUST be durably logged.

Each FaxOutJob can contain a FaxOutJobTicket which provides descriptive information as well as JobProcessing and DocumentProcessing instructions. The DocumentProcessing instructions apply to all documents within the Job unless overridden at the document level with a FaxOutDocumentTicket.

Each FaxOutJob contains zero or more FaxOutDocuments. There is a time between the creation of a Job and when the first document is added that the number of documents is zero. Support of multidocument jobs is OPTIONAL and implementation specific. The service’s support for multidocument jobs can be determined by examining the MultipleDocumentJobsSupported element in FaxOutServiceDescription. Note that PSTN FaxOut jobs either: (a) do not support multiple documents; or (b) do not distinguish the document boundaries in the FaxOut transmission.


633

47384739

474047414742474347444745

47464747474847494750

47514752475347544755

4756475747584759476047614762476347644765

4766476747684769

4770477147724773477447754776

634


13.1.1 FaxOutServiceDefaults

The FaxOutServiceDefaults provides the values that will be used if the element is omitted in a FaxOutJob’s FaxOutJobTicket or FaxOutDocumentTicket. Note that the processing instructions are not bound to the FaxOutJob until the FaxOutJob is actually processed. The values from the FaxOutServiceDefaults MUST NOT be copied to the Job’s FaxOutJobTicket or the Document’s FaxOutDocumentTicket. If the FaxOutJobReceipt is supported, the combined elements from the user supplied FaxOutJobTicket and the applied values from the DefaultFaxOutJobTicket are copied to the FaxOutJobReceipt. The DefaultFaxOutJobTicket elements MUST NOT be copied to the Job’s FaxOutJobTicket or the Document’s FaxOutDocumentTicket. Similarly if the FaxOutDocumentReceipt is supported, the combined elements from the user supplied FaxOutDocumentTicket and the applied values from the DefaultFaxOutDocumentTicket are copied to the FaxOutDocumentReceipt.

Figure 137 FaxOutServiceDefaults

For descriptions of the elements that comprise FaxOutDocumentDescription, FaxOutJobDescription, FaxOutJobProcessing and FaxOutDocumentProcessing see § on FaxOutJobTicket

13.1.2 FaxOutServiceCapabilities

The FaxOutServiceCapabilities provides information about the elements that can be used in FaxOutJobTickets and FaxOutDocumentTickets. The values of the elements in FaxOutServiceCapabilities indicate all the supported values for a FaxOutJobTicket and FaxOutDocumentTicket submitted to the FaxOutServer instance (e.g., all the available


635

4777

4778

477947804781478247834784478547864787478847894790

4791

4792

4793

479447954796

4797

4798479948004801

636


resolutions, the available Job priorities). The names of the elements within the FaxOutServiceCapabilities are the same as those in the FaxOutJobTicket. See § and §13.3.3 for the names of the FaxOutDocumentDescriptionCapabilities, FaxOutDocumentProcessingCapabilities, FaxOutJobDescriptionCapabilities, and FaxOutJobProcessingCapabilities elements.

Although most of the elements have the same name as their FaxOutJobTicket counterparts the syntax is often different. For example an element such as InputSource that is a single keyword in FaxOutJobTicket is a sequence of keywords in FaxOutServiceCapabilities. The values list the allowed values for the FaxOutJobTicket element. Some elements that are of the data type integer in a FaxOutJobTicket are a range of integers in FaxOutServiceCapabilities. Other elements that are simple strings or predefined ranges in the FaxOutJobTicket are simply Boolean values in FaxOutServiceCapabilities, indicating supported FaxOutJobTicket elements. See [PWG5108.01] for details on the syntax.

NotetSource, MediaBox, Resolutions1, Up, AutoSkewCorrection, ColorEntry, ContentType, Exposure,

Figure 138 FaxOutServiceCapabilities

Table 90 FaxOutServiceCapabilities

Group Elements described in [PWG5108.01]

FaxOutDocumentDescriptionCapabilities

DocumentDigitalSignature, DocumentMessage, DocumentName,


637

48024803480448054806

480748084809481048114812481348144815

48164817

4818

4819

4820

638


DocumentNaturalLanguage, LastDocument, CompresssionSupplied, DocumentCharsetSupplied, DocumentDigitalSignatureSupplied, DosumentFormatDetailsSupplied, DocumentFormatSupplied, DocumentFormatVersionSupported, DocumentMessageSupplied, DocumentNameSupplied, DocumentUri, Impressions, KOctets, MediaSheets, PageorderReceived

FaxOutDocumentProcessingCapabilities

NumberUp, PresentationDirectionNumberUp, AutoSkewCorrection, ContentType, Exposure, HeaderPrint, Quality, Resolutions1, Scaling, DocumentSizeAutoDetect, ScanRegions, sides

FaxOutJobDescriptionCapabilities ElementsNaturalLanguage, JobAccountingID, JobAccountingUserID, JobMandatoryElements, JobMessageFromOperator, JobMessageToOperator, JobMorInfo, JobName, JobOriginatingUserName, JobOriginatingUserUri,JobPassword, JobPasswordEncryption, KOctets, TemplateCreatorName, TemplateId, TemplateInfo, TemplateName, TemplateType, CompressionSupplied, DocumentCharsetSupplied, DocumentDigitalSignatureSupplied, DosumentFormatDetailsSupplied, DocumentFormatSupplied, DocumentFormatVersionSupported, DocumentMessageSupplied, DocumentNameSupplied

FaxOutJobProcessingCapabilities JobDelayOutputUntil2, JobDelayOutputUntilTime2, JobHoldUntil2, JobHoldUntilTime2, JobMandatoryElements, JobPhoneNumber, JobPriority, JobRecipientName, ConfirmationSheetPrint, CoverSheetInfo, DestinationUris, JobAccountingSheets, JobSaveDisposition, RetryInfo


639

640


1 Resolution in the FaxOutJobTicket’s FaxOutDocumentProcessing is a single instance of Resolution from the sequence of Resolutions element in FaxOutDocumentProcessingCapabilities.

2For the FaxOut Service holding or delaying a Job means to delay the transmission of the facsimile.

.

13.1.3 FaxOutServiceCapabilitiesReady

FaxOutServiceCapabilitiesReady provides information about the elements that can be used in FaxOutJobTickets and FaxOutDocumentTickets. The values of the elements in FaxOutServiceCapabilitiesReady indicate all the values for a FaxOutJobTicket and FaxOutDocumentTickets that can be submitted to the FaxOutServer instance and applied without operator intervention. The names of the elements within FaxOutServiceCapabilitiesReady are the same as those in FaxOutServiceCapabilities. See § and §13.3.3 for the names of the FaxOutDocumentDescriptionCapabilities, FaxOutDocumentProcessingCapabilities, FaxOutJobDescriptionCapabilities, and FaxOutJobProcessingCapabilities elements.

13.1.4 FaxOutServiceConfiguration

The types of Subunits defined in the MFD Model and Common Semantics specification [PWG5108.01] that are applicable to a FaxOutService are Console, Cover, FaxModem, Finisher, InputChannel, InputTray, Interface, Interpreter, Marker, MediaPath, OutputChannel, OutputTray, Processor, ScanMediaPath, Scanner, Storage and optionally VendorSubunits. There are no standard subunits unique to the FaxOutService.


641

482148224823

48244825

4826

4827

482848294830483148324833483448354836

4837

4838

48394840484148424843

4844

4845

642


Figure 139 FaxOutServiceConfiguration

13.1.5 FaxOutServiceDescription

Figure 140 is a view of the Description elements for the FaxOutService. The Description elements provide descriptive information for the FaxOutService. The elements are administratively set. The element values can be modified directly or modified indirectly through an operation.


643

4846

4847

4848

4849485048514852

4853

644



645

4854

646


Figure 140 FaxOutServiceDescription

The elements common to all Service Descriptions are also described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 140 by being included in the yellow box. The remaining elements are common elements used by FaxOut. These elements are also described in the MFD Model and Common Semantics specification [PWG5108.01]. Note that FaxLogURI specifies the location of the durable log that is REQUIRED for all FaxOutService implementations (see section 7).

13.1.6 FaxOutServiceStatus

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


647

4855

4856485748584859486048614862

4863

48644865486648674868

648


Figure 141 FaxOutServiceStatus

The elements common to all ServiceStatus are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 141 by being included in the yellow box. The remaining elements are common elements used by FaxOut. These elements are also described in the MFD Model and Common Semantics specification [PWG5108.01].


649

4869

4870

4871

48724873487448754876

650


13.2 FaxOutJob Model

Figure 142 is the top level view of the FaxOutJob. 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, and Canceled) appear in the JobHistory list. Note that the JobHistory list is REQUIRED and the retention period for jobs in the JobHistory list is implementation specific but MUST NOT be less than 300 seconds. Before a Job can be deleted from the JobHistory, the Job metadata (e.g., JobId, DateTimeAtCompleted, JobOriginatingUserName, DestinationUris) MUST be durably logged to the location specified in FaxLogURI (see section 6.5).

Figure 142 JobTable

FaxOutJobs can contain zero or more documents. During Job creation it is possible that temporarily there are zero documents. The state of the Job is described in the FaxOutJobStatus element. FaxOutJobTicket contains descriptive information about the Job and the Job and Document processing instructions. It is possible to override the Document Processing instructions on a document by document basis by supplying a FaxOutDocumentTicket with the FaxOutDocument. The FaxOutJobTicket and FaxOutDocumentTicket represent the End User’s intent while the FaxOutJobReceipt and FaxOutDocumentReceipt represent what the FaxOutService actually did.


651

4877

48784879488048814882488348844885

4886

4887

48884889489048914892489348944895

652


Figure 143 High Level FaxOutJob View

13.2.1 FaxOutJobReceipt

This element has exactly the same structure as the FaxOutJobTicket. For each processing element of a FaxOutJob, it records the actual value used by the FaxOutService for processing the FaxOutJob. It contains the elements supplied by the FaxOut Client and applied to the job, any element or values substitutions made by the FaxOutService and any default elements or values applied by the FaxOutService. See § for element descriptions.

13.2.2 FaxOutJobStatus

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


653

4896

4897

4898

489949004901490249034904

4905

49064907490849094910

654


Figure 144 FaxOutJobStatus

The elements common to all JobStatus are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 144 by being included in the yellow box. The remaining elements are common elements used by


655

4911

4912

491349144915

656


FaxOut. These elements are also described in the MFD Model and Common Semantics specification [PWG5108.01].

13.2.3 FaxOutJobTicket

The FaxOutJobTicket contains description and processing elements provided by the FaxOut Client during FaxOutJob creation. This information is used by the FaxOutService during the processing of a FaxOutJob. This information is made available to FaxOut Clients through the GetFaxOutJobElements operation and a subset is made available through the GetActiveFaxOutJobs and GetFaxOutJobHistory operations.

Figure 145 FaxOutJobTicket

13.2.4 FaxOutDocumentProcessing

The FaxOutDocumentProcessing 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 the user has requested.


657

49164917

4918

49194920492149224923

4924

4925

4926

4927

4928

4929493049314932

4933

658


Figure 146 FaxOutDocumentProcessing

The elements common to all DocumentProcessing are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure146 by being included in the yellow box. The remaining elements are common elements used by FaxOut. These elements are also described in the MFD Model and Common Semantics specification [PWG5108.01].

13.2.5 FaxOutJobDescription

Figure 147 is a view of the Description elements for the FaxOutJob. These elements are set by the FaxOut Client during Job creation.


659

4934

4935

49364937493849394940

4941

49424943

660


Figure 147 FaxOutJobDescription


661

4944

4945

662


The elements common to all Job Descriptions are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure147 by being included in the yellow box. The remaining elements are common elements used by FaxOut. These elements are also described in the MFD Model and Common Semantics specification [PWG5108.01].

13.2.6 FaxOutJobProcessing

The FaxOutJobProcessing 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 FaxOutService does not process the Job unless the element is supported; otherwise the FaxOutService processes the Job with its best effort.

Figure 148 FaxOutJobProcessing


663

49464947494849494950

4951

4952495349544955

4956

4957

664


The elements common to all JobProcessing are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure148 by being included in the yellow box. The DestinationUris element is FaxouOutService specific and is described in the next section. The remaining elements are common elements used by FaxOut. These elements are also described in the MFD Model and Common Semantics specification [PWG5108.01].

13.2.6.1 DestinationUris

This FaxOutJobProcessing element specifies destinations for the Fax transmission. It is a sequence of DestinationUrisEntry each of which defines a single destination. The DestinationUri is an RFC3966 [RFC3966] compliant URI. Dial Strings were dropped when RFC3966 superseded RFC2806 [RFC2806], "Dial strings" are the actual numbers, symbols, and pauses entered by a user to place a phone call. We have added some elements to contain the Dial String information even though they could be encoded as RFC3966 compliant parameters. The PreDialString is the Dial string entered before the DestinationUri is applied. The PostDialString is the Dial string entered after the DestinationUri is applied.

The ABNF for a Dial Sting that applies to a PreDialString and a PostDialString is given below.

DialString = 1*(phonedigit / dtmf-digit / pause-character)

pause-character = one-second-pause / wait-for-dial-tone

one-second-pause = "p"

wait-for-dial-tone = "w"

dtmf-digit = "*" / "A" | "B" / "C" / "D" / “#”

phonedigit = DIGIT / [ visual-separator ]

visual-separator = "-" / "." / "(" / ")" / "'" / "(" / ")"

The T33 subaddressing can be specified by the T33Subaddress element since a T33 subaddress can only contain digits [RFC3192], the datatype for the T33Subaddress is an integer. Multiple T33 subaddresses are not supported in a single DestinationUrisEntry. If multiple mailboxes are to be addressed each one requires its own entry.


665

495849594960496149624963

4964

496549664967496849694970497149724973

49744975

4976

4977

4978

4979

4980

4981

4982

4983

4984

4985498649874988

666


13.3 FaxOutDocument Model

Figure 149 is the top level view of the FaxOutDocument. FaxOutDocuments are associated with one FaxOutJob. Note that PSTN FaxOut jobs either: (a) do not support multiple documents; or (b) do not distinguish the document boundaries in the FaxOut transmission. Initial implementations MAY support multiple document jobs. The state of the Document is described in the FaxOutDocumentStatus element. FaxOutJobTicket contains descriptive information about the Job and the Job and Document processing instructions. It is possible to override the Document Processing instructions on a document by document basis by supplying a FaxOutDocumentTicket with the FaxOutDocument. The FaxOutJobTicket and FaxOutDocumentTicket represent the End User’s intent while the Job Receipt and Document Receipt represent what the FaxOutService actually did.

Figure 149 High Level FaxOutDocument View

13.3.1 FaxOutDocumentReceipt

This element has exactly the same structure as the FaxOutDocumentTicket. For each processing element of a FaxOutDocument, it records the actual value used by the FaxOutService for processing the FaxOutDocument. It contains the elements supplied by the FaxOut Client, Any substitutions made by the FaxOutService and any Default elements applied by the FaxOutService. See §13.3.3 for element descriptions.


667

4989

49904991499249934994499549964997499849995000

5001

5002

5003

5004

5005

50065007500850095010

668


13.3.2 FaxOutDocumentStatus

Figure 150 is a view of the Status elements for the FaxOutDocument. The Status elements provide state information for the FaxOutDocument. The elements are maintained by automata and cannot be directly set.


669

5011

501250135014

670


.

Figure 150 FaxOutDocumentStatus


671

5015

5016

672


The elements common to all DocumentStatus are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure150 by being included in the yellow box. The remaining elements are common elements used by FaxOut. These elements are described in the MFD Model and Common Semantics specification [PWG5108.01].

13.3.3 FaxOutDocumentTicket

The FaxOutDocumentTicket contains description and processing elements provided by the FaxOut Client during FaxOutDocument creation. This information is used by the FaxOutService during the processing of a FaxOutDocument. This information is made available to FaxOut Clients through the GetFaxOutDocumentElements operation.

Figure 151 FaxOutDocumentTicket

13.3.4 FaxOutDocumentDescription

Figure 152 is a view of the Description elements for the FaxOutDocument. These elements are set by the FaxOut Client during Document creation.


673

50175018501950205021

5022

5023502450255026

5027

5028

5029

50305031

674


Figure 152 FaxOutDocumentDescription

The elements common to all DocumentDescription are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure152 by being included in the yellow box. The only other element included is the standard extension point.

13.3.5 FaxOutDocumentProcessing

This Group Element has exactly the same structure as the FaxOutDocumentProcessing element of FaxOutJob (See 7.2.1). It provides the document processing instructions that have been requested by the End User at each document level, overriding the Job level document processing instructions.


675

5032

5033

5034503550365037

5038

5039504050415042

676


13.4 FaxOutService Interfaces

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

The requests parameters are summarized in Table 91, Table 92 and Table 93. Responses to operations that fail are expected to return a fault.

The semantics for these operations are the same as the operations specified in the MFD Model and Common Semantics specification [PWG5108.01]. In in Table 91, Table 92 and Table 93 the required parameters are in bold and optional parameters are in italic font.

Table 91 Mandatory User Operations

User Operation Name


AddFaxOutHardCopyDocument InputSource, JobId, ElementsNaturalLanguage, FaxOutDocumentTicket, LastDocument, RequestingUserName

DocumentNumber, UnsupportedAttributes

CancelFaxOutJob ElementsNaturalLanguage, JobId, Message, RequestingUserName

CloseFaxOutJob JobId, RequestingUserNameCreateFaxOutJob ElementsNaturalLanguage,

FaxOutJobTicket, RequestingUserNameJobId, UnsupportedElements

GetActiveFaxOutJobs ElementsNaturalLanguageRequested, limit, RequestingUserName

ActiveJobs(list of JobSummary), ElementsNaturalLanguage

GetFaxOutJobElements ElementsNaturalLanguageRequested, JobId, RequestedElements, RequestingUserName

FaxOutJobElements, ElementsNaturalLanguage

GetFaxOutJobHistory ElementsNaturalLanguageRequested, limit, RequestingUserName


GetFaxOutServiceElements ElementsNaturalLanguageRequested, RequestedElements, RequestingUserName

ElementsNaturalLanguage, FaxOutServiceElements

SendFaxOutDocument ElementsNaturalLanguageRequested, FaxOutDocumentTicket, JobId, LastDocument, RequestingUserName, DocumentData


ValidateFaxOutJobTicket ElementsNaturalLanguage, UnsupportedAttributes


677

5043

50445045504650475048

50495050

505150525053

5054

678


User Operation Name


FaxOutJobTicket, RequestingUserName

Table 92 Optional User Operations

User Operation Name


CancelCurrentFaxOutJob ElementsNaturalLanguage, JobId, Message, RequestingUserName

CancelFaxOutDocuments DocumentNumber, ElementsNaturalLanguage, JobId, Message, RequestingUserName

CancelMyFaxOutJobs ElementsNaturalLanguage, JobIds, Message, RequestingUserName

JobIds

GetFaxOutDocumentElements

DocumentNumber, ElementsNaturalLanguageRequested, JobId, RequestedElements, RequestingUserName

FaxOutDocumentElements, ElementsNaturalLanguage

GetFaxOutDocuments ElementsNaturalLanguageRequested, JobId, RequestingUserName

Documents(List of DocumentSummary),ElementsNaturalLanguage, JobId, JobName

HoldFaxOutJob ElementsNaturalLanguage, JobHoldUntil | JobHoldUntilTime JobId, Message, RequestingUserName

ReleaseFaxOutJob ElementsNaturalLanguage, JobId, Message, RequestingUserName

ResubmitFaxOutJob ElementsNaturalLanguage, FaxOutJobTicket, JobId, RequestingUserName

JobId, UnsupportedElements

ResumeFaxOutJob ElementsNaturalLanguage, JobId, Message, RequestingUserName

SendFaxOutUri DocumentUri, ElementsNaturalLanguageRequested, FaxOutDocumentTicket,



679

5055

5056

680


User Operation Name


JobId, LastDocument, RequestingUserName

SetFaxOutDocumentElements

DocumentNumber, ElementsNaturalLanguage, FaxOutDocumentTicket, JobId, Message, RequestingUserName

UnsupportedElements

SetFaxOutJobElements ElementsNaturalLanguage, FaxOutJobTicket, JobId, Message, RequestingUserName

UnsupportedElements

SuspendCurrentFaxOutJob ElementsNaturalLanguage, JobId, Message, RequestingUserName

ValidateFaxOutDocumentTicket

ElementsNaturalLanguage, FaxOutDocumentTicket, RequestingUserName

UnsupportedElements




CancelFaxOutJobs ElementsNaturalLanguage, JobIds, Message, RequestingUserName

JobIds

DisableFaxOutService ElementsNaturalLanguage, Message, RequestingUserName

EnableFaxOutService ElementsNaturalLanguage, Message, RequestingUserName

HoldNewFaxOutJobs ElementsNaturalLanguage, JobHoldUntil | JobHoldUntilTime, Message, RequestingUserName

PauseFaxOutService ElementsNaturalLanguage, Message, RequestingUserName

PauseFaxOutServiceAfterCurrentJob ElementsNaturalLanguage, Message, RequestingUserName

PromoteFaxOutJob ElementsNaturalLanguage, JobId, Message, PredecessorJobId,


681

5057

682




RequestingUserNameReleaseNewFaxOutJobs ElementsNaturalLanguage,

Message, RequestingUserName

RestartFaxOutService ElementsNaturalLanguage, IsAcceptingJobs, Message, RequestingUserName, StartServicePaused

ResumeFaxOutService ElementsNaturalLanguage, Message, RequestingUserName

SetFaxOutServiceElements ElementsNaturalLanguage, FaxOutServiceElements, Message, RequestingUserName

UnsupportedElements

ShutdownFaxOutService ElementsNaturalLanguage, Message, RequestingUserName


683

684


13.5 Conformance

14. EmailIn Service

14.1 EmailInService Model Overview

14.1.1 EmailInServiceDefaults

14.1.2 EmailInServiceCapabilities

14.1.3 EmailInServiceCapabilitiesReady

14.1.4 EmailInServiceConfiguration

14.1.5 EmailInServiceDescription

14.1.6 EmailInServiceStatus

14.2 EmailInJob Model

14.2.1 EmailInJobReceipt

14.2.2 EmailInJobStatus

14.2.3 EmailInJobTicket

14.2.4 EmailInDocumentProcessing

14.2.5 EmailInJobDescription

14.2.6 EmailInJobProcessing

14.3 EmailInDocument Model

14.3.1 EmailInDocumentReceipt

14.3.2 EmailInDocumentStatus

14.3.3 EmailInDocumentTicket

14.3.4 EmailInDocumentDescription

14.3.5 EmailInDocumentProcessing

14.4 EmailInService Interfaces


685

5058

5059

5060

5061

5062

5063

5064

5065

5066

5067

5068

5069

5070

5071

5072

5073

5074

5075

5076

5077

5078

5079

5080

686


14.5 Conformance


687

5081

5082

688


15. EmailOut Service

15.1 EmailOutService Model Overview

15.1.1 EmailOutServiceDefaults

15.1.2 EmailOutServiceCapabilities

15.1.3 EmailOutServiceCapabilitiesReady

15.1.4 EmailOutServiceConfiguration

15.1.5 EmailOutServiceDescription

15.1.6 EmailOutServiceStatus

15.2 EmailOutJob Model

15.2.1 EmailOutJobReceipt

15.2.2 EmailOutJobStatus

15.2.3 EmailOutJobTicket

15.2.4 EmailOutDocumentProcessing

15.2.5 EmailOutJobDescription

15.2.6 EmailOutJobProcessing

15.3 EmailOutDocument Model

15.3.1 EmailOutDocumentReceipt

15.3.2 EmailOutDocumentStatus

15.3.3 EmailOutDocumentTicket

15.3.4 EmailOutDocumentDescription

15.3.5 EmailOutDocumentProcessing

15.4 EmailOutService Interfaces


689

5083

5084

5085

5086

5087

5088

5089

5090

5091

5092

5093

5094

5095

5096

5097

5098

5099

5100

5101

5102

5103

5104

690


15.5 Conformance


691

5105

5106

692


16. Transform Service The TransformService 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 Element Group with regard to describing the TransformService is Services.

One of the MFD’s services is the TransformService. There can be multiple instances of a TransformService 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 Element Group, which contains all the subunits that comprise the MFD. Each TransformService instance contains a Service-specific view of the subunits used by that Service instance. The TransformService element TransformServiceConfiguration contains the Service-specific view of the associated Subunits.

Figure 136 is the top level view of the TransformService schema.


693

5107

510851095110

511151125113

51145115511651175118

5119

5120

5121

694


Figure 153 High Level TransformService Schema

The PWG Imaging System model [PWG5108.01] can contain zero or more TransformServices. A TransformService is hosted locally on an MFD or on another system. The TransformService model has an Active Job queue, a Job History and a set of Element Group which includes TransformService status, configuration, description, defaults, and processing capabilities.

The TransformServiceCapabilities Element Group represents the allowed values supported by the TransformService for a TransformJobTicket and TransformDocumentTicket. The details of each TransformServiceCapabilities Element Group are specified in §13.1.2

The TransformService Configuration provides a TransformService-specific view into the Subunits that are associated with this Service instance. Only Subunits that are applicable to the TransformService will appear in this element. The subunits are explained in §13.1.4. The System element provides an all-encompassing view of all the Subunits of the MFD.

The TransformServiceDefaults Element Group contains TransformJobTicket and TransformDocumentTicket default values. The values contained in the default tickets are the values that that will be used by the TransformService when processing a TransformJobTicket/TransformDocumentTicket which does not explicitly specify a different value. The values for this are populated in an implementation specific manner. The details of the DefaultTransformTicket are specified in §13.1.1.

The TransformServiceDescription Element Group includes descriptive information such as Service name and information, and has an extension point for vendor specific information. These Description Element Group values can be set by Administrators. Similar to TransformService state elements, there are localized Description Elements for each supported Description Element. The details of the TransformServiceDescription Element Group are specified in §13.1.5.

The TransformServiceStatus Element Group is an extension of the SystemServiceStatus class that includes elements such as ID, state, Service counters, state messages and state reasons. State messages are localized state reasons. The only TransformService-specific status extensions are the TransformService-specific counters. The details of the Elements in the TransformServiceStatus group are specified in §13.1.6.

A TransformService contains zero or more jobs. Each Job has zero or more Documents. The results of the transform are stored at the specified destination. The TransformService organizes its TransformJobs in two Job queues: (1) ActiveJobs, (2) JobHistory. ActiveJobs queue maintains a list of jobs that are pending or processing. The JobHistory queue maintains a log of Transform processes that have reached a terminating state (i.e., Completed, Aborted, or Canceled). The retention period for jobs in the JobHistory list is implementation specific but MUST NOT be less than 300 seconds.


695

5122

51235124512551265127

5128512951305131

51325133513451355136

513751385139514051415142

514351445145514651475148

51495150515151525153

5154515551565157515851595160

696


Each TransformJob can contain a TransformJobTicket which provides descriptive information as well as JobProcessing and DocumentProcessing instructions. The DocumentProcessing instructions apply to all documents within the Job subject to transform unless overridden at the document level with a TransformDocumentTicket.

Each TransformJob contains zero or more TransformDocuments. There is a time between the creation of a Job and when the first document is added that the number of documents is zero. Support of multidocument jobs is OPTIONAL and implementation specific. The service’s support for multidocument jobs can be determined by examining the MultipleDocumentJobsSupported element in TransformServiceDescription.

Complex transforms of documents may require additional instructions, scripts, templates or additional data. These are often transform and/or vendor specific. To keep the Transform model simple these components will be treated as additional documents in the TransformJob. How many there are and what order they appear is specific to the transform and not covered in this specification.

16.1.1 TransformServiceDefaults

The TransformServiceDefaults provides the values that will be used if the element is omitted in a TransformJob’s TransformJobTicket or TransformDocumentTicket. Note that the processing instructions are not bound to the TransformJob until the TransformJob is actually processed. The values from the TransformServiceDefaults MUST NOT be copied to the Job’s TransformJobTicket or the Document’s TransformDocumentTicket. If the TransformJobReceipt is supported, the combined elements from the user supplied TransformJobTicket and the applied values from the DefaultTransformJobTicket are copied to the TransformJobReceipt. The DefaultTransformJobTicket Element Group MUST NOT be copied to the Job’s TransformJobTicket or the Document’s TransformDocumentTicket. Similarly if the TransformDocumentReceipt is supported, the combined elements from the user supplied TransformDocumentTicket and the applied values from the DefaultTransformDocumentTicket are copied to the TransformDocumentReceipt.


697

5161516251635164

51655166516751685169

51705171517251735174

5175

5176517751785179518051815182518351845185518651875188

5189

698


Figure 154 TransformServiceDefaults

For descriptions of the elements that comprise TransformDocumentDescription, TransformJobDescription, TransformJobProcessing and TransformDocumentProcessing see § on TransformJobTicket

16.1.2 TransformServiceCapabilities

The TransformServiceCapabilities Element Group provides information about the elements that can be used in TransformJobTickets and TransformDocumentTickets. The values of the elements in TransformServiceCapabilities indicate all the supported values for a TransformJobTicket and TransformDocumentTicket submitted to the TransformService instance (e.g., all the available resolutions, the available Job priorities). The names of the elements within the TransformServiceCapabilities are the same as those in the TransformJobTicket. See § and §13.3.3 for the names of the TransformDocumentDescriptionCapabilities, TransformDocumentProcessingCapabilities, TransformJobDescriptionCapabilities, and TransformJobProcessingCapabilities Element Group.

Although most of the elements have the same name as their TransformJobTicket counterparts the syntax is often different. For example an element such as DocumentFormat that is a single keyword in TransformJobTicket is a sequence of keywords in TransformServiceCapabilities. The values list the allowed values for the TransformJobTicket element. Some elements that are of the data type integer in a TransformJobTicket are a range of integers in TransformServiceCapabilities. Other elements that are simple strings or predefined ranges in the TransformJobTicket are simply Boolean values in TransformServiceCapabilities, indicating supported TransformJobTicket elements. See [PWG5108.01] for details on the syntax.

NotetSource, MediaBox, Resolutions1, Up, AutoSkewCorrection, ColorEntry, ContentType, Exposure,


699

5190

5191

519251935194

5195

5196519751985199520052015202520352045205

520652075208520952105211521252135214

52155216

700


Figure 155 TransformServiceCapabilities

Table 94 TransformServiceCapabilities

Group Elements described in [PWG5108.01]

TransformDocumentDescriptionCapabilities

CompressionSupplied, DocumentDigitalSignature, DocumentMessage, DocumentMetadata, DocumentName, DocumentNaturalLanguage, LastDocument, DocumentCharsetSupplied, DosumentFormatDetailsSupplied, DocumentFormatSupplied, DocumentFormatVersionSupplied, DocumentUri, Impressions, KOctets, MediaSheets, PageorderReceived

TransformDocumentProcessingCapabilities

NumberUp, PresentationDirectionNumberUp, AutoSkewCorrection, ColorEntry, Compression, CompressionQualityFactor, ContentType, Destination, DestinationUris, DocumentFormat, DocumentFormatVersion,


701

5217

5218

5219

5220

5221

5222

5223

702


DocumentFormatDetails, Resolution1, Rotation, Scaling

TransformJobDescriptionCapabilities ElementsNaturalLanguage, JobAccountingID, JobAccountingUserID, JobMessageFromOperator, JobMessageToOperator, JobMorInfo, JobName, JobOriginatingUserName, JobOriginatingUserUri, KOctets, TemplateCreatorName, TemplateId, TemplateInfo, TemplateName, TemplateType

TransformJobProcessingCapabilities JobDelayOutputUntil, JobDelayOutputUntilTime, JobHoldUntil, JobHoldUntilTime, JobMandatoryElements, JobPhoneNumber, JobPriority, JobRecipientName

1 Resolution in the TransformJobTicket’s TransformDocumentProcessing is a single instance of Resolution from the sequence of Resolutions element in TransformDocumentProcessingCapabilities.

.

16.1.3 TransformServiceCapabilitiesReady

TransformServiceCapabilitiesReady provides information about the elements that can be used in TransformJobTickets and TransformDocumentTickets. The values of the elements in TransformServiceCapabilitiesReady indicate all the values for a TransformJobTicket and TransformDocumentTickets that can be submitted to the TransformService instance and applied without operator intervention. The names of the elements within TransformServiceCapabilitiesReady are the same as those in TransformServiceCapabilities. See § and §13.3.3 for the names of the TransformDocumentDescriptionCapabilities, TransformDocumentProcessingCapabilities, TransformJobDescriptionCapabilities, and TransformJobProcessingCapabilities Element Group.

16.1.4 TransformServiceConfiguration

The types of Subunits defined in the MFD Model and Common Semantics specification [PWG5108.01] that are applicable to a TransformService are Console, InputChannel,


703

522452255226

5227

5228

5229523052315232523352345235523652375238

5239

5240

52415242

704


Interface, Interpreter, OutputChannel, Processor, Storage and optionally VendorSubunits. There are no standard subunits unique to the TransformService.

Figure 156 TransformServiceConfiguration

16.1.5 TransformServiceDescription

Figure 140 is a view of the Description elements for the TransformService. The Description elements provide descriptive information for the TransformService. The element values can be modified directly or modified indirectly through an operation by an authenticated administrator.


705

52435244

5245

5246

5247

5248524952505251

706


Figure 157 TransformServiceDescription

The elements common to all ServiceDescription Elemenet Groups are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 140 by being included in the shaded box. The remaining elements are


707

5252

5253

525452555256

708


common elements used by the TransformService. These elements are also described in the MFD Model and Common Semantics specification [PWG5108.01].

16.1.6 TransformServiceStatus

Figure 141 is a view of the Status Element Group for the TransformService. The Status Element Group provides state information for the TransformService. The elements are maintained by automata and cannot be directly set. The element values can be modified indirectly through an operation by an authenticated administrator. For example PauseTransformService operation on the TransformService may result in the change of the State and StateReasons elements.


709

52575258

5259

526052615262526352645265

710


Figure 158 TransformServiceStatus

The elements common to all ServiceStatus Element Groups are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 141 by being included in the shaded box. The remaining elements are common elements used by the TransformService. These elements are also described in the MFD Model and Common Semantics specification [PWG5108.01].


711

5266

5267

5268

52695270527152725273

712


16.2 TransformJob Model

Figure 142 is the top level view of the TransformJob. 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, and Canceled) appear in the JobHistory list.

Figure 159 JobTable

TransformJobs can contain zero or more documents. During Job creation it is possible that temporarily there are zero documents. The state of the Job is described in the TransformJobStatus element. TransformJobTicket contains descriptive information about the Job and the Job and Document processing instructions. It is possible to override the Document Processing instructions on a document by document basis by supplying a TransformDocumentTicket with the TransformDocument. The TransformJobTicket and TransformDocumentTicket represent the End User’s intent while the TransformJobReceipt and TransformDocumentReceipt represent what the TransformService actually did.


713

5274

527552765277

5278

5279

5280

52815282528352845285528652875288

714


Figure 160 High Level TransformJob View

16.2.1 TransformJobReceipt

This element has exactly the same structure as the TransformJobTicket. For each processing element of a TransformJob, it records the actual value used by the TransformService for processing the TransformJob. It contains the elements supplied by the TransformClient and applied to the job, any element or values substitutions made by the TransformService and any default elements or values applied by the TransformService. See § for element descriptions.

16.2.2 TransformJobStatus

Figure 144 is a view of the Status Element Group for the TransformJob. The Status Element Group provides state information for the TransformJob. The elements are maintained by automata and cannot be directly set. The element values can be modified indirectly through an operation by an authorized user. For example CancelTransformJob operation on the TransformJob may result in the change of the State and StateReasons elements.


715

5289

5290

5291

5292

529352945295529652975298

5299

530053015302530353045305

716


Figure 161 TransformJobStatus

The elements common to all JobStatus Element Groups are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 144 by being included in the shaded box. The remaining elements are common


717

5306

5307

530853095310

718


elements used by the TransformService. These elements are also described in the MFD Model and Common Semantics specification [PWG5108.01].

16.2.3 TransformJobTicket

The TransformJobTicket contains description and processing elements provided by the TransformClient during TransformJob creation. This information is used by the TransformService during the processing of a TransformJob. This information is made available to TransformClients through the GetTransformJobElements operation and a subset is made available through the GetActiveTransformJobs and GetTransformJobHistory operations.

Figure 162 TransformJobTicket

16.2.3.1 TransformDocumentProcessing

The TransformDocumentProcessing 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 the user has requested.


719

53115312

5313

5314

531553165317531853195320

5321

5322

5323

5324532553265327

5328

720


Figure 163 TransformDocumentProcessing

The elements common to all DocumentProcessing Element Groups are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 146 by being included in the shaded box. The remaining elements are common elements used by the TransformService. These elements are also described in the MFD Model and Common Semantics specification [PWG5108.01].

The DestinationUris element has TransformService specific semantics. While the common definition of any DocumentProcessing element allows element to be used at theJob and Document level, the TransformService imposes a constraint on the DesditationsUri element. A conforming TransformClient MUST NOT supply the DestinationsUri at the Document level. The TransformService MUST reject a Document Creation operation (i.e.,


721

5329

5330

53315332533353345335

53365337533853395340

722


SendTransformDocument, SendTransformUri) that includes the DestinationsUri. The error MUST indicate that the request was malformed.

16.2.3.2 TransformJobDescription

Figure 147 is a view of the Description Element Group for the TransformJob. These elements are set by the TransformClient during Job creation.


723

53415342

5343

53445345

724


Figure 164 TransformJobDescription


725

5346

5347

5348

726


The elements common to all JobDescription Element Groups are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 147 by being included in the shaded box. The remaining elements are common elements used by the TransformService. These elements are also described in the MFD Model and Common Semantics specification [PWG5108.01].

16.2.3.3 TransformJobProcessing

The TransformJobProcessing 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 TransformService does not process the Job unless the element is supported; otherwise the TransformService processes the Job with its best effort.

. Figure 165 TransformJobProcessing


727

53495350535153525353

5354

5355535653575358

5359

5360

5361

5362

728


The elements common to all JobProcessing Element Groups are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 148 by being included in the shaded box. The only the TransformService specific element is the standard extension point

16.3 TransformDocument Model

Figure 149 is the top level view of the TransformDocument. TransformDocuments are associated with one TransformJob. Initial implementations MAY support multiple document jobs. The state of the Document is described in the TransformDocumentStatus element. TransformJobTicket contains descriptive information about the Job and the Job and Document processing instructions. It is possible to override the Document Processing instructions on a document by document basis by supplying a TransformDocumentTicket with the TransformDocument. The TransformJobTicket and TransformDocumentTicket represent the End User’s intent while the Job Receipt and Document Receipt represent what the TransformService actually did.

Figure 166 High Level TransformDocument View

16.3.1 TransformDocumentReceipt

This element has exactly the same structure as the TransformDocumentTicket. For each processing element of a TransformDocument, it records the actual value used by the TransformService for processing the TransformDocument. It contains the elements supplied by the TransformClient, Any substitutions made by the TransformService and any Default elements applied by the TransformService. See §13.3.3 for element descriptions.


729

5363536453655366

5367

536853695370537153725373537453755376

5377

5378

5379

538053815382538353845385

730


16.3.2 TransformDocumentStatus

Figure 150 is a view of the Status Element Group for the TransformDocument. The Status elements provide state information for the TransformDocument. The elements are maintained by automata and cannot be directly set.


731

5386

538753885389

732


.

Figure 167 TransformDocumentStatus


733

5390

5391

5392

734


The elements common to all DocumentStatus Element Groups are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 150 by being included in the shaded box. The remaining elements are common elements used by the TransformService. These elements are described in the MFD Model and Common Semantics specification [PWG5108.01]. Note that the unit for work performed by the Transform Service is Images. For some transforms (e.g., converting PDF to Raster) the unit is directly applicable. For other transforms the mapping may not be as straight forward. Implementers should use ImagesCompleted to represent the number of input units processed. When Images are not in input documents the implementer must map ImagesCompleted to something applicable.

16.3.3 TransformDocumentTicket

The TransformDocumentTicket contains description and processing elements provided by the TransformClient during TransformDocument creation. This information is used by the TransformService during the processing of a TransformDocument. This information is made available to TransformClients through the GetTransformDocumentElements operation.

Figure 168 TransformDocumentTicket

16.3.3.1 TransformDocumentDescription

Figure 152 is a view of the Description Element Group for the TransformDocument. These elements are set by the TransformClient during Document creation.


735

5393

5394539553965397539853995400540154025403

5404

54055406540754085409

5410

5411

5412

5413

54145415

736


Figure 169 TransformDocumentDescription

The elements common to all DocumentDescription Element Groups are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 152 by being included in the shaded box. The remaining elements are common elements used by the TransformService. These elements are also described in the MFD Model and Common Semantics specification [PWG5108.01]..

16.3.3.2 TransformDocumentProcessing

This Element Group has exactly the same structure as the TransformDocumentProcessing element of TransformJob (See Figure 146). It provides the document processing instructions that have been requested by the End User at each document level, overriding the Job level document processing instructions.


737

5416

5417

54185419542054215422

5423

5424542554265427

738


16.4 TransformService Interfaces

The TransformService provides a set of Service interfaces that is the same for a co-located local TransformClient or a remote TransformClient via a local interface, a local area network, or the Internet. A user makes a TransformService request by interacting directly with the TransformService or indirectly through a local TransformClient via the MFD UI or a remote TransformClient via its software application UI.

The requests parameters are summarized in Table 91, Table 92 and Table 93. Responses to operations that fail are expected to return a fault.

The semantics for these operations are the same as the operations specified in the MFD Model and Common Semantics specification [PWG5108.01]. In in Table 91, Table 92 and Table 93 the required parameters are in bold and optional parameters are in italic font.

Table 95 Mandatory User Operations

User Operation Name


CancelTransformJob ElementsNaturalLanguage, JobId, Message, RequestingUserName, RequestingUserUri

CloseTransformJob JobId, RequestingUserName, RequestingUserUri

CreateTransformJob DocumentPassword, ElementsNaturalLanguage, JobPassword, JobPasswordEncryption, TransformJobTicket, RequestingUserName, RequestingUserUri


GetActiveTransformJobs ElementsNaturalLanguageRequested, FirstIndex, limit, RequestingUserName, RequestingUserUri

ActiveJobs(list of JobSummary), ElementsNaturalLanguage

GetTransformJobElements ElementsNaturalLanguageRequested, JobId, RequestedElements,

TransformJobElements, ElementsNaturalLangua


739

5428

54295430543154325433

5434

54355436

543754385439

5440

740


User Operation Name


RequestingUserName, RequestingUserUri

ge

GetTransformJobHistory ElementsNaturalLanguageRequested, limit, RequestingUserName, RequestingUserUri


GetTransformServiceElements

DocumentFormat, ElementsNaturalLanguageRequested, RequestedElements, RequestingUserName, RequestingUserUri, TransformName

ElementsNaturalLanguage, TransformServiceElements

ListInputDocumentFormats RequestingUserName, RequestingUserUri, DocumentFormatDetails | (DocumentFormat, DocumentFormatVersion)

list of DocumentFormatDetails | (DocumentFormat, DocumentFormatVersion)

ListOutputDocumentFormats

RequestingUserName, RequestingUserUri, DocumentFormatDetails | (DocumentFormat, DocumentFormatVersion)

list of DocumentFormatDetails | (DocumentFormat, DocumentFormatVersion)

SendTransformDocument DocumentPassword, ElementsNaturalLanguage, TransformDocumentTicket, JobId, LastDocument, RequestingUserName, RequestingUserUri, DocumentData


ValidateTransformJobTicket

DocumentPassword, ElementsNaturalLanguage, JobPassword, JobPasswordEncryption, TransformJobTicket, RequestingUserName, RequestingUserUri



741

742


Table 96 Optional User Operations

User Operation Name


CancelCurrentTransformJob ElementsNaturalLanguage, JobId, Message, RequestingUserName, RequestingUserUri

CancelMyTransformJobs ElementsNaturalLanguage, JobIds, Message, RequestingUserName, RequestingUserUri

JobIds

CancelTransformDocument DocumentNumber, ElementsNaturalLanguage, JobId, Message, RequestingUserName, RequestingUserUri

GetTransformDocumentElements

DocumentNumber, ElementsNaturalLanguageRequested, JobId, RequestedElements, RequestingUserName, RequestingUserUri

TransformDocumentElements, ElementsNaturalLanguage, UnsupportedElements

GetTransformDocuments ElementsNaturalLanguageRequested, FirstIndex, JobId, Limit, RequestingUserName, RequestingUserUri

Documents(List of DocumentSummary),ElementsNaturalLanguage, JobId, JobName, UnsupportedElements

HoldTransformJob ElementsNaturalLanguage, JobHoldUntil | JobHoldUntilTime JobId, Message, RequestingUserName, RequestingUserUri

ReleaseTransformJob ElementsNaturalLanguage, JobId, Message, RequestingUserName, RequestingUserUri

ResubmitTransformJob ElementsNaturalLanguage, TransformJobTicket, JobId, RequestingUserName,



743

5441

5442

744


User Operation Name


RequestingUserUri

ResumeTransformJob ElementsNaturalLanguage, JobId, Message, RequestingUserName, RequestingUserUri

SendTransformUri DocumentPassword, DocumentUri, ElementsNaturalLanguageRequested, TransformDocumentTicket, JobId, LastDocument, RequestingUserName, RequestingUserUri


SetTransformDocumentElements

DocumentNumber, ElementsNaturalLanguage, JobId, OperationMode, Message, RequestingUserName, RequestingUserUri, TransformDocumentTicket

UnsupportedElements

SetTransformJobElements ElementsNaturalLanguage, JobId, OperationMode, Message, RequestingUserName, RequestingUserUri, TransformJobTicket

UnsupportedElements

SuspendCurrentTransformJob

ElementsNaturalLanguage, JobId, Message, RequestingUserName, RequestingUserUri

ValidateTransformDocumentTicket

DocumentPassword, ElementsNaturalLanguage, TransformDocumentTicket, RequestingUserName, RequestingUserUri

UnsupportedElements



745

5443

746




CancelTransformJobs ElementsNaturalLanguage, JobIds, Message, RequestingUserName, RequestingUserUri

JobIds

DisableTransformService ElementsNaturalLanguage, Message, RequestingUserName, RequestingUserUri

EnableTransformService ElementsNaturalLanguage, Message, RequestingUserName, RequestingUserUri

HoldNewTransformJobs ElementsNaturalLanguage,

JobHoldUntil | JobHoldUntilTime,

Message, RequestingUserName, RequestingUserUri

PauseTransformService ElementsNaturalLanguage, Message, RequestingUserName, RequestingUserUri

PauseTransformServiceAfterCurrentJob

ElementsNaturalLanguage, Message, RequestingUserName, RequestingUserUri

PromoteTransformJob ElementsNaturalLanguage, JobId, Message, PredecessorJobId, RequestingUserName, RequestingUserUri

PurgeTransformJobs ElementsNaturalLanguage, Message,


747

748


RequestingUserName, RequestingUserUri

ReleaseNewTransformJobs ElementsNaturalLanguage, Message, RequestingUserName, RequestingUserUri


749

750


RestartTransformService ElementsNaturalLanguage, IsAcceptingJobs, Message, RequestingUserName, RequestingUserUri, StartServicePaused

ResumeTransformService ElementsNaturalLanguage, Message, RequestingUserName, RequestingUserUri

SetTransformServiceElements ElementsNaturalLanguage, OperationMode, Message, RequestingUserName, RequestingUserUri, TransformServiceElements

UnsupportedElements

ShutdownTransformService ElementsNaturalLanguage, Message, RequestingUserName, RequestingUserUri

16.5 Conformance


751

5444

5445

5446

752


17. ResourceThe diagram below depicts the top level architecture of Resource Service. A Resource Service is considered part of an Imaging System and is accessed by the other Imaging Services. It provides resource storage and retrieval interfaces to a resource client object which may also reside locally within teh same Imaging System or on a remote system. A User always requests resource storage or retrieval by interacting with a Local Resource Client or a Remote Resource Client. A Remote Resource Client may connect to multiple Resource Services at any period of time. By the same token, a Resource Service may serve multiple Remote Resource Clients. Each Resource Service may process zero or more resource storage and retrieval requests simultaneously; it does not process Jobs. A Resource Service stores or retrieves a resource at or from a resource storage location. For security consideration, the resource storage location is not exposed to users, must be configurable only by an authorized administrator, and may be local or remote to the Resource Service.

Figure 170 Resource Service Top Level Architecture


753

5447

5448544954505451545254535454545554565457545854595460

5461

5462

5463

5464

5465

5466

5467

5468

5469

5470

5471

5472

5473

5474

754


The lifecycle of a Resource begins when the Resource is created and ends when the Resource is deleted.

An Imaging System resource is created by an Resource Client, then stored by a Resource Service at a resource storage location. The Imaging System Resource Client, Resource Service, or the resource storage location is local or remote to the Imaging System.

At any time a resource may encounter the following events while stored in at resource storage location:

Retrieval by a Resource Service at the request from a Resource Client invoked by an MFD application on behalf of a user’s Job processing request,Update/replacement by a Resource Service at the request of a Resource Client on behalf of the creator of the resource,Expiration that signals the end of life for the resource, and the resource will then be deleted by the Resource Services.

17.1 Resource Service Model Overview

Resource Service is an optional Imaging Service. There may be zero or multiple instances of Resource Services in an Imaging System.

The types of resources within the scope of Resource Service include, but are not limited to: Font, Form, Logo, ICC Profile, Firmware, Software, Image, Template (including Job Template and document Template).

The Resource Service model contains several Service properties: Service capability, Service configuration, Service description, Service status, and an extension point for vendor’s unique Service properties.

The Service capability of Resource Service has a ResourceDescriptionCapabilites element that contains the abilities of the Service in supporting some of the descriptive attributes of a resource entry. These descriptive attributes of a resource entry include natural language for any Service generated message or description text, date and time of expiration, Resource category, Resource creator user name, Resource format, Resource descriptive information, Resource name, and Resource type. A Resource Service does not provide other job-related Service capabilities because it only stores and retrieves Resources, does not process any MFD job. The Service capability of Resource Service also has an extension point for other vendor’s unique Service capabilities.

The Service configuration is the Resource Service specific view of the applicable MFD subunits which may include Storages, Interfaces, InputChannels, and OutputChannels.


755

5475

54765477

547854795480

54815482

5483548454855486548754885489

5490

54915492

549354945495

549654975498

549955005501550255035504550555065507

55085509

756


The Service description property contains only the basic set of imaging Service description elements common to all imaging services. It includes owner’s web address and identification information, Service URIs, Service descriptive information, Service location, and Service name.

The Service status property contains state information maintained by the Service automata. The state information consists of a set of basic imaging Service states which are common to all imaging services and a set of Service states that are Resource Service specific.

The basic imaging Service state information includes Service access rights, Service creation date, current time, Service id, a flag indicating whether the Service is accepting jobs (here refers to requests for storing and retrieving resources in Resource Service), the natural language currently used by the service, queued Service request count, serial number of the device hosting the service, the current state of the service, the current state of the subunits used by the service, additional information about the Service state, and human readable messages on the additional information about the Service state.

The Resource Service specific set of Service state contains information on resource Service counters that provide Resource Service specific usage accounting information.

Below is the top level view of the Resource Service schema.

Figure 171 High Level Resource Service Schema


757

5510551155125513

5514551555165517

5518551955205521552255235524

55255526

5527

5528

5529

758


Besides Service properties, Resource Service has an unordered list of Resources: ResourceList. Each element in the list is a ResourceEntry that contains Resource descriptive and status information for the stored resource.

Resource Service provides a set of client interfaces that allow users to list all resources available to a specific user or group, retrieve a resource that is specified by the Resource ID, store a new resource that validates a resource before it is stored, replace (update) and delete a resource with the specified Resource ID, and get and set the metadata of a Resource and a Resource Service.

Like all other imaging services, Resource Service model provides a set of administrative interfaces that allows authorized administrators to remotely disable/enable the service, and shutdown/restart the service.

17.2 Resource Service Model Description

17.2.1 Data Types

The keywords used to define the data types of the elements of the Resource Service model are the same as those defined in the Network Scan Service Semantic Model and Service Interfaces specification [PWG 5108.02-2009].

17.2.2 Resource Service Configuration

(complex-ResourceServiceConfiguration) This group element identifies the actual instances of the subunits the Resource Service uses. These elements are based on the Printer MIB [RFC3805]. See the RFC for details on these elements.

Note that not all subunits are used by the Resource Services.

The following diagram shows the schema of Resource Service Configuration.


759

553055315532

55335534553555365537

553855395540

5541

5542

554355445545

5546

554755485549

5550

5551

760


Figure 172 Resource Service Configuration Schema

All subunits defined for all imaging services are optional for a Resource Service. The subunits applicable to Resource Service are Consoles, Covers, Interfaces, InputChannels, OutputChannels, Storages, and VendorSubunits.

For the descriptions of the subunits Consoles, Covers, Interfaces, InputChannels, OutputChannels, and VendorSubunits please refer to the PWG Candidate Standard Network Scan Service Semantic Model and Service Interface Version 1.0 [PWG5108.02-2009].

The subsections below describe the Storage subunit that is specific to the Resource Service.


761

5552

5553

555455555556

5557555855595560

55615562

762


17.2.2.1 Storage

(complex-Storage) Each storage subunit contains a StorageStatus element and a StorageDescription element.

Below is the XML Schema diagram of the Storage subunit.

Figure 173 Storage Subunit Schema

A Storage contains the elements described in the following sections.


763

5563

55645565

5566

5567

5568

5569

5570

764



Reference

Storage complexStorage Status complex

StorageIdint the unique identifier of

the storage subunit within the Resource Service instance.

StorageType keyword Type of storage Para 17.2.2.1.1StorageSize int total bytes allocatedStorageFree int bytes currently free for

useStorageIsRemovable Boolean Storage subunit removable

by design List of ##Other vendor’s extension points

Storage Description complex-StorageName string unique within a Resource

Service instance.StorageMake string manufacturerStorageModel string model nameStorageInfo string administrator settable

descriptionStorageDataEncryption boolean supports data encryptionList of ##Other vendor’s extension pointsStorageURI URI network location

17.2.2.1.1 StorageType

(keyword) This element indicates the type of the storage subunit. The allowed storage types are expanded from the IETF Host Resource MIB standard [RFC 2790] as in the following list:

RAM - Random access memory, NVRam - Non-volatile random access memory, e.g. flash memory (non-

removable flash), flash card (removable flash), ramDisk - Random access memory used as hard disk for secondary storage,


765

5571

5572

5573

557455755576

55775578557955805581

766


HardDisk - Non-removable, rigid, rotating storage, FloppyDisk - Non-rigid rotating magnetic storage, VirtualMemory - Temporary storage of swapped or paged memory, NetworkStorage - Any storage external to an MFD, CD - Compact disk. DVD - Digital versatile disk, OpticalDiskROM - Optical disk, Read only memory, OpticalDiskWORM - Write once read many optical disk, OpticalDiskRW - Read writable optical disk, Other (Any other vendor defined storage).

17.2.3 Resource Service Description

(complex-ResourceServiceDescription) The ResourceServiceDescription group element provides descriptive information for the Resource Service. The constituent elements are administratively set. The element values once set can be modified directly or indirectly through an operation of a Service or a management protocol such as WS-Management. Currently Resource Service does not define such administrative operations.

Note that Resource Service Description consists of two sequences. The first represents elements inherited from the Imaging Service super class and the second sequence includes Resource Service specific extensions.

Below is a view of the Description elements for the Resource Service.

Figure 174 Resource Service Description Schema


767

5582558355845585558655875588558955905591

5592

55935594559555965597

559855995600

5601

5602

5603

768


17.2.3.1 OwnerURI

(URI) This is the URI by which you can reach the administrator or owner who created the service.

17.2.3.2 OwnerVCard

(string) This is the vCard [RFC2426] of the owner of the Resource Service.

17.2.3.3 ResourcesSupported

(list of complex-AvailableResource) This attribute is not applicable to Resource Service. This is a Service specific view of the available resources used by a service. Note that the AvailableResources element at the MFD server’s top level contains installed resources on a specific MFD, not physical resources to be managed by Resource Service.

17.2.3.4 ServiceInfo

(string) This is descriptive information about this Resource Service the owner of the Service wishes to provide.

17.2.3.5 ServiceLocation

(string) This element describes the physical location of this Service. (Example: “Building 128 Floor 2 Room 210C")

17.2.3.6 ServiceName

(string) This is the end-user friendly name of the Resource Service.

17.2.3.7 ServiceURISupported

(list of URI) This REQUIRED element contains the URIs where the Resource Service is available.

17.2.3.8 Sequence of ##other

(list of any) This optional element contains extension points for vendor differentiation and implementation specific extensions while maintaining interoperability.

17.2.3.9 Attribute of ##other

(any) This is a REQUIRED vendor’s extension point for adding one single extra attribute to Resource description properties.


769

5604

56055606

5607

5608

5609

5610561156125613

5614

56155616

5617

56185619

5620

5621

5622

56235624

5625

56265627

5628

56295630

770


17.2.4 Resource Service Capability

(complex-ResourceServiceCapability) This element contains the ResourceDescriptionCapabilities group element which specifies the descriptive elements supported in the ResourceDescription of each ResourceEntry.

Below is the Schema diagram of ResourceServiceCapability.

Figure 175 Resource Service Capability Schema

17.2.4.1 List of ##other

(list of any) This optional list contains extension points for vendor differentiation and implementation specific extensions while maintaining interoperability.

17.2.4.2 Resource Description Capabilities

(complex-ResourceDescriptionCapabilities) This is a group of elements specifying the ResourceDescription elements (see section ) supported by the service.

DateTimeOfExpiration

(boolean) This Boolean valued element indicates whether the DateTimeOfExpiration element of ResourceDescription is supported by the service.


771

5631

563256335634

5635

5636

5637

5638

5639

56405641

5642

5643

56445645

5646

56475648

772


ElementsNaturalLanguage

(list of keyword) This element contains a sequence of AllowedValues that specify the supported natural languages for the ResourceDescription elements with a string syntax (example values: en-us, fr, de, ja) See [RFC4646]

ResourceCategory

(list of keyword) This element contains a sequence of AllowedValues that specify the supported keywords of the ResourceCategory element of the ResourceDescription. See section for example values of supported ResourceCategory.

ResourceCreatorUserName

(boolean) This element indicates the support of the ResourceCreatorUserName element of the ResourceDescription by the service.

ResourceFormat

(boolean) This element indicates the support of the ResourceFormat element of the ResourceDescription.

ResourceInfo

(boolean) This element indicates the support of the ResourceInfo element of the ResourceDescription.

ResourceName

(boolean) This element indicates the support of the ResourceName element of the ResourceDescription.

ResourceType

(list of keyword) This element contains a sequence of AllowedValues that specify the supported values of the ResourceType element of the ResourceDescription. See section for example values of supported ResourceType.

List of ##Other

This list contains an extension point for vendor differentiation and implementation specific extensions while

maintaining interoperability.


773

5649

565056515652

5653

565456555656

5657

56585659

5660

56615662

5663

56645665

5666

56675668

5669

567056715672

5673

56745675

5676

774


17.2.5 Resource Service Status

(complex-ResourceServiceStatus) The Status elements provide state information of the Resource Service. The states are maintained by automata and can not be directly set.

Note that ResourceServiceStatus consists of two sequences. The first represents elements inherited from the Imaging Service super class and includes elements such as Id and State. The second sequence includes Resource Service specific extensions to the super class such as the Resource Service counters.

Below is a view of the Status elements for the Resource Service.

Figure 176 Resource Service Status Schema

AccessModes


775

5677

56785679

5680568156825683

5684

5685

5686

5687

776


(list of keyword) This element corresponds to the access mode property of a POSIX file and specifies the basic access control policy for the Resource Service object, as set by the Owner. The AccessMode element takes precedence over any externally specified access policy; e.g., Access Control Lists (ACLs) MUST NOT reduce the security required by this AccessMode element but MAY further restrict that access.

The AccessMode element describes the basic access control policy for the Owner, members of the Owner's group (e.g., Administrators), and all other authenticated users (i.e., the 'World'). Typically, only the Owner or a member of the Owner's group (site-specific) is granted the Write permission, but the World is granted Read permission (e.g., to read elements such as capabilities). [CHMOD, STAT]

CreateDate

(dateTime) Date and Time the Service was created.

CurrentTime

(dateTime) This element indicates the current date and time according to the Resource Services internal clock

ID(int) A REQUIRED 32 bit Object Identifier for the Resource Service instance. It is unique within a Resource server.

IsAcceptingResources

(boolean) This element indicates whether this Resource Service is currently able to store or retrieve Resources. When the Service is NOT accepting resources, the Service MUST still be able to process requests for obtaining information on Service configuration, Service description, and Service status. How the value for this element is configured is implementation-specific, e.g., local console, web page.

NaturalLanguage

(string) Indicates the local language currently used by the Service. This is used unless the operation specifies a RequestedNaturalLanguage .

QueuedJobCount

(int) This element does not apply to Resource Service. This element specifies the number of requests the Service has currently accepted but not yet finished processing.

Resource Service Counters


777

56885689569056915692

5693

56945695569656975698

5699

5700

5701

57025703

57045705

5706

57075708570957105711

5712

57135714

5715

57165717

5718

778


(complex-ResourceServiceCounter) This element contains the counters for the amount of work performed by the Resource Service, timers covering utilization and monitoring information covering errors, warnings, traffic, resource counts and configuration changes. See PWG5106.1-2007.

SerialNumber

(string) This element specifies the serial number of the device hosting the service.

State

(keyword) This is an element of Resource Service Status. This REQUIRED element records the current state of the Resource Service instance. The state contains one of the following values:

From [RFC2911]:

Idle – The Resource Service is available and can start processing a new request.

Processing – The Resource Service is currently processing requests.

From [RFC2790]:

Unknown– The state of the Resource Service is not known.

Testing- The Resource Service is in testing or maintenance mode.

Down- The Resource Service is unavailable for Service requests.

Service State Diagram

All imaging services inherit the same Service state behavior.

The Service State Diagram is divided into three phases:

- <Init> - Unknown state - immediately after Service creation

- <Offline> - Down and Testing states - no user requests are processed

- <Online> - Idle and Processing states

See ‘Network Scan Service Semantic Model and Service Interface’ specification [PWG5108.02-2009] for the Service state diagram.


779

5719572057215722

5723

5724

5725

572657275728

5729

5730

5731

5732

5733

5734

5735

5736

5737

5738

5739

5740

5741

5742

57435744

780


17.2.6 Service State Transition Tables

The following notations are used in the two subsequent Service state transition tables:

~ = logical NOT (e.g., ~C.critical means "not critical")

C = prefix of a condition

E = prefix of an event (e.g., E.endRequest means "request completed")

titlecase = state (e.g., Idle), operation (e.g., Startup), or phase

lowercase = action function (in FSM)

error = In Table 2 indicates that an error response is returned to the requestor

In Table 3 indicates that an error message should be logged indicating an implementation error

The following notes are used in the two Service state transition tables:

(1) Startup and Restart

- Startup (Unknown/Init) sends E.startup and goes to (Down/Offline)

- Startup (Down/Offline) is a synonym for Restart

- Restart (Down/Offline) initializes and goes to (Idle/Online)

(2) Shutdown

- Shutdown (Testing|Idle) goes to (Down/Offline)

- Shutdown (Processing) sends E.shutdown and stays in (Processing)

(3) Testing

- Testing (Down) goes to (Testing/Offline)


781

5745

5746

5747

5748

5749

5750

5751

5752

5753

57545755

5756

5757

5758

5759

5760

5761

5762

5763

5764

5765

5766

5767

5768

5769

782


- Testing (Idle|Processing) is an error

General Notes :

1) C.isAcceptingResources represents the ability of the Service to retrieve, store, replace, and delete a resource (i.e. StoreResource will fail if ~C.isAcceptingResources). Other operations are not affected by this condition.

2) E.startRequest and E.endRequest refer to the event for starting and ending a resource transfer operation respectively. Resource transfer operations are StoreResource, RetrieveResource, ReplaceResource, and DeleteResource.

17.2.7 Service State Transition By Operations

SERVICE STATE MACHINE (Operations)

Input

State

Down Testing Idle Processing

Operation(Condition)

Action(new state)

Action(new state)

Action(new state)

Action(new state)

Disable error

disable

(~C.IsAcceptingResources)

disable(~C.IsAcceptingResources)

disable

(~C.IsAcceptingResources)

Enableerror

enable

(C.IsAcceptingResources)

enable


enable


Restart (Note 1)

restart (Idle)

restart (Idle)

restart (Idle)

restart (Idle)

Shutdown(Note 2) error

shutdown(Down)

shutdown(Down)

shutdown(Down)


783

5770

5771

5772

577357745775

5776

577757785779

5780

5781

784


Startup (Note 1)

restart (Idle) error error error

test

(Note 3)

test

(Testing)

test

(Testing) error error

17.2.8 Service State Transition By Events

SERVICE STATE MACHINE (Events)

Input

State

Down Testing IdleProcessing

Event(Condition)

Action(new state)

Action(new state)

Action(new state)

Action(new state)

E.critical C.critical C.critical C.critical C.critical

E.criticalCleared ~C.critical

~C.critical

~C.critical

~C.critical

E.endRequest(C.shutdown) error

shutdown

(down) error

shutdown(Down)

E.endRequest error(Testing) error

schedule

(Idle or Processing)

E.warningC.Warning

C.Warning

C.Warning

C.Warning

E.warningCleared ~C.War ~C.War ~C.Warn ~C.War


785

5782

5783

5784

786


ning ning ing ning

E.startRequest

(~C.isAcceptingResources) error

error


E.startRequest error

schedule

(Testing)

schedule

(Processing)

schedule

E.startup(Note 1)

restart(Idle) error error error

E.testing

(Note 3)(Testing)


E.testingCleared error (Down) error error


787

788


17.2.8.1 Detailed Service State Transition Diagram

Figure 177 Detailed Service Transition Diagram

State Messages

(complex-StateMessages) This element contains information about the Service State and StateReasons in human readable text. If the Service supports this element, it MUST be able to generate the messages in any of the natural languages supported by the Service.

StateReasons


789

5785

5786

5787

5788

578957905791

5792

790


(list of keyword) This element contains additional detail about the service's state. The standard keyword values are defined in §4.4.12 of [RFC2911]. Values of interest to a Resource Service include:

AttentionRequired ConnectingToDevice Deactivated None Other StorageFull StorageAlmostFull Shutdown TimedOut

List of ##other

(list of any) This element contains an extension point for vendor differentiation and implementation specific extensions while maintaining interoperability

17.2.9 Condition Table

(complex-ConditionTable) The Condition Table provides additional information on the current and past state of Subunits used by Resource Service. The contents of the tables are based on the Alert Table from the Printer MIB.


791

579357945795579657975798579958005801580258035804

5805

58065807

5808

580958105811

5812

792


Figure 178 Condition Table

17.2.9.1 Active Conditions

(complex-ActiveConditions) This is a REQUIRED element for ConditionTable. This element represents the Resource Service specific view of conditions (informational, warning or critical) that are currently in effect on the device. This is modeled by a list of DeviceConditions and an extension point for a manufacturer specific condition.


793

5813

5814

5815

5816581758185819

5820

794


Figure 179 Active Conditions

Device Condition

(list of complex-DeviceCondition) This is an unbounded list of device conditions each contains the attributes described in the following subsections.

Component

(complex-Component) This element indicates the origin of the condition that is represented by the class and the name of the origin component.

Group

(keyword) This element specifies the class of the component (e.g. subunit, service) that is the source of the condition. Allowed values include: Storages, Console, Finisher, InputChannel, InputTray, Interface, Interpreter, Marker, MediaPath, OutputChannel, OutputTray, ScanMediaPath, Scanner, VendorSubunit, CopyService, EmailInService, EmailOutService, FaxInService, FaxOutService, NetFaxInService, NetFaxOutService, PrintService, ScanService, ResourceService, TransformService.VendorSubunit. The only values applicable to Resource Service are Storages and ResourceService.


795

5821

5822

5823

5824

58255826

5827

58285829

5830

5831583258335834583558365837

796


Name

(string) This element specifies the instance of the component (e.g. subunit of resource service) that is the source of the condition. Values are taken from the Name element of the Group that is the source of the condition.

ConditionId

(int) This element is the unique identifier for the condition.

Name

(string) This element is the keyword that identifies the condition type. The values are the same values that are used for Service’s StateReasons (e.g. AttentionRequired, StorageFull, StorageAlmostFull, …, etc.) .

Severity

(keyword) This element is the keyword that identifies criticality of the condition (i.e. Informational, Warning, Critical)

Time

(dateTime) This element is the date and time the condition occurred.

##Other

(any) This is an extension point for manufacturer defined attributes for DeviceCondition.

17.2.9.2 Conditions History

(complex-ConditionHistory) This OPTIONAL table represents the conditions (informational, warning or critical) that have been cleared from the device. This element is an extension of the data type used by ActiveConditions. See above for the elements that are common. Only the ConditionHistory specific elements are explained below.


797

5838

583958405841

5842

5843

5844

584558465847

5848

58495850

5851

5852

5853

5854

5855

5856

5857585858595860

5861

798


Figure 180 Condition History

ClearTime

(dateTime) This element is the date and time the condition was removed from the ActiveConditions list.

17.2.10 Resource List

(complex-ResourceList or list of complex-ResourceEntry) There is at least one entry of Resource in this list. This list records Resources on which a Resource Service operation described in section Error: Reference source not found has completed. There is no implied requirement of the ordering of the resources in the list. Below is the top level schema diagram of the ResourceList.


799

5862

5863

5864

58655866

5867

58685869587058715872

800


Figure 181 ResourceList Top Level Schema

Resource Entry

(complex-ResourceEntry) As depicted in Figure 10, each Resource Entry contains Resource Description, and Resource Status.

Resource Description

(complex-ResourceDescription) Resource Description is a REQUIRED group element of the Resource Entry.


801

5873

5874

5875

58765877

5878

5879

5880

58815882

5883

802


Figure 182 Resource Description Schema

ResourceCategory

(keyword) This REQUIRED element specifies the resource category of the ResourceEntry. The allowed values are: Executable, Static, Template, and Other.

ResourceCreatorUserName

(string) This is the user name unique within a network domain; the user of which created the resource. This element may be used to associate with the resource access control policy for the resource creator set by an authorized administrator.

ResourceName

(string) This REQUIRED element is the name of the Resource that uniquely identifies a Resource within a unique Resource Service instance.

ResourceType

(keyword) This REQUIRED element specifies the type of MFD Resources manageable by a Resource Service. The list of keywords allowed for ResourceType are the union of allowed resource types from three categories:

(1) Executable Resource category that allows one of the two types:


803

5884

5885

5886

58875888

5889

589058915892

5893

58945895

5896

589758985899

5900

5901

804


Firmware,

Software.

(2) Static Resource category that allowed the following types:

Font,

Form,

Image,

Logo,

ICCProfile.

(3) Template category that allows one of the following types:

CopyDocument, CopyJob,

EmailInDocument, EmailInJob,

EmailOutDocument, EmailOutJob,

FaxInDocument, FaxInJob,

FaxOutDocument, FaxOutJob,

NetFaxInDocument, NetFaxInJob,

NetFaxOutDocument, NetFaxOutJob,

PrintDocument, PrintJob,

ScanDocument, ScanJob,

TransformDocument, TransformJob.

Each template type indicates the resource is a Job template or document template of a Job ticket or document ticket for a particular job-oriented MFD Service. A Job template or document template is a preconfigured Job ticket or document ticket representing a user’s intent for a particular Job or document respectively.


805

5902

5903

5904

5905

5906

5907

5908

5909

5910

5911

5912

5913

5914

5915

5916

5917

5918

5919

5920

5921

5922

5923

5924592559265927

806


Resource Format

(complex-ResourceFormat) This REQUIRED element represents the format of the data for the resource. It is a choice of either DocumentFormat (string) which contains a MIME type value, or ResourceNamespace which is the URI string (XML namespace) identifying the resource data model (XML Schema).

DocumentFormat MUST be an enumeration of MIME type which is pwg:DocumentFormat type. (sample values: application/octet-stream, application/pdf, application/postscript, application/vnd.pwg-xhtml-print+xml, application/vnd.hp-PCL, image/g3fax, image/jpeg, image/tiff, image/tiff-fx, text/html, text/plain, text/plain; charset=ISO-8859-1, text/plain; charset=US-ASCII, text/plain; charset=utf-8, unknown). See [rfc2911] §3.2.1.1 and [PWG5100.5] §9.1.12.

ResourceInfo

(string) This element allows an user to provide arbitrary descriptive text for the resource.

ElementsNaturalLanguage

(keyword) This element indicates the natural language currently used to generate the descriptive text used by some elements in Resource Description.

List of ##other

(list of any) This list provides extension points for manufacturers to extend the Resource Description properties while maintaining interoperability.

Resource Status

(complex) Resource Status is another REQUIRED group element of the Resource Entry. A Resource is successfully stored, retrieved, deleted, or updated at the completion of a Resource operation. There is no intermediate status (or state), nor state reason associated with those intermediate states.

At the success of a Resource operation, a Resource ID MUST be created by the Resource Service to uniquely identify the Resource stored in or retrieved from a resource storage location.

ResourceStatus contains an element of any type (##other) for vendor-specific differentiation or implementation extension while maintaining interoperability.

Below is the Schema diagram of Resource Status.


807

5928

5929593059315932

5933

593459355936593759385939

5940

5941

5942

59435944

5945

59465947

5948

5949595059515952

595359545955

59565957

5958

808


Figure 183 Resource Status Schema

DateTimeAtCreation

(dateTime) This element records the date and time when this resource was created by the Resource Service.

DateTimeAtLastUpdate

(dateTime) This element records the date and time when this resource was last updated by the Resource Service.

DateTimeOfExpiration

(dateTime) This element is settable only by an authorized administrator or through the RenewResource operation. It specifies the date and time this resource is to be expired.

At the time of Resource expiration, the Resource Service MUST choose either:

(1) delete the Resource, or

(2) Mark the Resource has expired by setting ResourceHasExpired to ‘true’ in the ResourceStatus element without deleting the Resource.

For security consideration, if (2) is chosen, the Resource Service MUST then:


809

5959

5960

5961

59625963

5964

59655966

5967

59685969

5970

5971

5972

59735974

5975

5976

810


(1) block all operations on the expired resource except for RenewResource operation.

(2) disallow any user (including administrator) to set any metadata element of the expired resource.

ResourceHasExpired

(Boolean) This REQUIRED element is automatically initialized to ‘false’ and set to ‘true’ by the Resource Service whenever the resource is expired, and the implementation choose not to delete the expired resource.

ResourceId

(int) This REQUIRED element uniquely identifies the Resource within the Service. The Service is responsible for implementing a Resource numbering scheme that will not allow two different Resources to coexist with the same ResourceId..

Key

(Boolean) The key is used to identify whether the ResourceId is the key of the Resource object.

List of ##other

(list of any) This list serves as extension points for the Resource Status properties while maintaining interoperability.


811

5977

59785979

5980

598159825983

5984

598559865987

5988

59895990

5991

59925993

5994

812


18. System Control ServiceThere is both a SystemControlService and a System Object in the Imaging Device Model. The distinction between them is that the System Object represents the Imaging Device as a whole and is the root container for all the Imaging Device attributes, components and services. The SystemControlService acts upon the System Object on behalf of SystemControl Clients to query the state of the System Object and to affect the System Object state through a well-defined set of operations

The SystemControlService fits within the Imaging Device model as one of a number of services that can be hosted on a multifunction device (i.e., System or System Object). One difference between the SystemControlService and other hosted services is that there can only be a single instance. Another difference is that that since this Service is not Job oriented there are no Jobs coming in or output produced and therefore no subordinate DefaultJobTicket or Capabilities. Since the SystemControlService provides a management interface for the entire Imaging Device, the mandatory SystemControlService is always active while the Imaging Device is available. (See [PWG5108.01])

18.1.1 SystemControlService Model

The Imaging Device supports exactly one SystemControlService (See Figure 184). A SystemControlService is hosted locally on an Imaging Device or remotely on another computer. The SystemControlService contains elements for SystemControlService status and description.

While the SystemControlService provides operations to obtain an Imaging Device wide view of the Subunits that are configured on the Imaging Device, they are not subordinate to the SystemControlService. The Subunits (i.e., SystemConfiguration) appear at the root of the model and are defined in §4.2.2.

The SystemControlServiceDescription group element includes descriptive information such as Service name and information, and has an extension point for vendor specific information. These description elements are settable by Administrators. The details of the SystemControlServiceDescription elements are specified in §18.1.2.

The SystemControlServiceStatus group element is an extension of SystemServiceStatus class that includes elements such as ID, state, state messages and state reasons. State messages are localized state reasons. The details of the elements in the SystemControlServiceStatus group are specified in §18.1.3.


813

5995

599659975998599960006001

600260036004600560066007600860096010

6011

6012601360146015

6016601760186019

6020602160226023

6024602560266027

814


Figure 184 SystemControlService

18.1.2 SystemControlServiceDescription

Figure 185 is a view of the SystemControlServiceDescription. SystemControlServiceDescription provides Descriptive information for the SystemControlService. The element values are administratively set. The element values can be modified directly or modified indirectly through an operation. The SystemControlServiceDescription group element includes descriptive information such as Service name and information, and has an extension point for vendor specific information. The MFD Model and Common Semantics specification [PWG5108.01] defines the SystemControlServiceDescription elements.


815

6028

6029

6030

60316032603360346035603660376038

6039

816


Figure 185 SystemControlServiceDescription

The elements common to all ServiceDescriptions are defined in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in the above diagram by being included in the yellow box. The remaining elements also are taken from ServiceDescription. These elements are defined in the MFD Model and Common Semantics specification [PWG5108.01].


817

6040

6041

60426043604460456046

818


18.1.3 SystemControlServiceStatus

Figure 186 is a view of the SystemControlService’s SystemControlServiceStatus. SystemControlServiceStatus provides state information for the SystemControlService. The elements values are maintained by automata and cannot be directly set. The element values can be modified indirectly through an operation. For example PauseAllServices operation on the SystemControlService may result in the change of the State and StateReasons elements.


819

6047

604860496050605160526053

6054

820


Figure 186 SystemControlServiceStatus

The elements common to all ServiceStatus are defined in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in the above diagram by being included in the yellow box. There are no elements specific to the SystemControlServiceStatus except the usual extension point (i.e., Any).

18.1.4 SystemControlService Operations

The SystemControlService provides a Service interface that is the same for a co-located local SystemControl Client or a Remote SystemControl Client via a local interface, a local area network, or the Internet. A user makes a SystemControlService request by interacting directly with the SystemControlService or indirectly through a local SystemControl Client via the Imaging Device UI or a Remote SystemControl Client via its software application UI.

Table 98 and Table 99 list the input and output parameters for the defined operations. Responses to operations that fail are expected to return a fault.

The semantics for these operations are similar to the operations specified in the MFD Model and Common Semantics specification [PWG5108.01]. One difference is that many of the operations affect all the hosted document related services instead of an individual service. In the tables below the required parameters are in bold and optional parameters are in normal font.

Notes for Table 98 follow Table 99

Table 98 Mandatory System Operations

User Operation Name


DisableAllServices 1 ElementsNaturalLanguage, Message, RequestingUserName

EnableAllServices 1 ElementsNaturalLanguage, Message, RequestingUserName

GetSystemElements ElementsNaturalLanguageRequested, RequestedElements, RequestingUserName

ElementsNaturalLanguage, System Elements,

ListAllServices ElementsNaturalLanguageRequested, , RequestingUserName

ElementsNaturalLanguage, List of Service


821

6055

6056605760586059

6060

6061

606260636064606560666067

60686069

60706071607260736074

6075

6076

822


User Operation Name


summary,

PauseAllServices 2 ElementsNaturalLanguage, Message, RequestingUserName

RestartAllServices 1,

5, 6, 7ElementsNaturalLanguage, IsAcceptingJobs | IsAcceptingResources, Message, RequestingUserName, StartServicePaused

RestartService 3, 4, 5, 6,

7ElementsNaturalLanguage, Id, IsAcceptingJobs | IsAcceptingResources, Message, RequestingUserName, ServiceType, StartServicePaused

ResumeAllServices 2 ElementsNaturalLanguage, Message, RequestingUserName

ShutdownAllServices 1

ElementsNaturalLanguage, Message, RequestingUserName

ShutdownService1, 8 ElementsNaturalLanguage, Id, Message, RequestingUserName ServiceType

StartupAllServices 1,

5, 6, 7ElementsNaturalLanguage, IsAcceptingJobs, Message, RequestingUserName, StartSystemPaused

StartupService 1, 5, 6, 7 ElementsNaturalLanguage, IsAcceptingJobs, Message, RequestingUserName ServiceType, StartServicePaused

Id

Notes for Table 99 follow Table 99

Table 99 Optional System Operations


823

6077

6078

6079

824




DeleteService 1, 8 Id, ElementsNaturalLanguage, Message, RequestingUserName, ServiceType

PauseAllServicesAfterCurrentJob 2 ElementsNaturalLanguage, Message, RequestingUserName

SetSystemElements ElementsNaturalLanguage, Message, OperationMode, RequestingUserName SystemElements

UnsupportedElements

Notes for Table 98 and Table 99:

1 The operations do not apply to the SystemControlService.

2 The operation only applies to Job based services (e.g., CopyService, FaxOutService, FaxInService, PrintService, ScanService, and TransformService),

3 When the target Service is the SystemControlService the implementation MUST restart the SystemControlService and MAY restart the other services as well.

4 When the target Service is the SystemControlService the implementation of the restart may be soft (i.e., affects software only) or hard (i.e., hardware and software reinitialized).

5 When the Service startup is complete the Service state is ‘Idle’ (See note 6). The Service will then follow the Service state model as defined in section 7.2.1 of [PWG5108.01]

6 When the operation contains the “StartServicePaused” parameter and it is set to ‘true’, the resulting Service state is ‘Stopped’ (i.e., transitions from ‘Down’ to ‘Idle’ then immediately to ‘Stopped’). The Service will then follow the Service state model as defined in section 7.2.1 of [PWG5108.01]

7 When the operation contains the “IsAcceptingJobs” or “IsAcceptingResources” parameter and it is set to ‘false’, the Service state is ‘Idle’ (See note 6). The Service will


825

6080

6081

6082

60836084

60856086

60876088

608960906091

6092609360946095

60966097

826


then follow the behaviors as defined in section 7.3.2.2 of [PWG5108.01] or section 8.2.1 of [PWG5108.03] respectively.

8 This operations results in an error when applied to the SystemControlService.

18.1.4.1 DeleteService

The DeleteService operation removes an instance of a service. The result is that all data associated with the Service is deleted and the Service can no longer be restarted. It is an error to specify a Service that is not shutdown or to specify the SystemControlService itself.

18.1.4.2 DisableAllServices

The DisableAllServices operation is consistent with the operation DisableService specified in [PWG5108.01]. If the requestor is determined to have proper access, the SystemControlService MUST accept this request and MUST set the IsAcceptingJobs/ IsAcceptingResources Element to ‘false’ for all hosted services. This operation does not affect the SystemControlService itself. This operation has no effect upon the Services’ State elements.

18.1.4.3 EnableAllServices

The EnableAllServices operation is consistent with the operation EnableService specified in [PWG5108.01]. If the requestor is determined to have proper access, the SystemControlService MUST accept this request and MUST set the IsAcceptingJobs/ IsAcceptingResources Element to ‘true’ for all hosted services. This operation has no effect upon the Services’ State elements. This operation does not affect the SystemControlService itself.

18.1.4.4 GetSystemElements

Unlike the GetServiceElements [PWG5108.01] operation that allows access to only the elements of the specified , the GetSystemElements operation allows a SystemControl Client to obtain detailed information about the System Object as well as the SystemControlService.

For the SystemControlService, this operation can request the elements directly below the SystemControlService element (e.g., ServiceDescription, ServiceStatus). This operation MUST NOT query information from any other Service.

For the System Object, this operation can request the elements directly below the System element (e.g., SystemConfiguration, SystemDescription, and SystemStatus).

The elements constitutingSystemConfiguration have a special representation. Some SystemConfiguration Subunits contain complex groups that have either “referenced” or “contained” associations. Examples of the two types of associations are represented in


827

60986099

6100

6101

6102610361046105

6106

610761086109611061116112

6113

611461156116611761186119

6120

6121612261236124

612561266127

61286129

613061316132

828


the simplified figure below (Figure 187). A referenced association is a pointer to another Subunit as shown for InputChannelInterface. For Subunits with a contained association, the constituents of the complex element (e.g., MarkerColorants) are fully contained within the Subunit (e.g., Marker). Table 100 list all the SystemConfiguration sub-elements with an association and their type.

When the GetSystemElements operation accesses a Subunit with a referenced association, it follows the reference and responds with the contained elements conceptually in that Subunit. This was done so that references would not have to be chased by SystemControl Client software and so that a Subunit element such as InputChannel would contain all its associated information. Note that this dereferencing is not done for the SetSystemElements operation; see § 7.4.15 for SetSystemElement’s handling of a referenced association.

Figure 187 Association Types

Table 100 SystemConfiguration sub-element associations


829

61336134613561366137

6138613961406141614261436144

6145

6146

6147

6148

6149

830


Element Name Association Type

FinisherSupply Contained

FinisherSupplyMediaInput Contained

InputChannelInterface Referenced

InputChannelDefaultJobControlLanguage

Referenced

InputChannelDefaultPageDescriptionLanguage

Referenced

MarkerColorant Contained

MarkerSupply Contained

OutputChannelInterface Referenced

OutputChannelDefaultJobControlLanguage

Referenced

18.1.4.5 ListAllServices

This operation is unique to the SystemControlService. This operation provides summary information on all Imaging Device hosted services including the SystemControlService. The response returns a ServiceSummary for each Service that includes Id, ServiceName, ServiceState, ServiceStateReasons for the service’s endpoint and other general information.

18.1.4.6 PauseAllServices

The PauseAllServices operation is consistent with the operation PauseService specified in [PWG5108.01]. If the requestor is determined to have proper access, the SystemControlService MUST accept this request and transition all the currently active Job based Services (e.g., CopyService, FaxOutService, FaxInService, PrintService, ScanService, TransformService) to the Stopped state. During the transition each ServiceStateReasons MUST contain the reason ‘MovingToPaused’. This operation does not affect the SystemControlService.


831

6150

6151

61526153615461556156

6157

6158615961606161616261636164

832


18.1.4.7 PauseAllServicesAfterCurrentJob

The PauseAllServicesAfterCurrentJob operation is consistent with the operation PauseServiceAfterCurrentJob specified in [PWG5108.01]. If the requestor is determined to have proper access, the SystemControlService MUST accept this request and transition all the currently active Job based Services (e.g., CopyService, FaxOutService, FaxInService, PrintService, ScanService, TransformService) to the Stopped state in an orderly manner. During the transition each ServiceStateReasons MUST contain the reason ‘MovingToPaused’. No pending jobs may be scheduled and all processing jobs will complete. This operation does not affect the SystemControlService.

18.1.4.8 RestartAllServices

The RestartAllServices operation is consistent with the operation RestartService specified in [PWG5108.01]. This operation does not affect the SystemControlService. If the requestor is determined to have proper access, the SystemControlService MUST accept this request and MUST reinitialize all hosted services, except the SystemControlService. This includes setting the State to ‘Idle’, clearing the StateReasons Element and setting the IsAcceptingJobs/IsAcceptingResources Element to ‘true’ if applicable. Note that parameters control subsequent Service behavior (See the last paragraph in this section). When the Service startup is complete the Service state is ‘Idle’ (See below). The Service will then follow the Service state model as defined in section 7.2.1 of [PWG5108.01].

When the operation contains the “StartServicePaused” parameter and it is set to ‘true’, the resulting Service state is ‘Stopped’ (i.e., transitions from ‘Down’ to ‘Idle’ then immediately to ‘Stopped’). The Service will then follow the Service state model as defined in section 7.2.1 of [PWG5108.01]. When the operation contains the “IsAcceptingJobs” or “IsAcceptingResources” parameter and it is set to ‘false’, the Service state is ‘Idle’ (See note 6). The Service will then follow the behaviors as defined in section 7.3.2.2 of [PWG5108.01] or section 8.2.1 of [PWG5108.03] respectively. Parameters that do not apply to target Service are silently ignored.

18.1.4.9 RestartService

The RestartService operation is consistent with operation RestartService specified in [PWG5108.01]. If the requestor is determined to have proper access, the SystemControlService MUST accept this request and MUST reinitialize the specified Service State to ‘Idle’, clear the StateReasons Element and set the IsAcceptingJobs/IsAcceptingResources Element to ‘true’ if applicable. Note that parameters control subsequent Service behavior (See the last paragraph in this section). When the Service startup is complete the Service state is ‘Idle’ (See below). The Service will then follow the Service state model as defined in section 7.2.1 of [PWG5108.01]. This operation can specify any Service including the SystemControlService.

When the SystemControlService is the target of this operation the system behavior is implementation specific. The implementation may reinitialize the existing Service or


833

6165

61666167616861696170617161726173

6174

617561766177617861796180618161826183

61846185618661876188618961906191

6192

619361946195619661976198619962006201

62026203

834


shutdown and instantiate the SystemControlService. It is also implementation specific whether or not restarting the SystemControlService also causes a restart of all the other hosted services.

When the operation contains the “StartServicePaused” parameter and it is set to ‘true’, the resulting Service state is ‘Stopped’ (i.e., transitions from ‘Down’ to ‘Idle’ then immediately to ‘Stopped’). The Service will then follow the Service state model as defined in section 7.2.1 of [PWG5108.01]. When the operation contains the “IsAcceptingJobs” or “IsAcceptingResources” parameter and it is set to ‘false’, the Service state is ‘Idle’ (See note 6). The Service will then follow the behaviors as defined in section 7.3.2.2 of [PWG5108.01] or section 8.2.1 of [PWG5108.03] respectively. Parameters that do not apply to target Service are silently ignored.

18.1.4.10 ResumeAllServices

The ResumeAllServices operation is consistent with the operation ResumeService specified in [PWG5108.01]. If the requestor is determined to have proper access, the SystemControlService MUST accept this request and transition every Job based Service (e.g., CopyService, FaxOutService, FaxInService, PrintService, ScanService, and TransformService) to the ‘Idle’ state. The Service will then follow the Service state model as defined in section 7.2.1 of [PWG5108.01]. This operation does not affect the SystemControlService.

18.1.4.11 ShutdownAllServices

The ShutdownAllServices operation is consistent with the operation ShutdownService specified in [PWG5108.01]. If the requestor is determined to have proper access, the SystemControlService MUST accept this request and forces each of the services, except the SystemControlService, to the ‘Down’ state from any state that it is in, in an orderly manner. This operation does not affect the SystemControlService itself.

18.1.4.12 ShutdownService

The ShutdownService operation is consistent with the operation ShutdownService specified in [PWG5108.01]. If the requestor is determined to have proper access, the SystemControlService MUST accept this request and force the specified Service to the ‘Down’ state from any state that it is in, in an orderly manner. It is an error to specify the SystemControlService itself.

18.1.4.13 StartupAllServices

The StartupAllServices operation initializes all the shutdown services and takes them through the ‘Down’ state to ‘Idle’, assuming that there are no inhibiting conditions See sections 7.2.1 of [PWG5108.01]. If the requestor is determined to have proper access, the SystemControlService MUST accept this request and initializes each of the services,


835

620462056206

62076208620962106211621262136214

6215

6216621762186219622062216222

6223

62246225622662276228

6229

62306231623262336234

6235

6236623762386239

836


except the SystemControlService. This operation does not affect the SystemControlService itself.

18.1.4.14 StartupService

The StartupService operation creates a new instance of the specified Service type and takes it through the ‘Down’ state to ‘Idle’, assuming that there are no inhibiting conditions See section 7.2.1 of [PWG5108.01]. If the requestor is determined to have proper access, the SystemControlService MUST accept this request, create a new instance and initialize the Service of the specified type. It is an error to specify the SystemControlService type.

18.1.4.15 SetSystemElements

Unlike the SetServiceElements [PWG5108.01] operation, the SetSystemElements operation allows a SystemControl Client to modify information about the System Object as well as the SystemControlService Elements.

For the SystemControlService, this operation can set the SystemControlService’s settable elements (i.e., elements in ServiceDescription and none in ServiceStatus). This operation MUST NOT set elements from any other Service (i.e. any other Service under the Services element at the System root).

For the System Object, this operation can set settable elements the elements directly below the System element (i.e., elements in SystemConfiguration and SystemDescription but not in SystemStatus). The SystemConfiguration element in a SetSystemElements operation has additional rules and an alternative syntax.

The alternative syntax for SystemConfiguration permits schema enforcement of setting only a few elements within a SystemConfiguration element. Although an element may be mandatory in the model, the SetSystemElements operation need not contain a mandatory element unless it is the element being set.

An alternative syntax is also used when an element is a reference to another element instead of a contained element (e.g., InputChannelInterface in System.SystemConfiguration.InputChannels.InputChannel). See § 18.1.4.4 for a discussion of elements with referenced associations versus elements with contained association. For simplicity and convenience of the GetServiceElements operation, when accessing an element with a referenced association to another element, the entire referenced element is replicated in place. Thus there is no need to use the reference identifier and make another query to obtain the information. However when the SetSystemElements operation acts upon an element with a referenced association, it action is to modify the reference identification and not the referenced element. Therefore when a SetSystemElements operation modifies an element with a referenced association, the element value will be an integer that corresponds to the identifier of the referenced element. To modify the referenced element itself, the elements themselves (e.g., Interface


837

62406241

6242

62436244624562466247

6248

624962506251

6252625362546255

6256625762586259

6260626162626263

6264626562666267626862696270627162726273627462756276

838


in System.SystemConfiguration.Interfaces) are modified using the SetSystemElements operation.

Table 101 SetSystemElements Contained/Referenced Datatypes

Element Name Parent Element Name

Association Type

Name in SetSystemElements

Syntax in SetSystemElements

FinisherSupply Finisher Contained FinisherSupply FinisherSupplySet Type

FinisherSupplyMediaInput

FinisherSupply

Contained FinisherSupplyMediaInput

FinisherSupply MediaInputSetType

InputChannelInterface

InputChannel

Referenced

InputChannelInterfaceId

Integer

InputChannelDefaultJob ControlLanguage

InputChannel

Referenced

InputChannelDefaultJob ControlLanguageId

Integer

InputChannelDefaultPage DescriptionLanguage

InputChannel

Referenced

InputChannelDefaultPageDescriptionLanguageId

Integer

MarkerColorant Marker Contained MarkerColorant MarkerColorantSet Type

MarkerSupply Marker Contained MarkerSupply MarkerSupplySet Type

OutputChannelInterface

OutputChannel

Referenced

OutputChannelInterfaceId

Integer

OutputChannelDefaultJob ControlLanguage

OutputChannel

Referenced

OutputChannelDefaultJob ControlLanguageId

Integer

The SetSystemElements operation has some special rules when setting a virtual row in a virtual table. In the Printer MIB these rows are represented as rows. In the schema associated with this specification the table is represented as an element whose name


839

62776278

6279

6280

6281

628262836284

840


ends in ‘s’ (e.g., Finishers, InputChannels, Interfaces) that contains multiple instances of the element itself (e.g., Finisher, InputChannel, Interface). The elements in the row that can be directly set by an authorized client are grouped together in a Description element and the elements that are maintained by automata or can only be modified by a first class operation are grouped together in the Status element. When setting a row in a table the request MUST be limited to operate only on the one row in one table. It is an error to include multiple rows or to include elements not part of the row. The alternative schema for the SetSystemElements enforces this by limiting the element that represents rows to a single instance. Where applicable a choice construct is used to insure that when a row is the target of the operation no other elements can be included in the request.


841

6285628662876288628962906291629262936294

6295

842


19. Conformance RequirementsThis Document does not define the model of any particular Imaging Service but rather defines Elements, terms, concepts and operations common to several Imaging Service Models. Conformance requirements applicable to each Service Model are defined in the specification for that Service Model.

37. Imaging Service Model and MFD System Model specifications MUST import the definitions of Elements, terms and semantics from this specification.

38.Although when necessary, those Imaging Service Model and the MFD System Model specifications may define new Elements, terms or concepts, they MUST NOT attempt to redefine, alter or even restate any of the Elements, terms or semantics defined in this specification.

.

20. Internationalization ConsiderationsAll Element values defined by enumeration (e.g., State) represent keywords. Keywords are never localized by the device. The client may convert the values into a form acceptable to the client. This includes not only localization but also transformations into graphical representation. The Elements with an extensible list of keyword are represented by the union of an enumeration of keywords and a pattern for new values.

Some of the Elements have values that are Service-generated strings (e.g., State Messages). In each operation request, the client identifies a natural language that affects the Service generated strings returned by the Service in operation responses. The Service MUST provide the localized value as requested by the user for any supported natural languages. A request for a language not supported results in a response with the string in the default localization.

The final category of string values are those supplied by administrator or End User (e.g., JobName). No localization is performed on these strings and they are returned in operation responses as set by the administrator or End User.

For interoperability and basic support for multiple languages, conforming implementations MUST support the UTF-8 [RFC3629] encoding of Unicode [UNICODE] [ISO10646].

21. Security ConsiderationsThe exact security model for MFD’s and implementation are out-of-scope for this specification. The IEEE 2600™-2008 standard [IEEE2600] defines security requirements for manufacturers, administrators, and others in the selection, installation, configuration,


843

6296

6297629862996300

630163026303630463056306

6307

6308

63096310631163126313

631463156316631763186319

632063216322

63236324

6325

632663276328

844


and usage of hardcopy devices, including MFDs. The common security considerations for all MFD Imaging Services outlined in the Imaging Service Model Requirements [MFD-REQ] are intended to support the IEEE 2600™-2008 standard. Implementations must preserve the Imaging Service Model semantics when addressing security considerations and requirements.

Security considerations specific to each Imaging Service are discussed in the specification for the corresponding Service Model.

.

22. IANA ConsiderationsProvide IANA registration information for this specification.

Subsections include IANA registration templates using the Example style:

Some IANA registration text.

23. PWG Registration ConsiderationsThis specification and the associated schema will require an update to register extensions to the Imaging Service model. Vendors may use extensions in their own namespace until such time as an update to the specification is under review. At that time the extension can be registered with the PWG and included in the PWG standard.

24. References

24.1 Normative References

[CIM-PRINTER]

DMTF CIM Schema Printer class CIM_ Printer.mof in any version of [CIM-SCHEMA]

[DCMI]

DUBLIN CORE METADATA INITIATIVE, "DUBLIN CORE METADATA REGISTRY, 1995-2011, http://dcmi.kc.tsukuba.ac.jp/dcregistry/

[CIM-SCHEMA]

DMTF CIM Schema Repository http://dmtf.org/standards/cim


845

63296330633163326333

63346335

6336

6337

6338

6339

6340

6341

6342634363446345

6346

6347

6348

6349

6350

6351

63526353

6354

6355

846

http://dmtf.org/standards/cim

http://dcmi.kc.tsukuba.ac.jp/dcregistry/


[DSP0004]

DMTF Common Information Model (CIM) Infrastructure, DSP0004, March 2010, http://dmtf.org/sites/default/files/standards/documents/DSP0004_2.6.0_0.pdf

[IANA-FIN]

IANA FINISHER MIB (ORIGINALLY PUBLISHED IN RFC 3806), June 2004, R. Bergman, H. Lewis, I. McDonald, n http://www.iana.org/assignments/ianafinisher-mib

[IANA-PRT]

IANA PRINTER MIB (ORIGINALLY PUBLISHED IN RFC 3805), June 2004, R. Bergman, H. Lewis, I. McDonald, http://www.iana.org/assignments/iana Printer-mib

[IEEE2600]

IEEE 2600™-2008 IEEE Standard for Information Technology: Hardcopy Device and System Security, 2008

[IPPREG]

IANA “INTERNET PRINTING PROTOCOL (IPP) REGISTRATIONS”, December 2011, http://www.iana.org/assignments/ipp-registrations/ipp-registrations.xml

[MFD-REQ]

PWG Multifunction Device Service Model Requirements, September, 2010, N. Chen, I. McDonald, W. Wagner, P. Zehler, ftp://ftp.pwg.org/pub/pwg/informational/req-mfdreq10-20100901.pdf

[MFD_SCHEMA]

PWG Semantic Model Schema v1.127, P. Zehler, I. McDonald, Namespace:http://www.pwg.org/schemas/2011/3/sm/ ftp://ftp.pwg.org/pub/pwg/mfd/schemas/PWG_SM2_ver_1.127.zip

[PWG5100.1]

PWG 5100.1-2001, "Internet Printing Protocol (IPP): “finishings” attribute values extension ", February 5, 2001, T. Hastings, D. Fullman, ftp://ftp.pwg.org/pub/pwg/candidates/cs-ippfinishings10-20010205-5100.1.pdf


847

6356

635763586359

6360

636163626363

6364

63656366

6367

63686369

6370

637163726373

6374

637563766377

6378

637963806381

6382

6383638463856386

848

ftp://ftp.pwg.org/pub/pwg/candidates/cs-ippfinishings10-20010205-5100.1.pdf

ftp://ftp.pwg.org/pub/pwg/candidates/cs-ippfinishings10-20010205-5100.1.pdf

ftp://ftp.pwg.org/pub/pwg/mfd/schemas/PWG_SM2_ver_1.127.zip

ftp://ftp.pwg.org/pub/pwg/informational/req-mfdreq10-20100901.pdf

http://www.iana.org/assignments/ipp-registrations/ipp-registrations.xml

http://www.iana.org/assignments/ipp-registrations/ipp-registrations.xml

http://www.iana.org/assignments/ianaprinter-mib

http://www.iana.org/assignments/ianafinisher-mib

http://www.iana.org/assignments/ianafinisher-mib

http://dmtf.org/sites/default/files/standards/documents/DSP0004_2.6.0_0.pdf

http://dmtf.org/sites/default/files/standards/documents/DSP0004_2.6.0_0.pdf


[PWG5100.2]

PWG 5100.2-2001, "Internet Printing Protocol (IPP): “output-bin” attribute extension ", February 7, 2001, T. Hastings, R. Bergman, ftp://ftp.pwg.org/pub/pwg/candidates/cs-ippoutputbin10-20010207-5100.2.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-ippprod Print10-20010212-5100.3.pdf

[PWG5100.4]

PWG 5100.4-2001, "Internet Printing Protocol (IPP): Override Attributes for Documents and Pages ", February 7, 2001, K. Ocke, R. Herriot, ftp://ftp.pwg.org/pub/pwg/candidates/cs-ippoverride10-20010207-5100.4.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

[PWG5100.6]

PWG 5100.6-2003, Standard for The Internet Printing Protocol (IPP): Page Overrides”, October 31, 2003, P. Zehler, R. Herriot, K. Ocke, ftp://ftp.pwg.org/pub/pwg/candidates/cs-ipppageoverride10-20031031-5100.6.pdf

[PWG5100.7]

PWG 5100.7-2003, Standard for The Internet Printing Protocol (IPP): Job Extensions”, October 31, 2003, T. Hastings, P. Zehler, ftp://ftp.pwg.org/pub/pwg/candidates/cs-ippjobext10-20031031-5100.7.pdf

[PWG5100.10]

PWG 5100.10-2009, "The Internet Printing Protocol Version 2.0", 31 July 2009, R. Bergman, H. Lewis, I. McDonald, M. Sweet, ftp://ftp.pwg.org/pub/pwg/candidates/cs-ipp20-20090731-5100.10.pdf


849

6387

6388638963906391

6392

6393639463956396

6397

6398639964006401

6402

6403640464056406

6407

6408640964106411

6412

6413641464156416

6417

641864196420

850

ftp://ftp.pwg.org/pub/pwg/candidates/cs-ipp20-20090731-5100.10.pdf

ftp://ftp.pwg.org/pub/pwg/candidates/cs-ippjobext10-20031031-5100.7.pdf

ftp://ftp.pwg.org/pub/pwg/candidates/cs-ippjobext10-20031031-5100.7.pdf

ftp://ftp.pwg.org/pub/pwg/candidates/cs-ipppageoverride10-20031031-5100.6.pdf

ftp://ftp.pwg.org/pub/pwg/candidates/cs-ipppageoverride10-20031031-5100.6.pdf

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

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

ftp://ftp.pwg.org/pub/pwg/candidates/cs-ippoverride10-20010207-5100.4.pdf

ftp://ftp.pwg.org/pub/pwg/candidates/cs-ippoverride10-20010207-5100.4.pdf

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

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

ftp://ftp.pwg.org/pub/pwg/candidates/cs-ippoutputbin10-20010207-5100.2.pdf

ftp://ftp.pwg.org/pub/pwg/candidates/cs-ippoutputbin10-20010207-5100.2.pdf


[PWG5100.11]

PWG 5100.11-2010 “IPP Job and Printer Extensions Set 2 (JPS2)”, 30 October 2010, T. Hastings, D. Fullman, ftp://ftp.pwg.org/pub/pwg/candidates/cs-ippjob Printerext10-20101030-5100.11.pdf

[PWG5101.1]

PWG 5101.1-2002 Media Standardized Names, February 26, 2002, R. Bergman, T. Hastings, ftp://ftp.pwg.org/pub/pwg/candidates/cs-pwgmsn10-20020226-5101.1.pdf

[PWG5101.2]

PWG 5101.2-2004, "The Printer Working Group (PWG) RepertoireSupported Element", February 1, 2004, H. Lewis, et al, ftp://ftp.pwg.org/pub/pwg/candidates/cs-crrepsup10-20040201-5101.2.pdf

[PWG5105.1]

PWG 5101.2-2004, " Printer Working Group (PWG) Semantic Model ", February 1, 2004, P.Zehler, T. Hastings, S. Albright, ftp://ftp.pwg.org/pub/pwg/candidates/cs-sm10-20040120-5105.1.pdf

[PWG5106.1]

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

[PWG5106.2]

PWG 5106.2-2006 “Web-based Imaging Management Service V1.0/Abstract Protocol, April 21, 2006. H. Lewis, I. McDonald and W. Wagner, ftp://ftp.pwg.org/pub/pwg/candidates/cs-wims10-20060421-5106.2.pdf

[PWG 5106.4]

PWG 5106.4-2011 “Power Management Model for Imaging Systems 1.0”, February 14, 2011, I. McDonald, ftp://ftp.pwg.org/pub/pwg/candidates/cs-wimspower10-20110214-5106.4.pdf


851

6421

642264236424

6425

642664276428

6429

6430643164326433

6434

643564366437

6438

6439644064416442

6443

644464456446

6447

644864496450

6451

6452

852

ftp://ftp.pwg.org/pub/pwg/candidates/cs-wimspower10-20110214-5106.4.pdf

ftp://ftp.pwg.org/pub/pwg/candidates/cs-wimspower10-20110214-5106.4.pdf

ftp://ftp.pwg.org/pub/pwg/candidates/cs-wims10-20060421-5106.2.pdf

ftp://ftp.pwg.org/pub/pwg/candidates/cs-wimscount11-20070427-5106.1.pdf

ftp://ftp.pwg.org/pub/pwg/candidates/cs-wimscount11-20070427-5106.1.pdf

ftp://ftp.pwg.org/pub/pwg/candidates/cs-sm10-20040120-5105.1.pdf

ftp://ftp.pwg.org/pub/pwg/candidates/cs-crrepsup10-20040201-5101.2.pdf

ftp://ftp.pwg.org/pub/pwg/candidates/cs-crrepsup10-20040201-5101.2.pdf

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

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

ftp://ftp.pwg.org/pub/pwg/candidates/cs-ippjobprinterext10-20101030-5100.11.pdf

ftp://ftp.pwg.org/pub/pwg/candidates/cs-ippjobprinterext10-20101030-5100.11.pdf


[PWG5108.2]

PWG 5108.2-2009, Network Scan Service Semantic Model and Service Interface v1.0", 10 April 2009, N.Chen, P. Zehler, ftp://ftp.pwg.org/pub/pwg/candidates/cs-sm20-scan10-20090410-5108.02.pdf

[RFC 1696]

RFC 1696, “Modem Management Information Base (MIB) using SMIv2”, August 1994, J. Barnes, L. Brown, R. Royston, S. Waldbusser, ftp://ftp.RFC-editor.org/in-notes/RFC1896.txt

[RFC2119]

RFC 2119, “Key words for use in RFCs to Indicate Requirement Levels”, March 1997, S. Bradner, ftp://ftp.RFC-editor.org/in-notes/RFC2119.txt

[RFC2396]

RFC 2396, “Uniform Resource Identifiers (URI): Generic Syntax”, August 1998, T. Berners-Lee, R. Fielding, L. Masinter, ftp://ftp.RFC-editor.org/in-notes/RFC2396.txt

[RFC2426]

RFC 2426, “vCard MIME Directory Profile”, September 1998, F. Dawson, T. Howes, www.ietf.org/RFC/RFC2426.txt

[RFC2617]

RFC 2617, “HTTP Authentication: Basic and Digest Access Authentication“June 1999, ,J. Franks, P. Hallam-Baker, J. Hostetler, S. Lawrence, P. Leach, A. Luotonen, L. Stewart, http://www.ietf.org/RFC/RFC2617.txt

[RFC 2790]

RFC 2790, “Host Resources MIB, March 2000, S. Waldbusser, P. Grillo, http://www.ietf.org/RFC/RFC3805.txt

[RFC 2863]

RFC 2863, “The Interfaces Group MIB”, June 2000, K. McCloghrie, F. Kastenholz, http://www.ietf.org/RFC/RFC2863.txt

[RFC2911]


853

6453

6454645564566457

6458

645964606461

6462

64636464

6465

646664676468

6469

64706471

6472

647364746475

6476

64776478

6479

64806481

6482

854

http://www.ietf.org/rfc/rfc2863.txt


http://www.ietf.org/RFC/RFC2617.txt


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





ftp://ftp.pwg.org/pub/pwg/candidates/cs-sm20-scan10-20090410-5108.02.pdf

ftp://ftp.pwg.org/pub/pwg/candidates/cs-sm20-scan10-20090410-5108.02.pdf


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

[RFC3066]

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

[RFC3192]

RFC 3192 “Minimal FAX address format in Internet Mail”, October, 2001, C. Allocchio. http://www.ietf.org/RFC/RFC3192.txt

[RFC3380]

RFC 3380 “Internet Printing Protocol (IPP): Job and Printer Set Operations”, September 2002, C. Kugler, H. Lewis, T. Hastings, R. Herriot, http://www.ietf.org/RFC/RFC3380.txt

[RFC 3805]

RFC 3805, “ Printer MIB v2”, June 2004, R. Bergman, H. Lewis, I. McDonald, http://www.ietf.org/RFC/RFC3805.txt

[RFC 3806]

RFC 3806, “ Printer Finishing MIB”, June 2004, R. Bergman, H. Lewis, I. McDonald, http://www.ietf.org/RFC/RFC3806.txt

[RFC3986]

RFC3986, “Uniform Resource Identifier (URI): Generic Syntax”, January 2005, T. Berners-Lee, R. Fielding, L. Masinter, http://www.ietf.org/RFC/RFC3986.txt

[RFC3998]

RFC 3998 “Internet Printing Protocol (IPP): Job and Printer Administrative Operations”, March 2005, C. Kugler, H. Lewis, T. Hastings, http://www.ietf.org/RFC/RFC3998.txt

[RFC4122]

RFC 4122 “A Universally Unique IDentifier (UUID) URN Namespace”, July 2005, P. Leach, M. Mealling, R. Salz, http://www.ietf.org/RFC/RFC4122.txt

[RFC4355]


855

648364846485

6486

64876488

6489

64906491

6492

649364946495

6496

64976498

6499

65006501

6502

65036504

6505

650665076508

6509

65106511

6512

856












RFC4355, “IANA Registration for Enumservices email, fax, mms, ems, and sms”, January 2006, R. Brandner, L. Conroy, R. Stastny, http://www.ietf.org/RFC/RFC4355.txt

[RFC4556]

RFC 4556, “Public Key Cryptography for Initial Authentication in Kerberos (PKINIT)” June 2006, L. Zhu, B. Tung, http://www.ietf.org/RFC/RFC4556.txt

[RFC4648]

RFC 4648, “The Base16, Base32, and Base64 Data Encodings”, October 2006, S. Josefsson, http://www.ietf.org/RFC/RFC4648.txt

[RFC5870]

RFC 5870, “A Uniform Resource Identifier for Geographic Locations ('geo' URI)”, June 2010, A. Mayrhofer, C. Spanring, http://www.ietf.org/RFC/RFC5870.txt

[W3C-XSD1]

XML Schema Part 1: Structures Second Edition W3C Recommendation, 28 October 2004, H. Thompson, D. Beech, M. Maloney, N. Mendelsohn, http://www.w3.org/TR/xmlschema-1/

[W3C-XSD2]

XML SCHEMA PART 2: DATATYPES SECOND EDITION, 28 OCTOBER 2004, P. BIRON, A. MALHOTRA, http://www.w3.org/TR/xmlschema-2/

[WS-Scan]

“Scan Service DefinitionVersion 1.0 For Web Services on Devices”, November 2006, Microsoft, M.Fenelon, http://www.microsoft.com/whdc/connect/rally/wsdspecs.mspx

24.2 Informative References

[REFERENCE] F. Last author list or standards body, "Title of referenced document", Document Number, Month YYYY, URL (if any)

25. Authors' AddressesWilliam A Wagner


857

651365146515

6516

65176518

6519

65206521

6522

652365246525

6526

652765286529

6530

65316532

6533

653465356536

6537

65386539

6540

6541

858

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

http://www.w3.org/TR/xmlschema-2/

http://www.w3.org/TR/xmlschema-1/






Technical Interface Consulting

Email: [email protected]

Voice: (978)251-4565

Peter Zehler

Xerox Research Center Webster

Email: [email protected]

Voice: (585) 265-8755

Fax: (585) 265-7441

US Mail: Peter Zehler

Xerox Corp.

800 Phillips Rd.

M/S 128-25E

Webster NY, 14580-9701

The authors would also like to thank the following individuals for their contributions to this standard:

Nancy Chen, OkiDataLee Farrell Ira McDonald, High NorthAnd other members of the PWG MFD Working Group


859

6542

6543

6544

6545

6546

6547

6548

6549

6550

6551

6552

6553

6554

6555

6556

6557655865596560656165626563

860




26. Appendix A: PWG SMv2 Elements’ Semantic information Table 81 provides information about all the PWG Semantic Model v2 elements. Included in the information is the element’s name, whether or not it can have multiple values, its syntax and a brief description of its semantics. Included in the brief description for elements with syntax of Keyword are some example values. A description of the Group and Constraint fields is included below. Each entry includes a reference to the standard and section number that provides the authoritative details for the element.

Group: 1 – Document Processing2 – Job Description3 – Job Processing4 – Document Description (multi-document Job only) 5 –Service Description6 - Operational

Constraint:Type2 and Type3 keywords are defined in [rfc2911] §6.1. These are extensible keywords with different registration requirements. All keywords can be extended with vendor or site specific extensions [PWG5108.1] §10. Other constraints include integer ranges or string length.

Table 102 PWG SMv2 Element Summary


Description (values)

AutoExposure No Boolean N/A 1 [PWG5108.02] § 8.1.3.1.11.1

When selected automatic background reduction will be performed on the image. (Included in Exposure)

AutoSkewCorrection No Boolean N/A 1 [PWG5108.02] § 8.1.3.1.3

Indicates if detection and correction of small skew orientation error from the media loading

from the ADF or placement on the platen by the user is to be applied

Brightness No Integer -100:100 1 [PWG5108.02] § 8.1.3.1.11.2


861

6564

656565666567656865696570

65716572657365746575657665776578

65796580658165826583

6584

862


Fix the references for newer or final versions.




Specifies the relative amount to enhance or reduce the brightness of the image. Negative values will darken the Image. (Included in Exposure)

ColorEntry No Keyword Type2 1 [PWG5108.02] § 8.1.3.1.4

This element describes the color processing mode. Each keyword describes a color encoding, color space, bit depth and samples per pixel combination. Values: ColorEntryWKV, KeywordNsExtensionPattern (e.g., Grayscale16, RGBa32, CMYK64)

Compression No Keyword Type2 2,4 [RFC2911] §3.2.1.1

Client specified compression algorithm used for the Document’s Data. Values: CompressionWKV, KeywordNsExtensionPattern (e.g., Compress, Deflate, Gzip, None)

CompressionSupplied No Keyword Type2 2,4 [PWG5100.7] §5.2.1

Default compression algorithm used for the all the Job’s Document Data. Values: CompressionWKV, KeywordNsExtensionPattern (e.g., Compress, Deflate, Gzip, None)

CompressionQualityFactor No Integer 0:100 1 [PWG5108.02] § 8.1.3.1.6

a normalized integer value used by JPEG compression to determine the amount of

acceptable image loss. The higher the requested compression factor the smaller the resulting file size.

ContentType No Keyword Type2 1 [PWG5108.02] § 8.1.3.1.4

This element describes the main characteristics of the original Document. Values: ContentTypeWKV, KeywordNsExtensionPattern (e.g., Auto, Text, Photo)

Contrast No Integer -100:100 1 [PWG5108.02] § 8.1.3.1.11.3

Specifies the relative amount to enhance or reduce the contrast of the image. Negative values will reduce the apparent difference between light and dark pixels in the image. (Included in Exposure)

Copies No Integer 1:MAX 1,3 [rfc2911] §4.2.5

The number of copies of the associated Document(s) to be Printed. (See also JobCopies)


863

864




CoverBack No complex Type2 1 [PWG5100.3] §3.1

The back cover to apply this Document. (Contains Media/MediaType or MediaCol, CoverType) (See also Job CoverBack)

CoverFront No complex Type2 1 [PWG5100.3] §3.1

The front cover to apply to this Document. (Contains Media/MediaType or MediaCol, CoverType) (See also Job CoverFront)

CoverType No Keyword Type2 1 [PWG5100.3] §3.1.2

Indicates if covers are requested and which sides will contain Print stream pages. Values: CoverTypeWKV, KeywordNsExtensionPattern (e.g., NoCover, PrintNone, PrintFront, PrintBack, PrintBoth) (Included in CoverBack, CoverFront, JobCoverBack & JobCoverFront )

CrossFeed No Integer 1:MAX 1 RFC2911] §4.2.12

[PWG5108.02] § 8.1.3.1.12

Specifies the resolution in Units for the CrossFeed direction. (Included in Resolution)

Destination No complex Type2 1 [PWG5108.02] § 8.1.3.1.8

Indicates where the output of the Job is delivered. The destination indicates the location of either a directory or file. (Contains DestinationFile, DestinationDirectory)

DestinationDirectory No URI Unlimited 1 [PWG5108.02] § 8.1.3.1.8.2

This element is used when the output of the Job is a set of Digital Document files stored in adirectory. (Included in Destination)

DestinationFile No URI Unlimited 1 [PWG5108.02] § 8.1.3.1.8.1

This element is used when the output of the Job is a Digital Document file. (Included in Destination)

DocumentCharsetSupplied No Keyword Type2 2,4 [PWG5100.7] §5.2.2


865

866




Default charset of the Documents content. Values:CharsetWKV, StringExtensionPattern (e.g., utf-8, iso-10646-unicode-latin1)

DocumentCopies Yes RangeOfInteger 1:MAX 3 [PWG5100.6] §4.1.3

Specifies which copies of a Document to apply the override Processing elements. (Included in Overrides)

DocumentDigitalSignature No Keyword Type2 4 [PWG5100.7] §3.2.3 [PWG5100.5] §9.1.11

The type of digital signature used in the Document Content , Values: DigitalSignatureWKV, KeywordNsExtensionPattern (e.g., None, Pgp, Xdsig)

DocumentDigitalSignatureSupplied No Keyword Type2 2 [PWG5100.7] §5.2.3

The type of digital signature used in the Document Content. This , Values: DigitalSignatureWKV, KeywordNsExtensionPattern (e.g., None, Pgp, Xdsig)

DocumentFormat No Keyword Type2 2,4 [RFC2911] §3.2.1.1

Document format (i.e., PDL) for the Document content, Values: DocumentFormatWKV, MimeExtensionPattern (e.g., application/postscript, image/jpeg, text/plain) (Included in DocumentFormatDetailsSupplied)

DocumentFormatDetailsSupplied No Complex N/A 2,4 [PWG5100.7] §5.2.4

Summarizes the default distinct contained document formats (Contains DocumentSourceApplicationName, DocumentSourceApplicationVersion, DocumentSourceOsName, DocumentSourceOsVersion, DocumentFormat, DocumentFormatDeviceId, DocumentFormatVersion, DocumentNaturalLanguage)

DocumentFormatDeviceId No String Maxlength=1023 2,4 [PWG5100.5] §9.1.13

Type of device for which the document was formatted, following the IEEE 1284-2000 Device ID string. (Included in DocumentFormatDetailsSupplied)

DocumentFormatSupplied No Keyword Type2 2 [PWG5100.7] §5.2.5


867

868




Document format (i.e., PDL) for the Document content, Values: DocumentFormatWKV, MimeExtensionPattern (e.g., application/postscript, image/jpeg, text/plain)

DocumentFormatVersion No String Type2 2,4 [PWG5100.5] §9.1.16

Level or version of the DocumentFormat. (Included in DocumentFormatDetailsSupplied)

DocumentFormatVersionSupplied No String Type2 2 [PWG5100.7] §5.2.6

Level or version of the DocumentFormat.

DocumentMessage No String Maxlength=1023 4 [PWG5100.5] §9.1.20

Message from either (1) the user to the operator about the Documents or (2) from the operator, system administrator, or "intelligent" process to indicate to the end user the reasons for modification or other management action taken on the Documents

DocumentMessageSupplied No String Maxlength=1023 2 [PWG5100.7] §5.2.7

message from either (1) the user to the operator about the Documents or (2) from the operator, system administrator, or "intelligent" process to indicate to the end user the reasons for modification or other management action taken on the Documents

DocumentMetadata No Complex N/A 4 [DCMI]

[JPS3] § 5.1.1

The Dublin Core Metadata Element Set for the document. The XML binding uses XML schema from <http://dublincore.org/schemas/xmls/qdc/2008/02/11/qualifieddc.xsd>. See JPS3 § 5.1.1 for IPP encoding.

DocumentName No String Maxlength=255 4 [PWG5100.5] §9.1.21

Name for the Document to be used in an implementation specific manner.

DocumentNameSupplied No String Maxlength=255 2 [PWG5100.7] §5.2.8

Default name for the Documents in the Job to be used in an implementation specific manner.

DocumentNaturalLanguage No Keyword Type2 2,4 [RFC2911] §3.2.1.1


869

870




Primary Natural Language of the Document. Values: NaturalLanguageWKV, NatLangExtensionPattern (e.g., en, de, fr, en-us) (Included in DocumentFormatDetailsSupplied)

DocumentNumbers Yes RangeOfInteger 1:MAX 3 [PWG5100.6] §4.1.2

Specifies the documents in a Job for override processing. (Included in Overrides)

DocumentPassword No Base64Binary 1:1366 1 [JPS3] §5.1.2

Specifies the unencrypted passphrase to be used to access the document content. (DocumentPassword length maximum is 1024 octets before encoding)

DocumentSourceApplicationName No String Type2 2,4 [PWG5100.5] §9.1.13

Name of the application that created the document, without its version number. (Included in DocumentFormatDetailsSupplied)

DocumentSourceApplicationVersion No String Type2 2,4 [PWG5100.5] §9.1.13

Version of the application that created the document, without its name. (Included in DocumentFormatDetailsSupplied)

DocumentSourceOsName No Keyword Type3 2,4 [PWG5100.5] §9.1.13

Name of the operating system, without version number, on which the document was generated. Values: OperatingSystemNameWKV, OperatingSystemNameExtensionPattern (e.g., LINUX, OSX , WIN32 ) (Included in DocumentFormatDetailsSupplied)

DocumentSourceOsVersion No String Type2 2,4 [PWG5100.5] §9.1.13

version of the operating system, without its name, on which the document was generated. (Included in DocumentFormatDetailsSupplied)

DocumentUri No URI Unlimited 2,4 [PWG5100.5] §9.1.28

Reference to the document to Print. (See also [rfc2911] § 3.3.2)

DocumentMessage No String Maxlength=1023 4 [PWG5100.5] §9.1.20


871

872




A message from either (1) the user to the operator about the Document or (2) from the operator, system administrator, or "intelligent" process to indicate to the end user the reasons for modification or other management action taken on the Document.

DocumentName No String Maxlength=255 4 [rfc2911] §3.2.1.1

Name for this Document to be used in an implementation specific manner.

DocumentNaturalLanguage No String Maxlength=127 4 [rfc2911] §3.2.1.1

[PWG5100.5] §9.1.22

Identifies the primary Natural Language of this Document.

ElementsNaturalLanguage No Keyword Type2 2 [rfc2911] §4.3.20

Identifies the natural language used for any Client supplied strings. Values: NaturalLanguageWKV, NatLangExtensionPattern (e.g., en, de, fr, en-us)

Exposure No complex Type2 1 [PWG5108.02] § 8.1.3.1.11

Specifies how the Service will employ image processing techniques to reduce the background of the Document to a white Image. (Contains AutoExposure, Brightness, Contrast, Sharpness, and Any)

Feed No Integer 1:MAX 1 RFC2911] §4.2.12

[PWG5108.02] § 8.1.3.1.12

Specifies the resolution in Units for the Feed direction. (Included in Resolution)

FeedOrientation No Keyword Type3 1 [PWG5100.11] §7.1

Specifies the media edge that is fed into the Print engine from the paper tray. Values: FeedOrientationWKV, KeywordNsExtensionPattern (e.g., LongEdgeFirst ShortEdgeFirst)

Finishings Yes Keyword Type2 1 [rfc2911] §4.2.6

[PWG5100.1] §2


873

874




Identifies the finishings that the PrintService uses for each copy of the Output Document. Values: FinishingsWKV, KeywordNsExtensionPattern (e.g., Bale, Bind, BindLeft, BookletMaker, EdgeStitch, Fold, JogOffset, None, Punch, Staple, StapleTopLeft, Trim). (See also JobFinishings Job element)

FinishingsCol No complex N/A 1 [PWG5100.3] §3.2

Enables an end user to specify detailed finishing options not possible with the “Finishings” element for the Output Document. (Contains FinishingTemplate, Stitching) (See also JobFinishingsCol element)

FinishingTemplate No String Maxlength=1023 1 [PWG5100.3] §3.2.1

A string specifying some particular finishing operation. (Included in FinishingsCol, JobFinishingsCol)

FirstIndex No Integer 0:MAX 6 [PWG5108.02] § 8.1.3.1.12

Specifies the first object or element, starting at 0, to be returned in a response.

FontNameRequested No String Maxlength=255 1 [PWG5100.11] §7.2

Specifies the name of the font if the document data is in a format that does not have inherent font information (e.g., ‘text/plain’), otherwise, this element is ignored.

FontSizeRequested No Integer 1:MAX 1 [PWG5100.11] §7.3

Specifies the font size in points (1/72 of an inch) if the document data is in a format that does not have inherent font information, otherwise, this element is ignored.

ForceFrontSide Yes Integer 1:MAX 1 [PWG5100.3] §3.3

Forces the specified pages to be Printed on the front side of a sheet of media. The pages of the output document start at 1.

Height No Integer MIN:MAX 1 [PWG5108.02] §8.1.3.1.15.1.1

Element identifies the height of the image box in RegionUnits. (Contained in ImageBox)

IdentifyActions Yes List of keywords Type 3 6 [JPS3] § 5.1.4


875

876




Specifies the action(s) that are taken to identify the device hosting the service.

IdentifyActionsDefault Yes List of keywords Type 3 5 [JPS3] § 5.6.3

Specifies the defaults action(s) that are taken to identify the device hosting the service.

IdentifyActionsSupported Yes List of keywords Type 3 5 [JPS3] § 5.1.4

Specifies the defaults action(s) that are taken to identify the device hosting the service.

ImageBox No Complex N/A 1 [PWG5108.02] § 8.1.3.1.15.1

Describes the region where the Image from the Scan of the ScanRegion will be placed. (Contains Height, RegionUnits, Width, XOffset, YOffset)

ImagesToTransfer No Integer 0:MAX 1 [PWG5108.02] § 8.1.3.1.13

Specifies the number of Images to Scan from the Hardcopy Document.

ImpositionTemplate No Keyword Type2 1 [PWG5100.3] §3.4

Specifies imposition method for laying out finished page images onto the surface of output media. Values: ImpositionWKV, KeywordNsPattern (e.g., None, Signature)

Impressions No Integer 0:MAX 2,4 [RFC2911] §4.3.17.2

Total size in number of impressions in all the Job‟s Document(s).

InputSource No Keyword Type2 1 [PWG5108.02] § 8.1.3.1.14

Specifies the source of the scanned Document. Values: InputSourceWKV, KeywordNsPattern (e.g., ADF, Platen, FilmReader)

InsertAfterPageNumber No Integer 0:MAX 1 [PWG5100.3] §3.5.1

Specifies the input page after which the Insert Sheet will be placed. Pages are numbered starting at 1. A 0 value means in front of the first page. (Included in InsertSheet)

InsertCount No Integer 0:MAX 1 [PWG5100.3] §3.5.2


877

878




Specifies the number of Insert Sheet to insert. (Included in InsertSheet)

InsertSheet Yes complex N/A 1 [PWG5100.3] §3.5

Specifies how Insert Sheets are to be inserted into the sequence of media sheets that are produced for each copy of the documents. (Contains InsertAfterPageNumber, InsertCount, Media/MediaType or MediaCol)

JobAccountingID No String Maxlength=1023 2 [PWG5100.3] §3.6

The account associated with the Job (e.g., customer name, internal billing number) . Use of this element is implementation dependent.

JobAccountingOutputBin No Keyword Type3 3 [PWG5100.3] §3.8.3

Specifies the output bin where the accounting sheet is to be placed. Values: OutputBinWKV, KeywordNsPattern (e.g., Bottom, FaceUp, LargeCapacity, Left, MailboxN*, Rear, Right, Side, StackerN*, Top, TrayN*. *Note: N is replaced by a cardinal number)

JobAccountingSheets No complex N/A 3 [PWG5100.3] §3.8

Specifies the accounting sheet for a job. (Contains JobAccountingSheetsType, Media/ MediaType or MediaCol, JobAccountingOutputBin).

JobAccountingSheetsType No Keyword Type3 3 [PWG5100.3] §3.8.1

Specifies the accounting sheet format for a job. Values: JobAccountingSheetsTypeWKV, KeywordNsPattern (e.g., None, Standard) (Included in JobAccountingSheets)

JobAccountingUserID No String Maxlength=1023 2 [PWG5100.3] §3.7

Specifies the user ID associated with the account specified by the

JobAccountingID. These two elements are used for authentication and account tracking

JobCopies No Integer 1:MAX 3 [PWG5100.7] §4.1.1

The number of copies of the Job to be Printed. (See also Copies)

JobCoverBack No complex N/A 3 [PWG5100.7] §4.1.2


879

880




The back cover to apply this Job. (Contains Media/MediaType or MediaCol, CoverType) (See also Job CoverBack)

JobCoverFront No complex N/A 3 [PWG5100.7] §4.1.3

The front cover to apply to this Job. (Contains Media/MediaType or MediaCol, CoverType) (See also Job CoverFront)

JobDelayOutputUntil No Keyword Type3 3 [PWG5100.11] §7.4

Specifies the named time period during which the Job output may be produced. Other Job processing can occur at any time. Values: HoldUntilWKV, KeywordNsPattern (e.g., NoHold, Indefinite, DayTime, Evening, Night, Weekend, SecondShift, ThirdShift)

JobDelayOutputUntilTime No String DateTime [rfc1123] 3 [PWG5100.11] §7.5

Specifies the date and time after which the Job output may be produced. Other Job processing can occur at any time. (e.g., Fri, 03 May 2002 08:49:37 GMT)

JobErrorSheet No complex N/A 3 [PWG5100.3] §3.9

Specifies the error sheet for a job. (Contains JobErrorSheetType, JobErrorSheetWhen, Media/MediaType or MediaCol).

JobErrorSheetType No Keyword

Type3 3 [PWG5100.3] §3.9.1

Specifies the error sheet format for a job. Values: JobErrorSheetTypeWKV, KeywordNsPattern (e.g., None, Standard) (Included in JobErrorSheet)

JobErrorSheetWhen No Keyword Type2 3 [PWG5100.3] §3.9.2

Indicateds conditions required to produce JobErrorSheet. Values: JobErrorSheetWhenWKV, KeywordNsExtensionPattern (e.g., OnError, Always) (Included in JobErrorSheet)

JobFinishings Yes Keyword Type2 3 [PWG5100.7] §4.1.4


881

882




Identifies the finishings that the PrintService uses for the Job. Values: FinishingsWKV, KeywordNsExtensionPattern (e.g., Bale, Bind, BookletMaker, Fold, JogOffset, None, Punch, Staple, StapleTopLeft, Trim). (See also Finishings element)

JobFinishingCol No complex N/A 3 [PWG5100.7] §4.1.5

Enables an end user to specify detailed finishing options not possible with the “JobFinishings” element for the Job. (Contains FinishingTemplate, Stitching) (See also FinishingsCol element)

JobHoldUntil No Keyword Type3 3 [rfc2911] §4.2.2

Specifies the named time period during which the Job must become a candidate for processing (i.e., document(s) interpreted and output produced). Values: HoldUntilWKV, KeywordNsPattern (keywords: NoHold, Indefinite, DayTime, Evening, Night, Weekend, SecondShift, ThirdShift)

JobHoldUntilTime No String DateTime [rfc1123] 3 [PWG5100.11] §7.6

Specifies the date and time after which the Job must become a candidate for processing (i.e., document(s) interpreted and output produced). (e.g., Fri, 03 May 2002 08:49:37 GMT)

JobMandatoryElements Yes List of keywords Type 3 3 [PWG5100.7] §3.12

This deprecated element permits the client to identify which Processing elements the PrintService MUST support in this Job Creation request in order to accept the Job. This element has been replaced by the “MustHonor” attribute on all the processing elements. Values: Any Processing element keyword

JobMessageFromOperator No String Maxlength=1023 2 [rfc2911] §4.3.16

Message from an operator, system administrator or "intelligent" process to indicate to the end user the reasons for modification or other management action taken on a job. (e.g., “Job held until system maintenance completed”)

JobMessageToOperator No String Maxlength=1023

2 [PWG5100.3] §3.10


883

884




Message from the end user to indicate something about the processing of this Job. (e.g., “Call 555-1234 before running this job”)

JobMoreInfo No URI Unlimited 2 [rfc2911] §4.3.4

the URI referencing some resource with more information about this Job Object, perhaps an HTML page containing information about the Job.

JobName No String Maxlength=255 2 [rfc2911] §4.3.5

User friendly name of the Job. It does not have to be unique.

JobOriginatingUserName No String Maxlength=255 2 [rfc2911] §4.3.5

Name of the end user that submitted the Print job. The PrintService sets this element to the most authenticated Printable name.

JobOriginatingUserUri No URI Unlimited 2 [JPS3] §5.3.6

URI of the User that submitted the Job creation request. The PrintService sets this element to the most authenticated user URI available. This element differs from JobOriginatingUserName which is a human readable name. This element is a URI (e.g., urn:uuid:f92eface-7dec-21c3-ab55-12d3c91eabff, mailto:[email protected]).

JobPassword No Base64Binary 1:340 2 [PWG5100.11] §6.1

Password supplied by the client, encrypted according to method specified by the client in the JobPasswordEncryption Element. (JobPassword length maximum is 255 octets before encoding)

JobPasswordEncryption No Keyword type3 2 [PWG5100.11] §6.2

Encryption the client is using for the supplied value of the JobPassword Element. Values: JobPasswordEncryptionWKV, KeywordNsExtensionPattern (e.g., None, Shah, MD5)

JobPhoneNumber No String Maxlength=127 3 [PWG5100.11] §7.7,

Contains the contact telephone number for this Job.

JobPriority No Integer 1:100 3 [rfc2911] §4.2.1


885

886




Priority for scheduling the Job. A higher value specifies a higher priority.

JobRecipientName No String Maxlength=255 3 [PWG5100.11]§ 5.6

Name of the intended recipient of the Job.

JobSaveDisposition No Complex N/A 3 [PWG5100.11] §7.9

Specifies that the PrintService is to save the Job as a file that can be re- Printed on demand anytime in the future (Contains SaveDisposition, SaveInfo)

JobSheetMessage No String Maxlength=1023 3 [PWG5100.3] §3.12

Conveys a message that is delivered with the job.

JobSheets No Keyword type3 3 [rfc2911] §4.2.3

Specifies which Job start/end sheet(s), will be Printed with a job. Values: JobSheetsWKV, KeywordNsExtensionPattern (e.g., None, Standard, JobStartSheet, First PrintStreamPage)

JobSheetsCol No complex N/A 3 [PWG5100.3] §3.11

Enables an end user to specify detailed Job Sheet options not possible with the “JobSheet” element. (Contains JobSheets, Media/MediaType or MediaCol)

JobUuid No URI Maxlength=45 2 [JPS3] §5.3.1

Specifies a globally-unique identifier for the job. This element is a URN (e.g., urn:uuid:f92eface-7dec-21c3-ab55-12d3c91eabff).

Koctets No Integer 0:MAX 2,4 [rfc2911] §4.3.17.1

Total size of this Job‟s Digital Document(s) in integral units of 1024 octets.

LastDocument No Boolean N/A 4 [PWG5100.5] §9.1.35

Indicates whether or not this Document is the last Document in the Job.

Margin No complex N/A 1,3 [JPS3] §7.4


887

888




Defines the PrintService's physical margin for the associated media in hundredths of millimeters. (Contains media-bottom-margin, media-left-margin, media-right-margin, media-top-margin)

MediaBottomMargin No int 0:MAX 1,3 [JPS3] §7.4.1

Defines the PrintService's physical bottom margin in hundredths of millimeters from the bottom edge, without respect to the value of the “OrientationRequested” element.

MediaBottomMarginSupported Yes int 0:MAX 1,3 [JPS3] §5.6.9

Lists the supported values for the "MediaBottomMargin" in hundredths of millimeters or 1/2540th of an inch and specifies a hardware margin supported by the Printer

MediaLeftMargin No int 0:MAX 1,3 [JPS3] §7.4.2

Defines the PrintService's physical left margin in hundredths of millimeters from the left edge, without respect to the value of the “OrientationRequested” element.

MediaLeftMarginSupported Yes int 0:MAX 1,3 [JPS3] §5.6.10

Lists the supported values for the "MediaLeftMargin" in hundredths of millimeters or 1/2540th of an inch and specifies a hardware margin supported by the Printer

MediaRightMargin No int 0:MAX 1,3 [JPS3] §7.4.3

Defines the PrintService's physical right margin in hundredths of millimeters from the right edge, without respect to the value of the “OrientationRequested” element.

MediaRightMarginSupported Yes int 0:MAX 1,3 [JPS3] §5.6.11

Lists the supported values for the "MediaRightMargin" in hundredths of millimeters or 1/2540th of an inch and specifies a hardware margin supported by the Printer

MediaSheets No int 0:MAX 4 [rfc2911] §4.3.17.3

The total number of media sheets to be produced for this Document. (job-media-sheets in IPP)

MediaTopMargin No int 0:MAX 1,3 [JPS3] §7.4.7


889

890




Defines the PrintService's physical top margin in hundredths of millimeters from the top edge, without respect to the value of the “OrientationRequested” element.

MediaTopMarginSupported Yes int 0:MAX 1,3 [JPS3] §5.6.12

Lists the supported values for the "MediaTopMargin" in hundredths of millimeters or 1/2540th of an inch and specifies a hardware margin supported by the Printer

Media No Keyword type3 1,3 [RFC2911] ] §4.2.11, [PWG5101.1] §5

The name of the medium that the PrintService uses for all impressions of the Job. Values: MediaWKV, MediaNsExtensionPattern (e.g., na_letter_8.5x11in, iso_a4_210x297mm, na_monarch_3.875x7.5in, choice_iso_a4_210x297mm_na_letter_8.5x11in. ) (Included in CoverBack, CoverFront, InsertSheet, SeparatorSheets, JobAccountingSheets, JobCoverBack, JobCoverFront, JobErrorSheet, JobSheetsCol, MediaCol)

MediaBox No Complex N/A 1 [PWG5101.1] §5

This element is only applicable when the document format used to store the Digital Document has a similar construct that controls the placement and bounding of the scanned Image on the document format specific page Image. (Contains ImageBox, ImageCroppingPolicy, MediaSizeName, OrientationRequested )

MediaCol No complex N/A 1,3 [PWG5100.3] §3.13

Enables a client end user to submit a list of media characteristics to the PrintService as a way to more completely specify the media to be used than the Media element. (Contains MediaBackCoating, MediaColor, MediaFrontCoating, MediaGrain , MediaHoleCount, MediaInfo, MediaKey, MediaOrderCount, MediaPre Printed, MediaRecycled, MediaSize, MediaSizeName, MediaThickness, MediaTooth, MediaType, MediaWeightMetric, Margins, MediaSource) (Included in CoverBack, CoverFront, InsertSheet, SeparatorSheets, JobAccountingSheets, JobCoverBack, JobCoverFront, JobErrorSheet, JobSheetsCol)

MediaBackCoating No Keyword Type3 1,3 [PWG5100.3] §3.13.10

Indicates the pre-process coating applied to the back of the media. Values: MediaCoatingWKV, MediaNsExtensionPattern (e.g., None, Glossy, HighGloss, SemiGloss, Satin, Matte) (Included in MediaCol)


891

892




MediaColor No Keyword Type3 1 [PWG5100.3] §3.13.4

Indicates the desired color of the media being specified. Values: MediaColorWKV, KeywordNsExtensionPattern (e.g., no-color, white, pink, yellow, blue, green, buff, goldenrod, red, gray, ivory, orange) (See also [pwg5101.1] §4) (Included in MediaCol)

MediaFrontCoating No Keyword Type3 1,3 [PWG5100.3] §3.13.10

Indicates the pre-process coating applied to the front of the media. Values: MediaCoatingWKV, MediaNsExtensionPattern (e.g., None, Glossy, HighGloss, SemiGloss, Satin, Matte) (Included in MediaCol)

MediaGrain No Keyword Type3 1,3 [PWG5100.11] §11.5.2

Indicates the grain of the media. Values: MediaGrainWKV, KeywordNsExtensionPattern (e.g, x-direction, y-direction) (Included in MediaCol)

MediaHoleCount No Integer 0:MAX 1,3 [PWG5100.3] §3.13.6

Indicates the number of pre-drilled holes in the desired media. (Included in MediaCol)

MediaInfo No String Maxlength=255 1,3 [PWG5100.3] §3.13.3

Specifies information that helps describe the media instance. Intended for human consumption. (Included in MediaCol)

MediaInputTrayCheck No Keyword Type3 1 [PWG5100.3] §3.14

Indicates that the characteristics of the media in the identified input tray must match the characteristics of the media identified by the "media" or "media-col" element. Values: MediaInputTrayWKV, MediaNsExtensionPattern (e.g., Top, Middle, Bottom, Side, LargeCapacity, Envelope, Main, Manual. See [RFC2911] Appendix C)

MediaKey No Keyword Type3 1,3 [PWG5100.3] §3.13.1

The unique media name associated with an instance of MediaCol elements and their values. Identical values of MediaKey and the Media element represent the same media. (Included in MediaCol)

MediaOrderCount No Integer 1:MAX 1,3 [PWG5100.3] §3.13.7


893

894




Indicates the number of sheets, within an ordered sequence of sheets; after which the sequence begins to repeat. (Included in MediaCol)

MediaPre Printed No Keyword Type3 1,3 [PWG5100.3] §3.13.5

Indicates the pre- Printed characteristics of the desired media. Values: MediaPre PrintedWKV, KeywordNsExtensionPattern (e.g., Blank, Pre Printed, LetterHead) (Included in MediaCol)

MediaRecycled No Keyword Type3 1,3 [PWG5100.3] §3.13.11

Indicates the recycled characteristics of the media. Values: MediaRecycledWKV, KeywordNsExtensionPattern (e.g., None, Standard) (Included in MediaCol)

MediaSheets No Integer 0:MAX 2,4 [RFC2911] §4.3.17.2

Total size in number of impressions in all the Job‟s Document(s).

MediaSize No Complex N/A 1,3 [PWG5100.3] §3.13.8

Explicitly specifies the numerical media width and height dimensions in hundredth of a millimeter. (Contains XDimension, YDimension) (Included in MediaCol)

MediaSizeName No Keyword Type3 1 [PWG5108.02] § 8.1.3.1.15.3 , [PWG5101.1] §5

The size of the canvas for an Image in the Digital Document expressed as a named size. (See Media). Values: MediaWKV, MediaNsExtensionPattern (e.g., na_letter_8.5x11in, iso_a4_210x297mm, na_monarch_3.875x7.5in). (See also [pwg5101.1] §5) (Included in MediaBox)

MediaSource No Keyword Type3 1,3 JPS3] §7.4.5

Specifies the input tray, slot, roll, or other source for the media Values: MediaSourceWKV, KeywordNsExtensionPattern (e.g., Auto, Bottom, Envelope, LargeCapacity, Top, Tray1) (Included in MediaCol)

MediaThickness No Integer 1:MAX 1,3 [PWG5100.11] §11.5.3


895

896




The thickness of the media in units of one hundredth of a millimeter. This unit is equivalent to 1/2540 th of an inch. (Included in MediaCol)

MediaTooth No Keyword Type3 1,3 [PWG5100.11] §11.5.1

The tooth (or roughness) of the media. Values: MediaToothWKV, KeywordNsExtensionPattern (e.g., Fine, Medium, Coarse, Linen) (Included in MediaCol)

MediaType No Keyword Type3 1,3 [PWG5101.1] §3

[WS- Print] §3.5.2.3.2

The medium type that the PrintService uses for all impressions. Values: MediaTypeWKV, KeywordNsExtensionPattern (e.g., stationery, transparency envelopecontinuous, tab-stock, pre-cut-tabs, photographic, cardstock, other) (Included in CoverBack, CoverFront, InsertSheet, JobAccountingSheets, JobCoverBack, JobCoverFront, JobErrorSheet, JobSheetsCo, MediaCol l, SeparatorSheets)

MediaWeightMetric No Integer 0:MAX 1,3 [PWG5100.3] §3.13.9

Indicates the weight of the desired media rounded to the nearest whole number of grams per square meter. (Included in MediaCol)

MultipleDocumentHandling No Keyword type2 3 [rfc2911] §4.2.4

Controls whether Input Document in multi-Document jobs are combined into a single Output Document or are kept as separate Output Documents Useful for application of Finishings. Values: MultipleDocumentsHandlingWKV, KeywordNsExtensionPattern (e.g. SingleDocument, SeparateDocumentCollatedCopies, SingleDocumentNewSheet)

NumberOfPagesInSubset Yes Integer 1:MAX 3 [PWG5100.4] §5.3

Specifies The number of pages in a subset of pages of the document PDL data. (Included in PagesPerSubset)

NumberUp No Integer 1:MAX 1 [rfc2911] §4.2.9

Indicates the number of Input pages that the PrintService is to image on one impression.

OrientationRequested No Keyword type2 1 [rfc2911] §4.2.10


897

898




The desired orientation for Printed pages for document formats that don’t have a built-in orientation. Values: OrientationRequestedWKV, KeywordNsExtensionPattern (e.g., Portrait, Landscape, ReverseLandscape, ReversePortrait)

OutputBin No Keyword type2 1,3 [PWG5100.2] §2.1 [PWG5100.5] §8.1

Specifies the output bin where the Job is to be delivered. Values: OutputBinWKV, KeywordNsExtensionPattern (e.g., Bottom, FaceUp, LargeCapacity, Left, MailboxN*, Rear, Right, Side, StackerN*, Top, TrayN*. *Note: N is replaced by a cardinal number)

OutputDevice No String Maxlength=255

1,3 [PWG5100.7] §4.2.1 [PWG5100.5] §8.1

Specifies the device where the pages of of a Job/Document will be Printed.

Overrides Yes complex N/A 3 [PWG5100.6] §4.1

Provides for the overriding of processing instructions on a page basis. (Contains Pages, DocumentNumbers, DocumentCopies, OverridingElements)

OverridingElements Yes Any Supported Element 3 [PWG5100.6] §4.1.4

Document Ticket processing elements to apply to the Document pages specified in the Override (Contained in Overrides)

PageDelivery No Keyword Type2 1 [PWG5100.3] §3.15

Indicates whether the pages of the Job are to be delivered to the output bin or finisher in the same page order as the original document and face up or face down. Values: PageDeliveryWKV, KeywordNsExtensionPattern (e.g., ReverseOrderFaceDown, SameOrderFaceUp, SystemSpecified) . (See also PageOrderReceived)

PageOrderReceived No Keyword Type3 2,4 [PWG5100.3] §3.16

The order of pages in this Document data as supplied with the job. Values: PageOrderReceivedWKV, KeywordNsExtensionPattern (e.g., 1ToNOrder, NTo1Order)

PageRanges Yes RangeOfInteger 1:MAX 1 [RFC2911] §4.2.7


899

900




Specifies a range of pages in the document data to be output.

Pages Yes RangeOfInteger 1:MAX 3 [pwg5100.6] §4.1.1

Specifies a range of pages in the document PDL data. (Included in Overrides)

PagesPerSubset Yes Complex Ordered list of Integer 3 [JPS3] §5.2.1

Combines all of the Pages of all of the Documents into a single stream of Pages. Then the PrintService partitions that single stream into contiguous subsets of Pages according to the list of integers. The list of integers is cyclical. When the last integer in the list is reached, the next subset uses the first.in the list. (Contains NumberOfPagesInSubset)

PdlInitFile Yes Complex N/A 1 [PWG5100.11] §7.10

Controls initialization of the PrintService’s Page Description Language (PDL) interpreter. (Contains PdlInitFileEntry, PdlInitFileLocation. PdlInitFileName)

PdlInitFileEntry No String Maxlength=255 1 [PWG5100.11] §7.10

Specifies an entry point within the init file at which the PDL interpreter starts. (Included in PdlInitFile)

PdlInitFileLocation No String Maxlength=1023 1 [PWG5100.11] §7.10

Contains a URL that specifies the path to the directory where the initialization file for the PrintService’s PDL interpreter will be found. (Included in PdlInitFile)

PdlInitFileName No String Maxlength=255 1 [PWG5100.11] §7.10

Specifies the name of the PDL interpreter’s initialization file within the directory specified by the PdlInitFileLocation element. (Included in PdlInitFile)

PdlOverrideSupported No Keyword Type2 1 [RFC2911] §4.4.28

Expresses the ability for a PrintService to override document data instructions with PrintJobTicket. Values: PdlOverrideSupportedWKV, KeywordNsExtensionPattern(e.g., NotAttempted, Attempted, Guaranteed)

PresentationDirectionNumberUp No Keyword Type2 1 [PWG5100.3] §3.17


901

902




Specifies the placement order of the page images on a Finished-Page Image with the "number-up" element. Values: PresentationDirectionNumberUpWKV , KeywordNsExtensionPattern (e.g., TorightTobottom, TobottomToright, ToleftTotop)

PrintColorMode No keyword Type3 1 [JPS3] §5.2.2

Specifies the color mode to use for Printing. Values: PrintColorModeWKV, KeywordNsExtensionPattern (e.g., Auto, BiLevel, Color, Monochrome, ProcessBilevel)

PrintContentOptimize No Keyword Type3 1 [PWG5100.7] §4.2.2 [PWG5100.5] §8.1

Directs the type of optimization/processing that will be performed on the Document content. It does not necessarily mean the value describes the content. Values: PrintContentOptimizeWKV, KeywordNsExtensionPattern (e.g., Photo, Text)

PrintRenderingIntent No Keyword Type3 1 [JPS3] §5.2.3

Specifies how out-of-gamut colors (or shades of gray) are mapped to device colors when Printing. Values: PrintRenderingIntentWKV, KeywordNsExtensionPattern (e.g., Absolute, Perceptual, Relative)

Proof Print No Complex N/A 3 [PWG5100.11] §7.11

Specifies the elements for proof Prints of the Job that are to be Printed prior to the Printing the full run of the job. (Contains Copies , Media/MediaType or MediaCol and any other Processing elements).

PwgRasterDocument

Backside

No Keyword Type3 5 [RST] §10.1

Specifies the bitmap coordinate system for the backside of duplex sheets. Values: PwgRasterDocumentBacksideWKV, KeywordNsExtensionPattern (e.g., Flipped, ManualTumble)

PwgRasterDocument

ResolutionSupported

Yes List of Resolution N/A 5 [RST] §10.2

Lists the supported page bitmap resolutions in dots per inch


903

904




PwgRasterDocument

TypeSupported

Yes List of Keywords Type3 5 [RST] §10.3

Lists the supported Color Space and bit depth combinations. Values: ColorEntryWKV, KeywordNsExtensionPattern (e.g., Grayscale16, RGBa32, CMYK64)

Quality No Keyword type2 1 RFC2911] §4.2.13

The output quality that the PrintService uses for the Job. Values: PrintQualityWKV, KeywordNsExtensionPattern (e.g., Draft, Normal, High) Note: FaxQualityWKV values are also included in the Quality definition for when this element is used in FaxOutJobTickets.

RegionUnits No Keyword type2 1 [PWG5108.02] §8.1.3.1.15.1.2

Element identifies the the units used for specifying the region. Values: RegionUnitsWKV, KeywordNsExtensionPattern (e.g., Micrometers, Pixels) (Contained in ImageBox)

Resolution No Complex N/A 1 RFC2911] §4.2.12

[PWG5108.02] §8.1.3.1.16

The resolution in Units for the Feed CrossFeed directions at which an image is captured or an impression is Printed (Contains Feed, XFeed and Units)

Rotation No Keyword type2 1 [PWG5108.02] §8.1.3.1.17

Specifies the amount to rotate each Image of a scanned document specified in degrees clockwise. Values: RegionUnitsWKV, KeywordNsExtensionPattern (e.g., 0, 90, 180, 270)

SaveDisposition No Keyword type3 3 [PWG5100.11] §7.9.1.1

Specifies whether the PrintService must Print and/or save the job. Values: SaveDispositionWKV, KeywordNsExtensionPattern (e.g., None, PrintSave, SaveOnly) (Included in JobSaveDisposition)

SaveDocumentFormat No String MimeMediaType 3 [PWG5100.11] §7.9.1.2.3.3 [rfc2046], [rfc2048]


905

906




Indicates the document format in which the PrintService saves the Document Data. (See DocumentFormat Document Description element) (Included in SaveInfo)

SaveInfo Yes complex N/A 3 [PWG5100.11] §7.9.1.2

Contains sets of elements that each tells the PrintService how to create each copy of the saved job. (Included in JobSaveDisposition) (Contains SaveLocation, SaveName, SaveDocumentFormat)

SaveLocation No URI Unlimited 3 [PWG5100.11] §7.9.1.2.3.1

Specifies the path to the directory as a URI where the PrintService saves the Document Data and other Job information. (Included in SaveInfo)

SaveName No String Unlimited 3 [PWG5100.11] §7.9.1.2.3.2

Specifies the name of the saved Job in the directory specified by the “save-location” member element. The value may be a relative path. (Included in SaveInfo)

SeparatorSheets No complex N/A 1 [PWG5100.3] §3.18

Specifies the separator sheets to be Printed with the Document. (Contains SeparatorSheetsType, Media/MediaType or MediaCol)

SeparatorSheetsType No Keyword Type3 1 [PWG5100.3] §3.18.1

Specifies the separator sheets type. Values: SeparatorSheetsTypeWKV, KeywordNsExtensionPattern (e.g., None, SlipSheets, StartSheet, EndSheet, BothSheets) (Included in SeparatorSheets)

Sharpness No Integer -100:100 1 [PWG5108.02] § 8.1.3.1.11.3

Specifies the relative amount to enhance or reduce object edges within an image. Negative values will reduce object edges in the image. (Included in Exposure)

SheetCollate No Keyword Type2 1 [rfc3381] §3.1

Specifies if the media sheets of each copy of each Printed document in a Job are to be in sequence. Values: SheetCollateWKV, KeywordNsExtensionPattern (e.g., Collated)


907

908




Sides No Keyword type2 1 [rfc2911] §4.2.8

Indicates how an impression is to be placed upon the side(s) of the media. Values: SidesWKV, KeywordNsExtensionPattern (e.g., OneSided, TwoSidedShortEdge)

Stitching No complex N/A 1 [PWG5100.3] §3.2.2

Provides detailed stitching parameters. (Included in FinishingsCol, JobFinishingsCol) (Contains StitchingReferenceEdge, StitchingOffset, StitchingLocations)

StitchingLocations Yes Integer 0:MAX D [PWG5100.3] §3.2.2.3

The distance along the stitching axis where a stitch will be placed in hundredths of a millimeter. (Included in Stitching)

StitchingOffset No Integer 0:MAX 1 [PWG5100.3] §3.2.2.2

The perpendicular distance from the reference edge to the stitching axis in hundredths of a millimeter. (Included in Stitching)

StitchingReferenceEdge No Keyword type2 1 [PWG5100.3] §3.2.2.1

Specifies edge of the output media from which the stitching offset is measured. Values: StitchingReferenceEdgeWKV, KeywordNsExtensionPattern (e.g., Bottom, Top, Left, Right) (Included in Stitching)

TemplateCreatorUserName No String Unlimited 2 [PWG5108.2] §8.1.3.2.12

Used only when Ticket is created from a template. This is the most authenticated user name of the template creator

TemplateId No URI Unlimited 2 [PWG5108.2] §8.1.3.2.13

Used only when Ticket is created from a template. This is the ID of the template used to create the Job Ticket.

TemplateInfo No String Maxlength=2047 2 [PWG5108.2] §8.1.3.2.14

Used only when Ticket is created from a template. Information about the template used to create the Job Ticket.


909

910




TemplateName No String Unlimited 2 [PWG5108.2] §8.1.3.2.15

Used only when Ticket is created from a template. Name of template used to create the Job Ticket.

TemplateType No Keyword Type2 2 [PWG5108.2] §8.1.3.2.16

Used only when Ticket is created from a template. Type of the template used to create the Ticket. . Values: TemplateTypeWKV, KeywordNsExtensionPattern (e.g., None, Center)

Units No Keyword Type2 1 RFC2911] §4.2.12 [PWG5108.3] § 8.1.3.1.16.3

This specifies the units used to express the resolution. Values: UnitsWKV, KeywordNsExtensionPattern (e.g., Dpcm, Dpi)

Width No Integer MIN:MAX 1 [PWG5108.02] §8.1.3.1.15.1.3

Element identifies the width of the image box in RegionUnits. (Contained in ImageBox)

XDimension No Integer 0:MAX 1,3 [PWG5100.3] §3.13.8.1

Size of the media in hundredths of a millimeter along the bottom edge. (Included in MediaSize)

XImagePosition No Keyword type2 1 [PWG5100.3] §3.19.2

Causes the specified point of the Finished-Page Image to be positioned at a specified location. Values: XImagePositionWKV, KeywordNsExtensionPattern (e.g., None, Center)

XImageShift No Integer MIN:MAX 1 [PWG5100.3] §3.19.3

Causes the Finished-Page Image to be shifted in position with respect to the x-axis of the media in hundredths of a millimeter. The values’s sign indicates the direction of the shift.

XOffset No Integer MIN:MAX 1 [PWG5108.02] §8.1.3.1.15.1.4

Element identifies the offset, positive or negative, on the X axis from the origin of the MediaBox in RegionUnits. (Contained in ImageBox)


911

912




Xside1ImageShift No Integer MIN:MAX 1 [PWG5100.3] §3.19.4

Causes each Finished-Page Image that would be placed on the front side of a sheet to be shifted in position with respect to the x-axis of the media in hundredths of a millimeter. The value’s sign indicates the direction of the shift.

Xside2ImageShift No Integer MIN:MAX 1 [PWG5100.3] §3.19.5

Causes each Finished-Page Image that would be placed on the backside of a sheet to be shifted in position with respect to the x-axis of the media in hundredths of a millimeter. The value’s sign indicates the direction of the shift.

YDimension No Integer 0:MAX 1,3 [PWG5100.3] §3.13.8.2

Size of the media in hundredths of a millimeter along the left edge. (Included in MediaSize)

YImagePosition No Keyword type2 1 [PWG5100.3] §3.19.6

Causes the specified point of the Finished-Page Image to be positioned at a specified location. Values: YImagePositionWKV, KeywordNsExtensionPattern (e.g., None, Center)

YImageShift No Integer MIN:MAX 1 [PWG5100.3] §3.19.7

Causes the Finished-Page Image to be shifted in position with respect to the y-axis of the media in hundredths of a millimeter. The value’s sign indicates the direction of the shift.

YOffset No Integer MIN:MAX 1 [PWG5108.02] §8.1.3.1.15.1.5

Element identifies the offset, positive or negative, on the Y axis from the origin of the MediaBox in RegionUnits. (Contained in ImageBox)

Yside1ImageShift No Integer MIN:MAX 1 [PWG5100.3] §3.19.8

Causes each Finished-Page Image that would be placed on the front side of a sheet to be shifted in position with respect to the y-axis of the media in hundredths of a millimeter. The Value’s sign indicates the direction of the shift.

Yside2ImageShift No Integer MIN:MAX 1 [PWG5100.3] §3.19.9


913

914




Causes each Finished-Page Image that would be placed on the backside of a sheet to be shifted in position with respect to the y-axis of the media in hundredths of a millimeter. The value’s sign indicates the direction of the shift.

27. Appendix B: Service CapabilitiesServiceCapabilities are closely related to the JobTicket. The ServiceCapabilities have the same structure and element names as the corresponding JobTicket elements. The ServiceCapabilities elements differ in syntax. The purpose of ServiceCapabilities is to provide information on what JobTicket elements are supported and what values those elements can have.

For example if a JobTicket element can contain a keyword (e.g. DocumentFormat), then the presence of the corresponding ServiceCapabilities element indicate that the JobTicket element is supported. The ServiceCapabilities element’s syntax is a list of keywords that supplies the allowed values for the JobTicket element.

In a similar fashion a JobTicket element that has a datatype of integer has a ServiceCapabilities element with syntax of a range of integers specifying the range of allowed values for the JobTicket element.

Some JobTicket elements only require the ServiceCapabilities to specify that the element is supported. For these instances the ServiceCapabilities element uses the Boolean type.

It should be noted that the the MediaCol element can be quite large for high end systems (e.g., Production PrintServices). The syntax for the MediaCol capabilities element is a list of MediaCol. There are a number of elements in the MediaCol datatype and a large number of combinations are possible. An implementation of a registration process must accommodate this potentially large amount of data.

Table 82 summarizes the semantics of the ServiceCapabilities syntax and specifies which ServiceCapabilities element uses the syntax.

Table 103 ServiceCapabilities Syntax

Capabilities Syntax

Semantics Capabilities Element

Boolean Specifies the JobTicket element is supported

DocumentDigitalSignatureSupplied , DocumentSourceApplicationName ,


915

6585

65866587658865896590

6591659265936594

659565966597

65986599

66006601660266036604

66056606

6607

916


Capabilities Syntax


DocumentSourceApplicationVersion , DocumentSourceOsVersion , DocumentFormatDeviceId , DocumentFormatVersion , DocumentMessageSupplied , DocumentNameSupplied , FinishingTemplate, Impressions , JobAccountingID , JobAccountingUserID , JobMandatoryElements , JobMessageFromOperator , JobMessageToOperator , JobMoreInfo , JobName , JobOriginatingUserName , JobOriginatingUserUri , JobSheetMessage, KOctets , MediaCol, MediaSheets , Overrides, PageRanges, PagesPerSubset, SaveName, TemplateCreatorUserName, TemplateId, TemplateInfo, TemplateName

Integer Specifies the supported string length for the JobTicket element

JobPassword

List of Keywords

Specifies the valid list of keywords for the JobTicket element

CompressionSupplied , CoverType, DocumentCharsetSupplied , DocumentFormatDetailsSupplied , DocumentFormatSupplied , DocumentSourceOsName , DocumentFormat , DocumentFormatSupplied , DocumentFormatVersionSupplied , DocumentNaturalLanguage , ElementsNaturalLanguage , FeedOrientation, Finishings, FontNameRequested, ImpositionTemplate, JobAccountingSheetsType, JobAccountingOutputBin, JobErrorSheetType, JobErrorSheetWhen, JobPasswordEncryption , JobSheets, Media, MediaInputTrayCheck,


917

918


Capabilities Syntax


MediaSource, MediaType, MultipleDocumentsHandling, OrientationRequested, OutputBin, OutputDevice, PageDelivery, PageOrderReceived , PdlInitFileLocation, PdlInitFileName, PdlInitFileEntry, PresentationDirectionNumberUp, PrintColorMode , PrintContentOptimize, PrintRenderingIntent , Quality, SaveDisposition, SaveDocumentFormat, SeparatorSheetsType , SheetCollate, Sides , StitchingReferenceEdge, TemplateType , XImagePosition, YImagePosition

List of Integers

Specifies the valid list of integers for the JobTicket element

NumberUp

List of MediaCol

This element is associated with the MediaCol PrintDocumentProcessing element. This element is referred to as the MediaCol database. It is a list of all the instances of MediaCol supported by the PrintService. Note that this element must be explicitly requested and is not returned with the other PrintDocumentProcessing elements.

MediaColSupported

(Note for MediaCol in element groups such as InsertSheet, the MediaCol capabilities element with a syntax of Boolean is used)

List of Resolutions

Specifies the allowed resolution tuples for the JobTicket element

Resolution

List of URI schemes

Specifies the allowed URI schemes for the JobTicket element

SaveLocation, Destination


919

920


Capabilities Syntax


Range of Integers

Specifies the lower and upper bounds for the JobTicket element

Copies, FontSizeRequestedSupported, ForceFrontSide, InsertAfterPage, InsertCount, JobCopies, StitchingLocation, StitchingOffset, XImageShift, XSide1ImageShift, XSide2ImageShift, YImageShift, YSide1ImageShift, YSide2ImageShift

28. Appendix C: Keyword Well-Known ValuesError: Reference source not found shows some of the well-known keywords from the PWG Semantic Model [PWG5108.1] and associated schema. The authoritative registry for the keywords defined in the Internet Printing Protocol is hosted by IANA [IPPREG]. IANA is also the source for other keywords such and character sets <http://www.iana.org/assignments/character-sets> and operating system names <http://www.iana.org/assignments/operating-system-names/operating-system-names.xml>. Where applicable the last value(s) enclosed in brackets indicate the name of the extension pattern used to extend the values.

39. Keyword Well Known Values

CharsetWKV adobe-standard-encoding, adobe-symbol-encoding, ansi-x3-110-1983, asmo-449, big5, big5-hkscs, bocu-1, bs-4730, bs-viewdata, cesu-8, csa-z243-4-1985-1, csa-z243-4-1985-2, csa-z243-4-1985-gr, csn-369103, dec-mcs, din-66003, dk-us, ds-2089, ebcdic-at-de, ebcdic-at-de-a, ebcdic-ca-fr, ebcdic-dk-no, ebcdic-dk-no-a, ebcdic-es, ebcdic-es-a, ebcdic-es-s, ebcdic-fi-se, ebcdic-fi-se-a, ebcdic-fr, ebcdic-it, ebcdic-pt, ebcdic-uk, ebcdic-us, ecma-cyrillic, es, es2, euc-jp, euc-kr, extended-unix-code-fixed-width-for-japanese, gb18030, gb-1988-80, gb2312, gb-2312-80, gbk, gost-19768-74, greek7, greek7-old, greek-ccitt, hp-desktop, hp-legal, hp-math8, hp-pi-font, hp-roman8, hz-gb-2312, ibm00858, ibm00924, ibm01140, ibm01141, ibm01142, ibm01143, ibm01144, ibm01145, ibm01146, ibm01147, ibm01148, ibm01149, ibm037, ibm038, ibm1026, ibm1047, ibm273, ibm274, ibm275, ibm277, ibm278, ibm280, ibm281, ibm284, ibm285, ibm290, ibm297, ibm420, ibm423, ibm424, ibm437, ibm500, ibm775, ibm850, ibm851, ibm852, ibm855, ibm857, ibm860, ibm861, ibm862, ibm863, ibm864, ibm865, ibm866, ibm868, ibm869, ibm870, ibm871,


921

6608

66096610661166126613661466156616

922

http://www.iana.org/assignments/operating-system-names/operating-system-names.xml

http://www.iana.org/assignments/operating-system-names/operating-system-names.xml

http://www.iana.org/assignments/character-sets



ibm880, ibm891, ibm903, ibm904, ibm905, ibm918, ibm-symbols, ibm-thai, iec-p27-1, inis, inis-8, inis-cyrillic, invariant, iso-10367-box, iso-10646-ucs-2, iso-10646-ucs-4, iso-10646-ucs-basic, iso-10646-unicode-latin1, iso-10646-utf-1, iso-2022-cn, iso-2022-cn-ext, iso-2022-jp, iso-2022-jp-2, iso-2022-kr, iso-2033-1983, iso-5427, iso-5427-1981, iso-5428-1980, iso-646-basic-1983, iso-646-irv-1983, iso-6937-2-25, iso-6937-2-add, iso-8859-1, iso-8859-10, iso-8859-13, iso-8859-14, iso-8859-15, iso-8859-16, iso-8859-1-windows-3-0-latin-1, iso-8859-1-windows-3-1-latin-1, iso-8859-2, iso-8859-2-windows-latin-2, iso-8859-3, iso-8859-4, iso-8859-5, iso-8859-6, iso-8859-6-e, iso-8859-6-i, iso-8859-7, iso-8859-8, iso-8859-8-e, iso-8859-8-i, iso-8859-9, iso-8859-9-windows-latin-5, iso-8859-supp, iso-ir-90, iso-unicode-ibm-1261, iso-unicode-ibm-1264, iso-unicode-ibm-1265, iso-unicode-ibm-1268, iso-unicode-ibm-1276, it, jis-c6220-1969-jp, jis-c6220-1969-ro, jis-c6226-1978, jis-c6226-1983, jis-c6229-1984-a, jis-c6229-1984-b, jis-c6229-1984-b-add, jis-c6229-1984-hand, jis-c6229-1984-hand-add, jis-c6229-1984-kana, jis-encoding, jis-x0201, jis-x0212-1990, jus-i-b1-002, jus-i-b1-003-mac, jus-i-b1-003-serb, koi8-r, koi8-u, ks-c-5601-1987, ksc5636, latin-greek, latin-greek-1, latin-lap, macintosh, microsoft-publishing, mnem, mnemonic, msz-7795-3, nats-dano, nats-dano-add, nats-sefi, nats-sefi-add, nc-nc00-10-81, nf-z-62-010, nf-z-62-010--1973-, ns-4551-1, ns-4551-2, pc8-danish-norwegian, pc8-turkish, pt, pt2, ptcp154, scsu, sen-850200-b, sen-850200-c, shift-jis, t-101-g2, t-61-7bit, t-61-8bit, tis-620, unicode-1-1, unicode-1-1-utf-7, unknown-8bit, us-ascii, us-dk, utf-16, utf-16be, utf-16le, utf-32, utf-32be, utf-32le, utf-7, utf-8, ventura-international, ventura-math, ventura-us, videotex-suppl, viqr, viscii, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1255, windows-1256, windows-1257, windows-1258, windows-31j, [StringNsExtensionPattern]

ColorEntryWKV BlackAndWhite1, Grayscale4, Grayscale8, Grayscale16, RGB24, RGB48, RGBa32, RGBa64, CMYK32, [KeywordNsExtensionPattern]

CompressionWKV Compress, Deflate, Gzip, ModifiedHuffman, ModifiedRead, MatsushitaWhitelineSkip, None,


923

924



[KeywordNsExtensionPattern]

ContentTypeWKV Auto, Text, Photo, TextAndPhoto, LineArt, Magazine, Halftone, [KeywordNsExtensionPattern]

CoverTypeWKV NoCover, PrintBack, PrintBoth, PrintFront, PrintNone, [KeywordNsExtensionPattern]

DocumentDigitalSignatureWKV

Dss, None, Pgp, Smime, Xdsig, [KeywordNsExtensionPattern]

DocumentFormatWKV

application/octet-stream, application/pdf, application/postscript, application/vnd.pwg-xhtml- Print+xml, application/vnd.hp-PCL, image/g3fax, image/jpeg, image/tiff, image/tiff-fx, text/html, text/plain, text/plain; charset=ISO-8859-1, text/plain; charset=US-ASCII, text/plain; charset=utf-8, unknown, [MimeExtensionPattern]

FeedOrientationWKV LongEdgeFirst, ShortEdgeFirst, [KeywordNsExtensionPattern]

FilmScanModeWKV NotApplicable, ColorSlideFilm, ColorNegativeFilm, BlackandWhiteNegativeFilm, [KeywordNsExtensionPattern]

FinishingsWKV Bale, Bind, BindBottom, BindLeft, BindRight, BindTop, BookletMaker, Cover, EdgeStitch, EdgeStitchBottom, EdgeStitchLeft, EdgeStichRight, EdgeStitchTop, Fold, JogOffset, None, Punch, SaddleStitch, Staple, StapleBottomLeft, StapleBottomRight, StapleDualBottom, StapleDualLeft, StapleDualRight, StapleDualTop, StapleTopLeft, StapleTopRight, Trim, TrimAfterCopies, TrimAfterDocuments, TrimAfterJob, TrimAfterPages, [KeywordNsExtensionPattern]

HoldUntilWKV DayTime, Evening, Indefinite, Night, NoHold, SecondShift, ThirdShift, Weekend, [KeywordNsExtensionPattern]

IdentifyActionWKV Display, Flash, Print, Sound, Speak, [KeywordNsExtensionPattern]

ImpositionWKV None, Signature, [KeywordNsExtensionPattern]


925

926



InputSourceWKV ADF, Platen, FilmReader, [KeywordNsExtensionPattern]

JobAccountingSheetTypeWKV

None, Standard, [KeywordNsExtensionPattern]

JobErrorSheetTypeWKV

None, Standard, [KeywordNsExtensionPattern]

JobErrorSheetWhenWKV

Always, OnError, [KeywordNsExtensionPattern]

JobPasswordEncryptionWKV

AES, ECC, Md2, Md4, Md5, None, Sha, TripleDES, [KeywordNsExtensionPattern]

JobSheetsWKV BothSheets, EndSheet, First PrintStreamPage, None, Standard, StartSheet, [KeywordNsExtensionPattern]

MediaCoatingWKV none, glossy, high-gloss, semi-gloss, satin, matte, [MediaNsExtensionPattern]

MediaColorWKV no-color, white, pink, yellow, blue, green, buff, goldenrod, red, gray, ivory, orange, [MediaColorExtensionPattern]

MediaGrainWKV x-direction, y-direction, [MediaNsExtensionPattern]

MediaInputTrayWKV top, middle, bottom, side, large-capacity, envelope, main, manual, [MediaNsExtensionPattern]

MediaPre PrintedWKV

blank, pre Printed, letterhead, [MediaNsExtensionPattern]

MediaRecycledWKV none, standard, [MediaNsExtensionPattern]

MediaSourceWKV Alternate, AlternateRoll, Auto, Bottom, Center, Disc, Envelope, Hagaki, LargeCapacity, Left, Main, MainRoll, Manual, Middle, Photo, Rear, Right, Side, Top, Tray1, Tray2, Tray3, Tray4, Tray5, Tray6, [MediaNsExtensionPattern]

MediaToothWKV coarse, fine, medium, [MediaNsExtensionPattern]

MediaTypeWKV back- Print-film, cardstock, continuous, continuous-long, continuous-short, envelope, envelope-plain, envelope-


927

928


Update MediaXXX from MSN 2 and JPS 3.



window, full-cut-tabs, labels, pre-cut-tabs, multi-layer, multi-part-forms, photographic, photographic-film, photographic-glossy, photographic-high-gloss, photographic-matte, photographic-satin, photographic-semi-gloss, roll, screen, screen-paged, stationery, stationery-coated, stationery-fine, stationery-heavyweight, stationery-inkjet, stationery-letterhead, stationery-lightweight, stationery-pre Printed, stationery-prepunched, tab-stock, transparency, other, [MediaTypeExtensionPattern]

MediaWKV asme_f_28x40in, iso_2a0_1189x1682mm, iso_a0_841x1189mm, iso_a0x3_1189x2523mm, iso_a1_594x841mm, iso_a10_26x37mm, iso_a1x3_841x1783mm, iso_a1x4_841x2378mm, iso_a2_420x594mm, iso_a2x3_594x1261mm, iso_a2x4_594x1682mm, iso_a2x5_594x2102mm, iso_a3_297x420mm, iso_a3-extra_322x445mm, iso_a3x3_420x891mm, iso_a3x4_420x1189mm, iso_a3x5_420x1486mm, iso_a3x6_420x1783mm, iso_a3x7_420x2080mm, iso_a4_210x297mm, iso_a4-extra_235.5x322.3mm, iso_a4-tab_225x297mm, iso_a4x3_297x630mm, iso_a4x4_297x841mm, iso_a4x5_297x1051mm, iso_a4x6_297x1261mm, iso_a4x7_297x1471mm, iso_a4x8_297x1682mm, iso_a4x9_297x1892mm, iso_a5_148x210mm, iso_a5-extra_174x235mm, iso_a6_105x148mm, iso_a7_74x105mm, iso_a8_52x74mm, iso_a9_37x52mm, iso_b0_1000x1414mm, iso_b1_707x1000mm, iso_b10_31x44mm, iso_b2_500x707mm, iso_b3_353x500mm, iso_b4_250x353mm, iso_b5_176x250mm, iso_b5-extra_201x276mm, iso_b6_125x176mm, iso_b6c4_125x324mm, iso_b7_88x125mm, iso_b8_62x88mm, iso_b9_44x62mm, iso_c0_917x1297mm, iso_c1_648x917mm, iso_c10_28x40mm, iso_c2_458x648mm, iso_c3_324x458mm, iso_c4_229x324mm, iso_c5_162x229mm, iso_c6_114x162mm, iso_c6c5_114x229mm, iso_c7_81x114mm, iso_c7c6_81x162mm, iso_c8_57x81mm, iso_c9_40x57mm, iso_dl_110x220mm, iso_ra0_860x1220mm, iso_ra1_610x860mm, iso_ra2_430x610mm,


929

930



iso_sra0_900x1280mm, iso_sra1_640x900mm, iso_sra2_450x640mm, jis_b0_1030x1456mm, jis_b1_728x1030mm, jis_b10_32x45mm, jis_b2_515x728mm, jis_b3_364x515mm, jis_b4_257x364mm, jis_b5_182x257mm, jis_b6_128x182mm, jis_b7_91x128mm, jis_b8_64x91mm, jis_b9_45x64mm, jis_exec_216x330mm, jpn_chou2_111.1x146mm, jpn_chou3_120x235mm, jpn_chou4_90x205mm, jpn_hagaki_100x148mm, jpn_kahu_240x322.1mm, jpn_kaku2_240x332mm, jpn_oufuku_148x200mm, jpn_you4_105x235mm, na_10x11_10x11in, na_10x13_10x13in, na_10x14_10x14in, na_10x15_10x15in, na_10x15_10x15in, na_11x12_11x12in, na_11x15_11x15in, na_12x19_12x19in, na_5x7_5x7in, na_6x9_6x9in, na_7x9_7x9in, na_9x11_9x11in, na_a2_4.375x5.75in, na_arch-a_9x12in, na_arch-b_12x18in, na_arch-c_18x24in, na_arch-d_24x36in, na_arch-e_36x48in, na_b-plus_12x19.17in, na_c_17x22in, na_c5_6.5x9.5in, na_d_22x34in, na_e_34x44in, na_edp_11x14in, na_eur-edp_12x14in, na_executive_7.25x10.5in, na_f_44x68in, na_fanfold-eur_8.5x12in, na_fanfold-us_11x14.875in, na_foolscap_8.5x13in, na_govt-legal_8x13in, na_govt-letter_8x10in, na_index-3x5_3x5in, na_index-4x6_4x6in, na_index-4x6-ext_6x8in, na_index-5x8_5x8in, na_invoice_5.5x8.5in, na_ledger_11x17in, na_legal_8.5x14in, na_legal-extra_9.5x15in, na_letter_8.5x11in, na_letter-extra_9.5x12in, na_letter-plus_8.5x12.69in, na_monarch_3.875x7.5in, na_number-10_4.125x9.5in, na_number-11_4.5x10.375in, na_number-12_4.75x11in, na_number-14_5x11.5in, na_number-9_3.875x8.875in, na_personal_3.625x6.5in, na_quarto_8.5x10.83in, na_super-a_8.94x14in, na_super-b_13x19in, na_wide-format_30x42in, om_dai-pa-kai_275x395mm, om_folio_210x330mm, om_folio-sp_215x315mm, om_invite_220x220mm, om_italian_110x230mm, om_juuro-ku-kai_198x275mm, om_large-photo_200x300mm, om_pa-kai_267x389mm, om_postfix_114x229mm, om_small-photo_100x150mm, prc_1_102x165mm, prc_10_324x458mm, prc_16k_146x215mm, prc_2_102x176mm, prc_3_125x176mm, prc_32k_97x151mm,


931

932



prc_4_110x208mm, prc_5_110x220mm, prc_6_120x320mm, prc_7_160x230mm, prc_8_120x309mm, pwg_letter-or-a4_choice, roc_16k_7.75x10.75in, roc_8k_10.75x15.5in, a0x2, a0x3, a1x3, a1x4, a2x3, a2x4, a2x5, a3x3, a3x4, a3x5, a3x6, a3x7, a4x3, a4x4, a4x5, a4x6, a4x7, a4x8, a4x9, arch-a, arch-b, arch-c, arch-d, arch-e, c, d, e, executive, f, folio, invoice, iso-a0, iso-a1, iso-a10, iso-a1x3, iso-a1x4, iso-a2, iso-a2x3, iso-a2x4, iso-a2x5, iso-a3, iso-a3-extra, iso-a3x3, iso-a3x4, iso-a3x5, iso-a3x6, iso-a3x7, iso-a4, iso-a4x3, iso-a4x4, iso-a4x5, iso-a4x6, iso-a4x7, iso-a4x8, iso-a4x9, iso-a5, iso-a6, iso-a7, iso-a8, iso-a9, iso-b0, iso-b1, iso-b10, iso-b2, iso-b3, iso-b4, iso-b5, iso-b6, iso-b7, iso-b8, iso-b9, iso-c0, iso-c1, iso-c2, iso-c3, iso-c4, iso-c5, iso-c6, iso-c7, iso-c8, iso-designated, iso-ra0, iso-ra1, iso-ra2, iso-sra0, iso-sra1, iso-sra2, jis-b0, jis-b1, jis-b10, jis-b2, jis-b3, jis-b4, jis-b5, jis-b6, jis-b7, jis-b8, jis-b9, monarch-envelope, na-10x13-envelope, na-10x14-envelope, na-10x15-envelope, na-10x15-envelope, na-6x9-envelope, na-7x9-envelope, na-8x10, na-9x11-envelope, na-legal, na-letter, na-number-10-envelope, na-number-9-envelope, quarto, tabloid, 10x11, 10x13, 10x14, 10x15, 11x12, 11x15, 12x19, 2a0, 5x7, 6x9, 7x9, 9x11, a, a0, a1, a10, a2, a3, a4, a4-extra, a4-tab, a5, a5-extra, a6, a7, a8, a9, architecture-a, architecture-b, architecture-c, architecture-d, architecture-e, architecture-f, b, b0, b1, b10, b2, b3, b4, b5, b5-extra, b6, b6/c4, b7, b8, b9, b-plus, c0, c1, c10, c2, c3, c4, c5, c6, c6/c5, c7, c7/c6, c8, c9, chou2, chou3, chou4, comm-10, dai-pa-kai, designated-long, dl, e1, edp, engineering-a, engineering-b, engineering-c, engineering-d, engineering-e, engineering-f, european-edp, exec, f, fanfold-European, fanfold-us, folio-sp, foolscap, german-legal-fanfold, government-legal, government-letter, hagaki, half-letter, index-3x5, index-4x6, index-4x6-ext, index-5x8, Invite, Italian, juuro-ku-kai, kahu, kaku2, large-photo, ledger, legal, legal-extra, letter, letter-extra, letter-plus, letter-tab, mini, number-11, number-12, number-14, oufuku, pa-kai, personal, Postfix, prc1, prc10, prc-16k, prc2, prc3, prc-32k, prc4, prc5, prc6, prc7, prc8, roc-16k, roc-8k, small-photo, statement, super-a, super-b, tabloid-extra, wide-format, you4, bottom, by-pass-tray, large-capacity, main, manual, middle, top, side, tray-1, tray-2, tray-3, tray-4, tray-5, tray-6,


933

934



tray-7, tray-8, tray-9, tray-10, [MediaSizeNameExtensionPattern]

MultipleDocumentsHandlingWKV

SeparateDocumentsCollatedCopies, SeparateDocumentsUncollatedCopies, SingleDocument, SingleDocumentNewSheet, [KeywordNsExtensionPattern]

MultipleOperationTimeoutActionWKV

Abort, Hold, Process, [KeywordNsExtensionPattern]

NaturalLanguageWKV

ar, de, en, en-us, es, fr, hi, it, ja, pt, zh, [NatLangExtensionPattern]

OperatingSystemNameWKV

aegis, amiga-os-1.2, amiga-os-1.3, amiga-os-2.0, amiga-os-2.1, amiga-os-3.0, amiga-os-3.1, amiga-os-3.5, amiga-os-3.9 , apollo, aix/370, aix-ps/2, beos-4.5.2, beos-5.0, bs-2000, cedar, cgw, chorus, chrysalis, cmos, cms, cos, cpix, ctos, ctss, dcn, ddnos, domain, dos, edx, elf, embos, emmos, epos, foonex, freebsd, forth, fuzz, gcos, gpos, hdos, imagen, instant-internet, intercom, impress, interlisp, ios, irix, isi-68020, its, kosos, linux, linux-1.0, linux-1.2, linux-2.0, linux-2.2, linux-2.4, lisp, lispm, locus, macos, minos, mos, mpe5, mpe/v, mpe/ix, msdos, multics, music, music/sp, mvs, mvs/sp, netbsd-1.0, netbsd-1.1, netbsd-1.2, netbsd-1.3, netware-3, netware-3.11, netware-4.0, netware-4.1, netware-5.0, nexus, nms, nonstop, nos-2, ntos, openbsd, openvms, os/ddp, os/2, os4, os86, osx, pcdos, perq/os, pli, psdos/mit, psos, primos, risc-os, risc-os-3.10, risc-os-3.50, risc-os-3.60, risc-os-3.70, risc-os-4.00, rmx/rdos, ros, rsx11m, rte-a, satops, sinix, sco-open-desktop-1.0, sco-open-desktop-1.1, sco-open-desktop-2.0, sco-open-desktop-3.0, sco-open-desktop-lite-3.0, sco-open-server-3.0, sco-unix-3.2.0, sco-unix-3.2v2.0, sco-unix-3.2v2.1, sco-unix-3.2v4.0, sco-unix-3.2v4.1, sco-unix-3.2v4.2, sco-xenix-386-2.3.2, sco-xenix-386-2.3.3, sco-xenix-386-2.3.4, scs, simp, sun, sun-os-3.5, sun-os-4.0, swift, tac, tandem, tenex, the-major-bbs, tops10, tops20, tos, tp3010, trsdos, ultrix, unix, unix-bsd, unix-v1at, unix-v, unix-v.1, unix-v.2, unix-v.3, unix-pc, unknown, ut2d, v, vm, vm/370, vm/cms, vm/sp, vms, vms/eunice, vrtx, waits, wang, win32, windows-95, windows-95-osr1, windows-95-osr2, windows-98, windows-ce, windows-nt, windows-nt-2, windows-nt-3, windows-nt-3.5, windows-nt-3.51, windows-


935

936



nt-4, windows-nt-5, worldgroup, wyse-wyxware, x11r3, xde, xenix, [OperatingSystemNameExtensionPattern]

OrientationRequestedWKV

Landscape, Portrait, ReverseLandscape,ReversePortrait, [KeywordNsExtensionPattern]

OutputBinWKV Bottom, Center, Face-down, Face-up, Large-capacity, Left, Middle, My-mailbox, Rear, Right, Side, Top, [KeywordNsExtensionPattern]

OutputChannelWKV Other, Unknown, SerialPort, ParallelPort, IEEE1284Port, SCSIPort, FTP, TFTP, IEEE1394, DCERemoteProcCall, ONCRemoteProcCall, OLE, NamedPipe, ServerMessageBlock, DLLAPI, VxDAPI, SystemObjectManager, DECLAT, USB, IRDA, PortTCP, BidirPortTCP, PortHTTP,, [KeywordNsExtensionPattern]

PageDeliveryWKV ReverseOrderFaceDown, ReverseOrderFaceUp, SameOrderFaceDown, SameOrderFaceUp, SystemSpecified, [KeywordNsExtensionPattern]

PageOrderReceivedWKV

1ToNOrder, NTo1Order, [KeywordNsExtensionPattern]

PdlOverrideSupportedWKV

Attempted, Guaranteed, NotAttempted, [KeywordNsExtensionPattern]

PresentationDirectionNumberUpWKV

TobottomToleft, TobottomToright, ToleftTobottom, ToleftTotop, TorightTobottom, TorightTotop, TotopToleft, TotopToright, [KeywordNsExtensionPattern]

PrintColorModeWKV Auto, BiLevel, Color, Highlight, Monochrome, ProcessBiLevel, ProcessMonochrome, [KeywordNsExtensionPattern]

PrintContentOptimizeWKV

Graphics, Photo, Text, TextAndGraphics, [KeywordNsExtensionPattern]

PrintQualityWKV Draft, High, Normal, [KeywordNsExtensionPattern]

PrintRenderingIntentWKV

Absolute, Perceptual, Relative, Saturation, [KeywordNsExtensionPattern]


937

938



PwgRasterDocument

BacksideWKV

Flipped, ManualTumble, Normal, Rotated, [KeywordNsExtensionPattern]

RegionUnitWKV Absolute, Perceptual, Relative, Saturation, [KeywordNsExtensionPattern]

SaveDispositionWKV None, PrintSave, SaveOnly, [KeywordNsExtensionPattern]

SeparatorSheetsTypeWKV

BothSheets, EndSheet, None, SlipSheets, StartSheet, [KeywordNsExtensionPattern]

SheetCollateWKV Collated, Uncollated, [KeywordNsExtensionPattern]

SidesWKV OneSided, TwoSidedLongEdge, TwoSidedShortEdge, [KeywordNsExtensionPattern]

StitchingReferenceEdgeWKV

Bottom, Left, Right, Top, [KeywordNsExtensionPattern]

TemplateTypeWKV

CopyDocument, CopyJob, EmailInDocument, EmailInJob, EmailOutDocument, EmailOutJob, FaxInDocument, FaxInJob, FaxOutDocument, FaxOutJob, NetFaxInDocument, NetFaxInJob, NetFaxOutDocument, NetFaxOutJob, PrintDocument, PrintJob, ScanDocument, ScanJob, TransformDocument, TransformJob, Vendor, [KeywordNsExtensionPattern]

UnitsWKV Dpcm. Dpi, [KeywordNsExtensionPattern]

XImagePositionWKV

Center, Left, None, Right, [KeywordNsExtensionPattern]

YImagePositionWKV

Bottom, Center, None, Top, [KeywordNsExtensionPattern]

29. Appendix D: Keyword Value extension patternsTable 83 shows the extension patterns for PWG keyword elements. The regular expression syntax is specified in appendix F of the XML Schema Part 2: Datatypes


939

6617

6618

66196620

940


Clean up the numbering.


Second Edition specification [XMLDAT]. The link to the appendix that covers regular expressions is <http://www.w3.org/TR/xmlschema-2/#dt-regex>

Table 104 Keyword Value extension patterns

Pattern Name Regular Expression

KeywordNsExtensionPattern \w+:[\w_\-\.]+

MediaColorExtensionPattern custom-media-color-[a-z][a-z0-9\-]*

MediaNsExtensionPattern \w+:[\w:/;_\-\.]+

MediaSizeNameExtensionPattern (custom_max|custom_min|custom|na|asme|roc|oe)_[\p{Ll}\d][\p{Ll}\d\-]*_\d+(\.\d+)?x\d+(\.\d+)?in

(custom_max|custom_min|custom|na|asme|roc|oe)_[\p{Ll}\d][\p{Ll}\d\-]*_\d+(\.\d+)?x\d+(\.\d+)?mm

MediaTypeExtensionPattern custom-media-type-[a-z][a-z0-9\-]*

MimeExtensionPattern \w+[\w:/;_\-\\\+\.]*

NatLangExtensionPattern \w+[\w:/;_\-\\\+\.]*

OperatingSystemNameExtensionPattern [A-Z/\.\-]+

StringExtensionPattern \w+[\w:/;_\-\\\+\.]*

StringNsExtensionPattern \w+:[\w:/;_\-\\\+\.]*

30. Appendix D – IPP Mapping

30.1 Changes to remove some IPP specific aspects

This section lists some changes to remove some IPP specific aspects from the PWG Semantic Model.


941

66216622

6623

6624

6625

6626

66276628

942


Keep this section.


There are extension patterns in the schema. Remove this table. Just include the discussion. Point to PWG SM XML Schema.

http://www.w3.org/TR/xmlschema-2/#dt-regex


IPP enumerations use their well-known string name instead of the integer enumeration. This applies not only to IPP attributes but also to IPP Operations.

Any IPP attribute name containing “ipp” has had the “ipp” removed.

All IPP attribute and operation keywords have the substring “attribute” replaced with “element”.

All IPP operation, status codes, attribute, and attribute value keyword names have had the first letter capitalized and the ‘-‘ character removed and the character following the ‘-‘ has been capitalized. (All mixed case PWG Semantic Model keywords can be interpreted without regard to case.)

Certain elements prefixed with”Job” that apply to either Jobs or Documents has had the “Job” prefix removed. (This mapping clarified by the value in the “Group” cell of the PWG SMv2 Element Summary table in appendix A)

The IPP attribute value keywords defined in other registries remain unchanged. Note that the PWG defined media keyword values for the Semantic Elements MediaType, MediaColor, MediaSizeName and Media use the values as specified in PWG 5101.1.

XML datatypes are used that map as closely as possible to the IPP specification.

The IPP datatypes NameWithoutLanguage, NameWithLanguage, TextWithoutLanguage and TextWithLanguage are mapped to the XML datatype String. Localization is handled globally by the ElementsNaturalLanguage element.

The IPP datatype Enum is mapped to the XML datatype NMToken. See #1 above.

The IPP collection datatype is represented as an XML sequence. Although sequence is used the set of elements is unordered unless order is explicitly specified in the element definition.

The “1setOf X” types are represented as the base type and the “Multivalued” field in the tables set to “Yes”.

Any constraints placed on attribute values has been noted in the tables and whenever possible expressed in the XML schema.

The term “keyword” continues to be used for string values enumerated as part of the PWG Model. The term “object” is sometimes changed to “data class”. The term “operation” has been changed to “action” to use the term more frequently used with XML.

The following IPP attributes are not included: operation-id, attributes-charset, request-id.


943

66296630

6631

66326633

6634663566366637

663866396640

6641664266436644

6645

6646664766486649

6650

665166526653

66546655

66566657

665866596660

6661

944


30.2 Attribute Group Mapping

IPP Actions may contain a number of parameters. The first parameter is always the Operation Attributes for the Action. The IPP Operation Attributes have been mapped to the Printer and Job Description Element Groups.

The IPP Printer Description Attributes map to the PWG Printer Status Elements and Printer Description Elements. The IPP Job Description Attributes map to the PWG Job Status Elements and Job Description Elements. The PWG Model differentiates elements that can be directly set (i.e., Description) versus those that are maintained by automata and can only be changed through first class operations (i.e., Status)

The IPP Job Template Attributes map to the PWG Job Processing Elements and Document Processing Elements.


945

6662

666366646665

66666667666866696670

66716672

6673

6674

6675

946


Keep.


31. Image Terms and Conventions

31.1 Content Region and Images

An Imaging System deals with Documents, converting them from Hardcopy to Digital Document, Digital to Hardcopy Document, Hardcopy to Hardcopy Document or Digital to another form of Digital Document. There is not always a 1:1 relation between a Hardcopy Document and the Digital Document derived from it or from which it is derived. Services that can obtain input from a Scanner Subunit (e.g., Scan, Copy and FaxOut) may allow the user to select or may restrict regions of the original hardcopy to be rendered in the Digital Document. Similarly, Services that provide output to a Marker Subunit may allow selection or may restrict regions of the Digital Document to be rendered in the Hardcopy Document output.

31.1.1 Content Region

Content Region is a complex type referring to a rectangular area of interest in a Document; i.e., an area of the Document that contains desired content. In the Imaging System modeling, the Scan Region and ImageBox complex Elements are of the Content Region type. The Elements in the Scan Region, which also constitute the constituent Elements of the Content RegionType, are shown in Figure 8.

Figure 188 Scan Region Element

It is possible to identify multiple Scan Regions on a media sheet side. Each such region has a one-to-one mapping to a scanned image. The relationships among Hardcopy Document, Scan Region, and Image are represented in Figure 9. A Service using the


947

6676

6677

667866796680668166826683668466856686

6687

66886689669066916692

6693

6694

669566966697

948


Scanner Subunit defines a Scan Region and converts the acquired data into an Image. The encoding of the Image at this point is implementation specific. The Service accumulates the set of images that are to be extracted from the input Hardcopy Document and encodes them in the format reflecting appropriate to the Service and the User Intent to produce the Digital Document Depending upon the Service, this Digital Document may be sent to a repository (Scan), to a Printer (Copy), or transmitted as a Facsimile (FaxOut).

Content Region also applies to a Service using the Marker Subunit, such as Print. In most cases, the selection of Content Region in these cases is done outside of the Imaging System . However, in certain production Printing environments, there are Service Elements to define a Print content region independent of the maximum Printable area defined as part of the Marker Subunit status. These Elements are included in the Print Service model, but being limited to a special type of Print Service, are not described here. See Production Printing Attributes Set 1[PWG 5100.3], Para. 2.2 Finished Page Image Cell.

Figure 189 Hardcopy Document, Region, Image Relationsh

31.1.2 Job/Document Object and Digital Document Cardinality

There can be multiple Documents in a Job. Digital Documents are output as Files. Therefore, there are various ways in which the Services that accept multi-Document Jobs


949

669866996700670167026703

67046705670667076708670967106711

6712

6713

6714

67156716

950


(i.e., Scan and Transform) can provide their Digital Document output. These are diagramed in Figure 10.

Figure 190 Document Cardinality

SDSF (Single Document Single File Job): One Document object that contains a reference to one single file. There is one file URI for the single Document location. The Destination is the Document URI; i.e., the single file URI.

SDMF (Single Document Multiple File Job): One Document object that contains references to multiple files. Each image in the Document data is stored in a separate file. There is one file URI per image file which constitutes the Document. The Destination is the directory URI of the files for the Document.

MDSF (Multiple Document Single File Job): Job object contains multiple Document objects. Each Document can have a different set of processing parameters. Each file contains a specified number of images for the Document. Each such set of images is stored in a separate file. Each Document object contains one file URI for each image file location. Each Destination is a Document URI; i.e., the single file URI.

MDMF (Multiple Document Multiple File Job): Job object contains multiple Document objects. Each Document can have different set of processing parameters from another. Each image in the Document data is stored in a separate file. The Document object contains a file URI for each image file location. Each Destination is the directory URI for the Document.

A Scan or Transform Job produces 1 to N Document objects. The Job has a unique ID within a unique Service. The Documents within the Job are numbered 1 to N. The Destination of a multi-Document Job is a directory for multi-Document files. After the Document file is stored, the Document file URI will be updated in the Document object as the Document location.


951

67176718

6719

6720

672167226723

6724672567266727

67286729673067316732

67336734673567366737

67386739674067416742

952


In addition to URI, the MIME type of a stored Document MUST be specified by the end user to clearly indicate the content type to be used for transporting the stored Document.

The capability of a Service to generate the various Document/File cardinalities is declared in the Document Output Mode in the Job Processing Capabilities Element. The value of the Document Output Mode which is set in the Job Ticket allows an End User to request one of the supported values.

31.2 Coordinate Systems

All primary Imaging Services deal with Documents that, at some point in their existence, are visually presented for human consumption. Ideally, Imaging Services would use a consistent coordinate system mapping between a hardcopy (or monitor displayed) Document and its Digital Document form. However, different systems have evolved in different environments and a realistic coordinate system approach must accommodate the existing practices. This section discusses the relationships between the coordinate systems used for scanning, Printing, and for various Digital Document formats.

31.2.1 Coordinate Nomenclature

In a comprehensive Imaging System model, the intent is that the definition of a semantic Element be consistent across the modeling of the constituent Services. Because this also applies to the coordinate system semantics, there may appear to be some inconsistency in the names associated with coordinate related semantics.

There are Scan Subunit specific semantics (e.g., Fast Scan Direction), Print Subunit semantics, media related semantics (e.g., width), as well as general image processing semantics (e.g., X). Each semantic system has terms which are related to terms in the other systems. The terms Cross Feed, XFeed, Fast Scan, X, and Width are semantically aligned. For Scan and Print Subunits, these terms refer to the axis which is perpendicular to the movement of the Hard Copy Document, the Scan Subunit’s light bar or the Print Subunit’s Print head or laser sweep path; it is also the axis along which the image data is read or written most quickly. The terms Feed, SlowScan, Y, and Height are semantically aligned. They refer to the axis which is parallel to the movement of the Hard Copy Document, the Scan Subunit’s light bar or the Print Subunit’s Print head or laser sweep path; it is also the axis along which the image data is read or written most slowly.

31.2.2 Content Coordinate Systems

Below are descriptions of the coordinate systems and units of measures for the Scanner and Marker Subunits and various Services. The Digital Document output is discussed as it relates to the semantic of the layout affecting Document Processing Elements.


953

67436744

6745674667476748

6749

6750675167526753675467556756

6757

6758675967606761

67626763676467656766676767686769677067716772

6773

677467756776

954


31.2.2.1 Scan and Marker Subunit Media Content Coordinates

Figure 11 identifies the terms used to describe the placement and relative motion of media on a hardcopy scanner or Printer. The outermost rectangle represents the surface upon which the media moves in the case of a scanner ADF or typical Printer, or rests in the case of a flatbed scanner. The dimensions of this are given in terms of a MediaPathMax Element for Printers and a Scan Media Path for scanners. In the case of a flatbed scanner, the platen is considered an instance of the Scan Media Path. These dimensions determine the maximum sized media that may be accommodated.

The media content (represented by the innermost rectangle in Figure 11) is the information that is being impressed upon the media or read from the media. The media itself is represented by the middle rectangle. The leading edge of the media is referred to as the North (N) edge, with the side of the media containing the content area facing the observer. The other edges of the media are defined by the normal compass layout of East (E), West (W), and South (S), with the compass facing the observer.

Figure 191 Scanner or Marker Coordinates

In a Scanner ADF or a typical Printer, the media is moved in the direction indicated by the large arrow in Figure 11; in a flatbed scanner, the media may be stationary and the Scan head moved in the opposite direction. In either case, the relative direction of motion of the


955

6777

6778677967806781678267836784

678567866787678867896790

6791

6792

679367946795

956


media with respect to the head is the same as is the direction of feed or slow-scan (as indicated by the arrow at the right of the diagram.) The content area is scanned in two orthogonal directions, variously defined as Cross Feed, Fast Scan or X and Feed, SlowScan or Y. The origin is at the leading edge of the Cross Feed and proceeds down the media.

31.2.2.2 Service Coordinates

Figure 12 shows the coordinate system that is used for a Service using a Scanner Subunit. The Content Region is facing the observer. Note that a Content Region for a Scan Service is termed a Scan Region (para. 2.4.) The Service coordinate system and the defining parameters are the same in both cases. The Scan Region associated with a Scan operation is defined in terms of the offset from the junction of the Fast Scan and SlowScan origins and the height and width dimensions of the region. The coordinate system for the Device and Service are linked together; that is, the origin of the Device’s coordinate system is the same as the origin of the Service’s coordinate system. The Scan Region may be defined by the user, or it may be default to the media size or the maximum allowable Scan area. It is possible to have multiple overlapping Scan Regions.

Figure 192 Service Scan Coordinates


957

67966797679867996800

6801

6802680368046805680668076808680968106811

6812

6813

958


31.2.2.3 Document Format Coordinates

When the output of a Service such as Scan or Transform is converted into certain Document Formats and stored (e.g., PDF, XPS), under some circumstances the entire image may not be stored. This is because these Document formats contain various constructs that bound the area where the image can be placed.

As represented in Figure 13, the Imaging System Model includes the Image Box and the Media Box. The Image Box is where the image will be placed and corresponds to the Hardcopy Document “content area” within the Digital Document. The Media Box delineates the area where the image can appear in the output Document and corresponds to the Hardcopy Document Media Size that may or may not be assumed in the Digital Document. If the X Offset and Y Offset are absent or set to 0, the origin of the coordinate systems for the Image Box and Media Box are aligned.

Figure 193 Document Format coordinates

These bounding boxes correspond to two PostScript bounding boxes.

- ImagingBBox: A bounding box defining an outer boundary for each page image. This corresponds to the Imaging System Model Image Box.

- PageSize: A rectangular area corresponding to the overall dimensions of the physical medium that was assumed in page description. This corresponds to the Imaging System Model Media Box.


959

6814

6815681668176818

6819682068216822682368246825

6826

6827

6828

68296830

683168326833

960


The Portable Document Format (PDF) defines five boxes described by various bounding conditions:

- ArtBox: A rectangle, expressed in default user space units, defining the extent of the page’s meaningful content (including potential white space) as intended by the page’s creator. This corresponds to the Imaging System Model Image Box

- MediaBox: A rectangle, expressed in default user space units, defining the boundaries of the physical medium on which the page is intended to be displayed or Printed. This corresponds to the Imaging System Model Media Box.

PDF also defines some additional bounding boxes than are not included in the Imaging System Model.

- BleedBox: A rectangle, expressed in default user space units, defining the region to which the contents of the page should be clipped when output in a production environment

- CropBox: A rectangle, expressed in default user space units, defining the visible region of default user space. When the page is displayed or Printed, its contents are to be clipped (cropped) to this rectangle and then imposed on the output medium in some implementation-defined manner.

- TrimBox: A rectangle, expressed in default user space units, defining the intended dimensions of the finished page after trimming.


961

68346835

683668376838

683968406841

68426843

684468456846

6847684868496850

68516852

6853

962


32. Change Log

32.1 January 3, 2012

Initial revision. Converted MFD Model and Common Semantics Version 1.0 to new PWG template & changed name. All the figures have been updated. (Revision marks turned off) – Peter Zehler.

32.2 January 9, 2012

Updated to latest JPs3 and Raster spec. Began adding missing elements to appendix A. Added section on IPP mapping. (Revision marks turned on) – Peter Zehler.

32.3 June 3, 2013

Updated the Abstract, and the section on “About the Semantic Model Working Group” – Daniel Manchala.

32.4 June 15, 2013

Assembled sections from Requirements and individual Service specifications

32.5 June 24, 2013

Modifications in organization and format made in accord with minutes of 17 June conference call.


963

6854

6855

685668576858

6859

68606861

6862

68636864

6865

6866

6867

68686869

6870

964