1. Home
  2. Job XML Definition

Job XML Definition

Definition

A job in the workflow is defined as an XML containing the properties of the job:

  • Resources : input file(s), profiles

  • Layout : media size, position, output size, mirror

  • Device settings

  • Color management instructions

  • Logs : processing time, ink usage, media usage

The job is passed to a component, such as a RIP or a Printer, which reads the settings relevant to that component (and can add things like logs or additional settings for use further downstream in the workflow).

Each component can do its job without depending on other components.

File structure

A job on disk follows the following layout:

GUID : folder with the GUID of the job as name (Mandatory)

  • Settings.xml : the job settings described below (Mandatory)
  • META : halftone and vector data and preview of rendered page
  • -job name-.-ext- : the input file (if no external location specified in the job and the input file is not already PDF)
  • -job name-.pdf : the PDF resulting from the input file after interpretation (if no external location is specified in the job)Any further resources that are to be kept with the job

XML tags

The XML tags need only to be available when:

  • the setting is relevant to the job and its components

  • has a value other than its default value

  • is required

The XML tags are stored all on the same level in the job node. The root-level node is “Job”. The grouping below is based on its functionality, there is no required sequence for the elements in the root level node. All dimensions related values are expressed in float and using a unit of 1/18″. So 1 inch is equal to 18 units.

The 2014 XSD can be downloaded from the bottom of this page.

General

JobGUID

String

Required GUID of the job. Required and must be unique. This GUID is used to identify the job.

Name

String

Required Name of the job visible to the user. Required but does not need to be unique.

User

String

Name of the user that submitted the job.

Producer

String

Name of the application that created this job. The values “Editor” and “Calibrator” have side effects that the RIP will ignore all color management settings (see section “Color management” below).

QueueName

String

Name of the queue to which the job was submitted.

Description

String

Long description of the job as “Name” is the short description.

JobType

Regular

Proof

Silkscreen

1BitPlates

DirectInk

Regular

Required Type of job. “Regular” refers to regular processing. “Proof” jobs are rendered to a reference profile and simulated on a printer. “Silkscreen” job are separated to multi pages, a page for every plate. “DirectInk” maps all channels defined in the document directly to ink channels on the printer without color management.

JobState

Integer

Processing state of the job. 0 – Indicates that the job is processing (running). 1 – Indicates that the job is stopped with the entire context. 2 – Indicates that the job was manually stopped (ex. stopped by a user).

Print

Boolean

false

Indicates that the job is to be printed

Cut

Boolean

false

Indicates that the job is to be (contour) cut

Copies

Integer

1

Number of copies to be output

Pages

Integer

1

Number of pages in the input file or number of tiles when tiling info is supplied

RenderGUID

String

Unique ID to identify the render session. Is set/overwritten when the job is rendered and used to pair a color certification with job

CreationTime

Integer

now

Time at which the job is created in seconds since 1 jan 1970 00:00 (POSIX time() function)

Area

Units

0

Area covered by the output job. This value is used by the nesting routines to determine if the jobs exceed the area threshold

MediaUsage

Units

0

Length of media used by the output job. This value is used by the roll length calculator to keep stock control

InputJob

Node

Node containing information about the file to be used as input.

PDFJob

Node

Node containing information about the PDF file.

PrintJob

Node

Node containing information about the META data generated by the RIP.

ColorCertfication

Node

Color certification results

AtDone

Delete

Action to take after the job has been printed successfully. Currently only one command is possible: Delete

AtFailure

Delete

Action to take after the job has not been printed correctly. Currently only one command is possible: Delete

ReportURL

String

URL to which HTTP server the log entries or complete Job settings will be sent each time a job log entry is made.

Type (A)

Update

Full

Update

Full: complete settings.xml containing all logs for this job.

Update: All Log entries will be sent separately ( for Input and Print jobs )

InputJob / PDFJob / PrintJob node

FilePath

Path

Required Path the file.

FileType

String

Extention in lower case of the file pointed to by “FilePath”.

Status

Waiting

Hold

Warning

Spooling

Processing

Canceling

Ready

