Вы находитесь на странице: 1из 54

EIP Job Model

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 Specification Copyright 2011, Xerox Corporation.

EIP Job Model


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 Specification Copyright 2011, Xerox Corporation.

ii

EIP Job Model

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 Removal Error! Bookmark not define 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 Specification Copyright 2011, Xerox Corporation.

iii

EIP Job Model


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 Specification Copyright 2011, Xerox Corporation.

iv

EIP Job Model Tables


Table 1-1 Attribute types .................................................................................................................................................. 12 Table 5-2: Generic "Finishings" values ............................................................................................................................ 18 Table 3: InputTraysCol member attributes.................................................................................................................... 22

EIP Job Model Specification Copyright 2011, Xerox Corporation.

EIP Job Model 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 Specification Copyright 2011, Xerox Corporation.

vi

EIP Job Model

1. Introduction
This specification defines the schemas assocated with the EIP Job Model. The Model defines data structures that describe job status, job status details, and job tickets. The semantics of the EIP Job Model are based on the CPSS (Common Print Semantic Specification) and have been extended to include attributes for other job types besides . The EIP Job Model also borrows its design from the Device Working Group (www.pwg.org) which has recently defined a job model for a Multi-Function Device (MFD).

2 3 4 5 6

7 8 9 10 11

1.1 Conformance Terminology


The capitalized words MUST, CONDITIONALLY REQUIRED (or CMUST), MUST NOT, CONDITIONALLY RECOMMENDED, REQUIRED, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL in this document are to be interpreted as conformance terminology as described in RFC 2119 [RFC2119].

12 13

1.2 Terminology
This section contains definitions of terminology used in this document.
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

16 17 18 19 20 21

1.3 Structure of the EIP Job Model


The EIP Job Model is used to describe both a job ticket and a job status. It supports ticket definition used in job submsions and defines the data being returned in both the job queue and details about a particular job. Versioning of these elements is done via an XML element. The element is defined with three sub elements major, minor, and revision. For example, version 1.1.0 is the major version 1, the minor version 1, and the revision number 0. See the API specification for definition of major, minior, and revision.

EIP Job Model Specification Copyright 2011, Xerox Corporation.

EIP Job Model


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

3 4 5 6 7 8

Figure 1 - The Job Queue Schema Each job in the queue, both active and completed, will contain the same information for each job. The one difference is that the completed job log will contain the time the job completed. The job ticket for the Copy Service is shown below. This schema defines the XML document which will be submitted to initiate a copy.

EIP Job Model Specification Copyright 2011, Xerox Corporation.

EIP Job Model

1 2 3 4 5 6 7 Figure 2 - The Copy Job Ticket Note all the optional attributes. If the attribute is not specified, the device default will be used on the MFD. The copy job ticket is limited in size to 10240 when used with the WS-CopyService WSDL. If details about a particular job are requested of the copy service, an XML document defined by the following schema is returned.

EIP Job Model Specification Copyright 2011, Xerox Corporation.

EIP Job Model

1 2 3 4 5 6 Figure 3 - The Copy Job details The JobInfo is the same JobInfo as defined in the job-queue. The copy-job-receipt is exactly the same as the copy-jobticket but all attributes are required. This receipt defines what actually was set on the job. The figure below represents basic Job Information returned in a job queue:

EIP Job Model Specification Copyright 2011, Xerox Corporation.

10

EIP Job Model

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

3 4 5 6 7 8 9

1.4 Processing an EIP Job Ticket


If an attribute is not supported by the device, the device will ignore that attribute and execute the job. If an attribute has a enumeration value that is not supported by the device, the device will use its default for that attribute. If the optional attribute is not understood or invalid, the element will be ignored. All attributes apply to the entire job. There are no page level attributes. Exceptions to this rule (for example, when empty strings are considered valid), will be noted in individual elements.

10 11 12

1.5 Attribute Types


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

EIP Job Model Specification Copyright 2011, Xerox Corporation.

11

EIP Job Model


1 Table 1-1 Attribute types Attribute Syntax Example Parameter Value To Encode Logical True UTF-8

boolean charset collection dateTime integer keyword mimeMediaType name rangeOfInteger

Same as XML schema dateTime 500 (five hundred) completed application/octetprint-stream Billy Lower-bound value is 1 Upper-bound value is 99,999

resolution text uri

300x600 dpi Billys Job ipp://CPSJALAPENO.sdi.na.xde3.xerox.org/ CPS-JALAPENO_HOLD

2 3

EIP Job Model Specification Copyright 2011, Xerox Corporation.

12

EIP Job Model Specification v 1.0.13


1

2. Job Model Attributes and Values


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

EIP Job Model Specification Copyright 2011, Xerox Corporation.

13

EIP Job Model Specification v 1.0.13


1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

ColorEffectsType
Vernacular Names Service type Summary Output Color Print, Copy Render full color document in full color or grayscale.

Description

This attribute indicates whether a color document should be rendered in full color or should be rendered using an algorithm that maps the full range of colors to alternate values, such as gray scale or monochrome. This capability allows a full color document to render to a color document in monochrome or grayscale or black and white as a way to save time, toner, or cost when proofing a document. If the Device supports this attribute, it MUST support the Color and MonochromeGrayscale values. If a color Device does not support this attribute, the Device MUST provide the Color behavior. Black and white Devices and highlight color Devices MUST NOT support this attribute. Standard keyword values are:
Keyword Color Monochrome Grayscale Description all color content of the document MUST be preserved and rendered in color. 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. Automatically detect the color when scanning the document and use that setting on the output.

Auto

19 20 21 22 23

EIP Job Model Specification Copyright 2011, Xerox Corporation.

14

EIP Job Model Specification v 1.0.13


1 2 3 4 5 6 7 8 9

Copies (integer(1:MAX))
Vernacular Names Service type Description Copies, Quantity Print, Copy This attribute specifies the number of copies to be printed. On many devices the supported number of collated copies will be limited by the number of physical output bins on the device, and may be different from the number of uncollated copies which can be supported

