You could test for special conditions and force (or suppress) a control break.<br />The sorted logical record is available to you at this point. This insertion point is before the accumulation into the (cont.)<br />detail level accumulators and before the detail print line (WS-DETAIL-LINE) has been built.<br />Cautions:<br />The control break logic varies from program to program depending on the number of control breaks and sort fields (cont.)<br />specified. If you "hard-code" some logic based on a certain number of control breaks, then change the specs to result (cont.)<br />in a different number of breaks or sort fields, you could have a problem. Refer to the discussion about the insertion (cont.)<br />point %ACCUMS, also.<br />### <br />Batch Insertion Point<br />%BRKPRT<br />Found in Model:<br />MODELRPT<br />Location:<br />PROCEDURE DIVISION -- DC200-BREAK-PRINT<br />Description:<br />This logic is near the top of the routine which is PERFORM'ed at each control break (if ACCUM-PRINT-SW for this level = (cont.)<br />Y) to print the total line WS-TOTAL-LINE and, if requested, the average line (WS-AVRAG-LINE). The "total heading line" (cont.)<br />(WS-TOT-HDG-LINE) has not yet been built.<br />Suggested Uses:<br />You could override the entire break total printing routine by coding your own logic and GO'ing to DC299-EXIT.<br />You can dynamically control forced page breaks before or after each break by setting ACCUM-HOF-BEFORE and ACCUM-HOF-AFTER to Y or N, based on any criteria your desire.<br />Cautions:<br />This routine is PERFORM'ed for each level of break. The subscript, THIS-LVL, determines which break level is being (cont.)<br />processed. If you corrupt the value in THIS-LVL results will be unpredictable (or predictably (cont.)<br />wrong!).<br />If you wish to exit this routine you must GO TO DC299-EXIT. It is a very good idea to study the standard generated code before attempting to customize it.<br />### <br />Batch Insertion Point<br />%DATADEF<br />Found in Model:<br />MODELRPT<br />Location:<br />WORKING-STORAGE -- DB-DATA-AREA<br />Description:<br />This code is inserted immediately behind the generated includes (-MAGECINC's) for the program's primary and secondary Elements.<br />Suggested Uses:<br />You can code additional data definitions here. These may consist of more -MAGECINC statements or of standard Cobol definitions.<br />This is a good place to define any non-database (non-file) data, sometimes called "derived data". You could define (cont.)<br />items here which will be filled in via calculations you will provide in the %JOIN insertion point. This allows you to (cont.)<br />logically join non-file data to create a logical record. Data fields you have defined here could be referenced as the (cont.)<br />Source field for a report field (in RPTDEF).<br />Cautions:<br />If you define numeric fields in %DATADEF, be sure that they are always initialized with valid numeric data in %JOIN (or (cont.)<br />elsewhere). If the VERIFY option is off and you leave bad data in a numeric field which is referenced as a Source (cont.)<br />field, you will abend with a "data exception".<br />### <br />Batch Insertion Point<br />%EOJ<br />Found in Model:<br />MODELRPT<br />Location:<br />PROCEDURE DIVISION -- ZZ900-EOJ<br />Description:<br />This logic is inserted immediately before the GOBACK in ZZ999-GOBACK.<br />Suggested Uses:<br />This is a place where you can insert your own special end of job processing. You may need to close some files you have added. You may wish to DISPLAY or print special end of job messages.<br />Cautions:<br />The print file may have been closed in the %RPTEND logic.<br />You must exit the program using a GOBACK, not a STOP RUN, since your program is actually running as a subroutine to the (cont.)<br />MAGEC batch I/O module (and possibly another database I/O module, as well). When your program executes a GOBACK control (cont.)<br />returns to the I/O module(s) so that they can close files and clean house. This is especially important when your (cont.)<br />program is accessing an IMS/DL1 database or a Datacom/DB database as well as standard VSAM files.<br />### <br />Batch Insertion Point<br />%FILEFD<br />Found in Model:<br />MODELRPT<br />Location:<br />DATA DIVISION -- below PRINT-REC<br />Description:<br />This insertion point is in the FILE SECTION, just below the definition of the print file.<br />Suggested Uses:<br />You could add definitions for additional files here. You could also redefine the PRINT-REC here if necessary.<br />Cautions:<br />The length of the PRINT-REC is variable, depending on the specifications for this program (on the BCHPGM screen).<br />### <br />Batch Insertion Point<br />%FILES<br />Found in Model:<br />MODELRPT<br />Location:<br />ENVIRONMENT DIVISION -- FILE-CONTROL<br />Description:<br />This insertion point is immediately after the generated SELECT statements for the SORT-FILE and PRINTR file.<br />Suggested Uses:<br />You could code SELECT statements for your own additional files here.<br />Cautions:<br />Do not forget to code the OPEN (in %INITWS or %PREINIT) and the CLOSE (in %EOJ) for your files.<br />### <br />Batch Insertion Point<br />%HDGPRT<br />Found in Model:<br />MODELRPT<br />Location:<br />PROCEDURE DIVISION -- DA200-HDG<br />Description:<br />This logic is performed at all page breaks. It prints the report headings.<br />Suggested Uses:<br />You could code your own heading routine to be used in lieu of the default logic which MAGEC will insert here if you do (cont.)<br />not provide customization for %HDGPRT. This will enable you to produce reports with headings vastly different from the (cont.)<br />standard headings MAGEC generates.<br />You could catalogue a standard heading routine on the MAGEC library which produces headings in compliance with your own (cont.)<br />installation's standards. You could then merely code a -MAGECINC statement in %HDGPRT to include it.<br />Cautions:<br />To exit this routine you must GO TO DA299-EXIT.<br />### <br />Batch Insertion Point<br />%INITWS<br />Found in Model:<br />MODELRPT<br />Location:<br />PROCEDURE DIVISION -- AA000-BEGIN<br />Description:<br />This insertion point is near the top of the program logic, just after the standard generated initialization logic. It is the last point before the SORT begins.<br />Suggested Uses:<br />You could initialize any variables you have added to the program (in %DATADEF or %ACCUMS).<br />You could override the settings which control break printing and so forth. These are set in generated code just before the %INITWS insertion point.<br />You could actually code your own SORT, overriding the generated SORT statement, and then GO TO ZZ900-EOJ.<br />Cautions:<br />You are not yet in the SORT, so the SORT-FILE is not yet open.<br />You have not yet executed the CALL to MAGDBMS with the '*READ' command. This command tells MAGDBMS (the I/O module) (cont.)<br />that this program does not intend to update any of the files which are accessed, therefore, the I/O module simply opens (cont.)<br />the files "read-only". If you access a file via MAGDBMS in the %INITWS insertion point, MAGDBMS will open the file for (cont.)<br />update (the default), unless you first code a CALL using the '*READ' command. It is okay to CALL MAGDBMS with '*READ' (cont.)<br />multiple times.<br />### <br />Batch Insertion Point<br />%JOIN<br />Found in Model:<br />MODELRPT<br />Location:<br />PROCEDURE DIVISION -- BB100-LOGICAL-JOIN<br />Description:<br />This logic is PERFORM'ed after each read of the primary data. It is where you logically join data from other files or (cont.)<br />other databases or from calculations. The result of the logical join process is this program's "logical (cont.)<br />record".<br />Suggested Uses:<br />If you use the Automatic Logical Join facilities in creating your program (via BCHPGM, etc.) online, then there will (cont.)<br />likely already be customization coding generated for you in %JOIN. This generated customization coding will read up-to (cont.)<br />fifteen (15) secondary files, as specified on your BCHPGM screen definition.<br />You can read any type of additional file(s) here, MAGEC files or non-MAGEC files.<br />You can fill in non-file (derived) fields which you have defined in the %DATADEF insertion point.<br />Cautions:<br />Do not "clobber" the data which is in DB-DATA-AREA which has been filled in via the preceding reads. If you have defined numeric fields in %DATADEF, be sure to set them to valid numeric values here.<br />To exit this routine you must GO TO BB900-RETURN or just allow the logic to "fall thru" to BB900-RETURN.<br />### <br />Batch Insertion Point<br />%MGLOCKY<br />Found in Model:<br />MODELRPT<br />Location:<br />PROCEDURE DIVISION -- BA102-START-BROWSE<br />Description:<br />This logic starts (positions) the reading into the primary file. The default logic will CALL the I/O module (MAGDBMS) (cont.)<br />using the LOCKY command with a key value of LOW-VALUES. This starts reading at the beginning of the (cont.)<br />file.<br />Suggested Uses:<br />You could override the default logic to start reading somewhere other than the beginning of the file by setting a starting key value other than LOW-VALUES into DB-KEY-VALUE.<br />You may wish to do some special routine just before (or just after) positioning into the file -- for instance, OPEN one of your own files.<br />After the LOCKY command is processed the key value of the first record to be read is returned in DB-KEY-VALUE, you might want to interrogate it.<br />Cautions:<br />If you bypass the LOCKY CALL altogether, the subsequent REDLE and REDNX CALLs will not work correctly -- you should override them with customization also.<br />### <br />Batch Insertion Point<br />%MGREDLE<br />Found in Model:<br />MODELRPT<br />Location:<br />PROCEDURE DIVISION -- BA102-START-BROWSE<br />Description:<br />This insertion point immediately follows the %MGLOCKY insertion point. The default logic for %MGREDLE will CALL the I/O (cont.)<br />module (MAGDBMS) with the REDLE command to read the record which you just positioned to via the LOCKY (cont.)<br />command.<br />Suggested Uses:<br />You may wish to read a non-MAGEC file, rather than use the standard generated code to CALL MAGDBMS.<br />You may wish to do something special for the first record read, you could do that here.<br />Cautions:<br />It is a good practice to test the return code (IF REC-FOUND) and to handle an error condition if one arises. You could (cont.)<br />simply GO TO BZ190-END to terminate the input procedure of the sort and proceed to the output procedure. Some sort (cont.)<br />software does not handle "zero records sorted" very well, therefore you might want to issue a message and terminate the (cont.)<br />program.<br />If you do not choose to terminate the program in this insertion point then you should GO TO BA112-GET-JOINED-DATA, or (cont.)<br />just fall thru to the generated statement below %MGREDLE which will GO TO that routine.<br />If you read a non-MAGEC file, you should be sure to set the values in DB-REQUEST-AREA accordingly so that subsequent (cont.)<br />program logic operates correctly. Particularly, be sure to set DB-RETURN-CODE correctly.<br />### <br />Batch Insertion Point<br />%MGREDNX<br />Found in Model:<br />MODELRPT<br />Location:<br />PROCEDURE DIVISION -- BA110-READ-NEXT<br />Description:<br />This insertion point is used to sequentially read through the primary file. The default code will CALL the I/O module (MAGDBMS) using the REDNX command.<br />Suggested Uses:<br />You could override the standard MAGEC reads with your own reads of a non-MAGEC file.<br />You might wish to place code here to bypass certain records. An example of that would be when reading a file which has (cont.)<br />multiple record types, you may wish to process only one type. You can bypass records by coding GO TO (cont.)<br />BA110-READ-NEXT.<br /><br />next: insert08.md.txt