Modifying IOA Screens and Constants

IOA screens and constants can be adapted by the user for local language, local site terminology, ease of use, and so on.

IOA screen and constant members are stored in the IOA MSGxxx library, where xxx is a three-character language identifier (for example, ENG for English, GER for German). According to this naming convention, at English speaking sites the library is the IOA MSGENG library.

Throughout this guide, the English version of this library, MSGENG, is referenced. Substitute the appropriate library name where applicable if English is not the language at your site.

The naming convention for these members is:

CTxSyyyz

Table 22 Naming Convention for Language Members

Field	Description
x	Single character indicating the product (for example, M for a Control‑M screen)
yyy	Three‑character screen identifier
z	Single character indicating the language of the screen (for example, E for English, G for German)

Each member contains definitions for either a screen and its constants, or a set of constants. Definitions are specified as Assembler macro instructions. Each member must be assembled and link edited to create a CSECT and module with a name identical to the screen member name.

A screen is defined by the following macros in the IOA library:

Table 23 Macros that Define a Screen

Macro	Description
IOASACT	Start screen and constants definition (one IOASACT macro for each screen definition).
IOASBLK	Start a block of fields and constants.
IOASFLD	Define a field in the screen and constant.
IOASEND	End screen and constant definition (one IOASEND macro for each screen definition).

Each unit of data in an IOA screen is called a block. A block can contain one or more fields.

Examples

The header block is composed of two or more lines that contain the header line, the command field, the scroll field, and so on.

The following line at the top of the Control‑M Job List screen is a block:

'====>>>>>> TOP OF ACTIVE JOBS LIST <<<<<<===='

Within each block, the location of the fields can be changed. It is possible to change the length of fields that are defined as skip protected and contain constants. Do not change the length of unprotected data fields unless specifically permitted in the member. The length of a field does not include the attribute byte. The total accumulated length of the fields within a block that describes screen lines remains the same after modifications have been made. This restriction does not apply to blocks used for defining constants.

Each block is line‑oriented. The total length of each block must be the number of lines in the block multiplied by the length of the line.

Do not change the location and contents of macros IOASACT, IOASBLK, and IOASEND. Changes can be applied only in the contents (parameters) of macro IOASFLD.

Macro IOASFLD defines a field in the screen. The format is

NAME=[field_name,][parameter=value,...]

If a name has been specified, do not change it.

Table 24 Fields for Defining Screen Fields Using Macro IOASFLD

Field	Description
ATTR=code	Field attributes. Refer to macro CTMSATT in the IOA MAC library.
LTH=m	Length without attribute byte. If not specified, the length of the DATA text is used. The real length of the field is always one more than that specified in the LTH field to account for the attribute byte.
DATA=‘text’	The data in the field (if any) in quotes.
PROF=Y \| N	Indicates whether the value of the field (when exiting the Online environment) is saved in the user’s profile member and used at the next invocation of the environment. Optional. Valid values: Y (Yes) N (No). Default Note: Not all fields can use profiled values.
COLOR=color	Color of the field. Valid Values: RED, BLUE, PINK, GREEN, TURQUOISE, YELLOW, WHITE, TURQ and NO.
HILITE=hilite	Highlight technique for the field. Valid values: BLINK, REVERSE, USCORE and NO.

Parent Topic

Customizing IOA Screens