MODIFY MAP

Purpose

Modifies a map write control character (WCC) options and specifies attributes for map data fields.

Syntax

►►─── MODIFY MAP ──────────┬─ PERManent ◄ ─┬──────────────────────────────────►
                           └─ TEMPorary   ─┘

 ►─┬─────────────────────────────────────────────┬────────────────────────────►
   └─ CURSOR at ──┬─┬─ FIELD ─┬─ field-name ───┬─┘
                  │ └─ DFLD ──┘                │
                  └─ row, column ──────────────┘

 ►─┬──────────────────────────────┬───────────────────────────────────────────►
   │       ┌────────────────────┐ │
   └─ WCC ─▼─┬─┬─ RESETMDT ─┬─┬─┴─┘
             │ └─ NOMDT ────┘ │
             ├─┬─ RESETKBD ─┬─┤
             │ └─ NOKBD ────┘ │
             ├─┬─ ALARM ────┬─┤
             │ └─ NOALARM ──┘ │
             ├─┬─ STARTPRT ─┬─┤
             │ └─ NOPRT ────┘ │
             └─┬─ NLCR ─┬─────┘
               ├─ 40CR ─┤
               ├─ 64CR ─┤
               └─ 80CR ─┘
 ►──┬─────────────────────────────────────────────────────────────────────────►
    └─ FOR ─┬─┬────────────────────┬───── CURrent ───────────────┬────────────
            │ └─ all ─┬─ BUT ────┬─┘                             │
            │         └─ EXCept ─┘                               │
            ├─ ALL ────┬───────────┬─── FIELDS ──────────────────┤
            │          ├─ CORrect ─┤                             │
            │          └─ ERRor   ─┘                             │
            │                            ┌───────────────┐       │
            └─ all ─┬────────────┬─┬─ ( ─▼── field-name ─┴─ ) ─┬─┘
                    └┬─ BUT ────┬┘ └┬─ FIELD ─┬─ field-name ───┘
                     └─ EXCept ─┘   └─ DFLD ──┘ 
►────────────────────────────────────────────────────────────────────────────►
  ──┬──────────────┬───────┬──────────────────────────────────┬───────────────
    ├─ BACKscan ───┤       └─ OUTput DATA is ──┬─ Yes ───────┬┘
    └─ NOBACKscan ─┘                           ├─ No ────────┤
                                               ├─ ERASE ─────┤
                                               └─ ATTribute ─┘
 ►────────────────────────────────────────────────────────────────────────────►
  ──┬──────────────────────────┬───────┬──────────────────────┬───────────────
    └─ INput DATA is ─┬─ Yes ─┬┘       └┬─ Right ─┬─ JUSTify ─┘
                      └─ No  ─┘         └─ Left ──┘

 ►────────────────────────────────────────────────────────────────────────────►
  ──┬───────────────────────────┬──┬────────────────────────┬─────────────────
    ├─ PAD ─┬─ pad-character ─┬─┤  └─ EDIT is ─┬─ CORrect ─┬┘
    │       ├─ LOW-VALUE ─────┤ │              └─ ERRor ───┘
    │       └─ HIGH-VALUE ────┘ │
    └─ NOPAD ───────────────────┘

 ►────────────────────────────────────────────────────────────────────────────►
  ─┬────────────┬─────┬─────────────────────────────────────────────┬─────────
   ├─ REQuired ─┤     └─ ERRor ─┬─ MESSAGE ─┬─ is ──┬─ ACTive ───┬──┘
   └─ OPTional ─┘               └─ MSG ─────┘       └─ SUPpress ─┘
 ►────────────────────────────────────────────────┬── . ──────────────────────►◄
  ──┬──────────────────────────────────────────┬──┘
    │              ┌─────────────────────────┐ │
    └─ ATTRibutes ─▼─┬─── SKIP ───────────┬──┴─┘
                     ├─┬─ ALPHAmeric ─┬───┤
                     │ └─ NUMeric ────┘   │
                     ├─┬─ PROTected ───┬──┤
                     │ └─ UNPROTected ─┘  │
                     ├─┬─ DISPlay ─┬──────┤
                     │ ├─ DARK ────┤      │
                     │ └─ BRIGHT ──┘      │
                     ├─── DETECTable ─────┤
                     ├─┬─ MDT  ──┬────────┤
                     │ └─ NOMDT ─┘        │
                     ├─┬─ BLINK ───┬──────┤
                     │ └─ NOBLINK ─┘      │
                     ├─┬─ REVerse-video ─┬┤
                     │ └─ NORMal-video ──┘│
                     ├─┬─ UNDERscore ───┬─┤
                     │ └─ NOUNDERscore ─┘ │
                     └─┬─ NOColor ─────┬──┘
                       ├─ BLUe ────────┤
                       ├─ RED ─────────┤
                       ├─ PINk ────────┤
                       ├─ GREen ───────┤
                       ├─ TURquoise ───┤
                       ├─ YELlow ──────┤
                       └─ WHIte ───────┘

