Program Remarks / Identification
IDENTIFICATION DIVISION comments area
ALL
Place COBOL comment lines (remarks) at the top of the generated program,
typically used for program identification, author, date, or change history.
Appears in every generated MMP and MBP regardless of function type.
Code placed here must use COBOL comment syntax (asterisk in column 7).
[Insertion Points Reference — %REMARKS (online)]
[Insertion Points Reference — %REMARKS (batch)]
Data Definitions (DB-DATA-AREA additions)
Within TWA-DB-DATA area (LINKAGE SECTION)
ALL
Add supplemental COBOL data definitions into the DB-DATA-AREA of the TWA
(Task Work Area). Used to define additional data elements that the MMP needs
to access beyond what MAGEC auto-generates — e.g. extra copybooks, additional
Element areas, or host variable areas for SQL. Code placed here participates
in the pseudo-conversational save/restore because it is in the TWA (LINKAGE SECTION).
Data defined here IS saved and restored between pseudo-conversational cycles.
Use %VARSTOR for fields that need only last within one task invocation.
Use %LITERAL for constants (WORKING-STORAGE).
Distinguished from %VARSTOR: %DATADEF is for data that must survive
across screen sends (TWA-resident), %VARSTOR is for intra-task work areas.
[Insertion Points Reference — %DATADEF (online)]
[Insertion Points Reference — %DATADEF (batch DB-DATA-AREA)]
[Customization Tutorial — %DATADEF usage]
[Application Developer Tutorial — %DATADEF]
Variable Storage (LINKAGE SECTION work fields)
VARIABLE-STORAGE area within LINKAGE SECTION
ALL
Add COBOL data definitions for work fields (variables) used within the MMP's
procedure division logic. This is the LINKAGE SECTION VARIABLE-STORAGE area.
Preferred over WORKING-STORAGE for variables in mainframe/CICS environments
to ensure reentrancy.
RULE: In mainframe CICS environments, ALL variables (fields you MOVE TO) must
go in %VARSTOR (LINKAGE SECTION), never in %LITERAL (WORKING-STORAGE).
Violation causes unpredictable results in WESTI; in CICS it causes inefficiency.
%VARSTOR data is initialized to LOW-VALUES on every task invocation (not saved
across pseudo-conversational cycles). Use %DATADEF for data that must persist
across screen sends. VALUE clause is ILLEGAL in LINKAGE SECTION — do not use it.
PC/LAN environments have no penalty for using WORKING-STORAGE for variables.
[Insertion Points Reference — %VARSTOR]
[Customization Tutorial — %VARSTOR rules]
[Customization Tutorial — %VARSTOR additional notes]
Data Constants (WORKING-STORAGE)
WORKING-STORAGE SECTION
ALL
Add COBOL data definitions for constants and literals into WORKING-STORAGE.
These are items whose values do not change at runtime (VALUE clauses are valid here).
RULE: Use %LITERAL ONLY for constants and literals — never for variables
(fields you will MOVE TO). In mainframe environments, placing variables here
causes reentrancy problems. If the program is swapped from memory, WORKING-STORAGE
data reverts to initialized values — another reason not to use it for runtime variables.
[Insertion Points Reference — %LITERAL (online)]
[Customization Tutorial — %LITERAL]
[Customization Tutorial — %LITERAL usage context]
Special SECTION-NAME (e.g. for IDMS)
Before PROCEDURE DIVISION — special section name area
ALL
Insert a special COBOL section name required by some database systems (e.g. IDMS)
that need a named schema section before the PROCEDURE DIVISION. Rarely used in
standard VSAM/CICS environments.
[Insertion Points Reference — %SCHEMA]
User Work Area definition
TWA user work area (LINKAGE SECTION)
ALL
Define a user-controlled work area within the TWA. Data here is saved and restored
across pseudo-conversational cycles (because it is TWA-resident / LINKAGE SECTION).
Used when you need persistent work data not in the standard DB-DATA-AREA.
[Insertion Points Reference — %USRAREA]
[Customization Tutorial — %USRAREA]
A - Data Division / Function Code Control
Add/Modify Function Codes
AA100-CHECK-FUNCTION area
ALL — at function-code check time
Add or modify the set of Function Codes the MMP recognizes and routes to.
Allows custom function codes beyond the standard nine (SEE, CHG, ADD, DEL, DUP,
LOC, SCN, FND, RPT). Code here participates in function-code routing logic.
Related to &PFX substitution parameter. See %LOCINIT for browse-specific
function routing. For adding a completely new function, also code %PREINIT
and the relevant action insertion points.
[Insertion Points Reference — %FUNCT]
[Customization Tutorial — %FUNCT (adding custom functions)]
[Customization Tutorial — %FUNCT and &PFX]
[Security Reference — %FUNCT]
Pre Initialization Routine
AA000-BEGIN (before any other initialization)
SEE CHG ADD DEL DUP LOC SCN FND MBP-BROWSE MBP-MAINT
Fires at the very start of the MMP's execution cycle, BEFORE %INIT, %INITATB,
and %LOCINIT. Provides the earliest possible hook into program logic.
Useful for: intercepting and rerouting control before MAGEC initializes;
setting control variables that influence subsequent initialization;
checking TWA flags set by a prior program before this MMP initializes;
implementing early exits or transfers to other programs.
Because it fires before %INIT and %INITATB, data in screen fields and
TWA work areas has not yet been initialized for the current cycle.
Use with care — no MAGEC standard initialization has run yet at this point.
Default code is provided; if no custom code is entered, default code runs.
Fires across ALL function types including both online (MMP) and batch (MBP) flows.
[Insertion Points Reference — %PREINIT (online)]
[Insertion Points Reference — %PREINIT (batch)]
[Analysis of Generated MMP — %PREINIT position]
[Processing Diagrams — SEE flow]
[Processing Diagrams — LOC flow]
[Processing Diagrams — CHG flow]
[Processing Diagrams — DEL flow]
[Processing Diagrams — ADD flow]
[Processing Diagrams — DUP flow]
[Processing Diagrams — MBP flow]
[Customization Tutorial — %PREINIT in TSKLST]
Maint. Function Initialization
AA000-BEGIN (maintenance function initialization block)
SEE CHG ADD DEL DUP
Fires during the initialization phase for maintenance-type functions (SEE, CHG,
ADD, DEL, DUP). Used to set up work fields, move initial values, or perform
checks that apply specifically to maintenance operations at the start of a cycle.
Fires AFTER %PREINIT but before screen blanking (%BLNKSCR) and attribute
initialization (%INITATB). Does NOT fire for browse functions (LOC, SCN, FND)
— use %LOCINIT for browse initialization.
[Insertion Points Reference — %INIT]
[Processing Diagrams — SEE]
[Processing Diagrams — CHG]
[Processing Diagrams — DEL]
[Processing Diagrams — ADD]
[Processing Diagrams — DUP]
Attribute Initialization
BA200-INIT-ATTRIBUTES
SEE CHG ADD DEL DUP LOC SCN FND
Initialize or override screen field attributes (color, protection, intensity)
at the start of each pseudo-conversational cycle. Fires after %INIT and before
screen blanking. Commonly used to set dynamic attribute values that depend on
data content or user authorization level.
Attribute bytes control whether fields are protected, unprotected, bright, dark,
colored, etc. Standard attributes are set by MAGEC automatically; this point
lets you override them conditionally. Fires for both maintenance and browse functions.
[Insertion Points Reference — %INITATB]
[Processing Diagrams — SEE]
[Processing Diagrams — CHG]
[Processing Diagrams — DEL]
[Processing Diagrams — ADD]
[Processing Diagrams — DUP]
Browse Function Initialization
BA105-LOCAT-INIT (BA100-INIT-STORAGE area)
LOC SCN FND
Fires at the start of the browse (locate/scan/find) mainline, analogous to %INIT
for maintenance functions. Use to set up work fields, override starting key
position, intercept the operator's entry, or take action before the MMP's
standard browse logic begins.
Described as "a handy place to intercept the operator's entry and take action
before the MMP has done much of its standard logic." (cstm_main.htm)
Also the preferred place to add custom browse function routing logic.
[Insertion Points Reference — %LOCINIT]
[Processing Diagrams — LOC flow]
[Customization Tutorial — %LOCINIT (custom browse functions)]
[Customization Tutorial — %LOCINIT additional]
B - Initialization (Batch)
Batch — Initialize Working Storage
BA100-INIT-STORAGE (batch MBP)
MBP-ALL
Batch-only. Fires at the start of the MBP to initialize working storage fields,
open files, or perform any one-time setup needed before the batch mainline begins.
[Insertion Points Reference — %INITWS]
[Processing Diagrams — MBP flow]
Initialize Screen (Blank Screen)
BB100-BLANK-SCREEN
SEE CHG ADD DEL DUP LOC SCN FND
Fires just before the screen is blanked/initialized. Allows code to be inserted
around the screen-blanking step. Rarely customized but available if you need to
selectively blank or pre-fill certain fields before the standard blank operation.
[Insertion Points Reference — %BLNKSCR]
[Processing Diagrams — SEE]
[Processing Diagrams — CHG]
[Processing Diagrams — SCN/FND]
[Processing Diagrams — DEL]
[Processing Diagrams — ADD]
[Processing Diagrams — DUP]
Computations for Screen Display
BB200-FILL-SCREEN
SEE CHG ADD DEL DUP LOC SCN FND
Fires during the screen-filling phase, after database records are read and before
the screen is sent. Primary use: compute derived or calculated fields to be
displayed on-screen (e.g. calculated totals, formatted values, cross-file lookups
whose results populate display-only fields).
This is the most common place for display-side calculations. Analogous in purpose
to a "before screen" event. Works in conjunction with %JOIN for logical join data.
[Insertion Points Reference — %COMP]
[Processing Diagrams — SEE]
[Processing Diagrams — SCN/FND]
[Processing Diagrams — DEL]
[Processing Diagrams — ADD]
[Processing Diagrams — DUP]
[Customization Tutorial — %COMP]
Screen Field Edit(s) — Phase 1
BB500-SCREEN-EDIT
CHG ADD DUP
Fires before any database updating, after the operator has entered data and
pressed ENTER. Insert cross-field validation, business edits, range checks, or
any custom validation of operator-entered screen data. Setting an error flag
or moving an error message to SERRMSG here will abort the update and re-display
the screen with the error.
Phase 1 edits — fires before %EDIT2. Use this for the majority of custom
validation logic. Does NOT fire for SEE or DEL (no data entry in those flows).
The %EDIT2 point (Phase 2) fires after %EDIT and allows a second pass of edits
that may depend on results from %EDIT.
[Insertion Points Reference — %EDIT]
[Processing Diagrams — CHG update phase]
[Processing Diagrams — ADD post-edit phase]
[Customization Tutorial — %EDIT]
[Customization Tutorial — %EDIT advanced]
[Database Administration Tutorial — %EDIT]
Phase 2 Edits
BB500-SCREEN-EDIT (second pass)
CHG ADD DUP
Phase 2 of screen edit validation. Fires immediately after %EDIT. Use for edits
that depend on the results of %EDIT phase 1, or for a logical separation of
validation concerns (e.g. first pass: field-level; second pass: cross-record).
[Insertion Points Reference — %EDIT2]
[Processing Diagrams — CHG update phase]
[Processing Diagrams — ADD post-edit phase]
Additional Data to Browse Screen
CA700-MOVE-TO-WORK-AREA
LOC SCN FND
Fires during the browse screen fill phase, after each record is read and before
it is placed into the browse display. Allows custom data to be moved into browse
display fields — e.g. computed values, data from logically joined records,
or conditional field formatting for each row in the browse list.
[Insertion Points Reference — %LOCMOV]
[Processing Diagrams — LOC flow]
[Customization Tutorial — %LOCMOV]
Additional Edit Routine for MMP Maint. Key
BA300-NORMALIZE-KEY / BA400-NORMALIZE-MAINT-KEY
SEE CHG ADD DEL DUP
Fires during key normalization — after the operator enters a key value on the
top line of the screen, before MAGEC uses it to access the database. Allows
custom formatting, zero-filling, translation, or validation of the key value
before the record read is attempted.
[Insertion Points Reference — %NORMKEY]
[Processing Diagrams — SEE]
[Processing Diagrams — CHG]
[Processing Diagrams — DEL]
[Processing Diagrams — ADD]
[Processing Diagrams — DUP]
Send Screen (before EXEC CICS SEND)
AA800-SEND-SCREEN
SEE CHG ADD DEL DUP LOC SCN FND
Fires immediately before the CICS SEND MAP command is executed to display the
screen to the operator. Final opportunity to set or override any screen field
values or attributes before the screen is physically sent.
[Insertion Points Reference — %SNDSCRN]
[Processing Diagrams — LOC]
[Processing Diagrams — CHG]
[Processing Diagrams — SCN/FND]
[Processing Diagrams — DEL]
[Processing Diagrams — DEL confirm]
[Processing Diagrams — ADD]
[Processing Diagrams — CHG update]
[Processing Diagrams — DUP]
[Processing Diagrams — ADD completion]
PF Key Logic (Browse)
AAL200-BROWSE-MAINLINE PF-key handling area
LOC SCN FND
Insert custom PF key handling logic for browse functions. Allows the developer
to trap specific PF keys pressed while on a browse screen and route to custom logic.
[Insertion Points Reference — %PFKEYL]
[Processing Diagrams — LOC]
PF Key Logic (Maintenance)
AAM200-MAINTENANCE-MAINLINE PF-key handling area
SEE CHG ADD DEL DUP
Insert custom PF key handling logic for maintenance functions (SEE, CHG, ADD,
DEL, DUP). Allows trapping PF keys and routing to developer-defined logic,
e.g. PF keys for custom sub-functions, pop-up windows, or special navigation.
[Insertion Points Reference — %PFKEYM]
[Processing Diagrams — SEE]
[Processing Diagrams — CHG]
[Processing Diagrams — DEL]
[Processing Diagrams — ADD]
[Processing Diagrams — DUP]
[Customization Tutorial — %PFKEYM]
Initialize Record for ADD
BB600-BUILD-REC (ADD initialization)
ADD
Fires when the ADD function initializes a new record before the blank screen is
displayed. Use to pre-populate fields with default values, system-generated keys,
or data carried from a prior context before the operator sees the blank ADD screen.
[Insertion Points Reference — %ADDINIT]
[Processing Diagrams — ADD completion]
[Customization Tutorial — %ADDINIT]
[Customization Tutorial — %ADDINIT context]
Logic to ADD to Database
AAM710-ADD-TO-DATABASE
ADD
Wraps the MAGECIO ADDIT command. Code placed here fires just before (or replaces)
the standard database add operation. Use to set fields that must be computed at
write time, enforce system-generated values, or perform pre-add actions.
[Insertion Points Reference — %ADDIT]
[Processing Diagrams — ADD completion]
[Customization Tutorial — %ADDIT]
[Customization Tutorial — %ADDIT context]
Logic to UPDATE the Database
AAM720-UPDATE-DATABASE
CHG
Wraps the MAGECIO UPDAT command. Fires just before the standard database update
(rewrite) is issued for a CHG function. Use to perform final field computations,
set audit data not handled by the Audit Stamp, or conditionally override the update.
[Insertion Points Reference — %UPDAT]
[Processing Diagrams — CHG update phase]
[Customization Tutorial — %UPDAT]
[Customization Tutorial — %UPDAT context]
Logic to DELETE from Database
AAM730-DELETE-FROM-DATABASE
DEL
Wraps the MAGECIO DELET command. Fires just before the database delete (or
pseudodelete) is issued. Use to cascade deletions to related records, archive
data before deletion, or conditionally block a deletion.
[Insertion Points Reference — %DELET]
[Processing Diagrams — DEL execute phase]
[Customization Tutorial — %DELET]
Edit for Delete (pre-delete validation)
BB400-EDIT-FOR-DELETE
DEL
Fires when the operator confirms a delete (presses ENTER on the DEL confirmation
screen), before the actual delete is executed. Use to validate whether the delete
is permissible — e.g. referential integrity checks, checking for dependent records,
or operator confirmation prompts.
[Insertion Points Reference — %DELEDIT]
[Processing Diagrams — DEL execute]
Read for Update Routine (CHG)
AAM420-READ-BY-KEY-FOR-UPDATE
CHG
Wraps the MAGECIO LOCKY/RDUKY (read for exclusive update) command sequence.
Fires around the exclusive-lock read in the CHG flow. Use to supplement or
replace the standard LOCKY/RDUKY logic, e.g. reading additional related records
under exclusive control, or handling special lock conditions.
[Insertion Points Reference — %RDUKY]
[Processing Diagrams — ADD (RDUKY context)]
[Processing Diagrams — DEL]
Read for Display Routine (SEE/DEL display)
AAM410-READ-BY-KEY
SEE DEL DUP
Wraps the MAGECIO REDKY (read by key, display-only) command. Fires around the
non-exclusive read used for SEE, DEL display, and DUP. Use to supplement or
handle special read conditions, or read additional related data concurrently.
[Insertion Points Reference — %REDKY]
[Processing Diagrams — SEE]
[Processing Diagrams — DEL display]
[Processing Diagrams — ADD/DUP read]
[Customization Tutorial — %REDKY]
[Customization Tutorial — %REDKY advanced]
Logic to Read FIRST Record (Browse)
AAL420-READ-FIRST-RECORD
LOC SCN FND
Wraps the MAGECIO REDLE (read less-than-or-equal / first record) command for
browse positioning. Fires when the browse is positioning to the starting record.
Use to implement custom positioning logic or to filter which record is treated
as the first.
[Insertion Points Reference — %REDLE]
[Processing Diagrams — SCN/FND]
[Customization Tutorial — %REDLE]
Logic to READ-NEXT Record (Browse)
AAL430-READ-NEXT-RECORD (also AAM430)
LOC SCN FND
Wraps the MAGECIO REDNX (read next) command during browse scrolling. Fires on
each successive read-next during a browse page. Use to implement custom record
filtering, skip logic, or supplemental data reads for each browse row.
[Insertion Points Reference — %REDNX]
[Processing Diagrams — LOC]
[Processing Diagrams — SCN/FND]
[Customization Tutorial — %REDNX]
Logic to DROP Exclusive Control
AAM740-RELEASE-EXCL-CONTROL
CHG DEL
Wraps the MAGECIO RELES command that releases exclusive (update) control of a
record after a CHG or DEL. Fires around the release step. Use if you need to
perform additional operations before or after releasing lock control.
[Insertion Points Reference — %RELES]
[Processing Diagrams — CHG update phase]
[Customization Tutorial — %RELES]
Logic to SETL / Position for Update
AAL410-SET-STARTING-POSITION
LOC SCN FND CHG DEL
Wraps or supplements the MAGECIO LOCKY (lock / set position) command used to
establish exclusive control or position for a browse. Use to implement custom
positioning logic, manage lock acquisition, or handle lock-conflict conditions.
[Insertion Points Reference — %LOCKY]
[Processing Diagrams — LOC]
[Customization Tutorial — %LOCKY]
Locate Literals (browse key setup)
Within browse positioning logic
LOC SCN FND
Insert literal values or computed data into the browse key fields just before
the LOCKY/REDLE positioning call. Use to override or supplement the starting
key value that the browse will use to position.
[Insertion Points Reference — %LOCLITS]
Locate Variables (browse work area setup)
Within browse positioning setup logic
LOC SCN FND
Insert code to set up work variables used during browse positioning.
Fires before the LOCKY/REDLE commands during LOC/SCN/FND initialization.
[Insertion Points Reference — %LOCVARS]
Normalize Key for LOC/Browse
BA300-NORMALIZE-KEY (browse variant)
LOC SCN FND
Fires during key normalization for browse functions, analogous to %NORMKEY for
maintenance. Allows formatting, zero-filling, or transformation of the browse
starting key value entered by the operator before the browse positioning read.
[Insertion Points Reference — %NKLOC]
[Processing Diagrams — LOC]
Build Secondary/Subordinate Key
CA800-BUILD-SKEY
LOC SCN FND
Fires when building the secondary (subordinate/alternate) key value for browse
functions that use a non-primary key. Use to construct composite secondary keys
or to derive the key value from screen input or other data.
[Insertion Points Reference — %SKEYBLD]
[Processing Diagrams — LOC]
[Processing Diagrams — SCN/FND]
Logic to JOIN Secondary Files
JA100-LOGICAL-JOIN (via BB100-LOGICAL-JOIN)
SEE CHG ADD DEL DUP LOC SCN FND MBP-BROWSE MBP-MAINT
Fires after every successful read of the Primary Data Class record, to perform
Logical Join reads of secondary (related) Data Classes. This is the standard
mechanism for reading related records from other files and making their data
available to the screen and procedure division logic as a "Logical Record."
Also used to perform calculated field computations that depend on primary record data.
The Automatic Logical Join feature (in application development) auto-generates
%JOIN code. You can supplement or replace it here. The first line of auto-generated
code typically tests IF (NOT-FOUND) GO TO JA900-RETURN to guard against missing
primary records. Always preserve this guard when adding to auto-generated %JOIN code.
Fires for ALL function types because every function reads the primary record.
[Insertion Points Reference — %JOIN (online)]
[Insertion Points Reference — %JOIN (batch browse)]
[Processing Diagrams — SEE]
[Processing Diagrams — LOC]
[Processing Diagrams — SCN/FND]
[Processing Diagrams — DEL]
[Processing Diagrams — ADD]
[Processing Diagrams — DUP]
[Processing Diagrams — MBP]
[Application Developer Tutorial — %JOIN]
[Batch Developer Tutorial — %JOIN]
[Customization Tutorial — %JOIN]
[Customization Tutorial — %JOIN advanced]
MMP Exit Logic
AA900-GOBACK
SEE CHG ADD DEL DUP LOC SCN FND
Fires at the point where the MMP is about to return control (EXEC CICS RETURN
or GOBACK). Use to perform cleanup, logging, or to redirect control to another
program or transaction before the MMP exits.
[Insertion Points Reference — %GOBACK]
[Processing Diagrams — SEE]
[Processing Diagrams — LOC]
[Processing Diagrams — CHG]
[Processing Diagrams — SCN/FND]
[Processing Diagrams — DEL]
[Processing Diagrams — DEL confirm]
[Processing Diagrams — ADD]
[Processing Diagrams — CHG update]
[Processing Diagrams — DUP]
[Processing Diagrams — ADD completion]
After Successful ADD
AAM753-GOODADD
ADD
Fires immediately after a successful ADDIT (record added to database). Use for
post-add logic: trigger cascading adds to related files, send notifications,
chain to another function, or log the addition.
[Insertion Points Reference — %GOODADD]
[Processing Diagrams — ADD completion]
[Customization Tutorial — %GOODADD]
After Successful CHG
AAM755-GOODCHG
CHG
Fires immediately after a successful UPDAT (record updated in database). Use for
post-change logic: cascade updates to related files, trigger downstream processes,
chain to another function, or audit the change.
[Insertion Points Reference — %GOODCHG]
[Processing Diagrams — CHG update phase]
[Customization Tutorial — %GOODCHG]
After Successful DEL
AAM757-GOODDEL
DEL
Fires immediately after a successful DELET (record deleted from database). Use for
post-delete logic: cascade deletions to child records, archive data, free associated
resources, or log the deletion.
[Insertion Points Reference — %GOODDEL]
[Processing Diagrams — DEL execute phase]
After Update ERROR
AAM751-UPDERR
CHG ADD DEL DUP
Fires when MAGECIO returns an error condition from an ADDIT, UPDAT, or DELET
command (e.g. duplicate key on ADD, record changed by another user during CHG).
Use to provide custom error handling, user-friendly messages, or recovery logic
beyond the standard MAGEC error handling.
[Insertion Points Reference — %UPDERR]
[Processing Diagrams — DEL error path]
[Processing Diagrams — CHG error path]
[Processing Diagrams — ADD error path]
Custom Subroutines for Browse MMP
End of browse mainline — custom subroutine paragraph area
LOC SCN FND
Place custom COBOL subroutine paragraphs (PERFORMed routines) for use within
browse function logic. Paragraphs placed here are available to be PERFORMed
from %LOCINIT, %LOCMOV, %PFKEYL, or other browse insertion points.
[Insertion Points Reference — %SUBRTNL]
G - Subroutines (Maintenance)
Custom Subroutines for Maintenance MMP
End of maintenance mainline — custom subroutine paragraph area
SEE CHG ADD DEL DUP
Place custom COBOL subroutine paragraphs for use within maintenance function logic.
Paragraphs placed here are available to be PERFORMed from %INIT, %EDIT, %JOIN,
%GOODADD, %GOODCHG, %GOODDEL, %PFKEYM, or other maintenance insertion points.
[Insertion Points Reference — %SUBRTNM (online)]
[Insertion Points Reference — %SUBRTNM (batch)]
[Customization Tutorial — %SUBRTNM]
Spool / Print Output
CB900-SPOOL
SEE CHG ADD DEL DUP (when print action triggered)
Fires when the MMP is to produce spooled (printed) output via the MAGEC TP Spooler.
Used to format and write lines to the spool file. Relevant when an MMP has a
"hardcopy" PF key or automatic print capability.
[Insertion Points Reference — %SPOOL]
Accumulators Area (batch report)
ACCUMULATORS-AREA (WORKING-STORAGE, batch)
MBP-REPORT
Define accumulator (total) fields in the batch MBP's WORKING-STORAGE.
These are typically numeric fields used to accumulate running totals for
report subtotals and grand totals.
[Insertion Points Reference — %ACCUMS]
Add to Totals (batch report accumulation)
CA130-ADD-TOTALS
MBP-REPORT
Fires for each record processed in a batch report, to add values to running
accumulators defined in %ACCUMS.
[Insertion Points Reference — %ADDTOT]
[Processing Diagrams — MBP report]
Control Breaks (batch report)
CA115-CHECK-FOR-BREAKS
MBP-REPORT
Fires to check for control breaks in a batch report (e.g. change in department,
customer, or date). When a break is detected, triggers subtotal printing and
accumulator reset logic.
[Insertion Points Reference — %BREAKS]
[Processing Diagrams — MBP report]
Break Print (print subtotals at control break)
DC200-BREAK-PRINT
MBP-REPORT
Fires to print subtotal lines when a control break occurs. Code placed here
formats and writes the subtotal/break lines to the report.
[Insertion Points Reference — %BRKPRT]
[Processing Diagrams — MBP report]
End of Job (batch)
CA190-END
MBP-ALL
Fires at the end of a batch MBP run, after all records have been processed.
Use for final grand total printing, closing files, writing summary records,
or any end-of-job cleanup.
[Insertion Points Reference — %EOJ]
[Processing Diagrams — MBP report]
Heading Print (batch report page heading)
DA200-HDG
MBP-REPORT
Fires when a new page heading is to be printed in a batch report (at start of
run and on each page overflow). Code placed here formats and writes page heading
lines to the report.
[Insertion Points Reference — %HDGPRT]
[Processing Diagrams — MBP report]
Move to Print Area (batch report detail line)
CA130-ADD-TOTALS / detail line area
MBP-REPORT
Fires for each record to move data fields into the print line area before the
detail line is printed. Format each detail line of the report here.
[Insertion Points Reference — %MVTOPRT]
[Processing Diagrams — MBP report]
Roll Accumulators (reset after break print)
DC100-ROLL-ACCUMULATORS
MBP-REPORT
Fires after a control-break subtotal is printed, to roll up (or reset) accumulator
values for the next control group.
[Insertion Points Reference — %ROLLAC]
[Processing Diagrams — MBP report]
Report End (final grand totals)
CA190-END (report termination)
MBP-REPORT
Fires at the very end of the report run to print grand total lines. Distinct
from %EOJ in that it is specifically for final total printing, whereas %EOJ
is for all end-of-job logic.
[Insertion Points Reference — %RPTEND]
[Processing Diagrams — MBP report]
Save Previous Key (for break detection)
CA120-SAVE-KEYS
MBP-REPORT
Fires after each record is processed to save the current control-break key values
as "previous" values for comparison on the next record pass, enabling break detection.
[Insertion Points Reference — %SVPREV]
[Processing Diagrams — MBP report]
J - Batch File Definitions (MBP)
File FD Definitions (batch)
DATA DIVISION — FILE SECTION (batch MBP)
MBP-ALL
Insert COBOL FD (File Description) entries into the FILE SECTION of a batch MBP.
Used when the batch program needs to access non-MAGECIO files (e.g. sequential
print files, work files) that require explicit FD definitions.
[Insertion Points Reference — %FILEFD]
J - Batch File Definitions (MBP)
File Record Definitions (batch)
DATA DIVISION — FILE SECTION record definitions (batch MBP)
MBP-ALL
Insert COBOL 01-level record definitions for files declared in %FILEFD.
Pairs with %FILEFD to complete the file description in the batch MBP's DATA DIVISION.
[Insertion Points Reference — %FILES]
K - Batch Browse/Maintain (MBP)
Batch Locate/Position (MBP browse)
BA102-START-BROWSE
MBP-BROWSE
Batch equivalent of %LOCKY. Fires during the MBP browse starting-position setup.
Used to control how the batch program positions to its starting record.
[Insertion Points Reference — %MGLOCKY]
[Processing Diagrams — MBP flow]
K - Batch Browse/Maintain (MBP)
Batch Read First Record (MBP browse)
BA102-START-BROWSE (REDLE variant)
MBP-BROWSE
Batch equivalent of %REDLE. Fires when the MBP reads its first/starting record
during the batch browse mainline.
[Insertion Points Reference — %MGREDLE]
[Processing Diagrams — MBP flow]
K - Batch Browse/Maintain (MBP)
Batch Read Next Record (MBP browse)
BA110-READ-NEXT
MBP-BROWSE
Batch equivalent of %REDNX. Fires on each successive read-next during the
batch browse mainline loop.
[Insertion Points Reference — %MGREDNX]
[Processing Diagrams — MBP flow]
K - Batch Browse/Maintain (MBP)
Move to Sort Area (MBP)
BA150-RELEASE (sort release area)
MBP-BROWSE
Fires during MBP processing to move record data into the sort work area before
RELEASEing records to an internal sort. Used in MBPs that sort their input data.
[Insertion Points Reference — %MVTOSRT]
[Processing Diagrams — MBP flow]
K - Batch Browse/Maintain (MBP)
Select/Filter Records (MBP)
BA115-SELECT
MBP-BROWSE
Fires for each record read during an MBP browse pass, to allow the developer
to implement record selection/filter logic. Setting a "skip" or "not selected"
flag here causes the record to be bypassed in processing.
[Insertion Points Reference — %SELECT]
[Insertion Points Reference — %SELECT (online)]
[Processing Diagrams — LOC (online equivalent)]
[Processing Diagrams — MBP]
[Customization Tutorial — %SELECT]
Calculations (online and batch)
Within mainline — calculation area
SEE CHG ADD DEL DUP LOC MBP-BROWSE MBP-REPORT
A general-purpose calculation insertion point that fires during record processing
to perform arithmetic, data derivation, or any computational logic. Can be used
in both online MMPs and batch MBPs to compute values before display or write operations.
[Insertion Points Reference — %CALC]
[Processing Diagrams — CHG update]
[Processing Diagrams — ADD completion]
[Customization Tutorial — %CALC]