IBM Z® Open Editor

Using the Zowe Explorer views

When you have the Zowe Explorer VS Code extension installed, you can open the following three views by clicking the Zowe icon on the VS Code Activity bar to interact with z/OS resources:

  • DATA SETS view that shows your data sets and members and allows you to directly open, edit, and save your programs against MVS™.
  • UNIX SYSTEM SERVICES (USS) view that shows you USS folders and files that you can also directly open, edit, and save.
  • JOBS view that gives you access to your jobs and spool files.

See the documentation in the VS Code Marketplaceopen in new window for details on using and configuring each view. More examples are available in the section How to manipulate data sets with Zowe Explorer and Submitting JCL to compile, link, and run jobs sections.

When you install IBM Z Open Editor from the VS Code marketplace into your VS Code, the latest version of Zowe Explorer is automatically co-installed.

Setting up and using profiles in Zowe Explorer

To use Zowe Explorer, you must have at least one z/OSMF profile or RSE profile.

You can also mix and match z/OSMF and RSE CLI API profiles and use CLI commands and Zowe Explorer views with the different profiles at the same time. For example, you can access one LPAR with z/OSMF and another with RSE API from within the same VS Code workspace using Zowe Explorer and IBM Z Open Editor. IBM Z Open Editor capabilities such as COBOL copybook or PL/I include file resolving can be used with either of the two protocols as well.

Using RSE API in Zowe Explorer and Z Open Editor

Follow this procedure to use RSE CLI plug-in with Zowe Explorer so that you can graphically navigate and access file and job resources.

Setting up and using RSE profiles

To use RSE profiles in Zowe Explorer and IBM Z Open Editor, complete the following procedures:

Follow these steps to create or add an RSE profile in Zowe Explorer:

Setting up and using v2 profile management for Zowe Explorer
  1. Switch to the Zowe Explorer Activity Group in VS Code.
  2. Expand the Zowe Explorer view where you wish to create the profile (DATA SETS, USS, or JOBS), and then click the + icon in the view's header bar.
  3. Select Create a New Team Configuration File when prompted in the input box shown.
  4. If no workspace is opened, a global configuration will be created in your ~/.zowe directory and open in the VS Code text editor. If a workspace is opened, you will be prompted to select global or project level config. A project level config will be created in the top level of the workspace. After selecting the appropriate file, the file will open in the text editor.
  5. Add host, port, and other properties to the loaded file after creating the configuration file and save.
Setting up and using v1 profile management for Zowe Explorer

Note If a Team Configuration file is in place, v1 profile creation and use will not be available.

  1. Switch to the Zowe Explorer Activity Group in VS Code.
  2. Expand the Zowe Explorer view where you wish to create the profile (DATA SETS, USS, or JOBS), and then click the + icon in the view's header bar.
  3. Select an existing RSE profile from the dropdown to add it to the view, or create a new RSE profile by clicking Create a New Connection to z/OS.
  4. If creating a new profile, Zowe Explorer's GUI provides prompts to guide you through the following steps:
    1. Provide a connection name for the profile.
    2. Select rse as the profile type
    3. Fill in the connection details provided by a system administrator to complete the profile.

Using Zowe Explorer's GUI, you can create an RSE profile in the same way as creating a z/OSMF profile. For help on creating a profile using Zowe Explorer's GUI, see Working with user profilesopen in new window.

Then, you can use the RSE profile for connection as you did with a z/OSMF profile. All the same operations are available with RSE API.

Setting up and using RSE profiles in IBM Z Open Editor

You can use RSE profiles for IBM Z Open Editor operations. For example, if you edit a COBOL program and have defined property groups to dynamically retrieve contents of copybooks from MVS, then you can use your RSE profile for that access operation instead of the default z/OSMF CLI profile. The default precedence rules to identify which CLI profile to use are as follows:

  1. Use the profile that is specified by the zopeneditor.zowe workspace settings.
  2. Use the profile that is specified by the zopeneditor.zowe user settings.
  3. If no profile was specified in the locations above or the specified name of these profiles could not be found, then use the default RSE profile if available.
  4. If the default RSE profile is not available, then use the default z/OSMF profile if available. If the default z/OSMF profile is not defined, errors are shown.

The format of the zopeneditor.zowe user setting is as follows:

"zopeneditor.zowe": {
    "defaultCliProfile": "rseCLI",
},

The value of defaultCliProfile is the name of the CLI profile that you specified in the create statement above.

If you have v2 profiles in place and cannot remember the names, then you can run this command to get the information of all your profiles in the team configuration file:

zowe config list

If you have v1 profiles in place and cannot remember the names, then you can run this command to get the list of all your profiles and your default profile:

zowe profiles list rse

As we only use the profile name to find a profile, we require that you use unique names for profiles of different types. In other words, if you use the same name for your RSE API and z/OSMF profile, then the RSE API profile will always be picked if that name is used in the settings. If you want to switch between z/OSMF and RSE API profiles, you must use unique names.

Using Zowe Explorer views to interact with z/OS

When you connect to the host with either a z/OSMF profile or an RSE profile, you can view a tree list of data sets, members in the DATA SETS view, UNIX files and directories in the UNIX SYSTEM SERVICES (USS) view, and jobs with spool files in the JOBS view.

