Chapter 6 - Archiving Document Images - Revision history

SSprencel at 20:36, 20 April 2011

2011-04-20T20:36:41Z

SSprencel at 21:16, 22 April 2010

2010-04-22T21:16:09Z

SSprencel at 19:28, 4 March 2010

2010-03-04T19:28:43Z

SSprencel at 18:19, 4 March 2010

2010-03-04T18:19:58Z

Show changes

SSprencel at 21:56, 1 March 2010

2010-03-01T21:56:19Z

SSprencel at 21:55, 1 March 2010

2010-03-01T21:55:31Z

SSprencel at 21:54, 1 March 2010

2010-03-01T21:54:52Z

SSprencel at 21:26, 1 March 2010

2010-03-01T21:26:44Z

192.168.0.10 at 22:29, 25 February 2010

2010-02-25T22:29:04Z

192.168.0.10 at 23:22, 23 February 2010

2010-02-23T23:22:54Z

@@ Line 27: / Line 27: @@
 ===Manual Archive===
 Manual archive lets the user run archive interactively. The steps to running a manual archive include:
@@ Line 44: / Line 46: @@
 ===How Images are Stored on Cartridges===
 When images are stored on cartridges, they are placed into specific directories. The highest directory level is the application id. The second directory level used depends on the folder option specified for the application (set using File-Application). The following illustrates the directories used for the various folder options.
@@ Line 85: / Line 89: @@
 ===Auto Archive===
 halFILE's Archive utility includes an Auto Archive feature to archive a selected baskets to selected cartridges on a scheduled basis. The program, HFARCHIVE32.EXE, can be run as a scheduled task on an NT Server, a SQL Server Agent job, or via another scheduling method. Multiple Archive sets can be set up to archive to different sets of cartridges.

@@ Line 35: / Line 35: @@
 # Remove baskets that you wish to exclude from the archive using the '''Remove Basket button'''.
 # Review the statistics shown in the middle of the screen, to make sure enough space is available for the images to be archived.
-# The''' Delete Images after Archive''' check box should be checked if you want the original images to be removed from the hard disk after they have been placed onto permanent storage.<br /><br /><p style="color:blue;font-style:italic">If you do not check the Delete Images after Archive box, it is your responsibility to 'clean up' archived images. You can use the File Manager or the DOS Delete command to do this.</p><br />
+# The''' Delete Images after Archive''' check box should be checked if you want the original images to be removed from the hard disk after they have been placed onto permanent storage.<br /><br /><hr><p style="color:blue;font-style:italic">If you do not check the Delete Images after Archive box, it is your responsibility to 'clean up' archived images. You can use the File Manager or the DOS Delete command to do this.</p><hr><br />
 # The '''Save Data for Archived Images to Cartridge''' check box will cause the system to save tab-delimited files of archived information. This is a great disaster recovery tool. The system saves aaadd_prime.txt (primary information) and aaadd_multi.txt (multi-entry information to the application folder on the cartridge. (aaa is the Application id and dd is the Database Id).
 # Press the '''Begin Archive button''' to start the archive process.

@@ Line 6: / Line 6: @@
 A Cartridge is a permanent storage device for images. Typically, these are magnetic disks or optical disk cartridges. Refer to Chapter 1 for information on setting up cartridges.
 </p>
 ----
 <p style="color:blue;font-style:italic">A CD Stage Area is a 625 megabyte hard disk partition, typically on a file server. Images are archived or "stages" onto the CD Stage Area and, once it becomes full, CD-Rom disks are made from the partition as an image backup. The contents of the CD Stage Drive are then moved to a permanent location such as a Large Disk Partition or Snap Server.
 </p>
 ----
 There are a number of ways to run Archive including:
@@ Line 84: / Line 89: @@
 '''Auto Archive Set up'''
-You can configure Auto Archive by selecting the '''Tools-Archive Setup''' menu in the halFILE Administrator.. This brings up a screen with several tabs for defining the various Auto Archive options as described below:
+You can configure Auto Archive by selecting the '''Tools-Archive Setup''' menu in the halFILE Administrator. This brings up a screen with several tabs for defining the various Auto Archive options as described below:
 '''General tab'''
