Tabbed PDF Plugin


This plugin is used to merge all multipage PDFs to form a single-tabbed PDF file based on a placeholder. This plugin creates bookmarked PDF files in the configured export folder by merging all multipage PDFs.


Steps for configuring the plugin

  • User can select the Export module and navigate to Tabbed PDF plugin configuration page as shown below:

Users can edit the above settings in order to change the settings as per their requirements.

Configurable Properties

Following are the configurable properties available for the Tabbed PDF plugin:

Configurable property Type of value Value options Description
Tabbed PDF Switch List of values
  • ON
  • OFF
Determines whether the plug-in will run or not.Default OFF.
Tabbed PDF Export Folder String(Folder path) Ex – C:Ephesoft3SharedFolderstabbed-pdf-export-folder Folder in which the output tabbed PDF and multipage tiff file (if created) will be stored
Tabbed PDF Placeholder List of values
  • YES
  • NO
If this switch is YES this plug-in will create the document map on the basis of order or priority of document types defined in file. In this case a tab will be created in document map for each document type and load the error PDF if the document is not present in batch xml.If this switch is NO this plugin will create a document map on the basis of documents present in batch xml. Tabs will be created only for documents that are present in batch xml.

Default NO.

Tabbed PDF Property file String(File path) Ex – This property file has document types and their priority in a predefined format.
Tabbed PDF Creation Parameters String Ex. -q -dBATCH -dNOPAUSE -sDEVICE=pdfwrite These parameters will be used by ghost script at the time of PDF creation.
Tabbed PDF Optimization Parameters String Ex. -q -dNODISPLAY -P- -dSAFER -dDELAYSAFER — These parameters will be used by ghost script at the time of PDF optimization.
PDF Optimization switch List of values
  • ON
  • OFF
Determines whether the PDF optimization will be performed or not.Default ON.


Property File Configuration

Property file:


Configurable property Type of value Value options Description
tabbed_pdf.ghost_script_command String
  • gswin64c
  • gswin32c
Ghost script command for Linux and Windows.
tabbed_pdf.unix_ghost_script_command String gs Ghost script command for Unix.

Steps of execution

  • Plug-in uses batch xml file, multipage PDF files and multipage tiff files inside batch instance folder.
  • Batch XML is changed as per the processing done by the plug-in.
  • All multipage PDF files are combined to create single PDF document and then copied to tabbed-pdf-export-folder inside shared folders. Name of PDF file will be as below given format-

“name of batch folder” + “_”+ “batch instance identifier”+.pdf

  • Finally first multipage tiff will be copied to tabbed-pdf-export-folder inside shared folder and rest of multipage tiffs will be lost.


The plugin assumes that multipage PDFs are created by batch preprocessing. So create multi page files plugin should be in workflow of batch class because create multi page files plugin is responsible for creating multi page PDFs. Besides this file should be at right place with correct information.


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

S no. Error message Possible root cause
1. {folderPath} is not a Directory. Folder path configured by user is not valid.
2. Property file for documents not valid. Same priority is defined for more than one document type.
3. File does not exist. File Name=”{file-name}” Invalid PDF file name is mentioned in batch xml.
4. Error in writing pdfMarks file. Some error occurred while processing.
5. Enviornment Variable GHOSTSCRIPT_HOME not set GHOSTSCRIPT_HOME is not set in environment variable or in startup.bat file inside {Ephesoft-home}JavaAppServerbin folder.
6. No ghostcript command specified in properties file. Either file is not present or properties are missing in properties file.
7. Sample PdfMarks file not provided. pdfmarks.dat is not present at specified location.


Note: If the tabs of the exported PDF are not arranged by Acrobat Reader DC (v.2018.009.20050) according to the priority specified in, you have to manually change the following setting:

  1. In Adobe Acrobat Reader DC, click Edit from the top menu and select Preferences
  2. In the General tab, select Basic Tools.
  3. Check the box Enable PDF thumbnail previews in Windows Explorer, and wait for the Windows to configure Adobe Acrobat DC.

Now, the PDF tabs will be shown in the correct order.


<Back| Release Documentation