Dialog-expression

Application and Dialog Utilities › ADSOBCOM › Dialog-expression

Dialog-expression

Purpose

Dialog-expression is used to specify those dialogs which are to be added, modified, and deleted.

Syntax

►►──┬─┬──────────┬─── DIAlog ────┬──────┬──── dialog-name ──────────────────┬─►
    │ ├─ ADD ────┤               ├─ IS ─┤                                   │
    │ └─ DELete ─┘               └─ = ──┘                                   │
    └ MODify DIAlog dialog-name-options ┬──────────────────────────────────┬┘
                                        └ VERsion ┬─────┬ version#-options ┘
                                                  ├ IS ─┤
                                                  └ = ──┘

 ►──┬──────────────────────────────────────────┬──────────────────────────────►
    └─ VERsion ──┬──────┬── version-number ────┘
                 ├─ IS ─┤
                 └─ = ──┘

 ►──┬─────────────────────────────────────┬───────────────────────────────────►
    └─ MAInline ───┬──────┬────┬─ YES  ─┬─┘
                   ├─ IS ─┤    └─ NO ◄ ─┘
                   └─ = ──┘

 ►──┬─────────────────────────────────────────────────────────────────────────►─
    └─────┬──────────┬─────── SUBschema ───┬──────┬──── subschema-name ───────
          ├─ ADD ────┤                     ├─ IS ─┤
          ├─ MODify ─┤                     └─ = ──┘
          └─ DELete ─┘
─►──────────────────────────────────────────────────────────────────────────┬─►
  -─┬─────────────────────────────────────────────────────────────────────┬─┘
    └─ SCHema ─┬────┬─ schema-name ─┬───────────────────────────────────┬─┘
               ├ IS ┤               └─ VERsion ─┬────┬─ version-number ─┘
               └ = ─┘                           ├ IS ┤
                                                └ = ─┘

 ►─┬──────────────────────────────────────────────────────────────────┬───────►
   └─┬──────────┬─ ACCess MODule (AM) ─┬──────┬── access-module-name ─┘
     ├─ ADD ────┤                      ├─ IS ─┤
     ├─ MODify ─┤                      └─ = ──┘
     └─ DELete ─┘

 ►─┬──────────────────────────────────────────────────────────────────────────►─
   └┬──────────┬──────────────────────────────────────────────────────────────
    ├─ ADD ────┤
    ├─ MODify ─┤
    └─ DELete ─┘

─►──────────────────────────────────────────────────────────────────────────┬─►
   ─┬──────────┬─ MAP ─┬──────┬─ map-name ─┬───────────────────────────────┬┘
    └─ ONLine ─┘       ├─ IS ─┤            └─ version ─┬──────┬─ version# ─┘
                       └─ = ──┘                        ├─ IS ─┤
                                                       └─ = ──┘

 ►─┬──────────────────────────────────────────────────────────────────────────►─
   └┬──────────┬──────────────────────────────────────────────────────────────
    ├─ ADD ────┤
    ├─ MODify ─┤
    └─ DELete ─┘
─►────────────────────────────────────────────────────────────────────────────►─
  ─── INput ─┬──────────────────────────────────────────────────────────────┬─
             └─ MAPname ─┬─ IS ─┬─ map-name ┬──────────────────────────────┬┘
                         │      │           └ version ─┬──────┬─ version# ─┘
                         └─ = ──┘                      ├─ IS ─┤
                                                       └─ = ──┘

─►──────────────────────────────────────────────────────────────────────────┬─►
  ┬────────────────────────────────────┬┬──────────────────────────────────┬┘
  └─ FILEname ─┬────┬─ run-time-label ─┘└─ SUSfile ─┬────┬─ suspense-label ┘
               ├ IS ┤                               ├ IS ┤
               └ = ─┘                               └ = ─┘

 ►─┬──────────────────────────────────────────────────────────────────────────►─
   └┬──────────┬──────────────────────────────────────────────────────────────
    ├─ ADD ────┤
    ├─ MODify ─┤
    └─ DELete ─┘

─►────────────────────────────────────────────────────────────────────────────►─
  ─── OUTput ─┬─────────────────────────────────────────────────────────────┬─
              └─ MAPname ─┬─ IS ─┬ map-name ┬──────────────────────────────┬┘
                          │      │          └ version ─┬──────┬─ version# ─┘
                          └─ = ──┘                     ├─ IS ─┤
                                                       └─ = ──┘

