Difference between revisions of "HalFILE 3.0 Documentation"

From HalFILE Online Help
Jump to: navigation, search
Line 10: Line 10:
 
Version 3.0
 
Version 3.0
 
April 22, 2009
 
April 22, 2009
 
 
 
 
 
  
  
Line 49: Line 44:
  
 
All information contained or disclosed by this document is considered confidential and proprietary by hal Systems Corporation, except for rights expressly granted by contract in writing to other parties concerning the data or information disclosed herein. All design, manufacture, use, reproduction, and sales rights are reserved by hal Systems Corporation. Under the copyright laws, neither the documentation nor the software may be copied, photocopied, reproduced, translated, or reduced to any electronic medium or machine readable format except in the manner described in the documentation. Copyright © 2004-2009 by hal Systems Corporation. All rights reserved.
 
All information contained or disclosed by this document is considered confidential and proprietary by hal Systems Corporation, except for rights expressly granted by contract in writing to other parties concerning the data or information disclosed herein. All design, manufacture, use, reproduction, and sales rights are reserved by hal Systems Corporation. Under the copyright laws, neither the documentation nor the software may be copied, photocopied, reproduced, translated, or reduced to any electronic medium or machine readable format except in the manner described in the documentation. Copyright © 2004-2009 by hal Systems Corporation. All rights reserved.
 
 
   
 
   
'''Table of Contents'''
 
