raincode rect

Catalog Explorer User Guide


Version 4.2.333.0

1. Introduction

Catalog Explorer is a graphical user interface for accessing the Raincode JCL Catalog. The Catalog Explorer helps to manage Data Sets of type Files, PDS (Partitioned Data Set), and GDG (Generation Data Group).

The Catalog Explorer has the ability to:

  • Create Data Set

  • Modify metadata of Data Set

  • Replace data file

  • Rename, Copy/Paste, Move and Delete Data Set

  • Import/Export

2. User Interface

As shown below, the main screen of the Catalog Explorer shows the UI elements.

image001 1
Figure 1. Catalog Explorer main screen

Following is a short description of the UI elements:

1. Menu bar

2. Toolbar

When the Catalog Explorer starts, or you change the catalog configuration file, it does not refresh all the data to reduce the populating time.

datanotrefreshed
Figure 2. Data not refreshed

You have to click refresh from the toolbar to refresh the data.

Once the refresh is done, the not refreshed text will disappear from the Navigation pane.

datarefreshed
Figure 3. Data refreshed

The Catalog Explorer also allows you to load multiple volumes.

Multiplevolumes
Figure 4. Multiple Volumes

You have to select the required volume from the Volume Selector and click refresh to load them.

The red dot on top of the volume represents the Default volume.
The Default Volume has already been expanded for your ease.

2.1. Toolbar

toolbar
Figure 5. Toolbar
Table 1. Catalog Explorer toolbar
Icon Description

add

It creates a new Data Set

floppy

It saves the Data Set

re

It renames the Data Set

delete

It deletes the Data Set

contract

It contracts all the Data Sets

openfile

It opens the Data Set in the File Explorer

refresh

It refreshes the Data Set

pagesizebox

It sets the size of the page in the page size box

slowcatalogaccess

It saves the time of catalog populating. For more details, refer to the Slow Catalog Access.

2.1.1. Slow Catalog Access

When the slow catalog access is checked, the children nodes of GDG and PDS will not get populated.

beforedoubleclick
Figure 6. Data Set when slow catalog access checked

To populate them, you have to double-click the Data Sets.

Dataset after double click
Figure 7. Data Set after double click

A small triangle icon will appear after the double-click on the Data Set, as shown in the screenshot above.

To see the children’s nodes, click on the triangle icon.

pdsmemeberslowaccess
Figure 8. Data Set with its children’s nodes

The size will appear once you select the children node.

childsize
Figure 9. Node Size
The Catalog Explorer’s toolbar is context-sensitive.

The Navigation Pane of the Catalog Explorer shows the Data Sets, provides the Filter controls to filter them and the Volume selector to select the volumes.

2.2.1. Volume Selector

The drop-down menu appears when you click on the arrow in the volume selector.

Navipane1
Figure 11. Volume Selector

2.2.2. Volume Header

The Catalog Explorer’s Volume header shows the Data Sets in a tabular form, with the first column showing the Data Sets, the second column showing the type of the Data Sets, the third column showing the record format, the fourth column showing the record length, the fifth column showing the creation date and the sixth column showing the size.

volumeheader
Figure 12. Volume Header

Volume header also allows you to navigate the Data Sets using the navigation navibutt buttons.

Clicking on the drop-down arrow of the Volume header will expand and contract the Data Sets.

Pointing the mouse arrow on the Volume header shows the path of the volume root.

volumeroot
Figure 13. Path of the volume root
If the record length of the Data Set is 0, then the record length column entry will show a hyphen (-).
Navigation is within the volume.

2.3. Metadata Window

The Metadata window allows you to edit and modify the metadata of the Data Sets. The Metadata window appears when you select the Data Sets, right-click and select editmeta from the context menu. The Metadata window opens as a modal window.

metadatapane
Figure 14. Metadata Window

Below mentioned are metadata that you can modify:

  • Creation date

  • Expiry date

  • Retention period

  • Record format

  • File format

  • Record length

  • SYSOUT message class

  • Number of copies

  • Marked for deletion

  • Override path

  • Code page

  • Key length

  • Key offset

  • Maximum record size

  • File config

When you edit any metadata for the Data Set, it will show that Data Set as a draft in the main Catalog Explorer window, and the Save button will get highlighted as shown in the Draft Data Set screenshot. If you press enter at this moment, your changes will get saved. If you close the Metadata window without saving or discarding, you can save the modified metadata by pressing the save button from the toolbar of the Catalog Explorer.

