Downloading and installing CICS Explorer

You can install IBM® CICS Explorer® on your workstation by using the following methods:

  • CICS Explorer for Aqua: This method gives you full IBM support of CICS Explorer and other IBM-provided Eclipse tools. It also supports several installation methods (see Table 3 for details).
  • CICS Explorer on Eclipse Marketplace: This method gives flexibility to use your own version of Eclipse and has full access to the set of plug-ins that are available on Eclipse Marketplace.

Downloading CICS Explorer for Aqua

To download CICS Explorer for Aqua, see Install Eclipse Tools. This interactive site guides you to locate and use the installation files required.

If you are not sure of which version to install or which installation method to use, read further.

Choose a required version of CICS Explorer

Eclipse, z/OS® Explorer, and CICS Explorer are packaged as a part of the Aqua release train of compatible Eclipse plug-ins. Each version of the release train is based on a different version of Eclipse.

Table 1 shows each version of CICS Explorer and its underlying platform. Ready-to-run packages are available as .zip files for quick installation on the Mainframe Downloads website.

CICS Explorer is compatible with earlier versions, so you can always install the latest fix pack available and connect it to any version of CICS® TS. If you are using an earlier version of CICS Explorer, Table 2 shows the highest version of CICS TS that different versions of CICS Explorer can support.

Table 1. Reference table for CICS Explorer versions and platforms
Eclipse version Platform CICS Explorer Fix Pack
2022-03 or 2024-03 Eclipse plug-in downloaded from Eclipse Marketplace 5.5.x
2024-03 Aqua 3.4 release train 5.5.x
2022-03 Aqua 3.3 release train 5.5.x
Table 2. Compatibility reference table for CICS Explorer and CICS TS
CICS Explorer Fix Pack numbers Supported CICS TS releases
5.5.45 CICS TS 6.3 (full support) and earlier
5.5.44 CICS TS 6.3 and earlier

CICS Explorer 5.5.44 connects to CICS TS 6.3 regions, but does not support the new features that are introduced with CICS TS 6.3.

5.5.36 or later CICS TS 6.2 (full support) and earlier
5.5.35 CICS TS 6.2 and earlier

CICS Explorer 5.5.35 connects to CICS TS 6.2 regions, but does not support the new features that are introduced with CICS TS 6.2.

5.5.22—5.5.35 CICS TS 6.3 and earlier
5.5.0.9—5.5.21 CICS TS 5.6 and earlier
5.5.0.1—5.5.0.8 CICS TS 5.5 and earlier

For more information, see z/OS Explorer, CICS Explorer, and CICS tools plug-ins release compatibility reference tables.

Install or upgrade CICS Explorer for Aqua

If you use CICS Explorer for Aqua, you cannot directly upgrade from one Aqua version to another because the Eclipse platform underneath is different.

  • To upgrade from one Aqua version to another, for example to upgrade CICS Explorer from Aqua 3.3 to Aqua 3.4, you need to install a new copy of CICS Explorer.
  • To get the latest fix pack within your current Aqua version, you can upgrade CICS Explorer in the same way as it was installed.

Prerequisites

Choose an installation method

You can choose to install CICS Explorer through CICS Explorer for Aqua or from Eclipse Marketplace, depending on your needs.

CICS Explorer for Aqua: Why?
  • You want full IBM support for both CICS Explorer and the Eclipse platform.
  • You want to use full suite of the Eclipse tools provided by IBM, including IDz, CICS tools, and other tools, in addition to CICS Explorer.
For more details on installation, see Install CICS Explorer for Aqua.
CICS Explorer on Eclipse Marketplace: Why?
  • You want the Liberty Developer Tools (LDT) to work with Open Service Gateway Initiative (OSGi) applications, which is not provided with CICS Explorer for Aqua.
  • You want to use your own version of Eclipse.
For more details on installation, see Install CICS Explorer from Eclipse Marketplace.

Install CICS Explorer for Aqua

