VAX_COBOL_____________________________________ Installation Guide Order Number: AA-K026P-TE March 1997 This document contains instructions for installing VAX COBOL on the OpenVMS VAX operating system. It also explains how to read the online release notes before or after installing the product. This document applies to VAX COBOL Version 5.4 and any maintenance updates for that version. Revision/Update Information: This revised manual supersedes the VAX COBOL Installation Guide (Order Number AA- K026N-TE). Operating System and Version: OpenVMS VAX Version 6.1 or higher. Future releases may require higher versions. Software Version: VAX COBOL Version 5.4 __________________________________________________________ First Printing, June 1980 March 1997 Digital Equipment Corporation makes no representations that the use of its products in the manner described in this publication will not infringe on existing or future patent rights, nor do the descriptions contained in this publication imply the granting of licenses to make, use, or sell equipment or software in accordance with the description. © Digital Equipment Corporation 1980, 1997. All Rights Reserved. The following are trademarks of Digital Equipment Corporation: ACMSxp, Bookreader, CMS, DEC COBOL, DECdocument, DEC Fortran, DEC FUSE, DECladebug, DECnet, DEC PASCAL, DCset, DECTPU, DIGITAL, OpenVMS, PDP, Professional, VAX, VAX-11/730 VAX-11/780, VAX ADA, VAX BASIC, VAX C, VAX CDD, VAXcluster, VAX COBOL, VAX COBOL GENERATOR, VAX DOCUMENT, VAX MACRO, VAX RMS, VAX SCAN, VMS, VT, VT100, VT200, VT300, VT420, and the DIGITAL logo. The following are third-party trademarks: BASIC is a registered trademark of the Trustees of Dartmouth College, (Dartmouth Structured Basic) D.B.A. Dartmouth College. Display POSTSCRIPT and POSTSCRIPT are registered trademarks of Adobe Systems Incorporated. Micro Focus is a registered trademark of Micro Focus Limited. DBAPack, Hot Standby, Oracle CDD/Administrator, Oracle CDD/Repository, Oracle CODASYL DBMS, Oracle DBA Workcenter, Oracle Enterprise Manager, Oracle Expert, Oracle Graphical Schema Editor, Oracle InstantSQL, Oracle Rally, Oracle Rdb, Oracle RMU, Oracle RMUwin, Oracle SQL/Services, Oracle Trace, Oracle Trace Collector, and Rdb7 are trademarks of Oracle Corporation. UNIX is a registered trademark in the United States and other countries, licensed exclusively through X/Open Company Limited. X/Open is a trademark of X/Open Company Limited. All other trademarks and registered trademarks are the property of their respective holders. ZK5514 This document is available on CD-ROM. This document was prepared using VAX DOCUMENT Version 2.1. ______________________________________________________________ Contents .................................................. v 1 Preparing to Install VAX COBOL............... 1 1.1 Accessing the Online Release Notes....... 1 1.2 System Prerequisites..................... 2 1.3 Installation Procedure Requirements...... 2 1.4 Special Requirements..................... 4 1.5 Using VMSINSTAL.......................... 5 2 Installing VAX COBOL......................... 7 3 After the Installation....................... 17 4 Running the Installation Verification Procedure Separately......................... 17 5 Customizing VAX COBOL Error Messages......... 18 6 Error Conditions............................. 20 7 Installing VAX COBOL as a Shared Image....... 21 8 Special COBRTL-Only Save Set ................ 22 9 Maintenance Updates.......................... 22 Sample Installation Files Installed on Your System Recovering from Errors C.1 Failures During VAX COBOL Installation....... C-1 C.2 Problems During VAX COBOL Use................ C-2 iii Tables 1 Telephone and Direct Mail Orders......... viii B-1 Directories Containing VAX COBOL Installed Files ......................... B-1 iv ________________________________________________________________ Preface This guide describes how to install VAX COBOL on the OpenVMS VAX operating system. It is intended for system managers. This document applies to VAX COBOL Version 5.4 and any maintenance updates for that version. For more information about installing VAX COBOL on OpenVMS VAX systems, refer to your processor-specific installation or operations guide. The installation procedure is described step-by-step and is, for the most part, self-explanatory. The system prompts you to answer questions and to change volumes, and waits for you to tell it to continue. Associated Documentation In addition to this guide, the VAX COBOL documentation set includes the following: o Read Before Installing or Using VAX COBOL Version 5.4 for OpenVMS VAX Systems cover letter o VAX COBOL Reference Manual o VAX COBOL User Manual o VAX COBOL Release Notes o VAX COBOL Help You may also find the following documentation useful: o Guide to Software License Management o Guide to Sharing Software on a Local Area Network o OpenVMS License Management Utility Manual v o OpenVMS System Manager's Manual Conventions The following conventions are used in this guide: __________________________________________________________ Convention____________________Meaning_____________________ [Yes] Default answers to system [No] questions are framed in square brackets. Simply press to accept the default response. UPPERCASE Uppercase letters indicate the name of a command, a file, a parameter, a procedure, or a VAX COBOL utility. $ @SYS$UPDATE:VMSINSTAL In interactive examples, prompts or displayed text appear in a monospace font. User input appears in bold. $ The dollar sign is used to indicate the DCL prompt. This prompt may be different on your system. In procedures, a sequence such as indicates that you must hold down the key labeled Ctrl while you press another key or a ______________________________pointing_device_button._____ References The following table shows certain references and their respective meanings in this manual: __________________________________________________________ Reference_____Meaning_____________________________________ OpenVMS OpenVMS VAX or OpenVMS VAX operating system vi __________________________________________________________ Reference_____Meaning_____________________________________ DIGITAL UNIX DIGITAL UNIX operating system[1] CDD/Plus Oracle CDD/Repository[2] [1]DIGITAL_UNIX_was_formerly_known_as_DEC_OSF/1.__________ [2]Oracle CDD/Repository is a product of Oracle Corporation.______________________________________________ vii How To Order Additional Documentation Use Table 1 to order additional documentation or information. If you need help deciding which documentation best meets your needs, call 800-DIGITAL (800-344-4825). Table_1_Telephone_and_Direct_Mail_Orders__________________ Location____Call/Fax____Write_____________________________ U.S.A. DECdirect Digital Equipment Corporation 800- P.O. Box CS2008 DIGITAL Nashua, NH 03061 800-344- 4825 Fax: 800-234- 2298 Puerto 809-781- Digital Equipment Caribbean, Inc. Rico 0505 3 Digital Plaza, 1st Street, Suite Fax: 200 809-749- P.O. Box 11038 8300 Metro Office Park San Juan, Puerto Rico 00910-2138 Canada 800-267- Digital Equipment of Canada, Ltd. 6215 Box 1300 Fax: 100 Herzberg Road 613-592- Kanata, Ontario, Canada K2K 2A6 1946 Attn: DECdirect Sales Internationa- Local DIGITAL subsidiary or approved distributor (continued on next page) viii Table_1_(Cont.)_Telephone_and_Direct_Mail_Orders__________ Location____Call/Fax____Write_____________________________ Internal DTN: 264- U.S. Software Supply Business Orders 4446 Digital Equipment Corporation 603-884- Nashua, NH 03063-1260 4446 Fax: 603-884- ____________3960__________________________________________ ix Reader's Comments DIGITAL appreciates user comments. If you would like to comment about this manual or if you should find errors in it, please send the manual title, order number, and your comments by one of the following methods: o Electronic Internet mail: cobol_docs@casdoc.enet.dec.com o Fax: 603-881-0120 Attn: Languages Documentation, ZKO2-3/K35 o A letter sent to the following address: Digital Equipment Corporation Languages Documentation, ZKO2-3/K35 110 Spit Brook Road Nashua, NH 03062-2698 USA x 1 Preparing to Install VAX COBOL Your distribution kit includes a letter titled Read Before Installing or Using VAX COBOL Version 5.4 for OpenVMS VAX Systems. The letter discusses important information that might not be included in this guide. You should read this letter before beginning the installation. Your bill of materials (BOM) and indented bills report (BIL) specify the number and contents of your media. Be sure to check the contents of your kit against this information. If your kit is damaged or if you find that parts of it are missing, call your DIGITAL representative. Distribution media must be mounted in numerical order. The installation procedure prompts you to mount the volumes. For more information on how to mount distribution media, refer to your processor-specific installation or operations guide. This guide also details several options to the installa- tion procedure. 1.1 Accessing the Online Release Notes VAX COBOL provides online release notes. The prompt to display or print the release notes before installation appears in Step 4 of the installation procedure when you invoke VMSINSTAL with the OPTIONS N parameter. After the installation, the release notes are available in text format and PostScript format in the following files: SYS$HELP:COBOL05n.RELEASE_NOTES (text file) SYS$HELP:COBOL05n_RELEASE_NOTES.PS Where n represents version point release number. Online help also directs you to the release notes file. After the installation, type the following: $ HELP COBOL RELEASE_NOTES 1 1.2 System Prerequisites This is a complete kit for VAX COBOL; you need not install any previous versions of VAX COBOL before installing Version 5.n. (Note that for n you should use the actual maintenance-update number after the decimal point, for example, 4 in Version 5.4, which appears on the title page as the Software Version.) VAX COBOL requires OpenVMS VAX Version 6.1 or higher. Certain VAX COBOL features may require higher versions of OpenVMS VAX. See the SPD for information about specific system dependencies. If you are installing Oracle Rdb or Oracle CDD/Repository, you should make certain that they have been successfully installed before you attempt to install VAX COBOL. To eliminate possible installation errors, execute the following command procedure to start up Oracle CDD/Repository: $ @SYS$STARTUP:CDDSTRTUP.COM 1.3 Installation Procedure Requirements The installation should take approximately 5 to 10 minutes, depending on the type of media and your system configuration. Before installing VAX COBOL, you must have the following privileges and resources: o SETPRV privileges, or CMKRNL, WORLD, and SYSPRV privileges. o A minimum of 12,000 blocks of free disk space during installation. After the installation, approximately 3,000 blocks are used. o A minimum of 950 free global pages plus the size (in number of disk blocks) of the file SYS$LIBRARY:DCLTABLES.EXE at installation. After the installation, 950 free global pages plus the size of SYS$LIBRARY:DCLTABLES.EXE are used. o A minimum of 3 free global sections are needed at installation; 3 global sections are used after installation. 2 ________________________Note ________________________ You must ensure that your system has the necessary global page and global section SYSGEN quotas for the installation. Failure to do so could cause the DCL tables to be corrupted in some situations. _____________________________________________________ To determine the number of available global pages on your system, invoke the OpenVMS Install utility (INSTALL) by typing the following command: $ INSTALL Then type the following command: INSTALL> LIST/GLOBAL/SUMMARY Summary of Local Memory Global Sections nn Global Sections Used, nnn/nnnn Global Pages Used/Unused INSTALL> EXIT When you issue these commands, the system displays a summary of the number of global sections used, the number of global pages used, and the number of global pages unused. To exit from the OpenVMS Install utility, type the EXIT command. VAX COBOL requires approximately 950 global pages. If fewer than 950 pages are available, you can delete an existing known image with the OpenVMS Install utility, or you can increase the GBLPAGES system parameter with the OpenVMS System Generation utility (SYSGEN) by editing the file SYS$SYSTEM:MODPARAMS.DAT and then invoking the AUTOGEN command procedure, SYS$UPDATE:AUTOGEN.COM. For more information on the AUTOGEN command procedure, refer to your processor-specific installation or operations guide. You can determine the number of available global sections by invoking SYSGEN as follows: 3 $ RUN SYS$SYSTEM:SYSGEN SYSGEN>USE CURRENT SYSGEN>SHOW GBLSECTIONS SYSGEN>EXIT The last number displayed is the maximum number of global sections. Compare this to the number of global sections in use displayed by the OpenVMS Install utility. VAX COBOL requires 3 global sections. Therefore, if the number of global sections used plus 3 exceeds the current number of global sections, you must increase the number of available global sections before you can install VAX COBOL. To increase the number, you must increase the GBLSECTIONS system parameter with SYSGEN by editing the file SYS$SYSTEM:MODPARAMS.DAT and then invoking the SYS$UPDATE:AUTOGEN.COM procedure. For more information on the AUTOGEN.COM procedure, refer to your processor-specific installation or operations guide. If number of global sections used plus 3 is less than the maximum number of global sections, you can exit from SYSGEN and continue. 1.4 Special Requirements A license Product Authorization Key (PAK) must be registered with the License Management Facility in order to use VAX COBOL. If this is a new installation, please be sure to register the VAX COBOL PAK before starting the installation procedure. If this is an update to an existing installation, the PAK should already be registered in the license database and no further action needs to be taken. You can register the information contained in the PAK that is shipped to new customers with VAX COBOL by using either the OpenVMS License command procedure (VMSLICENSE) or the LICENSE REGISTER command, as described in the OpenVMS License Management Utility Manual. ________________________Note ________________________ If you are missing your PAK and you have purchased a software support contract, you can obtain a Temporary Service PAK from the DIGITAL Software 4 Information Network (DSIN). For more information about DSIN, call your Customer Support Center. _____________________________________________________ Hardware Requirements Object modules produced by the VAX COBOL compiler can be executed incorrectly if your OpenVMS VAX operating system does not meet the following requirements when you install the compiler: o A VAX-11/780 computer must have the hardware engi- neering change order (ECO) status of system level 4 or higher. o A VAX-11/730 must have the writable control store (WCS) status of system level 50 or higher. ________________________Note ________________________ The VAX COBOL Installation Verification Procedure (IVP) checks for the presence or absence of these ECOs. _____________________________________________________ When using VAX COBOL on OpenVMS VAX with the Oracle Database Management System (Oracle DBMS), Oracle CDD/Repository, or both, refer to the installation guides for these products for information on their ECO requirements. 1.5 Using VMSINSTAL After you log in to a privileged account to install VAX COBOL, set the default to SYS$UPDATE: and then invoke VMSINSTAL, the command procedure that installs this product, as follows: $ SET DEFAULT SYS$UPDATE $ @VMSINSTAL COBOLvvv ddn: OPTIONS N The following paragraphs describe the command parameters. 5 vvv Represents the version and maintenance update number of VAX COBOL (for example, 054). Refer to the label on the VAX COBOL distribution kit or the VAX COBOL BOM or BIL for the number. ddn: Represents a device name where the distribution volumes will be mounted for the VAX COBOL installation media, where dd is the device code and n is the unit number. It is not necessary to use the console drive to install VAX COBOL. If you do use the console drive, you should replace any media you removed from the drive. CSA1: is the device name used in examples in this document. OPTIONS N Is an optional parameter you should provide if you want to be prompted to display or print the release notes. If you do not include the OPTIONS N parameter, VMSINSTAL does not prompt you to display or print the release notes. Note that VMSINSTAL permits the use of several other options. For more information on the other options, refer to your processor-specific installation or operations guide. You can also type an asterisk (*) in place of COBOL. If you are installing from magnetic tape, you can use the asterisk to save installation time; the asterisk causes VAX COBOL to be installed with a minimum of tape passes. For example, the first parameter to VMSINSTAL for COBOL Version 5.4 could be either COBOL054 or *. If you do not supply the first two parameters, VMSINSTAL prompts you for the product and device names. If you wish to be prompted for the product and device names and to display or print the release notes, type the following: $ @SYS$UPDATE:VMSINSTAL "" "" OPTIONS N When you invoke VMSINSTAL, it checks the following: o Whether or not you are logged in to a privileged account. DIGITAL recommends that you install software from the system manager's account with your default device and directory set to SYS$UPDATE. 6 o Whether or not you have adequate quotas for installa- tion. VMSINSTAL then checks whether or not the following conditions exist: o DECnet is up and running. o Any users are logged in to the system. If VMSINSTAL detects either of these conditions, you will be asked whether or not you want to continue the installation. If you want to continue, type Yes. If you want to stop the installation, press Return. 2 Installing VAX COBOL This section contains excerpts from the installation procedure and explains each step. ________________________Note ________________________ Defaults appear in brackets throughout the installa- tion procedure. _____________________________________________________ To abort the installation procedure at any time, press Ctrl/Y. When you press Ctrl/Y, the installation procedure deletes all files it has created up to that point and then returns you to DCL level. If you want to retry the installation procedure after pressing Ctrl/Y, you must proceed from Step 2. Step 1: Log in to a privileged account and set your default device and directory to SYS$UPDATE. Username: SYSTEM Password: $ SET DEFAULT SYS$UPDATE 7 Step 2: Invoke VMSINSTAL. $ @VMSINSTAL COBOLvvv CSA1: OPTIONS N VAX/VMS Software Product Installation Procedure VX.X It is dd-mmm-yyyy at hh:mm. Enter a question mark (?) at any time for help. * Are you satisfied with the backup of your system disk [YES]? If you are satisfied with the backup of your system disk, press Return. Otherwise, type No and press Return to discontinue the installation. Step 3: Insert the first installation kit volume. Depending on your media, you may get the following prompts: Please mount the first volume of the set on CSA1:. * Are you ready? YES To indicate that you want to continue the installation, mount volume 1, type Yes, and then press Return. The following products will be processed: COBOL V5.n Beginning installation of COBOL V5.n at hh:mm %VMSINSTAL-I-RESTORE, Restoring product save set A... Release notes included with this kit are always copied to SYS$HELP. 8 Step 4: Select a release notes option. This step applies only if you specified OPTIONS N in Step 2. Additional Release Notes Options: 1. Display release notes 2. Print release notes 3. Both 1 and 2 4. None of the above * Select option [2]: If you select option 1, VMSINSTAL displays the release notes on line immediately. You can terminate the display at any time by pressing Ctrl/C. If you select option 2, VMSINSTAL prompts you for a queue name. Either type a queue name or press Return to send the file to the default output print device. * Queue name [SYS$PRINT]: If you select option 3, VMSINSTAL displays the release notes on line immediately and then prompts you for a queue name. 9 ________________________Note ________________________ This version of the release notes file installed by VMSINSTAL is labeled with the current product name and version number. Take care not to delete release notes for previous versions of VAX COBOL. _____________________________________________________ Next, VMSINSTAL displays the following prompt: * Do you want to continue the installation [NO]? Y %VMSINSTAL-I-RELMOVED, The product's release notes have been moved to SYS$HELP. If you want to continue the installation, type Yes and press Return. If you type No or only press Return, VMSINSTAL discontinues the installation. In either case, VMSINSTAL moves the release notes to SYS$HELP. Step 5: Install the COBOL Run-Time Library image separately (if applicable). VAX COBOL allows you to install the COBOL Run-Time Library (COBRTL) image (COBRTL.EXE) separately from the full product installation. This option can be useful if your COBRTL has been overwritten or lost, or if you need to run a COBOL application compiled with VAX COBOL V5.n on a system that does not have VAX COBOL V5.n installed. Press Return at the prompt to continue with the full installation of VAX COBOL. Or, if you want to install the COBRTL image only, type Yes and press Return in response to the prompt, as follows: * Do you want to install only the COBRTL [NO]? Y In this case, the installation skips any subsequent inquiries, including the question about the PAK, and proceeds to install only the COBRTL image. As in the full installation, the version of the current COBRTL.EXE is automatically checked. If the version already installed on your system is later than the COBRTL.EXE you are attempting to install separately, the installation procedure issues the following message followed by another prompt: 10 %COBOL-I-IDNTCK, COBRTL found in SYS$SHARE has later ident than COBRTL to be installed. Do you still want to install COBRTL from kit [NO]? Press Return at the prompt to terminate the installation without installing the COBRTL image supplied with your VAX COBOL kit. Or type Yes and press Return to install it. * Do you still want to install COBRTL from kit [NO]? Y %COBOL-I-UPDIMG, Installing new COBRTL image %PATCH-I-NOLCL, image does not contain local symbols %PATCH-I-WRTFIL, updating image file ... DKB300:[SYS0.SYSUPD.COBOLvvv]COBRTL.EXE;2 %COBOL-I-UPDOBJ, Updating system object library %VMSINSTAL-I-MOVEFILES, Files will now be moved to their target directories... ________________________Note ________________________ If your system includes a later version of the COBRTL.EXE than the one that is supplied with your VAX COBOL kit, it is highly recommended that you not install the earlier kit version. Backward compatibility for your applications is not guaranteed; that is, while applications compiled with older versions of COBOL will run compatibly with newer versions of the COBRTL, the reverse may not be true. _____________________________________________________ Remember to use the INSTALL utility to make the COBRTL.EXE that is replaced by the installation a known image. Also, this must be done on each node in a VAXcluster. Use INSTALL REPLACE or use the OpenVMS System Management utility (SYSMAN) to facilitate the installation on multiple nodes (see the section on Installing VAX COBOL on a VAXcluster). 11 Step 6: Respond to LMF queries. This product supports the OpenVMS License Management Facility (LMF). For more information on LMF, see the OpenVMS License Management Utility Manual. During the installation procedure, the VAX COBOL Product Authorization Key (PAK) is invoked and the following questions are asked: * Does this product have an authorization key registered and loaded? YES This step allows you to indicate whether or not your LMF license for VAX COBOL is registered and loaded. It is strongly recommended that you install the PAK for VAX COBOL prior to installing the product. If the PAK is not installed, you can still proceed with the installation and install the PAK after the installation is complete. The following list summarizes the outcome of your responses to this query: o If you answer Yes and the PAK is installed, the installation proceeds normally. o If you answer Yes and the PAK is not installed and you selected the IVP option, the IVP will fail. o If you answer Yes and the PAK is not installed, the installation fails if you selected the REFORMAT utility option. o If you answer No, the installation terminates. In any case, VAX COBOL will not execute until the PAK for VAX COBOL is installed. Step 7: Install the VAX LSE environment update. * Do you want the VAX LSE environment updated for VAX COBOL [YES]? This question appears if the DEC Language-Sensitive Editor (LSE) is installed on your system and the VAX COBOL installation kit contains updates to the DEC LSE environment for VAX COBOL. 12 If you answer Yes to this question or accept the default, the VAX LSE environment for VAX COBOL is automatically updated. Step 8: Install the REFORMAT utility. * Do you want the REFORMAT utility installed [YES]? Depending on your use of VAX COBOL, you may want to install the optional REFORMAT utility. Step 9: Respond to the message file query. * Do you want to save the COBOL message file for modification [NO]? This query enables you to edit the VAX COBOL message file COBOLMSG.MSG. Customized messages are often desirable for international users. If you plan to edit the message file, type Yes and press Return. If you do not want to edit the message file, press Return. For more information, see Section 5. Step 10: Select installation options. * Do you want to run the IVP after installation [YES]? The Installation Verification Procedure (IVP) runs tests to check whether or not the installation was successful. Press Return to run the IVP after the installation. If you do not want to run the IVP, type No in response to the prompt. Step 11: Respond to the purge files query. If the installation is successful, the SYS$EXAMPLES, SYS$HELP, SYS$LIBRARY, SYS$MANAGER, SYS$UPDATE, SYS$MESSAGE, and SYS$SYSTEM directories may contain previous versions of the following VAX COBOL files: o [SYSEXE]COBOL.EXE o [SYSEXE]REFORMAT.EXE o [SYSLIB]DCLTABLES.EXE o [SYSTEST.COBOL]COBOL$IVP.COM o [SYSHLP]COBOLvvv.RELEASE_NOTES o [SYSHLP]COBOLvvv_RELEASE_NOTES.PS 13 o [SYSMSG]COBOLMSG.EXE o [SYSUPD]COBOLMSG.MSG o [SYSLIB]LSE$SYSTEM_ENVIRONMENT.ENV * Do you want to purge files replaced by this installation [YES]? These files are replaced during the installation with new files, but the old files are not automatically purged. Purging is recommended. (Purging will not destroy earlier versions of the release notes, which you should retain.) In response to the purging prompt, press Return to purge the files or type No to keep them. In either case, the system help files are updated. Not purging these files allows you to go back to a previous version of a file, if necessary. The installation may also create a new version of the following file, which is not purged along with the previously listed files: o [SYSLIB]COBRTL.EXE The installation procedure may update the following files (it will not create new versions of them, nor will it purge them): o [SYSLIB]IMAGELIB.OLB o [SYSLIB]STARLET.OLB The query on purging files is the last one you have to respond to during the installation. After you respond to this query, the following message is displayed: No more questions will be asked during this installation. You may need to mount additional distribution volumes depending on the type of media you use. In this case, you will receive a prompt from VMSINSTAL to determine that you are ready to proceed. (See Step 12.) 14 Step 12: Insert the subsequent installation kit volumes. %BACKUP-I-READYREAD, mount volume 2 on _CSA1: for reading Enter "YES" when ready: YES VMSINSTAL prompts you to insert the next volume and waits for you to type Yes after inserting it. If you type No, VMSINSTAL displays the prompt again. This prompt is displayed only if your installation kit contains more than one volume. Exactly when these prompts appear depends on the type of media that you are using. Step 13: Read the informational messages. The VAX COBOL installation procedure produces a number of informational messages that report on the progress of the installation. The success of the installation is indicated by the following message: %VMSINSTAL-I-MOVEFILES, files will now be moved to their target directories... If the installation procedure is successful, the new or modified files are moved to their target directories. The SYS$HELP:HELPLIB.HLB and SYS$LIBRARY:DCLTABLES.EXE files are updated to include the new versions of the VAX COBOL Help text and the VAX COBOL command line definition. Step 14: Observe the Installation Verification Procedure. If you chose to run the IVP in Step 10, VMSINSTAL now calls the IVP to verify that VAX COBOL was installed successfully. Start of VAX COBOL Installation Verification Procedure Successful test of VAX COBOL V5.n-cc Installation of COBOL V5.n completed at hh:mm Step 15: End the installation procedure. VMSINSTAL procedure done at hh:mm $ LOGOUT SYSTEM logged out at dd-mmm-yyyy hh:mm:ss.ss 15 When the product installation procedure is complete, you can choose to install more products or to log out (as shown here). If you removed any media from the console drive before beginning the installation, you should replace it now. Note that VMSINSTAL deletes or changes entries in the process symbol tables during the installation. Therefore, if you are going to continue using the system manager's account and you want to restore these symbols, you should log out and log in again. Installing VAX COBOL on a VAXcluster You can use the OpenVMS System Management utility (SYSMAN) to facilitate running VAX COBOL on multiple nodes in a cluster. With SYSMAN, you can define a system management environment so that operations performed on one node are automatically executed on all other nodes in the VAXcluster. (See the OpenVMS VAX documentation for more information.) First, check to see that you have the appropriate software license. Then, once you have installed VAX COBOL on one system disk in the VAXcluster, you can update the version of the DCL tables and the version of the COBRTL installed on the other nodes in the cluster by performing the following steps: 1. Log in to a node on the VAXcluster. Invoke SYSMAN and enter the following command at the SYSMAN> prompt: SYSMAN>SET ENVIRONMENT/CLUSTER 2. If you are a new customer, ensure that the PAK has been registered before attempting to install VAX COBOL. To load the PAK on all nodes in your cluster environment simultaneously, invoke SYSMAN and enter the following command at the SYSMAN> prompt: SYSMAN>LICENSE LOAD COBOL 3. Enter the following commands at the SYSMAN> prompt: SYSMAN>DO INSTALL REPLACE SYS$SHARE:DCLTABLES.EXE SYSMAN>DO INSTALL REPLACE SYS$SHARE:COBRTL.EXE 16 3 After the Installation VAX COBOL is now installed and can be invoked by all users with the COBOL command. The installation procedure modifies the DCL command table so that the COBOL command is recognized and processed. However, the previous command table is still in effect for those users who are currently logged in. All logged in users who want to use the newly installed version of VAX COBOL must log out of the system and log in again or issue the following command: $ SET COMMAND/TABLE=SYS$LIBRARY:DCLTABLES If VAX COBOL will be used extensively on your system, you can reduce system overhead and memory requirements by installing it as a shared image by using the OpenVMS Install utility. For more information, see Section 7. 4 Running the Installation Verification Procedure Separately The Installation Verification Procedure (IVP) is usually run at installation. If you want to run the IVP separately to ensure the integrity of installed files if system problems occur, execute the following command procedure: $ @SYS$COMMON:[SYSTEST.COBOL]COBOL$IVP.COM If the IVP fails for any reason, the following messages are displayed: The VAX COBOL V5.n Installation Verification Procedure failed. %VMSINSTAL-E-IVPFAIL, The IVP for VAX COBOL V5.n has failed. What to Do If the Installation Fails During or After Running the IVP Some reasons for installation failure after running the IVP can produce error messages such as the following: %CLI-F-SYNTAX, error parsing ... %COBOL-F-BADVALUE ... 17 These errors indicate an incompatibility between SYS$SYSTEM:COBOL.EXE and the COBOL command syntax in SYS$LIBRARY:DCLTABLES. To understand the reasons for such errors and to correct them, follow this procedure: 1. If either SYS$SYSTEM:COBOL.EXE or SYS$LIBRARY:DCLTABLES exists in SYS$SPECIFIC, the SYS$SPECIFIC file will override the file in SYS$COMMON (where the installation procedure places these files). Ensure that neither of these files exists in SYS$SPECIFIC. 2. Deassign any logical names for COBOL or DCLTABLES. 3. If neither 1 nor 2 applies and you are in the same account on the same node where VAX COBOL was installed, this error indicates that DCLTABLES was not updated. This error usually occurs when another user had DCLTABLES locked during the installation procedure. To correct the error, you must reinstall VAX COBOL. Other reasons for installation failure after running the IVP can produce RPC$SHARE error messages. Such errors occur because VAX COBOL accesses RPC$SHARE indirectly through CDDSHR.EXE (if you have a version of CDD prior to Version 5.0) and usually indicate a problem with the Oracle CDD/Repository installation. To correct these errors, execute the following command procedure: $ @SYS$STARTUP:CDDSTRTUP.COM If you encounter other errors after executing this command procedure, consult the Oracle CDD/Repository documentation for further information or contact your Customer Support Center. 5 Customizing VAX COBOL Error Messages If you choose to customize the VAX COBOL message file, the installation procedure copies the VAX COBOL message file COBOLMSG.MSG into the system directory [SYSUPD]. After the file is copied to the system directory, you can edit COBOLMSG.MSG to customize the error messages that users receive when using VAX COBOL. Customized messages are often desirable for international users. 18 You must install VAX COBOL before editing the message file. If you install VAX COBOL after editing COBOLMSG.MSG, the software installation will supersede the revised message file in the [SYSMSG] directory. Also, you must have the OpenVMS Message utility installed on your system before editing COBOLMSG.MSG. The edited version of COBOLMSG.MSG must be processed through the Message utility before the file can be accessed by VAX COBOL. The following steps explain how to edit the VAX COBOL messages and install the customized message file on your system: 1. Run the VAX COBOL installation procedure and answer Yes to the question "Do you want to save the COBOL message file for modification." The installation procedure copies the message file, COBOLMSG.MSG, into the system directory [SYSUPD]. 2. Edit the message file. Each error message appears on a separate line and is enclosed in angle brackets (< >). You can edit the text portion of the error messages, but for VAX COBOL to correctly identify the errors you must not change the following: o The 3- to 9-character mnemonic that appears in the first column o The sequence in which the error messages appear in the file o The severity level of the error message o The number, type, and order of the formatted ASCII ouput (FAO) arguments that appear in the message 3. Run the OpenVMS Message utility. To translate the new message text into a file VAX COBOL can access, run the text file through the Message utility by entering the following command: $ MESSAGE COBOLMSG The Message utility creates the object module COBOLMSG.OBJ. 19 4. Enter the LINK command with the /SHARE qualifier to create the shareable image COBOLMSG.EXE: $ LINK/SHARE COBOLMSG 5. Install COBOLMSG.EXE in the system directory [SYSMSG]: $ COPY COBOLMSG.EXE SYS$COMMON:[SYSMSG]/PROT=W:RE 6. If VAX COBOL is installed as a known image, you must reinstall COBOLMSG.EXE by entering the following command: $ INSTALL REPLACE SYS$MESSAGE:COBOLMSG VAX COBOL will now generate your customized error messages. 6 Error Conditions If the installation procedure fails for any reason, a message like the following is displayed: %VMSINSTAL-E-INSFAIL, The installation of VAX COBOL V5.n has failed. An error during the installation can occur if one or more of the following conditions exist: o Operating system version is incorrect. o Prerequisite software version is incorrect. o Quotas necessary for successful installation are insufficient (see Section 1.3.) o Process quotas required by VMSINSTAL are incorrect (see Section 1.5.) o OpenVMS Help library is currently in use. o Product was registered incorrectly or not registered. For descriptions of the error messages generated by these conditions, see the OpenVMS System Messages and Recovery Procedures Reference Manual, your processor-specific installation or operations guide, or the OpenVMS License Management Utility Manual. 20 If you are notified that any of these conditions exist, take the appropriate action as described in the message. You may need to change a system parameter or increase an authorized quota value. If the installation fails, you must restart the in- stallation procedure from Step 2 in Section 2. The installation may fail due to an IVP failure. If so, you should first consult the "What to Do if the Installation Fails During or After Running the IVP" in Section 4. If you still need assistance, contact a DIGITAL field service representative. 7 Installing VAX COBOL as a Shared Image If VAX COBOL will be used extensively on your system, you can reduce the system overhead and memory requirements by installing it as a shared image. To perform the installation on a system that is currently running, use the OpenVMS Install utility while you are logged in to a privileged account. If errors occur, consult the OpenVMS System Messages and Recovery Procedures Reference Manual. First, determine the number of available global pages and global sections on your system. See Section 1.3 for information on how to do this. Then, invoke the OpenVMS Install utility and install VAX COBOL as a shared image, as follows: $ INSTALL INSTALL> ADD SYS$SYSTEM:COBOL.EXE/OPEN/SHARED INSTALL> ADD SYS$MESSAGE:COBOLMSG.EXE/OPEN/SHARED INSTALL> EXIT Then, update the system startup file to install VAX COBOL. To ensure that VAX COBOL is installed as a shared image each time the system is bootstrapped, include the follow- ing lines in SYS$MANAGER:SYSTARTUP_V5.COM (the site-specific startup file): 21 $ INSTALL $ ADD SYS$SYSTEM:COBOL.EXE/OPEN/SHARED $ ADD SYS$MESSAGE:COBOLMSG.EXE/OPEN/SHARED $ EXIT 8 Special COBRTL-Only Save Set Within the COBOL054.C save set, there is (starting with Version 5.4 of VAX COBOL) another save set named COBRTL054.A containing files needed to install only the COBOL Run-Time Library (COBRTL) image. Although most users have no need of this, you may find this save set useful if you are a vendor distributing VAX COBOL applications to your customers, and have experienced incompatibility problems with the version of the COBRTL on your customers' systems in the past. You can distribute the COBRTL054.A save set with your COBOL application to enable your customers to install the COBRTL on their VAX systems. Note that the COBRTL.EXE image is identical to the COBRTL.EXE image shipped on the main kit. To extract the COBRTL054.A save set, copy the save set COBOL054.C from your media to your default directory, and do the following: $ BACKUP COBOL054.C/SAVE/SELECT=COBRTL054.A destination-directory The COBRTL054.A save set can then be distributed to customers with your VAX COBOL application and installed on their system with the VMSINSTAL utility, as described in Step 5 in this Installation Guide. Note that there is no problem with licensing, as the COBRTL.EXE can be copied to any properly licensed OpenVMS VAX system. 9 Maintenance Updates DIGITAL may periodically issue maintenance updates of VAX COBOL. Each update consists of an installation kit. Install this kit as described in this document or in any documentation that may accompany the maintenance update. Each time a maintenance update is released, the version number changes. For example, if the current version is 1.0, the version number of the first maintenance update will be 1.1. The maintenance update also includes new 22 release notes that describe the changes that have been made to VAX COBOL since the previous release. The updated release notes are provided on line. You should read the release notes when you first install VAX COBOL; they are also accessible at any time after the product is installed. For information on reading the release notes at the time that you install VAX COBOL, follow the installation procedure through Step 5 in Section 2. To locate the release notes after VAX COBOL is installed, display or print the file SYS$HELP:COBOLvvv.RELEASE_NOTES or type the following: $ HELP COBOL RELEASE_NOTES 23 A ________________________________________________________________ Sample Installation This appendix contains a sample listing of a regular installation of VAX COBOL. Please note: this is only a sample. The installation procedure may be modified for maintenance updates of this product. Because this guide is not usually revised for maintenance updates, be sure to read the Read Before Installing or Using VAX COBOL Version 5.4 for OpenVMS VAX Systems letter before you install this product. This letter notes any significant changes in the installation that vary from this sample. $ @SYS$UPDATE:VMSINSTAL COBOL CSA1: OPTIONS N VAX/VMS Software Product Installation Procedure V5.x It is dd-mmm-yy at hh:mm Enter a question mark (?) at any time for help. * Are you satisfied with the backup of your system disk [YES]? __CSA1: allocated Please mount the first volume of the set on CSA1:. * Are you ready? YES %MOUNT-I-MOUNTED, COBOL1 mounted on _CSA1: The following products will be processed: COBOL V5.n Beginning installation of COBOL V5.n at hh:mm %VMSINSTAL-I-RESTORE, Restoring product save set A... Release Notes included with this kit are always copied to SYS$HELP. Sample Installation A-1 Additional Release Notes Options: 1. Display release notes 2. Print release notes 3. Both 1 and 2 4. None of the above * Select option [2]: 2 * Queue name [SYS$PRINT]: Job COBOLvvv (queue SYS$PRINT, entry 1248) started on SYS$LPA0 * Do you want to continue the installation [NO]? YES %VMSINSTAL-I-RELMOVED, The product's release notes have been moved to SYS$HELP. * Do you want to install only the COBRTL [NO]? Product: COBOL Producer: DEC Version: 5.n Release Date: dd-mmm-yyyy * Does this product have an authorization key registered and loaded? YES The ANSI/Terminal-Format REFORMAT utility may optionally be installed. * Do you want the REFORMAT utility installed [YES]? * Do you want to save the COBOL message file for modification [NO]? A-2 Sample Installation * Do you want to run the IVP after the installation [YES]? This installation procedure creates a new version of, or updates some or all of the following files: [SYSEXE]COBOL.EXE [SYSEXE]REFORMAT.EXE [SYSLIB]DCLTABLES.EXE [SYSTEST.COBOL]COBOL$IVP.COM [SYSHLP]COBOLvvv.RELEASE_NOTES [SYSHLP]COBOLvvv_RELEASE_NOTES.PS [SYSMSG]COBOLMSG.EXE [SYSUPD]COBOLMSG.MSG [SYSLIB]LSE$SYSTEM_ENVIRONMENT.ENV * Do you want to purge files replaced by this installation [YES]? YES The installation procedure may also create a new version of the following file, which is not purged along with the previously listed files: [SYSLIB]COBRTL.EXE This installation procedure additionally may update the following files (it will not create new versions of them, nor will it purge them): [SYSLIB]IMAGELIB.OLB [SYSLIB]STARLET.OLB No more questions will be asked during this installation. %COBOL-I-UPDIMG, Installing new COBRTL image %PATCH-I-NOLCL, image does not contain local symbols %PATCH-I-WRTFIL, updating image file VMI$ROOT:[SYSUPD.COBOLvvv]COBRTL.EXE;2 %COBOL-I-UPDOBJ, Updating system object library %VMSINSTAL-I-RESTORE, Restoring product save set B... %VMSINSTAL-I-SYSDIR, This product creates system disk directory VMI$ROOT:[SYSTEST.COBOL]. The IVP has been moved to directory [SYSTEST.COBOL] Sample Installation A-3 To invoke the IVP, enter @SYS$COMMON:[SYSTEST.COBOL]COBOL$IVP.COM Please mount the next distribution volume on CSA1: * Are you ready? YES %MOUNT-I-MOUNTED, COBOL2 mounted on _CSA1: %VMSINSTAL-I-RESTORE, Restoring product save set C... %BACKUP-I-READYREAD, mount volume 2 on _CSA1: for reading Enter "YES" when ready: YES %BACKUP-I-READYREAD, mount volume 3 on _CSA1: for reading Enter "YES" when ready: YES %VMSINSTAL-I-MOVEFILES, Files will now be moved to their target directories... Start of VAX COBOL Installation Verification Procedure Successful test of VAX COBOL V5.n-xx Installation of COBOL V5.n completed at hh:mm Please mount the console volume on CSA1:. * Are you ready? YES %MOUNT-I-MOUNTED, CONSOLE mounted on _CSA1: Enter the products to be installed from the next distribution volume set. * Products: EXIT VMSINSTAL procedure done at hh:mm $ LOGOUT SYSTEM logged out dd-mmm-yyy hh:mm:ss.cc A-4 Sample Installation B ________________________________________________________________ Files Installed on Your System The VAX COBOL installation procedure installs a number of files on your system. Table B-1 identifies the directories that contain the installed files. Table_B-1_Directories_Containing_VAX_COBOL_Installed_Files______ Directory_____File_Name________________File_Content_Summary_____ [SYSEXE] COBOL.EXE Compiler image [SYSEXE] REFORMAT.EXE ANSI/Terminal-Format REFORMAT utility [SYSMSG] COBOLMSG.EXE Message file [SYSUPD] COBOLMSG.MSG Customizable source for message file[1] [SYSHLP] COBOL054.RELEASE_NOTES Release notes (ASCII file) [SYSHLP] COBOL054_RELEASE_ Release notes (POSTSCRIPT NOTES.PS file) [SYSLIB] COBRTL.EXE VAX COBOL Run-Time Support Library[2] [SYSLIB] DCLTABLES.EXE Updates to the system DCL tables [SYSLIB] IMAGELIB.OLB New run-time symbols [SYSLIB] STARLET.OLB Updated with VAX COBOL RTL routines[2] [1]See_Section_5_for_information_on_customizing_the_VAX_COBOL___ message file [2]This file is added or updated if an RTL installation is performed (continued on next page) Files Installed on Your System B-1 Table B-1 (Cont.) Directories Containing VAX COBOL Installed __________________Files_________________________________________ Directory_____File_Name________________File_Content_Summary_____ [SYSTEST.COBOLCOBOL$IVP.COM Installation Verification _______________________________________Procedure________________ B-2 Files Installed on Your System C ________________________________________________________________ Recovering from Errors This appendix provides information to help you with failures or errors that might occur during product installation or product use. C.1 Failures During VAX COBOL Installation If VMSINSTAL detects any problems during the installation, it notifies you and asks if you want to continue the installation. In some instances, you can enter Yes to continue. To stop the installation process and correct the situation, enter No and press Return. Then correct the problem and restart the installation. If errors occur during the installation itself or when the Installation Verification Procedure (IVP) is running, VMSINSTAL displays failure messages. If the installation fails, you see the following message: %VMSINSTAL-E-INSFAIL, The installation of VAX COBOL 5.4 has failed. If the IVP fails, you see these messages: The VAX COBOL 5.4 Installation Verification Procedure failed. %VMSINSTAL-E-IVPFAIL, The IVP for VAX COBOL 5.4 has failed. Errors can occur during the installation if any of the following conditions exist: o The operating system version is incorrect. o A prerequisite software version is incorrect. Recovering from Errors C-1 o Quotas necessary for successful installation are insufficient. o System parameter values for successful installation are insufficient. o The OpenVMS Help library is currently in use. o The product license has not been registered and loaded. For descriptions of the error messages generated by these conditions, see the OpenVMS VAX documentation on system messages, recovery procedures, and OpenVMS VAX software installation. If you are notified that any of these conditions exist, you should take the appropriate action as described in the message. For information on installation requirements, see Section 1. C.2 Problems During VAX COBOL Use If you encounter a problem while using VAX COBOL, please report it to DIGITAL. Depending on the type of support you have and the nature of the problem, take one of the following actions: o If you have a Software Product Services Support Agreement, contact your DIGITAL Customer Support Center (CSC), either by telephone or using the electronic means provided with your support agreement (such as DSNlink). The CSC provides telephone support for high-level advisory and remedial assistance. When you initially contact the CSC, please indicate the following: - The name (OpenVMS VAX) and the version number of the operating system you are using - The product name ( VAX COBOL) and the version number of VAX COBOL you are using - The hardware system you are using, such as a model number - A very brief description of the problem (one sentence if possible) - How critical the problem is C-2 Recovering from Errors When you submit information electronically or are speaking on the phone to the appropriate VAX COBOL support specialist, you can provide more detailed information. The information should include the specific commands used to compile and link the program, the error messages displayed, and relevant detailed information (possibly including source program listings). Please attempt to narrow the cause of the problem to a specific module or lines of code. Please submit electronic copy of all source files required to demonstrate the problem. This includes source program code, source copy libraries and dictionaries, data files and databases, as well as .COM files to compile, link, and run the program. o If you wish to comment on the VAX COBOL documentation or if you should find errors in this manual, please send the manual title, order number, and your comments by one of the following methods: - Electronic Internet mail: cobol_docs@casdoc.enet.dec.com - Fax: 603-881-0120 Attn: Languages Documentation, ZKO2-3/K35 - A letter sent to the following address: Digital Equipment Corporation Languages Documentation, ZKO2-3/K35 110 Spit Brook Road Nashua, NH 03062-2698 USA Recovering from Errors C-3