What is the Notes Install Cleanup Executable (NICE) tool and how is it used?
You can use the Notes Install Cleanup Executable (NICE) tool to clean up a failed install, failed uninstall or failed upgrade. You can also use the tool to uninstall an existing version of Notes, and clean up extraneous files, before performing an upgrade install. The tool is available for Lotus Notes 6.x and higher installations on supported Windows platforms only and must be run by an administrator.
|Where to find nice.exe|
The Notes Install Cleanup Executable tool (nice.exe) tool is available for download from the IBM Support FTP site (direct download link provided below).
NOTE: The .zip file linked above contains the 9.0.1 version of nice.exe, and it is backwards compatible. You can also find nice.exe in the Utility subdirectory of the Notes install kit.
|How it works|
The tool removes various files and settings, including registry setting values, program files, and Notes user data files. It obtains the location of applicable files and folders by searching the registry for settings that contain a "xpdInstallLocation" or "XPD_INSTALL_LOCATION" value, such as the following:
The tool checks to see whether Notes processes and services are running.
If NICE detects certain processes, you are instructed to shut down Notes. NICE does not close
these processes for you. The process list includes the following:
If NICE detects certain services, it will stop them. The service list includes the following:
Lotus Notes Diagnostics
Multi-user Cleanup Service
Lotus Notes Single Logon
Lotus Notes Smart Upgrade Service
NICE then removes the following items:
-- Shared DLL files based on the HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\SharedDlls registry setting
-- Notes workspace directory (for 8.x and higher) -- User's Data Directory/workspace
-- Program files (if the Remove all program files check box or command line option is enabled) -- All "\Program Files\IBM\Lotus\Notes" directory contents are removed except the \Program Files\IBM\Lotus\Notes\Data subdirectory.
Note: The above is true only if Remove Data Files is not enabled.
-- Desktop shortcuts -- Notes, Domino Designer, Domino Administrator, and embedded Lotus Symphony desktop shortcuts are removed, as are applicable Start > Programs Shortcuts items.
-- Notes data files (if the Remove all data files check box or command line option is enabled) -- The Notes data directory, as specified in the registry, is deleted.
Note: Prior to running the NICE tool consider backing up your Notes client . For details, see "Backing up and restoring Notes client data" in the Notes and Domino wiki.
|When to use NICE|
Consider running the NICE tool in the following situations:
-- Clean install -- Remove the existing Notes installation, and clean the registry, to prepare for a clean install.
-- Failed install -- Detect the install version from the registry and clean up registry settings and files on the system to prepare for a clean install of the same release.
-- Failed upgrade -- Detect the install version from the registry and clean up registry settings and files on the system to prepare for a clean install or the upgrade release.
-- Failed uninstall -- Detect the version from the registry and clean up registry settings and files on the system to prepare for a clean install.
For all situations, the following occurs:
-- If a Notes version is not detected in the registry but files exist in the default location , you are prompted to remove those files from disk. For example, if there is no entry for Notes in the Add/Remove Programs dialog, NICE detects whether there is a key in registry HKEY_LOCAL_MACHINE\SOFTWARE\Lotus\Notes, gets the PROGDIR and DATADIR information from the registry, and does the deletion. If there is no key in HKEY_LOCAL_MACHINE\SOFTWARE\Lotus\Notes, NICE does nothing.
-- If there is no Add/Remove Programs entry for Notes, but there are registry keys in either HKCU\Software\Lotus\Notes\Installer or HKLM\Software\Lotus\Notes, you can remove those registry settings. For example, if there is no Add/Remove Programs entry for Notes, NICE gets the PROGDIR and DATADIR information from HKLM\Software\Lotus\Notes and continues to remove program files, remove shortcuts, and clean the registry.
|Running the tool|
Once you understand exactly which files and settings the tool will remove, run the Notes Install Cleanup Utility (NICE) tool as follows:
Note: Consider backing up the user's files before running the tool. See "Backing up and restoring Notes client data" in the Lotus Notes and Domino wiki for information on file backup.
1. Log in to the Windows operating system as an administrative user and ensure that Notes is not running.
2. Locate and run the NICE tool; double-click the nice.exe executable from the Notes install kit's Utility subdirectory or run nice.exe in a command line.
The tool checks for an existing Notes installation, informs you what version is installed, and enables you to specify removal options.
2. Optionally enable Remove all program files to remove applicable files and folder in the \Program Files\IBM\Lotus\Notes directory.
Note: All "\Program Files\IBM\Lotus\Notes" directory contents are removed except the \Program Files\IBM\Lotus\Notes\Data subdirectory.
3. Optionally enable Remove all data files to remove the user's data directory, as specified in the registry.
Note: The Remove all data files check box is disabled when Notes is installed in multi user mode.
4. Click Remove to delete the files impacted by the above options.
Note: If neither option is enabled, the tool only removes the registry entries and stops services; then NICE leaves all the files on disk..
5. Respond to any confirmation prompts.
6. A progress bar indicates the progress of the cleanup process. When cleanup is complete, the NICE user interface closes.
|Silent & Command Line Options|
NICE can also be run silently and/or by using the command line. See below for the options:
Nice.exe [-h | -?] [-rp] [-rd] [-wipe] (/qn/qn+/qb/qb+)
|-h | -?||show the recommended usage options for NICE|
|-rp||Remove program files|
|-rd||Remove Data files (NICE will remove Data fiiles ONLY if installed in Single-user mode)|
|-wipe||This option will enable NICE to do a Notes registry clean up even if no Notes instances are found in the registry. If used without any of the /q options, the UI will be launched and
Remove button will be enabled
|/q options, if specified, will launch NICE only in cmd line mode|
|/qb||launch NICE in silent mode showing a limited progress bar|
|/qb+||launch NICE in silent mode showing a limited progress bar and show a dialog at the end
of completion with an OK button.
|/qn||launch NICE in completely silent mode without any progress bar|
|/qn+||launch NICE in completely silent mode without any progress bar but show a dialog at
the end of completion with an OK button