Overview

Copy batch xml plugin copies the batch xml and batch files (multipage pdf and tiff files) from batch instance folder to the Batch XML Export Folder. Admin can modify the names of the document files to be copied and folder where they are to be copied.

Guidelines for entering Export Folder Name and Export File Name

  • Values specified in these fields can be either document field name, EphesoftBatchID or EphesoftDOCID.
  • Each parameter (document field name, EphesoftBatchID or EphesoftDOCID) should be preceded by ‘$’.
  • Example: $Invoice Date && _ && $Invoice Total && _ && $EphesoftBatchID. If batch xml has following values for these parameters :
    • Invoice Date : 13 Jan
    • Invoice Total : 22.22
    • EphesoftBatchID : BIA

Then folder or file names will be named as “13 Jan_22.22_BIA”.

  • && will be used as a separator between parameters.
  • If any invalid character is entered by user (for either Export Folder Name or Export File Name) or value for any of the parameters specified contains invalid character, it will be replaced by replace_char which is configurable from properties file.

Note Invalid character is the one that cannot be used for a file or folder name.

(e.g., / \ : * < > ? ” | for windows)

  • In case document doesn’t contains any of parameter specified (e.g., $Invoice Date && _ && $Invoice Total) or doesn’t contain value for any of the parameter,
    • Document files (multipage pdfs and tiffs) names will be retained as it is, in case of Export File Name.
    • Document files will be moved to folder named Unknown, in case of Export Folder Name.

Configuration

UI Configurations

Copy batch xml plugin can be configured from UI:

{Batch Class List} -> {Batch Class} -> Export -> COPY_Batch_XML

 

400px-3.1_CopyBatchxmlplugin_10001

 

Properties Description:

 

Just test table
Configurable property Type of value Value options Description
Final Export Folder String NA Folder Path where all the files (batch xml, multipage pdf, multipage tiff) are to be exported.
Export To Folder Switch String ON
OFF
Switch to decide whether or not to copy the batch files to the Final Export Folder. Default ON.
Export Folder Name String NA Folder with this name will be created in the Final Export Folder and all the document files (multipage pdf(s) and tiffs) will be copied in this folder. Refer to Guidelines for entering Export Folder Name and Export File Name.
Export File Name String NA All the document files (multipage pdfs and tiffs) will be renamed based on the parameters specified in this property. Refer to Guidelines for entering Export Folder Name and Export File Name.
Batch XML Export Folder String Batch Instance Folder

Final Export Folder
Folder where batch xml file will be copied. Possible Values:

Batch Instance Folder: Batch XML files will be copied to batch instance folder (BI??) in the Final Export Folder.

Final Export Folder: In this case, batch xml's will be copied directly in the Final Export Folder.
Copy Multipage File Type List of values PDF
Tiff
Tiff and PDF
Default : PDF
This property decides which file has to be copied along with batch xml to the folder location specified in the property Final Export Folder. If PDF is selected then multipage PDF's created by CREATE_MULTIPAGE_FILE plugin will be copied. Similarly if tiff is selected then multipage tiffs are copied and if PDF and Tiff is selected then both are copied.

 

Property File Configurations

Configuration for Replacing Invalid Character:

Property File Name: dcma-export.properties

Property file location: {Ephesoft_Home}/WEB-INF/classes/META-INF/dcma-export/*
Properties Description:

 

Screen Shot 2014-09-07 at 2.08.52 PM

 

Dependencies

CREATEMULTIPAGE_FILES plugin: This plugin is responsible for creating multipage pdf and tiff files which are copied by Copy batch XML plugin to Batch XML Export folder. If multipage file creation type is different from Copy multipage file type then the batch will go into error.

Troubleshooting

 

S No. Error message Possible root cause
1 Could not create folder. Batch instance folder could not be created in Final Export Folder. Check for permission on this folder.
2 Folder does not exist. Folder specified for Final Export Folder doesn't exist.

 

 

Was this article helpful to you?

wikiadmin

Comments are closed.