IBM Z® Open Editor
Docs
News and Blogs
IBM Downloads
VS Code Marketplace
GitHub
Docs
News and Blogs
IBM Downloads
VS Code Marketplace
GitHub
  • Overview

    • Introduction
    • Updates and user feedback
  • Getting Started

    • Getting started with IBM Z Open Editor
    • Setting up integrations to interact with z/OS
    • Getting started with Zowe 3.0
  • Configuration

    • Setting preferences
    • Configuring your applications with ZAPP files
    • Setting property groups
    • Setting compiler options
    • Setting file associations
    • Setting language-specific tab stops and rulers
    • Enabling and disabling problems in IBM Z Open Editor
    • Enabling and disabling unreachable COBOL code warnings
    • Customizing the Outline view
    • Setting language-specific maximum line length
    • EBCDIC code pages and mappings files
    • Experimental: Formatting COBOL source code
  • Tutorials

    • Tutorial overview
    • Exploring the user interface
    • Exploring the sample files
    • COBOL editing tutorial
    • COBOL, PL/I Preprocessor tutorial
    • HLASM editing tutorial
    • REXX editing tutorial
    • Managing z/OS resources with IBM RSE API Plug-in for Zowe CLI tutorial
    • Submitting JCL to compile, link, and run jobs tutorial
  • Editing program files

    • Language References
    • Making COBOL and PL/I code changes
    • Making High Level Assembler code changes
    • Making REXX code changes
    • Making JCL code changes
    • Using and managing code snippets
    • Using the integrated Git
    • Searching for COBOL, PL/I, HLASM, and REXX components
  • Interacting with z/OS using Zowe

    • Interacting with z/OS
    • Creating a configuration profile in Zowe Explorer v3.0.0
    • Migrating your old Zowe yaml profiles for Zowe v3.0
    • Supported methods of authentication for z/OS using Zowe
    • Sharing team configuration files
    • Connecting to z/OS with Zowe Explorer walk through
    • Using the Zowe Explorer views
    • Using Zowe profiles in Z Open Editor
    • Connecting to z/OS using Zowe CLI walk through
    • Using command line to interact with z/OS
    • Interact with RSE Common Properties
  • Advanced Capabilities

    • Overview
    • Activating advanced capabilities
    • Launching a 3270 emulator from Zowe Explorer
    • z/OS Resources Table
    • Data Elements View
    • Program Control Flow Browser
    • Data Flow Browser
    • Preprocessor support
    • Custom Macros for HLASM
    • Language Detection
    • Linting with IBM ZCodeScan
    • User build with IBM Dependency Based Build (DBB)
    • Agent Mode
    • Line Hex Editor
  • Cloud-based Editing

    • Overview to using Cloud and Browser-based platforms
    • Try Z Open Editor in the Red Hat Developer Sandbox
    • Configuring Red Hat OpenShift Dev Spaces
    • Managing Developer Workspaces
    • Managing secrets
    • Create and use custom images
    • Migrating from IBM Wazi for Dev Spaces
    • Using Z Open Editor on GitHub Codespaces
    • Using Z® Open Editor with Dev Containers
  • Troubleshooting

    • Known issues and limitations
    • Troubleshooting using log files
    • Troubleshooting for User Build
    • Uninstalling CLI plugins and VS Code extensions
  • Reference

    • IBM RSE API Plug-in for Zowe CLI commands
    • IBM RSE API Plug-in for Zowe CLI as nodejs SDK package
    • IBM RSE API Plug-in for Zowe CLI as nodejs SDK reference
    • Example Zowe configuation setups
    • IBM Z Open Editor MCP Tools
    • Accessibility and Keyboard Shortcuts
    • settings.json properties
    • Message ID Reference
    • Other Visual Studio Code extensions
  • Legal information

    • Notices
    • Trademarks
    • Privacy policy considerations

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

  • The Zowe CLI overview to Using Global Profile Configuration
  • Zowe Explorer's documentation on using configuration files

Migration overview

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 Wiki.

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 command.
  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.

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 configuration file and save. Refresh Zowe Explorer by either clicking the button in the notification message shown after creation, alt+z, or the Zowe Explorer and also refresh Zowe Explorer command palette option.

For more details, see the Zowe CLI docs on Creating a configuration file.

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 that 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 configuration schema to not update correctly when a new extender registers with Zowe Explorer.

To workaround this issue, perform the following:

  1. Reinstall 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 plugins

Last Updated: 1/21/26, 4:24 PM
Contributors: Billie Simmons, phaumer, Vinithanjali Selvaraj, Esther M, PETER HAUMER
Prev
Setting up integrations to interact with z/OS