ImageScan, Inc. RemitTrac. Batch Archive Version 11. Documentation

Transcription

1 ImageScan, Inc RemitTrac Batch Archive Version 11 Documentation

2 TABLE OF CONTENTS Batch Archive Version Setup Data File... 1 Archive Data File... 2 Appendix I... 3 Installation... 3 Initialization File... 3 Example INI File... 4 Archive Data Directories... 4 Batch Archive Cleanup... 5 Third Party Responsibility... 5

3 Batch Archive Version 11 This document describes the method and format of the Batch Archive Specification for version 11. Batch Archive is a process that archives the work (batches) and the setup information for a site, allowing the information to be imported into an external data base for reporting purposes. The Batch Archive process is a scheduled task in the system. For the process to be scheduled, the Site, Bank and Lockbox must have the Batch Archive option enabled for the Batch Archive task. The files generated by Batch Archive are formatted XML files based on a Document Type Definition (DTD). The files archived during the Batch Archive process are: Setup Data File For more information about the contents of the Setup Data File, please refer to the document Setup Archive XML Content in the Archive section of the RemitTrac Workflow Manual. Archive Data File For more information about the contents of the Archive Data File, please refer to the document Data Archive XML Content in the Archive section of the RemitTrac Workflow Manual. Setup Data File The Setup Archive file contains the information about a Site, Bank and Lockbox. The Setup Data file for Version 11 is a formatted XML file based on the following Document Type Definitions: BaseElem.DTD Contact.DTD Form.DTD GlobalOperWork.DTD Lockbox.DTD SiteBank.DTD These DTD files are found in the Product_Main\Config\Export directory and contain the definition of the elements found in the Setup XML file. When a change is made to Configuration, Site, Bank or Lockbox Setup, the Batch Archive process will place a Setup Data file of the changes the Setup subdirectory of the root directory specified in the [BatchArch] section of the Archive.ini file. This directory will contain all the changes made to any setup for a time period (i.e., since the last time the directory was cleaned out). For more information, see Appendix I. Each time a setup changes, a new Setup Data file will automatically be generated. The name of the Setup Data file is SETUP_YYYYMMDD_HHMMSS.XML. NOTE: A Setup Data file will only be generated if the Save command on the main Setup screen is selected. If a secondary setup window is saved, a Setup Data file will not be generated until the Save command on the primary Setup window is used. For example, if the Save command is selected on the Retail Form Setup window, a Setup Data file will not be generated until the Retail Form Setup window is closed and the Save command on the main Lockbox Setup screen is selected. IMPORTANT: The Setup Data XML file is not a cumulative file of setup information. Each Setup Data file will only contain the information that was changed. The date and time in the file name of each file will be unique. This allows a vendor to load the oldest changes first. A vendor must be Page 1 of 5 - Version

4 able to handle multiple setup data files and apply each file in the order in which the change was made. For more information about the contents of the Setup Data File, please refer to the document Setup Archive XML Content in the Archive section of the RemitTrac Workflow Manual. Archive Data File The Data Archive file contains the information for a batch of work. The Archive Data file for Version 11 is a formatted XML file based on the ArchiveFile.DTD. The ArchiveFile.DTD is found in the Site\Config directory and contains the definition of the elements found in the XML file. IMPORTANT: Depending on the type of lockbox and batch, the batch information contained in the XML will vary. Not all elements and fields defined in the ArchiveFile.DTD will be present for each batch. Some of the defined elements and fields are not currently being used by RemitTrac, but will be utilized over time as new features are added to RemitTrac. A vendor must be able to handle the presence or absence of elements within the Archive Data file. Please refer to the ArchiveFile.DTD for element requirements. In the normal workflow, a batch is scheduled to Batch Archive after it has finished encoding. The Batch Archive process places the Archive Data file for the batch into the XML subdirectory of the root directory that is specified in the [BatchArch] section of the Archive.ini file. This directory contains all batches of work archived for the time period (i.e., since the last time the directory was cleaned out). For more information, see Appendix I. The Archive Data file will automatically be regenerated every time that the batch of work is modified, including within Research Editor, when MICR Repair is performed after encode, when Data Entry is performed after encode, for Change of Address and Float. If the lockbox allows the sending of deleted batches to Archive, a deleted batch will also be sent to Batch Archive. Once a batch is encoded, the operators in RemitTrac can reschedule a batch back to Batch Archive at anytime. Once scheduled, the Archive processes will generate the batch XML file. If the archive file for the batch does not already exist in the archive directory, the data file will be placed in the archive directory. If the archive file for the batch already exists in the archive directory, the archive data file will be overwritten with the current information for the batch. Thus, the contents of the Archive Data file will change as the process day progresses. Although the contents are changing, the name of the archived files will remain the same. The name of the Archive Data file is MMDDYYYY_B_BatchNumber.XML. A batch can be deleted at any time in the workflow process. If the batch is deleted after encode and the Lockbox Setup option to send deleted batches to Archive is set, the deleted batch will be scheduled for archive. When a batch is deleted, the system control number of the batch is renamed to D_BatchNumber. The archive data file for a deleted batch will be named D_B_BatchNumber. A vendor must be aware that the presence of the D_ files means that a previously archived batch has been deleted and the vendor must take appropriate actions. Each time a batch is archived, an entry is written to the Work Processing file (BatchArch.Lst) and to the RemitTrac Event Logger. The Work Processing File (BatchArch.Lst) contains a listing of batches that have been archived. This file contains the many different lines of straight ASCII text that can be read by a text editor to review when the Archive Program was processing and what was processed. The Work Processing File is not deleted or purged every time the software starts, but is always appended. Thus, the file could have many different days or runs in it. It is the responsibility of the cleaning software to remove this file when all the XML and image files are pulled. The file is a straight ASCII text file that starts with a line denoting the Archive File Version and date and time the Archive process started. Batch Archive: Version Started: Wed Oct 26 09:05: Page 2 of 5 - Version

