Caché Installation Guide
Installing Caché on Microsoft Windows
[Back] [Next]
   
Server:docs1
Instance:LATEST
User:UnknownUser
 
-
Go to:
Search:    

This chapter describes how to install Caché on a Microsoft Windows system. It assumes you are familiar with Windows directory structures, utilities, and commands. This chapter contains the following major sections:

Installation Requirements
You must have administrator privileges to install Caché regardless of the type of installation.
If you are installing Caché from a network, first copy the installation kit to the network drive. Map the network drive to a particular drive letter by clicking Map Network Drive from the Tools menu in Windows Explorer.
The following sections describe the hardware and software requirements for new and upgrade installations of Caché.
Disk Space Requirements
A Caché installation that includes support for Caché Server Pages (CSP) uses approximately 1500 MB (megabytes) of disk storage (not including disk space for user data).
The installation kit must be available, either on your computer or on a network.
Any system that can effectively support Windows should be sufficiently powerful to run Caché. Caché performance greatly improves with increased processor and disk speed.
Supported Platforms and Web Servers
For a list of Microsoft Windows platforms on which this version of Caché is supported, see InterSystems Supported Platforms.
Caché installs and runs only on Intel-based systems that use the Pentium P4 or later chipset (that is, those that support the SSE2 cpu extensions). This also applies to other manufacturers’ equivalent chipsets, such as those from Advanced Micro Devices (AMD) that are functionally equivalent to the Intel Pentium P4.
For a list of web servers on which InterSystems CSP technology is supported, see “Supported Web Servers” in the “Supported Technologies” chapter of InterSystems Supported Platforms.
If you are using CSP, install the web server before installing Caché to let the Caché installer configure the web server automatically. See the CSP Architecture chapter of the Using Caché Server Pages guide for more information.
With each instance, Caché installs a private web server and a private CSP Gateway to serve CSP pages to ensure proper operation of the Management Portal and Caché Online Documentation. Its Windows service name is “Web Server for instname” where instname is the instance name you enter when you install Caché. Caché installs the web server into the install-dir\httpd directory, where install-dir is the Caché installation directory. It is uninstalled when you uninstall the corresponding Caché instance.
Note:
The private web server is installed to ensure that:
  1. The Management Portal runs out of the box.
  2. An out-of-the-box testing capability is provided for development environments.
The private web server is not supported for any other purpose.
For deployments of http-based applications, including CSP, Zen, and SOAP over http or https, you should not use the private web server for any application other than the Management Portal; instead, you must install and deploy one of the supported web servers (see “Supported Web Servers” in InterSystems Supported Platforms).
Supported Upgrade Paths and Procedures
If you are performing an upgrade, first read and perform all necessary procedures described in the Upgrading Caché chapter of this guide.
When upgrading, back up your old Caché installation after completing all the pre-installation upgrade tasks and before installing Caché.
Installation Directory Restrictions
You cannot install Caché into a destination directory that has any of the following characteristics:
Caché Upgrade Installation
The steps for upgrading each type of a Caché installation are the same. The upgrade installation procedure installs the required components for the selected setup type on the computer.
To upgrade an installation follow this procedure:
  1. Stop any running Caché server on the computer. Also, close all other Windows applications and shut down the web server if it is installed on the same computer. Ensure that you have access to the installation kit.
  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
  3. The Select Instance dialog box lists the existing installation directories of all Caché instances installed on the machine. Select the instance you want to upgrade. (You can always select New Instance to install a new Caché instance, as described in Installing Caché.)
  4. The Welcome to the Caché Installation dialog box displays the following buttons to let you control the upgrade:
  5. The InstallShield Wizard Complete dialog box indicates the installation has completed successfully. Click Finish.
Caché Installation
The steps for installing each type of Caché configuration are fundamentally the same, but diverge slightly depending on the type of installation. The differences are detailed in subsections after the standard installation description.
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. The Caché setup begins. Within setup, the following buttons are activated to let you control the installation:
  4. 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.)
  5. 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.
  6. 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 chacaters only. Subsequent updates to this instance maintain the instance name you enter here.
  7. 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.
  8. The Setup Type dialog box lets you specify how you intend to use Caché:
The following table identifies which component groups are installed for each setup type. The Custom setup type lets you select specific component groups/components to install or remove; see the Caché Custom Installation section of this guide:
Components Installed by Setup Type
Component Group Components Development Server Client Web
Caché Database Engine (Caché Server)
Server Monitoring Tools
Samples database
User database
SQL Gateway
Agent Service (ISCAgent)
Apache FOP (Formatting Objects Processor)
X
X
   
