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

 CIMCoreCR00962

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

 Richard Landau, Richard_Landau@dell.com
Alliance Partner submitting CR request (if applicable)
Printer Working Group pwg.org
Alliance Partner vote history
(e.g. SNIA XYZ Approved on 8/12/06)
Alliance Partner identifier/tracking number (if available)
CIMCoreCR_PrintMediaPath_02.htm

Errata   [Yes|No]

 No

Short Description

Add new class CIM_PrintMediaPath to enhanced printer device model.

Spec, Document or Model(s) Being Changed
[Application|Core|Database|Device|Event|Interop|
Network|Physical|Policy|Support|System|User ]

 Device

Spec, Document or Model Version Incorporating the Change  [2.16.0 Experimental | Final]

2.17 Experimental

Filename(s) Incorporating the Change
[Core/CIM_Container.mof, DSP0204.pdf]

CIM_PrintMediaPath.mof

Date Originated  [mm/dd/yyyy]

 06/29/2007

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

 07/13/2007

Dependencies   [CIMCoreCR00555,CIMCoreCR00600,...]

 CIMCoreCR00958

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

As part of the PWG/DMTF Work Register, PWG is updating the printing-related classes in the CIM data model.  

The PWG models for printing related devices and services include many properties that need to be managed but are not currently represented in CIM at all.  The CIM model will be extended to include these important management objects.  This will require extensions to the CIM_Printer class and the addition of other CIM classes to represent the capabilities, settings, and counters required.   

Many early implementers of this class are expected to be proxy providers for SNMP-capable printers.  A few properties in this class are included to permit software and users to correlate status and event information between CIM and legacy SNMP access paths.  It is expected that such properties will be deprecated when they are no longer needed for this purpose.

The current new class, CIM_PrintMediaPath, is one of several classes to be added.  A PrintMediaPath represents a particular path that the media (e.g., sheets of paper) take through the print engine.  Different media paths may print the media in portrait or landscape mode, print one side or both sides, and so forth. 
 

Alliance Partner Status (tracking number, other key identifiers,  supporting documentation, etc.):

n/a

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

//add the class CIM_PrintMediaPath


MOF Changes (The complete CIM Class (ASCII) using blue text for new, red text for removed and black text for no change, only one CIM Class can be changed per CR):
 
// Copyright (c) 2007 DMTF.  All rights reserved.
// ==================================================================
// CIM_PrintMediaPath
// ==================================================================

   [Experimental, Version ( "2.17.0" ),
       UMLPackagePath ( "CIM::Device::Printing" ), Description (
       "This class represents the PrintMediaPath component of a "
       "Printer (print device). It contains properties that describe "
       "the PrintMediaPath, including type, speed, and status. Note: A "
       "PrintMediaPath shall be associated with exactly one Printer "
       "via an instance of the PrinterComponent class. See: Model in "
       "section 2 of Printer MIB (RFC 3805)."), 
    MappingStrings { "MIB.IETF|Printer-MIB.prtMediaPathEntry" }]
class CIM_PrintMediaPath : CIM_PrinterElement {

      [Description (
          "Denotes whether or not this PrintMediaPath is the default "
          "PrintMediaPath for this Printer. If the default "
          "PrintMediaPath feature is not sPrintMediaPathupported for this Printer, "
          "then this property shall be null. If the default "
          "PrintMediaPath feature is supported for this Printer, then "
          "this property shall be true for at most one instance of "
          "CIM_PrintMediaPath on this Printer, i.e., the default may "
          "not be currently configured."), 
       MappingStrings { "MIB.IETF|Printer-MIB.prtMediaPathDefaultIndex" 
          }]
   boolean IsDefault;

      [Description (
          "A free-form text description of this PrintMediaPath "
          "PrintMediaPath in the localization specified by "
          "CIM_Printer.CurrentNaturalLanguage."), 
       MinLen ( 0 ), MaxLen ( 255 ), 
       MappingStrings { "MIB.IETF|Printer-MIB.prtMediaPathDescription",
          "MIB.IETF|Printer-MIB.PrtLocalizedDescriptionStringTC" }]
   string LocalizedDescription;

      [Description (
          "The type of this PrintMediaPath."), 
       ValueMap { "1", "2", "3", "4", "5", ".." }, 
       Values { "Other", "Unknown", "LongEdgeBindingDuplex",
          "ShortEdgeBindingDuplex", "Simplex", "DMTF Reserved" }, 
       MappingStrings { "MIB.IETF|Printer-MIB.prtMediaPathType",
          "MIB.IETF|IANA-PRINTER-MIB.PrtMediaPathTypeTC" }]
   uint32 Type;

