Previous Topic: OSCaR to APPC MappingNext Topic: ADSO-APPLICATION-MENU-RECORD


System Records

This section contains the following topics:

Overview

ADSO-APPLICATION-GLOBAL-RECORD

ADSO-APPLICATION-MENU-RECORD

Overview

CA ADS provides the three system records, listed in the table below. This appendix describes ADSO-APPLICATION-GLOBAL-RECORD and ADSO-APPLICATION-MENU-RECORD.

CA ADS System Records

System record

Purpose

ADSO-APPLICATION-GLOBAL-RECORD

Passes information between dialogs in an application

ADSO-APPLICATION-MENU-RECORD

Holds information for the runtime system to use in building menus.

ADSO-STAT-DEF-REC

Associates level-88 condition names with status codes during dialog compilation

ADSO-APPLICATION-GLOBAL-RECORD and ADSO- APPLICATION-MENU-RECORD have fully addressable fields. At runtime, information supplied during application definition is moved to the applicable fields in the system records.

When the fields of a system record are referenced by a dialog, the record must be associated with the dialog as a work or map record. In applications not defined using the application compiler, system records are treated like any other work or map records.

The CA ADS system records ADSO-APPLICATION-GLOBAL-RECORD and ADSO-APPLICATION-MENU-RECORD are discussed separately below.

More information:

Error Handling

ADSO-APPLICATION-GLOBAL-RECORD

ADSO-APPLICATION-GLOBAL-RECORD is automatically associated with an application as a global record, unless the record is explicitly deselected on the Global Records screen while defining the application with the application compiler (ADSA). If ADSO-APPLICATION-GLOBAL-RECORD is deselected, on the Global Records screen, the runtime system does not supply runtime information to the application's dialogs, and dialogs cannot modify runtime flow of control by changing AGR-CURRENT-RESPONSE.

The CA ADS runtime system uses ADSO-APPLICATION- GLOBAL-RECORD in the following ways:

Field Descriptions

AGR-APPLICATION-NAME

Contains the name of the current application, as specified on the Main Menu during application definition.

This field is updated once at the beginning of the application.

AGR-CURRENT-FUNCTION

Contains the name of the current function.

This field is updated at the beginning of each function.

AGR-NEXT-FUNCTION

Contains the name of the next function to be executed. The next function is the function initiated by the response contained in the AGR-CURRENT-RESPONSE field.

This field is updated on mapin from the terminal.

If a process command modifies AGR-CURRENT-RESPONSE to change the flow of control, AGR-NEXT-FUNCTION does not have to be changed. On an EXECUTE NEXT FUNCTION command, the runtime system transfers control to the function associated with the response.

AGR-CURRENT-RESPONSE

Contains the name of the next response to be executed, as specified by the user.

This field is updated on each mapin from the terminal.

The runtime system executes the response in AGR-CURRENT- RESPONSE when it encounters an EXECUTE NEXT FUNCTION command. The value in AGR-CURRENT-RESPONSE can be overwritten by the premap or response process of a dialog function.

Note that if AGR-CURRENT-RESPONSE is modified by a process command, the runtime system does not perform security checking.

AGR-DEFAULT-RESPONSE

Contains the name of the default response (if any) for the current function, as specified on any Function Definition screen with ADSA during application definition.

This field is updated at the beginning of each function. If the function has no default response, AGR-DEFAULT-RESPONSE contains blanks.

AGR-TASK-CODE

Contains the task code entered by the user to initiate the application.

This field is updated once at the beginning of the application.

AGR-EXIT-DIALOG

Contains the name of the user exit dialog (if any) associated with the current function, as specified on the Function Definition screen during application definition.

This field is updated at the beginning of each function, and is blank if the function has no user exit dialog.

AGR-PRINT-DESTINATION

Contains the default print destination for the application, as specified on the Main Menu during application definition.

AGR-PRINT-DESTINATION can be specified in a WRITE PRINTER command to specify a print destination.

This field is updated once at the beginning of the application and is blank if the application has no default print destination.

AGR-DATE

Contains the current date in the format specified by the application developer on the Main Menu during application definition.

This field is updated at the beginning of each premap and response process, and each menu and menu/dialog function.

AGR-USER-ID