Caché Launcher (cube)  
X
X
X
 
Caché Studio  
X
 
X
 
xDBC
ODBC Driver
Java Database Connectivity
X
 
X
 
Caché Application Development
ActiveX Connectivity
C++ Binding for Caché
Light C++ Binding
Java Binding for Caché
C++ SDK for Caché
Caché Engine Link Libraries
Perl Binding for Caché 1
Python Binding for Caché 1
.NET Binding for Caché
Threaded Server Libraries
Other Samples)
X
     
Documentation
PDF Documentation
Online Documentation
X
X
   
Web Server Gateway (CSP)
CSP for IIS
CSP for Apache 2.0.x
CSP for Apache 2.2.x
 
X
 
X
1 This component is supported only on the x86-32 bit platform.
Caché Development or Server Installation
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. If you experience such problems with an instance that is already installed, try reinstalling the instance specifying an appropriate account for the Caché service.
      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 for Caché Security” appendix 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 Access to the Caché Instance and the Initial Caché Security Settings section of the “Preparing for Caché Security” appendix 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.
Caché 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.
Caché Client Installation
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.
Important:
Before you can use the client, you must specify the preferred server for this client; this procedure is described in the Define a Remote Server Connection section of the “Connecting to Remote Servers” chapter of the Caché System Administration Guide.
Web Server (CSP) Gateway Installation
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:
You can change the configurations manually after installation from the CSP Gateway application; for information, see the CSP Gateway Configuration Guide.
Note:
The installer cannot automatically configure an Apache web server for use with Caché and CSP; for information on the required manual configuration procedures, see the CSP Gateway Configuration Guide.
Caché Custom 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 Caché Custom 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:
  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:
    When you click Next, the installation verifies the following if you enter a defined user account:
    For a detailed explanation of these settings, see the Initial Caché Security Settings section of the “Preparing for Caché Security” appendix of this guide.
  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.