Parameters

PERManent

Specifies permanent modification.

The modifications apply to each display of the map as long as the dialog remains operative in the application thread. In a pageable map, a modification to a map data field of a detail line occurrence applies throughout the map paging session.

PERMANENT is the default when neither TEMPORARY nor PERMANENT is specified.

TEMPorary

Specifies temporary modification.

The modifications apply only to the next display of the map. In a pageable map, a modification to a map data field of a detail line occurrence applies only to the next time the detail line occurrence is displayed on the screen during the map paging session.

CURSOR

Specifies the cursor position on the terminal screen when the map is displayed.

FIELD field-name

Positions the cursor at the beginning of the named map field.

Field-name specifies a data field in the map associated with the current dialog.

DFLD can be used in place of FIELD.

row

Either the name of a variable data field that contains the row number or the row number itself, expressed as a numeric constant.

column

Either the name of a variable data field that contains the column number or the column number itself, expressed as a numeric constant.

The specified row and column numbers must be 1- to 16-digit unsigned integers and must be valid for the terminal in use. The row and column specifications must be separated by a blank or a comma.

WCC

Modifies the write control character (WCC) specifications for the map associated with the current dialog.

RESETMDT

The modified data tags (MDTs) are turned off.

NOMDT

The modified data tags (MDTs) are not turned off.

An MDT marks a data field for transmission to the dialog whether or not it is modified by the user.

RESETKBD

The keyboard is unlocked when the map is displayed.

NOKBD

The keyboard remains locked when the map is displayed.

ALARM

If installed, the terminal's audible alarm will sound when the map is displayed.

NOALARM

Even if installed, the terminal's audible alarm will not sound when the map is displayed.

STARTPRT

The contents of the terminal buffer are printed when the map is displayed.

NOPRT

The contents of the terminal buffer are not printed when the map is displayed.

Note: This specification is meaningful only when a 3280-type printer is in use.

NLCR

No line formatting is performed on the printer output. The printer advances to a new line only when the new line (NL) and carriage return (CR) characters occur.

40CR

Printer output is formatted into 40 characters per line.

64CR

Printer output is formatted into 64 characters per line.

80CR

Printer output is formatted into 80 characters per line.

Note: This specification is meaningful only if the STARTPRT option above is specified.

If the MODIFY MAP command is used to alter any WCC option, all WCC options are overridden by the command. Unspecified WCC options default, as follows:

RESETMDT/NOMDT defaults to NOMDT.
RESETKBD/NOKBD defaults to NOKBD.
ALARM/NOALARM defaults to NOALARM.
STARTPRT/NOPRT defaults to NOPRT.
NLCR/40CR/64CR/80CR has no default.

FOR

Specifies the map data fields being modified.

all BUT CURrent

Modifies all map data fields except the current field.

EXCEPT can be used in place of BUT.

ALL FIELDS

Introduces which map data fields are to be modified.

