Zowe Explorer

Zowe Explorer is a separately delivered component of Zowe belonging to the Zowe CLI sub-project.
Zowe is a project hosted by the Open Mainframe Project, a Linux Foundation project.

The Zowe Explorer extension modernizes the way developers and system administrators interact with z/OS mainframes. Working with data sets and USS files from VSC can be more convenient than using 3270 emulators, and complements your Zowe CLI experience. The extension provides the following benefits:

• Enables you to create, modify, rename, copy, and upload data sets directly to a z/OS mainframe.
• Enables you to create, modify, rename, and upload USS files directly to a z/OS mainframe.
• Provides a more streamlined way to access data sets, uss files and jobs.
• Lets you create, edit, and delete Zowe CLI zosmf compatible profiles.
• Lets you use the Secure Credential Store plug-in to store your credentials securely in the settings.

Note: The Zowe Explorer is powered by Zowe CLI. The extension demonstrates the potential for plug-ins powered by Zowe.

Tips:

• For information about how to install the extension from a VSIX file and run system tests on the extension, see the Developer README.
• For information about how to develop for Eclipse Theia, see Theia README.
• For information about how to create a VSCode extension for Zowe Explorer (a Zowe Explorer extension) see VSCode extensions for Zowe Explorer.
• For questions and general guidance, please visit #zowe-explorer channel on Slack

Contents

• Software Requirements
• Create a Zowe CLI z/OSMF profile
• Secure Credential Store
• Usage tips
• Sample use cases

Software Requirements

Ensure that you meet the following prerequisites before using the extension:

• Installed Node.js v8.0 or later.
• Configured TSO/E address space services, z/OS data set and file REST interface, and z/OS jobs REST interface. For more information, see z/OS Requirements.
• Zowe CLI zosmf profile.

Notes:

• You can use your existing Zowe CLI zosmf profiles that are created with the Zowe CLI v.2.0.0 or later.
• Zowe CLI zosmf profiles that are created in Zowe Explorer can be interchangeably used in the Zowe CLI.

Create a Zowe CLI z/OSMF profile

Follow these steps:

1. Navigate to the explorer tree.

2. Click the + button next to the DATA SETS, USS or JOBS bar.

   Note: If you already have a profile, select it from the drop-down menu.

3. Select the Create a New Connection to z/OS option.

   Note: When you create a new profile, user name and password fields are optional. However, the system will prompt you to specify your credentials when you use the new profile.

4. Follow the instructions, and enter all required information to complete the profile creation.

You successfully created a Zowe CLI zosmf profile. Now you can use all the functionalities of the extension.

Secure Credential Store

You can now use Secure Credential Store plug-in in the Zowe Explorer extension. Secure Credentials Store plug-in lets you store your credentials securely. You can use the plug-in in the following ways:

• Use the plug-in only with Zowe Explorer

• Use the plug-in both with Zowe CLI and Zowe Explorer

  For more information about Secure Credential Store plug-in for Zowe CLI, see Secure Credential Store Plug-in for Zowe CLI.

Prerequisites

Ensure that you meet the following prerequisites before you can use the plug-in both with Zowe CLI and Zowe Explorer:

• Install Zowe CLI
• Install Secure Credential Store for Zowe CLI

Using Secure Credential Store with Zowe Explorer

Activate the Secure Credential Store plug-in.

Follow these steps:

1. Open Zowe Explorer.
2. Navigate to the VSCode settings.
3. Open Zowe Explorer Settings.
4. Add the Zowe-Plugin value to the Zowe Security: Credential Key entry field.
5. Restart VSCode.
6. Create a profile.

Your Zowe Explorer credentials are now stored securely.

Using Secure Credential Store with Zowe CLI and Zowe Explorer

Activate the Secure Credential Store plug-in.

Follow these steps:

1. (Optional) If you have existing profiles, issue the following command, using Zowe CLI:

   zowe scs u

2. Open Zowe Explorer.

3. Navigate to the VSCode settings.

4. Open Zowe Explorer Settings.

5. Add the Zowe-Plugin value to the Zowe Security: Credential Key entry field.

6. Restart VSCode.

The credentials of your newly created or existing profiles are now stored securely.

Usage tips

Use the following tips to familiarize yourself with the extension and make the best use of it:

• Data set, USS and jobs persistence settings: You can enable the persistence of any data sets, USS files and jobs by adding them to the Favorites tab. Right-click on a data set, USS file or jobs and click Add Favorite.