Unattended Custom Installation
The Caché for Windows installer provides a way to perform unattended custom installation, upgrade, reinstallation (repair), and removal (uninstall) of instances of Caché on your computer. A typical install operation obtains necessary input from the user in the form of responses to dialog boxes. An unattended operation, however, does not prompt the user for input; instead, it gets input from properties passed to the Caché installation file on the command line. These properties are described in the Command-Line Reference section.
Important:
Before using the Caché unattended installation utility, you must download and install the Visual C++ Redistributable Packages for Visual Studio 2013 from Microsoft (https://www.microsoft.com/en-us/download/details.aspx?id=40784). If you are installing on a 64-bit system, you must install both the vcredist_x86.exe file and the vcredist_x64.exe file.
This section discusses the following topics:
Note:
No messages are displayed during unattended installation, upgrade, reinstallation, or uninstallation.
Running an Unattended Install
To launch unattended installation of a new instance of Caché, use the following command:
<path>\<installer>.exe /instance <instancename> /q{b|n} <properties> 
where:
For example, to install an instance of Caché with the default instance name in an installation directory named C:\InterSystems\MyCache on a 64–bit Windows system, specify the following:
C:\downloads\cache-2015.1.0.320.0-win_x64.exe /qn INSTALLDIR=C:\InterSystems\MyCache
To install an instance of Caché with the instance name CacheA, specify the following:
C:\downloads\cache-2015.1.0.320.0-win_x64.exe /instance CacheA /qn 
Alternatively, you can custom install a subset of features using the ADDLOCAL property; see the Command-Line Properties table, as well as the Custom-Installable Features table for a list of features that can be specified. For example, to install only the Launcher and the PDF version of documentation in an installation that uses the default instance name and default installation directory on a 64–bit Windows system, specify the following:
C:\downloads\cache-2015.1.0.320.0-win_x64.exe /qn ADDLOCAL=cube,documentation,documentation_pdf
Note:
An unattended installation does not install the CSP Gateway by default; this must be specified using the ADDLOCAL property (see the Command-Line Properties table).
Running an Unattended Upgrade or Reinstall
The target of the Caché installer can be an existing installed instance as well as a new instance. When there are no installed Caché instances, the target is always a new instance. When one or more instances of Caché are already installed, you must the /instance flag to specify either the name of one of the existing instances or a new name, which installs a new instance.
When an installed instance is the installer target, the action the installer takes depends on the versions of the installation file specified in the command line and the target instance, as follows:
For example, to run an unattended upgrade of an installed instance CacheB that is an earlier version than the installation file, use the following:
C:\downloads\cache-2015.1.0.320.0-win_x64.exe /instance CacheB /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 CacheB, you can use the following command (assuming the installation file and CacheB are the same version):
C:\downloads\cache-2015.1.0.320.0-win_x64.exe /instance CacheB /qn REINSTALL=studio
Running an Unattended Uninstall
To launch an unattended uninstall, specify the instance to be uninstalled and the REMOVE=ALL property, as follows:
C:\downloads\cache-2015.1.0.320.0-win_x64.exe /instance CacheC /qn 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 CSP Gateway from instance CacheC, use the following command:
C:\downloads\cache-2015.1.0.320.0-win_x64.exe /instance CacheC 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 Registry:
where <instance> is the name of the Caché instance you want to uninstall in unattended mode. The ProductCode property value is displayed in a row similar to the following:
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) TechNet article (http://technet.microsoft.com/en-us/library/cc759262.aspx).
Command-Line Reference
The Command-Line Properties table describes the Caché-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:
... ISCSTARTCACHE=0 UNICODE=0 WEBSERVERPORT=57779 INITIALSECURITY=Normal
Note:
In the following table, only the REINSTALL and REMOVE properties are used with installed instances, as described in Running an Unattended Upgrade or Reinstall and Running an Unattend Uninstall, respectively. All of the other properties are used only when installing new instances.
Command-Line Properties
Property Name Description
ADDLOCAL
Use this property to custom install a new instance of Caché with a subset of features (see the Custom-installable Features table) by specifying a comma-separated list of featurenames together with their group names, as described in the example following this table.
In the absence of the ADDLOCAL property, or if ADDLOCAL=ALL is specified, all features are installed.
See also the REINSTALL property, for use with installed instances.
CACHESERVICEDOMAIN Required if the service credentials are defined as UserDefined; see the SERVICECREDENTIALS property in this table. Use this property to specify the domain of the Windows Caché service login account specified by CACHESERVICEUSER.
If the service credentials are specified as LocalSystem, do not use this property.
CACHESERVICEPASSWORD
Required if the service credentials are defined as UserDefined; see the SERVICECREDENTIALS property in this table. Use this property to specify the password for the Windows Caché service account specified by CACHESERVICEUSER.
If the service credentials are specified as LocalSystem, do not use this property.
CACHESERVICEUSER
Required if the service credentials are defined as UserDefined; see the SERVICECREDENTIALS property in this table. Use this property to specify the username of the account under which to run the Windows Caché service.
If the service credentials are specified as LocalSystem, do not use this property.
CACHEUSERPASSWORD
Required if the security level is Normalor Locked Down; see the INITIALSECURITY property in this table. Use this property to specify the password for the predefined Caché accounts _SYSTEM, Admin, and SuperUser, as well as the account with the username specified by CACHESERVICEUSER if SERVICECREDENTIALS is specified as UserDefined.
If the initial security level is None, do not use this property.
CSPSYSTEMUSERPASSWORD
If the security level is Normalor Locked Down (see the INITIALSECURITY property in this table), optionally use this property to specify a password for the CSPSystem predefined user. If this property is omitted, the value of CACHEUSERPASSWORD is used.
If the initial security level is None, do not use this property.
INITIALSECURITY
Optionally use this property to specify the level of security to be used by the instance being installed. Specify None, Normal, or Locked Down.
Omit this property to accept the default of None.
See also the CACHEUSERPASSWORD, CSPSYSTEMUSERPASSWORD, and SERVICECREDENTIALS properties in this table.
INSTALLDIR
Optionally use this property to specify the directory in which the instance is to be installed.
If the property is omitted, the default installation directory is C:\InterSystems\CACHEn, where n is {empty}, 1, 2, ... 127.
INSTALLERMANIFEST
If installing with an installation manifest, as described in Using the Manifest in the appendix “Creating and Using an Installation Manifest”, you must use this property to specify the location of the installation manifest (that is, your exported manifest class) .
INSTALLERMANIFESTLOGLEVEL
If installing with an installation manifest, as described in Using the Manifest in the appendix “Creating and Using an Installation Manifest”, optionally use this property to specify the log level of the setup() method of your installation manifest class. The default log level is 1.
INSTALLERMANIFESTPARAMS
If installing with an installation manifest, as described in Using the Manifest in the appendix “Creating and Using an Installation Manifest”, use this property to specify the name/value pairs (name=value) to be passed to the first argument of the setup() method of your installation manifest clas. This property can be used to modify the Caché parameter file (cache.cpf) and activate the changes before your manifest runs. The following parameters can be specified:
For example:
INSTALLERMANIFESTPARAMS="bbsiz=512000,globals4kb=20, globals8kb=30,globals16kb=40,globals32kb=50, globals64kb=100,routines=40,gmheap=10000, LibPath=c:\libpath\,locksiz=2179648,MaxServerConn=5, Path=c:\lib\,ZFSize=2000,ZFString=3000"
The following would be useful in installing and activating 100 MB of 64KB buffers before running a manifest that creates a 64kb block size database:
INSTALLERMANIFESTPARAMS="globals64kb=100"
ISCSTARTCACHE Optionally set this property to 0 to prevent Caché from starting after installation. The default is 1, to start Caché.
ISCSTARTLAUNCHER Optionally set this property to 0 to prevent the Caché launcher (cube) from being added to the system tray. The default is 1, to add the launcher.
REINSTALL
Use this property to reinstall (repair) an installed instance of Caché or to change the custom-installed features (see the Custom-installable Features table) for an installed instance of Caché:
  • To reinstall whatever features are currently installed for the instance—whether that is a custom-installed subset of features or all features—specify ALL.
  • To reinstall a subset of Caché features that is different from the subset of features currently installed, specify a comma-separated list of featurenames together with their group names (as described in the example following this table).
See also the ADDLOCAL property (for use with new instances) and REMOVE property (for uninstalling installed instances).
REMOVE
Use this property to uninstall (remove) an instance of Caché or a subset of custom-installed features (see the Custom-installable Features table) installed for an installed instance of Caché:
  • To remove an instance of Caché, specify ALL.
  • To remove a subset of Caché features (see the Custom-installable Features table), specify a comma-separated list of featurename together with their group names (as described in the example following this table).
See also the ADDLOCAL (for new instances) and REMOVE properties in this table properties in this table.
SERVICECREDENTIALS
If the security level is Normalor Locked Down (see the INITIALSECURITY property in this table), optionally use this property to specify the credentials under which the Windows Caché service will run: LocalSystem for the default local system account or UserDefined (an existing Windows user account). If you do not specify the property, the default of LocalSystem is used.
If the initial security level is None, do not use this property.
See Managing Access to the Caché Instance for important information about the Caché service account.
If you specify UserDefined for this property, you must also specify the CACHESERVICEDOMAIN, CACHESERVICEPASSWORD, and CACHESERVICEUSER properties.
SUPERSERVERPORT
Optionally use this property to specify the Superserver port to be used by the instance being installed.
By default, this port is auto-determined, beginning with 1972 (if available), then 56773, and increasing by 1 for each installed instance of Caché.
UNICODE
Optionally use this property to specify whether 8–bit or 16–bit Unicode characters are to be supported by the instance being installed. For 8–bit characters, specify 0; for 16–bit characters, specify 1.
This setting applies to Caché instances only; Ensemble instances are always Unicode.
If you omit this property, is 8–bit specified by default for all languages except Chinese, Korean and Japanese; 16–bit is specified by default for Chinese, Korean, and Japanese systems.
WEBSERVERPORT
Optionally use this property to specify the Webserver port to be used by the instance being installed.
By default, this port is auto-determined, beginning with 57772 and increasing by 1 for each installed instance of Caché.
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 (see the Command-Line Properties table), 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 SAMPLES and USER databases and the PDF documentation, include the following in the command line:
ADDLOCAL=server,server_samples,server_user,documentation,documentation_pdf
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 the following:
ADDLOCAL=documentation,documentation_pdf,server,development,perlbind,pythonbind
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.)
Custom-Installable Features
Component Group (featurename) Components (featurename)
Server (server)
Samples database (server_samples)
User database (server_user)
SQL Gateway (sqlgateway)
Apache Formatting Objects Processor (fop)
Server monitoring tools (server_monitoring)
HotJVM RenderServer/QueuingRenderServer for Zen Reports (renderserver)
Agent Service (agent_service)
For Ensemble and HealthShare only: ENSDemo database (server_ensdemo)
Launcher (cube)
 
