Release notes: Version 20.11.01 of BMC Compuware Topaz Workbench
Date | 2022/07/07 00:00 |
---|
We are releasing version 20.11.01 of the BMC Compuware Topaz Workbench product.
What's new
This section summarizes the changes or new features in this release. You can also view a short video.
Topaz Workbench
Feature | Description |
---|---|
Upgrade logback to current release | CES upgraded logback to its latest version and it dependent on some of the BMC Compuware Topaz Workbench bundles which use the Topaz logging framework. So, Topaz Workbench logging is updated to support API changes. |
Windows 11 - Toleration Support for Topaz Workbench | Toleration support for Windows 11 based products is available. |
Topaz Enterprise Data
Feature | Description |
---|---|
Locate columns from the Metadata Viewer | The Locate function is now available in the Metadata Viewer. This function helps in positioning the data mode to the selected columns within the formatted mode display. |
Jenkins Plug-in | A plugin for the Topaz Enterprise Data CLI is now available from the Jenkins Marketplace. The CLI is used to automate the execution of Topaz Enterprise Data specifications for Extract, Load, ConverterPro, and ComparePro. The Extract and Load specifications for non-mainframe data are executed by the File-AID Execution Servers, and the Extract and Load specifications for mainframe data are executed by File-AID/RDX. |
Topaz for Total Test
Feature | Description |
---|---|
Total Test Search | A new search capability is added to Topaz for Total Test. In the Topaz Search dialog box, a new tab Total Test Search is added. You can search for unit test cases, Name, Program, Alias, Load Module, and Description. |
Getting Started | A Getting Started with Total Test page is added to the launch of the Total Test perspective, which helps the users to get up to speed quickly with the product. This page will be continuously upgraded with new content when it becomes available with every quarterly launch. |
Topaz Workbench ISPW/Eclipse
Feature | Description |
---|---|
Deploy action messages in the Console view | You can now view the status of the Deploy action in the Console View. The messages in this view also provide additional information to help you identify and resolve issues, if any. For more information, see Console-View-for-ISPW-Eclipse and Deploy. |
Downloading of specific files from ISPW via ISPW APIs | As a DevOps engineer, you can now create a custom integration between ISPW and Git. You can now use the ISPW API to easily transfer files from ISPW running on the mainframe. To help build your toolchain, you can also use the APIs to download the contents of an Assignment, Release, or Set and have them available for code analysis. |
Improved logic for enabling modify set actions | The Modify Set actions Terminate and Restart, are now enabled if a Set postexit fails during a Deploy action. |
Fast Binary Support for TASK LOADSET | We have incorporated the fast-binary API for the mainframe source components in the ISPW Git integration. With this enhancement, we have added support to edit or browse such components that may contain embedded binary strings in the EBCDIC source. |
Increased length of the WORK REQ field | The length of the WORK REQ field has increased to 24 characters. This field appears in user interfaces such as the Add New Assignment and Add New Release dialog boxes, the Containers view, and so on. Note: This enhancement requires ISPW Server API version XZ 22.01.01, which is included in the ISPW Server version 22.01. For versions prior to XZ 22.01.01, the WORK REQ field will be restricted to 8 characters. |
Technical notes
This section describes the technical notes applicable to this version.
Feature | Component | Description |
---|---|---|
Topaz Workbench | CLI installation location | If upgrading from a release prior to 19.05, for Windows installations the Topaz Workbench CLI, the default install path location has been changed to C:\Topaz\WorkbenchCLI to better address access issues caused by the previous default path of C:\Program Files\Compuware\Topaz Workbench CLI. The new default is specified in the install wizard and can be changed during installation. |
Eclipse memory settings | Java OutOfMemory errors may occur when editing a large file or displaying a large JES report. These errors can often be avoided by increasing the maximum size of the JVM memory heap. The initialization files in Topaz Workbench or Eclipse (topaz.ini or eclipse.ini) include an Xmx parameter (Eclipse default 1024m or Topaz default 2048m) used to specify the maximum heap size. The optimum value for this parameter varies depending on the OS used, memory fragmentation, and other factors. The optimal setting for a particular installation—with no OutOfMemory errors or noticeable garbage collection pauses—can only be determined by experimenting with different values. We recommend increasing the Xmx value to 1200m as a starting point and increasing or decreasing the value in small increments, such as 512m, until an optimum value is found. However, even with a setting of 1536m, large JES output can easily exceed that value. On 64-bit Windows operating systems, heap size is limited by your Windows virtual memory specification, minus a small amount of memory used by the OS and other processes. Specifying 4-GB or more for the Xmx parameter might be practical, depending on the Windows virtual memory size. | |
eGit compatibility | eGit versions 4.6.1 through 5.0.1, 5.04, and 5.13 are compatible with Topaz Workbench releases with major version 20. eGit versions 5.02 and 5.03, however, exhibit known issues with the eGit UI and are not compatible with Topaz Workbench releases. | |
Fault Analytics EOS | Fault Analytics has stated End of Support from July 1, 2020. Beginning October 2020, Fault Analytics is no longer installable through Topaz Workbench. | |
Host Explorer licensing | Use of Host Explorer requires a valid Compuware Mainframe License (any product) on any LPAR serving Host Explorer connections. The HCI hosting these communications must have access to Compuware’s License Manager. If there is any licensed Compuware mainframe product running on an LPAR where HCI is executing, no further effort is necessary. | |
IBM IDz support | Topaz Workbench release 20.05.03 and later are supported for installation into IBM Developer for z Systems (IDz) 15.0.1, 15.0.4, and 15.0.5 releases. To use this support, enable Java Development Tools (JDT) and Debug Support. Select Windows > Preferences > General > Capabilities > Development , and then check the boxes to enable Debug Support and Java Development . | |
Running Topaz Workbench in 32-bit mode on a 64-bit OS | Topaz Workbench 20.xx releases no longer support running on Windows 32-bit versions or in 32-bit mode. | |
VIPA networks | A minimum of HCI 3.0 is required for VIPA networks. | |
Compuware Shared Services enhanced listings | Xpediter/Eclipse does not support Compuware Shared Services (CSS) enhanced listings. For information about enhanced listings, see CSS documentation in BMC Compuware Enterprise Common Components. | |
Connection to LPAR | Xpediter/Eclipse requires a direct connection to an LPAR with a working version of Xpediter/CICS, Xpediter/TSO, or Xpediter/IMS on any LPAR where Xpediter debugging sessions are to execute. | |
Topaz Enterprise Data | Audit preference | By default, the Enable Auditing preference is turned on and an audit file is created on the mainframe. Be aware that when auditing is enabled, the FORCE option on the Concurrent Update view does not work because it would negate the audit. |
Database connection for Compuware DB2 for z/OS | After installing the Compuware DB2 for z/OS using Topaz (base) feature, a database connection must be established. From the New Connection Profile option in the Data Management - Data Source Explorer view, under Database Connections - New, select DB2 for z/OS using Topaz. | |
Eclipse-based IDE installs | You must include and enable the following update sites:
| |
License checking requirements |
| |
Oracle 19c support | Users upgrading Topaz Workbench from versions earlier than 20.03 via P2 upgrades might need to upgrade from ojdbc6.jar to ojdbc8.jar. The xdb6.jar has also been updated. Both jars are in the <topaz-install-location>\drivers\folder. | |
Topaz Workbench Datatools | If you intend to use Topaz Workbench Datatools, install only the Compuware DB2 for z/OS using Topaz (base) feature. This plug-in is not required if the native Eclipse datatools plug-ins will be utilized. | |
Topaz for Total Test | Generating unit test cases for very large programs | Generating Topaz for Total Test unit test cases for very large programs might require increasing the memory allocated to Topaz Workbench. To do this, edit the topaz.ini file in your installation directory of Topaz Workbench (the default path is C:\Users\userid\Compuware\Topaz\eclipse). Find the entry -Xms256m and change it to -Xms512m. This adjustment doubles the amount of memory available to the Topaz Workbench and Topaz for Total Test. Save the topaz.ini file and restart Topaz Workbench. |
Java Runtime Environment (JRE) | A 64-bit JRE is required for the Topaz for Total Test Command Line Interface (CLI). | |
KSDS support | Topaz for Total Test does not support KSDS READ NEXT using an alternate key for which duplicates are allowed when there are duplicates and they are not ordered in prime key order. | |
Pipeline Syntax | The junit and sonar files have been renamed as follows:
The junit and sonar files always have the last directory specified on the -f option in the name examples. | |
Xpediter/Eclipse | Compuware Shared Services enhanced listings | Xpediter/Eclipse does not support Compuware Shared Services (CSS) enhanced listings. For information about enhanced listings, see CSS documentation in BMC Compuware Enterprise Common Components. |
Connection to LPAR | Xpediter/Eclipse requires a direct connection to an LPAR with a working version of Xpediter/CICS, Xpediter/TSO, or Xpediter/IMS on any LPAR where Xpediter debugging sessions are to execute. |
Known and corrected issues
This section summarizes the known and corrected issues in this version.
Known issues
Feature | Description |
---|---|
Topaz Workbench | After installing multiple Topaz components into an Eclipse-based IDE, you are asked to restart. During that restart, however, the Eclipse IDE sometimes fails to rewire the bundle dependencies. Symptoms can include UI components that do not function properly and views that do not display. To correct this, manually close the Eclipse IDE, then start it back up again with the -clean option. Only use the -clean option for one startup after a new install. |
The topaz.ini file sets the osgi.instance.area.default to the @user.home location, which is typically mapped to a local drive or absolute path. If the user has their @user.home set to a UNC network path, the toolbars and menus within Topaz Workbench might not be displayed. To correct the problem, edit the topaz.ini file (default location is the Topaz Workbench installation’s eclipse directory), replacing the @user.home location with a local drive or absolute path. If Topaz Workbench is installed via p2repo into an Eclipse instance, you must edit the eclipse.ini file instead. | |
Navigating Topaz COBOL Editor search results do not place the cursor at the exact position of the match in the Editor if the match exists within a non-editable region. This pertains to the Sequence Number or Identity areas within the Editor where either have been set via preferences to be non-editable. The cursor in this case is placed at the beginning of the statement or in the general vicinity of the match in the editable region. | |
When exporting an image from Program Analysis or Visualizer if the View document after export check box is selected, *.png is selected from the Save as type list. The default application associated with .png files is Microsoft Paint and the exported image cannot be opened automatically. Browse to the export location and open the file manually. | |
Under Open JDK, when the Team Profile Import process finds an invalid profile, it fails to display the full error message. | |
When analyzing a project, for example after adding a large copybook concatenation PDS, Program Analysis can take a long time or hang Topaz Workbench. | |
When installing Topaz Workbench plug-ins into IBM Aqua, the following issues might occur:
| |
If you open a file in Host Explorer, perform Search Text > File within it, close the Editor, and then click on the search results, the selected file fails to open. This happens because when the Editor is closed, the file is no longer present in the Topaz Workbench local directory. Reopening the file through Host Explorer re-syncs the search results with the file. The issue affects all Topaz Editors. | |
Cut (Ctrl+x) is not supported in the Topaz 3270 Emulator. | |
ISPW/Eclipse | SonarLint Analyze Changed Files option is not functional for ISPW controlled files. |
For tasks generated from a Sandbox Codeline, the Parts view shows incorrect data set names. | |
For tasks in a Sandbox Codeline, the Deploy action is not yet supported. |
Corrected issues
Feature | Description |
---|---|
Topaz Workbench | Cobol parser - Resolved the Cobol -parser IllegalArgumentException (2) PG0J435B issue. |
Cobol parser - If a copybook is included containing a REPLACING clause, parser will now keep track of the new number of lines and adjust offsets accordingly, avoiding IllegalArgumentExceptions. As a result, the includes will be displayed in the Outline View. | |
Cobol parse - When the keyword "DTC" is used for a variable name, it is now recognized by the parser and not flagged as an error. | |
Cobol Editor tagging in columns 73 to 80 were not visible. | |
Keyword DTC was not recognized when used as a variable, causing Cobol parser to flag it as an "Erroneous Input". Added DTC to the cobolWords. | |
Fixed issue related to opening 3270 Emulator. | |
Avoidable / Non-Avoidable: non avoidable conflict with newer version of mylyn in workbench SDK. | |
Added grammar to support OF keyword in Gson generate. | |
When Topaz plugins are installed, all the files without extension or which extension is not set in préférences générales > Editors > File associations become associated to Topaz Compuware Editor Text. | |
Including a check of whether the file exists or not on the mainframe before trying to open the file in the text editor solved the issue of topaz workbench not responding. It shows the user with the appropriate error message instead. | |
COBOL Editor: Hovering over a PERFORM statement where the action is defined as a SECTION and not just a paragraph now works correctly, and user by right-clicking has the option to open the definition. | |
COBOL editor auto-complete feature does not work after column 40. | |
Topaz 20.9.2 PL/1 editor - Outline view incomplete for pgm ASPYR04. | |
PL/I /Editor: autoGen sections are not displayed in the outline view. | |
PL/I Editor: Parsing a file with multiple %DO SKIP blocks could cause the opening of the file to fail, or the syntax coloring be off. Now files with multiple %DO SKIP blocks will open fine, and the syntax coloring will be correct. | |
Cobol grammar is not supporting literal reference in IF statement. Added grammar to support literal reference in IF statements. | |
REXX parser now will support special characters in variable names (as defined in the language reference). These variable names will be correctly color highlighted in the editor. | |
JCL parser now supports the hex character 44 (Ã ). This allows the syntax highlighting to work correctly in JCL files containing this special character. | |
In Topaz Editor, copy/paste of a line doesn't paste it in a correct way. | |
Cobol programs with debug statements (D or d in column 7) will be properly parsed without generating parser errors. DEBUG-ITEM with offset and length will also be handled properly by the parser. | |
Topaz using Windows-Root cannot connect to CES. | |
Grammar changes implemented for JSON Generate and JSON Parse rule which will parse Cobol file. | |
Removed extra copybook nodes from the Outline view which were getting displayed under each copybook within the Includes section. | |
Grammar changes implemented JSON Generate and JSON Parser which will parse Cobol file. | |
Opening a Cobol copybook when Program Analysis perspective is active (opening through Host Explorer or hover over copybook and select :Open Definition") will not cause Program Analysis to be called, thereby avoiding a potential Program Analyzer error "no identification div found" | |
Corrected an issue where https connections were prompting for a client certificate when it was not necessary. | |
Added changes to open copybook elements (variables/procs ,etc) from outline view and avoid reparsing the copybook. | |
Updated the messages as the messages were not generic causing a security violation. | |
Cobol editor: when there are several variables with the same name, hovering over a variable will take in account the struct it belongs to so that the correct information will be shown ( OF clause) | |
Added variables and procedures for all copybook nodes in outline view. | |
Topaz Enterprise Data | Fixed an issue when the user inserts a new record in Db2. |
Fixed an issue when the user tries to open a file using File-AID data editor in Remote System Explorer. | |
Fixed an issue when the user tries to open an empty dataset (with no record). | |
Topaz for Total Test | The method to update an existing system lacked correct syntax which caused the problem for its immediate updating after toggling lock on the system. |
Added code to set the folder name that is passed from the record test case dialog box. This allows the recording of the test case in the given folder, either an already existing folder is used or a new folder is created. | |
The recording is completed successfully but the stub for the cursor statement shows, *****The cursor statement cannot be retrieved.***** | |
Code changes made to change the recording process for background and debug mode. | |
Resolved the linkage issue when user renames or moves the Tests folder. | |
Resolved the issue with vertical scroll bar for Environments section under Repository View disappears when switching perspectives. | |
Null pointer exception for Code page number is fixed by assigning a default value as "1047". | |
Implemented Execute Options High Level Qualifier field. | |
Handled Null Pointer Issue for logging account info and dataset qualifiers | |
Add check to see if Record Session section is present or not on the Topaz for Total Test window when recording a Test case either from Xpediter perspective or Total Test perspective. | |
Resolved an issue for adding functional test component from palette items not showing environments from repository. | |
The "Record format", "Unit name" and "Volume name" values are converting to uppercase letters. | |
An error message display with SQL cursor declaration part. | |
Fixed an issue of saving scenario if 'Rest Service' component body has CDATA tag. | |
Resolved an issue of getting 'Illegal URL' error when executing 'Test Suite' with only NVT Test. | |
ISPW/Eclipse | When operating ISPW with the Japanese version of Topaz Workbench, if you use the filter in the ISPW Approvals view, no record is displayed. Thereafter, on resetting the filter setting too, no record is displayed. |
Upgrade considerations
When you upgrade the software, consider the following items:
- The Topaz Workbench 20.xx releases are based on Eclipse Photon 4.8. When you upgrade Topaz Workbench from a release earlier than 20.01, a new installation is required because of the significant changes to the underlying Topaz Workbench architecture.
To upgrade Topaz Workbench 20.xx releases, use the P2 Repository file to perform the Check for Updates processing. You can also use the P2 Repository to install into a compatible Eclipse-based IDE release after an uninstall of the Topaz Workbench plug-ins prior to Topaz Workbench 20.01. For more information, see Topaz Workbench Installation Guide > Milestone 2 Install Topaz Workbench.
- When installing Topaz plugins into an Eclipse version, we recommend that you start Eclipse with the -clean option for the first time post-installation, irrespective of the Topaz components installed. You can remove that option for subsequent times of starting Eclipse.
Downloading the release
You can download this release from the Update Center.
The following video (5:57) provides detailed information about downloading BMC Compuware releases:
https://www.youtube.com/embed/N7clGZHaO0M
To download this version of the product from the BMC Electronic Product Distribution (EPD) website, follow these steps:
Go toProduct Downloads in BMC Support Central.
- Locate the product name by browsing or searching in the Search for Product field. If you have marked the product as a favorite, click Favorites.
- Under the product name, click the box containing the required supported version.
- Select the required files and click Download.
Installing the release
For information about installing, see Topaz-Workbench-Installation-Guide.
If you have questions,call BMC Support. If outside the United States, use the Select Another Country list to search for local phone numbers.