Variable Data Fields › System-Supplied Data Field Names

System-Supplied Data Field Names

Purpose

System-supplied data field names specify variable data fields supplied by the CA ADS runtime system.

Syntax

►►───────┬─ + ◄─┬───┬─ DIRECT-DBKEY ────────────┬────────────────────────────►◄
         └─ - ──┘   ├─ DB-NAME ─────────────────┤
                    ├─ NODE-NAME ───────────────┤
                    ├─ agr-data-field ──────────┤
                    ├─ amr-data-field ──────────┤
                    ├─ $RESPONSE ───────────────┤
                    ├─ $PAGE ───────────────────┤
                    ├─ LENGTH (map-field-name) ─┤
                    ├─ CURSOR-ROW ──────────────┤
                    ├─ CURSOR-COLUMN ───────────┤
                    ├─ ERROR-STATUS ────────────┤
                    ├─ JULIAN ──────────────────┤
                    ├─ JULIANX ─────────────────┤
                    ├─ DATE ────────────────────┤
                    ├─ DATEX ───────────────────┤
                    ├─ TIME ────────────────────┤
                    ├─┬─ $ERROR-COUNT ─┬────────┤
                    │ └─ $ERRCNT ──────┘        │
                    ├─┬─ $INPUT-COUNT ─┬────────┤
                    │ └─ $INCNT ───────┘        │
                    └─┬─ $OUTPUT-COUNT ─┬───────┘
                      └─ $OUTCNT ───────┘

Parameters

+/-

Specifies the unary operator to precede a numeric data field.

A plus sign (+) does not change the sign of the data field.

A minus sign (-) multiplies the data field by -1.

+ is the default when neither + or - is specified.

A unary operator can be used when the data field is specified as part of an arithmetic expression

DIRECT-DBKEY

References a binary fullword field that contains the database key of the record being stored.

DIRECT-DBKEY is used in conjunction with a STORE operation when the location mode of the record being stored is DIRECT.

DB-NAME/NODE-NAME

Establish the database name and Distributed Database System (DDS) node name used for database commands at runtime. DB-NAME and NODE-NAME allow access to multiple databases under a DC/UCF system. When used, DB-NAME and NODE-NAME must be set before the first database command is issued for the run unit.

When dialog execution begins, DB-NAME and NODE-NAME are initialized to spaces. Database names and DDS node names that are moved to these fields within a process are propagated downward to all lower level dialogs. In this way, a dialog can access a database other than the subschema default.

DB-NAME and NODE-NAME can also be specified when the runtime system is initiated,

agr-data-field

Represents a data field provided in the ADSO-APPLICATION- GLOBAL-RECORD.

This record supplies runtime information in applications created by the CA ADS application compiler (ADSA).

amr-data-field

Represents a data field provided in the ADSO-APPLICATION- MENU-RECORD.

The ADSO-APPLICATION-MENU-RECORD contains information used to build menus in applications created by the CA ADS application compiler.

$RESPONSE

References the 32-character $RESPONSE field of a map.

Any value moved to $RESPONSE appears in the map's $RESPONSE field when the map is displayed. On mapin, the value in the $RESPONSE field is considered by the runtime system in its selection of a dialog response process or an application function.

Once a response is selected, the $RESPONSE field is cleared.

Note: For more information about the $RESPONSE map field, see the CA IDMS Mapping Facility Guide.

$PAGE

References the $PAGE field of a map.

$PAGE determines the page displayed when a pageable map is mapped out to the terminal. Values are assigned to $PAGE, as follows:

• At the beginning of a map paging session, $PAGE is initialized to zero.
• Arithmetic and assignment process commands can modify $PAGE.
• When a map is displayed, if $PAGE is greater than the map's highest page number or less than its lowest page number, $PAGE is set to the highest or lowest page number.

  Note: The lowest page number can be greater than zero when backpaging is not allowed.

• If the user presses a control key associated with paging forward or backward, $PAGE is incremented or decremented by 1, unless it is already equal to the highest or lowest page number.
• If the user modifies the $PAGE field displayed on the screen and presses a control key other than the paging forward key or paging backward key, and other than [Clear], [PA1], [PA2], or [PA3] (which do not transmit data), $PAGE is assigned the modified value. If the new value is higher than the highest page number or lower than the lowest page number, $PAGE is set to the highest or lowest page number.
• A GET DETAIL process command assigns $PAGE the page number of the retrieved detail occurrence. If no detail occurrence is retrieved, $PAGE is not changed.