EIP Job Model Specification Copyright 2011, Xerox Corporation.

15

EIP Job Model Specification v 1.0.13


1 2 3 4 5

DateTimeAtCompleted (dateTime)
Service type Description Generic This OPTIONAL attribute indicates the date and time at which the Job completed (or was cancelled or aborted).

EIP Job Model Specification Copyright 2011, Xerox Corporation.

16

EIP Job Model Specification v 1.0.13


1 2 3 4 5 6 7

DateTimeAtCreation (dateTime)
Service type Status Description Generic Draft This OPTIONAL attribute indicates the date and time at which the Job was created..

EIP Job Model Specification Copyright 2011, Xerox Corporation.

17

EIP Job Model Specification v 1.0.13


1 2 3 4 5 6 7 8 9 10 11 12 13

Finishings (keyword)
Vernacular Names Service type Finsihings Print, Copy This finishings attribute identifies the finishing operations that the Device uses for each copy of each document in the Job This element contains three subelements StapleFinishing PunchFinishing FoldFinishing Standard values are: Table 5-2: Generic "Finishings" values
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 sitedefined. 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 sitedefined. 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 sitedefined.

Description

EIP Job Model Specification Copyright 2011, Xerox Corporation.

18

EIP Job Model Specification v 1.0.13


EdgeStitchBottom: Bind the document(s) with one or more staples (wire sti tches) along the bottom edge. The exact number and placement of the staples is implementation and/or sitedefined. 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.

EIP Job Model Specification Copyright 2011, Xerox Corporation.

19

EIP Job Model Specification v 1.0.13


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 None: Perform no finishing 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
holes is implementation and/or site-defined

Punch2HoleRight: Punch two holes along the right edge. The exact placement of the
holes is implementation and/or site-defined

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
holes is implementation and/or site-defined

EIP Job Model Specification Copyright 2011, Xerox Corporation.

20

EIP Job Model Specification v 1.0.13


Punch3HoleTop: Punch three holes along the top edge. The exact placement of the
holes is implementation and/or site-defined

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
holes is implementation and/or site-defined

Punch4HoleTop: Punch four holes along the top edge. The exact placement of the
holes is implementation and/or site-defined

punch-4-hole-right: Punch four holes along the right edge. The exact placement of
the holes is implementation and/or site-defined

Punch4HoleRight: Punch four holes along the bottom edge. The exact placement of
the holes is implementation and/or site-defined

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 None: Perform no finishing 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.

EIP Job Model Specification Copyright 2011, Xerox Corporation.

21

EIP Job Model Specification v 1.0.13


1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

InputTraysCol (1setOf collection)


Vernacular Name Service type Summary Input Tray Copy A collection that identifies the media loaded in each tray of the Device as well as other device configuration information such as feed orientation, capacity and current level.

Description

This attribute uses collections to identify the current state of input trays. Each collection returned by the InputTraysCol attribute in the future, will identify the media configured for each tray of the Device, plus device capability and status information including tray name, feed orientation, tray capacity, tray status, the current level of media in the tray, and the position of the tray relative to the fuser. For EIP presently only the input tray name is in this collection.

Member Attributes for the InputTraysCol Device Description Attribute


Error! Reference source not found. lists the member attributes of the InputTraysCol collection attribute: Table 3: InputTraysCol member attributes
Member Attribute Name Error! Reference source not found. TrayLevel Attribute Syntax

keyword | name (MAX)

integer (-1:100)

20 21 22 23 24 25 26 27 28 29 30 31 32 33 34

The InputTraysCol collection member attributes definitions are:

InputTrayName ( keyword | name(MAX))


The InputTrayName member attribute indicates the keyword name of the input tray (sometimes called an input feeder).

TrayLevel (integer(-1:100))
The TrayLevel element indicates the percentage of the capacity remaining in the tray. The value returned is a percentage of the maximum of media that can be put into the tray. A value of 0 indicates that there is no media remaining, or that only a small amount of media remains in the tray which cannot be fed by the device without more sheets being loaded, depending on the implementation. Whether the defaults switches to another tray or faults when it tries to feed from this tray when the value is 0 is implementation dependent.

EIP Job Model Specification Copyright 2011, Xerox Corporation.

22

EIP Job Model Specification v 1.0.13


1 2 3 4 5 6 7 8 The TrayLevel member attribute is expressed in whole percentage points. If the device cannot determine the level of paper in the tray, it MUST return a value of -1 to indicate an unknown level. If the device conveys a tray level but can only sense a small number of discreet levels, such as empty, low, etc., the device SHOULD NOT support TrayLevel which would give users a mis-leading reading.

EIP Job Model Specification Copyright 2011, Xerox Corporation.

23

EIP Job Model Specification v 1.0.13


1 2 3 4 5 6 7 8 9 10

JobId (name(MAX))
Service type Status Description Print, Copy Draft This REQUIRED attribute contains the ID of the job. The Device, on receipt of a new job, generates an ID which identifies the new Job on that Device. The Device returns the value of the JobId attribute as part of the response to a create request. The 0 value is not included to allow for compatibility with SNMP index values which also cannot be 0.

EIP Job Model Specification Copyright 2011, Xerox Corporation.

24

EIP Job Model Specification v 1.0.13


1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

ClientId (name(MAX))
Service type Status Summary Generic draft Allows the client to supply a job identifier that clients can query to determine status of the job by scanning jobs returned by the Device in obtain job status and/or use for human communication with the Devices operator.

Description

The client OPTIONALLY supplies this attribute. The Device object OPTIONALLY supports this attribute. It contains a job identifier created by the client. The client MAY automatically include any information that will help the client distinguish amongst the jobs that it has submitted.

Job Forwarding
When a Device forwards a job, the jobs ClientId is forwarded as received by the Device. In other words, these values are preserved throughout the workflow that involved Job Forwarding (rather than being changed to the JobId value generated by the Device that is performing the Job Forwarding).

EIP Job Model Specification Copyright 2011, Xerox Corporation.