@@ Line 118: / Line 123: @@
 :'''Cart Name Mask''' - this field defines how new cartridges are named. Use the %appl% to substitute the Application ID and %doctype% to substitute the Document Type. Also, use # to designate the cartridge number, including as many digit placeholders as the maximum cartridge number will be. For example, if your Application ID was XXX and your Document Type ID was TP and the mask was %appl%%doctype%###, then the first cartridge created would be named XXXTP001. Cartridges are limited to 8 characters so your cartridge mask should not exceed 8 characters.<br />
-:'''Cart Prefix'''- defines the cartridge prefix to include when creating new cartridges. You do not need to include the cartridge name prefix, it will automatically be included.<br />
+:'''Cart Prefix''' - defines the cartridge prefix to include when creating new cartridges. You do not need to include the cartridge name prefix, it will automatically be included.<br />
 :'''Cart Description''' - defines the cartridge description to use when creating a new cartridge. Again, you can use the %appl%, %doctype% and ### substitution values.<br />
 :'''Size limit (in MB)'''- defines the size limit in megabytes for new cartridges. When the files on the cartridge reach this size, then the cartridge is considered full and the system rotates to a new cartridge.<br />

@@ Line 141: / Line 141: @@
 ----
-<p style="red:blue;font-style:italic">
+<p style="color:red;font-style:italic">
 It is recommended that documents for different databases be archived to different sets of cartridges. To do this you should set up an archive set for each database and name the cartridges in a way that the database is identified. One good method is to use the database id as part of the cartridge mask. So, if you have an application id of HAL and two databases with database ids of DD and TP then the first auto archive set could be set up to archive documents for application HAL, database DD to cartridges using the cartridge mask DD#####. The first cartridge is named DD00001. Then a second archive set would be set up to archive documents for application HAL, database TP to cartridges using the cartridge mask of TP#####. The first cartridge is then named TP00001.
 </p>

@@ Line 57: / Line 57: @@
 Therefore, if the application id is 'TST' and the folder is 'TEST' and the number of images per folder is 500, then the first 500 images are placed into the following directory.
-[[Image:Cartridge_Folder_Drilldown_2]]
+[[Image:Cartridge_Folder_Drilldown_2.jpg]]
 ===Limit number of images per folder and auto assign the folder id===
 With this option, each folder is limited to a user-defined number of images and the system automatically defines the folder id. The directory structure on the archive cartridge is as follows:
-[[Image:Cartridge_Folder_Drilldown_3]]
+[[Image:Cartridge_Folder_Drilldown_3.jpg]]
 ===Database Level Archiving===
 A option lets you include a database level folder in the archive folder structure. This option is defined on the General tab of the Auto Archive configuration screen (Tools-Configure Auto Archive menu in the halFILE Administrator). When this option is enabled, the folder structure is as follows:
-[[Image:Cartridge_Folder_Drilldown_4]]
+[[Image:Cartridge_Folder_Drilldown_4.jpg]]
 ----

@@ Line 7: / Line 7: @@
 </p>
 ----
 <p style="color:blue;font-style:italic">A CD Stage Area is a 625 megabyte hard disk partition, typically on a file server. Images are archived or "stages" onto the CD Stage Area and, once it becomes full, CD-Rom disks are made from the partition as an image backup. The contents of the CD Stage Drive are then moved to a permanent location such as a Large Disk Partition or Snap Server.
 </p>
@@ Line 31: / Line 30: @@
 # Remove baskets that you wish to exclude from the archive using the '''Remove Basket button'''.
 # Review the statistics shown in the middle of the screen, to make sure enough space is available for the images to be archived.
