Attributes

introduction

Here are some readable attributes and their values, as described in RFC 2911.

Warning

attributes names returned by print-ipp are written with underscores and not with dashes (which are interpreted like minus operation by PHP).

eg: 'printer-uri' will be written 'printer_uri'.

This rewriting do not affects attributes data

common attributes

attributes-charset

(charset)

in which charset is returned the response

attributes-natural-language

(naturalLanguage)

in which language is returned the response

Job Attributes

Job description attributes

job-uri

(uri) Uniform Resource Identifier of the job
this attribute defined job unique identification and can be used in cancelJob, getJobAttributes, holdJob, releaseJob, restartJob and setJobAttributes operations.

job-id

(integer(1:MAX))
id nbr of the job

job-printer-uri

(uri)
which Printer object has created the Job object

job-more-info

(uri)
self-explanatory

job-name

(name(MAX))
self-explanatory

job-originating-user-name

(name(MAX))
who created the job

job-state

(type1 enum)

job's current state

job-state-reasons

(1set Of type2 keyword)
self-explanatory

job-state-message

(text(MAX))
self-explanatory

job-detailed-status-messages

(1set Of text(MAX))
self-explanatory

job-document-access-errors

(1set Of text(MAX))
especially for printUri operation, returns error code of given protocol and document uri,
eg: (404) http://www.foobar.com/mydocument.ps
[ encountered a 404 http error (document not found) ]

number-of-documents

(integer(0:MAX))
self-explanatory

output-device-assigned

(name(127))
Useful when a printer objects support multiple devices (fan-out).

Event Time Job Description Attributes

time-at-creation

(integer(MIN:MAX))
self-explanatory

time-at-processing

(integer(MIN:MAX))
self-explanatory

time-at-completed

(integer(MIN:MAX))
self-explanatory

job-printer-up-time

(integer(1:MAX))
printer uptime

date-time-at-creation

(dateTime)
self-explanatory

date-time-at-processing

(dateTime)
self-explanatory

date-time-at-completed

(dateTime)
self-explanatory

number-of-intervening-jobs

(integer(0:MAX))
Jobs count before to process this one

job-message-from-operator

(text(127))
self-explanatory

Job Size Attributes

job-k-octets

(integer(0:MAX))
self-explanatory

job-impressions

(integer(0:MAX))
total number of impressions
an impression is the image (can be more than one print-stream page, see number-up) onto a single media page.

job-media-sheets

(integer(0:MAX))
the total number of media sheets to be produced for this job

Job Progress Attributes

job-k-octets-processed

(integer(0:MAX))
self-explanatory

job-impressions-completed

(integer(0:MAX))
the impressions completed includes interpreting, marking, and stacking the output

job-media-sheets-completed

(integer(0:MAX))
self-explanatory

Printer Attributes

Printer Description Attributes

printer-uri-supported

(1set Of uri)
printer uri

uri-authentication-supported

(1set Of type2 keyword)
authentication mechanism (if any)
same count than printer-uri-supported

uri-security-supported

(1set Of type2 keyword)
indicate the security mechanisms (if any) used for each URI listed in "printer-uri-supported"

printer-name

(name(127))
self-explanatory

printer-location

(text(127))
where is the printer, physically

printer-info

(text(127))
descriptive information about the printer object

printer-more-info

(uri)
URI of printer's information

printer-driver-installer

(uri)
contains a URI to use to locate the driver installer for the printer

printer-more-info-manufacturer

(uri)
manufacturer URI of printer information

printer-state

(type1 enum)
self-explanatory

printer-state-reasons

(1set Of type2 keyword)
self-explanatory

printer-state-message

(text(MAX))
self-explanatory

ipp-versions-supported

(1set Of type2 keyword)
1.0 or/and 1.1

operations-supported

(1set Of type2 enum)
self-explanatory

multiple-document-jobs-supported

(boolean)
self-explanatory

charset-configured

(charset)
in which charset are sent 'text' and 'name' information (nothing to do with printed document)

charset-supported

(1set Of charset)
Idem (s/sent/can be sent/). at least UTF-8

natural-language-configured

(naturalLanguage)
identifies the natural language that the Printer object has been configured to represent 'text' and 'name' printer attributes that are set by the operator, system administrator, or manufacturer (i.e. printer-location, printer-info ...)

generated-natural-language-supported

(1set Of naturalLanguage)
see above

document-format-default

(mimeMediaType)
document format that the Printer object has been configured to assume if the client does not supply a "document-format" operation attribute (MIME type, like 'application/pdf')

document-format-supported

(1set Of mimeMediaType)
see above

printer-is-accepting-jobs

(boolean)
self-explanatory

queued-job-count

(integer(0:MAX))
number of jobs that are either 'pending', 'processing', 'pending-held', or 'processing-stopped'

printer-message-from-operator

(text(127))
end user information or status of the printer

color-supported

(boolean)
self-explanatory

reference-uri-schemes-supported

(1set Of uriScheme)
URI schemes supported by printUri operation
if printUri is supported, at least ftp

pdl-override-supported

(type2 keyword)
ability for a particular printer implementation to either attempt to override document data instructions with IPP attributes or not

printer-up-time

(integer(1:MAX))
self-explanatory

printer-current-time

(dateTime)
self-explanatory

multiple-operation-time-out

(integer(1:MAX))
the minimum time (in seconds) that the Printer object waits for additional sendDocument or sendURI operations to follow a still-open Job object before taking any recovery actions

compression-supported

(1set Of type3 keyword)
standard values: 'none', 'deflate' (ZIP public domain), 'gzip', 'compress' (RFC 1977 UNIX compression technology)

job-k-octets-supported

(rangeOfInteger(0:MAX))
max size of job

job-impressions-supported

(rangeOfInteger(0:MAX))
max pages of job

job-media-sheets-supported

(rangeOfInteger(0:MAX))
max sheets

pages-per-minute

(integer(0:MAX))
self-explanatory

pages-per-minute-color

(integer(0:MAX))
self-explanatory