25

EIP Job Model Specification v 1.0.13


1 2 3 4 5 6 7

JobIdentifier (collection)
Service type Status Description Generic draft The JobIdentifier attribute is used to specify what type of job identification is being used and the value for that identifier.

JobIdentifier member attributes


Member Attribute Name JobIdentifierType JobIdentifierString keyword name Attribute Syntax

8 9 10 11 12 13 14 15 16 17 18 19 20

The JobIdentifier collection member attributes definitions are:

JobIdentifierType (type2 keyword)


The JobIdentifierType member attribute specifies the type of job identifier being used. Standard keyword values are:
Keyword JobId ClientId Description See the JobId description above for details. See the ClientId description above for details.

JobIdentifierString (name)
The JobIdentifierString member attribute specifies the vlaue for the identifier specified in the JobIdentifierType member attribute.

EIP Job Model Specification Copyright 2011, Xerox Corporation.

26

EIP Job Model Specification v 1.0.13


1 2 3 4 5 6 7 8 9 10 11 12 13

JobName (name(MAX))
Service type Status Description Generic Draft The client OPTIONALLY supplies this attribute. The Device object MUST support this attribute. It contains the client supplied Job name. If this attribute is supplied by the client, its value is used for the JobName attribute of the newly created Job object. The client MAY automatically include any information that will help the enduser distinguish amongst his/her jobs, such as the name of the application program along with information from the document, such as the document name, document subject, or source file name. If this attribute is not supplied by the client, the Device generates a name to use in the JobName attribute of the newly created Job object

EIP Job Model Specification Copyright 2011, Xerox Corporation.

27

EIP Job Model Specification v 1.0.13


1 2 3 4 5 6

JobState (keyword)
Service type Description Generic This REQUIRED attribute identifies the current state of the job. Implementations only need to support those states which are appropriate for the particular implementation. Standard enum values are:
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 jobs 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 hasnt 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 objects Device-state, Device-statereasons, and Device-state-message attributes. Implementations MAY, though they NEED NOT, include additional values in the jobs 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 wont 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 jobs JobStateReasons attribute MAY indicate why the job has stopped processing. For example, if the

EIP Job Model Specification Copyright 2011, Xerox Corporation.

28

EIP Job Model Specification v 1.0.13


output device is stopped, the Device-stopped value MAY be included in the jobs 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 objects Device-state, Device-state-reasons and Devicestate-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 jobs JobStateReasons attribute SHOULD contain the processing-to-stop-point value and one of the canceled-by-user, canceled-by-operator, or canceledat-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 jobs 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 jobs JobStateReasons attribute SHOULD contain one of: CompletedSuccessfully, CompletedWithWarnings, or CompletedWithErrors values.

1 2 3 4 5 6 7 8 9 10 11 12

The final value for this attribute MUST be one of: Completed, Canceled, or Aborted before the Device removes the job altogether. The length of time that jobs remain in the Canceled, Aborted, and Completed states depends on implementation. The following figure shows the normal job state transitions
+ Canceled / + Pending Processing --------- + Completed | ^ ^ \ + | | + Aborted | v v / + PendingHeld ProcessingStopped --+

EIP Job Model Specification Copyright 2011, Xerox Corporation.

29

EIP Job Model Specification v 1.0.13


1 2 3 4 5 6 7 8 9 10 11 Normally a job progresses from left to right. Other state transitions are unlikely, but are not forbidden. Not shown are the transitions to the Canceled state from the pending, PendingHeld, and ProcessingStopped states. Jobs reach one of the three terminal states: Completed, Canceled, or Aborted, after the jobs have completed all activity, including stacking output media, after the jobs have completed all activity, and all job status attributes have reached their final values for the job.

EIP Job Model Specification Copyright 2011, Xerox Corporation.

30

EIP Job Model Specification v 1.0.13


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

JobStateReasons (keyword)
Service type Summary Generic Augments the "JobState" attribute to give more detailed information about this Jobs state. There can be more than one keyword in this element.

Description

This REQUIRED attribute provides additional information about the job's current state, i.e., information that augments the value of the job's "JobState" attribute. These values MAY be used with any job state or states for which the reason makes sense. Some of these value definitions indicate conformance requirements; the rest are OPTIONAL. Furthermore, when implemented, the Device MUST return these values when the reason applies and MUST NOT return them when the reason no longer applies whether the value of the Job's "JobState" attribute changed or not. When the Job does not have any reasons for being in its current state, the value of the Job's "JobStateReasons" attribute MUST be 'none'. Note: While values cannot be added to the 'JobState' attribute without impacting deployed clients that take actions upon receiving "JobState" values, it is the intent that additional "JobStateReasons" values can be defined and registered without impacting such deployed clients. In other words, the "JobStateReasons" attribute is intended to be extensible. When this attribute contains more than one reason, the reasons MUST be ordered with the most important first and the least important last. The most important is usually the reason that caused the last state transition. The determination of the importance of a state reason is implementation specific. The level of severity associated with a reason indicates its importance. Error is more important than warning and warning is more important than report. The following standard keyword values are defined. For ease of understanding, the values are presented in the order in which the reasons are likely to occur (if implemented), starting with the 'JobHoldUntil-specified' value: None: There are no reasons for the jobs current state. This state reason is semantically equivalent to JobStateReasons without any value and MUST be used when there is no other value, since the 1setOf attribute syntax requires at least one value. JobHoldUntilSpecified: The value of the jobs JobHoldUntil attribute was specified with a time period that is still in the future. The job MUST NOT be a candidate for processing until this reason is removed and there are no other reasons to hold the job. This value SHOULD be supported if the JobHoldUntil Job Template attribute is supported. JobHeldOnCreate: The job is currently being held in the PendingHeld state because the operator had previously issued a Hold-New-Jobs Device operation (see Section 2.4 of CPSS

EIP Job Model Specification Copyright 2011, Xerox Corporation.

31

EIP Job Model Specification v 1.0.13


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 Volume 2Operations). The job may be made a candidate for scheduling, i.e., moved to the pending state, by either the Release-Job or the Release-Held-New-Job operations (see Section 2.4 of CPSS Volume 2Operations). JobPasswordWait: The job is currently being held until the correct password is entered at the device. If the JobPassword Operation attribute (See description earlier in this section) is supported, this value MUST be supported. ProofPrintWait: The job is currently being held until the operator verifies the output of the proof print and performs a Release-Job operation. If the proof-print Job Template attribute (See description later in this section) is supported, this value MUST be supported. ContextBasedRestrictionsViolated: The Device/Service object accepted the job before checking the context based restrictions for the supplied user and application that was submitting the Job Creation Operation and subsequently found that one or more supplied job creation attributes violated the Devices/Services Context Based Restrictions configured by the administrator.