Waiting

Processing status of the job.

Warning

String

Warning/error message when the “Status” is “Warning”.

IsTemporary

Boolean

true

The file pointed to by “FilePath” is to be deleted when the job is deleted.

ProcesTime

Integer

0

Seconds used to process this part of the job.

PrintJobCurrentCopy

Integer

0

The number of copies already printed.

EfficientBorder

Boolean

false

Allow nesting to skip spaces when a grid can be formed, only printing cut marks on the outside.

PlateInfo

Plates found during 1-bit plate collection process in human-readable form.

DeviceNInfo

String

Information provided by the RIP indicating how spot color look-up was performed in human-readable form.

Color certification node

Result

Boolean

false

Result of the certifcation, true when succeeded, false when failed, absent when not certified.

Media and layout

MediaSizeName

String

Name of the media size to be used for output. This must be a name as known by the output printer driver. Names can be like “A4” or “24-inch roll”

MediaType

String

The media type of the substrate to be used. When this is specified the job will only be printed when the media loaded on the printer matches this type or when the RIP is set to ignore the media type. For vinyl cutting this element defines the vinyl to be used.

CIELab_L (A)

Float

L value of the media color defined in CIE Lab.

CIELab_a (A)

Float

a value of the media color defined in CIE Lab.

CIELab_b (A)

Float

b value of the media color defined in CIE Lab.

TrayName

String

Name of the tray to be used for output

ScaleX

Float

1

Horizontal scale factor of the output. The width of the input is multiplied with this scale. This prior to any possible rotation.

ScaleY

Float

1

Vertical scale factor of the output. The height of the input is multiplied with this scale. This prior to any possible rotation.

Mirror

Boolean

false

Mirror the input file on the output page.

MediaSizeType

Fixed

Custom

ByJob

ByJob

Defines the way the media selection is performed. “Fixed” indicated that the media is set by tag “MediaIndex”. When “Custom” then the media size is defined by “CustomMediaWidth” and “CustomMediaHeight”. “ByJob” will search for the media that best fits the job size.

MediaIndex

Integer

0

Defines the index in the media table of the driver to be used as media size when “MediaSizeType” is set to “Fixed”.

CustomMediaWidth

Units

0

Media width used when “MediaSizeType” is set to “Custom”.

CustomMediaHeight

Units

0

Media height/length used when “MediaSizeType” is set to “Custom”.

TrayIndex

Integer

0

Defines the index in the tray table of the driver to be used for output.

Orientation

Undefined

Portrait

Landscape

Undefined

Orientation of the job to output. When the orientation is Undefined the interpreter or RIP component may set it based on the size of the selected media.

Ticket

String

Name of the job ticket to be added to the output. A job ticket with the given name must be available at the RIP resources otherwise it will be omitted. Next to the build-in job tickets the custom job tickets are found in the “Tickets” folder.

Template

String

Name of the template to be used at the RIP to layout the jobs passed to it. A template with the given name must be available at the RIP resources otherwise it will be omitted. Templates are stored in the “Templates” folder.

ResizeMode

None

Width

Width And Height

Percentage

Scale To Fit

None

The resize mode defines how the job is scaled. The result of this operation is stored in “Scale”. “None” will not scale the job. “Width” will scale the job to the width defined by “ResizeWidth”. “Width And Height” will scale the job the smallest scale that fits within the sizes defined by “ResizeWidth” and “ResizeHeight”. “Percentage” scales the job by “ResizePercentage” and “Scale To Fit” will scale the job as large as possible on the printable area of the selected media size.

ResizeWidth

Units

0

Width used by “ResizeMode”.

ResizeHeight

Units

0

Height used by “ResizeMode”.

ResizePercentage

Float

0

Percentage used by “ResizeMode”.

PositionMode

Left Top

Center Top

Right Top

Left Center

Center Center

Right Center

Left Bottom

Center Bottom

Right Bottom

XY Position

Left Top

Defines the position on the media its printable area where the job will be placed. All values indicate the relative horizontal position and vertical position except “XY Position”. The latter is defined by “PositionX” and “PositionY”.

