an appropriate value in TWA-DB-RETURN-CODE so that the standard MMP logic can work as usual.<br />Do not forget JA100-LOGICAL-JOIN!<br />### <br />Online Insertion Point<br />%REDKY<br />Found in Model:<br />MODELMMP MODELWIN<br />Location:<br />PROCEDURE DIVISION -- AAM410-READ-BY-KEY<br />Description:<br />This logic is executed in the NEW-TRANSACTION-MODE of the MAINT-FUNCTION's. It is executed only if the Normalize Key (cont.)<br />routine has found no errors in the key value given (in SKEY). The default logic for %REDKY tests the file's status (cont.)<br />(open or closed) using the FSTAT command to the MAGEC I/O module, then uses the REDKY command to read the Primary Data (cont.)<br />Class using the key value from NORMALIZED-KEY. It then PERFORM's the JA100-LOGICAL-JOIN routine to execute your %JOIN (cont.)<br />code to Logically Join data from other files or from calculations. The result is the Logical Record for this (cont.)<br />function.<br />The default also saves the Audit-Stamp so it can be compared later in the %RDUKY logic.<br />Suggested Uses:<br />You may read a non-MAGEC file or database by replacing the default code with your own. Or you may make minor modifications or additions to the default logic.<br />When you begin to add your custom code for %REDKY you will be presented a Proforma which is very similar to the default logic. You may overkey it entirely or in part to make any changes you wish.<br />You may wish to check the record for non-numerics in numeric fields and set them to zero. This is sometimes useful when (cont.)<br />new fields are added to a record (Element) definition where a FILLER used to be.<br />Cautions:<br />Be sure you exit this routine by GO'ing to AAM440-TEST-RETURN-CODE or by falling through to the GO TO which is immediately behind the %REDKY insertion point.<br />If you do not call the MAGEC I/O module then you should be sure to set the TWA-DB-RETURN-CODE appropriately so that the (cont.)<br />subsequent logic of the MMP will properly recognize the REC-FOUND or NOT-FOUND conditions.<br />### <br />Online Insertion Point<br />%REDLE<br />Found in Model:<br />MODELMMP MODLOCAT&nbsp; MODELWIN<br />Location:<br />PROCEDURE DIVISION -- AAL420-READ-FIRST-RECORD<br />Description:<br />This logic is executed for BROWS-FUNCTION's only, and only in the NEW-TRANSACTION-MODE. It is executed after the %LOCKY (cont.)<br />logic and only if the LOCKY was successful. This logic is to read the record you have positioned to in (cont.)<br />%LOCKY.<br />The default code merely GO's to AAL430-READ-NEXT-RECORD to do the read.<br />Suggested Uses:<br />You may want to code your own read to a non-MAGEC file or database.<br />Cautions:<br />To exit the routine be sure you GO TO AAL440-TEST-RETURN-CODE. Be sure you alter the TWA-DB-CMD from LOCKY to another (cont.)<br />command since LOCKY will cause the AAL440 routine to loop back to the AAL420 routine endlessly.<br />If you do your own I/O be sure to set the TWA-DB-RETURN-CODE appropriately so the subsequent MMP logic will work properly.<br />### <br />Online Insertion Point<br />%REDNX<br />Found in Model:<br />MODELMMP (2 places) MODELWIN MODLOCAT<br />Location:<br />PROCEDURE DIVISION -- AAL430-READ-NEXT-RECORD<br />, AAM430-READ-NEXT-RECORD<br />Description:<br />This logic is executed in both BROWS-FUNCTION's and in MAINT-FUNCTION's. It is the logic to read "pseudo-sequentially", (cont.)<br />either forward or backward. The direction is controlled in the MAGEC I/O module based on the value of (cont.)<br />TWA-BROWSE-DIRECTION (F or B).<br />The default logic for %REDNX calls the MAGEC I/O module, then it PERFORM's JA100-LOGICAL-JOIN.<br />It is executed for xxxLOC, xxxSCN, xxxFND, and xxxNXT functions.<br />Suggested Uses:<br />You might want to do I/O to non-MAGEC files or databases instead of using the MAGEC I/O module.<br />You might want to check some data in the record (Elements) just read so you can bypass some (such as wrong record type or wrong company).<br />You may want to skip over entire groups of records based on the high-order position of the key value. You could do a LOCKY followed by REDLE to reposition past them.<br />You can simulate end-of-file by MOVE'ing '14' to TWA-DB-RETURN-CODE and allowing the logic to fall through to the test-return-code routine (see Cautions).<br />Cautions:<br />This logic will be used in both the Browse and Maintenance mainlines. If you insert code which needs to exit the (cont.)<br />routine (or reference any paragraph names in the mainline then you must check which mainline you are in. For (cont.)<br />example:<br />IF (MAINT-FUNCTION)<br />&nbsp; GO TO AAM440-TEST-RETURN-CODE<br />ELSE<br />&nbsp; GO TO AAL440-TEST-RETURN-CODE.<br />Also, since this logic will be inserted twice (once in each mainline) you must avoid coding any paragraph names, they (cont.)<br />would be duplicated. It might simplify your work to place your logic in a routine which is PERFORM'd from %REDNX. The (cont.)<br />PERFORM'd routine should be in the %SUBRTNM insertion point (%SUBRTNL for MODLOCAT).<br />If you code non-MAGEC I/O, set TWA-DB-RETURN-CODE.<br />### <br />Online Insertion Point<br />%RELES<br />Found in Model:<br />MODELMMP MODELWIN<br />Location:<br />PROCEDURE DIVISION -- AAM740-RELEASE-EXCL-CONTROL<br />Description:<br />This logic is executed only for MAINT-FUNCTION's in the CONTINUATION-MODE, and only when the ERROR-FOUND condition has (cont.)<br />been set (usually by either MAGEC Automatic Editing or by your coding in %EDIT). It drops the Exclusive Control which (cont.)<br />was obtained in the read-for-update logic earlier (%RDUKY).<br />The default logic for %RELES calls the MAGEC I/O module using the RELES command. It then exits to the AAM750-TEST-RETURN-CODE routine.<br />Suggested Uses:<br />If you coded a non-MAGEC I/O in %RDUKY to read-for-update then you should probably code an appropriate Release of the Exclusive Control here, in %RELES.<br />Since the fact that %RELES is executed indicates that some type of error has been detected, you could update some sort of a log file here.<br />Cautions:<br />Be sure to exit to AAM750-TEST-RETURN-CODE. You may just fall through to the GO TO which is immediately following the %RELES insertion point.<br />### <br />Online Insertion Point<br />%REMARKS<br />Found in Model:<br />MODELMMP MODELWIN MODLOCAT<br />Location:<br />IDENTIFICATION DIVISION -- REMARKS SECTION<br />Description:<br />The text you code in the %REMARKS insertion point will be inserted in the front of the generated MMP in the REMARKS section. It is for comments only, it does not execute.<br />Suggested Uses:<br />Describe what this MMP does, omit the standard things which all MMP's do, that is documented in the *Application User's Guide* which is provided with MAGEC.<br />Cautions:<br />Don't get too wordy, it gets boring.<br />Put an asterisk (*) in column 7 so that your remarks will be compatible with all versions of Cobol, including the '85 standard and PC MAGEC.<br />### <br />Online Insertion Point<br />%SCHEMA<br />Found in Model:<br />MODELMMP MODELWIN<br />Location:<br />DATA DIVISION<br />Description:<br />The %SCHEMA insertion point is in the data division immediately before the WORKING-STORAGE SECTION.<br />Suggested Uses:<br />You can insert database SCHEMA coding here. For instance, for IDMS.<br />Cautions<br />Check the rules and restrictions for your DBMS regarding this coding.<br />### <br />Online Insertion Point<br />%SELECT<br />Found in Model:<br />MODELMMP MODLOCAT&nbsp; MODELWIN<br />Location:<br />PROCEDURE DIVISION -- CA700-MOVE-TO-WORK-AREA<br />Description:<br />This logic is near the top of the CA700 routine. It is a handy place to intercept each record that was read to (cont.)<br />determine whether or not you want to show it on the LOC, SCN, or FND screen display. The CA700 routine is PERFORM'd (cont.)<br />from the Browse Mainline only. It formats a "print line" in WS-ITEM to be MOVE'd to a screen line for the (cont.)<br />browses.<br />A one-byte switch, PROCESS-INDICATOR, is used to control the subsequent processing. A value of P (the default) (cont.)<br />indicates that this record is to be processed, a value of B indicates that this record is to be bypassed, a value of E (cont.)<br />indicates that the program is to simulate End-Of-File (and not process this record).<br />Suggested Uses:<br />You might test for record type on a multi-record-type file to bypass the inappropriate records for this browse. You (cont.)<br />might also test for some other logical subdivision, such as Company code to bypass records for all companies other than (cont.)<br />the one to which this operator belongs. Remember that the "Logical Record" you are looking at is made up of the (cont.)<br />combined data from the Primary Data Class plus any other Data Classes read in the %JOIN routine plus any Derived Fields (cont.)<br />which you may have COMPUTE'd in %JOIN.<br />The SCAN-CTR is incremented just prior to your %SELECT logic. It tells how many records have been read so far to try to (cont.)<br />fill the screen lines (this transaction). CUMULATIVE-SCAN-CTR tells how many have been read since the first screen of (cont.)<br />this browse. On the first "page" these two will be the same.<br />The SCAN-CTR is compared to SCAN-LIMIT (VALUE'd at 1000) to determine if the program should continue reading or just (cont.)<br />send what has been found so far and ask the operator to press the ENTER key to continue. You could alter the contents (cont.)<br />of SCAN-LIMIT by simply MOVE'ing some other value to it here. You could even do so based on which operator was at the (cont.)<br />terminal or which terminal or which location, etc.<br />CUMULATIVE-SCAN-CTR is displayed to the screen after the last line of each browse display, do not mess with it! You (cont.)<br />may, however, alter SCAN-CTR to affect the comparison with SCAN-LIMIT (i.e. MOVE 1000 TO SCAN-CTR) in order to "force" (cont.)<br />the transaction to stop reading and send the screen. This may be preferrable to altering SCAN-LIMIT in a truly (cont.)<br />reentrant environment since SCAN-LIMIT is in WORKING-STORAGE.<br />Cautions:<br />Remember, this logic is used only in BROWS-FUNCTION's, do not refer to any screen fields except those in MSK652.<br />Be careful not to corrupt the value in LIN-CTR as it is the subscript used to indicate which line on the screen (or, if PF13 was hit, on the hardcopy page) was last used.<br />The WS-ITEM print line has not yet been built, do not try to test for values in it here. You can do that in %LOCMOV, if necessary.<br />### <br />Online Insertion Point<br />%SKEYBLD<br />Found in Model:<br />MODELMM&nbsp; MODELWIN<br />Location:<br />PROCEDURE DIVISION -- CA800-BUILD-SKEY<br />Description:<br />This logic is PERFORM'd from the CA700-END paragraph for the BROWS-FUNCTION's. It is also PERFORM'd from the (cont.)<br />Maintenance mainline for the NXT function. The function of this routine is to construct the Master (Primary) key, in (cont.)<br />the format that an operator would enter it (including any slashes, etc.) from the record data and then to MOVE the (cont.)<br />results to the screen in SKEY (also to TWA-LAST-KEY).<br />This is done to simulate an operator's entry of the full key when using the cursor selection features of BROWS-FUNCTION's or the forward or backward reading of NXT functions.<br />The default code for %SKEYBLD is the entire routine, including the CA800-BUILD-SKEY and CA899-EXIT paragraph names.<br />Suggested Uses:<br />In the unlikely event that you need to entirely replace the CA800 routine's logic you would use this insertion point.<br />To make more minor alterations to the output of the CA800 routine you might consider using the %SNDSCRN insertion point (cont.)<br />to intercept the screen just before it is sent. An example of some of the types of "minor" alterations you may want to (cont.)<br />make is adding a standard prefix or suffix for the Browse functions' cursor selection feature.<br />Cautions:<br />The logic of the CA800 routine (the default code) is somewhat complex and is based upon the definition of the Master (cont.)<br />key (xxxK1) for your MMP's Primary Data Class. It handles multi-component keys, mixed upper and lower case alphabetics (cont.)<br />within the key value, and mixed data representations (binary, packed, zoned decimal, signed, unsigned, alphanumeric). (cont.)<br />You may want to think twice before replacing your own routine for it.<br />The output of this routine is MOVE'd to both SKEY and TWA-LAST-KEY.<br />The input to this routine comes from the Cobol data-name you specified in the KYF file definition for the Primary Data Class' Master key (xxxK1)<br />### <br />Online Insertion Point<br />%SNDSCRN<br />Found in Model:<br />MODELMMP&nbsp; MODELWIN<br />Location:<br />PROCEDURE DIVISION -- AA800-SEND-SCREEN<br />Description:<br />This logic is executed just before the MMP exits, returning to MAGECCP. Most of the time the MMP is exiting to allow (cont.)<br />MAGECCP to send the screen and then terminate the task, sometimes it may be exiting with a command in TWA-NONTP-REQUEST (cont.)<br />to invoke (fetch) another function (program).<br />There is no default logic for %SNDSCRN, if you do not provide any customization coding then it will simply be a comment.<br />Suggested Uses:<br />This is a handy place to intercept the screen just prior to its being sent back to the operator. You might wish to put (cont.)<br />some finishing touches on it, like blanking out a field if its value is zero, or setting the highlight (or color) (cont.)<br />attribute if its value is higher (or lower) than a certain level, and so forth.<br />You may wish to "massage" the SKEY value set by the cursor select feature (in CA800-BUILD-SKEY) on a BROWS-FUNCTION. For example, you might want to add some prefix or suffix to the key.<br />This logic is executed both for MAINT-FUNCTION's and for BROWS-FUNCTION's<br />Cautions:<br /><br />next: insert06.md.txt