Found in Model:<br />MODELMMP MODELWIN<br />Location:<br />PROCEDURE DIVISION -- AAM755-GOODCHG<br />Description:<br />This logic will be executed only on a xxxCHG function and only after a successful database update to the Primary Data (cont.)<br />Class. If the return code from the I/O indicates an error then the %UPDERR logic will be executed (cont.)<br />instead.<br />The default logic simply MOVE's the UPDATED-MSG to the screen field, SCOMPL, then fetches to the SEE function to re-display the updated data.<br />Suggested Uses:<br />You may want to update another record/file after a successful update of the Primary Data Class, perhaps some of the files which were Logically Joined in the %JOIN routines.<br />The Primary Data Class' data is still available to you in the TWA-DB-DATA area, you may reference it.<br />This would be a good place to "post" to a control record.<br />You might wish to transfer to another screen, function, or program after a successful update. You can do so by coding:<br />MOVE 'xxxxxx' TO SFUNCT.<br />MOVE FTH-FUNCT TO TWA-NONTP-REQUEST.<br />GO TO AA900-GOBACK.<br />where xxxxxx is the desired "next function" you wish to transfer to.<br />An example of this might be a case where, after an update to an Invoice on the Invoice file (function IVCCHG, perhaps), (cont.)<br />you wish to transfer immediately to the Customer display screen to show the effect on the Customer's status. Assume (cont.)<br />that the function code is CUSSEE, and that the Customer number from the Invoice record is to be used as a key to read (cont.)<br />the Customer file with.<br />In the IVCCHG program (MMP), in the insertion point %GOODCHG, you could code:<br />MOVE 'CUSSEE' TO SFUNCT.<br />MOVE FTH-FUNCT TO TO TWA-NONTP-REQUEST.<br />MOVE IVC01-CUSTOMER-NO TO SKEY.<br />GO TO AA900-GOBACK.<br />Cautions:<br />To exit this routine be sure you GO TO AA800-SEND-SCREEN or to AA900-GOBACK to avoid falling through to the irrelevant logic below.<br />### <br />Online Insertion Point<br />%GOODDEL<br />Found in Model:<br />MODELMMP MODELWIN<br />Location:<br />PROCEDURE DIVISION -- AAM757-GOODDEL<br />Description:<br />This logic will be executed only in xxxDEL functions and only after a successful delete of the Primary Data. If a bad (cont.)<br />return code is sensed (the delete failed) then the %UPDERR logic will be executed instead.<br />The default logic simply MOVE's the DELETED-MSG to the screen field, SCOMPL.<br />Suggested Uses:<br />You may want to update a control record, or any other file, after a successful delete.<br />You may want to transfer to another function, screen, or program. For example, after the deletion of an Invoice from (cont.)<br />the Invoice file you might want to automatically present the Customer display (function CUSSEE, perhaps) to show the (cont.)<br />effect on the Customer's status. To do that you might code:<br />MOVE 'CUSSEE' TO SFUNCT.<br />MOVE FTH-FUNCT TO TWA-NONTP-REQUEST.<br />MOVE ------- TO SKEY. (customer number)<br />GO TO AA900-GOBACK.<br />Cautions:<br />To exit this routine you should GO TO AA800-SEND-SCREEN or AA900-GOBACK to avoid falling through to the irrelevant coding below.<br />### <br />Online Insertion Point<br />%INIT<br />Found in Model:<br />MODELMMP MODELWIN<br />Location:<br />PROCEDURE DIVISION BA150-MAINT-INIT<br />Description:<br />This logic is executed in the initialization for all MAINT-FUNCTIONs (xxxADD, xxxCHG, xxxSEE, etc.) very early in (cont.)<br />execution of the program. VARIABLE-STORAGE is always set to LOW-VALUES just before the %INIT code is (cont.)<br />executed.<br />Suggested Uses:<br />You can initialize any data and work fields in VARIABLE-STORAGE (or elsewhere) here. This is useful when you have (cont.)<br />defined some of your own custom variables in %VARSTOR or in %DATADEF, particularly if they are COMP-3 and need to be (cont.)<br />set to ZERO to avoid Data Exception errors. In some environments it is permissible to MOVE to WORKING-STORAGE items (cont.)<br />also. Be careful of doing this in any environment in which your program might be "swapped" in and out, such as WESTI. (cont.)<br />It is best to reserve WORKING-STORAGE for constants, that is why the insertion point in WORKING-STORAGE is named (cont.)<br />%LITERAL.<br />Cautions:<br />Do not reference any screen fields except for the standard MAGEC fields (SFUNCT, SKEY, SCOMPL, and SERRMSG) here since (cont.)<br />this logic is executed before the MMP has made sure that the proper Mask format is in effect; it is possible that the (cont.)<br />screen is still formatted with some other MMP's Mask.<br />If you wish to check whether the Mask area is properly formatted, you may do so by coding:<br />IF TWA-MSK-ID = THIS-PGMS-MSK THEN .........<br />### <br />Online Insertion Point<br />%INITATB<br />Found in Model:<br />MODELMMP MODELWIN<br />Location:<br />PROCEDURE DIVISION -- BA200-INIT-ATTRIBUTES<br />BA210-MAINT-SCREEN<br />Description:<br />This logic will be executed only for Maint functions (xxxADD, xxxSEE, etc.) and not for Browse functions. It is (cont.)<br />inserted at the very end of the Attribute Initialization routine, immediately before BA299-EXIT.<br />Suggested Uses:<br />You can override the default Attribute values which are set in BA210-MAINT-SCREEN, perhaps based on the Function Code or even on the Operator ID (TWA-EMP-NO), or any other criteria.<br />All the valid 3270 attribute codes are defined in the MMP in an included "copy book" for your convenience. They are (cont.)<br />named ATxxxxxx (xxxxxx is the six-character code, exactly like you specify online in MSKDEF). They are documented in (cont.)<br />your Developer's Reference Summary and in the appendices of your Developer's Tutorials.<br />You can also alter the contents of any screen fields here. This is handy for setting a variable screen heading based on the Function Code or any other criteria.<br />Cautions:<br />Do not reference Data Items from the file here since the I/O has not yet been done.<br />To exit the routine be sure to GO TO BA299-EXIT, or just fall through to it.<br />Do not reference fields in the Browse screen (MSK652) since this routine is only executed for Maint functions, and after the Maint Mask has been formatted (read in).<br />### <br />Online Insertion Point<br />%JOIN<br />Found in Model:<br />MODELMMP&nbsp; MODELWIN<br />Location:<br />PROCEDURE DIVISION -- JA100-LOGICAL-JOIN<br />Description:<br />This logic is executed after each of the standard READ's of the Primary Data Class. It is used to READ other files or (cont.)<br />to do calculations of "derived fields" which are to be Logically Joined to the Primary data. The result is that the MMP (cont.)<br />has a "Logical Record" made up of data from one or more physical files (and records) plus, possibly, some computed (cont.)<br />fields.<br />This logic is executed for both Maint and Browse functions.<br />Suggested Uses:<br />If you use the Automatic Screen Painting and Logical Join then the READ's for your "Secondary" files will be automatically generated here. You may modify them, if you wish.<br />You may code your own READ's here, or your own calculations for "derived fields". An example might be computing the (cont.)<br />gross pay by multiplying hours times rate, where hours and rate are in the file data and gross pay is not. More complex (cont.)<br />algorithms are, of course, possible. This allows you to treat gross pay (a field you have defined in %VARSTOR) as if it (cont.)<br />were an ordinary Data Item, it may even be the Source/Target for a screen field.<br />You need not worry about saving and restoring the TWA-DB-REQUEST area, the MMP does it before PERFORM'ing the JA100-LOGICAL-JOIN routine.<br />Cautions:<br />If you must reference screen fields then you will have to be certain that the Mask is formatted as you expect. This (cont.)<br />logic is executed for both Maint and Browse functions. Therefore, it is possible that either the Maint Mask or the (cont.)<br />Browse Mask (MSK652) is formatted.<br />To be sure, you can code:<br />IF (MAINT-FUNCTION)<br />-or-<br />IF (BROWS-FUNCTION)<br />before trying to access screen fields.<br />To exit the routine:<br />GO TO JA900-RETURN&nbsp;<br />-- not JA999-EXIT!<br />### <br />Online Insertion Point<br />%LITERAL<br />Found in Model:<br />MODELMMP MODELWIN<br />Location:<br />WORKING-STORAGE -- 01 CUSTOM-ALGORITHM-LITERALS<br />Description:<br />This insertion point is at the end of WORKING-STORAGE, it allows you to add your own custom literals and constants to the MMP.<br />Any valid Data Division definitions are allowed. You may use any Cobol level numbers (except 77) and any clauses (VALUE, OCCURS DEPENDING, etc.).<br />This area is not initialized by the MMP unless you code some MOVE's to it, it is intended to be constant data.<br />Suggested Uses:<br />You may define literals, constants, message text, and so forth here. There is no particular size restriction on this (cont.)<br />area, except that WORKING-STORAGE is physically a part of your program and your environment may impose a size limit for (cont.)<br />programs.<br />Cautions:<br />In some environments (notably WESTI) you must not MOVE to data fields in WORKING-STORAGE since your MMP might be (cont.)<br />"rolled in and out" at any time and these areas might revert to their initial values unexpectedly.<br />It is good "form" to avoid MOVE'ing to WORKING-STORAGE in all but exceptional cases, regardless of environment.<br />If you do not code the VALUE clause the contents of any fields you define here will be unpredictable.<br />Data in WORKING-STORAGE is not saved and passed from execution to execution, it is intended to be constant data which never is altered.<br />### <br />Online Insertion Point<br />%LOCINIT<br />Found in Model:<br />MODELMMP MODLOCAT MODELWIN<br />Location:<br />PROCEDURE DIVISION -- BA100-INIT-STORAGE & BA105-LOCAT-INIT<br />Description:<br />This logic will be executed only for Browse (xxxLOC, xxxSCN, and xxxFND) functions. It will be executed very early in the processing to initailize VARIABLE-STORAGE and other work fields.<br />All the standard initializations are done just prior to the %LOCINIT coding; therefore, you may use %LOCINIT to override or supplement the standard logic.<br />There is no default logic for %LOCINIT, if you do not provide any custom logic then only the standard initialization logic will be done.<br />Suggested Uses:<br />You can initialize any work fields you may have added to the %VARSTOR or %LOCVARS definitions.<br />You can alter the value of UPPERCASE-SW from Y to N to tell the xxxSCN and xxxFND functions that you do not wish for (cont.)<br />upper and lowercase alphabetics to be compared as equal in its searches. A value of Y causes them to be compared as (cont.)<br />equal (i.e. "Alan" will match "ALAN" or "alan", etc.).<br />Cautions:<br />This logic must never reference screen fields in the Maint Mask (THIS-PGMS-MASK), only those in the COMMON-LOC-MSK (MSK652).<br />Since this logic is executed prior to the logic which checks that the screen is formatted with the COMMON-LOC-MSK, it (cont.)<br />is possible that the screen format is neither THIS-PGMS-MSK nor MSK652. You really should not refer to screen fields (cont.)<br />other than the four standard MAGEC fields which are on all Masks. They are SFUNCT, SKEY, SCOMPL, and (cont.)<br />SERRMSG.<br />### <br />Online Insertion Point<br />%LOCKY<br />Found in Model:<br />MODELMMP MODLOCAT MODELWIN<br />Location:<br />PROCEDURE DIVISION -- AAL410-SET-STARTING-POSITION<br />Description:<br />This logic is executed only for Browse functions. It is executed in the NEW-TRANSACTION-MODE to "position" into the Primary file (using a generic key value in NORMALIZED-KEY).<br />The default logic calls the MAGEC I/O module to access the file. It uses the FSTAT command to test the file's status (cont.)<br />(open or closed), then uses the LOCKY command to set the position for subsequent reads.<br />Suggested Uses:<br />You might wish to code the logic to access a non-MAGEC type of file (or database). Or you might wish to make minor modifications to the default logic which does the calls.<br />When you are adding custom coding for %LOCKY you will be presented with a Proforma which resembles the default logic (cont.)<br />very closely. You may overkey all, or any portion, of it to create whatever coding you desire. The purpose for the (cont.)<br />Proforma is simply to reduce your keystrokes since most of the time you will probably want to make only minor (cont.)<br />alterations to the default logic.<br />You may wish to alter the key value in NORMALIZED-KEY (by forcing a certain prefix, perhaps) just before the LOCKY is (cont.)<br />done. If you did this based on Operator ID or Location you could effectively restrict users' access on Browses. The (cont.)<br />fields TWA-EMP-NO and TWA-LOCATION tell you who is logged on and where.<br />Cautions:<br />If you code your own non-MAGEC I/O you might want to set the TWA-DB-RETURN-CODE to indicate whether your I/O was (cont.)<br />successful or not. That will allow the remainder of the logic of the MMP to flow naturally, as if the I/O were a (cont.)<br />standard MAGEC I/O.<br />To exit this routine either GO TO AAL440-TEST-RETURN-CODE or just fall through to the "GO TO" which is immediately following the %LOCKY insertion point.<br />### <br />Online Insertion Point<br />%LOCLITS<br />Found in Model:<br /><br />next: insert04.md.txt