Using GUI Mode

Start the Installer on a Windows System

  1. Log on to the machine as the installation user you created earlier.
  2. Download the IBM webMethods Installer from Passport Advantage Online.
    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 to install.
  3. Shut down all non-IBM 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 IBM 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. Open Windows Explorer, go to the directory that contains the downloaded installer, and double-click the IBM_webMethods_Install_Windows_x64.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.

Start the Installer on a Mac OS X, UNIX, or Linux System

  1. Log on to the machine as the installation user you created earlier.
  2. Download the IBM webMethods Installer from Passport Advantage Online.
    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.
  3. Shut down all non-IBM 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 IBM 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 IBM installation directory. If it does, execute the Software AG_directory/bin/beforeInstallAsRoot script.
  5. 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.
  6. If you are going to install on a remote machine, do the following:
    1. 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.
    2. 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.
    3. Start the installer in the same shell.
    4. 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.
  7. Take the action below to start the installer, based on the file you downloaded from Passport Advantage Online.

    Operating System File Actions
    Mac OS X dmg Double-click the file.
    UNIX, Linux bin

    Run the command below. The bin file is a self-extracting archive that extracts its content into the machine's temporary directory.

    chmod 755 IBM_webMethods_Install_operating_system.bin
    sh IBM_webMethods_Install_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 IBM webMethods Installer and the bin file extract location, set the following environment variable before running the bin file:
    TMPDIR=<temporary-directory>
    export TMPDIR
    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.

View the Welcome Panel

After you start the installer, the installer displays the Welcome panel. You can resize the GUI.

Use a Proxy Server

proxy server panel

If the installer can connect to the IBM webMethods 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 settings for an HTTP or Socks proxy server.

If the installer cannot connect to the IBM webMethods 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 IBM webMethods 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

release, Empower user name, and Empower password panel

Provide your IBM ID and Entitlement key. Click Next. The installer connects to Passport Advantage Online and verifies your credentials.

Choose Release

release, Empower user name, and Empower password panel

Click the product release that includes the products you want to install. Click Next. The installer downloads the list of your products.

Specify the Installation Directory

installation directory, host name, and start menu group name panel

For Installation directory, specify the installation directory in which to install your IBM 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.
Note: Some third-party applications used by IBM runtime products have limitations regarding spaces in the installation directory. IBM therefore recommends installing in a directory that does not include spaces. However, if you are installing on a Windows system, you can install some IBM design-time products in a directory under Program Files; the installer indicates which products.

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.

Select Products to Install

product selection tree panel

The installer lists all products you can download.

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.

You can select products using these methods:

  • Select typical development installations from the Typical Installations list. The installer automatically selects the products that make up those installations.
  • Select every product in the tree by clicking .
  • Select individual products in the tree. If a selected product requires other products on the same machine, the installer does the following:
    • If you are installing from Passport Advantage Online, 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.

When you are done, click Next.

Select Language Packs to Install

If language packs are available for products you are installing or have already installed, the installer displays the language packs tree. The behavior of this tree is the same as the behavior of the product tree.

By default, the installer installs U.S. English for all products, but many products support multiple languages. You can install as many language packs as you want, and all of the languages installed will be available to users. Select the language packs to install, and then click Next.

Select Product Updates to Install

fixes selection tree panel

When performing product installation in an empty directory for the first time, the IBM webMethods Installer client also installs the most recent updates for your selected products. If the selected installation directory contains other IBM products, the Installer client will not install any product updates and you can use Update Manager or Command Central to install the most recent updates for your products. You can choose whether to install the latest updates for all products or install updates for only a subset of products. Updates can be installed both online and offline and any user data that is needed, for example credentials and proxy settings, is collected from the Installer client.

  • When using an online installation, the Installer client connects to Passport Advantage Online to install all products and updates that you selected.
  • When using an offline installation, a previously created image is used. The image is created using the Installer client and the image must contain the required products, updates, and Update Manager.
    Note: Images created using Command Central or older versions of the Installer client allow you to install only products without updates. Fix images created using Update Manager are not supported.