PositionX

Units

0

X position of the job used by “PositionMode”.

PositionY

Units

0

Y position of the job used by “PositionMode”.

Imposition

Node

Imposition information, when this node is available all other layout elements are ignored.

Imposition node

Parts

Node

Required List of parts from the source document and their placement on the output media.

Stitches

Node

List of locations where a media feed must occur. This is used by flatbed printer and cutters to advance the media.

TransparencyZones

Node

List of transparent areas. A gradual fade out is used to make the tile overlaps add up to the total image when mounting backlit or transparent media.

Parts node

Part

Node

A part node, containing the elements below.

SourcePage

Integer

Required Page from the source document where the part is taken from. 1 based.

SourceArea

Rectangle

Required Area of the source document.

Left (A)

Units

Left side of the source area.

Top (A)

Units

Top side of the source area.

Right (A)

Units

Right side of the source area.

Bottom (A)

Units

Bottom side of the source area.

Position

Position

Required Position of the part on the output.

X (A)

Units

X position of the part.

Y (A)

Units

Y position of the part.

Space

Units

0

Space between parts. Not relevant for consuming applications.

MarkerSize

Units

0

Size of the marker area outside of the imagable area of the part.

DesitnationPage

Integer

Required Destination output page, 1 based.

MarkerType

Integer

0

See MarkerType of the main job for explanation.

Orientation

Undefined

Portrait

Landscape

Undefined

Orientation of the part to output. When the orientation is Undefined the producer is allowed to choose any.

Angle

Integer

0

Orientation of the part on the output for the consumer. Only 0, 90, 180, 270 degrees are allowed.

Mirror

Boolean

false

Mirrors the part on the output.

Scale

Scale of the part on the output, the marker size is not scaled by these factors.

X (A)

Float

1

X scale of the part, applied on the source area.

Y (A)

Float

1

Y scale of the part, applied on the source area.

AutoClose

Boolean

false

Close contours of the part if the are left open due to the clip of the source rectangle.

Column

Integer

0

Column number in case the tiling was a simple grid.

Row

Integer

0

Row number in case the tiling was a simple grid.

OverlapWhite

Units

0

Amount of the overlap of a tile to leave unprinted to enable welding.

BleedSize

Units

0

Amount of bleed to generate in the marker area by mirroring the parts content.

Label

String

Label to be printed with the tile as a reference for the mounting crew.

OverlapSize

Rectangle

Definition of the amount of overlap on each side of the source rectangle.

Left (A)

Units

Left side overlap.

Top (A)

Units

Top side overlap.

Right (A)

Units

Right side overlap.

Bottom (A)

Units

Bottom side overlap.

OverlapLabel

Node

Labels defined per side of the part.

BarCode

String

Barcode identifying this part.

OverlapLabel node

Left

String

Left side overlap label.

Top

String

Top side overlap label.

Right

String

Right side overlap label.

Bottom

String

Bottom side overlap label.

Stitches node

Stitch

Float

Location from the top of the roll where a feed of the media on the table must occur. The feed amount is the distance between this stitch location and the previous location. The first stitch at location 0 is assumed.

TransparencyZones node

Zone

Node

A zone node, containing the elements below.

SourceArea

Rectangle

Required Area of the source document.

Left (A)

Units

Left side of the source area.

Top (A)

Units

Top side of the source area.

Right (A)

Units

Right side of the source area.

Bottom (A)

Units

Bottom side of the source area.

Alpha

Float

Require Alpha blend value for this zone.

Color management

UseEmbeddedProfiles

EmbeddedOff

ProfileOnly

ProfileIntent

ProfileIntent

Profiles embedded in files are handled according to this setting. “EmbeddedOff” will remove all embedded profiles and assign the profile indicated by other tags like “CMYKVectorSpec”. “ProfileOnly” will retain the profiles but overwrite the intent as set by tags like “CMYKVectorIntent”. “ProfileIntent” will leave all embedded profiles and intents and only change elements without embedded profiles

CMYKVectorSpec

Path

Path to the ICC profile to be assigned to CMYK vector objects (see “UseEmbeddedProfiles”).

