2019oct Using SAG Installer
2019oct Using SAG Installer
Version 10.5
October 2019
This document applies to Software AG Installer Version 10.5 and to all subsequent releases.
Specifications contained herein are subject to change and these changes will be reported in subsequent release notes or new editions.
Copyright © 2010-2019 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or
its affiliates and/or their licensors.
The name Software AG and all Software AG product names are either trademarks or registered trademarks of Software AG and/or
Software AG USA Inc. and/or its subsidiaries and/or its affiliates and/or their licensors. Other company and product names mentioned
herein may be trademarks of their respective owners.
Detailed information on trademarks and patents owned by Software AG and/or its subsidiaries is located at
hp://softwareag.com/licenses.
Use of this software is subject to adherence to Software AG's licensing conditions and terms. These terms are part of the product
documentation, located at hp://softwareag.com/licenses and/or in the root installation directory of the licensed product(s).
This software may include portions of third-party products. For third-party copyright notices, license terms, additional rights or
restrictions, please refer to "License Texts, Copyright Notices and Disclaimers of Third Party Products". For certain specific third-party
license restrictions, please refer to section E of the Legal Notices available under "License Terms and Conditions for Use of Software AG
Products / Copyright and Trademark Notices of Software AG Products". These documents are part of the product documentation, located
at hp://softwareag.com/licenses and/or in the root installation directory of the licensed product(s).
Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with
Software AG.
Table of Contents
Concepts......................................................................................................................................... 11
Software AG Installer and Uninstaller...................................................................................... 12
Installation Methods..................................................................................................................12
Install Products from Empower......................................................................................... 12
Install Products Using an Installation Image.....................................................................13
Install Products Using an Installation Script......................................................................14
Install Products or Create Images Faster................................................................................ 14
Generate Images for Multiple Operating Systems from an Image Generation Script...............14
Uninstallation Methods............................................................................................................. 15
Installation and Uninstallation Modes.......................................................................................15
JDK Support............................................................................................................................. 15
Ports..........................................................................................................................................16
Logging..................................................................................................................................... 16
EU General Data Protection Regulation (GDPR).....................................................................17
Uninstalling.....................................................................................................................................63
Overview................................................................................................................................... 64
Before You Begin......................................................................................................................64
Start the Uninstaller..................................................................................................................65
Uninstall Selected Products from Local or Remote Machine................................................... 65
Uninstall All Products from Local or Remote Machine with No User Input...............................66
Uninstall All Products Silently in GUI Mode......................................................................66
Uninstall All Products Silently in Console Mode............................................................... 67
Uninstall Using a Script............................................................................................................ 67
This guide explains how to prepare your machine to use this release of Software AG
Installer, and how to use Software AG Installer and Software AG Uninstaller to install
and uninstall your products.
This release of Software AG Installer supports installation of several different
releases of Software AG products. This guide, therefore, is intended for use with the
Software AG product installation guides for all supported product releases. The product
installation guides provide product-specific preparation, installation, and uninstallation
instructions. However, features offered by this release of Software AG Installer might
not be available when you install products that were released before that date.
Document Conventions
Convention Description
Italic Identifies:
Variables for which you must supply values specific to your own
situation or environment.
New terms the first time they occur in the text.
References to other documentation sources.
Monospace Identifies:
font
Text you must type in.
Messages displayed by the system.
Program code.
{} Indicates a set of choices from which you must choose one. Type
only the information inside the curly braces. Do not type the { }
symbols.
Convention Description
... Indicates that you can type multiple options of the same type.
Type only the information. Do not type the ellipsis (...).
Software AG TECHcommunity
You can find documentation and other technical information on the Software AG
TECHcommunity website at “hp://techcommunity.softwareag.com”. You can:
Access product documentation, if you have TECHcommunity credentials. If you do
not, you will need to register and specify "Documentation" as an area of interest.
Access articles, code samples, demos, and tutorials.
Data Protection
Software AG products provide functionality with respect to processing of personal data
according to the EU General Data Protection Regulation (GDPR). Where applicable,
appropriate steps are documented in the respective administration documentation.
1 Concepts
■ Software AG Installer and Uninstaller .......................................................................................... 12
■ Installation Methods ..................................................................................................................... 12
■ Install Products or Create Images Faster .................................................................................... 14
■ Generate Images for Multiple Operating Systems from an Image Generation Script .................. 14
■ Uninstallation Methods ................................................................................................................. 15
■ Installation and Uninstallation Modes .......................................................................................... 15
■ JDK Support ................................................................................................................................. 15
■ Ports ............................................................................................................................................. 16
■ Logging ......................................................................................................................................... 16
■ EU General Data Protection Regulation (GDPR) ........................................................................ 17
For detailed instructions on using the installer, see the other chapters in this guide.
Installation Methods
The Software AG Installer offers the methods below for installing products.
You can install the latest releases of products directly from the Software AG
Empower Product Support website on one machine. Empower always offers only the
latest product releases.
You can download products from Empower into an installation image and then install
some or all products from the image on one or more machines.
You can record an installation script of yourself installing products from Empower or
from an installation image, and then install the products with no user input on one
or more machines.
You want to install some or all of the same products on multiple machines, and you
want to avoid the time required to download from Empower.
You create an image by running the Software AG Installer, connecting to Empower,
and selecting products to download into the image. You can create an image for any
operating system from any operating system; for example, you can create an image for
a Solaris system from a Windows system. When you create an image, therefore, the
installer ignores the local machine. This means that:
When you select a product to include in the image, the installer does not
automatically select additional products that are required by the selected product.
Instead, the installer lists the required products and asks whether to select them for
you. If the target installation directories are empty, you would accept the offer. If
you know that the target installation directories already contain all or some of the
required products and you want to reduce the size of the image, you can accept the
offer and then deselect already installed products, or refuse the offer and make the
necessary selections yourself.
The installer does not ask for machine-specific information such as target installation
directory or product port values. You will provide the machine-specific information
when you install from the image on each target machine.
The installer does not request product-specific information such as product port
values, license files, and database connection parameters during image creation. You
will provide product-specific information when you install from the image on each
target machine.
The installer saves images as zip files. Each zip file includes an HTML file named
ImageContents.html that you can open to see the contents of the image.
you select the operating system that supports the greatest number of your products. For
most products, that operating system is Microsoft Windows 64-bit.
Image generation scripts do not specify release numbers for the products. When you
generate an image from an image generation script, the installer connects to Empower
and downloads the latest releases of the selected products at that point in time into the
image.
Note: You cannot use an image generation script to install products; it is not an
installation script. The only purpose of an image generation script is to enable
you to generate images for multiple operating systems.
Uninstallation Methods
You can uninstall products using these methods:
You can uninstall specified products from the local machine.
You can uninstall all products from the local machine.
You can create an uninstallation script for specified products and run it on multiple
machines with identical installations.
Note: The Software AG Installer does not support running in compatibility mode
on Windows systems. For example, the installer does not support running
in Windows XP compatibility mode on Windows Vista or Windows 7.
Console mode. You can use console mode to install or uninstall locally or remotely
using the installer, an image, or a script on all non-Windows operating systems
supported by Software AG products. You can also use console mode to install or
uninstall using a script on Windows operating systems.
JDK Support
The Software AG Installer installs a separate JDK for the products in the
Software AG_directory/jvm directory and configures the products and the Software AG
Uninstaller to use it. For information on supported JDKs, see the product system
requirements on the Software AG Documentation website.
Important: Do not apply maintenance updates from the vendor of the installed JDK.
If an update to the installed JDK is required, Software AG will provide the
update in the form of a fix.
If you want your products to be able to run in FIPS mode, or use algorithms such as 256-
bit AES, your JVM must use Java Cryptography Extension (JCE) Unlimited Strength
Jurisdiction Policy Files.
The table below explains how to obtain JCE Unlimited Strength Jurisdiction Policy Files.
For Software AG Products Obtain JCE Unlimited Strength Jurisdiction Policy Files
Released at this Time
Ports
The Software AG Installer uses HTTP port 80 to download files over the Internet, or if
you choose to use SSL, port 443.
Logging
By default, the Software AG Installer writes errors that occur during installation to a
file named installLog.txt in the Software AG_directory/install/logs directory. If errors
occur during uninstallation, the Software AG Uninstaller writes them to a file named
uninstallLog.txt and stores the file in the same directory. You can increase or decrease
the amount of information that is wrien, specify a different file name and directory,
and choose to write to standard out and standard error in addition to the log file.
The Software AG Installer writes product, version, and build information to an audit
history log file named history.txt in the Software AG_directory/install/history directory.
The Software AG Installer writes provisioning operations information to a log file
named sag-osgi.log in the Software AG_directory/install/profile/logs directory.
Machine Requirements
Make sure the machine on which you are going to run the installer has at least 1GB
of available virtual memory, and at least 200MB of free disk space in its system temp
(Windows) or temporary (UNIX) directory.
If you are going to create an installation image, make sure the machine on which
you are going to run the installer has at least twice the size of the installation image
in free disk space in the file system that will contain the image file. For example,
if you are going to create the 1GB image MyImage.zip in C:\MyDirectory, file
system C:\ must have at least 2GB free disk space available. This is because the
installer downloads the products to a directory with the same name as the image (for
example, C:\MyDirectory\MyImage) before adding the products to the image, so if
you lose your connection to Empower, you can resume where you left off. To predict
the image size, see the numbers for Free Space Required (for the image) and Free
Space Available (in the file system) in the product selection tree after you select the
products to include in the image.
Make sure the machine on which you are going to run the installer has enough free
disk space in its system temp (Windows) or temporary (UNIX) directory. If you are
going to install from an installation image, you need 200MB of free disk space in that
directory. If you are going to install from an installation image, you need 200MB plus
the size of the image of free disk space in that directory. For example, if the image is
200MB, the directory must have at least 400MB of available disk space.
If you are going to install on a Windows system:
Make sure the machine on which you are going to run the installer has the latest
Windows updates. On Windows 8.1 and Windows Server 2012 R2, installation
will fail if the Microsoft update KB2919355 from April 2014 is not present.
You can only install Software AG products on a local hard drive. You cannot
install the products on a network-mounted drive.
If you are going to install or uninstall on a UNIX system, and you are going to do so
using the GUI, your local machine must be equipped with an X11 display server.
Note: Results from using different X11 display servers may vary. If you
experience problems with one X11 display server, Software AG
recommends trying another. MobaXterm, for example, has been used
successfully with the Software AG Installer.
Access Requirements
If you are going to install on a Windows system, create a user account for performing
the installation, give the account Windows system administrator privileges, and
install as that user. The installation user will own all files you install.
If you are going to install on a UNIX system, create a non-root user account for
performing the installation and install as that user. The installation user will own all
files you install.
If you are going to install new products into an existing Software AG installation
directory (that is, a directory that contains Software AG products from the same
release), use the same user account to install the new products.
The user account must have full read and write permissions to the directory in which
you are going to install your products.
Use the same user account to uninstall products.
product releases, while installation images contain the product releases you
download into them. In addition, installing from images helps you reduce WAN
traffic and improve installation speeds.
Uninstall products using the uninstaller that came with the installer you used to
install the products. For example, if you used the April 2015 Software AG Installer
to install products, use the April 2015 Software AG Uninstaller to uninstall the
products.
This guide provides general instructions for installing and uninstalling. See
your product installation guide for additional, product-specific installation and
uinstallation instructions.
Troubleshooting Downloads
Product jar files and product files downloaded from Empower are verified using
SHA256 checksums.
The installer performs a write check before downloading files. On some
systems using Kaspersky anti-virus software, the write check might fail. If
possible, disable your anti-virus software. If you are installing on Windows
using SoftwareAGInstalleryyyymm .exe, try seing environment variable
ZFUSION_INSTALL_ARGS= -skipWriteCheck and restarting the installer. If UAC is
enabled on the machine, launch a command shell using Run as Administrator and
execute SoftwareAGInstalleryyyymm .exe from inside the shell.
During file download, activity might appear at times to stop completely. The cause
might be that your virus scanner is scanning the files the installer is downloading.
The download will resume after the virus scanner finishes scanning the files.
If your network interferes with the downloading of files, you might have problems
connecting to Empower or see error messages about corrupted Zip files. Try the
following:
Most download issues are caused by interference from a security appliance
such as a virus scanner. Ask your network administrator whether he can make
an adjustment to allow the download to work properly. Also check whether a
proxy must be used to download files properly in the installer. Ask the network
administrator to check the security seings for your proxy or firewall; they might
be incompatible with the installer. If so, ask your IT department for temporary
access to a port outside the firewall to download the files.
Run the installer again, but this time select the Use SSL to connect to the Software
AG Installer Server option on the Proxy panel, and select the Verbose logging level
on the Advanced Options Logging tab. Using SSL may allow installation to
continue despite security appliances because the streams will be encrypted; the
encrypted streams should not trigger anti-virus, anti-malware, or other scanners.
Also test whether your network is handling SSL traffic properly; public websites
are available to help with this diagnoses. The verbose log will give you a great
deal of troubleshooting information, but even if you cannot spot the problem,
you will need to provide the verbose log to Software AG Global Support.
If you have access to another network, try running the same installation on the
other network. If the installation succeeds, create an installation image to use on
machines in the network that is experiencing problems.
If you are still having trouble after trying these options, contact Software AG
Global Support for help. If the issue cannot be resolved after exploring all
possibilities, or if you need an installation image urgently, Software AG Global
Support can contact Software AG Logistics to provide your products on a DVD
or through a private FTP site.
Important: On a Hebrew Windows system, move the exe file to a directory whose
path does not include Hebrew characters. If you cannot do this, you
must instead use the instructions in “Start the Installer on a Mac OS X,
UNIX, or Linux System” on page 26 to install.
b. Copy the product license files aached to the email to the machine on which you
are going to install.
3. Shut down all non-Software AG applications that are running on the machine on
which you are going to install. If these applications are not shut down, product files
might become corrupted.
4. If you are going to install new products into an existing Software AG installation
directory (that contains products from the same release), shut down running
products in that directory so the installer can update key files that are locked by the
operating system. For instructions, see the product documentation.
5. Check the classpath environment variable on the machine on which you are going to
run the installer. If it points to a JRE that is earlier than version 8, either remove the
path or edit the variable to point to a JRE that is version 8 or later.
6. Open Windows Explorer, go to the directory that contains the downloaded installer,
and double-click the SoftwareAGInstalleryyyymm .exe file.
If your temporary directory contains thousands of files, the startup process might
take one minute or longer. The installer will display Initializing system
resources during this time. If you want to speed up this process, delete the files in
your temporary folder.
As you move through the wizard, the installer stores some of the files it requires in
the default system temp directory. If you cancel the installer and later restart it on
the same machine, the installer will use the stored files rather than downloading
them from the installer server again, to improve performance. After installation
concludes successfully, the installer will delete the stored files.
a. Follow the instructions to download the Software AG Installer from the Software
Download Center on Empower.
Note: If you download the bin file and you want to transfer it to another
machine using FTP, use the binary file transfer mode\type. If you use
another mode\type, the bin file might become corrupted.
b. Copy the product license files aached to the email to the machine on which you
are going to install.
3. Shut down all non-Software AG applications that are running on the machine on
which you are going to install. If these applications are not shut down, product files
might become corrupted.
4. If you are going to install new products into an existing Software AG installation
directory (that contains products from the same release):
Shut down running products in that directory so the installer can update key
files that are locked by the operating system. For instructions, see the product
documentation.
Check whether a file named afterInstallAsRootLog.txt exists in the Software AG
installation directory. If it does, execute the Software AG_directory/bin/
beforeInstallAsRoot script.
5. Check the classpath environment variable on the machine on which you are going to
run the installer. If it points to a JRE that is earlier than version 8, either remove the
path or edit the variable to point to a JRE that is version 8 or later.
6. The user file-creation mode mask (umask) can affect the file permissions for newly
created files and directories. Make sure the umask you are using for installation will
not prevent users from accessing and executing these files.
7. If you are going to install on a remote machine, do the following:
a. Allow the remote machine to access your local machine’s X11 display. If
your local machine is a UNIX system, you can use the command xhost
+remote_machine. If your local machine runs a X11 emulation on Windows, you
might have to set a property in your emulation software.
b. Log on to the remote machine and set the shell variable DISPLAY to the value of
your local machine’s X11 display. For example, if you are using a sh, ksh, or bash
shell, you can use export DISPLAY=local_machine:0.0. If you are using a csh
or tcsh shell, you can use setenv DISPLAY local_machine:0.0.
c. Start the installer in the same shell.
d. On Mac OS X, you can only install in GUI mode in the Mac OS X desktop, or in
console mode in a terminal session. There is no way to use a remote X11 display
like with other UNIX systems.
8. Take the action below to start the installer, based on the file you downloaded from
Empower.
UNIX, bin Run the command below. The bin file is a self-extracting
Linux archive that extracts its content into the machine's
temporary directory.
chmod 755 SoftwareAGInstalleryyyymmdd -operating_system .bin
sh SoftwareAGInstalleryyyymmdd -operating_system .bin
You might receive Java messages when you start the installer. For example, you
might receive warning messages about system preferences, or about unlocking
connections. You can ignore these messages.
If your temporary directory contains thousands of files, the startup process might
take one minute or longer. The installer will display Initializing system
resources during this time. If you want to speed up this process, delete the files in
your temporary folder.
To change the temporary directory for Software AG Installer and the bin file extract
location, set the following environment variable before running the bin file:
TMPDIR=<temporary-directory>
export TMPDIR
To reuse the extracted content of the bin file, specify the following before running
the bin file:
SAGINSTALLERDIR=/path/to/installer
export SAGINSTALLERDIR
To specify custom Java options, set the following environment variable before
running the bin file:
SAG_JAVA_OPTIONS=<custom-options>
export SAG_JAVA_OPTIONS
As you move through the installer wizard, the installer stores some of the files it
requires in the default temporary directory. If you cancel the installer and later
restart it on the same machine, the installer will use the stored files rather than
downloading them from the installer server again, to improve performance.
After installation concludes successfully, the installer will delete the stored files in
the default temporary directory and, if you used the bin file, the bin file content.
If the installer can connect to the Software AG Installer server without going through a
proxy, it displays a message to that effect. You can click Next to continue, click AutoDetect
to have the installer auto-detect your proxy servers so you can select one to use, or
manually supply the seings for an HTTP or Socks proxy server.
If the installer cannot connect to the Software AG Installer server without going through
a proxy server but detects a proxy server, it displays a message to that effect. You can
take the same actions as above.
If the installer cannot connect to the Software AG Installer server without going through
a proxy server and does not detect a proxy server, consult your network administrator.
You will not be able to continue installation until the issue is resolved.
Provide Credentials
Provide your Empower user name and password; these credentials tell the installer
which products you have licensed. Click Next. The installer connects to Empower and
verifies your credentials.
Choose Release
Click the product release that includes the products you have licensed and want to
install. Click Next. The installer downloads the list of your products.
For Installation directory, specify the installation directory in which to install your
Software AG products.
Note: If you want to use a symlink for the installation directory, you must use the
symlink every time you install into the directory. For example, you cannot
install some products using a directory name and then later create a symlink
and use it to install more products into the same directory, or vice versa.
When you install using any method, the installer auto-detects a host name or IP address
for the machine on which you are running the installer. You might need to change that
value, as follows:
If the machine has multiple host names or IP addresses, the value detected by the
installer might not be the one you want to use. For example, the installer might
have detected an IP address that is only accessible from inside your organization’s
network. If you want the products to be accessible from outside your organization,
replace the auto-detected value with an externally accessible host name or IP
address.
If you are installing in the cloud, the installer detects the internal IP address of the
cloud instance. If you want your products to be accessible from outside the cloud
instance (for example, from another cloud instance running other products), replace
the auto-detected value with an externally accessible host name or IP address.
If you are creating a script, the installer stores the auto-detected or changed value in the
script. When you install from the script, the installer will use the stored value.
If you are installing on a Windows system, for Start Menu group name, specify the name to
use for the Start menu group for the products you are installing.
Click Next.
Important: The installer does not distinguish among versions (Windows) or flavors
(UNIX) of an operating system. Make sure you install products only on the
supported versions or flavors listed in the products’ system requirements.
The highest level in the product tree shows product names and releases, while the
lower levels show the items that make up or can be used with the product. If you have
already installed a product or item in the specified installation directory, the item name
is followed by the text (Installed) and the item name and its check box are grayed out.
Note: If you later unselect products, the installer does not automatically
unselect the required products. To clear all automatically selected
required products, clear all selections on the tree and make your
product selections again.
If you are creating an image, the installer lists the required products and asks
whether to download them into the image. If the required products are not in the
target installation directories, you must include them in the image. If you do not,
when you try to install from the image, installation will fail.
Note: If a selected product requires other products but those products can be
installed on a different machine, the installer does not automatically select
or list those products.
Configure Products
If configuration values are necessary for products you are installing, the installer asks
for configuration information. For details on product configuration, see the appropriate
product installation documentation.
Important: If you proceed with the installer while products are still running, the
installer might hang in the file copy stage because files it needs are locked, or
your installation could be corrupted. Do not use Task Manager to shut down
processes or your installation could be corrupted.
The installer installs the products and related items, and then displays the installation
complete panel. Click Close.
Important: If you stop the installer or the installer exits during the product configuration
stage, any product that has not yet been configured will appear with the
words (Configuration Incomplete) in the product selection tree in both the
installer and the uninstaller. You must uninstall and reinstall such products.
On the Welcome panel, click Advanced Options, and then click the Images tab.
The table below shows the values for the supported operating systems.
HP11IT HP HP-UX Intel Itanium 2 (for product releases 10.3 and lower)
4. Click OK and go to “Use a Proxy Server” on page 29. You will see all panels
described in that section and the following sections except the installation directory
panel and the product configuration panels; you will see those panels when you
install from the image.
Important: When you select products to download into an image, the installer
lists additional products that are required by the selected products. If
these required products do not already exist in the target installation
directories, you must include them in the image. If you do not, you will
not be able to install the selected products, and in some cases installation
will fail. This includes the Java package; if the Java package does not exist
in the target installation directories, you must include it in the image. The
installer includes the license agreement in every image.
Specify existing images that contain the products you want as described below. It does
not maer which operating systems the images were created for.
You can specify the full path to an image file and click Add.
You can specify directories that contain image files and click Add.
You can create a text file that lists image files, then specify the text file on the panel,
and click Add. For example, the text file could look like this:
C:\IS_HPUX.zip
C:\Designer_Solaris.zip
C:\MwS_Windows.zip
Each time you specify a file or directory, the installer lists it below the Source images
field.
Note: If you specify a file that is not an image file, the installer ignores it.
Create a Script
1. Click Create script and click For product installation.
2. Indicate whether to install products on the local machine during script creation.
3. In the Script file field, type the name of the file in which to save the new script. You
can specify any file name that is permied by your operating system.
By default, the installer will write the new script file to the directory it indicates
when you click OK. If you want to write the file to a different directory, include the
full path to the file in the Script file field. The directory to which you save the file
must already exist.
4. Later in the installer, you will provide your Empower user name and password to
download your products, and this password is stored in the script. If you want to
encrypt the password, provide a master password.
5. If you want to create the script of yourself installing from an image rather than from
Empower, click the Images tab, click Install from image, and type the name of the image
in the Image file field.
6. Click OK, go to “Use a Proxy Server” on page 29, and follow the rest of the
instructions in this chapter.
Important: If you are creating a script that will install products into an existing
Software AG product installation directory, select the installation
directory using the Browse buon. If you type the installation directory
name into the field instead, and you do not exactly match the upper and
lower casing for the directory name, your installation might become
corrupted and possibly unrecoverable.
Important: If you created the script from Empower, the product releases referred to
in the script must be available on Empower or the script will fail. If you
created the script from an image, the image must be in the location it was
in when you created the script or the script will fail.
3. When you created the script, you might have provided a master password to encrypt
the stored Empower password. If so, provide that master password so the installer
can decrypt the Empower password.
4. After a script runs successfully, by default, the installer exits immediately. If you
want the installer to instead display the Finish panel until you choose to exit, select
Display Finish panel.
5. If errors occur while a script is running, installation fails. By default, the installer
shows the errors and does not exit. You can choose instead to Exit immediately or to
Display error then exit after number_of_seconds seconds.
When you created the script, you might have provided a master password to encrypt
the stored Empower password. If so, provide that master password so the installer
can decrypt the Empower password. For example, enter:
set ZFUSION_INSTALL_ARGS= -readScript c:\myScript.txt -masterPassword password
3. Open a command window, go to the directory that contains the installer, and
execute the following:
SoftwareAGInstalleryyyymm .exe
If your company connects to the Internet through an HTTP or Socks proxy server,
you must use that proxy server to install. If you specified proxy information when
you created the script, the installer stored all seings except user name and password
in the script. If you want to override the stored seings, or if you did not specify
proxy information when you created the script, set the environment variable
ZFUSION_INSTALL_ARGS to the appropriate parameters below.
To have the installer use an HTTP proxy server:
set ZFUSION_INSTALL_ARGS=-proxyHost host -proxyPort port -proxyUser user
-proxyPass password
When you created the script, you might have provided a master password to encrypt the
stored Empower password. If so, provide that master password as [masterPassword
password so the installer can decrypt the Empower password.
After a script runs successfully, by default, the installer exits immediately. If you want
the installer to instead allow you to choose when to exit after the script completes,
specify the -scriptNoExit parameter at the end of the command.
If errors occur while a script is running, installation fails. By default, the installer shows
the errors and does not exit. If you want the installer to exit immediately with a non-
zero exit value, specify the -scriptErrorInteract no parameter at the end of the
command. If you want the installer to show the errors and pause for a specified number
of seconds before exiting, specify the -scriptErrorInteract number_of_seconds
parameter at the end of the command.
full path to the file in the Script file field. The directory to which you save the file
must already exist.
4. If the operating system on which you are running the installer is the system that
supports the greatest number of products for which you want to generate images,
click OK, go to “Use a Proxy Server” on page 29, and follow the rest of the
instructions in this chapter.
Otherwise, follow the steps below to indicate the operating system that supports the
greatest number of products for which you want to generate images.
Note: Typically, the operating system that supports the greatest number of
products is Microsoft Windows 64-bit.
Note: This name is needed by the installer but is not used for any purpose.
c. In the Image platform field, click the operating system for which to generate the
image.
d. Go to “Use a Proxy Server” on page 29 and follow the rest of the instructions
in this chapter.
Generate Images
1. Restart the installer.
2. On the Welcome panel, click Advanced Options, and then click the Scripts tab.
3. Click Install from script.
4. In the Script file field, type the full path to the image generation script file you just
created.
Note: If you run a script on a machine with the Windows firewall enabled, you
might get warnings during script execution, which would cause your
script to hang or fail.
8. Click OK and go to “Use a Proxy Server” on page 29. You will see all panels
described in that section and the following sections except the installation directory
panel and the product configuration panels; you will see those panels when you
install from the image.
Important: When you select products to download into an image, the installer
lists additional products that are required by the selected products. If
these required products do not already exist in the target installation
directories, you must include them in the image. If you do not, you will
not be able to install the selected products, and in some cases installation
will fail. This includes the Java package; if the Java package does not exist
in the target installation directories, you must include it in the image. The
installer includes the license agreement in every image.
9. Repeat the previous steps to create an image for each operating system you want.
Important: Do not extract or modify image files using any tool other than the
installer.
The following table lists the value to enter to log specified types of information.
All Verbose
By default, the installer will write the log file to the directory it indicates when you click
OK. If you want to write the file to a different directory, include the full path to the file in
the Log file field.
If the log file reaches the specified maximum size, the installer begins writing a second
file (installLog_part2.txt), and then a third file (installLog_part3.txt), and so on, until
it writes ten files (installLog_part10.txt). It then overwrites the first file, and then the
second file, and so on.
Note: If you want to transfer the bin file to another machine using FTP, use
the binary file transfer mode\type. If you use another mode\type, the
bin file might become corrupted.
b. Copy the product license files aached to the email to the machine on which you
are going to install.
3. Shut down all non-Software AG applications that are running on the machine on
which you are going to install. If these applications are not shut down, product files
might become corrupted.
4. If you are going to install new products into an existing Software AG installation
directory (that contains products from the same release):
Shut down running products in that directory so the installer can update key
files that are locked by the operating system. For instructions, see the product
documentation.
Check whether a file named afterInstallAsRootLog.txt exists in the Software AG
installation directory. If it does, execute the Software AG_directory/bin/
beforeInstallAsRoot script.
5. Check the classpath environment variable on the machine on which you are going to
run the installer. If it points to a JRE that is earlier than version 8, either remove the
path or edit the variable to point to a JRE that is version 8 or later.
6. Run the command below. The bin file is a self-extracting archive that extracts its
content into the machine's temporary directory.
sh SoftwareAGInstalleryyyymmdd -operating_system .bin
You might receive Java messages when you start the installer. For example, you
might receive warning messages about system preferences, or about unlocking
connections. You can ignore these messages.
If your temporary directory contains thousands of files, the startup process might
take one minute or longer. The installer will display Initializing system
resources during this time. If you want to speed up this process, delete the files in
your temporary folder.
To change the temporary directory for Software AG Installer and the bin file extract
location, set the following environment variable before running the bin file:
TMPDIR=<temporary-directory>
export TMPDIR
To reuse the extracted content of the bin file, specify the following before running
the bin file:
SAGINSTALLERDIR=/path/to/installer
export SAGINSTALLERDIR
To specify custom Java options, set the following environment variable before
running the bin file:
SAG_JAVA_OPTIONS=<custom-options>
export SAG_JAVA_OPTIONS
As you move through the installer wizard, the installer stores some of the files it
requires in the default temporary directory. If you cancel the installer and later
restart it on the same machine, the installer will use the stored files rather than
downloading them from the installer server again, to improve performance.
After installation concludes successfully, the installer will delete the bin file content
and the stored files in the default temporary directory.
7. The user file-creation mode mask (umask) can affect the file permissions for newly
created files and directories. Make sure the umask you are using for installation will
not prevent users from accessing and executing these files.
Provide Credentials
Provide your Empower user name and password; these credentials tell the installer
which products you have licensed. The installer connects to Empower and verifies your
credentials.
Choose Release
Choose the product release that includes the products you have licensed and want to
install. The installer downloads the list of your products.
Note: If you want to use a symlink for the installation directory, you must use the
symlink every time you install into the directory. For example, you cannot
install some products using a directory name and then later create a symlink
and use it to install more products into the same directory, or vice versa.
When you install using any method, the installer auto-detects a host name or IP address
for the machine on which you are running the installer. You might need to change that
value, as follows:
If the machine has multiple host names or IP addresses, the value detected by the
installer might not be the one you want to use. For example, the installer might
have detected an IP address that is only accessible from inside your organization’s
network. If you want the products to be accessible from outside your organization,
replace the auto-detected value with an externally accessible host name or IP
address.
If you are installing in the cloud, the installer detects the internal IP address of the
cloud instance. If you want your products to be accessible from outside the cloud
instance (for example, from another cloud instance running other products), replace
the auto-detected value with an externally accessible host name or IP address.
If you are creating a script, the installer stores the auto-detected or changed value in the
script. When you install from the script, the installer will use the stored value.
Important: The installer does not distinguish among flavors of an operating system.
Make sure you install products only on the supported flavors listed in the
products’ system requirements
The highest level of the product tree shows product names and releases, while the lower
levels show the items that make up or are related to the product. If you have already
installed an item in the specified installation directory, the item name is preceded by the
leer I within brackets (that is, [I]).
The installer can display only a limited number of lines in the tree at a time. To page
forward through the tree, enter a plus sign (+). To page backward through the tree, enter
a minus sign (-). To search for a specific product or item, enter S, then enter the name of
the product or item. Enter S again to find the next occurrence of the product or item.
You can select products using the methods below in any combination. The installer puts
an X in the tree next to selected products and items.
Select typical development installations from the Typical Installations list by entering
the appropriate numbers. The installer automatically selects the products that make
up those installations.
Note: You might not see the selections until you page forward through the tree.
Select individual products in the tree by entering the numbers next to the product
headings. Enter each number on a separate line. If a selected product requires other
products on the same machine, the installer does the following:
If you are installing from Empower, the installer automatically selects the
required products.
Note: If you later unselect products, the installer does not automatically
unselect the required products. To clear all automatically selected
required products, clear all selections on the tree and make your
product selections again.
If you are creating an image, the installer lists the required products and asks
whether to download them into the image. If the required products are not in the
target installation directories, you must include them in the image. If you do not,
when you try to install from the image, installation will fail.
Note: If a selected product requires other products but those products can be
installed on a different machine, the installer does not automatically select
or list those products.
Configure Products
If configuration values are necessary for products you are installing, the installer asks
for configuration information. For details on product configuration, see the appropriate
product installation documentation.
Important: Never extract or modify image files using any tool other than the installer.
Create an Image
To create an installation image, specify the -writeImage parameter on the command.
For example:
sh SoftwareAGInstalleryyyymm -operating_system .bin
-writeImage full_path_to_new_image_file -console
You can specify any file name for the image that is permied by your operating system.
Do not specify an extension; the installer will automatically add .zip. The directory to
which you save the file must already exist.
By default, the installer creates the image for the operating system on which you are
running the installer. If you want to create the image for another operating system,
specify the -imagePlatform parameter on the command. For example:
sh SoftwareAGInstalleryyyymmdd -operating_system.bin
-writeImage full_path_to_new_image_file
-imagePlatform operating_system -console
On operating_system, identify the operating system for which to create the image.
The table below lists the values for the operating_system parameter.
Go to “Use a Proxy Server” on page 51. You will see all prompts described in that
section and the following sections except the installation directory panel and the product
configuration panels; you will see those panels when you install from the image.
Important: When you select products to download into an image, the installer lists
additional products that are required by the selected products. If these
required products do not already exist in the target installation directories,
you must include them in the image. If you do not, you will not be able to
install the selected products, and in some cases installation will fail. This
includes the Java package; if the Java package does not exist in the target
installation directories, you must include it in the image. The installer
includes the license agreement in every image.
For existing_image_files, specify existing images that contain the products you
want, as described below. It does not maer which operating systems the images were
created for.
You can specify full paths to image files. For example:
-existingImages /opt/myImages/IS_HPUX.zip,/opt/myImages/Designer_Solaris.zip
You can specify directories that contain image files. For example:
-existingImages /opt/myImages/MyImages
Note: If you specify files that are not image files, the installer ignores them.
Create a Script
To create an installation script, run one of the commands below. You can specify any file
name for the script that is permied by your operating system. The directory to which
you save the file must already exist.
To create an installation script and install products on the local machine, specify the
-writeScript parameter on the command. For example:
sh SoftwareAGInstalleryyyymmdd -operating_system .bin
-writeScript full_path_to_new_script_file -console
To create an installation script of yourself installing from an image rather than from
Empower, specify the -readImage parameter on the command. For example:
sh SoftwareAGInstalleryyyymmdd -operating_system .bin
{-writeScript|-editScript} full_path_to_new_script_file
-readImage full_path_to_existing_image_file -console
To create an installation script from an existing script, specify the -readScript and
-writeScript parameters on the command. For example:
sh SoftwareAGInstalleryyyymmdd -operating_system .bin
-readScript full_path_to_new_script_file
When you created the script, you might have provided a master password to encrypt
the stored Empower password. If so, provide that master password so the installer can
decrypt the Empower password. For example, enter:
sh SoftwareAGInstalleryyyymm -operating_system .bin
-readScript full_path_to_existing_script_file -masterPassword password
By default, you will see the installer run in wizard mode unless you are installing on
a headless system. If you are installing on a headless system, the installer will run in
console mode.
Important: If you created the script from Empower, the product releases referred to in
the script must be available on Empower or the script will fail. If you created
the script from an image, the image must be in the location it was in when
you created the script or the script will fail.
If you are installing on a system that has a monitor, and you want to display the output
on a console, specify the -console parameter. For example:
sh SoftwareAGInstalleryyyymm -operating_system .bin
-readScript full_path_to_existing_script_file -console
If your company connects to the Internet through an HTTP or Socks proxy server, you
must use that proxy server to install. If you specified proxy information when you
created the script, the installer stored all seings except user name and password in
the script. If you want to override the stored seings, or if you did not specify proxy
information when you created the script, specify the appropriate parameters below.
To have the installer use an HTTP proxy server, specify these parameters on the
command:
-proxyHost host -proxyPort port -proxyUser user -proxyPass password
To have the installer use a Socks proxy server, specify these parameters on the
command:
-socksProxyHost host socksProxyPort port
For example:
sh SoftwareAGInstalleryyyymm -operating_system .bin
-socksProxyHost host -socksProxyPort port
-readScript full_path_to_existing_script_file -console
Note: If you are installing on a Windows system and you logged in remotely, you
might experience problems with the Windows graphics subsystem. Try
adding -Djava.awt.headless=true as the first parameter on the command.
Only do this if you experience an actual problem; configuring the installer as a
headless application on Windows systems might trigger a known problem in
Java (see bug JDK-6607186).
After a script runs successfully, by default, the installer exits immediately. If you want
the installer to instead allow you to choose when to exit after the script completes,
specify the -scriptNoExit parameter at the end of the command.
If errors occur while a script is running, installation fails. By default, the installer shows
the errors and does not exit. If you want the installer to exit immediately with a non-
zero exit value, specify the -scriptErrorInteract no parameter at the end of the
command. If you want the installer to show the errors and pause for a specified number
of seconds before exiting, specify the -scriptErrorInteract number_of_seconds
parameter at the end of the command.
You can specify any file name for the image generation script that is permied by your
operating system. The directory to which you save the file must already exist. For
operating_system , specify the operating system that supports the greatest number of
products for which you want to generate images. For most products, that operating
system is Microsoft Windows 64-bit (W64).
Generate Images
1. To generate an installation image from the image generation script, specify the -
readImageScript parameter on the command. For example:
sh SoftwareAGInstalleryyyymm -operating_system .bin
-readImageScript full_path_to_existing_image_generation_script_file
full_path_to_new_image_file -console
You can specify any file name for the image that is permied by your operating
system. Do not specify an extension; the installer will automatically add the
extension .zip. The directory to which you save the file must already exist.
By default, the installer generates the image for the operating system on which you
are running the installer. If you want to generate the image for another operating
system, specify the -imagePlatform parameter on the command. For example:
sh SoftwareAGInstalleryyyymm -operating_system .bin
-readImageScript full_path_to_existing_image_generation_script_file
full_path_to_new_image_file
-imagePlatform operating_system -console
Follow the usual image creation steps to select products and so on.
2. Repeat the previous step to create images for other operating systems.
Note: Generating these images requires no user input, so you can automate the
generation of these images if desired.
Important: Do not extract or modify image files using any tool other than the
installer.
The following table lists the parameters you can specify to change logging options.
Parameter Variables
Parameter Variables
-debugFile Full path to the file to contain the logging information. The
debug_file default is Software AG_directory/install/logs/installLog.txt.
5 Uninstalling
■ Overview ....................................................................................................................................... 64
■ Before You Begin ......................................................................................................................... 64
■ Start the Uninstaller ..................................................................................................................... 65
■ Uninstall Selected Products from Local or Remote Machine ...................................................... 65
■ Uninstall All Products from Local or Remote Machine with No User Input .................................. 66
■ Uninstall Using a Script ............................................................................................................... 67
■ Windows Usage Notes ................................................................................................................. 68
Overview
This chapter explains how to uninstall products using the Software AG Uninstaller.
The chapter provides general instructions for uninstalling; your products might
require additional instructions. See your product installation guide for product-specific
instructions.
8. The uninstaller does not delete files that were created after you installed your
products (for example, user-created or configuration files), nor in most cases does
it delete the directory structure that contains the files. You can delete these files and
directory structure after uninstallation is complete. If you are going to reinstall into
the same directory, you must delete the product directories after uninstallation is
complete or, if you want to save the files, move them.
The uninstaller looks almost identical to the Software AG Installer. You can change the
same logging options that you can change in the installer.
2. After all products are uninstalled successfully, by default, the uninstaller exits
immediately. If you want the uninstaller to instead display the Finish panel until you
choose to exit, select Display Finish panel.
3. If errors occur while products are being uninstalled, uninstallation fails. By default,
the uninstaller shows the errors and does not exit. You can choose instead to Exit
immediately or to Display error then exit after number_of_seconds seconds.
After a script runs successfully, by default, the uninstaller exits immediately. If you want
the uninstaller to instead allow you to choose when to exit after the script completes,
specify the -scriptNoExit parameter at the end of the command.
If errors occur while a script is running, uninstallation fails. By default, the uninstaller
shows the errors and does not exit. If you want the uninstaller to exit immediately
with a non-zero exit value, specify the -scriptErrorInteract no parameter at the
end of the command. If you want the uninstaller to show the errors and pause for
a specified number of seconds before exiting, specify the -scriptErrorInteract
number_of_seconds parameter at the end of the command.
Create a Script
To create an uninstallation script and uninstall products from the local machine,
specify the -writeUninstallScript parameter on the command. For example:
uninstall -writeUninstallScript full_path_to_new_script_file -console
After a script runs successfully, by default, the uninstaller exits immediately. If you want
the uninstaller to instead allow you to choose when to exit after the script completes,
specify the -scriptNoExit parameter at the end of the command.
If errors occur while a script is running, uninstallation fails. By default, the uninstaller
shows the errors and does not exit. If you want the uninstaller to exit immediately
with a non-zero exit value, specify the -scriptErrorInteract no parameter at the
end of the command. If you want the uninstaller to show the errors and pause for
a specified number of seconds before exiting, specify the -scriptErrorInteract
number_of_seconds parameter at the end of the command.
If you uninstalled from a Windows Vista, 2008, or 7 system, you might see a Program
Compatibility Assistant dialog box that says This program might not have
uninstalled correctly. Select the option This program uninstalled correctly.