ResourcesAreNotSupported: At least one of the resources needed by the job, such as media, fonts, resource objects, etc., is not supported on any of the physical Devices for which the job is a candidate. This condition MAY be detected when the job is accepted, or subsequently while the job is pending or processing, depending on implementation. The job may (1) remain in its current state, (2) be moved to the PendingHeld state, depending on implementation and/or job scheduling policy, or (3) scheduled normally, but the Device is put into the stopped state when the job is attempted to be processed on the Device. ResourcesAreNotReady: At least one of the resources needed by the job, such as media, fonts, resource objects, etc., is not ready on any of the physical Devices for which the job is a candidate. This condition MAY be detected when the job is accepted, or subsequently while the job is pending or processing, depending on implementation. The job may remain in its current state or be moved to the PendingHeld state, depending on implementation and/or job scheduling policy. JobIncoming: Either (1) the Device has accepted the Create-Job operation and is expecting additional Send-Document and/or Send-URI operations or (2) the Device is retrieving/accepting document data as a result of a Print-Job, Print-URI, SendDocument or Send-URI operation. JobSpooling: Same as JobIncomingwith the specialization that the Device is spooling the document data before processing it. This value corresponds to the spool or automatic value of the jobspooling-supported Device Description attribute.

EIP Job Model Specification Copyright 2011, Xerox Corporation.

32

EIP Job Model Specification v 1.0.13


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 49 JobStreaming: Same as JobIncomingwith the specialization that the Device is processing the document data as it is being received (that is, the job is not being spooled, but rather is being processed in chunks by the output device and is being imaged during reception). This value corresponds to the stream or automatic value of the job-spooling-supported Device Description attribute. JobDataInsufficient: The Create-Job operation has been accepted by the Device, but the Device is expecting additional document data before it can move the job into the Processing state. If a Device starts processing before it has received all data, the Device removes the JobDataInsufficient reason, but the JobIncoming remains. If a Device starts processing after it has received all data, the Device removes the JobDataInsufficient reason and the job-incoming at the same time. UnsupportedCompression: The job was aborted by the system because the Device determined while attempting to decompress the document-datas that the compression is actually not among those supported by the Device. This value MUST be supported, since compressions is a REQUIRED operation attribute. CompressionError: The job was aborted by the system because the Device encountered an error in the document-data while decompressing it. If the Device posts this reason, the documentdata has already passed any tests that would have led to the unsupported-compression JobStateReasons. DocumentAccessError: After accepting a Print-URI or Send-URI request, the Device could not access one or more documents passed by reference. This reason is intended to cover any file access problem, including file does not exist and access denied because of an access control problem. The Device MAY also indicate the document access error using the job-documentaccess-errors Job Description attribute (see the description of job-document-access-errors above). Whether the Device aborts the job and moves the job to the aborted job state or prints all documents that are accessible and moves the job to the completed job state and adds the completed-with-errors value in the jobs JobStateReasons attribute depends on implementation and/or site policy. This value SHOULD be supported if the Print-URI or Send-URI operations are supported. UnsupportedDocumentFormat: The job was aborted by the system because the document-datas document-format is not among those supported by the Device. If the client specifies the document-format as application/octetprint-stream, the Device MAY abort the job and post this reason even though the format is a member of the document-format-supported Device attribute, but not among the auto-sensed document-formats. This value MUST be supported, since document-format is a REQUIRED operation attribute.

EIP Job Model Specification Copyright 2011, Xerox Corporation.

33

