Standard for Internet Printing Protocol -Actual Attributes

1 2 3 1October 12, 2008 2wd-mfdresourcemod10-2008 Working Draft 3 4 The Printer Working Group

7 Network Resource Service 8 Semantic Model and Service Interface 9 10 Status: Interim 11 12 13 14 15Abstract: When network Multifunction Devices are installed in local office or enterprise networks shared by large groups 16of users, the ability to provide resources such as job tickets pre-configured with user’s intent (Job Resource), 17professionally prepared Logos, Fonts, Forms, Signatures, …, etc, that can be reused by user’s jobs is very important for 18office document productivity. This specification defines a Resource Service that provides operators and end users a 19convenient way to remotely store, manage resources so that they can be retrieved and shared later for effectual job 20submissions to other services of network Multifunction Devices.

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

30Title: Network Resource Service Semantic Model and Service Interface

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

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

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

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

46 [email protected]

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

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

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

61For additional information regarding the IEEE-ISTO and its industry programs visit: 62http://www.ieee-isto.org. 63 64About the Printer Working Group

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

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

74Contact information:

75The Printer Working Group 76c/o The IEEE Industry Standards and Technology Organization 77445 Hoes Lane 78Piscataway, NJ 08854 79USA 80 81MFD Web Page: http://www.pwg.org/mfd MFD Mailing List: [email protected] 82 83Instructions for subscribing to the MFD mailing list can be found at the following link: 84http://www.pwg.org/mailhelp.html 85Members of the PWG and interested parties are encouraged to join the PWG and MFD WG mailing lists in order to 86participate in discussions, clarifications and review of the WG product.

87Contents 881 Introduction...... 7 892 Summary...... 7 903 Terminology...... 7 91 3.1 Conformance Terminology...... 7 92 3.2 Content Specific Terminology...... 8 93 3.3 Rationale...... 11 94 3.3.1 Rationale for Resource Service Specification...... 11 95 3.3.2 Out of Scope for Resource Service Model...... 11 96 3.4 Model mapping conventions...... 11 974 Resource Service Concept Diagram...... 11 985 Resource Service Model Overview...... 13 996 Resource Service Model Description...... 14 100 6.1 ResourceServiceConfiguration...... 14 101 6.1.1 Storages...... 15 102 6.2 Resource Service Description...... 17 103 6.2.1 OwnerURI...... 18 104 6.2.2 OwnerVCard...... 18 105 6.2.3 ResourcesSupported...... 18 106 6.2.4 ServiceInfo...... 18 107 6.2.5 ServiceLocation...... 18 108 6.2.6 ServiceName...... 18 109 6.2.7 ServiceURISupported...... 18 110 6.2.8 Sequence of ##other...... 18 111 6.2.9 Attribute of ##other...... 19 112 6.3 ResourceServiceCapability...... 19 113 6.3.1 NaturalLanguageSupported...... 19 114 6.3.2 ##other...... 19 115 6.4 ResourceServiceStatus...... 19 116 6.4.1 AccessModes...... 20 117 6.4.2 CreateDate...... 20 118 6.4.3 CurrentTime...... 20 119 6.4.4 ID...... 20 120 6.4.5 IsAcceptingJobs...... 21 121 6.4.6 NaturalLanguage...... 21 122 6.4.7 QueuedJobCount...... 21 123 6.4.8 SerialNumber...... 21 124 6.4.9 ConditionTable...... 21 125 6.4.10 State...... 23 126 6.4.11 ResourceServiceCounters...... 27 127 6.4.12 ##other...... 27 128 6.5 ResourceList...... 27 129 6.5.1 ResourceEntry...... 27 1307 Theory of Operation...... 30 131 7.1 Basic Resource Service Operations...... 31 132 7.1.1 DeleteResource...... 31 133 7.1.2 DeleteResourceRequest...... 31 15Copyright © 2007-2008, Printer Working Group. All rights reserved. Page 4 of 41 16 17MFD: Resource Service October 126, 2008 18 134 7.1.3 GetResourceServiceElements...... 32 135 7.1.4 GetResourceServiceElementsRequest...... 32 136 7.1.5 GetResourceServiceElementsResponse...... 32 137 7.1.6 GetResourceElements...... 33 138 7.1.7 GetResourceElementsRequest...... 33 139 7.1.8 ListResources...... 34 140 7.1.9 PutResource (ResourceDescription, Resource, OverwriteFlag)...... 34 141 7.1.10 ReplaceResource (ResourceId, Resource, ResourceDescription)...... 35 142 7.1.11 SetResourceElements (ResourceStatus, ResourceDescription)...... 36 143 7.2 Administrative Resource Service Operations...... 36 144 7.2.1 DisableResourceService...... 36 145 7.2.2 EnableResourceService...... 37 146 7.2.3 PauseResourceService...... 37 147 7.2.4 ResumeResourceService...... 38 148 7.2.5 ShutdownResourceService...... 38 149 7.2.6 StartupResourceService...... 39 1508 Conformance Requirements...... 39 1519 PWG and IANA Registration Considerations...... 39 15210 Internalization Considerations...... 39 15311 Security Considerations...... 39 15412 References...... 39 155 12.1 Normative References...... 39 156 12.2 Informative References...... 40 15713 Author’s Address...... 40 15814 Change Log...... 40 159 160

161Figures

19Copyright © 2007-2008, Printer Working Group. All rights reserved. Page 5 of 41 20 21MFD: Resource Service October 126, 2008 22 162Figure 1 Resource Service Top Level Architecture...... 12 163Figure 2 High Level Resource Service Schema...... 14 164Figure 3 Resource Service Configuration Schema...... 15 165Figure 4 Storages subunit Schema...... 16 166Figure 5 Resource Service Description Schema...... 18 167Figure 6 Resource Service Capability...... 19 168Figure 7 Resource Service Status Schema...... 20 169Figure 8 Condition Table...... 21 170Figure 9 Active Conditions...... 22 171Figure 10 Condition History...... 23 172Figure 11 Detailed Service Transition Diagram...... 26 173Figure 12 ResourceList Top Level Schema...... 27 174Figure 13 Resource Description Schema...... 28 175Figure 14 Resource Status Schema...... 29 176

1771 Introduction

178This document specifies the PWG abstract model for a Resource Service of a Multifunction Device (MFD). 179Included in this document are the content specific terminology, data model, the theory of operation, the resource 180service interfaces and the conformance requirements. The MFD resource service abstract models include the 181functional models and interfaces of the associated resource services for a local or enterprise network connected 182multifunction device.

