FR712B RPGLE
The RPGLE program FR712B is called by FR712C to print the Freight Out Reconciliation Report sorted by carrier. It reads data from the temporary work file FR712W, retrieves additional information from reference files, and generates a formatted report with totals at various levels. It is structurally similar to FR711B but tailored for carrier-sorted output and includes the carrier name. Below is an explanation of the process steps, business rules, tables used, and external programs called, based on the provided source code.
Process Steps of the RPGLE Program (FR712B)¶
The program processes records from the FR712W work file, organizes them by company, location, and routing group, and prints a detailed report with subtotals and totals. It also supports an Excel-compatible output file. Here are the detailed steps:
- Initialization:
- Purpose: Sets up the program environment and parameters.
-
Actions:
- Receives seven input parameters:
P$CO: Company code (2 characters).P$RDAT: Report date (8 characters, CYMD format).P$LOC: Location code (3 characters).P$CAID: Carrier ID (6 characters).P$SORT: Sort option (1 character, expected to be 'C' for carrier).P$SELMO: Month selection (1 character, added in revisionjb02).P$FGRP: File group (1 character, 'G' or 'Z').- Defines data structures:
W1FRGL: Splits freight GL account intoW$ACCT(account, 6 digits) andW$SUB(sub-account, 2 digits).D$RDAT: Splits report date intoD$CCYY(year) andD$MM(month).W1NAME: Splits customer name intoW$NAME(first 20 characters).D#CYMD: Date conversion structure for parsing dates (CYMD, MDY, etc.).PSDS##: Program status data structure for job, user, and timestamp information.- Defines arrays:
STR(82 elements): Likely for string formatting (not used in the provided code snippet).HYP(66 elements): Likely for hyphenation or formatting (not used in the provided code).OVG(5 elements, revisionjb03): File overrides for 'G' group (GINLOC,GGLCONT,Gbbcaid).OVZ(5 elements, revisionjb03): File overrides for 'Z' group (ZINLOC,ZGLCONT,Zbbcaid).HDR(5 elements, revisionsjb02,jb04): Descriptions for month selection options.- Applies file overrides based on
P$FGRP: - For 'G': Overrides
INLOCtoGINLOC,GLCONTtoGGLCONT, andbbcaidtoGbbcaid. - For 'Z': Overrides
INLOCtoZINLOC,GLCONTtoZGLCONT, andbbcaidtoZbbcaid. - Opens the
INLOC,GLCONT, andbbcaidfiles.
-
Processing Input Records:
- Purpose: Reads records from
FR712Wand organizes them for printing. -
Actions:
- Reads
FR712Wsequentially, with level-break indicators (L7for company,L6for location,L5for routing group,L4for state,L3for city,L2for customer,L1for order/sequence number). - At each level break:
- Company (L7):
- Sets
PRTOVRto*ONto indicate a new company section. - Resets company-level totals (
L7BFRT,L7EFRT,L7AFRT,L7DIFF,L7POST,L7NEGT) and selected date range totals (L7BFRTs,L7EFRTs,L7AFRTs,L7DIFFs,L7POSTs,L7NEGTs, revisionjb01). - Chains to
GLCONTusingW1COto retrieve the company name (GCNAME) intoR$CNAM. ClearsR$CNAMif not found (*IN99 = *ON).
- Sets
- Location (L6):
- Sets
PRTOVRto*ONto indicate a new location section. - Resets location-level totals (
L6BFRT,L6EFRT,L6AFRT,L6DIFF,L6POST,L6NEGT) and selected date range totals (L6BFRTs,L6EFRTs,L6AFRTs,L6DIFFs,L6POSTs,L6NEGTs, revisionjb01). - Chains to
INLOCusingKEY(likely company and location) to retrieve the location name (ILNAME) intoR$ILNM. ClearsR$ILNMif not found (*IN99 = *ON).
- Sets
- Routing Group (L5):
- Resets routing group-level totals (
L5BFRT,L5EFRT,L5AFRT,L5DIFF,L5POST,L5NEGT) and selected date range totals (L5BFRTs,L5EFRTs,L5AFRTs,L5DIFFs,L5POSTs,L5NEGTs, revisionjb01). - Chains to
bbcaidusingW1RTG1(routing group) to retrieve the carrier name (CICANM, revisionjb03). ClearsCICANMif not found.
- Resets routing group-level totals (
- Reads
-
Printing the Report:
- Purpose: Outputs the report to the printer files
LIST164andLIST378(Excel-compatible, revisionmg01). -
Actions:
- Header (HDR01):
- Prints company information (
W1CO,R$CNAM), report title ("FREIGHT OUT RECONCILIATION REPORT"), and page number (PAGE1). - Prints job, program, and user information (
PS#JOB,PS#PGM,PS#USR), location (W1LOC,R$ILNM), and month selection description (D$SELMOHDR, revisionjb02). - Prints selected location (
P$LOC), carrier (P$CAID), and date (D$MM,D$CCYY), along with the current date (PS#MDY) and time (PS#HMS). - Prints column headings (e.g., "ROUTING", "SHIPPING DESTINATION", "STATE", "SHP DATE", etc.).
- Detail Lines (DETL):
- Prints detail fields from
FR712W: routing group (W1RTG1), carrier name (CICANM, revisionjb03), city (W1SCIT), state (W1SST), ship date (W$SDAT), customer name (W$NAME), order number (W1RDNO), sequence number (W1SRN), invoice number (W1INVN), customer number (W1CUST), ship-to (W1SHIP), order type (W1TYPE), quantity (W1QTY), unit of measure (W1UM), freight code (W1FRCD), billed freight (W1BFRT), expected carrier (W1EFRT), actual carrier (W1AFRT), difference (W1DIFF), and closed status (W1CLOS). - Location Totals (TOTL6):
- Prints location totals (
L6BFRT,L6EFRT,L6AFRT,L6DIFF) and carrier charges greater/less (L6POST,L6NEGT). - Company Totals (TOTL7):
- Prints company totals for the selected month (
L7BFRTs,L7EFRTs,L7AFRTs,L7DIFFs,L7POSTs,L7NEGTs, revisionjb01) and all dates (L7BFRT,L7EFRT,L7AFRT,L7DIFF,L7POST,L7NEGT). - Includes labels for "SELECTED MONTH ONLY" and "ALL DATES".
- Excel Output (LIST378, revision
mg01): - Outputs data to a separate printer file (
LIST378) for Excel-compatible formatting, though specific fields are not detailed in the snippet.
-
Program Termination:
- Closes all open files (
INLOC,GLCONT,bbcaid,FR712W,LIST164,LIST378). - Sets
*INLR = *ONto indicate the program is ending. - Returns control to the caller (
FR712C).
Business Rules¶
- Report Structure:
- The report is organized hierarchically by company (
L7), location (L6), and routing group (L5), with detail lines for each record and totals at the location and company levels. - Totals include:
- Billed freight (
L7BFRT,L6BFRT,L5BFRT). - Expected carrier charges (
L7EFRT,L6EFRT,L5EFRT). - Actual carrier charges (
L7AFRT,L6AFRT,L5AFRT). - Difference (
L7DIFF,L6DIFF,L5DIFF). - Carrier charges greater (
L7POST,L6POST,L5POST). - Carrier charges less (
L7NEGT,L6NEGT,L5NEGT).
- Billed freight (
-
Selected date range totals (revision
jb01) are included for the same fields with an 's' suffix (e.g.,L7BFRTs) to reflect the filtered month selection. -
Month Selection Options (revisions
jb02,jb04): - The
P$SELMOparameter determines the data included, with descriptions printed in the header (D$SELMOHDR):M: Selected month only, including all (open and closed) records ("Selected Mo Only All (Open/Closed)").O: Selected month, open records only ("Selected Month Open Only").C: Selected month, closed records only ("Selected Mo Closed Only").A: All open records from previous and selected months ("All Open-Prev/Sel Mo").- Blank: Previous month open records and selected month all records ("Prev Mo Open/Sel Mo All").
-
The data is pre-filtered by
FR712Abased on these options. -
File Group:
-
The
P$FGRPparameter ('G' or 'Z') determines which reference files are used:- 'G': Uses
GINLOC,GGLCONT,Gbbcaid. - 'Z': Uses
ZINLOC,ZGLCONT,Zbbcaid.
- 'G': Uses
-
Carrier Name (revision
jb03): -
The carrier name (
CICANM) is retrieved from thebbcaidfile and printed in the detail lines, enhancing report readability. -
Excel Output (revision
mg01): -
A separate printer file (
LIST378) is used to generate an Excel-compatible output, likely with a wider format (378 characters vs. 164 forLIST164), though specific formatting details are not provided in the snippet. -
Report Spacing (revision
jb03): -
Minor spacing adjustments were made to improve report formatting, though specifics are not detailed in the provided code.
-
Error Handling:
- Handles missing company, location, or carrier records (
*IN99 = *ON) by clearing the respective name fields (R$CNAM,R$ILNM,CICANM). -
No explicit error handling for file access or printing issues, relying on system-level error management.
-
Revision History:
jb01(03/26/2015): Converted from RPG to RPGLE and added selected date range totals.jb02(04/07/2015): Added month selection options (M,O, blank,A).jb03(04/22/2015): Added carrier name (CICANM) frombbcaidand made minor report spacing changes.jb04(11/09/2017): AddedCfor selected month closed records.mg01(11/27/2017): Added separate output for Excel creation (LIST378).
Tables Used¶
- Input Files:
FR712W: Temporary work file inQTEMP(created byFR712C, populated byFR712A), containing freight reconciliation data. Read sequentially with level-break indicators (L7toL1).INLOC: Location file, overridden toGINLOCorZINLOCbased onP$FGRP, used to retrieve location names (ILNAME).GLCONT: Company file, overridden toGGLCONTorZGLCONT, used to retrieve company names (GCNAME).-
bbcaid: Carrier file (revisionjb03), overridden toGbbcaidorZbbcaid, used to retrieve carrier names (CICANM). -
Output Files:
LIST164: Printer file (164 characters wide) for the standard report output.LIST378: Printer file (378 characters wide, revisionmg01) for Excel-compatible output.
External Programs Called¶
- QCMDEXC: System program used to execute file override commands for
INLOC,GLCONT, andbbcaid(implied, as overrides are defined inOVGandOVZarrays, though the execution is not shown in the snippet).
Additional Notes¶
- Purpose:
FR712Bgenerates the final Freight Out Reconciliation Report sorted by carrier, using data fromFR712Wand enriching it with company, location, and carrier names from reference files. - Comparison with
FR711B: The program is similar toFR711Bbut sorts by routing group (W1RTG1) instead of state, includes the carrier name (CICANM), and adjusts column spacing for carrier-focused output. - Multi-User Support: Relies on
FR712Cto createFR712WinQTEMP, ensuring job-specific data isolation. - Parameter Validation: Assumes input parameters are valid, as they are validated by
FR711Pand passed throughFR712C. - Execution Context: Runs in the same job session as its caller, producing the report directly to the printer files.
This program produces a detailed, hierarchically organized report with totals, supporting both standard and Excel-compatible formats, based on pre-processed data from the carrier-sorted work file.