CORrect

Modifies all map data fields set to be correct by the automatic error-handling facility or the dialog.

ERRor

Modifies all map data fields set to be correct by the automatic error-handling facility or the dialog.

If CORRECT or ERROR is not specified, all map data fields are modified.

all BUT

Introduces the fields to be modified.

The optional keyword BUT modifies all map data fields except the field or fields specified by field-name.

EXCEPT can be used in place of BUT.

FIELD field-name

Specifies the map data field to be modified.

DFLD can be used in place of FIELD.

BACKscan

The contents of the designated map fields are displayed without trailing blanks. Characters remaining from the previous display of the map may appear in any unused positions.

NOBACKscan

The contents of the designated map fields are displayed with trailing blanks.

OUTput DATA is

Clause introducing selections which determine whether data from the dialog's record buffers and attribute specifications are transmitted to the designated map fields when the map is displayed. Attribute specifications include all attributes that can be specified in conjunction with the ATTRIBUTES keyword of the MODIFY MAP command.

Yes

Data and attribute specifications are transmitted.

No

Data is not transmitted. Data remaining from the previous display of the map appears in the designated map fields. Attribute specifications for a designated map field are transmitted only if one of the following conditions is met:

The map being displayed is different than the map previously displayed.
The designated map field is in error.

ERASE

Data is not transmitted, and data remaining from the previous display of the map is erased from the designated map fields. Attribute specifications are transmitted.

ATTribute

Attribute specifications are transmitted, but data is not. Data remaining from the previous display of the map appears in the designated map fields.

INput DATA is

Clause introducing selections which determine whether data entered in the specified map fields is transmitted to the dialog's record buffers.

Yes

Data in the designated map fields is transmitted to the dialog's record buffers.

No

Data in the designated map fields is not transmitted to the dialog's record buffers.

JUSTify

Introduces how data entered in the designated map fields is justified before it is transmitted to the dialog's record buffers.

Note: This specification is meaningful for nonnumeric fields only.

Right

Data in the designated map fields is right justified.

Left

Data in the designated map fields is left justified.

PAD pad-character

Specifies whether data entered in the designated map fields is padded before it is transmitted to the dialog's record buffers.

Data is padded on the left (if RIGHT JUSTIFY is specified) or on the right (if LEFT JUSTIFY is specified) with the specified pad character.

Pad-character is either the name of a variable data field that contains the pad character or the actual pad character, enclosed in single quotation marks.

NOPAD

Data in the designated map fields is not padded.

EDIT is

Specifies whether an error flag is set for the designated map fields.

ERRor

An error flag is set for the designated map fields.

CORrect

No error flag is set for the designated map fields.

Note: Error flags cannot be set permanently.

On a mapout operation, if any field is flagged to be in error, then for all fields both correct and incorrect) only attribute bytes are transmitted; no data is moved from program variable storage to the screen.

There is one exception to the above rule: on the initial display of a map by an CA ADS dialog, all literals and data fields are transmitted even if a field is in error.

REQuired

The user must enter data in the designated map fields.

OPTional

The user can enter data in the designated map fields, as applicable.

ERRor MESSAGE is

Specifies display or suppression of an error message associated with a field.

ACTive

Enables display of an error message.

A message is usually enabled after ERROR MESSAGE SUPPRESS is specified within a MODIFY MAP PERMANENT specification.

SUPpress

Disables display of an error message associated with a field.

When the map is redisplayed because of errors, the message defined for the map field will not be displayed even if the field contains edit errors.

Note: Autoedit errors detected on map in for detail fields within a pageable map cannot be suppressed unless you turn off autoedit.

ATTRibutes

Applies 3270- and 3279-type terminal display attributes to the designated map fields.

SKIP

Causes repositioning of the cursor over the designated map fields to the next unprotected field.

SKIP automatically assigns the NUMERIC and PROTECTED attributes (see below) to the designated map fields.

ALPHAmeric