In the three views provided by Zowe Explorer, you can perform the following tasks:

  • Create, edit, save, rename, delete data sets, members, UNIX files, and directories on the host. For examples of managing data sets, see How to manipulate data sets with Zowe Explorer.
  • Upload local files as a partitioned data set member or as a sequential data set.
  • Submit JCL data sets or members as a job. Delete jobs. Download job spool files from the host to a local directory, and view them in the text editor.

Single sign-on support for RSE profiles in Zowe Explorer

Once an RSE profile has been created and is accessible in Zowe Explorer, users can use Single sign-on (SSO) support for connecting to the RSE API host component in Zowe Explorer 1.22.0 and higher. JWTs are stored securely in the profile's file.

Login to Authentication Service

  1. Right-click on the profile name in the Zowe Explorer tree view and select Login to Authentication Service.
  2. Enter credentials for z/OS connection when prompted.
  3. Recieve a successful login message Login to authentication service was successful. from Zowe Explorer.

Logout from Authentication Service

  1. Right-click on the profile name in the Zowe Explorer tree view and select Logout from Authentication Service.
  2. Recieve a successful logout message Logout from authentication service was successful. from Zowe Explorer.

If obtaining authentication tokens from the API Mediation layer, see Connecting profiles to API Mediation Layeropen in new window. For an example team configuration file with RSE profile authenticating with API Mediation Layer see Single sign-on support for IBM RSE CLI plugin.

Example: How to manipulate data sets with Zowe Explorer

When you are connected to Zowe with a z/OSMF profile or an RSE profile, you can work with your COBOL, PL/I, and HLASM data sets in Zowe Explorer.

Switch to Zowe Explorer to see the DATA SETS view by clicking the Zowe icon on the Activity bar. If the DATA SETS view is not opened by default, right-click one of the headers, and select the checkbox Data Sets.

Prerequisite: Before working on your data sets, you must connect to the Zowe server by expanding the node in the explorer that has the name of the connection profile you created. A list of existing profiles is shown.

Creating data sets

The data set is created with the parameters defined in the User Preferences. To create a data set, complete the following steps:

  1. Right-click on the preferred profile name and select Create New Data Set from the context menu.

  2. Provide a name such as USER1.SAMPLE.COBOL, replacing USER1 with the High Level Qualifier that should be used for the new data set. Then, press Enter to continue.

  3. Select one option from the menu such as Data Set Binary, Data Set C, Data Set Classic, Data Set Partitioned, Data Set Sequential.

  4. To allocate the data set with default attributes, press Enter or select Allocate Data Set. Alternatively, you can customize the new data set's attributes by clicking Edit Attributes.

    • If you edit attributes, press Enter or select Allocate Data Set once you are ready for the data set to be created.

  5. A new data set appears in the DATA SETS view. You might need to refresh the browser to see the new data set.

Creating new data set members

  1. Right-click the PDS and select Create New Member.
  2. Provide a name for the new member and press Enter.
  3. Expand the PDS to see the new member.

Migrating and recalling data sets

To migrate a data set, right-click a data set and select Migrate Data Set. An informational message then appears stating Migration of dataset: USER1.SAMPLE.COBOL requested..

To recall a data set, right-click a data set that has been migrated and select Recall Data Set. An informational message then appears stating Recall of dataset: USER1.SAMPLE.COBOL requested..

You can verify the status with either of the following ways:

  • Refresh the DATA SETS view.

    • A migrated data set will have a greyed out file icon.
    • A recalled data set's icon will return to normal.

  • Right-click the data set and select Show Data Set Attributes.

    • For a migrated data set, the attributes will show the value migr: YES.
    • For a recalled data set, the attributes will show the value migr: NO.

Note: If the data set migration or recall does not work, contact your system administrator to ensure HSM is active on the host system.

Deleting data sets or data set members

  1. Right-click the data set or member to delete.
  2. Select Delete from the context menu. A confirmation dialog appears and lists the item(s) you selected for deletion.
  3. Click Delete to confirm that you want to delete the listed item(s), or click Cancel to cancel the deletion.

Adding or removing favorites

  1. Right-click a resource, for example, a data set, folder, job, or profile.
  2. Select Add to Favorites or Remove Favorite to add to or remove from the Favorites tree.

Example: How to search for jobs in Zowe Explorer

In the JOBS view of Zowe Explorer, you can query the jobs that you are interested in. You can filter job lists based on various combinations of criteria such as job owner, a job prefix sub-string, as well as values for job status such as Active, Input, or Output.

To search for jobs in the JOBS view:

  1. Switch to Zowe Explorer to see the JOBS view by clicking the Zowe icon on the Activity bar. If the JOBS view is not opened by default, right-click one of the headers, and then select the JOBS checkbox.
  2. Click the Search Jobs icon on the profile that you want.
  3. Click Create a new filter. You'll see a menu where you can select parameters by which to search. Default parameters are all jobs under your name.
  4. Click each menu item to modify the prefix, user, or status.
  5. You can click each job search history item and modify the search criteria.
  6. You can also favorite a job search query by clicking Add to favorites.
Last Updated:
Contributors: Shi Kun Li, Billie Simmons, BillieJean-Simmons, kmaselli, Lauren Li, Peter Haumer, Peter Haumer, Billie J Simmons, Billie Simmons, Chun Hong Zheng, KRISTINA MAYO, Lauren Li