proj title of specification (acronym)ftp.pwg.org/.../mfd/wd/wd-pwgsemanticmodel20-20130615.docx ·...

May 6, 2023Working Draft

The Printer Working Group

PWG Semantic Model v2.0 (SM2)

Status: Initial

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 in a separate section. The various imaging services include Print, scan, fax-in, fax-out, email-in, email-out, transform and a network resource service.

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-20130615.pdf

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

123456789

10

11

12

13

14

15

1617181920

21

22

2324

25

26

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 15, 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 379 Copyright © 2011-2013 The Printer Working Group. All rights reserved.

1

27

282930313233

34

353637

383940

41424344

454647484950

515253

54555657

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

58

5960616263

64

65

66

676869707172737475

767778

79

80

81

828384858687

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, Copy, 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

88

899091929394

95

96

979899

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.....................................................................................................................20

1.1 Scope........................................................................................................................................................................................20

1.2 Background...........................................................................................................................................................................20

2. TERMINOLOGY......................................................................................................................22

2.1 Conformance Terminology..............................................................................................................................................22

2.2 Other Terminology.............................................................................................................................................................22

2.3 Modeling Representations used in this Document.................................................................................................272.3.1 Element, Operation and Attribute Name Representation...............................................................................................272.3.2 “Any” Element and “Any” Attribute Extensions...................................................................................................................282.3.3 Representation of Mandatory versus Optional Elements and Number of Instances..........................................282.3.4 Representation of Exclusive Or...................................................................................................................................................29

2.4 Datatypes...............................................................................................................................................................................29

3. REQUIREMENTS.....................................................................................................................31

3.1 Rationale................................................................................................................................................................................31

3.2 Use Cases................................................................................................................................................................................313.2.1 Service Basic Functions..................................................................................................................................................................323.2.2 Consideration of Subunits.............................................................................................................................................................323.2.3 Imaging Service Use Scenarios....................................................................................................................................................32

3.2.3.1 Use Case 1: Create Job Template from a Remote Network Client Application.............................................32Scan Service Example........................................................................................................................................................................... 32Copy Service Example.......................................................................................................................................................................... 32FaxOut Example...................................................................................................................................................................................... 33Example Processing Steps..................................................................................................................................................................333.2.3.2 Use Case 2: Handling Multiple Hardcopy Documents from a Computer.........................................................33Service Examples....................................................................................................................................................................................33Example Processing Steps..................................................................................................................................................................343.2.3.3 Use Case 3: Walk-Up Batch-Scanned Input..................................................................................................................34Service Example...................................................................................................................................................................................... 34Example Processing Steps..................................................................................................................................................................343.2.3.4 Use Case 4: Pause Service for Pre-emptive use of Subunits.................................................................................35Pausing Scan Service.............................................................................................................................................................................35Pausing Print Service...........................................................................................................................................................................35Processing Steps..................................................................................................................................................................................... 353.2.3.5 Use Case 5: Service Discovery............................................................................................................................................36Processing Steps..................................................................................................................................................................................... 363.2.3.6 Use Case 6: Service Capability Discovery......................................................................................................................36Processing Steps..................................................................................................................................................................................... 37

3.3 Out of Scope...........................................................................................................................................................................37


7

100

101

102

103

104

105

106

107108109110111

112

113

114

115116117118119120121122123124125126127128129130131132133134135136137

138

8


3.4 Design Requirements.........................................................................................................................................................373.4.1 Basic Operations................................................................................................................................................................................373.4.2 Requirements from Common Use of Subunits.....................................................................................................................383.4.3 Design Requirements from Use Cases.....................................................................................................................................38

3.4.3.1 Requirement for a System...................................................................................................................................................393.4.3.2 Job Related Requirements...................................................................................................................................................393.4.3.3 Service Status and Description Requirements...........................................................................................................39

4. MODEL CONCEPTS.................................................................................................................40

4.1 Top Level Model Elements...............................................................................................................................................40

4.2 Overview of Services..........................................................................................................................................................41

4.3 Primary Service Interfaces..............................................................................................................................................41

4.4 Functional Overview of a Multifunction Device.......................................................................................................42

4.5 Jobs, Documents, Tickets and Templates...................................................................................................................44

4.6 Content Region and Images.............................................................................................................................................454.6.1 Content Region...................................................................................................................................................................................454.6.2 Job/Document Object and Digital Document Cardinality...............................................................................................46

4.7 Coordinate Systems............................................................................................................................................................474.7.1 Coordinate Nomenclature.............................................................................................................................................................474.7.2 Content Coordinate Systems........................................................................................................................................................48

4.7.2.1 Scan and Marker Subunit Media Content Coordinates...........................................................................................484.7.2.2 Service Coordinates................................................................................................................................................................494.7.2.3 Document Format Coordinates.........................................................................................................................................49

4.8 Job and Job Ticket Life Cycle............................................................................................................................................51

5. SYSTEM CONFIGURATION SUBUNITS.....................................................................................54

5.1 Common Subunit Elements..............................................................................................................................................565.1.1 Common Subunit Status Elements............................................................................................................................................57

5.1.1.1 Power Counters........................................................................................................................................................................585.1.1.2 Power Meters............................................................................................................................................................................ 585.1.1.3 Power Monitor..........................................................................................................................................................................595.1.1.4 Power Support..........................................................................................................................................................................605.1.1.5 Power Transition.....................................................................................................................................................................61

5.1.2 Common Subunit Description Elements.................................................................................................................................615.1.2.1 Power Calendar........................................................................................................................................................................625.1.2.2 Power Event...............................................................................................................................................................................635.1.2.3 Power Timeout.........................................................................................................................................................................64

5.2 Consoles..................................................................................................................................................................................64

5.3 Covers......................................................................................................................................................................................67

5.4 FaxModems............................................................................................................................................................................68


9

139140141142143144145

146

147

148

149

150

151

152153154

155156157158159160

161

162

163164165166167168169170171172173

174

175

176

10


5.5 Finishers.................................................................................................................................................................................72

5.6 Input Channels.....................................................................................................................................................................76

5.7 Input Trays............................................................................................................................................................................78

5.8 Interfaces...............................................................................................................................................................................81

5.9 Interpreters...........................................................................................................................................................................84

5.10 Marker..................................................................................................................................................................................86

5.11 Media Paths.........................................................................................................................................................................90

5.12 Output Channels................................................................................................................................................................92

5.13 Output Trays.......................................................................................................................................................................94

5.14 Processors...........................................................................................................................................................................97

5.15 Scan Media Paths..............................................................................................................................................................99

5.16 Scanners............................................................................................................................................................................101

5.17 Storages.............................................................................................................................................................................104

5.18 Vendor Subunits.............................................................................................................................................................106

6. SERVICE MODEL ELEMENT GROUPS.....................................................................................109

6.1 Job Table..............................................................................................................................................................................110

6.2 Service Available Job Ticket..........................................................................................................................................111

6.3 Service Capabilities and Service Capabilities Ready............................................................................................111

6.4 Service Job and Document Ticket Document Processing Capabilities..........................................................1136.4.1.1 Media Collection Supported.............................................................................................................................................120

6.4.2 Service Document Ticket Document Description Capabilities...................................................................................1226.4.3 Service Job Ticket Job Processing Capabilities..................................................................................................................125

6.5 Service Configuration......................................................................................................................................................130

6.6 Service Defaults.................................................................................................................................................................130

6.7 Service Description..........................................................................................................................................................1316.7.1 OwnerURI.......................................................................................................................................................................................... 1336.7.2 OwnerVCard..................................................................................................................................................................................... 1336.7.3 MultipleOperationTimeoutAction..........................................................................................................................................133

6.8 Service Status.....................................................................................................................................................................1366.8.1 Condition Table...............................................................................................................................................................................1386.8.2 Relationship among Service State, Service State Reasons, Condition Table and Service State Message Elements........................................................................................................................................................................................................ 140


11

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195196197198

199

200

201202203204

205206207208

12


7. COUNTERS & TIMERS...........................................................................................................141

7.1 Work Counters (WorkTotals, DataStream, Auxiliary, Waste and Maintenance).......................................142

7.2 MediaUsed Counters........................................................................................................................................................146

7.3 Availability Counters.......................................................................................................................................................147

7.4 Monitoring Counters.......................................................................................................................................................147

8. IMAGING JOB MODEL..........................................................................................................149

8.1 Job Status.............................................................................................................................................................................1498.1.1 JobOriginatingUri........................................................................................................................................................................... 153

8.2 Job Ticket.............................................................................................................................................................................1558.2.1 Job Ticket Document Processing.............................................................................................................................................155

8.2.1.1 Header Print............................................................................................................................................................................1628.2.1.2 Media Collection (Specific)...............................................................................................................................................166

8.2.2 Job Ticket Job Description..........................................................................................................................................................1688.2.3 JobTicket Job Processing.............................................................................................................................................................172

8.2.3.1 Description of DestinationUris’ Elements..................................................................................................................1738.2.3.2 Description of ConfirmationSheet Print Element...................................................................................................1748.2.3.3 Description of CoverSheetInfo’s Elements................................................................................................................1748.2.3.4 Description of RetryInfo’s Elements............................................................................................................................175

8.3 Job Receipt..........................................................................................................................................................................181

9. DOCUMENT MODEL.............................................................................................................182

9.1 Document Status...............................................................................................................................................................182

9.2 Document Ticket...............................................................................................................................................................1869.2.1 Document Description.................................................................................................................................................................1869.2.2 Document Processing...................................................................................................................................................................189

9.3 Document Receipt............................................................................................................................................................189

10. SERVICE OPERATIONS AND STATES....................................................................................190

10.1 General Service Sequence of Operation.................................................................................................................19010.1.1 Initialization and Startup.........................................................................................................................................................19010.1.2 Job Creation....................................................................................................................................................................................19110.1.3 Job Processing...............................................................................................................................................................................19110.1.4 Service Pause, Service Shutdown and Abnormal Job Termination.......................................................................192

10.2 Service, Job and Document States............................................................................................................................19210.2.1 Service States, Conditions and State Transitions..........................................................................................................192

10.2.1.1 Service States.......................................................................................................................................................................19210.2.1.2 Operations, Events and Conditions............................................................................................................................19310.2.1.3 Service State Transition by Operations....................................................................................................................19510.2.1.4 Service State Transition and Condition Change by Events..............................................................................195


13

209

210

211

212

213

214

215216

217218219220221222223224225226

227

228

229

230231232

233

234

235236237238239

240241242243244245

14


10.2.2 Job States and State Transitions...........................................................................................................................................19610.2.3 Document States and State Transitions.............................................................................................................................197

10.3 Service Operations.........................................................................................................................................................19910.3.1 Basic Service Operations..........................................................................................................................................................202

10.3.1.1 Add<service>HardcopyDocument.............................................................................................................................20210.3.1.2 Cancel<service>Document........................................................................................................................................20310.3.1.3 Cancel<service>Job...........................................................................................................................................................20310.3.1.4 CancelCurrent<service>Job...........................................................................................................................................20410.3.1.5 CancelMy<service>Jobs...................................................................................................................................................20410.3.1.6 Close<service>Job..............................................................................................................................................................20410.3.1.7 Create<service>Job...........................................................................................................................................................20510.3.1.8 Get<Service>DocumentElements...............................................................................................................................20510.3.1.9 Get<service>Documents.................................................................................................................................................20610.3.1.10 Get<service>JobElements............................................................................................................................................20610.3.1.11 Get<service>Jobs.............................................................................................................................................................20610.3.1.12 Get<service>ServiceElements...................................................................................................................................20610.3.1.13 GetActive<service>Jobs................................................................................................................................................20710.3.1.14 Hold<service>Job............................................................................................................................................................20710.3.1.15 Release<service>Job......................................................................................................................................................20710.3.1.16 Resubmit<service>Job..................................................................................................................................................20810.3.1.17 Resume<service>Job.....................................................................................................................................................20810.3.1.18 Send<service>Document.............................................................................................................................................20910.3.1.19 Send<service>Uri............................................................................................................................................................20910.3.1.20 Set<service>DocumentElements.............................................................................................................................21010.3.1.21 Set<service>JobElements............................................................................................................................................21110.3.1.22 SuspendCurrent<service>Job....................................................................................................................................211

10.3.2 Administrative Service Operations......................................................................................................................................21210.3.2.1 Cancel<service>Jobs.........................................................................................................................................................21310.3.2.2 Disable<service>Service.................................................................................................................................................21410.3.2.3 Enable<service>Service..................................................................................................................................................21410.3.2.4 HoldNew<service>Jobs...................................................................................................................................................21410.3.2.5 Pause<service>Service....................................................................................................................................................21510.3.2.6 Pause<service>ServiceAfterCurrentJob..................................................................................................................21510.3.2.7 Promote<service>Job.......................................................................................................................................................21610.3.2.8 ReleaseNew<service>Jobs.............................................................................................................................................21610.3.2.9 Restart<service>Service.................................................................................................................................................21610.3.2.10 Resume<service>Service.............................................................................................................................................21710.3.2.11 Set<service>ServiceElements....................................................................................................................................21710.3.2.12 Shutdown<service>Service........................................................................................................................................217

11. SPECIFIC IMAGING SERVICE MODELS.................................................................................219

11.1 Print Service.....................................................................................................................................................................21911.1.1 Print Service Model.................................................................................................................................................................... 219

11.1.1.1 Print ServiceCapabilities.................................................................................................................................................22011.1.1.2 Print ServiceCapabilitiesReady....................................................................................................................................22111.1.1.3 Print ServiceConfiguration............................................................................................................................................22111.1.1.4 Print ServiceDefaults........................................................................................................................................................22111.1.1.5 Print ServiceDescription.................................................................................................................................................22211.1.1.6 Print ServiceStatus............................................................................................................................................................222

11.1.2 PrintJob Model.............................................................................................................................................................................. 22211.1.2.1 PrintJobReceipt...................................................................................................................................................................22311.1.2.2 PrintJobStatus......................................................................................................................................................................223


15

246247

248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284

285

286287288289290291292293294295296

16


11.1.2.3 PrintJobTicket.....................................................................................................................................................................22311.1.2.4 PrintDocumentProcessing.............................................................................................................................................22311.1.2.5 PrintJobDescription..........................................................................................................................................................22311.1.2.6 PrintJobProcessing............................................................................................................................................................22411.1.2.7 Print Service Interfaces...................................................................................................................................................224

11.1.3 Conformance................................................................................................................................................................................. 224

11.2 Scan Service......................................................................................................................................................................22511.2.1 ScanService Model Overview.................................................................................................................................................225

11.2.1.1 ScanServiceDefaults..........................................................................................................................................................22511.2.1.2 ScanServiceCapabilities..................................................................................................................................................22511.2.1.3 ScanServiceCapabilitiesReady......................................................................................................................................22511.2.1.4 ScanServiceConfiguration..............................................................................................................................................22511.2.1.5 ScanServiceDescription...................................................................................................................................................22511.2.1.6 ScanServiceStatus..............................................................................................................................................................225

11.2.2 ScanJob Model...............................................................................................................................................................................22511.2.2.1 ScanJobReceipt....................................................................................................................................................................22511.2.2.2 ScanJobStatus...................................................................................................................................................................... 22511.2.2.3 ScanJobTicket...................................................................................................................................................................... 22511.2.2.4 ScanDocumentProcessing..............................................................................................................................................22511.2.2.5 ScanJobDescription...........................................................................................................................................................22511.2.2.6 ScanJobProcessing.............................................................................................................................................................225

11.2.3 ScanDocument Model................................................................................................................................................................22511.2.3.1 ScanDocumentReceipt.....................................................................................................................................................22511.2.3.2 ScanDocumentStatus........................................................................................................................................................22511.2.3.3 ScanDocumentTicket........................................................................................................................................................22511.2.3.4 ScanDocumentDescription............................................................................................................................................22511.2.3.5 ScanDocumentProcessing..............................................................................................................................................225

11.2.4 ScanService Interfaces...............................................................................................................................................................22511.2.5 Conformance................................................................................................................................................................................. 225

11.3 FaxIn...................................................................................................................................................................................22611.3.1 FaxInService Model Overview...............................................................................................................................................226

11.3.1.1 AvailableFaxInJobTicket.................................................................................................................................................22811.3.1.2 FaxInServiceDefaults........................................................................................................................................................22811.3.1.3 FaxInServiceCapabilities.................................................................................................................................................22911.3.1.4 FaxInServiceCapabilitiesReady....................................................................................................................................23111.3.1.5 FaxInServiceConfiguration............................................................................................................................................23111.3.1.6 FaxInServiceDescription.................................................................................................................................................23211.3.1.7 FaxInServiceStatus............................................................................................................................................................234

11.3.2 FaxInJob Model.............................................................................................................................................................................23511.3.2.1 FaxInJob Lifecycle:.............................................................................................................................................................23611.3.2.2 FaxInJobReceipt..................................................................................................................................................................23711.3.2.3 FaxInJobStatus.................................................................................................................................................................... 23811.3.2.4 FaxInJobTicket.................................................................................................................................................................... 240

11.3.3 FaxInDocument Model..............................................................................................................................................................24311.3.3.1 FaxInDocumentReceipt...................................................................................................................................................24411.3.3.2 FaxInDocumentStatus......................................................................................................................................................24411.3.3.3 FaxInDocumentTicket......................................................................................................................................................246

11.3.4 FaxInService Subunits...............................................................................................................................................................24711.3.5 FaxInService Interfaces.............................................................................................................................................................24711.3.6 Conformance................................................................................................................................................................................. 249

11.4 FaxOut................................................................................................................................................................................25011.4.1 FaxOutService Model Overview............................................................................................................................................250


17

297298299300301302

303304305306307308309310311312313314315316317318319320321322323324325

326327328329330331332333334335336337338339340341342343344345346

347348

18


11.4.1.1 FaxOutServiceDefaults....................................................................................................................................................25211.4.1.2 FaxOutServiceCapabilities.............................................................................................................................................25211.4.1.3 FaxOutServiceCapabilitiesReady................................................................................................................................25411.4.1.4 FaxOutServiceConfiguration.........................................................................................................................................25411.4.1.5 FaxOutServiceDescription.............................................................................................................................................25511.4.1.6 FaxOutServiceStatus.........................................................................................................................................................257

11.4.2 FaxOutJob Model..........................................................................................................................................................................25811.4.2.1 FaxOutJobReceipt.............................................................................................................................................................. 26011.4.2.2 FaxOutJobStatus.................................................................................................................................................................26011.4.2.3 FaxOutJobTicket.................................................................................................................................................................26211.4.2.4 FaxOutDocumentProcessing.........................................................................................................................................26211.4.2.5 FaxOutJobDescription......................................................................................................................................................26311.4.2.6 FaxOutJobProcessing........................................................................................................................................................265

11.4.3 FaxOutDocument Model...........................................................................................................................................................26611.4.3.1 FaxOutDocumentReceipt................................................................................................................................................26711.4.3.2 FaxOutDocumentStatus...................................................................................................................................................26711.4.3.3 FaxOutDocumentTicket..................................................................................................................................................26911.4.3.4 FaxOutDocumentDescription.......................................................................................................................................26911.4.3.5 FaxOutDocumentProcessing.........................................................................................................................................270

11.4.4 FaxOutService Interfaces.........................................................................................................................................................27011.4.5 Conformance................................................................................................................................................................................. 275

11.5 EmailIn...............................................................................................................................................................................27511.5.1 EmailInService Model Overview...........................................................................................................................................275

11.5.1.1 EmailInServiceDefaults...................................................................................................................................................27511.5.1.2 EmailInServiceCapabilities............................................................................................................................................27511.5.1.3 EmailInServiceCapabilitiesReady...............................................................................................................................27511.5.1.4 EmailInServiceConfiguration........................................................................................................................................27511.5.1.5 EmailInServiceDescription............................................................................................................................................27511.5.1.6 EmailInServiceStatus.......................................................................................................................................................275

11.5.2 EmailInJob Model........................................................................................................................................................................ 27511.5.2.1 EmailInJobReceipt.............................................................................................................................................................27511.5.2.2 EmailInJobStatus................................................................................................................................................................27511.5.2.3 EmailInJobTicket................................................................................................................................................................27511.5.2.4 EmailInDocumentProcessing.......................................................................................................................................27511.5.2.5 EmailInJobDescription.....................................................................................................................................................27511.5.2.6 EmailInJobProcessing......................................................................................................................................................275

11.5.3 EmailInDocument Model..........................................................................................................................................................27511.5.3.1 EmailInDocumentReceipt..............................................................................................................................................27511.5.3.2 EmailInDocumentStatus.................................................................................................................................................27511.5.3.3 EmailInDocumentTicket.................................................................................................................................................27511.5.3.4 EmailInDocumentDescription......................................................................................................................................27511.5.3.5 EmailInDocumentProcessing.......................................................................................................................................275

11.5.4 EmailInService Interfaces........................................................................................................................................................27511.5.5 Conformance................................................................................................................................................................................. 275

11.6 EmailOut............................................................................................................................................................................27611.6.1 EmailOutService Model Overview........................................................................................................................................276

11.6.1.1 EmailOutServiceDefaults................................................................................................................................................27611.6.1.2 EmailOutServiceCapabilities.........................................................................................................................................27611.6.1.3 EmailOutServiceCapabilitiesReady............................................................................................................................27611.6.1.4 EmailOutServiceConfiguration....................................................................................................................................27611.6.1.5 EmailOutServiceDescription.........................................................................................................................................27611.6.1.6 EmailOutServiceStatus....................................................................................................................................................276

11.6.2 EmailOutJob Model.....................................................................................................................................................................276


19

349350351352353354355356357358359360361362363364365366367368369

370371372373374375376377378379380381382383384385386387388389390391392

393394395396397398399400401

20


11.6.2.1 EmailOutJobReceipt..........................................................................................................................................................27611.6.2.2 EmailOutJobStatus.............................................................................................................................................................27611.6.2.3 EmailOutJobTicket.............................................................................................................................................................27611.6.2.4 EmailOutDocumentProcessing....................................................................................................................................27611.6.2.5 EmailOutJobDescription.................................................................................................................................................27611.6.2.6 EmailOutJobProcessing...................................................................................................................................................276

11.6.3 EmailOutDocument Model......................................................................................................................................................27611.6.3.1 EmailOutDocumentReceipt...........................................................................................................................................27611.6.3.2 EmailOutDocumentStatus..............................................................................................................................................27611.6.3.3 EmailOutDocumentTicket..............................................................................................................................................27611.6.3.4 EmailOutDocumentDescription...................................................................................................................................27611.6.3.5 EmailOutDocumentProcessing....................................................................................................................................276

11.6.4 EmailOutService Interfaces.....................................................................................................................................................27611.6.5 Conformance................................................................................................................................................................................. 276

11.7 Transform.........................................................................................................................................................................27711.7.1.1 TransformServiceDefaults.............................................................................................................................................27811.7.1.2 TransformServiceCapabilities......................................................................................................................................27911.7.1.3 TransformServiceCapabilitiesReady.........................................................................................................................28111.7.1.4 TransformServiceConfiguration..................................................................................................................................28111.7.1.5 TransformServiceDescription......................................................................................................................................28211.7.1.6 TransformServiceStatus.................................................................................................................................................284

11.7.2 TransformJob Model.................................................................................................................................................................. 28511.7.2.1 TransformJobReceipt.......................................................................................................................................................28611.7.2.2 TransformJobStatus..........................................................................................................................................................28611.7.2.3 TransformJobTicket..........................................................................................................................................................288

11.7.3 TransformDocument Model....................................................................................................................................................29211.7.3.1 TransformDocumentReceipt........................................................................................................................................29211.7.3.2 TransformDocumentStatus...........................................................................................................................................29211.7.3.3 TransformDocumentTicket...........................................................................................................................................294

11.7.4 TransformService Interfaces..................................................................................................................................................29511.7.5 Conformance................................................................................................................................................................................. 300

11.8 Resource............................................................................................................................................................................30011.8.1 Resource Service Model Overview.......................................................................................................................................30211.8.2 Resource Service Model Description..................................................................................................................................303

11.8.2.1 Data Types............................................................................................................................................................................ 30311.8.2.2 Resource Service Configuration..................................................................................................................................3031.1.1.1 Storage Status................................................................................................................................................................3051.1.1.2 Storage Description.....................................................................................................................................................306(string) This is the name of the storage subunit that is unique within a Resource Service instance...................................................................................................................................................................................................................... 30611.8.2.3 Resource Service Description.......................................................................................................................................30711.8.2.4 Resource Service Capability..........................................................................................................................................308

