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]	CIMCoreCR00901
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_PrintOutputTray 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_PrintOutputTray.mof
Date Originated [mm/dd/yyyy]	02/07/2007
Date of Last Revision of the Change Request [mm/dd/yyyy]	03/08/2007
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):

As part of the PWG/DMTF Work Register dated 2005/05/12, the Printer Working Group (PWG, see http://www.pwg.org/) is updating the printing-related classes in the CIM data model. PWG is submitting a series of Change Requests to update the CIM model to align with the current model developed in the PWG.

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. If these properties are to be visible to CIM-based management applications, then they must appear in the CIM model.

The current PWG printer device model, as embodied in the SNMP Printer MIB v2, RFC3805, contains many properties Some examples:

• Printer console displays and lights, and cover and other interlocks

• Printer input and output trays containing media

• Printer media paths that control the layout of page images on physical sheets

• Printer toners, colorants, and other supplies

• Printer communication channels and language interpreters

• Printer counters for pages and sheets printed in various operational modes

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.

The current new class, CIM_PrintOutputTray, is the first of several classes to be added.

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 new class CIM_PrintOutputTray as CIM_PrintOutputTray.mof

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

// CIM_PrintOutputTray

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

[Experimental, Version ( "2.16.0" ), Description (

"Subunit: Output tray on a printer (print device). Properties "

"of a device capable of receiving media delivered from the "

"printing process.") ,

UMLPackagePath ( "CIM::Device::Printing" )]

class CIM_PrintOutputTray : CIM_ManagedElement {

[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> must 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> must not "

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

"colon to appear in InstanceID must 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 must 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> must not "

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

"colon to appear in InstanceID must 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 must 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 "

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

string InstanceID;

[Required, Override ( "ElementName" ), Write, Description (

"The user-friendly name for this instance of output 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 to a site-specific name by the system "

"administrator."),

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

string ElementName;

[Description (

"A unique value used by this printer to identify this output "

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

"major reconfiguration of the subunit (e.g., the addition of "

"new output trays to the printer), values should remain "

"stable across successive printer power cycles."),

MinValue ( 1 ), MaxValue ( 65535 ),

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

uint32 Id;

[Description (

"The type of technology supported by this output tray "

"subunit."),

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

Values { "Other", "Unknown", "RemovableBin", "UnRemovableBin",

"ContinuousRollDevice", "MailBox", "ContinuousFanFold" },

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

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

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 OtherType;

[Description (

"The unit of measurement for use in calculating and relaying "

"capacity values for this output tray subunit."),

ValueMap { "1", "2", "3", "4", "8", "16", "17", "18", "19" },

Values { "Other", "Unknown", "TenThousandthsOfInches",

"Micrometers", "Sheets", "Feet", "Meters", "Items",

"Percent" },

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

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

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

string OtherCapacityUnit;

[Write, Description (

"The maximum capacity of this output tray subunit. There is "

"no convention associated with the media itself so this "

"value essentially reflects claimed capacity. If this output "

"tray subunit can reliably sense this value, the value is "

"sensed by the printer and shall not be changed by "

"management requests; otherwise, the value may be written "

"(by a Remote Control Panel or a Management Application). "

"The value (-1) means other and specifically indicates that "

"the subunit places no restrictions on this parameter. The "

"value (-2) means unknown."),

MinValue ( -2 ), MaxValue ( 2147483647 ),

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

"MIB.IETF|Printer-MIB.prtOutputCapacityUnit",

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

sint32 MaxCapacity;

[Write, Description (

"The remaining capacity of this output tray subunit. If this "

"output tray subunit can reliably sense this value, the "

"value is sensed by the printer and shall not be modified by "

"management requests; otherwise, the value may be written "

"(by a Remote Control Panel or a Management Application). "

"The value (-1) means other and specifically indicates that "

"the subunit places no restrictions on this parameter. The "

"value (-2) means unknown. The value (-3) means that the "

"printer knows that there remains capacity for at least one "

"unit."),

MinValue ( -3 ), MaxValue ( 2147483647 ),

MappingStrings {

"MIB.IETF|Printer-MIB.prtOutputRemainingCapacity",

"MIB.IETF|Printer-MIB.prtOutputCapacityUnit",

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

sint32 RemainingCapacity;

[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" },