Release notes: Version 20.12.01 of BMC Compuware Topaz Workbench


Date

2022/10/03 00:00

We are releasing version 20.12.01 of the BMC Compuware Topaz Workbench product.

Important

If additional information becomes available, we will update this notice only in the documentation portal. To receive an email alert whenever the notice changes, set a watch on the notice's page:

  1. In the upper right toolbar, click Watch:
    watch.png
  2. Click Watch this Page.
  3. Email alerts are sent from docs-noreply@bmc.com, so make sure that @bmc.com is in your mail system's safe list to prevent email alerts being lost in your spam folder.

Important

Before you begin installation, we recommend checking Notices for recent release notes, technical bulletins, and flashes. Also, checkBMC Support Central for:

  • Product downloads, patches, and fixes (PTFs)
  • Product availability and compatibility data

What's new

This section summarizes the changes or new features in this release. 

Topaz Enterprise Data

Important

Some new features of Topaz Enterprise Data (TED) are available only if you are using File-AID version 21.1 with current maintenance.

Feature

Description

View Metadata

A new option View Metadata is now available in the Host Explorer perspective. In the Metadata Viewer, right-click on a member of a data set layout and select View Metadata. The data displayed in View Metadata mode simplifies to display the picture, data type, size, and starting and ending positions for each field within the layout.

It also includes the identification of Occurs and Redefines:

  • For both COBOL and PL/I layouts
  • In group items that display size and starting and ending positions
  • When multiple 01 levels are displayed (if present in the layout)
  • When Configure columns provide control over which metadata information is displayed

This feature is similar to File-AID/MVS option 8–View Record Layout.

Metadata Viewer in Edit

We have added new features to the Metadata Viewer displayed in the Edit session. The new features are now available from all types of Edit sessions, including z/OS, Db2, IMS, and distributed databases. The settings are defined for each layout and are preserved for the Edit session, so the following features are now available when using XREFs.

  • Hide/Show columns provide control over which columns are displayed within the Edit session.
  • Freeze/Unfreeze columns allow selected columns to remain in view when scrolling across a record.
  • Hide/Show All Filler columns to act on all Filler fields. This option applies to all layouts used in the Edit session.
  • Hide/Show All Redefines columns to act on all Redefines fields. This option applies to all layouts used in the Edit session.

Requests in File-AID Explorer

The saved edit and compare requests are now visible from File-AID Explorer. The Open, Delete, Execute, and SaveAs options are now available when you right-click on the requests.

Topaz Workbench ISPW/Eclipse

Feature

Description

Increased field lengths

We have enhanced the character limit for the following fields:

  • To allow for more meaningful names, we have increased the length of the Application name field to eight characters.
  • We have increased the length of the Component Type field to eight characters. For example, COBC can now be COBCICS.
  • We have increased the length of the Work Request field to 24 characters. This helps you store a Jira or trouble ticket number, thus freeing up the Description field for other purposes.

New SubAppl field

To enable greater granularity in your application definitions, we have introduced a new field SubAppl (SubApplication), with a limit of eight characters. This field now appears in various views, dialog boxes, and filters of the ISPW/Eclipse user interface.

DevOps updates

We have added the following DevOps enhancements:

  • We have extended support to Azure DevOps with a new Download extension that will allow developers creating pipelines to download source for analysis in a pipeline.
  • As a developer setting up a DevOps pipeline, you can now use Sub Application in your API calls.

Important

To use the new features and enhancements in the ISPW version 22.01, you need to make sure you are connecting to the 22.01 Mainframe server and not the 18.02 Mainframe server.

To effectively see the updated field enhancements in the different views in ISPW, you need to respectively close and reopen the views.

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

  • Compuware Enterprise Services (CES) 19.05.01 or later is required, and Topaz Enterprise Data components must be configured to identify CES location.
  • If you intend to access mainframe data, apply Enterprise Common Components (ECC) PTF CXS905A. This PTF returns a list of File-AID licenses to CES.

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:

  • -f "MyProject/MyTests/SimpleTest/Unit Test/Scenarios"
    The junit is now Scenarios.cli.suite.junit.xml.
    The sonar is now Scenarios.cli.suite.sonar.xml.
    The TTTJUNIT and TTTSONAR directories are now located in the Unit Test directory.
  • -f “MyProject/MyTests/SimpleTest/”
    The junit is now SimpleTest.cli.suite.junit.xml.
    The sonar is now SimpleTest.cli.suite.sonar.xml.
    The TTTJUNIT and TTTSONAR directories are now located in the SimpleTest directory.

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:

  • Deleting a PDS member in Host Explorer and then trying to open the same member from the Project Explorer might cause Aqua to hang.
  • Creating a new folder in a Compuware Online Project and then creating a new file in that folder causes Aqua to hang.
  • The shortcut keys for Toggle Comment (Ctrl+/) do not work in the JCL editor.

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

Added code to get the variable from the HCI getlist request.

Resolved more than one match issue for variables by checking the levels and if the variable has the same parent hierarchy.

When you duplicate lines and then undo or redo the changes, the tags are updated correctly.

Topaz Workbench supports Codepage 803 (Hebrew-Oldcode) in Host Explorer.

