IBM Z® Open Editor

Getting started with Zowe 3.0

Overview

Zowe Explorer v3.0.0 and Zowe CLI v8.0.0 drop support for Zowe v1 profiles in favor of the Team Configuration file for profile management. IBM Z Open Editor and IBM RSE API Plugin for Zowe CLI v5.0.0 add full support for the profile changes as well.

These configuration files replaced the old Zowe CLI v6 profiles that were storing each connection in individual files, with central files that allow defining common properties such as host names, ports, protocols only once. They also distinguish user-specific properties from properties that define generic profiles for a project managed with application source in an SCM, such as Git, that all team members share for using the same development systems. In that case, personal properties such as username and passwords would be stored for the individual users on their development clients, and all other properties in a project configuration file.

For more information regarding configuration files in Zowe CLI and Zowe Explorer v3.0.0 review

Migration overview

Semi-automatic migration of Zowe CLI profiles

If you have Zowe v1 profiles in place there are 2 ways to migrate those profiles into a Team Configuration file.

  1. To migrate profiles using Zowe CLI, use the config convert commandopen in new window.
  2. To migrate profiles using Zowe Explorer, select the convert option in the VS Code modal message on startup stating that v1 profiles were found.

Automated migration of Zowe Explorer settings in VS Code

Zowe explorer persistent settings have been moved to VS Code local storage as of Zowe Explorer v3.0.0. For more information on Zowe Explorer and feature changes view the Zowe Explorer Wikiopen in new window.

Creating Zowe Team configuration files

To get started using Zowe v2 configuration profiles, the following steps must be performed:

  1. Create a configuration file by clicking the + button in Zowe Explorer's tree view, and select Create a New Team Configuration File when prompted in the input box shown.

  2. Update host, port and other information in the config file and save. Refresh Zowe Explorer by either clicking the button in the notification message shown after creation, alt+z, or the Zowe Explorer: Refresh Zowe Explorer command palette option.

For more details, see the Zowe CLI docs on Creating a configuration fileopen in new window.

Configure your Zowe profiles for IBM User Build

  1. Set the profile you wish to use for IBM User Build in your VS Code user settings or ZAPP settings in the following setting zopeneditor.zowe.defaultCliProfile. If the profile type z/OSMF is used, an SSH profile must be specified in the zopeneditor.zowe.defaultSshCliProfile setting.

  2. The team configuration file should now be ready to use in IBM User Build. Test it by performing a User Build against a supported language file and verifying the Zowe v2 profile is used in the output shown.

Known issues

Zowe Explorer and CLI Plugin Schema Integration

If you experience one of the following symptoms:

  • RSE API CLI plugin profiles are not shown or cannot be added to a tree view in Zowe Explorer although you had added them to your configuration file and the profile even appears in the drop-down of profiles that can be added
  • You do not get code completion suggestions for RSE API Plugin profile properties, but just for profile properties of other type.

Then you might have installed plugins and ran configuration commands in the wrong order, which is currently impacted by a known issue in Zowe Explorer that causes Zowe CLI's global config schema to not being updated correctly when a new extender registers with Zowe Explorer.

To workaround this issue, perform the following:

  1. (Re)Install Zowe plugins through Zowe CLI in order for your schema to be updated with zowe plugins install <your plugin name>.

  2. Run the following command to update the schema with newly registered plugins from extenders zowe config update-schemas.

To learn more about how to install a Zowe plugin through CLI, view Zowe CLI's documentation on installing Zowe CLI pluginsopen in new window

Last Updated:
Contributors: Billie Simmons