Download Copybooks

Topaz COBOL Editor or Topaz PL/I Editor copybook downloading can be configured to automatically download copybooks when opening a program in one of these editors. In addition, copybooks can be manually downloaded as needed, for example, if a program was opened without automatically downloading the copybooks or if the program has been modified.

For the download process to work, the source code member must be mapped to a COBOL or PL/I language extension (.cbl, .pli, and so on).

The high-level tasks involved in the copybook download process are as follows:

• Set copybook preferences.
• Download copybooks.
• Address any failures

Set copybook preferences

Preferences can be set to control automatic downloading of copybooks when opening a program, clearing the cache, and validating datasets prior to download. In addition, copybook download settings can be exported into the local file system and then imported.

To set preferences for downloading copybooks

1. From the Window menu, select Preferences. On the Preferences dialog box, toggle open the Compuware node and select Copybooks. The Copybooks page appears.
2. Select one of the following settings to control automatic downloading of copybooks when opening a program in the Topaz COBOL Editor or Topaz PL/I Editor:
   • Always - Copybooks are always automatically downloaded when a program is opened in a supported editor.
   • Never - Copybooks are never automatically downloaded when a program is opened in a supported editor.
   • Prompt - The user is asked whether to download copybooks when a program is opened in a supported editor.

3. Select the check box in the Copybook Cache box to clear the cache of downloaded copybooks when the Eclipse-based session is terminated. Clear the check box to keep downloaded copybooks until the user manually deletes them.

   Warning

   Note: At any time, to manually delete downloaded copybooks from the cache, click Delete Now. A message appears asking for confirmation. Click OK. The copybooks are deleted. Any that are open in an editor will be deleted when the editor is closed.

4. Select the Validate datasets prior to downloading copybooks check box if validation is desired. Otherwise, clear the check box.
5. Click OK.

Download copybooks

To automatically download copybooks

When opening a program in the Topaz COBOL Editor or Topaz PL/I Editor from an ISPW view, the component must be mapped to one of the COBOL or PL/I language extensions.

1. Ensure that the copybook preference is set to Always or Prompt.

2. Open the program in a Topaz COBOL Editor or Topaz PL/I Editor. The copybooks are automatically downloaded unless any failures occur.

   Warning

   Note: When opening a program, if the copybook preference is set to Prompt, a message appears asking whether to download the copybooks used in the program. Click Yes.

To manually download copybooks for a program currently opened in a supported editor

When opening a program in the Topaz COBOL Editor or Topaz PL/I Editor from an ISPW view, the component must be mapped to one of the COBOL or PL/I language extensions.

1. With the program open in a supported editor, right-click anywhere within the editor and select Download Copybooks. The appropriate copybooks are download unless any failures occur.