Installing IBM AD Analyze Client

Edit online
Attention:
  • Only one instance of AD Analyze Client can be used on the same machine in case that Authentication Server (DEX) is used for the authentication and authorization.
  • If you want to connect the AD Analyze Client software on a machine or operating system instance to multiple AD Server instances that are all running the same AD Server code level, one copy of the AD Analyze Client software can be installed into an Eclipse/IDz instance, but each AD server connection (IP/Hostname, port, and Unique ID, at a minimum) must be configured in a unique workspace that does not already contain an instance of the AD Analyze Client software's configuration settings.
  • If you want to install multiple code levels of the AD Analyze Client software on the same machine or operating system instance (to connect to different AD Servers running different AD code levels), each level of the AD Analyze Client software can be installed into a separate Eclipse/IDz instance, and also must use a unique workspace that does not already contain the AD Analyze Client software's configuration settings. A workspace in use when the AD Analyze Client software is installed and configured contains the AD Analyze Client software's configuration settings in a folder named: <workspace location>\.metadata\.ez\.settings.

Before you begin

Before you install IBM® AD Analyze Client, you need to install Eclipse or IBM Developer for z/OS® (IDz) first. For more information about the supported versions and download information of Eclipse and IDz, see Prerequisite Software and Configurations.

Take the installation of IDz 15.0.6 as an example.
  1. Download IDz 15.0.6 from this website.
  2. From the list, select IBM Developer for z/OS (IDz or IDz EE).
  3. After you confirm the selection, select the Aqua version that you want in the next screen. For example, select Aqua 3.2.
  4. In the next screen, select the installation client that you want. For example, select Eclipse p2.
  5. In the next screen, select Starting from fresh. Then, click the download link.
  6. After you download IDz, unzip the downloaded file. Then, Open the developer_for_zos.ini in the unzipped folder.
  7. Add the following three parameters to the -vmargs section in the file by placing a hyphen immediately followed by the parameter name. Each parameter needs to be added to a separate line.
    Parameters Descriptions
    Dorg.osgi.framework.os.name=win32 Without this setting, you might compromise code that relies on the original OS name that is coming from the Java™ VM.
    Dsun.awt.noerasebackground=true This system property is used to avoid UI glitches.
    Dsun.java2d.noddraw=true This setting can disable the use of DirectDraw pipeline. GDI will be used instead.
  8. Save and exit.
  9. Open IDz. If it is the first time that you use IDz, you need to create or select a dedicated workspace and make it be the default workspace.

Installation procedure

After the IDz eclipse is opened, install IBM AD Analyze Client by following these steps:

  1. To install IBM AD Analyze Client: In your Eclipse instance, select Window > Preferences.
  2. From the Install /Update section to the left of the Preferences dialog window select Available Software Sites: A list of software sites available for update or install is displayed.
  3. To select the location from where IBM AD Analyze Client is being installed click Add: The Add Site dialog window is displayed.
    • In the Name field, enter a name for your IBM AD Analyze Client installation.
    • If you extracted the installation archive that you received from IBM and you stored it on your computer, use Local and point to the Repository folder generated after the extract operation.
    • If you did not extract the installation archive received from IBM, use Archive button to select the installation archive stored on your computer.
    • If you did not store the installation archive locally but in a location on your intranet, enter the full path to that location in the Location field.

    Click Add. IBM AD Analyze Client will be added to the list of Available Software Sites.

    Click Apply and Close to close the Preferences dialog window and proceed to the next step in the installation process.

  4. In your Eclipse client select Help > Install New Software: The Install dialog window is displayed. In Work with field select the IBM AD Analyze Client site you have defined in the previous step. After you selected the IBM AD Analyze Client site, the corresponding IBM AD Analyze components are displayed in the central part of the dialog window. By default, all the components are selected.
    1. If you are installing AD Analyze Client into IBM IDz, you can choose all the features listed under IBM AD Analyze. For more information, see Explanations of each of the Analyze Client features.
    2. If you are installing AD Analyze Client into an Eclipse package that is not IBM IDz, for example an Eclipse distribution downloaded from eclipse.org, you can choose the features listed under IBM AD Analyze, except you should deselect all features that start with Application Discovery Integration with to avoid errors during the installation process. For more information, see Explanations of each of the Analyze Client features.
    3. Once you have selected the correct features to install in your environment, click Next.

  5. The Install details dialog window is displayed.

    Select a component from the list to display a detailed description of it in the Details section of the dialog window. Click Next

  6. The Review license dialog window is displayed. Carefully read the License agreement then select I accept the terms and press Finish to start the installation process.
  7. After the installation is completed, Eclipse will prompt you for a restart: Accept the restart operation to see the newly installed features.
    Important: After IBM AD Analyze Client has been installed, make sure to configure properly your Eclipse or IDz instance. For more information, see Configuring IBM AD Analyze Client.

Explanations of each of the Analyze Client features

Note: The translation support features that are named similarly to some of the integration features enable the translation and display of labels in IBM AD Analyze Client into non-English languages that IBM AD supports. If you anticipate that you will use a non-English language in your Analyze Client instance, those translation support features that correlate with any other features will be useful.
  • Application Discovery mainframe analysis - This feature provides the core mainframe-centric (as opposed to java-centric) functionality and by choosing this feature you can see/analyze the projects created with mainframe resources.
    Note: This feature is selected by default during the installation process of IBM AD Analyze Client into IBM IDz
  • Application Discovery integration with Common Access Repository Manager (CARMA) - By choosing this feature you can view the contents of the resources in the Editor view (directly from mainframe, and not from the disk repository used by the IBM AD server) when you work with mainframe resources residing in Endeavor. To set up a CARMA connection, you need to have the CARMA feature installed either on the RDz or IDz platform. This feature requires to have an RSE connection to the mainframe and use TSO credentials when viewing the mainframe-based source assets.
  • Application Discovery integration with IBM CICS Explorer® - By choosing this feature you have a new context menu action Application Discovery > Analyze available when a Transaction is selected in Transactions views from CICS Explorer. After you select a mainframe project from the list and the analysis to be performed (for example, Transaction Callgraph), the analysis will be displayed. This feature requires IBM CICS Explorer SDK.
  • Application Discovery integration with IBM CICS® IA® - By choosing this feature you can open an Interdependency Analyzer connection. You can select program names from various CICS IA views (for example, Programs, Command flow) and from the new context menu action Application Discovery > Analyze , you can start an analysis in your IBM AD Analyze Client IDz instance.
  • Application Discovery integration with IBM Data Source Explorer - By choosing this feature you have a new context menu action Application Discovery > Analyze available when a table is selected in Data Source Explorer. After you select a mainframe project from the list and the analysis to be performed (for example, SQL Table Usage), the analysis will be displayed.
  • Application Discovery integration with IBM Explorer for z/OS - By choosing this feature you can view the contents of the resources in the Editor view (directly from mainframe, and not from the disk repository used by the IBM AD server) when you work with mainframe resources in ChangeMan ZMF, and also of type PDS. This feature requires to have an RSE connection to the mainframe and use TSO credentials when viewing the mainframe-based source assets.
  • Application Discovery integration with NPS® Survey - By choosing this feature you can offer feedback in IBM AD Analyze Client that is installed in IBM Developer for z Systems®.
    Note: This feature is selected by default during the installation process of IBM AD Analyze Client into IBM IDz