---<br />title: "insert_main"<br />original_file: "insert_main"<br />generated: "2026-06-12 10:24:19"<br />---<br /><br /># <br />Online Insertion Points<br />## Online Insertion Point Cross Reference <br />| Insertion Point Name | Maintenance | Browse | Remarks <br />| New Trans Mode | Continuation Mode | New Trans | Continuation <br />| ADD | CHG | DEL | SEE | ADD | CHG | DEL | NXT | DUP | LOC | SCN | FND | LOC | SCN | FND <br />| ADDINIT | | | | | X | | | | X | | | | | | | Only if no error found <br />ADDIT | | | | | X | | | | X | | | | | | | Only if no error found <br />BLNKSCR | X | | | | | | | | | | | | | | | Also if Invalid Key or NOT-FOUND <br />CALC | | | | | X | X | | | X | | | | | | | <br />COMP | X | X | X | X | | | | | | | | | | | | Only if REC-FOUND <br />DATADEF | | | | | | | | | | | | | | | | Linkage Section <br />DELEDIT | | | | | | | X | | | | | | | | | <br />DELET | | | | | | | X | | | <br />| | | | | | Only if no error found <br />EDIT | | | | | X | X | | | X | | | | | | | <br />EDIT2 | | | | | X | X | | | X | | | | | | | If no error found in %EDIT <br />FUNCT | | | | | | | | | | | | | | | | Linkage Section - 88 levels <br />GOBACK | X | X | X | X | X | X | X | X | X | X | X | X | X | X | X | <br />GOODADD | | | | | X | | | | X | | | | | | | If ADDIT is successful <br />GOODCHG | | | | | | X | | | | | | | | | | If UPDAT is successful <br />GOODDEL | | | | | | | X | | | | | | | | | If DELET is successful <br />INIT | X | X | X | X | X | X | X | X | X | | | | | | | <br />INITATB | X | X | X | X | X | X | X | X | X | | | | | | | <br />JOIN | X | X | X | X | X | X | X | X | X | X | X | X | X | X | X | <br />LITERAL | | | | | | | | | | | | | | | | Working-Storage Section <br />LOCINIT | | | | | | | | | | X | X | X | X | X | X | <br />LOCKY | | | | | | | | | | X | X | X | | | | <br />LOCLITS | | | | | | | | | | X | X | X | X | X | X | Obsolete <br />LOCMOV | | | | | | | | | | X | X | X | X | X | X | <br />LOCVARS | | | | | | | | | | X | X | X | X | X | X | Obsolete <br />NKLOC | | | | | | | | | | X | X | X | X | X | X | <br />NORMKEY | X | X | X | X | X | X | X | X | X | | | | | | | Only if no error found in key <br />PFKEYL | | | | | | | | | | X | X | X | X | X | X | <br />PRKEYM | X | X | X | X | X | X | X | X | X | | | | | | | <br />PREINIT | X | X | X | X | X | X | X | X | X | X | X | X | X | X | X | <br />RDUKY | | | | | | X | X | | | | | | | | | <br />REDKY | X | X | X | X | | | | | | | | | | | | <br />REDLE | | | | | | | | | | X | X | X | | | | <br />REDNX | | | | | | | | X | | X | X | X | X | X | X | <br />RELES | | | | | X | X | X | X | X | | | | | | | Only if error found <br />REMARKS | | | | | | | | | | | | | | | | Identification Division - Remarks <br />SELECT | | | | | | | | | | X | X | X | X | X | X | <br />SKEYBLD | | | | | | | | X | | X | X | X | X | X | X | <br />SNDSCRN | X | X | X | X | X | X | X | X | X | X | X | X | X | X | X | <br />SPOOL | X | X | X | X | X | X | X | X | X | X | X | X | X | X | X | If PF13 hit <br />SCHEMA | | | | | | | | | | | | | | | | Before Working-Storage <br />SUBRTNL | X | X | X | X | X | X | X | X | X | X | X | X | X | X | X | Only when PERFORM'd <br />SUBRTNM | X | X | X | X | X | X | X | X | X | X | X | X | X | X | X | Only when PERFORM'd <br />UPDAT | | | | | | X | | | | | | | | | | Only if no error found <br />UPDERR | | | | | X | X | X | | X | | | | | | | Only if error found <br />USRAREA | | | | | | | | | | | | | | | | Linkage Section - 01 levels <br />VARSTOR | | | | | | | | | | | | | | | | Linkage Section - Variable Storage <br />| ADD | CHG | DEL | SEE | ADD | CHG | DEL | NXT | DUP | LOC | SCN | FND | LOC | SCN | FND <br />Figure 1<br />Refer to the ["Insertion Points"](/DOC/magref_main.htm#MAGREF009001) reference table for a compact list.<br />### <br />Online Insertion Point<br />%ADDINIT<br />Found in Model:<br />MODELMMP&nbsp; MODELWIN<br />Location:<br />PROCEDURE DIVISION&nbsp; --&nbsp; BB600-BUILD-REC<br />Description:<br />Only used for ADD functions. This logic will be used to initialize the Record's Elements just before the individual (cont.)<br />Data Items are MOVE'd from the screen to the Elements. The default logic will just MOVE SPACES to the Elements. NOTE: (cont.)<br />it moves SPACES to all the Elements in TWA-DB-DATA, both from the primary and from joined Data (cont.)<br />Classes.<br />Suggested Uses:<br />Initializing numeric Data Items in the Elements to zero or to some other value. Setting default values into selected (cont.)<br />database fields which will NOT be MOVE'd to otherwise; i.e. they are not used as a Source/Target for any of the screen (cont.)<br />fields.<br />You may use this insertion point to set the "Date & Time Added" into the record, if you desire.<br />You may wish to override the default logic by moving SPACES (or other initialization value) to only the primary Data Class's Elements.<br />Cautions:<br />This logic will only be done for an ADD function; usually this means xxxADD or xxxDUP, unless you have added other ADD functions through customization in the %FUNCT insertion point.<br />If you MOVE a value to a Data Item which *is* specified as a Source/Target for a screen field; it will be overlaid when the generated MOVE's are done, immediately below in the BB600-BUILD-REC logic.<br />Do not attempt to MOVE to the Audit-Stamp. Anything you move there will be overlaid by the MAGEC I/O module since it handles all Audit-Stamp maintenance.<br />Your custom coding will replace the default MOVE SPACES. If you want the Element(s) initialized to SPACES first, you must code it in your logic.<br />### <br />Online Insertion Point<br />%ADDIT<br />Found in Model:<br />MODELMMP&nbsp; MODELWIN<br />Location:<br />PROCEDURE DIVISION -- AAM710-ADD-TO-DATABASE<br />Description:<br />This is the logic used to add a record to the Primary Data Class (file). The default logic CALL's the MAGEC I/O module. The command used when calling the MAGEC I/O module is:&nbsp; "ADDIT".<br />Suggested Uses:<br />When you add customization for %ADDIT MAGEC presents you with Proforma code which resembles the default logic. You may (cont.)<br />modify or add to it as needed. You can also entirely replace the Proforma by overkeying it. This enables you to code (cont.)<br />the necessary commands to access a file directly instead of using the MAGEC I/O module.<br />You could code the database commands for a non-MAGEC file.<br />You could add code to update a control record just before the add to the Primary file.<br />You could access a control record to determine the next available key (such as P.O. number, Invoice number, etc.) so as to assign the key for the record you are about to add.<br />Cautions:<br />If you want to do something after the add is completed, this is not the best place to do it. The %GOODADD insertion (cont.)<br />point is a better place since the MMP will test for a good return code before going to %GOODADD.<br />If you do other I/O before the add, be sure to save and restore TWA-DB-REQUEST (in TWA-DB-REQ-SAV) and TWA-ELT-LIST if you "step on" them.<br />Be sure not to "step on" the Elements (in TWA-DB-DATA) for the Primary Data Class before they are added to the file.<br />Be sure the file is open and authorized for adds.<br />### <br />Online Insertion Point<br />%BLNKSCR<br />Found in Model:<br />MODELMMP MODELWIN<br />Location:<br />PROCEDURE DIVISION -- BB100-BLANK-SCREEN<br />Description:<br />Logic inserted at the very end of the "blank screen" routine, after all the standard generated MOVE's of ALL '_' to all (cont.)<br />screen variables. This is executed on the "NEW-TRANSACTION" phase of the xxxADD function and also whenever the "INVALID (cont.)<br />KEY FORMAT" message is displayed.<br />Suggested Uses:<br />You could initialize selected screen fields to some value other than underscores, if you wish.<br />You could move values to the screen based on the key value the operator entered. For instance, if the key value in SKEY (cont.)<br />is a Customer Number, you might read the Customer file to get the Name and Address, then move them to the screen. (cont.)<br />Actually, the read might have been done in the %NORMKEY insertion point as a custom key edit.<br />You could test for an edit failure in the key normalization (IF&nbsp;SCOMPLE&nbsp;=&nbsp;E) and move your own message to the screen to help the operator correct the error.<br />Cautions:<br />This logic is only executed in the NEW-TRANSACTION phase of the xxxADD function (and on INVALID KEY). If you want (cont.)<br />something to be done at other times also, you should probably place the logic in a PERFORM'd routine (in %SUBRTNM) and (cont.)<br />then PERFORM it from here as well as from anywhere else it may be desired (such as %CALC and %COMP).<br />This logic may, of course, not reference any screen fields in MSK652 (the Browse Mask) since it is executed only for Maint functions.<br />### <br />Online Insertion Point<br />%CALC<br />Found in Model:<br />MODELMMP MODELWIN<br />Location:<br />PROCEDURE DIVISION -- BB610-MOVE-SCREEN-TO-DB<br />Description:<br />Logic inserted at the very end of the BB600-BUILD-REC routine which MOVE's data from the screen to the database (cont.)<br />Element(s). This logic will be after all the generated MOVE's from the screen fields to the record fields, but before (cont.)<br />the MOVE of NORMALIZED-KEY to the record key and before the business rule processing.<br />BB600-BUILD-REC is executed for all database updating functions, typically xxxADD, xxxCHG, xxxDUP. It is executed only (cont.)<br />in the CONTINUATION-MODE, not in the NEW-TRANSACTION-MODE -- and only if there were no fatal errors flagged in the (cont.)<br />editing (NOT ERROR-FOUND).<br />Suggested Uses:<br />You can override any of the generated MOVE's here.<br />You can move to database fields which are not the Source/Target for any screen field.<br />You can do calculations or conversions to store computed values, instead of "raw" screen data, on the file. For (cont.)<br />example, converting a date to Julian (or binary) using a conversion subroutine to save file space. There is such a date (cont.)<br />conversion subroutine, named MAGDATE, available with MAGEC.<br />You can override the value in NORMALIZED-KEY which will be moved into the record's key. NORMALIZED-KEY is moved in (cont.)<br />order to prevent the possibility of your adding records without setting the key value. In some cases the value in (cont.)<br />NORMALIZED-KEY may not be what you want as the key, especially on an ADD-FUNCTION where you may wish to automatically (cont.)<br />assign part or all of the key. You can bypass the MOVE of NORMALIZED-KEY by branching around it to the business rule (cont.)<br />logic; to do so you should GO TO BB680-DATA-RULES.<br />Cautions:<br />On an ADD function, the data in the Element's fields will be unreliable unless you have initialized it in %ADDINIT. (cont.)<br />This is not a good place to do I/O. If you do you will have to be careful not to "step on" the TWA-DB-REQUEST area (or, (cont.)<br />at least, save and restore it). Of course, you should also be careful not to corrupt the data just MOVE'd into the (cont.)<br />Element area.<br />If you want to update another file, such as a control record, you would be better off doing so in the %GOODADD and (cont.)<br />%GOODCHG insertion points, which will be executed only if the update I/O completes successfully.<br />Remember, %CALC logic will NOT be executed for any of the Browse functions (xxxLOC, xxxSCN, xxxFND). *Do not* GO TO (cont.)<br />BB699-EXIT unless you intend to bypass the MOVE of the record key coded just behind %CALC and also bypass the business (cont.)<br />rule processing.<br />### <br />Online Insertion Point<br />%COMP<br />Found in Model:<br />MODELMMP MODELWIN<br />Location:<br />PROCEDURE DIVISION -- BB200-FILL-SCREEN<br />Description:<br />This logic is inserted at the end of BB200-FILL-SCREEN. It is inserted after all of the generated MOVE's from the database fields to the screen, just before BB299-EXIT.<br />This code is executed in NEW-TRANSACTION-MODE of Maint functions to MOVE data to the screen for display. It is not (cont.)<br />executed in the CONTINUATION-MODE of any function, unless you PERFORM it in customization code of your (cont.)<br />own.<br />Suggested Uses:<br />You can MOVE literals or COMPUTE'd values to the screen here.<br />You can "translate" codes from the file into more readable descriptions and move them to the screen, if you wish.<br />You can alter screen field 3270 Attributes based on the data being displayed; especially useful when MAGEC's Extended Color support and 7-Color terminals are being used.<br />You can MOVE data or messages to the last three lines of the screen (SERRMSG), increasing the usable display capacity of the screen.<br />Cautions:<br />Data displayed in SERRMSG is Display-Only. If MAGEC needs to place error messages or other notifications there, your data will be overlaid.<br />This logic is executed only for Maint functions, you may not reference screen fields in MSK652, the Browse Mask.<br />If you are moving to a numeric screen field you should:<br />1) MOVE (or COMPUTE) into the "numeric equivalent" field, named S_____-N.<br />* -AND-*<br />2) MOVE to the "edit pattern" field, named S_____-ED. This will maintain the standard set by MAGEC in its generated MOVE's and will ensure agreement.<br />You should check numeric database fields (IF NUMERIC&nbsp;.&nbsp;.&nbsp;.) before trying to MOVE them if you are not (cont.)<br />sure of their validity. The generated MOVE's will do that if you have specified the VERIFY option.<br />### <br />Online Insertion Point<br />%DATADEF<br />Found in Model:<br />MODELMMP MODELWIN MODLOCAT<br />Location:<br />LINKAGE SECTION -- TWA-DB-DATA<br />Description:<br />This insertion point is immediately after the generated data definitions for the Elements specified in the Screen (cont.)<br />Header definition (SHDxxx screen). The Element definitions for any Logically Joined data will be automatically inserted (cont.)<br /><br />next: insert02.md.txt