Contains the user id passed to ADSO-APPLICATION-GLOBAL- RECORD from the AMR-USER-ID field of ADSO- APPLICATION-MENU-RECORD.

This field is updated after a successful user signon to the application and is blank if signon is unsuccessful or is not performed.

AGR-SECURITY-CODE

Contains the security class associated with the user id, as returned by CA IDMS/DC or DC/UCF following successful execution of a system SIGNON function. AGR-SECURITY-CODE is treated as a 256-bit field, with each bit representing a security class, from 0 to 255. A bit is set to 1 if the user is authorized at that security class, and is set to 0 if the user is not.

AGR-INSTALLATION-CODE

Contains the installation-defined security code associated with the user id, as returned by CA IDMS/DC or DC/UCF following successful execution of a system SIGNON function.

AGR-PASSED-DATA

A group field that consists of the following elements:

AGR-PASSED-ONE

Contains data passed to ADSO-APPLICATION-GLOBAL-RECORD from the AMR-PASSING field of ADSO-APPLICATION-MENU- RECORD on mapin from the terminal.

Note that if the user does not enter data in AMR- PASSING, AGR-PASSED-ONE is not updated.

AGR-PASSED-TWO

A 32-byte field that the application developer can use as applicable.

AGR-PASSED-THREE

A 32-byte field that the application developer can use as applicable.

AGR-PASSED-FOUR

A 32-byte field that the application developer can use as applicable.

The runtime system never updates fields AGR-PASSED-TWO, AGR-PASSED-THREE, and AGR-PASSED-FOUR.

AGR-APPLICATION-VERSION

Contains the version number of the current application, as specified by the application developer on the Main Menu during application definition.

This field is updated once at the beginning of the application.

AGR-APPL-SECURITY-CLASS

Contains the security class associated with the current application, as specified during application definition.

This field is updated once at the beginning of the application.

AGR-RESP-SECURITY-CLASS

Contains the security class associated with the response contained in the AGR-CURRENT-RESPONSE field, as specified on the Response Definition screen during application definition.

This field is updated on mapin from the terminal.

Note that if AGR-CURRENT-RESPONSE is modified by a process command, the runtime system does not perform security checking.

AGR-PRINT-CLASS

Contains the default print class for the application, as specified on the General Options screen during application definition.

AGR-PRINT-CLASS can be specified in a WRITE PRINTER command to specify a print class.

This field is updated once at the beginning of the application and is blank if the application has no default print class.

AGR-MODE

Contains the value passed to ADSO-APPLICATION-GLOBAL- RECORD from the AMR-MODE field of ADSO-APPLICATION- MENU-RECORD. The following level-88 condition names are defined for AGR-MODE:

AGR-STEP-MODE

AGR-MODE contains the value STEP.

AGR-FAST-MODE

AGR-MODE contains the value FAST.

This field is updated at the beginning of the application with the default mode specified on the Main Menu during application definition.

AGR-DATE-FORMAT

Contains a value indicating the date format specified by the application developer on the Main Menu during application definition. The following level-88 condition names are defined for AGR-DATE-FORMAT:

AGR-MMDDYY

AGR-DATE-FORMAT contains the value C.

AGR-DDMMYY

AGR-DATE-FORMAT contains the value E.

AGR-YYMMDD

AGR-DATE-FORMAT contains the value G.

AGR-YYDDD

AGR-DATE-FORMAT contains the value J.

This field is updated once at the beginning of the application.

AGR-AID-BYTE

Contains the AID byte that represents the control key pressed by the user.

A level-88 condition name is defined for each possible value.

AGR-CURRENT-FUNC-TYPE

Contains a value indicating the type of function named in the AGR-CURRENT-FUNCTION field. The following level-88 condition names are defined for AGR-CURRENT-FUNC-TYPE:

AGR-FUNCTION-DIALOG

AGR-CURRENT-FUNC-TYPE contains the value D.

AGR-FUNCTION-MENU

AGR-CURRENT-FUNC-TYPE contains the value M.

AGR-FUNCTION-SIGNON

AGR-CURRENT-FUNC-TYPE contains the value S.

This field is updated at the beginning of each function.

AGR-NEXT-FUNC-TYPE

Contains a value indicating the type of the function named in the AGR-NEXT-FUNCTION field. The following level-88 condition names are defined for AGR-NEXT-FUNC-TYPE:

AGR-NEXT-DIALOG

AGR-NEXT-FUNC-TYPE contains the value D.

AGR-NEXT-MENU

AGR-NEXT-FUNC-TYPE contains the value G.

AGR-NEXT-MENU-DIALOG

AGR-NEXT-FUNC-TYPE contains the value M.

AGR-NEXT-SIGNON

AGR-NEXT-FUNC-TYPE contains the value N.

AGR-NEXT-SIGNON-DIALOG

AGR-NEXT-FUNC-TYPE contains the value S.

AGR-NEXT-PROGRAM

AGR-NEXT-FUNC-TYPE contains the value P.

AGR-NEXT-SYSTEM-FUNC

AGR-NEXT-FUNC-TYPE contains the value F, B, O, U, R, T, or Q.

AGR-NEXT-FORWARD

AGR-NEXT-FUNC-TYPE contains the value F.

AGR-NEXT-BACKWARD

AGR-NEXT-FUNC-TYPE contains the value B.

AGR-NEXT-POP

AGR-NEXT-FUNC-TYPE contains the value O.

AGR-NEXT-POPTOP

AGR-NEXT-FUNC-TYPE contains the value U.

AGR-NEXT-RETURN

AGR-NEXT-FUNC-TYPE contains the value R.

AGR-NEXT-TOP

AGR-NEXT-FUNC-TYPE contains the value T.

AGR-NEXT-QUIT

AGR-NEXT-FUNC-TYPE contains the value Q.

This field is updated on mapin from the terminal.

AGR-CTRL-COMMAND

Contains a value indicating the control command associated with the response named in the AGR-CURRENT-RESPONSE field, as specified on the Response Definition screen during application definition. The following level-88 condition names are defined for AGR-CTRL-COMMAND:

AGR-TRANSFER

AGR-CTRL-COMMAND contains the value T.

AGR-INVOKE

AGR-CTRL-COMMAND contains the value I.

AGR-LINK

AGR-CTRL-COMMAND contains the value L.

AGR-RETURN

AGR-CTRL-COMMAND contains the value R.

This field is updated on mapin from the terminal. If a process command modifies AGR-CURRENT-RESPONSE to change the flow of control, AGR-CTRL-COMMAND does not have to be changed. On an EXECUTE NEXT FUNCTION command, the runtime system uses the control command associated with the response.

AGR-SIGNON-SWITCH

Contains a value indicating whether a system SIGNON function was performed for the current application. The following level-88 condition names are defined for AGR-SIGNON-SWITCH:

AGR-SIGNON-NOT-DONE

AGR-SIGNON-SWITCH contains the value N.

AGR-SIGNON-OK

AGR-SIGNON-SWITCH contains the value Y.

AGR-DIALOG-NAME

Contains the name of the dialog or user program (if any) associated with the function named in the AGR-CURRENT-FUNCTION field.

This field is updated at the beginning of a dialog, menu/dialog, or user program function, and is blank if the function is not associated with a dialog or user program.

AGR-FUNC-DESCRIPTION

Contains the description of the function named in the AGR- CURRENT-FUNCTION field, as specified on the Function Definition screen during application definition.

This field is updated at the beginning of each function and is blank if the function does not contain a description.

AGR-MESSAGE

AGR-MESSAGE is a 240-byte field that the application developer can use, as necessary. The runtime system never updates this field. (This field can be used for pass data.)

AGR-SIGNON-REQMTS

Contains a value indicating the signon requirements for the current application, as specified during application definition. The following level-88 condition names are defined for AGR-SIGNON-REQMTS:

AGR-SIGNON-REQUIRED

AGR-SIGNON-REQMTS contains the value R.

AGR-SIGNON-OPTIONAL

AGR-SIGNON-REQMTS contains the value O.

AGR-SIGNON-NOT-ALLOWED

AGR-SIGNON-REQMTS contains the value N.

This field is updated once at the beginning of the application.

AGR-MAP-RESPONSE

Contains a response name entered by the user in a field that maps to AGR-MAP-RESPONSE. AGR-MAP-RESPONSE performs the same function as a $RESPONSE map field. The application developer can initialize the AGR-MAP-RESPONSE field with a default response name.