5 The file will then have a series of lines indicating the batches processed by Batch Archive for the date listed above. Identifier Length Description BA or BE 24 Batch Number NOTE: BA indicates archive was successful BE indicates archive failed LB 24 Lockbox ID IT 5 Batch Item Count AM 15 Batch Amount DR 32 Archive Directory FI 64 Archive Data File Name DT 10 Date the file was Archived (MM/DD/YYYY) TI 8 Time the file was Archived In the event that the archive files (data file and/or image files) cannot be written, the batch will fail archive and a BE line will be written to the Work Processing File and to the Event Logger of the archive workstation. If this failure occurs, any batch files already completed will be deleted from the archive directory. For third party processors that pull these files, the BE line in the Work Processing file is an indication that this batch is no longer valid. Note: The Work Processing file will allow Read Access while the file is being updated. Appendix I Installation Batch Archive is a purchasable module. After a site has purchased the Batch Archive module and loaded the license file through the Site Setup, Batch Archive can be enabled. The ability to start the Batch Archive background function is controlled by three settings. 1) The Workstation must be enabled to perform Batch Archive. This is enabled through the Workstation Management Archive Functions in Configuration Workstation Setup. 2) The Archive.INI file must include a [BatchArch] section defining the Workstation in which to load the Batch Archive software. 3) The operator must have rights to start Batch Archive. This is achieved through the Operator Management Background Functions in Configuration Operator Setup. Once these flags have been set, the software can be loaded on the workstation. In order for a batch to be scheduled to Batch Archive, the Site, Bank and Lockbox must be enabled for Batch Archive. Once these flags have been set, the Batch Scheduler will start to schedule batches to Batch Archive. Note: A sample Archive.INI and.dtd file was supplied with the software in the Ver_ \Config directory. These files should be included in the Site\Config directory for the system. Initialization File The Archive.INI file contains the settings for all of the Archive programs that will run in the RemitTrac System. This is a standard INI file to enable the Site to define the Archive processes behavior in order to suit certain customer needs. The file is broken up into sections, including ImageArch, LockArch and BatchArch. Each section deals with a specific type of archive process. As other archive processes are added or new features are added to existing Page 3 of 5 - Version

6 processes, additional sections and/or variables may be added. For more information on the contents of the Archive INI file, please refer to the INI Configuration Setup document in the RemitTrac Setup Manual. Example INI File This is the ARCHIVE INI file. This file is used to define the parameters for the lockbox Archive program and the Image Archive program to run with. It identifies global parameters to control how the two programs work also. [Parameters] [ImagArch] DebugMode = No ImagArcMach = ISDEV04 ImagArcdisk = D: ImagArcResv = 20 XP - Image Archive machine Local Image Archive disk Amount of storage to reserve for Daily Databases [LockArch] LockArcMach = ISDEV04 XP - Lockbox Archive Machine LockArcDisk = D: Local Lockbox Archive Disk (DVD) LockArcDir = LockArch Root Lockbox Archive directory name DebugMode = ENAB FLOW DUMP SEND UPDT FILE LV01 LV02 OutputVersion = 2.0 AllowScanline = Yes LimitFlags = Yes [BatchArch] Version = File Version BatchArcMach = ISDEV04 XP - Lockbox Archive Machine BatchArcDisk = D: Local Lockbox Archive Disk (DVD) BatchArcDir = BatchArch Root Lockbox Archive directory name DebugMode = ENAB FLOW SEND UPDT FILE LV01 LV03 Archive Data Directories The machine that is running Batch Archive must have a disk dedicated to providing the capability for Batch Archive. This disk is specified in the [BatchArch] section of the Archive.ini file. The specified disk will have a root directory structure that is also defined in the BatchArch] section of the Archive.ini file. This root directory will contain an XML subdirectory under which the archive files will be stored and a Setup subdirectory under which the setup files will be stored. An example of the directory structure will be: D:\BatchArch BatchArch.Lst (Archive Processed Work File) XML _B_23350.XML (Archive Data File) _B_12390.XML _B_56790.XML Page 4 of 5 - Version

7 SETUP SETUP_ _ XML (Setup File) SETUP_ _ XML (Setup File) Etc. Batch Archive Cleanup The Batch Archive Directory Cleanup is a responsibility of the site. There are two general methods for cleanup. 1) Wipe the contents of the directory structure at the end of each day, thus providing a clean slate for the next processing date. 2) Use the software that pulls/picks up the archive files to clean out the files after they are posted to the destination. Third Party Responsibility It is the responsibility of the Third Party Software (TPS) package to retrieve the XML files to update their information structure. RemitTrac will NOT communicate with TPS packages. The presence of the XML file and the ability to LOCK the file for WRITING implies that file is ready for retrieval. At that time, the TPS software should retrieve (copy out) the XML file and associated Image Files. It is the responsibility of the TPS to leave the XML file, rename the XML, delete the XML, or move the XML to another location. The RemitTrac software will recreate the XML file, and associated Image Files, if required. The TPS package should be able to handle the same XML file many different times. It is the responsibility of the TPS package to recognize that the XML file has been processed before and take the appropriate action, including update, delete/add or ignore, to handle the revised XML file. Page 5 of 5 - Version