When creating an image, the latest updates are added to the image by default using Update Manager. After the image is created, Update Manager is removed.

Configure Products

Administrator Password panel

Some products have default admin passwords. When you select one or more of those products on the product selection tree, the Installer displays the Administrator Password panel so you can change the default product administrator password. The password restriction/complexity suggested by the Installer is basic and follows parts of the NIST guidelines.

The Installer asks you to provide an admin password on each run, even when installing into an existing directory. In such cases you can use either the same password, or a different password. Providing a password is mandatory.

When installing products using a script, you provide the administrator password during script execution and can do so through automation.

The Require password change at first product login checkbox is unselected by default. Selecting the checkbox means that the product user will have to change the administrator password at first login.
Note: Product installation and product administration may not be done by the same individual. You can use this checkbox to prompt the product administrator to set a password for production purposes on first login, instead of hardcoding a password in installation scripts.

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.

Review and Install

Review the list of products and items you have selected for installation. If the list is not correct, click Back until you reach the product tree and correct your selections. If the list is correct, click Next.

If you are going to install new products into an existing product installation directory (that contain products from the same release), the sections in this chapter about starting the installer instructed you to shut down running products installed in that directory. On Windows, if any products are still running, the installer lists those products. The PID column in the list shows the process ID as you would see it in Task Manager. The Product column lists the product name as it is shown in the installer product tree. Shut down running products using the instructions in the product 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.

Use Installation Images

Important: Never extract or modify image files using any tool other than the installer.

On the Welcome panel, click Advanced Options, and then click the Images tab.

Advanced Options - Images tab

Create an Image for One Operating System

  1. Click Create image.
  2. In the Image file field, type the name of the file in which to save the new image. You can specify any name that is permitted by your operating system. Do not specify an extension; the installer will automatically add .zip.

    By default, the installer will write the new image 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 Image file field. The directory to which you save the file must already exist.

  3. In the Image platform field, click the operating system for which to create the image. You can create an image for any operating system from any operating system.

    The table below shows the values for the supported operating systems.

    Value Operating System
    AIX IBM AIX
    OSX Apple Mac OS X
    HP11IT HP HP-UX Intel Itanium 2 (for product releases 10.3 and lower)
    HP11 HP HP-UX PA-RISC
    LNXS390X Linux RHEL and SLES IBM System z
    LNX Linux RHEL and SLES x86
    LNXAMD64 Linux RHEL and SLES x86-64 (EM64T, AMD64)
    WNT Microsoft Windows x86
    W64 Microsoft Windows x86-64 (EM64T, AMD64)
    SOL Oracle Solaris SPARC
    SOLAMD64 Oracle Solaris x86-64 (EM64T, AMD Opteron) (for product releases 10.3 and lower)
  4. Click OK and go to Use a Proxy Server. 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.

Install from an Image

  1. Click Install from image.
  2. In the Image file field, type the full path to the image file from which to install.
  3. If you want to list the contents of the image, click Image Contents.
  4. If you want to validate the contents of the image before installing from it, click Validate Image. Validating makes sure that the image is not missing any files and all checksums match.

Use Existing Images to Install Products or Create Images Faster

On the Welcome panel, click Advanced Options, and then click the Caching tab.

Advanced Options - Caching tab

Specify existing images that contain the products you want as described below. It does not matter 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.

Use Installation Scripts

On the Welcome panel, click Advanced Options, and then click the Scripts tab.

Advanced Options - Scripts tab

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 permitted 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 IBM ID and Entitlement key to download your products, and this Entitlement key is stored in the script. If you want to encrypt the Entitlement key, provide a master password.
  5. If you want to create the script of yourself installing from an image rather than from Passport Advantage Online, 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, and follow the rest of the instructions in this chapter.
    Important: If you are creating a script that will install products into an existing IBM product installation directory, select the installation directory using the Browse button. 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.