      [Description (
          "A free-form string that describes the type of "
          "PrintMediaPath when the value of the Type property is equal "
          "to 1 (Other)."), 
       MinLen ( 0 ), MaxLen ( 255 )]
   string OtherTypeDescription;

      [Description (
          "The unit of measure used in specifying the speed of this "
          "PrintMediaPath."), 
       ValueMap { "3", "4", "5", "6", "7", "8", "9", "16", "17", ".." }, 
       Values { "TenThousandthsOfInchesPerHour", "MicrometersPerHour",
          "CharactersPerHour", "LinesPerHour", "ImpressionsPerHour",
          "SheetsPerHour", "DotRowPerHour", "FeetPerHour",
          "MetersPerHour", "DMTF Reserved" }, 
       MappingStrings { 
          "MIB.IETF|Printer-MIB.prtMediaPathMaxSpeedPrintUnit",
          "MIB.IETF|Printer-MIB.PrtMediaPathMaxSpeedPrintUnitTC" }]
   uint32 MaxSpeedUnit;

      [Description (
          "The basis for the limit property MaxSpeed, that specifies "
          "whether a meaningful value is available. 1 (Other) means "
          "the PrintMediaPath places no restrictions on speed and "
          "MaxSpeed shall be null. 2 (Unknown) means the "
          "PrintMediaPath does not have a meaningful value and "
          "MaxSpeed shall be null. 3 (Actual) means the PrintMediaPath "
          "does have a meaningful value and MaxSpeed shall be present."), 
       ValueMap { "1", "2", "3", ".." }, 
       Values { "Other", "Unknown", "Actual", "DMTF Reserved" }, 
       MappingStrings { "MIB.IETF|Printer-MIB.prtMediaPathMaxSpeed" }]
   uint16 MaxSpeedBasis;

      [Description (
          "The maximum printing speed of this PrintMediaPath."), 
       MinValue ( 0 ), MaxValue ( 2147483647 ), 
       MappingStrings { "MIB.IETF|Printer-MIB.prtMediaPathMaxSpeed",
          "MIB.IETF|Printer-MIB.prtMediaPathMaxSpeedPrintUnit",
          "MIB.IETF|Printer-MIB.PrtMediaPathMaxSpeedPrintUnitTC" }]
   uint32 MaxSpeed;

      [Description (
          "The basis for the limit property MaxMediaSizeName, that "
          "specifies whether a meaningful value is available. 1 "
          "(Other) means the PrintMediaPath places no restrictions on "
          "maximum size and MaxMediaSizeName shall be null. 2 "
          "(Unknown) means the PrintMediaPath does not have a "
          "meaningful value and MaxMediaSizeName shall be null. 3 "
          "(Actual) means the PrintMediaPath does have a meaningful "
          "value and MaxMediaSizeName shall be present."), 
       ValueMap { "1", "2", "3", ".." }, 
       Values { "Other", "Unknown", "Actual", "DMTF Reserved" }, 
       MappingStrings { 
          "MIB.IETF|Printer-MIB.prtMediaPathMaxMediaFeedDir",
          "MIB.IETF|Printer-MIB.prtMediaPathMaxMediaXFeedDir" }]
   uint16 MaxMediaSizeNameBasis;

      [Description (
          "This property provides the value of the PWG standard or, "
          "custom media size name of the media that is the maximum "
          "media size supported by this PrintMediaPath. The values of "
          "this property shall conform to the requirements of the PWG "
          "Media Standardized Names specification [PWG5101.1], which "
          "defines the normative values for this property."), 
       MinLen ( 0 ), MaxLen ( 63 ), 
       MappingStrings { "PWG5101-1.PWG|Media Standardized Names",
          "MIB.IETF|Printer-MIB.prtMediaPathMaxMediaFeedDir",
          "MIB.IETF|Printer-MIB.prtMediaPathMaxMediaXFeedDir" }]
   string MaxMediaSizeName;

