MSKDOC print documentation for mask and applications<br />MSKPRT print an image of the generated screen<br /># <br />Screen Detail<br />## <br />MSKDEF Screen Painter<br />The principle method for adding, modifying, or deleting screen detail field definitions is via the online screen (cont.)<br />painter, MSKDEF. All work is done using an image of the screen mask as it will appear when generated, with the addition (cont.)<br />of special display characters to indicate where field attribute codes will be. This enables you to continuously observe (cont.)<br />the results of changes as you make them.<br />## <br />Mode of Operation<br />The image of a mask is made up of a collection of one or more screen fields. Each screen field has an individual record (cont.)<br />defining it in the MAGEC repository, enabling you to manipulate it with the maximum of flexibility.<br />There are two types of screen fields: variables and constants. A variable is a field which has a name and which can be (cont.)<br />referenced by the generated program. A constant is named FILLER and cannot be referenced. Constants are used for (cont.)<br />headings, prompts, and the like. It is perfectly acceptable for a heading or prompt to be a variable, as well. This (cont.)<br />enables you to have headings or labels on the screen which you can alter from your program. Every field, whether (cont.)<br />variable or constant, has its own discreet definition in the repository and can be modified via the MSKDEF (cont.)<br />facility.<br />A common structure for screens is to have pairs of fields, one constant and one variable. For example:<br />@Emp#@<br />_________><br /> <br />In the above example the at-signs (@) show where the field attribute bytes will reside. There are two screen fields, (cont.)<br />one is a constant which contains the value "Emp#" and the other is a variable which contains a value of all (cont.)<br />underscores. The variable field is where the program would move the actual employee number to be displayed, it is also (cont.)<br />optionally an enterable field where the operator can key in an employee number. The greater-than symbol (>) indicates a (cont.)<br />"stopper", a dummy field having an attribute but not data, which is used to terminate the preceeding field. There is (cont.)<br />not a stopper after the first field (the constant) because another field immediately follows it, serving as a stopper (cont.)<br />for it.<br />The MSKDEF facility allows you to select a field by pointing the cursor to it and pressing a PF key. The choice of (cont.)<br />which PF key was hit determines what is to be done to the selected field. For example, pressing PF18 would indicate (cont.)<br />that you wished to change the specifications for that field, pressing PF19 would indicate that you wished to delete (cont.)<br />that field from the mask, and so on.<br />There are also line manipulation functions which enable you to operate upon all fields on the selected line at one (cont.)<br />time. For instance, you could move an entire line to another line on the screen, or you could delete all fields on a (cont.)<br />line. To use the line manipulation functions you simply position the cursor anywhere on the line you wish to operate (cont.)<br />upon and press the appropriate PF key.<br />A legend of the PF keys and their meanings is displayed on the last three rows of the MSKDEF screen along with (cont.)<br />statistics about the mask. The PF keys are divided into "field manipulation" and "line manipulation" keys in the (cont.)<br />legend.<br />| ```<br /> MSKDEF xxx<br />  M A G E C  Development Process Selection<br />  Press PF7  -  for the semi-automated development process which allows you to<br />  provide Cobol code to construct the key(s) to use to join<br />  additional Data Classes to the primary Data Class.<br />  Press PF8  -  for the fully-automated development process which generates the<br />  join logic completely based upon your selections and using the<br />  Domain definitions for Data Items.<br />  Press PF3  -  to return to the manual screen painter which provides complete<br />  flexibility to manually draw a screen, define attributes, and<br />  code join logic.<br />Choose the level of automated development you desire.  The fully-automated<br />process is preferred.  The semi-automated process is necessary only if your<br />data has not been defined using MAGEC's Domain facility.<br />```** <br />Figure 04 --  MSKDEF Screen<br />**<br />NOTE:<br />**<br />If there are currently no screen fields defined for the mask number specified, MSKDEF presents a selection screen (cont.)<br />asking you to choose which level of automated assistance you desire. In this *Screen Painting* section of the (cont.)<br />"Programmer's Reference" manual we will concern ourselves primarily with the "manual" screen painting operations which (cont.)<br />you can select by pressing PF3 when the above selection screen appears.<br />## <br />Detail Field Specifications<br />When you select a screen field for "change", a pop-up window shows you all of the specificatons for that field. You can overtype them to make your changes. They are:<br />**Scrn Fld Nm:** is the name to be used for this screen field in the generated mask copybook. This name may be up to (cont.)<br />seven characters long. In the copybook you will find the actual screen field defined using this exact name, plus (cont.)<br />various other related fields named using this name with a suffix added. For example: the attribute byte for the field (cont.)<br />named "SFIELD" would be named "SFIELDA", the edit picture for it would be named "SFIELD-ED" (if it were a numeric (cont.)<br />item).<br />The occurrence [**( ... )**] is the Cobol subscript value used to access this field, if it is part of an array. A value (cont.)<br />of 000 indicates that the field is not part of an array and that no subscript is needed. A value of 001 thru 099 is the (cont.)<br />actual occurrence number or subscript value to be used. A value of "*nn" indicates that this field is a repeating (cont.)<br />field<br />it is occurrence 01 of an array and MAGEC is to automatically generate occurrences 02 thru nn aligned vertically below. (cont.)<br />A value of "#nn" is similar to "*nn" except that the array is repeated horizontally, rather than vertically. When you (cont.)<br />use either of these automatic repeating field specifications, MAGEC displays the generated occurrences on the MSKDEF (cont.)<br />screen exactly where they will appear on the generated mask. It uses a ditto (") to indicate where the attribute for (cont.)<br />each field will be, rather than the usual at-sign (@).<br />**Database Source/Targe****t:** is the Cobol name of the database field which is both the source (for displays) for (cont.)<br />this screen field, and the target (for updates) from this screen field. This may be the name of a database field or of (cont.)<br />a work field in your MMP's data division. If you leave this blank, MAGEC will simply not generate any moves to or from (cont.)<br />this screen field<br />you can code your own moves through customization, though. The name given in this parameter may contain a subscript (cont.)<br />enclosed in parentheses, just as you would spell it in Cobol coding. If the screen field is part of an array (that is, (cont.)<br />if the occurrence number is non-zero), then the subscript for the source/target may be a relative subscript. For (cont.)<br />example: a subscript of [(*)] means that the source/target subscript is the same as the occurrence number of the screen (cont.)<br />field, a subscript of [(*+12)] means that the subscript for the source/target is the occurrence number of the screen (cont.)<br />field plus twelve (negative offsets are also possible, but not much used). Certain datanames are recognized by MAGEC as (cont.)<br />being "read-only. In those cases MAGEC generates the move to the screen for displays but does not generate a move from (cont.)<br />the screen to the source/target field for updates. Examples of such names are: CURRENT-DATE, TWA-IPL-DATE, TWA-TIME, (cont.)<br />and others.<br />**Row:** is the screen row number on which this field begins. Screen fields may extend for multiple rows by "wrapping (cont.)<br />around" beyond the end of the line. Since MAGEC automatically defines rows 001, 022, 023, and 024, you are restricted (cont.)<br />to rows 002 thru 021. The row(and column) is initially set by MAGEC when you draw a new field onto the mask or when the (cont.)<br />automatic painter generates the initial mask. You can change it, though.<br />**Col:** is the screen column number in which this field begins.Valid columns are 001 thru 080.<br />**Lgth:** is the length in characters (bytes) of this screen field, not including the leading attribute or trailing (cont.)<br />stopper, if any. If you change the length you should be careful to also change the value in the screen field shown in (cont.)<br />the screen image. MAGEC edits to be sure that the field is large enough to contain the value shown.<br />| ```<br />**<br />MSKDEF nnn  ................ ............. ...<br />@<br />MAGEC SCREEN PAINTER  (PFKEYS) --FIELD: 18=CHG 19=DEL 20=DUP 21=MOVE<br />LAST GEN=93 08 05 --LINE: 4=DUP 5=ERASE 6=MOVE 13=DEL 15=INS<br />LAST UPD=93 06 22 2494 BYTES MAX, nnnn USED, nnnn LEFT  PF24=POP-UP HELP**<br />``` <br />*** <br />Figure 05 --  MSKDEF with Window Displayed<br />Attr****:** is the six-character symbolic attribute name which specifies the field attribute code. Each position of the (cont.)<br />six-character name represents a unique attribute, only certain combinations are allowed. For example: UADRNF means (cont.)<br />Unprotected, Alphanumeric, Displayable, Regular-intensity, Non-selector-pen-detectable, modify-data-tag-ofF. When you (cont.)<br />are using MSKDEF you can press PF24 (Alt-F4, on a PC) any time to request a pop-up window of special help text which, (cont.)<br />among other things, gives the meanings and codes for each character of the attribute name.<br />**Clr:** is the 3270 color code for this screen field. A value of 0 (or "D")indicates that you do not want extended (cont.)<br />color support for this screen field. A value of 1 thru 7 (or their letter code equivalents) indicates that you want (cont.)<br />extended color support and the initial color desired. You can press PF24 for the pop-up help which lists all the valid (cont.)<br />color codes and their meanings.<br />**Typ****e:** is the one-character edit type code which controls the automatic field-level editing done by MAGEC, and (cont.)<br />the Cobol definitions generated for the screen field in the mask copybook. The PF24 pop-up help text lists all the (cont.)<br />valid type codes. Refer to the ["Edit Types"](/DOC/magref_main.htm#MAGREF002001) reference table for a complete (cont.)<br />list.<br />**Sig:** is the number of significant digits left of the decimal point. This has no meaning for alphanumeric type (cont.)<br />fields. The maximum value is 13. For date type fields this parameter is used to indicate the number of digits in the (cont.)<br />year, either 2 or 4.<br />**Dec****:** is the number of digits right of the decimal point (max. is 09). It has no meaning for alphanumeric type (cont.)<br />fields. For dates this parameter is used to control the maximum number of years old that a date may be, i.e. if you set (cont.)<br />this parameter to 03, and this is 1989, then a date of 1985 would be rejected by the automatic editing as being too (cont.)<br />old.<br />**Edit Table****:** has meaning only for edit type "T" fields. It is the three-digit (001 thru 999) lookup table number (cont.)<br />against which this field is to be edited by the automatic editing. The number used must be a valid, defined table (cont.)<br />number in MAGEC<br />**W-Fld****:** has meaning only if the edit type for this screen field is "T". It is the seven-character name of the (cont.)<br />screen field into which MAGEC is to set the description (from the lookup table entry) corresponding to the value (cont.)<br />entered into this field. For example: if this field is a type T field using table 003 (State & Province Code Table), (cont.)<br />and the operator has entered "TX" into it, the description "TEXAS" would be displayed in the field named as this (cont.)<br />field's W-Field. The name you enter into this parameter must be a valid, defined screen field name in this same mask; (cont.)<br />further, the field having that name must be specified as an edit type "W" (hence, the term W-field). The only exception (cont.)<br />is that MAGEC will accept a specification of the type "T" field as the W-field for itself. This would result in an (cont.)<br />automatic code translation, i.e the operator enters TX into a field and it is automatically converted into TEXAS in the (cont.)<br />same field on the screen.<br />The W-field occurrence [**( ... )**] is a modifier for the W-field name. It is the occurrence number, or subscript. A value of 000 means that this W-field is not an arrayed field.<br />**Req:** is a parameter specifying that this field is (R) required, or (O) optional. Optional fields may be left blank by the operator and will default to spaces or zero, depending on edit type.<br />**Loc****:** is the designator for the position of this field on the generated browses. A value of 0 indicates that (cont.)<br />this field does not appear on the browses. A value of 1 thru 9 indicates the relative position, left to right, of this (cont.)<br />field on the browses.<br />| ```<br />**<br />MSKDEF nnn  ................ ............. ...<br />@<br />MAGEC SCREEN PAINTER  (PFKEYS) --FIELD: 18=CHG 19=DEL 20=DUP 21=MOVE<br />LAST GEN=93 08 05 --LINE: 4=DUP 5=ERASE 6=MOVE 13=DEL 15=INS<br />LAST UPD=93 06 22 2494 BYTES MAX, nnnn USED, nnnn LEFT  PF24=POP-UP HELP<br />```** <br />** <br />Figure 06 --  MSKDEF with Window Displayed<br /># <br />MSKDEF Functions<br />## <br />Getting Help<br />There are several types of online help available to you while you are using the MSKDEF function. You should take advantage of them to ease your task and reduce the need to remember codes.<br />For hardcopy tables of code values, copy the appendices from your tutorials.<br />For general explanation for the MSKDEF function and field specifications:<br />press PF1 (F1, on a PC)<br />For a pop-up window listing color codes, attribute codes, and other useful screen definition information:<br />press PF24 (Alt-F4, on a PC)<br />## <br />Using a Mouse<br />On a PC or LAN, MAGEC supports most Mouses (or Mice, as you prefer). You do not need a Mouse to use MAGEC, the Mouse (cont.)<br />merely is a convenient way to do many commonly used functions. MAGEC can be used in Text (character) mode or in GUI (cont.)<br />(Graphical User Interface) mode and the usage of a mouse differs. In GUI mode, there is a menu bar, pull-down menus, (cont.)<br />pushbuttons, and icons to mouse-select all of the MSKDEF functions. In Text mode, there are PF key instructions on the (cont.)<br />screen. Pointing to the PF key instruction and clicking the left mouse button causes that PF key to be depressed (cont.)<br />(logically). This works much like pushbuttons and icons in GUI mode.<br />## <br />Changing a Field<br />The PF18 (Shift-F8, on a PC) key is used to change specifications for a screen field. To change any of the parameters for a screen field:<br />position the cursor onto the desired field<br />(anywhere in the field, but not on the "stopper")<br />press PF18<br />(window appears with all of that field's specifications)<br />overtype any of the specifications you wish to change<br />press ENTER<br />(message in SCOMPL tells you either that your change was completed or gives you an error message)<br />## <br />Changing a Field (continued)<br />To change the literal value for any field:<br />overtype the literal value directly onto the screen image<br />(if you move the stopper, you should also change the field's length specification accordingly<br />see below)<br />position the cursor onto the desired field<br />(anywhere in the field, but not on the "stopper")<br />press PF18<br />(window appears with all of that field's specifications)<br />change any specifications, if desired<br /><br />next: msk03.md.txt