Create Multipage Files plugin
This topic describes how to configure the Create Multipage Files plugin in Transact. These steps are intended for Transact administrators.
The Create Multipage Files plugin is a default plugin in the Export module. 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 can be configured in the Copy Batch XML plugin.
This plugin also generates color, searchable, and optimized PDFs depending on your chosen configurations.
Prerequisites
To configure and use the CREATEMULTIPAGE_FILES plugin, you need a batch class with a document type configured. For detailed steps, see Add new document type.
Configure the Create Multipage Files plugin
This topic provides the information on how to configure the Create Multipage Files plugin. This plugin only needs to be configured once per batch class.
- From the Batch Class Management page, select and open your batch class.
-
Go to
.
-
Configure the required fields according to your workflow needs.
Use the following table as a reference.
Configurable property Options Description Use EText Original Pages When Available
- TRUE
- FALSE
This property determines whether Transact uses the originally uploaded PDF when a text layer is detected, or uses a transformed image.
Multipage File Export Process
- IMAGE_MAGICK
- HOCRtoPDF
- GHOSTSCRIPT
- ITEXT
- ITEXT-SEARCHABLE
- RECOSTAR
- GRAPHIC_MAGICK
This property determines the export process to create multipage files.
Colored Output PDF
- TRUE
- FALSE
This property determines whether the generated PDF is colored or grayscale.
- TRUE: Color
- FALSE: Grayscale
Searchable Output PDF
- TRUE
- FALSE
This property determines whether the output PDF is created with a searchable text layer or not.
PDF Creation Parameters
N/A
Use this field to provide the parameters for creating multipage files.
Multipage File Creation Type
- Tiff
- Tiff and PDF
This property determines the file extension of the output multipage files.
IText Searchable PDF Type
- Advanced PDF
This property determines the PDF type when the Multipage File Export Process is set to ITEXT-SEARCHABLE.
- PDF: Standard PDF format
- Advanced PDF: PDF/A-1b format
Compression switch
- ON
- OFF
This switch enables or disables compression of the output PDF.
Compression Factor
- 0.25f
- 0.5f
- 0.75f
This property determines the compression factor of the output PDF file, with 0.25f being the most compressed, and 0.75 being the least.
For example, 0.50 does not decrease the export file by half; instead it compresses the contained images by the defined compression factor. If the size of the image is X MB and the compression factor is 0.50, the file is compressed to X*0.50 in dimension.
This does not compress any output TIFF files.Output PDF Version
- 1.7
- 1.6
- 1.5
This property determines the Adobe PDF version of the output file.
PDF Optimization switch
- ON
- OFF
This switch enables or disables PDF optimization.
PDF optimization cannot be applied if the Multipage File Export Process is set to GRAPHIC_MAGICK or IMAGE_MAGICK.PDF Optimization Engine
- OmniPage (default)
- Ghostscript
For Windows only.Use this field to select the PDF Optimization Engine for optimizing the exported PDF file:
-
OmniPage (default): Use the engine with OmniPage set of tools for PDF optimization
-
Ghostscript: Use the engine with Ghostscript set of tools for PDF optimization
Ghostscript PDF Optimization Parameters
Example: -dQUITE -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -dPDFSETTINGS=/ebook
For Windows only.Use this field to define Ghostscript parameters for creating optimized PDFs.
OmniPage PDF Optimization Parameters
Example: -compressionLevel=3 -compressionType=COMPRESSION_ADVANCED
Use this field to define OmniPage parameters for creating optimized PDFs.
Configure the Property file
You can perform additional configurations in the imagemagick.properties file. This file is located at [Ephesoft Transact_Directory]\WEB-INF\classes\META-INF\dcma-imagemagick.
See the following table for descriptions and examples of configurable properties.
| Configurable property | Data type | Sample value | Description |
|---|---|---|---|
| imagemagick.tif_compression |
string |
LZW |
Defines the compression mode used when creating multipage TIFF files. |
| imagemagick.pdf_quality |
integer |
100 |
Defines the quality of PDF files, which can vary from 0-100. |
| imagemagick.colored |
string |
True |
Defines whether multipage TIFF files have colored or grayscale images. |
| imagemagick.pdf_compression |
string |
LZW |
Defines the compression mode used when creating multipage PDF files. |
| imagemagick.display_image_output_parameters |
string |
-colorspace gray +matte |
Defines the ImageMagick and GraphicMagick output parameters used when generating multipage TIFF files. |
| imagemagick.max_files_processed_per_gs_cmd |
integer |
75 |
Defines the maximum number of files Ghostscript can process to generate multipage PDFs. |
| imagemagick.height_for_pdf_page |
integer |
792 |
Defines the height of PDF pages when generating PDFs using iText |
| imagemagick.width_for_pdf_page |
integer |
612 |
Defines the width of PDF pages when generating PDFs using iText |
| imagemagick.max_files_processed_per_im_cmd |
integer |
100 |
Defines the maximum number of files ImageMagick or GraphicsMagick can process to generate multipage TIFF files. |
Dependency
The CREATEMULTIPAGE_FILES plugin requires the hocr.xml file to create searchable PDFs. This plugin has a dependency on the RECOSTAR_HOCR (Windows) or TESSERACT_HOCR (Linux) plugins.
Troubleshooting
| Error message | Possible root cause |
|---|---|
|
IM4JAVA_TOOLPATH is not set for converting images using ImageMagick. |
Environment variable for ImageMagick is not set. |
|
GM4JAVA_TOOLPATH is not set for converting images using GraphicMagick. |
Environment variable for GraphicMagick is not set. |
|
Environment Variable GHOSTSCRIPT_HOME not set. |
Environment variable for GhostScript is not set. |