Getting started

To install one or more product offerings under IBM Explorer for z/OS Aqua, use the product table to determine which installation options (IBM Installation Manager and/or Eclipse p2) are available for the specific product you're looking for.

What is IBM z/OS Explorer Aqua?

What is the difference between Aqua 3.0, 3.1 and 3.2?

Can I upgrade an Aqua 3.0 environment directly to Aqua 3.1 or 3.2?

How do I install an offering from the Aqua release train?

How do I know whether or not a specific product is offered through the IBM Installation Manager or Eclipse p2 method?

Is it possible to install Aqua products onto an offline environment?

IBM Explorer for z/OS Aqua


  • Pre-packaged repository zip files are only available for products that are supported on Eclipse Neon 4.6 (Aqua 3.1)
  • [1] IBM Developer for z/OS V14.1.6 or later and IBM Rational Programming Patterns 9.6.1 (latest Aqua 3.1) cannot be installed together. See this tech note for more details.
  • [2] If installing through p2, only V14.2.x is available; IDz V14.2.x cannot shell-share with IBM RPP
  • [3] RTC is renamed to EWM(Engineering Workload Manager) starting from v7.0. See this tech note for details / installation steps for older versions of RTC
  • [ ! ] See here for shell-share compatibility

Zowe Integration

IBM Wazi for Red Hat CodeReady Workspaces


[1] Recommended for enterprise deployment


IBM Installation Manager (IM)

Install a new Installation Manager for online product installation

Install options Windows (32/64-bit) Linux (32/64-bit) MacOS (64-bit)
IM for z/OS Explorer Aqua V3.0
(Eclipse Luna V4.4)
IM for z/OS Explorer Aqua V3.1
(Eclipse Neon V4.6)
IM for z/OS Explorer Aqua V3.2
(Eclipse Photon V4.8)

  1. Download one of the installation packages
  2. Unzip and install IBM Installation Manager (IM) using one of the following options.

    Operating System User Install Administrator Install
    Windows imLauncherWindowsUser.bat imLauncherWindows.bat
    Linux imLauncherLinuxUser.sh imLauncherLinux.sh
    OS X InstallerImage_macosx_cocoa_x86_64/Userinst.app InstallerImage_macosx_cocoa_x86_64/Install.app or imLauncherMac.sh
    • User Install uses the home directory of the current user
    • Administrator Install requires administrative privileges and typically uses a common install directory that is accessible to all users
  3. Restart IM after installation
  4. In IM, click Install to view and select product offering(s) for installation

Other installation options including silent and group installation are detailed in IBM Installation Manager documentation under Installing as an administrator, nonadministrator, or group together with a full list of the installation locations for each operating system.

If you are planning deployment to many systems at once consult Using IBM Installation Manager for Enterprise Deployment.


Use an existing Installation Manager for online product installation

  1. Update IBM Installation Manager to a version specified below:
    • For Aqua 3.0 (Eclipse Luna V4.4), please update to version 1.8.5.1 or later - for more information, please refer to this tech note.
    • For Aqua 3.1 (Eclipse Photon V4.6) and Aqua 3.2 (Eclipse Neon V4.8), please update to version 1.9.1 or later.
  2. Launch IBM Installation Manager
  3. Click File → Preferences → Add Repository
  4. Add the applicable repository URL:
    • z/OS Explorer Aqua V3.0 (Eclipse Luna V4.4) https://public.dhe.ibm.com/ibmdl/export/pub/software/htp/zos/tools/aqua/
    • z/OS Explorer Aqua V3.1 (Eclipse Neon V4.6) https://public.dhe.ibm.com/ibmdl/export/pub/software/htp/zos/tools/aqua3.1/
    • z/OS Explorer Aqua V3.2 (Eclipse Photon V4.8) https://public.dhe.ibm.com/ibmdl/export/pub/software/htp/zos/tools/aqua3.2/
    • Your local product repository file path for offline installation, for example C:\my-local-IM-repository\repository.config
  5. Click Install to view and select product offering(s) for installation

For Rational Developer for z Systems (RDz) users, you may directly upgrade RDz V9.5.x to IDz V14 using IM. However, if you are currently using RDz V8.0, 9.0 or 9.1, you must perform a fresh installation of IDz V14 after you have uninstalled RDz. For more information, please refer to the blog “Where oh where has RDz gone?”.

- To install IBM Debug for z/OS, you will need to select the IBM Developer for z/OS offering. More details can be found here: Installing IBM Debug for z/OS.

- If you are using an earlier version of installation manager it is recommended you upgrade to the latest version. More details can be found here: Installing or updating Installation Manager


Download product repositories for offline installation

There are two ways to prepare the files needed for the local repository which will be used as the offline source for IBM Installation Manager. In the sections below, you can choose to use IBM Packaging Utility or use pre-packaged repository zip files (only supports IBM Explorer for z/OS Aqua 3.1, Eclipse Neon V4.6) to prepare a local or offline repository.

