Skip to main content

 

Documentation & User Guides | FotoWare

Job Request File specification

This documents the Job Request File format that third-party systems can create integrate with a Color Factory server. It also includes the specs of the PRF (Process Results file) that Color Factory returns to allow the other system to pick up the output file and determine whether the processing succeeded.

About Job request files

The Job Request File (JRF) is an ascii file that contains the full local or UNC (Universal Naming Convention) path for an image file that is to be processed by Color Factory. It also contains the full path of the resulting output file.

The  moment a JRF is saved in a Color Factory hotfolder it is read and the processing starts. This means that the file to be processed must be in place before the JRF is created.The output file will be given a temporary name during the processing and renamed to the proper name when the output file is complete. If a file with the same name already exists it will be overwritten. The input and output filenames can be the same.

Process result files

Color Factory can generate a result file that will contain the name of the output file and an error code with description. 
The result file will have the same name and path as the JRF but with the extension PRF (Process Result File).

The JRF file is always removed by Color Factory.

The syntax of the files is the same as a Windows “INI” file. This will give us the possibility to extend the functionality at a later stage.

A JRF is recognized by Color Factory as such if the file begins with the string “[JRF]”.

FotoWare Job Request File (JRF) specification

 The complete specification for a Job Request File with a description of what each entry does below.

[JRF] 
/* section name and magic string */
M_VERSION=2 
/* Current version */
M_INPUT_FILE=\\SERVER1\OPI\HIRES\Nice Image.jpg 
/* Full path and filename of input file */
M_OUTPUT_FILE=\\SERVER1\OPI\HIRES\Nice Image.jpg
/* If left empty, the channel output folder will be used
M_REMOVE_INPUT_FILE=1 
/* 0 =do not remove input file, 1 =remove input file */
M_SET_EXTENSION=1 
/* 0 = use exact filename in M_OUTPUT_FILE, 1 = Set Extension depending of file format */
M_RETURN_PRF=1 
/* 1 = ON , 0 = OFF */
O_INPUT_UID=xxxxxxxxxxxxxx 
/* Search for image with this UID. If UID is present and found it is used instead of M_INPUT_FILE*/
O_INPUT_OID=xxxx 
/* Owner ID. Can be used for HTTP search*/
O_OUTPUT_IMAGENAME=Image.jpg 
/* Name to use on output file if M_OUTPUT_FILE is left empty */
O_COPY_INPUT_FILE=\\SERVER1\OPI\BACKUP\Nice Image.jpg 
/*Copy the input file to this location */
O_OUTPUT_COLOR=CMYK 
/* can be CMYK , RGB or BW */
O_OUTPUT_RES_DPI=180 
/* output resolution in DPI */
O_AUTOCONTRAST=1 
/* 1 = ON , 0 = OFF */
O_UNSHARPMASK=1 
/* 1 = ON , 0 = OFF */
/* Crop and Width values can also be given as floating pointvalues. Note that when FP is used a dot ‘.’ must appear in the value string. 
FP values must not be multiplied by 100 or 1000. Max values for Crop is 100.0 and width values are given in inch or cm.*/
O_CROP_LEFT=1500 
/* left crop 0 - 10000. 10000 = 100% of width */
O_CROP_TOP=1500 
/* top crop 0 - 10000. 10000 = 100% of height */
O_CROP_RIGHT=5000 
/* right crop 0 - 10000. 10000 = 100% of width */
O_CROP_BOTTOM=5000 
/* bottom crop 0 - 10000. 10000 = 100% of height */
O_WIDTH_INCH=4500 
/* width of crop area in Inch * 1000 */
O_WIDTH_CM=4500 
/* width of crop area in cm * 1000 */
O_HEIGHT_INCH=4500 
/* Height of crop area in Inch * 1000 .*/
O_HEIGHT_CM=4500 
/* Height of crop area in cm * 1000 */
O_ROTATE=90 
/* rotation in degrees, values between 0-360 */
O_WIDTH_PIXEL=1024
/*Output width in pixels. If width is missing, the output width will be floating based on the height value.*/
O_HEIGHT_PIXEL=1024
/*Output height in pixels. If height is missing, the output height will be floating based on the width value.*/

 

Process Result File (PRF) specification

[PRF] 
/* section name and magic string */
OUTPUT_FILE=\\SERVER1\OPI\HIRES\Nice Image.jpg
ERROR=1  
/* O = no error, 1 = process failed */
ERROR_STRING=Invalid Path 
/* Error description generated by Color Factory */
  • Was this article helpful?