If both AGR-MAP-RESPONSE and $RESPONSE are defined for a map, a value in the AGR-MAP-RESPONSE field has precedence over a value entered in the $RESPONSE field. Once the AGR-MAP- RESPONSE field is initialized with a value, that value remains in the AGR-MAP-RESPONSE field until it is reinitialized with a new value either by process code or by the user.

Note: The $RESPONSE map field can also be initialized by process code, through the $RESPONSE system-supplied data field. For more information about the $RESPONSE system-supplied data field, see the CA IDMS Mapping Facility Guide.

Usage

The following example illustrates the role of ADSO-APPLICATION- GLOBAL-RECORD during runtime execution of an application.

During execution of a nonmenu dialog function, the user selects a response that initiates either the FORWARD or BACKWARD system function. The following values are established in ADSO-APPLICATION-GLOBAL-RECORD:

All other fields in the record remain unchanged.

The dialog can now access these fields to do its own paging, provided that ADSO-APPLICATION-GLOBAL-RECORD is defined to the dialog as a work record. (Automatic paging by the runtime system is performed only for menu functions.)

Note: For more information about the use of ADSO-APPLICATION-GLOBAL-RECORD, see the CA ADS Application Design Guide.

More information:

CA ADS Application Compiler (ADSA)

CA ADS Runtime System

Variable Data Fields

ADSO-APPLICATION-GLOBAL-RECORD

One copy of the record is automatically associated with all applications during application definition.

ADSO-APPLICATION-GLOBAL-RECORD is defined in the data dictionary as follows:

01  ADSO-APPLICATION-GLOBAL-RECORD. 
 03  AGR-APPLICATION-NAME    PICTURE IS X(8)   USAGE IS DISPLAY.
 03  AGR-CURRENT-FUNCTION    PICTURE IS X(8)   USAGE IS DISPLAY.
 03  AGR-NEXT-FUNCTION       PICTURE IS X(8)   USAGE IS DISPLAY.
 03  AGR-CURRENT-RESPONSE    PICTURE IS X(8)   USAGE IS DISPLAY.
 03  AGR-DEFAULT-RESPONSE    PICTURE IS X(8)   USAGE IS DISPLAY.
 03  AGR-TASK-CODE           PICTURE IS X(8)   USAGE IS DISPLAY.
 03  AGR-EXIT-DIALOG         PICTURE IS X(8)   USAGE IS DISPLAY.
 03  AGR-PRINT-DESTINATION   PICTURE IS X(8)   USAGE IS DISPLAY.
 03  AGR-DATE                PICTURE IS X(8)   USAGE IS DISPLAY.
 03  AGR-USER-ID             PICTURE IS X(32)  USAGE IS DISPLAY.
 03  AGR-SECURITY-CODE       PICTURE IS X(32)  USAGE IS DISPLAY.
 03  AGR-INSTALLATION-CODE   PICTURE IS X(32)  USAGE IS DISPLAY.
 03  AGR-PASSED-DATA                           USAGE IS DISPLAY.
     05  AGR-PASSED-ONE      PICTURE IS X(32)  USAGE IS DISPLAY.
     05  AGR-PASSED-TWO      PICTURE IS X(32)  USAGE IS DISPLAY.
     05  AGR-PASSED-THREE    PICTURE IS X(32)  USAGE IS DISPLAY.
     05  AGR-PASSED-FOUR     PICTURE IS X(32)  USAGE IS DISPLAY.
 03  AGR-APPLICATION-VERSION PICTURE IS S9(4)  USAGE IS COMP.
 03  AGR-APPL-SECURITY-CLASS PICTURE IS S999   USAGE IS COMP.
 03  AGR-RESP-SECURITY-CLASS PICTURE IS S999   USAGE IS COMP.
 03  AGR-PRINT-CLASS         PICTURE IS S999   USAGE IS COMP.
 03  AGR-MODE                PICTURE IS X(4)   USAGE IS DISPLAY.
     88  AGR-STEP-MODE USAGE IS CONDITION-NAME VALUE IS 'STEP'.
     88  AGR-FAST-MODE USAGE IS CONDITION-NAME VALUE IS 'FAST'.
 03  AGR-DATE-FORMAT         PICTURE IS X      USAGE IS DISPLAY.
     88  AGR-MMDDYY    USAGE IS CONDITION-NAME VALUE IS 'C'.
     88  AGR-DDMMYY    USAGE IS CONDITION-NAME VALUE IS 'E'.
     88  AGR-YYMMDD    USAGE IS CONDITION-NAME VALUE IS 'G'.
     88  AGR-YYDDD     USAGE IS CONDITION-NAME VALUE IS 'J'.
 03  AGR-AID-BYTE            PICTURE IS X      USAGE IS DISPLAY.
     88  AGR-ENTER     USAGE IS CONDITION-NAME VALUE IS QUOTE.
     88  AGR-PF1       USAGE IS CONDITION-NAME VALUE IS '1'.
     88  AGR-PF2       USAGE IS CONDITION-NAME VALUE IS '2'.
     88  AGR-PF3       USAGE IS CONDITION-NAME VALUE IS '3'.
     88  AGR-PF4       USAGE IS CONDITION-NAME VALUE IS '4'.
     88  AGR-PF5       USAGE IS CONDITION-NAME VALUE IS '5'.
     88  AGR-PF6       USAGE IS CONDITION-NAME VALUE IS '6'.
     88  AGR-PF7       USAGE IS CONDITION-NAME VALUE IS '7'.
     88  AGR-PF8       USAGE IS CONDITION-NAME VALUE IS '8'.
     88  AGR-PF9       USAGE IS CONDITION-NAME VALUE IS '9'.
     88  AGR-PF10      USAGE IS CONDITION-NAME VALUE IS ':'.
     88  AGR-PF11      USAGE IS CONDITION-NAME VALUE IS '#'.
     88  AGR-PF12      USAGE IS CONDITION-NAME VALUE IS '@'.
     88  AGR-PF13      USAGE IS CONDITION-NAME VALUE IS 'A'.
     88  AGR-PF14      USAGE IS CONDITION-NAME VALUE IS 'B'.
     88  AGR-PF15      USAGE IS CONDITION-NAME VALUE IS 'C'.
     88  AGR-PF16      USAGE IS CONDITION-NAME VALUE IS 'D'.
     88  AGR-PF17      USAGE IS CONDITION-NAME VALUE IS 'E'.
     88  AGR-PF18      USAGE IS CONDITION-NAME VALUE IS 'F'.
     88  AGR-PF19      USAGE IS CONDITION-NAME VALUE IS 'G'.
    88  AGR-PF20      USAGE IS CONDITION-NAME VALUE IS 'H'.
    88  AGR-PF21      USAGE IS CONDITION-NAME VALUE IS 'I'.
    88  AGR-PF22      USAGE IS CONDITION-NAME VALUE IS '&cent.'.
    88  AGR-PF23      USAGE IS CONDITION-NAME VALUE IS '.'.
    88  AGR-PF24      USAGE IS CONDITION-NAME VALUE IS '<'.
    88  AGR-PA1       USAGE IS CONDITION-NAME VALUE IS '%'.
    88  AGR-PA2       USAGE IS CONDITION-NAME VALUE IS '>'.
    88  AGR-PA3       USAGE IS CONDITION-NAME VALUE IS ','.
    88  AGR-CLEAR     USAGE IS CONDITION-NAME VALUE IS '_'.
    88  AGR-LPEN      USAGE IS CONDITION-NAME VALUE IS '='.
    88  AGR-EOF       USAGE IS CONDITION-NAME VALUE IS 'N'.
    88  AGR-IOERR     USAGE IS CONDITION-NAME VALUE IS 'O'.
    88  AGR-SERR      USAGE IS CONDITION-NAME VALUE IS 'P'.
    88  AGR-IERR      USAGE IS CONDITION-NAME VALUE IS 'R'.
    88  AGR-OERR      USAGE IS CONDITION-NAME VALUE IS 'S'.
03  AGR-CURRENT-FUNC-TYPE   PICTURE IS X      USAGE IS DISPLAY.
    88  AGR-FUNCTION-DIALOG    USAGE IS CONDITION-NAME
                                              VALUE IS 'D'.
    88  AGR-FUNCTION-MENU      USAGE IS CONDITION-NAME
                                              VALUE IS 'M'.
    88  AGR-FUNCTION-SIGNON    USAGE IS CONDITION-NAME
                                              VALUE IS 'S'.
