{"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

Configuration<\/h2>\n

Steps for configuring the plugin<\/h3>\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

Configurable Properties<\/h3>\n

Following are the configurable properties available for the TABBED_PDF plugin:<\/p>\n\n\n\n\n\n\n\n\n\n\n
Configurable property<\/strong><\/td>\nType of value<\/strong><\/td>\nValue options<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
Tabbed PDF Switch<\/strong><\/td>\nList of values<\/td>\n\n
    \n
  • ON<\/li>\n
  • OFF<\/li>\n<\/ul>\n<\/td>\n
Determines whether the plug-in will run or not.Default OFF.<\/td>\n<\/tr>\n
Tabbed PDF Export Folder<\/strong><\/td>\nString(Folder path)<\/td>\nExample:<\/p>\n

C:\\Ephesoft\\SharedFolders\\tabbed-pdf-export-folder<\/td>\n

Folder in which the output tabbed PDF and multi-page tiff file (if created) will be stored<\/td>\n<\/tr>\n
Tabbed PDF <\/strong>Placeholder<\/strong><\/td>\nList of values<\/td>\n\n
    \n
  • YES<\/li>\n<\/ul>\n
      \n
    • NO<\/li>\n<\/ul>\n<\/td>\n
\n
    \n
  • If this switch is set to YES,<\/strong> this plugin will create the document map by order or priority of document types defined in the export-script.properties<\/strong> 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<\/strong>.xml<\/strong>.<\/li>\n
  • If this switch is set to NO,<\/strong> this plugin will create a document map on the basis of documents present in batch.xml.<\/strong> Tabs will be created only for documents that are present in batch.xml<\/strong>.<\/li>\n<\/ul>\n

    By default, this option is set to NO<\/strong>.<\/td>\n<\/tr>\n

Tabbed PDF Property file<\/strong><\/td>\nString(File path)<\/td>\nExample:<\/p>\n

C:\\Ephesoft\\SharedFolders\\property\\export-script.properties<\/td>\n

This property file has document types and their priority in a predefined format.<\/td>\n<\/tr>\n
Tabbed PDF Creation Parameters<\/strong><\/td>\nString<\/td>\nExample:<\/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
Tabbed PDF Optimization Parameters<\/strong><\/td>\nString<\/td>\nExample:<\/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
PDF Optimization switch<\/strong><\/td>\nList of values<\/td>\n\n
    \n
  • ON<\/li>\n
  • OFF<\/li>\n<\/ul>\n<\/td>\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

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\n\n\n\n\n
Configurable property<\/strong><\/td>\nType of value<\/strong><\/td>\nValue options<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
tabbed_pdf.ghost_script_command<\/strong><\/td>\nString<\/td>\n\n
    \n
  • gswin64c<\/li>\n
  • gswin32c<\/li>\n<\/ul>\n<\/td>\n
Ghost script command for Linux and Windows.<\/td>\n<\/tr>\n
tabbed_pdf.unix_ghost_script_command<\/strong><\/td>\nString<\/td>\ngs<\/td>\nGhost script command for Unix.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Steps of execution<\/h2>\n
    \n
  1. This plugin uses the batch.xml<\/strong> file, multi-page PDF files, and multi-page tiff files inside batch instance folder.<\/li>\n
  2. The\u00a0batch.xml<\/strong> is updated with the processing results.<\/li>\n
  3. All multi-page PDF files are combined to create single PDF document and copied to the tabbed-pdf-export-folder<\/strong> inside SharedFolders<\/strong>. The PDF filename uses the following format:<\/li>\n<\/ol>\n

    <name of batch folder><\/em><\/strong>_<batch instance identifier><\/strong><\/em>.pdf<\/p>\n

    For example, BC1_BI3.pdf<\/strong><\/p>\n

      \n
    1. The first multi-page TIFF is copied to the tabbed-pdf-export-folder<\/strong> inside SharedFolders <\/strong>and the remaining multi-page TIFF files will be lost.<\/li>\n<\/ol>\n

      Dependency<\/h2>\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

      Troubleshooting<\/h2>\n

      Following are few common error messages received due to mal-functioning of the plugin:<\/p>\n\n\n\n\n\n\n\n\n\n\n
      S no.<\/td>\nError message<\/td>\nPossible root cause<\/td>\n<\/tr>\n
      1.<\/td>\n{folderPath} is not a Directory.<\/td>\nFolder path configured by user is not valid.<\/td>\n<\/tr>\n
      2.<\/td>\nProperty file for documents not valid.<\/td>\nSame priority is defined for more than one document type.<\/td>\n<\/tr>\n
      3.<\/td>\nFile does not exist. File Name=”{file-name}\u201d<\/td>\nInvalid PDF file name is mentioned in batch xml.<\/td>\n<\/tr>\n
      4.<\/td>\nError in writing pdfMarks file.<\/td>\nSome error occurred while processing.<\/td>\n<\/tr>\n
      5.<\/td>\nEnviornment Variable GHOSTSCRIPT_HOME not set<\/td>\nGHOSTSCRIPT_HOME is not set in environment variable or in startup.bat file inside the [Ephesoft_Directory<\/em>]\\JavaAppServer\\bin folder.<\/td>\n<\/tr>\n
      6.<\/td>\nNo ghostcript command specified in properties file.<\/td>\nEither the dcma-tabbed-pdf.properties<\/strong> file is not present, or properties are missing in properties file.<\/td>\n<\/tr>\n
      7.<\/td>\nSample PdfMarks file not provided.<\/td>\npdfmarks.dat<\/strong> is not present at specified location.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\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

        \n
      1. In Adobe Acrobat Reader DC, click Edit<\/strong> from the top menu and select Preferences<\/strong><\/li>\n
      2. In the General<\/strong> tab, select Basic Tools<\/strong>.<\/li>\n
      3. Check the box Enable PDF thumbnail previews in Windows Explorer,<\/strong> and wait for the Windows to configure Adobe Acrobat DC.<\/li>\n<\/ol>\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":"\nTabbed PDF Plugin | Ephesoft Docs<\/title>\n<meta name=\"robots\" content=\"noindex, follow\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Tabbed PDF Plugin\" \/>\n<meta property=\"og:description\" content=\"Available: on-premises, cloud This plugin is used to merge all multi-page PDFs to form a single-tabbed PDF file based on […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/tabbed-pdf-plugin-2\/\" \/>\n<meta property=\"og:site_name\" content=\"Ephesoft Docs\" \/>\n<meta property=\"article:modified_time\" content=\"2020-07-22T20:04:06+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/03\/word-image305.png\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"4 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/tabbed-pdf-plugin-2\/\",\"url\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/tabbed-pdf-plugin-2\/\",\"name\":\"Tabbed PDF Plugin | Ephesoft Docs\",\"isPartOf\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/#website\"},\"datePublished\":\"2015-03-09T20:52:12+00:00\",\"dateModified\":\"2020-07-22T20:04:06+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/tabbed-pdf-plugin-2\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/tabbed-pdf-plugin-2\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/tabbed-pdf-plugin-2\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/ephesoft.com\/docs\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Transact\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Features and Functions\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Administrator Role and Features\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Modules and Plugins\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/\"},{\"@type\":\"ListItem\",\"position\":6,\"name\":\"Export Module\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/\"},{\"@type\":\"ListItem\",\"position\":7,\"name\":\"Tabbed PDF Plugin\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/ephesoft.com\/docs\/#website\",\"url\":\"https:\/\/ephesoft.com\/docs\/\",\"name\":\"Ephesoft Docs\",\"description\":\"Intelligent Document Processing Made Easy\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/ephesoft.com\/docs\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"Tabbed PDF Plugin | Ephesoft Docs","robots":{"index":"noindex","follow":"follow"},"og_locale":"en_US","og_type":"article","og_title":"Tabbed PDF Plugin","og_description":"Available: on-premises, cloud This plugin is used to merge all multi-page PDFs to form a single-tabbed PDF file based on […]","og_url":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/tabbed-pdf-plugin-2\/","og_site_name":"Ephesoft Docs","article_modified_time":"2020-07-22T20:04:06+00:00","og_image":[{"url":"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2015\/03\/word-image305.png"}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"4 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/tabbed-pdf-plugin-2\/","url":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/tabbed-pdf-plugin-2\/","name":"Tabbed PDF Plugin | Ephesoft Docs","isPartOf":{"@id":"https:\/\/ephesoft.com\/docs\/#website"},"datePublished":"2015-03-09T20:52:12+00:00","dateModified":"2020-07-22T20:04:06+00:00","breadcrumb":{"@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/tabbed-pdf-plugin-2\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/tabbed-pdf-plugin-2\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/tabbed-pdf-plugin-2\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/ephesoft.com\/docs\/"},{"@type":"ListItem","position":2,"name":"Transact","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/"},{"@type":"ListItem","position":3,"name":"Features and Functions","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/"},{"@type":"ListItem","position":4,"name":"Administrator Role and Features","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/"},{"@type":"ListItem","position":5,"name":"Modules and Plugins","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/"},{"@type":"ListItem","position":6,"name":"Export Module","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/"},{"@type":"ListItem","position":7,"name":"Tabbed PDF Plugin"}]},{"@type":"WebSite","@id":"https:\/\/ephesoft.com\/docs\/#website","url":"https:\/\/ephesoft.com\/docs\/","name":"Ephesoft Docs","description":"Intelligent Document Processing Made Easy","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/ephesoft.com\/docs\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"}]}},"comment_count":0,"_links":{"self":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31788"}],"collection":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/comments?post=31788"}],"version-history":[{"count":0,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31788\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31772"}],"next":[{"title":"Key Value Learning Plugin","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/key-value-learning-plugin-2\/","href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31789"}],"prev":[{"title":"DB Export Plugin","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/db-export-configuration\/","href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31787"}],"wp:attachment":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/media?parent=31788"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/doc_tag?post=31788"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}