You can obtain CICS Explorer for Aqua from Install Eclipse Tools. Several installation methods are supported, as summarized in Table 3. If you already know which method to choose, go to Install Eclipse Tools for a quick download. Whichever installation method you choose, Install Eclipse Tools guides you through the installation process.
  • The IBM CICS SDK for Enterprise Java (Liberty) is a separate feature that supports Liberty application development. You can either install it with CICS Explorer or add it later, as described for each method in Table 3.
  • If you want to install an earlier version of CICS Explorer, follow the instructions that are given in Downloads for older releases of IBM Explorer for z/OS and IBM CICS Explorer.
  • To install CICS Explorer for Aqua on MacOS, you must follow the instructions that are given in this technote to bypass the security restrictions.
  • Installation instructions focus on scenarios where you use the public online repository for installation and updates. If you want to host an internal repository within your enterprise, choose Hosting an internal repository as your starting point in the wizard.
Table 3. Comparison of different ways of installing CICS Explorer for Aqua
Installation method Scenarios How to install
Installing a stand-alone CICS Explorer by using a CICS Explorer for Aqua .zip file The quickest way to install CICS Explorer if you're starting from scratch, that is, if you don't have Eclipse or IBM Installation Manager installed.

It installs CICS Explorer as a stand-alone product. Use the Eclipse p2 update site to install updates or more features.

In Install Eclipse Tools, choose Eclipse p2 as your installation client and Starting from fresh as your starting point.

The IBM CICS SDK for Enterprise Java (Liberty)1 is not included in the compressed file. You must install it separately.

Installing CICS Explorer by using IBM Installation Manager2 Install CICS Explorer either as a stand-alone product or into an existing Installation Manager-based Eclipse instance.

Use IBM Installation Manager to install updates or more features.

In Install Eclipse Tools, choose IBM Installation Manager as your installation client.

If you want to install the IBM CICS SDK for Enterprise Java (Liberty)1, you can select the feature during installation or install it later.

Installing CICS Explorer into existing Eclipse by using Eclipse p2 Install CICS Explorer into an existing Eclipse product.

Use the Eclipse p2 update site to install updates or more features.

In Install Eclipse Tools, choose Eclipse p2 as your installation client and Extending an existing Eclipse instance as your starting point.

If you want to install the IBM CICS SDK for Enterprise Java (Liberty)1, you can select the feature during installation or install it later.

1 As of Aqua 3.3, the SDK does not support WDT anymore, but you can find alternative solutions in Consideration for OSGi applications when installing CICS Explorer.

2 To install CICS Explorer for Aqua 3.3 or CICS Explorer for Aqua 3.4, you must use IBM Installation Manager 1.10.1 or higher.

Install CICS Explorer from Eclipse Marketplace

To install CICS Explorer from Eclipse Marketplace:
  1. Install an Eclipse client that Eclipse Marketplace: IBM CICS Explorer solution supports. For example, Eclipse 2022-03.
  2. Install CICS Explorer by using one of the following methods:
    • Open CICS Explorer. Click Help > Eclipse Marketplace from the main menu of the workbench. Search for ibm cics explorer using the search bar that is present on the screen. Follow the instructions that are given to install.
    • Go to Eclipse Marketplace: IBM CICS Explorer solution on the Eclipse Marketplace site. Follow the instructions that are given to install.

Verify your CICS Explorer installation

  1. Start CICS Explorer. For detailed instructions, see Starting CICS Explorer.
    • To start CICS Explorer for Aqua, double-click the zosexplorer.exe file (zosexplorer on Linux or macOS), in a subdirectory called zosexplorer.
    • To start CICS Explorer on Eclipse Marketplace, open the Eclipse client where the CICS Explorer is installed from Eclipse Marketplace.

    You can start CICS Explorer with a different workspace and save it in a different location by using a CICS Explorer shortcut. See Changing the CICS Explorer workspace location for more details.

  2. Connect your CICS Explorer to a CICS system. For detailed instructions, see Connecting CICS Explorer to CICS systems.