1.1.2 List of ##other..........................................................................................................................................................................3091.1.3 Resource Description Capabilities...................................................................................................................................309

11.8.2.5 Resource Service Status..................................................................................................................................................31011.8.2.6 Resource List........................................................................................................................................................................320

11.9 System Control Service.................................................................................................................................................32611.9.1 Imaging Device Model............................................................................................................................................................... 32611.9.2 System Object................................................................................................................................................................................326

11.9.2.1 SystemConfiguration........................................................................................................................................................32711.9.2.2 SystemDescription............................................................................................................................................................32711.9.2.3 SystemStatus........................................................................................................................................................................329


21

402403404405406407408409410411412413414415

416417418419420421422423424425426427428429430431432

433434435436437438439440441442443444445446447

448449450451452453

22


11.9.3 SystemControlService...............................................................................................................................................................33211.9.3.1 SystemControlService Model........................................................................................................................................33211.9.3.2 SystemControlServiceDescription..............................................................................................................................33211.9.3.3 SystemControlServiceStatus.........................................................................................................................................33411.9.3.4 SystemControlService Operations..............................................................................................................................335

DeleteService............................................................................................................................................................................................... 337DisableAllServices.....................................................................................................................................................................................337EnableAllServices...................................................................................................................................................................................... 337GetSystemElements..................................................................................................................................................................................337ListAllServices.............................................................................................................................................................................................339PauseAllServices........................................................................................................................................................................................339PauseAllServicesAfterCurrentJob......................................................................................................................................................339RestartAllServices..................................................................................................................................................................................... 339RestartService.............................................................................................................................................................................................340ResumeAllServices....................................................................................................................................................................................340ShutdownAllServices...............................................................................................................................................................................340ShutdownService....................................................................................................................................................................................... 340StartupAllServices.....................................................................................................................................................................................340StartupService............................................................................................................................................................................................ 341SetSystemElements..................................................................................................................................................................................341

12. CONFORMANCE REQUIREMENTS.......................................................................................343

13. INTERNATIONALIZATION CONSIDERATIONS......................................................................343

14. SECURITY CONSIDERATIONS..............................................................................................343

15. IANA CONSIDERATIONS.....................................................................................................343

16. PWG REGISTRATION CONSIDERATIONS.............................................................................344

17. REFERENCES......................................................................................................................344

17.1 Normative References..................................................................................................................................................344

17.2 Informative References...............................................................................................................................................349

18. AUTHORS' ADDRESSES.......................................................................................................349

19. CHANGE LOG.....................................................................................................................349

19.1 January 3, 2012...............................................................................................................................................................349

19.2 January 9, 2012...............................................................................................................................................................350

19.3 June 3, 2013......................................................................................................................................................................350

19.4 June 15, 2013...................................................................................................................................................................350


23

454455456457458459460461462463464465466467468469470471472473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

24


20. APPENDIX A: PWG SMV2 ELEMENTS’ SEMANTIC INFORMATION.......................................351

21. APPENDIX B: SERVICE CAPABILITIES...................................................................................371

22. APPENDIX C: KEYWORD WELL-KNOWN VALUES.................................................................373

23. APPENDIX D: KEYWORD VALUE EXTENSION PATTERNS......................................................384

24. APPENDIX D – IPP MAPPING..............................................................................................385

24.1 Changes to remove some IPP specific aspects.....................................................................................................385

24.2 Attribute Group Mapping............................................................................................................................................386

Note: Section 10 will discuss the various Imaging Services. The section on Counters and Timers will be a subsection called Service Counters and Timers within an earlier section (see service status).

List of FiguresFigure 1 Element Extension Symbol..................................................................................20Figure 2 Attribute Extension Symbol.................................................................................20Figure 3 Conditionally Mandatory Element........................................................................20Figure 4 Optional Element.................................................................................................21Figure 5 System Object.....................................................................................................24Figure 6 Primary Interfaces with Servic.............................................................................25Figure 7 Relationships within a Multifunction Device.........................................................27Figure 8 Scan Region Element..........................................................................................29Figure 9 Hardcopy Document, Region, Image Relationsh................................................30Figure 10 Document Cardinality........................................................................................30Figure 11 Scanner or Marker Coordinates........................................................................32Figure 12 Service Scan Coordinates.................................................................................33Figure 13 Document Format coordinates..........................................................................34Figure 14 UML Diagram Showing Relationships Relative to Job Ticket............................37Figure 15 Elements in System Configuration....................................................................39Figure 16 SubunitStatus Elements....................................................................................41Figure 17 Power Counters Schema...................................................................................42Figure 18 Power Meters Schema......................................................................................43Figure 19 Power Monitor Schema.....................................................................................44Figure 20 Power Support Schema.....................................................................................45Figure 21 Power Transition Schema.................................................................................46Figure 22 Subunit Description Schema.............................................................................46Figure 23 Power Calendar Schema...................................................................................47Figure 24 Power Event Schema........................................................................................48Figure 25 Power Timeout Schema....................................................................................49


25

488

489

490

491

492

493

494495496497498499500

501502503504505506507508509510511512513514515516517518519520521522523524525526

26


Figure 26 Console Subunit Schema..................................................................................50Figure 27 Console Lights Schema.....................................................................................52Figure 28 Cover Subunit Schema......................................................................................53Figure 29 FaxModem........................................................................................................54Figure 30 FaxModem Description......................................................................................55Figure 31 FaxModem Status.............................................................................................57Figure 32 Finisher..............................................................................................................58Figure 33 FinisherDescription............................................................................................58Figure 34 FinisherStatus...................................................................................................59Figure 35 FinisherSupply...................................................................................................60Figure 36 FinisherSupplyMediaInput.................................................................................61Figure 37 Input Tray..........................................................................................................64Figure 38 Input Tray Description.......................................................................................65Figure 39 Input Tray Status...............................................................................................66Figure 40 Interface............................................................................................................67Figure 41 InterfaceDescription...........................................................................................68Figure 42 InterfaceStatus..................................................................................................69Figure 43 Interpreter..........................................................................................................71Figure 44 Marker Schema.................................................................................................73Figure 45 MarkerDescription Schema...............................................................................73Figure 46 MarkerStatus Schema.......................................................................................74Figure 47 Marker Colorant Schema...................................................................................75Figure 48 Marker Supply...................................................................................................76Figure 49 Media Path........................................................................................................77Figure 50 MediaPathDescription.......................................................................................77Figure 51 MediaPathStatus...............................................................................................77Figure 52 Output Channel.................................................................................................79Figure 53 Output Tray.......................................................................................................80Figure 54 Output Tray Description.....................................................................................81Figure 55 Output Tray Status............................................................................................82Figure 56 Processor..........................................................................................................84Figure 57 Scan Media Path...............................................................................................86Figure 58 Scanner.............................................................................................................88Figure 59 Scanner Addressability......................................................................................89Figure 60 Scanner Margin.................................................................................................90Figure 61 Storage..............................................................................................................91Figure 62 Vendor Subunit..................................................................................................93Figure 63 Abstract Imaging Service Structure...................................................................95Figure 64 Imaging Job Table.............................................................................................95Figure 65 Imaging Job Model............................................................................................96Figure 66 Imaging Service Available Job Ticket................................................................96Figure 67 Imaging Service Capabilities.............................................................................98Figure 68 Imaging Document Processing Capabilities......................................................99Figure 69 Representative Service-Specific Document Processing Capabilities (Scan

Service).....................................................................................................................100Figure 70 Print Document Capabilities...........................................................................103


27

527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572

28


Figure 71 Media Col Structure.........................................................................................106Figure 72 Imaging Service Job Description Capabilities.................................................108Figure 73 Print Service Specific Job Description Capabilities........................................109Figure 74 Document Format Details Structure................................................................110Figure 75 Imaging Service Job Processing Capabilities..................................................111Figure 76 Representative Service-Specific JobProcessingCapabilities Elements (FaxOut

Service Examples).....................................................................................................112Figure 77 Imaging Service Defaults.................................................................................115Figure 78 Basic Document Ticket Default.......................................................................116Figure 79 Imaging Service Job Ticket Defaults...............................................................116Figure 80 Imaging Service Description............................................................................117Figure 81 Representative Service-Specific Service Description (FaxOut).......................119Figure 82 Detail of DocumentFormatDetailsDefault........................................................121Figure 83 Imaging Service Status....................................................................................122Figure 84 Condition Table...............................................................................................124Figure 85 Imaging Job.....................................................................................................126Figure 86 Imaging Job Status..........................................................................................128Figure 87 Job Originating User Authentication Info.........................................................130Figure 88 Representative Service-Specific Job Status Elements....................................131Figure 89 Imaging Job Ticket..........................................................................................132Figure 90 JobTicket Superclass DocumentProcessing...................................................133Figure 91 JobTicket DocumentProcessing - Image Output Services Sheet 1.................134Figure 92 JobTicket DocumentProcessing - Image Output Services Sheet 2.................135Figure 93 JobTicket DocumentProcessing - Image Output Services MediaBox.............136Figure 94 JobTicket DocumentProcessing - Impression Output Services Sheet 1.........139Figure 95 JobTicket DocumentProcessing – Impression Output Services Sheet 2.........139Figure 96 JobTicket DocumentProcessing – Impression Output Services Sheet 3.........140Figure 97 Media Col Structure Specific...........................................................................144Figure 98 ImagingJobDescription (Superclass)...............................................................146Figure 99 Representative Service-Specific Job Ticket Job Description Elements ( Print

Service).....................................................................................................................148Figure 100 Superclass Job Processing Elements...........................................................150Figure 101 Representative Service-Specific Job Processing Elements (FaxOut Service)

Sheet 1......................................................................................................................154Figure 102 Representative Service-Specific Job Processing Elements (FaxOut Service)

Sheet 2......................................................................................................................155Figure 103 Representative Service-Specific Job Processing Elements (Copy Service)

Sheet 1......................................................................................................................155Figure 104 Representative Service-Specific Job Processing Elements (Copy Service)

Sheet 2......................................................................................................................155Figure 105 Imaging Document Model..............................................................................159Figure 106 Imaging Document Status.............................................................................160Figure 107 Service-Specific Document Status Elements................................................162Figure 108 Imaging Document Ticket..............................................................................163Figure 109 Imaging Document Description.....................................................................164Figure 110 Service-Specific Document Description Elements.........................................165


29

573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618

30


Figure 111 Service State Model......................................................................................167Figure 112 Service State Transitions and Causal Events...............................................171Figure 113 Job State Transition.......................................................................................174Figure 114 Document State Transition............................................................................176Figure 115 System Counters...........................................................................................197Figure 116 Counters, Showing the Derivation of Service Totals and System Totals.......199Figure 117 Work Counter Counts Type...........................................................................200Figure 118 Media Used Counters....................................................................................201Figure 119 Availability Counters......................................................................................202Figure 120 Monitoring Counts.........................................................................................203

List of TablesTable 1 PWG Semantic Model Terminology......................................................................14Table 2 Basic Element Datatypes......................................................................................21Table 3 Subunits................................................................................................................39Table 4 Description of SubunitStatus Elements................................................................41Table 5 Power Counter Elements......................................................................................42Table 6 Power Meter Elements.........................................................................................43Table 7 Power Monitor Elements.......................................................................................44Table 8 Power Support Elements......................................................................................45Table 9 Power Transition Elements...................................................................................46Table 10 Description of Subunit Description Elements......................................................46Table 11 Power Calendar Elements..................................................................................47Table 12 Power Event Elements.......................................................................................48Table 13 Power Timeout Elements....................................................................................49Table 14 Console Elements..............................................................................................50Table 15 Cover Elements..................................................................................................53Table 16 Fax Modem Description Elements......................................................................55Table 17 Fax Modem Status Elements..............................................................................57Table 18 Finisher Subunit Elements..................................................................................59Table 19 FinisherSupply Elements....................................................................................60Table 20 FinisherSupplyMediaInput Elements..................................................................61Table 21 Input Tray Description Elements.........................................................................65Table 22 Input Tray Status Elements................................................................................66Table 23 InterfaceDescription Elements............................................................................68Table 24 InterfaceStatus Elements....................................................................................69Table 25 Interpreter Elements...........................................................................................71Table 26 Marker Elements................................................................................................73Table 27 Marker Status Elements.....................................................................................74Table 28 Market Colorant Elements..................................................................................75Table 29 Marker Supply Elements.....................................................................................76Table 30 Media Paths Elements........................................................................................77Table 31 Output Channel Elements...................................................................................80Table 32 Output Tray Elements.........................................................................................82Table 33 Processor Subunit Elements..............................................................................84


31

619620621622623624625626627628

629630

631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664

32


Table 34 Scan Media Path Elements................................................................................86Table 35 Scanner Subunit Elements.................................................................................88Table 36 Scanner Addressability Elements.......................................................................89Table 37 Scanner Margin Elements..................................................................................90Table 38 Storage Elements...............................................................................................91Table 39 Vendor Subunit Elements...................................................................................93Table 40 Imaging Document Processing Capabilities.......................................................99Table 41 Service-Specific Document Processing Capabilities Image Output..................100Table 42 Service-Specific Document Processing Capabilities Impression Outputs........104Table 43 MediaCol Elements...........................................................................................106Table 44 Imaging Service Job Description Capabilities...................................................108Table 45 Service Specific Job Description Capabilities...................................................109Table 46 Document Format Detail Elements...................................................................110Table 47 Imaging Service Job Processing Capabilities...................................................111Table 48 Service-Specific JobProcessingCapabilities Elements.....................................112Table 49 Service Description Elements...........................................................................118Table 50 Service-Specific Service Description Elements................................................119Table 51 Constituent Elements of DocumentFormatDetailsDefault.................................121Table 52 Service Status Elements...................................................................................122Table 53 Service-Specific Service Status Elements........................................................123Table 54 Condition Table Elements.................................................................................124Table 55 Job Status Elements.........................................................................................128Table 56 Job Originating User Authentication Info Elements..........................................130Table 57 Service-Specific Job Status Elements..............................................................131Table 58 JobTicket Superclass DocumentProcessing Elements.....................................133Table 59 Service-Specific Job Ticket Document Processing Elements - Image Output

Services.....................................................................................................................136Table 60 Color Processing Elements..............................................................................138Table 61 Service-Specific Job Ticket Document Processing Elements - Impression Output

Services.....................................................................................................................140Table 62 Media Collection Elements in Job Ticket..........................................................144Table 63 JobTicket ImagingJobDescription Elements (Superclass)................................146Table 64 Service-Specific JobTicketJobDescription Elements........................................148Table 65 Superclass JobProcessing Element Descriptions.............................................150Table 66 Service-Specific Job Processing Elements......................................................155Table 67 Document Status Elements..............................................................................160Table 68 Service-Specific Document Status Elements...................................................163Table 69 Document Description Elements......................................................................164Table 70 Service-Specific Document Description Elements............................................165Table 71 Conditions and Bounding Events......................................................................170Table 72 ServiceState Change by Operations................................................................172Table 73 Service State Change by Events......................................................................172Table 74 MFD Common Operations and Antecedents....................................................177Table 75 Basic MFD Interface Requests and Responses...............................................178Table 76 Administrative Operations.................................................................................190Table 77 Counter Elements Used in the Various Service and System Work Counters...200


33

665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710

34


Table 78 Media Used Counter Elements.........................................................................201Table 79 Availability Counter Elements...........................................................................202Table 80 Monitoring Count Elements..............................................................................203


35

711712713714

36


1. Introduction

1.1 ScopeThis document specifies the core attributes of the PWG semantic model of an Imaging System and for the Imaging Services provided including such as Print, Scan, FaxIn, FaxOut, Transform, EmailIn, EmailOut, Copy 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: The overall MFD model including the terminology and concepts used in the Imaging Service

models. The models of an Imaging Service, Job and Document “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

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

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

1.2 BackgroundOffice 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


37

715

716

717718719720721722

723724

725726727728729730

731732733734735736737738739

740741

742743744745746747748749750751752

753

754755756

38


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.


39

757758759

760761762763764765766767

768769770771772773774

40


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 ‘<service>’ 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 TerminologyCapitalized 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 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 ‘<service>’ 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

Term Definition<service> An 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.)


41

775

776777778

779780781782

783784785786

787

788789

790

791792793

794795796797

798799800801

802

42


Term DefinitionCapabilities Used in the context of <service> 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 <service>Job Ticket

A Job Ticket data object that is bound to an instance of an Imaging Service. The Job Ticket Default <service>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.

Destination 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 <service>). 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.


43

44


Term DefinitionDocument 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 <service>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 <service> Client.

Element 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.


45

46


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 <service>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.

Job 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 <service> client, where <service> 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.


47

48


Term DefinitionMultifunction 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 <service>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 <service>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.

Resource 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.


49

50


Term DefinitionSubunit 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.

Template 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 Modeling Representations used in this DocumentThis specification describes the overall aspects of the MFD 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.

2.3.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.)


51

803

804

805806807808809810811

812

813814815816817818819820

821822823

52


2.3.2 “Any” Element and “Any” Attribute Extensions

The MFD 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.

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

2.3.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


53

824

825826827828829830

831

832

833834835

836

837

838839

840841842843844845846847

848

849

850851852

853

854

54


2.3.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”.

2.4 DatatypesThe modeling of an MFD 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 MFD 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 2 Basic Element Datatypes

Abstract Datatype

XML DataType

XML SchemaReference

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 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]


55

855

856857858

859

860861862863

864865866867868869870871872873874

875876877878

879

56


Abstract Datatype

XML DataType

XML SchemaReference

Description and IPP Reference

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 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]


57

880881

58


3. Requirements

3.1 RationaleOffice 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.

3.2 Use CasesBecause each of the basic Imaging Services have been provided for many years, 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:

1. 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 Printed 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 Printing is hidden by applications, user interfaces and Print Devices, the typical user thinks Printing is simple. By extending Print Semantics to all Imaging Services, all Document processing and handing should appear simple and intuitive to Users.


59

882

883

884885886887888889890891892893

894895896897898899900

901902903904905906907

908909

910911912

913

914915916917918919920921922923

60


2. 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.

3. 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 Functions

The basic functionality of scanning/ Printing/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.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 Services need a scanner subunit2. Copy, Print, FaxIn, EmailIn Services need a marker subunit3. FaxIn and FaxOut Services need a FaxModem

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.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.Scan Service 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 <service>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.Copy Service 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


61

924925926927928929930931

932

933934935936937938

939

940941942943944945

946

947948949

950

951952953954

955956957958959960961962963964

965966

62


know how to set up the MFD 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 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.FaxOut 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 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. 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 <service> Intent3. The User requests the creation of a new <service> 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 <service> Capabilities).

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

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

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

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

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 <service> Intent. This use case can apply to all Imaging Services that use the Scanner Subunit.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 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


63

967968969970971972

973974975976977978979980

981982983984985986987988989990991992993994995996997998999

1000

1001

1002100310041005100610071008

10091010101110121013

64


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.Example Processing Steps

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 <service>Intent.2. The Imaging Service Client modifies the local copy of the Job Template to the user’s <service>

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 <service> 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 <service> 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.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.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. Example Processing Steps

The following are the processing steps for this scenario.1. Glen places the stack of Hardcopy Documents on the ADF.


65

1014101510161017

101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047

1048

104910501051

10521053105410551056

10571058

66


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.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 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.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).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.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.


67

10591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084

1085

10861087108810891090

1091109210931094

1095109610971098

10991100110111021103

68


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.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). Processing Steps

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


69

11041105110611071108110911101111111211131114111511161117

1118

1119112011211122

112311241125112611271128

1129113011311132113311341135113611371138113911401141114211431144

1145

114611471148

70


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. Processing Steps

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

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 to display the list of Service Capabilities to the User.

3.3 Out of ScopeThe 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 RequirementsConsideration 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 3 MFD Common Operations

MDF Service Operation

Add<service>HardcopyDocument

CancelCurrent<service>Job

Cancel<service>DocumentCancel<service>Job

Cancel<service>Jobs

CancelMy<service>Jobs

Close<service>Job


71

11491150115111521153

11541155115611571158

1159

11601161116211631164116511661167116811691170

1171

11721173

1174

11751176

1177

72


MDF Service Operation

Create<service>Job

Disable<service>Service

Enable<service>Service

Get<service>DocumentElements

Get<service>DocumentsGet<service>JobElements

Get<service>Job History

GetActive<service>Jobs

Get<service>ServiceElements

Get<service>ServiceElements

Hold<service>Job

HoldNew<service>Jobs

Pause<service>Service

Pause<service>ServiceAfterCurrentJob

Promote<service>Job

ReleaseNew<service>Jobs

Release<service>Job

Restart<service>Service

Resubmit<service>Job

Resume<service>Job

Resume<service>Service

Promote<service>Job

Send<service>Document

Send<service>URI

Set<service>DocumentElements

Set<service>JobElements

Set<service>ServiceElements

Shutdown<service>Service

Startup<service>Service

SuspendCurrent<service>Job

3.4.2 Requirements from Common Use of Subunits

An MFD includes many subunits, some of which are used by all Services, and some a subset of the supported Services. Indeed, there may be MFD 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 MFD Services, all of the MFD subunits that might be used by the Service must be identified.


73

1178

11791180118111821183

74


3.4.3 Design Requirements from Use Cases

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

3.4.3.1 Requirement for a System

An MFD potentially supports several Services, and those Services share the Subunits constituting the MFD. 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 Job Related Requirements

Each Service must accommodate:1. A consistent Job structure, including a Job Ticket defining the User <service>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 Status and Description 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.

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.


75

1184

11851186

1187

11881189119011911192

1193

1194119511961197119811991200120112021203

1204

1205120612071208120912101211121212131214121512161217121812191220

76


4. Model Concepts

4.1 Top Level Model ElementsThe PWG MFD XML Schema [MFD_SCHEMA] is a concise description of an MFD, 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 MFD is the System object. As shown in Error: Reference source not found, the System includes four mandatory Complex Elements which are basic to the perceived imaging functionality of the MFD, three optional Elements and an extension point.

Services: The group of Complex Elements performing the functional imaging services associated with an MFD. The Elements common to two or more Services are identified in this specification. Each Service and the Elements and characteristics unique to that Service are individually described in a separate specification.

System Configuration: the set of Subunits contained in the MFD, certain of which are used by each Service to implement Service functionality. Because the Subunits are a necessary part of the Service specifications, the Subunits are also addressed in this specification.

System Description and System Status: the Elements of the System object that are administrator settable (description) and inherent (status); these System specific elements are more appropriately described in a separate System specification.

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


77

1221

1222

12231224122512261227

122812291230123112321233123412351236123712381239124012411242

1243

1244

78


4.2 Overview of ServicesThe 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 MFD itself.

4.3 Primary Service InterfacesThe 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.

Figure 6 Primary Interfaces with Servic


79

1245

124612471248

1249

125012511252125312541255125612571258

1259

1260

80


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 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 MFD. The Repository, which stores Digital Documents before and/or after servicing, may be either contained within the MFD 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 MFD or not.

4.4 Functional Overview of a Multifunction DeviceThe Semantic Model is very general, covering an MFD hosting anything from one to all of the Imaging Services as well as an MFD 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 MFD model is represented in Figure 7, which shows the relationship of Services and Subunits (i.e., System Configuration) within the MFD. 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 MFD. 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) 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.


81

126112621263126412651266

1267126812691270

12711272127312741275127612771278127912801281

1282

1283128412851286

128712881289

12901291129212931294

12951296129712981299

13001301130213031304

82


Figure 7 Relationships within a Multifunction Device


83

1305

1306

1307

84


4.5 Jobs, Documents, Tickets and TemplatesThe MFD 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:

Converting Documents between hardcopy and electronic forms (scan and Print) Duplicating Documents in hardcopy form, usually going through an electronic form (Copy) Transmitting Documents electronically (Facsimile) 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: 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.)

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.

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

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.


85

1308

130913101311

1312131313141315131613171318

131913201321132213231324132513261327

132813291330

13311332

1333133413351336133713381339

1340134113421343

13441345

134613471348

86


4.6 Content Region and ImagesAn MFD 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.

4.6.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 MFD 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 8 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 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 MFD. 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.


87

1349

1350135113521353135413551356

1357

1358135913601361

1362

1363

13641365136613671368136913701371

137213731374137513761377

88


Figure 9 Hardcopy Document, Region, Image Relationsh

4.6.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 (i.e., Scan and Transform) can provide their Digital Document output. These are diagramed in Figure 10.

Figure 10 Document Cardinality


89

1378

1379

1380

138113821383

1384

1385

90


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.

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.

4.7 Coordinate SystemsAll 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.

4.7.1 Coordinate Nomenclature

