IBM Support Assistant Lite for Rational Developer for System z

News


Abstract

This document describes how to use the IBM Support Assistant Lite (ISA Lite) for IBM Rational Developer for System z products. IBM Support assistant Lite is a tool that provides an automated way for user to gather initial data needed for the Rational support team to analyze problems relating to the Rational Developer for System z product.

Content

ISA Lite for Rational Developer for System z is a customized subset of the IBM Support Assistant Workbench that provides automated data collection capability specific for Rational Developer for System z. If you do not have IBM Support Assistant Workbench installed and need to provide information for our support team, you can use this to quickly gather information needed for troubleshooting.

ISA Lite is currently available for the following versions of Rational Developer for System z (RDz):

  • RDz 7.6
  • RDz 8.0.1

IMPORTANT: The data collection tool will ask for the user credentials and configuration directory location to obtain the host data during a server collection. A "Skip" option is available if these information are not available at the time of collector execution.

Five data collectors are now available as part of this delivery.

  • Installation Manager Collector. Use this collector for general installation related issue on products that leverages IBM Installation Manager. This collector is included in this package, but description are documented here: Installation Manager Collector
  • Client Log Collector - for Problem Recreation. Use this data collector if you can consistently re-create the problem you see on the RDz product. This will enable debug trace settings on the RDz workspace you have a concern with, and guide you through problem recreation steps. Optionally, user can gathers server information if provided with host credentials and configuration directory path. When done, the tool will disable trace and gather logs. Detailed description: Client Log Collector - for Problem Recreation
  • Client Log Collector - Without Problem Recreation. Use this data collector if you just want to gather trace logs for a problem you see on the RDz product. The tool will only gather logs - similar to above, but will not enable/disable trace settings. Optionally, user can gathers server information if provided with host credentials and configuration directory path. Detail Description: Client Log Collector - Without Problem Recreation
  • Client Workspace Collector - Use this data collector to provide your RDz workspace for our support team. Details: Client Workspace Collector
  • Remote System Log Collector. Use this data collector to gather remote system logs via ftp. Details: Remote System Log Collector



*NEW* Web enabled data collection tool - ISA Data Collector for Rational Developer for System z v.8.0.1 is available!
  • Please review information on ISA Data Collector here first. This includes system requirement and browser support.
  • Click here to access the collector specific for RDz v8.0.1.
  • All the collection options below are available.

Details about each of the data collector options are described below.


Prerequisites
Downloading and Launching ISA Lite
Using ISA Lite
Details: Client Log Collector - for Problem Recreation
Details: Client Log Collector - Without Problem Recreation
Details: Client Workspace Collector
Details: Remote System Log Collector
Data Collector Completion Options & Uploads

Prerequisites

  • You need an IBM ID and password to download ISA Lite. Register here if you do not already have one.
  • You need Java JRE 1.4.2 or greater on your machine to run ISA Lite. A valid JDK is available if you have Installation Manager, or any Rational eclipse based product installed on your system. Some common locations:
    • <Installation Manager Install Location>\eclipse\jre_5.0.4.sr11_20091106a\jre
    • <RationalSDLC location>\jdk\jre


Downloading and Launching ISA Lite
  1. Download ISA Lite for Rational System Developer for z from:
  2. Extract the .zip file in a folder.
    • If your platform does not have unzip utility, you can use jar to unzip file. Example: jar xf ISALiteforRDz_76_20110401_134.zip (or ISALiteforRDz_80x_20110802_134.zip)
  3. In the same folder, cd ISALite
  4. If Java is available in your path , simply run: runISALite.bat
  5. If Java is not available on your path, ISA Lite will prompt you for the path. You can also set JAVA_HOME first:
    • set JAVA_HOME=<your full path to Java> This path should point to the bin directory in your Java installation, containing java.exe.
    • Example: set JAVA_HOME=C:\Program Files\IBM\SDP_RDP76\jdk\jre
    • Once this is completed, run: runISALite.bat or runISALite.bat -console to run in console mode.



Using ISA Lite (non-console mode)

Once you've launched ISA Lite:
  1. Select a collector to run that fits your needs. Overview of collector is listed in the above section.
  2. Fill in the Filename field.
  3. Click the Collect Data button to start data collection.
  4. (Optional) Click on "Show execution details" to see the collector execution details.
  5. When finished, simply close the window.
    ISALite with list of collection options
    You can check the " Show execution details" box on ISALite to view the detailed collector execution.

Using ISA Lite (silent mode)
To automate ISA collection and/or to run silently, please review the following two documents that discuss performing a silent recording, and a silent playback via command line:

http://www.ibm.com/support/docview.wss?uid=swg27017356
see section : Using ISA Lite for Remote Collection, starting at "To further simplify ..."

Using this technique you can record an ISA Lite execution, and subsequently playback via command line silently.



Details: Client Log Collector - for Problem Recreation

