Reporting Facility Commands › FILE Command › CA Datacom/DB Table Definition

CA Datacom/DB Table Definition

This format of the FILE command defines the physical attributes of a CA Datacom/DB input table. The command is coded as follows:

►►─ filename: ─┬─ INPUT ─┬─ DATACOM ─ RECORD=nnn ─┬───────────────┬───────────►
               └─ FILE ──┘                        └─ NAME=dbname ─┘

 ►─┬─────────────┬────────────────────────────────────────────────────────────►◄
   └─ DBID=dbid ─┘

filename:

Is a unique identifier within the Reporting Facility program. The Reporting Facility automatically generates a one-character alphanumeric field with the same name as the table name. It is used as a return code in conjunction with the GET command.

RECORD=nnn

Indicates the combined size of all the elements to be retrieved from the CA Datacom/DB table, plus an additional 300 characters used for communication with CA Datacom/DB. The system reserves the 300 characters of control information as the first 300 characters of the I/O record area.

The subsequent Format 1 DEFINE commands must define all data to be returned as being relative to position 301. The reserved 300-character area has a specific format, and you must complete it prior to any access to the database.

The following details the format of the I/O area as required by the CA Datacom/DB Interface program:

1-5

5-character CA Datacom/DB command

6-10

5-character key name by which access is requested

11-190

Maximum 180-character key value for specific key requests

191-285

Maximum 15-element list, specifying the CA Datacom/DB elements to be returned

286-292

7-character CA Datacom/DB record ID, in the format FFTTTRL

293-300

Filler, reserved for future use

301-nnn

Returned elements

NAME=dbname

Specifies the three-character CA Datacom/DB table name for the CA Datacom/DB table to be accessed. This parameter is optional. If omitted, the first three characters of the filename are used.

Note: For partitioned tables, the CA Datacom/DB Reporting Facilitysupports full parent tables orthe child (table partition) tables.

DBID=dbid

Specifies the numeric database ID in which the table to be accessed resides. If coded, it must specify a positive integer in the range 1—5000.

Note the following:

• The CA Datacom/DB Reporting Facility interface program performs all database table handling and the contents of the 300-character reserved portion of the I/O area directs processing.
• The CA Datacom/DB commands currently supported (in bytes 1-5 of the I/O area) are:

REDKY has been superseded by REDKX, REDLE is no longer required as a priming read, and REDID should not be used if the URI option is elected. The first GETITs will read the next record in key sequence unless and until another GSETL is encountered. The KEY= value in bytes 11—190 of the I/O area must accompany those commands that require a key value. Supply the key name in positions 6—10 of the I/O area for all CA Datacom/DB requests. It must match the key name defined in the Control File.

• Supply the element list in positions 191—285 of the I/O area prior to issuing a GET to the database table. You must initialize it according to normal CA Datacom/DB rules.

Example

 xxxxxs....

xxxxx

A five-character element name.

s

A one-character security code.

Both are defined in the Control File.

Note the following:

• Five consecutive blanks terminate the list.
• The internal record ID of the current record in the I/O buffer is always updated in positions 286-292 of the I/O buffer after each request to CA Datacom/DB is completed. The record ID is in the format FFTTTRL.
• When a GETIT command is the first command requested for a CA Datacom/DB table, the Reporting Facility automatically issues a GSETL command internally. This defaults to positioning at the front of the file.
• When an explicit GSETL command is encountered, the Reporting Facility first performs the GSETL, then performs an implied GETIT to retrieve the data record for the key value specified.
• When the system processes any LOC command, the Reporting Facility updates the appropriate values in the Communications Area of the I/O buffer, but does not return data to the I/O area.
• With the exception of sequential processing (GSETL/GETIT), you must follow the prerequisite hierarchy of commands.
• The system automatically generates a User Requirements Table (URT) that contains an entry for each CA Datacom/DB table to be accessed.
• Any unrecoverable errors that occur during access to a CA Datacom/DB table cause the Reporting Facility to stop processing at the time the error is detected. A standard message prints, showing the table on which the problem has occurred and the associated CA Datacom/DB return code.