Studio (studio)
 
xDBC (sqltools)
ODBC (odbc)
JDBC (jdbc)
Development (development)
C++ Binding (cppbind)
Light C++ Binding (lcbind)
C++ SDK (cppsdk)
Callin (callin)
Callin, Threaded (callin_threaded)
Perl Binding (perlbind)
Python Binding (pythonbind)
Java (javabind)
.NET Binding (dotnetbind)
Threaded Server Libraries (server_threaded)
ActiveX Connectivity (activex)
Other Samples (other_samples)
Documentation (documentation)
PDF Documentation (documentation_pdf)
Online Documentation (documentation_online)
CSP Gateway (cspgateway)
IIS (cspiis)
Apache 2.0 (cspapache20)
Apache 2.2 (cspapache22)
Post-Installation Tasks
Review the following important post-installation tasks:
Special Considerations
The following topics describe particular issues or tasks associated with licensing, specific platforms, or kinds of installations:
Managing Access to the Caché Instance and Installation Tree
When Caché is installed with Normal or Locked-Down security, the account under which the Windows Caché service runs must have both of the following:
When you specify a service account that is not a member of Administrators, to address these needs, the installer creates the following two user groups and adds the service account to each:
Please note the following points about these groups:
Important:
If you want to change the Windows Caché service account to one that is not in Administrators, do not use the Windows Control Panel for this purpose. Instead use the following command, which adds the specified account to the CacheServices and the Cache_Instance_instancename groups:
<install-dir>\bin\Cinstall.exe setserviceusername <instance-name> <username> <password>
Use an Installation Manifest
You can define an installation manifest that describes a specific Caché configuration and invoke it when executing the installation file. For more information on installation manifests, see the appendix Creating and Using an Installation Manifest.
Multiple Caché Installation Issues
You can install and simultaneously run multiple instances of Caché 4.0 and later on a single Windows machine. Install Caché 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 Caché Instances section of the Caché System Administration Guide for more detailed information.
Installing multiple Caché instances is limited by components where only one exists on a system. For example, typically there is only one web server on a system; and as such, the Caché installation configures CSP for the most recent installation. Caché client components stored in the registry encounter the same issue. Caché stores its ODBC driver and ActiveX components in the registry using one name for each. Currently, the last installation updates these components to point to the last instance installed. If you are adding this release of Caché to your machine and keeping older (Caché 4.1 and earlier) versions running, you need to register the latest components. See Register Files for details.
InterSystems makes an effort to move common components to a common directory that can be shared across Caché instances. Unfortunately, because of backward compatibility issues, not all current Caché components support Caché 5.0 and 4.1 instances and are even less likely to support Caché 4.0 instances on the same machine.
As a work-around, you can take advantage of a feature Microsoft introduced with Windows 2000 and later. You can force your executable to ignore the registry paths to an executable by creating an empty file of the same name with .local appended to the executable name.
For example: CStudio.exe would need an empty file called CStudio.exe.local to force the Studio program to look in the current directory, before using the registry path. By creating these empty .local files, you enable a previous Caché instance to use the compatible local files, rather than a newly installed current Caché set of registered executables.
To create .local files for all the executables in a directory type the following at a DOS prompt:
for %c in (*.exe) do set tempvariable= >%c.local
For more information on .local files, see the MSDN library article Dynamic-Link Library Redirection.
Register Files
The Caché installation contains a Regfiles.bat script file in the install-dir/Bin directory that reregisters object tool files in a common Caché directory. You require Administrator privileges to run RegFiles.bat.
You only need to run this script if you install or uninstall any instance of Caché 4.1 or earlier; if you are only running instances of Caché 5.0 or later, the object tools function properly with multiple instances.
Here is an example of running the script:
C:\MyCache\Bin>regfiles.bat