draftdataset
Figure 15. Draft Data Set

For more details, see the section Data Sets Metadata.

2.4. Activity Log Pane

Activity Log Pane at the bottom of the Catalog Explorer shows the result of the actions such as creating the Data Set or import.

activitylog
Figure 16. Activity Log Pane
The title of the main screen of Catalog Explorer provides the path of the loaded catalog.

3. Data Sets

3.1. Data Sets

Data Sets are a collection of multiple related records. There are several types of Data Sets in the mainframe. Refer to Representation of the Data Sets for more details on the Data Sets.

Data Sets are shown in the DSN view. DSN view is the visual representation of the Data Sets from the mainframe naming perspective.

Data Sets handled by the Catalog Explorer are:

  • Partitioned Data Set (PDS)

  • Generation Data Group (GDG)

  • File

3.1.1. Partitioned Data Set

A Partitioned Data Set, also known as PDS, is a Data Set that contains a directory and members.

pdsonthemaindisplay
Figure 17. PDS with its members

pdsicon is the icon of PDS.

The type of PDS member is represented in brackets (pdsmember).

For more details, see the Partitioned Data Set.

3.1.2. Generation Data Group

A Generation Data Group, also known as GDG, versions the Data Sets that are successive generations of historically-related data.

gdglastversionsetascurent
Figure 18. GDG, with its generations

gdgicon is the icon of the GDG.

gdggeneration is the icon of the GDG generation.

Each generation of a GDG has the pattern G0001V00. Letter G is followed by four digits, representing the number of the generation, and Letter V represents the version.

GDG version with the red dot on the top indicates the current GDG generation.

For more details, see the Generation Data Group.

3.1.3. File

fileonthemaindisplay
Figure 19. File Data Sets

fileicon is the icon of the File Data Set.

4. Data Sets Metadata

All types of Data Sets have metadata that appears in the Metadata window. The Catalog Explorer’s Metadata window allows you to edit and modify the metadata.

Few fields of metadata:

  • Cataloged: If you checked the cataloged checkbox, the Data Set could be referred to by the name without specifying where it is stored.

cataloged
Figure 20. Cataloged
  • Record format: Click the arrow, and a drop-down menu with the options FB, VB, FBA, VBA, LSEQ will appear. Select the required format from this menu.

edit file record
Figure 21. Edit Record Format
  • File format: Click the arrow, and a drop-down menu with the options EntrySequenced, KeySequenced, RelativeRecord, Binary will appear. Select the required format from this menu.

edit file format
Figure 22. Edit File Format
  • Record length: Select a value from 0 to 32-bit integer.

edit record length
Figure 23. Edit record length
  • Code page: Click the arrow, and a drop-down menu with the code page options will appear. Select the required code page from these options.

codepage
Figure 24. Code Page
  • File config: You can edit the file config parameters by adding parameters in the file config box.

fileconfig
Figure 25. File config
The metadata of PDS members and GDG versions cannot be edited.

5. Walk-through

5.1. Change catalog configuration

The Catalog Explorer provides the flexibility of choosing a different catalog than the one loaded by default. You can do this by selecting the appropriate catalog configuration file.

To select the configuration file:

  • Select File→Change configuration

changeconfig
Figure 26. Change Catalog Configuration

5.2. Modifying a Data Set

5.2.1. Adding a new Data Set

The steps to add a new Data Set (PDS, GDG, or File) are as follows:

1. Click add in the Catalog Explorer toolbar, a new screen will appear as shown below.

2. Keep DEFAULT in the Volume.

3. Add the name of the Data Set.

4. From the Type option, select the type of Data Set.

image030
Figure 27. Add a new Data Set Screen

After the Data Set is created, it will appear on the main window.

image032
Figure 28. A new file on the main window
A newly created Data Set will appear in bold; click floppy from the toolbar to save.
A newly created Data Set is preserved during navigation, refresh, filter, and volume expand/contract.

5.2.2. Context menu of the Data Sets

PDS, GDG, and File provide a separate context menu when you right-click on the Data Set.

Table 2. Context menu of the Data Sets

Data Set

Context Menu

PDS

contextmenuforpds

GDG

