EIP Job Model Attributes Spec.pdf

EIP Job Model

EIP Job Model Specification i

Copyright © 2011, Xerox Corporation.

Extensible Interface Platform (EIP) Job Model Attributes

Version: 1.0.14

File: EIP Job Model Attributes

Last Revised: 07/25/11

Release Status: Approved

Generated by:

Xerox Common Print Semantics Specification Working Group (CPSS WG) and the Extensible Interface Platform Team

(EIP)

Contact: Christine Miyachi

Xerox Corporation

Global Business Group (GBG)/ Solutions Business Team (SBT)/ Applications and Solutions Delivery Unit (ASDU)

EIP Job Model

EIP Job Model Specification ii


Copyright © 1999-2011 XEROX CORPORATION. All Rights Reserved. Copyright protection claimed

includes all forms and matters of copyrightable material and information now allowed by statutory or

judicial law or hereinafter granted, including without limitation, material generated from the software

programs which are displayed on the screen such as icons, screen display looks, etc. All other copyrights

herein not held by the Xerox Corporation remain the intellectual property of those persons or legal

entities with rights thereto.

All rights reserved. Printed in the United States of America. No part of this document may be

reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic,

mechanical, photocopied, recorded, or otherwise, without prior written consent from XEROX

Corporation.

All terms mentioned in this document that are known to be trademarks or service marks have been

appropriately capitalized. XEROX cannot attest to the accuracy of this information. Use of a term in this

document should not be regarded as affecting the validity of any trademark or service marks. All

product names are trademarks of their respective companies.

EIP Job Model

EIP Job Model Specification iii


Table Of Contents

Table Of Contents ................................................................................................................ iii Tables .................................................................................................................................... v Figures .................................................................................................................................. vi

1. Introduction .................................................................................................................................... 7

1.1 Conformance Terminology .................................................................................................................................. 7

1.2 Terminology ........................................................................................................................................................ 7

1.3 Structure of the EIP Job Model ........................................................................................................................... 7

1.4 Processing an EIP Job Ticket ............................................................................................................................ 11

1.5 Attribute Types .................................................................................................................................................. 11

2. Job Model Attributes and Values ............................................................................................... 13

ColorEffectsType ................................................................................................................. 14 Copies (integer(1:MAX)) ..................................................................................................... 15 DateTimeAtCompleted (dateTime) ..................................................................................... 16 DateTimeAtCreation (dateTime)......................................................................................... 17 Finishings (keyword) ........................................................................................................... 18 InputTraysCol (1setOf collection) ........................................................................................ 22

Member Attributes for the “InputTraysCol” Device Description Attribute ............................................. 22 InputTrayName ( keyword | name(MAX)) .............................................................................................. 22 TrayLevel (integer(-1:100)) ..................................................................................................................... 22

JobId (name(MAX)) ............................................................................................................ 24 ClientId (name(MAX)) ......................................................................................................... 25

Job Forwarding ........................................................................................................................................ 25 JobIdentifier (collection) ...................................................................................................... 26

JobIdentifierType (type2 keyword) ......................................................................................................... 26 JobIdentifierString (name) ....................................................................................................................... 26

JobName (name(MAX))...................................................................................................... 27 JobState (keyword) ............................................................................................................. 28

Forwarding Servers: .................................................................................. Error! Bookmark not defined. Job Phases: Job Not Completed, Job Completed, Job Retention, Job History, Job RemovalError! Bookmark not defined.

JobStateReasons (keyword) ............................................................................................... 31 JobType (keyword) ............................................................................................................. 38 MediaCol (collection) .......................................................................................................... 40

FeedOrientation (type2 keyword) ............................................................................................................ 40 MediaColor (type3 keyword | name(MAX)) ............................................................................................ 40 MediaSize (collection) ............................................................................................................................. 42

