Performing integrity checks on document stores

The integrity check can fix reported incorrect file size.

The method depends on whether or not there is a backup path specified in the field Restored Backup Folder For Store:

• If there is no backup folder specified, by updating the dataset's last known file size to match the size of the item as it actually is in the store
• If there is a backup folder specified, Content Manager looks in the specified backup folder for the document.

  If Content Manager finds it and the document is the expected size, Content Manager restores it to the document store and changes the references to point to the restored item.

  If Content Manager does not find the document, it will take no action.

The integrity check can fix missing files if you choose to correct errors.

The method depends on whether or not there is a backup path specified in the field Restored Backup Folder For Store:

• If there is no backup folder specified, Content Manager creates a new item to indicates that the item is no longer available.
• If there is a backup folder specified, Content Manager looks in the specified backup folder for the document. If Content Manager finds it, Content Manager restores it to the document store and changes the references to point to the restored item.

  If Content Manager does not find it, it will remain Missing.

1. On the Administration menu, click Document Stores.

   The Document Stores dialogue box appears.

2. Right-click the store to run an integrity check on and click Integrity Check.

   TIP:

   • Run the integrity check first without any options selected.

     Content Manager will return reports about changes and missing data, which will give you an opportunity to restore these from backup, if needed.

     Details of any errors are recorded in the store integrity log file in the Content Manager folder.

   • Then run the integrity check again with the option Correct any errors that are encountered selected.

   • Treat any pending asynchronous transfers as missing documents - if an asynchronous transfer of a document is still pending, then treating the pending document as Missing ensures that the latest revision of a document is not overwritten
   • Perform a detailed check - if a Document Store Integrity check is run with this option unchecked the integrity check will check for the existence of the document but will not run more extensive tests that require a download of the document. If running a Document Store Integrity check on a regular basis running it is recommended to not run detailed checks as it will run far quicker than running detailed checks.
     • Generate a hash for records that don't have a stored hash - for records without a hash, generate and store a hash for the currently stored document.
   • Correct any errors that are encountered - automatically corrects errors detected in document store processing, including recalculating a record hash if it's incorrect.
     
     NOTE:
     if you have specified a backup store and the backup store contains a version of the document that has a correct hash, then it will be copy this document into the main store and change over the reference.
     • Confirm errors before correcting - select to display a confirmation message for each error
     • Document Store to place any corrections in - the store that will receive the corrected files
     • Restored Backup Folder For Store - the full store backup folder path that Content Manager will use to restore missing files from or to replace files with incorrect size.

       TIP: The backup folder must have the same file and folder structure as the document store you are restoring to.

     • Add Missing File from Backup Store Folder - only available if errors are being corrected as a part of the check and a Restored Backup Folder has been nominated - select this option to restore any documents that are missing from a backup of the Document Store.
     • Restore File with incorrect Size from Backup Store Folder - only available if errors are being corrected as a part of the check and a Restored Backup Folder has been nominated - select this option to restore any documents that have incorrect sizes from a backup of the Document Store.
   • Processing log file - select the log file that will record the transfer process
   • Only log errors - select this option to only save the errors to the log file
   • Processing buffer size - set the processing batch buffer size. After each batch is processed details of the last item in the batch are saved, along side the integrity check settings, to the registry. If the integrity check does not finish successfully when you run it again, the restart settings from the registry, together with intermediate processing data required to execute a restart, are read and a message is displayed confirming if the user wants to restart the failed run. The processing will start from the item immediately after the last successfully processed item.
   • Run in multi-threaded mode - select this option to run the integrity check as a multi-threaded process.
     • Number of threads - set the number of threads.
     • Thread processing timeout (seconds) - set the timeout limit for each thread. If a thread fails to make any progress in it's work queue within this time frame, this setting will cut in.
3. Click OK.

Once the check is completed, to view the generated log file, click View Log on the displayed Run Integrity Check dialogue.