In a comprehensive MFD 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


91

138613871388

138913901391

1392139313941395

1396139713981399

1400140114021403

14041405

140614071408

1409

141014111412141314141415

1416

141714181419

14201421142214231424142514261427

92


Subunit’s Print head or laser sweep path; it is also the axis along which the image data is read or written most slowly.

4.7.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.

4.7.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 11 Scanner or Marker Coordinates


93

14281429

1430

143114321433

1434

143514361437143814391440

14411442144314441445

1446

1447

94


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

4.7.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 12 Service Scan Coordinates

4.7.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 MFD 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


95

144814491450145114521453

1454

145514561457145814591460146114621463

1464

1465

1466

146714681469

14701471

96


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 13 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 MFD 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 MFD Model Media Box.

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 MFD 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 MFD Model Media Box.

PDF also defines some additional bounding boxes than are not included in the MFD 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


97

1472147314741475

1476

1477

147814791480148114821483148414851486148714881489149014911492149314941495149614971498

98


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.

4.8 Job and Job Ticket Life CycleThe 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:

A Document Ticket contains only Document Description and Processing Elements, A Document Ticket is bound to a Document and, 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 <service> 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.

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:

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.

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.

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

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


99

1499150015011502

1503

1504150515061507150815091510

151115121513151415151516

15171518151915201521

15221523152415251526152715281529153015311532

1533153415351536

153715381539

15401541

100


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.


101

154215431544

1545

102


Figure 14 UML Diagram Showing Relationships Relative to Job Ticket

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.


103

1546

15471548154915501551

15521553

15541555

104


5. System Configuration SubunitsThe System Configuration represents device semantics in the MFD 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 MFD. 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 <service>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 <service>Configuration which identifies the Subunits that may be used by an instance of that Service.


105

1556

155715581559

156015611562

1563156415651566156715681569

106


Figure 15 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 4 Subunits

Subunits Reference DescriptionConsoles prtConsole [RFC3805] User Interface Console(s) used to display and modify the 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.


107

1570

1571

1572157315741575

1576

108


Subunits Reference DescriptionFaxModems [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 PathInterfaces 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

Vendor 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 ElementsThe Status and Description Elements common to most Subunits are grouped into the complex types Subunit Status and Subunit Description, respectively. Following the MFD 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.


109

1577

157815791580158115821583

1584

15851586158715881589159015911592

110


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 MFD as a unit). The description of these complex Elements is appropriate to the System specification. However, within the MFD model, the Subunits correlate most closely to the physical components of the MFD. Because the various Services in an MFD 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.

Figure 16 SubunitStatus Elements

Table 5 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 MFD

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.4


111

1593159415951596159715981599160016011602

1603

160416051606

1607

1608

1609

112



Reference

PowerTransition complex See 3.1.1.5ProductID string manufacturer’s ID for the Subunit hrDeviceID [RFC2790]SubunitStates keyword current operational state of the

Subunit SubunitStateWKV

hrDeviceStatus [RFC2790]

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 17 Power Counters Schema

Table 6 Power Counter Elements