─►──────────────────────────────────────────┬─────────────────────────────────►
  ─┬──────────────────────────────────────┬─┘
   └─ FILEname ─┬──────┬─ run-time-label ─┘
                ├─ IS ─┤
                └─ = ──┘
 ►─┬──────────────────────────────────┬───────────────────────────────────────►
   └─ AUTostatus ─┬──────┬──┬─ Yes ─┬─┘
                  ├─ IS ─┤  └─ No ──┘
                  └─ = ──┘

 ►─┬──────────────────────────────────────────────────────────────────────────►─
   └─ STAtus ─┬───────────────────────────┬─┬──────┬─ record-name ────────────
              └─ DEFinition ─┬──────────┬─┘ ├─ IS ─┤
                             └─ RECord ─┘   └─ = ──┘

─►──────────────────────────────────────────┬─────────────────────────────────►
  ─┬──────────────────────────────────────┬─┘
   └─ VERsion ─┬──────┬─ version-number ──┘
               ├─ IS ─┤
               └─ = ──┘

 ►─┬─────────────────────────────────────────────┬────────────────────────────►
   └─ AUTO ─┬───────────┬──┬──────┬──┬─ Yes ◄ ─┬─┘
            └─ DISPlay ─┘  ├─ IS ─┤  └─ No ────┘
                           └─ = ──┘
 ►─┬────────────────────────────────────────┬─────────────────────────────────►
   └─ PAGing MODE ─┬──────┬──┬─ UPDate ◄ ─┬─┘
                   ├─ IS ─┤  └─ BROwse ───┘
                   └─ = ──┘
 ►─┬──────────────────────────────────┬───────────────────────────────────────►
   └─ BACKpage ─┬──────┬──┬─ Yes ◄ ─┬─┘
                ├─ IS ─┤  └─ No ────┘
                └─ = ──┘

 ►─┬────────────────────────────────────────┬─────────────────────────────────►
   └─ PAGing TYPE ─┬──────┬──┬─ Nowait ◄ ─┬─┘
                   ├─ IS ─┤  ├─ Return ───┤
                   └─ = ──┘  └─ Wait ─────┘

 ►─┬────────────────────────────────────┬─────────────────────────────────────►
   └─ ACTivity log ─┬──────┬──┬─ Yes ─┬─┘
                    ├─ IS ─┤  └─ No ──┘
                    └─ = ──┘

 ►─┬────────────────────────────────────────────┬─────────────────────────────►
   └─ SYMbol ─┬─────────┬──┬──────┬──┬─ Yes ──┬─┘
              └─ TABle ─┘  ├─ IS ─┤  └─ No ◄ ─┘
                           └─ = ──┘
 ►─┬─────────────────────────────────────────────────┬────────────────────────►
   └─ DIAGnostic ─┬─────────┬──┬──────┬──┬─ Yes ◄ ─┬─┘
                  └─ TABle ─┘  ├─ IS ─┤  └─ No ────┘
                               └─ = ──┘
 ►─┬─────────────────────────────────────────────┬────────────────────────────►
   └─ MESsage PREfix ─┬──────┬──┬─ prefix ─────┬─┘
                      ├─ IS ─┤  └─ DEfault ◄ ──┘
                      └─ = ──┘

 ►─┬─────────────────────────────────────────┬────────────────────────────────►
   └─ COBol ─┬────────┬──┬──────┬──┬─ Yes ─┬─┘
             └─ MOVe ─┘  ├─ IS ─┤  └─ No ──┘
                         └─ = ──┘

 ►─┬─────────────────────────────────────────────┬────────────────────────────►
   └┬─ ENTRY POINT ─┬─┬──────┬──┬─ Premap ◄ ──┬──┘
    └─ EP ──────────┘ ├─ IS ─┤  └─ Map ───────┘
                      └─ = ──┘

 ►─┬────────────────────────────────────────┬─────────────────────────────────►
   └─ RETrieval LOCKing ─┬────┬─┬─ Yes ◄ ─┬─┘
                         ├ IS ┤ └─ No ────┘
                         └ = ─┘
 ►─┬────────────────────────────────────────────────────────────────────────┬─►
   └─── SQL CHEck SYNtax ─┬─ EXTended ◄ ─┬──────────────────────────────────┘
                          ├─ SQL89 ──────┤
                          └─ FIPS ───────┘

 ►─┬─────────────────────────────────────┬────────────────────────────────────►
   └─── SQL ─── DATe ─┬──────┬─┬─ ISO ─┬─┘
                      ├─ IS ─┤ ├─ USA ─┤
                      └─ = ──┘ ├─ EUR ─┤
                               └─ JIS ─┘

 ►─┬─────────────────────────────────────┬────────────────────────────────────►
   └─── SQL ─── TIMe ─┬──────┬─┬─ ISO ─┬─┘
                      ├─ IS ─┤ ├─ USA ─┤
                      └─ = ──┘ ├─ EUR ─┤
                               └─ JIS ─┘

 ►─┬─────────────────────────────────────────────────────────────────┬────────►
   │ ┌─────────────────────────────────────────────────────────────┐ │
   └─▼─┬────────┬ SQL TABle ┬────┬ table-name ─┬─────────────────┬─┴─┘
       ├ ADD ───┤           ├ IS ┤             └─ table-options ─┘
       ├ MODify ┤           └ = ─┘
       └ DELete ┘

 ►─┬───────────────────────────────────────────────────────────────────┬──────►
   │ ┌──────────────────────────────────────────────────────────────┐  │
   └─▼─┬──────────┬─ RECord ─┬──────┬─ record-name record-options -─┴──┘
       ├─ ADD ────┤          ├─ IS ─┤
       ├─ MODify ─┤          └─ = ──┘
       └─ DELete ─┘
 ►─┬──────────────────────────────────────────────────────────────────────────►─
   └┬──────────┬─ PREmap ─┬──────────────────────┬─┬──────┬───────────────────
    ├─ ADD ────┤          └─ PROcess ─┬────────┬─┘ ├─ IS ─┤
    ├─ MODify ─┤                      └─ NAMe ─┘   └─ = ──┘
    └─ DELete ─┘