Note: For more information about the $PAGE map field, see the CA IDMS Mapping Facility Guide.

LENGTH

Represents the halfword binary value equal to the number of characters entered into the named map field.

map-field-name

The name of a data field used by the dialog's map, enclosed in parentheses.

CURSOR-ROW

Represents the halfword binary value equal to the cursor row position on the dialog's map following the mapin operation.

CURSOR-COLUMN

Represents the halfword binary value equal to the cursor column position on the dialog's map following the mapin operation.

ERROR-STATUS

Represents the 4-byte EBCDIC value equal to the most recent status code returned to the dialog.

JULIAN

References a signed packed decimal field that contains the current date in the format yyddd.

JULIAN is updated before the execution of each premap and response process.

JULIANX

References a signed packed decimal field that contains the current date in the format yyyyddd.

JULIANX is updated before the execution of each premap and response process.

DATE

References an unsigned zoned decimal field that contains the current date in the format yymmdd.

DATE is updated before the execution of each premap and response process.

DATEX

References an unsigned zoned decimal field that contains the current date in the format yyyymmdd.

DATEX is updated before the execution of each premap and response process.

TIME

References an unsigned zoned decimal field that contains the time in the format hhmmss.

TIME is updated before the execution of each premap and response process.

$ERROR-COUNT

(CA ADS Batch only) Contains the number of input records that have been written to the suspense file for the current dialog.

$ERRCNT can be used in place of $ERROR-COUNT.

Note: Data cannot be moved into $ERROR-COUNT.

If a record is written to the suspense file but a suspense file was not allocated for the dialog, nothing is written, but $ERROR-COUNT is still incremented.

$INPUT-COUNT

(CA ADS Batch only) Contains the number of input records read for the current dialog.

$INCNT can be used in place of $INPUT-COUNT.

Note: Data cannot be moved into $INPUT-COUNT.

$OUTPUT-COUNT

(CA ADS Batch only) Contains the number of output records written for the current dialog.

$OUTCNT can be used in place of $OUTPUT-COUNT.

Note: Data cannot be moved into $OUTPUT-COUNT.

Usage

System-supplied data fields are provided automatically for use by a dialog, except for fields in the ADSO-APPLICATION-GLOBAL- RECORD and the ADSO-APPLICATION-MENU-RECORD. To use these system record fields in a dialog, the records must be associated with the dialog.

All system-supplied data fields can be used as source fields in process commands. The following fields can also be used as target fields:

• DIRECT-DBKEY
• DB-NAME
• NODE-NAME
• Fields in ADSO-APPLICATION-GLOBAL-RECORD
• Fields in ADSO-APPLICATION-MENU-RECORD
• $RESPONSE
• $PAGE

System-supplied data fields for batch processing ($ERROR-COUNT, $INPUT-COUNT, $OUTPUT-COUNT) count the suspense, input, and output file records read or written by each dialog. A field is set to zero when the file it describes is opened. If an input file is opened, closed, then reopened, the field is reset to zero when the file is reopened. Data from these fields can be moved to other data fields, but data cannot be moved into the system-supplied fields.

Example 1: Using the DB-NAME and NODE-NAME fields

This example uses the DB-NAME and NODE-NAME fields to establish IDMSNWKZ as an alternative database for a dialog. SYSTEM99 is named as the DDS node that controls IDMSNWKZ. All lower level dialogs access IDMSNWKZ and SYSTEM99 unless another database is established in a lower level dialog:

MOVE 'IDMSNWKZ' TO DB-NAME.
MOVE 'SYSTEM99' TO NODE-NAME.

Note: The database and DDS node cannot be changed at a lower level if the processing is part of an extended run unit.

Example 2: Displaying a value in the $RESPONSE field

This example causes ADD to appear in the $RESPONSE field of a displayed map:

MOVE 'ADD' TO $RESPONSE.
DISPLAY.

Example 3: Using $PAGE to display a specified map page

This example displays page 10 of a pageable map:

MOVE 10 TO $PAGE.
DISPLAY.

More information:

System Records

CA ADS Runtime System

Control Commands

Initiating the CA ADS Runtime System

Map Commands