      [Description (
          "The basis for the limit property MinMediaSizeName, that "
          "specifies whether a meaningful value is available. 1 "
          "(Other) means the PrintMediaPath places no restrictions on "
          "minimum size and MinMediaSizeName shall be null. 2 "
          "(Unknown) means the PrintMediaPath does not have a "
          "meaningful value and MinMediaSizeName shall be null. 3 "
          "(Actual) means the PrintMediaPath does have a meaningful "
          "value and MinMediaSizeName shall be present."), 
       ValueMap { "1", "2", "3", ".." }, 
       Values { "Other", "Unknown", "Actual", "DMTF Reserved" }, 
       MappingStrings { 
          "MIB.IETF|Printer-MIB.prtMediaPathMinMediaFeedDir",
          "MIB.IETF|Printer-MIB.prtMediaPathMinMediaXFeedDir" }]
   uint16 MinMediaSizeNameBasis;

      [Description (
          "This property provides the value of the PWG standard or, "
          "custom media size name of the media that is the maximum "
          "media size supported by this PrintMediaPath. The values of "
          "this property shall conform to the requirements of the PWG "
          "Media Standardized Names specification [PWG5101.1], which "
          "defines the normative values for this property."), 
       MinLen ( 0 ), MaxLen ( 63 ), 
       MappingStrings { "PWG5101-1.PWG|Media Standardized Names",
          "MIB.IETF|Printer-MIB.prtMediaPathMinMediaFeedDir",
          "MIB.IETF|Printer-MIB.prtMediaPathMinMediaXFeedDir" }]
   string MinMediaSizeName;

      [Description (
          "This property contains detailed availability information "
          "for this PrintMediaPath, as follows: 1 (Other) means other "
          "detailed availability information is present in the "
          "OtherAvailabilityStatus property. 2 (Unknown) means "
          "detailed availability information for this PrintMediaPath "
          "is unknown. 3 (AvailableIdle) means this PrintMediaPath is "
          "available and idle, i.e., not currently in use. 4 "
          "(AvailableStandy) means this PrintMediaPath is available "
          "but on standby, e.g., in a power saving mode. 5 "
          "(AvailableActive) means this PrintMediaPath is available "
          "and active, i.e., currently in use. 6 (AvailableBusy) means "
          "this PrintMediaPath is available but busy, i.e., not "
          "immediately available for its primary function. 7 "
          "(UnavailableOnRequest) means this PrintMediaPath is not "
          "available and is on request, i.e., needs human "
          "intervention. 8 (UnavailableBroken) means this "
          "PrintMediaPath is not available and is broken, e.g., needs "
          "repair/replacement."), 
       ValueMap { "1", "2", "3", "4", "5", "6", "7", "8", ".." }, 
       Values { "Other", "Unknown", "AvailableIdle",
          "AvailableStandby", "AvailableActive", "AvailableBusy",
          "UnavailableOnRequest", "UnavailableBroken",
       "DMTF Reserved" }, 
       MappingStrings { "MIB.IETF|Printer-MIB.PrtSubUnitStatusTC" }, 
       ModelCorrespondence { 
          "CIM_ManagedSystemElement.OperatingStatus",
          "CIM_PrintMediaPath.OtherAvailabilityStatus" }]
   uint32 AvailabilityStatus;

      [Description (
          "A free-form string that describes the detailed availability "
          "of this PrintMediaPath when the value of the "
          "AvailabilityStatus property is equal to 1 (Other)."), 
       MinLen ( 0 ), MaxLen ( 255 ), 
       ModelCorrespondence { "CIM_PrintMediaPath.AvailabilityStatus" }]
   string OtherAvailabilityStatus;

      [Description (
          "If true, there are currently non-critical alerts on this "
          "PrintMediaPath."), 
       MappingStrings { "MIB.IETF|Printer-MIB.PrtSubUnitStatusTC" }, 
       ModelCorrespondence { "CIM_ManagedSystemElement.DetailedStatus" 
          }]
   boolean NonCriticalAlertsPresent;

      [Description (
          "If true, there are currently critical alerts on this "
          "PrintMediaPath."), 
       MappingStrings { "MIB.IETF|Printer-MIB.PrtSubUnitStatusTC" }, 
       ModelCorrespondence { "CIM_ManagedSystemElement.DetailedStatus" 
          }]
   boolean CriticalAlertsPresent;
};

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

 00

2007/07/13

Original version.  
02
 2007/08/05
 New template.
03
 2007/08/10
 Fix color tags.
04
 2007/08/20
 Change Model from Core to Device.

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 Version 2.0.1b
Copyright (C) 2007 Distributed Management Task Force, Inc. (DMTF). All rights reserved.