The user can enter any data type characters.

Note: ALPHAMERIC cannot be specified if SKIP (see above) is specified.

NUMeric

The user can enter only numeric data type characters.

PROTected

The designated map fields are input protected. The user cannot enter, modify, or delete data.

UNPROTected

The designated map fields are not input protected. The user can enter, modify, or delete data.

Note: UNPROTECTED cannot be specified if SKIP (see above) is specified.

DISPlay

The designated map fields are displayed at normal intensity.

DARK

The designated map fields are displayed at darker-than-normal intensity.

Characters in a darkened field do not appear on the terminal screen. DARK cannot be specified if DETECTABLE (see below) is specified.

BRIGHT

The designated map fields are displayed at brighter-than-normal intensity. A brightened field appears highlighted on the terminal screen.

DETECTable

Specifies that the designated map fields are detectable by selector light pen.

Note: DETECTABLE cannot be specified if DARK (see above) is specified.

MDT

Modified data tags (MDTs) are turned on for the designated map fields when the map is displayed.

NOMDT

Modified data tags (MDTs) are not turned on for the designated map fields when the map is displayed.

BLINK

(3279-type terminals only) The designated map fields are displayed with blinking characters.

Note: BLINK cannot be specified if either REVERSE-VIDEO or UNDERSCORE (see below) is specified.

NOBLINK

(3279-type terminals only) Blinking characters are suppressed for the designated map fields.

REVerse-video

(3279-type terminals only) The designated map fields are displayed with dark characters on a light background.

Note: REVERSE-VIDEO cannot be specified if either BLINK (see above) or UNDERSCORE (see below) is specified.

NORMal-video

(3279-type terminals only) The designated map fields are displayed with light characters on a dark background.

UNDERscore

(3279-type terminals only) The designated map fields are underscored.

Note: UNDERSCORE cannot be specified if either BLINK or REVERSE-VIDEO (see above) is specified.

NOUNDERscore

(3279-type terminals only) The designated map fields are not underscored.

NOColor

(3279-type terminals only) The designated map fields are displayed with the default color of the terminal.

BLUE/RED/PINk/GREen/TURquoise/YELlow/WHIte

(3279-type terminals only) The designated map fields are displayed with one of the seven available color attributes.

Usage

Considerations

Multiple attributes to be modified can be specified in a single MODIFY MAP command. All indicated modifications apply to all specified map data fields in the command.
If multiple attributes are specified, they must be separated by commas or blanks.
The following rules apply to attributes and WCC options that are omitted from a MODIFY MAP command:
- If an attribute that is not a WCC option is omitted, the attribute remains as defined at map compilation time or as set by a previous modification designated as PERMANENT.
- If any WCC option is altered by the MODIFY MAP command, all WCC options are overridden by the command. Unspecified WCC options are assigned the default values listed in the syntax rules below.
The ERROR MESSAGE clause of the MODIFY MAP statement allows suppression of a default error message and display of a more appropriate message. For example, the following error message can be displayed for a part-number field in an order entry application:
```
THE SPECIFIED PART CANNOT BE MAILED
```

Note: Pageable maps cannot have the error message suppressed on map in.

Example

The following statements are part of a response process that adds a new CUSTOMER record occurrence to the database. The CUST-NUMBER field is required when adding a customer. If the user does not enter a customer number, an error flag is set for the CUST-NUMBER field and the field is made required:

IF CUST-NUMBER EQ SPACES
THEN
  DO.
    MODIFY MAP TEMPORARY FOR FIELD CUST-NUMBER EDIT ERROR.
    MODIFY MAP PERMANENT FOR FIELD CUST-NUMBER REQUIRED.
    DISPLAY MESSAGE TEXT IS
    'CUSTOMER NUMBER REQUIRED WHEN ADDING CUSTOMER.'.
  END.
ELSE
    MODIFY MAP TEMPORARY FOR FIELD CUST-NUMBER EDIT CORRECT OPTIONAL.