CMYKImageSpec

Path

Path to the ICC profile to be assigned to CMYK image objects (see “UseEmbeddedProfiles”).

RGBVectorSpec

Path

Path to the ICC profile to be assigned to RGB vector objects (see “UseEmbeddedProfiles”).

RGBImageSpec

Path

Path to the ICC profile to be assigned to RGB image objects (see “UseEmbeddedProfiles”).

GrayVectorSpec

Path

Path to the ICC profile to be assigned to Gray vector objects (see “UseEmbeddedProfiles”).

GrayImageSpec

Path

Path to the ICC profile to be assigned to Gray image objects (see “UseEmbeddedProfiles”).

CMYKVectorIntent

Perceptual

Colorimetric

Absolute

Colorimetric

Rendering intent to be assigned to CMYK vector objects (see “UseEmbeddedProfiles”).

CMYKImageIntent

Perceptual

Colorimetric

Absolute

Colorimetric

Rendering intent to be assigned to CMYK image objects (see “UseEmbeddedProfiles”).

RGBVectorIntent

Perceptual

Colorimetric

Absolute

Colorimetric

Rendering intent to be assigned to RGB vector objects (see “UseEmbeddedProfiles”).

RGBImageIntent

Perceptual

Colorimetric

Absolute

Colorimetric

Rendering intent to be assigned to RGB image objects (see “UseEmbeddedProfiles”).

GrayVectorIntent

Perceptual

Colorimetric

Absolute

Colorimetric

Rendering intent to be assigned to Gray vector objects (see “UseEmbeddedProfiles”).

GrayImageIntent

Perceptual

Colorimetric

Absolute

Colorimetric

Rendering intent to be assigned to Gray image objects (see “UseEmbeddedProfiles”).

CIELabVectorIntent

Perceptual

Colorimetric

Absolute

Colorimetric

Rendering intent to be assigned to CIELab vector objects (see “UseEmbeddedProfiles”).

CIELabImageIntent

Perceptual

Colorimetric

Absolute

Colorimetric

Rendering intent to be assigned to CIELab image objects (see “UseEmbeddedProfiles”).

BlackCompensation

Boolean

false

Black point compensation is applied on input profiles with a colorimetric rendering intent when this option is set to true.

PureHue

Boolean

false

CMYK vector object with a color that consist of only a primary color (C,M,Y or K) or secondary color (R, G or B) are left unchanged by color management when this option is true.

ColorEdits

Path

Path to a color edit script. The color edit script is applied to the document before it is rendered.

Output settings

PrinterDriver

String

Required Name of the printer driver to be used to print the document to.

DS

Node

Driver settings dictionary. Content is specific to the printer driver.

PrinterProfile

Path

Profile

Required Depending on the attribute “Type” the contents is a path (attribute value “Path”) or a printer profile (attribute value “Profile”). When the attribute is not specified “Path” is assumed. The path points to the calibration profile to be used for output. The profile is stored as a hex-encoded binary stream in ICC format. When no path is specified or the profile is invalid Euroscale Coated CMYK and linear transfer curves will be used for output.

ToneCorrection

Binary

Correction curves that are applied on the linearization curves from the calibration (“PrinterProfile” or “EmbeddedPrinterProfile”).

GradientCMM

Vector

Image

Vector

Defines which printer ICC profile to be used for gradients if separate printer profiles are defined for vector objects and image objects.

SpotColorLibrary

Path

Path to the spot color library in CxF? format. Spot colors in this library will be used as first place to look-up spot colors

ConvertAllSpotsToAlt

Boolean

false

Convert all spot colors to process colors. All DeviceN objects with channels that do not match the printer inks are converted to its alternate colorspace.

ConvertCMYKSpotsToAlt

Boolean

false

Convert all spot colors that are only subsets of CMYK to CMYK. All DeviceN object with a channel set that is a subset of CMYK are converted to its alternate colorspace. This is needed for TrueFlow files which use DeviceN(1) with names like “C”, “M”, “Y” and “K”.

ScreenType

Error Diffusion

FM Screening

