{"id":31775,"date":"2018-03-27T20:07:56","date_gmt":"2018-03-28T04:07:56","guid":{"rendered":"https:\/\/ephesoft.com\/docs\/2019-1-2\/moduleplugin-configuration\/export-module\/tabbed_pdf-plugin-and-ordering-doc-types\/"},"modified":"2020-09-23T12:29:23","modified_gmt":"2020-09-23T19:29:23","slug":"tabbed_pdf-plugin-and-ordering-doc-types","status":"publish","type":"docs","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/tabbed_pdf-plugin-and-ordering-doc-types\/","title":{"rendered":"TABBED_PDF Plugin and Ordering Doc Types"},"content":{"rendered":"
This document describes how to add and configure the TABBED_PDF plugin in Transact Release 4.5.0.0, and contains these topics.<\/p>\n
For additional information about using the TABBED_PDF plugin, refer to Tabbed PDF Plugin<\/a><\/p>\n The TABBED_PDF plugin is used to merge all multipage PDF files to form a single tabbed PDF file, based on the placeholder component that you define with the plugin.<\/p>\n This plugin merges all incoming, multipage PDF files.<\/p>\n This plugin creates a single, bookmarked PDF file in the Export module folder, as configured for the batch class.<\/p>\n Transact Release 4.5.0.0 further enhances the TABBED_PDF plugin. When exporting multiple different document types, such as invoices and purchase orders, you can specify which document type should come first, second, and last in the TABBED_PDF plugin, and in the resulting PDF file to be exported.<\/p>\n This capability is available with the export-script.properties<\/strong> file. This file is located at [Ephesoft_Directory]\\<\/em>SharedFolders\\property\\export.script.properties<\/p>\n Release 4.5.0.0 also resolves an observed error with the Folder Management<\/strong> screen that relates to the TABBED_PDF plugin.<\/p>\n In some circumstances, the TABBED_PDF plugin would create an error when executed from the Folder Management screen:<\/p>\n This issue has been resolved for Release 4.5.0.0.<\/p>\n Perform these steps to add the TABBED_PDF plugin to a batch class.<\/p>\n 1. Log in to Transact. From the Administration<\/strong> section, select Batch Class Management<\/strong>.<\/p>\n 2. In the Batch Class Management<\/strong> screen, select the batch class to configure and click Open<\/strong>.<\/p>\n 3. Navigate to Modules > Export.<\/strong> The plugins that are currently enabled in the Export<\/strong> module appear.<\/p>\n <\/p>\n Figure 1. Export Module with Plugins<\/em><\/p>\n 4. To add the TABBED_PDF plugin to this module, scroll down to this plugin from the Associated Plugins<\/strong> menu, then click the right arrow. This activates the plugin for the Export<\/strong> module.<\/p>\n <\/p>\n Figure 2. Activating the TABBED_PDF Plugin<\/em><\/p>\n 5. Select (highlight) the TABBED_PDF plugin on the right, and click the up or down arrow to adjust the sequence of this plugin in relation to the other plugins.<\/p>\n Note<\/strong>: This plugin should be placed before the CLEANUP plugin, in the Export module.<\/p>\n 6. Click Apply<\/strong> to apply or register the changes. Then click Deploy<\/strong> to activate the changes within the batch class.<\/p>\n The system displays a temporary confirmation message that the changes have been saved and that the workflow has been activated.<\/p>\n The TABBED_PDF plugin is now included in the batch class, and ready to be configured.<\/p>\n Once you have added the TABBED_PDF plugin to the Batch Class with the previous procedure, perform these steps to configure the TABBED_PDF plugin:<\/p>\n 1. Log in to Transact. From the Administration<\/strong> section, select Batch Class Management<\/strong>.<\/p>\n 2. In the Batch Class Management<\/strong> screen, select the batch class to configure and click Open<\/strong>.<\/p>\n 3. Navigate to Modules > Export.<\/strong> The plugins that are currently enabled in the Export<\/strong> module appear. The TABBED_PDF plugin should be visible in the Export<\/strong> module.<\/p>\n <\/p>\n Figure 3. Export Module > TABBED_PDF Plugin<\/em><\/p>\n 4. Select (click on) the TABBED_PDF plugin. The Plugin Configuration<\/strong> screen for the TABBED_PDF plugin appears on the right.<\/p>\n <\/p>\n Figure 4. Plugin Configuration for TABBED_PDF Plugin<\/em><\/p>\n 5. Complete the fields on this screen. Required fields are indicated with an asterisk.<\/p>\n ON \u2014 enables the plugin<\/p>\n OFF (default) \u2014 disables the plugin<\/td>\n<\/tr>\n [Ephesoft_Directory]<\/em>\\SharedFolders\\tabbed-pdf-export-folder<\/p>\n You can change this location if desired. Enter a new path if you do not wish to use the default location.<\/td>\n<\/tr>\n YES<\/strong> \u2014 If this switch is set to YES, this plugin will create the document tabs in the PDF file on the basis of order or priority of document types, which are defined in the export-script.properties file.<\/p>\n NO<\/strong> (default) \u2014 If this switch is set to NO, this plugin will create document tabs in the PDF on the basis of documents present in batch.xml<\/strong>.<\/td>\n<\/tr>\n [Ephesoft_Directory]<\/em>\\SharedFolders\\property\\export-script.properties<\/p>\n You can change this location if desired.<\/p>\n You can specify which document type should come first, second, and last in the TABBED_PDF plugin. This capability is available with the export-script.properties<\/strong> file.<\/td>\n<\/tr>\n -q -dBATCH -dNOPAUSE -sDEVICE=pdfwrite<\/p>\n You can adjust these parameters if desired.<\/p>\n -q<\/strong>: Quiet startup: suppress normal startup messages, and also do the equivalent of -dQUIET.<\/p>\n -dBATCH<\/strong>: Causes Ghostscript to exit after processing all files named on the command line, rather than going into an interactive loop reading PostScript commands. Equivalent to putting -c quit <\/strong>at the end of the command line.<\/p>\n -dNOPAUSE<\/strong>: Disables the prompt and pause at the end of each page. Normally one should use this (along with -dBATCH) when producing output on a printer or to a file; it also may be desirable for applications where another program is “driving” Ghostscript.<\/p>\n Additional Ghost script information is available at the following website:<\/p>\nTABBED_PDF Plugin Overview, Transact 4.5.0.0<\/h2>\n
Error in writing PDF marks<\/pre>\n
Adding the TABBED_PDF Plugin to the Batch Class<\/h2>\n
Configuring the TABBED_PDF Plugin<\/h2>\n
\n\n
\n Field<\/strong><\/td>\n Description<\/strong><\/td>\n<\/tr>\n \n Tabbed PDF Switch:*<\/td>\n Select ON or OFF to enable or disable this switch.<\/p>\n \n Tabbed PDF Export Folder:*<\/td>\n By default, this folder is set to the following location:<\/p>\n \n Tabbed PDF Placeholder:*<\/td>\n Use this setting to define how the document tabs are created, in the exported PDF.<\/p>\n \n Tabbed PDF Property file:*<\/td>\n By default, this file is set to the following location:<\/p>\n \n Tabbed PDF Creation Parameters:*<\/td>\n By default, the parameters set for this plugin are as follows:<\/p>\n