IMPORTANT: This collector will require that you close and restart your application for problem recreation.

Use this data collector if you can consistently re-create the problem you see on the RDz product. This collector will enable debug trace settings on the RDz workspace you have a concern with and guide you through problem recreation steps. When done, the collector will disable trace and gather logs.

This data collector updates the following files to enable trace & logging, and is updated with the options specified.

This is specific to RDz 7.6 & 8.0.1
  • .metadata/.plugins/org.eclipse.core.runtime/.settings/com.ibm.ftt.common.tracing.prefs
    • com.ibm.ftt.projects.core=FINEST
    • com.ibm.systemz.cobol.editor.core=FINEST
    • com.ibm.ftt.properties=FINEST
    • com.ibm.ftt.ui.rse.utils=FINEST
    • com.ibm.ftt.resources.core=FINEST
    • com.ibm.ftt.lpex.systemz=FINEST
    • com.ibm.ftt.core.migration.impl=FINEST
    • com.ibm.ftt.rse.mvs.client=FINEST
    • com.ibm.systemz.cobol.editor.lpex=FINEST
    • com.ibm.ftt.ui.views.project.navigator=FINEST
  • .metadata/.plugins/org.eclipse.core.runtime/.settings/org.eclipse.rse.ui.prefs
    • logging_level=2
You can verify this from your workspace preferences: Windows > Preferences > Remote Systems > Logging & Windows > Preferences > Tracing.

The tool will backup the existing .log and .trace file so that new log and trace can be written.

Data Collected:

    Folder
File Description
/RDz/WORKSPACE/<selected>/.metadata *.* All the top level files from the .metadata directory of user selected workspace. This includes all the log and trace files generated by RDz.
/ftp_scripts & /server_log *.* Optionally available, for server log collection. See below for more details.
/autopdzip/autopd *.* Version and execution output from about the ISA Lite tool. This includes system inventory.


Walk Through of "Client Log Collector - for Problem Recreation"

This collector will first inform you what this data collector does. Click OK, to proceed .
Information for this collector

Select Workspace
You'll need to select the workspace that you are having problems with. This will enable the script to enable trace settings and collect the data available for that workspace.
Select workspace
Two ways of selecting a workspace is available.

  1. Select the workspace via the pull down menu. This lists your recent workspaces. If the script cannot find this information, you'll only have a browse button available.
  2. or , select your workspace via the Browse... option. Select your workspace, keep in mind workspace should contain .metadata directory.

Once you specify a directory via Browse option, this value is used instead of the value selected in pull-down menu. You'll need to clear the Browse result in order for the script to use the value selected in the pull-down menu.

Click OK to select the workspace. Once you click OK. the tool will enable your Log and Trace settings against the workspace that you have selected.


Trace Enabled.
This panel instructs you to launch RD/z against the same workspace you had enabled trace on. You'll need to follow the steps specified below to re-create the problem you had, using the same workspace.
Steps to problem recreation: restart RDz client, recreate problem, shutdown.
Click OK to continue. Please DO NOT click on "Cancel", this will cause data collection to end without disabling trace settings.
You will be prompted once again to ensure you did recreated the problem you like to report.


Double check for prolem recreation completed


Clicking OK will disabled the log and trace settings, as well as collect the logs.
Again, please DO NOT click on "Cancel", this will cause data collection to end without disabling trace settings.


Remote System Data Collection (Optional)

IMPORTANT: You'll need your host user credentials and configuration directory information for this task. A "Skip" option is available if these information are not available at the time of collector execution.

You can optionally collect the remote system logs as part of this data collection. Click on "OK" to continue, or "Skip" if you would like to skip this data collection. See below for more details: Remote System Log Collector

The collector will run to completion and request feedback and ftp options.

Please continue to Data Collector Completion Options & Uploads for additional information.




Details: Client Log Collector - Without Problem Recreation

Use this data collector if you just want to gather trace logs for a problem you see on the RDz product. The tool will only gather logs - similar to above, but will not enable/disable trace settings.

Data Collected: Same as above: "Client Log Collector - for Problem Recreation"

Walk Through of "Client Log Collector - Without Problem Recreation"

This collector will first inform you what this data collector does. Click OK, to proceed .
Information for this collector

Select Workspace
You'll need to select the workspace that you are having problems with and would like to provide client log for our support team.
Select a workspace
Two ways of selecting a workspace is available.

  1. Select the workspace via the pull down menu. This lists your recent workspaces. If the script cannot find this information, you'll only have a browse button available.
  2. or , select your workspace via the Browse... option. Select your workspace, keep in mind workspace should contain .metadata directory.

Once you specify a directory via Browse option, this value is used instead of the value selected in pull-down menu. You'll need to clear the Browse result in order for the script to use the value selected in the pull-down menu.
Click OK to select the workspace. Once it is selected, the data is collected.

