Caché Installation Guide
Unattended Custom Installation
[Home] [Back] [Next]
InterSystems: The power behind what matters   
Class Reference   
Search:    

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.
This section discusses the following topics:
Note:
No messages are displayed during unattended installation, upgrade, reinstallation, or uninstallation.
Running an Unattended Installation
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 use 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 Uninstallation
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 or to omit optional databases (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 chapter “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 chapter “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 chapter “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.)
Note:
You can choose not to install any of the three optional databases, ISC_PACKAGE_DOCBOOK_DATABASE, ISC_PACKAGE_SAMPLES_DATABASE, and ISC_PACKAGE_USER_DATABASE, by changing the value to N (Y by default). Doing so will ensure these database/namespace definitions are not installed and will not be created in cache.rpf.
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)