Use IBM Packaging Utility to prepare a local repository

  1. Download and install IBM Packaging Utility
    • Optionally, if you do not have an existing IM, proceed to download the IM installation package from here and follow the instructions to install IM.
  2. Launch IBM Packaging Utility and select "Open Packages"
  3. Click on “Open Repository” and add the applicable repository URL into the field:
    • z/OS Explorer Aqua V3.0 (Eclipse Luna V4.4) https://public.dhe.ibm.com/ibmdl/export/pub/software/htp/zos/tools/aqua/
    • z/OS Explorer Aqua V3.1 (Eclipse Neon V4.6) https://public.dhe.ibm.com/ibmdl/export/pub/software/htp/zos/tools/aqua3.1/
  4. Select the offerings that you wish to include in your customized repository package
  5. Click “Next” and then specify the directory of your customized repository, click “Copy” to confirm and begin the operation
  6. Once the operation has been completed, compress the directory into a zip file which can then be transferred to the offline environment
  7. In the offline environment, extract the archive into a local directory and proceed with installing products from this local repository by following the instructions here

Use pre-packaged repository zip files to prepare a local repository

IBM Explorer for z/OS Aqua 3.1 (Eclipse Neon V4.6)

  1. Refer to the table below and download the repository zip file
  2. Product Name Download Minimum Prerequisite
    IBM Application Discovery IBM Explorer for z/OS
    IBM Application Performance Analyzer for z/OS IBM Explorer for z/OS
    IBM CICS Configuration Manager IBM CICS Explorer
    IBM CICS Deployment Assistant IBM CICS Explorer
    IBM CICS Explorer IBM Explorer for z/OS
    IBM CICS Interdependency Analyzer IBM CICS Explorer
    IBM CICS Performance Analzyer IBM CICS Explorer
    IBM CICS Transaction Gateway IBM CICS Explorer
    IBM Data Studio N/A
    IBM Debug for z/OS Included in IBM Developer for z/OS
    IBM Developer for z/OS 14.1.x N/A
    IBM Developer for z/OS 14.2.x N/A
    IBM Developer for z/OS Enterprise Edition N/A
    IBM Explorer for z/OS N/A
    IBM Fault Analyzer for z/OS IBM Explorer for z/OS
    IBM File Manager for z/OS IBM Explorer for z/OS
    IBM IMS Configuration Manager N/A
    IBM IMS Connect Extensions for z/OS N/A
    IBM IMS Explorer for Development (V3.3) N/A
    IBM Monitoring and Diagnostic Tools - Health Center Eclipse 4.x client
    IBM MQ Explorer IBM Explorer for z/OS
    IBM Rational Programming Patterns N/A
    IBM Rational Team Concert Eclipse 4.x client
    IBM Rational Team Concert for z/OS Eclipse 4.x client
    IBM z/OS Connect (V3) IBM Explorer for z/OS
  3. In the offline environment, extract the archive into a local directory and proceed with installing products from this local repository by following the instructions here

IBM Explorer for z/OS Aqua 3.2 (Eclipse Photon V4.8)

  1. Refer to the table below and download the repository zip file
  2. Product Name Download
    Aqua 3.2 All IM Repo Zip
  3. In the offline environment, extract the archive into a local directory and proceed with installing products from this local repository by following the instructions here

Eclipse (p2)

Download a full version of the explorer platform for online product installation

Download the Eclipse package for IBM Explorer for z/OS Aqua release by selecting one of the following platforms and architectures and perform the following steps to install the product:

Eclipse Luna V4.4

Install Options Windows (32-bit) Windows (64-bit) Linux (32-bit) Linux (64-bit) MacOS (64-bit)
IBM Explorer for z/OS V3.0
IBM CICS Explorer V5.3

Eclipse Neon V4.6

Install Options Windows (32-bit) Windows (64-bit) Linux (32-bit) Linux (64-bit) MacOS (64-bit)
IBM Explorer for z/OS V3.1
IBM CICS Explorer V5.4
IBM Developer for z/OS V14.2

Eclipse Photon V4.8

Install Options Windows (32-bit) Windows (64-bit) Linux (32-bit) Linux (64-bit) MacOS (64-bit)
IBM Explorer for z/OS V3.2
IBM CICS Explorer V5.5
IBM Developer for z/OS V15.0
  1. Unzip and start using the chosen application
    • IBM Z Open Development on MacOS only: after extracting the client file contents, move the application to the "Applications" folder so that it is possible to update to a new release - updates are not possible when the client files are placed in a different folder.
  2. (Optional) To install one or more features from the Eclipse p2 update site for IBM Explorer for z/OS Aqua release
    • Click Help → Install New Software → Add
    • Select to work with “IBM Explorer for z/OS Update site”
    • Select and install one or more available installation packages
  • [ ! ] For MacOS compatibility, see this tech note

Use an existing Eclipse for online product installation

