IBM Support

Using the Notes Install Cleanup Executable (NICE) tool for Notes and ICAA

Technote (FAQ)


Question

What is the Notes Install Cleanup Executable (NICE) tool and how is it used?

Answer

You can use the Notes Install Cleanup Executable (NICE) tool to clean up a failed install, failed uninstall or failed upgrade of Notes and ICAA. You can also use the tool to uninstall an existing version of Notes and ICAA, and clean up extraneous files, before performing an upgrade install.

Where to find nice.exe

The Notes Install Cleanup Executable tool (nice.exe) tool is available for download from the IBM Support FTP site at the following link:
NOTE: The .zip file linked above contains the Notes 9.0.1 version of nice.exe that was updated to that was updated to work with ICAA 1.0.1.

Requirements

- Windows platforms only

- Must be run by an administrator

- Notes 6.x and higher (cloud or on-premises)

- ICAA 1.0.1 and higher (cloud or on-premises)


How NICE works for Notes

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:

HKEY_LOCAL_MACHINE\SOFTWARE\IBM\Lotus\Expeditor\[UpgradeCode]
HKEY_CURRENT_USER\SOFTWARE\IBM\Lotus\Expeditor\[UpgradeCode]
HKEY_USERS\.DEFAULT\Software\IBM\Lotus\Expeditor\[UpgradeCode]
HKEY_USERS\.DEFAULT\Software\IBM\Lotus\Expeditor\[TARGETUPGRADECODE1]
HKEY_USERS\.DEFAULT\Software\IBM\Lotus\Expeditor\[TARGETUPGRADECODE2]
HKEY_LOCAL_MACHINE\SOFTWARE\IBM\Lotus\Expeditor\[TARGETUPGRADECODE3]
HKEY_CURRENT_USER\SOFTWARE\IBM\Lotus\Expeditor\[TARGETUPGRADECODE3]
HKEY_USERS\.DEFAULT\Software\IBM\Lotus\Expeditor\[TARGETUPGRADECODE3]
HKEY_LOCAL_MACHINE\SOFTWARE\IBM\Lotus\Expeditor\[TARGETUPGRADECODE1]
HKEY_CURRENT_USER\SOFTWARE\IBM\Lotus\Expeditor\[TARGETUPGRADECODE1]
HKEY_LOCAL_MACHINE\SOFTWARE\IBM\Lotus\Expeditor\[TARGETUPGRADECODE2]
HKEY_CURRENT_USER\SOFTWARE\IBM\Lotus\Expeditor\[TARGETUPGRADECODE2]

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:

notes2.exe
ntaskldr.exe
notes.exe
nlnotes.exe
sametime75.exe
nminder.exe
soffice.bin
soffice.exe

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.

How NICE works for ICAA
The tool removes various files and settings, including registry setting values, program files, and ICAA user data files.  The tool checks to see whether ICAA processes and services are running.

If NICE detects certain services, it will stop them. The service list includes the following:
  • IBM Notes Diagnostics
  • Multi-user Cleanup Service
  • IBM Auto Update Service


NICE then removes the following items:

-- Shared DLL files based on the HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\SharedDlls registry setting

-- Program files (if the Remove all program files check box or command line option is enabled)  -- All "\Program Files\IBM\ICAA" directory contents are removed except the \Program Files\IBM\ICAA\Data subdirectory.

Note: The above is true only if Remove Data Files is not enabled.

-- Desktop shortcuts -- IBM Client Application Access shortcut is removed, as are applicable Start > Programs Shortcuts items.

-- ICAA data files (if  the Remove all data files check box or command line option is enabled) -- The ICAA data directory, as specified in the registry, if not empty, is deleted.

Note: Prior to running the NICE tool consider backing up your ICAA.

When to use NICE

Consider running the NICE tool in the following situations for Notes and ICAA:

-- 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 for Notes and ICAA

Notes

-- 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.



ICAA

-- If a ICAA 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 ICAA in the Add/Remove Programs dialog, NICE detects whether there is a key in registry HKEY_LOCAL_MACHINE\SOFTWARE\IBM\ICAA, gets the PROGDIR and DATADIR information from the registry, and does the deletion. If there is no key in HKEY_LOCAL_MACHINE\SOFTWARE\IBM\ICAA, NICE does nothing.

-- If there is no Add/Remove Programs entry for ICAA, but there are registry keys in either HKCU\Software\IBM\Notes\Installer or HKLM\Software\IBM\Notes, you can remove those registry settings. For example, if there is no Add/Remove Programs entry for ICAA, NICE gets the PROGDIR and DATADIR information from HKLM\Software\IBM\ICAA 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 or ICAA is not running.
2. Locate and run the NICE tool; double-click the nice.exe executable .
 

The tool checks for an existing Notes or ICAA installation, informs you what version is installed, and enables you to specify removal options. When ICAA coexists with a Notes client, you can choose which instance to remove.



2. Optionally enable Remove all program files to remove applicable files and folders in the \Program Files\IBM\Lotus\Notes directory for Notes, or \Program Files\IBM\ICAA directory for ICAA.

Note: 

-
All "\Program Files\IBM\Lotus\Notes" directory contents are removed except  the \Program Files\IBM\Lotus\Notes\Data subdirectory.

- All "\Program Files\IBM\ICAA" directory contents are removed except  the \Program Files\IBM\ICAA\Data subdirectory if it exists.


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 or ICAA 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+)
Nice will print the result of run to %TEMP%\Nice.status. If successful, the content of the file will be "OK". Otherwise, the content of file will be "FAILED"

-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)
-ri Remove ICAA instance if ICAA and Notes instances coexist
-rn Remove Notes instance if ICAA and Notes instances coexist
(When the -rn and -ri options both occur, only the later one will take effect. For example, using the command "Nice.exe -rn -ri", only ICAA instance will be removed)
-wipe This option will enable NICE to do a Notes or ICAA registry clean up even if no Notes or ICAAinstances 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

Related information

Featured documents for Lotus Notes Domino iNotes and No
How to rerun setup on a Notes 8.0 or 8.5 client
Single user to multi-user migration assistant tool

Cross reference information
Segment Product Component Platform Version Edition
Messaging Applications IBM Client Application Access

Document information

More support for: IBM Notes
Install/Setup

Software version: 6.5, 7.0, 8.0, 8.5, 9.0

Operating system(s): Windows

Reference #: 1459714

Modified date: 02 February 2017


Translate this page: