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]

 CIMCoreCR00945

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)

n/a

Errata   [Yes/No]

 No

Short Description

Add new class  CIM_PrintMarker to enhanced printer device model.

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

 [Core Model]

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

 V2.16 Experimental

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

CIM_PrintMarker.mof

Date Originated  [mm/dd/yyyy]

 05/31/2007

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

 

Dependencies   [smwgCR00567,sysdevCR00555]

 

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_PrintMarker, is the third of several classes to be added.  A PrintMarker represents the portion of the printer that places marks on media.  It is possible for a printer to have more than one marker.  However, a typical color printer, for instance, has one marker with several supplies for its several colorants.  

 

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

(insert text here)

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

 

//add the class CIM_PrintMarker

 

// Copyright (c) 2007 DMTF.  All rights reserved.

// ==================================================================

// CIM_PrintMarker

// ==================================================================

 

   [Experimental, Version ( "2.16.0" ),

       UMLPackagePath ( "CIM::Device::Printing" ), Description (

       "This class represents the marker subunit of a printer (print "

       "device). It contains properties that describe the marker "

       "technology, capabilities, and status.")]

class CIM_PrintMarker : CIM_LogicalElement {

 

      [Key, Description (

          "Within the scope of the instantiating Namespace, InstanceID "

          "opaquely and uniquely identifies an instance of this class. "

          "To ensure uniqueness within the NameSpace, the value of "

          "InstanceID should be constructed using the following "

          "\"preferred\" algorithm: \n"

          "<OrgID>:<LocalID> \n"

          "Where <OrgID> and <LocalID> are separated by a colon (:), "

          "and where <OrgID> shall include a copyrighted, trademarked, "

          "or otherwise unique name that is owned by the business "

          "entity that is creating or defining the InstanceID or that "

          "is a registered ID assigned to the business entity by a "

          "recognized global authority. (This requirement is similar "

          "to the <Schema Name>_<Class Name> structure of Schema class "

          "names.) In addition, to ensure uniqueness, <OrgID> shall "

          "not contain a colon (:). When using this algorithm, the "

          "first colon to appear in InstanceID shall appear between "

          "<OrgID> and <LocalID>. \n"

          "<LocalID> is chosen by the business entity and should not "

          "be reused to identify different underlying (real-world) "

          "elements. If the above \"preferred\" algorithm is not used, "

          "the defining entity shall assure that the resulting "

          "InstanceID is not reused across any InstanceIDs produced by "

          "this or other providers for the NameSpace of this instance. "

          "\nFor DMTF-defined instances, the \"preferred\" algorithm "

          "entity that is creating or defining the InstanceID or that "

          "is a registered ID assigned to the business entity by a "

          "recognized global authority. (This requirement is similar "

          "to the <Schema Name>_<Class Name> structure of Schema class "

          "names.) In addition, to ensure uniqueness, <OrgID> shall "

          "not contain a colon (:). When using this algorithm, the "

          "first colon to appear in InstanceID shall appear between "

          "<OrgID> and <LocalID>. \n"

          "<LocalID> is chosen by the business entity and should not "

          "be reused to identify different underlying (real-world) "

          "elements. If the above \"preferred\" algorithm is not used, "

          "the defining entity shall assure that the resulting "

          "InstanceID is not reused across any InstanceIDs produced by "

          "this or other providers for the NameSpace of this instance. "

          "\nFor DMTF-defined instances, the \"preferred\" algorithm "

          "shall be used with the <OrgID> set to CIM.")]

   string InstanceID;

 

      [Key, Description (

          "A unique value used by the printer to identify this marker "

          "subunit. Although these values may change due to a major "

          "reconfiguration of the device (e.g., the addition of new "

          "marker subunits to the printer), values should remain "

          "stable across successive printer power cycles. Note: This "

          "property is necessary to correlate status and event (alert) "

          "information between CIM and SNMP interfaces."),

       MinValue ( 1 ), MaxValue ( 65535 ),

       MappingStrings { "MIB.IETF|Printer-MIB.prtMarkerIndex" }]

   uint32 SNMPRowId;

 

      [Description (

          "Denotes whether or not this marker is the default marker "

          "for this printer."),

       MappingStrings { "MIB.IETF|Printer-MIB.prtMarkerDefaultIndex" }]

   boolean IsDefault;

 

      [Description (

          "The type of marking technology used for this marker "

          "subunit."),

       ValueMap { "1", "2", "3", "4", "5", "6", "7", "8", "9", "10",

          "11", "12", "13", "14", "15", "16", "17", "18", "19", "20",

          "21", "22", "23", "24", "25", "26", "27", ".." },

       Values { "Other", "Unknown", "ElectrophotographicLED",

          "ElectrophotographicLaser", "ElectrophotographicOther",

          "ImpactMovingHeadDotMatrix9pin",

          "ImpactMovingHeadDotMatrix24pin",

          "ImpactMovingHeadDotMatrixOther",

          "ImpactMovingHeadFullyFormed", "ImpactBand", "ImpactOther",

          "InkjetAqueous", "InkjetSolid", "InkjetOther", "Pen",

          "ThermalTransfer", "ThermalSensitive", "ThermalDiffusion",

          "ThermalOther", "Electroerosion", "Electrostatic",

          "PhotographicMicrofiche", "PhotographicImagesetter",

          "PhotographicOther", "IonDeposition", "EBeam", "Typesetter",

          "DMTF Reserved" },

       MappingStrings { "MIB.IETF|Printer-MIB.prtMarkerMarkTech",

          "MIB.IETF|IANA-PRINTER-MIB.PrtMarkerMarkTechTC" }]

