Class CIM_PrintJob
extends CIM_Job

Description of a print request that is either waiting on a Queue for a Printer to become available or in the process of being output on a Printer, or that has previously been printed on a Printer. PrintJobs are weak to their current Queue, or to the last Queue that held them. The ABNF for CIM references to PWG Standards and MIBs is in the directory 'ftp://ftp.pwg.org/pub/pwg/general/process' in the file 'pwg-cim-references-format-20060309.txt'. An example for a MappingStrings reference to a PWG Standard is 'PWG5101-1.PWG|Section 4 Media Color Names'. An example for a MappingStrings reference to a PWG MIB is 'MIB.PWG|PWG-IMAGING-COUNTER-MIB.icMonitorCompletedJobs'.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

Name	Data Type	Value
Description	string	Description of a print request that is either waiting on a Queue for a Printer to become available or in the process of being output on a Printer, or that has previously been printed on a Printer. PrintJobs are weak to their current Queue, or to the last Queue that held them. The ABNF for CIM references to PWG Standards and MIBs is in the directory 'ftp://ftp.pwg.org/pub/pwg/general/process' in the file 'pwg-cim-references-format-20060309.txt'. An example for a MappingStrings reference to a PWG Standard is 'PWG5101-1.PWG\|Section 4 Media Color Names'. An example for a MappingStrings reference to a PWG MIB is 'MIB.PWG\|PWG-IMAGING-COUNTER-MIB.icMonitorCompletedJobs'.
UMLPackagePath	string	CIM::Device::Printing
Version	string	2.29.0

Class Properties

Local Class Properties

Name	Data Type	Default Value	Qualifiers
Name	Data Type	Default Value	Name	Data Type	Value
CharSet	string
			Description	string	Specifies the character set and encoding method that should be used by the Printer for the management of this Job. The strings should conform to the semantics and syntax that are specified by section 4.1.2 'Charset parameter' in RFC 2046 (MIME Part 2) and contained in the IANA character-set registry. Examples include 'utf-8', 'us-ascii', and 'iso-8859-1'.
			MappingStrings	string	MIB.IETF\|Job-Monitoring-MIB.jobCodedCharSet, MIB.IETF\|IANA-CHARSET-MIB.IANACharset, RFC2911.IETF\|Job.attributes-charset
			ModelCorrespondence	string	CIM_Printer.CharSetsSupported, CIM_PrintServiceCapabilities.Charset
Copies	uint32
			Description	string	The number of physical copies of the output that will be produced from this Job.
			MappingStrings	string	MIB.IETF\|Job-Monitoring-MIB.jobCopiesRequested, RFC2911.IETF\|Job.copies
			ModelCorrespondence	string	CIM_Printer.MaxCopies, CIM_PrintServiceCapabilities.Copies, CIM_PrintServiceSettings.Copies
ElapsedTime	datetime
			Description	string	The processing elapsed time of this instance of PrintJob, after the Job has completed. Note: This property is NOT meaningful before PrintJob completion.
			MappingStrings	string	RFC2911.IETF\|Section 4.3.14.3 time-at-completed, RFC2911.IETF\|Section 4.3.14.7 date-time-at-completed
			ModelCorrespondence	string	CIM_PrintJob.TimeCompleted
			Override	string	ElapsedTime
ElementName	string
			Description	string	The user-friendly name for this instance of PrintJob. 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 supplied by the client or generated by the PrintService (if missing in job creation operation).
			MappingStrings	string	RFC2911.IETF\|Section 4.3.5 job-name
			Override	string	ElementName
			Required	boolean	true
HorizontalResolution	uint32
			Description	string	The resolution of the in Pixels per Inch for the Job in the cross-feed direction, i.e., short-edge in portrait feed mode.
			MappingStrings	string	MIB.IETF\|Job-Monitoring-MIB.printerResolutionRequested, RFC2911.IETF\|Job.printer-resolution
			ModelCorrespondence	string	CIM_Printer.HorizontalResolution, CIM_PrintServiceCapabilities.Resolution, CIM_PrintServiceSettings.Resolution
			PUnit	string	pixel / inch
			Units	string	Pixels per Inch
JobID	string
			Description	string	Uniquely identifies this Job within its scoping Queue, but NOT across different Queues or PrintServices.
			Key	boolean	true
			MappingStrings	string	MIB.IETF\|Job-Monitoring-MIB.jmJobIndex, MIB.IETF\|Job-Monitoring-MIB.jmJobSubmissionID, RFC2911.IETF\|Job.job-id
