{"id":31788,"date":"2015-03-09T12:52:12","date_gmt":"2015-03-09T20:52:12","guid":{"rendered":"https:\/\/ephesoft.com\/docs\/2019-1-2\/moduleplugin-configuration\/export-module\/tabbed-pdf-plugin-2\/"},"modified":"2020-07-22T13:04:06","modified_gmt":"2020-07-22T20:04:06","slug":"tabbed-pdf-plugin-2","status":"publish","type":"docs","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/tabbed-pdf-plugin-2\/","title":{"rendered":"Tabbed PDF Plugin"},"content":{"rendered":"
Available<\/strong>: on-premises, cloud<\/p>\n This plugin is used to merge all multi-page 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 multi-page PDFs.<\/p>\n Select the Export module and navigate to TABBED_PDF plugin configuration page as shown below:<\/p>\n <\/p>\n You can edit the above settings as per your requirements.<\/p>\n Following are the configurable properties available for the TABBED_PDF plugin:<\/p>\n C:\\Ephesoft\\SharedFolders\\tabbed-pdf-export-folder<\/td>\n By default, this option is set to NO<\/strong>.<\/td>\n<\/tr>\n C:\\Ephesoft\\SharedFolders\\property\\export-script.properties<\/td>\n The property file is located at:<\/p>\n [Ephesoft_Directory<\/em>]\/WEB-INF\/classes\/META-INF\/dcma-tabbed-pdf\/dcma-tabbed-pdf.properties<\/p>\n <name of batch folder><\/em><\/strong>_<batch instance identifier><\/strong><\/em>.pdf<\/p>\n For example, BC1_BI3.pdf<\/strong><\/p>\n 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 export-script.properties file should be at right place with correct information.<\/p>\n Following are few common error messages received due to mal-functioning of the plugin:<\/p>\n Note<\/strong>: If the tabs of the exported PDF are not arranged by Acrobat Reader DC (v.2018.009.20050) according to the priority specified in export-script.properties, you have to manually change the following setting:<\/p>\n Now, the PDF tabs will be shown in the correct order.<\/p>\n <\/p>\n","protected":false},"featured_media":0,"parent":31772,"menu_order":5,"comment_status":"closed","ping_status":"open","template":"","doc_tag":[],"yoast_head":"\nConfiguration<\/h2>\n
Steps for configuring the plugin<\/h3>\n
Configurable Properties<\/h3>\n
\n\n
\n Configurable property<\/strong><\/td>\n Type of value<\/strong><\/td>\n Value options<\/strong><\/td>\n Description<\/strong><\/td>\n<\/tr>\n \n Tabbed PDF Switch<\/strong><\/td>\n List of values<\/td>\n \n \n
Determines whether the plug-in will run or not.Default OFF.<\/td>\n<\/tr>\n \n Tabbed PDF Export Folder<\/strong><\/td>\n String(Folder path)<\/td>\n Example:<\/p>\n Folder in which the output tabbed PDF and multi-page tiff file (if created) will be stored<\/td>\n<\/tr>\n \n Tabbed PDF <\/strong>Placeholder<\/strong><\/td>\n List of values<\/td>\n \n \n
\n
\n \n
\n Tabbed PDF Property file<\/strong><\/td>\n String(File path)<\/td>\n Example:<\/p>\n This property file has document types and their priority in a predefined format.<\/td>\n<\/tr>\n \n Tabbed PDF Creation Parameters<\/strong><\/td>\n String<\/td>\n Example:<\/p>\n -q -dBATCH -dNOPAUSE -sDEVICE=pdfwrite<\/pre>\n<\/td>\n
These parameters will be used by ghost script at the time of PDF creation.<\/td>\n<\/tr>\n \n Tabbed PDF Optimization Parameters<\/strong><\/td>\n String<\/td>\n Example:<\/p>\n -q -dNODISPLAY -P- -dSAFER -dDELAYSAFER -- pdfopt.ps<\/pre>\n<\/td>\n
These parameters will be used by ghost script at the time of PDF optimization.<\/td>\n<\/tr>\n \n PDF Optimization switch<\/strong><\/td>\n List of values<\/td>\n \n \n
Determines whether the PDF optimization will be performed or not.Default ON.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n Property File Configuration<\/h3>\n
\n\n
\n Configurable property<\/strong><\/td>\n Type of value<\/strong><\/td>\n Value options<\/strong><\/td>\n Description<\/strong><\/td>\n<\/tr>\n \n tabbed_pdf.ghost_script_command<\/strong><\/td>\n String<\/td>\n \n \n
Ghost script command for Linux and Windows.<\/td>\n<\/tr>\n \n tabbed_pdf.unix_ghost_script_command<\/strong><\/td>\n String<\/td>\n gs<\/td>\n Ghost script command for Unix.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n Steps of execution<\/h2>\n
\n
\n
Dependency<\/h2>\n
Troubleshooting<\/h2>\n
\n\n
\n S no.<\/td>\n Error message<\/td>\n Possible root cause<\/td>\n<\/tr>\n \n 1.<\/td>\n {folderPath} is not a Directory.<\/td>\n Folder path configured by user is not valid.<\/td>\n<\/tr>\n \n 2.<\/td>\n Property file for documents not valid.<\/td>\n Same priority is defined for more than one document type.<\/td>\n<\/tr>\n \n 3.<\/td>\n File does not exist. File Name=”{file-name}\u201d<\/td>\n Invalid PDF file name is mentioned in batch xml.<\/td>\n<\/tr>\n \n 4.<\/td>\n Error in writing pdfMarks file.<\/td>\n Some error occurred while processing.<\/td>\n<\/tr>\n \n 5.<\/td>\n Enviornment Variable GHOSTSCRIPT_HOME not set<\/td>\n GHOSTSCRIPT_HOME is not set in environment variable or in startup.bat file inside the [Ephesoft_Directory<\/em>]\\JavaAppServer\\bin folder.<\/td>\n<\/tr>\n \n 6.<\/td>\n No ghostcript command specified in properties file.<\/td>\n Either the dcma-tabbed-pdf.properties<\/strong> file is not present, or properties are missing in properties file.<\/td>\n<\/tr>\n \n 7.<\/td>\n Sample PdfMarks file not provided.<\/td>\n pdfmarks.dat<\/strong> is not present at specified location.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n \n