Maintaining Application Components › Maintaining Panels › Panel Statements › #ERR Statement

#ERR Statement

This statement defines action to be taken during error processing.

The #ERR statement is a panel control statement that determines the processing required when a panel is being redisplayed following an error condition.

An error condition can be detected either by Panel Services internal validation or by the processing NCL procedure. If detected by internal validation (and &CONTROL PANELRC is not in effect), error processing is automatically invoked by Panel Services. If detected by the processing NCL procedure, error processing is invoked in one of two ways:

• Using the &ASSIGN OPT=SETERR verb
• By nominating the name of the variable that identifies the invalid input field on the ERRFLD operand of the #OPT statement. This is dynamically invoked by using a symbolic variable with the ERRFLD operand and setting this variable to the name of the variable (minus the ampersand) that identifies the field in error.

Note: For information about using this technique, see the Network Control Language Programming Guide.

When #ERR processing is initiated, the cursor is positioned to the first field in error and the panel is redisplayed, applying the attributes defined on the #ERR statement to the fields in error. This technique provides the panel user with a simple means of drawing the terminal operator’s attention to the field in error. This is particularly effective on color terminals where the color of any field in error can be altered for the duration of the error, and reverts to normal when the error condition is rectified.

One or more #ERR statements can be defined in any order. However, as with #OPT, #FLD, and #NOTE statements, any #ERR statement must precede the start of the panel, which is determined by the first line that is not a control statement.

This statement has the following format:

#ERR [ INTENS={ HIGH | LOW } ]
   [ { COLOR | COLOUR }={ BLUE | RED | PINK | GREEN |
                        TURQUOISE | YELLOW | WHITE | DEFAULT } ]
   [ { HLIGHT | HLITE }={ USCORE | REVERSE | BLINK | NONE } ]
     [  ALARM={ YES | NO } ]

INTENS={ HIGH | LOW }

Determines the intensity of the error field when displayed. The INTENS operand is ignored for terminals with extended color and highlighting when either the COLOR or HLIGHT operands are specified.

HIGH specifies that the field is displayed in double intensity.

LOW specifies that the field is displayed in low or standard intensity.

{ COLOR | COLOUR }={ BLUE | RED | PINK | GREEN | TURQUOISE |
                                                YELLOW | WHITE| DEFAULT }

Determines the color of the field. It applies only to IBM terminals with seven-color support and Fujitsu terminals with three- or seven-color support.

The COLOR operand is ignored if the terminal does not support extended color. This enables COLOR to be specified on panels that are displayed on both color and non-color terminals. COLOR can be used in conjunction with the HLIGHT operand.

For Fujitsu terminals that support extended color data streams, but support only three colors, the following color relationships are used:

GREEN

When GREEN is specified, it produces a result of GREEN on a Fujitsu three-color terminal.

RED

When RED is specified, it produces a result of RED on a Fujitsu three-color terminal.

PINK

When PINK is specified, it produces a result of RED on a Fujitsu three-color terminal.

BLUE

When BLUE is specified, it produces a result of GREEN on a Fujitsu three-color terminal.

TURQUOISE

When TURQUOISE is specified, it produces a result of GREEN on a Fujitsu three-color terminal.

YELLOW

When YELLOW is specified, it produces a result of WHITE on a Fujitsu three-color terminal.

WHITE

When WHITE is specified, it produces a result of WHITE on a Fujitsu three-color terminal.

DEFAULT

When DEFAULT is specified, it produces a result of GREEN on a Fujitsu three-color terminal.

Fujitsu seven-color terminals are treated the same as IBM seven-color terminals.

The DEFAULT keyword indicates that the color of the field is determined from the INTENS operand. This is particularly useful if you want to set the color from an NCL procedure (that is, COLOR=&COLOR is specified and the NCL procedure can set the &COLOR variable to DEFAULT).

{ HLIGHT | HLITE } = { USCORE | REVERSE | BLINK | NONE  }

Applies only to terminals with extended highlighting support, and determines the highlighting to be used for the field.

Because the HLIGHT operand is ignored if the terminal does not support extended highlighting, HLIGHT can be specified on panels that are displayed on terminals that do not support extended highlighting. HLIGHT can be used with the COLOR operand.

When NONE is specified, the HLIGHT operand is ignored and no extended highlighting is performed for this field.

ALARM={ YES | NO }

Turns the terminal alarm on or off if the panel is displayed with an error condition. This works independently of the ALARM operand on the #OPT control statement.

Examples:

#ERR COLOR=RED HLIGHT=REVERSE ALARM=YES
#ERR COLOR=YELLOW HLIGHT=BLINK INTENS=HIGH

Notes:

• Only those attributes defined on the #ERR statement are modified for the field in error. All other attributes associated with the original field, such as internal validation, remain intact
• Symbolic variables can be included in a #ERR statement. Variable substitution is performed before processing the statement, by using variables available to the NCL procedure at the time the &PANEL statement is issued.
• When &CONTROL PANELRC is in effect, internal validation does not automatically reshow the panel with the error message, and so on. In this case, the procedure regains control following the &PANEL statement with the &RETCODE system variable set to 8 to indicate that an error has occurred. The &SYSMSG variable contains the text of the error message that describes the error and the &SYSFLD variable contains the name of the field in error. This name is the name of the variable in an input field that receives the data entered into that field.
• The &ASSIGN statement SETERR option provides a mechanism for assigning #ERR field attributes to multiple (input field) variables before displaying a panel. This lets you accept input from a number of different fields on a panel, validate all the fields and then redisplay the panel with all incorrect fields displayed with the #ERR attributes. This shows the user all the errors at one time, rather than field by field.