JobOrigination	string
			Description	string	Provides additional information, beyond Job Owner that is inherited from CIM_Job, to identify the origins of the PrintJob. This property could include information such as the System, Application, or Process that created the Job.
			MappingStrings	string	MIB.IETF\|Job-Monitoring-MIB.jobOriginatingHost, MIB.IETF\|Job-Monitoring-MIB.submittingServerName, MIB.IETF\|Job-Monitoring-MIB.submittingApplicationName, RFC2911.IETF\|Job.job-originating-user-name
JobSize	uint32
			Description	string	Specifies the size of the PrintJob (as a byte stream) in units of Kbytes.
			MappingStrings	string	MIB.IETF\|Job-Monitoring-MIB.jmJobKOctetsProcessed, RFC2911.IETF\|Job.job-k-octets
			ModelCorrespondence	string	CIM_Printer.MaxSizeSupported, CIM_PrintServiceCapabilities.MaxJobSize, CIM_PrintQueue.MaxJobSize
			PUnit	string	byte * 10^3
			Units	string	KiloBytes
JobStatus	string
			Description	string	The inherited JobStatus is used to provide additional information about the status of a PrintJob beyond that enumerated by PrintJobStatus.
			MappingStrings	string	MIB.IETF\|Job-Monitoring-MIB.jmJobState, MIB.IETF\|Job-Monitoring-MIB.jmJobStateReasons1, RFC2911.IETF\|Job.job-state, RFC2911.IETF\|Job.job-state-reasons, RFC2911.IETF\|Job.job-state-message
			ModelCorrespondence	string	CIM_PrintJob.PrintJobStatus
			Override	string	JobStatus
Language	uint16
			Deprecated	string	CIM_PrintJob.MimeTypes
			Description	string	Note: The use of this property has been deprecated, due to ambiguity. Instead use MimeTypes. Enumerated print languages are only available in the IETF Printer MIB v1/v2 (RFC 1759/3805) and are not available in open standard print protocols (i.e., no known mapping). Deprecated description: Specifies the print language that is used by this Job. Note: For legacy compatiblity reasons, this property is NOT exactly aligned (in order of values) with the authoritative PrtInterpreterLangFamilyTC in the IANA Printer MIB, unlike the newer property PrintInterpreter.LangType (which is exactly aligned with the IANA Printer MIB).
			MappingStrings	string	MIB.IETF\|Printer-MIB.prtInterpreterLangFamily, MIB.IETF\|IANA-PRINTER-MIB.PrtInterpreterLangFamilyTC, MIB.IETF\|Job-Monitoring-MIB.documentFormat, PWG5100-7.PWG\|Job.document-format-supplied
			ModelCorrespondence	string	CIM_Printer.LanguagesSupported, CIM_PrintService.LanguagesSupported, CIM_PrintJob.MimeTypes
			ValueMap	string	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, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, ..
			Values	string	Other, Unknown, PCL, HPGL, PJL, PS, PSPrinter, IPDS, PPDS, EscapeP, Epson, DDIF, Interpress, ISO6429, Line Data, MODCA, REGIS, SCS, SPDL, TEK4014, PDS, IGP, CodeV, DSCDSE, WPS, LN03, CCITT, QUIC, CPAP, DecPPL, Simple Text, NPAP, DOC, imPress, Pinwriter, NPDL, NEC201PL, Automatic, Pages, LIPS, TIFF, Diagnostic, CaPSL, EXCL, LCDS, XES, MIME, TIPSI, Prescribe, LinePrinter, IDP, XJCL, PDF, RPDL, IntermecIPL, UBIFingerprint, UBIDirectProtocol, Fujitsu, PCLXL, ART, CGM, JPEG, CALS1, CALS2, NIRS, C4, XPS, OpenXPS, DMTF Reserved
NaturalLanguage	string
			Description	string	Identifies the language that should be used by the Printer for the management of this Job. The specified value should conform to RFC 5646. For example, 'en' is used for English.
			MappingStrings	string	MIB.IETF\|Job-Monitoring-MIB.jobNaturalLanguageTag, RFC2911.IETF\|Job.attributes-natural-language
			ModelCorrespondence	string	CIM_Printer.NaturalLanguagesSupported, CIM_PrintServiceCapabilities.NaturalLanguage