Edit an Existing Script

Important: Do not edit a script manually, by opening the text file.
  1. Click Edit script.
  2. In the Script file to edit field, browse to the file that contains the script to edit.
  3. If you want to save the edited script under a different name, in the Save script to file field, type the name of the file in which to save the edited script. You can specify any file name that is permitted by your operating system. The directory to which you save the file must already exist.
  4. When you created the script, you might have provided a master password to encrypt the stored Entitlement key. If so, provide that master password so the installer can decrypt the Entitlement key.
  5. Click OK, go to Use a Proxy Server, and follow the rest of the instructions in this chapter.

Install from a Script Using the GUI

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.
  1. Click Install from script.
  2. In the Script file field, type the full path to the script file from which to install.
    Important: If you created the script from Passport Advantage Online, the product releases referred to in the script must be available on Passport Advantage Online 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 Entitlement key . If so, provide that master password so the installer can decrypt the Entitlement key.
  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.

Install from a Script Using the Command Line on Windows Systems

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.

To use the exe file, do the following:

  1. Log on as the installation user you created earlier.
  2. Use the -readScript full_path_to_script_file parameter. For example, enter:
    IBM_webMethods_Install_Windows_x64.exe -readScript C:\myScript.txt

    When you created the script, you might have provided a master password to encrypt the stored Entitlement key. If so, provide that master password so the installer can decrypt the Entitlement key. For example, enter:

    -readScript c:\myScript.txt -masterPassword password
  3. Open a command window, go to the directory that contains the installer, and execute the following:
    IBM_webMethods_Install_Windows_x64.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 settings, including ProxyUser and ProxyPassword in the script. If you want to override the stored settings, or if you did not specify proxy information when you created the script, set the appropriate parameters below:

  • To have the installer use an HTTP proxy server:
    IBM_webMethods_Install_Windows_x64.exe -proxyHost host -proxyPort port -proxyUser user 
    -proxyPass password 
  • To have the installer use a Socks proxy server:
    IBM_webMethods_Install_Windows_x64.exe -socksProxyHost host -socksProxyPort port

When you created the script, you might have provided a master password to encrypt the stored Entitlement key. If so, provide that master password as [masterPassword password so the installer can decrypt the Entitlement key.

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.

Generate Images for Multiple Operating Systems from an Image Generation Script

Create the Image Generation Script

Procedure

  1. On the Welcome panel, click Advanced Options, and then click the Scripts tab.
  2. Click Create script and then click For image generation.
  3. In the Script file field, type the name of the file in which to save the new image generation script. You can specify any file name that is permitted 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. 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, 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.
    1. Click the Images tab and then click Create image.
    2. In the Image file field, type any file name.
      Note: This name is needed by the installer but is not used for any purpose.
    3. In the Image platform field, click the operating system for which to generate the image.
    4. Go to Use a Proxy Server and follow the rest of the instructions in this chapter.

Generate Images

Procedure

  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.
  5. Click the Images tab and then click Create image.
  6. In the Image file field, type the name of the file in which to save the new image. You can specify any name that is permitted by your operating system. Do not specify an extension; the installer will automatically add .zip.

    By default, the installer will write the new image 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 Image file field. The directory to which you save the file must already exist.

  7. In the Image platform list, click the system for which to generate the image.
  8. Click OK and go to Use a Proxy Server. 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.
  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.

Change Logging Options

On the Welcome panel, click Advanced Options, and then click the Logging tab.

Advanced Options - Logging tab

The following table lists the value to enter to log specified types of information.

Type of Information to Log Value
Fatal only Fatal
Fatal and errors Error
Fatal, errors, and warnings Warning
Fatal, errors, warnings, and informational messages Info
All
Note: This logging level produces a 10 to 200 MB file.
Verbose
No information (that is, do not log any information) None

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.