Remote System Data Collection (Optional)

IMPORTANT: You'll need your host user credentials and configuration directory information for this task. A "Skip" option is available if these information are not available at the time of collector execution.

You can optionally collect the remote system logs as part of this data collection. Click on "OK" to continue, or "Skip" if you would like to skip this data collection. See below for more details: Remote System Log Collector

The collector will run to completion and request feedback and ftp options.

Please continue to Data Collector Completion Options & Uploads for additional information.




Details: Client Workspace Collector

Use this data collector to provide your RDz workspace for our support team. It is recommended that you exit your target workspace so that all data can be gathered.

Data Collected:

    Folder
File Description
/RDz/WORKSPACE/<selected> *.* All contents of a selected workspace excluding .lock & .lck files. Files that cannot be accessed by the collection tool will be skipped.
/autopdzip/autopd *.* Version and execution output from about the ISA Lite tool. This includes system inventory.

Walk Through of "Client Workspace Collector"

This collector will first inform you what this data collector does. Click OK, to proceed .
Information for this collector

After you've selected your workspace, the tool prompts you to close your workspace if it is currently in use. This will help prevent issues with possible lock files.
Is selected workspace in use?
Select 'OK' to continue.

The collector will run to completion and request feedback and ftp options.

Please continue to Data Collector Completion Options & Uploads for additional information.




Details: Remote System Log Collector

Use this data collector to gather remote system logs via ftp. The tool will generate a ftp file that gets executed to gather remote system log.

IMPORTANT: You'll need your host user credentials and configuration directory information for this task.

Data Collected:

    Folder
File Description
/server_log *.* Server log gathered base on user input:
  • <config_dir>/*.*
  • <server_log_dir>/rse*.log
  • <user_log_dir>/*.last
  • <user_log_dir>/*.log
  • /etc/services
  • /etc/inetd.conf
/ftp_scripts *.* FTP file and output.
remoteauthen.ftp.nopassword.txt - ftp script to test authentication of the information provided (password removed)
remoteauthen.ftp.out.txt - output of the authentication test
remotecollect.ftp.nopassword.txt - ftp script that is executed to gather remote log (password removed)
remotecollect.ftp.out.txt - output of the script that was executed.
/autopdzip/autopd *.* Version and execution output from about the ISA Lite tool. This includes system inventory.


Walk Through of "Remote System Log Collector"

This collector will first inform you what this data collector does. Click OK, to proceed .
Information for this collector

Provide Remote System Information
Please provide the information below to authenticate to the remote system z you've specified. This should be the system that you are having a concern with.
Provide remote system information
Select 'OK' to continue, or 'Skip' to skip server collection.


Provide Log and Configuration Locations
The default location for RDz Server logs has been provided for you. If your system administrator has configured otherwise, please provide the appropriate information below:
Provide remote log locations
Select 'OK' to start collection, or Skip to keep the default values, and collect.

Keep in mind that the more data you have, the longer this may take.

The collector will run to completion and request feedback and ftp options.

Please continue to Data Collector Completion Options & Uploads for additional information.



Data Collector Completion Options & Uploads

When the collector is completed, it will request feedback about ISA. Select Yes, to provide feedback. Select No to continue.

You'll also be provided with data upload options. This will allow you to send the collected data to IBM or another location via FTP or HTTPS.

IMPORTANT: To upload information to IBM, you'll need to have a PMR number. This is obtained when you work with our support team. If you do not have a PMR number, but do have support contract, you can leverage the Software Support page to open a service request and included the collected data with the service request.
IBM Service Request Page: https://www.ibm.com/support/servicerequest/

The upload options are:

  • Send the Logs to IBM using secure transfer (HTTPS). You'll need an PMR number to transfer the data to IBM. This sends the collected data to IBM Support team through the HTTPS protocol.
  • FTP the Logs to IBM Support (unencrypted). You'll need an PMR number to transfer the data to IBM. This sends the collected data to IBM Support team through the FTP protocol. This is a less secure option.
  • FTP the Logs to a Different Location (unencrypted) This allows you to send the collected data to another location via FTP. You'll need to provide the target FTP location and appropriate authentication to access it.
  • Do Not FTP the Logs. Do nothing.

Click OK to continue. If you choose options other than 4 above, you will need to fill in additional information required to complete the upload.

When the collector completes, the .zip file is created at the location specified in Output File name. You can use any unzip tool to extract the files to examine the content of collected data.

Related information

IBM Support Assistant Data Collector
ISA Data Collector for Rational Developer for System z
IBM Support Assistant

Rate this page:

(0 users)Average rating

Document information


More support for:

Rational Developer for System z
General Information

Software version:

7.6, 7.6.1, 7.6.2, 8.0.1

Operating system(s):

Windows

Reference #:

1496063

Modified date:

2012-11-28

Translate my page

Machine Translation

Content navigation