The HCL Z Data Tools extension for Microsoft Visual Studio Code works in conjunction with the Zowe Explorer extension. HCL Z Data Tools provides flexible, user-friendly tools for enhanced file processing when working with z/OS data sets.

This comprehensive solution provides intuitive interfaces for accessing, editing, and managing data sets and files on z/OS systems, and is a modern alternative to working with HCL Z Data Tools outside the existing ISPF client.

Table of contents

• Requirements
• Integration with Zowe Explorer
• Configuring the extension
• Using the extension
• Getting help

Requirements

General requirements

• Assumes knowledge of the HCL Z Data Tools product installation and features.
• The Z Data Tools VS Code extension connectivity to the host is similar to using the Z Common Components (ZCC) server:
  • Assumes knowledge of how to install and configure the Z Common Components server.
  • ZCC must use the AT-TLS feature when configuring TLS support.

Host requirements

• HCL Z Data Tools 16.1.0+
• HCL Z Common Components 16.1.0+
  • You must configure and deploy at least one Z Common Components server on the host you intend to use with the extension.

VS Code requirements

• VS Code 1.108.0+
• Zowe Explorer 3.2.0+
  • Assumes the user is familiar with the Zowe Explorer extension before using the HCL Z Data Tools extension.

Integration with Zowe Explorer

The HCL Z Data Tools extension builds on the strong foundation provided by Zowe Explorer. To preserve the familiar Zowe Explorer user experience, it purposefully avoids contributing highly customized UI elements whenever possible. Instead, it enhances your current workspace by:

• Reusing your Zowe profiles configuration to manage local and remote resources.
• Adding new functionality directly to Zowe Explorer's existing Data Sets view.
• Integrating additional information directly into Zowe Explorer's existing Attributes view.

See the Getting help section to report issues related to the Zowe Explorer extension.

Configuring the extension

Configure the following settings under HCL Z Data Tools in VS Code Settings.

Page Size

Use the Page Size setting to configure the number of records shown on each page by the Formatted Editor.

Column Ruler

Use the Show Ruler setting to show or hide the column ruler in the Unformatted Editor.

Input Mode

Important: this is an experimental feature

The Synchronize Input Mode setting synchronizes the editor insert or overtype mode with VS Code. Restart VS Code after changing this setting.

Character sets

The extension supports decoding and encoding character data using the following character sets:

IBM037  IBM930   IBM1144
IBM273  IBM937   IBM1146
IBM277  IBM939   IBM1147
IBM278  IBM1047  IBM1390
IBM280  IBM1141  IBM1399
IBM285  IBM1142
IBM297  IBM1143

Important: DBCS (Double-Byte Character Set) support is still rough around the edges and may not work correctly in all cases.

Using the extension

Configuring the Z Common Components connection

Before you begin, all previously listed requirements must be satisfied.

1. Open VS Code.
2. If necessary, create at least one Zowe profile.
3. Switch to the Zowe Explorer tool window.
4. Right-click the Zowe profile that matches the z/OS subsystem where your Z Common Components server runs.
5. From the Z Common Components menu item, select Configure connection.
6. Enter the connection information for the Z Common Components server.

You are now ready to use the HCL Z Data Tools extension.

Note: if you access a Z Data Tools feature before configuring the Z Common Components connection, you are prompted to provide the required connection information. This prompt occurs only during the first access.

For more information on Z Common Components connections, see the relevant chapter in the HCL Z Common Components extension documentation.

Opening and editing data sets

Open a data set or member from the Zowe Explorer Data Sets tree by right-clicking it and selecting HCL Z Data Tools > Open Data Set (Formatted Editor). You can also run HCL Z Data Tools: Open Data Set (Formatted Editor) from the command palette.

The opening wizard lets you choose the session type and character set. Opening a data set without a template uses the Unformatted Editor. Selecting a template opens the data set in the Formatted Editor.

Both editors support View and Edit sessions.

The Unformatted Editor supports essential navigation commands such as TOP, BOTTOM, UP, DOWN and LOCATE, and offers toolbar options to display hex line representations, and to enable a column ruler. It also offers editor actions to work with records directly. All other related editor actions, such as Cut, Copy and Paste, are supported across different opened data set sessions in Unformatted mode.

The Formatted mode editor supports the same set of navigation commands, along with the hex representation of text displayed in table cells.

Managing templates

Open a template from the Zowe Explorer Data Sets tree by selecting HCL Z Data Tools > Open Template (Template Editor), or run HCL Z Data Tools: Open Template (Template Editor) from the command palette. The Template Editor supports layout selection, segmentation, layout criteria, and Held or Selected column settings.

Run HCL Z Data Tools: Lock Template and HCL Z Data Tools: Unlock Template from the command palette to programmatically lock and unlock templates.

Allocating data sets

Run HCL Z Data Tools: Allocate Data Set from the command palette to allocate a data set, or select HCL Z Data Tools > Allocate Data Set for an existing data set in the Zowe Explorer Data Sets tree.

When started from the Data Sets tree, the allocation form uses the selected data set's properties as a starting point.

Exporting data sets

Export a data set or member to a local CSV or XML file by selecting HCL Z Data Tools > Export Data Set in the Zowe Explorer Data Sets tree, or by running HCL Z Data Tools: Export Data Set from the command palette. The export wizard prompts for the data set, template, character set, and output format.

Importing data sets

Import a local CSV file into a data set or member by selecting HCL Z Data Tools > Import Data Set in the Zowe Explorer Data Sets tree, or by running HCL Z Data Tools: Import Data Set from the command palette. The import wizard prompts to select the CSV file, template, character set, destination, and import options.

Important: Import Data Set might not work correctly with HCL Z Data Tools host versions older than 16.1.5 or 17.1.0.

Viewing resource attributes

Select HCL Z Data Tools > Show Resource Attributes from a data set or member in the Zowe Explorer Data Sets tree. The command opens the Zowe Explorer Attributes view with Z Data Tools-provided information for the selected resource.

Getting help

To ask questions or report issues related to the installation, configuration, or use of this extension, contact HCL Support.

Zowe Explorer issues

The HCL Z Data Tools extension depends on Zowe Explorer.
Issues might originate from core Zowe Explorer functionality rather than the extension itself. Examples include:

• Data set and Unix System Services (USS) file browsing
• Job management and submission
• Base Zowe Explorer commands and views

Report issues that are specific to Zowe Explorer to the Zowe Explorer issue tracker.

To determine the source of an issue and the appropriate reporting channel, consider the following:

• Error notifications include the extension name.
• Log entries displayed in the Output view are categorized by extension.