Installing InterSystems IRIS on Microsoft Windows

Windows User Accounts

When installing InterSystems IRIS, you must choose the Windows user account to run the InterSystems service, InterSystems IRIS Controller for <instance-name>. There are two options:

• The default SYSTEM account (Windows Local System account). This is used in Minimal security installations.

• A defined Windows user account.

Running the InterSystems service under the default SYSTEM account is appropriate for many installations, but in some cases can cause issues relating to file permissions and network security access. If you anticipate potential problems in these areas for an InterSystems IRIS instance—for example due to your network configuration or security arrangements—specify a Windows account for the InterSystems service that has the needed privileges and access, such as a domain administrator account.

For instructions on how to change the service account after installation, see Managing Access to the InterSystems IRIS Instance.

Choosing a Configuration Strategy

You can define an installation manifest that describes a specific InterSystems IRIS configuration and invoke it when executing the installation file. This is useful when considering automated deployment, as it reduces the need to adjust settings after the installation is complete.

For more information on installation manifests, see Creating and Using an Installation Manifest.

Installing Development or Server Components Only

If you wish, you can install only the components of InterSystems IRIS that are required on a development system or on a server system.

To perform a Development or Server installation, first complete the steps in the InterSystems IRIS Installation Procedure, then continue:

1. Select Development or Server in the Setup Type dialog box.

2. The Install Unicode Support dialog box lets you select either 8-bit or Unicode character support for your installation (the default depends on your operating system locale).

3. The Initial Security Settings dialog box lets you decide how restrictive you want the initial InterSystems security settings to be: Minimal, Normal, or Locked Down. For a detailed explanation of these security settings, see Initial InterSystems Security Settings.

   Minimal is only available for InterSystems IRIS installations. If you choose Minimal, skip to the Ready to Install step.

   Important:

   If you select Minimal for your initial security setting but InterSystems IRIS requires network access to shared drives and printers, you must manually change the Windows user account under which to run the InterSystems service to one that has the desired access privileges. For instructions on how to do so, see Managing Access to the InterSystems IRIS Instance.

4. The Enter Credentials for InterSystems Service dialog lets you choose the credentials under which the Windows InterSystems service runs.

   The default is the local default SYSTEM account. You can instead specify a defined (existing) Windows user account and password; if you do, the installer verifies that:

   • the account exists on the domain.

   • the password is correct.

   Note:

   The default SYSTEM account is not always appropriate, and may cause issues relating to file permissions and network security access. Also, if you are using Kerberos, you must enter a defined account that you have set up to run the InterSystems service. To decide what account should run the Windows InterSystems Service, review the Windows User Accounts section of this chapter.

5. The InterSystems IRIS Users configuration dialog let you enter the initial password for the predefined InterSystems IRIS user accounts listed in the dialog box. The password must meet the criteria described in the Initial User Security Settings table. After clicking Next, the installer prompts you for the initial password for the CSPSystem predefined account.

   If you specified a Windows account in the previous step, the installation creates a “privileged user account” with the same name as the Windows account to grant that user access to services necessary to administer InterSystems IRIS. For more details on all these predefined accounts, see Predefined User Accounts.

6. The Ready to Install dialog box lets you review the installation name, type, and installation directory, as well as the license key status.

   You can also click the License button to select an InterSystems IRIS license key. If the key is valid, the license is automatically activated and the license key is copied to the instance’s install-dir/mgr directory as iris.key during installation, and no further activation procedure is required. If you do not select a key, you can activate your InterSystems IRIS license key following installation. See Activating a License Key in the “Managing InterSystems IRIS Licensing” chapter of the System Administration Guide for information about licenses, license keys and activation.

   Click Install to continue. Setup installs InterSystems IRIS in the selected directory.

7. The InterSystems IRIS Installation Completed dialog box indicates the installation has completed successfully. Choose whether you want to see the Getting Started page and click Finish.

By default, the system starts automatically after installation is complete and the InterSystems IRIS launcher icon appears in the system tray area of the Windows tool bar. Click the launcher to bring up the InterSystems IRIS menu. In addition, there is an InterSystems IRIS item on the Windows Programs menu.

Continue to the Post-Installation Tasks section to complete the installation process.

Installing Client Components Only

If you wish, you can install only those parts of InterSystems IRIS that are required on a client machine.

To perform a client installation, first complete the steps in the InterSystems IRIS Installation Procedure, then continue:

1. Select Client in the Setup Type dialog box and click Next.

2. The Ready to Install dialog box lets you review the installation name, type, and destination directory for the software files.

   Click Install to continue. Setup installs InterSystems IRIS in the selected directory.

