Transact

  1. Home
  2. Transact
  3. Features and Functions
  4. Administrator Role and Features
  5. Modules and Plugins
  6. Export Module
  7. Create Multipage Files Plugin

Create Multipage Files Plugin

Available: on-premises, cloud

This page describes how to configure the Create Multipage Files plugin in Ephesoft Transact. These steps are intended for Transact administrators.

Overview

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 colored, searchable, and optimized PDFs depending on your chosen configurations.

Prerequisites

To configure and use the CREATEMULTIPAGE_FILES plugin, the following configurations must be in place:

  • You will need a batch class with a document type configured. For detailed steps, refer to Add New Document Type.

Note: You don’t need to add this plugin to the Export module, as it is included by default.

Configuring the Create Multipage Files Plugin

This section provides information on how to configure the Create Multipage Files plugin. This plugin only needs to be configured once per batch class.

To navigate to the plugin:

  1. From the Batch Class Management page, select and open your batch class.
  2. Go to Modules > Export > CREATE_MULTIPAGE_FILES.

Figure 1. CREATE_MULTIPAGE_FILES Plugin Configuration

  1. Configure the required fields according to your workflow needs. Use the table below as a reference.
Configurable Property Options Description
Use EText Original Pages When Available
  • TRUE
  • FALSE
This property determines whether Transact will use the originally uploaded PDF when a text layer is detected, or use a transformed image.
PDF Optimization switch
  • ON
  • OFF
This switch enables or disables PDF optimization.

Note: PDF optimization cannot be applied If the Multipage File Export Process is set to GRAPHIC_MAGICK or IMAGE_MAGICK.

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 will be color or grayscale.

  • TRUE: Color
  • FALSE: Grayscale
Searchable Output PDF
  • TRUE
  • FALSE
This property determines whether the output PDF will be created with a searchable text layer or not.
PDF Creation Parameters N/A Use this field to provide the parameters for creating multipage files.
PDF Optimization Parameters N/A Use this field to define Ghostscript parameters for creating optimized PDFs.
Multipage File Creation Type
  • PDF
  • Tiff
  • Tiff and PDF
This property determines the file extension of the output multipage files.
IText Searchable PDF Type
  • PDF
  • 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 would not decrease the export file by half, instead it will compress 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.

Note: 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.

Configuring the Property File

Additional configurations can be made in the imagemagick.properties file. This file is located at [Ephesoft_Directory]\WEB-INF\classes\META-INF\dcma-imagemagick.

Refer to the table below 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 will 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 Tiffs.

Dependency

The CREATEMULTIPAGE_FILES plugin requires an hocr.xml file to create searchable PDFs. As such, 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.

Conclusion

This completes an overview of how to configure the Create Multipage Files plugin in Ephesoft Transact.

Was this article helpful to you? Yes No