Caché Installation

Installing Caché

The installation procedure installs the required components for the selected setup type on the computer. To perform an installation follow this procedure:

1. Ensure that the installation kit is available on your computer or on a network.

2. Execute the installation file, for instance by double-clicking it in Windows Explorer or executing it on the command line as follows:

   C:\Users\Public\Downloads\cache-2016.2.0.626.0-win_x64.exe
   

   Note:

   By default, a newly installed Caché instance starts immediately after installation and the Caché launcher (cube) is placed in the system tray. To prevent Caché from starting, set the Windows Installer property ISCSTARTCACHE to 0; to prevent the launcher from being placed in the system tray, set ISCSTARTLAUNCHER to 0. You can do this using the setup.exe from the multifile installation kit on the command line, for example:

   C:\Users\Public\Downloads\setup.exe ISCSTARTCACHE=0 ISCSTARTLAUNCHER=0
   

   

   For a description of all Caché Windows installer properties, see Unattended Custom Installation.

3. If there are existing Caché instances installed on the system, the Select Instance dialog box lists their installation directories. Select New Instance to install a new Caché instance. (You can also select an existing instance to upgrade that instance.)

4. If you are installing a new instance of Caché on this computer, setup displays the License Agreement dialog box. Click I accept the terms in the license agreement to confirm that you accept the license agreement.

5. The Caché Instance Name dialog box lets you assign a name to the new instance you are installing. The default name is CACHE (or if other instances, exist CACHEn, where n is the number of Caché instances including this new one). Accept the default or enter another name, using alphanumeric characters only. Subsequent updates to this instance maintain the instance name you enter here.

6. The Destination Folder dialog box lets you select a destination directory for the Caché software for the new instance; the default location is C:\InterSystems\Cache (or Cachen when multiple instances exist).

   You can select or create a directory by clicking Change. If the specified directory does not exist, setup lets you create it.

   Important:

   Be sure to see Installation Directory in the “Preparing to Install” chapter for important information about choosing an installation directory.

7. The Setup Type dialog box lets you specify how you intend to use Caché. Review the Setup Type section in Preparing to Install Caché to decide which components of Caché you need.

The next steps of the installation procedure differ based on the Setup Type you choose. To finish installing Caché, follow the steps in the section that corresponds to your chosen Setup Type:

• Development — Installing Caché Development or Server Components Only

• Server — Installing Caché Development or Server Components Only

• Client — Performing a Caché Client Installation

• Web Server — Installing the Web Server (CSP) Gateway Only

• Custom — Performing a Caché Custom Installation

Installing Caché Development or Server Components Only

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

To perform a Development or Server installation:

1. Select Development or Server in the Setup Type dialog box, described in the Installing Caché procedure, and click Next.

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 Caché security settings to be. If you choose Minimal, the installation continues with the next step.

   Important:

   If you select Minimal for your initial security setting, but Caché requires network access to shared drives and printers, you must manually change the Windows user account under which to run the Caché service, choosing an existing account or creating a new account that has local administrator privileges on the server machine.

   If you select Normal or Locked Down, the installation includes the following steps:

   1. The Enter Credentials for Caché Service dialog lets you choose the credentials under which the Windows Caché service will run. The default is the local default SYSTEM account. You can also specify a defined (existing) Windows user account and password; when you do so, the installer verifies these credentials before proceeding. The installer also creates a Caché account with the same username, with the %All role for unrestricted access to the instance (the password for this account is provided on the next panel).

      Running the Windows Caché 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 a Caché instance, for example due to your network configuration or security arrangements, specify an account for the Windows Caché service that has the needed privileges and/or access, for example that of a domain administrator.

      To change the service account (in Windows 10): Navigate to Control Panel > Administrative Tools > Services. Next, locate the correct Caché service. Then, right-click to open the properties dialog of the correct instance. Finally, change the credentials on the Log On Tab and restart Caché.

      Important:

      If you are using Kerberos, you must configure a service account before installing Caché; see Preparing the Security Environment for Kerberos in the “Preparing to Install Caché” chapter for more information.

      Note:

      See Shared Memory Allocation on Windows for information about granting the Windows “Lock Pages in Memory” (SELockMemory) privilege when running Caché under credentials other than the local system account.

   2. The first panel of the Caché Users configuration dialog let you enter the initial password for the following predefined Caché user accounts _SYSTEM, Admin, and SuperUser, as well as the username you specified if you selected a defined Windows account as the service account on the previous panel. The second panel of the Caché Users configuration dialog lets you enter the initial password for the CSPSystem predefined account. For more details on these predefined users, see the Predefined User Accounts section of the “Users” chapter of the Caché Security Administration Guide.

   For a detailed explanation of these security settings, see Managing Windows User Access to the Caché Instance below, and the Initial Caché Security Settings section of the “Preparing to Install Caché” chapter of this guide.

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

   Click the License button to select a Caché license key. If the key is valid, the license is automatically activated, the License Key field on the Ready to Install dialog is updated to Valid, and the license key is copied to the instance’s manager directory (install-dir/mgr) as cache.key during installation; no further activation procedure is required. If you do not select a key, you can activate your InterSystems Caché license key following installation. See Activating a License Key in the “Managing Caché Licensing” chapter of the Caché System Administration Guide for information about licenses, license keys and activation.

   Click Install to continue. Setup installs Caché in the selected directory.