─►──────────────────────────────────────────────────────────────┬─────────────►
  ─── process-name ───┬──────────────────────────────────────┬──┘
                      └─ VERsion ─┬──────┬─ version-number ──┘
                                  ├─ IS ─┤
                                  └─ = ──┘

 ►─┬──────────────────────────────────────────────────────────────────────────►─
   └┬──────────┬─ DECLaration ─┬──────────────────────┬─┬──────┬──────────────
    ├─ ADD ────┤               └─ PROcess ─┬────────┬─┘ ├─ IS ─┤
    ├─ MODify ─┤                           └─ NAMe ─┘   └─ = ──┘
    └─ DELete ─┘

─►──────────────────────────────────────────────────────────────┬─────────────►
  ─── process-name ───┬──────────────────────────────────────┬──┘
                      └─ VERsion ─┬──────┬─ version-number ──┘
                                  ├─ IS ─┤
                                  └─ = ──┘
 ►─┬──────────────────────────────────────────────────┬───────────────────────►◄
   │ ┌──────────────────────────────────────────────┐ │
   └─▼──┬──────────┬─ RESponse ── response-options ─┴─┘
        ├─ ADD ────┤
        ├─ MODify ─┤
        └─ DELete ─┘

Expansion of response-options

 ►►─┬──────────┬─ RESponse ─┬──────────────────────┬─┬──────┬─ process-name ──►
    ├─ ADD ────┤            └─ PROcess ─┬────────┬─┘ ├─ IS ─┤
    ├─ MODify ─┤                        └─ NAMe ─┘   └─ = ──┘
    └─ DELete ─┘

 ►─┬──────────────────────────────────────┬─┬─────────────────────────────┬───►
   └─ VERsion ─┬──────┬─ version-number ──┘ └─ DEFault ─┬──────┬┬─ Yes ──┬┘
               ├─ IS ─┤                                 ├─ IS ─┤└─ No ◄ ─┘
               └─ = ──┘                                 └─ = ──┘

 ►─┬────────────────────────────────────────────────────────────────────────┬─►
   │ ┌─────────────────────────────────────────────────────────────────────┐│
   └─▼─┬ CONtrol KEY ─┬────┬─ key ─┬────────────────┬─────────────────────┬┴┘
       │              ├ IS ┤       └─ FROm old-key ─┘                     │
       │              └ = ─┘                                              │
       ├ RESponse ─┬──────────────────┬─┬────┬─ value ─┬────────────────┬─┤
       │           └ FIELD ─┬───────┬─┘ ├ IS ┤         └ FROm old-value ┘ │
       │                    └ VALue ┘   └ = ─┘                            │
       ├─ BATch CONtrol EVENT ─┬─┬────┬─ event ───────────────────────────┘
       └─ BCE ─────────────────┘ ├ IS ┤
                                 └ = ─┘
 ►─┬───────────────────────────────────────────┬──────────────────────────────►◄
   └─ EXEc ON EDIT ERRors ─┬──────┬─┬─ Yes ──┬─┘
                           ├─ IS ─┤ └─ No ◄ ─┘
                           └─ = ──┘

Expansion of table-options

►►──┬───────────────────────────────────┬┬────────────────────────┬───────────►◄
    └─ SCHema ─┬────┬─ sql-schema-name ─┘│ ┌────────────────────┐ │
               ├ IS ┤                    └─▼─┬─┬─ NEW copy ─┬─┬─┴─┘
               └ = ─┘                        │ └─ NC ───────┘ │
                                             └─┬─ WORk ─┬─────┘
                                               └─ WK ───┘

Expansion of record-options