['''Welcome to halFILE 1-]'''
 
'''[About halFILE 1-]'''
 
<u>[Document Capture</u> 1-]
 
<u>[Document Indexing</u> 1-]
 
<u>[Document Archiving</u> 1-]
 
<u>[Document Search</u> 1-]
 
<u>[Web Enabling</u> 1-]
 
'''[Chapter Contents 1-]'''
 
<u>[Chapter 1: Welcome to halFILE™</u> 1-]
 
<u>[Chapter 2: Overview</u> 2-]
 
<u>[Chapter 3: System Setup</u> 2-]
 
<u>[Chapter 4: Capturing Documents</u> 2-]
 
<u>[Chapter 5: Indexing Documents</u> 2-]
 
<u>[Chapter 6: Archiving Document Images</u> 2-]
 
<u>[Chapter 7: Search for Documents</u> 2-]
 
<u>[Chapter 8: Tools</u> 2-]
 
<u>[Chapter 9: Other halFILE Features</u> 2-]
 
<u>[Chapter 10: Security</u> 2-]
 
<u>[Appendix I: Compatible Scanners and Engines</u> 2-]
 
<u>[Appendix II: Enabling Other Application</u> 2-]
 
<u>[Appendix III: Building a Sample Application</u> 2-]
 
<u>[Appendix IV: Importing Other Document Types into halFILE</u> 3-]
 
<u>[Appendix V: Text File Support</u> 3-]
 
<u>[Appendix VI: Add-On Applications</u> 3-]
 
<u>[Appendix VII: Hot Keys and Short Cuts</u> 3-]
 
'''[Online Help 3-]'''
 
<u>[Search the halFILE Knowledge</u> 3-]
 
<u>[Supporting Documentation</u> 3-]
 
<u>[Tech Support Briefs / White Papers</u> 3-]
 
<u>[HalFILE Users Group (HUG)</u> 3-]
 
'''[Product registration 4-]'''
 
'''[Technical Support 4-]'''
 
'''[OVERVIEW 5-]'''
 
'''[Upgrading to version 3.0 5-]'''
 
<u>[From Version 2.2</u> 5-]
 
<u>[From Versions prior to 2.2</u> 5-]
 
'''[halFILE Update Service 5-]'''
 
'''[Document Management with halFILE 6-]'''
 
'''[What\’s New in 3.0 6-]'''
 
'''[What\’s New in 3.0 7-]'''
 
'''[SYSTEM SETUP 11-]'''
 
'''[System Configuration 11-]'''
 
<u>[Minimum Workstation System Requirements</u> 11-]
 
<u>[Recommended Workstation System Requirements</u> 11-]
 
<u>[Recommendations Terminal Servers</u> 12-]
 
<u>[Recommendations Database Servers</u> 12-]
 
<u>[Recommendations Image Servers</u> 12-]
 
<u>[Other Components</u> 12-]
 
'''[Networks Supported 12-]'''
 
'''[Databases Supported 12-]'''
 
'''[Installation Requirements 13-]'''
 
'''[Preparing the Hardware and Software Components 13-]'''
 
'''[Software Installation Procedure 13-]'''
 
'''[Video Scanner Drivers 17-]'''
 
'''[ISIS Scanner Drivers 17-]'''
 
'''[TWAIN Scanner Drivers 17-]'''
 
'''[halFILE Menu Structure 18-]'''
 
'''[Viewing the help file 18-]'''
 
'''[Exiting halFILE 19-]'''
 
'''[Registration 19-]'''
 
'''[Running halFILE for the first time 19-]'''
 
'''[halFILE Administrator 20-]'''
 
'''[Setting up an Application 20-]'''
 
'''[The Application Definition 21-]'''
 
<u>[Defining a new application</u> 21-]
 
<u>[Changing an application set up</u> 21-]
 
'''[Designing a Database 23-]'''
 
<u>[Creating a document database</u> 23-]
 
<u>[Using Specification Templates</u> 24-]
 
<u>[Using Field Lookups</u> 25-]
 
<u>[Using Field Links</u> 26-]
 
<u>[Setting Up Custom Search formats</u> 27-]
 
<u>[Search References</u> 28-]
 
<u>[Field Masks</u> 29-]
 
<u>[Auto Fill</u> 30-]
 
<u>[ODBC Compliant Data Sources</u> 31-]
 
<u>[Migrating your Preliminary Access database</u> 31-]
 
<u>[Add ODBC</u> 31-]
 
<u>[ODBC Info</u> 31-]
 
<u>[Review Layout</u> 31-]
 
<u>[Verify Setup</u> 31-]
 
'''[Setting Up Electronic In-baskets 32-]'''
 
<u>[Defining baskets</u> 32-]
 
'''[halFILE Workflow 33-]'''
 
<u>[Enabling Workflow</u> 34-]
 
<u>[Workflow Routing Example</u> 37-]
 
'''[Defining Validation Tables 38-]'''
 
<u>[Creating a new validation table</u> 38-]
 
<u>[Adding or editing entries in a table</u> 38-]
 
<u>[Searching for an entry</u> 39-]
 
<u>[Deleting an entry in a table</u> 39-]
 
<u>[Deleting a table</u> 39-]
 
<u>[Printing a list of table entries</u> 39-]
 
<u>[Adding Predefined Tables</u> 40-]
 
'''[Looking Up a Field in a Table 40-]'''
 
'''[Changing or Adding Reports 41-]'''
 
'''[Defining Drives into which Archive Cartridges are placed 41-]'''
 
'''[Defining Cartridges where Document Images are placed 42-]'''
 
<u>[Defining a cartridge</u> 42-]
 
'''[Configuring Bar Code Fields 44-]'''
 
<u>[Bar Codes Types Supported</u> 44-]
 
<u>[Setting Up a Bar Code Field</u> 45-]
 
'''[Setting Up Custom Features 46-]'''
 
<u>[General</u> 46-]
 
<u>[System Messaging</u> 47-]
 
<u>[Administrative Reports</u> 47-]
 
<u>[Transactions</u> 47-]
 
<u>[Security/Versions</u> 48-]
 
<u>[FTP Setup</u> 48-]
 
<u>[HFDeliver</u> 48-]
 
<u>[Menus</u> 48-]
 
<u>[Admin Status</u> 48-]
 
'''[HALFILE.INI 48-]'''
 
<u>[halFILE For Windows section</u> 49-]
 
<u>[Current Section</u> 49-]
 
<u>[Execute Section</u> 50-]
 
<u>[Special HALFILE.INI Hooks</u> 50-]
 
<u>[HALFILE.INI Entries for Attached Tables</u> 50-]
 
'''[CAPTURING DOCUMENTS 53-]'''
 
'''[Scanning Pages 53-]'''
 
<u>[Preparing to scan</u> 53-]
 
<u>[Page preparation</u> 53-]
 
'''[Kofax Scanning 54-]'''
 
<u>[Changing the Scanner Parameters</u> 54-]
 
<u>[General Scanning Procedure</u> 55-]
 
<u>[Scanning two-sided documents with a duplex scanner</u> 56-]
 
<u>[Scanning one-sided documents with a duplex scanner</u> 56-]
 
<u>[Scanning two-sided documents with a simplex scanner</u> 56-]
 
<u>[Scanning a batch of single page documents</u> 56-]
 
<u>[Stapling pages into documents</u> 57-]
 
<u>[Staple Preview Option</u> 57-]
 
<u>[Removing a page from a batch</u> 57-]
 
<u>[Inserting pages into a batch</u> 57-]
 
<u>[Replacing a page in a batch</u> 57-]
 
<u>[Deskewing pages during scan</u> 58-]
 
<u>[Removing the black border from pages during scan</u> 58-]
 
<u>[Removing shaded areas from pages during scan</u> 58-]
 
<u>[Despeckling pages during scan</u> 59-]
 
<u>[Enhancing the edges of characters during scan</u> 59-]
 
<u>[Removing the lines from pages during scan</u> 60-]
 
<u>[Removing streaks from pages during scan</u> 60-]
 
<u>[Inverting (reversing) the image during scan</u> 60-]
 
<u>[Stapling Pages into Documents using Bar Codes</u> 61-]
 
<u>[Printing during Stapling</u> 61-]
 
<u>[Summary of scan menu selections</u> 61-]
 
'''[TWAIN Scanning 62-]'''
 
<u>[Changing the Scanner Parameters</u> 62-]
 
<u>[General Scanning Procedure</u> 64-]
 
<u>[Scanning two-sided documents with a duplex scanner.</u> 65-]
 
<u>[Scanning one-sided documents with a duplex scanner.</u> 65-]
 
<u>[Scanning two-sided documents with a single sided scanner</u> 65-]
 
<u>[Scanning a batch of single page documents</u> 65-]
 
<u>[Stapling pages into documents</u> 65-]
 
<u>[Staple Preview Option</u> 66-]
 
<u>[Removing a page from a batch</u> 66-]
 
<u>[Inserting pages into a batch</u> 66-]
 
<u>[Replacing a page in a batch</u> 66-]
 
<u>[Deskewing pages during scan</u> 66-]
 
<u>[Despeckling pages during scan</u> 66-]
 
<u>[Cropping pages during scan</u> 67-]
 
<u>[Inverting (reversing) images during scan</u> 67-]
 
<u>[Printing during Stapling</u> 67-]
 
<u>[Summary of TWAIN scan menu selections</u> 67-]
 
'''[Streamlined Scanning 68-]'''
 
<u>[Scan and E-mail</u> 68-]
 
<u>[Scan and FTP</u> 69-]
 
<u>[HALFTP.INI</u> 70-]
 
'''[Paper Sizes 71-]'''
 
'''[Remote Scanning 72-]'''
 
<u>[Scanning and Importing</u> 72-]
 
<u>[FTP Scanning using Third Party Products</u> 72-]
 
'''[Importing Documents 72-]'''
 
<u>[Using the import feature to import images</u> 73-]
 
<u>[Staple Preview Option</u> 74-]
 
'''[Capturing Printed Output 75-]'''
 
'''[Sending Office Documents to halFILE 75-]'''
 
'''[Importing Documents using the Explorer Send To Feature 76-]'''
 
'''[INDEXING DOCUMENTS 77-]'''
 
'''[Indexing Overview 77-]'''
 
<u>[Indexing a document</u> 78-]
 
<u>[Adding a database record without an image</u> 78-]
 
'''[Index Windows 78-]'''
 
<u>[Index fields window</u> 78-]
 
<u>[Saving the Default Window Position</u> 79-]
 
'''[Entering Data into Database Fields 79-]'''
 
'''[Setting Up Custom Index Features 79-]'''
 
<u>[IndexExecute</u> 79-]
 
<u>[IndexLoadExecute</u> 79-]
 
<u>[IndexMenuExecute</u> 80-]
 
<u>[Notifications</u> 80-]
 
<u>[General</u> 80-]
 
<u>[Field Deactivation</u> 80-]
 
<u>[Duplication Hot Keys</u> 80-]
 
'''[halFILE Document Clipboard 81-]'''
 
'''[Using Auto Fill 81-]'''
 
'''[Index Menu Summary 81-]'''
 
'''[Improving search performance and database integrity 83-]'''
 
'''[ARCHIVING DOCUMENTS 85-]'''
 
'''[Manual Archive 85-]'''
 
'''[How Images are Stored on Cartridges 87-]'''
 
<u>[No limits on number of images per folder</u> 87-]
 
<u>[Limit number of images per folder and enter the folder id</u> 87-]
 
<u>[Limit number of images per folder and auto assign the folder id</u> 87-]
 
<u>[Database Level Archiving</u> 88-]
 
'''[Auto Archive 88-]'''
 
<u>[Auto Archive Set up</u> 88-]
 
<u>[Running Auto Archive Interactively</u> 90-]
 
<u>[Running Auto Archive as a Scheduled Task</u> 91-]
 
<u>[Reviewing Auto Archive Results</u> 91-]
 
<u>[Other Auto Archive Features</u> 91-]
 
'''[SEARCH FOR DOCUMENTS 93-]'''
 
'''[Overview of Search 93-]'''
 
<u>[Searching for documents that have been indexed</u> 93-]
 
'''[The Search Criteria Window 93-]'''
 
<u>[Searching for more than one multi-entry field item</u> 94-]
 
<u>[Searching for a range of values</u> 95-]
 
<u>[Printing the search criteria</u> 95-]
 
<u>[Closing the search module</u> 95-]
 
<u>[Performing an Append search</u> 95-]
 
<u>[Designing a report</u> 95-]
 
<u>[Printing a report</u> 96-]
 
<u>[Printing Large Reports</u> 97-]
 
<u>[Avoiding slow searches</u> 97-]
 
'''[Criteria Field Types 97-]'''
 
<u>[Search criteria results examples</u> 98-]
 
'''[The Hit List Window 98-]'''
 
<u>[Selecting the Display Result Option</u> 99-]
 
<u>[Formatting the hit list grid</u> 99-]
 
<u>[Marking entries in the hit list grid</u> 99-]
 
<u>[Saving and Restoring the Hit List</u> 99-]
 
<u>[The Right Click Menu on the Search Hit List</u> 99-]
 
'''[The Document Information Window 100-]'''
 
<u>[Changing database information</u> 100-]
 
'''[Imaging View Window 102-]'''
 
<u>[Zooming in on the image</u> 103-]
 
<u>[Rotating the image</u> 103-]
 
<u>[Printing an Image</u> 103-]
 
<u>[Using image panning</u> 103-]
 
<u>[Zoom Hot Keys</u> 103-]
 
'''[Managing Search Windows 103-]'''
 
<u>[Viewing the SQL Statement for a Search</u> 103-]
 
<u>[Returning to the Search Hit List Window</u> 104-]
 
<u>[Preparing for a New Search</u> 104-]
 
<u>[Append Searches</u> 104-]
 
<u>[Combining Documents on the Search Hit List</u> 104-]
 
'''[Setting Up Custom Search Features 105-]'''
 
<u>[Hit List</u> 105-]
 
<u>[Cross Name Search</u> 106-]
 
<u>[Order By</u> 107-]
 
<u>[Publish</u> 107-]
 
<u>[Image modifications</u> 108-]
 
<u>[Execute Triggers</u> 108-]
 
<u>[Document Information e-mail</u> 108-]
 
<u>[Scan-on-demand e-mail</u> 108-]
 
<u>[Notifications</u> 108-]
 
<u>[Word Merge</u> 109-]
 
<u>[Starter</u> 109-]
 
<u>[Fallout Report</u> 109-]
 
'''[SmartName Search 109-]'''
 
<u>[Creating the SmartNames table</u> 110-]
 
<u>[Adding a proper name</u> 110-]
 
<u>[Editing nick names</u> 110-]
 
<u>[Deleting a proper name</u> 110-]
 
<u>[Searching for a proper name</u> 110-]
 
<u>[Testing your dictionary</u> 111-]
 
<u>[Using SmartNames in Search</u> 111-]
 
'''[Soundex Searches 111-]'''
 
<u>[How Soundex Works</u> 111-]
 
<u>[Using Soundex in Search</u> 111-]
 
<u>[Limitations to Soundex</u> 111-]
 
'''[Cross Name Search 112-]'''
 
<u>[Setting up Cross Name Search</u> 112-]
 
<u>[Using the Cross Name Search Feature</u> 112-]
 
'''[Starter Searches 112-]'''
 
<u>[Setting Up the Starter System for a Database</u> 112-]
 
<u>[Performing a Starter Search</u> 114-]
 
<u>[Date Down Searches</u> 117-]
 
<u>[Closing a Starter</u> 117-]
 
<u>[Re-opening a Starter</u> 117-]
 
<u>[Copy a Starter to a new Starter</u> 118-]
 
<u>[Saving the Grid Format of the Starter Information Form</u> 118-]
 
<u>[Fallout Report</u> 118-]
 
'''[Proximity Search 119-]'''
 
<u>[Enabling Proximity Search</u> 119-]
 
<u>[Using Proximity Search</u> 119-]
 
'''[Full-Text Search 119-]'''
 
'''[Search Menu Summary 120-]'''
 
<u>[Search Criteria window menus</u> 120-]
 
<u>[Search Hit List window menus</u> 120-]
 
<u>[Document Information window menus</u> 122-]
 
'''[TOOLS 125-]'''
 
'''[Login 125-]'''
 
'''[Basket Status 125-]'''
 
<u>[Showing the status for a document</u> 126-]
 
<u>[Changing the status of a document</u> 127-]
 
<u>[Removing all images from the basket</u> 127-]
 
<u>[Removing marked documents</u> 127-]
 
<u>[Adding pages to a document</u> 127-]
 
<u>[Deleting a page from a document</u> 127-]
 
<u>[Reordering pages within a document</u> 127-]
 
<u>[Printing Marked Documents</u> 127-]
 
<u>[Inserting Document Numbers into a basket</u> 128-]
 
<u>[Export documents</u> 128-]
 
<u>[Change the status for a range of documents</u> 128-]
 
<u>[Transfer documents to another basket</u> 128-]
 
<u>[Selecting documents</u> 128-]
 
<u>[Optical Character Recognition (OCR)</u> 129-]
 
<u>[Refreshing a basket</u> 129-]
 
<u>[Basket Statistics</u> 129-]
 
'''[Move Images 129-]'''
 
<u>[Rearranging pages</u> 129-]
 
<u>[Replacing pages of documents</u> 130-]
 
<u>[Appending pages to documents</u> 130-]
 
<u>[Deleting pages from documents</u> 130-]
 
<u>[Moving pages from document to document</u> 130-]
 
'''[Image Utility 131-]'''
 
<u>[Rearranging pages</u> 131-]
 
<u>[Swapping pages of documents</u> 132-]
 
<u>[Replacing pages of documents</u> 132-]
 
<u>[Appending pages to documents</u> 132-]
 
<u>[Inserting pages in documents</u> 133-]
 
<u>[Deleting pages from documents</u> 133-]
 
<u>[Moving pages from document to document</u> 133-]
 
'''[Test Images 134-]'''
 
'''[Process Images 134-]'''
 
'''[Associated Import 135-]'''
 
<u>[Overview</u> 135-]
 
<u>[Running the program</u> 135-]
 
<u>[Operation</u> 135-]
 
<u>[Adding a New Import Filter</u> 136-]
 
<u>[Editing an existing Import Filter</u> 138-]
 
<u>[Editing the Field Information</u> 139-]
 
<u>[Executing an Import Filter Manually</u> 141-]
 
<u>[Executing Import Filters Automatically</u> 143-]
 
<u>[Additional Options</u> 143-]
 
<u>[Troubleshooting</u> 143-]
 
'''[OTHER HALFILE FEATURES 145-]'''
 
'''[Import/Export Database 145-]'''
 
<u>[Exporting Database Information</u> 145-]
 
<u>[Exporting data for all images on a selected cartridge</u> 146-]
 
<u>[Importing a Database</u> 147-]
 
'''[E-Mail Images 149-]'''
 
<u>[Requirements</u> 149-]
 
<u>[Setting up E-Mail</u> 149-]
 
<u>[Viewing image attachments</u> 149-]
 
<u>[E-Mail Image Mark Up</u> 149-]
 
<u>[Selecting an image to mark up</u> 150-]
 
<u>[Mark up icons</u> 150-]
 
<u>[Annotation Tool Bar</u> 150-]
 
<u>[Menu Selections</u> 151-]
 
<u>[Zooming in on an Image Area</u> 152-]
 
<u>[TIFF Format Information</u> 152-]
 
'''[SECURITY 153-]'''
 
'''[Security Set Up 153-]'''
 
<u>[Adding a new user</u> 154-]
 
<u>[Editing an existing user set up</u> 155-]
 
'''[Windows Active Directory Integration 157-]'''
 
<u>[Why use Active Directory Integration?</u> 157-]
 
<u>[Before you start</u> 157-]
 
<u>[halFILE Active Directory Integration Set Up Procedure</u> 157-]
 
<u>[halFILE Active Directory Integration</u> 158-]
 
<u>[e.halFILE Active Directory Integration</u> 158-]
 
<u>[Active Directory Integration - Behind the Scenes</u> 159-]
 
'''[APPENDIX I. 160-]'''
 
'''[Compatible Scanners and Engines 160-]'''
 
'''[Kofax 160-]'''
 
'''[TWAIN 160-]'''
 
'''[APPENDIX II. 161-]'''
 
'''[Enabling Other Applications 161-]'''
 
'''[APPENDIX III 162-]'''
 
'''[Building a Sample Application 162-]'''
 
'''[Importing Other Document Types into halFILE 163-]'''
 
'''[Setting up Associations 163-]'''
 
'''[Importing Associated Documents 163-]'''
 
'''[Importing using File_Import 163-]'''
 
'''[Version Control 164-]'''
 
'''[Reviewing the Basket Contents 164-]'''
 
'''[Archiving Associated Documents 164-]'''
 
'''[Searching and Viewing Associated Documents 164-]'''
 
'''[Document Types Tested 165-]'''
 
'''[Organizing Documents 165-]'''
 
'''[Associated Import Utility 165-]'''
 
'''[APPENDIX V 166-]'''
 
'''[Text File Support 166-]'''
 
'''[APPENDIX VI 167-]'''
 
'''[Add-On Applications 167-]'''
 
'''[APPENDIX VII 168-]'''
 
'''[Hot Keys and Short Cuts 168-]'''
 
  
 
 
[[Chapter 1]]
 
[[Chapter 1]]
 +
 
[[Chapter 2]]
 
[[Chapter 2]]
 +
 
[[Chapter 3]]
 
[[Chapter 3]]
 +
 
[[Chapter 4]]
 
[[Chapter 4]]
 +
 
[[Chapter 5]]
 
[[Chapter 5]]
 +
 
[[Chapter 6]]
 
[[Chapter 6]]
 +
 
[[Chapter 7]]
 
[[Chapter 7]]
 +
 
[[Chapter 8]]
 
[[Chapter 8]]
 +
 
[[Chapter 9]]
 
[[Chapter 9]]
 +
 
[[Chapter 10]]
 
[[Chapter 10]]
 +
 
[[Appendix I]]
 
[[Appendix I]]
 +
 
[[Appendix II]]
 
[[Appendix II]]
 +
 
[[Appendix III]]
 
[[Appendix III]]
 +
 
[[Appendix IV]]
 
[[Appendix IV]]
 +
 
[[Appendix V]]
 
[[Appendix V]]
 +
 
[[Appendix VI]]
 
[[Appendix VI]]
 +
 
[[Appendix VII]]
 
[[Appendix VII]]

Revision as of 11:06, 24 September 2009

User Manual



halFILE Document Manager


Version 3.0 April 22, 2009



hal Systems Corporation













Copyright © 2004-2009 by hal Systems Corporation halFILE is a trademark of hal Systems Corporation.

All information contained or disclosed by this document is considered confidential and proprietary by hal Systems Corporation, except for rights expressly granted by contract in writing to other parties concerning the data or information disclosed herein. All design, manufacture, use, reproduction, and sales rights are reserved by hal Systems Corporation. Under the copyright laws, neither the documentation nor the software may be copied, photocopied, reproduced, translated, or reduced to any electronic medium or machine readable format except in the manner described in the documentation. Copyright © 2004-2009 by hal Systems Corporation. All rights reserved.


Chapter 1

Chapter 2

Chapter 3

Chapter 4

Chapter 5

Chapter 6

Chapter 7

Chapter 8

Chapter 9

Chapter 10

Appendix I

Appendix II

Appendix III

Appendix IV

Appendix V

Appendix VI

Appendix VII