EIP Job Model Specification v 1.0.13


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 49 DocumentFormatError: The job was aborted by the system because the Device encountered an error in the document-data while processing it. If the Device posts this reason, the document-data has already passed any tests that would have led to the unsupported-document-format JobStateReasons. SavePasswordMismatch: A Print With Job (see Error! Reference source not found. (1setOf collection) Job Template attributes attempted to reference a saved job, but the supplied Error! Reference source not found. attribute in the Print With Job did not match the saved jobs Error! Reference source not found. attribute supplied when the job was saved (see Error! Reference source not found. (collection) Job Template attribute). The Device MAY (1) process the job ignoring the saved job, (2) fault the job and wait for Operator intervention to provide a matching password or (3) abort the job depending on implemenation, including configuration. SavePasswordNotSupplied: A Print With Job (see Error! Reference source not found. (1setOf collection) Job Template attributes attempted to reference a saved job, but no Error! Reference source not found. attribute was supplied in the Print With Job for a saved job that had been saved with a Error! Reference source not found. attribute supplied when the job was saved (see Error! Reference source not found. (collection) Job Template attribute). The Device MAY (1) process the job ignoring the saved job, (2) fault the job and wait for Operator intervention to provide a matching password or (3) abort the job depending on implemenation, including configuration. DigitalSignatureTypeNotSupported: One or more documents in the Job contain a digital signature type that is not supported. Implementation or site policy determines the state of the Job once this condition is detected. JobDigitalSignatureWait: The Job is currently being held because the Job was submitted with a document-digital-signature attribute value that is not supported. DigitalSignatureDidNotVerify: One or more documents in the Job contains a digital signature type that is supported (see document-digital-signature Operation attribute), but the signature did not verify when the Device attempted to verify the signature. SubmissionInterrupted: The job was not completely submitted for some unforeseen reason, such as: (1) the Device has crashed before the job was closed by the client, (2) the Device or the document transfer method has crashed in some non-recoverable way before the document data was entirely transferred to the Device, (3) the client crashed or failed to close the job before the time-out period. See the description of the multiple-operationtime-out status code in Section 2.4 of CPSS Volume 3Status Codes.

EIP Job Model Specification Copyright 2011, Xerox Corporation.

34

EIP Job Model Specification v 1.0.13


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 JobOutgoing: The Device is transmitting the job to the output device. JobScheduling: The Device is in the process of scheduling the processing for the job. JobQueued: Job is in the processing state, but more specifically, the Device has queued the document data. JobTransforming: Job is in the processing state, but more specifically, the Device is interpreting document data and producing another electronic representation. ManualCheckRequested: The job was supplied with media-col / Error! Reference source not found. = manual-check. See media-col / Error! Reference source not found. Description which covers Devices that have a queue and those that dont. After the Job has entered the ProcessingStopped state and the Error! Reference source not found. has confirmed that the requested media is loaded, the Device removes the manual-check-requested value, changes the jobs JobState back to processing and continues processing the job. JobInterpreting: Job is in the processing state, but more specifically, the Device is interpreting the document data. JobQueuedForMarker: Job is in any of the PendingHeld, Pending, or Processing states, but more specifically, the Device has completed enough processing of the document to be able to start marking and the job is waiting for the marker. Systems that require human intervention to release jobs using the Release-Job operation, put the job into the PendingHeld job state. Systems that automatically select a job to use the marker put the job into the Pending job state or keep the job in the Processing job state while waiting for the marker, depending on implementation. All implementations put the job into (or back into) the processing state when marking does begin. JobPrinting: The output device is marking media. This value is useful for Devices which spend a great deal of time processing (1) when no marking is happening and then want to show that marking is now happening or (2) when the job is in the process of being canceled or aborted while the job remains in the processing state, but the marking has not yet stopped so that impression or sheet counts are still increasing for the job. DeviceStoppedPartly: The value of the Devices Device-statereasons attribute contains the value stopped-partly. DeviceStopped: The value of the Devices Device-state attribute is stopped. JobSuspending: The Device is in the process of moving the job from a processing condition to a suspended condition where other jobs can be processed. JobSuspended: The job has been suspended while processing using the Suspend-Current-Job operation and other jobs can be

EIP Job Model Specification Copyright 2011, Xerox Corporation.

35

EIP Job Model Specification v 1.0.13


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 processed on the Device. The Job can be resumed using the Resume-Job operation which removes this value JobSuspendedByOperator: The job has been indefinitely suspended by the Device operator. JobSuspendedByUser: The job has been indefinitely suspended by the user. JobSuspendedBySystem: The job has been indefinitely suspended by the Devices system software during normal processing of the job. JobResuming: The Device is in the process of moving the job from a suspended condition to a candidate for processing. JobCanceledByUser: The job was canceled by the owner of the job using the Cancel-Job request, i.e., by a user whose authenticated identity is the same as the value of the originating user that created the Job object, or by some other authorized end-user, such as a member of the job owners security group. This value SHOULD be supported. JobCanceledByOperator: The job was canceled by the operator using the Cancel-Job request, i.e., by a user who has been authenticated as having operator privileges (whether local or remote). If the security policy is to allow anyone to cancel anyones job, then this value may be used when the job is canceled by other than the owner of the job. For such a security policy, in effect, everyone is an operator as far as canceling jobs is concerned. This value SHOULD be supported if the implementation permits canceling by other than the owner of the job. JobCanceledAtDevice: The job was canceled by an unidentified local user, i.e., a user at a console at the device. This value SHOULD be supported if the implementation supports canceling jobs at the console. AbortedBySystem: The job (1) is in the process of being aborted, (2) has been aborted by the system and placed in the aborted state, or (3) has been aborted by the system and placed in the pending-held state, so that a user or operator can manually try the job again. This value SHOULD be supported. ProcessingToStopPoint: The requester has issued a Cancel-Job operation or the Device object has aborted the job, but is still performing some actions on the job until a specified stop point occurs or job termination/cleanup is completed. If the implementation requires some measurable time to cancel the job in the processing or ProcessingStopped job states, the CPSS object MUST use this value to indicate that the Device object is still performing some actions on the job while the job remains in the processing or ProcessingStopped state. After all the jobs job description attributes have stopped incrementing, the Device object moves the job from the processing state to the canceled or aborted job states.

EIP Job Model Specification Copyright 2011, Xerox Corporation.

36

EIP Job Model Specification v 1.0.13


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 NOTE: The semantics of this attribute or the set of valid values may be different for different document formats. WarningsDetected: If the Device supports the value warningsdetected, the Device MUST add it to JobStateReasons when it generates the first warning message. That is, a single occurrence of this value is present in the JobStateReasons if the Device has generated one or more warnings. JobCompletedSuccessfully: The job completed successfully. There were no warnings or errors in printing, and no errors in saving of jobs or Forms. This value SHOULD be supported. JobCompletedWithWarnings: The print part of the job completed with warnings (whether or not there were save errors for jobs or Forms). This value SHOULD be supported if the implementation detects warnings. JobCompletedWithErrors: The print part of the job completed with errors (and possibly warnings too) (whether or not there were save errors for jobs or Forms). This value SHOULD be supported if the implementation detects errors. JobSaving: The Device is transmitting the job to the save location. This is similar to the job-printing value. JobSaveError: The job did not save successfully (whether or not it was printed successfully, printed with warnings, printed with errors, or not printed). The Device MUST ensure that none of the saved job is accessible, if it was unable to successfully save all of the job. JobRestartable: This job is retained (see the description of JobState above, specifically Partitioning of Job States) and is currently able to be restarted using the Restart-Job operation (see Section 2.4 of CPSS Volume 2Operations). If job-restartable is a value of the jobs JobStateReasons attribute, then the CPSS object MUST accept a Restart-Job operation for that job. This value SHOULD be supported if the Restart-Job operation is supported. QueuedInDevice: The job has been forwarded to a device or print system that is unable to send back status. The Device sets the jobs JobState attribute to completed and adds the queued in-device value to the jobs JobStateReasons attribute to indicate that the Device has no additional information about the job and never will have any better information. See the description of the JobState attribute above, specifically the portion on Forwarding Servers. JobHeldForAuthorization: The job has been held waiting for the Job Limits service to determine if the user has permission for the job to proceed. OutOfAccountingResources: The job has been rejected by the Job Limits server.

EIP Job Model Specification Copyright 2011, Xerox Corporation.

37

EIP Job Model Specification v 1.0.13


1

EIP Job Model Specification Copyright 2011, Xerox Corporation.

38

EIP Job Model Specification v 1.0.13


1 2 3 4 5 6 7

JobType (keyword)
Vernacular Names Service type Description Job Type Generic This attributre defines the type of job being returned.

Standard enum values are: Table 5-55: Generic "job-type" values


Name and Description Copy: a copy job Print: a print job. WorkflowScanning: a scan job

EIP Job Model Specification Copyright 2011, Xerox Corporation.

39

EIP Job Model Specification v 1.0.13


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.

EIP Job Model Specification Copyright 2011, Xerox Corporation.

40

EIP Job Model Specification v 1.0.13


1 2 3 4 5 6 7 8 9

MediaCol (collection)
Vernacular Names Service type Status Description MediaCol Print, Copy Draft This MediaCol attribute identifies the characteristics of a media. . Each member attribute of the collection identifies a media characteristic.

MediaCol member attributes


Member Attribute Name FeedOrientation MediaColor MediaSize MediaType keyword keyword | name collection keyword | name Attribute Syntax

10 11 12 13 14 15

The MediaCol collection member attributes definitions are:

FeedOrientation (type2 keyword)


The OPTIONAL FeedOrientation member attribute specifies the media edge which is fed into the print engine from the paper tray. Standard keyword values are:
Keyword LongEdgeFirst ShortEdgeFirst Description The specified media is fed using the long edge first. The specified media is fed using the short edge first.

16 17 18 19 20 21

MediaColor (type3 keyword | name(MAX))


The OPTIONAL MediaColor member attribute indicates the desired color of the media being specified. The MediaColor attribute may be set as a custom string of 1 to 128 characters or one of the keywords below. Standard keyword values for MediaColor are:
Keyword Description

EIP Job Model Specification Copyright 2011, Xerox Corporation.

41

EIP Job Model Specification v 1.0.13


Keyword White Blue Yellow Green Pink NoColor Ivory Gray Buff Goldenrod Red Orange Custom1 Custom2 Custom3 Custom4 Custom5 Custom6 Custom7 Custom8 Custom9 Custom10 Custom11 Custom12 Custom13 Custom14 Custom15 Custom16 Custom17 Custom18 Custom19 Description The specified media should be white. The specified media should be blue. The specified media should be yellow. The specified media should be green. The specified media should be pink. The specified media should have no color. The specified media should be ivory. The specified media should be gray. The specified media should be buff. The specified media should be goldenrod. The specified media should be red. The specified media should be orange. A custom color. A custom color. A custom color. A custom color. A custom color. A custom color. A custom color. A custom color. A custom color. A custom color. A custom color. A custom color. A custom color. A custom color. A custom color. A custom color. A custom color. A custom color. A custom color.

EIP Job Model Specification Copyright 2011, Xerox Corporation.

42

EIP Job Model Specification v 1.0.13


Keyword Custom20 UseAny Other SystemDefault A custom color. Use any ready color. A color that is not one of the defined colorc. Use the Devices default color. Description

1 2 3 4 5 6

MediaSize (collection)
The OPTIONAL MediaSize member attribute is a collection that explicitly specifies the numerical XDimension(short edge) and YDimension(long edge) of the media instance. The MediaSize collection member attributes are:
Member Attribute Name XDimension YDimension Attribute Syntax

integer((1:MAX) integer((1:MAX)

7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

XDimension(integer((1:MAX)) The XDimension member attribute indicates the size of the media in hundredths of a millimeter along the bottom(short) edge of the media. This unit is equivalent to 1/2540 th of an inch resolution. YDimension(integer((1:MAX)) The YDimension member attribute indicates the size of the media in hundredths of a millimeter along the left(long) edge of the media. This is equivalent to 1/2540 th of an inch resolution. The specified XDimension value MUST be less than or equal to the YDimension value.

MediaType (type3 keyword | name(MAX))


The OPTIONAL MediaType member attribute identifies the type of media, i.e., the media instances predominate characteristic or characteristics. The MediaType attribute may be set as a custom string of 1 to 128 characters or one of the keywords below. Standard keyword values for MediaType are:
Keyword Bond Description A better quality grade of paper that is stronger and more durable than the average sheet of paper. Separately cut sheets of an opaque

Cardstock

EIP Job Model Specification Copyright 2011, Xerox Corporation.

43

EIP Job Model Specification v 1.0.13


Keyword Description material , heavier than Stationery. CardstockExtraHeavyweight Card Stock that is of heavier than Heavyweight Cardstock and is Typically uncoated. Card Stock that is of heavier than Heavyweight Cardstock and has a glossy coating Typically on both sides. 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. Card Stock that is of heavier than normal weight and is Typically uncoated. Card Stock that is of heavier than normal weight and has a glossy coating Typically on both sides. Card Stock that is of heavier than normal weight 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. Card Stock that is of heavier than normal weight and is Typically uncoated. 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. Card Stock that is of lighter than normal weight and is typically uncoated. Card Stock that is of lighter than normal weight and is typically uncoated. 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. Separately cut sheets of an opaque material that is heavier than

CardstockExtraHeavyweightGlossy

CardstockExtraHeavyweightGlossyReloaded

CardstockHeavyweight

CardstockHeavyweightGlossy

CardstockHeavyweightGlossyReloaded

CardstockHeavyweightReloaded

CardstockLightweight

CardstockLightweightReloaded

CardstockPostcard

EIP Job Model Specification Copyright 2011, Xerox Corporation.

44

EIP Job Model Specification v 1.0.13


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 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. Separately cut sheets of an opaque material used for front and back covers. A custom type. A custom type. A custom type. A custom type. A custom type. A custom type. A custom type. A custom type. A custom type. A custom type. A custom type. A custom type. A custom type. A custom type. A custom type. A custom type. A custom type. A custom type. A custom type. A custom type. Separately cut sheets of an opaque material with pre-drilled holes along one edge.

Coverstock

Custom1 Custom10 Custom11 Custom12 Custom13 Custom14 Custom15 Custom16 Custom17 Custom18 Custom19 Custom2 Custom20 Custom3 Custom4 Custom5 Custom6 Custom7 Custom8 Custom9 Drilled

EIP Job Model Specification Copyright 2011, Xerox Corporation.

45

EIP Job Model Specification v 1.0.13


Keyword Envelope Labels LabelsExtraHeavyweight Description Envelopes that can be used for conventional mailing purposes. Label stock [For example, a sheet of peel-off labels]. Label stock [For example, a sheet of peel-off-labels. Heavier than labelsheavyweight. Label stock [For example, a sheet of peel-off labels]. Heavier than labels. The other keyword value is used when the media instance does not correspond to any of the Printers supported media types. Separately cut sheets of a transparent material with an opaque paper backing. Separately cut sheets of an opaque material to produce photographic quality images. The coating is unspecified. 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. Media that is heavier than pre-cuttabs 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. Separately cut sheets of an opaque material. Separately cut sheets of a heavy stock opaque material. Stationery that is of heavier than normal weight and has a glossy coating typically on both sides. Stationery that is of heavier than normal weight 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. Separately cut sheets of an opaque

LabelsHeavyweight

Other

PaperBackedTransparency

Photographic

PreCutTabs

PreCutTabsHeavyweight

Stationery StationeryHeavyweight StationeryHeavyweightGlossy

StationeryHeavyweightGlossyReloaded

StationeryLetterhead

EIP Job Model Specification Copyright 2011, Xerox Corporation.

46

EIP Job Model Specification v 1.0.13


Keyword Description material with a pre-printed letterhead. StationeryLightweight Stationery that is of lighter than normal weight and is Typically uncoated. Stationery that is of lighter than normal weight and has a glossy coating typically on both sides. Stationery that is of lighter than normal weight 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. Stationery that is of lighter than normal weight and is Typically uncoated. 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. Separately cut sheets of an opaque material with a pre-printed image. Separately cut sheets of an opaque material that contains recycled material. Separately cut sheets of an opaque material. 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. Separately cut sheets of an opaque material with a rougher than normal surface. Use the Devices default. Media with tabs, either pre-cut or fullcut. Separately cut sheets of a transparent material. Select any ready input tray whose contents match the supplied mediacol attributes.

StationeryLightweightGlossy

StationeryLightweightGlossyReloaded

StationeryLightweightReloaded

StationeryPrePrinted StationeryRecycled

StationeryReloaded

StationeryRoughSurface

SystemDefault TabStock Transparency UseAny

EIP Job Model Specification Copyright 2011, Xerox Corporation.

47

EIP Job Model Specification v 1.0.13


1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

SheetCollate (keyword)
Vernacular Names Service type Status Description Collated Print, Copy Draft This attribute specifies whether or not the media sheets of each copy of each document in a job are to be in sequence, when multiple copies of the document are specified by the Copies attribute. For example, suppose a document produces two media sheets as output, and copies is equal to 6, For the uncollated case, six copies of the first media sheet are ed followed by six copies of the second media sheet. For the collated case, one copy of each of the six sheets are ed followed by another copy of each of the six media sheets. Whether the effect of sheet collation is achieved by placing copies of a document in multiple output bins or in the same output bin with implementation defined document separation is implementation dependent. Also whether it is achieved by making multiple passes over the job or by using an output sorter is implementation dependent. Standard keyword values are:
Keyword Uncollated Description Each print-stream sheet is printed a number of times in succession equal to the value of the Copies attribute, followed by the next printstream sheet. Each copy of each document is ed with the printstream sheets in sequence, followed by the next document copy.

Collated

21 22 23

EIP Job Model Specification Copyright 2011, Xerox Corporation.

48

EIP Job Model Specification v 1.0.13


1 2 3 4 5 6 7 8 9

Sides (keyword)
Vernacular Names Service type Description Sides Imaged Print, Copy This attribute specifies how print-stream pages are to be imposed upon the sides of an instance of a selected medium, i.e., an impression. It also specifices how pages are interpreted when being scanned. Thus it is used as both an input and an output attribute for a job ticket. The Standard keyword values are:
Keyword OneSided TwoSidedLong Edge Description imposes each consecutive print-stream page upon the same side of consecutive media sheets. 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. 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.

TwoSidedShort 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

EIP Job Model Specification Copyright 2011, Xerox Corporation.

49

EIP Job Model Specification v 1.0.13


1 2 3 4 5 6 7

Scaling (collection)
Vernacular Names Service type Description Magnification, ReduceEnlarge, Scaling Copy This Scaling attribute specifies how the images should be scaled. The image may be scaled in both the x and the y directions.

Scaling member attributes


Member Attribute Name ScalingType ScaleProportional ScaleIndependent keyword collection collection Attribute Syntax

8 9 10 11 12 13

The Scaling collection member attributes definitions are:

ScalingType (type2 keyword)


The ScalingType member attribute specifies the type of scaling that is being used. Standard keyword values are:
Keyword AutoProportional Description 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. 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. Specifies that the sides of the image will be scaled proportionally . The ScaleProportional collection will be used to specify the amount of scaling. Specifies that the sides of the image will be scaled independently. The ScaleIndependent collection will be used to specify the amount of scaling.

AutoIndependent

Proportional

Independent

EIP Job Model Specification Copyright 2011, Xerox Corporation.

50

EIP Job Model Specification v 1.0.13


1 2 3 4 5 6

ScaleProportional (collection)
The OPTIONAL ScaleProportional member attribute is a collection that is used to specify that the sides of the image will be scaled proportionally. This member attribute must only be used when the ScalingType attribute is set to Proportional. The ScaleProportional collection member attributes are:
Member Attribute Name ScalingValue Attribute Syntax

rangeOfInteger

7 8 9 10 11 12 13 14 15 16

ScalingValue(rangeOfInteger) The ScalingValue member attribute specifies the percentage an image should be scaled. The valid values can be from 25% all the way up to 400%.

ScaleIndependent (collection)
The OPTIONAL ScaleIndependent member attribute is a collection that is used to specify that the sides of the image will be scaled indepently. This member attribute must only be used when the ScalingType attribute is set to Independent. The ScaleIndependent collection member attributes are:
Member Attribute Name XScaling YScaling Attribute Syntax

rangeOfInteger rangeOfInteger

17 18 19 20 21 22 23 24 25

XScaling(rangeOfInteger) The XScaling member attribute specifies the percentage an image should be scaled in the x direction. The valid values can be from 25% all the way up to 400%. YScaling(rangeOfInteger) The YScaling member attribute specifies the percentage an image should be scaled in the y direction. The valid values can be from 25% all the way up to 400%.

EIP Job Model Specification Copyright 2011, Xerox Corporation.

51

EIP Job Model Specification v 1.0.13

3. APPENDIX A: References
This Appendix provides additional references to documents. References to this Appendix are indicated in square brackets using hot links. Cross Reference Symbol (in alphabetic order) Access Token Auditron Reference Document Title, Description, and URL

2 3 4

http://en.wikipedia.org/wiki/Token_(Windows_NT_architecture) Available at: http://download.support.xerox.com/pub/drivers/CC_32C/docs/winxp/en/CC-WCP3240-CC-WCP2128-2636-3545_AuditronUG_1104.pdf http://www.webopedia.com/TERM/D/domain_name.html Available at: http://en.wikipedia.org/wiki/Equitrac http://www.equitrac.com/solutions_office.asp

Error! Reference source not found. Equitrac Reference

IEC 61966-2-1:1999 [ISO-838] [JDF] [Lightweight Directory Access Protocol (LDAP)]

Multimedia systems and equipment - Colour measurement and management - Part 21: Colour management - Default RGB colour space - sRGB ISO 838: 1974. Paper -- Holes for general filing purposes -- Specifications. Specifies the hole sizes and spacing. Job Definition Format (JDF), Versions 1.0, 1,1, 1,2, 1.3, and 1.4 are available from http://www.cip4.org. 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]. http://en.wikipedia.org/wiki/Pluggable_Authentication_Modules. http://www.opengroup.org/onlinepubs/8329799/chap4.htm PWG 5101.1-2002 Standardized Media Type Names. Available as: ftp://ftp.pwg.org/pub/pwg/candidates/cs-pwgmsn10-20020226-5101.1.pdf Device Working Group - Semantic Model, PWG IEEE-ISTO 5100.1-2004 [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]

[Error! Reference source not found.] [Error! Reference source not found.] [PWG5101.1-2002] [pwg-sm] [RFC 2806]

EIP Job Model Specification Copyright 2011, Xerox Corporation.

52

EIP Job Model Specification v 1.0.13


[RFC 3192] [RFC 3261] [RFC 3508] [RFC 3966] [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] Rosenberg, J, et al, SIP: Session Initiation Protocol, RFC 3261, June 2002. Available at: http://tools.ietf.org/html/rfc3261 [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 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] UPnPv1 WSD [XDevCap] [XSDF spec] Lightweight Directory Access Protocol (LDAP):Technical Specification Road Map. Available at: http://tools.ietf.org/html/rfc4510 Microsofts Universal Plug N Play (UPnP), version 1 and version 2. Microsofts Web Services for Devices (WSD) Xerox Device Capabilities an XML encoding of the Device Capabilities as specified in the [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.docushareinnovation.world.xerox.com/dsweb/View/Collection-95235 1

EIP Job Model Specification Copyright 2011, Xerox Corporation.

53

EIP Job Model Specification v 1.0.13

4. Appendix B: Document History


Document Revision
Version 1.0.0 1.0.2 1.0.3 Date 10/10/09 06/20/10 06/27/10 Created Added support for Job Limits Added input tray collection attribute; fixed figures to show new job model elements for job limits; added section on ticket consumption and validation Changed JobIdFromClient to ClientID to match the Job Management and Copy WSDL implementations. Added new custom numbers for Media Color and Media Type and added new media type keyword called Photographic; Updated new definition of schemaVersion. Added Tray Level Changed descriptions of MediaColor, MediaType, and Scaling. Added JobIdentifier. Added some more staple values. Added information about invalid optional elements Made job state reasons unbounded so there can be more than one returned in JobInfo payload CQGbl00304183 Updated the list of valid media types CQGbl00306419 Removed ServiceOffline job state reason as it is not being used / description is confusiong in CPSS; Added definition of Device CQGbl00305904 removed xs:any from the schema figures CQGbl00311386 clean up for SDK 1.0.14 07/25/11 CQGbl00325672: Added "OutOfAccountingResources" new job state reason C. Miyachi Description Author C. Miyachi J. Howell C. Miyachi

1.0.4 1.0.5

8/11/10 8/24/10

J. Howell C. Miyachi

1.0.6 1.0.7 1.0.8 1.0.9 1.0.10 1.0.11 1.0.12

9/1/10 9/9/10 9/17/10 11/4/10 12/12/10 3/25/11 4/5/11

C. Miyachi J. Howell J. Howell C. Miyachi C. Miyachi J. Howell C. Miyachi

1.0.13

04/20/11

C. Miyachi

EIP Job Model Specification Copyright 2011, Xerox Corporation.

54