DMTF Change Request

DMTF Confidential

All changes to be submitted by the Working Group Chair (or designee) after approval by the working group.  

The Change Request sample (http://www.dmtf.org/members/zdata/CRTemplateSample.html) contains more detailed information on how to complete the template.

 DMTF Change Request Number   [sysdevCR006655]

WIP-WSMAN-CR00007.001.htm

CR Owner Name, Email  [My Name, my.name@company.com]

Bryan Murray, bryan.murray@hp.com  

Errata   [Yes/No]

No  

Short Description

Enumeration total results hint

Spec, Document or Model(s) Being Changed   [Device Model]

wsman-baseline-00

Spec, Document or Model Version Incorporating the Change  [V2.9 Final]

 

Filename(s) Incorporating the Change [Device_USB.mof]

n/a

Date Originated  [mm/dd/yyyy]

12/07/2005

Date of Last Revision of the Change Request [mm/dd/yyyy]

12/21/2005

Dependencies   [smwgCR00567,sysdevCR00555]

n/a

Terminology

The terminology used in this CR should conform to the "Rules for the structure and drafting of International Standards", 5th Edition, 2005 available at:

http://isotc.iso.org/livelink/livelink.exe/fetch/2000/2122/3146825/4229629/4230450/4230456/ISO_IEC_Directives__Part_2__Rules_for_the_structure_and_drafting_of_International_Standards__2004__5th_edition___pdf_format_.pdf?nodeid=4230517&vernum=0

Particular attention shall be paid to Annex H which lays out guidelines for the expression of provisions.

Background/Rationale (Explanation of the background and reason(s) for the requested change, and supporting documentation):

There are many cases where the results of an enumeration may be used to drive a progress bar on an application. For instance, if some operation or update needs to be done to all members of an enumerable resource, it is desirable to be able to inform the operator how much progress has been made so far. In order to provide this information to an operator, it is necessary for the application to have an approximate total number of members returned in the wsen:EnumerateResponse message. Since the intent is to provide an indication that progress is being made, it is not necessary for the response to contain an exact number of enumeration members. It is also desirable to get updates on this estimated count in later wsen:PullResponse messages.

Requested Change (Change information such as details before/after the change, readable/indented MOF, and/or references to "Uploaded" MOF and other documents if the changes are too lengthy to include inline):

Page 56, just before section 5.2 add the following text:

In order to give applications an estimate of the number of items in an enumeration, two optional SOAP headers are defined; one to request an approximate count of items in an enumeration sequence, and another to return the requested estimate. These SOAP headers have defined behavior when used with the wsen:Enumerate and wsen:Pull messages and their responses. The SOAP headers are defined as follows:

(01)      <wsman:RequestTotalItemsCountEstimate/>
(02)      <wsman:TotalItemsCountEstimate>xs:nonNegativeInteger</wsman: TotalItemsCountEstimate >

The following describes additional, normative constraints on the outline listed above:

wsman:RequestTotalItemsCountEstimate

The presence of this element (no value is required) as a SOAP header on an wsen:Enumerate or wsen:Pull message indicates that the client is requesting that the associated response message should include an estimate of the total number of items in the enumeration sequence. This SOAP header does not have any meaning defined by this specification when included with any other messages.

wsman:TotalItemsCountEstimate

The presence of this element as a SOAP header on an wsen:EnumerateResponse or wsen:PullResponse message indicates the approximate number of items in the enumeration sequence. This is the total number of items and not the remaining number of items in the sequence. This SOAP header does not have any meaning defined by this specification when included with any other messages.

 

R5.1-7: A conformant service MAY support the ability to return an estimate of the number of items in an enumeration sequence. If a service receives an wsen:Enumerate or wsen:Pull message without the wsman:RequestTotalItemsCountEstimate SOAP header, the service MUST NOT return the wsman:TotalItemsCountEstimate SOAP header on the associated response message. When a service sends a result count estimate after a previous estimate for the same enumeration sequence, the most recent total results count estimate is considered as the more precise estimate.

 

 

Page 149, just before chapter 7 comment, add the following text:

<xs:element name=”RequestTotalItemsCountEstimate”/>
<xs:element name=”TotalItemsCountEstimate” type=”xs:nonNegativeInteger”/>

Discussion Points (Summary of decisions and discussions of the WG in creating this CR) :

 

Change History (Mandatory after submission to the TC, May be used by the WGs):

Version

Date 

Short description of changes

 0

 12/06/2005

Initial CR

 1

 12/21/2005

Incorporate feedback from Dec 2006 f2f

Note that this document is labeled as "DMTF Confidential".  It is intended only for DMTF member companies and alliance partners.  This Change Request may be withdrawn or modified by subsequent Change Requests.

All submissions MUST comply with the DMTF Patent and Technology policy (http://www.dmtf.org/about/policies/patent-10-18-01.pdf)

Template Sample Version 2.0.0c.