NumberUp	uint32
			Description	string	The number of print-stream pages that should be rendered onto a single media sheet when the Printer outputs this PrintJob.
			MappingStrings	string	RFC2911.IETF\|Job.number-up
			ModelCorrespondence	string	CIM_Printer.MaxNumberUp, CIM_PrintServiceCapabilities.NumberUp, CIM_PrintServiceSettings.NumberUp
PrintJobStatus	uint16
			Description	string	Describes the current state of this Job with respect to the PrintQueue and the Printer. Additional information can be specified in JobStatus. 1 (Other) means this Job is in some non-standard state. 2 (Unknown) means this Job is in an unknown state. 3 (Pending) maps to IPP job-state 'pending'. 4 (Blocked) maps to IPP job-state 'pending-held'. 5 (Completed) maps to IPP job-state 'completed'. 6 (Completed With Error) maps to IPP job-state 'completed' in combination with IPP job-state-reasons 'completed-with-errors'. 7 (Printing) maps to IPP job-state 'processing'. 8 (Processing Stopped) maps to IPP job-state 'processing-stopped'. 9 (Canceled) maps to IPP job-state 'canceled'. 10 (Aborted) maps to IPP job-state 'aborted'.
			MappingStrings	string	MIB.IETF\|Job-Monitoring-MIB.jmJobState, RFC2911.IETF\|Job.job-state
			ModelCorrespondence	string	CIM_PrintJob.TimeCompleted, CIM_PrintJob.JobStatus
			ValueMap	string	1, 2, 3, 4, 5, 6, 7, 8, 9, 10
			Values	string	Other, Unknown, Pending, Blocked, Complete, Completed With Error, Printing, Processing Stopped, Canceled, Aborted
QueueCreationClassName	string
			Description	string	The CreationClassName of the scoping Queue.
			Key	boolean	true
			MaxLen	uint32	256
			Propagated	string	CIM_PrintQueue.CreationClassName
QueueName	string
			Description	string	The Name of the scoping Queue.
			Key	boolean	true
			MappingStrings	string	MIB.IETF\|Job-Monitoring-MIB.jmGeneralJobSetName, MIB.IETF\|Job-Monitoring-MIB.queueNameRequested, RFC2911.IETF\|Job.output-device-assigned
			MaxLen	uint32	256
			Propagated	string	CIM_PrintQueue.Name
RequiredPaperType	string
			Description	string	A string that specifies the type of paper that is required by this PrintJob. The values of the property SHOULD conform to the requirements of the PWG Media Standardized Names specification [PWG5101.1], which defines the normative values for this property. See older Appendix B 'Media Size Names' and Appendix C 'Media Names' of IETF Printer MIB v2 [RFC3805] which list the values of standardized media names defined in ISO DPA [ISO10175].
			MappingStrings	string	PWG5101-1.PWG\|Media Standardized Names, MIB.IETF\|Job-Monitoring-MIB.mediumRequested, RFC2911.IETF\|Job.media
			ModelCorrespondence	string	CIM_Printer.PaperTypesAvailable, CIM_PrintServiceSettings.Media, CIM_PrintService.PaperTypesAvailable
SchedulingInformation	string
			Deprecated	string	No Value
			Description	string	Note: The use of this free-form string property is deprecated in lieu of the more semantically rich CIM_JobSettingData class inherited from CIM_Job.
StartTime	datetime
			Description	string	The processing start time of this instance of PrintJob.
			MappingStrings	string	RFC2911.IETF\|Section 4.3.14.2 time-at-processing, RFC2911.IETF\|Section 4.3.14.6 date-time-at-processing
			Override	string	StartTime
SystemCreationClassName	string
			Description	string	The CreationClassName of the scoping System.
			Key	boolean	true
			MaxLen	uint32	256
			Propagated	string	CIM_PrintQueue.SystemCreationClassName
SystemName	string
			Description	string	The Name of the scoping System.
			Key	boolean	true
			MappingStrings	string	MIB.IETF\|SNMPv2-MIB.sysName
			MaxLen	uint32	256
			Propagated	string	CIM_PrintQueue.SystemName
TimeCompleted	datetime
			Description	string	The time when this Job was completed. This value is valid only if the PrintJobStatus has been assigned to 'Complete' or 'Completed With Error'.
			MappingStrings	string	MIB.IETF\|Job-Monitoring-MIB.jobCompletionTime, RFC2911.IETF\|Job.date-time-at-completed
			ModelCorrespondence	string	CIM_PrintJob.PrintJobStatus
