Opening a z/OS dataset or z/OS UNIX file in an editor from a hyperlink

The Topaz Editors can recognize text references to z/OS datasets and z/OS UNIX files and allow users to click the hyperlinked names to open the files in an editor. Abend-Aid users can click hyperlinks in the Abend-AID Web Browser Interface to open them in an editor as well. Refer to the Abend-AID help for more information.

Syntax rules

Hyperlinks to datasets must adhere to IBM’s z/OS dataset naming rules. Hyperlinks for z/OS UNIX files must adhere to the following syntax rules:

• A symbol must be preceded by whitespace or else located at the beginning of a line.
• A symbol must begin with a single forward slash.
• A symbol may contain any combination of alphanumeric characters, hyphens, periods, and underscores.
• Spaces and most other non-word characters are not recognized.
• z/OS UNIX hyperlinks are case-sensitive.

To enable hyperlinking

1. From the Window menu, select Preferences. The Preferences dialog box appears.
2. Select General>Editors>Text Editors>Hyperlinking. The Hyperlinking preferences page appears.
3. Select the Enable on demand hyperlink style navigation check box to enable hyperlinks.
4. Select the check box(es) for the items to be recognized:
   • z/OS Dataset
   • z/OS UNIX File
5. Optionally, do one of the following to require a modifier key be entered :
   • Enter in the Default modifier key field a default modifier to be used for all selected link kinds.
   • Select an item in the Link Kind column and then enter a modifier key for that item in the Modifier keys for selected detector field. Note: Valid modifier keys for z/OS datasets and z/OS UNIX files are CTRL and ALT.

6. Click OK. Future text references to the selected items will appear as hyperlinks. In the Topaz JCL Editor, hyperlinks appear underlined. 

   Important

    In the Topaz Editors, to disable hyperlinking, clear the appropriate check box or clear the Enable on demand hyperlink style navigation check box to disable all hyperlinking.

To specify which file extensions will display z/OS dataset hyperlinks

Users can specify which file extensions will display z/OS dataset hyperlinks. By default, z/OS dataset hyperlinks are shown only for files with a .jcl, .jes, .cntl, or .ctl extension, however, any extension can be added.

1. From the Window menu, select Preferences. The Preferences dialog box appears.
2. Select Compuware>Hyperlinks. The Hyperlinks preferences page appears.
3. Do either of the following:
   • To display z/OS dataset hyperlinks for all file extensions, clear the Only display z/OS dataset hyperlinks for the following file extensions check box.
   • To display z/OS dataset hyperlinks for selected file extensions only, ensure that the Only display z/OS dataset hyperlinks for the following file extensions check box is selected, type the extension into the text field, and click Add. Repeat as necessary for additional file extensions. Extensions are case-insensitive and are not prefixed by a dot (.).
4. Click Apply to apply the changes but not close the dialog box or click OK to apply the changes and close the dialog box.

To share hyperlink preferences

The preferences for which file extensions will display z/OS hyperlinks can be exported so they can be shared with others or be imported when configuring a new workspace.

1. From the Export Compuware Configuration dialog box, export the hyperlink preferences by selecting Host Explorer>Hyperlinks and completing the remainder of the dialog box. Refer to the Workbench for Eclipse User Guide online help for details on using this dialog box.
2. From the Import Compuware Configuration dialog box, import the hyperlink preferences by selecting Host Explorer>Hyperlinks and completing the remainder of the dialog box. Refer to the Workbench for Eclipse User Guide online help for details on using this dialog box.

To open a resource from a hyperlink

1. In an editor, do one of the following:
   • Click a hyperlink. Note that the Topaz JCL Editor's hyperlink-eligible dataset names are underlined.
   • If a modifier key is required, press that key and click the hyperlink.
   • Select the hyperlink, then right-click the hyperlink, select Hyperlink, and select from the submenu on of the following:
     • Browse
     • Edit
     • Browse With
     • Edit With
       Note: The Hyperlink submenu option is not available for z/OS datasets if the extension type of the resource is not included in the File extensions list on the Hyperlinks dialog box.

2. Do one of the following if necessary:

   • If the hyperlink references a PDS that contains members, the Dataset Selection dialog box appears. Select the member to open and click OK.
   • If the hyperlink references a migrated dataset, a message asks whether to recall the dataset. If desired, click Yes and, when the recall is complete, click the hyperlink again.
   • If the hyperlink is in a local file or if a host connection has not been established, the Select a Host dialog box appears so the appropriate host can be selected or configured for hyperlink processing.

   The resource is opened in an editor based on the default dataset open mode indicated on the Host Explorer Preferences dialog box.

   Important

   If the dataset name or file name is not a valid format, an error message appears and allows for the choice of a different host that may allow processing of the hyperlink. If the hyperlink references an empty PDS, an error message appears.