Reference to the structured parent variables were not resolved as we were not ignoring lowercase and uppercase while checking whether the parent variable for A.B.C (here parent is C and B of A) is declared.

Made change in VariableReconciler.java class method checkForParentStructuredVarsMap to check whether variable has its parent variable present in structured map.

If the variable reference is present, then avoid throwing cannot be resolved error.

Handled the exception which was occurring when you right-click on USS file or folder and select Permissions.

In locked mode , type and paste text beyond column 72 is not allowed.
In unlocked mode, type and paste text beyond column 80 is allowed but in that case a warning message is displayed and save function will be blocked.

In Host Explorer, you can compare two UNIX files, two local files, or a local file and a UNIX file.

Fixed the issue related to COBOL code from mainframe being back-filled with trailing spaces, preventing anything from being inserted.

When you select a line (position cursor at beginning of line, then press Shift + down arrow key) and then hit the Delete key, the identity area and sequence number area will be updated correctly if tagging is on for those areas.

Generate Diagnostic Report now includes previous versions of compuware.log files from a new workspace created by Topaz 20.11. 

Added line commands (Duplicate Lines) to the Line Editing menu.

Added XML / END-XML grammar support In COBOL.

Added fixes for tags getting misplaced when we execute line commands such as delete entire line or number of lines, or duplicate any number of Lines.
Made some fixes if we are deleting multiple lines then tags get added if any content from the current line is deleted.
Also, when we lock or unlock areas, tagging works when we execute line commands after that.

Fixed the COBOL Replacement logic to handle replacement of complete text only.

Added support for TrustStorePath as NONE value in certificate validation.

When copybook was on the same line as another statement hover text was not working. Updated the regular expression to account for such copybook statements.

Fixed code to insert tags in sequence and identity area when we press enter in between lines or at the start of lines. Also added changes to add tags while copying more than 2 lines. Also, backspace at column 0 should merge with previous line when the line count is less than 72.

Modified code to support replacement mapping in COBOL.

Topaz Workbench now can connect to CES.

Fixed the following error:

Topaz Unable to connect to CES : Validate Connection Failed | SSL exception occurred: TopazTrustStore.p12 KeyStore not available

Added code to handle COBOL grammar in multiple occurrence of identifier in working storage data description. 

Added grammar changes to support extra dot operator as it is not syntax error in COBOL.
Modified logic for replacement mapping in COBOL.

Added code to track the copybook variables in Define symbol. When we encounter the same variable in main program , checking that variable presence in copybook variable if yes setting them as not an implicit variable.

Hover and open declaration now work for nested copybooks opened from the main PLI program.

When you make a secure connection to CES, Topaz was corrected so that it does not prompt the user for a certificate when only one certificate is available.

Comparing the copy statement line number with the original source document instead of the parsed document creates correct mapping entries. This results in completion of the preprocessing without any error which enables the F3 and Open Definition functionality to work as expected.

PL/I Editor: Main editor outline view for all copybooks is retained, when opened through the problems view.

Struct variables are shown under Main file as well as in copybook's include section as an hierarchical structure.

Fixed PLI tab and Shift+tab behavior for both single line and block selections.

Added preprocessor procedures to the SymbolTable and outline view of Topaz PL/I Editor for copybooks.

Implemented the grammar changes for special registers - JSON-CODE and JSON -STATUS, which will parse COBOL file.

Topaz Enterprise Data

Fixed an issue where rows are marked for delete due to a wrong key binding.

Fixed an issue for adding the external functions file (.class file) in ConverterPro.

Fixed an issue with editing invalid data in File-AID Data Editor.

Topaz for Total Test

Fixed an issue where structure data is not getting associated with filler pointer.

Fixed an issue to set codepage to the current environment object present in the context.

When parsing the Cobol code REPLACE/REPLACE OFF statement was not supported. The REPLACE/REPLACE OFF statement support is now added.

Fixed an SQL select component 'error' tag without 'message' attribute condition, that fails SonarQube standards.

Uploading a test scenario without job card in the Job Submit palette is working properly on CES repository.

Fixed an issue with the help icon in the Total Test Search tab.

Restored options for sub-program recording and multiple test cases on Xpediter options dialog box.

Dataset High Level Qualifier option is now available for Virtualized tests.

Fixed the string errors occurring when opening the stubs.

Corrected the error message for repository server configuration page.

Fixed the broken test scenario link on report page after renaming the 'Tests' folder.

Fixed an issue where user is logged in and receives the error "You can not access repository. User not logged in".

Fixed the failing REST service component when response contains CDATA. 

ISPW/Eclipse

The status messages during View > Impacts processing are not showing up in Topaz.

We have fixed this by implementing the accurate status messages. Thus, in a view that support tasks, when you go to View > Impacts, the Status column displays meaningful status messages depending on the conditions satisfied.

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:

icon_play.png https://www.youtube.com/embed/N7clGZHaO0M

To download this version of the product from the BMC Electronic Product Distribution (EPD) website, follow these steps:

  1. Go toProduct Downloads in BMC Support Central. 

    Important

    • If the Export Compliance And Access Terms page is displayed, enter the relevant data and click Continue.
    • You must enable pop-ups for this web page in your browser.
  2. 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.
  3. Under the product name, click the box containing the required supported version.
  4. 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.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*