XDimension(integer((1:MAX)) ........................................................................................................... 42 YDimension(integer((1:MAX)) ........................................................................................................... 42

MediaType (type3 keyword | name(MAX))............................................................................................. 42 SheetCollate (keyword) ...................................................................................................... 47 Sides (keyword) .................................................................................................................. 48 Scaling (collection) .............................................................................................................. 49

ScalingType (type2 keyword) .................................................................................................................. 49 ScaleProportional (collection) ................................................................................................................. 50

EIP Job Model

EIP Job Model Specification iv


ScalingValue(rangeOfInteger) ............................................................................................................. 50 ScaleIndependent (collection) .................................................................................................................. 50

XScaling(rangeOfInteger) .................................................................................................................... 50 YScaling(rangeOfInteger) .................................................................................................................... 50

3. APPENDIX A: References ........................................................................................................... 51

4. Appendix B: Document History ................................................................................................. 53

EIP Job Model

EIP Job Model Specification v


Tables

Table 1-1 Attribute types .................................................................................................................................................. 12

Table 5-2: Generic "Finishings" values ............................................................................................................................ 18

Table 3: “InputTraysCol” member attributes.................................................................................................................... 22

EIP Job Model

EIP Job Model Specification vi


Figures

Figure 1 - The Job Queue Schema ...................................................................................................................................... 8

Figure 2 - The Copy Job Ticket .......................................................................................................................................... 9

Figure 3 - The Copy Job details ........................................................................................................................................ 10

Figure 4 - Job Info as part of the Job Queue ..................................................................................................................... 11

EIP Job Model

EIP Job Model Specification 7


1. Introduction 1

This specification defines the schemas assocated with the EIP Job Model. The Model defines data structures that 2

describe job status, job status details, and job tickets. The semantics of the EIP Job Model are based on the CPSS 3

(Common Print Semantic Specification) and have been extended to include attributes for other job types besides . The 4

EIP Job Model also borrows it‟s design from the Device Working Group (www.pwg.org) which has recently defined a 5

job model for a Multi-Function Device (MFD). 6

1.1 Conformance Terminology 7

The capitalized words “MUST”, “CONDITIONALLY REQUIRED” (or “CMUST”), “MUST NOT”, 8

“CONDITIONALLY RECOMMENDED”, “REQUIRED”, “SHOULD”, “SHOULD NOT”, 9

“RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as conformance 10

terminology as described in RFC 2119 [RFC2119]. 11

1.2 Terminology 12

This section contains definitions of terminology used in this document. 13

Device In CPSS the term “Device” is the object that accepts CPSS operations

that implement a Service, such as a Print Service or a Fax-Out Service.

The Fax-Out Service may be implemented in a Multifunction Device

(MFD), a dedicated Server, or as a software package running on a PC. In

other parts of CPSS, the term “Printer” is used, since CPSS was

originally focused only on the Print Service. However, any CPSS

attribute conformance requirements specified for a “Printer” apply to a

Fax-Out Server, if the Fax-Out Servier support the CPSS attribute in

question.

Conformance requirements are specified using the terms “Device”,

“Printer”, “Server”, and “Fax-Out Server”, interchangeably.

“Output Device” is the output module of the “Device” and a “marker” is

the system that puts dots on output. These terms are NOT

interchangeable with “Device”.

14

15

1.3 Structure of the EIP Job Model 16

The EIP Job Model is used to describe both a job ticket and a job status. It supports ticket definition used in 17

job submsions and defines the data being returned in both the job queue and details about a particular job. 18

Versioning of these elements is done via an XML element. The element is defined with three sub elements – 19

major, minor, and revision. For example, version 1.1.0 is the major version 1, the minor version 1, and the 20

revision number 0. See the API specification for definition of major, minior, and revision. 21

http://www.pwg.org/

EIP Job Model



The APIs to list the job queue in the Job Management API return XML documents in the following format: 1

2

3 Figure 1 - The Job Queue Schema 4

Each job in the queue, both active and completed, will contain the same information for each job. The one 5

difference is that the completed job log will contain the time the job completed. 6

The job ticket for the Copy Service is shown below. This schema defines the XML document which will be 7

submitted to initiate a copy. 8

EIP Job Model



1

2

Figure 2 - The Copy Job Ticket 3

Note all the optional attributes. If the attribute is not specified, the device default will be used on the MFD. The copy 4

job ticket is limited in size to 10240 when used with the WS-CopyService WSDL. 5

If details about a particular job are requested of the copy service, an XML document defined by the following schema is 6

returned. 7

EIP Job Model



1

2

Figure 3 - The Copy Job details 3

The JobInfo is the same JobInfo as defined in the job-queue. The copy-job-receipt is exactly the same as the copy-job-4

ticket but all attributes are required. This receipt defines what actually was set on the job. 5

The figure below represents basic Job Information returned in a job queue: 6

EIP Job Model



1

Figure 4 - Job Info as part of the Job Queue 2

1.4 Processing an EIP Job Ticket 3

If an attribute is not supported by the device, the device will ignore that attribute and execute the job. 4

If an attribute has a enumeration value that is not supported by the device, the device will use it‟s default for that 5

attribute. If the optional attribute is not understood or invalid, the element will be ignored. 6

All attributes apply to the entire job. There are no page level attributes. 7

Exceptions to this rule (for example, when empty strings are considered valid), will be noted in individual 8

elements. 9

1.5 Attribute Types 10

The following table describes the attributes types defined in the schema: 11

12

EIP Job Model



Table 1-1 Attribute types 1

Attribute Syntax Example Parameter Value To Encode

boolean Logical True

charset UTF-8

collection

dateTime Same as XML schema dateTime

integer 500 (five hundred)

keyword ‘completed’

mimeMediaType application/octetprint-stream

name “Billy”

rangeOfInteger Lower-bound value is 1

Upper-bound value is 99,999

resolution 300x600 dpi

text “Billy’s Job”

uri ipp://CPS-JALAPENO.sdi.na.xde3.xerox.org/CPS-JALAPENO_HOLD

2

3

EIP Job Model Specification v 1.0.13



1

2. Job Model Attributes and Values 2

The following sections describe the attributes used in the EIP Job Model. 3




ColorEffectsType 1

2

Vernacular Names Output Color 3

Service type Print, Copy 4

Summary Render full color document in full color or grayscale. 5

6

Description This attribute indicates whether a color document should be rendered 7

in full color or should be rendered using an algorithm that maps the 8

full range of colors to alternate values, such as gray scale or 9

monochrome. This capability allows a full color document to render 10

to a color document in monochrome or grayscale or black and white 11

as a way to save time, toner, or cost when proofing a document. 12

If the Device supports this attribute, it MUST support the „Color‟ and 13

„MonochromeGrayscale‟ values. If a color Device does not support 14

this attribute, the Device MUST provide the „Color‟ behavior. 15

Black and white Devices and highlight color Devices MUST NOT 16

support this attribute. 17

Standard keyword values are: 18

Keyword Description

„Color‟ all color content of the document MUST be preserved

and rendered in color.

„Monochrome

Grayscale‟

the color content of the input document should be

identified and an implementation-dependent

algorithm MUST be applied to map the document

colors to various intensities of black and white.

„Auto‟ Automatically detect the color when scanning the

document and use that setting on the output.

19

20

21

22

23




Copies (integer(1:MAX)) 1

Vernacular Names Copies, Quantity 2


Description This attribute specifies the number of copies to be printed. 4

On many devices the supported number of collated copies will be 5

limited by the number of physical output bins on the device, and may 6

be different from the number of uncollated copies which can be 7

supported 8

9




DateTimeAtCompleted (dateTime) 1

Service type Generic 2

Description This OPTIONAL attribute indicates the date and time at which the 3

Job completed (or was cancelled or aborted). 4

5




DateTimeAtCreation (dateTime) 1


Status Draft 3

Description This OPTIONAL attribute indicates the date and time at which the 4

Job was created.. 5

6

7




Finishings (keyword) 1

2

Vernacular Names Finsihings 3


5

Description This “finishings” attribute identifies the finishing operations that the 6

Device uses for each copy of each document in the Job 7

This element contains three subelements – 8

StapleFinishing 9

PunchFinishing 10

FoldFinishing 11

Standard values are: 12

Table 5-2: Generic "Finishings" values 13

Name and Description of Finishing Values

Name and Description of Staple Finishing Values

„None‟: Perform no finishing

„OneStaple‟: Add one staple

„TwoStaple‟: Add two staples

„ThreeStaple‟: Add three staples

„FourStaple‟: Add four staples

„Staple‟: Bind the document(s) with one or more staples. The exact number and placement

of the staples is site-defined.

„StapleTopLeft‟: Bind the document(s) with one or more staples in the top left corner.

„StapleBottomLeft‟: Bind the document(s) with one or more staples in the bottom left corner.

„StapleTopRight‟: Bind the document(s) with one or more staples in the top right corner.

„StapleBottomRight‟: Bind the document(s) with one or more staples in the bottom right

corner.

„EdgeStitchLeft‟: Bind the document(s) with one or more staples (wire stitches) along the

left edge. The exact number and placement of the staples is implementation and/or site-

defined.

„EdgeStitchTop‟: Bind the document(s) with one or more staples (wire stitches) along the

top edge. The exact number and placement of the staples is implementation and/or site-

defined.

„EdgeStitchRight‟: Bind the document(s) with one or more staples (wire stitches) along the

right edge. The exact number and placement of the staples is implementation and/or site-

defined.




„EdgeStitchBottom‟: Bind the document(s) with one or more staples (wire stitches) along the

bottom edge. The exact number and placement of the staples is implementation and/or site-

defined.

„StapleDualLeft‟: Bind the document(s) with two staples (wire stitches) along the left edge.

„StapleDualTop‟: Bind the document(s) with two staples (wire stitches) along the top edge.

„StapleDualRight‟: Bind the document(s) with two staples (wire stitches) along the right

edge.

„StapleDualBottom‟: Bind the document(s) with two staples (wire stitches) along the bottom

edge.

„Staple3Left‟: Bind the document(s) with a three staples (wire stitch) centered along the left

edge.

„Staple3Top‟: Bind the document(s) with a three staples (wire stitch) centered along the top

edge

„Staple3Right‟: Bind the document(s) with a three staples (wire stitch) centered along the

right edge.

„Staple3Bottom‟: Bind the document(s) with a three staples (wire stitch) centered along the

bottom edge.

„Staple4Left‟: Bind the document(s) with a four staples (wire stitch) centered along the left

edge.

„Staple4Top‟: Bind the document(s) with a four staples (wire stitch) centered along the top

edge

„Staple4Right‟: Bind the document(s) with a four staples (wire stitch) centered along the

right edge.

„Staple4Bottom‟: Bind the document(s) with a four staples (wire stitch) centered along the

bottom edge.

„StapleMultipleLeft‟: Bind the document(s) with a multiple staples (wire stitch) centered

along the left edge.

„StapleMultipleTop‟: Bind the document(s) with a multiple staples (wire stitch) centered

along the top edge

„StapleMultipleRight‟: Bind the document(s) with a multiple staples (wire stitch) centered

along the right edge.

„StapleMultipleBottom‟: Bind the document(s) with a multiple staples (wire stitch) centered

along the bottom edge.

„StapleInboard‟: Bind the document(s) with one or more staples (wire stitch) in the inboard

position.

„StapleOutboard‟: Bind the document(s) with one or more staples (wire stitch) in the

outboard position.

„StaplePortrait‟: Bind the document(s) with one or more staples (wire stitch) in the portrait

position.




„StapleLandscape‟: Bind the document(s) with one or more staples (wire stitch) in the

landscape position.

„StapleDualBooklet‟: Bind the document(s) with two staples (wire stitch) in the booklet

position.

„StapleDualPortrait‟: Bind the document(s) with two staples (wire stitch) in the portrait

position.

„StapleDualLandscape‟: Bind the document(s) with two staples (wire stitch) in the

landscape position.

„StapleMultiplePortrait‟: Bind the document(s) with multiple staples (wire stitch) in the

portrait position.

„StapleMultipleLandscape‟: Bind the document(s) with multiple staples (wire stitch) in the

landscape position.

Name and Description of Punch Finishing Values


„Punch: Punch the document(s) with one or more holes. The exact number and placement

of the holes is site-defined.

„Punch2Hole‟: Punch two holes in the document. The exact location and size of the holes to

be punched is implementation and/or site-defined.

„Punch3Hole‟: Punch three holes in the document. The exact location and size of the holes

to be punched is implementation and/or site-defined..

„Punch4Hole‟: Punch four holes in the document. The exact location and size of the holes to

be punched is implementation and/or site-defined..

„PunchLeft‟: Punch along the left edge. The exact number and placement of the holes is

implementation and/or site-defined.

„PunchTop‟: Punch along the top edge. The top edge is opposite and parallel to the bottom

edge. The exact number and placement of the holes is implementation and/or site-defined.

„PunchRight‟: Punch along the right edge. The right edge is opposite and parallel to the left

edge. The exact number and placement of the holes is implementation and/or site-defined.

„PunchBottom‟: Punch along the bottom edge. The exact number and placement of the holes

is implementation and/or site-defined.

„Punch2HoleLeft‟: Punch two holes along the left edge. The exact placement of the

holes is implementation and/or site-defined

„Punch2HoleTop‟: Punch two holes along the top edge. The exact placement of the


„Punch2HoleRight‟: Punch two holes along the right edge. The exact placement of the


„Punch2HoleBottom‟: Punch two holes along the bottom edge. The exact placement

of the holes is implementation and/or site-defined

„Punch3HoleLeft‟: Punch three holes along the left edge The exact placement of the





„Punch3HoleTop‟: Punch three holes along the top edge. The exact placement of the


„Punch3HoleRight‟: Punch three holes along the right edge. The exact placement of

the holes is implementation and/or site-defined

„Punch3HoleBottom‟: Punch three holes along the bottom edge. The exact

placement of the holes is implementation and/or site-defined

„Punch4HoleLeft‟: Punch four holes along the left edge. The exact placement of the


„Punch4HoleTop‟: Punch four holes along the top edge. The exact placement of the


„punch-4-hole-right‟: Punch four holes along the right edge. The exact placement of


„Punch4HoleRight‟: Punch four holes along the bottom edge. The exact placement of


„Punch4HoleBottom‟: Punch four holes along the bottom edge. The exact placement

of the holes is implementation and/or site-defined

Name and Description of Fold Finishing Values


„Fold‟: Fold the document(s) with one or more folds. The exact number and orientations of

the folds and whether or not they are concave or convex with respect to Side 1 of the sheet is

implementation and/or site-defined.




InputTraysCol (1setOf collection) 1

Vernacular Name Input Tray 2

Service type Copy 3

Summary A collection that identifies the media loaded in each tray of the 4

Device as well as other device configuration information such as feed 5

orientation, capacity and current level. 6

7

Description This attribute uses collections to identify the current state of input 8

trays. Each collection returned by the “InputTraysCol” attribute in the 9

future, will identify the media configured for each tray of the Device, 10

plus device capability and status information including tray name, 11

feed orientation, tray capacity, tray status, the current level of media 12

in the tray, and the position of the tray relative to the fuser. 13

For EIP presently only the input tray name is in this collection. 14

Member Attributes for the “InputTraysCol” Device 15

Description Attribute 16

Error! Reference source not found. lists the member attributes 17

of the “InputTraysCol” collection attribute: 18

Table 3: “InputTraysCol” member attributes 19

Member Attribute

Name

Attribute Syntax

Error! Reference source

not found.

keyword | name (MAX)

TrayLevel integer (-1:100)

The “InputTraysCol” collection member attributes definitions are: 20

InputTrayName ( keyword | name(MAX)) 21

The “InputTrayName” member attribute indicates the keyword name 22

of the input tray (sometimes called an input feeder). 23

24

TrayLevel (integer(-1:100)) 25

The TrayLevel element indicates the percentage of the capacity remaining 26

in the tray. The value returned is a percentage of the maximum of media 27

that can be put into the tray. 28

A value of “0” indicates that there is no media remaining, or that only a 29

small amount of media remains in the tray which cannot be fed by the 30

device without more sheets being loaded, depending on the 31

implementation. Whether the defaults switches to another tray or faults 32

when it tries to feed from this tray when the value is “0” is implementation 33

dependent. 34




The TrayLevel member attribute is expressed in whole percentage points. If 1

the device cannot determine the level of paper in the tray, it MUST return a 2

value of -1 to indicate an unknown level. 3

If the device conveys a tray level but can only sense a small number of 4

discreet levels, such as empty, low, etc., the device SHOULD NOT support 5

TrayLevel which would give users a mis-leading reading. 6

7

8




JobId (name(MAX)) 1


Status Draft 3

Description This REQUIRED attribute contains the ID of the job. The Device, on 4

receipt of a new job, generates an ID which identifies the new Job on 5

that Device. The Device returns the value of the “JobId” attribute as 6

part of the response to a create request. The 0 value is not included to 7

allow for compatibility with SNMP index values which also cannot be 8

0. 9

10




ClientId (name(MAX)) 1


Status draft 3

Summary Allows the client to supply a job identifier that clients can query 4

to determine status of the job by scanning jobs returned by the 5

Device in obtain job status and/or use for human 6

communication with the Device’s operator. 7

8

Description The client OPTIONALLY supplies this attribute. The Device object 9

OPTIONALLY supports this attribute. It contains a job identifier 10

created by the client. The client MAY automatically include any 11

information that will help the client distinguish amongst the jobs that 12

it has submitted. 13

Job Forwarding 14

When a Device forwards a job, the job‟s “ClientId” is forwarded as 15

received by the Device. In other words, these values are preserved 16

throughout the workflow that involved Job Forwarding (rather than 17

being changed to the “JobId” value generated by the Device that is 18

performing the Job Forwarding). 19




JobIdentifier (collection) 1


Status draft 3

Description The JobIdentifier attribute is used to specify what type of job 4

identification is being used and the value for that identifier. 5

6

“JobIdentifier” member attributes 7

Member Attribute Name

Attribute Syntax

JobIdentifierType keyword

JobIdentifierString name

The “JobIdentifier” collection member attributes definitions are: 8

JobIdentifierType (type2 keyword) 9

The “JobIdentifierType” member attribute specifies the type of job 10

identifier being used. 11


13

14

15

16

JobIdentifierString (name) 17

The “JobIdentifierString” member attribute specifies the vlaue for the 18

identifier specified in the JobIdentifierType member attribute. 19

20

Keyword Description

„ JobId ‟ See the JobId description above for details.

„ ClientId ‟ See the ClientId description above for details.




JobName (name(MAX)) 1


Status Draft 3

Description The client OPTIONALLY supplies this attribute. The Device object 4

MUST support this attribute. It contains the client supplied Job 5

name. If this attribute is supplied by the client, its value is used for 6

the “JobName” attribute of the newly created Job object. The client 7

MAY automatically include any information that will help the end-8

user distinguish amongst his/her jobs, such as the name of the 9

application program along with information from the document, such 10

as the document name, document subject, or source file name. If this 11

attribute is not supplied by the client, the Device generates a name to 12

use in the “JobName” attribute of the newly created Job object 13




JobState (keyword) 1


Description This REQUIRED attribute identifies the current state of the job. 3

Implementations only need to support those states which are 4

appropriate for the particular implementation. 5

Standard enum values are: 6

Symbolic Name and Description

„Pending‟: The job is a candidate to start processing, but

is not yet processing.

„PendingHeld‟: The job is not a candidate for

processing for any number of reasons but will return to

the „pending‟ state as soon as the reasons are no longer

present. The job‟s “JobStateReasons” attribute MUST

indicate why the job is no longer a candidate for

processing.

„Processing: One or more of:

1. The job is using, or is attempting to use, one or more

purely software processes that are analyzing,

creating, or interpreting a PDL, etc.,

2. The job is using, or is attempting to use, one or more

hardware devices that are interpreting a PDL,

making marks on a medium, and/or performing

finishing, such as stapling, etc.,

3. The Device object has made the job ready for

printing, but the output device is not yet printing it,

either because the job hasn‟t reached the output

device or because the job is queued in the output

device or some other spooler, awaiting the output

device to print it.

When the job is in the „processing‟ state, the entire

job state includes the detailed status represented in

the Device object‟s “Device-state”, “Device-state-

reasons”, and “Device-state-message” attributes.

Implementations MAY, though they NEED NOT,

include additional values in the job‟s

“JobStateReasons” attribute to indicate the progress

of the job, such as adding the „job-printing‟ value to

indicate when the output device is actually making

marks on paper and/or the „processing-to-stop-point‟

value to indicate that the CPSS object is in the

process of canceling or aborting the job. Most

implementations won‟t bother with this nuance.

„ProcessingStopped‟: The job has stopped while

processing for any number of reasons and will return to

the „processing‟ state as soon as the reasons are no

longer present.

The job‟s “JobStateReasons” attribute MAY indicate

why the job has stopped processing. For example, if the




output device is stopped, the „Device-stopped‟ value

MAY be included in the job‟s “JobStateReasons”

attribute.

Note: When an output device is stopped, the device

usually indicates its condition in human readable form

locally at the device. A client can obtain more complete

device status remotely by querying the Device object‟s

“Device-state”, “Device-state-reasons” and “Device-

state-message” attributes.

„Canceled‟: The job has been canceled by a Cancel-Job

operation and the Device object has completed canceling

the job and all job status attributes have reached their

final values for the job. While the Device object is

canceling the job, the job remains in its current state, but

the job‟s “JobStateReasons” attribute SHOULD contain

the „processing-to-stop-point‟ value and one of the

„canceled-by-user‟, „canceled-by-operator‟, or „canceled-

at-device‟ value. When the job moves to the „canceled‟

state, the „processing-to-stop-point‟ value, if present,

MUST be removed, but the „canceled-by-xxx‟, if

present, MUST remain.

„Aborted‟: The job has been aborted by the system,

usually while the job was in the „processing‟ or

„ProcessingStopped‟ state and the Device has completed

aborting the job and all job status attributes have reached

their final values for the job. While the Device object is

aborting the job, the job remains in its current state, but

the job‟s “JobStateReasons” attribute SHOULD contain

the „processing-to-stop-point‟ and „aborted-by-system‟

values. When the job moves to the „aborted‟ state, the

„processing-to-stop-point‟ value, if present, MUST be

removed, but the „aborted-by-system‟ value, if present,

MUST remain.

„Completed‟: The job has completed successfully or

with warnings or errors after processing and all of the

job media sheets have been successfully stacked in the

appropriate output bin(s) and all job status attributes

have reached their final values for the job. The job‟s

“JobStateReasons” attribute SHOULD contain one of:

„CompletedSuccessfully‟, „CompletedWithWarnings‟, or

„CompletedWithErrors‟ values.

The final value for this attribute MUST be one of: „Completed‟, 1

„Canceled‟, or „Aborted‟ before the Device removes the job 2

altogether. The length of time that jobs remain in the „Canceled‟, 3

„Aborted‟, and „Completed‟ states depends on implementation. 4

The following figure shows the normal job state transitions 5

+ Canceled 6 / 7 + Pending Processing --------- + Completed 8 | ^ ^ \ 9 + | | + Aborted 10 | v v / 11 + PendingHeld ProcessingStopped --+ 12




Normally a job progresses from left to right. Other state transitions 1

are unlikely, but are not forbidden. Not shown are the transitions to 2

the „Canceled‟ state from the „pending‟, „PendingHeld‟, and 3

„ProcessingStopped‟ states. 4

Jobs reach one of the three terminal states: „Completed‟, „Canceled‟, 5

or „Aborted‟, after the jobs have completed all activity, including 6

stacking output media, after the jobs have completed all activity, and 7

all job status attributes have reached their final values for the job. 8

9

10

11




JobStateReasons (keyword) 1


Summary Augments the "JobState" attribute to give more detailed information 3

about this Job‟s state. There can be more than one keyword in this 4

element. 5

6

Description This REQUIRED attribute provides additional information about the 7

job's current state, i.e., information that augments the value of the 8

job's "JobState" attribute. 9

These values MAY be used with any job state or states for which the 10

reason makes sense. Some of these value definitions indicate 11

conformance requirements; the rest are OPTIONAL. Furthermore, 12

when implemented, the Device MUST return these values when the 13

reason applies and MUST NOT return them when the reason no 14

longer applies whether the value of the Job's "JobState" attribute 15

changed or not. When the Job does not have any reasons for being in 16

its current state, the value of the Job's "JobStateReasons" attribute 17

MUST be 'none'. 18

Note: While values cannot be added to the 'JobState' attribute without 19

impacting deployed clients that take actions upon receiving 20

"JobState" values, it is the intent that additional "JobStateReasons" 21

values can be defined and registered without impacting such deployed 22

clients. In other words, the "JobStateReasons" attribute is intended to 23

be extensible. 24

When this attribute contains more than one reason, the reasons 25

MUST be ordered with the most important first and the least 26

important last. The most important is usually the reason that caused 27

the last state transition. The determination of the importance of a 28

state reason is implementation specific. The level of severity 29

associated with a reason indicates its importance. Error is more 30

important than warning and warning is more important than report. 31

The following standard keyword values are defined. For ease of 32

understanding, the values are presented in the order in which the 33

reasons are likely to occur (if implemented), starting with the 34

'JobHoldUntil-specified' value: 35

„None‟: There are no reasons for the job‟s current state. This state 36

reason is semantically equivalent to “JobStateReasons” without 37

any value and MUST be used when there is no other value, since 38

the 1setOf attribute syntax requires at least one value. 39

„JobHoldUntilSpecified‟: The value of the job‟s “JobHoldUntil” 40

attribute was specified with a time period that is still in the future. 41

The job MUST NOT be a candidate for processing until this 42

reason is removed and there are no other reasons to hold the job. 43

This value SHOULD be supported if the “JobHoldUntil” Job 44

Template attribute is supported. 45

„JobHeldOnCreate‟: The job is currently being held in the 46

„PendingHeld‟ state because the operator had previously issued a 47

Hold-New-Jobs Device operation (see Section 2.4 of CPSS 48




Volume 2—Operations). The job may be made a candidate for 1

scheduling, i.e., moved to the „pending‟ state, by either the 2

Release-Job or the Release-Held-New-Job operations (see 3

Section 2.4 of CPSS Volume 2—Operations). 4

„JobPasswordWait‟: The job is currently being held until the correct 5

password is entered at the device. If the “JobPassword” 6

Operation attribute (See description earlier in this section) is 7

supported, this value MUST be supported. 8

„ProofPrintWait‟: The job is currently being held until the operator 9

verifies the output of the proof print and performs a Release-Job 10

operation. If the “proof-print” Job Template attribute (See 11

description later in this section) is supported, this value MUST 12

be supported. 13

„ContextBasedRestrictionsViolated‟: The Device/Service object 14

accepted the job before checking the context based restrictions 15

for the supplied user and application that was submitting the Job 16

Creation Operation and subsequently found that one or more 17

supplied job creation attributes violated the Device‟s/Service‟s 18

Context Based Restrictions configured by the administrator. 19

20

21

„ResourcesAreNotSupported‟: At least one of the resources needed by 22

the job, such as media, fonts, resource objects, etc., is not 23

supported on any of the physical Devices for which the job is a 24

candidate. This condition MAY be detected when the job is 25

accepted, or subsequently while the job is pending or processing, 26

depending on implementation. The job may (1) remain in its 27

current state, (2) be moved to the „PendingHeld‟ state, depending 28

on implementation and/or job scheduling policy, or (3) scheduled 29

normally, but the Device is put into the „stopped‟ state when the 30

job is attempted to be processed on the Device. 31

„ResourcesAreNotReady‟: At least one of the resources needed by 32

the job, such as media, fonts, resource objects, etc., is not ready 33

on any of the physical Device‟s for which the job is a candidate. 34

This condition MAY be detected when the job is accepted, or 35

subsequently while the job is pending or processing, depending 36

on implementation. The job may remain in its current state or be 37

moved to the „PendingHeld‟ state, depending on implementation 38

and/or job scheduling policy. 39

„JobIncoming‟: Either (1) the Device has accepted the Create-Job 40

operation and is expecting additional Send-Document and/or 41

Send-URI operations or (2) the Device is retrieving/accepting 42

document data as a result of a Print-Job, Print-URI, Send-43

Document or Send-URI operation. 44

„JobSpooling‟: Same as „JobIncoming‟with the specialization that the 45

Device is spooling the document data before processing it. This 46

value corresponds to the „spool‟ or „automatic‟ value of the “job-47

spooling-supported” Device Description attribute. 48




„JobStreaming‟: Same as „JobIncoming‟with the specialization that 1

the Device is processing the document data as it is being received 2

(that is, the job is not being spooled, but rather is being processed 3

in chunks by the output device and is being imaged during 4

reception). This value corresponds to the „stream‟ or „automatic‟ 5

value of the “job-spooling-supported” Device Description 6

attribute. 7

„JobDataInsufficient‟: The Create-Job operation has been accepted 8

by the Device, but the Device is expecting additional document 9

data before it can move the job into the „Processing‟ state. If a 10

Device starts processing before it has received all data, the 11

Device removes the „JobDataInsufficient‟ reason, but the 12

„JobIncoming‟ remains. If a Device starts processing after it has 13

received all data, the Device removes the „JobDataInsufficient‟ 14

reason and the „job-incoming‟ at the same time. 15

„UnsupportedCompression‟: The job was aborted by the system 16

because the Device determined while attempting to decompress 17

the document-data‟s that the compression is actually not among 18

those supported by the Device. This value MUST be supported, 19

since “compressions is a REQUIRED operation attribute. 20

„CompressionError‟: The job was aborted by the system because the 21

Device encountered an error in the document-data while 22

decompressing it. If the Device posts this reason, the document-23

data has already passed any tests that would have led to the 24

„unsupported-compression‟ JobStateReasons. 25

„DocumentAccessError‟: After accepting a Print-URI or Send-URI 26

request, the Device could not access one or more documents 27

passed by reference. This reason is intended to cover any file 28

access problem, including file does not exist and access denied 29

because of an access control problem. The Device MAY also 30

indicate the document access error using the “job-document-31

access-errors” Job Description attribute (see the description of 32

“job-document-access-errors” above). Whether the Device 33

aborts the job and moves the job to the „aborted‟ job state or 34

prints all documents that are accessible and moves the job to the 35

„completed‟ job state and adds the „completed-with-errors‟ value 36

in the job‟s “JobStateReasons” attribute depends on 37

implementation and/or site policy. This value SHOULD be 38

supported if the Print-URI or Send-URI operations are 39

supported. 40

„UnsupportedDocumentFormat‟: The job was aborted by the system 41

because the document-data‟s document-format is not among 42

those supported by the Device. If the client specifies the 43

document-format as „application/octetprint-stream‟, the Device 44

MAY abort the job and post this reason even though the format is 45

a member of the “document-format-supported” Device attribute, 46

but not among the auto-sensed document-formats. This value 47

MUST be supported, since “document-format” is a REQUIRED 48

operation attribute. 49




„DocumentFormatError‟: The job was aborted by the system because 1

the Device encountered an error in the document-data while 2

processing it. If the Device posts this reason, the document-data 3

has already passed any tests that would have led to the 4

„unsupported-document-format‟ JobStateReasons. 5

„SavePasswordMismatch‟: A Print With Job (see “Error! Reference 6

source not found.” (1setOf collection) Job Template attributes 7

attempted to reference a saved job, but the supplied “Error! 8

Reference source not found.” attribute in the Print With Job did 9

not match the saved job‟s “Error! Reference source not 10

found.” attribute supplied when the job was saved (see “Error! 11

Reference source not found.” (collection) Job Template 12

attribute). The Device MAY (1) process the job ignoring the 13

saved job, (2) fault the job and wait for Operator intervention to 14

provide a matching password or (3) abort the job depending on 15

implemenation, including configuration. 16

„SavePasswordNotSupplied‟: A Print With Job (see “Error! 17

Reference source not found.” (1setOf collection) Job Template 18

attributes attempted to reference a saved job, but no “Error! 19

Reference source not found.” attribute was supplied in the Print 20

With Job for a saved job that had been saved with a “Error! 21

Reference source not found.” attribute supplied when the job 22

was saved (see “Error! Reference source not found.” 23

(collection) Job Template attribute). The Device MAY (1) 24

process the job ignoring the saved job, (2) fault the job and wait 25

for Operator intervention to provide a matching password or (3) 26

abort the job depending on implemenation, including 27

configuration. 28

„DigitalSignatureTypeNotSupported‟: One or more documents in the 29

Job contain a digital signature type that is not supported. 30

Implementation or site policy determines the state of the Job 31

once this condition is detected. 32

„JobDigitalSignatureWait‟: The Job is currently being held because 33

the Job was submitted with a “document-digital-signature” 34

attribute value that is not supported. 35

„DigitalSignatureDidNotVerify‟: One or more documents in the Job 36

contains a digital signature type that is supported (see 37

“document-digital-signature” Operation attribute), but the 38

signature did not verify when the Device attempted to verify the 39

signature. 40

„SubmissionInterrupted‟: The job was not completely submitted for 41

some unforeseen reason, such as: (1) the Device has crashed 42

before the job was closed by the client, (2) the Device or the 43

document transfer method has crashed in some non-recoverable 44

way before the document data was entirely transferred to the 45

Device, (3) the client crashed or failed to close the job before the 46

time-out period. See the description of the „multiple-operation-47

time-out‟ status code in Section 2.4 of CPSS Volume 3—Status 48

Codes. 49




„JobOutgoing‟: The Device is transmitting the job to the output 1

device. 2

„JobScheduling‟: The Device is in the process of scheduling the 3

processing for the job. 4

„JobQueued‟: Job is in the „processing‟ state, but more specifically, 5

the Device has queued the document data. 6

„JobTransforming‟: Job is in the „processing‟ state, but more 7

specifically, the Device is interpreting document data and 8

producing another electronic representation. 9

„ManualCheckRequested‟: The job was supplied with “media-col” / 10

“Error! Reference source not found.” = „manual-check‟. See 11

“media-col” / “Error! Reference source not found.” 12

Description which covers Devices that have a queue and those 13

that don‟t. After the Job has entered the „ProcessingStopped‟ 14

state and the Error! Reference source not found. has confirmed 15

that the requested media is loaded, the Device removes the 16

„manual-check-requested‟ value, changes the job‟s “JobState” 17

back to „processing‟ and continues processing the job. 18

„JobInterpreting‟: Job is in the „processing‟ state, but more 19

specifically, the Device is interpreting the document data. 20

„JobQueuedForMarker‟: Job is in any of the „PendingHeld‟, 21

„Pending‟, or „Processing‟ states, but more specifically, the 22

Device has completed enough processing of the document to be 23

able to start marking and the job is waiting for the marker. 24

Systems that require human intervention to release jobs using the 25

Release-Job operation, put the job into the „PendingHeld‟ job 26

state. Systems that automatically select a job to use the marker 27

put the job into the „Pending‟ job state or keep the job in the 28

„Processing‟ job state while waiting for the marker, depending 29

on implementation. All implementations put the job into (or 30

back into) the „processing‟ state when marking does begin. 31

„JobPrinting‟: The output device is marking media. This value is 32

useful for Devices which spend a great deal of time processing 33

(1) when no marking is happening and then want to show that 34

marking is now happening or (2) when the job is in the process of 35

being canceled or aborted while the job remains in the 36

„processing‟ state, but the marking has not yet stopped so that 37

impression or sheet counts are still increasing for the job. 38

„DeviceStoppedPartly‟: The value of the Device‟s “Device-state-39

reasons” attribute contains the value „stopped-partly‟. 40

„DeviceStopped‟: The value of the Device‟s “Device-state” attribute 41

is „stopped‟. 42

„JobSuspending‟: The Device is in the process of moving the job 43

from a processing condition to a suspended condition where 44

other jobs can be processed. 45

„JobSuspended‟: The job has been suspended while processing using 46

the Suspend-Current-Job operation and other jobs can be 47




processed on the Device. The Job can be resumed using the 1

Resume-Job operation which removes this value 2

„JobSuspendedByOperator‟: The job has been indefinitely suspended 3

by the Device operator. 4

„JobSuspendedByUser‟: The job has been indefinitely suspended by 5

the user. 6

„JobSuspendedBySystem‟: The job has been indefinitely suspended 7

by the Device‟s system software during normal processing of the 8

job. 9

„JobResuming‟: The Device is in the process of moving the job from 10

a suspended condition to a candidate for processing. 11

„JobCanceledByUser‟: The job was canceled by the owner of the job 12

using the Cancel-Job request, i.e., by a user whose authenticated 13

identity is the same as the value of the originating user that 14

created the Job object, or by some other authorized end-user, 15

such as a member of the job owner‟s security group. This value 16

SHOULD be supported. 17

„JobCanceledByOperator‟: The job was canceled by the operator 18

using the Cancel-Job request, i.e., by a user who has been 19

authenticated as having operator privileges (whether local or 20

remote). If the security policy is to allow anyone to cancel 21

anyone‟s job, then this value may be used when the job is 22

canceled by other than the owner of the job. For such a security 23

policy, in effect, everyone is an operator as far as canceling jobs 24

is concerned. This value SHOULD be supported if the 25

implementation permits canceling by other than the owner of the 26

job. 27

„JobCanceledAtDevice‟: The job was canceled by an unidentified 28

local user, i.e., a user at a console at the device. This value 29

SHOULD be supported if the implementation supports canceling 30

jobs at the console. 31

„AbortedBySystem‟: The job (1) is in the process of being aborted, 32

(2) has been aborted by the system and placed in the „aborted‟ 33

state, or (3) has been aborted by the system and placed in the 34

„pending-held‟ state, so that a user or operator can manually try 35

the job again. This value SHOULD be supported. 36

„ProcessingToStopPoint‟: The requester has issued a Cancel-Job 37

operation or the Device object has aborted the job, but is still 38

performing some actions on the job until a specified stop point 39

occurs or job termination/cleanup is completed. 40

If the implementation requires some measurable time to cancel 41

the job in the „processing‟ or „ProcessingStopped‟ job states, the 42

CPSS object MUST use this value to indicate that the Device 43

object is still performing some actions on the job while the job 44

remains in the „processing‟ or „ProcessingStopped‟ state. After 45

all the job‟s job description attributes have stopped incrementing, 46

the Device object moves the job from the „processing‟ state to the 47

„canceled‟ or „aborted‟ job states. 48




„WarningsDetected‟: If the Device supports the value „warnings-1

detected‟, the Device MUST add it to “JobStateReasons” when it 2

generates the first warning message. That is, a single occurrence 3

of this value is present in the “JobStateReasons” if the Device 4

has generated one or more warnings. 5

„JobCompletedSuccessfully‟: The job completed successfully. There 6

were no warnings or errors in printing, and no errors in saving of 7

jobs or Forms. This value SHOULD be supported. 8

„JobCompletedWithWarnings‟: The print part of the job completed 9

with warnings (whether or not there were save errors for jobs or 10

Forms). This value SHOULD be supported if the 11

implementation detects warnings. 12

„JobCompletedWithErrors‟: The print part of the job completed with 13

errors (and possibly warnings too) (whether or not there were 14

save errors for jobs or Forms). This value SHOULD be 15

supported if the implementation detects errors. 16

„JobSaving‟: The Device is transmitting the job to the save location. 17

This is similar to the „job-printing‟ value. 18

„JobSaveError‟: The job did not save successfully (whether or not it 19

was printed successfully, printed with warnings, printed with 20

errors, or not printed). The Device MUST ensure that none of 21

the saved job is accessible, if it was unable to successfully save 22

all of the job. 23

„JobRestartable‟: This job is retained (see the description of 24

“JobState” above, specifically “Partitioning of Job States”) and is 25

currently able to be restarted using the Restart-Job operation (see 26

Section 2.4 of CPSS Volume 2—Operations). If „job-restartable‟ 27

is a value of the job‟s “JobStateReasons” attribute, then the 28

CPSS object MUST accept a Restart-Job operation for that job. 29

This value SHOULD be supported if the Restart-Job operation is 30

supported. 31

„QueuedInDevice‟: The job has been forwarded to a device or print 32

system that is unable to send back status. The Device sets the 33

job‟s “JobState “ attribute to „completed‟ and adds the „queued-34

in-device‟ value to the job‟s “JobStateReasons” attribute to 35

indicate that the Device has no additional information about the 36

job and never will have any better information. See the 37

description of the “JobState” attribute above, specifically the 38

portion on “Forwarding Servers”. 39

„JobHeldForAuthorization‟: The job has been held waiting for the Job 40

Limits service to determine if the user has permission for the job 41

to proceed. 42

„OutOfAccountingResources‟: The job has been rejected by the Job 43

Limits server. 44

45

NOTE: The semantics of this attribute or the set of valid values may 46

be different for different document formats. 47




1




JobType (keyword) 1

2

Vernacular Names Job Type 3


Description This attributre defines the type of job being returned. 5

Standard enum values are: 6

Table 5-55: Generic "job-type" values 7

Name and Description -

„Copy‟: a copy job

„Print‟: a print job.

„WorkflowScanning‟: a scan job




Name and Description -

„IncomingFax‟: A fax job that comes into the device

„FaxSend‟: A fax job that is being sent out by the device

„Email‟: A scan to e-mail job

„InternetFaxReceive‟: An internet fax being received by the device

„InternetFaxSend‟: An internet fax being sent by the device

„ReportJob‟: A report from the device. One example is the configuration report that prints

out after each reboot.

„FaxSendFromPc‟: A lanfax job- typically submitted by the print driver but instead of

printing, the job gets faxed.

„DelayedPrint‟: A network submitted job that is held until a specified time and then

automatically released to print.

„EmbeddedFaxReceive‟: A job that was received via the on-board fax card and printed by

the device.

„EmbeddedFaxSend‟: A walk up user scans images to be faxed out with the on-board fax

card.

„Other‟: A type of job that is not of any of the types specified in this list. "Other" should not

be used in any other API type is available.

„ProofPrint‟: A net print job that prints a first copy, then waits for the user to release the

other copies of the job.

„ScanToFax‟: A fax job that a walk up operator programmed. The job is scanned to the

network to be faxed out.

„ScanToIfax‟: A job that was scanned to be sent to one or more Internet fax recipients via

email.

„ScanToPrint‟: A job that was scanned to memory, then printed. (another form of a copy

job)

„SecurePrint‟: A net print job that is automatically held in the print queue for later release by

the net print walk up user.

„StoreFiles‟: A job scanned to a user-supplied USB drive plugged into the Xerox device.

„PrintFiles‟: A job printed from a user-supplied USB drive plugged into the Xerox device or

from other local media.

1




MediaCol (collection) 1

Vernacular Names MediaCol 2


Status Draft 4

Description This MediaCol attribute identifies the characteristics of a media. . 5

Each member attribute of the collection identifies a media 6

characteristic. 7

8

“MediaCol” member attributes 9


Attribute Syntax

FeedOrientation keyword

MediaColor keyword | name

MediaSize collection

MediaType keyword | name

The “MediaCol” collection member attributes definitions are: 10

FeedOrientation (type2 keyword) 11

The OPTIONAL “FeedOrientation” member attribute specifies the 12

media edge which is fed into the print engine from the paper tray. 13


15

MediaColor (type3 keyword | name(MAX)) 16

The OPTIONAL “MediaColor” member attribute indicates the 17

desired color of the media being specified. The MediaColor attribute 18

may be set as a custom string of 1 to 128 characters or one of the 19

keywords below. 20

Standard keyword values for “MediaColor” are: 21

Keyword Description

Keyword Description

„LongEdgeFirst‟ The specified media is fed using the long edge

first.

„ShortEdgeFirst‟ The specified media is fed using the short edge

first.




Keyword Description

„White‟ The specified media should be white.

„Blue‟ The specified media should be blue.

„Yellow‟ The specified media should be yellow.

„Green‟ The specified media should be green.

„Pink‟ The specified media should be pink.

„NoColor‟ The specified media should have no color.

„Ivory‟ The specified media should be ivory.

„Gray‟ The specified media should be gray.

„Buff‟ The specified media should be buff.

„Goldenrod‟ The specified media should be goldenrod.

„Red‟ The specified media should be red.

„Orange‟ The specified media should be orange.

„Custom1‟ A custom color.






















Keyword Description


„UseAny‟ Use any ready color.

„Other‟ A color that is not one of the defined colorc.

„SystemDefault‟ Use the Device‟s default color.

1

MediaSize (collection) 2

The OPTIONAL “MediaSize” member attribute is a collection that 3

explicitly specifies the numerical XDimension(short edge) and 4

YDimension(long edge) of the media instance. 5

The “MediaSize” collection member attributes are: 6

Member Attribute

Name

Attribute Syntax

XDimension integer((1:MAX)

YDimension integer((1:MAX)

XDimension(integer((1:MAX)) 7

The “XDimension” member attribute indicates the size of the 8

media in hundredths of a millimeter along the bottom(short) edge 9

of the media. This unit is equivalent to 1/2540 th of an inch 10

resolution. 11

YDimension(integer((1:MAX)) 12

The “YDimension” member attribute indicates the size of the media 13

in hundredths of a millimeter along the left(long) edge of the media. 14

This is equivalent to 1/2540 th of an inch resolution. The specified 15

“XDimension” value MUST be less than or equal to the 16

“YDimension” value. 17

MediaType (type3 keyword | name(MAX)) 18

The OPTIONAL “MediaType” member attribute identifies the type 19

of media, i.e., the media instance‟s predominate characteristic or 20

characteristics. The MediaType attribute may be set as a custom 21

string of 1 to 128 characters or one of the keywords below. 22

Standard keyword values for “MediaType” are: 23

Keyword Description

„Bond‟ A better quality grade of paper that is

stronger and more durable than the

average sheet of paper.

„Cardstock‟ Separately cut sheets of an opaque




Keyword Description

material , heavier than Stationery.

„CardstockExtraHeavyweight‟ Card Stock that is of heavier than

Heavyweight Cardstock and is

Typically uncoated.

„CardstockExtraHeavyweightGlossy‟ Card Stock that is of heavier than

Heavyweight Cardstock and has a

glossy coating Typically on both

sides.

„CardstockExtraHeavyweightGlossyReloaded‟ Card Stock that is of heavier than

Heavyweight Cardstock and has a

glossy coating Typically on both

sides. In addition the media has been

placed in the input tray turned over

from its normal placement in that

input tray so that it can be printed on

the other side.

„CardstockHeavyweight‟ Card Stock that is of heavier than

normal weight and is Typically

uncoated.

„CardstockHeavyweightGlossy‟ Card Stock that is of heavier than

normal weight and has a glossy

coating Typically on both sides.

„CardstockHeavyweightGlossyReloaded‟ Card Stock that is of heavier than


coating Typically on both sides. In

addition the media has been placed in

the input tray turned over from its

normal placement in that input tray so

that it can be printed on the other

side.

„CardstockHeavyweightReloaded‟ Card Stock that is of heavier than


uncoated. In addition the media has

been placed in the input tray turned

over from its normal placement in that


the other side.

„CardstockLightweight‟ Card Stock that is of lighter than

normal weight and is typically

uncoated.

‟CardstockLightweightReloaded‟ Card Stock that is of lighter than

normal weight and is typically





the other side.

„CardstockPostcard‟ Separately cut sheets of an opaque

material that is heavier than




Keyword Description

„stationery‟ and which could have

xerographic properties suitable for

postcards, e.g., heavier weight and

more glossy/matte than „stationery‟.

„CardstockReloaded‟ Separately cut sheets of an opaque

material , heavier than Stationery. In





side.

„Coverstock‟ Separately cut sheets of an opaque

material used for front and back

covers.

„Custom1‟ A custom type.




















„Drilled‟ Separately cut sheets of an opaque

material with pre-drilled holes along

one edge.




Keyword Description

„Envelope‟ Envelopes that can be used for

conventional mailing purposes.

„Labels‟ Label stock [For example, a sheet of

peel-off labels].

„LabelsExtraHeavyweight‟ Label stock [For example, a sheet of

peel-off-labels‟. Heavier than „labels-

heavyweight‟.

„LabelsHeavyweight‟ Label stock [For example, a sheet of

peel-off labels]. Heavier than

„labels‟.

„Other‟ The „other‟ keyword value is used

when the media instance does not

correspond to any of the Printer‟s

supported media types.

„PaperBackedTransparency‟ Separately cut sheets of a transparent

material with an opaque paper

backing.

„Photographic‟ Separately cut sheets of an opaque

material to produce photographic

quality images. The coating is

unspecified.

„PreCutTabs‟ Media with tabs that are cut so that

more than one tab is visible extending

out beyond the edge of non-tabbed

media in an Output-Document.

„PreCutTabsHeavyweight‟ Media that is heavier than „pre-cut-

tabs‟ and with tabs that are cut so that

more than one tab is visible extending

out beyond the edge of non-tabbed

media in an Output-Document.

„Stationery‟ Separately cut sheets of an opaque

material.

„StationeryHeavyweight‟ Separately cut sheets of a heavy stock

opaque material.

„StationeryHeavyweightGlossy‟ Stationery that is of heavier than


coating typically on both sides.

‟StationeryHeavyweightGlossyReloaded‟ Stationery that is of heavier than


coating typically on both sides. In





side.

„StationeryLetterhead‟ Separately cut sheets of an opaque




Keyword Description

material with a pre-printed letterhead.

„StationeryLightweight‟ Stationery that is of lighter than


uncoated.

„StationeryLightweightGlossy‟ Stationery that is of lighter than


coating typically on both sides.

‟StationeryLightweightGlossyReloaded‟ Stationery that is of lighter than


coating typically on both sides. In





side.

„StationeryLightweightReloaded‟ Stationery that is of lighter than






the other side.

„StationeryPrePrinted‟ Separately cut sheets of an opaque

material with a pre-printed image.

„StationeryRecycled‟ Separately cut sheets of an opaque

material that contains recycled

material.

„StationeryReloaded‟ Separately cut sheets of an opaque

material. In addition the media has




the other side.

„StationeryRoughSurface‟ Separately cut sheets of an opaque

material with a rougher than normal

surface.

„SystemDefault‟ Use the Device‟s default.

„TabStock‟ Media with tabs, either pre-cut or full-

cut.

„Transparency‟ Separately cut sheets of a transparent

material.

„UseAny‟ Select any ready input tray whose

contents match the supplied “media-

col” attributes.

1




SheetCollate (keyword) 1

2

Vernacular Names Collated 3


Status Draft 5

Description This attribute specifies whether or not the media sheets of each copy 6

of each document in a job are to be in sequence, when multiple copies 7

of the document are specified by the „Copies‟ attribute. 8

For example, suppose a document produces two media sheets as 9

output, and “copies” is equal to „6‟, For the „uncollated‟ case, six 10

copies of the first media sheet are ed followed by six copies of the 11

second media sheet. For the „collated‟ case, one copy of each of the 12

six sheets are ed followed by another copy of each of the six media 13

sheets. 14

Whether the effect of sheet collation is achieved by placing copies of 15

a document in multiple output bins or in the same output bin with 16

implementation defined document separation is implementation 17

dependent. Also whether it is achieved by making multiple passes 18

over the job or by using an output sorter is implementation dependent. 19


Keyword Description

„Uncollated‟ Each print-stream sheet is printed a number of

times in succession equal to the value of the

„Copies‟ attribute, followed by the next print-

stream sheet.

„Collated‟ Each copy of each document is ed with the print-

stream sheets in sequence, followed by the next

document copy.

21

22

23




Sides (keyword) 1

Vernacular Names Sides Imaged 2


Description This attribute specifies how print-stream pages are to be imposed 4

upon the sides of an instance of a selected medium, i.e., an 5

impression. It also specifices how pages are interpreted when being 6

scanned. Thus it is used as both an input and an output attribute for a 7

job ticket. 8

The Standard keyword values are: 9

Keyword Description

„OneSided‟ imposes each consecutive print-stream page upon the

same side of consecutive media sheets.

„TwoSidedLong

Edge‟

imposes each consecutive pair of print-stream pages

upon front and back sides of consecutive media sheets,

such that the orientation of each pair of print-stream

pages on the medium would be correct for the reader

as if for binding on the long edge.

„TwoSidedShort

Edge‟

imposes each consecutive pair of print-stream pages

upon front and back sides of consecutive media sheets,

such that the orientation of each pair of print-stream

pages on the medium would be correct for the reader

as if for binding on the short edge.

10

TwoSided‟ imposes each consecutive pair of print-stream pages

upon front and back sides of consecutive media sheets;

used when the orientation specification does not

matter to the service, sucy as copy.

11

12




Scaling (collection) 1

Vernacular Names Magnification, ReduceEnlarge, Scaling 2

Service type Copy 3

Description This Scaling attribute specifies how the images should be scaled. The 4

image may be scaled in both the x and the y directions. 5

6

“Scaling” member attributes 7


Attribute Syntax

ScalingType keyword

ScaleProportional collection

ScaleIndependent collection

The “Scaling” collection member attributes definitions are: 8

ScalingType (type2 keyword) 9

The “ScalingType” member attribute specifies the type of scaling that 10

is being used. 11


13 Keyword Description

„AutoProportional‟ Specifies that the sides of the image will be scaled

proportionally. The device will determine the

amount of scaling required to fit the image on the

media.

„AutoIndependent‟ Specifies that the sides of the image will be scaled

independently. The device will determine the

amount of scaling required to fit the image on the

media.

„Proportional‟ Specifies that the sides of the image will be scaled

proportionally . The ScaleProportional collection

will be used to specify the amount of scaling.

„Independent‟ Specifies that the sides of the image will be scaled

independently. The ScaleIndependent collection

will be used to specify the amount of scaling.




ScaleProportional (collection) 1

The OPTIONAL “ScaleProportional” member attribute is a collection 2

that is used to specify that the sides of the image will be scaled 3

proportionally. This member attribute must only be used when the 4

ScalingType attribute is set to „Proportional‟. 5

The “ScaleProportional” collection member attributes are: 6

Member Attribute

Name

Attribute Syntax

ScalingValue rangeOfInteger

ScalingValue(rangeOfInteger) 7

The “ScalingValue” member attribute specifies the percentage an 8

image should be scaled. The valid values can be from 25% all the 9

way up to 400%. 10

ScaleIndependent (collection) 11

The OPTIONAL “ScaleIndependent” member attribute is a collection 12

that is used to specify that the sides of the image will be scaled 13

indepently. This member attribute must only be used when the 14

ScalingType attribute is set to „Independent‟. 15

The “ScaleIndependent” collection member attributes are: 16

Member Attribute

Name

Attribute Syntax

XScaling rangeOfInteger

YScaling rangeOfInteger

XScaling(rangeOfInteger) 17

The “XScaling” member attribute specifies the percentage an 18

image should be scaled in the x direction. The valid values can be 19

from 25% all the way up to 400%. 20

YScaling(rangeOfInteger) 21

The “YScaling” member attribute specifies the percentage an 22

image should be scaled in the y direction. The valid values can be 23

from 25% all the way up to 400%. 24

25




3. APPENDIX A: References 1

This Appendix provides additional references to documents. References to this Appendix are indicated in square 2

brackets using hot links. 3

4

Cross Reference Symbol (in

alphabetic order)

Document Title, Description, and URL

Access Token http://en.wikipedia.org/wiki/Token_(Windows_NT_architecture)

Auditron Reference Available at:

http://download.support.xerox.com/pub/drivers/CC_32C/docs/winxp/en/CC-WCP32-

40-CC-WCP2128-2636-3545_AuditronUG_1104.pdf

Error! Reference source not

found.

http://www.webopedia.com/TERM/D/domain_name.html

Equitrac Reference Available at: http://en.wikipedia.org/wiki/Equitrac

http://www.equitrac.com/solutions_office.asp

IEC 61966-2-1:1999 Multimedia systems and equipment - Colour measurement and management - Part 2-

1: Colour management - Default RGB colour space - sRGB

[ISO-838] ISO 838: 1974. Paper -- Holes for general filing purposes -- Specifications.

Specifies the hole sizes and spacing.

[JDF] Job Definition Format (JDF), Versions 1.0, 1,1, 1,2, 1.3, and 1.4 are available from

http://www.cip4.org.

[Lightweight Directory Access

Protocol (LDAP)]

The Lightweight Directory Access Protocol, or LDAP (pronounced el dap) is an

application protocol for querying and modifying directory services running over

TCP/IP. Its current version is LDAPv3, which is specified in a series of Internet

Engineering Task Force (IETF) Standard Track Requests for comments (RFCs) as

detailed in [RFC 4510].

[Error! Reference source not

found.]

http://en.wikipedia.org/wiki/Pluggable_Authentication_Modules.

[Error! Reference source not

found.]

http://www.opengroup.org/onlinepubs/8329799/chap4.htm

[PWG5101.1-2002] PWG 5101.1-2002 Standardized Media Type Names. Available as:

ftp://ftp.pwg.org/pub/pwg/candidates/cs-pwgmsn10-20020226-5101.1.pdf

[pwg-sm] “Device Working Group - Semantic Model”, PWG IEEE-ISTO 5100.1-2004

[RFC 2806] [RFC 2806] Vaha-Sipila, A., “URLs for Telephone Calls”, RFC 2806, April 2000.

Available at: http://tools.ietf.org/html/rfc2806 which describes the „tel:‟ and „fax:‟

URL schemes, among others. This RFC is obsoleted by [RFC 3966]

http://en.wikipedia.org/wiki/Token_(Windows_NT_architecture)

http://download.support.xerox.com/pub/drivers/CC_32C/docs/winxp/en/CC-WCP32-40-CC-WCP2128-2636-3545_AuditronUG_1104.pdf

http://download.support.xerox.com/pub/drivers/CC_32C/docs/winxp/en/CC-WCP32-40-CC-WCP2128-2636-3545_AuditronUG_1104.pdf

http://www.webopedia.com/TERM/D/domain_name.html

http://en.wikipedia.org/wiki/Equitrac

http://www.equitrac.com/solutions_office.asp

http://en.wikipedia.org/wiki/Application_protocol

http://en.wikipedia.org/wiki/Directory_service

http://en.wikipedia.org/wiki/Internet_protocol_suite

http://en.wikipedia.org/wiki/Internet_Engineering_Task_Force



http://en.wikipedia.org/wiki/Request_for_Comments

http://tools.ietf.org/html/rfc4510



http://en.wikipedia.org/wiki/Pluggable_Authentication_Modules

http://www.opengroup.org/onlinepubs/8329799/chap4.htm

ftp://ftp.pwg.org/pub/pwg/candidates/cs-pwgmsn10-20020226-5101.1.pdf





[RFC 3192] [RFC 3192] Allocchio, C., “Minimal FAX address format in Internet Mail”, RFC

3192, October 2001. Available at: http://tools.ietf.org/html/rfc3192

[RFC 3261] [RFC 3261] Rosenberg, J, et al, “SIP: Session Initiation Protocol”, RFC 3261, June

2002. Available at: http://tools.ietf.org/html/rfc3261

[RFC 3508] [RFC 3508] Levin, O, “H.323 Uniform Resource Locator (URL) Scheme

Registration”, RFC 3508, April 2003. Available at: http://tools.ietf.org/html/rfc3508

[RFC 3966] [RFC 2966] Schulzrinne, H., “The tel URI for Telephone Numbers”, December

2004. Available at: http://tools.ietf.org/html/rfc3966).

Note: [RFC 3966 and the „tel:‟ URI scheme obsoletes [RFC 2806] „tel:‟ and „fax:‟

schemes. The "tel" URI does not specify the call type, such as voice, fax, or data

call, and does not provide the connection parameters for a data call. The type and

parameters are assumed to be negotiated either in-band by the telephone device or

through a signaling protocol such as SIP.

[RFC 4510] Lightweight Directory Access Protocol (LDAP):Technical Specification Road Map.

Available at: http://tools.ietf.org/html/rfc4510

UPnPv1 Microsoft‟s Universal Plug N Play (UPnP), version 1 and version 2.

WSD Microsoft‟s Web Services for Devices (WSD)

[XDevCap] Xerox Device Capabilities – an XML encoding of the Device Capabilities as

specified in the [XSDF spec]

[XSDF spec] The “Xerox Service Definition Format” specification. This is a Xerox standard for

representing the results of a query of a Service, such as a Device, in XML using the

same encoding technique as XPIF that is suitable for use with a DTD.

Available at: http://xww.docushare-

innovation.world.xerox.com/dsweb/View/Collection-95235

1





http://xww.docushare-innovation.world.xerox.com/dsweb/View/Collection-95235

http://xww.docushare-innovation.world.xerox.com/dsweb/View/Collection-95235




4. Appendix B: Document History 1

Document Revision 2

Version Date Description

Author

1.0.0 10/10/09 Created C. Miyachi

1.0.2 06/20/10 Added support for Job Limits J. Howell

1.0.3 06/27/10 Added input tray collection attribute; fixed figures to show new job model elements for job limits; added section on ticket consumption and validation

C. Miyachi

1.0.4 8/11/10 Changed JobIdFromClient to ClientID to match the Job Management and Copy WSDL implementations.

J. Howell

1.0.5 8/24/10 Added new custom numbers for Media Color and Media Type and added new media type keyword called “Photographic”; Updated new definition of schemaVersion.

C. Miyachi

1.0.6 9/1/10 Added Tray Level C. Miyachi

1.0.7 9/9/10 Changed descriptions of MediaColor, MediaType, and Scaling. Added JobIdentifier.

J. Howell

1.0.8 9/17/10 Added some more staple values. J. Howell

1.0.9 11/4/10 Added information about invalid optional elements C. Miyachi

1.0.10 12/12/10 Made job state reasons unbounded so there can be more than one returned in JobInfo payload

C. Miyachi

1.0.11 3/25/11 CQGbl00304183 – Updated the list of valid media types J. Howell

1.0.12 4/5/11 CQGbl00306419 – Removed ServiceOffline job state reason as it

is not being used / description is confusiong in CPSS; Added

definition of “Device”

C. Miyachi

1.0.13 04/20/11 CQGbl00305904 – removed xs:any from the schema figures

CQGbl00311386 – clean up for SDK

C. Miyachi

1.0.14 07/25/11 CQGbl00325672: Added new job state reason

"OutOfAccountingResources"

C. Miyachi

3

Date post:	26-Nov-2015
Category:	Documents
Upload:	corvo000
View:	83 times
Download:	15 times

EIP Job Model Attributes Spec.pdf

Documents