CREATEMULTIPAGE_FILES Plugin
Overview
The CREATEMULTIPAGE_FILES plugin is a part of export module by default. This plugin generates multipage PDF and TIF files for each document type of a batch inside the final drop folder. This final drop folder path is a configurable property defined inside the COPY_BATCH_XML plugin.
This plugin also generates colored, searchable, and optimized PDFs depending on the configuration made.
Configuration
UI Configurations
The following table lists the configurable properties in the CREATEMULTIPAGE_FILES plugin.
Configurable property | Type of value | Value options | Description |
Use EText Original Pages When Available | List of values |
|
This switch enables the use of the original ETEXT pages when creating the final PDF. |
PDF Optimization switch | List of values |
|
This switch is used to create an optimized PDF by adding webview. |
Multipage File Export Process | List of values |
|
This option allows the user to select an API to create multi-page files. |
Colored Output PDF | List of values |
|
This option can be used to generate colored PDF as output. |
Searchable Output PDF | List of values |
|
This option can be used to create a searchable PDF when this option is set to TRUE. |
PDF Creation | String | N/A | This option provides the parameter to create any multi-page file. |
PDF Optimization Parameters | String | N/A | This option can be used to define Ghostscript parameters when creating optimized PDFs. |
Multipage File type Creation | List of values |
|
This option defines what type of Ghostscript file that the user can create. |
IText searchable PDF type | List of values |
|
This provides types of IText searchable PDF types if the user has selected IText searchable in the export process. |
Compression switch | List of values |
|
This switch determines the compression for the final PDF. |
Compression Factor | List of values |
|
This option determines the factor of the compression. |
Output PDF Version | List of values |
|
This option determines the version of the output PDF. |
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 property | Type of value | Sample Value | 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 +matte | This property defines imagemagick/graphicmagick output parameters to be used while generating multipage tiff |
imagemagick.max_files_processed_per_gs_cmd | int | 75 | This property defines number of maximum 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/graphicmagick can process to generate multipage tiff |
Steps of execution
- This plugin works in the export phase of the application when all of the processing on the batch is complete and ready to be exported.
- The plugin creates multipage TIFFs or PDFs in the final drop folder for all document types in a batch.
- The batch.xml is updated and passed to other export plugins.
This plugin requires the hocr.xml file for creating searchable PDFs. It has a dependency on one of the the plugins from Recostar HOCR’/ ‘Tesseract HOCR.
Troubleshooting
The following table lists common error messages:
S no. | Error message | Possible root cause |
1 | IM4JAVA_TOOLPATH is not set for converting images using ImageMagick. | Environment variable for ImageMagick is not set. |
2 | GM4JAVA_TOOLPATH is not set for converting images using GraphicMagick. | Environment variable for GraphicMagick is not set. |
3 | Environment Variable GHOSTSCRIPT_HOME not set. | Environment variable for GhostScript is not set. |