XML Connectors

Input

There are three ways of inputting jobs:
  • XML/JDF jobs: Sending files via the external Public API.
  • (Partial) XML jobs : Drop XML files in a hot folder. The hotfolder settings will enrich the job where it’s necessary, to become a full job.
  • JDF files: HP WallArt, EFI Metrix, HP Wide-Format ICS are amongst the supported JDF files that are accepted by hotfolders in a similar way as the XML jobs.

XML jobs

An XML job specification can range from just having the link (file path or URL) to the input file, to being a fully specified job including imposition and anything in between.
Jobs are delivered to hotfolders as a file (.xml), or through the REST API to a queue. The queue processes the job just as you’d expect, as any other file that’s dropped into the hotfolder of the queue. However, if the job has specified a particular node for a processing step – and that’s specified in the queue – then this processing step is skipped. So, when a full specified job is delivered (specifying all processing nodes for each processing step that is set in the queue set-up), nothing gets added to the job and it will be processed as-is.
PrintFactory Layout and Editor deliver fully-specified jobs that don’t get touched by the queue.
Minimal job
A minimal job only specifies the path to the file:
<?xml version="1.0" encoding="UTF-8" ?>
    <Job>
    <PDFJob>
        <FilePath>C:\Example\MyExample.pdf</FilePath>
        <IsTemporary>false</IsTemporary>
    </PDFJob>
</Job>
The file path points to the PDF and the tag ‘IsTemporary’ specifies whether or not the RIP should delete the file after picking it up. By setting it to false the file will be left at its original location.
In this simple form, it is also possible to pickup any of the other support file formats besides PDF like TIFF, JPEG, etc.
As the job is enriched with the processing steps specified in the queue it is fairly easy to set-up, for example:
  • print & cut workflow that automatically adds the correct registration marks, creates cut-contours and send a job to the cutter.
  • proofing or layout proofing cycle that creates a scaled down, color accurate job to the proofer to can be used as reference during production

Example jobs

The best way to create example jobs is by using PrintFactory Layout.
Open a file and create the layout you want. Then send the job to the RIP – the job will appear in the RIP work folder (see RIP preferences for the location). The file Settings.xml contains a fully-specified job. Use the document at Job XML to analyse how Layout set up the job and specifies the parameters … and then copy the parts needed to your own XML to test it.

JDF files

PrintFactory supports predefined JDF ICS schemas through the hotfolder in a similar fashion as XML jobs. So the JDF is also enriched with steps specified in the queue that are not specified in the JDF.
HP WallArt, EFI Metrix, HP Wide-Format ICS are amongst the supported JDF files that are accepted, please check with the sales and/or support department which are the currently supported ICSs.

Output

There are three ways to receive progress and status information from the RIP:
  • XML messages : Every status change is posted to a HTTP server using a GET call.
  • JMF messages : HP WallArt is supporting JMF messaging to report the status

XML messages

The RIP pushes a message for a range of events, both job related as RIP related to the URL specified at ‘XML report URL’ in the RIP preferences. During processing, the events are stored in a local database (DataBaseLogger.db) that is located in the shared data folder. A background task will try to deliver the messages to the specified URL for the number of days specified at ‘Buffer messages until’ in the RIP preferences.
Or, it is possible to add a “ReportURL” tag in the job. In this case, that URL will be used for that job. It’s also possible to specify “AtFailure” and “AtDone” URLs in the job to get job-specific URLs called when the job is processed successfully (or if it fails).
The messages only contain the job reference (GUID), and data about the event as it’s written in the job (the journal section, by default). However if the “Type” attribute of the “ReportURL” in the job is set to “Full” then the complete job XML is pushed to the specified URL.
The following events are pushed to the host:
  • RIP : Job render results
  • Spooler : Job printing results
  • Input Job XML parsing failure
  • NestJob : Nest created (see Nesting XML report)
  • ConvertToPDF : Input job converted to PDF
  • DefectCheck : Input job defect check results

JMF messages

JMF messaging is currently supported for HP WallArt and other bespoke implementation. Please check with the sales and/or support department to find out which JMF messages are currently supported.

REST API

When no custom XML report URL is specified in the RIP preferences, and Data Collection is set to on in HUB server, then all messages are sent to the cloud-based database. The data can be viewed and analysed by various tools in the HUB server but is also available through a single REST API.
The MIS/ERP or Web-to-print system can query this API to find the status of each job or can register itself to get push messages about status changes.