If you have an existing instance of Eclipse (Luna V4.4 or Neon V4.6), perform the following steps to add the Eclipse p2 update site for IBM Explorer for z/OS Aqua release:

  1. Launch Eclipse
  2. Click Help → Install New Software → Add
  3. Add the applicable repository URL:
    • z/OS Explorer Aqua V3.0 (Eclipse Luna V4.4) https://public.dhe.ibm.com/ibmdl/export/pub/software/htp/zos/tools/aqua/
    • z/OS Explorer Aqua V3.1 (Eclipse Neon V4.6) https://public.dhe.ibm.com/ibmdl/export/pub/software/htp/zos/tools/aqua3.1/
    • z/OS Explorer Aqua V3.2 (Eclipse Photon V4.8) https://public.dhe.ibm.com/ibmdl/export/pub/software/htp/zos/tools/aqua3.2/
  4. At the bottom of the window, enable the checkbox for "Group items by category" to view the list of all individual features
  5. Select and install one or more available installation packages by following the provided steps
  6. If your existing Eclipse was packaged with a version of RSE (Remote System Explorer), you may run into a version conflict during installation
    • To resolve this error, check "Show original error and build my own solution" and "Remove items already installed" when the Install Remediation panel is presented
    • See this page for more information

Download product p2 update sites for offline installation

Users who are looking to perform offline installations through Eclipse p2 can do so by downloading one of the options below:

  • Download the entire update site repository for p2

    Install options Included offerings Download
    z/OS Explorer Aqua V3.0 update site package
    (Eclipse Luna V4.4)
    • IBM Application Discovery
    • IBM Application Performance Analyzer for z/OS
    • IBM CICS Configuration Manager
    • IBM CICS Deployment Assistant
    • IBM CICS Explorer
    • IBM CICS Interdependency Analyzer
    • IBM CICS Performance Analyzer
    • IBM CICS Transaction Gateway
    • IBM Explorer for z/OS
    • IBM Fault Analyzer for z/OS
    • IBM File Manager for z/OS
    • IBM MQ Explorer
    • IBM Rational Team Concert
    • IBM z/OS Connect EE
    z/OS Explorer Aqua V3.1 update site package
    (Eclipse Neon V4.6)
    • IBM Application Discovery
    • IBM Application Performance Analyzer for z/OS
    • IBM CICS Configuration Manager
    • IBM CICS Deployment Assistant
    • IBM CICS Explorer
    • IBM CICS Interdependency Analyzer
    • IBM CICS Performance Analyzer
    • IBM CICS Transaction Gateway
    • IBM Debug for z/OS
    • IBM Developer for z/OS
    • IBM Explorer for z/OS
    • IBM Fault Analyzer for z/OS
    • IBM File Manager for z/OS
    • IBM IMS Configuration Manager
    • IBM IMS Connect Extensions for z/OS
    • IBM Java Health Center
    • IBM MQ Explorer
    • IBM Rational Team Concert
    • IBM z/OS Connect EE
    z/OS Explorer Aqua V3.2 update site package
    (Eclipse Photon V4.8)
    • IBM Application Discovery
    • IBM Application Performance Analyzer for z/OS
    • IBM CICS Configuration Manager
    • IBM CICS Deployment Assistant
    • IBM CICS Explorer
    • IBM CICS Interdependency Analyzer
    • IBM CICS Performance Analyzer
    • IBM CICS Transaction Gateway
    • IBM Explorer for z/OS
    • IBM Debug for z/OS
    • IBM Developer for z/OS
    • IBM Fault Analyzer for z/OS
    • IBM File Manager for z/OS
    • IBM IMS Configuration Manager
    • IBM IMS Connect Extensions for z/OS
    • IBM Java Health Center
    • IBM MQ Explorer
    • IBM z/OS Connect EE

  • Download individual repository zip files for p2 (IBM Explorer for z/OS Aqua 3.1 - Eclipse Neon V4.6 only)

    Product Name Download Minimum Prerequisite
    IBM Application Discovery IBM Explorer for z/OS
    IBM Application Performance Analyzer for z/OS IBM Explorer for z/OS
    IBM CICS Configuration Manager IBM CICS Explorer
    IBM CICS Deployment Assistant IBM CICS Explorer
    IBM CICS Explorer IBM Explorer for z/OS
    IBM CICS Interdependency Analyzer IBM CICS Explorer
    IBM CICS Performance Analzyer IBM CICS Explorer
    IBM CICS Transaction Gateway IBM CICS Explorer
    IBM Debug for z/OS IBM Developer for z/OS
    IBM Developer for z/OS 14.2.x N/A
    IBM Explorer for z/OS N/A
    IBM Fault Analyzer for z/OS IBM Explorer for z/OS
    IBM File Manager for z/OS IBM Explorer for z/OS
    IBM IMS Configuration Manager N/A
    IBM IMS Connect Extensions for z/OS N/A
    IBM Monitoring and Diagnostic Tools - Health Center Eclipse 4.x client
    IBM MQ Explorer IBM Explorer for z/OS
    IBM Rational Team Concert Eclipse 4.x client
    IBM Rational Team Concert for z/OS Eclipse 4.x client
    IBM z/OS Connect (V3) IBM Explorer for z/OS

For a detailed guide on how proceed with offline installation through Eclipse p2, please see this blog post: Deploying IBM z/OS Explorer Aqua to users without internet access.

Documentation

For online documentation, please refer to the product table on the downloads page and click on the icon under the "Documentation" column.

For offline or locally hosted documentation, please see this page for the IBM Knowledge Center Installer for IBM Explorer for z/OS Aqua.