• Syntax highlighter: Zowe Explorer supports syntax hightlighter for data sets. To enhance the experience of using the extension, download an extension that highlights syntax, such as IBM-JCL or IBM-Assembler.

• Edit a profile: You can now edit existing profiles by clicking the pencil button next to the magnifying glass button in the explorer tree. The feature lets you modify the information inside your profile.

• Delete a profile: You can permanently delete profiles by right-clicking the profile and selecting the Delete Profile option. The feature deletes a profile from your .zowe folder. Alternatively, you can delete a profile from the VSCode Command Palette.

  Follow these steps:

  1. Press F1 on your keyboard.
  2. Select the Zowe: Delete a Profile Permanently option.

• Hide a profile: You can hide a profile from profile tree by right-clicking the profile and selecting the Hide Profile option. If necessary, add the profile back by clicking the + button from the explorer tree.

Advanced Configuration

You can modify Zowe Explorer preferences in the extension Setting in the following ways:

• Temp Folder Location: You can change the default folder location where temporary files are stored. For example, use the following script:

"Zowe-Temp-Folder-Location": {
    "folderPath": "/path/to/directory"
  }

where /path/to/directory is the folder location that you specify.

• Data set creation settings: You can change the default creation settings for various data set types.

1. Navigate to the extension configuration manager.
2. In the section Extensions, scroll to Zowe Configuration and expand the options.
3. Click the Edit in settings.json button under Data Set, USS or JOBS settings that you want to edit.
4. Edit the settings as needed.
5. Save the settings.

Sample use cases

Review the following use cases to understand how to use Zowe Explorer.

• Data Sets
• USS
• JOBS
• Extras

Data Sets

You can use the following functionalities when interacting with data set:

• View data sets and use multiple filters: You can view multiple data sets simultaneously and apply filters to show specified data sets.
• Rename data sets: You can rename specified data sets.
• Copy data sets: You can copy a specified data sets and memebers.
• Download, edit, and upload existing PDS members: You can instantly pull data sets and data set members from the mainframe, edit them and upload back.
• Create and delete data sets and data set members: Enables you to easily create and delete both data sets and their members.
• View and access multiple profiles simultaneously: Enables to work with data sets from multiple profiles.
• Submit a JCL: You can submit a jcl from a chosen data set.

View data sets and use multiple filters

1. Navigate to the explorer tree.
2. Open the DATA SETS bar.
3. Select the profile that you want to filter.
4. Click the Search Data Sets by Entering Patterns magnifying glass.
5. From the drop-down, enter the patterns that you want to filter.
   The data sets that match your pattern(s) display in the explorer tree.

Tip: To provide multiple filters, separate entries with a comma. You can append or postpend any filter with an *, which indicates wildcard searching. You cannot enter an * as the entire pattern.

Refresh the list of data sets

1. Navigate to the explorer tree.
2. Click Refresh All button on the right of the DATA SETS explorer bar.

Rename data sets

1. Navigate to the explorer tree.
2. Open the DATA SETS bar.
3. Select a data set you want to rename.
4. Right-click the data set and select the Rename Data Set option.
5. Change the name of the data set.

Copy data sets

1. Navigate to the explorer tree.
2. Open the DATA SETS bar.
3. Select a member you want to copy.
4. Right-click the member and select the Copy Data Set option.
5. Right-click the data set where the member belongs and select the Paste Data Set option.
6. Enter the name of the copied member.

Download, edit, and upload existing PDS members

1. Navigate to the explorer tree.

2. Open the DATA SETS bar.

3. Open a profile.

4. Click the PDS member (or PS) that you want to download.

   Note: To view the members of a PDS, click the PDS to expand the tree.

   The PDS member displays in the text editor window of VSC.

5. Edit the document.

6. Navigate back to the PDS member (or PS) in the explorer tree, and click the Save button.

Your PDS member (or PS) is uploaded.

Note: If someone else has made changes to the PDS member (or PS) while you were editing it, you can merge your conflicts before uploading to the mainframe.

Use the save option to prevent merge conflicts

1. Navigate to the explorer tree.
2. Open the DATA SETS bar.
3. Open a profile.
4. Download and edit a data set.
5. Click the Save button for the data set that you opened in the explorer tree.
6. Resolve merge conflicts if necessary.

Create a new PDS and a PDS member

1. Navigate to the explorer tree.
2. Open the DATA SETS bar.
3. Click the Create New Data Set button to specify the profile that you want to create the data set with.
4. From the drop-down menu, select the type of PDS that you want to create.
5. Enter a name for the PDS. The PDS is created.
6. To create a member, right-click the PDS and select Create New Member.
7. Enter a name for the member. The member is created.

