How to install and run the EmpScan.exe utility for NuGenesis SDMS - WKB97938

OBJECTIVE or GOAL

Install and run the EmpScan.exe utility for NuGenesis SDMS.

The tool/utility was created by Waters as a response to CRI-1719, which provided the ability to install and run the tool/utility on the NuGenesis SDMS database.  The tool/utility scans a NuGenesis SDMS database for incomplete archived Empower projects to identify projects that were not successfully archived.

ENVIRONMENT

• NuGenesis 9 SDMS
• NuGenesis 8 SDMS

PROCEDURE

Prerequisites

• SDMS .NET SDK: SDK Runtime must be installed on the machine.
• Oracle Client: It is recommended that the utility be installed on a machine where SDMS Administrator has been installed. Ideally, the utility should be placed in the PM folder.

1. Copy the EmpScan.exe file to the same folder as the SDMS Administrator program:
   • NuGenesis 9: Drive:\Program Files (x86)\Waters\NGSDMS\PM
   • NuGenesis 8: Drive:\Program Files (x86)\NuGenesis 8.0\PM

2. (For NuGenesis 8) Run NG80tkfu.exe before running EmpScan.exe - Run a command prompt as an administrator, navigate to the location of the NG80tkfu.exe in command prompt, and execute the following statement: NG80tkfu.exe on misctk <Return>
   
   (For NuGenesis 9) Run NGtkfu.exe before running EmpScan.exe - Run a command prompt as an administrator, navigate to the location of the NGtkfu.exe in command prompt, and execute the following statement: NGtkfu.exe on misctk <Return>

3. Run EmpScan.exe as an administrator.
4. In the tool, select a server name from the list, and enter the ngprojmgr username and password.
5. To scan all SDMS projects, select "ALL SDMS Projects" in the Project list; otherwise, select a project and view.
   • Note: the selected view must have, at a minimum, the ID column available, or else the tool will not be able to use the view. If the "Data Name" and "Archive (VPR) Product" columns are available, the tool will use those columns, but they are not required.
6. Click the Begin button to start scanning. If "ALL SDMS Projects" is selected, the tool will look through all projects (using the DefaultView in each project) in the selected server that are available to the user account; otherwise, the tool checks for access to the project and view, and whether the view is suitable for use with the tool. If the ID column is not available, EmpScan will display an error message and not scan the project. If the Data Name and/or Archive (VPR) Product columns are not available, EmpScan will warn the user about the missing columns and ask the user whether or not to continue scanning.
   • Required SDMS privileges if ngprojmgr is not used:
     • Privileges to open each File Data project
     • Access to the DefaultView in each project
     • Access to the "Any Location" Restore Location in each project
7. EmpScan.exe will log its actions to the on-screen window and to a log file, status.txt, in the \PM folder. Errors that result in NuGenesis error codes (NGxxxxx) will pause the utility, so watch the program and click OK to these messages so that it can continue checking the DB records.

8. The utility can generate three logs (Process.log, Status.txt, and Bad.log). Initially, none of these logs exist and the utility will create them as needed. Process.log and Status.txt will be in the same folder as EmpScan.exe. The utility will create a "Bad" subfolder as needed. Any Empower project backup in SDMS that meets the "bad" criteria (see below) will be included in the bad.log in the \Bad subfolder.

ADDITIONAL INFORMATION

EmpScan.exe is not part of the standard NuGenesis product installation. It is a support tool developed to check for cases where SDMS archived an incomplete project export from Empower. Contact Waters Technical Support if you want a copy of this utility.

The tool looks for file records where the vendor/product is "Waters Corp." and "Empower-2 Projects" or "Empower-3 Projects".  It performs the following checks on the records:

1. Check for a file named backup.log in the archive group, and log an error if one is not found.
2. Download the backup.log file to a temp folder on disk and read through it for the text "Export completed successfully without warnings".  If that text is found, the tool reports "backup.log shows completed export".  If that text is NOT found, it will note the NGID of the SDMS record as having an incomplete export, and download backup.log to the \Bad subfolder. The backup.log file will be renamed with a timestamp, the project name, and NGID for the associated SDMS record.
   
   Troubleshooting
   1. If you receive a message in the logging area of the Empower Project Backup log Integrity Check Utility window that says:    
      "This method is reserved for future use":
      This indicates that the appropriate NG80tkfu / NGtkfu.exe file was not run. 
      Stop the scan, remove any log files created, and repeat the procedure above starting at step 2. 
      Clicking on Abort will stop the process fairly quickly. If restore work is going on, it will happen after that.
   2. The order in which Empower Projects are processed is not necessarily sequential. The NGID displayed in the status window may appear to count down toward 0001, but on reaching this it may well continue to process other records.