-# The''' Delete Images after Archive''' check box should be checked if you want the original images to be removed from the hard disk after they have been placed onto permanent storage.<br />''If you do not check the Delete Images after Archive box, it is your responsibility to 'clean up' archived images. You can use the File Manager or the DOS Delete command to do this.''<br />
+# The''' Delete Images after Archive''' check box should be checked if you want the original images to be removed from the hard disk after they have been placed onto permanent storage.<br /><br /><p style="color:blue;font-style:italic">If you do not check the Delete Images after Archive box, it is your responsibility to 'clean up' archived images. You can use the File Manager or the DOS Delete command to do this.</p><br />
 # The '''Save Data for Archived Images to Cartridge''' check box will cause the system to save tab-delimited files of archived information. This is a great disaster recovery tool. The system saves aaadd_prime.txt (primary information) and aaadd_multi.txt (multi-entry information to the application folder on the cartridge. (aaa is the Application id and dd is the Database Id).
 # Press the '''Begin Archive button''' to start the archive process.
 The archive process searches the selected in-baskets for documents that have been indexed. When an indexed document is found, the images related to that document are copied from the in-basket directory to the selected cartridge. Refer to the '''How Images are Stored on Cartridges''' section below for a discussion of the directory structure into which images are placed on the cartridge.
 ==How Images are Stored on Cartridges==
@@ Line 51: / Line 48: @@
 Therefore, if the application id is 'TST' and the folder is 'TEST' then images archived to cartridge are placed into the directory:
-			\TST\TEST\
+[[Image:Cartridge_Folder_Drilldown_1.jpg]
 ===Limit number of images per folder and enter the folder id===
@@ Line 62: / Line 57: @@
 Therefore, if the application id is 'TST' and the folder is 'TEST' and the number of images per folder is 500, then the first 500 images are placed into the following directory.
-			               \TST\TEST\00001
+[[Image:Cartridge_Folder_Drilldown_2]]
 ===Limit number of images per folder and auto assign the folder id===
 With this option, each folder is limited to a user-defined number of images and the system automatically defines the folder id. The directory structure on the archive cartridge is as follows:
-			            \TST\CART1\00001
+[[Image:Cartridge_Folder_Drilldown_3]]
 ===Database Level Archiving===
 A option lets you include a database level folder in the archive folder structure. This option is defined on the General tab of the Auto Archive configuration screen (Tools-Configure Auto Archive menu in the halFILE Administrator). When this option is enabled, the folder structure is as follows:
-                                                       \TST\DB\CART1\00001
+[[Image:Cartridge_Folder_Drilldown_4]]
+----
+<p style="color:blue;font-style:italic">
 Note: The system will never split the images for a document across two cartridges. If, based on the number of images per folder, there is not enough room in the folder counter directory, the document images will be copied to the next folder counter directory. Therefore, it is possible to have fewer images in a directory than is designated by the number of images per folder parameter.''
+</p>
-''Note: The system will never split the images for a document across two cartridges. If, based on the number of images per folder, there is not enough room in the folder counter directory, the document images will be copied to the next folder counter directory. Therefore, it is possible to have fewer images in a directory than is designated by the number of images per folder parameter.''
+----
 ==Auto Archive==
@@ Line 99: / Line 85: @@
 This tab is used to set up general auto archive options as follows:
-'''Enable Auto Archive Features''' - check this box to enable auto archive.
+'''Enable Auto Archive Features''' - check this box to enable auto archive.<br />
-'''Force recalculation of cartridges''' - as the screen suggests, this option is used when archiving to some NAS storage devices if copy requests periodically seem to fail.
+'''Force recalculation of cartridges''' - as the screen suggests, this option is used when archiving to some NAS storage devices if copy requests periodically seem to fail.<br />
-'''Enable database-level archiving''' - this option will create a database level folder beneath the application folder to further separate images on the cartridge.
+'''Enable database-level archiving''' - this option will create a database level folder beneath the application folder to further separate images on the cartridge.<br />
 '''Low Disk Notify (in MB)''' – when the free space on the current archive drive reaches the disk space configured in this box, an alert e-mail and system message is sent as a notification that the drive is getting low on space (see Alerts section).
@@ Line 154: / Line 140: @@
 '''Alerts tab''' - this tab is used to set up e-mail alerts of the Auto Archive activity to selected users. Enter the SMTP Server Address or Server Name in the SMTP Server box then enter the e-mail addresses to which the message should be sent. This feature requires HALSMTP.EXE, halFILE's SMTP e-mail program.
-''It is recommended that documents for different databases be archived to different sets of cartridges. To do this you should set up an archive set for each database and name the cartridges in a way that the database is identified. One good method is to use the database id as part of the cartridge mask. So, if you have an application id of HAL and two databases with database ids of DD and TP then the first auto archive set could be set up to archive documents for application HAL, database DD to cartridges using the cartridge mask DD#####. The first cartridge is named DD00001. Then a second archive set would be set up to archive documents for application HAL, database TP to cartridges using the cartridge mask of TP\#\#\#\#\#. The first cartridge is then named TP00001.''
+----
 ===Running Auto Archive Interactively===

@@ Line 1: / Line 1: @@
 =ARCHIVING DOCUMENTS=
-Archiving is the process of moving documents from on-line storage to permanent storage. Typically, this means copying the images or documents from a local or network disk drive to a CD Stage Area, an Optical Disk, or some other permanent storage area. Only indexed documents are archived and the archive process removes the document from the basket. Multiple in-baskets can be selected.
+[[Image:Archive_Icon.jpg|align=left]] Archiving is the process of moving documents from on-line storage to permanent storage. Typically, this means copying the images or documents from a local or network disk drive to a CD Stage Area, an Optical Disk, or some other permanent storage area. Only indexed documents are archived and the archive process removes the document from the basket. Multiple in-baskets can be selected.
 ----
+<p style="color:blue;font-style:italic">
-''A Cartridge is a permanent storage device for images. Typically, these are magnetic disks or optical disk cartridges. Refer to Chapter 1 for information on setting up cartridges.''
+A Cartridge is a permanent storage device for images. Typically, these are magnetic disks or optical disk cartridges. Refer to Chapter 1 for information on setting up cartridges.
+</p>
 ----
-''A CD Stage Area is a 625 megabyte hard disk partition, typically on a file server. Images are archived or "stages" onto the CD Stage Area and, once it becomes full, CD-Rom disks are made from the partition as an image backup. The contents of the CD Stage Drive are then moved to a permanent location such as a Large Disk Partition or Snap Server.''
+<p style="color:blue;font-style:italic">A CD Stage Area is a 625 megabyte hard disk partition, typically on a file server. Images are archived or "stages" onto the CD Stage Area and, once it becomes full, CD-Rom disks are made from the partition as an image backup. The contents of the CD Stage Drive are then moved to a permanent location such as a Large Disk Partition or Snap Server.
+</p>
 ----

@@ Line 5: / Line 5: @@
 ''A Cartridge is a permanent storage device for images. Typically, these are magnetic disks or optical disk cartridges. Refer to Chapter 1 for information on setting up cartridges.''
 ----
@@ Line 33: / Line 31: @@
 # Remove baskets that you wish to exclude from the archive using the '''Remove Basket button'''.
 # Review the statistics shown in the middle of the screen, to make sure enough space is available for the images to be archived.
-# The''' Delete Images after Archive''' check box should be checked if you want the original images to be removed from the hard disk after they have been placed onto permanent storage.
+# The''' Delete Images after Archive''' check box should be checked if you want the original images to be removed from the hard disk after they have been placed onto permanent storage.<br />''If you do not check the Delete Images after Archive box, it is your responsibility to 'clean up' archived images. You can use the File Manager or the DOS Delete command to do this.''<br />
 # The '''Save Data for Archived Images to Cartridge''' check box will cause the system to save tab-delimited files of archived information. This is a great disaster recovery tool. The system saves aaadd_prime.txt (primary information) and aaadd_multi.txt (multi-entry information to the application folder on the cartridge. (aaa is the Application id and dd is the Database Id).
 # Press the '''Begin Archive button''' to start the archive process.
@@ Line 114: / Line 109: @@
 '''Disable Archive Logging''' - check this box to disable all logging.
 '''Append to archive logs''' - check this box to append to archive logs. Uncheck it to overwrite archive logs from previous jobs. It is recommended that you uncheck this box except when debugging problems.
 '''Turn on Debug log file''' - check this box to create an archive.dbg log file of detail activity. This is useful when debugging set up problems.
 '''Use Dated Log''' - check this box to create dated log files. Normally log files are named autoarchauto1.log (where 1 is the archive set number). With this option the log file is named HFARCHIVE32_YYYYMMDD_Auto1.log (where YYYYMMDD is year, month, and day, and 1 is the archive set number).
 '''Path to backup dated archive log files''' - if the Use Dated Log box is checked, enter the path to store these files. You must create the folder.
@@ Line 133: / Line 132: @@
 '''Destination tab '''- this tab is used to configure the destination cartridges and drives for the auto archive. The '''Use Defaults''' button usually can configure this screen properly.
-'''Cart Name Mask''' - this field defines how new cartridges are named. Use the %appl% to substitute the Application ID and %doctype% to substitute the Document Type. Also, use \# to designate the cartridge number, including as many digit placeholders as the maximum cartridge number will be. For example, if your Application ID was XXX and your Document Type ID was TP and the mask was %appl%%doctype%\#\#\#, then the first cartridge created would be named XXXTP001. Cartridges are limited to 8 characters so your cartridge mask should not exceed 8 characters.
+'''Cart Name Mask''' - this field defines how new cartridges are named. Use the %appl% to substitute the Application ID and %doctype% to substitute the Document Type. Also, use # to designate the cartridge number, including as many digit placeholders as the maximum cartridge number will be. For example, if your Application ID was XXX and your Document Type ID was TP and the mask was %appl%%doctype%###, then the first cartridge created would be named XXXTP001. Cartridges are limited to 8 characters so your cartridge mask should not exceed 8 characters.
-'''Cart Prefix '''- defines the cartridge prefix to include when creating new cartridges. You do not need to include the cartridge name prefix, it will automatically be included.
+'''Cart Prefix'''- defines the cartridge prefix to include when creating new cartridges. You do not need to include the cartridge name prefix, it will automatically be included.
-'''Cart Description''' - defines the cartridge description to use when creating a new cartridge. Again, you can use the %appl%, %doctype% and \#\#\# substitution values.
+'''Cart Description''' - defines the cartridge description to use when creating a new cartridge. Again, you can use the %appl%, %doctype% and ### substitution values.
-'''Size limit (in MB) '''- defines the size limit in megabytes for new cartridges. When the files on the cartridge reach this size, then the cartridge is considered full and the system rotates to a new cartridge.
+'''Size limit (in MB)'''- defines the size limit in megabytes for new cartridges. When the files on the cartridge reach this size, then the cartridge is considered full and the system rotates to a new cartridge.
 '''Cart type''' - defined the cartridge type to use for new cartridges. This should match the drive type used when the Archive Drive was created (Configure-Drives).
-'''Drive '''- select the drive to archive to from the list of drives provided. These drives are defined using the Configure-Drive menu.
+'''Drive'''- select the drive to archive to from the list of drives provided. These drives are defined using the Configure-Drive menu.
 '''Overflow Drive''' - should the drive configured in the Drive box become full, then auto archive will begin using this drive to archive to, if it is defined.
@@ Line 155: / Line 154: @@
 '''Alerts tab''' - this tab is used to set up e-mail alerts of the Auto Archive activity to selected users. Enter the SMTP Server Address or Server Name in the SMTP Server box then enter the e-mail addresses to which the message should be sent. This feature requires HALSMTP.EXE, halFILE's SMTP e-mail program.
-''It is recommended that documents for different databases be archived to different sets of cartridges. To do this you should set up an archive set for each database and name the cartridges in a way that the database is identified. One good method is to use the database id as part of the cartridge mask. So, if you have an application id of HAL and two databases with database ids of DD and TP then the first auto archive set could be set up to archive documents for application HAL, database DD to cartridges using the cartridge mask DD\#\#\#\#\#. The first cartridge is named DD00001. Then a second archive set would be set up to archive documents for application HAL, database TP to cartridges using the cartridge mask of TP\#\#\#\#\#. The first cartridge is then named TP00001.''
+''It is recommended that documents for different databases be archived to different sets of cartridges. To do this you should set up an archive set for each database and name the cartridges in a way that the database is identified. One good method is to use the database id as part of the cartridge mask. So, if you have an application id of HAL and two databases with database ids of DD and TP then the first auto archive set could be set up to archive documents for application HAL, database DD to cartridges using the cartridge mask DD#####. The first cartridge is named DD00001. Then a second archive set would be set up to archive documents for application HAL, database TP to cartridges using the cartridge mask of TP\#\#\#\#\#. The first cartridge is then named TP00001.''
 ===Running Auto Archive Interactively===