C:\MyCache\Bin>rem Register Cache Self-Registering executables in
 common directory
.
.
If after running RegFiles.bat, you still receive errors similar to the following when you start Studio:
Cannot create class factory for COM_SLSID_TNodes
Run the script with the ALL argument; this reregisters all JCOM DLLs in addition to the other files.
For example:
C:\MyCache\Bin>RegFiles.bat ALL

C:\MyCache\Bin>rem Register Cache Self-Registering executables in
common directory
.
.
C:\MyCache\Bin>rem Register JCOM dlls

C:\MyCache\Bin>set CacheDir=C:\MyCache\bin\
.
.
Important:
Running RegFiles.bat ALL when it is not necessary will prevent the uninstall procedure from removing some registry keys under HKLM\Software\Intersystems when you uninstall the last Caché instance.
Change the Caché Language
When you install Caché, 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:
Code Language
CHS Chinese (Simplified)
DEU German (Standard)
ENU English (United States)
ESP Spanish (Spain)
FRA French
ITA Italian (Standard)
JPN Japanese
KOR Korean
NLD Dutch (Standard)
PTB Portuguese (Brazilian)
RUS Russian
For information about changing the locale of a Caché installation, see Using the NLS Pages of the Management Portal in the “Configuring Caché” chapter of the Caché System Administration Guide.
Note:
You can change only among 8-bit locales or Unicode locales, not from 8-bit to Unicode or vice versa. See the %SYS.NLS entry in the InterSystems Class Reference for more information.
Reinstall or Uninstall Caché
By running setup and selecting a Caché instance of the same version as the installer, or by selecting Programs and Features from Windows Control Panel and selecting a Caché instance, you can make changes to or uninstall the instance.
When you run setup as described in Caché Installation and select a Caché 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.
Note:
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.
Important:
Use only the Caché installer or Windows Control Panel Programs and Features to uninstall Caché. Other uninstall programs are not supported and using them may cause unexpected results.
InterSystems Caché Packet Drivers
Install Caché Packet Driver for Windows 2000, XP, and 2003 Server
To use Raw Ethernet with Caché on Windows systems, you must install the appropriate packet driver as described below. First ensure that the appropriate driver file is available on your computer or on a network.
For Windows 2000, XP, and 2003 Server systems, install the InterSystems Packet Protocol Driver as follows:
  1. Right-click My Network Places on the desktop and click Properties.
    You can also click Start, point to Settings and click Network and Dial-up Connections.
  2. Right-click Local Area Connection and click Properties.
  3. Click Install.
  4. Click Protocol in the Select Network Component Type dialog box and then click Add.
  5. Click Have Disk in the Select Network Protocol dialog box.
  6. Enter the path to the packet driver kit and click OK.
    You can also enter the appropriate drive letter and click Browse to search for the correct path, \drivers\win2k, that contains the file ispkt2k.inf. Click Open and then click OK.
  7. Select the appropriate driver for your operating system, InterSystems Packet Driver for Windows 2000, XP and 2003 Server, for example, and click OK.
  8. After the driver is installed, click Close.