Element DataType Description Reference(PWG Power Management Model

[PWG 5106.4]

Power Counters complex Para 5.4HibernateTransitions 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


113

1610

1611

1612161316141615

1616

1617

1618

1619

1620

1621162216231624162516261627

114


transferred to the Power Previous Month KWH Element value. Power Lifetime KWH is, of course, persistent over power and reconfiguration cycles.

Figure 18 Power Meters Schema

Table 7 Power Meter Elements


Reference(PWG Power Management Model

[PWG 5106.4]

PowerMeters Complex the current power meters for each System or Subunit

PowerMetersAreActual boolean 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 hoursPara 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

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.


115

16281629

1630

1631

1632

1633

163416351636

1637

116


Figure 19 Power Monitor Schema

Table 8 Power Monitor Elements


Reference(PWG Power Management Model)

[PWG 5106.4]Power Monitor complex

PowerState 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.

Figure 20 Power Support Schema

Table 9 Power Support Elements


117

1638

1639

1640

164116421643

1644164516461647164816491650

1651

1652

1653

118



Reference(PWG Power Management 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]CanRequestPowerState boolean 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.

Figure 21 Power Transition Schema

Table 10 Power Transition Elements


Reference(PWG Power Management 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.


119

1654

1655

165616571658

1659

1660

1661

1662

16631664166516661667

120


Figure 22 Subunit Description Schema

Table 11 Description of Subunit Description Elements


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 23 Power Calendar Schema

Table 12 Power Calendar Elements


121

1668

1669

1670

1671

1672

1673

1674

1675

122


Element DataType Description or Keyword Group Reference(PWG Power Management Model

[PWG 5106.4]

CalendarEntry ComplexId int Id of entry, policy Para 7.3.1 [PWG 5106.4]RequestPowerState keyword PowerStateWKV Para 7.3.2 [PWG 5106.4]CalendarRunOnce boolean Once vs recurring Para 7.3.3. [PWG 5106.4]CalendarDayOfWeek keyword 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 24 Power Event Schema

Table 13 Power Event Elements

Element DataType Description or Keyword Group 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]RequestPowerState keyword PowerStateWKV Para 7.4.3 [PWG 5106.4]Any Various Extensions to Power EventEntry

Note that the Event Name Element, identifying the event on which the power state is to be set, must be structured as either:


123

1676

1677

16781679168016811682

1683

1684

1685

168616871688

124


(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 25 Power Timeout Schema

Table 14 Power Timeout Elements

Element DataType Description or Keyword Group Reference(PWG Power Management Model

[PWG 5106.4]

TimeoutEntry ComplexId int Id of entry, policy Para 7.2.1 [PWG 5106.4]RequestPowerState keyword 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]Any Various Extensions to Power TimeoutEntry

5.2 ConsolesThis 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.


125

16891690169116921693

1694

169516961697

1698

1699

1700

1701

1702

170317041705

126


Figure 26 Console Subunit Schema

Table 15 Console Elements


127

1706

1707

1708

128



Reference (all [RFC3805]*)

ConsoleDescription complexSubunitDescription complex See 3.1.2ConsoleNumberOfDisplayChars 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 ConsoleDescriptionConsoleStatus

SubunitStatus 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

ConsoleLightOnTime int defines the current status of the light in conjunction with ConsoleLightOffTime

prtConsoleOnTime

ConsoleLightOffTime int defines the current status of the light in conjunction with ConsoleLightOnTime,.

prtConsoleOffTime

ConsoleLightColor keyword color of this light. ConsoleLightColorWKV

prtConsoleColor

ConsoleLightInfo string prtConsoleDescription ConsoleNaturalLanguage string 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 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.


129

17091710171117121713171417151716

1717

130


Figure 27 Console Lights Schema

5.3 CoversThis 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.

Figure 28 Cover Subunit Schema

Table 16 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 CoverDescription


131

1718

1719

172017211722

1723

1724

1725

132


CoverStatusCoverIsOpen booleanCoverSubunitType keyword Differentiates between cover, interlock, etc.

CoverSubunitTypeWKVAny various Extension point for CoverStatus

Any various Extension point for Cover

5.4 FaxModemsThis 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 29 FaxModem


133

1726

17271728172917301731

1732

1733

1734

134


Figure 30 FaxModem Description

Table 17 Fax Modem Description Elements


Reference (All[RFC1696])

FaxModemDescription complex [RFC1696]SubunitDescription complex See 3.1.2AudioVolume intCallSetUpFailTimer intDialingMethod keywordDTEInactivityTimeout intDTESyncAsyncMode keyword DTESynchModeWKVDTESyncTimingSource keyword DTESynchWKVEscapeAction keyword CCEscapeActionWKVFaxModemInfo string


135

1735

1736

1737

136




FaxModemName stringFaxModemModel stringFaxModemVersion stringFaxModemSerialNumber stringFaxModemVendorName stringFaxModemLineCapabilities list of keywords LineCapabilityWKVFaxModemDTROnToOff keyword DTRToOffWKVFaxModemDTROffToOn keyword DTRToOnWKVNumberOfRetries intRingsBeforeAnswer intAny various Extension point for

FaxModemDescription


137

138


Figure 31 FaxModem Status

Table 18 Fax Modem Status Elements



FaxModemStatus complex [RFC1696]SubunitStatus complex See 3.1.1CompressionTypeUsed keyword CompressionTypeConnectionFailReason keyword ConnectionFailReasonWKVCurrentLineReceiveRate intCurrentLineTransmitRate int


139

1738

1739

1740

140


ErrorControlUsed keyword ErrorControlWKVLineCarrierLossTime intModulationSchemeUsed keyword ModulationSchemeUsedAny various Extension point for FaxModemStatus

Any various Extension point for FaxModem

5.5 FinishersThis 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 32 Finisher

Figure 33 FinisherDescription


141

1741

1742174317441745

1746

1747

1748

1749

1750

1751

142


Figure 34 FinisherStatus

Table 19 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]

FinisherMaxCapacityBasis keyword ObjectCounterBasisWKV finDeviceMaxCapacity [RFC3806]FinisherMaxCapacity counter finisher maximum capacity (in units

specified by FinisherCapacityUnit)finDeviceMaxCapacity [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


143

1752

1753

1754

1755

144



Reference

[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

Figure 35 FinisherSupply

Table 20 FinisherSupply Elements


Reference (RFC3805 and RFC3806)

FinisherSupplyStatus complexId int Index of finisher supplies for finisher finSupplyIndex in [RFC3806]FinisherSupplyCurrentLevelBasis keyword ObjectCounterBasisWKV finSupplyCurrentLevel [RFC3806]FinisherSupplyCurrentLevel int finisher supply current level (in units

specified by FinisherSupplyCapacityUnit)finSupplyCurrentLevel [RFC3806]

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

Any various Extension point for FinisherSupplyStatusFinisherSupplyDescription complex

FinisherSupplyClass keyword MarkerSupplyClassWKV prtMarkerSuppliesClass [RFC3805]FinisherSupplyType keyword MarkerSupplyTypeWKV prtMarkerSuppliesType [RFC3805]


145

1756

1757

1758

146



Reference (RFC3805 and RFC3806)

FinisherSupplyInfo string prtMarkerSuppliesDescription [RFC3805]

FinisherSupplyColorName string prtMarkerSuppliesColorantIndex [RFC3805]

FinisherSupplyCapacityUnit keyword MarkerSupplyCapacityUnitWKV prtMarkerSuppliesSupplyUnit [RFC3805]

FinisherSupplyMaxCapacityBasis keyword ObjectCounterBasisWKVFinisherSupplyMaxCapacity int prtMarkerSuppliesMaxCapacity

[RFC3805]Any various Extension point for

FinisherSupplyDescription

Figure 36 FinisherSupplyMediaInput

Table 21 FinisherSupplyMediaInput Elements


Reference

FinisherSupplyMediaInputDescription complexFinisherSupplyMediaInputType 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 keyfinSupplyMediaInputIndex [RFC3806]

FinisherSupplyMediaInputStates keyword SubunitStateWKV


147

1759

1760

1761

148



Reference

FinisherSupplyMediaInputSecurity keyword SubunitPresentOnOffWKV finSupplyMediaInputSecurity (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]

FinisherSupplyMediaInputMediaInfo string finisher supply media input current media info (weight, etc.)

finSupplyMediaInputMediaWeight & finSupplyMediaInputMediaThickness [RFC3806]

Any various Extension point for FinisherSupplyMediaInputStatus

5.6 Input ChannelsThis 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.


149

1762

1763176417651766

150




InputChannelDescription complex See Note 1 below.Description string prtChannelInformationInputChannelType keyword InputChannelTypeWKV PrtChannelTypeTC InputChannelProtocolVersion string input channel protocol

version (refines InputChannelType)

prtChannelProtocolVersion

InputChannelAuxInfo string input channel auxiliary information in a structured string

PrtChannelTypeTC prtChannelInformation

Any various Extension point to InputChannelDescription

InputChannelStatus complex See Note 1 below.DeviceErrors int hrDeviceErrors[RFC2790]Id int prtChannelIndexInputChannelDefaultJobControlLanguage complex Refers to instance of langage

interpreter See Note 2 and prtChannelCurrentJobCntlLangIndex


151

1767

152




Elements of an Interpreter, Error: Reference source not found

InputChannelDefaultPageDescription complex 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 various Extension point to

InputChannel

Notes:

1. 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.

2. 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 Elements defined those Subunits. Please see the corresponding Subunit paragraph for the description of these Elements.

*Unless otherwise indicated

5.7 Input TraysThis 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 37 Input Tray


153

1768

17691770177117721773

1774177517761777

17781779

1780

17811782178317841785

1786

1787

154


Figure 38 Input Tray Description

Table 22 Input Tray Description Elements

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

InputTrayType keyword InputTrayTypeWKV prtInputType InputTrayName string prtInputName InputTrayVendorName string prtInputVendorName InputTrayModel string input tray /vendor-supplied model of Subunit prtInputModel 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 PrtCapacityUnitTC


155

1788

1789

1790

156


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

Any various Extension point to InputTrayDescription

Figure 39 Input Tray Status

Table 23 Input Tray Status Elements


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 prtInputMediaType


157

1791

1792

1793

1794

158




Names section 3 in [PWG5101.1]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

5.8 InterfacesThis 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 40 Interface

Figure 41 InterfaceDescription


159

1795

1796179717981799

1800

1801

1802

1803

160


Table 24 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

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


161

1804

162


Figure 42 InterfaceStatus

Table 25 InterfaceStatus Elements


Reference(all [RFC2863])

InterfaceStatus complexSubunitStatus complex See 3.1.1


163

1805

1806

1807

164



Reference(all [RFC2863])

InterfaceAdminState 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

InterfaceInUnknownProtocols

int 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

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 InterpretersThis 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 aligned with prtInterpreter Table [RFC3805]. The


165

1808

180918101811

166


constituents of the Interpreter Subunit complex Element are represented in Figure 41. The Elements are described in Table 27.

Figure 43 Interpreter

Table 26 Interpreter Elements



InterpreterDescription complex See note below.Description stringInterpreterLanguageSupported keyword control languages which this interpreter can

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

prtInterpreterLangFamily


167

18121813

1814

1815

1816

168




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]

InterpreterLanguageVersion string 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 InterpreterDescriptionInterpreterStatus See note below.

InterpreterDefaultOrientation keyword current orientation default for this interpreter.InterpreterPageOrientationWKV

prtInterpreterDefaultOrientation

InterpreterAddressabilityUnit keyword units used for Interpreter Addressability. SubunitAddressabilityUnitWKV

prtMarkerAddressabilityUnits

InterpreterAddressabilityBasis keyword 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

InterpreterAddressabilityFeed int addressability in the feed direction i.e., slow –scan direction in InterpreterAddressabilityUnits


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

prtInterpreterDefaultCharSetIn

InterpreterDefaultCharsetOut string 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 InterpreterStatus

Any various Extension point to InterpreterNote: 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 MarkerThis 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.


169

1817181818191820

1821

182218231824182518261827

170


Figure 44 Marker Schema

Figure 45 MarkerDescription Schema

Table 27 Marker Elements



MarkerDescription complex

SubunitDescription complex See 3.1.2

MarkerTechnology keyword MarkerTechnologyWKV PrtMarkerMarkTechTC MarkerProcessColorants counter prtMarkerProcessColorants MarkerSpotColorants counter prtMarkerSpotColorants Any various Extension point to

MarkerDescription


171

1828

1829

1830

1831

1832

1833

172


Figure 46 MarkerStatus Schema

Table 28 Marker Status Elements



SubunitStatus complex See 3.1.1MarkerAddressability complex

MarkerAddressabilityBasis keyword ObjectCounterBasisWKV prtMarkerFeed/xFeedAddressability out of band values

MarkerAddressabilityCrossFeed counter prtMarkerXFeedAddressability MarkerAddressabilityFeed counter prtMarkerFeedAddressability MarkerAddressabilityUnit keyword SubunitAddressabilityUnitWKV PrtMarkerAddressabilityUnitTC

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 valueMarkerNorthMargin counter prtMarkerNorthMargin


173

1834

1835

1836

174




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

Figure 47 Marker Colorant Schema

Table 29 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

MarkerColorantTonality counter 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


175

1837

1838

1839

176


Figure 48 Marker Supply

Table 30 Marker Supply Elements



MarkerSupplyStatus complexMarkerSupplyId int prtMarkerSuppliesIndex MarkerSupplyColorantId pointer prtMarkerSuppliesColorantIndex MarkerSupplyCurrentLevelBasis keyword ObjectCounterBasisWKV prtMarkerSuppliesLevel MarkerSupplyCurrentLevel counter prtMarkerSuppliesLevel Any various Extension point for

MarkerSupplyStatusMarkerSupplyDescription complex

MarkerSupplyClass keyword MarkerSupplyClassWKV prtMarkerSuppliesClass MarkerSupplyType keyword MarkerSupplyTypeWKV prtMarkerSuppliesType MarkerSupplyInfo string prtMarkerSuppliesDescription MarkerSupplyCapacityUnit keyword MarkerSupplyCapacityUnitWKV prtMarkerSuppliesSupplyUnit MarkerSupplyMaxCapacityBasis keyword ObjectCounterBasisWKV prtMarkerSuppliesMaxCapacity MarkerSupplyMaxCapacity counter prtMarkerSuppliesMaxCapacity Any various Extension point for

MarkerSupplyDescriptionAny various Extension point for MarkerSupply

5.11 Media PathsThis 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.


177

1840

1841

1842

1843

18441845184618471848

178


Figure 49 Media Path

Figure 50 MediaPathDescription

Figure 51 MediaPathStatus

Table 31 Media Paths Elements

Element DataType

Description or Keyword Group


MediaPathDescription complexSubunitDescription complex See 3.1.2


179

1849

1850

1851

1852

1853

1854

1855

180


Element DataType

Description or Keyword Group


MediaPathMaxSpeed counter prtMediaPathMaxSpeed MediaPathMaxSpeedUnit keyword PrtMediaPathMaxSpeed PrintUnitTC in

[RFC3805] MediaPathMaxSpeedUnitWKV

prtMediaPathMaxSpeed PrintUnit

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

prtMediaPathMediaSizeUnit; prtMediaPathMaxMediaFeedDir prtMediaPathMaxMediaXFeedDir

MediaPathMinMediaSizeName string 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 MediaPathStatus

Any various Extension point MediaPath

5.12 Output ChannelsThis 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.


181

1856

1857185818591860

182


Figure 52 Output Channel

Table 32 Output Channel Elements


183

1861

1862

1863

184



Reference [RFC3805]*

OutputChannelDescription complex See Note below.Description string prtChannelInformationOutputChannelAuxInfo 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

OutputChannelInterface complex This is the Interface instance associated with this instance of an Output Channel. See 5.8 for constituent Elements.

prtChannelIfIndex

OutputChannelIsEnabled boolean 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

5.13 Output TraysThis 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 53 Output Tray


185

186418651866186718681869

1870

18711872187318741875

1876

1877

186


Figure 54 Output Tray Description


187

1878

1879

1880

188


Figure 55 Output Tray Status

Table 33 Output Tray Elements



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

OutputTrayMaxCapacityBasis keyword ObjectCounterBasisWKV prtOutputMaxCapacity OutputTrayMaxCapacity counter output tray maximum capacity (in units

specified by OutputTrayCapacityUnitOutputTrayMaxMediaSizeName string see Media Size Self-Describing Names

section 5 in [PWG5101.1]prtOutputDimUnit; prtOutputMaxDimFeedDir prtOutputMaxDimXFeedDir

OutputTrayMinMediaSizeName string

Any various Extension point to OutputTrayDescriptionOutputTrayStatus complex


189

1881

1882

1883

190




SubunitStatus complex See 3.1.1OutputTraySecurity keyword SubunitPresentOnOffWKV prtOutputSecurity (PresentOnOff)

OutputTrayRemainingCapacityBasis

keyword ObjectCounterBasisWKV prtOutputRemainingCapacity

OutputTrayRemainingCapacity counter 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

5.14 ProcessorsThis 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.


191

1884

1885188618871888

192


Figure 56 Processor

Table 34 Processor Subunit Elements

Element DataType Description Reference (all [RFC2790])ProcessorDescription complex

SubunitDescription 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


193

1889

1890

1891

194


ProcessorDescriptionProcessorStatus complex Common Subunit Status

SubunitStatus complex See 5.1.1 prtChannelStatusAny various Extension point to Processor

5.15 Scan Media PathsThis 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.


195

1892

189318941895189618971898

196


Figure 57 Scan Media Path

Table 35 Scan Media Path Elements


Reference

ScanMediaPathDescription complex

SubunitDescription complex See 3.1.2


197

1899

1900

1901

198



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 intScanMediaPathMaxSpeedUnit keyword 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.1SheetsCompleted 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 ScannersThis 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.


199

1902

1903190419051906

200


Figure 58 Scanner

Table 36 Scanner Subunit Elements


Reference [RFC3805] *

ScannerDescription complex [PWG5108.2]SubunitDescription complex See 3.1.2


201

1907

1908

1909

202



Reference [RFC3805] *

ScannerBitsPerPixel int number of bits per pixel used by the scanner’s image acquisition subsystem.

[PWG5108.2]

ScannerColorPlanes int number of color planes used by the scanner’s image acquisition subsystem.

[PWG5108.2]

Any various Extension point for ScannerDescription.ScannerStatus complex [PWG5108.2]

SubunitStatus complex See 3.1.1ScannerAddressabilities 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

ScannerCounterUnit keyword 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 59 Scanner Addressability

Table 37 Scanner Addressability Elements


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


203

1910

1911

1912

1913

204


Figure 60 Scanner Margin

Table 38 Scanner Margin Elements


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

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 StoragesThis 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.


205

1914

1915

1916

1917191819191920

206


Figure 61 Storage

Table 39 Storage Elements


Reference

StorageDescription complexSubunitDescription complex See 3.1.2StorageDataEncryption boolean Data encryption is supportedStorageMakeAndModel string information on the manufacturer of the

storage Subunit including model name of the [RFC 2790]


207

1921

1922

1923

208



Reference

storage SubunitStorageName 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 StorageDescriptionStorageStatus complex

SubunitStatus 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 SubunitsThis 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 MFD product. Examples are a thumb Print or access card reader for security. It is modeled in Figure 57 and described in Table 41.


209

1924

1925192619271928

210


Figure 62 Vendor Subunit

Table 40 Vendor Subunit Elements


VendorSubunitDescription

complex

SubunitDescription complex See 3.1.2Any various Extension point for VendorSubunitDescription

VendorSubunitStatus complexSubunitStatus complex See 3.1.1SubunitCounterUnit keyword SubunitCounterUnitWKVSubunitLifeCount counterSubunitPowerOnCount counter


211

1929

1930

1931

212


Any various Extension point for VendorSubunitStatus Any various Extension point for VendorSubunit


213

1932

1933

214


6. Service Model 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:

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

Capabilities) and 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:

Available Job Ticket Service Capabilities Service Capabilities Ready Service Configuration- Service Defaults Service Description Service Status 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 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).


215

1934

19351936193719381939194019411942

194319441945

1946194719481949195019511952195319541955

1956195719581959196019611962196319641965

19661967196819691970

216


Figure 63 Abstract Imaging Service Structure

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

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

Job History list.

Figure 64 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.


217

1971

1972

1973

1974197519761977

1978

1979

19801981

1982

218


Figure 65 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 TicketImaging 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 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 66 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 ReadyThe 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


219

1983

1984

198519861987

19881989

1990

19911992199319941995

1996

1997

19981999200020012002

2003

20042005

220


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:

Document Ticket Capabilities Document Processing Capabilities: Document Description Capabilities

Job Ticket Capabilities Document Processing Capabilities: Job Description Capabilities 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 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.


221

200620072008200920102011

201220132014201520162017201820192020

2021202220232024

202520262027202820292030

2031203220332034203520362037

20382039

222


Figure 67 Imaging Service Capabilities

6.4 Service Job and Document Ticket Document Processing CapabilitiesDocument 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:

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.

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).


223

2040

2041

2042

2043

204420452046204720482049205020512052

224


Figure 68 Imaging Document Processing Capabilities

Table 41 Imaging Document Processing Capabilities

Element DataType Description orKeyword Group

NumberUp 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.


225

2053

2054

2055

2056205720582059

226


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

Table 42 Service-Specific Document Processing Capabilities Image Output


227

2060

20612062

2063

228



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 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 <service> DocumentProcessingCapabilities


229

230


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.


231

2064206520662067

2068206920702071207220732074

232


Figure 70 Print Document Capabilities


233

2075

2076

234


Table 43 Service-Specific Document Processing Capabilities Impression Outputs


Copies range of intCoverBack complex

CoverType list of keywords CoverTypeWKV, KeywordNsExtensionPattern Media list of keywords MediaSizeAliasNameWKV, MediaSizeLegacyNamesWKV,

MediaSizeSelfDescribingNameWKVMediaType list of keywords MediaTypeWKVMediaCol boolean Indicates whether feature is supportedAny various Extension point for CoverBack

CoverFront complexCoverType list of keywords CoverTypeWKV, KeywordNsExtensionPattern Media list of keywords MediaSizeAliasNameWKV, MediaSizeLegacyNamesWKV,

MediaSizeSelfDescribingNameWKVMediaType list of keywords MediaTypeWKVMediaCol boolean Indicates whether feature is supported

Any various Extension point for CoverFront

FeedOrientation list of keywords FeedOrientationWKV KeywordNsExtensionPattern

Finishings list of keywords FinishingsWKV, KeywordNsExtensionPattern FinishingsCol complex

FinishingTemplate booleanStitching complex

StitchingReferenceEdge list 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 intForceFrontSide range of intHeader Print list of keywords Header PrintType (e.g., FaxOut and EmailOut)ImpositionTemplate list of stringsInsertSheet complex

IsheetInsertAfterPage range of intInsertCount range of intMedia list of keywords MediaSizeAliasNameWKV, MediaSizeLegacyNamesWKV,

MediaSizeSelfDescribingNameWKVMediaType list of keywords MediaTypeWKVMediaCol boolean Indicates whether feature is supportedAny various Extension point for InsertSheet

Media list of keywords MediaSizeAliasNameWKV, MediaSizeLegacyNamesWKV, MediaSizeSelfDescribingNameWKV

MediaType list of keywordsMediaColSupported complex Zero or more instances of MediaCol. See 6.4.1.1

MediaCol complex The Media Col complex element appears in several places and is separately described. See Error: Reference source not found

MediaInput TrayCheck list of keywords MediaInput TrayCheckWKV, MediaNsExtensionPattern

OrientationRequested list of keywords OrientationRequestedWKVOutputBin list of keywords OutputBinWKV, KeywordNsExtensionPatternOutputDevice string


235

2077

236



PageDelivery 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

PdlInitFileNameSubdirectory boolean(attribute of PdlInitFileName

indicates whether or not the Printer will accept a FORWARD SLASH (“/”) character in the value of the “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 PdlInitFile<service>ColorMode list of keywords PrintColorModeWKV<service>tContentOptimize list of keywords PrintContentOptimizeWKV, KeywordNsExtensionPatternQuality list of keywords

PrintQualityWKV, KeywordNsExtensionPatternResolutions complex

Resolution complex the supported sequence of resolutions in Cross Feed and Feed direction for image capture.

CrossFeedDir intFeedDir intUnits list of keywords UnitsWKV

SeparatorSheets complexSpreaderSheetsType list of keywords SeparatorSheetsTypeWKV, KeywordNsExtensionPatternMedia list of keywords MediaSizeAliasNameWKV, MediaSizeLegacyNamesWKV,

MediaSizeSelfDescribingNameWKVMediaType list of keywords MediaTypeWKVMediaCol boolean Indicates whether feature is supportedAny various Extension point for SeparatorSheets

SheetCollate list of keywords SheetCollateWKVSides list of keywords SidesWKV XImagePosition list of keywords See [PWG5100.3 ]

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

YImagePositionWKVYImageShift range of int See [PWG5100.3 ]YSide1ImageShift range of intYSide2ImageShift range of intAny various Extension point for <service> 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


237

2078

2079208020812082

238


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 Get<service>Elements request. Rather, an explicit request for the specific Media Col elements desired is required.

Figure 71 Media Col Structure

Table 44 MediaCol Elements

Element DataType Description or Keyword

Reference [PWG5100.3]

MediaColMediaBackCoating list of keywords supported pre-process coatings applied to the media

MediaCoatingWKV, MediaColorExtensionPatternpara 3.13.10

MediaColor list of keywords media color supported MediaColorWKV, MediaColorExtensionPattern

para 3.13.4

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


239

20832084

208520862087

2088

2089

2090

240




MediaCoatingWKV, MediaNsExtensionPatternMediaGrain list of keywords Supported grain of the media (affects curling and folding

MediaGrainWKV, MediaNsExtensionPattern[PWG5100.11] para 11.5.2

MediaHoleCount range of int Supported number of predrilled holes for the media para 3.13.6MediaInfo 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.MediaOrderCount range 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

MediaRecycled list 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.8XDimension range of int para 3.13..8.1

YDimension range of int para 3.13..8.2

MediaSizeName list of keywords Supported named sizes of the media MediaSizeNameWKV, MediaSizeNameExtensionPattern

[PWG5101.1] para 5

MediaThickness range 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

MediaType list of keywords 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.9Any various

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.


241

2091

20922093

2094

20952096

2097

242


Figure 72 Imaging Service Job Description Capabilities

Table 45 Imaging Service Job Description Capabilities

Element DataType DescriptionElementsNaturalLanguage list of keywords supported natural languages for the Elements with a string syntax (See [RFC3066]

NaturalLanguageWKVJobAccountingID boolean Service’s support for Job Accounts.JobAccountingUserID boolean Service’s support for a User supplied Accounting ID associated with Job.JobMandatoryElements 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.4JobName boolean Service’s support of a name for the Job.JobOriginatingUserName boolean Service’s support of the name of the user submitting the JobJobOriginatingUserUri 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.


243

2098

2099

2100

244


Element DataType DescriptionTemplateName 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

Figure 73 Print Service Specific Job Description Capabilities

Table 46 Service Specific Job Description Capabilities

Element DataType DescriptionCompressiuonSupplied list of keywords CompressionWKV, KeywordNsExtensionPatternDocumentCharsetSuppied list of keywords CharsetWKV, KeywordNsExtensionPatternDocumentDigitalSignatureSupplied boolean True if supportedDocumentFormatDetailsSupplied 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, KeywordNsExtensionPatternDocumentFormatVersionSupplied boolean Service’s support for Document Format VersionDocumentMessageSupplied boolean Service’s support for Document MessageDocumentNameSupplied boolean Service’s support for Document NameAny (service specific) various an extension point for <service>JobDescriptionCapabilities


245

2101

2102

2103

246


Figure 74 Document Format Details Structure

Table 47 Document Format Detail Elements

Element DataType Description ReferenceDocumentFormatDetailsSupplied 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

DocumentSourceOsVersion string 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

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


247

2104

2105

2106

2107

2108210921102111

2112

211321142115

211621172118

248


Processing Capabilities Elements as well as some others that are not included in the example Service Schema illustrations.

Figure 75 Imaging Service Job Processing Capabilities

Table 48 Imaging Service Job Processing Capabilities

Element DataType Description orKeyword

Reference

JobDelayOutputUntil list of keywords the named events for releasing the delayed output [PWG5100.11] para 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.1JobPhoneNumber 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


249

21192120

2121

2122

2123

250


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

Table 49 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)

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

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


251

2124

21252126

2127

252



Reference

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)

DestinationUriSchemes list 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 8.2.3.1.3.

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

[RFC3192]

DocumentOutputMode list of keywords (Scan, etc) DocumentOutputModeWKV, KeywordNsExtensionPattern

[PWG5108.2] para 8.1.3.3.6

JobAccountingSheets complex (Figure 75) [PWG5100.3] para 3.8JobAccountingSheetsType list of keywords JobAccountingSheetsTypWKV [PWG5100.3] para 3.8.1JobAccountingOutputBin list of keywords JobAccountingOutputBin [PWG5100.3] para 3.8.3Media list of keywords MediaSizeAliasNameWKV,

MediaSizeLegacyNamesWKV, MediaSizeSelfDescribingNameWKV MediaSizeNameExtensionPattern

[RFC2911] para 4.2.11

MediaType list of keywords MediaTypeWKV MediaTypeExtensionPattern [PWG5100.3] para 3.13.2MediaCol boolean Indicates if MediaCol is supported for

JobAccountingSheets[PWG5100.3] para 3.13

Any various Extension point for JobAccountingSheetsJobCopies range of int Numbers of copies supported (Figure 74) [PWG5100.7] para 4.1.1JobCoverBack complex (Figure 75) [PWG5100.7] para 4.1.2

CoverType list of keywords [PWG5100.3] para 3.1.2

Media list of keywords MediaSizeAliasNameWKV, MediaSizeLegacyNamesWKV, MediaSizeSelfDescribingNameWKV MediaSizeNameExtensionPattern

[RFC2911] para 4.2.11


JobCoverBack[PWG5100.3] para 3.13

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

CoverType list of keywords [PWG5100.3]para3.1.2Media list of keywords MediaSizeAliasNameWKV,


[RFC2911] para 4.2.11


253

254



Reference


JobCoverFront[PWG5100.3] para 3.13

Any various Extension point for JobCoverFrontJobErrorSheet complex (Figure 76)

JobErrorSheetType list of keywords JobErrorSheetTypeWKVJobErrorSheetWhen list of keywords JobErrorSheetWhenWKVMedia list of keywords MediaSizeAliasNameWKV,


[RFC2911] para 4.2.11

MediaType list of keywords MediaTypeWKV MediaTypeExtensionPattern [PWG5100.3] para 3.13.2MediaCol Boolean Indicates if MediaCol is supported for

JobErrorSheet[PWG5100.3] para 3.13

Any various Extension point for JobErrorSheetJobFinishings list of keywords JobFinishingsWKV (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.1Stitching complex [PWG5100.3] para 3.2.2

StitchingReferenceEdge list of keywords StitchingReferenceEdgeWKV [PWG5100.3] para 3.2.2.1StitchingOffset range of int [PWG5100.3] para 3.2.2.2StitchingLocations range 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.9

SaveDisposition list of keywords SaveDispositionWKV [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

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.12JobSheets 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

Media list of keywords MediaSizeAliasNameWKV, MediaSizeLegacyNamesWKV, MediaSizeSelfDescribingNameWKV MediaSizeNameExtensionPattern

[RFC2911] para 4.2.11


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


255

256



Reference

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 timeoutsNumberOfRetries 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 RetryInfoAny (service specific) various an extension point for <service>

JobProcessingCapabilities

6.5 Service ConfigurationThe 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 DefaultsThe Service Defaults (Error: Reference source not found) can include a Default Document Ticket (Error: Reference source not found) and a Default Job Ticket (Error: Reference source 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.

Figure 77 Imaging Service Defaults


257

2128

2129

213021312132

21332134

2135

2136213721382139214021412142

2143

2144

258


Figure 78 Basic Document Ticket Default

Figure 79 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

6.7 Service DescriptionThe 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.

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

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.


259

2145

2146

2147

2148

2149

215021512152

2153

215421552156215721582159216021612162

260


Figure 80 Imaging Service Description


261

2163

2164

262


Table 50 Service Description Elements


Reference

CharsetConfigured keyword CharsetWKV [RFC2911] Para 4.3.19CharsetSupported list of keywords CharsetWKV [RFC2911] Para 4.3.19DeviceId string IEEE 1284 Device ID [PWG 5105.1] Para 11.1MakeAndModel string [RFC2911] Para 4.4.9MessageFromOperator string [RFC2911] Para 4.4.25NaturalLanguageConfigured keyword NaturalLanguageWKV [RFC2911] Para 4.4.19NaturalLanguageSupported * list of keywords NaturalLanguageWKV [RFC2911] Para 4.4.20OperationsSupported list of keywords OperationsSupportedWKV [RFC2911] Para 4.4.15OwnerURI 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.1XriAuthentication list of keywords UriAuthenticationWKV [RFC2911] Para 4.4.2XriSecurity list of keywords UriSecurityWKV [RFC2911] Para 4.4.3

Any 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:

‘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.


263

2165

2166

216721682169

2170

2171217221732174

2175

217621772178217921802181

264


Figure 81 Representative Service-Specific Service Description (FaxOut)

Table 51 Service-Specific Service Description Elements

Element DataType Description ReferenceCompressionDefault keyword Default Compression algorithm assumed to be used on [RFC2911]


265

2182

2183

2184

266


Element DataType Description Referencethe Document Data 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 booleanMultipleOperationTimeout 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 stringServiceOrganizationUnit stringAny various Extension point for ServiceOrganizations

Any various Extension point for <service>ServiceDescription


267

268


Figure 82 Detail of DocumentFormatDetailsDefault

Table 52 Constituent Elements of DocumentFormatDetailsDefault

Element DataType ReferenceDocumentFormatDetailsDefault complex [PWG5100.7] section 7.6

DocumentSourceApplicationName stringDocumentSourceApplicationVersion stringDocumentSourceOsName keywordDocumentSourceOsVersion stringDocumentFormat keywordDocumentFormatDeviceId stringDocumentFormatVersion stringDocumentNaturalLanguage keyword

6.8 Service StatusThe 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 <service> Pause operation may result in the change of the State and State Reasons Elements.

Service Status Elements consists of two sequences. 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.


269

2185

2186

2187

2188

2189

219021912192

21932194219521962197

270


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 <service>Counters Element which includes the counters applicable to that Service. Counters are discussed separately in Chapter 8, Counters & Timers.

Figure 83 Imaging Service Status

Table 53 Service Status Elements

Element DataType DescriptionAccessModes list of keywords basic 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


271

21982199

220022012202

2203

2204

2205

272


Element DataType Descriptionany externally specified access policy.ObjectAccessModeWKV

ConditionTable complex additional information on the current and past state of Services and Subunits. 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 paragraph10.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 intKOctetsProcessed 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 54 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 7 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. A mandatory list of active conditions An optional Condition History.


273

2206

2207

2208

2209

22102211221222132214

221522162217

274


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.

Figure 84 Condition Table

Table 55 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


275

221822192220

2221

2222

2223

276


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 source not 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 as 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.

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.


277

2224

22252226

22272228222922302231

2232223322342235223622372238

22392240224122422243224422452246

2247224822492250225122522253225422552256

22572258225922602261226222632264

278


7. Counters & TimersCounters 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 MFDs 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 MFD Model as well as in the System. Counters and timers of a particular parameter may be with respect to the MFD 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.

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.


279

2265

226622672268226922702271227222732274

227522762277

2278

22792280228122822283228422852286228722882289229022912292

22932294

22952296

22972298

2299

230023012302230323042305

2306

280


Figure 85 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 MFD 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.

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


281

2307

2308

2309231023112312231323142315

23162317

2318

2319

23202321232223232324

2325

282


Note that: 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. 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.

An Image is the digital representation of a virtual media sheet side. 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. 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 source not found. Note however that all counter types are optional.


283

232623272328232923302331233223332334233523362337

2338233923402341

284


Figure 86 Counters, Showing the Derivation of Service Totals and System Totals


285

2342

2343

286


Figure 87 Work Counter Counts Type

Table 56 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

FullColorImpressionsHighlightColorImpressions int Number of Impression requiring a black colorant plus one other colorantHighlightColorImpressionsTwoSided int Number of instances where both sides of a sheet Printed in duplex are

HighlightColorImpressionsImages int Total images of all typesImpressions Int Total Impressions of all types


287

2344

2345

2346

288


Element DataType Description *ImpressionsTwoSided 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

MonochromeImpressionsOutputKOctets int Quantity of outgoing data In units of 1024 octetsOutputMessages int Total number of messages sent by the serviceAny various Extension point for Counts

7.2 MediaUsed CountersThe 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: Reference source not found with constituent Elements described in Error: Reference source not found.

Figure 88 Media Used Counters

Table 57 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 impressionMediaUsedMediaInfo string Human readable media description


289

2347

2348234923502351

2352

2353

2354

290


MediaUsedMonochromeSheets int Count of instances this media had monochrome impressionMediaUsedSizeName 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

7.3 Availability CountersThe Availability counters indicate the availability a System, Service or Subunit by measuring the Down Time, Processing Time, Time In, Maintenance Mode and Total Time. 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 89 Availability Counters

Table 58 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

7.4 Monitoring CountersMonitoring 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 .


291

2355

235623572358

23592360

2361

2362

2363

2364

2365236623672368

292


Figure 90 Monitoring Counts

Table 59 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


293

2369

2370

2371

2372

2373

294


8. Imaging Job Model 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: Reference source not found. The individual Services each have their own <service>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 9) 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 91 Imaging Job

8.1 Job StatusJob Status Elements provide state information for the Job. The <service> 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


295

2374

237523762377

23782379238023812382

23832384238523862387238823892390

2391

2392

2393

2394239523962397

296


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 source not found and listed in Error: Reference source not found All Services include a <service>Job Counters complex Element; the constituent counters are discussed in Chapter 7. Most include an Images Completed or Impressions Completed Element. Some Services include substantially more Elements in Job Status.


297

239823992400

2401240224032404

298


Figure 92 Imaging Job Status

Table 60 Job Status Elements


299

2405

2406

2407

300



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 8.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

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


301

302



Reference

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

ImpressionsCompleted int [RFC2911] para. 4.3.18.2

Any various an extension point for JobStatus

8.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 93 Job Originating User Authentication Info

Table 61 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 RFC4648Cert base64binary Contains a transport safe encoded certificate RFC4648AuthUri anyUri A sting with a URI syntax RFC2396AuthString string A stringAny various Vendor specific type other than one of the above


303

2408

24092410

2411

2412

2413

304


Figure 94 Representative Service-Specific Job Status Elements

Table 62 Service-Specific Job Status Elements

Element DataType Description ReferenceCompressionDetected keyword Compression type actually used on the Document [PWG5100.5]

para9.1.12DocumentFormatDetailsDetected 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

DocumentSourceApplicationVersion 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

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 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


305

2414

2415

2416

306


Element DataType Description ReferenceDocumentNaturalLanguage 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

<service>JobCounters complex Counters appropriate to the Service See Chapter 7 [PWG5106.1]Images (or Impressions)Completed int Number of images (or impressions) processed by the

service[PWG5106.1]

Any various Extension point for <service>JobStatus

8.2 Job TicketThe 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.

Figure 95 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 Default<service>Job Ticket that is part of the Service model (see Error: Reference source not found, 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.

8.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


307

2417

2418241924202421

2422

2423

24242425242624272428242924302431

2432

2433243424352436

308


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: 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. 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.

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 96 JobTicket Superclass DocumentProcessing

Table 63 JobTicket Superclass DocumentProcessing Elements

Element DataType Description or Keyword Group ReferenceNumberUp 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


309

24372438

243924402441244224432444244524462447

244824492450

2451

2452

2453

310


Figure 97 JobTicket DocumentProcessing - Image Output Services Sheet 1


311

2454

2455

312


Figure 98 JobTicket DocumentProcessing - Image Output Services Sheet 2


313

2456

2457

314


Figure 99 JobTicket DocumentProcessing - Image Output Services MediaBox

Table 64 Service-Specific Job Ticket Document Processing Elements - Image Output Services


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

DestinationDirectory anyURI 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


315

2458

2459

24602461

316



Reference

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

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

ImageCroppingPolicy keyword 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

OrientationRequested keyword identifies the orientation of the MediaBox OrientationRequestedType

[RFC2911] para 4.2.10

Any various Extension point for MediaBox


317

318



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

ScanRegion complex See 4.6.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 determinedSides 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 65 Color Processing Elements

Keyword Color Type Color Encoding Bit Depth Samples per pixel


319

246224632464

2465

320


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

8.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:

‘Inside’ – the header is added within document image for transmission, ‘Outside’ – The header is added outside the document image for transmission, ‘No Print’ – the header is not added to the document image for transmission.

Figure 100 JobTicket DocumentProcessing - Impression Output Services Sheet 1

Figure 101 JobTicket DocumentProcessing – Impression Output Services Sheet 2

Figure 102 JobTicket DocumentProcessing – Impression Output Services Sheet 3


321

2466

24672468246924702471247224732474

2475

2476

2477

2478

2479

2480

322


Table 66 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

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.11]

para 7.1FilmScanMode 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

StitchingReferenceEdge 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

FontSizeRequested int Specifies the font size for a document format that does not have inherent font information

[PWG5100.11] para 7.3


323

24812482

324



Reference

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 8.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

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


325

326



Reference

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

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

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


327

328


8.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 source not 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 Get<service>JobElements or Get<service>JobElements request. An explicit request for the specific Media Col elements is required.


329

2483

248424852486248724882489

249024912492

330


Figure 103 Media Col Structure Specific

Table 67 Media Collection Elements in Job Ticket


331

2493

2494

2495

332


Element DataType

Description or Keyword


MediaColMediaBackCoating keyword pre-process coatings applied to the media

MediaCoatingWKV, MediaColorExtensionPatternpara 3.13.10

MediaColor keyword color of the media MediaColorWKV, MediaColorExtensionPattern

para 3.13.4

MediaFrontCoating keyword 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

MediaHoleCount int number of predrilled holes for the media para 3.13.6MediaInfo 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 valuespara 3.13.1

MediaOrderCount int 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

MediaRecycled keyword 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

XDimension int para 3.13..8.1

YDimension int para 3.13..8.2

MediaSizeName keyword Name of medium size that the Printer uses for all impressions of the Job MediaSizeNameWKV, MediaSizeNameExtensionPattern

[PWG5101.1] para 5

MediaThickness int thickness of the media in .01 millimeters [PWG5100.11] 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

MediaWeightMetric int weight of the desired media rounded to the nearest whole number of grams per square meter

para 3.13.9

Any various Extension point for MediaCol

8.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. Elements inherited from the Imaging Job super class (i.e., Imaging Job Description), as

represented in Figure 98 and listed in Table 66. 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.


333

2496

2497249824992500

250125022503250425052506

2507250825092510

334


Figure 104 ImagingJobDescription (Superclass)

Table 68 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


335

2511

2512

2513

336


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

TemplateName 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


337

338


Figure 105 Representative Service-Specific Job Ticket Job Description Elements ( Print Service)

Table 69 Service-Specific JobTicketJobDescription Elements

Element DataType Description ReferenceCompressiuonSupplied 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


339

2514

25152516

2517

340


Element DataType Description ReferenceDocumentSourceOsVersion 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

DocumentFormatSupplied 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

8.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: 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. 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.


341

2518

2519252025212522

25232524252525262527252825292530

342


Figure 106 Superclass Job Processing Elements

Table 70 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]

JobMandatoryElements variousJobPriority int JobPriorityType [RFC2911] para4.2.1JobRecipientName string name of the intended recipient of the Job. [[PWG5100.11para 5.6

8.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.

8.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.


343

2531

2532

2533

2534

25352536253725382539

2540

254125422543

344


8.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 = "-" / "." / "(" / ")" / "'" / "(" / ")"

8.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.

8.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.

8.2.3.1.5 Any

This is the extension point for the DestinationUris element.

8.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.

8.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.


345

2544

254525462547

2548254925502551255225532554

2555

255625572558

2559

25602561256225632564

2565

2566

2567

2568256925702571257225732574

2575

2576257725782579

346


8.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.

8.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.

8.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.

8.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.

8.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.

8.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.

8.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.

8.2.3.3.8 Any

This is the extension point for the CoverSheetInfo element.

8.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.

8.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.


347

2580

25812582

2583

258425852586

2587

25882589

2590

25912592

2593

25942595

2596

25972598

2599

26002601

2602

2603

2604

26052606

2607

260826092610

348


8.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.

8.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 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.

8.2.3.4.4 Any

This is the extension point for the RetryInfo element.


349

2611

261226132614

2615

2616261726182619

2620

2621

350


Figure 107 Representative Service-Specific Job Processing Elements (FaxOut Service) Sheet 1

Figure 108 Representative Service-Specific Job Processing Elements (FaxOut Service) Sheet 2


351

2622

26232624

2625

26262627

352


Figure 109 Representative Service-Specific Job Processing Elements (Copy Service) Sheet 1

Figure 110 Representative Service-Specific Job Processing Elements (Copy Service) Sheet 2

Table 71 Service-Specific Job Processing Elements


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 8.2.3.2

CoverSheetInfo complex Information entered by user to be put on Fax cover sheet.

See 8.2.3.3

CompanyName string user-supplied company name See 8.2.3.3.1DateTime string user-supplied date and time See 8.2.3.3.2From string user supplied name of the person group or entity for

the cover sheetSee 8.2.3.3.3

Logo URI user supplied URL pointing to an image to use as the logo for the cover sheet

See 8.2.3.3.4

Message string user-supplied message for the cover sheet See 8.2.3.3.5Subject boolean user-supplied subject entry for the cover sheet See 8.2.3.3.6To boolean user-supplied name of the intended recipient of the

documentSee 8.2.3.3.7

Any various extension point for CoverSheetInfo See 8.2.3.3.8DestinationUris Complex see para.8.2.3.1

DestinationUri URI URL used to transfer a Digital Document to its Destination.

See 8.2.3.1

PreDialString string dial string entered before the DestinationUri is applied See Error: Reference source not found

PostDialString string dial string entered after the DestinationUri is applied See 8.2.3.1.3T33Subaddress int For T33 subaddressing See 8.2.3.1.4Any various extension point for DestinationUris

DocumentOutputMode keyword Way in which the output documents are partitioned among files. See para 4.6.2DocumentOutputModeWKV, KeywordNsExtensionPattern

[PWG5108.2] para 8.1.3.3.6

JobAccountingSheets complex Specifies the accounting sheet for a job [PWG5100.3] para 3.8JobAccountingSheetsType 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.13JobAccountingOutputBin keyword output bin where the accounting sheet is to be placed,

OutputBinWKV, KeywordNsExtensionPattern

[PWG5100.3] para 3.8.3

Any various extension point for JobAccountingSheets


353

2628

26292630

2631

26322633

2634

354



Reference

JobCopies int The number of copies of the Job to be Printed [PWG5100.7] para 4.1.1JobCoverBack complex Characteristics of back cover for this Job

CoverType 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

MediaCol complex See 5.2.1.1 [PWG5100.3] para 3.13Any various Extension point for JobCoverBack

JobCoverFront 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

MediaCol complex See 5.2.1.1 [PWG5100.3] para 3.13Any various Extension point for JobCover Front

JobErrorSheet complex Characteristics of JobErrorSheet for this Job [PWG5100.3] para 3.9JobErrorSheetType keyword Indicates if JobErrorSheet is requested and which

sides will contain Print [PWG5100.3] para 3.9.1

JobErrorSheetWhen keyword 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

MediaCol complex See 5.2.1.1 [PWG5100.3] para 3.13Any various extension point for JobErrorSheet

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.1Stiching complex detailed stitching parameters [PWG5100.3] para 3.2.2

StitchingReferenceEdge 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

StitchingLocations int 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


355

356



Reference

JobSaveDisposition complex used to archive/save the Document Data of a job [PWG5100.11] para 7.9SaveDisposition 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

JobSheetMessage string a message that is delivered with the job [PWG5100.3] para 3.12JobSheets 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.11JobSheets 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.13Any various Extension point for JobSheetsCol

MultipleDocumentsHandling 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.1Pages range of

intidentifies 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

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 8.2.3.4

NumberOfRetries int number of retries before Job aborts See 8.2.3.4.1RetryInterval int time duration in seconds between retry attempts See 8.2.3.4.2RetryTimeout int time duration in seconds before terminating a retry See 8.2.3.4.3


357

358



Reference

Any (service specific) various an extension point for RetryInfo See 8.2.3.4.4Any various Extension point for Job Processing

8.3 Job ReceiptThis 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 8.2 for Element descriptions.


359

2635

2636263726382639

360


9. Document ModelThe 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 <service>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 <service>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 8.

Figure 111 Imaging Document Model

9.1 Document StatusJob Status consists of two sequences.

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.

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.

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.


361

2640

264126422643264426452646

26472648264926502651

265226532654

2655

2656

2657

26582659266026612662

266326642665

362


Figure 112 Imaging Document Status

Table 72 Document Status Elements


363

2666

2667

2668

364


Element DataType Description or Keyword Group ReferenceDateTimeAtCompleted 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]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 “<service>UpTime” seconds

[RFC2911] para 4.3.14.3

TimeAtCreation int time at which the Document was created in “<service>UpTime” seconds

[RFC2911] para 4.3.14.1

TimeAtProcessing int time at which the Document first began processing in “<service>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]

ImpressionsCompleted int

Any various Extension point for DocumentStatus


365

366


Figure 113 Service-Specific Document Status Elements


367

2669

2670

2671

368


Table 73 Service-Specific Document Status Elements

Element DataType Description or Keyword Group ReferenceCurrentPageOrder 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

<service>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 for<service>DocumentStatus PWG5100.5 para 9.1.24

9.2 Document TicketThe Document Ticket contains description and processing Elements provided by the Client. The general Imaging Document Ticket is shown in Error: Reference source not found. All <service> Document Tickets follow this form, although the description and processing 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 114 Imaging Document Ticket

9.2.1 Document Description

Document Description consists of two sequences: 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.


369

2672

2673

26742675267626772678

2679

2680

2681

268226832684

370


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 115 Imaging Document Description

Table 74 Document Description Elements


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


371

2685268626872688

2689

2690

2691

372


Figure 116 Service-Specific Document Description Elements

Table 75 Service-Specific Document Description Elements


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

DocumentFormatDetailsSupplied 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.6DocumentMessageSupplied 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 <service>DocumentDescription


373

2692

2693

2694

374


9.2.2 Document Processing

This group Element has exactly the same structure as the Document Processing Element of Job (See 8.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.

9.3 Document ReceiptThis 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 substitutions made by the Service and any Default Elements applied by the Service. See Section 9.2 for Element descriptions.


375

2695

269626972698

2699

270027012702270327042705

376


10. Service Operations and States

10.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 10.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.

Figure 117 Service State Model

10.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


377

2706

2707

27082709271027112712271327142715

2716271727182719

272027212722

2723

2724

2725

27262727

378


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.

10.1.2 Job Creation

A user initiates a Job by submitting a CreateJob request through a local (via the MFD user interface) or remote (via local network or Internet) Client. The “intent” of the 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 Ticket Life Cycle, section 4.8.)

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.

10.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.


379

2728272927302731

273227332734273527362737

2738

2739274027412742274327442745

27462747

2748274927502751

275227532754275527562757

2758275927602761276227632764

2765

27662767276827692770277127722773

380


10.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.

10.2 Service, Job and Document StatesThe 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.

10.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 and Events are summarized in Error: Reference source not found, Error: Reference source not found and Error: Reference source not found.

10.2.1.1 Service States

The modeling of a Service is based on the following six states. 7. 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 MFD, the Service will be initialized and will transition to the Down state.

8. 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.

9. Testing: An implementation-dependent state in which normal processing is not possible but the Service is operating in a test mode.

10. 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.


381

2774

27752776277727782779278027812782278327842785

2786278727882789279027912792

279327942795

2796

2797279827992800

2801

2802280328042805

2806

280728082809281028112812281328142815281628172818

382


11. Processing: At least one Job is in the Processing Job state. 12. 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.

10.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: Reference source 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.

Table 76 Conditions and Bounding Events

Condition Initiating Event Initiating Cause Terminating Event Terminating CauseC.testing E.testing Implementation dependent E.testingCleared Implementation dependentC.warning E.warning Some non critical equipment

problemE.warningCleared Clearing non critical equipment

problemC.critical E.critical A critical equipment problem E.criticalCleared Clearing critical equipment

problemC.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 DisableC.Pause E.pause Pause E.resume Resume

Note: 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.


383

281928202821

2822

282328242825

282628272828282928302831

283228332834283528362837

2838

283928402841

384


Figure 118 Service State Transitions and Causal Events


385

2842

2843

386


10.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 77 ServiceState Change by Operations

State

Down Testing Idle Processing Stopped

Operation Action(end state, condition)

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 1. 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.2. 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.3. StartupService sent when the Service is in the Down state has the same effect as a RestartService. StartupService is illegal

in any other state.4. PauseService and ShutdownService. Depending upon implementation:5. 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). 6. 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.

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

10.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 78 Service State Change by Events


387

2844

2845284628472848

2849

2850285128522853285428552856285728582859286028612862286328642865

2866

2867

2868286928702871

28722873

2874

388


Input

State

Down Testing Idle Processing Stopped

Event(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.paused

errorC.paused(Stopped) error

E.endJob

error --- errorschedule(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.warning

E.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 1. 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.2. 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.3. StartupService sent when the Service is in the Down state has the same effect as a RestartService. StartupService is illegal

in any other state.4. PauseService and ShutdownService. Depending upon implementation:5. 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). 6. 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.

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

10.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 source not 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.


389

2875287628772878287928802881288228832884288528862887288828892890

2891

2892289328942895

289628972898

2899

2900

390


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 Critical Event, or because the Service is awaiting resources necessary to continue processing.

Figure 119 Job State Transition

10.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.


391

2901

2902

29032904

29052906

2907

2908290929102911

2912

2913

2914

291529162917

29182919292029212922292329242925

392


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', '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.

Figure 120 Document State Transition


393

29262927292829292930293129322933

29342935293629372938

2939

29402941294229432944294529462947294829492950295129522953

2954

2955

394


10.3 Service OperationsThis section defines normative semantics of Service operations and the behavior in response to these operation requests by a Service conformant to the MFD model.

A User makes a Service request by interacting through a local Client (via the MFD 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 MFD Operations described in this section are common to more than one Service, with the “<service>” 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 Startup<service>Service, which is sent to the MFD 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.

The MFP operations applicable to two or more Services are listed in Error: Reference source 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 79 MFD Common Operations and Antecedents

MDF Operation Antecedent IPP Operation Antecedent Reference Access*Add<service>HardcopyDocument Send-URI** [RFC2911] UserCancel<service>Document Cancel-Document [PWG5100.5] 4.5 UserCancel<service>Job Cancel-Job [RFC2911] 3.3.3 UserCancel<service>Jobs Cancel-Jobs [PWG5100.11] 5.1 AdminCancelCurrent<service>Job Cancel-Current-Job [RFC3998] 4.2 UserCancelMy<service>Jobs Cancel-My-Jobs [PWG5100.11] 5.2 User

Close<service>Job Close-Job [PWG5100.11] 5.3 UserCreate<service>Job Create-Job

Print-Job[RFC2911] 3.1.4

3.2.1User

Disable<service>Service Disable- Printer [RFC3998] 3.1.1 AdminEnable<service>Service Enable- Printer [RFC3998] 3.1.2 AdminGet<service>DocumentElements Get-Document-Attributes [PWG5100.5] 4.3 UserGet<service>Documents Get-Documents [PWG5100.5] 3.3 User

Get<service>JobElements Get-Job-Attributes [RFC2911] 3.3.4 UserGet<service>Job History Get-Jobs (which-Jobs Element =

‘completed’)[RFC2911] 3.2.6 User

Get<service>ServiceElements Get- Printer-Attributes, Get- Printer-Supported-Values

[RFC2911], [RFC3380]

3.2.5 User


395

2956

29572958

2959296029612962

2963296429652966

29672968296929702971

2972297329742975297629772978

2979

2980

396


MDF Operation Antecedent IPP Operation Antecedent Reference Access*GetActive<service>Jobs Get-Jobs (which-Jobs Element =

‘not-completed’)[RFC2911] 3.2.6 User

Hold<service>Job Hold-Job [RFC2911] 3.3.5 UserHoldNew<service>Jobs Hold-New-Jobs [RFC3998] 3.3.1 AdminPause<service>Service Pause- Printer [RFC2911] 3.2.7 AdminPause<service>ServiceAfterCurrentJob Pause- Printer-After-Current-Job [RFC3998] 3.2.1 AdminPromote<service>Job Promote-Job

Schedule-Job-After[RFC3998] [RFC3998]

4.4.1 Admin

Release<service>Job Release-Job [RFC2911] 3.3.6 UserReleaseNew<service>Jobs Release-Held-New-Jobs [RFC3998] 3.3.2 AdminRestart<service>Service Restart- Printer [RFC3998] 3.5.1 AdminResubmit<service>Job Resubmit-Job [PWG5100.11] 5.4 UserResume<service>Job Resume-Job [RFC3998] 4.3.2 UserResume<service>Service Resume- Printer [RFC2911] 3.2.8 AdminSend<service>Document Send-Document [RFC2911] 3.3.1 UserSend<service>URI Send-URI [RFC2911] 3.3.2 UserSet<service>DocumentElements Set-Document-Attributes [PWG5100.5] 4.4 UserSet<service>JobElements Set-Job-Attributes [RFC3380] 4.2 UserSet<service>ServiceElements Set- Printer-Attributes [RFC3380] 4.1 AdminShutdown<service>Service Shutdown- Printer [RFC3998] 3.5.2 AdminStartup<service>Service Startup- Printer [RFC3998] 3.5.3 AdminSuspendCurrent<service>Job 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 (Get<service>JobElement, Get<service>JobHistory and Get<service>Jobs), 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 Add<service>HardcopyDocument 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 MFD 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 MFD Operation definitions are divided between basic or User (Job-oriented) operations and administrative operations. The basic MFD 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 (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


397

29812982298329842985298629872988

29892990299129922993

29942995299629972998299930003001

30023003300430053006

398


Table 80 Basic MFD Interface Requests and Responses

1. OperationRequest

Parameters (Notes 2)Response

Parameters (Note 3)Note

Add<service>HardcopyDocument InputSource, JobId, Document Ticket(optional), ElementsNaturalLanguage(optional), LastDocument(optional), RequestingUserName or RequestingUserUri

DocumentNumber, UnsupportedElements(optional)

Cancel<service>Document DocumentNumber, ElementsNaturalLanguage(optional), JobId, Message (optional) RequestingUserName or RequestingUserUri

Cancel<service>Job ElementsNaturalLanguage(optional), JobId, Message (optional) RequestingUserName or RequestingUserUri

CancelCurrent<service>Job ElementsNaturalLanguage(optional), JobId(optional), Message (optional) RequestingUserName or RequestingUserUri

CancelMy<service>Jobs JobIds (optional), Message (optional), ElementsNaturalLanguage(optional), RequestingUserName or RequestingUserUri

JobIds (optional) 1

Close<service>Job JobId, RequestingUserName or RequestingUserUri

Create<service>Job ElementsNaturalLanguage(optional), Job Ticket (optional) RequestingUserName or RequestingUserUri

JobId, UnsupportedElements(optional)

GetActive<service>Jobs ElementsNaturalLanguageRequested(optional), Limit(optional) RequestingUserName or RequestingUserUri

ElementsNaturalLanguage(optional)JobSummaries (includes JobID, JobName, JobOriginatingUserName, JobState and perhaps JobStateReasons)(optional)

Get<service>DocumentElements Document Number, ElementsNaturalLanguageRequested(optional), JobId, RequestingUserName or RequestingUserUri

DocumentElements(optional), ElementsNaturalLanguage(optional)

Get<service>Documents ElementsNaturalLanguageRequested(optional), JobId, RequestingUserName or RequestingUserUri

Documents(list of DocumentSummaries)(optional), ElementsNaturalLanguage(optional)JobID, JobName

Get<service>JobElements ElementsNaturalLanguageRequested(optional), JobId, RequestedElements (JobReceipt, JobStatus, or Job Ticket.)(optional) RequestingUserName or RequestingUserUri

JobElements, ElementsNaturalLanguage(optional)

Get<service>Job History ElementsNaturalLanguageRequested(optional), Limit(optional) RequestingUserName or RequestingUserUri

ElementsNaturalLanguage(optional)JobSummaries (includes JobID, JobName, JobOriginatingUserName, JobState and perhaps JobStateReasons

Get<service>ServiceElements ElementsNaturalLanguageRequested(optional), RequestedElements (Service Capabilities, ServiceConfiguration, ServiceDescription, ServiceStatus or DefaultJob Ticket.)(optional) RequestingUserName or RequestingUserUri

ElementsNaturalLanguage(optional)ServiceElements(optional)

Hold<service>Job ElementsNaturalLanguageRequested(optional), JobHoldUntil or JobHoldUntilTime, JobId, Message(optional), RequestingUserName or RequestingUserUri

Release<service>Job ElementsNaturalLanguageRequested(optional), JobId, Message(optional), RequestingUserName or RequestingUserUri

Resubmit<service>Job ElementsNaturalLanguageRequested(optional), JobId, Job Ticket (optional) RequestingUserName or RequestingUserUri

JobId, UnsupportedElements(optional)


399

3007

400


1. OperationRequest

Parameters (Notes 2)Response


Resume<service>Job ElementsNaturalLanguageRequested(optional), JobId, Message(optional)RequestingUserName or RequestingUserUri

Send<service>Document ElementsNaturalLanguageRequested(optional), Document Ticket (optional) JobId, LastDocument(optional), RequestingUserName or RequestingUserUri, DocumentData


Send<service>Uri DocumentUri, ElementsNaturalLanguageRequested(optional), Document Ticket (optional) JobId, LastDocument(optional), RequestingUserName or RequestingUserUri


Set<service>DocumentElements DocumentNumber, ElementsNaturalLanguage(optional), SocumentTicket, JobId, Message(optional), RequestingUserName or RequestingUserUri

UnsupportedElements(optional)

Set<service>JobElements ElementsNaturalLanguage(optional), Job Ticket, JobId, Message(optional), RequestingUserName or RequestingUserUri


SuspendCurrent<service>Job ElementsNaturalLanguage(optional), JobId(optional), Message(optional), RequestingUserName or RequestingUserUri

Validate<service>Document Ticket

ElementsNaturalLanguageRequested(optional), Document Ticket RequestingUserName or RequestingUserUri


Validate <service>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.

10.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.

10.3.1.1 Add<service>HardcopyDocument

The Add<service>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<service>Document and Send<service>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:1. The requestor is not the owner of the identified Job, or is not an Administrator or Operator; 2. The Service has already closed inputs to the identified Job, or 3. The Job is not found.


401

3008300930103011301230133014

3015

301630173018301930203021

3022

3023302430253026

3027302830293030

402


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.

10.3.1.2 Cancel<service>Document

The Cancel<service>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<service>Document request is received, some portion of the Document processing might be completed before the Document is actually canceled.

The Cancel<service>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<service>Job, the canceled Document is also submitted for processing. Thus Cancel<service>Document has the same semantics as Cancel<service>Job which cancels only the processing of the Job but does not delete the Job object itself.

The Cancel<service>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<service>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<service>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.

10.3.1.3 Cancel<service>Job

The Cancel<service>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<service>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 source not 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<service>Job operation


403

3031303230333034

3035

30363037303830393040

304130423043304430453046

3047304830493050

30513052305330543055

30563057305830593060

3061

3062306330643065

3066306730683069307030713072

404


10.3.1.4 CancelCurrent<service>Job

The CancelCurrent<service>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.

1. 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.

2. 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.

3. 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.

4. 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.

5. 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.

10.3.1.5 CancelMy<service>Jobs

The CancelMy<service>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.

10.3.1.6 Close<service>Job

The Close<service>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<service>Document, Send<service>URI or Add<service>Document) did not include the LastDocument Element with a 'true' value. This Close<service>Job operation supersedes and, if supported by the Service, is preferable to the


405

3073

3074307530763077

307830793080308130823083308430853086308730883089309030913092309330943095

3096

30973098309931003101310231033104

3105310631073108310931103111311231133114

3115

3116311731183119

406


practice of using a Send<service>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.

10.3.1.7 Create<service>Job

The Create<service>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<service>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 MFD Create<service>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<service>Job Request,

Once a Job is created, Documents may be input as part of that Job by Send<service>Document, Send<service>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<service>Document, Send<service>URI or Add<Service>Document operations. There are two methods of indicating when all Documents have been sent:

1. issuing a Close<service>Document request 2. issuing a Send<service>Document, Send<service>URI or, 3. 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 before taking some recovery action. If, for some reason, there is a longer period between Create<service>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.

10.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<service>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<service>Job, Send<service>Document or Send<service>URI) or provided in Set<service>DocumentElements operation a plus any additional Document Description Elements that the


407

31203121

31223123312431253126

3127

3128312931303131

31323133313431353136

3137313831393140314131423143314431453146

3147314831493150315131523153

3154

315531563157

3158315931603161

316231633164

408


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.

10.3.1.9 Get<service>Documents

The Get<service>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<service> and Get<service> operations except that it returns Elements from Documents rather than identified Jobs. As with the Get<service>DocumentElements operation, the Service MUST return only those Elements that are in the Document Ticket.

10.3.1.10 Get<service>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 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,

10.3.1.11 Get<service>Jobs

The Get<service>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<service>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.

10.3.1.12 Get<service>ServiceElements

The Get<service>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<service>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.


409

31653166316731683169

3170

317131723173

317431753176

3177

31783179318031813182

3183

3184

318531863187318831893190

31913192

3193

319431953196319731983199

3200320132023203

410


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.

10.3.1.13 GetActive<service>Jobs

The GetActive<service>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<service>Jobs may not include a RequestedElements argument; rather, it always returns a JobSummary for each Active Job with the summary 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 or Operator, the Job summary may not include all of the summary information, depending upon site security policy.

10.3.1.14 Hold<service>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<service>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<service>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<service>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<service>Job request can specify only one hold condition. In the case of multiple Hold<service>Job requests, the last accepted request overrides the condition imposed by any previous Hold<service>Request.

The restraint imposed by a Hold<service>Job is removed by a Release<service>Job operation directed to the same Job. If a Service implementation supports Hold<service>Job, it must also support Release<service>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.

10.3.1.15 Release<service>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<service>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<service>Job operation is removed by a Release<service>Job operation directed to the same Job. If a Service implementation supports Hold<service>Job, it must also support Release<service>Job and vice-versa.


411

320432053206

3207

320832093210321132123213

32143215

3216

3217321832193220

32213222322332243225322632273228

322932303231

32323233323432353236

3237

3238323932403241

324232433244324532463247

412


The Job Transitions as a result of a Release<service>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]

10.3.1.16 Resubmit<service>Job

The Resubmit<service>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<service>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 Resubmit<service>Job 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.

1. If the Resubmit<service>Job request contains a processing Element that was in the retained Job but with a different value, the value supplied in the Resubmit<service>Job operation MUST override the original value (if supported by the Service).

2. If the Resubmit<service>Job request contains a processing Element that was not in the retained Job, the Element with the value supplied with the Resubmit<service>Job operation MUST be applied (if supported by the Service)

3. For any processing Element in the original retained Job the value of which is not changed in the Resubmit<service>Job 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 Resubmit<service>Job 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 (Send<service>URI or Send>service>URI), the Service MUST re-fetch the data, since the semantics of Restart<service>Job 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.

The Service MUST accept or reject the Resubmit<service>Job 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.

10.3.1.17 Resume<service>Job

The Resume<service>Job 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 Suspend<service>Job or SuspendCurrent<service>Job operations, it MUST support the Resume<service>Job operation, and vice-versa.


413

324832493250

3251

325232533254

3255325632573258

3259326032613262326332643265326632673268326932703271

3272327332743275327632773278

3279328032813282

3283

3284328532863287328832893290

32913292

414


10.3.1.18 Send<service>Document

The Send<service>Document 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 Create<service>Job, 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 Send<service>Document 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 Send<service>Document requests associated with the same Job. Similarly, if the Service does support multiple Documents per Job, the Service MUST reject Send<service>Document requests associated with a given Job after inputs to that Job have been closed either a Close<service>Job operation or a previous Send<service>Document with a 'true' value for the LastDocument Element. Note that the Client may send and the Service must accept a Send<service>Document 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 Send<service>Document requests.

The Service MUST reject a Send<service>Document request and send an appropriate message if:1. The requestor is not the owner of the identified Job, or is not an Administrator or operator2. The Service has already closed inputs to the identified Job, 3. The Document size, format and/or compression are not supported by the Service, or4. 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.

10.3.1.19 Send<service>Uri

The Send<service>Uri 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 Send<service>Uri operation is identical to the Send<service>Document 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 Send<service>Uri and Send<service>Document operations to add new Documents to an existing multi-Document Job.

As with Send<service>Document, if the Service supports Send<service>Uri but does not support multiple Documents per Job, the Service MUST reject subsequent Send<service>Uri requests associated with the same Job. Similarly, if the Service does support multiple Documents per Job, the Service MUST reject Send<service>Uri requests associated with a given Job after inputs to that Job have been closed. Job inputs can be closed either by a Close<service>Job operation or a Send<service>Document (NOT a Send<service>Uri) request with a 'true' value for the LastDocument Element. Note that the Client may send and the Service must accept a Send<service>Document 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:1. The requestor is not the owner of the identified Job, or is not an Administrator or operator2. The Service has already closed inputs to the identified Job, 3. The Job is not found 4. The Document size, format and/or compression are not supported by the Service, or5. The Service does not support the URI Scheme specified.


415

3293

32943295329632973298

32993300330133023303330433053306

33073308

33093310331133123313

331433153316

3317

331833193320332133223323

33243325332633273328332933303331

333233333334333533363337

416


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 Send<service>Uri requests.

10.3.1.20 Set<service>DocumentElements

The Set<service>DocumentElements 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 specified Job. This operation is parallel to the Set<service>JobElements and Set<service>ServiceElements 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 Set<service>DocumentElements 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 Set<service>DocumentElements 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 Get<service>DocumentElements or Get<service>Documents 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 Set<service>DocumentElements operation.

If the client supplies an Element in a Set<service>DocumentElements 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 Set<service>DocumentElements 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 Set<service>DocumentElements MUST be accepted. If such a Document Creation operation would have been rejected, then the Set<service>DocumentElements 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, Set<service>DocumentElements 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 Create<service>Job request, if any, MUST have no effect on the behavior of the Set<service>DocumentElements operation. Rather, the Service must consider that any Element or Element value in a Set<service>DocumentElements 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.

The Service MUST respond to the Set<service>DocumentElements 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 Set<service>DocumentElements 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


417

3338333933403341

3342

33433344334533463347

33483349335033513352

33533354335533563357335833593360

3361336233633364

3365336633673368336933703371337233733374

33753376337733783379

33803381338233833384

418


example, if the operation creates a request for unavailable resources, the Job (but not the Document) transitions to a new state.

10.3.1.21 Set<service>JobElements

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 Set<service>DocumentElements and Set<service>ServiceElements 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 Set<service>JobElements 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 Get<service>JobElements or Get<service>Jobs 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 Set<service>JobElements operation.

If the client supplies an Element in a Set<service>JobElements 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 Set<service>JobElements 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 Set<service>JobElements request MUST be accepted. If such a Creation operation would have been rejected, then the Set<service>JobElements 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 words, after the operation, all the supplied Elements MUST be set or none of them MUST be set, thus making the Set<service>JobElements an atomic operation.

The value of JobMandatoryElements supplied in the original Create<service>Job request, if any, MUST have no effect on the behavior of the Set<service>JobElements operation. Rather, the Service must consider that any Element or Element value in a Set<service>JobElements 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 Set<service>JobElements operation according to the rules defined for the antecedent Set-Job-Attributes operation in Internet Printing Protocol (IPP):Job and Printer Set Operations [RFC3380].

10.3.1.22 SuspendCurrent<service>Job

The SuspendCurrent<service>Job 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


419

33853386

3387

3388338933903391

339233933394

33953396339733983399340034013402

3403340434053406

3407340834093410341134123413341434153416

34173418341934203421

342234233424

3425

3426342734283429

420


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:1. There is no target Job in the Processing or ProcessingStopped state to which the requestor has

access rights.2. 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:

1. 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,

2. 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.

3. 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.

4. 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.

5. 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 Resume<service>Job operation causes a suspended Job to be released. If a Service supports SuspendCurrent<service>Job operation, it MUST support the Resume<service>Job operation, and vice-versa.

10.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 MFD Administrative Service Operations are listed in Error: Reference source not found and are described below.

Table 81 Administrative Operations

1. OperationRequest Parameters (Note 2) Response


Cancel<service>Jobs ElementsNaturalLanguage(optional), JobIds(optional), Message (optional) RequestingUserName or RequestingUserUri

JobIds (optional) 1


421

343034313432

343334343435

3436

3437

34383439

3440344134423443

34443445344634473448344934503451345234533454345534563457345834593460

346134623463

3464

346534663467

3468

422


1. OperationRequest Parameters (Note 2) Response


Disable<service>Service ElementsNaturalLanguage(optional) Message (optional), RequestingUserName or RequestingUserUri

Enable<service>Service ElementsNaturalLanguage(optional),Message (optional) RequestingUserName or RequestingUserUri

-

HoldNew<service>Jobs ElementsNaturalLanguageRequested (optional), JobHoldUntil | JobHoldUntilTime, Message(optional), RequestingUserName or RequestingUserUri

Pause<service>Service ElementsNaturalLanguageRequested (optional), Message(optional), RequestingUserName or RequestingUserUri

Pause<service>ServiceAfterCurrentJob ElementsNaturalLanguageRequested (optional), Message(optional), RequestingUserName or RequestingUserUri

Promote<service>Job ElementsNaturalLanguageRequested (optional), JobId, Message(optional), PredecessorJobID(optional), RequestingUserName or RequestingUserUri

ReleaseNew<service>Jobs ElementsNaturalLanguageRequested (optional), Message(optional), RequestingUserName or RequestingUserUri

Restart<service>Service ElementsNaturalLanguageRequested (optional), IsAcceptingJobs| IsAcceptingResources (optional), Message(optional), RequestingUserName or RequestingUserUri

Resume<service>Job ElementsNaturalLanguageRequested(optional), JobId, Message(optional), RequestingUserName or RequestingUserUri

Resume<service>Service ElementsNaturalLanguageRequested(optional), Message(optional), RequestingUserName or RequestingUserUri

Set<service>ServiceElements DefaultJob Ticket(optional), RequestingUserName or RequestingUserUri ElementsNaturalLanguageRequested (optional), Capabilities(optional), CapabilitiesReady(optional), Description(optional), Message(optional),

Unsupported Elements(optional)

Shutdown<service>Service ElementsNaturalLanguageRequested(optional), Message(optional), RequestingUserName or RequestingUserUri

4

Note 1: Cancel<service>Jobs 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.

10.3.2.1 Cancel<service>Jobs

The Cancel<service>Jobs 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 Cancel<service>Job operation in 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.


423

3469347034713472347334743475

3476

3477347834793480348134823483

424


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].

10.3.2.2 Disable<service>Service

The Disable<service>Service 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 Create<service>Job. 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 Enable<service>Service operation. If an implementation supports Disable<service>Service it must also support Enable<service>Service and vice-versa.

10.3.2.3 Enable<service>Service

The Enable<service>Service operation asserts the IsAcceptingJobs Element to allow the Service to accept new Create<service>Job 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 Disable<service>Service operation, then it must also support Enable<service>Service operation and vice-versa.

10.3.2.4 HoldNew<service>Jobs

The HoldNew<service>Jobs 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 HoldNew<service>Jobs operation request. The operation has the same effect as a Hold<service>Jobs operation except that any Jobs in the Pending or Processing state when the HoldNew<service>Jobs 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 HoldNew<service>Jobs request and MUST add the supplied 'JobHoldUntil' or JobHoldUntilTime Element to the Jobs. This HoldNew<service>Job 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


425

348434853486348734883489349034913492

3493

3494349534963497

34983499

350035013502

3503

350435053506

350735083509

35103511

3512

351335143515351635173518

351935203521352235233524

35253526

426


10.3.2.5 Pause<service>Service

The Pause<service>Service 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 Pause<service>Service 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 Pause<service>Service operation is supported, then the Resume operation MUST also be supported, and vice-versa.

Service State transitions resulting from a Pause<service>Service 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 Pause<service>Service 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 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 Pause<service>Service 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].

10.3.2.6 Pause<service>ServiceAfterCurrentJob

The Pause<service>ServiceAfterCurrentJob 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 Pause<service>ServiceAfterCurrentJob operation is supported, then the Resume<service>Service operation MUST also be supported.

Service State transitions resulting from a Pause<service>ServiceAfterCurrentJob 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 Pause<service>ServiceAfterCurrentJob request and the Pause<service>Service 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'


427

3527

35283529353035313532353335343535

35363537

3538353935403541354235433544354535463547

354835493550

355135523553

3554

355535563557355835593560

35613562356335643565

3566356735683569

35703571

428


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].

10.3.2.7 Promote<service>Job

The Promote<service>Job 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 Promote<service>Job 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 Promote<service>Job 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 Promote<service>Job 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 Promote<service>Job Request accepted will be processed next.

10.3.2.8 ReleaseNew<service>Jobs

The ReleaseNew<service>Jobs operation allows a client to remove the condition initiated by HoldNew<service>Jobs and to release all Jobs previously forced to a PendingHeld state by the HoldNew<service>Jobs 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 HoldNew<service>Jobs initiated condition.

If the ReleaseNew<service>Jobs operation is supported, then the HoldNew<service>Jobs operation MUST be supported, and vice-versa.

10.3.2.9 Restart<service>Service

The Restart<service>Service 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-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 Restart<service>Service regardless of its current state. Providing that no conditions exist that would normally prevent these actions,


429

35723573

3574357535763577

3578

357935803581358235833584

35853586358735883589

3590359135923593

3594

35953596359735983599

360036013602

36033604

3605

3606360736083609361036113612

36133614

430


the Service MUST reinitialize its State to Idle, clear the StateReasons Element and set the IsAcceptingJobs Element to true.

10.3.2.10 Resume<service>Service

The Resume<service>Service 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 Resume<service>Service 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 Resume<service>Service operation is supported, then the Pause<service>Service operation MUST be supported, and vice-versa.

10.3.2.11 Set<service>ServiceElements

The Set<service>ServiceElements 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:

1. 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)