►►──┬───────────────────────────────────┬┬────────────────────────┬───────────►◄
    └─ VERsion ─┬────┬─ version-number ─┘│ ┌────────────────────┐ │
                ├ IS ┤                   └─▼─┬─┬─ NEW copy ─┬─┬─┴─┘
                └ = ─┘                       │ └─ NC ───────┘ │
                                             └─┬─ WORk ─┬─────┘
                                               └─ WK ───┘

Expansion of version#-options

►►─┬─ version-number ──────────────────────────────┬──────────────────────────►◄
   └─ ( low-version-number  high-version-number ) ─┘

Parameters

ADD

Specifies that a dialog is to be added to the data dictionary.

ADD is the default if the named dialog does not exist in the data dictionary.

MODify

Specifies that an existing dialog is to be modified.

MODIFY is the default if the named dialog exists in the data dictionary.

DELete

Specifies that an existing dialog is to be deleted.

When the action is DELETE, only the dialog name and version number can be specified in the dialog expression.

DIAlog is dialog-name

Specifies the 1- to 8-character name of the dialog being added, modified, or deleted.

The dialog name must begin with an alphabetic or national (@, #, and $) character and cannot contain embedded blanks.

The equals sign (=) can be used in place of IS.

VERsion is version-number

Specifies the version number (in the range 1 through 9999) of the dialog being added, modified, or deleted.

The default version number is 1.

The equals sign (=) can be used in place of IS.

MAInline is Yes/No

Specifies whether the dialog is a mainline dialog.

At runtime, the dialog that executes first in a series of dialogs that make up an application must be a mainline dialog. If a dialog function is initiated by an application task code, the dialog associated with the function must be a mainline dialog.

No is the default when neither Yes or No is specified.

ADD

Specifies that the subschema specification is to be added.

ADD is the default if no subschema is associated with the dialog.

MODify

Specifies that the existing subschema specification is to be replaced by a new subschema specification.

MODIFY is the default if a subschema is associated with the dialog.

DELete

Specifies that the subschema specification is to be deleted.

If the action is DELETE, the SCHEMA clause cannot be specified.

SUBschema is subschema-name

Specifies the 1- to 8-character name of the subschema associated with the dialog.

The equals sign (=) can be used in place of IS.

The specified subschema must be defined in the data dictionary. If no subschema is specified for a dialog, the dialog cannot perform database access.

SCHema is schema-name

Specifies the 1- to 8-character name of the schema.

A schema name must be specified if the named subschema is associated with more than one schema or version of a schema. If the named subschema is associated with only one schema and version, SCHEMA defaults to the name of that schema.

The equals sign (=) can be used in place of IS.

VERsion is version-number

Specifies the version number (in the range 1 through 9999) of the named schema.

The equals sign (=) can be used in place of IS.

If no version number is specified, VERSION defaults to the version of the named schema that was defined most recently.

ADD

Specifies that the access module specification is to be added.

MODify

Specifies that the existing access module specification is to be replaced by a new access module specification.

DELete

Specifies that the access module specification is to be cleared to spaces.

ACCess MODule

Sets the access module name which is used at runtime to satisfy the IDMS/DB request of the dialog.

(AM) is access-module-name

Specifies the 1- to 8-character name of the access module associated with the current dialog.

The dialog can override this specification at runtime by issuing a SET ACCESS MODULE statement.

When the access module name is not specified, the name defaults to the dialog name.

ADD

Specifies that a map specification is to be added to the dialog.

ADD is the default if no map of the type specified (online, input, or output) is associated with the dialog.

MODify

Specifies that the existing map specification is to be replaced by a new map specification.

MODIFY is the default if a map of the type specified (online, input, or output) is already associated with the dialog.

DELete

Specifies that the map definition is to be dissociated from the dialog.

If DELETE is specified, the version number of the MAPNAME clause cannot be specified.

ONLine/INput/OUTput

Specifies the type of map.

ONLINE is the default when no other map type is specified.

A dialog associated with an online map cannot be associated with an input or output file map. A dialog can be associated with both an input and an output file map by coding multiple ADD ... MAPNAME clauses. A dialog not associated with a map is called a mapless dialog and can be executed in both batch and online environments.

MAPname is map-name

Specifies the 1- to 8-character name of the map associated with the dialog.

The specified map must be defined in the data dictionary; however, the map load module does not have to exist. If the dialog has no map specification, only a premap process (not a response process) can be associated with the dialog.

VERsion is version-number

Specifies the version number (in the range 1 through 9999) of the named map.

The equals sign (=) can be used in place of IS.

If no version number is specified and the map is being added to a dialog, or the dialog is being associated with a different map, the version defaults to 1. Otherwise, the version number defaults to the version of the map currently associated with the dialog.

FILEname is runtime-label

(Batch only) Specifies the z/OS ddname (z/VSE filename, z/VM ddname) of the input or output file added or modified.

The equals sign (=) can be used in place of IS.

The runtime label must be specified either during dialog definition or at runtime.

The runtime control statement overrides the default specified during dialog definition.

SUSfile is suspense-label

(Batch only) Specifies the z/OS ddname (z/VSE filename, z/VM ddname) of the suspense file for input file maps only.

The equals sign (=) can be used in place of IS.

If a suspense file is maintained for the dialog at runtime, the label must be specified either during dialog definition or at runtime. The runtime control statement overrides the default specified during dialog definition.

AUTostatus is Yes/No

Specifies whether the autostatus facility is used when the current dialog executes.

The default setting corresponds to the autostatus specification defined at DC/UCF system generation. If autostatus is defined as optional, the application developer can override the initial setting. If autostatus is defined as mandatory, the initial setting cannot be changed.

STAtus DEFinition RECord is record-name

Specifies the 1 to 32-character name of the status definition record.

The specified record must be defined in the data dictionary. If no record name is specified, STATUS DEFINITION RECORD defaults to the name of the status definition record defined at DC/UCF system generation.

VERsion is version-number

Specifies the version number (in the range 1 through 9999) of the named status definition record.

If a version number is not specified, VERSION defaults to the system default version number, as specified in the OOAK record at system generation.

If no system default version is specified in the OOAK record, VERSION defaults to 1.

The equals sign (=) can be used in place of IS.

AUTO DISPlay is Yes/No

Specifies whether the first page of pageable map is displayed automatically.

A DISPLAY statement must be coded in the dialog's premap process to display the first page.

YES is the default when neither YES or NO is specified.

PAGing MODE is UPDate/BROwse

Specifies whether the user can modify data fields on a map during a map paging session.

UPDATE is the default setting for the paging mode option.

BACKpage is Yes/No

Specifies whether the user can page backward in a map paging session.

YES is the default setting for the backpage option.

PAGing TYPE is Nowait/Return/Wait

Specifies the method used to determine the runtime flow of control when the user presses a control key during a map paging session.

NOWAIT is the default setting for the paging type option.

These three paging session dialog options can be specified only if the dialog is associated with a pageable map.

The following combination of paging session dialog options cannot be specified: PAGING MODE IS UPDATE, BACKPAGE IS NO, and PAGING TYPE IS NOWAIT.

ACTivity log is Yes/No

Specifies whether the dialog uses the activity logging facility.

This facility documents all potential database activity by a dialog, based on the database commands issued explicitly or implicitly by the dialog's processes.

The default setting for the activity logging option is defined at DC/UCF system generation.

SYMbol TABle is Yes/No

Specifies whether a symbol table is created for a dialog.

A symbol table facilitates the use of element names and process line numbers by the online debugger.

Note: For more information about the online debugger, see the CA IDMS Online Debugger Guide.

NO is the default setting for the symbol table option.

DIAGnostic TABle is Yes/No

Specifies whether the dialog load module contains diagnostic tables (line number tables and offset tables).

Diagnostic tables facilitate the testing and debugging of a dialog. If a process aborts, diagnostic tables are used to display the process command in error on the Dialog Abort Information screen. The ADSORPTS utility uses diagnostic tables to format the dialog report for easy reference.

YES is the default setting for the diagnostic table option.

The setting must be YES if the symbol table setting is YES. Also, during the testing of a dialog, the diagnostic table setting should be YES.

Once a dialog has been tested thoroughly, the diagnostic table setting should be NO and the dialog recompiled if dialog load module size is a consideration. The size of a large dialog load module can be reduced significantly by compiling the dialog without diagnostic tables.

MESSage PREfix is

Clause introducing a message prefix for a dialog.

The equals sign (=) can be used in place of IS.

prefix

Specifies a user-supplied 2-character alphanumeric message prefix for the dialog.

DEfault

Specifies that the dialog uses the default message prefix.

DEFAULT is the default setting when the message prefix is not specified.

COBol MOVe is Yes/No

Specifies whether the rules of COBOL or CA ADS are used in the conversion between data types and in the rounding or truncation of the results of arithmetic and assignment commands.

The default setting for the COBOL MOVE option is defined at DC/UCF system generation. The system generation default is NO.

ENTRY POINT is

Clause introducing the entry point into the dialog when the dialog begins execution at runtime.

EP can be used in place of ENTRY POINT; the equals sign (=) can be used in place of IS.

Premap

Specifies that the dialog begins with its premap process.

PREMAP is the default when no other entry point is specified.

Map

Specifies that the dialog begins with its first mapping operation (mapout for online dialogs, mapin for batch dialogs).

Regardless of the specification, a dialog without an online map or batch input file map begins with its premap process. A dialog without a premap process begins with its first mapping operation.

RETrieval LOCKing is Yes/No

Specifies whether or not the dialog will cause record locks to be held for database records.

YES, the default, specifies that database record retrieval locks will be held on behalf of run units started by the dialog.

SQL CHEck SYNtax

Specifies the SQL standard you are enforcing. The default is CA IDMS extended ANSI-standard SQL. CA ADS supports the following SQL standards:

EXTended
SQL89
FIPS

Note: For more information about SQL standards, see the CA IDMS SQL Reference Guide.

SQL DATe is

Specifies the external date representation format. The date format can be one of the following:

ISO specifies the International Standards Organization standard
USA specifies the IBM USA standard
EUR specifies the IBM European standard
JIS specifies the Japanese Industrial Standard Christian Era standard

SQL TIMe is

Specifies the external time representation format. The time format can be one of the following:

ISO specifies the International Standards Organization standard
USA specifies the IBM USA standard
EUR specifies the IBM European standard
JIS specifies the Japanese Industrial Standard Christian Era standard

Note: For more information on date/time representations, see the CA IDMS SQL Reference Guide.

ADD

Specifies that the SQL table specification is to be added.

MODify

Specifies that the existing SQL table specification is to be replaced by a new SQL table specification.

DELete

Specifies that the SQL table specification is to be cleared to spaces.

SQL TABle is table-name

Specifies the name of the SQL table assigned the new copy attribute and/or the work record attribute.

table-options

See expansion of table-options below.

ADD

Specifies that a new copy/work record specification is to be added to the dialog.

ADD is the default if the named new copy/work record is not associated with the dialog.

MODify

Specifies that a new copy/work record specification of a dialog is to be modified.

MODIFY is the default if the named new copy/work record is already associated with the dialog.

DELete

Specifies that a new copy/work record specification of a dialog is to be deleted.

If the action is DELETE, the VERSION specification is optional, and the NEW COPY and WORK specifications cannot be included.

RECord is record-name record-options

Specifies the name of the record assigned the new copy attribute and/or the work record attribute.

See expansion of record-options below.

ADD

Specifies that a premap process is to be added to the dialog.

ADD is the default if no premap process is associated with the dialog.

MODify

Specifies that a new premap process is to replace the existing premap process.

MODIFY is the default if a premap process is already associated with the dialog.

DELete

Specifies that the premap process is to be deleted from the dialog.

If the action is DELETE, the version number cannot be specified.

PREmap PROcess NAMe is process-name

Specifies the 1- to 32-character name of the process source module associated with the dialog as a premap process.

PROCESS and NAME are optional keywords; the equals sign may be used in place of IS.

Note: The specified process source module must exist in the data dictionary.

VERsion is version-number

Specifies the version number (in the range 1 through 9999) of the named process source module.

The equals sign (=) may be used in place of IS.

The default version number is the system default version number, as specified in the OOAK record at system generation. If no system default version number is specified in the OOAK record, the default version number is 1.

ADD

Specifies that a premap process is to be added to the dialog.

ADD is the default if no premap process is associated with the dialog.

MODify

Specifies that a new premap process is to replace the existing premap process.

MODIFY is the default if a premap process is already associated with the dialog.

DELete

Specifies that the premap process is to be deleted from the dialog.

If the action is DELETE, the version number cannot be specified.

DECLaration PROcess NAMe is process-name

Specifies the 1- to 32-character name of the process source module associated with the dialog as a premap process.

PROCESS and NAME are optional keywords; the equals sign may be used in place of IS.

Note: The specified process source module must exist in the data dictionary.

VERsion is version-number

Specifies the version number (in the range 1 through 9999) of the named process source module.

The equals sign (=) may be used in place of IS.

ADD

Specifies that a response process is to be added to the dialog.

ADD is the default if the named response process is not already associated with the dialog.

ADD can be used to define duplicate response processes, in which the same response process is associated with several control keys and/or response field values. In the example shown below, response process RP1 is associated with control keys PF1, PF2, and PF3, and with response field values ADD and MOD:

ADD RESPONSE PROCESS RP1 CONTROL KEY PF1 RES VALUE ADD
ADD RESPONSE PROCESS RP1 CONTROL KEY PF2 RES VALUE MOD
ADD RESPONSE PROCESS RP1 CONTROL KEY PF3

MODify

Specifies that a response process of the dialog is to be modified.

MODIFY is the default if the named response process is already associated with the dialog.

In the example shown below, the control key specification for nonduplicate response process RP1 is modified to PF2:

MODIFY RESPONSE PROCESS RP1 CONTROL KEY PF2

To modify a duplicate response process, the application developer must specify which occurrence of the duplicate response process is being modified.

To modify the control key associated with the response process, the application developer specifies the FROM parameter of the CONTROL KEY specification. In the example shown below, the control key ENTER is changed to PA1 for duplicate response process RP1:

MODIFY RESPONSE PROCESS RP1 CONTROL KEY PA1 FROM ENTER

To modify the response field value associated with the response process, the application developer specifies the FROM parameter of the RESPONSE FIELD VALUE specification. In the example shown below, the response field value MOD is changed to ADD for duplicate response process RP1:

MODIFY RESPONSE PROCESS RP1 RES VALUE ADD FROM MOD

To modify the EXECUTE ON EDIT ERRORS specification associated with the response process, the application developer specifies either the CONTROL KEY or RESPONSE FIELD VALUE parameter. In the example shown below, the EXECUTE ON EDIT ERRORS specification is set to YES for the occurrence of duplicate response process RP1 that is associated with the ENTER key:

MODIFY RESPONSE PROCESS RP1 CONTROL KEY ENTER
       EXECUTE ON EDIT ERRORS YES

DELete

Specifies that a response process of the dialog is to be deleted.

If the action is DELETE, the version number is optional and the EXEC ON EDIT ERRORS specifications cannot be included.

An occurrence of a duplicate response process is deleted by specifying the CONTROL KEY or RESPONSE FIELD VALUE parameter. The example shown below deletes the occurrence of duplicate response process RP1 that is associated with the response field value ADD:

DELETE RESPONSE PROCESS RP1 RES VALUE ADD

RESponse response-options

See expansion of response-options below.

Expansion of response-options

RESponse PROcess NAMe

Specifies the 1- to 32-character name of the process source module associated with the dialog as a response process.

Note: The specified source module must exist in the data dictionary.

VERsion is version-number

Specifies the version number (in the range 1 through 9999) of the named process source module.

The equals sign (=) may be used in place of IS.

DEFault is Yes/No

Specifies whether the response process defined is the optional default response process of the dialog.

At runtime, after a mapin operation, the runtime system executes the default response process if no response process can be selected based on control event or response field values.

NO is the default specification.

If DEFAULT is NO, a control key, a response field value, a response field value, or a batch control event for the response process must be specified. If DEFAULT is YES, these specifications are optional.

CONtrol KEY is key

Specifies a user-defined control key that initiates the response process at runtime.

The equals sign (=) can be used in place of IS.

Key can also be specified to identify an occurrence of a duplicate response process, as described under ADD/MODIFY/DELETE RESPONSE PROCESS above.

Valid control key specifications are ENTER, CLEAR, PA1 through PA3, PF1 through PF24, FWD, BWD, and HDR. FWD, BWD, and HDR can be specified only if the dialog is associated with a pageable map. LPEN can be specified as a control key if the use of light pens is supported by the installation.

CLEAR, PA1, PA2, and PA3 do not transmit data; that is, input is not mapped in when these keys are pressed at runtime. The FWD, BWD, and HDR control keys are associated with pageable maps. FWD and BWD are synonymous with the keyboard control keys for paging forward and backward, respectively. If FWD and BWD are specified and the keys defined for paging forward and backward are changed, the dialog does not have to be recompiled.

HDR is not associated with any keyboard control key; rather, conditions encountered during a map paging session cause a response process associated with this control key value to be initiated.

FROm old-key

Identifies the occurrence of a duplicate response process whose associated control key specification is being modified, as described under ADD/MODIFY/DELETE RESPONSE PROCESS above.

RESponse FIEld VALue is value

Specifies a response name associated with the response process.

Value can also be specified to identify an occurrence of a duplicate response process, as described under ADD/MODIFY/DELETE RESPONSE PROCESS above.

The equals sign (=) may be used in place of IS.

When a control key value or a response field value of a response process needs to be dissociated from the response, a blank value (' ') can be used, as in the following example:

MOD RES PRO response-name VER 1 RES VALUE ' '

FROm old-value

Identifies the occurrence of a duplicate response process whose associated response field value specification is being modified, as described under ADD/MODIFY/DELETE RESPONSE PROCESS above.

BATch CONtrol EVENT is event

Specifies a batch control event that initiates the response process at runtime.

BCE can be used in place of BATCH CONTROL EVENT; the equals sign (=) can be used in place of IS.

Valid Batch Control Events

EOF indicates that the most recent input file read operation resulted in an end-of-file condition.
IOERR indicates that the most recent input file read operation resulted in physical input-error condition. In CA ADS Batch, output errors cause the runtime system to terminate the application.
Batch control events can be specified only for batch dialogs. Control keys can be specified only for online dialogs.

EXEc ON EDIt ERRors is

Introduces whether processing continues if automatic editing encounters map input errors.

The equals sign (=) can be used in place of IS.

Yes

Specifies that the response process executes even if the map contains input errors.

No

Specifies that the response process is not executed if the map contains input errors. The user must correct all map fields that are in error before processing continues.

NO is the default when neither YES or NO is specified.

Expansion of table-options

SCHema is sql-schema-name

Specifies the schema containing the SQL table.

The equals sign (=) can be used in place of IS.

NEW copy

Specifies that the table is assigned the new copy attribute.

Records with the new copy attribute are allocated new table buffers when the dialog executes at runtime.

NC can be used in place of NEW COPY.

WORk

Specifies that the table is assigned the work attribute.

Records with the work table attribute are available to the dialog as working storage at runtime.

WK can be used in place of WORK.

If no attribute is specified for the named table, WORK is assigned as the default. If NEW COPY is specified for the table, WORK is not automatically assigned; the application developer must explicitly specify the work table attribute.

Expansion of record-options

VERsion is version-number

Specifies the version number (in the range 1 through 9999) of the named record.

If a version number is not specified, VERSION defaults to the system default version number, as specified in the OOAK record at system generation.

If no system default version number is specified in the OOAK record, VERSION defaults to 1.

The equals sign (=) can be used in place of IS.

NEW copy

Specifies that the record is assigned the new copy attribute.

Records with the new copy attribute are allocated new record buffers when the dialog executes at runtime.

NC can be used in place of NEW COPY.

WORk

Specifies that the record is assigned the work attribute.

Records with the work record attribute are available to the dialog as working storage at runtime.

WK can be used in place of WORK.

If no attribute is specified for the named record, WORK is assigned as the default. If NEW COPY is specified for the record, WORK is not automatically assigned; the application developer must explicitly specify the work record attribute.

Expansion of version#-options

version-number

Specifies a single version number for the selected dialogs.

low-version-number high-version-number

Specifies all versions of the selected dialogs within the version-number range (inclusive).

The default version number is 1.

Usage

Considerations

The DIALOG clause must be the first clause of a dialog expression.
The MAINLINE, SUBSCHEMA, MAPNAME, AUTOSTATUS, STATUS DEFINITION RECORD, ACTIVITY LOG, SYMBOL TABLE, DIAGNOSTIC TABLE, MESSAGE PREFIX, COBOL MOVE, ENTRY POINT, and RETRIEVAL LOCKING clauses can appear in any order, but must precede the first RECORD clause.
The PAGING MODE, BACKPAGE, and PAGING TYPE clauses can be specified only if the dialog's map is pageable. These clauses can appear in any order, but must follow the MAPNAME clause and precede the first RECORD clause.
All RECORD clauses must precede the first PROCESS clause.
PREMAP PROCESS and RESPONSE PROCESS clauses can appear in any order, provided that the above requirements are met.

Example 1: Recompiling all dialogs

All dialogs in the load area are recompiled:

COMPILE FROM LOAD ALL.

Example 2: Recompiling dialogs by version number

All dialogs with version number 2 and version numbers 5 through 8 are recompiled:

COMPILE FROM LOAD ALL VERSION ( 2 ( 5 8 ) ).

Example 3: Recompiling dialogs by name

All dialogs with names that begin with C and that have the letters D and R in the fourth and fifth positions are recompiled:

COMPILE FROM LOAD DIALOG (C**DR***).

Example 4: Recompiling dialogs within a specified range

Dialogs QWERT001 through ZZZZZZZZ are recompiled:

COMPILE FROM LOAD DIALOG ( ( QWERT001 ZZZZZZZZ ) ).

Example 5: Recompiling an added dialog

The dialog SXADIAL is added and compiled:

COMPILE FROM SOURCE
  ADD DIALOG SXADIAL VER IS 1 MAINLINE YES
  ADD SUBSCHEMA DEMOSS01 SCHEMA DEMOSCHM VER 1
  ADD MAPNAME SXA1 VER IS 1
  ADD REC CUSTOMER VER 2 NC
  ADD REC SXAREC1 VER 1 NC WK
  ADD PREMAP SXAPREMAP VER 1
  ADD RESPONSE PROCESS NAME SXARESP5 VER 2 CONTROL KEY
      PF5 EXEC NO
  ADD RESPONSE PROCESS NAME SXARESP3 VER 1 CONTROL KEY ENTER
      RESPONSE FIELD SXARESP4 EXEC NO.

More information:

CA ADS Runtime System

Control Commands

CA ADS Dialog Compiler (ADSC)

Error Handling

Debugging an CA ADS Dialog

Activity Logging for an CA ADS Dialog

Database Specifications Screen

Introduction to Process Language

Map Commands

Database Access Commands