Create Multipage Files Plugin

Overview

The Create Multipage Files plugin by default is a part of export module. This plugin generates multipage PDF and TIF files for each document type of a batch inside final drop folder. This final drop folder path is a configurable property defined inside Copy Batch XML Plugin.

This plugin also generates colored, searchable and optimized PDF depending upon the configuration made.

Configuration

UI Configurations

Following are the list of configurable properties from UI:

Configurable propertyType of valueValue optionsDescription
PDF Optimization switchList of values
  • ON
  • OFF
This switch is used to create optimized PDF by adding web –view to PDF. This feature currently only works with Ghostscript.
Multipage File Export ProcessList of values
  • ITEXT
  • ITEXT-SEARCHABLE
  • HOCRtoPDF
  • IMAGE_MAGICK
  • GHOSTSCRIPT
  • GRAPHIC_MAGICK
This option provides user an option to select API to create multipage files.
Colored Output PDFList of values
  • TRUE
  • FALSE
This option provides the user an option to generate colored PDF as output.
Searchable Output PDFList of values
  • TRUE
  • FALSE
This option provides the user an option to create searchable PDF when this option is set to true.
PDF CreationStringNAThis option provides the parameter to create any multipage file.
PDF Optimization ParametersStringNAThis option provides the user an option to define ghostscript parameters for creating optimized PDF.
Multipage File type CreationList of Values
  • PDF
  • Tiff
  • Tiff and PDF
This option provides user an option to define which type of multipage file he wants to create.
IText searchable PDF typeList of Values
  • PDF
  • Advanced PDF
This option provides user an option to define which IText searchable PDF type he wants to choose if the user has selected IText searchable in Export Process.

Property File Configurations

Following are the list of configurable properties from property file located at ‘{Ephesoft-Home}/WEB-INF/classes/META-INF/dcma-imagemagick/imagemagick.properties’:

Configurable propertyType of valueSample ValueDescription
imagemagick.tif_compressionStringLZWThis property defines the compression mode to be used while creating multipage tiff.
imagemagick.pdf_qualityint100This property defines the quality of PDF which can vary from 0-100.
imagemagick.coloredStringTrueThis property is used to define whether multipage tiff will have colored or monochrome images
imagemagick.pdf_compressionStringLZWThis property defines the compression mode to be used while creating multipage PDF.
imagemagick.display_image_output_parametersString-colorspace gray +matteThis property defines imagemagick/graphicmagick output parameters to be used while generating multipage tiff
imagemagick.max_files_processed_per_gs_cmdint75This property defines number of maximum files ghostscript can process to generate multipage PDF
imagemagick.height_for_pdf_pageint792This property defines height of PDF page while generating PDF using iText
imagemagick.width_for_pdf_pageint612This property defines width of PDF page while generating PDF using iText
imagemagick.max_files_processed_per_im_cmdint100This property defines number of maximum files imagemagick/graphicmagick can process to generate multipage tiff

Steps of execution

  • This plug-in works in the export phase of the application when all processing on the batch has been done and it’s ready to be exported.
  • The plug-in creates multipage tiff or PDFs in the final drop folder for all document types in a batch.
  • After all the work is done, batch.xml is updated and batch is passed to other export plugins.

Dependency

This plugin requires hocr.xml file for creating searchable PDF. It has a dependency on one of the the plugins from: ‘Recostar HOCR’/ ‘Tesseract HOCR’.

Troubleshooting

Following are few common error messages received due to malfunctioning of the plugin:

S no.Error messagePossible root cause
1IM4JAVA_TOOLPATH is not set for converting images using ImageMagick.Environment variable for ImageMagick is not set.
2GM4JAVA_TOOLPATH is not set for converting images using GraphicMagick.Environment variable for GraphicMagick is not set.
3Environment Variable GHOSTSCRIPT_HOME not set.Environment variable for GhostScript is not set.