1832 Summary

184Resource Service allows professionally prepared job processing resources to be stored and then reused later for 185repetitive job processing, sharing by users, or managed in centralized or distributed manner for network MFDs. 186 187A network MFD client application has a client component for each of its targeted MFD services and optionally a 188Resource Client. A network Resource Client application interacts with the end user to retrieve a pre-stored 189Resource, such as those listed below in order to create or process a job: 190 191  a Template containing pre-set job or document descriptive and processing parameters suitable for 192 submission to a targeted MFD service. A Template contains instructions representing the end user’s 193 preconfigured intent that can be used as-is or modified by the end user, if permitted. Once the end user is 194 satisfied with the Template the network Template Client application passes the Template to an intended 195 MFD Service Client for creating job or document tickets for submission to the Service. 196  an input or output ICC Profile enabling correct color space conversion 197  an official corporate Logo for insertion at the front page of a document 198  an image (e.g. Watermark, Form, background, Signature) for Overlays 199  a Font for text printing 200 201The Resource Service in this specification provides the abstract data model of the service and the operations for 202retrieval, storage, replacement, deletion, and listing of Rresources, and obtaining summary information of 203Resources and Resource Services available to network MFD Services. Like all other MFD services, a Resource 204Service can be independently startup, shutdown, paused, resumed, disabled, or enabled by an authorized 205administrator at any time appropriate for the service.

2063 Terminology

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

MUST This word means that the definition is an absolute requirement of the specification.

REQUIRED This word means that the definition is an absolute requirement of the specification.

SHALL This word means that the definition is an absolute requirement of the specification.

MUST NOT This phrase means that the definition is an absolute prohibition of the specification.

SHALL NOT This phrase means that the definition is an absolute prohibition of the specification.

SHOULD This word means that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course. 28Copyright © 2007-2008, Printer Working Group. All rights reserved. Page 7 of 41 29 30MFD: Resource Service October 612, 2008 31 32

SHOULD NOT This phrase mean that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.

RECOMMENDED This word means that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.

NOT RECOMMENDED This phrase mean that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.

MAY This word means that an item is truly optional. One vendor may choose to include the item because a particular marketplace requires it or because the vendor feels that it enhances the product while another vendor may omit the same item. An implementation which does not include a particular option MUST be prepared to interoperate with another implementation which does include the option, though perhaps with reduced functionality. In the same vein an implementation which does include a particular option MUST be prepared to interoperate with another implementation which does not include the option (except, of course, for the feature the option provides.)

OPTIONAL This word means that an item is truly optional. One vendor may choose to include the item because a particular marketplace requires it or because the vendor feels that it enhances the product while another vendor may omit the same item. An implementation which does not include a particular option MUST be prepared to interoperate with another implementation which does include the option, though perhaps with reduced functionality. In the same vein an implementation which does include a particular option MUST be prepared to interoperate with another implementation which does not include the option (except, of course, for the feature the option provides.) 210

2113.2 Content Specific Terminology 212 Term Definition

Attribute Attributes can decorate XML Elements and contains additional information about an Element. Document Data The digitized data submitted by an end user as the document to be processed by a MFD service, or as the resulting data from the scanning of Hardcopy Document(s) in MFD. The images from the scanned Hardcopy Document(s) are encoded in an image or document format and stored at a Destination. Document Data is not considered as a resource that can be retrieved or stored by the Resource Service. Document Ticket A data object that contains end user’s intent for document processing and descriptive properties of a document within a job of a Service. The content of a Document Ticket is configured by end user through a network MFD Client application. Element Elements are used to convey structure and relationships in XML document instances. An Element can contain both content and 33Copyright © 2007-2008, Printer Working Group. All rights reserved. Page 8 of 41 34 35MFD: Resource Service October 612, 2008 36 37 Term Definition

Attributes. Executable Resource An executable code that is installed in a 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. Firmware Persistent computer instructions and data embedded in the HCD that provides the basic functions of that device. Firmware is only replaced during a specialized update process. [IEEE2600] Font A complete character set of a single size and style of a particular typeface. Most today computer fonts are based on fully scalable outlines. However, it 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 Static Resource that can be retrieved and stored by PWG MFD Resource Services. Form A document (printed or electronic) with spaces in which to write or enter data. Form in this document refers to an electronic form, which is a type of Static Resource that can be retrieved and stored by PWG MFD Resource Services. Group Element A collection of Elements that constitutes a complex Element.

ICC 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 attributes 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 (L*a*b*) 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 Static Resource that can be retrieved and stored by a PWG MFD Resource Service. Job Ticket A data object that contains end user’s intent for job-level document processing, job processing and descriptive properties of a job of a Service. The content of a Job Ticket is configured by end user through a network MFD Client application. MFD Service A software service that accepts and processes requests to create, monitor and manage Jobs requesting a service. The software service accepts and processes requests to monitor and control the status of the service itself and its associated resources. A MFD Service is hosted either locally or remotely to the MFD, Local Client A software application entity that is co-located with the service it interacts on behalf of an end user. 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 Static Resource that can be retrieved and stored by a PWG MFD Resource Service. Profile Connection Space A standard device independent color space defined by the 38Copyright © 2007-2008, Printer Working Group. All rights reserved. Page 9 of 41 39 40MFD: Resource Service October 612, 2008 41 42 Term Definition

(PCS) 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. Resource An data object that can be served by the Resource Service when required by a MFD system for performing a task or a job. There are two categories of resources required by a MFD: Executable Resource, and Static Resource. (See the definitions of Executable Resource and Static Resource). Resource Repository A persistent storage for storing Resources. Access to the Resource Repository is through a Resource Service. Resource Repository may be embedded within a device, co-located with the Resource Service or hosted remotely. Resource Client The local or remote software entity that interfaces with the end user and interacts with a Resource Service. Resource Service A software service that provides the interfaces for storing, retrieving, and maintaining users’ Resources. Static Resource A non-executable electronic data object that is required by a MFD system for performing a task. Static Resource includes the following types of resource: Font, Form, Images, Logo, Signature, Template. Sequence A type of XML structure that represents an ordered list of elements. Signature A signature in this document means an electronic signature, which is a person’s handwriting signature captured by an electronic signature capturing device, when attached to a document, can be used as the legal signature of the document. An electronic signature is a type of Static Resource that can be retrieved and stored by a PWG MFD Resource Service. Software Persistent computer instructions and data placed on the HCD, via download, that are separate from, and not a part of, the base Firmware. Applications are an addition to the base Firmware that provides additional function beyond that provided by the base Firmware. Software is a type of Executable Resource. Template A data object that contains descriptive information and the preconfigured content of a job or document ticket for a specific MFD 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 Static Resource that can be retrieved and stored by a PWG MFD Resource Service. Watermark A recognizable image or pattern when printed on paper used to identify authenticity. Watermark is a type of Static Resource that can be retrieved and stored by a PWG MFD Resource Service.

