This chapter describes how to install Caché 5.0 on a Windows system.
It assumes you are familiar with Windows directory structures, utilities, and commands.
This chapter contains the following major sections:
Installation Requirements
This section describes the hardware and software requirements for new and upgrade
installations of Caché 5.0.
A standard Caché installation that includes support for Caché
Server Pages (CSP) uses approximately 173187 MB (megabytes) of disk storage
(not including disk space for user data). You must have 10 MB additional disk space
free on your Windows system disk for installation.
Your system must have access to a CD-ROM drive for installation, either attached
to your computer or available across 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
The latest version of Caché is supported on the following versions of
the Windows operating system:
-
-
Windows XP (with SP1 or SP2)
-
Windows 2000 (with SP3 or SP4)
-
Windows NT 4.0 (with SP4, SP5, or SP6)
Caché is only supported as a client on the following platforms:
For Windows Server 2003, XP, 2000, NT, 98, and 95, the CSP technology is supported
on the Microsoft IIS/PWS Web servers. For all supported Windows versions, CSP is supported
on the Apache 1.3 and 2.0 Web server.
To install Caché on a Windows NT platform, you need NT system administrator
privileges.
If you are installing Caché from a network, first copy the entire contents
of the CD to the network drive. Map the network drive to a particular drive letter,
for example,
Q:, by clicking
from
the
menu in
Windows Explorer.
The Caché Studio is not available on Windows 95 and Windows 98.
Supported Upgrade Paths and Procedures
When upgrading, you may want to back up your 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:
-
It has a caret (^) in the pathname.
-
It has a character that is not in the US ASCII character set.
-
It is at the root level of a drive (such as
C:\).
-
It has more than 32 characters in the pathname.
The steps for installing each type of a Caché 5.0 configuration are fundamentally
the same, but differ in step 7, selecting the type of installation. The differences
are detailed in subsections after the standard installation description.
Caché Standard Installation
The standard installation procedure installs both Caché server and client
components on the computer. To perform a standard installation follow these steps:
-
If you are upgrading, 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. For a CD-ROM installation, load the software
CD into your CD drive. For a network installation, ensure that you have access to
the files.
-
Click
Start and click
from
the menu. In the
Open text box of the
Run dialog
box, enter:
The
drive value is the letter of your CD-ROM drive. The
Caché
Setup dialog box appears.
-
Click
Install. The Caché setup begins.
While preparing for the installation, setup checks that you have at least 173 MB of
free disk space. Within setup, reply to the prompts as they appear:
-
Click
Next to continue to the next dialog box.
-
Click
Back to go back to a previous dialog
box and change what you have entered.
-
Click
Cancel to stop the installation.
-
If this is a new installation, choose
Yes to
confirm that you accept the Caché License Agreement.
-
If this is an update installation, the
Select Install Configuration dialog
box is displayed. If a version of Caché for Windows exists, setup displays
a list of existing installation directories. You can select one of these directories
to update, or install into a new directory.
-
If this is a new installation, the
Define Caché Installation
Name dialog box is displayed and prompts you to enter an initial configuration
name.
CACHE is the default configuration name. Accept the default
or enter another name. Update installations maintain your current default configuration
name.
-
At the
Setup Type dialog box, select the type
of installation:
-
Standard installs the server, client,
and ODBC Driver components. Select this option if you plan to use this computer as
a Caché database server.
-
Client installs
only the Caché client components. Select this option if you plan to use the
Caché system and configuration utilities on this computer as a client to a
Caché database server on another computer.
-
Custom allows
you to select which components you want to install.
This dialog box also allows you to select a destination directory for the Caché
software; the default location is
C:\CacheSys. You can enter
another directory by clicking
Browse. The directory pathname
can be a maximum of 32 characters.
-
Select either 8-bit (the default) or Unicode support for your installation:
-
8-bit The software handles characters
in an 8-bit format.
-
Unicode The software handles characters
in the Unicode (16-bit) format. Select Unicode if your application uses languages
that store data in a Unicode format, such as Japanese.
InterSystems recommends
8-bit character support for locales based upon the Latin-1 character set, ISO 88591.
Use Unicode if the base character set for your locale is not Latin-1, or if you plan
to have data from locales based upon a different character set. If you use an 8-bit
version of Caché, your data is not portable to 8-bit locales based on a different
character set.
Caution:
If you choose a Unicode installation, you cannot revert to an 8-bit version
without potential data loss. This is because an 8-bit version of Caché cannot
retrieve 16-bit character data from a database.
For client installations, choose the format that matches that of the server
with which this client communicates. Install an 8-bit client to access 8-bit servers,
and a Unicode client to access Unicode servers.
-
The
Install Summary dialog box shows the selected
installation items and destination directory for the software files. Click
Next to
continue. Setup installs Caché in the selected directory.
-
If you are installing the Web Server Gateway (CSP Gateway) and an
IIS Web server is running, a dialog box appears asking if you want to stop the IIS
Web server. If you click
Yes, the installation procedure stops
the server, installs the CSP Gateway, and restarts the server. If you click
No,
the procedure does not install the CSP Gateway.
-
If you do not have a Caché license already on your computer
(no
cache.key file in the system manager’s directory),
the
Enter License dialog box explains that a key was not detected
and asks if you want to enter a license during the installation. See the
License
Key Information section for more information.
-
At the
Setup Complete dialog box, click
Finish.
Caché starts automatically. If a restart is necessary, you are prompted to
begin one.
-
After Caché is installed, the
Caché Cube icon
appears in the system tray area of the Windows tool bar. Click the icon to bring up
the Caché menu. In addition, there is a
Caché item
on the
menu.
For Windows servers, the installation names the Caché service as Caché
Controller for
configname, using the name entered in the
Define
Caché Installation Name dialog box. The service is set up to start
automatically as an NT service when you start your server.
Important:
The default installation of Caché starts communications on port 1972
without security enabled.
Caché Client Installation
If you wish, you can install only those parts of Caché that are required
on a client machine. These include the Caché system and programmer utilities.
The client installation follows a set of dialog boxes similar to a Caché standard
installation.
This software is included when you install Caché and does not require
a separate installation medium.
To perform a client installation:
-
-
The dialog box allows you to select a destination directory for the Caché
software; the default location is
C:\CacheSys. You can enter
another directory by clicking
Browse. The directory pathname
can be a maximum of 32 characters.
-
Continue with the remaining steps of the standard installation.
-
Caché Custom Installation
The Caché installation program allows you to select certain Caché
components to be installed on the computer. For example, you may want to install only
the Caché SQL Manager. Keep in mind that some selections require that you also
install other components.
The following table lists the components you can select.
Caché Custom Components
Component |
Description |
Other Required Components |
Caché Engine |
Installs the base Caché database
engine. |
Caché Tools and Utilities, Caché Direct Connectivity,
ActiveX Connectivity |
Manager Utility Source Code |
Installs the utility source
code into the %SYS Namespace. |
Caché Engine |
Web Server Gateway (CSP) |
Configures the Web server gateway
for Caché Server Pages (CSP). |
|
ActiveX Connectivity |
Installs
ActiveX components that allow connectivity between client applications and Caché. |
Caché Direct Connectivity |
SQL Tools * |
Installs ODBC and JDBC drivers and a relational
viewer of Caché databases. |
|
Caché Tools and Utilities |
Installs development tools
(such as the Caché Studio) and system management utilities (such as the Caché
Configuration Manager). |
Caché Direct Connectivity and ActiveX
Connectivity |
Caché Direct Connectivity † |
Installs Caché Direct runtime client components, which are needed
for client connectivity. |
|
Caché Engine Link Libraries |
Installs
C header files and object files that are necessary for relinking Caché on certain
Windows platforms. |
|
Caché Application Development |
Installs development
components for building your own applications (C, C++, Java) that use Caché
databases. |
|
WebLink |
Installs Caché WebLink, which links your
Caché database to the World Wide Web. |
|
Documentation |
Installs the
Caché documentation. |
|
† Caché Direct requires DLLs that are included in Internet Explorer
version 4.0 and higher.
To perform a Caché custom installation:
-
-
The dialog box allows you to select a destination directory for the Caché
software; the default location is
C:\CacheSys. You can enter
another directory by clicking
Browse. The directory pathname
can be a maximum of 32 characters.
-
Select the components you wish to install.
-
Continue with the remaining steps of the standard installation.
-
-
-
If appropriate for your installation, perform any additional tasks
described in the
Special Considerations section.
The following topics describe particular issues or tasks associated with licensing,
specific platforms, or kinds of installations:
Caché uses license keys to ensure proper operation of its registered
sites. Caché requires a product activation key that defines the Caché
features and capacity available. You may receive identifying information from InterSystems
for the license key file on paper, by phone, by fax, or by computer connection. You
may chose one of two options for entering license key information:
-
-
Click
No to continue with the remaining installation
steps. You can update your license information at another time by invoking the license
wizard from the
Caché Configuration Manager.
License keys are not required for single-user Windows installations of evaluation
kits via the Internet. If you are setting up such a site, bypass these sections.
Important:
Licenses from versions prior to Caché 4.1 or other InterSystems products
do not work with Caché 5.0. Please contact the
InterSystems
Worldwide Response Center (WRC) for an appropriate key if you are upgrading.
Enter License Key Information
Follow the instructions below to specify your license key from the
Caché
License Wizard:
-
-
-
Click
Finish. When Caché starts, your
new license information takes effect.
If you purchased multiserver licenses, you must configure one or more license
managers to allocate the Caché license units authorized by the key. All configurations
sharing a key must be configured to use the same license manager or set of license
managers. License managers can run on any computer where you run a Caché configuration.
The license manager is not a Caché process so it is unaffected if a Caché
configuration shuts down. Therefore, you need at most one per system regardless of
how many Caché configurations run on a system. Each system running an instance
of Caché under the auspices of one or more license managers must have a local
copy of the authorizing license key file installed in the system manager’s directory
of every configuration.
If you run Caché servers on multiple hosts, you can configure more than
one license manager to provide redundancy. The only requirement is that configurations
that share a license must use the same license manager or set of managers.
If, after entering your license and restarting Caché, only one user can
log in, check that you have typed in the license correctly. The Caché
Control
Panel shows how many processes are running. You can also use the
Control
Panel to display license information by right clicking the configuration.
Click
on the shortcut menu, then click the
License tab
to examine the license key information. If the key is not valid, the
CustomerName field
contains an explanation.
You can also check the license error messages in the
cconsole.log file.
This file is stored in the system manager’s directory and can be viewed in the
Control
Panel by expanding the
Logs folder and clicking
Console
Log.
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 configuration a unique name, a unique installation directory, and a unique
port number.
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, CSP is configured for the last installation. Caché client components
stored in the registry encounter the same issue. The Caché ODBC driver and
ActiveX components are stored 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 Caché 5.0 to your machine and keeping an older version running
also, run
RegFiles.bat in 5.0 to register all the 5.0 components.
Caché 5.0 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 Caché 5.0 components support Caché 4.1
instances, and are even less likely to support Caché 4.0 instances on the same
machine. See the
Supported Caché Version Interoperability section
of the
Supported Platforms document.
As a work-around, you can take advantage of a feature Microsoft introduced with
Windows 2000, Windows 98, 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:
CObjArch.exe would need an empty file called
CObjArch.exe.local to
force the Architect program to look in the current directory for registered ActiveX
components, before using the registry path. By creating these empty
.local files,
you enable a previous Caché 4.1 or Caché 4.0 instance to use the compatible
local files, rather than a newly installed Caché 5.0 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
Note:
Windows 95 and Windows NT 4.0 platforms do not support the
.local mechanism.
Change the Caché Language
When you install Caché, all supported language-specific utility DLLs
are installed in the
CacheSys\Bin directory. Each DLL contains
localized strings and messages.
The format of the name of the DLL is
UTILxxx.DLL, where
xxx is
a 3-letter code that signifies the following languages:
If you wish to change to the locale of a Caché installation, run the
Caché
National Language Support application
cnls.exe from
your
<cache-install-dir>/Bin directory and update the information
on the
Locale tab.
To uninstall Caché, first stop Caché and then click
on
the Caché cube to remove the cube from the system tray.
Use only the Caché-supplied uninstall program; accessible on a Windows
2000 system, for example, using the
utility
from the Windows
Control Panel.
Other uninstall programs are not supported, and using them may cause unexpected
results.
InterSystems Caché Packet Drivers
To use Raw Ethernet, DDP, or LAT (needed for NT only) with Caché on Microsoft
Windows systems, you must install the appropriate packet driver as described below.
First load the CD-ROM or verify the network location of the appropriate driver file.
Choose the install procedure based on your Windows version:
Important:
Caché does not include a Ethernet packet driver for Microsoft Windows
Server 2003 64-bit edition; therefore, the following features, which require the driver,
do not work: DCP over Ethernet, DSM-DDP, and the
$ZUTIL(114) function.
Install Caché Packet Driver for Windows 2000, XP, and 2003 Server
For Windows 2000, XP, and 2003 Server systems, install the InterSystems Packet
Protocol Driver as follows:
-
Right-click
My Network Places on the desktop and
click
.
You can also click
Start,
point to
and click
.
-
Right-click
Local Area Connection and click
.
-
-
-
-
Enter the path to the packet driver kit and click
OK.
-
-
After the driver is installed, click
Close.
After you restart Windows, Caché is fully available to you.
Install Caché Packet Driver for Windows NT
For Windows NT 4.0 systems, install the InterSystems Packet Driver for Windows
NT as follows:
-
Right-click
Network Neighborhood on the desktop
and click
.
You can also click
Start,
point to
and click
,
then double-click
Network.
-
-
-
Type the path of the CD-ROM or network drive and click
OK.
-
-
When complete, click
Close to start the binding
procedure.
-
When binding is complete, click
Yes to restart
your computer.
After you restart Windows NT, Caché is fully available to you.
Install Caché Packet Driver for Windows 95/98/ME
For Windows 95/98 or ME systems, install the InterSystems Packet Driver for
Windows as follows:
-
Right-click on
Network Neighborhood from the desktop
and then click
.
You can also click
Start,
point to
and click
Control Panel,
then double-click the
Network icon.
-
-
-
-
-
The
Network Control Panel installs the drivers
into the appropriate directories on your system. The installer may require the Windows
CD-ROM or installation diskettes if you do not have all of the necessary base components
installed.
-
After you restart Windows, Caché is fully available to you.