Mainframe Search README

Search a mainframe library running a jcl with ISRSUPC.

Table of Contents

• 1. Features
• 2. Requirements
• 3. Settings
• 4. How to...
• 5. Known Issues
• 6. Release Notes

1. Features

1. Search the mainframe for a string
2. Select the library from the Zowe Explorer
3. Filter the search library elements
4. Visualize search results
   1. List of elements
   2. Json
   3. OutDD
5. Showed information
   1. Show line number
   2. Show the line where the search string
6. Opens an item from the search results list in the row where that result is located.
7. highlight the search string
   1. List
   2. OutDD
   3. Json

2. Requirements

• Zowe Explorer VSCode Extension.
• A zosmf connection profile.
• A valid mainframe UserID.

3. Settings

This extension contributes the following settings:

• zSearch.JobCard.Name: Job Name to be used on Job Card.

  Default value: ${USER}S

  💡 Info: In the job card the variable ${USER} will be replaced by the userid associated with the active zosmf profile.

• zSearch.JobCard.CLASS: Class to be used on Job Card.

  Default value: D

• zSearch.JobCard.MSGCLASS: Message Class to be used on Job Card.

  Default value: X

• zSearch.PanelPosition: Select the position where the search results panel will be showned

  Possible values:

  Active - The currently active column

  Beside (Default) - The column to the side of the active one

• zSearch.SearchStrings.NumberOfPreviousSearchStrings: Number of previous search string to list on a quick pick for the selected library

  Default value: 5

  Min Value: 0

  Max Value: 20

• zSearch.SearchStrings.ListOfPreviousSearchStrings: A list of previous search string for the selected library. The list is showed on the Search String quick pick

  Min items: 0

  Max items: 20

• zSearch.SearchFilters.NumberOfPreviousSearchStrings: Number of previous search filters to list on a quick pick for the selected library

  Default value: 5

  Min Value: 0

  Max Value: 20

• zSearch.SearchStrings.ListOfPreviousSearchStrings: A list of previous search Filters for the selected library. The list is showed on the Search Filters quick pick

  Min items: 0

  Max items: 20

4. How to...

1. On the zowe explorer select a library.
2. Expand the library.
3. Right click on the library.
4. Select the zSearch - Search on library menu .

5. Enter the Search string.

   • A combobox shows the last Search Strings used.
   • If the active editor has a selected text, the search string input box opens with the selected text as search string.

6. Filter the library elements with the necessary Filters strings.

   • A combobox shows the last Filter strings used.
   • More than one filter is enabled.

7. On the mainframe a job will be launched.
8. A panel will show the results returned by the job after it's execution as ended.

9. The result can be visualized as a list, outDD or json:
   1. List - List of elements with the search string:
      1. The list of elements can be expanded tho show the line number em content of the line hiliting the search string.
      2. The line number as a link that will open the element on its respective line.
   2. OutDD - Representation of the sysout element outDD with the search result.
   3. Json - The search results represented as a json object.
10. The line number on the list opens the selected element at its line.

💡 Filter Facts:

1. Filter can select elements that start or end with a string:
   1. Start with the alfa-numeric string aaa (example: 'aaa*' or 'aaa').
   2. Ends with the alfa-numeric string aaa (example: '*aaa').
   3. If no filters selected or the '*' selected all elements on the library will be searched.
2. More than one filter can selected.

5. Known Issues

n/a

6. Release Notes

1.1.1

• Corrected dependency's.

1.1.0

• Added a "Searching..." message to the VS Code toolbar.
• Stopped saving files to the workspace when a line number is selected to open.
• Removed the dependency of having the xowe explorer members.

1.0.9

• Added the number os results to the "Expand All" and "Collapse All" buttons.

1.0.7

• Added Expand and Collapse buttons.

1.0.6

• Added the ability to search a string on the results.
• Corrected error on the open file at line functionality

1.0.6

• Improved performance.

1.0.4

• A historic of the search strings and used filters added.

1.0.3

• Correction of the zowe session access.

1.0.2

• Correcting the job definition

1.0.1

• Initial release of zSearch