Fiery Node Property Overrides

This document provides a comprehensive reference for property overrides supported by the JobFlow Fiery nodes. Property overrides allow you to dynamically set job attributes at runtime via msg.jobflow.properties.

Overview

Fiery nodes in JobFlow Pro support runtime property overrides through the msg.jobflow.properties object. This allows workflows to dynamically configure job settings based on upstream processing, user input, or business logic.

Key Points:

• Overrides are passed via msg.jobflow.properties
• Attribute names are case-sensitive
• Numeric values should be passed as strings (e.g., "5" not 5)
• EF-prefixed attributes vary by printer model and capabilities

---

Node Override Summary

Node	Accepts Overrides	Override Properties
fiery-submit	Yes	preset, pcmid, attributes
fiery-update	Yes	server, fieryJobID, method, attributes, preset, pcmid
fiery-job	Yes	server, fieryJobID, keys
fiery-info	Yes	server, keys

---

Detailed Node Reference

fiery-submit

Submits a file to a Fiery server for printing.

Supported Overrides

Property	Type	Description
preset	string	Preset ID to apply to the job (overrides node configuration)
pcmid	string	Paper Catalog Media ID for media selection
attributes	object	Key-value pairs of job attributes to set

Example

msg.jobflow.properties = {
  preset: "abc123-preset-id",
  pcmid: "paper-catalog-media-id",
  attributes: {
    NumCopies: "5",
    EFDuplex: "TopTop",
    EFColorMode: "CMYK",
    username: "workflow-user"
  }
};

Notes

• Attributes are merged with JobExpert settings configured in the node
• The preset override takes precedence over the node’s configured preset
• If pcmid is provided, it associates the job with a specific Paper Catalog entry

---

fiery-update

Updates an existing job on a Fiery server (change attributes, trigger actions).

Supported Overrides

Property	Type	Required	Description
server	string	No	Target Fiery server address (overrides node config)
fieryJobID	string	Yes	The job ID to update (from previous fiery-submit)
method	string	No	Job action to perform (see Valid Job Methods)
attributes	object	No	Key-value pairs of attributes to update
preset	string	No	Preset ID to apply
pcmid	string	No	Paper Catalog Media ID

Example

msg.jobflow.properties = {
  server: "192.168.1.100",
  fieryJobID: "job-12345",
  method: "print",
  attributes: {
    NumCopies: "10",
    EFStaple: "1Staple"
  },
  preset: "finishing-preset-id",
  pcmid: "glossy-paper-id"
};

Notes

• fieryJobID is required and typically comes from a previous fiery-submit node
• If method is empty, only attribute updates are applied without triggering an action
• The server override allows routing jobs to different Fiery servers dynamically

---

fiery-job

Retrieves detailed job information from a Fiery server.

Supported Overrides

Property	Type	Required	Description
server	string	No	Target Fiery server address
fieryJobID	string	Yes	The job ID to query
keys	string	No	Comma-separated list of attribute keys to retrieve

Example

msg.jobflow.properties = {
  server: "192.168.1.100",
  fieryJobID: "job-12345",
  keys: "NumCopies,PageSize,display status,state"
};

Notes

• The keys filter reduces response payload size by only returning specified attributes
• If keys is omitted, all whitelisted attributes are returned

---

fiery-info

Retrieves general information from a Fiery server (devices, queues, presets, etc.).

Supported Overrides

Property	Type	Description
server	string	Target Fiery server address
keys	string	Comma-separated list of keys to filter response

Example

msg.jobflow.properties = {
  server: "192.168.1.100",
  keys: "name,id,online"
};

---

fiery-monitor

WebSocket listener for real-time Fiery events.

Overrides

This node does not accept input messages. It is an output-only node that:

• Listens for device status changes (Output 1)
• Listens for job status changes (Output 2)

---

Job Attributes Reference

Core Job Properties

Attribute	Type	Description
NumCopies	string	Number of copies to print
PageSize	string	Page size (e.g., Letter, A4, Legal)
CustomPageSize	string	Custom page dimensions
CustomPrintSize	string	Custom print size
title	string	Job title
username	string	Submitting user name
instructions	string	Job instructions/notes
PresetName	string	Applied preset name

Media Properties