5. The InstallShield Wizard Complete dialog box indicates the installation has completed successfully. Choose whether you want to see the Getting Started page and click Finish.

The system starts automatically after installation is complete. The Caché Cube icon appears in the system tray area of the Windows tool bar. Click the cube to bring up the Caché menu. In addition, there is a Caché item on the Windows Programs menu.

Installing Caché Client Components Only

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

To perform a client installation:

1. Select Client in the Setup Type dialog box, described in the Installing Caché procedure, 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 Caché in the selected directory.

3. The InstallShield Wizard Complete dialog box indicates the installation has completed successfully. Click Finish.

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

Installing the Web Server (CSP) Gateway Only

If you wish, you can install only those parts of Caché that are required on a CSP Gateway machine.

To perform a CSP Gateway installation:

1. Select Web Server in the Setup Type dialog box, described in the Installing Caché procedure, 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 Caché in the selected directory.

3. The InstallShield Wizard Complete 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 CSP gateway. The installer also displays a checkbox for IIS; if you select this, CSP gateway IIS modules are installed in C:\InetPub\CSPGateway.

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

• /

• /csp

• /Cache (instance name)

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

Performing a Custom Caché Installation

The Caché installation program allows you to select certain Caché components to install on the computer. For example, you may want to install only the Web Server (CSP) Gateway. Keep in mind that some selections require that you also install other components.

To perform a custom Caché installation:

1. Select Custom in the Setup Type dialog box, described in the Installing Caché procedure, and click Next.

2. In the Custom Setup dialog box, select the components you want to install as described in the Components Installed by Setup Type table.

   Important:

   If you are custom-installing the Caché Database Engine (Caché Server) component group or any of its components, ActiveX Connectivity (included in the Caché Application Development component group) is a prerequisite.

   If you are custom-installing the Documentation component group or any of its components, the Caché Database Engine (Caché Server) component group is a prerequisite.

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

   Important:

   If you are installing Ensemble, you must select Unicode.

5. The Enter Port Numbers lets you change the port numbers assigned by Caché.

   Note:

   You cannot enter a port number greater than 65535 or less than 1. For information about setting port numbers, see Set Port Numbers in the “Using Multiple Instances of Caché” chapter of the Caché System Administration Guide.

   The following port numbers are valid for your Caché instance:

   • SuperServer Port Number — 1972 or the first available subsequent number equal to or higher than 56773; you can change the superserver port value after installation from the Memory and Startup page (System > Configuration > Memory and Startup).

   • WebServerPort number — 57772 or the first available subsequent number; you can change the WebServerPort values after installation from the Startup Settings page (System Administration > Configuration > Startup Settings).

6. The Initial Security Settings dialog box lets you decide how restrictive you want the initial Caché security settings to be. If you choose Minimal, the installation continues with the next step.

   Important:

   If you select Minimal for your initial security setting, but Caché requires network access to shared drives and printers, you must manually change the Windows user account under which to run the Caché service, choosing an existing account or creating a new account that has local administrator privileges on the server machine.

   If you select Normal or Locked Down, it displays Enter Credentials for Caché Service, where you can choose to run Caché service under:

   • The default SYSTEM account, which runs Caché as the Windows Local System account.

   • Defined Windows user account. The installation creates a Caché account with the %All role for the user who is installing Caché to grant that user access to services necessary to administer Caché. Enter and confirm the password for this account. The password must meet the criteria corresponding to the security setting.

     Important:

     If you are using Kerberos, you must enter a defined account that you have set up to run the Caché service. InterSystems recommends that you use a separate account specifically set up for this purpose.

   When you click Next, the installation verifies the following if you enter a defined user account:

   • The account exists on the domain.

   • You have supplied the correct password.

   For a detailed explanation of these settings, see the Initial Caché Security Settings section of the “Preparing for Caché Security” section of this book.

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

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

   Click Install to continue. Setup installs Caché in the selected directory.

8. The InstallShield Wizard Complete dialog box indicates the installation has completed successfully. Choose whether you want to see the Getting Started page and click Finish.