{"id":34699,"date":"2019-08-29T15:24:55","date_gmt":"2019-08-29T23:24:55","guid":{"rendered":"https:\/\/ephesoft.com\/docs\/?page_id=34699"},"modified":"2022-02-02T14:40:55","modified_gmt":"2022-02-02T21:40:55","slug":"custom-export-plugin-configuration-and-user-guide","status":"publish","type":"docs","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/custom-export-plugin-configuration-and-user-guide\/","title":{"rendered":"Custom Export Plugin"},"content":{"rendered":"<p><strong>Available:\u00a0<\/strong>on-premises, cloud<\/p>\n<h2>Introduction<\/h2>\n<p>This document describes the concepts, configuration, and additional information about using the Custom Export plugin with Ephesoft Transact. This plugin can be used with other export module plugins to maximize the desired outcome.<\/p>\n<h2><a id=\"post-34778-_Toc18662190\"><\/a>Benefits of the Custom Export Plugin<\/h2>\n<p><a id=\"post-34778-_Hlk10200751\"><\/a> The Custom Export plugin includes significant flexibility for data and metadata output from the workflow. Benefits of this plugin include the following:<\/p>\n<ul>\n<li>Customizing the output filenames for metadata and documents<\/li>\n<li>Enabling a variety of output formats<\/li>\n<li>Customizing the path and folders for output<\/li>\n<li>Choosing specific data for output to reduce the export footprint<\/li>\n<li>Using numerous additional options to configure metadata and document export<\/li>\n<\/ul>\n<h2><a id=\"post-34778-_Toc18662191\"><\/a>Primary Functions of the Custom Export Plugin<\/h2>\n<p><a id=\"post-34778-_Hlk10200778\"><\/a> The Custom Export plugin is designed for the administrator responsible for configuring the batch class. This plugin provides two major output functions as follows:<\/p>\n<p>1. <strong>Exporting the data\/metadata file<\/strong>:<\/p>\n<ul>\n<li style=\"list-style-type: none\">\n<ul>\n<li>Users can select the document type to be exported.<\/li>\n<li>Users have an option to export the desired metadata in the selected schema format (based on document type).<\/li>\n<li>Users can export metadata with the following file extensions:\n<ul>\n<li>CSV \u2014 comma-separated value<\/li>\n<li>HL7 \u2014 Health Level 7<\/li>\n<li>HTML \u2014 Hypertext Markup Language<\/li>\n<li>JSON \u2014 JavaScript Object Notation<\/li>\n<li>TXT \u2014 text-only files<\/li>\n<li>XML \u2014 eXtensible Markup Language<\/li>\n<\/ul>\n<\/li>\n<li>Users can configure dynamic file names and folder paths using a set of dynamic placeholders (e.g., replacement variables and XPath)<\/li>\n<li>Users can download and upload schema files to be used with the Custom Export plugin. This allows the administrator to edit the schema file and leverage existing schema files to create new schema files.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p>2. <strong>Exporting the image files with ability to name the output files and target folders<\/strong>:<\/p>\n<ul>\n<li style=\"list-style-type: none\">\n<ul>\n<li>Users can specify the file type or extension.<\/li>\n<li>Users can customize the filename and folder path with dynamic placeholders.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2><a id=\"post-34778-_Toc18662192\"><\/a>Limitations for Custom Export Plugin<\/h2>\n<p>The Custom Export plugin in Ephesoft Transact has the following limitations:<\/p>\n<ul>\n<li>The Custom Export plugin currently does not support exporting data in a tabular format. It can only export data extracted for configured Index fields.<\/li>\n<li>The schema file must be created and edited outside of Ephesoft Transact, and uploaded into the Custom Export plugin.<\/li>\n<\/ul>\n<h1><a id=\"post-34778-_Toc18662193\"><\/a>Configuring the Custom Export Plugin<\/h1>\n<h2><a id=\"post-34778-_Toc18662194\"><\/a>Prerequisite<\/h2>\n<p>Ensure that Ephesoft Transact is properly installed and licensed.<\/p>\n<h2><a id=\"post-34778-_Toc18662195\"><\/a>Procedure<\/h2>\n<p>The Custom Export plugin is configured in Batch Class Management.<\/p>\n<p>Perform the following steps to enable and configure the Custom Export plugin for the batch class:<\/p>\n<p>1. Log in to Ephesoft Transact as an administrator. Navigate to the <strong>Batch Class Management<\/strong> screen.<\/p>\n<p><img decoding=\"async\" class=\"wp-image-34779\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image.png\" alt=\"\" width=\"1429\" height=\"618\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image.png 1429w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-300x130.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-768x332.png 768w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-1024x443.png 1024w\" sizes=\"(max-width: 1429px) 100vw, 1429px\" \/><\/p>\n<p><span style=\"color: #999999\"><em>Figure 1. <strong>Batch Class Management<\/strong> Screen<\/em><\/span><\/p>\n<p>2. Open the batch class that will use the Custom Export plugin. The components and settings for this batch class display.<\/p>\n<p><img decoding=\"async\" width=\"1429\" height=\"618\" class=\"wp-image-34780\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-1.png\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-1.png 1429w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-1-300x130.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-1-768x332.png 768w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-1-1024x443.png 1024w\" sizes=\"(max-width: 1429px) 100vw, 1429px\" \/><\/p>\n<p><span style=\"color: #999999\"><em>Figure 2. Viewing Current Configuration for a Batch Class<\/em><\/span><\/p>\n<p>3. Expand the <strong>Export<\/strong> module. The plugins that are configured for this module display in the left-hand navigation panel.<\/p>\n<p><img decoding=\"async\" width=\"333\" height=\"616\" class=\"wp-image-34781\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-2.png\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-2.png 333w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-2-162x300.png 162w\" sizes=\"(max-width: 333px) 100vw, 333px\" \/><\/p>\n<p><span style=\"color: #999999\"><em>Figure 3. Export Module Prior to Configuring Custom Export<\/em><\/span><\/p>\n<p>4. Add the Custom Export plugin to the <strong>Export<\/strong> module:<\/p>\n<p style=\"padding-left: 40px\">a. On the right side of the screen, locate the <strong>CUSTOM_EXPORT<\/strong> plugin in the <strong>Associated Plugins<\/strong> field. Select it and move it to <strong>Selected Plugins<\/strong> field on the right.<\/p>\n<p><a href=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/08\/Custom-Export-Plugin01.png\"><img decoding=\"async\" class=\"alignnone wp-image-50305 size-full\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/08\/Custom-Export-Plugin01.png\" alt=\"\" width=\"315\" height=\"157\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/08\/Custom-Export-Plugin01.png 315w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/08\/Custom-Export-Plugin01-300x150.png 300w\" sizes=\"(max-width: 315px) 100vw, 315px\" \/><\/a><\/p>\n<p><span style=\"color: #999999\"><em>Figure 4. Example of Adding the CUSTOM_EXPORT to the <strong>Export<\/strong> Module<\/em><\/span><\/p>\n<p><strong>Note:<\/strong> The <strong>CLEANUP<\/strong> plugin should always be the last plugin to run in the Export module. If the CLEANUP plugin is not last in the workflow, move it\u00a0below the <strong>CUSTOM_EXPORT<\/strong> plugin.<\/p>\n<p style=\"padding-left: 40px\">\u00a0 \u00a0c. Click <strong>Deploy<\/strong>. The <strong>CUSTOM_EXPORT <\/strong>plugin displays in the <strong>Export<\/strong> module for this batch class.<\/p>\n<p><a href=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/08\/Custom-Export-Plugin03.png\"><img decoding=\"async\" class=\"alignnone wp-image-50304 size-full\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/08\/Custom-Export-Plugin03.png\" alt=\"\" width=\"330\" height=\"618\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/08\/Custom-Export-Plugin03.png 330w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/08\/Custom-Export-Plugin03-160x300.png 160w\" sizes=\"(max-width: 330px) 100vw, 330px\" \/><\/a><\/p>\n<p><span style=\"color: #999999\"><em>Figure 5. CUSTOM_EXPORT Added to a Batch Class<\/em><\/span><\/p>\n<p>5. Enable the Custom Export plugin:<\/p>\n<p style=\"padding-left: 40px\">a. Select <strong>CUSTOM_EXPORT <\/strong>in the left-hand navigation pane.<\/p>\n<p style=\"padding-left: 40px\">b. In the <strong>Plugin Configuration<\/strong> section on the right, set the <strong>Custom Export Plugin Switch<\/strong> to <strong>ON<\/strong>. Click <strong>Apply<\/strong>.<\/p>\n<p><img decoding=\"async\" class=\"alignnone wp-image-34784\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-5.png\" alt=\"\" width=\"800\" height=\"122\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-5.png 1081w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-5-300x46.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-5-768x117.png 768w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-5-1024x156.png 1024w\" sizes=\"(max-width: 800px) 100vw, 800px\" \/><\/p>\n<p><span style=\"color: #999999\"><em>Figure 6. <strong>Custom Export Plugin Switch<\/strong><\/em><\/span><\/p>\n<p>6. Configure the Custom Export plugin:<\/p>\n<p style=\"padding-left: 40px\">a. Select <strong>Configure<\/strong> under the <strong>CUSTOM_EXPORT<\/strong> plugin on the left navigation pane. The current configurations for this plugin display.<\/p>\n<p><a href=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/08\/Custom-Export-Plugin02.png\"><img decoding=\"async\" class=\"alignnone wp-image-50303\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/08\/Custom-Export-Plugin02-1024x477.png\" alt=\"\" width=\"900\" height=\"419\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/08\/Custom-Export-Plugin02-1024x477.png 1024w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/08\/Custom-Export-Plugin02-300x140.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/08\/Custom-Export-Plugin02-768x357.png 768w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/08\/Custom-Export-Plugin02.png 1433w\" sizes=\"(max-width: 900px) 100vw, 900px\" \/><\/a><\/p>\n<p><span style=\"color: #999999\"><em>Figure 7. Configuring Settings for Custom Export<\/em><\/span><\/p>\n<p style=\"padding-left: 40px\">This screen contains the following columns and information:<\/p>\n<ul>\n<li style=\"list-style-type: none\">\n<ul>\n<li style=\"list-style-type: none\">\n<ul>\n<li><strong>Document Type<\/strong> \u2014 Document type for which this export configuration will be applicable.<\/li>\n<li><strong>Export Schema Name<\/strong> \u2014 Name of the schema file for the metadata export. This file tells Ephesoft Transact which metadata fields (e.g., index fields, batch class fields, batch instance information, etc.) need to be exported and in which format.<\/li>\n<li><strong>Export Metadata Location<\/strong> \u2014 Location on<\/li>\n<li><strong>Export Metadata File<\/strong> \u2014 Name of the metadata file. The name can also have dynamic placeholders to generate dynamic file names.<\/li>\n<li><strong>Export Image File<\/strong> \u2014 Name of the exported image file.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p style=\"padding-left: 40px\">b. Click <strong>Add<\/strong> to create new configurations, or click <strong>Edit<\/strong> to display and adjust the existing configurations. The <strong>Custom Export Configurations<\/strong> screen displays.<\/p>\n<p><img decoding=\"async\" width=\"1024\" height=\"601\" class=\"wp-image-34786\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-7.png\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-7.png 1024w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-7-300x176.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-7-768x451.png 768w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/p>\n<p><span style=\"color: #999999\"><em>Figure 8. Custom Export Configurations Screen<\/em><\/span><\/p>\n<p style=\"padding-left: 40px\">c. Configure the settings for this plugin to include the output format and folder structure.<\/p>\n<ul>\n<li style=\"list-style-type: none\">\n<ul>\n<li style=\"list-style-type: none\">\n<ul>\n<li><strong>Document Type<\/strong> \u2014 This drop-down list is used to select the document type that exists within the batch class.<\/li>\n<li><strong>Export Metadata File <\/strong>section \u2014 This section contains the following fields and commands:\n<ul>\n<li><strong>Export Schema<\/strong> \u2014 This drop-down list is used with the three buttons immediately beneath it. Select an existing schema, upload a schema, or download the schema and edit it locally. The buttons are defined below:\n<ul>\n<li><strong>Upload Schema<\/strong> \u2014 Uploads the new schema file onto the server within the Batch Class Document Type location.<\/li>\n<li><strong>Download Schema<\/strong> \u2014 Downloads the selected schema file to the client workstation.<\/li>\n<li><strong>Refresh<\/strong> \u2014 Refreshes the values in the <strong>Export Schema<\/strong> drop-down list. If a new schema file was added directly into the file system folder, click <strong>Refresh<\/strong> so that the file displays in the <strong>Export Schema<\/strong> drop-down list.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<ul>\n<li style=\"list-style-type: none\">\n<ul>\n<li style=\"list-style-type: none\">\n<ul>\n<li style=\"list-style-type: none\">\n<ul>\n<li><strong>Encoding<\/strong> \u2014 This drop-down list is used to select the encoding format for a schema file. Ensure that you provide the correct encoding for the schema file. The output metadata file will also use the same encoding as that of the export schema file. The following encoding formats are available in this drop-down list:\n<ul>\n<li>ASCII<\/li>\n<li>UTF-7<\/li>\n<li>UTF-8<\/li>\n<li>UTF-16<\/li>\n<li>UTF-32<\/li>\n<li>ISO-8859-1<\/li>\n<\/ul>\n<\/li>\n<li><strong>File Name<\/strong> \u2014 Field where you define the format of the file name and have ability to customize it.<\/li>\n<li><strong>Folder Path<\/strong> \u2014 Field where you define the desired folder path for the metadata file. This is the output path for the exported metadata file using optional replaceable variables for desired customization.<\/li>\n<\/ul>\n<\/li>\n<li><strong>Export Image File<\/strong> section:<br \/>\nThis section contains the following fields:<\/p>\n<ul>\n<li><strong>File Extension<\/strong> \u2014 Choose from the following supported output formats:\n<ul>\n<li>PDF<\/li>\n<li>TIF<\/li>\n<li>PDF + TIFF<\/li>\n<\/ul>\n<\/li>\n<li><strong>File Name<\/strong> \u2014 Field where you define the format of the file name and have ability to customize it.<\/li>\n<li><strong>Folder Path<\/strong> \u2014 Field where you define the folder path to be used. This path can be customized using the variables under <a href=\"#post-34778-_Using_Dynamic_Placeholders\">Using Dynamic Placeholders<\/a>.<br \/>\n<strong>Note<\/strong>: \u00a0There are several limitations related to folder paths and file names.\u00a0 A combined folder path and file name must not exceed 255 characters. File names cannot contain \/*:&lt;&gt;|,? characters (if any of these characters appear in a file name at export time, they will be removed).<\/li>\n<\/ul>\n<\/li>\n<li><strong>Export Schema File Content<\/strong> section:<br \/>\nThis section displays a customer generated file containing placeholders and XPath expressions configured within it. For example, if you want to export metadata from Ephesoft Transact into a JSON file format, you must create a JSON schema file. The JSON schema file is a JSON file with placeholders for Ephesoft Transact values. When a batch instance is exported, Ephesoft Transact will replace those placeholders with their actual values and export the resultant file at the location provided in the <strong>Folder Path<\/strong> field. See the examples below for sample JSON and XML schema and output files:<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p style=\"padding-left: 40px\"><img decoding=\"async\" width=\"1512\" height=\"730\" class=\"wp-image-34787 alignleft\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-8.png\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-8.png 1512w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-8-300x145.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-8-768x371.png 768w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-8-1024x494.png 1024w\" sizes=\"(max-width: 1512px) 100vw, 1512px\" \/><\/p>\n<p style=\"text-align: left\"><em><span style=\"color: #999999\">Figure 9. Sample Invoice and JSON Files<\/span><\/em><\/p>\n<p><img decoding=\"async\" class=\"wp-image-34788 alignleft\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-9.png\" alt=\"\" width=\"1478\" height=\"840\" \/><\/p>\n<p style=\"text-align: left\"><em>Figure 10. Sample Invoice XML Files<\/em><\/p>\n<h2><a id=\"post-34778-_Toc18662196\"><\/a><a id=\"post-34778-_Using_Dynamic_Placeholders\"><\/a>Using Dynamic Placeholders<\/h2>\n<p>Replacement variables and XPath syntax can be used as dynamic placeholders to provide custom names for folders and files, and to export specific metadata from your documents and batches.<\/p>\n<h3><a id=\"post-34778-_Toc18662197\"><\/a>Replacement Variables<\/h3>\n<p>Placeholder variables are available for several common elements within a batch.<\/p>\n<p>The following table shows the variables and the syntax to be used to generate dynamic metadata file names, document file names, file locations, and metadata content. Refer to the Figure 10 above and the samples in the table below to see how placeholder variables in the table can be used.<\/p>\n<ul>\n<li>Sample file system locations:\n<ul>\n<li><strong>C:\\Ephesoft\\SharedFolders\\final-drop-folder\\CustomExport\\~BI:Identifier~\\~DOC:Type~ <\/strong>will create a folder named <strong>C:\\Ephesoft\\SharedFolders\\final-drop-folder\\CustomExport\\BI1\\UsInvoice<\/strong><\/li>\n<li><strong>C:\\Ephesoft\\SharedFolders\\final-drop-folder\\CustomExport\\~BCF$UserName:Value~ <\/strong>will create a folder named<strong> C:\\Ephesoft\\SharedFolders\\final-drop-folder\\CustomExport\\TestUser<\/strong><\/li>\n<\/ul>\n<\/li>\n<li>Sample file names:\n<ul>\n<li><strong>Invoice_~DLF$PONumber:Value~ <\/strong>will create a file named <strong>Invoice_2005012345<\/strong><\/li>\n<li><strong>Invoice_~DLF$PONumber:Value~_~BCF$UserName:Value~ <\/strong>will create a file named <strong>Invoice_2005012345_TestUser<br \/>\n<\/strong><strong>Note:<\/strong> Ephesoft Transact will append the appropriate file extension (i.e., .PDF or .TIF) to the exported files.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p>To enter a replacement variable in any of the <strong>File Name<\/strong> or <strong>Folder Path<\/strong> fields, perform the following:<\/p>\n<p>1. Click into the text box (e.g., for the <strong>File Name<\/strong> field), and enter a tilde (~). A drop-down list with all available variables displays.<\/p>\n<p>2. Enter the variable values or select variables from the drop-down list.<\/p>\n<p>3. Separate the values by entering the desired separators (e.g., dashes (-) or underscores (_)).<\/p>\n<p><img decoding=\"async\" width=\"722\" height=\"799\" class=\"wp-image-34789 alignnone\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-10.png\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-10.png 722w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-10-271x300.png 271w\" sizes=\"(max-width: 722px) 100vw, 722px\" \/><\/p>\n<p><span style=\"color: #999999\"><em>Figure 11. Enter Variable Values<\/em><\/span><\/p>\n<table>\n<tbody>\n<tr>\n<td><strong>Variable Relates to<\/strong><\/td>\n<td><strong>XML Field Name <\/strong><\/td>\n<td><strong>Placeholder<\/strong><\/td>\n<\/tr>\n<tr>\n<td>Batch class<\/td>\n<td>BatchClassIdentifier<\/td>\n<td>~BC:Identifier~<\/td>\n<\/tr>\n<tr>\n<td>Batch class<\/td>\n<td>BatchClassName<\/td>\n<td>~BC:Name~<\/td>\n<\/tr>\n<tr>\n<td>Batch class<\/td>\n<td>BatchClassDescription<\/td>\n<td>~BC:Description~<\/td>\n<\/tr>\n<tr>\n<td>Batch instance<\/td>\n<td>ReviewedBy<\/td>\n<td>~BI:ReviewedBy~<\/td>\n<\/tr>\n<tr>\n<td>Batch instance<\/td>\n<td>UUID (Unique identifier for the batch)<\/td>\n<td>~BI:UUID~<\/td>\n<\/tr>\n<tr>\n<td>Batch instance<\/td>\n<td>BatchCreationDate<\/td>\n<td>~BI:CreationDate~<\/td>\n<\/tr>\n<tr>\n<td>Batch instance<\/td>\n<td>UNCFolderPath<\/td>\n<td>~BI:UNCFolderPath~<\/td>\n<\/tr>\n<tr>\n<td>Batch instance<\/td>\n<td>BatchInstanceIdentifier<\/td>\n<td>~BI:Identifier~<\/td>\n<\/tr>\n<tr>\n<td>Batch instance<\/td>\n<td>BatchInstanceName<\/td>\n<td>~BI:Name~<\/td>\n<\/tr>\n<tr>\n<td>Batch instance<\/td>\n<td>BatchInstanceDescription<\/td>\n<td>~BI:Description~<\/td>\n<\/tr>\n<tr>\n<td>Batch instance<\/td>\n<td>ValidatedBy<\/td>\n<td>~BI:ValidatedBy~<\/td>\n<\/tr>\n<tr>\n<td>Batch class field<\/td>\n<td><strong><em>&lt;Specified batch class field value&gt;<\/em><\/strong><\/td>\n<td>~BCF$<strong><em>&lt;name of batch class field&gt;<\/em><\/strong>:Value~<\/p>\n<p>The placeholder above must be replaced with the name of the batch class field.<\/p>\n<p>Example: ~BCF$User_Name:Value~<\/td>\n<\/tr>\n<tr>\n<td>Document level field<\/td>\n<td><strong><em>&lt;Specified document level field value&gt;<\/em><\/strong><\/td>\n<td>~DLF$<em><strong>&lt;name of index field&gt;<\/strong><\/em>:<em><strong>&lt;name of index field&gt;<\/strong><\/em>~<\/p>\n<p>The placeholder above must be replaced with the name of the index field.<\/p>\n<p>Example: ~DLF$FED_TAX_FORM_1040:SSN~<\/td>\n<\/tr>\n<tr>\n<td>Document<\/td>\n<td>UUID (Unique identifier for the document)<\/td>\n<td>~DOC:UUID~<\/td>\n<\/tr>\n<tr>\n<td>Document<\/td>\n<td>Type<\/td>\n<td>~DOC:Type~<\/td>\n<\/tr>\n<tr>\n<td>Document<\/td>\n<td>Identifier<\/td>\n<td>~DOC:Identifier~<\/td>\n<\/tr>\n<tr>\n<td>Document<\/td>\n<td>Description<\/td>\n<td>~DOC:Description~<\/td>\n<\/tr>\n<tr>\n<td>Document<\/td>\n<td>Page count in the current document<\/td>\n<td>~DOC:PageCount~<\/td>\n<\/tr>\n<tr>\n<td>System<\/td>\n<td>SharedFolders location<\/td>\n<td>~SYS:SharedFolderLocation~<\/td>\n<\/tr>\n<tr>\n<td>System<\/td>\n<td>Date with specified format<\/td>\n<td>~SYS:Date(MM-dd-yyyy)~<\/td>\n<\/tr>\n<tr>\n<td>System<\/td>\n<td>Server name<\/td>\n<td>~SYS:ServerName~<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3><a id=\"post-34778-_Toc18662198\"><\/a>XPath Syntax<\/h3>\n<p>Using XPath syntax provides a simple way of locating data in an XML file when nested XML header tags are separated by slashes. For example, the XPath expression <strong>~<\/strong>\/<strong>Batch\/BatchSource~<\/strong> in Figure 12 can be used to extract any information from your batch.XML file to the exported metadata file.<\/p>\n<p><img decoding=\"async\" width=\"1718\" height=\"820\" class=\"wp-image-34790 alignleft\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-11.png\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-11.png 1718w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-11-300x143.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-11-768x367.png 768w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-11-1024x489.png 1024w\" sizes=\"(max-width: 1718px) 100vw, 1718px\" \/><\/p>\n<p style=\"text-align: left\"><span style=\"color: #999999\"><em>Figure 12. Using XPath to Extract Data from a Batch XML File<\/em><\/span><\/p>\n<p>Also, consider Figure 13 below that shows a portion of an XML file for a batch.<\/p>\n<p><img decoding=\"async\" width=\"874\" height=\"701\" class=\"wp-image-34791 alignnone\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-12.png\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-12.png 874w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-12-300x241.png 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image-12-768x616.png 768w\" sizes=\"(max-width: 874px) 100vw, 874px\" \/><\/p>\n<p><span style=\"color: #999999\"><em>Figure 13. XML File for a Batch<\/em><\/span><\/p>\n<p>See the following for examples of retrieving XML values using XPath:<\/p>\n<ul>\n<li><strong>~Batch\/BatchSource~<\/strong> returns the BatchSource value of Upload Batch<\/li>\n<li><strong>~Batch\/BatchPriority~<\/strong> returns a value of 1<\/li>\n<li><strong>~Batch\/Documents\/Document[1]\/Confidence~<\/strong> returns a value of 8.36<\/li>\n<li><strong>~Batch\/Documents\/Document[2]\/Confidence~<\/strong> returns the confidence value from the second document in the batch<\/li>\n<\/ul>\n","protected":false},"featured_media":0,"parent":31772,"menu_order":4,"comment_status":"closed","ping_status":"closed","template":"","doc_tag":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v19.0 (Yoast SEO v22.1) - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Custom Export 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=\"Custom Export Plugin\" \/>\n<meta property=\"og:description\" content=\"Available:\u00a0on-premises, cloud Introduction This document describes the concepts, configuration, and additional information about using the Custom Export plugin with Ephesoft [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/custom-export-plugin-configuration-and-user-guide\/\" \/>\n<meta property=\"og:site_name\" content=\"Ephesoft Docs\" \/>\n<meta property=\"article:modified_time\" content=\"2022-02-02T21:40:55+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image.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=\"11 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\/custom-export-plugin-configuration-and-user-guide\/\",\"url\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/custom-export-plugin-configuration-and-user-guide\/\",\"name\":\"Custom Export Plugin | Ephesoft Docs\",\"isPartOf\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/#website\"},\"datePublished\":\"2019-08-29T23:24:55+00:00\",\"dateModified\":\"2022-02-02T21:40:55+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/custom-export-plugin-configuration-and-user-guide\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/custom-export-plugin-configuration-and-user-guide\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/custom-export-plugin-configuration-and-user-guide\/#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\":\"Custom Export 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":"Custom Export Plugin | Ephesoft Docs","robots":{"index":"noindex","follow":"follow"},"og_locale":"en_US","og_type":"article","og_title":"Custom Export Plugin","og_description":"Available:\u00a0on-premises, cloud Introduction This document describes the concepts, configuration, and additional information about using the Custom Export plugin with Ephesoft [&hellip;]","og_url":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/custom-export-plugin-configuration-and-user-guide\/","og_site_name":"Ephesoft Docs","article_modified_time":"2022-02-02T21:40:55+00:00","og_image":[{"url":"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2019\/09\/word-image.png"}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"11 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/custom-export-plugin-configuration-and-user-guide\/","url":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/custom-export-plugin-configuration-and-user-guide\/","name":"Custom Export Plugin | Ephesoft Docs","isPartOf":{"@id":"https:\/\/ephesoft.com\/docs\/#website"},"datePublished":"2019-08-29T23:24:55+00:00","dateModified":"2022-02-02T21:40:55+00:00","breadcrumb":{"@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/custom-export-plugin-configuration-and-user-guide\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/custom-export-plugin-configuration-and-user-guide\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/custom-export-plugin-configuration-and-user-guide\/#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":"Custom Export 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\/34699"}],"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=34699"}],"version-history":[{"count":4,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/34699\/revisions"}],"predecessor-version":[{"id":50308,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/34699\/revisions\/50308"}],"up":[{"embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31772"}],"next":[{"title":"Tabbed PDF Plugin","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/tabbed-pdf-plugin-2\/","href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31788"}],"prev":[{"title":"Clean Up Batch Instance(s)","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/clean-up-batch-instances\/","href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31784"}],"wp:attachment":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/media?parent=34699"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/doc_tag?post=34699"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}