# Actions List
Below is a list of all actions that can be automated using hot folders and their corresponding resources. All fields are optional unless otherwise indicated in the field description.
# Opening/Creating Jobs
A new job can be created or an existing job can be opened in hot folders. One of these actions must be the first action defined in the Actions XML file.
# Create Job Action
Description: Creates a new job
XML Element: <create-job>
Resource Format:
<create-job-resource>
<id>Job ID</id> ID of job to create
<name>Job Name</name> Name of job to create
<template-path>Path</template-path> Path of PHXT template to create job with
<contact>Contact</contact> Name of contact person
<phone>Phone</phone> Phone number of contact person
<client>Client</client> Client name
<notes>Notes</notes> Job notes
<default-bleed>Scalar</default-bleed> Default product bleed offset
<units>Units</units> Units of job, defaults to preferences
</create-job-resource>
Note
Using job templates via the <template-path> element can be a powerful way of creating jobs. Phoenix templates (PHXT) can include everything in a job except artwork. For example, new jobs with imported CAD layouts, resolved bleed overlaps, pre-defined media, properties, marks, etc. can be loaded in this single action using templates.
# Open Job Action
Description: Opens an existing job
XML Element: <open-job>
Resource Format:
<open-job-resource>
<path>Path</path> Path of the PHX job to be opened (required)
<id>ID</id> ID to give to the opened job
</open-job-resource>
# Adding and Editing Layouts
# Add Layout Action
Description: Adds a layout to the job
XML Element: <add-layout>
Resource Format:
<add-layout-resource>
<name>Name</name> Optional layout name, when specified overrides default name
</add-layout-resource>
# Edit Layout Action
Description: Edits properties of an existing layout in the job
XML Element: <edit-layout>
Resource Format:
<edit-layout-resource>
<name>Name</name>Optional layout name, when specified edits the current layout name
<workstyle>Workstyle</workstyle> Workstyle of layout, when specified changes current layout workstyle: FlatWork, Sheetwise, or Perfecting
<run-length>Run length</run-length> Layout run length, when specified overrides the current layout run length
</edit-layout-resource>
# Setting Media
The "Hot Folders" module offers three actions for setting media in a job: Set Press, Set Plate, and Set Sheet.
# Set Press Action
Description: Sets the press to use in the job layout
XML Element: <set-press>
Resource Format:
<set-press-resource>
<name>Press Name</name> Name of press in Press Library (required)
</set-press-resource>
Note
If the press referenced has default plate and/or sheet defined, the plate or sheet will be added to the layout automatically. This is the same behavior as dragging and dropping the press into a layout within Phoenix.
# Set Plate Action
Description: Sets the plate to use in the job layout
XML Element: <set-plate>
Resource Format:
<set-plate-resource>
<name>Plate Name</name> Name of plate in Plates Library (required)
</set-plate-resource>
# Set Sheet Action
Description: Sets the sheet to use in the job layout
XML Element: <set-sheet>
Resource Format:
<set-sheet-resource>
<stock>Stock Name</stock> Stock name in Stocks Library (required)
<grade>Grade Name</grade> Grade name within that Stock (required)
<name>Sheet Name</name> Sheet name within that Grade (required)
</set-sheet-resource
# Resize Sheet Action
Description: Resizes the current sheet in the job layout
XML Element: <resize-sheet>
Resource Format:
<resize-sheet-resource>
<width>Sheet width</width> New width of current layout sheet (required)
<height>Sheet height</height> New height of current layout sheet (required)
</resize-sheet-resource>
# Adding Products
There are two actions for adding new products to the job: Add Products and Import Product CSV.
# Add Products Action
Description: Adds variable number of products to the job defined in the corresponding resource
XML Element: <add-products>
Resource Format:
<add-products-resource>
<products> (required)
<product> (required)
<name>Product Name</name> Name of product to create (required)
<ordered>Number</ordered> Ordered amount of product
<stock>Stock Name</stock> Name of stock product is to be printed on
<grade>Grade Name</grade> Name of grade product is to be printed on
<grain>Direction</grain> Grain direction: Horizontal, Vertical, None
<rotation>Rotation</ rotation> Rotation type to allow in product: An, Orthogonal, None, or Custom
<allowed-rotations>Rotations</allowed-rotation> List of custom rotations to allow
<width>Scalar</width> Width of product (empty product or scaling)
<height>Scalar</height> Height of product (empty product or scaling)
<artwork>Path</artwork> Path of artwork file to use to create product or snap into product if die defined
<page>Number</page> Page number of artwork file to use forfront of product, defaults to page 1
<back-artwork>Path</back-artwork> Path of artwork file to use for back of product
<back-page>Number</back-page> Page number of artwork file to use forback of product, defaults to page 1
<group>Group Name</group> Group that the product belongs to
<front-inks> Inks to use for front of product
<ink>Ink Name</ink> First Ink (required)
<ink>...</ink> Additional Ink(s)
</front-inks>
<back-inks> Inks to use for back of product
<ink>Ink Name</ink> First Ink (required)
<ink>...</ink> Additional Ink(s)
</back-inks>
<due-date>Date</due-date> Product due date
<priority>Priority</priority> Optional priority of product 1 being highest
<dieshape-source>Source</dieshape-source> Dieshape source: CAD, ArtworkPaths, ArtworkTrimbox, CustomSize, DieDesignLibrary
<cad-file>Path</cad-file> Path of CAD file to use when defining product based on 1-up design in a CAD file
<cad-design>Design Name</cad-design> Design name of 1-up CAD design in the CAD file, defaults to first 1-up in the CAD file when not defined
<die-design>Design Name</die-design> Design name of 1-up design in the die designlibrary
<spacing-type>Type</spacing-type> Spacing Type: Margins, Uniform, Bleed
<spacing-margin>Scalar</spacing-margin> Single scalar margin when type is Uniform
<spacing-margins> Spacing margins when type is Margins
<left>Scalar</left> Left spacing margin
<top>Scalar</top> Top spacing margin
<right>Scalar</right> Right spacing margin
<bottom>Scalar</bottom> Bottom spacing margin
</spacing-margins>
<bleed-type>Type</bleed-type> Bleed Type: Margins, Contour, CAD, None
<bleed-margin>Scalar</bleed-margin> Single scalar margin when type is Contour
<bleed-margins> Bleed margins when type is Margins
<left>Scalar</left> Left bleed margin
<top>Scalar</top> Top bleed margin
<right>Scalar</right> Right bleed margin
<bottom>Scalar</bottom> Bottom bleed margin
</bleed-margins>
<offcut-margins> Offcut margins
<left>Scalar</left> Left offcut margin
<top>Scalar</top> Top offcut margin
<right>Scalar</right> Right offcut margin
<bottom>Scalar</bottom> Bottom offcut margin
</offcut-margins>
<min-overruns>Number</min-overruns> Minimum percentage of overruns
<max-overruns>Number</max-overruns> Maximum percentage of overruns
<bundle-size>Number</bundle-size> Product bundle size, i.e. the allowed multiples of the product that can be produced
<description>Description</description> Product description
<notes>Notes</notes> Product notes
<marks> Optional product marks to apply to this product
<mark>Mark name</mark> First mark to apply
<mark>…</mark> Additional marks to apply
</marks>
<templates> List of templates to restrict this product to
<template>Template name</template> First template
<template>…</ template> Additional templates
</templates >
<autosnap-ink>Ink Name</autosnap-ink> Spot ink name to use for autosnap in imported artwork
<back-autosnap-ink>Ink Name</back-autosnap-ink> Spot ink name to use for autosnap on back of imported artwork
<autosnap-layer>Layer Name</autosnap-layer> PDF layer name to use for autosnap in imported artwork
<back-autosnap-layer>Layer Name</back-autosnap-layer> PDF layer name to use for autosnap on back of imported artwork
<cut-ink>Ink Name</cut-ink> Spot ink name to use for cut lines in Imported artwork (deprecated)
<crease-ink>Ink Name</crease-ink> Spot ink name to use for crease lines in imported artwork (deprecated)
<bleed-ink>Ink Name</bleed-ink> Spot ink name to use for bleed lines in imported artwork (deprecated)
<cut-layer>Layer Name</cut-layer> PDF layer name to use for cut lines in imported artwork (deprecated)
<crease-layer>Layer Name</crease-layer> PDF layer name to use for crease lines in imported artwork (deprecated)
<bleed-layer>Layer Name</bleed-layer> PDF layer name to use for bleed lines in imported artwork (deprecated)
</product>
<product>
…Additional product(s) to create
</product>
</products>
</add-products-resource>
Note
As with product CSV import, one of the following is required to create a product: height/width, artwork, or a die design. If none of these fields are present, the shape of the product cannot be determined and Add Products action will fail.
# Import Product CSV Action
Description: Add products from CSV file
XML Element: <import-product-csv>
Resource Format:
<import-product-csv-resource>
<path>Path</path> Path of CSV file (required)
<preset>Preset Name</preset> Name of preset to import, defaults toStandard Preset when not specified
<base-folder>Folder name</base-folder> Optional base folder to use for relative paths
</import-product-csv-resource>
Note
For non-standard CSV formats, you will need to create a preset beforehand in the Import Product CSV dialog in Phoenix and use the saved preset name in the <preset> element.
# Importing and Placing Dies, and Assigning Artwork
The hot folder feature includes actions for importing and placing CAD die templates into layouts, auto-snapping artwork into dies, and assigning artwork files to products automatically.
# Import Die Template Action
Modules: CAD
Description: Import die template from existing CAD file
XML Element: <import-die-template>
Resource Format:
<import-die-template-resource>
<path>Path</path> Path of CAD file (required)
<preset>Preset Name</preset> Name of preset to import, defaults to preset defined in preferences for given CAD format when not specified
</import-die-template-resource>
Note
CAD file format is detected automatically. For PDF-based CAD die templates, the Structural PDF feature included in Phoenix Pro is required.
# Place Die Template Action
Modules: CAD
Description: Place imported die template
XML Element: <place-die-template>
Resource Format:
<place-die-template-resource>
<name>Template Name</name> Name of Template to be placed
<x>Number</x> X-value of coordinates where template is placed
<y>Number</y> Y-value of coordinates where template is placed
</place-die-template-resource>
# Assign Artwork Files Action
Description: Automatically assign artwork files in a given folder to products in the jobs based on file name matching
XML Element: <assign-artwork-files>
Resource Format:
<assign-artwork-files-resource>
<path>Path</path> Path of artwork files (required)
<include-sub-folders>Boolean</include-sub-folders> Whether to include artwork in subfolders
</assign-artwork-files-resource>
# Autosnap Action
Description: Autosnap variable list of artwork files into specific die locations or products in the job
XML Element: <autosnap>
Resource Format:
<autosnap-resource>
<artworks>
<artwork>
<path>Path</path> Path of artwork file (required)
<front-page>Number</front-page> Front page number to snap, defaults to 1
<back-page>Number</back-page> Number of back page to snap, defaults to none meaning no snap to back side
<cut-ink>Ink Name</cut-ink> Name of spot cut line ink. Automatically detected when not specified
<products> List of product names to snap artwork into
<product>Name</product> First product name
<product>...</product> Additional product name(s)
<products>
<dies> List of dies in layout to snap artwork into
<die number="N" layout="L" /> First die to snap artwork into. Die number attribute "number" is required. Layout number attribute "layout" is the layout that the die is found on and defaults to layout 1
<die number="..." layout="..." />Additional die(s) to snap artwork into
…
<dies>
</artwork>
<artwork>Additional artworks(s) to snap
...
</artwork>
</artworks>
</autosnap-resource>
Note
For each <artwork> element, at least one <product> or <die> is needed. You cannot however define both products and dies in the same <artwork> element.
# Applying Marks
There are two actions for adding marks to a job in hot folders: Apply Mark and Apply Mark Set. Both actions support all Smart Mark types. Manual Marks are not supported in automation.
# Apply Mark Action
Description: Apply a smart mark from the Marks library to the job
XML Element: <apply-mark>
Resource Format:
<apply-mark-resource>
<name>Mark Name</name> Name of mark in Marks Library (required)
</apply-mark-resource>
# Apply Mark Set Action
Description: Apply a mark set from the Mark Set library to the job
XML Element: <apply-mark-set>
Resource Format:
<apply-mark-set-resource>
<name>Mark Set Name</name> Name of mark set in Mark Set Library (required)
</apply-mark-set-resource>
Step and Repeat
# Step and Repeat Action
Description: Step and repeat a given product in a layout
XML Element: <step-repeat>
Resource Format:
<step-repeat-resource>
<product-name>Product Name</product-name> Name of product to step and repeat (required)
<x>X position</x> Optional X position to place repeat group in sheet. This value is ignored if an auto-fill option is defined in settings in horizontal direction.
<y>Y position</y> Optional Y position to place repeat group in sheet. This value is ignored if an auto-fill option is defined in settings in vertical direction
<settings> Settings controlling how step and repeat group is generated (required)
<rows>Number</rows> Number of rows in step and repeat grid when vertical-fill is not set or is None
<columns>Number</columns> Number of columns in step and repeat grid when horizontal-fill is not set or is None
<head-turn>Head turn</head-turn> Head turn rotation to apply on every other row and/or column (None, Row, Column, or ColumnRow)
<initial-rotation>Number</initial-rotation> Initial rotation to apply to product when building step and repeat grid
<horizontal-gap-type>Gap type</horizontal-gap-type> Horizontal gap type defining how gap(s) are interpreted. (Center, Edge, or Smart) Default: Edge
<vertical-gap-type>Gap type</vertical-gap-type> Vertical gap type defining how gap(s) are interpreted. (Center, Edge, or Smart) Default: Edge
<horizontal-gap>Scalar Value</horizontal-gap> Horizontal gap scalar value (required)
<vertical-gap>Scalar value</vertical-gap> Vertical gap scalar value (required)
<even-horizontal-gap>Scalar value</even-horizontal-gap> Optional even horizontal gap scalar value. When set, horizontal-gap is used for odd horizontal gap spacing while this gap value is used for even rows
<even-vertical-gap>Scalar value</even-vertical-gap> Optional even vertical gap scalar value. When set, vertical-gap is used for odd vertical gap spacing while this gap value is used for even columns
<stagger>Stagger type</stagger> Type of stagger to apply to rows or columns. If not specified no stagger is applied. (None, Horizontal, or Vertical)
<stagger-amount>Number</stagger-amount> Stagger amount when stagger is not None
<stagger-restart>Number</stagger-restart> Number of rows or columns before staggeramount is restarted back to 0. If not defined, stagger value continues to be applied to each subsequent row or column indefinitely.
<horizontal-fill>Fill type</horizontal-fill> Whether to automatically fill the sheet as much as possible in the horizontal direction. By default horizontal-fill is off (None) in which case the columns field needs to be defined. (None, Pack, Expand, or Wrap)
<vertical-fill>Fill type</vertical fill> Whether to automatically fill the sheet as much as possible in the vertical direction. By default horizontal-fill is off (None) in which case the rows field needs to be defined
<sheet-margins> When specified, these margins are applied to the sheet to define the area to be used for auto fill. If not set the current sheet content margins are used.
<left>Scalar</left> Left sheet margin
<top>Scalar</top> Top sheet margin
<right>Scalar</right> Right sheet margin
<bottom>Scalar</bottom> Bottom sheet margin
</sheet-margins>
<bleed-offset>Scalar</bleed-offset> When set, a bleed offset is applied to each in the step and repeat group and rectangular bleeds are automatically resolved. If not set, product bleed masks are used.
</settings>
</step-repeat-resource>
# Imposition AI
All four Imposition AI tools in Phoenix are available as hot folder actions when the Imposition AI module is included in your license.
# Impose Action
Modules: Imposition AI
Description: Run Impose tool on the job with selected products and profile and apply the most cost-efficient result automatically.
XML Element: <impose>
Resource Format:
<impose-resource>
<products> Products to include, when not specified all products in the job are included
<product>Product Name</product> First Product
<product>...</product> Additional product(s)
</products>
<profiles>
<profile>Profile Name</profile> Profile to use, when not specified Default profile is used
</profiles>
<templates> Templates to use, when not specified all templates matching products in the job and Templates library are included
<template>Template Name</ template > First template
<template >...</template> Additional template(s)
</templates >
<stop-minutes>Number</stop-minutes> Max time to allow Impose to run in minutes
</impose-resource>
# Populate Action
Modules: Imposition AI
Description: Run Populate tool on the job with selected products and profile, and apply the first result automatically.
XML Element: <populate>
Resource Format:
<populate-resource>
<products> Products to include, when not specified all products in the job are included
<product>Product Name</product> First Product
<product>...</product> Additional product(s)
</products>
<profiles>
<profile>Profile Name</profile> Profile to use, when not specified Default profile is used
</profiles>
<stop-minutes>Number</stop-minutes> Max time to allow Populate to run in minutes
</populate-resource>
# Optimize Action
Modules: Imposition AI
Description: Run Optimize tool across the given sheet and press combinations and apply the most cost-effective layout automatically to the job.
XML Element: <optimize>
Resource Format:
<optimize-resource>
<products> Products to include, when not specified all products in the job are included
<product> Product Name</product>First Product
<product>...</product> Additional product(s)
</products>
<profiles>
<profile>Profile Name</profile> Profile to use, when not specified Default profile is used
</profiles>
<presses> Presses to use from Press library, when not specified all presses in library are used
<press>Press Name</press> Name of first press
<press>...</press> Name of additional press(es)
...
</presses>
<sheets> Sheets to use, when not specified all sheets in all product stocks are used
<sheet> First sheet
<stock>Stock Name</stock> Name of stock to use (required)
<grade>Grade Name</grade> Name of grade within that Stock
<name>Sheet Name</name> Name of sheet within that Grade (required)
</sheet>
<sheet> Additional sheet(s)
…
</sheet>
</sheets>
<rolls> Rolls to use, when not specified all rolls in all product stocks are used
<roll> First roll
<stock>Stock Name</stock> Name of stock to use (required)
<grade>Grade Name</grade> Name of grade within that Stock
<name>Sheet Name</name> Name of roll within that Grade (required)
</roll>
<roll>Additional roll(s)
…
</roll>
</rolls>
<templates> Templates to use, when not specified all templates matching products in the job and Templates library are included
<template>Template Name</template> First template
<template>...</template> Additional template(s)
</templates>
<stop-minutes>Number</stop-minutes> Max time to allow Optimize to run in minutes
</optimize-resource>
# Plan Action
Modules: Imposition AI
Description: Run Plan tool across the given sheet and press combinations and apply the most cost-effective plan automatically to the job.
XML Element: <plan>
Resource Format:
<plan-resource>
<products> Products to include when running Optimize, when not specified all products in the job are included
<product>Product Name</product> First Product
<product>...</product> Additional product(s)
</products>
<profiles>
<profile>Profile Name</profile> Profile to use when running Optimize, when not specified Default profile is used
</profiles>
<presses> Presses to use from Press library, when not specified all presses in library are used
<press>Press Name</press> Name of first press
<press>...</press> Name of additional press(es)
...
</presses>
<sheets> Sheets to use, when not specified all sheets in all product stocks are used
<sheet> First sheet
<stock>Stock Name</stock> Name of stock to use (required)
<grade>Grade Name</grade> Name of grade within that Stock
<name>Sheet Name</name> Name of sheet within that Grade (required)
</sheet>
<sheet> Additional sheet(s)
…
</sheet>
</sheets>
<rolls> Rolls to use, when not specified all rolls in all product stocks are used
<roll> First roll
<stock>Stock Name</stock> Name of stock to use (required)
<grade>Grade Name</grade> Name of grade within that Stock (required)
<name>Sheet Name</name> Name of roll within that Grade (required)
</roll>
<roll> Additional roll(s)
…
</roll>
</rolls>
<templates> Templates to use, when not specified all templates matching products in the job and Templates library are included
<template>Template Name</template> First template
<template >...</template> Additional template(s)
</templates >
<stop-minutes>Number</stop-minutes> Max time to allow Plan to run in minutes
</plan-resource>
# Saving and Exporting Jobs
# Save Job Action
Description: Save current job to a given path
XML Element: <save-job>
Resource Format:
<save-job-resource>
<path>Path</path> Path to save job to (required)
<embed-artwork>Boolean</embed-artwork> Whether to embed artwork files into the saved job (PHX), defaults to preferences
</save-job-resource>
# Save Job Template Action
Description: Save current job as a template to a given path
XML Element: <save-job-template>
Resource Format:
<save-job-template-resource>
<path>Path</path> Path to save template to (required)
</save-job-template-resource>
# Export PDF Action
Description: Export imposed PDF
XML Element: <export-pdf>
Resource Format:
<export-pdf-resource>
<path>Path</path> Path to save imposed PDF to (required)
<preset>Preset Name</preset> Name of PDF Export Preset to use, defaults to Factory Default PDF Export
</export-pdf-resource>
# Export JDF Action
Description: Export absolute path, relative path, or MIME JDF depending on JDF Export Preset used.
XML Element: <export-jdf>
Resource Format:
<export-jdf-resource>
<path>Path</path> Path to save imposed JDF to (required)
<preset>Preset Name</preset> Name of JDF Export Preset to use, defaults to Factory Default JDF Export
</export-jdf-resource>
# Export Vector Separation Action
Description: Export imposed vector separation file
XML Element: <export-vector-separation>
Resource Format:
<export-vector-separation-resource>
<path>Path</path> Path to save separation PDF to (required)
<preset>Preset Name</preset> Name of Export Vector Separation Preset to use (required)
</export-vector-separation-resource>
# Export Cover Sheet Action
Description: Export Cover Sheet PDF
XML Element: <export-cover-sheet>
Resource Format:
<export-cover-sheet-resource>
<path>Path</path> Path to save cover sheet to (required)
<preset>Preset Name</preset> Name of PDF Export Preset to use, defaults to Factory Default PDF Export
</export-cover-sheet-resource>
# Exporting Die Layouts
The hot folders feature supports four actions for exporting jobs layouts as dies or cutting data for post-press: Export CFF2 Layout, Export PDF Layout, and Export Cutting JDF.
# Export CFF2 Layout Action
Description: Export job layout in CFF2 CAD layout format
XML Element: <export-cff2-layout>
Resource Format:
<export-cff2-layout-resource>
<path>Path</path> Path to save CFF2 layout file to (required)
<preset>Preset Name</preset> Name of CFF2 Export Preset to use, defaults to CF2 Default Preset
</export-cff2-layout-resource>
# Export PDF Layout Action
Description: Export job layout die lines as PDF file
XML Element: <export-pdf-layout>
Resource Format:
<export-pdf-layout-resource>
<path>Path</path> Path to save PDF Die Layout file (required)
<preset>Preset Name</preset> Name of PDF Die Layout Preset to use, defaults to PDF Default Preset
</export-pdf-layout-resource>
# Export Cutting JDF Action
Description: Export cutting JDF file, i.e. CIP4 cutting data.
XML Element: <export-cutting-jdf>
Resource Format:
<export-cutting-jdf-resource>
<path>Path</path> Path to save Cutting JDF file to (required)
<preset>Preset Name</preset> Name of PostScript Die Layout Preset to use, defaults to PostScript Default Preset
</export-cutting-jdf-resource>
# Reports
Hot folder automation supports all three Phoenix report formats: PDF, XML, and JSON. PDF reports are ideal for sharing job estimates with colleagues or clients, while text-based XML and JSON formats are designed to pass job and product information back to the MIS and/or workflow system.
# Export PDF Report Action
Description: Export PDF job report
XML Element: <export-pdf-report>
Resource Format:
<export-pdf-report-resource>
<path>Path</path> Path to save PDF report to (required)
<preset>Preset Name</preset> Name of PDF job report preset to use, defaults to PDF Report Default Preset
</export-pdf-report-resource>
# Export XML Report Action
Description: Export XML job report
XML Element: <export-xml-report>
Resource Format:
<export-xml-report-resource>
<path>Path</path> Path to save XML report to (required)
<preset>Preset Name</preset> Name of XML job report preset to use, defaults to XML Report Default Preset
</export-xml-report-resource>
# Export JSON Report Action
Description: Export JSON job report
XML Element: <export-json-report>
Resource Format:
<export-json-report-resource>
<path>Path</path> Path to save JSON report to (required)
<preset>Preset Name</preset> Name of JSON job report preset to use, defaults to JSON Report Default Preset
</export-json-report-resource>