TotalFlow BatchBuilder Hot Folder Schema

This section describes all the job attributes required for an XML order file to match the TotalFlow BatchBuilder schema.

Overview

The diagrams offer you a graphical representation of the nodes and attributes that you could use for mapping XML values. The dotted lines represent an optional attribute of a node and the continuous lines represent a mandatory attribute.

Order node attributes

The table lists the order node attributes you can insert in the XML file.

Attribute Object Type Allowed Values Description

name

Character

 Enter 1–32 characters. The input filename.

number

Character

 Enter 1–256 characters. The number of the order.

dueDate

Character

 yyyy-mm-dd

Example: 2014–04–21

 Expiry date of the order.

dueTime

Character

 hh:min:ss +/- hh:mm

Example: 18:26:59 + 03:00

The first time values represent the GMT time and the last values represent the time zone offset.

 Expiry time of the order.

receieveDate

Character

 yyyy-mm-dd

Example: 2014–04–21

 Date the order was received.

receiveTime

Character

 hh:min:ss +/- hh:mm

Example: 18:26:59 + 03:00

The first time values represent the GMT time and the last values represent the time zone offset.

 Time the order was received.

jobNumber

Character

 Enter 1–32 characters. The number assigned for the job.

version

Character

 1.0 This is a fixed value and must be entered as specified.

Customer node attributes

Attribute Object Type Allowed Values Description

name

Character

 Enter 1–256 characters. The customer name.

Job node attributes

The table lists the optional job attributes you can insert in the XML file.

Attribute Object Type Allowed Values Description

name

Character

 Enter 1–256 characters. The input filename.

copies

Unsigned long

 Enter 1–5.000.000 copies. The number of copies.

simplexDuplex

SimplexDuplexEnumerator

  • Simplex

  • Duplex

 Specifies if the job is printed 1-sided or 2-sided.

plex

PlexEnum

  • BE_LEFT

  • BE_TOP

  • BE_RIGHT

  • BE_BOTTOM

 Specifies which edge to print on in duplex mode.

perforation

Boolean

  • 1

  • 0

  • true

  • false

 Specifies if the job is perforated or not.

drilling

Boolean

  • 1

  • 0

  • true

  • false

 Specifies if the job is drilled or not.

collation

Boolean

  • 1

  • 0

  • true

  • false

 Specifies if the job is collated or not.

proofing

Boolean

  • 1

  • 0

  • true

  • false

 Specifies if a sample is required.

color

Character

  • C_NONE

  • C_PROCESS

  • C_BW

  • C_PROCESS_PLUS.SPOT

    Note: Besides the predefined values, you can enter any custom value from 1 to 32 characters.
 Specifies color printing methods.

productType

Character

 Enter 1–32 characters. The type of the product.

description

Character

 Enter 1–128 characters. Description of the product.

isbn

Character

 Enter 1–20 characters. The ISBN code if it exists.

sku

Character

 Enter 1–32 characters. A number containing the product attributes, such as manufacturer, product description, size and so on.

subPartNumber

Character

 Enter1 –32 characters. The code that uniquely identifies an item.

finisher

Character

 Enter 1–32 characters. The name of the finisher installed.

press

Character

 Enter 1–32 characters. The name of the output device.

description

Character

 Enter 1–128 characters. Description of the file.

outputBin

Character
  • OB_TRIMMER
  • OB_FOLDING
  • OB_PERFECT_BINDER
  • OB_RING_BINDER
  • OB_EWIRE_BINDER
  • OB_BOOKLET
  • OB_SHIFT
  • OB_COPY
  • OB_MAILBOX_1
  • OB_MAILBOX_2
  • OB_MAILBOX_3
  • OB_MAILBOX_4
  • OB_MAILBOX_5
  • OB_MAILBOX_6
  • OB_MAILBOX_7
  • OB_MAILBOX_8
  • OB_MAILBOX_9
  • OB_FINISHER
  • OB_STACKER
  • OB_SECOND_STACKER
  • OB_UPPER
  • OB_ROLL
  • OB_LEFT_EXIT
  • OB_EXTENDED_OPTIONS
  • OB_ANY_STACKER
  • OB_BANNER_STACKER
Note: Besides the predefined values, you can enter any custom value from 1 to 32 characters.
 Specifies the output tray for the job when printed.

outputBinEject

Enumeration
  • OE_NONE
  • OE_FACE_DOWN
  • OE_FACE_UP
  • OE_FACE_DOWN_REVERSE
  • OE_FACE_UP_REVERSE
 Specifies whether the output is ejected face down or face up in the Output Bin.

File node attributes

Attribute Object Type Allowed Values Description

ref

Character

 Enter 1–1024 characters. The file path and name.

dataStream

DataStreamEnum

  • DS_PDF

  • DS_PS

  • DS_AFP

  • DS_UNKNOWN

