Map Commands › Pageable Maps › PUT DETAIL

PUT DETAIL

Purpose

The PUT DETAIL command:

• creates or modifies a detail occurrence of a pageable map
• specifies a numeric value to be associated with the occurrence
• specifies a message to appear in the message field of the occurrence.

Syntax

►►─── PUT ──┬────────────────────────────────────────────────────────────┬────►
            ├─ NEW ◄ ───┬──── DETail ───┬──────────────────────────────┬─┘
            └─ CURRent ─┘               └─ KEY ─┬──────┬─ key-number ──┘
                                                ├─ IS ─┤
                                                └─ =  ─┘

Expansion of Message-Options

 ►───┬────────────────────────────────────┬── . ──────────────────────────────►◄
     └─┬─ MESSAGE ─┬── message-options ───┘
       └── MSG ────┘

►►────┬─ TEXT ─────┬──────┬────────── message-text ───────────────────────────►
      │            ├─ IS ─┤
      │            └─ =  ─┘
      └─ CODE ─────┬──────┬────────── message-code ───────────────────────────
                   ├─ IS ─┤
                   └─ =  ─┘

 ►────────────────────────────────────────────────────────────────────────────►
  ────┬───────────────────────────────────────────────┬───────────────────────
      │                         ┌──────────────┐      │
      └─ PARMS ────┬─────┬─── (─▼── parameter ─┴─ ) ──┘
                   └─ = ─┘

 ►────────────────────────────────────────────────────┬───────────────────────►◄
  ────┬────────────────────────────────────────┬──────┘
      └─ PREFIX ───┬──────┬─────── prefix ─────┘
                   ├─ IS ─┤
                   └─ =  ─┘

Parameters

NEW DETail

Creates a detail occurrence which is stored at the end of the set of detail occurrences.

NEW is the default when neither NEW or CURRENT is specified.

CURRent DETail

Modifies the detail occurrence referenced by the most recent pageable map command.

After a pseudo-converse, a pageable map command must be issued to establish currency on a detail occurrence before a PUT CURRENT DETAIL command can be issued. If currency is not established, CA ADS abnormally terminates the dialog.

KEY is key-number

Specifies the numeric value to be associated with the detail occurrence being created or modified.

Key-number is either the name of a variable data field or the number itself, expressed as a numeric constant.

Key-number replaces the numeric value (if any) previously associated with the detail occurrence. The numeric value is not displayed at the terminal, but is stored along with the detail occurrence as a binary fullword.

The KEY parameter can be used to store the database key of a subschema record associated with a detail occurrence. A GET DETAIL command can later retrieve the database key when it retrieves the detail occurrence, facilitating the retrieval of the subschema record.

MESSage

Introduces the text or code of a message.

MSG can be used in place of MESSAGE.

message-options

Identifies message to be displayed.

Expanded syntax for message-options is shown above immediately following the PUT DETAIL syntax.

TEXT is message-text

Specifies the text of a message to be displayed in an online map's message field or sent to a batch application and a system log file.

Message-text specifies either the name of a variable data field containing the message text or the text string itself, enclosed in single quotation marks.

The text string can contain up to 240 displayable characters.

CODE is message-code

Specifies the message dictionary code of a message to be displayed in an online map's message field or sent to the log file in a batch application.

In a batch application, the message is also sent to the operator, if directed by the destination specified in the dictionary.

Message-code specifies either the name of a variable data field that contains the message code or the 6-digit code itself, expressed as a numeric literal.

PARMS = parameter

Specifies a replacement parameter for each variable field in the stored message identified by message-code.

Up to nine replacement parameters can be specified for a message. Multiple parameters must be specified in the order in which they are numbered and separated by blanks or commas.

Parameter specifies either the name of an EBCDIC or unsigned zoned decimal variable data field that contains the parameter value or the parameter value itself, enclosed in single quotation marks.

The parameter value must contain displayable characters. At run time, each variable data field in a stored message expands or contracts to accommodate the size of its replacement parameter. A replacement parameter can be a maximum of 240 bytes.

PREFIX is prefix

Overrides the default prefix of a dialog and a map.

Prefix specifies an EBCDIC or unsigned zoned decimal variable data field that contains a 2-character prefix or the 2-character prefix itself, enclosed in single quotation marks.