AM Screening

True Color

Floyd Steinberg

Chromatic Error Diffusion

Error Diffusion

Screening algorithm used to convert from contone to halftone. The default “Error Diffusion” refers to CED screening.

FastMode

Boolean

false

The fast mode causes the document to be rendered at half the resolution the driver requests. The screening will be performed at the resolution requested by the driver.

SpotColors

Node

Channels additional to the channels defined by the reference profile or printer profile (depending on the JobType? )

InkSet

Node

Defines an overriding inkset. The inkset provided by the driver is ignored when defined. This node contains a list of “Ink” elements.

OEMSettings

Node

Defines additional overriding inkset settings next to the settings in “InkSet”.

SpotColors node

Spot

String

Name of the spot color

InkSet node

Ink

Node

Node containing all properties of an ink.

Name (A)*

String

*Required Name of the ink.

CIELab_L(A)

Float

L value of the ink color defined in CIE Lab.

CIELab_a(A)

Float

a value of the ink color defined in CIE Lab.

CIELab_b(A)

Float

b value of the ink color defined in CIE Lab.

LinearizeBy(A)

Density C

Density M

Density Y

Density V

CIELab Lightness

CIELab a

CIELab b

CIELab Chroma

WhiteInk

Method to be used to linearize this ink. The value “WhiteInk” is used to not apply a linearisation, this is used for all technical inks such as ‘White’.

DotWeight

Float

Child elements of “Ink”, specifying the list of relative dot weights starting from low going to high. The DotWeight element count specifies the number of dot sizes for this ink (1 more than number of elements as the lowest value is 0 and is implicit defined). These elements are omitted when the ink has 256 levels (Contone).

OEMSettings node

ClogLevel

Integer

0

Level of anti-clog to be used by CED 1-bit error diffusion.

BlueNoise

Integer

0

Amount of blue noise to add to error diffusion. 0 and 1 means default. Other values multiply the default amount of noise.

Proofing (JobType : Proof)

ReferenceProfile

Path

Path to the reference profile to be used for proofing jobs. When no path is specified or is invalid Euroscale Coated CMYK will be used as reference.

AbstractProfile

Path

Path to the tuning profile. The tuning profile is the result from a device-link operation between a printer profile and reference profile and only valid when the abstract profile matches the profiles set with “PrinterProfile” and “ReferenceProfile”.

PaperSimulation

Boolean

false

When set a proofing job will use the absolute colorimetric conversion and thus simulate the reference paper color on the output.

UsePDFX3Profile

Boolean

false

When set to true then PDF/X its embedded destination profile will be used as reference profile

SolidBlack

Boolean

false

Parts in the document that are K only after rendering to the reference profile are kept K only.

UseSubstrate

Boolean

false

Use substrate simulation using the substrate definition of the reference profile (if any is specified in the reference profile).

ProofIntent

Perceptual

Colorimetric

Colorimetric

Rendering intent used from reference CMYK to printer channels. This is used for normalized CMYK printing in LFP production. E.g. the job is PDF/X and rendered to ISO Coated, the result is mapped perceptual to the printer utilizing the maximum of the gamut.

1-bit proofing (JobType : 1BitPlates)

HTProofMode

Color

Black

Shape

Color

1-bit proofing method to be used.

HTProofNegative

Boolean

false

Indicates that the plates received are in unreadable / negative format.

HTProofPlateCurve

Path

Path to a correction curve to be applied on the plates.

Silkscreen (JobType : Silkscreen)

ChannelArray

Node

Definition of the angle, frequency and shape to be used for the individual plates.

NegativeScreens

Boolean

false

Output the plates as unreadable / negative.

ClassicHalftone

Boolean

false

Use standard halftone algorithm to perform screening instead of Fitted Halftone.

ChannelArray node

Channel

String

Name of the output channel.

CIELab_L (A)

Float

0

L value of the ink color defined in CIE Lab.

CIELab_a (A)

Float

0

a value of the ink color defined in CIE Lab.

CIELab_b (A)

Float

0

b value of the ink color defined in CIE Lab.

Visible (A)