2153.3 Rationale

2163.3.1 Rationale for Resource Service Specification 217 218There are clear benefits to provide a Resource Service for MFD Services. If MFD resources can be professionally 219prepared, stored and then retrieved using a standard, interoperable interface, then many MFD applications can be 220developed and flexibly integrated to reuse and share, or manage the resources centrally or in distributed manner 221across all MFDs in an enterprise network environment. 222 223In order to implement an abstract model of the operations and elements for Resource Services, there is need to 224map them onto implementable applications and communication protocols that support interactions between 225Resource Clients and Resource Services. There is a clear need to define a binding of the abstract model into Web 226Service Schema and Web Service protocol stack. 227 2283.3.2 Out of Scope for Resource Service Model 229A Resource can be used in many ways to benefit users and their organizations. The purpose of the Resource 230Service specified herein is to provide users a convenient and interoperable method to store, retrieve, and manage 231resources for the jobs of MFD Services. The followings are outside the scope of this model: 232 233 (1) The use of a Template Resource for restricting users’ usage of certain MFD Service features regulated by 234 an organizational policy. 235 (2) The protection of Resource from unauthorized access, disclosure, and alteration according to a specified 236 security policy. 237 (3) Operations required to store and retrieve a Resource to and from a Resource Repository. 238 (4) Document data submitted by an end user to be processed by a job-oriented MFD service, or as the 239 resulting data from the scanning of Hardcopy Document(s) by a MFD scan service.

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

2484 Resource Service Concept Diagram

252 253 Figure 1 Resource Service Top Level Architecture 254 255The lifecycle of a Resource begins when the Resource is created, ends when the Resource is deleted. 256 257A MFD resource is created by a MFD Resource Client, then stored by a Resource Service in a Resource 258Repository. The MFD Resource Client, Resource Service, or the Resource Repository is local or remote to the 259MFD System. 260 261At any time a resource may encounter the following events while being stored in a Resource Repository: 262 263 (1) retrieval by a Resource Service at the request from a Resource Client invoked by a MFD application on 264 behalf of a user’s job processing request, 265 (2) update/replacement by a Resource Service at the request of a Resource Client on behalf of the creator 266 of the resource, 267 (3) expiration that signals the end of life for the resource, and the resource will then be deleted by the 268 Resource Services.

270Resource Service is an optional Imaging Service. There may be zero or multiple instances of Resource Services in 271an Imaging Service System. 272 273The types of resources within the scope of Resource Service include, but not limited to: Font, Form, Logo, ICC 274Profile, Firmware, Software, Image, Signature, Template (including job and document Template). 275 276The Resource Service model contains several service properties: service capability, service configuration, service 277descriptive information, service status, information with Resource Service specific counters, and an extension point 278for vendor’s unique service properties. It does not have default job ticket or service capabilities that is used for job 279processing in other MFD Services. 280 281[Need mor general information / description on Resource Service properties] 282The service capability of the service properties only provides information on the natural languages supported for 283any service generated message or description text. It does not provide other job-related service capabilities 284because a Resource Service only stores and retrieves Resources, does not process any MFD job. 285 286The service configuration property of the service is the Resource Service specific view to the MFD supported 287subunits in that only the Storages subunit which consists of a sequence of volatile and non-volatile storages is 288applicable. 289 290The service description property contains only the basic set of imaging service description elements common to all 291imaging services: owner’s web address and identification information, service URIs, service descriptive information, 292service location, and service name. 293 294The service status property provides state information maintained by the service automata. The state information 295consists of a set of basic imaging service states which are common to all imaging services and a Resource Service 296specific set of service states. The basic imaging service state information are: service access rights, service 297creation data, current time, service Id, a flag indicating whether the service is accepting jobs (which refer to storage 298and retrieval requests in Resource Service), the natural language currently used by the service, queued service 299request count, serial number of the device hosting the service, the current state of the service, the current state of 300the subunits used by the service, additional information about the service state, and human readable messages on 301the additional information about the service state. 302 303The Resource Service specific set of service state contains information on resource service counters that provide 304Resource Service specific usage accounting information. 305 306Below is the top level view of the Resource Service schema.

309 Figure 2 High Level Resource Service Schema 310 311Like all other imaging services, Resource Service Configuration references the imaging subunits used by the service 312and provides the service-specific view of the included subunits. 313 314The descriptive property of a ResourceEntry contains the Resource name, Resource information that can be arbitrarily 315set by the end user, the type of resource for a targeted MFD Service, the Resource creator’s name, Expiration Date, 316Date of Last Update, and a vendor extension point for Resource descriptive properties. 317 318The Resource status property contains the Resource identifier unique across Resource Services, and a vendor’s 319extension for other status attributes. 320 321Besides service properties, Resource Service has an unordered list of Resources: ResourceList. Each element in 322the list is a ResourceEntry that contains Resource descriptive and status information of the resource for which the 323operation has been completed. 324 325Resource Service provides a set of client interfaces that allow users to list all resources available to a specific user or 326group, get a resource that is specified by the Resource ID, put (store) a new resource that validates a resource before it 327is stored, replaceput (store) a new resource specified by the Resource Name, update (updatereplace) and delete a 328resource with the specified Resource ID, and get and set the metadata of a Resoure and a Resource Service.. 329 330Like all other imaging services, Resource Service model provides a set of administrative interfaces that allows 331authorized administrators to remotely disable/enable the service, pause/resume the service, and shutdown/restart the 332service.

3337 Resource Service Model Description

3347.1 ResourceServiceConfiguration 335This group element identifies the actual instances of the subunits the service uses. Note that not all subunits are 336used by the Resource Services. 337 338These elements are based on the Printer MIB [RFC3805]. See the RFC for details on these elements. 339All subunits defined for all imaging services are optional; only the subunit ‘Storages’ is applicable to Resource 340Service.

63Copyright © 2007-2008, Printer Working Group. All rights reserved. Page 14 of 41 64 65MFD: Resource Service October 612, 2008 66 67 341 342The following diagram shows the schema of Resource Service Configuration. 343

345 Figure 3 Resource Service Configuration Schema 346 3477.1.1 Storages

