Downloading and starting CICS Explorer

You can install the CICS Explorer® client onto your local workstation in several ways. You must update CICS Explorer in accordance to how it was installed.

Install or upgrade?

As of 12 June, 2020, IBM® CICS Explorer is branded to include the version of the IBM Explorer for z/OS® (z/OS Explorer) platform it's based on. If you're using a CICS Explorer V5.5 client, it will become CICS Explorer for Aqua V3.21 with your next fix pack update. If you are using an earlier release of CICS Explorer, you must install a new copy because earlier releases are based on different versions of Eclipse. See Appendix. Compatibility of CICS Explorer for a list of available CICS Explorer releases.

Prerequisites

Make sure that your operating system meets the system requirements as described on CICS Explorer Detailed System Requirements.

Before you begin

Before you install CICS Explorer, always read the CICS Explorer release notes for the latest information, including limitations and restrictions, about CICS Explorer.

If you are already using CICS Explorer, you might want to back up its workspace before you upgrade CICS Explorer to a new release.

Choose an installation method

The following tables lists different ways of installing CICS Explorer. If you already know which method to choose, go to Install Eclipse Tools for a quick download.

Note: The IBM CICS® SDK for Java™ EE, Jakarta EE and 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 the table.
Table 1. Installation methods for CICS Explorer
Installation methods Scenarios How to install2
Installing a stand-alone CICS Explorer using a compressed download file The quickest way to install CICS Explorer if you're starting from scratch, that is, you don't have Eclipse or Installation Manager installed.

It installs CICS Explorer as a stand-alone product. You must use the Eclipse p2 update site to install updates or additional features.

Go to Install Eclipse Tools and follow the instructions there to install. Choose Eclipse p2 as your installation client and Starting from fresh as your starting point.

The IBM CICS SDK for Java EE, Jakarta EE and Liberty is not included in the compressed file. You must install it separately.

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

You must use Installation Manager to install updates or additional features.

Go to Install Eclipse Tools and follow the instructions there to install. Choose IBM Installation Manager as your installation client.

If you want to install the IBM CICS SDK for Java EE, Jakarta EE and Liberty, 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.

You must use the Eclipse p2 update site to install updates or additional features.

Go to Install Eclipse Tools and follow the instructions there to install. 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 Java EE, Jakarta EE and Liberty, you can select the feature during installation or install it later.

Note: If you want to install an earlier release of CICS Explorer, go to Downloads for older releases of IBM Explorer for z/OS and IBM CICS Explorer and follow the instructions there.

Start CICS Explorer

To start CICS Explorer, double-click the zosexplorer.exe file (zosexplorer on Linux® or macOS), in a subdirectory called zosexplorer.

When CICS Explorer starts for the first time, a welcome screen is displayed and a workspace directory is created.

The workspace directory saves data and configuration files of CICS Explorer, including:
  • Connection details for connecting to CICS systems or CICSPlex® SM WUI servers
  • User IDs for accessing CICS systems or CICSPlex SM
  • User-customized view and perspective information
  • User files, for example bundled projects and text files that are created in the CICS Explorer Resource perspective.

By default, the workspace directory is called .zosexplorer and is located in your local user directory.

If you do not want to update your default workspace, start CICS Explorer with a different workspace by using the -data option to specify a new target path for the workspace. For example, to start CICS Explorer and create a new workspace in the location c:\my_cicsexplorer_workspace, use the following command:

C:\zosexplorer\zosexplorer.exe -data c:\my_cicsexplorer_workspace

To start CICS Explorer with a different workspace by using a CICS Explorer shortcut, see Changing the CICS Explorer workspace location.

1 Aqua refers to IBM Explorer for z/OS Aqua.
2 The 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.