CA ADS™ Batch for CA IDMS™ ADS Batch User Guide Release 18.5.00 This Documentation, which includes embedded help systems and electronically distributed materials, (hereinafter referred to as the “Documentation”) is for your informational purposes only and is subject to change or withdrawal by CA at any time. This Documentation is proprietary information of CA and may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. If you are a licensed user of the software product(s) addressed in the Documentation, you may print or otherwise make available a reasonable number of copies of the Documentation for internal use by you and your employees in connection with that software, provided that all CA copyright notices and legends are affixed to each reproduced copy. The right to print or otherwise make available copies of the Documentation is limited to the period during which the applicable license for such software remains in full force and effect. Should the license terminate for any reason, it is your responsibility to certify in writing to CA that all copies and partial copies of the Documentation have been returned to CA or destroyed. TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION “AS IS” WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION, LOST PROFITS, LOST INVESTMENT, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE. The use of any software product referenced in the Documentation is governed by the applicable license agreement and such license agreement is not modified in any way by the terms of this notice. The manufacturer of this Documentation is CA. Provided with “Restricted Rights.” Use, duplication or disclosure by the United States Government is subject to the restrictions set forth in FAR Sections 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section 252.227-7014(b)(3), as applicable, or their successors. Copyright © 2013 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies. CA Technologies Product References This document references the following CA products: ■ CA IDMS/DB ■ CA IDMS/DC (CA IDMS/DC Transaction Server Option) ■ DC/UCF (CA IDMS Universal Communications Facility) ■ CA ADS ■ CA ADS Batch Contact CA Technologies Contact CA Support For your convenience, CA Technologies provides one site where you can access the information that you need for your Home Office, Small Business, and Enterprise CA Technologies products. At http://ca.com/support, you can access the following resources: ■ Online and telephone contact information for technical assistance and customer services ■ Information about user communities and forums ■ Product and documentation downloads ■ CA Support policies and guidelines ■ Other helpful resources appropriate for your product Providing Feedback About Product Documentation If you have comments or questions about CA Technologies product documentation, you can send a message to [email protected]. To provide feedback about CA Technologies product documentation, complete our short customer survey which is available on the CA Support website at http://ca.com/docs. Contents Chapter 1: Introduction 9 Overview .......................................................................................................................................................................................... 9 Example 1: Employee-record Archiving Application.............................................................................................................. 10 Example 2: Employee-record Restore Application................................................................................................................. 12 Chapter 2: CA ADS Batch Concepts 15 Overview ........................................................................................................................................................................................ 15 Input and Output Files and File Maps ...................................................................................................................................... 16 Suspense Files ............................................................................................................................................................................... 20 Log Files.......................................................................................................................................................................................... 21 Log File Information............................................................................................................................................................. 22 Log File Prefix ........................................................................................................................................................................ 23 Archiving ................................................................................................................................................................................ 23 Batch Dialog Structure................................................................................................................................................................. 23 CA ADS Batch Dialog Components .................................................................................................................................... 24 Batch Control Events ........................................................................................................................................................... 25 Batch Response Field Values.............................................................................................................................................. 25 Batch Dialog Execution........................................................................................................................................................ 26 Application Structure................................................................................................................................................................... 30 Disallowed Functions........................................................................................................................................................... 30 Application Flow of Control................................................................................................................................................ 31 Accessing Input Files with Multiple Record Layouts ...................................................................................................... 33 Chapter 3: Process Command Language 35 Overview ........................................................................................................................................................................................ 35 System-supplied Data Fields ...................................................................................................................................................... 39 Status Conditions ......................................................................................................................................................................... 40 Batch Control Event Status Conditions ............................................................................................................................ 41 Environment Status Conditions ......................................................................................................................................... 41 Process Commands ...................................................................................................................................................................... 42 CLOSE...................................................................................................................................................................................... 42 READ TRANSACTION ............................................................................................................................................................ 43 WRITE TRANSACTION .......................................................................................................................................................... 44 Contents 5 Chapter 4: Application Compiler 49 Overview ........................................................................................................................................................................................ 49 Main Menu Screen....................................................................................................................................................................... 50 General Options Screens............................................................................................................................................................. 51 Global Records Screen................................................................................................................................................................. 53 Task Codes Screen........................................................................................................................................................................ 54 Response/Function List Screen.................................................................................................................................................. 55 Response Definition Screen........................................................................................................................................................ 56 Function Definition Screen ......................................................................................................................................................... 58 Chapter 5: Dialog Compiler 59 Overview ........................................................................................................................................................................................ 59 Dialog Compiler in Online Mode ............................................................................................................................................... 60 Main Menu Screen............................................................................................................................................................... 61 Map Specifications Screen.................................................................................................................................................. 62 Database Specifications ...................................................................................................................................................... 63 Options and Directives Screen ........................................................................................................................................... 64 Records and Tables Screen ................................................................................................................................................. 65 Process Modules Screen ..................................................................................................................................................... 65 Dialog Compiler in Batch Mode (ADSOBCOM) ....................................................................................................................... 67 Chapter 6: CA IDMS/DC Mapping Facility 69 Overview ........................................................................................................................................................................................ 69 Batch Automatic Editing and Error Handling .......................................................................................................................... 69 Variable Array Processing ........................................................................................................................................................... 71 Online Mapping Facility .............................................................................................................................................................. 72 Map Definition Screen......................................................................................................................................................... 73 Extended Map Definition Screen....................................................................................................................................... 74 File Field Selection Screen .................................................................................................................................................. 75 File Field Edit Screen............................................................................................................................................................ 76 Batch Map Compiler (RHDCMAP1) ........................................................................................................................................... 78 Chapter 7: Runtime Considerations 79 Overview ........................................................................................................................................................................................ 79 Runtime Flow of Control ............................................................................................................................................................. 80 Specifying File Characteristics.................................................................................................................................................... 83 Where to Specify File Characteristics ............................................................................................................................... 84 Specifying a Record Length ................................................................................................................................................ 85 Specifying a Block Size......................................................................................................................................................... 85 6 ADS Batch User Guide Default File Characteristics ................................................................................................................................................. 86 Specifying Characteristics of a Concatenated Data Set................................................................................................. 87 Specifying Characteristics of a Suspense File .................................................................................................................. 88 Tape Labels ............................................................................................................................................................................ 88 Application Components and Physical Data Sets ................................................................................................................... 89 Application Restartability ........................................................................................................................................................... 90 Checkpoint Record ............................................................................................................................................................... 91 Taking a Checkpoint at Runtime........................................................................................................................................ 91 Restarting the Application After an Abend...................................................................................................................... 92 CA ADS Batch Trace Facility ........................................................................................................................................................ 94 Multiple External Run Units Under CA ADS Batch.................................................................................................................. 97 Operator Shutdown ..................................................................................................................................................................... 97 Runtime Control Parameters ..................................................................................................................................................... 98 PARM Field Parameters ...................................................................................................................................................... 99 Control Statements .............................................................................................................................................................. 99 Loading Runtime Components ................................................................................................................................................109 JCL .................................................................................................................................................................................................110 Appendix A: ADSOBSYS 115 Overview ......................................................................................................................................................................................115 Control Statements ....................................................................................................................................................................115 Appendix B: z/VSE File Characteristics Program 123 Overview ......................................................................................................................................................................................123 SET OPTIONS Statement ...........................................................................................................................................................126 DEFINE CHARACTERISTICS Statement ....................................................................................................................................127 ACCEPT CHARACTERISTICS statement....................................................................................................................................130 RUN PROGRAM Statement.......................................................................................................................................................131 Appendix C: CA ADS Batch Print Log Utility 133 Overview ......................................................................................................................................................................................133 How to Use the Print Log Utility ..............................................................................................................................................133 DSECT for the Log File Prefix ....................................................................................................................................................135 Control Statements ....................................................................................................................................................................136 JCL .................................................................................................................................................................................................139 Appendix D: CA ADS Batch Sample Applications 143 Overview ......................................................................................................................................................................................143 Employee-record Archive Application....................................................................................................................................144 Contents 7 Step 1: Describe the Files in the Data Dictionary .........................................................................................................146 Step 2: Describe the Records in the Data Dictionary...................................................................................................146 Step 3: Define the File Maps ............................................................................................................................................148 Step 4: Define the Process Modules ...............................................................................................................................150 Step 5: Define the Dialogs ................................................................................................................................................150 Executing the Application .................................................................................................................................................161 Employee-Record Restore Application...................................................................................................................................164 Step 1: Define the Application Structure .......................................................................................................................166 Step 2: Define the Process Modules ...............................................................................................................................167 Step 3: Define the Dialogs ................................................................................................................................................167 Executing the Application .................................................................................................................................................180 Employee-Record Report Application ....................................................................................................................................182 Step 1: Describe the Records in the Data Dictionary...................................................................................................185 Step 2: Define the File Maps ............................................................................................................................................187 Step 3: Define the Process Modules ...............................................................................................................................188 Step 4: Define the Dialogs ................................................................................................................................................188 Executing the Application .................................................................................................................................................197 Index 199 8 ADS Batch User Guide Chapter 1: Introduction This section contains the following topics: Overview (see page 9) Example 1: Employee-record Archiving Application (see page 10) Example 2: Employee-record Restore Application (see page 12) Overview CA Application Development System/Batch (CA ADS Batch) is a facility that allows you to develop fourth-generation batch applications that execute in the CA IDMS environment. CA ADS Batch applications can read data from input files, perform CA IDMS/DB database update and retrieval, and write data to output files. Note: Do not confuse batch application execution with batch application definition. CA ADS Batch refers to Application Development System applications that execute in the batch environment. CA ADS Batch application components can be defined in online or batch mode. Common Facilities CA ADS Batch uses many of the same facilities as CA ADS, including: ■ The CA IDMS mapping facility, used to define maps through which all transaction input and output is performed. In the CA ADS environment, map definitions control the transfer of data between a terminal operator's screen and dialog variable storage. In the CA ADS Batch environment, map definitions control the transfer of data between input and output files and variable storage. Maps provide extensive automatic editing and error handling features that simplify application development. These features, formerly available only in the online environment, are now also available in the batch environment. ■ The dialog compiler, used to define dialogs that read, process, and write transactions at runtime. ■ The application compiler, used to create a global structure of an application. ■ The runtime system, used to execute applications. ■ The Integrated Data Dictionary (IDD), used to define certain application components, such as process modules and file definitions, and to provide centralized documentation of all application components. The data dictionary also provides automatic cross-referencing of components, reporting facilities, and security features. Chapter 1: Introduction 9 Example 1: Employee-record Archiving Application Differences CA ADS Batch differs from CA ADS mainly in its handling of transaction input and output. Online transactions are typically mapped in and mapped out through a terminal. Batch transactions are typically read from and written to files, such as sequential data sets. Batch Features CA ADS Batch includes the following features in support of the batch runtime environment: ■ Input and output file support──CA ADS Batch provides access to input and output sequential files, such as disk, tape, card, and printer, and to VSAM entry-sequenced data sets (ESDS) that are accessed sequentially. File records can be any type except variable spanned. ■ Suspense file support──CA ADS Batch can write erroneous input file records to a suspense file. After an application has been executed, the user can correct the records in the suspense file, then resubmit them directly in another run of the application. ■ Log file support──CA ADS Batch accumulates in a system log runtime information, such as error messages and dialog statistics. CA ADS Batch provides a log file archiving utility (z/OS), which writes log information to tape when the log file is full. CA ADS Batch also provides a print log utility that prints formatted reports of selected log file information. ■ Process commands──CA ADS Batch uses commands to read from and write to input, output, and log files, and to send messages to the operator's console. Environment test conditions are also included (for example, IF $ONLINE THEN DISPLAY. ..., or, IF $BATCH THEN DO. ...); thus, a process module can be used in both the online and batch environments. Sample Applications The remainder of this chapter introduces two examples of CA ADS Batch applications. These examples are illustrated in detail in CA ADS Batch Sample Applications (see page 143). Example 1: Employee-record Archiving Application The employee-record archiving application writes selected employee records and their associated insurance coverage records from an CA IDMS/DB database to tape. 10 ADS Batch User Guide