The type of the data stream.
Note: If you want the TotalFlow BatchBuilder system to identify the number of pages or the document size of a PDF job, you must insert the dataStream attribute in the XML file with the DS_PDF value.

Document node attributes

Attribute Object Type Allowed Values Description

pages

Unsigned long

Enter integer values from 0–1.000.000.

 The number of pages in the document.

Document size node attributes

Attribute Object Type Allowed Values Description

units

Enumeration

  • in

  • mm

 The measurement units for the document size.

width

Double

0.1– 200 inches or 1–6.000 millimeters.

 The width of the document.

height

Double

0.1–200 inches or from 1–6.000 millimeters.

 The height of the document.

Media node attributes

Attribute Object Type Allowed Values Description

name

Character

 Enter 1–256 characters. The name of the paper.

type

Enumeration + Character

  • MT_NONE

  • MT_BOND

  • MT_OFFSET

  • MT_COVER

  • MT_TAG

  • MT_INDEX

Note: Besides the predefined values, you can enter any custom value from 1 to 32 characters.
 The type of the paper.

color

Enumeration + Character

  • MC_BLACK

  • MC_BLUE

  • MC_BROWN

  • MC_BUFF

  • MC_GOLD

  • MC_GOLDENROD

  • MC_GRAY

  • MC_GREEN

  • MC_IVORY

  • MC_MAGENTA

  • MC_MULTICOLOR

  • MC_MUSTARD

  • MC_NO_COLOR

  • MC_ORANGE

  • MC_PINK

  • MC_RED

  • MC_SILVER

  • MC_TURQUOISE

  • MC_VIOLET

  • MC_WHITE

  • MC_YELLOW

Note: Besides the predefined values, you can enter any custom value from 1 to 32 characters.
 The color of the paper.

finish

Enumeration + Character

  • MF_NONE

  • MF_COATED

  • MF_GLOSSY

  • MF_INKJET

  • MF_HIGHGLOSS

  • MF_MATTE

  • MF_POLYMER

  • MF_SATIN

  • MF_SEMIGLOSS

  • MF_SILVER

Note: Besides the predefined values, you can enter any custom value from 1 to 32 characters.
 The finishing method of the paper.

productID

Character

 Enter 1–256 characters. The ID of the product.

Media size node attributes

Attribute Object Type Allowed Values Description

units

PaperSizeUnitsEnum

  • in

  • mm

 The size of the paper.

width

Unsigned long

0.1–200 inches or 1– 6.000 millimeters.

 The width of the paper.

height

Unsigned long

0.1–200 inches or 1–6.000 millimeters.

 The height of the paper.

Media weight node attributes

Attribute Object Type Allowed Values Description

value

Double

1–133 lb or 1–500 gr.

 Paper weight name.

units

PaperWeightUnitsEnum

  • gr

  • lb

 The measurement units for the paper weight.

Imposition node attributes

Attribute Object Type Allowed Values Description

name

Character

 Enter 1–256 characters. Specifies the imposition description.

positionsPerSide

Integer

Enter integer value from 1 to 1.000.

 The number of pages per one side.

impositionHotFolder

Character

 Enter 1–32 characters. Specifies the folder name where the jobs are sent to be imposed.

Binding node attributes

Attribute Object Type Allowed Values Description

binding

Enumeration + Character

  • BS_NONE

  • BS_CUTONLY

  • BS_CUTFOLD

  • BS_PERFECTBIND

  • BS_CASEBOUND

  • BS_COIL

  • BS_SPIRAL

  • BS_3HOLEDRILL

  • BS_SADDLESTITCH

Note: Besides the predefined values, you can enter any custom value from 1 to 32 characters.
 The binding style for the job

Spine node attributes

Attribute Object Type Allowed Values Description

size

FloatFloat

0–12 inches or 0–300 millimeters

 The spine size is based on the number of pages in your job.

unit

PaperSizeUnitsEnum

  • in

  • mm

 Measurement units for the spine.

Coating node attributes

Attribute Object Type Allowed Values Description

name

Enumeration + Character

  • CN_LAMINATION

  • CN_UV

Note: Besides the predefined values, you can enter any custom value from 1 to 32 characters.
 Specifies the name of the coating.

side

Enumeration

  • LS_FRONT

  • LS_BACK

  • LS_BOTH

The side the coating is applied.

type

Enumeration + Character

  • LT_ANTIQUE

  • LT_CALENDARED

  • LT_GRAIN

  • LT_LINEN

  • LT_MATTE

  • LT_SMOOTH

  • LT_STIPPLE

  • LT_VELLUM

Note: Besides the predefined values, you can enter any custom value from 1 to 32 characters.
 The type of coating used.

Custom fields nodes attributes

Attribute Object Type Allowed Values Description

no

Unsigned integer

Enter integer value from 1 to 50.

 Ordinal number of the custom field.
Parent topic: TotalFlow BatchBuilder Schema