VSI OpenVMS VSI FMS Form Driver Reference Manual Document Number: DO-FMSDRM-01A Publication Date: June 2021 Revision Update Information: This is a new manual. Operating System and Version: VSI OpenVMS x86-64 Version 9.0 VSI OpenVMS I64 Version 8.4-1H1 VSI OpenVMS Alpha Version 8.4-2L1 Software Version: VSI FMS Version 2.6 or higher VMS Software, Inc. (VSI) Burlington, Massachusetts, USA VSI FMS Form Driver Reference Manual Copyright © 2021 VMS Software, Inc. (VSI), Burlington, Massachusetts, USA Legal Notice Confidential computer software. Valid license from VSI required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license. The information contained herein is subject to change without notice. The only warranties for VSI products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. VSI shall not be liable for technical or editorial errors or omissions contained herein. HPE, HPE Integrity, HPE Alpha, and HPE Proliant are trademarks or registered trademarks of Hewlett Packard Enterprise. DEC, DEC/CMS, DEC/MMS, DECnet, DECsystem-10, DECSYSTEM-20, DECUS, DECwriter, MASSBUS, MICRO/PDP-11, Micro/ RSX, MicroVMS, PDP, PDT, RSTS, RSX, TOPS-20, UNIBUS, VAX, VMS, VT, and mm are trademarks or registered trademarks of Hewlett Packard Enterprise. ii VSI FMS Form Driver Reference Manual Preface ................................................................................................................................... vii 1. About This Manual ....................................................................................................... vii 2. Intended Audience ........................................................................................................ vii 3. Document Structure ...................................................................................................... vii 4. VSI Encourages Your Comments .................................................................................. viii 5. OpenVMS Documentation ............................................................................................ viii 6. Typographical Conventions .......................................................................................... viii Chapter 1. Introduction ........................................................................................................ 1 1.1. Terminals, Workspaces, Forms, and Fields .................................................................... 1 1.1.1. Terminals .......................................................................................................... 1 1.1.2. Workspaces ....................................................................................................... 2 1.1.3. Forms ............................................................................................................... 2 1.1.4. Fields ................................................................................................................ 2 1.2. Terminal Control Areas and Form Workspaces .............................................................. 3 1.3. Form Management Calls .............................................................................................. 3 1.3.1. Control Calls ..................................................................................................... 4 1.3.2. Form-Level Calls .............................................................................................. 4 1.3.3. Field-Level Calls ............................................................................................... 4 1.3.4. Utility Calls ...................................................................................................... 5 1.4. Memory-Resident Forms and Form Libraries ................................................................. 6 1.5. Multiterminal and Multiform Operations ....................................................................... 6 1.6. Debug Mode ................................................................................................................ 6 1.7. Scrolling Operations ..................................................................................................... 6 1.8. User Action Routines ................................................................................................... 6 1.9. Named Data ................................................................................................................. 7 1.10. Terminal Key Functions .............................................................................................. 7 1.11. Current States ............................................................................................................. 7 1.12. Operator Aids ............................................................................................................ 9 1.12.1. Help ................................................................................................................ 9 1.12.2. Screen Refresh ................................................................................................ 9 Chapter 2. Form Driver Interaction .................................................................................. 11 2.1. Interaction with the Form Description ......................................................................... 11 2.1.1. Storing and Accessing Form Descriptions ......................................................... 11 2.1.2. Displaying a Form ........................................................................................... 12 2.1.3. Terminal Control ............................................................................................. 14 2.1.4. Using Workspaces to Store Forms .................................................................... 14 2.1.5. The Help Function ........................................................................................... 16 2.1.6. Field Processing Order ..................................................................................... 17 2.1.7. Text, Field-Marker Characters, and Video Attributes .......................................... 17 2.1.8. Processing Fields ............................................................................................. 18 2.1.8.1. Field Pictures ........................................................................................ 18 2.1.8.2. Right Justified and Left Justified Field Attributes .................................... 18 2.1.8.3. Clear Character and Fill Character Attributes .......................................... 18 2.1.8.4. Default Field Value ............................................................................... 18 2.1.8.5. Autotab Attribute .................................................................................. 19 2.1.8.6. Response Required and Must Fill Attributes ........................................... 19 2.1.8.7. Fixed Decimal Attribute ........................................................................ 19 2.1.8.8. Display Only Attribute .......................................................................... 20 2.1.8.9. No Echo Attribute ................................................................................. 20 2.1.8.10. Supervisor Only Attribute .................................................................... 20 2.1.8.11. Scrolling ............................................................................................. 20 iii VSI FMS Form Driver Reference Manual 2.1.8.12. Date and Time Attributes .................................................................... 21 2.2. User Action Routines ................................................................................................. 21 2.2.1. Field Completion UARs ................................................................................... 22 2.2.2. Help UARs ..................................................................................................... 23 2.2.2.1. Pre-Help UAR ...................................................................................... 23 2.2.2.2. Post-Help UAR ..................................................................................... 24 2.2.3. Help Request Processing .................................................................................. 24 2.2.4. Function Key UARs ........................................................................................ 26 2.2.5. Legal Actions in a UAR .................................................................................. 27 2.3. Interaction with the Terminal Operator ........................................................................ 28 2.3.1. Signaling and Recovering from Errors .............................................................. 28 2.3.1.1. Help Key and Help Messages ................................................................ 28 2.3.1.2. Checking Operator Responses from Your Program .................................. 29 2.3.1.3. Refreshing the Screen: Typing CTRL/R ................................................. 29 2.3.2. Field Editing Functions .................................................................................... 29 2.3.2.1. VT100 Alternate Keypad Mode ............................................................. 30 2.3.2.2.