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] |
CIMCoreCR00930 |
|
CR Owner Name, Email [My Name, my.name@company.com] |
Richard Landau, Richard_Landau@dell.com |
|
|
Printer Working Group pwg.org |
|
|
|
|
|
n/a |
|
Errata [Yes/No] |
No |
|
Short Description |
Add new class CIM_PrintInputTray 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_PrintInputTray.mof |
|
Date Originated [mm/dd/yyyy] |
05/11/2007 |
|
Date of Last Revision of the Change Request [mm/dd/yyyy] |
05/11/2007 |
|
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:
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_PrintInputTray, is the second of several classes to be added.
(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_PrintInputTray
// Copyright (c) 2007 DMTF. All rights reserved.
// ==================================================================
// CIM_PrintInputTray
// ==================================================================
[Experimental, Version ( "2.16.0" ), Description (
"Subunit: Input tray on a printer (print device). Properties of "
"a device capable of providing media for input to the printing "
"process.") ,
UMLPackagePath ( "CIM::Device::Printing" ) ]
class CIM_PrintInputTray : 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;
[Required, Override ( "ElementName" ), Description (
"The user-friendly name for this instance of input tray. In "
"addition, the user-friendly name can be used as an index "
"property for a search or query. (Note: The name does not "
"have to be unique within a namespace.) This name shall be "
"generated as a factory default by the manufacturer and may "
"be changed out-of-band to a site-specific name by the "
"system administrator."),
MappingStrings { "MIB.IETF|Printer-MIB.prtInputName" },
ModelCorrespondence { "CIM_ManagedElement.ElementName" }]
string ElementName;
[Description (
"A unique value used by the printer to identify this input "
"tray subunit. Although these values may change due to a "
"major reconfiguration of the device (e.g., the addition of "
"new input tray 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.prtInputIndex" }]
uint32 SNMPRowId;
[Description (
"A free-form text description of this input tray subunit in "
"the localization specified by "
"CIM_Printer.CurrentNaturalLanguage."),
MinLen ( 0 ), MaxLen ( 255 ),
MappingStrings { "MIB.IETF|Printer-MIB.prtInputDescription",
"MIB.IETF|Printer-MIB.PrtLocalizedDescriptionStringTC" }]
string LocalizedDescription;
[Description (
"The type of technology (discriminated primarily according "
"to feeder mechanism type) employed by the input tray "
"subunit."),
ValueMap { "1", "2", "3", "4", "5", "6", "7", ".." },
Values { "Other", "Unknown", "SheetFeedAutoRemovableTray",
"SheetFeedAutoNonRemovableTray", "SheetFeedManual",
"ContinuousRoll", "ContinuousFanFold", "DMTF Reserved" },
MappingStrings { "MIB.IETF|Printer-MIB.prtInputType",
"MIB.IETF|IANA-PRINTER-MIB.PrtInputTypeTC" }]
uint32 Type;
[Description (
"A free-form string that describes the type of technology "
"when the value of the Type property is equal to 1 (Other)."),
MinLen ( 0 ), MaxLen ( 255 )]
string OtherTypeDescription;
[Description (
"The unit of measurement for use in calculating and relaying "
"capacity values for this input tray subunit."),
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|Printer-MIB.prtInputCapacityUnit",
"MIB.IETF|Printer-MIB.PrtCapacityUnitTC" }]
unit32 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 )]
string OtherCapacityUnit;
[Description (
"The basis for the limit property MaxCapacity, that "
"specifies whether a meaningful value is available. 1 "
"(Other) means the subunit places no restrictions on "
"capacity and MaxCapacity shall be null. 2 (Unknown) means "
"the subunit cannot sense a meaningful value and MaxCapacity "
"shall be null. 3 (Actual) means the subunit can sense a "
"meaningful value and MaxCapacity shall be present."),
ValueMap { "1", "2", "3", ".." },
Values { "Other", "Unknown", "Actual", "DMTF Reserved" },
MappingStrings { "MIB.IETF|Printer-MIB.prtInputMaxCapacity" }]
uint16 MaxCapacityBasis;
[Description (
"The maximum capacity of the input tray subunit in units "
"specified by CIM_PrintInputTray.CapacityUnit. There is no "
"convention associated with the media itself so this value "
"reflects claimed capacity. If this input tray subunit can "
"reliably sense this value, the value is sensed by the "
"printer 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|Printer-MIB.prtInputMaxCapacity",
"MIB.IETF|Printer-MIB.prtInputCapacityUnit",
"MIB.IETF|Printer-MIB.PrtCapacityUnitTC" }]
uint32 MaxCapacity;
[Description (
"The basis for the gauge property CurrentLevel, that "
"specifies whether a meaningful value is available. 1 "
"(Other) means the subunit places no restrictions on "
"capacity and CurrentLevel shall be null. 2 (Unknown) "
"means the subunit cannot sense a meaningful value and "
"CurrentLevel shall be null. 3 (Actual) means the "
"subunit can sense a meaningful value and CurrentLevel "
"shall be present. 4 (AtLeastOne) means that the subunit can "
"only sense that at least one capacity unit remains (i.e., "
"not empty) and CurrentLevel 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|Printer-MIB.prtOutputCurrentLevel" }]
uint16 CurrentLevelBasis;
[Description (
"The current level of the input tray subunit in units "
"specified by CIM_PrintInputTray.CapacityUnit. If this input "
"tray subunit can reliably sense this value, the value is "
"sensed by the "
"printer 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|Printer-MIB.prtInputCurrentLevel",
"MIB.IETF|Printer-MIB.prtInputCapacityUnit",
"MIB.IETF|Printer-MIB.PrtCapacityUnitTC" }]
uint32 CurrentLevel;
[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" }]
boolean NonCriticalAlertsStatus;
[Description (
"Status: If true, there are currently critical alerts on "
"this printer subunit."),
MappingStrings { "MIB.IETF|Printer-MIB.PrtSubUnitStatusTC" }]
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;
[Description (
"This property provides the value of the PWG standard or, "
"custom media size name of the media that is (or, if empty, "
"was or will be) in this input tray subunit. 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. If this "
"input tray subunit can reliably sense this value, the value "
"is sensed by the printer and cannot be changed by the "
"system administrator; otherwise, the value may be changed "
"out-of-band by the system administrator. The empty value "
"means unknown."),
MinLen ( 0 ), MaxLen ( 63 ),
MappingStrings { "PWG5101-1.PWG|Media Standardized Names",
"MIB.IETF|Printer-MIB.prtInputMediaDimFeedDirDeclared",
"MIB.IETF|Printer-MIB.prtInputMediaDimXFeedDirDeclared" }]
string MediaSizeName;
[Description (
"A description of the media contained in this input tray "
"subunit; this description is to be used by a client to "
"format and localize a string for display to a human "
"operator. This description is not processed by the printer. "
"It is used to provide information not expressible in terms "
"of the other media attributes (e.g., "
"CIM_PrintInputTray.MediaWeight and "
"CIM_PrintInputTray.MediaType)."),
MinLen ( 0 ), MaxLen ( 63 ),
MappingStrings { "MIB.IETF|Printer-MIB.prtInputMediaName" }]
string MediaName;
[Description (
"The basis for the media property MediaWeight, that "
"specifies whether a meaningful value is available. "
"2 (Unknown) means "
"the subunit cannot sense a meaningful value and MediaWeight "
"shall be null. 3 (Actual) means the subunit can sense a "
"meaningful value and MediaWeight shall be present."),
ValueMap { "2", "3", ".." },
Values { "Unknown", "Actual", "DMTF Reserved" },
MappingStrings { "MIB.IETF|Printer-MIB.prtInputMediaWeight" }]
uint16 MediaWeightBasis;
[Description (
"The weight of the medium associated with this input tray "
"subunit in grams per square meter."),
PUnit ( " gram / (meter * meter)" ),
MinValue ( 0 ), MaxValue ( 2147483647 ),
MappingStrings { "MIB.IETF|Printer-MIB.prtInputMediaWeight" }]
uint32 MediaWeight;
[Description (
"The name of the type of medium associated with this input "
"tray subunit. The values of this property should conform to "
"the requirements of the PWG Media Standardized Names "
"specification [PWG5101.1], which defines the normative "
"values for this property. This media type name need not be "
"processed by the printer; it might simply be displayed to "
"an operator."),
MinLen ( 0 ), MaxLen ( 63 ),
MappingStrings { "PWG5101-1.PWG|Media Standardized Names",
"MIB.IETF|Printer-MIB.prtInputfMediaType" }]
string MediaType;
[Description (
"The name of the color of the medium associated with this "
"input tray subunit. The values of this property should "
"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.prtInputMediaColor" }]
string MediaColor;
};
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 |
|
0.1 |
2007/05/10 |
Original version. |
|
0.2 |
2007/05/11 |
Fix CR number and date. |
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