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]

 CIMCoreCR00963

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

Errata   [Yes|No]

 No

Short Description

Add new class CIM_PrintFinisher 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_PrintFinisher.mof

Date Originated  [mm/dd/yyyy]

 07/13/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_PrintFinisher, is one of several classes to be added.  A PrintFinisher represents the portion of the printer that performs special processing on print media after the media has been marked, such as stapling, binding, bursting, folding, etc.  A finisher is often an optional add-on device, and therefore is not a required part of the Printer model.  A finisher is associated with a Printer, a PrintMediaPath, and a PrintOutputTray, and may be associated also with a PrintSupply, such as wire for stapling. 
 

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_PrintFinisher


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_PrintFinisher
// ==================================================================

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

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

      [Description (
          "Defines the type of finishing process associated with this "
          "PrintFinisher."), 
       ValueMap { "1", "2", "3", "4", "5", "6", "7", "8", "9", "10",
          "11", "12", "13", "14", "15", "16", "17", "18", ".." }, 
       Values { "Other", "Unknown", "Stitcher", "Folder", "Binder",
          "Trimmer", "DieCutter", "Puncher", "Perforater", "Slitter",
          "SeparationCutter", "Imprinter", "Wrapper", "Bander",
          "MakeEnvelope", "Stacker", "SheetRotator", "Inserter",
          "DMTF Reserved" }, 
       MappingStrings { "MIB.IETF|Finisher-MIB.finDeviceType",
          "MIB.IETF|IANA-PRINTER-MIB.PrtMarkerMarkTechTC" }, 
       ModelCorrespondence { "CIM_PrintFinisher.OtherTypeDescription" }]
   uint32 Type;

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

      [Description (
          "Denotes whether this PrintFinisher is present (configured) "
          "and whether the PrintFinisher is enabled."), 
       ValueMap { "1", "2", "3", "4", "5", ".." }, 
       Values { "Other", "Unknown", "On", "Off", "NotPresent",
          "DMTF Reserved" }, 
       MappingStrings { "MIB.IETF|Finisher-MIB.finDevicePresentOnOff",
          "MIB.IETF|Printer-MIB.PresentOnOff" }]
   uint32 PresentOnOff;

      [Description (
          "The unit of measure for specifying the capacity of this "
          "PrintFinisher."), 
       ValueMap { "1", "2", "3", "4", "8", "16", "17", "18", "19",
       ".." }, 
       Values { "Other", "Unknown", "TenThousandthsOfInches",
          "Micrometers", "Sheets", "Feet", "Meters", "Items",
          "Percent", "DMTF Reserved" }, 
       MappingStrings { "MIB.IETF|Finisher-MIB.finDeviceCapacityUnit",
          "MIB.IETF|Printer-MIB.PrtCapacityUnitTC" }, 
       ModelCorrespondence { "CIM_PrintFinisher.OtherCapacityUnit" }]
   uint32 CapacityUnit;

      [Description (
          "A free-form string that describes the capacity unit when "
          "the value of the CapacityUnit property is equal to 1 "
          "(Other)."), 
       MinLen ( 0 ), MaxLen ( 255 ), 
       ModelCorrespondence { "CIM_PrintFinisher.CapacityUnit" }]
   string OtherCapacityUnit;

      [Description (
          "The basis for the limit property MaxCapacity, that "
          "specifies whether a meaningful value is available. 1 "
          "(Other) means the PrintFinisher places no restrictions on "
          "capacity and MaxCapacity shall be null. 2 (Unknown) means "
          "the PrintFinisher cannot sense a meaningful value and "
          "MaxCapacity shall be null. 3 (Actual) means the "
          "PrintFinisher can sense a meaningful value and MaxCapacity "
          "shall be present."), 
       ValueMap { "1", "2", "3", ".." }, 
       Values { "Other", "Unknown", "Actual", "DMTF Reserved" }, 
       MappingStrings { "MIB.IETF|Finisher-MIB.finDeviceMaxCapacity" }, 
       ModelCorrespondence { "CIM_PrintFinisher.MaxCapacity" }]
   uint16 MaxCapacityBasis;

      [Description (
          "The maximum capacity of the PrintFinisher in units "
          "specified by CIM_PrintFinisher.CapacityUnit. If this "
          "PrintFinisher can reliably sense this value, the value is "
          "sensed by the PrintFinisher and cannot be changed by the "
          "system administrator; otherwise, the value may be changed "
          "out-of-band by the system administrator."), 
       MinValue ( 0 ), MaxValue ( 2147483647 ), 
       MappingStrings { "MIB.IETF|Finisher-MIB.finDeviceMaxCapacity",
          "MIB.IETF|Finisher-MIB.finDeviceCapacityUnit",
          "MIB.IETF|Printer-MIB.PrtCapacityUnitTC" }, 
       ModelCorrespondence { "CIM_PrintFinisher.MaxCapacityBasis" }]
   uint32 MaxCapacity;

      [Description (
          "The basis for the gauge property CurrentCapacity, that "
          "specifies whether a meaningful value is available. 1 "
          "(Other) means the PrintFinisher places no restrictions on "
          "capacity and CurrentCapacity shall be null. 2 (Unknown) "
          "means the PrintFinisher cannot sense a meaningful value and "
          "CurrentCapacity shall be null. 3 (Actual) means the "
          "PrintFinisher can sense a meaningful value and "
          "CurrentCapacity shall be present. 4 (AtLeastOne) means that "
          "the PrintFinisher can only sense that at least one capacity "
          "unit remains (i.e., not full) and CurrentCapacity shall be "
          "present and shall contain the value zero or one."), 
       ValueMap { "1", "2", "3", "4", ".." }, 
       Values { "Other", "Unknown", "Actual", "AtLeastOne",
          "DMTF Reserved" }, 
       MappingStrings { 
          "MIB.IETF|Finisher-MIB.finDeviceCurrentCapacity" }, 
       ModelCorrespondence { "CIM_PrintFinisher.CurrentCapacity" }]
   uint16 CurrentCapacityBasis;

      [Description (
          "The current capacity of the PrintFinisher in units "
          "specified by CIM_PrintFinisher.CapacityUnit. If this "
          "PrintFinisher can reliably sense this value, the value is "
          "sensed by the PrintFinisher and cannot be changed by the "
          "system administrator; otherwise, the value may be changed "
          "out-of-band by the system administrator."), 
       MinValue ( 0 ), MaxValue ( 2147483647 ), 
       MappingStrings { 
          "MIB.IETF|Finisher-MIB.finDeviceCurrentCapacity",
          "MIB.IETF|Finisher-MIB.finDeviceCapacityUnit",
          "MIB.IETF|Printer-MIB.PrtCapacityUnitTC" }, 
       ModelCorrespondence { "CIM_PrintFinisher.CurrentCapacityBasis" }]
   uint32 CurrentCapacity;

      [Description (
          "This property contains detailed availability information "
          "for this PrintFinisher, as follows: 1 (Other) means other "
          "detailed availability information is present in the "
          "OtherAvailabilityStatus property. 2 (Unknown) means "
          "detailed availability information for this PrintFinisher is "
          "unknown. 3 (AvailableIdle) means this PrintFinisher is "
          "available and idle, i.e., not currently in use. 4 "
          "(AvailableStandy) means this PrintFinisher is available but "
          "on standby, e.g., in a power saving mode. 5 "
          "(AvailableActive) means this PrintFinisher is available and "
          "active, i.e., currently in use. 6 (AvailableBusy) means "
          "this PrintFinisher is available but busy, i.e., not "
          "immediately available for its primary function. 7 "
          "(UnavailableOnRequest) means this PrintFinisher is not "
          "available and is on request, i.e., needs human "
          "intervention. 8 (UnavailableBroken) means this "
          "PrintFinisher 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_PrintFinisher.OtherAvailabilityStatus" }]
   uint32 AvailabilityStatus;

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

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

      [Description (
          "If true, there are currently critical alerts on this "
          "PrintFinisher."), 
       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.