After you restart Windows, Caché is fully available to you.
Shared Memory Allocation on Windows
InterSystems recommends enabling Caché to allocate its memory as large pages on Windows systems, which provides more efficient use of memory and paging space. To do so, grant the Windows “Lock Pages in Memory” (SELockMemory) privilege to the user account used to run Caché, which allows Caché to request its memory as large pages, and ensure that the memlock parameter is set to 0, the default (see memlock in the Caché Parameter File Reference).
Note:
If Caché is running under the default SYSTEM account, it has the “Lock Pages in Memory” privilege by default.
When you restart Caché while using large pages, you typically also need to restart Windows, to guarantee that all configured memory is allocated. If startup is unable to allocate the full amount of configured memory, it attempts to start up with less memory, and may or may not use large pages. You can check the actual memory allocated by reviewing the most recent Caché/Ensemble startup in the console log.
Specifically, Caché allocates shared memory at Windows startup as follows:
  1. Request large pages, if allowed.
  2. If unable to allocate the full amount of configured memory in large pages, or if large pages are not allowed, request small pages.
  3. If unable to allocate the full amount of configured memory in small pages, reduce the allocation by one eighth (1/8) and begin again with step 1.
Note:
On Windows versions prior to Windows Server 2008 and Windows Vista, which are not supported by this version Caché, allocation of small pages bigger than 2 GB is not allowed. The Caché memory allocation algorithm was therefore different, as follows:
  1. If large pages are allowed,
    1. Request large pages.
    2. If unable to allocate the full amount of configured memory in large pages, allocate small pages if amount of configured memory is smaller than 2 GB.
    3. If configured memory is larger than 2 GB, or if unable to allocate the full amount of configured memory in small pages, reduce the allocation by one eighth (1/8) and begin again with step 1a.
  2. If large pages are not allowed,
    1. Reduce memory request size to 2 GB.
    2. Request small pages.
    3. If unable to allocate the full amount of configured memory in small pages, reduce the allocation by one eighth (1/8) and begin again with step 2b.
If the total amount of shared memory configured for Caché exceeds 2 GB on one of these Windows versions and is not allocated as Windows large pages, Caché or Ensemble can become slow or unresponsive. In these circumstances, key Caché/Ensemble processes, such as the Write daemon, spend more and more time in the Windows kernel, visible as percentage of Privileged time in Windows Performance Monitor, perfmon.exe.