Skip to main content

Upgrading or Modifying Windows

This section describes the procedure to upgrade a single instance of InterSystems IRIS, InterSystems IRIS for Health, or HealthShare HealthConnect. Before proceeding, be sure to perform the tasks in the Before Upgrading section of this chapter. If you are upgrading a mirror or ECP configuration, also review the information in the Upgrading a Mirror and Upgrading ECP Configurations sections of this chapter.

If you are using a manifest as part of your upgrade process, see the instructions in Creating and Using an Installation Manifest before performing the standard installation steps.


Prior to beginning an upgrade of an instance, it is essential that the instance be shut down cleanly. To verify that the shutdown was clean, examine the messages.log file after the shutdown finishes. If the log contains entries similar to the following, then the shutdown was clean:

05/03/19-14:24:13:234 (5204) 0 Journal restore not required at next startup
05/03/19-14:24:13:234 (5204) 0 Transaction rollback not required at next startup

If these entries are not present, the instance did not shut down cleanly. Please contact the InterSystems Worldwide Response CenterOpens in a new tab before proceeding with the upgrade.

Windows Upgrade Procedure

The installer provides all the functionality required to upgrade to a new version of InterSystems IRIS. To instead perform a silent upgrade, which is necessary when using a manifest, review the information in Unattended Upgrade or Reinstall.

To perform the upgrade:

  1. Double-click the installer file, for example, IRIS-win_x64.exe.

  2. The installer displays a list of all existing InterSystems IRIS instances on the host. Select the name of the instance you want to upgrade and click OK.

  3. When prompted for an InterSystems IRIS license key, click License and browse for the new iris.key file. If the installer detects a new key file in the install-dir/mgr directory, it proceeds without prompting you for the license key.

  4. If a local Microsoft Internet Information Services (IIS) web server is detected, the Local Web Server dialog box lets you select whether or not the installer should automatically configure the web server for this instance. If you choose to not have the installer configure your web server automatically, you will have to configure it manually after the installation finishes. If a local web server is not detected, the dialog box instead asks if you want to Abort the installation or Continue the installation without Web Gateway. If you choose to continue anyway, you will have to configure the web server manually after the installation finishes.


    InterSystems recommends using the Microsoft IIS web server because it can be automatically configured during the upgrade process. Make sure it is installed and running before beginning the upgrade process. In most cases, it is not necessary to manually configure the IIS web server.

  5. After the installer validates the license key, click Upgrade.


    Do not interrupt the installation while it is in progress. If the upgrade fails with any error messages, correct the issues and restart the upgrade installation.

  6. After the upgrade is completed, click Finish.

  7. Examine messages.log, iboot.log, and ensinstall.log in the install-dir\mgr directory for any errors. If any fatal error is found, correct the error, and then run the installer again.


If your operating system is configured to use large memory pages, check the startup messages to make sure shared memory is being allocated in accordance with these settings. If you see a message similar to the following, reboot your server to avoid an out-of-memory situation.

Failed to allocate 592MB shared memory using large pages.  Switching to small pages.

Reinstall or Uninstall

By running setup and selecting an InterSystems IRIS instance of the same version as the installer, or by selecting Programs and Features from Windows Control Panel and selecting an InterSystems IRIS instance, you can make changes to or uninstall the instance.

When you run setup as described in Windows Attended Installation and select an InterSystems IRIS instance of the same version as the installer in the Select Instance box, or select an instance in Programs and Features and use the Change or Repair buttons, the Updating Instance instancename dialog box displays.


When you select the Uninstall button in Programs and Features, the uninstall operation begins immediately.

Click Next to display the Modify, repair or remove the program dialog box, then select the appropriate option on this dialog to change, repair, or uninstall the instance.

  • Select Modify to display the Custom Setup dialog box described in Windows Custom Installation. Using this dialog box, you can select the component groups or components you want to add or remove. Components are described in the Components Installed by Setup Type table.

  • Select Repair to repair problems with the instance such as missing or corrupt files or registry entries.

  • Select Remove to uninstall the instance.


Use only the InterSystems IRIS installer or Windows Control Panel Programs and Features to uninstall InterSystems IRIS. Other uninstall programs are not supported and using them may cause unexpected results.

Unattended Upgrade or Reinstall

In addition to installing a new instance, the InterSystems IRIS installer can be called on an existing installed instance. To do so, you must use the /instance flag to specify the name of the target existing instance. The action the installer takes depends on the version of the installation file compared to the version of the instance, as follows:

  • If the installation file is the same version as the target installed instance, the installer reinstalls (repairs) the instance.

  • If the installation file is a later version than the target installed instance, the installer upgrades the instance to the new version.

For example, to run an unattended upgrade of an installed instance IRISB that is an earlier version than the installation file, use the following:

C:\downloads\IRIS-2019.1.0.516.0-win_x64.exe /instance IRISB /qn

You can reinstall one or more specific features, as listed in the Custom-Installable Features table, by specifying the target instance and using the REINSTALL property (see the Command-Line Properties table). For example, to reinstall Studio for the installed instance IRISB, you can use the following command (assuming the installation file and IRISB are the same version):

C:\downloads\IRIS-2018.1.0.508.0-win_x64.exe /instance IRISB /qn REINSTALL=studio

Unattended Removal

To launch an unattended removal, specify the instance to uninstall and the REMOVE=ALL property, as follows:

<path>\<installer>.exe /instance <instancename> /q[b|n] REMOVE=ALL 

You can also use the REMOVE property to remove specific features, as described in the Custom-Installable Features table. For example, to remove the Apache 2.0 Web Gateway from instance IrisC, use the command:

C:\downloads\IRIS-2018.1.0.508.0-win_x64.exe /instance IrisC /qn REMOVE=cspgateway,cspapache20

Special Consideration

If you do not have access to the original installation package, you can run uninstall in unattended mode by using the Windows® Installer command-line application (msiexec) and information in the Registry, as follows:

msiexec /x {<product_guid>} /qn /l <logfile>

where <product_guid> is the ProductCode property value of the version you installed.

You can obtain the ProductCode property value from the following Registry location:

Processor Type Registry Location
32–bit HKEY_LOCAL_MACHINE\SOFTWARE\Intersystems\IRIS\Configurations\<instance>
64–bit HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Intersystems\IRIS\Configurations\<instance>

where <instance> is the name of the InterSystems IRIS instance you want to uninstall in unattended mode. The ProductCode property value is displayed in a row similar to:

ProductCode     REG_SZ   {80E3F658-2D74-4A81-92AD-FD16CD226154}

You can also use any of the properties in the Command-Line Properties table with msiexec. For information about msiexec, see the Microsoft msiexec (command-line options)Opens in a new tab TechNet article (

FeedbackOpens in a new tab