Attribute	Type	Description
media size	string	Media dimensions
media type	string	Media type classification
media weight	string	Media weight (gsm)
input slot	string	Paper tray/input source
SubstrateSizeName	string	Substrate size name
SubstrateWidthInPixels	number	Substrate width in pixels
SubstrateHeightInPixels	number	Substrate height in pixels

EF-Prefixed Attributes

All attributes starting with EF are supported. Available options depend on the connected printer’s PPD (PostScript Printer Description).

Attribute	Description	Example Values
EFDuplex	Duplex printing mode	None, TopTop, TopDown
EFColorMode	Color/grayscale mode	CMYK, Grayscale
EFMediaType	Media type	Device-specific
EFStaple	Stapling option	Off, 1Staple, 2Staples, MultiStaple
EFPunch	Hole punch option	Device-specific
EFCollate	Collation setting	True, False
EFFold	Folding option	Device-specific
EFBooklet	Booklet printing	Device-specific
EFJobExpertRule	JobExpert rule ID	Rule GUID
EFOutputBin	Output bin selection	Device-specific

Use the Property Explorer to browse all available properties for your Fiery server.

Status and Progress

Attribute	Type	Description
display status	string	Human-readable job status
state	string	Job state code
status	string	Status identifier
print status	string	Print progress status
print-progress	number	Print progress percentage
rip-progress	number	RIP progress percentage
print type	string	Type of print job
sequential printing	boolean	Sequential print mode

Page Counts

Attribute	Type	Description
num pages	number	Total pages in job
num sheets	number	Total sheets to print
num bw pages	number	Black & white pages
num color pages	number	Color pages
num cover pages	number	Cover pages
num document pages	number	Document pages
num normalPages	number	Normal pages
num specialPages	number	Special pages
blank page count	number	Blank pages
total pages printed	number	Pages printed so far
total sheets printed	number	Sheets printed so far

Timestamps

Attribute	Type	Description
date	string	Job creation date
time	string	Job creation time
timestamp printing	string	Print start timestamp
timestamp done printing	string	Print completion timestamp
timestamp done ripping	string	RIP completion timestamp
timestamp waiting to print	string	Queue wait timestamp
timestamp waiting to rip	string	RIP queue timestamp
timestamp first page printed	string	First page printed
timestamp last page printed	string	Last page printed
timestamp last page ripped	string	Last page ripped

---

Valid Job Methods

The method property in fiery-update accepts the following job actions:

Method	Description
print	Print the job
print_rush	Rush print (priority)
rip_rush	Rush RIP processing
print_and_hold	Print then hold
print_and_delete	Print then delete
hold	Hold the job
rip	RIP the job
remove_rasters	Remove raster data
duplicate	Duplicate the job
cancel	Cancel the job
rerip	Re-RIP the job
press_print	Press print
press_waiting	Set to press waiting
press_recall	Recall from press
force_print	Force print
estimate	Estimate print time/cost
pause_print	Pause printing
restart_print	Restart printing
complete_job	Mark job complete
print_next	Print next in queue
proof_print	Print proof

---

Usage Examples

Dynamic Copy Count Based on File Properties

// In a function node before fiery-submit
const pageCount = msg.jobflow.properties.pageCount || 1;
const copies = pageCount > 10 ? 1 : 5;

msg.jobflow.properties.attributes = {
  NumCopies: String(copies),
  EFCollate: "True"
};

return msg;

Routing to Different Presets by Media Type

// In a function node before fiery-submit
const mediaType = msg.jobflow.properties.detectedMediaType;

const presetMap = {
  "glossy": "preset-glossy-id",
  "matte": "preset-matte-id",
  "plain": "preset-plain-id"
};

msg.jobflow.properties.preset = presetMap[mediaType] || presetMap["plain"];

return msg;

Hold Job Then Print After Approval

// First pass: Submit to hold queue
msg.jobflow.properties.attributes = {
  NumCopies: "1"
};

// After approval (in fiery-update node):
msg.jobflow.properties = {
  fieryJobID: msg.jobflow.properties.fieryJobID,
  method: "print",
  attributes: {
    NumCopies: "100"
  }
};

return msg;

Query Specific Job Attributes

// Before fiery-job node
msg.jobflow.properties = {
  fieryJobID: msg.jobflow.properties.fieryJobID,
  keys: "display status,num pages,total pages printed,state"
};

return msg;