3. The InterSystems IRIS Installation Completed dialog box indicates the installation has completed successfully. Click Finish.

After InterSystems IRIS is installed on a client, the InterSystems IRIS launcher icon appears in the system tray area of the Windows tool bar; it appears dimmed because there is no InterSystems IRIS server running.

Continue to the Post-Installation Tasks section to complete the installation process.

Installing the Web Gateway Only

If you wish, you can install only those parts of InterSystems IRIS that are required for the Web Gateway.

To perform a Web Gateway installation, first complete the steps in the InterSystems IRIS Installation Procedure, then continue:

1. Select Web Server in the Setup Type dialog box and click Next.

2. The Ready to Install dialog box lets you review the installation name, type, and destination directory for the software files.

   Click Install to continue. Setup installs InterSystems IRIS in the selected directory.

3. The InterSystems IRIS Installation Completed dialog box indicates the installation has completed successfully. Click Finish.

If a web server is running, a dialog box asks if you want to restart the web server. If you click Yes, the installation procedure restarts the web server. If you click No, the procedure does not restart the web server, in which case it does not start until you restart it manually or restart the system.

If the installer detects an Internet Information Services (IIS) web server installed on the system, it configures the web server for the Web Gateway. The installer also displays a check box for IIS; if you select this, Web Gateway IIS modules are installed in C:\InetPub\CSPGateway.

The Web Gateway configures the following application paths pointing to the server configured for the instance:

• /

• /csp

• /<instancename> (by default, /IRIS)

You can change the configurations manually after installation from the Web Gateway application; for information, see the Web Gateway Guide.

Continue to the Post-Installation Tasks section to complete the installation process.

Performing a Custom Installation

The InterSystems IRIS installation program allows you to select certain InterSystems IRIS components to install on the system. For example, you may want to install only the Web Gateway. Keep in mind that some selections require that you also install other components.

To perform a custom InterSystems IRIS installation, first complete the steps in the InterSystems IRIS Installation Procedure, then continue:

1. Select Custom in the Setup Type dialog box.

2. In the Custom Setup dialog box, select the components you want to install. Some of the components include sub-items; to view these, select the +icon.

   Select a component to see a short description, or view a list of available components in the Components Installed by Setup Type table.

   Note:

   You can remove previously-installed components by selecting the X menu item for any component group or component.

3. Optionally, click Space to ensure that there is enough space on the disk for the selected components.

4. The Install Unicode Support dialog box lets you select either 8-bit or Unicode character support for your installation (the default depends on your operating system locale).

5. The Enter Port Numbers dialog box lets you change the port numbers assigned by InterSystems IRIS. Review the Port Numbers section in the “Preparing to Install InterSystems IRIS” chapter of this book for more information.

6. The Initial Security Settings dialog box lets you decide how restrictive you want the initial InterSystems security settings to be: Minimal, Normal, or Locked Down. For a detailed explanation of these security settings, see Initial InterSystems Security Settings.

   Minimal is only available for InterSystems IRIS installations. If you choose Minimal, skip to the Ready to Install step.

   Important:

   If you select Minimal for your initial security setting, but InterSystems IRIS requires network access to shared drives and printers, you must manually change the Windows user account under which to run the InterSystems service, choosing an existing account or creating a new account that has local administrator privileges on the server machine. For instructions on how to do so, see Managing Access to the InterSystems IRIS Instance.

7. The Enter Credentials for InterSystems Service dialog lets you choose the credentials under which the Windows InterSystems service runs.

   The default is the local default SYSTEM account. You can instead specify a defined (existing) Windows user account and password; if you do, the installer verifies that:

   • the account exists on the domain.

   • the password is correct.

   Note:

   The default SYSTEM account is not always appropriate, and may cause issues relating to file permissions and network security access. Also, if you are using Kerberos, you must enter a defined account that you have set up to run the InterSystems service. To decide what account should run the Windows InterSystems Service, review the Windows User Accounts section of this chapter.

8. The InterSystems IRIS Users configuration dialog let you enter the initial password for the predefined InterSystems IRIS user accounts listed in the dialog box. The password must meet the criteria described in the Initial User Security Settings table. After clicking Next, the installer prompts you for the initial password for the CSPSystem predefined account.

   If you specified a Windows account in the previous step, the installation creates a “privileged user account” with the same name as the Windows account to grant that user access to services necessary to administer InterSystems IRIS. For more details on all these predefined accounts, see Predefined User Accounts.