2. 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.

3. 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 Set<service>ServiceElements 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.

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.

10.3.2.12 Shutdown<service>Service

The Shutdown<service>Service 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 Restart<service>Service request. As with the antecedent IPP Shutdown- Printer operation all Jobs MUST be preserved. As with Restart<service>Service, 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.


431

36153616

3617

3618361936203621362236233624

36253626

3627

362836293630

36313632363336343635363636373638363936403641

36423643

364436453646

36473648

3649

36503651365236533654365536563657

432


Once shut down, a Service can be roused from its Down state by a Restart<service>Service operation. If a Service implementation supports Shutdown<service>Service it must also support Restart<service>Service and vice-versa. In the down state, the only operation request that a service will respond to is a Restart<service>Service 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.


433

3658365936603661

366236633664

434


11. Specific Imaging Service Models

11.1 Print Service

11.1.1 Print Service Model

Figure 1 is the top level view of the Print Service schema.

Figure 1 High Level Print Service Schema

The MFD System supports zero or more Print Services. A Print Service is hosted locally on an MFD 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 MFD..

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


435

3665

3666

3667

3668

3669

3670

3671

3672367336743675

36763677367836793680368136823683

368436853686

3687368836893690

369136923693

36943695369636973698

3699370037013702

436


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.

11.1.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.

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,