348Storages is a sequence of Storage, each models a storage subunit used by the Resource Service. Each storage 349subunit contain a StorageStatus element and a StorageDescription element.

350Below is the schema diagram of Storages.

352 Figure 4 Storages subunit Schema

353A Storage has the attributes described in the following sections.

3547.1.1.1 StorageStatus 355This group element contains the current status of the storage subunit. 3567.1.1.1.1 StorageId 357This is element is the unique identifier of the storage subunit within the Resource Service instance. 3587.1.1.1.2 StorageType

359 This element indicates the type of the storage subunit. The allowed storage types are : 360 361 RAM (Random memory), 362 FixedHardDisk (Non-removable, rigid, rotating storage), 363 RemovableHardDisk (Removable, rigid, rotating storage), 364 CompactDisc (Read-only rotating optical storage), 365 FloppyDisk (Non-rigid rotating magnetic storage), 366 VirtualMemory (Temporary storage of swapped or paged memory), 367 FlashMemory (Non-removbable flash), 368 FlashCard (Removable flash), 369 NetworkStorage (Any storage external to MFD), 370 Other (Any other vendor defined storage). 371 3727.1.1.1.3 StorageSize 373This element indicates the total bytes allocated to the service, i.e. the service-specific view of storage size.

73Copyright © 2007-2008, Printer Working Group. All rights reserved. Page 16 of 41 74 75MFD: Resource Service October 612, 2008 76 77 3747.1.1.1.4 StorageFree 375This element indicates the total bytes currently free for use to the service. 3767.1.1.1.5 ##Other 377This element provides vendor’s extension points for StorageStatus. 3787.1.1.2 StorageDescription

3797.1.1.2.1 StorageName

380 This is a unique name of the storage subunit that is unique within a Resource Service instance.

3817.1.1.2.2 StorageMake 382This element provides information on the manufacturer of the storage subunit. 3837.1.1.2.3 StorageModel 384This element describes the model name of the storage subunit. 3857.1.1.2.4 StorageInfo

386 This element contains administrator settable additional description text about the storage subunit such as 387 manufacturer, model name.

3887.1.1.2.5 StorageDataEncryption 389This element describes the encryption methods supported by the storage subunit (algorithm and key size). 3907.1.1.2.6 ##Other 391This element provide vendor’s extension points for StorageDescription while maintaining interoperability. 392 3937.1.1.3 StorageURI 394This element is only applicable to a NetworkStorage storage device of NetworkStorage type . Itand provides the 395network location information of the storage subunit. 396 397

3987.2 Resource Service Description 399The Description elements provide Descriptive information for the Resource Service. The elements are 400administratively set. The element values can be modified directly or indirectly through an operation of a service or 401a management protocol such as WS-Management. Currently Resource Service does not define such 402administrative operations. 403 404Note that Resource Service Description consists of two sequences. The first represents elements inherited from 405the Imaging Service super class and the second sequence includes Resource Service specific extensions. 406 407Below is a view of the Description elements for the Resource Service.

409 Figure 5 Resource Service Description Schema

