JetTrac ImageMerge

Introduction:

The following document will go through the functionality found within JetTrac ImageMerge. This module is used to merge images stored locally into a AcroForm PDF.

Technical Support:

If you need assistance in installing and configuring JetTrac ImageMerge™, call Pro Technology Automation, Inc. at 805-527-1248 or email us at support@protechinc.com. Please note that the JetTrac ImageMerge™ license fee does not cover configuration services and technical support so there may be an additional charge. Please ensure you read these instructions carefully before calling for technical support.

How to run JetTrac ImageMerge:

To run the program, you will need to have the following files located in the same folder:

  • JTImageMerge.exe
  • ExitHandler.dll
  • DebenuPDFLibraryDLL1112.dll

Executable files and dll files should not be edited for any reason.

Default Functionality:

JetTrac ImageMerge takes an input XML file containing the locations of any images that should be merged into a PDF and a PDF template, then outputs the resulting PDF.

Job Step Configuration Window in JobConfig for JetTrac ImageMerge:

imagemerge.PNG

When setting up a job step using JTImageMerge in JobConfig the only lines of the config you need to worry about are the first and the last two, the Input PDF, Input XML and the Output PDF. If left as an asterisk * the Input PDF will be whatever file is in the data folder that triggered the job running. This works well if it’s the first step but if the input is also the output of a previous job step you would need to specify the fully qualified path of the input PDF you want to insert images into. All other fields should be filled with the fully qualified path to the intended file. Eg: C:\JetTrac\…\input.pdf
In JobConfig, file paths entered should not be in quotes.

As with all modules, there is a dropdown to select whether or not the job should stop completely if this step fails. If you select Yes, any error will terminate the job process and write to the log file what happened, if no, then the job will try to continue anyways. However if any steps further down the line rely on the output of a job set to not stop on error, they may not work properly.

For more specifics go to the JetTrac BYODJobConfig page.

JetTrac ImageMerge Command Line:

The command line to run JetTrac ImageMerge contains the location of the executable, the input XML file, the input AcroForm PDF template, the output PDF, and the log file. The following is an example of the command line used to run this module:

“C:\JTImageMerge.exe” “C:\Input.xml” “C:\Input.pdf” “C:\Output.pdf” “C:\ImageMerge.log”

Each part of the line is divided by spaces (the amount doesn’t matter), and contains the fully qualified file path to the file you are referencing surrounded by quotes. In the example all of the file paths reference the root of C:\, however, it is likely that none of these files will be located in the root of C:\ for your system, so this is simply demonstrating that the full file path is required.

Setting Up the XML:

The XML input file for JetTrac ImageMerge contains a list of field names with the value being the file path to the image. The following is an example XML input file:

<ImageFieldName1>C:\Image1.JPG</ImageFieldName1>
<ImageFieldName2>C:\Image2.JPG</ImageFieldName2>

The node contains two parts, the name of the field within the PDF is the node field name and the node field value is the file path to the image you wish to merge into the place where that field name is found within the PDF.

For example, if you have a PDF template that has a field named “ImageFieldName2” and run JetTrac ImageMerge on this form with this input XML file, the image located at “C:\Image2.JPG” will be merged onto the PDF form in the place of the “ImageFieldName2” field.

Additional Notes:

If there is a field name within the XML that doesn’t exist on the PDF template, no image will be merged but the module will not give an error. This allows you to use the same input XML file for multiple forms when you want different images on each form.