03  AGR-NEXT-FUNC-TYPE      PICTURE IS X      USAGE IS DISPLAY.
    88  AGR-NEXT-DIALOG  USAGE IS CONDITION-NAME VALUE IS 'D'.
    88  AGR-NEXT-MENU    USAGE IS CONDITION-NAME VALUE IS 'G'.
    88  AGR-NEXT-MENU-DIALOG   USAGE IS CONDITION-NAME
                                                 VALUE IS 'M'.
    88  AGR-NEXT-SIGNON  USAGE IS CONDITION-NAME VALUE IS 'N'.
    88  AGR-NEXT-SIGNON-DIALOG USAGE IS CONDITION-NAME
                                                 VALUE IS 'S'.
    88  AGR-NEXT-PROGRAM USAGE IS CONDITION-NAME VALUE IS 'P'.
    88  AGR-NEXT-SYSTEM-FUNC USAGE IS CONDITION-NAME
                                                 VALUE IS 'F'
                                                 VALUE IS 'B'
                                                 VALUE IS 'O'
                                                 VALUE IS 'U'
                                                 VALUE IS 'R'
                                                 VALUE IS 'T'
                                                 VALUE IS 'Q'.
    88  AGR-NEXT-FORWARD USAGE IS CONDITION-NAME VALUE IS 'F'.
    88  AGR-NEXT-BACKWARD USAGE IS CONDITION-NAME VALUE IS 'B'.
    88  AGR-NEXT-POP     USAGE IS CONDITION-NAME VALUE IS 'O'.
    88  AGR-NEXT-POPTOP  USAGE IS CONDITION-NAME VALUE IS 'U'.
    88  AGR-NEXT-RETURN  USAGE IS CONDITION-NAME VALUE IS 'R'.
    88  AGR-NEXT-TOP     USAGE IS CONDITION-NAME VALUE IS 'T'.
    88  AGR-NEXT-QUIT    USAGE IS CONDITION-NAME VALUE IS 'Q'.
03  AGR-CTRL-COMMAND        PICTURE IS X      USAGE IS DISPLAY.
    88  AGR-TRANSFER     USAGE IS CONDITION-NAME VALUE IS 'T'.
    88  AGR-INVOKE       USAGE IS CONDITION-NAME VALUE IS 'I'.
    88  AGR-LINK         USAGE IS CONDITION-NAME VALUE IS 'L'.
    88  AGR-RETURN       USAGE IS CONDITION-NAME VALUE IS 'R'.
03  AGR-SIGNON-SWITCH       PICTURE IS X      USAGE IS DISPLAY
                                              VALUE IS 'N'.
    88  AGR-SIGNON-NOT-DONE    USAGE IS CONDITION-NAME
                                                 VALUE IS 'N'.
    88  AGR-SIGNON-OK    USAGE IS CONDITION-NAME VALUE IS 'Y'.
03  AGR-DIALOG-NAME         PICTURE IS X(8)   USAGE IS DISPLAY.
03  AGR-FUNC-DESCRIPTION    PICTURE IS X(28)  USAGE IS DISPLAY.
03  AGR-MESSAGE             PICTURE IS X(240) USAGE IS DISPLAY.
03  AGR-SIGNON-REQMTS       PICTURE IS X      USAGE IS DISPLAY.
    88  AGR-SIGNON-REQUIRED    USAGE IS CONDITION-NAME
                                                 VALUE IS 'R'.
    88  AGR-SIGNON-OPTIONAL    USAGE IS CONDITION-NAME
                                                 VALUE IS 'O'.
    88  AGR-SIGNON-NOT-ALLOWED USAGE IS CONDITION-NAME
                                                 VALUE IS 'N'.
03  AGR-MAP-RESPONSE        PICTURE IS X(8)   USAGE IS DISPLAY.
03  FILLER                  PICTURE IS X(54)  USAGE IS DISPLAY.

ADSO-APPLICATION-MENU-RECORD

The CA ADS runtime system builds menus by storing information in ADSO-APPLICATION-MENU-RECORD. This record is associated with maps used by menu and menu/dialog functions.

The menu map can be system-defined or user-defined. If a menu map is user-defined, ADSO-APPLICATION-MENU-RECORD must be explicitly associated with the map when it is defined.

