CA ADS for CA IDMS ADS Reference Guide - CA Technologies

770 Pages·2014·5.23 MB·English

CA ADS™ for CA IDMS™
ADS Reference Guide
Release 18.5.00, 2nd Edition
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 © 2014 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 (DC)
■ CA IDMS™/DC or CA IDMS™ UCF (DC/UCF)
■ CA IDMS™ OLQ

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.
Documentation Changes
The following documentation updates were made for the 18.5.00, 2nd Edition release of
this documentation:
■ DISPLAY (see page 334)—Updated the syntax diagram.
The following documentation updates were made for the 18.5.00 release of this
documentation:
■ Overview of ACCEPT (see page 373)—Added information to the ACCEPT sections to
document the new page-info parameter.
■ Extended Run Units (see page 143), Overview of Navigational Database Access (see
page 365), READY (see page 423)—Added information concerning the use of the
new FORCE option.
■ APPCCODE and APPCERC (see page 553)—Added an overview table summarizing
the APPCCODEs.
■ Runtime Error-Status Codes (see page 737)—This appendix was newly added,
previously it was available in the ADS Quick Reference Guide.
■ Online Debugger Syntax (see page 751)—This appendix was newly added,
previously it was available in the ADS Quick Reference Guide.
Contents

Chapter 1: Introduction to CA ADS 19
Introduction .................................................................................................................................................................................. 19
Syntax Diagram Conventions ..................................................................................................................................................... 19
What is CA ADS? ........................................................................................................................................................................... 21
What CA ADS Does....................................................................................................................................................................... 22
Creating a CA ADS Application ................................................................................................................................................... 23
Tools Used To Develop an Application ..................................................................................................................................... 24
The CA ADS Application Compiler (ADSA) ....................................................................................................................... 25
Mapping Facilities (MAPC and the Batch Compiler/Utility) ......................................................................................... 27
CA ADS Dialog Compilers (ADSC and ADSOBCOM) ........................................................................................................ 28
IDD Menu Facility and Online IDD..................................................................................................................................... 30
The CA ADS Runtime System.............................................................................................................................................. 31
CA ADS Screens............................................................................................................................................................................. 31
Action Bar .............................................................................................................................................................................. 33
Action Bar Actions ................................................................................................................................................................ 35
Checkout and Release Procedures............................................................................................................................................ 44
How to check out or release an entity ............................................................................................................................. 45
Listing Checkouts (ADSL)..................................................................................................................................................... 47
Modifying Checkouts (ADSM) ............................................................................................................................................ 48
CA ADS Help Facility..................................................................................................................................................................... 48
Chapter 2: CA ADS Application Compiler (ADSA) 51
Overview ........................................................................................................................................................................................ 51
Application Compiler Session..................................................................................................................................................... 51
Invoking the Application Compiler.................................................................................................................................... 52
Sequencing Through Application Compiler Screens ...................................................................................................... 53
Suspending a Session........................................................................................................................................................... 56
Terminating a Session.......................................................................................................................................................... 57
Application Compiler Screens .................................................................................................................................................... 57
Main Menu ............................................................................................................................................................................ 57
General Options Screen—Page 1 ...................................................................................................................................... 60
General Options Screen—Page 2 ...................................................................................................................................... 63
Response/Function List Screen.......................................................................................................................................... 66
Response Definition Screen................................................................................................................................................ 70
Function Definition (Dialog) Screen .................................................................................................................................. 74
Function Definition (Program) Screen .............................................................................................................................. 77
Contents 5
Function Definition (Menu) Screen................................................................................................................................... 80
Global Records Screen......................................................................................................................................................... 85
Task Codes Screen................................................................................................................................................................ 87
Chapter 3: CA ADS Dialog Compiler (ADSC) 91
Overview ........................................................................................................................................................................................ 91
Dialog Compiler Session.............................................................................................................................................................. 92
Invoking the Dialog Compiler ............................................................................................................................................. 92
Sequencing Through Dialog Compiler Screens ............................................................................................................... 94
Suspending a Session........................................................................................................................................................... 97
Terminating a Session.......................................................................................................................................................... 98
Dialog Compiler Screens ............................................................................................................................................................. 98
Main Menu ............................................................................................................................................................................ 98
Options and Directives Screen .........................................................................................................................................101
Map Specifications Screen................................................................................................................................................105
Database Specifications Screen .......................................................................................................................................109
Records and Tables Screen ...............................................................................................................................................111
Process Modules Screen ...................................................................................................................................................114
Chapter 4: CA ADS Runtime System 119
Initiating the CA ADS Runtime System ...................................................................................................................................119
How to Define Runtime Tasks..........................................................................................................................................119
How to Start a CA ADS Application .................................................................................................................................120
Runtime Menu and Help Screens............................................................................................................................................124
Menu Screens .....................................................................................................................................................................124
Site-Defined Menu Maps ..................................................................................................................................................126
System-Defined Menu Maps............................................................................................................................................126
Application Help Screen ....................................................................................................................................................133
Runtime Flow Of Control ..........................................................................................................................................................135
Effects of Automatic Editing on Flow of Control ..........................................................................................................139
Message Prefixes........................................................................................................................................................................140
CA ADS Tasks, Run Units, and Transactions ..........................................................................................................................141
Run units and database access ........................................................................................................................................142
Extended Run Units ...........................................................................................................................................................143
Dialog Abort Information Screen.............................................................................................................................................145
Debugging a Dialog ....................................................................................................................................................................148
Linking From CA ADS To CA OLQ .............................................................................................................................................149
Linking to CA OLQ...............................................................................................................................................................149
Passing Syntax to CA OLQ .................................................................................................................................................149
Linking Built-In Functions With The Runtime System..........................................................................................................150
ADSOVCON Module Creation ..........................................................................................................................................150
6 ADS Reference Guide
Managing Storage ......................................................................................................................................................................151
Adjusting Record Compression........................................................................................................................................151
Calculating RBB Storage ....................................................................................................................................................152
Writing Resources to Scratch Records ...........................................................................................................................152
Using XA Storage ................................................................................................................................................................153
Chapter 5: Introduction to Process Language 155
Overview ......................................................................................................................................................................................155
Process Modules ........................................................................................................................................................................156
Creating Process Modules ................................................................................................................................................156
Adding Process Modules to Dialogs................................................................................................................................157
Executing Process Modules ..............................................................................................................................................157
Process Commands ....................................................................................................................................................................159
Constructing Commands...................................................................................................................................................159
Coding Considerations.......................................................................................................................................................160
Data Types ...................................................................................................................................................................................161
Conversion Between Data Types.....................................................................................................................................167
Chapter 6: Arithmetic Expressions 171
Overview ......................................................................................................................................................................................171
Syntax ...........................................................................................................................................................................................171
Syntax: Arithmetic-Expression .........................................................................................................................................172
Evaluation Of Arithmetic Expressions ....................................................................................................................................173
Evaluation of Arithmetic Expressions .............................................................................................................................174
Coding Considerations...............................................................................................................................................................174
Chapter 7: Built-in Functions 175
Overview ......................................................................................................................................................................................177
Invocation Names ..............................................................................................................................................................178
Built-In Function Values ....................................................................................................................................................178
Coding Parameters.............................................................................................................................................................179
User-Defined Built-In Functions ..............................................................................................................................................179
System-Supplied Functions ......................................................................................................................................................179
Arithmetic Functions .........................................................................................................................................................179
Date Functions ....................................................................................................................................................................180
Date-Time Stamp Functions .............................................................................................................................................181
String Functions ..................................................................................................................................................................182
Trailing-Sign Functions ......................................................................................................................................................183
Trigonometric Functions ...................................................................................................................................................184
ABSOLUTE-VALUE.......................................................................................................................................................................185
Contents 7
ARC COSINE .................................................................................................................................................................................186
ARC SINE ......................................................................................................................................................................................187
ARC TANGENT .............................................................................................................................................................................188
CONCATENATE............................................................................................................................................................................189
COSINE .........................................................................................................................................................................................190
DATECHG .....................................................................................................................................................................................191
DATEDIF .......................................................................................................................................................................................194
DATEEXT.......................................................................................................................................................................................196
DATEINT .......................................................................................................................................................................................196
DATEOFF ......................................................................................................................................................................................197
DATETIMX ....................................................................................................................................................................................199
DISPDT ..........................................................................................................................................................................................199
DTINT ............................................................................................................................................................................................200
EXTRACT.......................................................................................................................................................................................201
FIX..................................................................................................................................................................................................202
GOODDATE ..................................................................................................................................................................................203
GOODTRAILING...........................................................................................................................................................................204
INITCAP ........................................................................................................................................................................................205
INSERT ..........................................................................................................................................................................................206
INVERT-SIGN................................................................................................................................................................................207
LEFT-JUSTIFY................................................................................................................................................................................208
LIKE................................................................................................................................................................................................209
LOGARITHM.................................................................................................................................................................................210
MODULO ......................................................................................................................................................................................211
NEXT-INT-EQHI............................................................................................................................................................................212
NEXT-INT-EQLO...........................................................................................................................................................................213
NUMERIC .....................................................................................................................................................................................214
RANDOM-NUMBER....................................................................................................................................................................216
REPLACE .......................................................................................................................................................................................218
RIGHT-JUSTIFY.............................................................................................................................................................................219
SIGN-VALUE.................................................................................................................................................................................220
SINE...............................................................................................................................................................................................220
SOCKET .........................................................................................................................................................................................221
SQUARE-ROOT ............................................................................................................................................................................223
STRING-INDEX .............................................................................................................................................................................223
STRING-LENGTH..........................................................................................................................................................................224
STRING-REPEAT ..........................................................................................................................................................................225
SUBSTRING ..................................................................................................................................................................................226
TANGENT .....................................................................................................................................................................................228
TIMEEXT .......................................................................................................................................................................................229
TIMEINT........................................................................................................................................................................................230
TODAY ..........................................................................................................................................................................................231
8 ADS Reference Guide
TOLOWER.....................................................................................................................................................................................232
TOMORROW ...............................................................................................................................................................................233
TOUPPER ......................................................................................................................................................................................234
TRAILING-TO-ZONED .................................................................................................................................................................235
TRANSLATE ..................................................................................................................................................................................236
VERIFY...........................................................................................................................................................................................237
WEEKDAY .....................................................................................................................................................................................238
WORDCAP....................................................................................................................................................................................240
YESTERDAY ..................................................................................................................................................................................241
ZONED-TO-TRAILING .................................................................................................................................................................242
Chapter 8: Conditional Expressions 245
Overview ......................................................................................................................................................................................245
General Considerations.............................................................................................................................................................246
Syntax for Conditional Expressions .................................................................................................................................247
Batch-Control Event Condition ................................................................................................................................................248
Command Status Condition......................................................................................................................................................249
Comparison Condition...............................................................................................................................................................251
Cursor Position Condition .........................................................................................................................................................253
Dialog Execution Status Condition ..........................................................................................................................................254
Environment Status Condition.................................................................................................................................................256
Level-88 Condition .....................................................................................................................................................................257
Map Field Status Condition ......................................................................................................................................................257
Map Paging Status Conditions .................................................................................................................................................261
Set Status Condition ..................................................................................................................................................................265
Arithmetic and Assignment Command Status Condition....................................................................................................266
Chapter 9: Constants 269
Overview ......................................................................................................................................................................................269
Figurative Constants ..................................................................................................................................................................269
Graphic Literals ...........................................................................................................................................................................271
Multibit Binary Constants .........................................................................................................................................................272
Nonnumeric Literals...................................................................................................................................................................273
Numeric literals ..........................................................................................................................................................................273
Chapter 10: Error Handling 277
Overview ......................................................................................................................................................................................277
The Autostatus Facility ..............................................................................................................................................................278
Status Codes Returned by the Autostatus Facility .......................................................................................................279
Error Expressions........................................................................................................................................................................279
Contents 9
The ALLOWING Clause ..............................................................................................................................................................280
Status Definition Records .........................................................................................................................................................281
ADSO-STAT-DEF-REC..........................................................................................................................................................284
Chapter 11: Variable Data Fields 285
Overview ......................................................................................................................................................................................285
User-Defined Data Field Names ..............................................................................................................................................285
System-Supplied Data Field Names ........................................................................................................................................287
Entity Names ...............................................................................................................................................................................293
Chapter 12: Introduction to Process Commands 295
Overview ......................................................................................................................................................................................295
Summary Of Process Commands ............................................................................................................................................296
INCLUDE .......................................................................................................................................................................................300
Dialog Compiler Directive .................................................................................................................................................301
Chapter 13: Arithmetic and Assignment Commands 303
Overview ......................................................................................................................................................................................303
General Considerations.............................................................................................................................................................304
Numeric Fields ....................................................................................................................................................................304
EBCDIC and DBCS Fields ....................................................................................................................................................304
Arithmetic and Assignment Command Status Condition............................................................................................305
Arithmetic Commands...............................................................................................................................................................306
ADD .......................................................................................................................................................................................306
COMPUTE ............................................................................................................................................................................307
DIVIDE...................................................................................................................................................................................309
MULTIPLY .............................................................................................................................................................................311
SUBTRACT ............................................................................................................................................................................313
Assignment Command ..............................................................................................................................................................314
MOVE....................................................................................................................................................................................315
Chapter 14: Conditional Commands 317
Overview ......................................................................................................................................................................................317
EXIT ...............................................................................................................................................................................................318
IF ....................................................................................................................................................................................................319
NEXT .............................................................................................................................................................................................321
WHILE ...........................................................................................................................................................................................322
10 ADS Reference Guide