XML Job Condition Files

Any job created in Kingfisher is saved in a job condition file, these are xml files usually created in the conditions folder. These files can be used to execute jobs from the Command line using the –JobFile parameter.

Developers may wish to create, edit or generate XML job files using the information below.

Option
Description
jobspecialoptions Set of options for the specified operation. Described in detail in Job Settings
outputnamemask The Name Template explained in File Naming
usenametemplate If the value is true, the Name Template will be used instead of the script.
Metadata Metadata settings for result PDF files. By default, metadata fields are left blank. Described in detail in PDF Metadata
docoptions Document option settings for result PDF files. Described in detail in section Display Modes
Security Security settings for result PDF files. By default, files are not secured. Described in detail in Security
Sourcefiles Source PDF file, folder or tree. May be multiple files for merge operations.
advancedflags Used to pass extra parameters, do not use unless directed by Aquaforest Technical team.
logfile Each run of a job is output will be logged to a file based on this template. See section Location Settings for details. The filename by default uses the %TIMESTAMP% variable. On completion of a run, the file referenced by kingfisherlivelog is copied to a new file based on this logfile template
kingfisherlivelog When a job is running, output is written to this file. At the end of a job, the logfile template is used as a destination for a copy.
textextraction This contains the definitions of text to be extracted .
forceocr When set to true, any file processed will be OCRd (see the OCR options for other related settings) irrespective of whether it would normally be considered searchable.