HP 3000 Manuals

Editing Form Attributes [ HP RPG/XL Utilities-Part 3 SIGEDITOR ] MPE/iX 5.0 Documentation


HP RPG/XL Utilities-Part 3 SIGEDITOR

Editing Form Attributes 

You can assign form attributes for each form and field attributes to each
field in a form.  Specifications or attributes describe how the form or
field is formatted when used by a program.  These settings are
recorded and stored by SIGEDITOR. SIGEDITOR does not respond to the
specifications, but stores them for later use by the RPG runtime library.
See chapter 4 for more information about using forms with RPG.

To edit form attributes, enter a valid form name in the edit main menu
and press  f2  (EDT FORM ATTRIB).

A set of form attributes appear on the screen after the main menu, as
shown in Figure 2-1.  The screen appears when you press the  f2  key (EDT
FORM ATTRIB). Figure 2-1 shows the default form attributes.  These
default values dictate how SIGEDITOR treats the form, unless you tab to a
field and enter a new value.
______________________________________________________________________________________________
|                                                                                            |
|           Form Name                     FORM1     Start line number     01                 |
|                                                                                            |
|           Number of lines to clear      24        Uppercase only         Y                 |
|                                                                                            |
|           Sound alarm                   N         Override fields        N                 |
|                                                                                            |
|           Exception output              N         Forms cache *GLOBAL    N                 |
|                                                                                            |
|           Suppress input                N         Return input           Y                 |
|                                                                                            |
|                           Erase input fields                N                              |
|                                                                                            |
|     ---------------------------------------------------------------------------            |
|                                                                                            |
|                                          PRNT   ROLL   ROLL               REC              |
|                                                  UP    DOWN  CLEAR  HELP  BKSPC            |
|           Retain function keys  N or                                                       |
|                                                                                            |
|                                           A    B   C   D    E   F   G   H    I   J   K   L |
|           Retain command keys   N or                                                       |
|                                                                                            |
|                                           M    N   P   Q    R   S   T   U    V   W   X   Y |
|                                                                                            |
|                                                                                            |
|                                                                                            |
|                                PRESS ENTER: TO CONTINUE                                    |
|                                                                                            |
|                                                                                            |
|                                                                                            |
______________________________________________________________________________________________

          Figure 2-1.  The Form Attribute Screen 

After editing the form attributes, you must save or abandon the changes.
To save them, press  ENTER ; to abandon them, press  f7 .  In either
case, you return to the edit main menu.

The next sections describe each form attribute.

Form Name 

Legal values are letters A-Z, @, $, #, digits, or blanks. 

The Form Name specification assigns a name to the form being designed.
Within a forms file, each form name must be unique, but the same form
name can be used in different forms files.  A form name can have eight
characters and must begin with a letter, @, $, or #; the remaining
characters can be letters, digits, @, $, #, or embedded blanks.  The only
way to rename a form is to change the name from this menu.

Start Line Number 

Legal values for this field are 1-24 and V. 

The Start line number specification is the line number on which the form
begins when it appears on the screen for data entry.  The start line
number is relative to the first line on the display (line one).  Valid
start line numbers are less than or equal to the number of lines on the
screen (24 lines).  If no value is entered, SIGEDITOR assumes that line
one is the starting line.  If you enter "V", the form has a variable
starting line number obtained from a field in the RPG program as it is
executing.  The field is named in a "KSTART" continuation record in the
workstation F-specifications.