Delete a PDS member and PDS

1. Navigate to the explorer tree.

2. Open the DATA SETS bar.

3. Open the profile and PDS containing the member.

4. Right-click on the PDS member that you want to delete and select Delete Member.

5. Confirm the deletion by clicking Yes on the drop-down menu.

   Note: Alternatively, you can select 'No' to cancel the deletion.

6. To delete a PDS, right-click the PDS and click Delete PDS, then confirm the deletion.

   Note: You can delete a PDS before you delete its members.

View and access multiple profiles simultaneously

1. Navigate to the explorer tree.
2. Open the DATA SETS bar.
3. Click the Add Profile button on the right of the DATA SET explorer bar.
4. Select the profile that you want to add to the view as illustrated by the following screen.

---

USS

You can use the following functionalities when interacting with USS files:

• View Unix System Services (USS) files: You can view multiple USS files simultaneously.
• Rename USS files: You can rename specified USS files.
• Download, edit, and upload existing USS files: You can instantly pull USS files from the mainframe, edit them and upload back.
• Create and delete USS files and directories: Enables you to easily create and delete both USS files and directories.
• View and access multiple profiles simultaneously: Enables to work with USS files from multiple profiles.

View Unix System Services (USS) files

1. Navigate to the explorer tree.
2. Open the Unix System Services (USS) bar.
3. Select the profile that you want to filter.
4. Click the Search Unix System Services (USS) by Entering a Path magnifying glass.
5. From the drop-down, enter the path that you want as the root of your displayed tree.
   All child files and directories of that root file are displayed in the explorer tree.

Note: You will not be able to expand directories or files that you are not authorised for.

Refresh the list of files

1. Navigate to the explorer tree.
2. Click Refresh All button on the right of the Unix System Services (USS) explorer bar as illustrated by the following screen:

Rename USS files

1. Navigate to the explorer tree.
2. Open the USS bar.
3. Select a USS file you want to rename.
4. Right-click the USS file and select the Rename USS file option.
5. Change the name of the USS file.

Download, edit, and upload an existing file

1. Click the file that you want to download.

   Note: To view the files within a directory, click the directory to expand the tree.

   The file displays in the text editor window of VSC.

   Note: If you have defined file associations with syntax coloring the suffix of your file will be marked up.

2. Edit the document.

3. Type Ctrl-s or Command-s (OSx) to save the file

Your file is uploaded.

Creating and deleting files and directories

Create a directory

1. Navigate to the explorer tree.
2. Open the Unix System Services (USS) bar.
3. Select a directory that you want to add the new directory to.
4. Select the Create directory button and specify the directory name. The directory is created.

Create a file

1. Navigate to the explorer tree.
2. Open the Unix System Services (USS) bar.
3. Select a directory that you want to add the new file to.
4. Select the Create file button and specify the file name. The file is created.

Delete a file

1. Navigate to the explorer tree.
2. Open the Unix System Services (USS) bar.
3. Select a file you want to remove.
4. Select the Delete button and press yes in the confirmation dropdown. The file is deleted.

Delete a directory

1. Navigate to the explorer tree.
2. Open the Unix System Services (USS) bar.
3. Select a directory you want to remove.
4. Select the Delete button and press yes in the confirmation dropdown. The directory and all child files and directories are deleted.

View and access multiple USS profiles simultaneously

1. Navigate to the explorer tree.
2. Open the Unix System Services (USS) bar.
3. Click the Add Session button on the right of the Unix System Services (USS) explorer bar.
4. Select the profile that you want to add to the view as illustrated by the following screen.

---

JOBS

You can use the following functionalities when interacting with Jobs:

• View a job: You can view multiple jobs simultaneously.
• Download spool content: You can download spool content on your computer.

View a job

1. Navigate to the explorer tree.
2. Open the JOBS bar.
3. Select a directory with JCL files.
4. Right-click on the JCL you want to view, and click Get JCL.

Download spool content

1. Navigate to the explorer tree.
2. Open the JOBS bar.
3. Select a directory with JCL files.
4. Click the Download icon next to a folder with the spool content.
5. Save the file on your computer.

---

Extras

Issue MVS commands

Zowe Explorer also enables you to issue MVS command. You can issue such commands as Allocate or Exec against a profile.

1. Press the F1 key on your keyboard.
2. Select the Zowe:Issue MVS Command option.
3. Select your profile.
4. Issue a MVS command.