437

3703370437053706370737083709371037113712371337143715

3716

37173718371937203721372237233724372537263727372837293730

3731

3732

3733

3734

3735

3736

373737383739

3740

3741

3742374337443745

438


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

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

11.1.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.

11.1.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

11.1.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.


439

37463747

3748

3749

3750375137523753

3754

3755

3756375737583759

3760

3761376237633764

3765

3766376737683769377037713772

3773

3774377537763777

3778

3779

378037813782378337843785

440


Figure Print ServiceDefaults

For descriptions of the elements that comprise PrintJobDescription, PrintJobProcessing and PrintDocumentProcessing see §7.n PrintJobTicket.

11.1.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 <service>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).

11.1.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 <service>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 <service> ServiceStatus. These elements are described in the MFD Model and Common Semantics specification [PWG5108.01].

11.1.2 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 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.


441

3786

37873788

3789

379037913792

3793

3794

3795

3796379737983799

3800

3801380238033804

3805

3806380738083809

3810

3811381238133814

3815

3816381738183819382038213822382338243825

442


Figure 8 High Level PrintJob View

11.1.2.1 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.

11.1.2.2 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 <service>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 <service>JobProcessing. These elements are described in the MFD Model and ommon Semantics specification [PWG5108.01].

11.1.2.3 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 .

11.1.2.4 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 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].

11.1.2.5 PrintJobDescription

Figure 1s a view of the PrintJob.s PrintJobDescription . These elements are set by the Print Client during job creation.


443

3826

3827

3828

3829383038313832

3833

3834383538363837

3838

3839384038413842

3843

384438453846

3847

38483849385038513852385338543855

3856

3857

38583859

3860

38613862

444


Figure PrintJobDescription

The elements common to all <service>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).

11.1.2.6 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 <service>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

11.1.2.7 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

11.1.3 Conformance


445

3863

3864

3865

3866386738683869

3870

3871387238733874

3875

3876387738783879

3880

3881388238833884

38853886388738883889

3890

3891

3892

446


11.2 Scan Service

11.2.1 ScanService Model Overview

11.2.1.1 ScanServiceDefaults

11.2.1.2 ScanServiceCapabilities

11.2.1.3 ScanServiceCapabilitiesReady

11.2.1.4 ScanServiceConfiguration

11.2.1.5 ScanServiceDescription

11.2.1.6 ScanServiceStatus

11.2.2 ScanJob Model

11.2.2.1 ScanJobReceipt

11.2.2.2 ScanJobStatus

11.2.2.3 ScanJobTicket

11.2.2.4 ScanDocumentProcessing

11.2.2.5 ScanJobDescription

11.2.2.6 ScanJobProcessing

11.2.3 ScanDocument Model

11.2.3.1 ScanDocumentReceipt

11.2.3.2 ScanDocumentStatus

11.2.3.3 ScanDocumentTicket

11.2.3.4 ScanDocumentDescription

11.2.3.5 ScanDocumentProcessing

11.2.4 ScanService Interfaces

11.2.5 Conformance


447

3893

3894

3895

3896

3897

3898

3899

3900

3901

3902

3903

3904

3905

3906

3907

3908

3909

3910

3911

3912

3913

3914

3915

3916

448


11.3 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.

11.3.1 FaxInService Model Overview

Below is the top level view of the FaxInService schema.

Figure 121 - 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.

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


449

3917

391839193920

392139223923

3924392539263927

3928

3929

3930

3931

3932393339343935

393639373938

39393940

450


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 §11.4.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 §11.4.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 §11.4.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 §11.3.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. 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.


451

39413942394339443945

394639473948

3949395039513952

395339543955395639573958

39593960396139623963

3964396539663967

3968396939703971397239733974

397539763977

39783979398039813982

3983

452


11.3.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.

Figure 122 - AvailableFaxInJobTicket

11.3.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.


453

3984

398539863987398839893990

3991

3992

3993

3994

399539963997399839994000

454


Figure 123 - FaxInServiceDefaults

For descriptions of the elements that comprise FaxInJobDescription, FaxInJobProcessing and FaxInDocumentProcessing see § on FaxInJobTicket below.

11.3.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.


455

4001

4002

40034004

4005

40064007400840094010401140124013

401440154016401740184019402040214022

456


Figure 124 - FaxInServiceCapabilities

Table 82 - 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, JobAccountingUserID, JobMandatoryElements, JobMessageFromOperator, JobMessageToOperator, JobMoreInfo, JobName, JobOriginatingUserName,


457

4023

4024

4025

4026

4027

458


JobOriginatingUserUri, JobPassword, JobPasswordEncryption, KOctets, TemplateCreatorUserName, TemplateId, TemplateInfo, TemplateName, TemplateType

FaxInJobProcessingCapabilities JobDelayOutputUntil, JobDelayOutputUntilTime, JobHoldUntil, JobHoldUntilTime, JobMandatoryElements, JobPhoneNumber, JobPriority, JobRecipientName

.

11.3.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.

11.3.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.


459

4028

4029

4030403140324033403440354036403740384039

4040

40414042404340444045

460


Figure 125 - FaxInServiceConfiguration

11.3.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 administratively set. The element values


461

4046

4047

4048

40494050

462


can be directly or indirectly modified through an operation.

Figure 126 - FaxInServiceDescription


463

4051

4052

4053

464


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 83 - FaxInServiceDescription Elements

Element Name DescriptionFaxLogUri 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.

11.3.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.


465

40544055405640574058

40594060

4061

4062

4063406440654066

466


Figure 127 - FaxInServiceStatus

The elements common to all <service>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].

11.3.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.


467

4067

4068

4069407040714072

4073

407440754076

4077

468


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 128 - 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.

11.3.2.1 FaxInJob Lifecycle:

1. Incoming connection arrives on FaxModem, SMTP, or other InputChannel.2. - 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.

3.4. 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.

5. 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).

6. System sends (internal) CreateFaxInJob to FaxInService with selected RequestingUserName and FaxInJobTicket.

7. - FaxInService assigns JobId and creates new FaxInJob in Pending state.- Job creation event is promptly recorded in durable log specified in FaxLogUri.

8. System sends (internal) AddFaxInDocument to FaxInService.- FaxInService creates new FaxInDocument.- System sends image data by streaming or spooling to FaxInService.

9. 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.

10. 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


469

40784079408040814082

4083

4084

40854086408740884089

4090

4091

4092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119

470


DestinationUris.

11. 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).

12. FaxInService “ages” FaxInJob based on implementation-defined method.- FaxInJob is deleted from JobHistory.- FaxInJob remains permanently in the durable log specified in FaxLogUri.

Figure 129 – 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).

Note: Multiple document jobs are inherently not applicable to PSTN FaxIn.

11.3.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.


471

4120

412241234124412541264127412841294130

4131

4132

4133

4134

41354136413741384139

4140

4141

41424143414441454146

472


11.3.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.


473

4147

4148414941504151

474


Figure 130 - FaxInJobStatus


475

4152

4153

476


The elements common to all <service>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].

11.3.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 131 - FaxInJobTicket

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.


477

415441554156

4157

4158415941604161

4162

4163

4164

4165416641674168

478


Figure 132 - FaxInDocumentProcessing

The elements common to all <service>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].

FaxInJobDescription

The FaxInJobDescription group provides the descriptive elements of the FaxInJob, which are set by the FaxIn Client during FaxInJobTicket creation.


479

4169

4170

4171

417241734174

4175

41764177

480


Figure 133 - 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).

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 the element is supported; otherwise the FaxInService processes the job with its best effort.


481

4178

4179

4180

418141824183

4184

4185418641874188

482


Figure 134 - FaxInJobProcessing

The elements common to all <service>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).

11.3.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 FaxInJobReceipt and FaxInDocumentReceipt represent what the FaxInService actually did.


483

4189

4190

4191

419241934194

4195

4196419741984199420042014202

484


Figure 135 – High Level FaxInDocument View

11.3.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 §11.4.3.3 for element names.

11.3.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.


485

4203

4204

4205

4206420742084209

4210

42114212

486


Figure 136 - FaxInDocumentStatus


487

4213

4214

4215

488


The elements common to all <service>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]

11.3.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 137 - FaxInDocumentTicket

FaxInDocumentDescription

Below is a view of the Description elements for the FaxInDocumentTicket. These elements are set by the FaxIn Client during FaxInDocumentTicket creation.

Figure 138 - FaxInDocumentDescription


489

4216421742184219

4220

4221422242234224

4225

4226

4227

4228

42294230

4231

4232

4233

490


The elements common to all <service>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.

FaxInDocumentProcessing

This Group Element has exactly the same structure as the FaxInDocumentProcessing element of FaxInJob (see section 8.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.

11.3.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).

11.3.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 84 - Mandatory User Operations

User Operation Name

Input Parameters Output Parameters

CancelFaxInJob ElementsNaturalLanguage, JobId, Message, RequestingUserName

GetActiveFaxInJobs ElementsNaturalLanguageRequested, Limit, RequestingUserName

ActiveJobs(list of JobSummary), ElementsNaturalLanguage

GetFaxInJobElements ElementsNaturalLanguageRequested, JobId, RequestedElements, RequestingUserName

FaxInJobElements, ElementsNaturalLanguage

GetFaxInJobHistory ElementsNaturalLanguageRequest JobHistory(list of


491

4234423542364237

4238

4239

4240424142424243

4244

424542464247

4248

4249425042514252

42534254

425542564257

425842594260

4261

492


User Operation Name


ed, Limit, RequestingUserName JobSummary), ElementsNaturalLanguage

GetFaxInServiceElements

ElementsNaturalLanguageRequested, RequestedElements, RequestingUserName

ElementsNaturalLanguage, FaxInServiceElements

ValidateFaxInJobTicket ElementsNaturalLanguage, FaxInJobTicket, RequestingUserName

UnsupportedAttributes

Table 85 - 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

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



493

4262

4263

4264

4265

494


Table 86 - Administrative Operations

Administrative Operation Name


CancelFaxInJobs ElementsNaturalLanguage, JobIds, Message, RequestingUserName

JobIds

DisableFaxInService ElementsNaturalLanguage, Message, RequestingUserName

EnableFaxInService ElementsNaturalLanguage, Message, RequestingUserName

HoldNewFaxInJobs ElementsNaturalLanguage, JobHoldUntil | JobHoldUntilTime, 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

11.3.6 Conformance


495

4266

4267

4268

4269

496


11.4 FaxOut

See [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.

11.4.1 FaxOutService Model Overview

Figure 139 is the top level view of the FaxOutService schema.


497

4270

427142724273

427442754276

4277427842794280

4281

4282

4283

498


Figure 139 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 §11.4.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 §11.4.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 §11.4.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


499

4284

4285

4286428742884289

429042914292

429342944295

42964297429842994300

43014302

500


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 §11.4.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 §11.4.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 §11.4.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.

11.4.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.


501

430343044305

43064307430843094310

4311431243134314

43154316431743184319432043214322

432343244325

4326432743284329433043314332

4333

4334433543364337433843394340434143424343

4344

502


Figure 140 FaxOutServiceDefaults

For descriptions of the elements that comprise FaxOutDocumentDescription, FaxOutJobDescription, FaxOutJobProcessing and FaxOutDocumentProcessing see § on FaxOutJobTicket

11.4.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 resolutions, the available job priorities). The names of the elements within the FaxOutServiceCapabilities are the same as those in the FaxOutJobTicket. See § and §11.4.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.


503

4345

4346

43474348

4349

43504351435243534354435543564357

4358435943604361436243634364

504


Figure 141 FaxOutServiceCapabilities

Table 87 FaxOutServiceCapabilities

Group Elements described in [PWG5108.01]

FaxOutDocumentDescriptionCapabilities DocumentDigitalSignature, DocumentMessage, DocumentName, 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,


505

4366

4367

4368

506


DocumentFormatVersionSupported, DocumentMessageSupplied, DocumentNameSupplied

FaxOutJobProcessingCapabilities JobDelayOutputUntil2, JobDelayOutputUntilTime2, JobHoldUntil2, JobHoldUntilTime2, JobMandatoryElements, JobPhoneNumber, JobPriority, JobRecipientName, ConfirmationSheetPrint, CoverSheetInfo, DestinationUris, JobAccountingSheets, JobSaveDisposition, RetryInfo

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.

.

11.4.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 §11.4.3.3 for the names of the FaxOutDocumentDescriptionCapabilities, FaxOutDocumentProcessingCapabilities, FaxOutJobDescriptionCapabilities, and FaxOutJobProcessingCapabilities elements.

11.4.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.


507

436943704371437243734374

4375

437643774378437943804381438243834384

4385

43864387438843894390

4391

4392

508


Figure 142 FaxOutServiceConfiguration

11.4.1.5 FaxOutServiceDescription

Figure 143 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.


509

4393

4394

4395

4396439743984399

510


Figure 143 FaxOutServiceDescription


511

4400

4401

512


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 143 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).

11.4.1.6 FaxOutServiceStatus

Figure 144 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.


513

440244034404440544064407

4408

4409441044114412

514


Figure 144 FaxOutServiceStatus

The elements common to all <service>ServiceStatus 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 FaxOut. These elements are also described in the MFD Model and Common Semantics specification [PWG5108.01].

11.4.2 FaxOutJob Model

Figure 145 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


515

4413

4414

4415

4416441744184419

4420

44214422

516


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 145 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.


517

44234424442544264427

4428

4429

4430

4431443244334434443544364437

518


Figure 146 High Level FaxOutJob View

11.4.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.

11.4.2.2 FaxOutJobStatus

Figure 147 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.


519

4438

4439

4440

44414442444344444445

4446

4447444844494450

520


Figure 147 FaxOutJobStatus

The elements common to all <service>JobStatus are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 147 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].


521

4451

4452

4453445444554456

522


11.4.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 148 FaxOutJobTicket

11.4.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.


523

4457

44584459446044614462

4463

4464

4465

4466

446744684469

524


Figure 149 FaxOutDocumentProcessing

The elements common to all <service>DocumentProcessing are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 149 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].

11.4.2.5 FaxOutJobDescription

Figure 150 is a view of the Description elements for the FaxOutJob. These elements are set by the FaxOut Client during job creation.


525

4470

4471

4472

4473447444754476

4477

44784479

526


Figure 150 FaxOutJobDescription

The elements common to all Job Descriptions are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 150 by being included in the yellow


527

4480

4481

44824483

528


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].

11.4.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 151 FaxOutJobProcessing

The elements common to all <service>JobProcessing are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 151 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].


529

44844485

4486

4487448844894490

4491

4492

4493

44944495449644974498

530


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.

11.4.3 FaxOutDocument Model

Figure 152 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.


531

4499

4500450145024503450445054506

4507

4508

4509

4510

4511

4512

4513

4514

4515

4516

4517451845194520

4521

452245234524452545264527452845294530

4531

532


