________________________________________________________________ Contents __________________________________________________________ PREFACE vii ________________________________________________________________ CHAPTER 1 PREPARING TO INSTALL VAX ADE 1-1 __________________________________________________________ 1.1 REQUIRED OPERATING SYSTEM COMPONENTS 1-1 __________________________________________________________ 1.2 PREREQUISITE HARDWARE 1-1 __________________________________________________________ 1.3 PREREQUISITE SOFTWARE 1-2 __________________________________________________________ 1.4 LICENSE REGISTRATION 1-2 __________________________________________________________ 1.5 INSTALLATION PROCEDURE REQUIREMENTS 1-3 1.5.1 Privileges and Disk Space 1-4 1.5.2 System Parameters 1-5 1.5.2.1 Calculating the Values for GBLPAGES and GBLSECTIONS, 1-5 1.5.2.2 Changing System Parameter Values with AUTOGEN, 1-7 1.5.3 VMSINSTAL Requirements 1-8 1.5.4 Backing Up Your System Disk 1-9 ________________________________________________________________ CHAPTER 2 INSTALLING VAX ADE 2-1 __________________________________________________________ 2.1 THE INSTALLATION PROCEDURE 2-1 iii Contents __________________________________________________________ 2.2 ERROR RECOVERY 2-11 ________________________________________________________________ CHAPTER 3 AFTER INSTALLING VAX ADE 3-1 __________________________________________________________ 3.1 RUNNING THE INSTALLATION VERIFICATION PROCEDURE SEPARATELY 3-1 __________________________________________________________ 3.2 EDITING THE SYSTEM FILES 3-2 __________________________________________________________ 3.3 USER ACCOUNT REQUIREMENTS 3-3 3.3.1 Privileges 3-3 __________________________________________________________ 3.4 ENHANCING VAX ADE PERFORMANCE 3-3 3.4.1 Installing the ADE help file 3-4 __________________________________________________________ 3.5 LINKING ADE TO ALL-IN-1 3-5 3.5.1 LINKING TO ALL-IN-1 V1.3-V1.4 3-5 3.5.2 LINKING ADE TO ALL-IN-1 V2.0 3-9 __________________________________________________________ 3.6 DETERMINING AND REPORTING PROBLEMS 3-12 ________________________________________________________________ APPENDIX A SAMPLE INSTALLATION A-1 ________________________________________________________________ APPENDIX B FILES AND LOGICAL NAMES INSTALLED ON YOUR SYSTEM B-1 __________________________________________________________ B.1 FILE NAMES B-1 B.1.1 Updated System Files B-2 iv Contents __________________________________________________________ B.2 LOGICAL NAMES B-2 ________________________________________________________________ APPENDIX C USING THE VAX ADE CALLABLE INTERFACE C-1 __________________________________________________________ C.1 EXAMPLES OF THE CALLABLE INTERFACE C-1 ________________________________________________________________ TABLES 1-1 Disk Space Requirements 1-4 1-2 Minimum Required System Parameter Values 1-5 v VAX ADE Installation Guide Order No. AA-M650F-TE Revision/Update Information: This is a revised manual. Software Version: VAX ADE, Version 2.5 Digital Equipment Corporation ________________________ January 1991 The information in this document is subject to change without notice and should not be construed as a commitment by Digital Equipment Corporation. Digital Equipment Corporation assumes no responsibility for any errors that may appear in this document. The software described in this document is furnished under a license and may only be used or copied in accordance with the terms of such license. No responsibility is assumed for the use or reliability of software on equipment not supplied by Digital Equipment Corporation or its affiliated companies. Restricted Rights: Use, duplication, or disclosure by the U.S. Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013. © Digital Equipment Corporation 1989. All rights reserved. Printed in U.S.A. The postpaid READER'S COMMENTS form on the last page of this document requests the user's critical evaluation to assist in preparing future documentation. The following are trademarks of Digital Equipment Corporation: ALL-IN-ONE, DEC, Digital, VAX, VMS, VT and the DIGITAL logo. This document was prepared using VAX DOCUMENT, Version 1.2 ________________________________________________________________ Preface This guide supplies information for the installation of the VAX ADE software, and should be read before attempting installation of the software. It applies to Version 2.5 of VAX ADE and all subsequent maintenance releases up to the next major product release. VAX ADE also provides online release notes. Digital strongly recommends that you read the release notes before proceeding with the installation. For information on accessing the online release notes, see Section 2.1. Your bill of materials (BOM) and indented bills report (BIL) specify the number and contents of your media. Be sure to verify the contents of your kit with this information. If your kit is damaged or if you find that parts of it are missing, contact your Digital representative. __________________________________________________________ Conventions The following conventions are used throughout this guide to display information such as command names, system prompts and keyboard keys: _______________________________________________________ Convention______Meaning________________________________ Text printed in this typeface indicates the system prompts and messages. SELECT OPTION vii Preface _______________________________________________________ Convention______Meaning________________________________ Red Print User input is shown in red. For example: $ Help ADE Release_Notes Return Indicates that you press a single key labeled on the keyboard, such as Return or Tab. GOLD KEY Refers to the Digital GOLD KEY keyboard interface. GOLD KEY 7 Indicates that you press the GOLD or PF1 key and then press the key that follows, such as 7, to perform a specific function. Ctrl/x Indicates that you hold down the Ctrl key and press the letter key that follows, such as x, to perform ________________a_specific_control_function.___________ viii Preface __________________________________________________________ Related Resources Refer to these resources for additional information: o VAX ADE Version 2.5 Release Notes (online) o VMS License Management Utility Manual o System Support Addendum (SSA) o VMS System Management Subkit ix _______________________________________________________ 1 Preparing to Install VAX ADE This chapter discusses the preparations and requirements necessary for installing VAX ADE. __________________________________________________________ 1.1 Required Operating System Components The VMS operating system comes with a variety of support options, or classes. Classes include such features as networking and RMS journaling. To use VAX ADE, your system should be running a version of VMS that includes the following classes: o VMS Required Saveset o Programming Support o Secure User's Environment o Utilities For a complete list of the required classes, see the Software Support Addendum (SSA), which comes with the Software Product Description (SPD). __________________________________________________________ 1.2 Prerequisite Hardware Hardware requirements for installing VAX ADE include a minimum system configuration consisting of: o A minimum of 1 megabyte of main memory o A VT52 terminal, a VT100 family terminal, a VT200 family terminal, a VT300 family terminal, or a Digital personal computer in VT102 emulation mode. 1-1 Preparing to Install VAX ADE Note For interactive use of VAX ADE, it is recommended that terminals be run on lines with transfer rates of at least 1200 baud. It is also recommended that a 250 page minimum working set size be used. __________________________________________________________ 1.3 Prerequisite Software You must have installed VMS Version 5.3 or higher on your system before installing VAX ADE. The System Software Addendum (SSA) contains a complete list of prerequisite and optional software and their required version numbers. __________________________________________________________ 1.4 License Registration If you are installing VAX ADE Version 2.5 on a newly licensed node or cluster, you must first register a License Product Authorization Key (License PAK) using the License Management Facility (LMF). The License PAK may be shipped along with the kit if you ordered the license and media together; otherwise, it is shipped separately to a location based on your license order. If you are installing VAX ADE Version 2.5 as an update on a node or cluster already licensed for this software, you must register the Service Update PAK (SUP) that is included in your Service Update Kit. If you already registered a License PAK or a SUP for this product on this node or cluster, you do not need to register the SUP. If you are installing an update of VAX ADE but lack a service contract, call your Digital representative for instructions on how to get a License PAK. 1-2 Preparing to Install VAX ADE You must register and load your license for VAX ADE before you start the installation in order to run the Installation Verification Procedure (IVP) and use the software. To register a license under VMS, first log in to the system manager's account, SYSTEM. You then have a choice of two ways to perform the registration: o Invoke the SYS$UPDATE:VMSLICENSE.COM procedure. When it prompts you for information, respond with data from your License PAK. o At the DCL prompt, enter the LICENSE REGISTER command with the appropriate qualifiers that correspond to License PAK information. If you plan to use VAX ADE on more than one node in a VAXcluster, you will need to perform a license load on the other nodes after you complete this installation. For complete information on using LMF, see the VMS License Management Utility Manual. __________________________________________________________ 1.5 Installation Procedure Requirements This section and those that follow discuss various requirements for installing VAX ADE. The installation takes approximately 10 to 20 minutes, depending on your type of media and your system configuration. Installing VAX ADE and running the Installation Verification Procedure (IVP) on a standalone VAX-11/780 system, for example, takes 20 minutes. 1-3 Preparing to Install VAX ADE _____________________________ 1.5.1 Privileges and Disk Space To install VAX ADE, you must be logged in to an account that has SETPRV or at least the following privileges: o CMKRNL o WORLD o SYSPRV Note that VMSINSTAL turns off BYPASS privilege at the start of the installation. VAX ADE's requirements for free disk storage space during installation are different from its requirements after installation. Table 1-1 summarizes the storage requirements. ________________________________________________________________ Table 1-1 Disk Space Requirements _______________________________________________________ Blocks During Blocks After Kit______________Installation_____Installation_________ VAX ADE Version 2,900 2,200 _________2.5____________________________________________________ To determine the number of free disk blocks on the current system disk, enter the following command at the DCL prompt: $ SHOW DEVICE SYS$SYSDEVICE 1-4 Preparing to Install VAX ADE _____________________________ 1.5.2 System Parameters Installing VAX ADE requires certain system parameter settings. Table 1-2 lists the minimum required system parameter values for the installation. Depending on the kinds of programs and applications running at your site, you might need higher values for some settings. ________________________________________________________________ Table 1-2 Minimum Required System Parameter Values _______________________________________________________ System Parameter________Minimum_Value_________________________ GBLPAGES[2] n + 1100 _______________________________________________________ [2]The value listed for this system parameters represents the number of free global pages required for the installation, not the total number you need to run your system and other software. ________________________________________________________________ The following sections show you how to: o Calculate values for the GBLPAGES and GBLSECTIONS system parameters o Change parameter values with the VMS AUTOGEN command procedure _____________________________ 1.5.2.1 Calculating the Values for GBLPAGES and GBLSECTIONS To install and run VAX ADE, you must have sufficient free global pages and global sections. After determining how many you have, use AUTOGEN if you need to increase the GLBPAGES and GBLSECTIONS system parameters. 1-5 Preparing to Install VAX ADE The n + 1100 value for GBLPAGES in Table 1-2 indicates that you must have at least 1100 unused global pages available on your system for the installation to process successfully. To calculate how many unused global pages and global sections your system has, perform the following steps: 1 Run the VMS Install Utility (INSTALL) using the following DCL command: $ INSTALL LIST /GLOBAL /SUMMARY The VMS Install Utility displays a summary of global pages and global sections used by your system, as well as the current number of unused global pages. For example: Summary of Local Memory Global Sections 258 Global Sections Used, 22580/3420 Global Pages Used/Unused 2 Determine if the number of unused global pages (3420 in the example) is equal to or greater than 1100 If the number of unused pages is less than 1100 you need to increase the value for GBLPAGES. 3 Note the amount shown for Global Sections Used (258 in the example). 4 Run the System Generation Utility (SYSGEN) and use the SHOW command to determine how many global sections have been allocated. For example: $ RUN SYS$SYSTEM:SYSGEN SYSGEN> SHOW GBLSECTIONS Parameter Name Current Default Minimum Maximum Unit Dynamic -------------- ------- ------- ------- ------- ---- ------- GBLSECTIONS 512 250 20 4095 Sections 1-6 Preparing to Install VAX ADE 5 Subtract the amount shown in the summary (258 in the example) from the amount allocated. If the difference is less than the number of incremental global sections that you will need, then you need to increase the value of the GBLSECTIONS parameter. VAX ADE does not require any additional Global sections. Section 1.5.2.2 describes the procedures for increasing these values using AUTOGEN. Refer to the VMS System Management Subkit for information on using AUTOGEN. _____________________________ 1.5.2.2 Changing System Parameter Values with AUTOGEN Use the AUTOGEN command procedure to change system parameters. AUTOGEN automatically adjusts values for parameters that are associated with the values you reset manually. To change system parameters with AUTOGEN, edit the following file: SYS$SYSTEM:MODPARAMS.DAT Use an editor to access the file. To change a parameter value listed in this file, delete the current value associated with that parameter and enter the new value. To add a new parameter, add a line to the file that includes both the name of the parameter and its value. For example: WSMAX = 1024 To modify incremental parameters such as GBLPAGES and GBLSECTS, use ADD_. The following example increases the global page setting by 2000: ADD_GBLPAGES = 2000 Note that when you set the page file quota, do not use a value that exceeds the amount of page file space available on the system. 1-7 Preparing to Install VAX ADE After you make all your changes, exit from the editor and execute the AUTOGEN procedure to recalculate your system parameters. Enter the following command at the DCL prompt: $ @SYS$UPDATE:AUTOGEN GETDATA REBOOT When you specify REBOOT, AUTOGEN performs an automatic system shutdown and then reboots the system. Any users logged in to the system are immediately disconnected during the shutdown. The automatic reboot puts the new parameter values into effect. The AUTOGEN Utility automatically adjusts some of the SYSGEN parameters based on the consumption of resources since the last reboot. If you do not want to take advantage of this automatic adjustment, include the NOFEEDBACK qualifier on the AUTOGEN command line. For more information about using AUTOGEN, see the VMS System Management Subkit. _____________________________ 1.5.3 VMSINSTAL Requirements When you invoke VMSINSTAL, it checks the following: o Whether you have set your default device and directory to SYS$UPDATE o Whether you are logged in to a privileged account o Whether you have adequate quotas for installation o Whether DECnet is running o Whether any users are logged in to the system Note that the VMSINSTAL requires that the installation account have a minimum of the following quotas: ASTLM = 24 BIOLM = 18 1-8 Preparing to Install VAX ADE BYTLM = 18,000 DIOLM = 18 ENQLM = 30 FILLM = 20 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 or press Return. Then correct the problem and restart the installation. _____________________________ 1.5.4 Backing Up Your System Disk At the beginning of the installation, VMSINSTAL asks if you have backed up your system disk. Digital recommends that you do a system disk backup before installing any software. Use the backup procedures that are established at your site. For details on performing a system disk backup, see the section on the Backup Utility in the VMS System Management Subkit. 1-9 _______________________________________________________ 2 Installing VAX ADE This chapter contains a step-by-step description of the installation procedure and a discussion on postinstallation considerations. __________________________________________________________ 2.1 The Installation Procedure The VAX ADE installation procedure consists of a series of questions and informational messages. See Appendix A for a sample installation. To abort the installation procedure at any time, press Ctrl/y. The installation procedure deletes all files it has created up to that point and exits. You can then start the installation again. 1 Invoke VMSINSTAL. @SYS$UPDATE:VMSINSTAL saveset-name device-name OPTIONS N To start the installation, invoke the VMSINSTAL command procedure from a privileged account, such as the SYSTEM account. VMSINSTAL is in the SYS$UPDATE directory. The following list defines the elements of the VMSINSTAL command procedure: saveset-name The installation name for the component. For VAX ADE, use the following installation name: @SYS$UPDATE:VMSINSTAL ADE025 MTA0: OPTIONS N 2-1 Installing VAX ADE device-name The name of the device on which you plan to mount the media. For example, MTA0: is the device name for a tape drive. It is not necessary to use the console drive for this installation; however, if you do, you should replace any media you removed once the installation is complete. OPTIONS N An optional parameter that indicates you want to see the question on release notes. If you do not include the OPTIONS N parameter, VMSINSTAL does not ask you about the release notes. You should review the release notes before proceeding with the installation in case they contain additional information about the installation. If you are restarting the installation and have already reviewed the release notes, you do not need to specify OPTIONS N. Note that there are several other options you can select when you invoke VMSINSTAL. These options are: o Auto_answer option (A)-Initially creates a file that contains your answers to VMSINSTAL questions and prompts. You can then use the option (and the answer file) to save time during a reinstallation (typically after upgrading your system). o Get save set option (G)- Lets you store product savesets temporarily on a magnetic tape or in a disk directory. o File log option (L)- Logs all activity to the terminal during installation. o Alternate root option (R)-Lets you install the product to a system root other than that of the running system. 2-2 Installing VAX ADE If you specify more than one option, separate the options with commas (OPTIONS A,N). See the VMS documentation on software installation in the VMS System Management Subkit for detailed information on these options. The following example invokes VMSINSTAL to install VAX ADE from tape drive MTA0: and shows the system response. This example uses the OPTIONS N release notes parameter. $ @SYS$UPDATE:VMSINSTAL ADE025 MTA0: OPTIONS N VAX/VMS Software Product Installation Procedure V2.5 It is 10-July-1991 at 08:05 Enter a question mark (?) at any time for help. If you do not supply either the product name or the device name, VMSINSTAL prompts you for this information later in the installation procedure. 2 Confirm system backup. * Are you satisfied with the backup of your system disk [YES]? VMSINSTAL asks if you are satisfied with your system backup. You should always back up your system disk before performing an installation. If you are satisfied with the backup of your system disk, press Return. Otherwise, enter NO to discontinue the installation. After you back up your system disk, you can restart the installation. 3 Mount the media. 2-3 Installing VAX ADE Please mount the first volume of the set on MTA0:. * Are you ready? YES %MOUNT-I-MOUNTED, VAX ADE MOUNTED ON _$$MTA0: (NODE 1) The following products will be processed: VAX ADE V2.5 Beginning installation of VAX ADE V2.5 at 20:01 %VMSINSTAL-I-RESTORE, Restoring product saveset A... You should now mount the first distribution volume on the device you specified when you invoked VMSINSTAL. The device name appears in the line preceding the question. VMSINSTAL then asks you if you are ready to continue with the installation. If you respond YES, VMSINSTAL displays a message that the media containing VAX ADE has been mounted on the specified device and that the installation has begun. If you entered the wrong device name when you invoked VMSINSTAL and need to restart the installation, enter NO in response to the Are you ready? question. To abort the installation for other reasons, press Ctrl/y. 4 Mount additional media volumes. %BACKUP-I-READYREAD, mount volume 2 on _MTA0: for reading Enter "YES" when ready: If your installation kit contains more than one volume, VMSINSTAL prompts you to mount the additional volumes and then asks you to indicate that you are ready for the installation to proceed. 2-4 Installing VAX ADE 5 Select a release notes option. If you specified OPTIONS N when you started the installation, VMSINSTAL asks a question on release notes. There are four options for handling the release notes under VMS Version 5.2 or higher. You will see the following display: Release notes included with this kit are always copied to SYS$HELP. 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 immediately on the console terminal. You can terminate the display at any time by pressing Ctrl/c. If you select option 2, VMSINSTAL prompts you for the name of the print queue: * Queue name [SYS$PRINT]: You can press RETURN to send the file to the default output print device or you can enter another queue name. If you select option 3, VMSINSTAL displays the release notes immediately on the console terminal and then prompts you for a queue name for the printed version. Select option 4 if you reviewed the release notes and are restarting the installation. 2-5 Installing VAX ADE Next, VMSINSTAL displays the following question: * Do you want to continue the installation [N]?: YES %VMSINSTAL-I-RELMOVED, The product's release notes have been successfully moved to SYS$HELP. 2-6 Installing VAX ADE To continue the installation, enter YES. Otherwise, press Return. In either case, the release notes are copied to a file in the SYS$HELP directory: SYS$HELP:ADE025.RELEASE_NOTES After the installation, you can enter the following command to review the release notes through the Help facility: $ HELP ADE RELEASE_NOTES Note The name of the release notes file installed by VMSINSTAL consists of the current product name and version number. Do not delete release notes for previous versions of VAX ADE. 6 Purge files. * Do you want to purge files replaced by this installation [YES]? You have the option to purge files from previous versions of VAX ADE that are superseded by this installation. Purging is recommended; however, if you need to keep files from the previous version, enter NO in response to the question. 7 Choose the Installation Verification Procedure (IVP) option. * Do you want to run the IVP after the installation [YES]? The installation procedure now asks if you want to run the IVP. The IVP for VAX ADE checks to be sure that the installation is successful. It is recommended that you run the IVP. 2-7 Installing VAX ADE After VAX ADE is installed, you can run the IVP independently to verify that the software is available on your system. You might need to run the IVP after a system failure to make sure that users can access VAX ADE. 8 Respond to license registration queries. Product: ADE Producer: DEC Version: 2.5 Release Date: 01-MAY-1989 * Does this product have an authorization key registered and loaded? 2-8 Installing VAX ADE The installation procedure displays license information about your product and then asks if you have registered and loaded your Product Authorization Key (PAK). If you have not registered and loaded your PAK, you must answer NO to this question. You have to register and load your PAK to successfully complete the installation. If you have not done so, you should stop the installation, register and load your PAK, and then restart the installation. 9 Read informational messages. At this point, the installation procedure displays a number of informational messages that report on the progress of the installation. There are no further questions. If the installation procedure has been successful up to this point, VMSINSTAL moves the new or modified files to their target directories, updates help files, and updates DCL tables, if necessary. If you chose to have files purged, that work is done now. The following messages are displayed: %VMSINSTAL-I-MOVEFILES, files will now be moved to their target directories... 10 Observe the Installation Verification Procedure (IVP). If you chose to run the IVP, VMSINSTAL runs it now. When the IVP runs successfully, you see the following display: 2-9 Installing VAX ADE Ade: REMARK . Ade: REMARK "**********************************************" Ade: REMARK "** **" Ade: REMARK "** ADE INSTALLATION TEST SUCCESSFUL **" Ade: REMARK "** **" Ade: REMARK "**********************************************" Ade: EXIT 11 End the installation procedure. Installation of VAX ADE V2.5 completed at 08:15 VMSINSTAL procedure done at 08:15 The previous messages indicate that the entire installation procedure is complete. 2-10 Installing VAX ADE You can now log out of the privileged account: $ LOGOUT SYSTEM logged out at10-JUL-1991 08:16:43.67 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. __________________________________________________________ 2.2 Error Recovery 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 ADE V2.5 has failed. If the IVP fails, you see these messages: The VAX ADE V2.5 Installation Verification Procedure failed. %VMSINSTAL-E-IVPFAIL, The IVP for VAX ADE V2.5 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. o Quotas necessary for successful installation are insufficient. o System parameter values for successful installation are insufficient. o The VMS help library is currently in use. 2-11 Installing VAX ADE o The product license has not been registered and loaded. For descriptions of the error messages generated by these conditions, see the VMS documentation on system messages, recovery procedures, and VMS 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 Chapter 1. 2-12 _______________________________________________________ 3 After Installing VAX ADE After installing VAX ADE, perform the following tasks: o Run the Installation Verification Procedure separately. o Edit the system startup and shutdown files. o Modify system parameter settings. o Make the product usable on a VAXcluster. o Set user account quotas. o Tailor your system. o Enhance performance. o Report problems. __________________________________________________________ 3.1 Running the Installation Verification Procedure Separately You usually run the Installation Verification Procedure (IVP) during installation. If you want to run the IVP separately to ensure the integrity of installed files should system problems occur, execute the following command procedure: $ DEFINE ADE$SYSFILES SYS$SYSTEM: $ ADE/COMMAND SYS$COMMON:[SYSTEST.ADE]ADE$IVP.COM 3-1 After Installing VAX ADE __________________________________________________________ 3.2 Editing the System Files You must edit the system startup and shutdown files to provide for automatic startup and shutdown of VAX ADE when your system is rebooted. If you are not installing ADE as a known image, add the following line to your file (called SYS$MANAGER:SYSTARTUP_v5.COM): $ DEFINE ADE$SYSFILES SYS$SYSTEM: 3-2 After Installing VAX ADE If you are installing ADE as a known image, or if you are linking ADE to ALL-IN-1, add the following line to your startup command file (called SYS$MANAGER:SYSTARTUP_V5.COM): $ @SYS$STARTUP:ADE$STARTUP.COM __________________________________________________________ 3.3 User Account Requirements To work with VAX ADE, user accounts on your system must have certain privileges and quotas. The next two sections contain information on these requirements. _____________________________ 3.3.1 Privileges To use VAX ADE, each account must have at least the TMPMBX and NETMBX privileges. Use the VMS Authorize Utility to determine whether users have the privileges they require. __________________________________________________________ 3.4 Enhancing VAX ADE Performance This section includes information on how to install VAX ADE as a shared image and how to install the VAX ADE help file. Enter the following command to install the ADE and ADESHR images: $ @SYS$STARTUP:ADE$STARTUP Now, add the following line to the appropriate system startup command file so that VAX ADE is available as a shared image each time the system is started (if your site has modularized its startup procedures, be sure you add the line to the correct file): $ @SYS$STARTUP:ADE$STARTUP 3-3 After Installing VAX ADE The default startup command file for V5.0 is SYS$MANAGER:SYSTARTUP_V5.COM. When you install VAX ADE as a shared image you need to increase the global pages and global sections parameters. Increase global pages (GBLPAGES) by 1100 pages. Refer to Section 1.5.2 for information on changing these parameters. _____________________________ 3.4.1 Installing the ADE help file The ADE help file (ADE$VMS.HLP) assumes that you followed the standard installation procedure. If ADE is not installed on the system disk or in system accounts, then modify the help file accordingly. You may also want to include information about the location of the manuals, local help, and so on. To edit the ADE help file, you need to extract ADE$VMS.HLP from the main help library and replace it when you've finished making your changes. Type the following commands (the dots represent the lines you are editing): $ LIBRARY/EXTRACT=ADE/HELP/OUTPUT=ADE$VMS SYS$HELP:HELPLIB . . . $ LIBRARY/REPLACE/HELP SYS$HELP:HELPLIB ADE$VMS $ DELETE ADE$VMS.HLP;* Alternatively, you could edit the copy of the help file that the installation procedure leaves in SYS$HELP:ADE$VMS.HLP. 3-4 After Installing VAX ADE __________________________________________________________ 3.5 Linking ADE to ALL-IN-1 The following sections contain the steps to follow to link VAX ADE to Versions 1.3, 1.4, and 2.0 of ALL-IN-1. _____________________________ 3.5.1 LINKING TO ALL-IN-1 V1.3-V1.4 If you installed ADESHR as a known image (see Chapter 1), ADE is now callable by ALL-IN-1 and any other application. The following steps show how to link to ALL-IN-1 and put ADE in the Information Management menu. Before linking callable ADE to ALL-IN-1, you must: o Have ALL-IN-1 Version 1.3 or 1.4 o Install ADESHR.EXE as a known image o Be familiar with ALL-IN-1 Application Programmer's Reference Manual and Form Editor (FED) from FMS 3-5 After Installing VAX ADE To link callable ADE to ALL-IN-1, do the following: 1 Log in to the ALL-IN-1 manager's account. 2 Edit the file LINKA1.COM as follows: a. In the section beginning with the label ASK_ QUESTIONS, insert the following line before the label GOT_ANSWERS: INQUIRE ADEOPT "Do you want to link with ADE [Y/N]" b. Find the statement GOTO START_LINK and replace with the following statement: GOTO CHECK_ADE c. Find the label START_LINK and insert the following lines before it: CHECK_ADE: IF ADEOPT THEN GOTO LINK_WITH_ADE WRITE A1TMP "SYMBOL=ADE$ADE, 0" GOTO START_LINK LINK_WITH_ADE: WRITE A1TMP "SYS$SHARE:ADESHR/SHARE" 3 Type the command: $ @LINKA1.COM Answer the questions according to the ALL-IN-1 options you want to include. Answer Y to the ADE question Do you want to link with ADE [Y/N]?. Note If relinking is necessary at any time, do not run LINKA1.COM from another command file or ADE will not be relinked. 4 Reinstall the A1.EXE image using the INSTALL program. 3-6 After Installing VAX ADE 5 Run ALL-IN-1 from the ALL-IN-1 Manager's account and type MANAGER to the Enter your Username: prompt. 6 Select the Form Development (FD) menu item. 7 Select the Edit an Existing Form (E) menu. 8 Type IM to the Enter Form Name to Update: prompt and press the Return key. 9 Type EDIT at the COMMAND prompt and insert the following as the last item on the form: AD ADE Information Management To bold AD: a. Place the cursor on the A of AD. b. Press the Select (.) key on the keypad. c. Retype AD. d. Press the Video (7) key on the keypad. e. Enter BOLD and to the Video prompt. f. Type to the Video prompt. This will return you to the Edit prompt. 10 Press GOLD KEY 7 on the keypad to return to the COMMAND prompt. 11 Enter NAME at the COMMAND prompt. The form Named Data Entry displays on your screen. 12 Press the Tab key until you reach the last line. 13 Insert the following after the last line: AD ADE 14 Press the Return key. This will return you to the COMMAND prompt. 3-7 After Installing VAX ADE 15 Enter SAVE at the COMMAND prompt. The following messages are displayed: ?FED - Form being saved. Form IM added to OALIB:OAFORM library Press RETURN to continue 16 Log out of the ALL-IN-1 manager's account. 17 Log in to an ALL-IN-1 user account. Select the IM menu. Type AD. You should see the WELCOME TO ADE screen. If not, redo the preceding steps. 3-8 After Installing VAX ADE _____________________________ 3.5.2 LINKING ADE TO ALL-IN-1 V2.0 Before linking callable ADE to ALL-IN-1, you must: o Have ALL-IN-1 Version 2.0 o Have ADESHR.EXE installed as a known image o Be Familiar with the ALL-IN-1 Application Programmer's Reference Manuals and the Form Editor (FED) from FMS To link ADE to ALL-IN-1, perform these steps: 1 Log in to the ALL-IN-1 manager's account. 2 Set Default to OA$BUILD:. 3 Edit the file A1LNKASK.COM as follows: a. Find the statement VMI$CALLBACK MESSAGE E NOHELP. Insert the following line before it: if p1 .eqs. "HELP_ADE" then goto 'p1 b. Find the label WPSPLUS_OK:. Insert the following lines after it: VMI$CALLBACK ASK A1$ADE - "Do you want to link with ADE" - "YES" B "@VMI$KWD:A1LNKASK HELP_ADE" c. Find the statement EXIT VMI$_SUCCESS and insert the following lines before it: if a1$ade then - vmi$callback FIND_FILE a1$adeshr adeshr.exe vmi$root:[syslib] S d. Go down five lines. After the statement EXIT VMI$_SUCCESS, insert the following line: HELP_ADE: 3-9 After Installing VAX ADE ALL-IN-1 allows ADE to be part of its image by linking against a sharable ADE image. If you would like to have ADE be a part of ALL-IN-1, respond YES. This will enable the ADE function of ALL-IN-1. 3-10 After Installing VAX ADE 4 Save what has just been entered and EXIT from the edit. 5 Edit the file A1LINK.COM. Find the statement CLUSTER=DTR and insert the following lines after it: if a1$ade then - $wo "Cluster=ADE ,,,"f$logical("A1$ADESHR")'/Sharable EXIT from the edit, saving what you just entered. 6 To relink ALL-IN-1, Set Default to OA$LIB: and type the command: $ @OA$BUILD:A1LNKDRV.COM Answer the questions according to the ALL-IN- 1 options you have selected for this customer installation. Answer YES to the question Do you want to link with ADE [YES]. 7 Reinstall the A1.EXE image using the INSTALL program. 8 Run ALL-IN-1 from the ALL-IN-1 manager's account and type MANAGER to the Enter your Username: prompt. 9 From the main menu, enter PD (Program Development Subsystem). 10 From the PD menu, enter FD (Forms Development Subsystem). 11 Select Library OA$LIB:OAFORM. 12 Select Form IM.FRM. 13 Select Edit. 14 Select Screen Image. 15 Enter Layout phase. 3-11 After Installing VAX ADE 16 Position the cursor at the location where you want to add the following: ADE Information Management Tool 17 Press GOLD KEY 7 (to exit the layout phase). 18 Enter DATA phase. 19 At the last entry in DATA, enter ADE after NAME and on the next line: EXAMPLE: 5 NAME: ADE ADE 20 Press GOLD KEY 7 (to exit DATA phase). 21 Enter EXIT (to exit FMS). 22 Enter YES (to save your change form). 23 Press Return to continue at the prompt. 24 Exit from ALL-IN-1 and enter the following. $ALLIN1/NOINIT OA$FLO_OPEN OA$LIB:OAFORM OA$FBT_WRITE LIBRARY OA$LIB:OAFORM OA$FBT_INSTALL LIBRARY OA$LIB:OAFORM $Ctrl/z ADE is now ready to run from ALL-IN-1. __________________________________________________________ 3.6 Determining and Reporting Problems If you encounter a problem while using VAX ADE, report it to Digital. Depending on the nature of the problem and the type of support you have, take one of the following actions: 3-12 After Installing VAX ADE o Call Digital if your software contract or warranty agreement entitles you to telephone support. o Submit a Software Performance Report (SPR). o Fill out and submit a Reader's Comments form if the problem has to do with the VAX ADE documentation. Reader's Comments forms can be found at the back of each manual. Use the form from the manual in which you found the error. Include the section and page number. Review the Software Product Description (SPD) and Warranty Addendum for an explanation of warranty. If you encounter a problem during the warranty period, report the problem as indicated above or follow alternate instructions provided by Digital for reporting SPD nonconformance problems. 3-13 _______________________________________________________ A Sample Installation This appendix contains a sample installation of VAX ADE. This sample was run on a system that had no previous version of VAX ADE installed. The sample installation assumes that DECnet has been shut down, that no users are logged in to your system, and that OPTIONS N is specified to print the release notes. The Installation Verification Procedure (IVP) runs at the end of the installation. $ @SYS$UPDATE:VMSINSTAL ADE025 ADE$:[KIT] OPTIONS N VAX/VMS Software Product Installation Procedure V5.3 It is 22-AUG-1991 at 14:52. Enter a question mark (?) at any time for help. * Are you satisfied with the backup of your system disk [YES]? YES The following products will be processed: ADE V2.5 Beginning installation of ADE V2.5 at 14:53 %VMSINSTAL-I-RESTORE, Restoring product save set A ... Release notes included with this kit are always copied to SYS$HELP. Additional Release Notes Options: 1. Display release notes 2. Print release notes 3. Both 1 and 2 4. None of the above A-1 Sample Installation * Select option [2]: 4 * Do you want to continue the installation [NO]? YES %VMSINSTAL-I-RELMOVED , The product's release notes have been successfully moved to SYS$HELP. ***************************************************************** * * * VAX ADE INSTALLATION PROCEDURE * * * * Copyright 1984, 1988, 1991 Digital Equipment Corporation * * * * Installing ADE V2.5 * * * ***************************************************************** During this installation, new files will be provided to replace existing versions. You may purge older versions to save disk space, or keep them if you feel that they may be of use. Purging is recommended. * Do you wish to purge the old version of VAX ADE ? [Y]? YES The IVP should be run after this installation to verify that the VAX ADE system files are in their proper locations. Running this procedure will invoke VAX ADE to verify the success of this installation. NOTE: The IVP must be run from a video terminal. * Do you want to run the IVP after the installation [YES]? Product: ADE Producer: DEC Version: 2.5 Release Date: 01-MAY-1989 * Does this product have an authorization key registered and loaded? y A-2 Sample Installation Please enter the UIC in the Format [Group,Member] * WHAT IS THE ADE UIC [[001,004]]: Please enter the UIC in the Format [Group,Member] * WHAT IS THE SYSLIB UIC [[001,004]]: Please enter the UIC in the Format [Group,Member] * WHAT IS THE SYSHLP.EXAMPLES UIC [[001,004]]: ****************************************************************** * * * INSTALLING ADE V2.5 PROGRAMS * * * * * * This will take a few minutes. Please wait!!! * * * ****************************************************************** * * * There are no more questions for this installation. * * * ****************************************************************** Installing IVP files %VMSINSTAL-I-MOVEFILES, Files will now be moved to their target directories .. ******************************************************************** * * * STARTING THE INSTALLATION VERIFICATION PROCEDURE * * * ******************************************************************** WELCOME TO ADE INFORMATION MANAGEMENT MADE EASY A-3 Sample Installation FOR OFFICE PROFESSIONALS ADE V2.5 starting at 22-Aug-91 02:58 PM using the File: VMI$ROOT:[SYSTEST.ADE]ADE$IVP.COM. Ade: option TERMINAL ? Working... Terminal type option was set to "?". Ade: MAKE new WORKSHEET called TEST.TABLE * Enter Column names for the WORKSHEET. (ENTER) @M (CANCEL) ^C (HELP) @Q (DISPLY) @PQ (UNDEL) @R (DEL.LN) @PR (UP) @A (TOP) @PA (DOWN) @B (BOTTOM) @PB (INSERT) @w Column 1? PN AS KEY Column 2? PNAME Column 3? WHOUSE Column 4? COLOR Column 5? WEIGHT AS NUM Column 6? QTY AS NUM Column 7? (ENTER) @M (CANCEL) ^C (HELP) @Q (DISPLY) @PQ (UP) @A (TOP) @PA (DOWN) @B (BOTTOM) @PB (D.RGHT) @PC (D.LEFT) @PD (SKIP) @x This is the last line you entered: PN PNAME WHOUSE COLOR WEIGHT QTY -- A-4 Sample Installation PN ? P01 PNAME ? NUT WHOUSE ? W2 COLOR ? RED WEIGHT ? 12 QTY ? 135 PN PNAME WHOUSE COLOR WEIGHT QTY -- P01 NUT W2 RED 12 135 PN ? P02 PNAME ? BOLT WHOUSE ? W2 COLOR ? GREEN WEIGHT ? 17 QTY ? 167 PN PNAME WHOUSE COLOR WEIGHT QTY -- P02 BOLT W2 GREEN 17 167 PN ? P03 PNAME ? SCREW WHOUSE ? W1 COLOR ? BLUE WEIGHT ? 17 QTY ? 48 PN PNAME WHOUSE COLOR WEIGHT QTY -- P03 SCREW W1 BLUE 17 48 PN ? P04 PNAME ? SCREW WHOUSE ? W2 COLOR ? RED WEIGHT ? 14 QTY ? 143 A-5 Sample Installation PN PNAME WHOUSE COLOR WEIGHT QTY -- P04 SCREW W2 RED 14 143 PN ? P05 PNAME ? CAM WHOUSE ? W1 COLOR ? BLUE WEIGHT ? 12 QTY ? 205 PN PNAME WHOUSE COLOR WEIGHT QTY -- P05 CAM W1 BLUE 12 205 PN ? P06 PNAME ? COG WHOUSE ? W3 COLOR ? RED WEIGHT ? 19 QTY ? 215 PN PNAME WHOUSE COLOR WEIGHT QTY -- P06 COG W3 RED 19 215 PN ? P07 PNAME ? GEAR WHOUSE ? W3 COLOR ? GREY WEIGHT ? 9 QTY ? 234 PN PNAME WHOUSE COLOR WEIGHT QTY -- P07 GEAR W3 GREY 9 234 PN ? P08 PNAME ? BEARING WHOUSE ? W2 COLOR ? GREY WEIGHT ? 25 QTY ? 136 A-6 Sample Installation PN PNAME WHOUSE COLOR WEIGHT QTY -- P08 BEARING W2 GREY 25 136 PN ? P09 PNAME ? BOLT WHOUSE ? W1 COLOR ? WHITE WEIGHT ? 5 QTY ? 15 PN PNAME WHOUSE COLOR WEIGHT QTY -- P09 BOLT W1 WHITE 5 15 PN ? 9 lines were ENTERED. You have 9 lines in your WORKSHEET. Ade: LIST existing WORKSHEET columns ALL --- A-7 Sample Installation PN PNAME WHOUSE COLOR WEIGHT QTY -- P01 NUT W2 RED 12 135 P02 BOLT W2 GREEN 17 167 P03 SCREW W1 BLUE 17 48 P04 SCREW W2 RED 14 143 P05 CAM W1 BLUE 12 205 P06 COG W3 RED 19 215 P07 GEAR W3 GREY 9 234 P08 BEARING W2 GREY 25 136 P09 BOLT W1 WHITE 5 15 Ade: SAVE worksheet as TEST.TABLE Enter a description for the Table: YES The WORKSHEET has been saved as Table "TEST.TABLE". Ade: RENAME existing TEST.TABLE to table TEST.TABLE Just press the (RETURN) key to keep: "YES" or enter a new description for the Table: Sample Parts Table The Table "TEST.TABLE" has been renamed to "TEST.TABLE". Ade: ALLOW access to TEST.TABLE by WORLD Ade: MAKE new REPORT called TEST.REPORT using table WORKSHEET (ENTER) @M (CANCEL) ^C (HELP) @Q (DISPLY) @PQ (UNDEL) @R (DEL.LN) @PR (UP) @A (TOP) @PA (DOWN) @B (BOTTOM) @PB (RIGHT) @C (INSERT) @w (SKIP) @x (FNDNXT) @y (FIND) @Py Loading section: @LAYOUT Loading section: @TOP Loading section: @BOTTOM Loading section: @WHERE @COLUMNS PN (PN) PN (PN) A-8 Sample Installation Enter a description for the Report: TEST REPORTS The Report "TEST.REPORT" has been saved. Ade: TEST.REPORT reporting the table WORKSHEET Loading section: @COLUMNS Loading section: @LAYOUT Loading section: @TOP Loading section: @BOTTOM Loading section: @WHERE 22-Aug-91 02:59 PM Page 1 TEST.TABLE -------------------------------------------------- | PN | PNAME | WHOUSE | COLOR | WEIGHT | QTY | -------------------------------------------------- P01 NUT W2 RED 12 135 P02 BOLT W2 GREEN 17 167 P03 SCREW W1 BLUE 17 48 P04 SCREW W2 RED 14 143 P05 CAM W1 BLUE 12 205 P06 COG W3 RED 19 215 P07 GEAR W3 GREY 9 234 P08 BEARING W2 GREY 25 136 P09 BOLT W1 WHITE 5 15 Ade: NAMES of ALL --- Name Description Date Saved Time Access * Tables * PARTS Sample Parts Table 06-JUL-1982 13:48 WORLD TEST.TABLE Sample Parts Table 22-AUG-1991 14:59 WORLD * There are no Verbs * * Reports * TEST.REPORT TEST REPORTS 22-AUG-1991 14:59 SELF A-9 Sample Installation Ade: ERASE existing TEST.TABLE Do you want to erase the Table "TEST.TABLE" (YES or NO) ? YES The Table "TEST.TABLE" has been erased. Ade: ERASE existing TEST.REPORT Do you want to erase the Report "TEST.REPORT" (YES or NO) ? YES The Report "TEST.REPORT" has been erased. Ade: HELP me with subject ADE --- Basic ADE operations --- Type: To find out about this: TRAIN - Training exercises if you are new to ADE HELP TABLES - Entering new data, or starting from scratch HELP WORK - Working with existing data HELP SHOW - Printing data HELP VERBS - Automating repetitive series of commands HELP REPORTS - Printing data using ADE Reports HELP ? - List all ADE commands HELP TOPICS - List topics you can get HELP about HELP KEYPAD - Where special functions are on the keyboard ---------------------------------------------------------------------------- In ADE, data is stored in Tables. Tables have lines and columns. To work with a Table, it is copied into the Worksheet. Permanent changes are made only by filing away the Worksheet as a Table. Ade: REMARK . Ade: REMARK "*************************************************" Ade: REMARK "** **" Ade: REMARK "** ADE INSTALLATION TEST SUCCESSFUL **" Ade: REMARK "** **" Ade: REMARK "*************************************************" Ade: EXIT ADE V2.5 finished at 22-Aug-91 02:59 PM. A-10 Sample Installation ******************************************************************* * * * If you are not installing ADE as a known image, add the * * following line to your startup command file * * (called SYS$MANAGER:SYSTARTUP.COM): * * * * $ DEFINE ADE$SYSFILES SYS$SYSTEM: * * * * If you are installing ADE as a known image, or if you are * * linking ADE to ALL-IN-1, add the following line to your * * startup command file(called SYS$MANAGER:SYSTARTUP.COM): * * * * $ @SYS$STARTUP:ADE$STARTUP.COM * * * ******************************************************************* Installation of ADE V2.5 completed at 14:59 VMSINSTAL procedure done at 14:59 A-11 _______________________________________________________ B Files and Logical Names Installed on Your System The VAX ADE installation procedure installs a number of files on your system and defines some logical names. Section B.1 lists the files installed. [Section B.1 tells where you can find the list of installed files.] Section B.2 lists the logical names that are added to the system logical name table. __________________________________________________________ B.1 File Names The following list contains the names of all files created on your system when VAX ADE is installed. o [SYSEXE] ADE.EXE - ADE task image o [SYSEXE] ADEINI.ADE - ADE initialization file o [SYSEXE] ENGHLP.ADE - English language help file o [SYSEXE] ENGINI.ADE - English language syntax file o [SYSEXE] ENGLEX.ADE - English language message file o [SYSEXE] ENGRPT.ADE - English Default Report file o [SYSEXE] ENGTRA.ADE - English Training command script o [SYSEXE] NOTICE.ADE - Message to all ADE users. o [SYS$STARTUP] ADE$STARTUP.COM - ADE startup command file for ADE shared image o [SYSLIB] ADESHR.EXE - ADE sharable image o [SYSLIB] DES001.ADE - ORDER.STATUS sample Table descriptor file o [SYSLIB] DIR000.ADE - Sample ADE directory B-1 Files and Logical Names Installed on Your System o [SYSLIB] TBL001.ADE - ORDER.STATUS sample Table data file o [SYSHLP] ADE$VMS.HLP - VMS system Help file for ADE o [SYSHLP] ADE025.RELEASE_NOTES - VAX ADE Release Notes o [SYSTEST] ADE$IVP.COM - Installation Test command file _____________________________ B.1.1 Updated System Files The VAX ADE software installation updates the following VAX/VMS system files: o [SYSHLP]HELPLIB.HLB The systemwide default help library now contains the new HELP topic, ADE. If this file is modified during the next update of VAX/VMS, you may have to reinstall ADE. __________________________________________________________ B.2 Logical Names The following logical names are entered into the system logical name table when VAX ADE is installed. These names are stored in the product's startup file. They are automatically entered into the system logical name table whenever the system reboots or whenever the software is invoked. o ADE$SYSFILES B-2 _______________________________________________________ C Using the VAX ADE Callable Interface __________________________________________________________ C.1 Examples of The Callable Interface Use the following command string format to implement the callable ADE interface: $ ADE$ADE command_string where: command_ is the name of a VERB or procedure which string ADE can execute. The exact syntax depends on the language you use. To link with callable ADE after you compile your program, enter the following: $ LINK filename, SYS$INPUT/OPTIONS SYS$SHARE:ADESHR/SHARE ^z where: filename is the name of the program that is calling the callable ADE. ^z is Ctrl/z. The following sample programs show you how to use the callable interface to run ADE: C-1 Using the VAX ADE Callable Interface VAX BASIC 1 REM THIS BASIC PROGRAM CALLS ADE 100 CALL ADE$ADE ('ADE.VERB') 900 END VAX BLISS-32 MODULE B32TEST (MAIN = B32TEST, ADDRESSING_MODE (NONEXTERNAL= GENERAL, EXTERNAL= GENERAL)) = BEGIN !+ ! Program using the ADE callable interface !- EXTERNAL ROUTINE ADE$ADE MACRO $DSC (STR) = WORD (%CHARCOUNT (STR)), WORD (%X'010E'), LONG (UPLIT (%STRING (STR))) %; OWN !+ ! Create the descriptor of the command to ! pass to ADE. !- CMD_STRING_DSC : VECTOR [8, BYTE] INITIAL ($DSC ('ADE.VERB')); ROUTINE B32TEST : NOVALUE = BEGIN LOCAL RESULT; RESULT = ADE$ADE (CMD_STRING_DSC); END; END ELUDOM C-2