Overview

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

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

Configuration

UI Configurations

Following are the list of configurable properties from UI:-

 

400px-3.1_CreateMultipageFilesPlugin_10001

 

 

[table caption=”” width=”800″ colwidth=”80|200|200|200″ colalign=”center|center|center|left”]
Configurable property,Type of value,Value options,Description
PDF Optimization switch,List 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 Process,List of values,ITEXT~~ITEXT-SEARCHABLE~~HOCRtoPDF~~IMAGE_MAGICK~~GHOSTSCRIPT~~RECOSTAR,This provides user with an option to select API to create multipage files.
Colored Output PDF,List of values,TRUE~~FALSE,This provides user with an option to generate colored PDF as output.
Searchable Output PDF,List of values,TRUE~~FALSE,This provides user with an option to create searchable PDF when this option is set to true.
PDF Creation Parameters,String,NA,This provides user with an option to define ghostscript parameters for creating PDF.
PDF Optimization Parameters,String,NA,This provides user with an option to define ghostscript parameters for creating optimized PDF.
Multipage File Creation Typ,List of values,PDF~~Tiff~~Tiff and PDF,This provides user with an option to select type of multipage file to be created.
IText Searchable PDF Type,List of values,PDF~~PDF Advanced,This provides user with an option to choose type of pdf.

[/table]

 

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’:-

 

[table caption=”” width=”800″ colwidth=”80|200|200|200″ colalign=”center|center|center|left”]
Configurable property,Type of value,Value options,Description
imagemagick.tif_compression,String,LZW,This property defines the compression mode to be used while creating multipage tiff.
imagemagick.pdf_quality,int,100,This property defines the quality of PDF which can vary from 0-100.
imagemagick.colored,String,True,This property is used to define whether multipage tiff will have colored or monochrome images.
imagemagick.pdf_compression,String,LZW,This property defines the compression mode to be used while creating multipage PDF.
imagemagick.display_image_output_parameters,String,-colorspace gray -alpha off,This property defines imagemagick output parameters to be used while generating multipage tiff.
imagemagick.max_files_processed_per_gs_cmd,int,75,This property defines maximum number of files ghostscript can process to generate multipage PDF.
imagemagick.height_for_pdf_page,int,792,This property defines height of PDF page while generating PDF using iText.
imagemagick.width_for_pdf_page,int,612,This property defines width of PDF page while generating PDF using iText.
imagemagick.max_files_processed_per_im_cmd,int,100,This property defines number of maximum files imagemagick can process to generate multipage tiff.

[/table]

 

Steps of execution

  • This plug-in works in the export phase of the application when all processing on the batch has been done and all the batch artifacts are ready to be exported.
  • The plug-in creates multipage tiff or PDFs in the final export 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 plugins from: ‘Recostar HOCR’/ ‘Tesseract HOCR’.

 

Troubleshooting

Following are few common error messages received due to mal-functioning of the plugin:

 

[table caption=”” width=”800″ colwidth=”20|200|200|200″ colalign=”center|center|center|left”]
S no.,Error message,Possible root cause
1,IM4JAVA_TOOLPATH is not set for converting images using image magic,Environment variable for ImageMagick is either not set.
2,Environment Variable GHOSTSCRIPT_HOME not set.,Environment variable for GhostScript is either not set.
[/table]