Back to list
Oct 19 2018

T43-2017: Usage of UpdateHistoryDescription.bat and When to Run It.

Workbook

The UpdateHistoryDescription.bat file is used to move data from the Description field to the FullDescription field in the AuditHistory table. The transfer of data is only need when moving from pre-6.9 SP5 to a 6.9 SP5+ version of Workbook. This transfer of data provides increase performance for the History of experiments. Currently, if the UpdateHistoryDescription.bat file is run after objects are inserted into the database, the descriptions in the new audit history records are lost. Data loss is not acceptable and in its current form possible. The UpdateHistoryDescription.bat file will affect the AuditHistory table in each of the versioned repositories, the Site repository, and the Home Repository.
 
Remember altering user, groups, permissions, folder, experiments, or any vault object before execution of the UpdateHistoryDescription.bat and will cause data loss.
UpdateHistoryDescription.bat remakes the audithistory tables moving the Description field to the FullDescription, but the Description records of newly created objects are null as the description information is only entered into the FullDescription field. We then delete the original AuditHistory tables and the original FullDescription data is now lost.
 
Resolution:
An interim file release corrects this issue, “Workbook 2017 R2 Interim File Release 1”. The UpdateHistoryDescription.sql file needs to be replaced in the C:\BIOVIA\Workbook\DatabaseScripts folder or wherever you extracted the installation files during the installation of Workbook.
We strongly recommend that the UpdateHistoryDescription.bat is executed as a post-installation task during your upgrade to BIOVIA Workbook 2017 R2 or later.
The best time to do this update for 2017 R2 is directly after it Vault Installation and before IQ.
The steps required to run the UpdateHistoryDescription.bat.

  • Backup the AuditHistory table in all the repository schema
  • Replace the UpdateHistoryDescription.sql file in C:\BIOVIA\Workbook\DatabaseScripts or wherever you extracted the installation files during the installation of Workbook.
  • Run the UpdateHistoryDescription.bat from the same folder.

      UpdateHistoryDescription.bat > UpdateHistoryDescription.log

  • Check the UpdateHistoryDescription.log for errors, if any errors are found contact BIOVIA.Support.

 
This defect is in NBK-28265