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

Activating advanced capabilities

Z Open Editor's advanced capabilities require activation when the 90-day trial period ends. Currently, you can activate a permanent license key in two ways:

  1. Automatic activation using an RSE API server.
  2. Manual activation by importing an activation kit.

The IBM Z Open Editor Welcome page is used to report on the status of the trial license, the status of the automatic activation, as well as provides the means to import a manual activation kit. If the Welcome page does not open automatically at startup or you have already closed it, you can open it by entering cmd/ctrl-shift-p and typing or selecting IBM Z Open Editor: Welcome.

In the "Advanced capabilities" section of the Welcome page, you find two expandable sections:

  • Available Features: Displays the advanced features currently enabled. A checkmark icon indicates that the feature is active. A lock icon means the trial period has expired for that feature or the imported license does not cover it.
  • Activation Status: Shows the license activation currently in use. If you are using a trial license, it displays the expiration date. If you have activated through automatic or manual activation kits, it shows the type of license currently enabled.

Automatic activation with RSE API

Automatic activation uses the same technology as other development clients for IBM Developer for z/OS® Enterprise Edition. It is not available to customers of IBM Developer for z/OS Select. This method is ideal for organizations that run IBM Remote Systems Explorer (RSE) and enable their developers to choose between Eclipse and VS Code as their development clients. A system programmer provisioning RSE installs activation tokens, which the editors retrieve automatically when they connect to RSE.

To enable activation tokens via RSE API on z/OS, the z/OS administrator needs to complete the following steps:

  1. Install and complete basic configuration of z/OS host component IBM z/OS Explorer Extensions, FMID HHOPxxx. For more information, see Installing and configuring the host components.
  2. Install and complete basic configuration of z/OS host component IBM Remote System Explorer API (RSE API), FMID HAMAxxx.
  3. Make sure z/OS Explorer knows where to find z/OS Explorer Extensions. Depending on where z/OS Explorer Extensions was installed, this detection is automatic, or done via an environment variable in the configuration file rse.env.
  4. Allow z/OS Explorer Extensions to register as ADFz or IDzEE. For more information, see Product enablement in IFAPRDxx.
  5. Allow z/OS Explorer Extensions to write SM122 records to track that it provided an activation token.

You can find more detailed instruction in the documentation for system programmers, such as in IBM Shopz.

The Z Open Editor end users can then use the VS Code user setting zopeneditor.advancedCapabilities.enableRseApiActivationCheck to enable the automatic RSE check. The Z Open Editor Welcome page also provides a convenient check box to enable these settings.

Once enabled, the next time you connect to the RSE API server via Zowe Explorer or Z Open Editor, an automatic check for activation will be executed. If successful, the Z Open Editor Welcome page will report the activation status in a table.

Notes:

  • Host component IBM Explorer for z/OS, FMID HALGxxx, is a prerequisite for both IBM z/OS Explorer Extensions and IBM Remote System Explorer API (RSE API).
  • You can use the Host Configuration Assistant at https://zdev-hca.ibm.com to guide you through the required host configuration.
  • The provided activation tokens operate for a limited time. However, activation tokens are automatically renewed each time the client connects to the z/OS host.

Automatic activation with IBM Bob™ Premium Package for Z

When Z Open Editor is running as part of IBM Bob™ Premium Package for Z, it automatically performs an entitlement check at startup to unlock Advanced Capabilities. The results are reported on the Welcome page. Contact your Bob administrator to confirm Premium Package availability in the organization.

  • The Available Features section lists exactly the capabilities that are unlocked. For Version 6.6.0 of Z Open Editor this includes all features except "Language detection for data set members" and "Remote Connection Emulator".
  • The Activation Status section you see the entry "IBM Developer for z/OS on VS Code 6.x.x as part of IBM Bob Premium Package for Z - registered".

Manual activation

If your organization uses z/OSMF instead of the RSE API, or has purchased IBM Developer for z/OS Select, you can activate your Z Open Editor client using an activation kit. The activation kit can be obtained through Shopz, Passport Advantage, or directly from your IBM sales representative. The kit consists of a single file that must be imported by each Z Open Editor user to activate the advanced capabilities.

  1. Open the Z Open Editor Welcome page and scroll to the Advanced capabilities section.
  2. Expand the "Activation Status subsection.
  3. Click the Update activation key link below the table that presents the status of your trial.
  4. Click Browse in the dialog, and select the activation kit file that you received.
  5. Click Import in the dialog to finish activation.
  6. VS Code prompts you to restart Z Open Editor; accept the prompt.
  7. After the restart, open the Welcome page again. Confirm that the table now shows details about the activation kit that you imported.
Last Updated: 6/18/26, 8:34 AM
Contributors: PETER HAUMER, phaumer, Hestia Zhang, Benjamin Santos, Esther M
Prev
Overview
Next
Launching a 3270 emulator from Zowe Explorer