9. The Ready to Install dialog box lets you review the installation name, type, and installation directory, as well as the license key status.

   You can also click the License button to select an InterSystems IRIS license key. If the key is valid, the license is automatically activated and the license key is copied to the instance’s install-dir/mgr directory as iris.key during installation, and no further activation procedure is required. If you do not select a key, you can activate your InterSystems IRIS license key following installation. See Activating a License Key in the “Managing InterSystems IRIS Licensing” chapter of the System Administration Guide for information about licenses, license keys and activation.

   Click Install to continue. Setup installs InterSystems IRIS in the selected directory.

10. The InterSystems IRIS Installation Completed dialog box indicates the installation has completed successfully. Choose whether you want to see the Getting Started page and click Finish.

Continue to the Post-Installation Tasks section to complete the installation process.

Running an Unattended Installation

To launch unattended installation of a new instance of InterSystems IRIS, use the following command:

<path>\<installer>.exe /instance <instancename> /q{b|n} <properties> 

You must specify:

For example, to install an instance of InterSystems IRIS with the default instance name in an installation directory named C:\InterSystems\MyIris on a 64–bit Windows system, specify the following:

C:\downloads\IRIS-<version_number>-win_x64.exe /qn INSTALLDIR=C:\InterSystems\MyIris

To install an instance of InterSystems IRIS with the instance name IrisA, specify:

C:\downloads\IRIS-<version_number>-win_x64.exe /instance IrisA /qn 

You can custom install a subset of features using the ADDLOCAL property; see ADDLOCAL in the Command-Line Properties table for more information. As an example, to install only the launcher on a 64–bit Windows system (accepting the default instance name and directory), specify:

C:\downloads\IRIS-<version_number>-win_x64.exe /qn ADDLOCAL=cube

When the installation is finished, continue to the Post-Installation Tasks section of this chapter.

Running an 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-<version_number>-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-<version_number>-win_x64.exe /instance IRISB /qn REINSTALL=studio

Running an 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-<version_number>-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 (https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2003/cc759262(v=ws.10)).

Command Line Reference

The Command-Line Properties table describes the InterSystems IRIS-specific unattended install properties that you can modify via the command-line interface. The property name must be uppercase, but the arguments are not case-sensitive; each property must be separated by one or more spaces, and properties can be specified in any order as PROPERTYNAME=argument. For example:

... ISCSTARTIRIS=0 WEBSERVERPORT=57779 INITIALSECURITY=Normal

The Custom-Installable Features table lists component group/component names and the associated featurename for each. You can specify “ALL” (to specify all available features) or a comma-separated list (with no spaces) of feature names (to specify individual features).

To specify components in ADDLOCAL, REINSTALL, and REMOVE properties, specify the featurename of a component group, followed by the featurename of each specific component from that group that you want installed. For example, to install only the USER database include the following in the command line:

ADDLOCAL=server,server_user

When specifying a component group, you must also specify at least one associated component; if no components are listed with a component group, the component group is ignored and no components are installed. For example, if you specify:

ADDLOCAL=documentation,documentation_pdf,server,development,callin

the server component group is ignored and no server components are installed. (This requirement does not apply to the studio and cube groups, as they have no components.)

Configuring Multiple InterSystems IRIS Instances

You can install and simultaneously run multiple instances on a single Windows machine. To do so, install InterSystems IRIS as for a single installation, giving each instance a unique name, a unique installation directory, and a unique port number.

Please refer to the Multiple InterSystems IRIS Instances section of the System Administration Guide for more detailed information.

Changing the InterSystems IRIS Language

When you install InterSystems IRIS, all supported language-specific utility DLLs are installed in the install-dir\bin directory. Each DLL contains localized strings and messages.

The format of the name of the DLL is UTILaaa.DLL, where aaa is a 3-letter code that signifies the following languages:

For information about changing the locale of an InterSystems IRIS installation, see Using the NLS Settings Page of the Management Portal in the “Configuring InterSystems IRIS” chapter of the InterSystems IRIS System Administration Guide.

Reinstalling or Uninstalling InterSystems IRIS

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 InterSystems IRIS Installation Procedure 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.

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

The Write-cache Buffer

Certain InterSystems IRIS features utilize Windows write-cache buffer flushing, which is enabled by default. To verify this option is correctly enabled and InterSystems IRIS receives the full benefit of these features:

1. Open the Device Manager from the Control Panel.

2. Select the storage device from the Disk Drives section.

3. Click on the Policies tab.

4. Ensure that Turn off Windows write-cache buffer flushing on this device is not selected.