Downloading copybooks

Copybook downloading can be configured to automatically download copybooks when opening a program in Topaz COBOL Editor or Topaz PL/I Editor. In addition, copybooks can be manually downloaded as needed, for example, if a program was opened without automatically downloading the copybooks, or if changes were made to the active copybook concatenation list, or if the program has been modified.

During copybook download, two types of failures can occur: concatenation list failure or copybooks not found error.

A concatenation list failure message appears if validation errors exist and the Validate datasets prior to downloading copybooks check box is selected on the Copybooks page of the Preferences dialog box. Reasons for validation failure are as follows:

• The dataset is not found.
• The dataset is migrated.
• The dataset is not a PDS dataset.
• The user does not have authority to the dataset.

A copybook not found error occurs after datasets are validated (if validation prior to download is requested) and available copybooks have been downloaded. This type of error indicates that certain copybooks within the selected copybook concatenation list were not found.

To automatically download copybooks

1. Ensure that the program member/dataset is mapped to one of the COBOL or PL/I language extensions. Refer to z/OS Dataset Extension Mappings for more information.
2. Set the Copybook preferences to Always or Prompt.

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

   Important

   When opening a program from the Host Explorer view, if the Copybook preference is set to Prompt, a message appears asking whether to download the copybooks used in the program. Click Yes.

4. Address any validation failures or copybook not found messages.

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

1. Ensure that the program member/dataset is mapped to one of the COBOL or PL/I language extensions. Refer to z/OS Dataset Extension Mappings for more information.
2. 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.
3. Address any validation failures or copybook not found messages.

To address validation failures

If the Review Validation Failure Results dialog box appears, do any of the following:

1. 
   
   • Click Ignore to continue the download process without using the invalid datasets.
   • Select Configure Copybook Concatenation Lists and make necessary changes to the concatenation list. Then click Retry to revalidate the list.
   • Click Cancel to abort the download process.

2. Note

   Select the Do not validate datasets prior to downloading copybooks check box to prohibit validation in the future.

To address copybook not found messages

If the Copybooks Not Found dialog box appears, do either of the following:

• Click Ignore to end the download process without downloading missing copybooks.
• Select Configure Copybook Concatenation Lists and make necessary changes to the concatenation list. Then click Retry to attempt to download these missing copybooks.