NOTE Regardless of the start line number you set, the form appears to start on line one of the display. The form placement is not adjusted on the design screen, but is displayed correctly by an RPG program. For example, if you specify 10 as the start line number, you do not have to space down to the tenth line of the screen when creating the form. If you do, the form begins on line 20 when displayed by your program. Be careful not to design a form that exceeds 24 lines.
Number of Lines to Clear Legal values for this field are 0-24. Number of lines to clear specifies the number of lines to be cleared on the display before the form appears. Clearing begins at the line specified as the start line number. For example, if line three is given as the start line number and the number of lines to clear is eight, lines three through ten are cleared. The number of lines to clear plus the start line number must not exceed 24. If a value is not given, 24 lines (the default) are cleared.
NOTE The number of lines to clear and the start line number can be used to overlay one form with another. Use caution when overlaying a form with output fields with forms with input fields. All fields must be aligned or unpredictable results occur (see chapter 4 for more details). Clear all lines if you do not want to overlay forms.
Uppercase Only Legal values for this field are Y and N. If you specify Y (yes) in the Uppercase only specification, alphabetic characters entered by a user are returned to the screen and to your program in uppercase. If you specify N (no), lowercase data entered by the user are not returned to your program upshifted. Sound Alarm Legal values or this field are Y, N, and 01-99. If you specify Y (yes) in the Sound alarm specification, an audible alarm sounds when the form is displayed. If you specify N (no), no alarm sounds. If you specify an indicator 01 through 99 and turn it on in your program, the alarm sounds when the form is displayed. Override Fields Legal values for this field are Y, N, and 01-99. An Override fields operation allows you to override (alter) fields in a form when the form is redisplayed. Only those fields modified as a result of an override operation are redisplayed. You can use an override operation if the user enters invalid data into a field and you want to flag the field in error. During an override operation, if an indicator 01 through 99 is specified and turned on, then: * If a field has an indicator in the output data entry (see "Field Attributes") and the indicator is off, the data entered in that field is unchanged. Any field with a Y or N in the output data entry is also unchanged. * If a field has an indicator in the output data entry and the indicator is on, the field is displayed with data from the program. If the field is also input capable, data that was entered into the field by the user is lost. * Form and field attributes that are controlled with indicators will be changed according to the current state of those indicators. If you specify Y (yes) in the Override fields specification, the override operation is performed each time the form is displayed.
NOTE Using Y is not recommended because only those fields with indicators on will be displayed when the form is initially displayed. Screen resident constants are not indicator controlled, thus they will never be displayed.
If you specify N (no), no override operation is performed on that form. Exception Output Legal values for this field are Y and N. Exception output is used to force the immediate display of a form. If Y (yes) is specified, the form is output at exception time. If N (no) is specified, the form is output prior to the next read from the WORKSTN file. Forms Cache (*GLOBAL) Legal values for this field are Y and N. The Forms cache (*GLOBAL) determines the form name stored in the forms cache directory when the form is downloaded.
NOTE Forms can be downloaded using the DOWNLOAD command of the Process Monitor software product, PROCMON. Currently, only the 2394A and 700/94 terminals support forms downloading. For more information, see the PROCMON/3000 Reference Manual.
If Y (yes) is specified, the name of the form in the forms cache directory consists of the form name and *GLOBAL. This allows a form that is in multiple forms files to be accessed as the same form from the forms cache. If N (no) is specified, the name of the form in the forms cache directory consists of the form name and the form filename that contains the form. Suppress Input Legal values for this field are Y, N, and 01-99. If Y (yes) is specified in the Suppress input specification, or an indicator is specified and the indicator is on, all input fields on the form will be returned to the RPG program as blanks. If N (no) is specified or an indicator is specified and the indicator is off, the input field will be returned to the RPG program normally.
NOTE If you specify Y (yes), input can never be read from the form.
Return Input Legal values for this field are Y and N. If Y (yes) is specified in the Return input specification, all input fields in the form are returned to your program, even if the user did not enter any data in the form. If N (no) is specified, data from input fields is returned only if the user enters data. If the user does not enter any data on the screen, all input fields are filled with blanks. Information does not have to be entered into mandatory enter fields (see "Field Attributes"). Erase Input Fields The legal values for this field are Y, N, and 01-99. The Erase input fields specification erases the input fields on a form. It is helpful to erase input fields when a user must enter information into the same form so that the form does not have to be redisplayed. If Y (yes) is specified in the Erase input fields specification, input fields are erased each time the form is displayed. If N (no) is specified or this entry is left blank, no erase input fields operation is allowed. If an indicator is specified in this field and is enabled in your program, the erase input fields operation is performed on the form only when the indicator is turned on. If the indicator is not on, the form is displayed normally. Retain Function Keys Legal values for this field are Y and N. Function keys are used to return status information to the RPG program. When the user presses a function key, a four-digit numeric status code is placed in element one of the status array. You can test function keys f1 through f8 by examining element one of the status array for the codes shown in Table 2-1. If Y (yes) is specified in the Retain Function Keys specification, the function keys that were enabled for the previous form are retained when this form is displayed. If N (no) is specified, the function keys active for the previous screen are not retained, and the user can enable new function keys for this form. Table 2-1 describes each function key. Table 2-1. Function Keys ----------------------------------------------------------------------------------------------- | | | | | Function Key | Description | Status Code | | | | | ----------------------------------------------------------------------------------------------- | | | | | f2 | print screen | 1121 | | | | | | f3 | roll up | 1122 | | | | | | f4 | roll down | 1123 | | | | | | f5 | clear | 1124 | | | | | | f6 | help | 1125 | | | | | | f7 | record backspace | 1126 | | | | | ----------------------------------------------------------------------------------------------- Enable a function key by placing any character in the space identified by the function number. The function key is enabled for a specific use that you determine in the RPG program. If a space is left blank, that function is not enabled.
NOTE The f1 key is reserved for the "command" key. The f8 key is used as the "dup" (duplicate) key.
Print Screen Key Legal values for this field are Y and N. If you enable the Print key for the current form, you determine its function. If you do not enable the Print key for the current form, pressing the Print key causes the contents of the display screen to be printed. The default device is LP, using the filename RSIPRINT. An asterisk (*) to the left of the Print key label indicates that the Print key is not enabled for this form. Retain Command Keys Legal values for this field are Y and N. Command keys are used in RPG programs to set indicators (KA-KN, KP-KY). When the user presses a command key, indicators are set that the program can use to perform the desired function. The command keys are independent of the function keys. If Y (yes) is specified in the Retain command key specification, the command keys that were active for the previous form are retained when this form is displayed. If N (no) is specified, the active command keys are not kept and you can enable new command keys for this form. Letters A through N on the Form Specification Screen correspond to command key indicators KA through KN. Letters P through Y correspond to indicators KP through KY. Command keys are enabled for a form by placing any character in the field corresponding to the command key. If a field is left blank, the corresponding command key is not enabled. The command key indicators are used in the RPG program to control the flow of operation. Refer to the HP RPG/XL Reference Manual, chapter 11 for a detailed list of command keys.


MPE/iX 5.0 Documentation