contextmenuforgdg

File

contextmenu

For more details on the context menu options, see section Specific Features and Modifying data.

5.2.3. Delete a Data Set

The steps to delete a Data Set are as follows:

1. Select and right-click on the Data Set which needs to be deleted. The context menu will appear.

2. Click on the delete delete from the context menu, and it will delete the Data Set after confirming, as shown below.

image037
Figure 29. Delete Data Set

5.2.4. Rename a Data Set

The steps to rename a Data Set are as follows:

1. Select and right-click on the Data Set, which needs to be renamed. The context menu will appear.

2. Click on the rename from the context menu, a new pop-up window will appear.

3. Provide a new name to the Data Set and click OK.

renamepopupwindow
Figure 30. Pop up window
You can only rename the last qualifier.

5.2.5. Copy and Paste

The steps to Copy and Paste a Data Set are as follows:

1. Select and right-click on the Data Set, which needs to be copied. The context menu will appear.

2. Click on the copy from the context menu.

3. Right-click on the root folder, click on the paste, a pop-up window will appear, provide the target and click OK.

pastepopupwindow
Figure 31. Paste pop up window

5.2.6. Move a Data Set

The move feature allows moving the Data Sets from one folder to another.

The steps to move a Data Set are as follows:

1. Select and right-click on the Data Set, which needs to be moved. The context menu will appear.

2. Click on the move from the context menu, a pop-up window will appear, provide the new folder name and click OK.

movepopupwindow
Figure 32. Move pop up window

5.3. Finding the Data Sets

Filter controls allow you to narrow down the shown Data Sets to find the desired Data Set.

The steps to apply a filter are as follows:

1. Enter the search term in the filter controls box of the navigation pane and click applyfilter.

2. Filtered Data Sets will be displayed, as shown in the Filtered Data Sets screenshot below.

3. Clear the filter by clicking clearfilter from the filter controls.

filtereddatasets
Figure 33. Filtered Data Sets

Press the refresh button from the filter controls to refresh all the filtered directories. It will populate the updated datasets.

refreshfilterdirectories
Figure 34. Refresh filtered directories

Filter controls support the following wildcard characters:

Table 3. Wildcard characters for filter

Character

Description

Example

*

Represents zero or more characters

pa* finds pa, pan, paint

?

Represents a single character

r?d finds red, rid, rod

Filter controls apply to all the volumes.

6. Specific Features

6.1. Adding a generation to a GDG

There are two ways to add a generation to an existing GDG:

1. Select the GDG and right-click; the context menu will appear. Select gdgcontextmenu from the context menu.

2. Select the GDG and click add from the toolbar. A pop-up window confirming the addition of the generation will appear

confirmpopupwindow
Figure 35. Confirm pop up window

A few generations of a GDG are shown in the screenshot below:

gdgwithgeneration
Figure 36. GDG with generations
Creating a GDG does not automatically create a generation. So, the options GDG(+1) and GDG(-1) will be disabled as there wouldn’t be a single generation.

If required, you can change the current GDG generation by selecting setascurrent from the GDG member context menu.

6.2. GDG plus one and GDG minus one

gdgplusone will set the current generation of the GDG one ahead.

If the current generation is set to G0001V00, GDG(+1) will move it to G0002V00.

If the last GDG generation is set as current,

gdglastversionsetascurent
Figure 37. GDG last generation set as current

then clicking GDG(+1) will give an error stating that cannot perform GDG(+1) beyond the latest generation.

popuperrorlatest
Figure 38. GDG beyond the latest generation

gdgminusone will set the current generation one back.

If the current generation is set to G0002V00, GDG(-1) will move it to G0001V00.

If the first GDG generation is set as current,

gdgfirstversionsetascurrent
Figure 39. GDG first generation set as current

then clicking GDG(-1) will give an error stating that cannot perform GDG(-1) beyond the oldest generation.

popuperrorolder
Figure 40. GDG beyond the oldest generation

6.3. Adding a member to a PDS

The steps to add a new member to the PDS are as follows:

1. Select the Add new member from the context menu, and Add new PDS member screen will appear

image007
Figure 41. PDS New Member
The new member’s prefix is the PDS name to which this member needs to be added, and the Catalog Explorer prefills it.

2. Provide a name for this new member.