Usage

In a menu/dialog function, ADSO-APPLICATION-MENU-RECORD is initialized at the beginning of the dialog, and its fields are primed by the runtime system when the map is displayed.

Thus, for example, at the beginning of a menu/dialog, AMR-PASSING does not contain any value passed by the previous menu function (AGR-PASSED-ONE of ADSO-APPLICATION-GLOBAL- RECORD does); and any value moved to a field in ADSO- APPLICATION-MENU-RECORD will be overwritten when the menu map is displayed.

Field Descriptions

AMR-PAGE

Maps to the PAGE field.

AMR-PAGE contains the number of the currently displayed page of the menu screen.

AMR-TOTAL-PAGES

Maps to the OF field.

AMR-TOTAL-PAGES contains the total number of pages for the current menu.

AMR-NEXT-PAGE

Maps to the NEXT PAGE field.

AMR-NEXT-PAGE contains the number of the next page to be displayed, as entered by the user.

AMR-HEADING

(or AMR-HDG) Maps to the heading text area.

AMR-HEADING or AMR-HDG contains the heading text specified by the application developer on the Function Definition (Menu) screen during application definition.

AMR-DATE

Maps to the DATE field.

AMR-DATE contains the current date in the format specified by the application developer on the General Options screen during application definition.

AMR-DIALOG

Maps to the DIALOG field.

If the current menu is associated with a dialog, AMR-DIALOG contains the name of the menu/dialog, as specified on the Response/Function List screen during application definition.

AMR-RESPONSE-FIELD

Maps to the RESPONSE field.

AMR-RESPONSE-FIELD contains the name of the next response to be executed, as entered by the user.

AMR-RESPONSE-FIELD is initialized with the default response for the current function (if any), as specified on the Function Definition screen during application definition. If the user does not specify a response, the default response remains in AMR-RESPONSE-FIELD.

AMR-MODE

Maps to the MODE field.

MODE contains the execution mode for the function, as specified on the Main Menu during application definition. At runtime, the user can change the specification in the MODE field on a menu map, thereby modifying the value in AMR-MODE. The value in AMR-MODE is passed to the AGR-MODE field of ADSO- APPLICATION-GLOBAL-RECORD each time the menu is mapped in.

AMR-PASSING

Maps to the SEND DATA field.

AMR-PASSING contains data to be passed to the next function, as entered by the user. CA ADS transfers the contents of AMR-PASSING to the AGR-PASSED-ONE field of ADSO- APPLICATION-GLOBAL-RECORD. The runtime system reinitializes the AMR-PASSING field each time the menu is mapped out.

AMR-USER-ID

Maps to the ENTER USER ID field of a signon menu.

AMR-USER-ID contains the user id entered by the user.

CA ADS transfers the contents of AMR-USER-ID to the AGR- USER-ID field of ADSO-APPLICATION-GLOBAL-RECORD. If a system SIGNON function is initiated, the runtime system passes the value in AMR-USER-ID to CA IDMS/DC or DC/UCF (DC/UCF) for security verification.

AMR-PASSWORD

Maps to the PASSWORD field of a signon menu.

AMR-PASSWORD contains the password entered by the user.

If a system SIGNON function is initiated, the runtime system passes the value in AMR-PASSWORD to DC/UCF for security verification. After passing the value, CA ADS overwrites the AMR-PASSWORD field with blanks.

AMR-SELECT-SECTION

Maps to the response listing area.

AMR-SELECT-SECTION is a group field that occurs 50 times.

Each valid response associated with the current function is moved to an occurrence of AMR-SELECT-SECTION. The occurrences are mapped out to the menu screen one page at a time.

Each occurrence of AMR-SELECT-SECTION consists of the following elements:

AMR-SELECT

Contains the character entered by the user in the one-byte field provided to select the response.

AMR-RESPONSE

Contains the name of the response, as specified on the Response/Function List screen during application definition.

AMR-KEY

Contains the AID byte representing the control key that initiates the response, as specified on the Response/Function List screen during application definition.

AMR-KEY is translated by a code table to a five-byte map field in order to display the associated control key.

AMR-DESCRIPTION

Contains the description of the response, as specified on the Response Definition screen during application definition.

More information:

CA ADS Application Compiler (ADSA)

CA ADS Runtime System