4107.2.1 OwnerURI 411This is the URI by which you can reach the administrator or owner who created the service. 4127.2.2 OwnerVCard 413This is the vCard (rfc2426) of the owner of the Resource Service. 4147.2.3 ResourcesSupported 415This attribute is not applicable to Resource Service. This is a service specific view of the available resources used 416by a service. Available resources are installed resources on a specific MFD, not a physical resource to be 417managed by Resource Service. 4187.2.4 ServiceInfo 419This is descriptive information about this Resource Service the owner of the service wishes to put. 4207.2.5 ServiceLocation 421This describes the physical location of this Service. (Example: “Building 128 Floor 2 Room 210C") 4227.2.6 ServiceName 423This is the end-user friendly name of Resource Service. 4247.2.7 ServiceURISupported 425This MANDATORY element contains the URIs where the Resource Service is available. 426 4277.2.8 Sequence of ##other 428This optional element provides an extension points for vendor differentiation and implementation specific 429extensions while maintaining interoperability.

83Copyright © 2007-2008, Printer Working Group. All rights reserved. Page 18 of 41 84 85MFD: Resource Service October 612, 2008 86 87 4307.2.9 Attribute of ##other 431This is a MANDATORY vendor’s extension point for adding one single extra attribute to Resource description 432properties.

4337.3 ResourceServiceCapability 434Resource Service contains one single service capability : NaturalLanguageSupported that indicates all natural 435languages supported by the service for system generated human readable status and messages. 436 437Below is the schema diagram of ResourceServiceapability. 438

440 Figure 6 Resource Service Capability 441 4427.3.1 NaturalLanguageSupported 443(sequence of keywords) Indicates the supported natural languages for the service elements with a string syntax 444(example values: en-us, fr, de, ja) See [rfc3066] 4457.3.2 ##other 446This optional element provides extension points for vendor differentiation and implementation specific extensions 447while maintaining interoperability. 448

4497.4 ResourceServiceStatus 450 451The Status elements provide state information of the Resource Service. The states are maintained by automata 452and can not be directly set. 453 454Note that ResourceServiceStatus consists of two sequences. The first represents elements inherited from the 455Imaging Service super class and includes elements such as Id and State. The second sequence includes 456Resource Service specific extensions to the super class such as the Resource Service counters. 457 458Below is a view of the Status elements for the Resource Service. 459

461 Figure 7 Resource Service Status Schema

4627.4.1 AccessModes 463This element corresponds to the access mode property of a POSIX file and specifies the basic access control 464policy for the Resource Service object, as set by the Owner. Site-specific policies, e.g., Access Control Lists 465(ACLs), MUST NOT reduce the security required by this AccessMode element but MAY further restrict that access. 466 467The AccessMode element describes the basic access control policy for the Owner, members of the Owner's group 468(e.g., Administrators), and all other authenticated users (i.e., the 'World'). Typically, only the Owner or a member of 469the Owner's group (site-specific) is granted the Write permission, but the World is granted Read permission (e.g., to 470read elements such as capabilities). [CHMOD, STAT] 471 4727.4.2 CreateDate 473Date and Time the Service was created. 4747.4.3 CurrentTime 475This element indicates the current date and time according the Resource Services internal clock 4767.4.4 ID 477A MANDATORY 32 bit Object Identifier for the Resource Service instance. It is unique within a Resource server. 478

93Copyright © 2007-2008, Printer Working Group. All rights reserved. Page 20 of 41 94 95MFD: Resource Service October 612, 2008 96 97 4797.4.5 IsAcceptingJobs 480This element indicates whether this Resource Service is currently able to store or retrieve Resources. When the 481service is NOT accepting jobs, the service MUST still be able to process get service configuration, service 482description, and service status commands. How the Value for this element is configured is implementation-specific, 483e.g., local console, web page. 4847.4.6 NaturalLanguage 485Indicates the local language currently used by the Service. This is the used unless the operation specifies a 486RequestedNaturalLanguage . 4877.4.7 QueuedJobCount 488This element does not apply to Resource Service. This element specifies the number of requests the service has 489currently accepted but not yet finished processing. 4907.4.8 SerialNumber 491This element specifies the serial number of the device hosting the service. 4927.4.9 ConditionTable 493The Condition Tables provide additional information on the current and past state of Subunits used by Resource 494Service. The contents of the tables are based on the Alert Table from the Printer MIB. 495

497 Figure 8 Condition Table

4987.4.9.1 ActiveConditions 499This is a MANDATORY element for ConditionTable. This element represents the Resource Service specific view of 500conditions (informational, warning or critical) that are currently in effect on the device. 501

503 Figure 9 Active Conditions 504 505 5067.4.9.1.1 Component 507This element specifies the origin of the condition.

5087.4.9.1.1.1 Group 509This element specifies the class of the component (e.g. subunit, service) that is the source of the condition. Values 510include: Storages, Console, Finisher, InputChannel, InputTray, Interface, Interpreter, Marker, MediaPath, 511OutputChannel, OutputTray, ScanMediaPath, Scanner, VendorSubunit, CopyService, EmailInService, 512EmailOutService, FaxInService, FaxOutService, NetFaxInService, NetFaxOutService, PrintService, 513ScanService, ResourceService, TransformService.VendorSubunit. The only values applicable to Resource 514Service are Storages, and ResourceService.

5157.4.9.1.1.2 Name 516This element specifies the instance of the component (e.g. subunit of resource service) that is the source of the 517condition. Values are taken from the Name element of the Group. 5187.4.9.1.2 ConditionId 519This element is the unique identifier for the condition. 5207.4.9.1.3 Name 521This element is the keyword that identifies the condition type. The values are the same values that are used for 522Service’s StateReasons (e.g. AttentionRequired, StorageFull, StorageAlmostFull, …, etc.) .

103Copyright © 2007-2008, Printer Working Group. All rights reserved. Page 22 of 41 104 105MFD: Resource Service October 612, 2008 106 107 5237.4.9.1.4 Severity 524This element is the keyword that identifies criticality of the condition (i.e. Informational, Warning, Critical) . 5257.4.9.1.5 Time 526This element is the date and time the condition occurred. 5277.4.9.2 ConditionsHistory 528This OPTIONAL table represents the conditions (informational, warning or critical) that have been cleared from the 529device. This element is an extension of the data type used by ActiveConditions. See above for the elements that 530are common. Only the ConditionHistory specific elements are explained below. 531

533 Figure 10 Condition History

5347.4.9.2.1 ClearTime 535This element is the date and time the condition was removed from the ActiveConditions list.. 5367.4.10 State 537The MANDATORY State element records the current state of the Resource Service instance. The state contains 538one of the following values: 539 540From rfc2911: 541Idle – The Scan Service is available and can start processing a new job. 542Processing – The Scan Service is currently processing jobs. 543Stopped - No jobs can be processed and intervention is needed. 544 545From rfc2790: 108Copyright © 2007-2008, Printer Working Group. All rights reserved. Page 23 of 41 109 110MFD: Resource Service October 612, 2008 111 112 546Unknown– The state of the Scan Service is not known. 547Testing- The Scan Service is in testing or maintenance mode. 548Down- The Scan Service is unavailable for jobs. 5497.4.10.1 Service State Diagram 550All imaging services inherit the same service state behavior. 551The Service State Diagram is divided into three phases: 552 - - Unknown state - immediately after service creation 553 - - Down and Testing states - no user jobs are processed 554 - - Idle, Processing, and Stopped states 555See ‘Network Scan Service Semantic Model and Service Interface’ specification for the service state diagram. 5567.4.10.2 Service State Transition Tables 557The following notations are used in the two subsequent service state transition tables: 558 559~ = logical NOT (e.g., ~C.paused means "not paused") 560C = prefix of a condition 561E = prefix of an event (e.g., E.endJob means "job completed") 562titlecase = state (e.g., Idle), operation (e.g., Startup), or phase 563lowercase = action function (in FSM) 564 565The following notes are used in the two service state transition tables: 566 567(2) Startup and Restart 568- Startup (Unknown/Init) sends E.startup and goes to (Down/Offline) 569- Startup (Down/Offline) is a synonym for Restart 570- Restart (Down/Offline) initializes and goes to (Idle/Online) 571 572(3) Shutdown 573- Shutdown (Testing|Idle|Stopped) goes to (Down/Offline) 574- Shutdown (Processing) sends E.shutdown and stays in (Processing) 575 576(4) Testing 577- Testing (Down|Stopped) goes to (Testing/Offline) 578- Testing (Idle|Processing) is an error

5797.4.10.2.1 Service State Transition By Operations 580 SERVICE STATE MACHINE (Operations) State Input Down Testing Idle Processing Stopped Operation Action Action Action Action Action (Condition) (new state) (new state) (new state) (new state) (new state) N/A disable disable disable disable Disable (~C.IsAcceptingJobs) (~C.IsAcceptingJobs) (~C.IsAcceptingJobs) (~C.IsAcceptingJobs) Enable N/A enable enable enable enable (C.IsAcceptingJobs) (C.IsAcceptingJobs) (C.IsAcceptingJobs) (C.IsAcceptingJobs) Restart restart restart restart restart (Note 2) (Idle) (Idle) restart (Idle) (Idle) Shutdown shutdown shutdown shutdown shutdown (Note 3) N/A (Down) (Down) (Down) (Down) Startup restart (Note 2) (Idle) error error error error

113Copyright © 2007-2008, Printer Working Group. All rights reserved. Page 24 of 41 114 115MFD: Resource Service October 612, 2008 116 117 Test test (Note 4) (Testing) error error error error 581 5827.4.10.2.2 Service State Transition By Events 583 SERVICE STATE MACHINE (Events) State Input Down Testing Idle Processing Stopped Event Action Action Action Action Action (Condition) (new state) (new state) (new state) (new state) (new state) critical critical E.critical N/A critical (Stopped) (Stopped) critical E.endCrit endCritical N/A endCritical error error (Idle|Processing) E.endJob shutdown (C.shutdown) N/A error error (Down) error testReport E.endTest N/A (Down) error error error E.endWarn N/A endWarning endWarning endWarning endWarning E.Startup restart (Note 2) (Idle) error error error error E.warning N/A warning warning warning warning

5857.4.10.2.3 Detailed Service State Transition Diagram

587 Figure 11 Detailed Service Transition Diagram

5887.4.10.3 StateReasons 589This element supplies additional detail about the service's state. The standard keyword values are defined in 590§4.4.12 of [rfc2911]. Values of interest to a Resource Service include: 591  AttentionRequired 592  ConnectingToDevice 593  Deactivated 594  None 595  Other 596  StorageFull 597  StorageAlmostFull 598  Shutdown 599  TimedOut 600

123Copyright © 2007-2008, Printer Working Group. All rights reserved. Page 26 of 41 124 125MFD: Resource Service October 612, 2008 126 127 6017.4.10.4 StateMessages 602This element contains information about the Service State and StateReasons in human readable text. If the 603Service supports this element, it MUST be able to generate the messages in any of the natural languages 604supported by the Service. 6057.4.11 ResourceServiceCounters 606This element contains the counters for the amount of work performed by the Resource Service, timers covering 607utilization and monitoring information covering errors, warnings, traffic, resource counts and configuration changes. 608See PWG5106.1-2007. 6097.4.12 ##other 610This element provides an extension point for vendor differentiation and implementation specific extensions while 611maintaining interoperability

6127.5 ResourceList 613This is a list of at least one entry of Resources on which a Resource Service operation described in section 8.1 has 614completed. There is no implied requirement of the ordering of the resources in the list. Below is the top level 615schema diagram of the ResourceList. 616

618 Figure 12 ResourceList Top Level Schema

6197.5.1 ResourceEntry 620As depicted in Figure 10, each Resource Entry contains Resource Description, and Resource Status.

623 Figure 13 Resource Description Schema

6247.5.1.1.1 ResourceCategory 625This element indicates the resource category of the ResourceEntry. The allowed values are: Executable, Static, 626and Template. 6277.5.1.1.2 ResourceCreatorUserName 628This is the user name unique within a network domain who created the resource. 6297.5.1.1.3 ResourceName 630This REQUIRED element is the name of the Resource that uniquely identifies a Resource within a unique 631Resource Service instance. 6327.5.1.1.4 ResourceType 633This REQUIRED element indicates the type of MFD Resources manageable by a Resource Service. The list of 634keywords allowed for ResourceType are divided into three categories: 635 636(1) Executable Resource category that has allowed Firmware and Software types, 637(2) Static Resource category that has allowed values Font, Form, Image, Logo, ICCProfile, and Signature types, 638(3) Template category allows one of the following types : 639 CopyDocument, CopyJob, 640 EmailInDocument, EmailInJob, 641 EmailOutDocument, EmailOutJob, 642 FaxInDocument, FaxInJob, 643 FaxOutDocument, FaxOutJob, 644 NetFaxInDocument, NetFaxInJob, 645 NetFaxOutDocument, NetFaxOutJob, 646 PrintDocument, PrintJob, 647 ScanDocument, ScanJob, 648 TransformDocument, TransformJob. 649 Each template type indicates the resource is a job or document template of a job or document ticket for a 650 particular job-oriented MFD Service. A job or document template is a preconfigured job or document ticket 651 representing a user’s intent for a particular job or document respectively. 133Copyright © 2007-2008, Printer Working Group. All rights reserved. Page 28 of 41 134 135MFD: Resource Service October 612, 2008 136 137 6527.5.1.1.5 ResourceFormat 653This element represents the format of the data for the resource. It is a choice of either DocumentFormat which 654contains a MIME type value, or ResourceNamespace which is the URI (XML namespace) identifying the resource 655data model (XML schema). 6567.5.1.1.6 ResourceInfo 657This element allows an end user to provide arbitrary descriptive text for the resource. 6587.5.1.1.7 ElementsNaturalLanguage 659This element indicates the natural language currently used to generate the descriptive text used by some elements 660in Resource Description. 6617.5.1.1.8 ResourceCreatorUserName 662This element records the name of the person who created the Resource. 6637.5.1.1.9 DateTimeOfExpiration 664This element is settable by the end user and specifies the date and time this resource is to be expired, and shall be 665deleted by the Resource sSerivice. 6667.5.1.1.10 DateTimeAtCreation 667This element records the date and time when this resource was created. 6687.5.1.1.11 DateTimeAtLastUpdate 669This element records the date and time when this resource was last updated. 6707.5.1.1.12 ##other 671This element provides an extension attribute for the Resource Description properties. 6727.5.1.2 Resource Status 673A Resource is either successfully stored, retrieved, deleted, or updated at the completion of a Resource operation. 674There is neither intermediate status or state, nor state reason associated with those states. 675 676At the success of a Resource operation, a Resource ID MUST be created by the Resource Service to uniquely 677identify the Resource stored in or retrieved from the Resource Repository. 678 679ResourceStatus contains a ##other in any type for vendor-specific differentiation or implementation extension while 680maintaining interoperability. 681 682Below is the Schema diagram of Resource Status.

684 Figure 14 Resource Status Schema 685 6867.5.1.2.1 DateTimeAtCreation 687This element records the date and time when this resource was created by the Resource Service. 6887.5.1.2.2 DateTimeAtLastUpdate 689This element records the date and time when this resource was last updated by the Resource Service. 6907.5.1.2.3 ResourceId 691This REQUIRED element is a Global Unique Identifier (GUID) generated by Resource Service that uniquely 692identifies a Resource across all Resource Service instances running in the network. 6937.5.1.2.4 ##other 694This element provides an extension attribute for the Resource Status properties.

6958 Theory of Operation

696The Resource Service operates autonomously through three phases: initialization, online, and offline. 697 698At power-up the Resource Service enters its initialization phase that initializes all its service attributes, connections 699to repository(ies), and may perform a self-testing. After the initialization is successful, the Resource Service enters 700the “Down” state (an offline state) and performs a start-up operation that brings the service online, authenticates 701and registers its service with a service directory or announces its service to the network domain in which it resides. 702The Resource Service then enters the “Idle” state and becomes ready for service discovery and accepting service 703requests from Resource Clients. 704 705The Resource Service accepts new resource storage or retrieval requests as long as it’s not disabled and is in one 706of the four states: Idle, Processing, Stopped, or Testing. Performing an administrative DisableResourceService() 707operation will stop the Resource Service from accepting new resource storage or retrieval requests. Performing an 708EnableResourceService() operation while the Resource Service is disabled will enable new resource storage or 709retrieval requests to be accepted again. When necessary, the Resource Service can be manually shutdown by an 710authorized administrator by sending a ShutdownResourceService request, and later manually restarted by sending 711a StartupResourceService request. While the Resource Service is in processing state, an authorized administrator 712can use the PauseResourceService request to temporarily stop the Resource Service that then pauses the 713processing of the current service request until a ResumeResourceService request is received. 714 715Before requesting a Resource Service, a user uses a local (via MFD UI) or remote (via local network or Internet) 716Resource Client to discover and select the desired target Resource Service. While the service is available, a Client 717application of a MFD Service can request one of the Resource Service operations specified in Sections 8.1 that

143Copyright © 2007-2008, Printer Working Group. All rights reserved. Page 30 of 41 144 145MFD: Resource Service October 612, 2008 146 147 718include DeleteResource, GetResource, GetResourceElements, GetResourceServiceElements, ListResource, 719PutResource, ReplaceResource, and SetResourceElement. 720 721On PutResource request, the Resource Service stores the specified Resource in a local or remote Resource 722Repository. It is implementation’s responsibility to determine the target Resource Repository for the Resource 723Service. Once a resource is stored, a Resource Client can use the GetResource request to retrieve the content of 724the resource identified by the ResourceId and the JobRequestingUserName. 725 726A ListResource can be used to request the Resource Service returns a filtered list of Resources available to the 727requesting user, allowing the user to select a desired Resource. On a GetResourceElements request, the Resource 728Service obtains the user desired metadata of the Resource identified by the ResourceId and the 729JobRequestingUserName from the designated Resource Repository. Similarly on a GetResourceServiceElements 730request, the Resource Service obtains the user desired metadata of the Resource Service identified by the 731Resource Service Id and the JobRequestingUserName; the metadata returned is described in the user designated 732natural language. On a ReplaceResource request, the Resource Service replaces the existing resource identified 733by the ResourceId in repository with the one supplied by the requesting user. On a SetResourceElements request, 734the Resource Service sets the elements such as the DateTimeOfExpiration of the ResourceDescription of the 735resource identified by the ResourceId to the desired content specified the end user. On DeleteResource request, 736the Resource Service deletes the Resource in the repository by ResourceId.

7378.1 Basic Resource Service Operations 738This section describes the semantics of all mandatory and optional external interfaces to a PWG Resource Service. 7398.1.1 DeleteResource 740This REQUIRED operation permanently removes a Resource from the Resource Repository by ResourceId. 7418.1.2 DeleteResource Request 742Below is the DeleteResource request message schema. 743

744 7458.1.2.1 DeleteResource Response 746Note: The response is expected to be an empty successful return or a fault. The response below indicates that 747vendors may extend the response with additional information 748

749 750 751 8.1.2.2 GetResource 752This REQUIRED operation allows a Resource Client to retrieve the content of a Resource. 753 8.1.2.3 GetResourceRequest 754This request retrieves the content of a Resource identified based on the ResourceId and JobRequestingUserName. 755 148Copyright © 2007-2008, Printer Working Group. All rights reserved. Page 31 of 41 149 150MFD: Resource Service October 612, 2008 151 152

756 757 8.1.2.4 GetResourceResponse 758The response of GetResource request returns the ResourceDescription elements first, followed by the content of 759the resource in two separate executions. It is recommended that MTOM is used to transport the binary content of 760the resource.

761 7628.1.3 GetResourceServiceElements 763This REQUIRED operation allows a Resource Client to retrieve the metadata of a Resource Service. 7648.1.4 GetResourceServiceElementsRequest 765This request gets a list of summarized information that only contains top level information of a list of requested 766elements of the Resource Service targeted by the resource client. The JobRequestingUserName can be used to 767authenticate the requesting user for accessing these service elements for security. NaturalLanguage is used to 768specify the natural language used for the returned description text of the service elements.

153Copyright © 2007-2008, Printer Working Group. All rights reserved. Page 32 of 41 154 155MFD: Resource Service October 612, 2008 156 157 7708.1.5 GetResourceServiceElementsResponse 771The response of GetResourceServiceElements request should include one or more of the top level Resource 772Service elements requested: ResourceServiceCapability, ResourceServiceConfiguration, 773ResourceServiceDescription, ResourceServiceStatus, and other vendor specific extension.

774 7758.1.6 GetResourceElements 776This REQUIRED operation allows a Resource Client to retrieve the metadata of a Resource. 7778.1.7 GetResourceElementsRequest 778This request gets a list of summarized information for a list of requested elements of the Resource identified by the 779ResourceId and the JobRequestingUserName. The JobRequestingUserName can be used to determine the access 780rights of the requesting user to these resource elements for security.This request gets a list of summarized 781information that only contains top level elements of ResourceDescription and ResourceStatus of Resources, filtered 782by three optional elements: JobRequestingUserName, ResourceCategory, and Resourcetype. 783

784 7858.1.7.1 GetResourceElementsResponse 786The response message from GetResourceElements request MUST contain only top level elements of 787ResourceDescription and ResourceStatus. ResourceDescritpion element contains MANDATORY ResourceType 788and ResourceName. ResourceType can be used by Resource Client to interprete the retrieved resource data. 789

790 7918.1.8 ListResources 792This REQUIRED operation allows a Resource Client to get a list of Resource. The list of Resources returned will 793provide some summary information on each Resource. The Resource Service SHOULD restrict the list of 794Resources returned based on the JobRequestingUserName, the ResourceCategory, and the ResourceType.. 7958.1.8.1 ListResourcesRequest

796 7978.1.8.2 ListResourcesResponse 798The response to the ListResource request only returns the top level summary information about the resources 799matching the requested ResourceType, ResourceCategory, and JobRequestingUserName. The 800ResourceSummary for each returned resource only contains ResourceCategory, ResourceFormat, ResourceId, 801ResourceName and ResourceType elements.

163Copyright © 2007-2008, Printer Working Group. All rights reserved. Page 34 of 41 164 165MFD: Resource Service October 612, 2008 166 167 8038.1.9 PutResource (ResourceDescription, Resource, OverwriteFlag) 804This MANDATORY operation stores a new Resource with the specified Resource descriptions into the Resource 805Repository connected to this Resource Service instance. OverwriteFlag indicates whether the Resource SHALL be 806overwritten if name collision is encountered. This operation MUST generate a GUID for the Resource and validate 807that the requested Resource is well-formed before the Resource is stored in the repository if the resource is a 808Template. 8098.1.9.1 PutResourceRequest

810 8118.1.9.2 PutResourceResponse 812Note: The response is expected to be an empty successful return or a fault. The response below indicates that 813vendors may extend the response with additional information.

814 8158.1.10 ReplaceResource (ResourceId, Resource, ResourceDescription) 816This OPTIONAL operation replaces the ResourceEntry that has the matching ResourceId in the connected 817repository. 8188.1.10.1 ReplaceResourceRequest

168Copyright © 2007-2008, Printer Working Group. All rights reserved. Page 35 of 41 169 170MFD: Resource Service October 612, 2008 171 172 8208.1.10.2 ReplaceResourceResponse 821Note: The response is expected to be an empty successful return or a fault. The response below indicates that 822vendors may extend the response with additional information.

823 824 8258.1.11 SetResourceElements (ResourceStatus, ResourceDescription) 826This request sets the metadata of the Resource that has the matching ResourceId indicated by the input parameter 827ResourceStatus to the ResourceDescription passed in as a request parameter. 828 8298.1.11.1 SetResourceElementsRequest 830

831 8328.1.11.2 SetResourceElementsResponse 833Note: The response is expected to be an empty successful return or a fault. The response below indicates that 834vendors may extend the response with additional information. 835

836 8378.2 Administrative Resource Service Operations 838Administrative operations available for Resource Service are disable, enable, pause, resume, shutdown, and 839startup. The request and response messages of these operations are the same for all MFD services. These 840messages are generically defined in PWG Administrative Operations and reused in the message body of the 841request and response messages of the corresponding Resource Service operations. 8428.2.1 DisableResourceService 843This operation prevents the Resource Service from accepting any new resource retrieval or storage operation 844request (e.g. PutResource operation). The Resource Service is still able to process other operations. 8458.2.1.1 DisableResourceServiceRequest 846Note: The request is not expected to contain any parameters. The request below indicates that vendors may extend 847the request with additional information. It uses the generic Disable Service Request message schema in its 848request message body.

849 173Copyright © 2007-2008, Printer Working Group. All rights reserved. Page 36 of 41 174 175MFD: Resource Service October 612, 2008 176 177 8508.2.1.2 DisableResourceServiceResponse 851Note: The response is expected to be an empty successful return or a fault. The response below indicates that 852vendors may extend the response with additional information. It uses the generic Disable Service Response 853message schema in its response message body. 854

855 856 8578.2.2 EnableResourceService 858This operation allows a previously disabled Resource Service to accept new resource retrieval or storage 859operations (e.g. PutResource operation). 860 8618.2.2.1 EnableResourceServiceRequest 862Note: The request is not expected to contain any parameters. The request below indicates that vendors may 863extend the request with additional information

864 8658.2.2.2 EnableResourceServiceResponse 866Note: The response is expected to be an empty successful return or a fault. The response below indicates that 867vendors may extend the response with additional information.

868 869 8708.2.3 PauseResourceService 871This OPTIONAL operation temporarily stops processing of the current Resource Service operation. 8728.2.3.1 PauseResourceServiceRequest 873

874 8758.2.3.2 PauseResourceServiceResponse 876Note: The response is expected to be an empty successful return or a fault. The response below indicates that 877vendors may extend the response with additional information. 878 178Copyright © 2007-2008, Printer Working Group. All rights reserved. Page 37 of 41 179 180MFD: Resource Service October 612, 2008 181 182

879 880 8818.2.4 ResumeResourceService 882This operation resumes processing of the previously stopped Resource Service operations. 8838.2.4.1 ResumeResourceServiceRequest

884 8858.2.4.2 ResumeResourceServiceResponse 886Note: The response is expected to be an empty successful return or a fault. The response below indicates that 887vendors may extend the response with additional information. 888

889 8908.2.5 ShutdownResourceService

8918.2.5.1 ShutdownResourceServiceRequest

892 8938.2.5.2 ShutdownResourceServiceResponse 894Note: The response is expected to be an empty successful return or a fault. The response below indicates that 895vendors may extend the response with additional information. 896

8998.2.6.1 StartupResourceServiceRequest

900 9018.2.6.2 StartupResourceServiceResponse 902Note: The response is expected to be an empty successful return or a fault. The response below indicates that 903vendors may extend the response with additional information. 904

9069 Conformance Requirements

907[TBD]

90810 PWG and IANA Registration Considerations

909[TBD]

91011 Internalization Considerations

911[TBD]

91212 Security Considerations

91313 References

914[TBD]

91513.1 Normative References

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

918[Others TBD]

92114 Author’s Address

922 Nancy Chen 923 Solutions and Technology 924 Oki Data 925 2000 Bishops Gate Blvd. 926 Mt. Laurel, NJ 08003 927 Phone: 856 222 7006 928 Fax: 856 222 5130 929 Email: [email protected] 930 931 Peter Zehler 932 Xerox Research Center Webster 933 Email: [email protected] 934 Voice: (585) 265-8755 935 FAX: (585) 265-7441 936 US Mail: Peter Zehler 937 Xerox Corp. 938 800 Phillips Rd. 939 M/S 128-25E 940 Webster NY, 14580-9701 941 942 Ira McDonald 943 High North Inc. 944 579 Park Place Saline, MI 48176 945 Phone: 734-944-0094 946 Email: [email protected] 947 948 949 950Additional contributors: (Still to be updated) 951 Lee Farrell - Canon 952 Mike Fenelon - Microsoft 953 Andrey Savov - Toshiba 954 Harry Lewis - IBM 955 Ira McDonald - High North, Inc. 956 Glen Petrie - Epson 957 Jerry Thrasher - Lexmark 958 David Whitehead - Lexmark 959 Craig Whittle - Sharp 960 961

96215 Change Log

963(To be removed in final version) 9646/04/2008 Initial draft created by Nancy Chen 965 966Participants: 967 968Shah Bhatti Samsung 969Ron Bergman Ricoh

193Copyright © 2007-2008, Printer Working Group. All rights reserved. Page 40 of 41 194 195MFD: Resource Service October 612, 2008 196 197 970Lee Farrell Canon 971Mike Fenelon Microsoft 972Harry Lewis InfoPrint 973Ira McDonald High North, Inc 974Joe Murdock Sharp Lab 975Glen Petrie Epson 976Ole Skov MPI Tech 977Jerry Thrasher Lexmark 978Randy Turner Konica Minolta 979Bill Wagner Konica Minolta 980David Whitehead Lexmark 981Craig Whittle Sharp Lab 982