   uint32 MarkTech;

 

      [Description (

          "A free-form string that describes the type of technology "

          "when the value of the MarkTech property is equal to 1, 5, "

          "11, 14, 19, or 24 (Other, ElectrophotographicOther, "

          "ImpactMovingHeadDotMatrixOther, ImpactOther, InkjetOther, "

          "ThermalOther, or PhotographicOther)."),

       MinLen ( 0 ), MaxLen ( 255 )]

   string OtherMarkTechDescription;

 

      [Description (

          "The unit that will be used by the printer when reporting "

          "counter values for this marker subunit. The time units of "

          "measure are provided for a device like a strip recorder "

          "that does not or cannot track the physical dimensions of "

          "the media and does not use characters, lines or sheets."),

       ValueMap { "3", "4", "5", "6", "7", "8", "9", "11", "16", "17",

          ".." },

       Values { "TenThousandthsOfInches", "Micrometers", "Characters",

          "Lines", "Impressions", "Sheets", "DotRow", "Hours", "Feet",

          "Meters", "DMTF Reserved" },

       MappingStrings { "MIB.IETF|Printer-MIB.prtMarkerCounterUnit",

          "MIB.IETF|Printer-MIB.PrtMarkerCounterUnitTC" }]

   uint32 CounterUnit;

 

      [Description (

          "The count of marker usage during the life of the printer "

          "using units of measure as specified by "

          "CIM_PrintMarker.CounterUnit."),

       MappingStrings { "MIB.IETF|Printer-MIB.prtMarkerLifeCount",

          "MIB.IETF|Printer-MIB.PrtMarkerCounterUnitTC" }]

   uint32 LifeCount;

 

      [Description (

          "The count of marker usage since the equipment was most "

          "recently powered on using units of measure as specified by "

          "CIM_PrintMarker.CounterUnit."),

       MappingStrings { "MIB.IETF|Printer-MIB.prtMarkerPowerOnCount",

          "MIB.IETF|Printer-MIB.PrtMarkerCounterUnitTC" }]

   uint32 PowerOnCount;

 

      [Description (

          "The number of process colors supported by this marker. A "

          "process color of 1 implies monochrome. The value of this "

          "property and CIM_PrintMarker.SpotColorants cannot both be "

          "0. The value of this property shall be 0 or greater."),

       MinValue ( 0 ), MaxValue ( 65535 ),

       MappingStrings {

          "MIB.IETF|Printer-MIB.prtMarkerProcessColorants" }]

   uint32 ProcessColorants;

 

      [Description (

          "The number of spot colors supported by this marker. The "

          "value of this property and CIMPrintMarker.ProcessColorants "

          "cannot both be 0. The value of this property shall be 0 or "

          "greater."),

       MinValue ( 0 ), MaxValue ( 65535 ),

       MappingStrings { "MIB.IETF|Printer-MIB.prtMarkerSpotColorants" }]

   uint32 SpotColorants;

 

      [Description (

          "Status: Assessment of the availability of this printer "

          "subunit."),

       ValueMap { "1", "2", "3", "4", "5", "6", "7", ".." },

       Values { "Unknown", "AvailableIdle", "AvailableStandby",

          "AvailableActive", "AvailableBusy", "UnavailableOnRequest",

          "UnavailableBroken", "DMTF Reserved" },

       MappingStrings { "MIB.IETF|Printer-MIB.PrtSubUnitStatusTC" },

       ModelCorrespondence { "CIM_ManagedSystemElement.OperatingStatus"

          }]

   uint32 AvailabilityStatus;

 

      [Description (

          "Status: If true, there are currently non-critical alerts on "

          "this printer subunit."),

       MappingStrings { "MIB.IETF|Printer-MIB.PrtSubUnitStatusTC" },

       ModelCorrespondence { "CIM_ManagedSystemElement.DetailedStatus"

          }]

   boolean NonCriticalAlertsStatus;

 

      [Description (

          "Status: If true, there are currently critical alerts on "

          "this printer subunit."),

       MappingStrings { "MIB.IETF|Printer-MIB.PrtSubUnitStatusTC" },

       ModelCorrespondence { "CIM_ManagedSystemElement.DetailedStatus"

          }]

   boolean CriticalAlertsStatus;

 

      [Description (

          "Status: If true, the current state is offline on this "

          "printer subunit."),

       MappingStrings { "MIB.IETF|Printer-MIB.PrtSubUnitStatusTC" },

       ModelCorrespondence { "CIM_ManagedSystemElement.OperatingStatus"

          }]

   boolean OfflineStatus;

};

 

// end of class 

 

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

(insert text here)

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

Version

Date 

Short description of changes

 00

 2007/05/31

Original version

 01

 2007/05/31

Correct CR number.

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