Boolean

true

Defines if the channels if to be printed.

Angle (A)

Float

0

Angle of the AM screen is degrees.

Frequency (A)

Float

0

Frequency (ruling) of the AM screen in LPI.

Shape (A)

Round

Ellipse

Diamond

Square

SimpleRound

EllipseA

EllipseB

EllipseC

Cosine

Line

Cross

Rhomboid

Ellipse2

LineX

LineY

DoubleDot

InvertedDoubleDot

SimpleDot

InvertedEllipseA

InvertedEllipseC

Round

Shape of the AM screen.

Printer / spooler

PrinterPort

String

Required URI specifying the output port. This can be any URI understood by the device driver or room:// followed by the path of the ROOM queue.

Expedited

Boolean

false

Causes the spooler to process the job immediately without waiting until the nesting criteria are met.

White generation

WhiteMethod

Off

Fill

UnderColor

NotUnderColor

Off

Defines the method used to automatically generate white for printers with white ink. “Off” does not generate any white. “Fill” generates white under the complete document area. “UnderColor” generates white under all places that have color (read: is not white). “NotUnderColor” generates white at all area that has no color set (read: is white).

WhiteAmount

Float

0

Amount of white to be generated by “WhiteMethod”. Range from 0 to 1.

WhiteEdgeAmount

Float

0

Spread or choke to be applied. Positive value indicated the amount of spread and negative value the amount of choke.

Workflow

AutomaticExport

Boolean

false

If set to true the job will be exported to the path given by “ExportPath” in the format defined by “ExportType”

ExportPath

Path

Path to the directory that will receive the job.

ExportType

Original

PDF

Original

“Original” will export the job as it is, so a JPEG will stay JPEG for example. “PDF” will write the job in PDF format, when the original file is not PDF then PDF 1.4 format will be used to write the PDF.

Contour cutting / Vinyl cutting

Feed

Begin

Right

Top

Transport

Cut and transport

Manual

Right

Location of the cutting head after processing the job (if supported by the device). Transport refers to flatbed cutters that are capable of moving the media from the table.

Sort

Speed

Transport

None

Speed

Method of sorting the contours to get the most effecient movement of the cutting head (“Speed”) or the minimum amount of media feed to avoid registration issues (“Transport”).

Cutting markers

MarkType

Integer

0

Mark type is a bit array of markers. The bit number assignments are:

  1. Registration marks

  2. Crop marks

  3. Frame

  4. Subscript

  5. OPOS

  6. EPOS

  7. Fotoba

  8. i-Cut

  9. Place holder

  10. Roland POS

  11. Mimaki marks

  12. Overlap ID

  13. Overlap line

BorderSize

Float

0

Amount of border size to add to the job to create room for the markers.

AutomaticCutting

Boolean

false

Perform automatic barcode scanning on plotters with barcode scanners when this is set to true.

BarCode

String

Barcode associated with this job to be scanned by an plotter with barcode reader support.

Fotoba

RollCutter

DigiStrim

XYAuto

RollCutter

The Fotoba model for which the markers are intended.

InnerWhite (A)

Float

0

Blacks (A)

Float

0

InnerOuter (A)

Float

0

MarkerBlack

Integer

0

Composition of black used to draw to markers. The valid numbers are:

  • 0 = K only

  • 1 = Weak black

  • 2 = Strong black

Journal

Journal

Node

List of action performed on this job

Journal node

JournalEntry

String

Description of the action performed

Date (A)*

String

*Required Date and time of the event.

Process (A)*

String

*Required Process that created the event

Remaining copies

PageCopiesRemaining

Node

List of copies remaining for each output page. The first entry refers to output page 1, second to 2, etc.

If the entry is not present then the value set by tag “Copies” can be assumed.

PageCopiesRemaining node

PageCopies

Integer

Number of copies still to be made of this page.

Done copies

PageCopiesDone

Node

List of copies done for each output page. The first entry refers to output page 1, second to 2, etc.

If the entry is not present 0 can be assumed.

PageCopiesRemaining node

PageCopies

Integer

Number of copies made of this page.