Figure 152 High Level FaxOutDocument View

11.4.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 §11.4.3.3 for element descriptions.

11.4.3.2 FaxOutDocumentStatus

Figure 153 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.


533

4532

4533

4534

4535

45364537453845394540

4541

45424543

534


.

Figure 153 FaxOutDocumentStatus

The elements common to all <service>DocumentStatus are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 153 by being included in


535

4544

4545

45464547

536


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].

11.4.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 154 FaxOutDocumentTicket

11.4.3.4 FaxOutDocumentDescription

Figure 155 is a view of the Description elements for the FaxOutDocument. These elements are set by the FaxOut Client during Document creation.


537

45484549

4550

4551455245534554

4555

4556

4557

45584559

538


Figure 155 FaxOutDocumentDescription

The elements common to all <service>DocumentDescription are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 155 by being included in the yellow box. The only other element included is the standard extension point.

11.4.3.5 FaxOutDocumentProcessing

This Group Element has exactly the same structure as the FaxOutDocumentProcessing element of FaxOutJob (See 8.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.

11.4.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 88, Table 89 and Table 90. Responses to operations that fail are expected to return a fault.


539

4560

4561

456245634564

4565

456645674568

4569

4570457145724573

45744575

540


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 88, Table 89 and Table 90 the required parameters are in bold and optional parameters are in italic font.

Table 88 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, RequestingUserName

JobId, UnsupportedElements

GetActiveFaxOutJobs ElementsNaturalLanguageRequested, limit, RequestingUserName


GetFaxOutJobElements ElementsNaturalLanguageRequested, JobId, RequestedElements, RequestingUserName

FaxOutJobElements, ElementsNaturalLanguage

GetFaxOutJobHistory ElementsNaturalLanguageRequested, limit, RequestingUserName

JobHistory(list of JobSummary), ElementsNaturalLanguage

GetFaxOutServiceElements ElementsNaturalLanguageRequested, RequestedElements, RequestingUserName

ElementsNaturalLanguage, FaxOutServiceElements

SendFaxOutDocument ElementsNaturalLanguageRequested, FaxOutDocumentTicket, JobId, LastDocument, RequestingUserName, DocumentData


ValidateFaxOutJobTicket ElementsNaturalLanguage, FaxOutJobTicket, RequestingUserName


Table 89 Optional User Operations

User Operation Name


CancelCurrentFaxOutJob ElementsNaturalLanguage, JobId, Message, RequestingUserName

CancelFaxOutDocuments DocumentNumber, ElementsNaturalLanguage, JobId, Message, RequestingUserName

CancelMyFaxOutJobs ElementsNaturalLanguage, JobIds, Message, RequestingUserName

JobIds


541

457645774578

4579

4580

4581

542


User Operation Name


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


ResumeFaxOutJob ElementsNaturalLanguage, JobId, Message, RequestingUserName

SendFaxOutUri DocumentUri, ElementsNaturalLanguageRequested, FaxOutDocumentTicket, 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,


543

4582

544




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, RequestingUserName

ReleaseNewFaxOutJobs ElementsNaturalLanguage, Message, RequestingUserName

RestartFaxOutService ElementsNaturalLanguage, IsAcceptingJobs, Message, RequestingUserName, StartServicePaused

ResumeFaxOutService ElementsNaturalLanguage, Message, RequestingUserName

SetFaxOutServiceElements ElementsNaturalLanguage, FaxOutServiceElements, Message, RequestingUserName

UnsupportedElements

ShutdownFaxOutService ElementsNaturalLanguage, Message, RequestingUserName


545

546


11.4.5 Conformance

11.5 EmailIn

11.5.1 EmailInService Model Overview

11.5.1.1 EmailInServiceDefaults

11.5.1.2 EmailInServiceCapabilities

11.5.1.3 EmailInServiceCapabilitiesReady

11.5.1.4 EmailInServiceConfiguration

11.5.1.5 EmailInServiceDescription

11.5.1.6 EmailInServiceStatus

11.5.2 EmailInJob Model

11.5.2.1 EmailInJobReceipt

11.5.2.2 EmailInJobStatus

11.5.2.3 EmailInJobTicket

11.5.2.4 EmailInDocumentProcessing

11.5.2.5 EmailInJobDescription

11.5.2.6 EmailInJobProcessing

11.5.3 EmailInDocument Model

11.5.3.1 EmailInDocumentReceipt

11.5.3.2 EmailInDocumentStatus

11.5.3.3 EmailInDocumentTicket

11.5.3.4 EmailInDocumentDescription

11.5.3.5 EmailInDocumentProcessing

11.5.4 EmailInService Interfaces

11.5.5 Conformance


547

4583

4584

4585

4586

4587

4588

4589

4590

4591

4592

4593

4594

4595

4596

4597

4598

4599

4600

4601

4602

4603

4604

4605

4606

4607

548


11.6 EmailOut

11.6.1 EmailOutService Model Overview

11.6.1.1 EmailOutServiceDefaults

11.6.1.2 EmailOutServiceCapabilities

11.6.1.3 EmailOutServiceCapabilitiesReady

11.6.1.4 EmailOutServiceConfiguration

11.6.1.5 EmailOutServiceDescription

11.6.1.6 EmailOutServiceStatus

11.6.2 EmailOutJob Model

11.6.2.1 EmailOutJobReceipt

11.6.2.2 EmailOutJobStatus

11.6.2.3 EmailOutJobTicket

11.6.2.4 EmailOutDocumentProcessing

11.6.2.5 EmailOutJobDescription

11.6.2.6 EmailOutJobProcessing

11.6.3 EmailOutDocument Model

11.6.3.1 EmailOutDocumentReceipt

11.6.3.2 EmailOutDocumentStatus

11.6.3.3 EmailOutDocumentTicket

11.6.3.4 EmailOutDocumentDescription

11.6.3.5 EmailOutDocumentProcessing

11.6.4 EmailOutService Interfaces

11.6.5 Conformance


549

4608

4609

4610

4611

4612

4613

4614

4615

4616

4617

4618

4619

4620

4621

4622

4623

4624

4625

4626

4627

4628

4629

4630

4631

550


11.7 Transform 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 139 is the top level view of the TransformService schema.

Figure 156 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.


551

4632

463346344635

463646374638

4639464046414642

46434644

4645

4646

4647464846494650

552


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 §11.4.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 §11.4.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 §11.4.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 §11.4.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 §11.4.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.

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.

11.7.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


553

465146524653

46544655465646574658

46594660466146624663

46644665466646674668

46694670467146724673

467446754676467746784679

4680468146824683

4684468546864687

4688468946904691

4692

469346944695

554


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.

Figure 157 TransformServiceDefaults

For descriptions of the elements that comprise TransformDocumentDescription, TransformJobDescription, TransformJobProcessing and TransformDocumentProcessing see § on TransformJobTicket

11.7.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 §11.4.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.


555

46974698469947004701470247034704

4705

4706

4707

47084709

4710

47114712471347144715471647174718

47194720472147224723472447254726

556


Figure 158 TransformServiceCapabilities

Table 91 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, 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


557

4728

4729

47304731

4732

4733

558


1 Resolution in the TransformJobTicket’s TransformDocumentProcessing is a single instance of Resolution from the sequence of Resolutions element in TransformDocumentProcessingCapabilities.

.

11.7.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 §11.4.3.3 for the names of the TransformDocumentDescriptionCapabilities, TransformDocumentProcessingCapabilities, TransformJobDescriptionCapabilities, and TransformJobProcessingCapabilities Element Group.

11.7.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, Interface, Interpreter, OutputChannel, Processor, Storage and optionally VendorSubunits. There are no standard subunits unique to the TransformService.

Figure 159 TransformServiceConfiguration

11.7.1.5 TransformServiceDescription

Figure 143 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.


559

4734473547364737

4738

473947404741474247434744474547464747

4748

4749475047514752

4753

4754

4755

475647574758

560


Figure 160 TransformServiceDescription

The elements common to all <service>ServiceDescription Elemenet Groups are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 143 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].


561

4759

4760

47614762476347644765

562


11.7.1.6 TransformServiceStatus

Figure 144 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.

Figure 161 TransformServiceStatus


563

4766

47674768476947704771

4772

4773

4774

4775

564


The elements common to all <service>ServiceStatus 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 elements used by the TransformService. These elements are also described in the MFD Model and Common Semantics specification [PWG5108.01].

11.7.2 TransformJob Model

Figure 145 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 162 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.


565

4776477747784779

4780

478147824783

4784

4785

4786

4787478847894790479147924793

566


Figure 163 High Level TransformJob View

11.7.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.

11.7.2.2 TransformJobStatus

Figure 147 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.


567

4794

4795

4796

4797

47984799480048014802

4803

48044805480648074808

568


Figure 164 TransformJobStatus

The elements common to all <service>JobStatus 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].


569

4809

4810

48114812481348144815

570


11.7.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 165 TransformJobTicket

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.


571

4816

48174818481948204821

4822

4823

4824

482548264827

572


Figure 166 TransformDocumentProcessing

The elements common to all <service>DocumentProcessing Element Groups are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 149 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 <service>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., SendTransformDocument, SendTransformUri) that includes the DestinationsUri. The error MUST indicate that the request was malformed.


573

4828

4829

4830

48314832483348344835

483648374838483948404841

574


TransformJobDescription

Figure 150 is a view of the Description Element Group for the TransformJob. These elements are set by the TransformClient during job creation.

Figure 167 TransformJobDescription


575

4842

48434844

4845

4846

576


The elements common to all <service>JobDescription 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 also described in the MFD Model and Common Semantics specification [PWG5108.01].

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 168 TransformJobProcessing

The elements common to all <service>JobProcessing Element Groups are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 151 by being included in the shaded box. The only the TransformService specific element is the standard extension point


577

4847

4848484948504851

4852

4853485448554856

4857

4858

4859

4860

486148624863

578


11.7.3 TransformDocument Model

Figure 152 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 169 High Level TransformDocument View

11.7.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 §11.4.3.3 for element descriptions.

11.7.3.2 TransformDocumentStatus

Figure 153 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.


579

4864

48654866486748684869487048714872

4873

4874

4875

48764877487848794880

4881

488248834884

580


.

Figure 170 TransformDocumentStatus


581

4885

4886

48874888

582


The elements common to all <service>DocumentStatus Element Groups are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 153 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.

11.7.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 171 TransformDocumentTicket

TransformDocumentDescription

Figure 155 is a view of the Description Element Group for the TransformDocument. These elements are set by the TransformClient during Document creation.


583

488948904891489248934894489548964897

4898

4899490049014902

4903

4904

4905

4906

49074908

584


Figure 172 TransformDocumentDescription

The elements common to all <service>DocumentDescription Element Groups are described in the MFD Model and Common Semantics specification [PWG5108.01]. Those elements are identified in Figure 155 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]..

TransformDocumentProcessing

This Element Group has exactly the same structure as the TransformDocumentProcessing element of TransformJob (See Figure 149). 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.

11.7.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.


585

4909

4910

49114912491349144915

4916

491749184919

4920

49214922492349244925

586


The requests parameters are summarized in Table 88, Table 89 and Table 90. 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 88, Table 89 and Table 90 the required parameters are in bold and optional parameters are in italic font.

Table 92 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


GetTransformJobElements ElementsNaturalLanguageRequested, JobId, RequestedElements, RequestingUserName, RequestingUserUri

TransformJobElements, ElementsNaturalLanguage

GetTransformJobHistory ElementsNaturalLanguageRequested, limit, RequestingUserName, RequestingUserUri

JobHistory(list of JobSummary), ElementsNaturalLanguage

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,



587

49264927

492849294930

4931

588


User Operation Name


TransformJobTicket, RequestingUserName, RequestingUserUri

Table 93 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, RequestingUserUri


ResumeTransformJob ElementsNaturalLanguage, JobId, Message, RequestingUserName, RequestingUserUri

SendTransformUri DocumentPassword, DocumentUri, ElementsNaturalLanguageRequested, TransformDocumentTicket, JobId, LastDocument, RequestingUserName, RequestingUserUri


SetTransformDocumentElements DocumentNumber, ElementsNaturalLanguage, JobId, OperationMode, Message,

UnsupportedElements


589

4932

4933

590


User Operation Name


RequestingUserName, RequestingUserUri, TransformDocumentTicket

SetTransformJobElements ElementsNaturalLanguage, JobId, OperationMode, Message, RequestingUserName, RequestingUserUri, TransformJobTicket

UnsupportedElements

SuspendCurrentTransformJob ElementsNaturalLanguage, JobId, Message, RequestingUserName, RequestingUserUri

ValidateTransformDocumentTicket DocumentPassword, ElementsNaturalLanguage, TransformDocumentTicket, RequestingUserName, RequestingUserUri

UnsupportedElements




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,


591

4934

592




Message, RequestingUserName, RequestingUserUri

ReleaseNewTransformJobs ElementsNaturalLanguage, Message, RequestingUserName, RequestingUserUri

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

11.7.5 Conformance

11.8 ResourceThe diagram below depicts the top level architecture of Resource Service. A Resource Service may reside locally within a MFD system or on a remote system. It provides resource storage and retrieval interfaces to a resource client object which may also reside locally within a MFD 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. 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 only configurable by an authorized administrator, and may be local or remote to the Resource Service.


593

4935

4936

4937

4938

4939494049414942494349444945494649474948

594


Figure 173 Resource Service Top Level Architecture

The lifecycle of a Resource begins when the Resource is created and ends when the Resource is deleted.

An MFD resource is created by an MFD Resource Client, then stored by a Resource Service at a resource storage location. The MFD Resource Client, Resource Service, or the resource storage location is local or remote to the MFD System.

At any time a resource may encounter the following events while stored in at resource storage location:

1. 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,

2. update/replacement by a Resource Service at the request of a Resource Client on behalf of the creator of the resource,

3. expiration that signals the end of life for the resource, and the resource will then be deleted by the Resource Services.


595

494949504951

4952

495349544955

49564957

495849594960496149624963

596


11.8.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.

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.


597

4964

49654966

49674968

49694970

49714972497349744975497649774978

49794980

498149824983

498449854986

498749884989499049914992

49934994

4995

598


Figure 174 High Level Resource Service Schema

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.

11.8.2 Resource Service Model Description

11.8.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].

11.8.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.


599

4996

4997

499849995000

5001500250035004

50055006

5007

5008

500950105011

5012

501350145015

5016

5017

600


Figure 175 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.

Storage(complex-Storage) Each storage subunit contains a StorageStatus element and a StorageDescription element.Below is the XML Schema diagram of the Storage subunit.


601

5018

5019

502050215022

502350245025

5026

5027502850295030

602


Figure 176 Storage Subunit Schema

A Storage contains the elements described in the following sections.

1.1.1.1 Storage Status

(complex-StorageStatus) This REQUIRED group element contains the current status of the storage subunit.

1.1.1.1.1 StorageId

(int) This REQUIRED element is the unique identifier of the storage subunit within the Resource Service instance.1.1.1.1.2 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),


603

5031

5032

5033

5034

50355036

5037

50385039

5040

504150425043504450455046

604


ramDisk - Random access memory used as hard disk for secondary storage,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).

1.1.1.1.3 StorageSize

(int) This element indicates the total bytes allocated to the service, i.e. the service-specific view of storage size.1.1.1.1.4 StorageFree

(int) This element indicates the total bytes currently free for use to the service.

1.1.1.1.5 StorageIsRemovable

(Boolean) This element indicates whether the Storage subunit is removable by the design of its manufacturer.1.1.1.1.6 List of ##Other

This serves as the list of vendor’s extension points for the attributes of StorageStatus.

1.1.1.2 Storage Description

(complex-StorageDescription) The group element provides descriptive information on the specific storage subunit used by the Resource Service.

1.1.1.2.1 StorageName

(string) This is the name of the storage subunit that is unique within a Resource Service instance.

1.1.1.2.2 StorageMake

(string) This element contains information on the manufacturer of the storage subunit.

1.1.1.2.3 StorageModel

(string) This element describes the model name of the storage subunit.1.1.1.2.4 StorageInfo

(string) This element contains administrator settable additional description text about the storage subunit

1.1.1.2.5 StorageDataEncryption

(boolean) This element indicates the support of data encryption by the storage subunit 1.1.1.2.6 List of ##Other

This element provides a list of vendor’s extension points for StorageDescription while maintaining interoperability.


605

504750485049505050515052505350545055505650575058

5059

50605061

5062

5063

5064

50655066

5067

5068

5069

50705071

5072

5073

5074

5075

5076

5077

5078

5079

5080

5081

5082

50835084

606


1.1.1.2.7 StorageURI

(URI) This element is only applicable to a NetworkStorage device . It provides the network location information of the storage subunit.

11.8.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 177 Resource Service Description Schema

OwnerURI

(URI) This is the URI by which you can reach the administrator or owner who created the service.

OwnerVCard

(string) This is the vCard [RFC2426] of the owner of the Resource Service.

ResourcesSupported


607

5085

508650875088

5089

50905091509250935094

509550965097

5098

5099

5100

5101

5102

5103

5104

5105

608