image008
Figure 42. Give a name to the new PDS member
The type of PDS member is always a File.

6.4. Drag and drop in a PDS

The Catalog Explorer provides an option of drag and drop in a PDS.

1. Select the File which needs to be moved

2. Drag the selected File to the PDS and release the mouse. A pop-up window confirming the move will appear; click OK to move

confirmdrop
Figure 43. Confirm move

You can also drag and drop the files from the folder outside the Catalog Explorer.

1. Select all the files which need to be moved

select members pds
Figure 44. Select files for the PDS

2. Drag all the selected Files to the PDS in the Catalog Explorer and release the mouse. All the chosen Files will be added to the PDS (DR01.K140771.PDS1), as shown in the screenshot below

drag selected members
Figure 45. Moved files
Since it is impossible to validate the meta-information for the files being dragged and dropped in a PDS, kindly make sure you drop the correct files.

7. Modifying data

The Catalog Explorer allows you to replace and edit the File.

7.1. Replace the File

The steps to replace the File are as follows:

1. Select the File and right-click; the context menu will appear.

2. Select Replace from the context menu. A pop-up window to choose the new File will appear.

3. Select the new File and click Open to replace the File with the chosen one.

filmenu
Figure 46. Pop-up window choose File

7.2. Edit the File

The steps to edit the File are as follows:

1. Select the File and right-click; the context menu will appear.

2. Select Edit from the context menu. A record editor will launch in a separate window to edit the data.

recordeditor
Figure 47. Record Editor

For more details on the working of the Raincode Record Editor, see the Record Editor.

8. Import Export

Metadata of the files and the files can be IMPORTED and EXPORTED through the Catalog Explorer.

8.1. Import the Files

The steps to import the files are as follows:

1. Select File→Import files…​.

importfile
Figure 48. Import File context menu

2. Select the required Files for import and click Open to import selected Files.

file import dialog
Figure 49. An import dialog box for file

8.2. Importing from CSV

The steps to import metadata of the Files through CSV are as follows:

1. Select File→Import CSV…​

importcsv
Figure 50. Import from CSV

2. Select the required CSV for the import.

CSV import dialog
Figure 51. Import dialog box

3. CSV File will be imported as shown in the screenshot below.

importedcsv
Figure 52. Imported CSV

8.3. Exporting to CSV

The steps to export metadata of the Files to the CSV are as follows:

1. Select File→Export All

exportcsv
Figure 53. Export to CSV

2. Select the path for the metadata to be exported.

CSV export
Figure 54. Export file

8.3.1. Export a Data Set

The steps to export a Data Set are as follows:

1. Select the Data Set and right-click; the context menu will appear.

exportgdg
Figure 55. Export Data Set context menu

2. Select export, choose the desired location for export, and press OK.

exportlocation
Figure 56. Exporting Data Set

9. Error Reporting

9.1. Error Reporting of the Catalog Explorer

Some of the possible scenarios when errors may occur are:

  • Trying to create or rename a Data Set that already exists.

image061
Figure 57. Data Set already exists
  • Trying to drag or drop with an invalid name.

image063
Figure 58. Invalid names while Drag and Drop

9.2. Naming limitation

  • Each name segment (qualifier) should be between 1 to 8 characters.

image010
Figure 59. Naming Limitation 1
  • Name cannot start or end with a dot (.).

Naminglimitation5
Figure 60. Naming Limitation 5
  • Name does not have the required prefix.

Naminglimitation6
Figure 61. Naming Limitation 6
  • Incorrect nesting. Required 2 level(s) but found 3.

Naminglimitation7
Figure 62. Naming Limitation 7
Naming limitations are also applicable when importing/exporting and drag and drop.

10. Keyboard Shortcuts

10.1. Keyboard shortcuts for the Catalog Explorer

Keyboard Shortcuts

Purpose

ctrl+N

New (create a new Data Sets)

ctrl+I

Import CSV

ctrl+E

Export All

ctrl+M

Import Files

ctrl+S

Save

Alt+F4

Exit

ctrl+C

Copy

ctrl+V

Paste

Del

Delete

F1

About

Appendix A: Lists of tables and figures in the document

Glossary

This section supplies a glossary of terms pertaining to Raincode Catalog Explorer.

PDS

Partitioned Data Set

GDG

Generation Data Group (A file with metadata and multiple possible generation)