TimeSubmitted	datetime
			Description	string	The creation time of this instance of PrintJob.
			MappingStrings	string	RFC2911.IETF\|Section 4.3.14.1 time-at-creation, RFC2911.IETF\|Section 4.3.14.5 date-time-at-creation
			Override	string	TimeSubmitted
VerticalResolution	uint32
			Description	string	The resolution in Pixels per Inch for the Job in the feed direction, i.e., long-edge in portrait feed mode.
			MappingStrings	string	MIB.IETF\|Job-Monitoring-MIB.printerResolutionRequested, RFC2911.IETF\|Job.printer-resolution
			ModelCorrespondence	string	CIM_Printer.VerticalResolution, CIM_PrintServiceCapabilities.Resolution, CIM_PrintServiceSettings.Resolution
			PUnit	string	pixel / inch
			Units	string	Pixels per Inch
Finishing	uint16[]
			ArrayType	string	Indexed
			Description	string	Note: The use of this property will been deprecated due to ambiguity in a future version. Instead use the experimental property Finishings. Enumerated finishings are not available in open standard print protocols (i.e., no known mapping). Deprecated description: An array of integers that indicates the type of finishing that is required by this Job. It is equivalent to the Capabilities property that is provided by the Printer.
			ModelCorrespondence	string	CIM_Printer.Capabilities, CIM_PrintService.Capabilities
			ValueMap	string	0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21
			Values	string	Unknown, Other, Color Printing, Duplex Printing, Copies, Collation, Stapling, Transparency Printing, Punch, Cover, Bind, Black and White Printing, One Sided, Two Sided Long Edge, Two Sided Short Edge, Portrait, Landscape, Reverse Portrait, Reverse Landscape, Quality High, Quality Normal, Quality Low
MimeTypes	string[]
			Description	string	Specifies the MIME types that are used by the PrintJob.
			ModelCorrespondence	string	CIM_PrintJob.Language, CIM_Printer.MimeTypesSupported, CIM_PrintServiceSettings.DocumentFormat, CIM_PrintService.MimeTypesSupported
RequiredJobSheets	string[]
			Description	string	Describes the job sheets that should be used when this Job is output on the Printer. Complete standard values are in the IANA IPP Registry. Additional vendor or site values may also be used. Standard values defined in IPP/1.1 (RFC 2911) include: Value 'none' indicates no job start/end sheets. Value 'standard' indicates one or more site-specific standard job sheets.
			MappingStrings	string	RFC2911.IETF\|Job.job-sheets
			ModelCorrespondence	string	CIM_Printer.AvailableJobSheets, CIM_PrintServiceCapabilities.JobSheets, CIM_PrintServiceSettings.JobSheets

Inherited Properties

Name	Data Type	Class Origin
Caption	string	CIM_ManagedElement
CommunicationStatus	uint16	CIM_ManagedSystemElement
DeleteOnCompletion	boolean	CIM_Job
Description	string	CIM_ManagedElement
DetailedStatus	uint16	CIM_ManagedSystemElement
ErrorCode	uint16	CIM_Job
ErrorDescription	string	CIM_Job
HealthState	uint16	CIM_ManagedSystemElement
InstallDate	datetime	CIM_ManagedSystemElement
InstanceID	string	CIM_ManagedElement
JobRunTimes	uint32	CIM_Job
LocalOrUtcTime	uint16	CIM_Job
Name	string	CIM_ManagedSystemElement
Notify	string	CIM_Job
OperatingStatus	uint16	CIM_ManagedSystemElement
OtherRecoveryAction	string	CIM_Job
Owner	string	CIM_Job
PercentComplete	uint16	CIM_Job
PrimaryStatus	uint16	CIM_ManagedSystemElement
Priority	uint32	CIM_Job
RecoveryAction	uint16	CIM_Job
RunDay	sint8	CIM_Job
RunDayOfWeek	sint8	CIM_Job
RunMonth	uint8	CIM_Job
RunStartInterval	datetime	CIM_Job
ScheduledStartTime	datetime	CIM_Job
Status	string	CIM_ManagedSystemElement
UntilTime	datetime	CIM_Job
OperationalStatus	uint16[]	CIM_ManagedSystemElement
StatusDescriptions	string[]	CIM_ManagedSystemElement

Class Methods

Inherited Class Methods

Name	Return Type	Class Origin
KillJob	uint32	CIM_Job

Class CIM_PrintJobextends CIM_Job

Table of Contents Hierarchy Direct Known Subclasses Class Qualifiers Class Properties Class Methods

Class Hierarchy

Direct Known Subclasses