(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.

ServiceInfo

(string) This is descriptive information about this Resource Service the owner of the service wishes to provide.

ServiceLocation

(string) This element describes the physical location of this Service. (Example: “Building 128 Floor 2 Room 210C")

ServiceName

(string) This is the end-user friendly name of the Resource Service.

ServiceURISupported

(list of URI) This REQUIRED element contains the URIs where the Resource Service is available.

Sequence of ##other

(list of any) This optional element contains extension points for vendor differentiation and implementation specific extensions while maintaining interoperability.

Attribute of ##other

(any) This is a REQUIRED vendor’s extension point for adding one single extra attribute to Resource description properties.

11.8.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.


609

5106510751085109

5110

51115112

5113

51145115

5116

5117

5118

5119

5120

51215122

5123

51245125

5126

512751285129

5130

610


Figure 178 Resource Service Capability Schema

1.1.2 List of ##other

(list of any) This optional list contains extension points for vendor differentiation and implementation specific extensions while maintaining interoperability.

1.1.3 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.

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


611

5131

5132

5133

5134

513551365137

5138

51395140

5141

51425143

5144

514551465147

5148

514951505151

5152

612


(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.

11.8.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.


613

51535154

5155

5156

5157

5158

5159

5160

5161

516251635164

5165

5166

5167

5168

51695170

517151725173

5174

614


Figure 179 Resource Service Status Schema

AccessModes

(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]


615

5175

5176

5177

5178517951805181

5182

5183518451855186

5187

616


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

(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.


617

5188

5189

5190

51915192

5193

51945195

5196

5197

5198519952005201

5202

52035204

5205

52065207

5208

520952105211

5212

5213

5214

52155216

5217

5218

5219

5220

618


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.

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)


619

5221

5222

5223

5224

5225

5226

5227

5228

5229

5230

5231

52325233

5234

5235

5236

5237

5238

5239

5240

5241

5242

5243

5244

5245

5246

5247

5248

620


- 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)

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

Service State Transition By Operations

SERVICE STATE MACHINE (Operations)

InputState

Down Testing Idle ProcessingOperatio

n(Conditio

n)

Action(new state)

Action(new state)

Action(new state)

Action(new state)

Disable error

disable(~C.IsAcceptingResources)



Enableerror

enable(C.IsAcceptingResources)



Restart restart restart restart restart


621

5249

5250

5251

5252

5253

5254

5255

5256

5257

5258

5259

5260

526152625263

5264

526552665267

5268

52695270

622


(Note 1) (Idle) (Idle) (Idle) (Idle)Shutdown(Note 2) error

shutdown(Down)

shutdown(Down)

shutdown(Down)

Startup (Note 1)

restart (Idle) error error error

test(Note 3)

test(Testing)

test(Testing) error error

1.1.3.1.1 Service State Transition By Events

SERVICE STATE MACHINE (Events)

Input

State

Down Testing IdleProcess

ing

Event(Condition)

Action(new state)

Action(new state)

Action(new state)

Action(new state)

E.critical C.critical C.critical C.critical C.criticalE.criticalCleared ~C.critic

al~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.Warning

~C.Warning

~C.Warning

~C.Warning

E.startRequest(~C.isAcceptingResources) error

error(Testing) error error

E.startRequest error

schedule(Testing)

schedule(Processing)

schedule

E.startup(Note 1)

restart(Idle) error error error

E.testing(Note 3)

(Testing)

(Testing) error error


623

5271

5272

5273

624


E.testingCleared error (Down) error error

1.1.3.1.2 Detailed Service State Transition Diagram

Figure 180 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


625

5274

5275

5276

5277

5278

527952805281

5282

626


(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

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.

Figure 181 Condition Table

Active Conditions


627

528352845285528652875288528952905291529252935294

5295

52965297

5298

5299530053015302

5303

5304

5305

628


(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.

Figure 182 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.


629

53065307530853095310

5311

5312

5313

5314

53155316

5317

53185319

5320

532153225323532453255326

630


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.

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.


631

5327532853295330

5331

5332

5333

53345335

5336

53375338

5339

5340

5341

5342

5343

5344

5345534653475348

5349

632


Figure 183 Condition History

ClearTime

(dateTime) This element is the date and time the condition was removed from the ActiveConditions list.

11.8.2.6 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.


633

5350

5351

5352

5353

5354

535553565357535853595360

634


Figure 184 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.


635

5361

5362

5363

53645365

5366

5367

5368

53695370

5371

636


Figure 185 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:

Firmware,

Software.


637

5372

5373

5374

53755376

5377

537853795380

5381

53825383

5384

538553865387

5388

5389

5390

5391

5392

638


(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.

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;


639

5393

5394

5395

5396

5397

5398

5399

5400

5401

5402

5403

5404

5405

5406

5407

5408

5409

5410

5411

5412541354145415

5416

541754185419

5420

542154225423

640


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.

Figure 186 Resource Status Schema

DateTimeAtCreation


641

54245425

5426

5427

5428

54295430

5431

54325433

5434

543554365437

54385439

54405441

5442

5443

5444

5445

642


(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:

(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.


643

54465447

5448

54495450

5451

54525453

5454

5455

5456

54575458

5459

5460

5461

5462

5463

546454655466

5467

546854695470

5471

5472

5473

54745475

5476

644


11.9 System Control Service

11.9.1 Imaging Device Model

There 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])

Figure 187and §11.9.2 define the System Object schema which represents the Imaging Device.

Figure 187 System Object

11.9.2 System Object

The System Object elements SystemConfiguration, SystemDescription and SystemStatus are defined in §11.9.2.1, §11.9.2.2 and §11.9.2.3 respectively. The Services element contains all the hosted services. See §11.9.3 below for the description of the SystemControlService.


645

5477

5478

547954805481548254835484

54855486548754885489549054915492

549354945495

5496

5497

5498

5499

5500550155025503

646


11.9.2.1 SystemConfiguration

The System Object has a SystemConfiguration element that contains all the Subunits configured onSubunit the Imaging Device. (See Figure 188) 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. The MFD Model and Common Semanticsspecification [PWG5108.01] defines all the Subunits.

Figure 188 SystemConfiguration

11.9.2.2 SystemDescription

Figure 189 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 specific information. The MFD Model and Common Semantics specification [PWG5108.01] defines most of the elements that are used in the SystemDescription element. Table 95 lists the SystemControlService specific SystemDescription elements.


647

5504

55055506550755085509

5510

5511

5512

5513

55145515551655175518551955205521

648


Figure 189 SystemDescription

Table 95 SystemDescription Elements

Element Name Multivalued

Syntax Constraint

Group

Reference

Description (values)

SERVICESSUPPORTEDYes List of

KeywordsDescription

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

SERVICETYPENo Keyword Type 3 Description


649

5522

5523

5524

5525

650



Syntax Constraint

Group

Reference

Description (values) 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)

11.9.2.3 SystemStatus

Figure 190 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 96 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. The MFD Model and Common Semantics specification [PWG5108.01] defines most of the the elements that are used in the SystemStatus element. Table 97 lists the new SystemControlService specific SystemStatus elements.

Table 96 Optimistic Status Roll-up

System Status ConditionUnknown 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

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.


651

5526

5527

5528552955305531553255335534553555365537553855395540

5541

5542

652


Figure 190 SystemStatus


653

5543

5544

654


Table 97 SystemStatus Elements


Syntax Constraint

Group

Reference

Description (values)

CONFIGUREDRESOURCES

Yes List of ResourceSummary

Status

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

RESOURCESUMMARYNo Complex Status [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)

SYSTEMTOTALSNo Complex Status [PWG5106.1] §6.1


655

5545

656



Syntax Constraint

Group

Reference

Description (values) The SystemTotals counters aggregates counters from all the services offered by the System.

11.9.3 SystemControlService

11.9.3.1 SystemControlService Model

The Imaging Device supports exactly one SystemControlService (See Figure 191). 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 §11.9.2.1. 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 §11.9.3.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 §11.9.3.3.

Figure 191 SystemControlService

11.9.3.2 SystemControlServiceDescription

Figure 192 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.


657

5546

5547

5548

5549555055515552555355545555555655575558555955605561556255635564

5565

5566

5567

556855695570557155725573

658


The MFD Model and Common Semantics specification [PWG5108.01] defines the SystemControlServiceDescription elements.

Figure 192 SystemControlServiceDescription

The elements common to all <service>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 <service> ServiceDescription. These elements are defined in the MFD Model and Common Semantics specification [PWG5108.01].


659

557455755576

5577

5578

55795580558155825583

660


11.9.3.3 SystemControlServiceStatus

Figure 193 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.

Figure 193 SystemControlServiceStatus


661

5584

558555865587558855895590

5591

5592

662


The elements common to all <service>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).

11.9.3.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 99Table 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 summary,

PauseAllServices 2 ElementsNaturalLanguage, Message, RequestingUserName

RestartAllServices 1, 5, 6, 7 ElementsNaturalLanguage, IsAcceptingJobs | IsAcceptingResources, Message, RequestingUserName, StartServicePaused

RestartService 3, 4, 5, 6, 7 ElementsNaturalLanguage, Id, IsAcceptingJobs | IsAcceptingResources, Message, RequestingUserName, ServiceType, StartServicePaused

ResumeAllServices 2 ElementsNaturalLanguage, Message, RequestingUserName

ShutdownAllServices 1 ElementsNaturalLanguage, Message, RequestingUserName

ShutdownService1, 8 ElementsNaturalLanguage, Id, Message,


663

55935594559555965597

5598

5599560056015602560356045605560656075608560956105611

5612

5613

664


User Operation Name


RequestingUserName ServiceTypeStartupAllServices 1, 5, 6, 7 ElementsNaturalLanguage, IsAcceptingJobs,

Message, RequestingUserName, StartSystemPaused

StartupService 1, 5, 6, 7 ElementsNaturalLanguage, IsAcceptingJobs, Message, RequestingUserName ServiceType, StartServicePaused

Id

Notes for Table 99 follow Table 99Table 99 Optional System Operations



DeleteService 1, 8 Id, ElementsNaturalLanguage, Message, RequestingUserName, ServiceType

PauseAllServicesAfterCurrentJob 2 ElementsNaturalLanguage, Message, RequestingUserName

SetSystemElements ElementsNaturalLanguage, Message, OperationMode, RequestingUserName SystemElements

UnsupportedElements


665

5614

5615

5616

666


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

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.

DisableAllServices

The DisableAllServices operation is consistent with the operation Disable<service>Service 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.

EnableAllServices

The EnableAllServices operation is consistent with the operation Enable<service>Service 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.

GetSystemElements

Unlike the Get<service>ServiceElements [PWG5108.01] operation that allows access to only the elements of the specified <service>, 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.


667

56175618561956205621562256235624562556265627562856295630563156325633563456355636

5637

563856395640

5641

56425643564456455646

5647

56485649565056515652

5653

565456555656

565756585659

668


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 the simplified figure below (Figure 194). 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 194 Association Types

Table 100 SystemConfiguration sub-element associations

Element Name Association TypeFinisherSupply Contained

FinisherSupplyMediaInput ContainedInputChannelInterface Referenced


669

56605661

5662566356645665566656675668

5669567056715672567356745675

5676

5677

5678

5679

670


Element Name Association TypeInputChannelDefaultJobControlLanguage Referenced

InputChannelDefaultPageDescriptionLanguage ReferencedMarkerColorant ContainedMarkerSupply Contained

OutputChannelInterface ReferencedOutputChannelDefaultJobControlLanguage Referenced

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.

PauseAllServices

The PauseAllServices operation is consistent with the operation Pause<service>Service 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 <service>ServiceStateReasons MUST contain the reason ‘MovingToPaused’. This operation does not affect the SystemControlService.

PauseAllServicesAfterCurrentJob

The PauseAllServicesAfterCurrentJob operation is consistent with the operation Pause<service>ServiceAfterCurrentJob 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 <service>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.

RestartAllServices

The RestartAllServices operation is consistent with the operation Restart<service>Service 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.


671

5680

5681

5682568356845685

5686

568756885689569056915692

5693

5694569556965697569856995700

5701

57025703570457055706570757085709

571057115712571357145715

672


RestartService

The RestartService operation is consistent with operation Restart<service>Service 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 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.

ResumeAllServices

The ResumeAllServices operation is consistent with the operation Resume<service>Service 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.

ShutdownAllServices

The ShutdownAllServices operation is consistent with the operation Shutdown<service>Service 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.

ShutdownService

The ShutdownService operation is consistent with the operation Shutdown<service>Service 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.

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, except the SystemControlService. This operation does not affect the SystemControlService itself.


673

5716

57175718571957205721572257235724

5725572657275728

572957305731573257335734

5735

573657375738573957405741

5742

57435744574557465747

5748

5749575057515752

5753

57545755575657575758

674


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.

SetSystemElements

Unlike the Set<service>ServiceElements [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 § 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 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 IntegerInputChannelDefaultJob

ControlLanguageInputChannel Referenced InputChannelDefaultJob

ControlLanguageIdInteger

InputChannelDefaultPage DescriptionLanguage

InputChannel Referenced InputChannelDefaultPageDescriptionLanguageId

Integer


675

5759

57605761576257635764

5765

576657675768

576957705771

5772577357745775

577657775778

577957805781578257835784578557865787578857895790

5791

5792

676


Element Name Parent Element Name

Association Type

Name in SetSystemElements

Syntax in SetSystemElements

MarkerColorant Marker Contained MarkerColorant MarkerColorantSet Type

MarkerSupply Marker Contained MarkerSupply MarkerSupplySet Type

OutputChannelInterface OutputChannel Referenced OutputChannelInterfaceId IntegerOutputChannelDefaultJob

ControlLanguageOutputChannel Referenced OutputChannelDefaultJob

ControlLanguageIdInteger

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


677

5793

579457955796579757985799580058015802580358045805

678


12. 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.

Imaging Service Model and MFD System Model specifications MUST import the definitions of Elements, terms and semantics from this specification.

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.

.

13. 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].

14. 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, 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.

.

15. IANA ConsiderationsProvide IANA registration information for this specification.


679

5806

58075808580958105811581258135814

5815

5816

5817581858195820

58215822582358245825

582658275828

58295830

5831

583258335834583558365837

58385839

5840

5841

5842

680


Subsections include IANA registration templates using the Example style:

Some IANA registration text.

16. 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.

17. References

17.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

[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]


681

5843

5844

5845

5846584758485849

5850

5851

5852

5853

5854

5855

58565857

5858

5859

5860

58615862

5863

58645865

5866

58675868

5869

5870

5871

682

http://www.iana.org/assignments/ianaprinter-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/standards/cim

http://dcmi.kc.tsukuba.ac.jp/dcregistry/


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

[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]


683

58725873

5874

587558765877

5878

587958805881

5882

588358845885

5886

588758885889

5890

589158925893

5894

589558965897

5898

589959005901

5902

590359045905

5906

684

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

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

ftp://ftp.pwg.org/pub/pwg/informational/req-mfdreq10-20100901.pdf

http://www.iana.org/assignments/ipp-registrations/ipp-registrations.xml


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

[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

[PWG5108.2]


685

590759085909

5910

591159125913

5914

591559165917

5918

59195920

5921

592259235924

5925

592659275928

5929

593059315932

5933

593459355936

5937

59385939

5940

5941

5942

686

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-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-sm10-20040120-5105.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-ippjobprinterext10-20101030-5100.11.pdf

ftp://ftp.pwg.org/pub/pwg/candidates/cs-ippjobprinterext10-20101030-5100.11.pdf

ftp://ftp.pwg.org/pub/pwg/candidates/cs-ipp20-20090731-5100.10.pdf

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


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]

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


687

594359445945

5946

59475948

5949

59505951

5952

59535954

5955

59565957

5958

595959605961

5962

59635964

5965

59665967

5968

59695970

5971

59725973

5974

59755976

688

http://www.ietf.org/rfc/rfc3192.txt


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



http://www.ietf.org/RFC/RFC2617.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


[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]

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/


689

5977

59785979

5980

59815982

5983

59845985

5986

59875988

5989

59905991

5992

59935994

5995

59965997

5998

59996000

6001

60026003

6004

60056006

6007

60086009

690

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

17.2 Informative References[REFERENCE] F. Last author list or standards body, "Title of referenced document", Document

Number, Month YYYY, URL (if any)

18. Authors' AddressesWilliam A WagnerTechnical Interface ConsultingEmail: [email protected] Voice: (978)251-4565

Peter ZehlerXerox Research Center WebsterEmail: [email protected] Voice: (585) 265-8755Fax: (585) 265-7441US Mail: Peter ZehlerXerox Corp.800 Phillips Rd.M/S 128-25EWebster 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

19. Change Log

19.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.


691

6010

60116012

6013

60146015

6016

60176018

6019

6020602160226023602460256026602760286029603060316032603360346035

6036

6037603860396040

6041

6042

60436044

692



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

http://www.w3.org/TR/xmlschema-2/


19.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.

19.3 June 3, 2013 Updated the Abstract, and the section on “About the Semantic Model Working Group” – Daniel Manchala.

19.4 June 15, 2013Assembled sections from Requirements and individual service specifications


693

6045

60466047

6048

6049

6050

6051

6052

694


20. 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

Element Name Multivalued Syntax Constraint Group ReferenceDescription (values)

AutoExposure No Boolean N/A 1 [PWG5108.02] § 8.1.3.1.11.1When 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.3Indicates if detection and correction of small skew orientation error from the media loadingfrom 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.2Specifies 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.4This 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)


695

6053

60546055605660576058

6059

6060606160626063606460656066

6067

60686069607060716072

6073

696


Fix the references for newer or final versions.



Compression No Keyword Type2 2,4 [RFC2911] §3.2.1.1Client 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.1Default 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 ofacceptable 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.4This 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.3Specifies 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.5The number of copies of the associated Document(s) to be Printed. (See also JobCopies)

CoverBack No complex Type2 1 [PWG5100.3] §3.1The back cover to apply this Document. (Contains Media/MediaType or MediaCol, CoverType) (See also Job CoverBack)

CoverFront No complex Type2 1 [PWG5100.3] §3.1The 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.2Indicates 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)


697

698



Destination No complex Type2 1 [PWG5108.02] § 8.1.3.1.8Indicates 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.2This 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.1This 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.2Default 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.3Specifies 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.3The 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.1Document 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.13Type 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


699

700



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.16Level or version of the DocumentFormat. (Included in DocumentFormatDetailsSupplied)

DocumentFormatVersionSupplied No String Type2 2 [PWG5100.7] §5.2.6Level or version of the DocumentFormat.

DocumentMessage No String Maxlength=1023 4 [PWG5100.5] §9.1.20Message 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.7message 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.21Name for the Document to be used in an implementation specific manner.

DocumentNameSupplied No String Maxlength=255 2 [PWG5100.7] §5.2.8Default 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.1Primary 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.2Specifies the documents in a Job for override processing. (Included in Overrides)

DocumentPassword No Base64Binary 1:1366 1 [JPS3] §5.1.2Specifies the unencrypted passphrase to be used to access the document content. (DocumentPassword length maximum is 1024 octets before encoding)


701

702



DocumentSourceApplicationName No String Type2 2,4 [PWG5100.5] §9.1.13Name of the application that created the document, without its version number. (Included in DocumentFormatDetailsSupplied)

DocumentSourceApplicationVersion No String Type2 2,4 [PWG5100.5] §9.1.13Version of the application that created the document, without its name. (Included in DocumentFormatDetailsSupplied)

DocumentSourceOsName No Keyword Type3 2,4 [PWG5100.5] §9.1.13Name 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.13version 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.28Reference to the document to Print. (See also [rfc2911] § 3.3.2)

DocumentMessage No String Maxlength=1023 4 [PWG5100.5] §9.1.20A 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.1Name 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.20Identifies 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.11Specifies 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)


703

704



FeedOrientation No Keyword Type3 1 [PWG5100.11] §7.1Specifies 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

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.2Enables 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.1A string specifying some particular finishing operation. (Included in FinishingsCol, JobFinishingsCol)

FirstIndex No Integer 0:MAX 6 [PWG5108.02] § 8.1.3.1.12Specifies the first object or element, starting at 0, to be returned in a response.

FontNameRequested No String Maxlength=255 1 [PWG5100.11] §7.2Specifies 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.3Specifies 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.3Forces 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.1Element identifies the height of the image box in RegionUnits. (Contained in ImageBox)

IdentifyActions Yes List of keywords Type 3 6 [JPS3] § 5.1.4Specifies 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


705

706


Element Name Multivalued Syntax Constraint Group ReferenceDescription (values) 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.4Specifies 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.1Describes 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.13Specifies the number of Images to scan from the Hardcopy Document.

ImpositionTemplate No Keyword Type2 1 [PWG5100.3] §3.4Specifies 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.2Total size in number of impressions in all the Job‟s Document(s).

InputSource No Keyword Type2 1 [PWG5108.02] § 8.1.3.1.14Specifies 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

Specifies the number of Insert Sheet to insert. (Included in InsertSheet)

InsertSheet Yes complex N/A 1 [PWG5100.3] §3.5Specifies 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.6The 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


707

708


Element Name Multivalued Syntax Constraint Group ReferenceDescription (values) 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.8Specifies the accounting sheet for a job. (Contains JobAccountingSheetsType, Media/ MediaType or MediaCol, JobAccountingOutputBin).

JobAccountingSheetsType No Keyword Type3 3 [PWG5100.3] §3.8.1Specifies 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.7Specifies 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.1The number of copies of the Job to be Printed. (See also Copies)

JobCoverBack No complex N/A 3 [PWG5100.7] §4.1.2The 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.3The 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.4Specifies 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.5Specifies 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.9Specifies 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)


709

710



JobErrorSheetWhen No Keyword Type2 3 [PWG5100.3] §3.9.2Indicateds conditions required to produce JobErrorSheet. Values: JobErrorSheetWhenWKV, KeywordNsExtensionPattern (e.g., OnError, Always) (Included in JobErrorSheet)

JobFinishings Yes Keyword Type2 3 [PWG5100.7] §4.1.4Identifies 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.5Enables 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.2Specifies 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.6Specifies 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.12This 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

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


711

712


Element Name Multivalued Syntax Constraint Group ReferenceDescription (values) 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.5User friendly name of the Job. It does not have to be unique.

JobOriginatingUserName No String Maxlength=255 2 [rfc2911] §4.3.5Name 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.6URI 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.1Password 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.2Encryption 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.1Priority for scheduling the Job. A higher value specifies a higher priority.

JobRecipientName No String Maxlength=255 3 [PWG5100.11]§ 5.6Name of the intended recipient of the Job.

JobSaveDisposition No Complex N/A 3 [PWG5100.11] §7.9Specifies 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.12Conveys a message that is delivered with the job.

JobSheets No Keyword type3 3 [rfc2911] §4.2.3Specifies 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


713

714


Element Name Multivalued Syntax Constraint Group ReferenceDescription (values) 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.1Specifies 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.1Total size of this Job‟s Digital Document(s) in integral units of 1024 octets.

LastDocument No Boolean N/A 4 [PWG5100.5] §9.1.35Indicates whether or not this Document is the last Document in the Job.

Margin No complex N/A 1,3 [JPS3] §7.4

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


715

716


Element Name Multivalued Syntax Constraint Group ReferenceDescription (values) 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

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.13Enables 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.10Indicates 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)

MediaColor No Keyword Type3 1 [PWG5100.3] §3.13.4Indicates 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


717

718


Element Name Multivalued Syntax Constraint Group ReferenceDescription (values) 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.2Indicates 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.6Indicates the number of pre-drilled holes in the desired media. (Included in MediaCol)

MediaInfo No String Maxlength=255 1,3 [PWG5100.3] §3.13.3Specifies information that helps describe the media instance. Intended for human consumption. (Included in MediaCol)

MediaInputTrayCheck No Keyword Type3 1 [PWG5100.3] §3.14Indicates 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.1The 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.7Indicates 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.5Indicates 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.11Indicates 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.2Total size in number of impressions in all the Job‟s Document(s).

MediaSize No Complex N/A 1,3 [PWG5100.3] §3.13.8


719

720


Element Name Multivalued Syntax Constraint Group ReferenceDescription (values) 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.5Specifies 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.3The 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.9Indicates 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.4Controls 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


721

722


Element Name Multivalued Syntax Constraint Group ReferenceDescription (values) 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.9Indicates the number of Input pages that the PrintService is to image on one impression.

OrientationRequested No Keyword type2 1 [rfc2911] §4.2.10The 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.1Provides 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.4Document Ticket processing elements to apply to the Document pages specified in the Override (Contained in Overrides)

PageDelivery No Keyword Type2 1 [PWG5100.3] §3.15Indicates 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.16The 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.7Specifies a range of pages in the document data to be output.

Pages Yes RangeOfInteger 1:MAX 3 [pwg5100.6] §4.1.1Specifies a range of pages in the document PDL data. (Included in Overrides)

PagesPerSubset Yes Complex Ordered list of Integer 3 [JPS3] §5.2.1


723

724


Element Name Multivalued Syntax Constraint Group ReferenceDescription (values) 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.10Controls initialization of the PrintService’s Page Description Language (PDL) interpreter. (Contains PdlInitFileEntry, PdlInitFileLocation. PdlInitFileName)

PdlInitFileEntry No String Maxlength=255 1 [PWG5100.11] §7.10Specifies 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.10Contains 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.10Specifies 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.28Expresses 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.17Specifies 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.2Specifies 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.3Specifies how out-of-gamut colors (or shades of gray) are mapped to device colors when Printing. Values: PrintRenderingIntentWKV, KeywordNsExtensionPattern (e.g., Absolute, Perceptual, Relative)


725

726



Proof Print No Complex N/A 3 [PWG5100.11] §7.11Specifies 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).

PwgRasterDocumentBackside

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)

PwgRasterDocumentResolutionSupported

Yes List of Resolution N/A 5 [RST] §10.2

Lists the supported page bitmap resolutions in dots per inch

PwgRasterDocumentTypeSupported

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.13The 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.2Element 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.17Specifies 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)


727

728



SaveDocumentFormat No String MimeMediaType 3 [PWG5100.11] §7.9.1.2.3.3 [rfc2046], [rfc2048]

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.2Contains 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.2Specifies 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.18Specifies the separator sheets to be Printed with the Document. (Contains SeparatorSheetsType, Media/MediaType or MediaCol)

SeparatorSheetsType No Keyword Type3 1 [PWG5100.3] §3.18.1Specifies 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.1Specifies 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)

Sides No Keyword type2 1 [rfc2911] §4.2.8Indicates 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.2Provides detailed stitching parameters. (Included in FinishingsCol, JobFinishingsCol) (Contains StitchingReferenceEdge, StitchingOffset, StitchingLocations)

StitchingLocations Yes Integer 0:MAX D [PWG5100.3] §3.2.2.3


729

730


Element Name Multivalued Syntax Constraint Group ReferenceDescription (values) 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.2The 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.12Used 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.13Used 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.14Used only when Ticket is created from a template. Information about the template used to create the Job Ticket.

TemplateName No String Unlimited 2 [PWG5108.2] §8.1.3.2.15Used 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.16Used 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.3Element identifies the width of the image box in RegionUnits. (Contained in ImageBox)

XDimension No Integer 0:MAX 1,3 [PWG5100.3] §3.13.8.1Size 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


731

732


Element Name Multivalued Syntax Constraint Group ReferenceDescription (values) 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.3Causes 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.4Element identifies the offset, positive or negative, on the X axis from the origin of the MediaBox in RegionUnits. (Contained in ImageBox)

Xside1ImageShift No Integer MIN:MAX 1 [PWG5100.3] §3.19.4Causes 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.5Causes 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.2Size of the media in hundredths of a millimeter along the left edge. (Included in MediaSize)

YImagePosition No Keyword type2 1 [PWG5100.3] §3.19.6Causes 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.7Causes 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.5Element 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.8Causes 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


733

734


Element Name Multivalued Syntax Constraint Group ReferenceDescription (values) 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.

21. Appendix B: Service Capabilities<service>ServiceCapabilities are closely related to the <service>JobTicket. The <service>ServiceCapabilities have the same structure and element names as the corresponding <service>JobTicket elements. The <service>ServiceCapabilities elements differ in syntax. The purpose of <service>ServiceCapabilities is to provide information on what <service>JobTicket elements are supported and what values those elements can have.

For example if a <service>JobTicket element can contain a keyword (e.g. DocumentFormat), then the presence of the corresponding <service>ServiceCapabilities element indicate that the <service>JobTicket element is supported. The <service>ServiceCapabilities element’s syntax is a list of keywords that supplies the allowed values for the <service>JobTicket element.

In a similar fashion a <service>JobTicket element that has a datatype of integer has a <service>ServiceCapabilities element with syntax of a range of integers specifying the range of allowed values for the <service>JobTicket element.

Some <service>JobTicket elements only require the <service>ServiceCapabilities to specify that the element is supported. For these instances the <service>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 <service>ServiceCapabilities syntax and specifies which <service>ServiceCapabilities element uses the syntax.

Table 103 <service>ServiceCapabilities Syntax

Capabilities Syntax

Semantics Capabilities Element

Boolean Specifies the JobTicket element is supported

DocumentDigitalSignatureSupplied , DocumentSourceApplicationName , DocumentSourceApplicationVersion , DocumentSourceOsVersion , DocumentFormatDeviceId , DocumentFormatVersion , DocumentMessageSupplied , DocumentNameSupplied , FinishingTemplate, Impressions , JobAccountingID , JobAccountingUserID , JobMandatoryElements , JobMessageFromOperator , JobMessageToOperator , JobMoreInfo , JobName , JobOriginatingUserName ,


735

6074

60756076607760786079

6080608160826083

608460856086

60876088

6089609060916092

60936094

6095

736


Capabilities Syntax


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, 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


737

738


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

22. 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.

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, 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-


739

6096

6097609860996100610161026103

740

http://www.iana.org/assignments/operating-system-names/operating-system-names.xml

http://www.iana.org/assignments/character-sets



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, [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]InputSourceWKV ADF, Platen, FilmReader, [KeywordNsExtensionPattern]JobAccountingSheetTypeWKV

None, Standard, [KeywordNsExtensionPattern]

JobErrorSheetTypeWKV

None, Standard, [KeywordNsExtensionPattern]

JobErrorSheetWhenWKV

Always, OnError, [KeywordNsExtensionPattern]


741

742



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-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,


743

744


Update MediaXXX from MSN 2 and JPS 3.



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, 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,


745

746



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, 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-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,


747

748



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]

PwgRasterDocumentBacksideWKV

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]


749

6104

750


23. 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 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 ExpressionKeywordNsExtensionPattern \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:/;_\-\\\+\.]*

24. Appendix D – IPP Mapping

24.1 Changes to remove some IPP specific aspectsThis section lists some changes to remove some IPP specific aspects from the PWG Semantic Model.

1. 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.

2. Any IPP attribute name containing “ipp” has had the “ipp” removed.


751

6105

610661076108

6109

6110

6111

6112

6113

61146115

6116

752


Keep this section.


There are extension patterns in the schema. Remove this table. Just include the discussion. Point to PWG SM XML Schema.


Clean up the numbering.

http://www.w3.org/TR/xmlschema-2/#dt-regex


3. All IPP attribute and operation keywords have the substring “attribute” replaced with “element”.

4. 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.)

5. 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)

6. 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.

7. XML datatypes are used that map as closely as possible to the IPP specification.

a. The IPP datatypes NameWithoutLanguage, NameWithLanguage, TextWithoutLanguage and TextWithLanguage are mapped to the XML datatype String. Localization is handled globally by the ElementsNaturalLanguage element.

b. The IPP datatype Enum is mapped to the XML datatype NMToken. See #1 above.

c. 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.

d. The “1setOf X” types are represented as the base type and the “Multivalued” field in the tables set to “Yes”.

8. 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.

24.2 Attribute Group MappingIPP 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.


753

61176118

6119612061216122

612361246125

612661276128

6129

613061316132

6133

613461356136

61376138

61396140

614161426143

6144

6145

614661476148

6149615061516152

615361546155

754


Keep.



755

6156

6157

756