0.012/01/95 KATHY CAMPER 1.0 PROGRAM NARRATIVE ----------------- THIS SUBPROGRAM IS CALLED BY THE ONLINE CHECK WRITER PROGRAM, FRS010. IT IS CALLED TO PROVIDE INTERACTION WITH THE SIS STUDENT FINANCIAL AID DATA BASE FOR USE IN PRODUCING AND/OR VOIDING STUDENT AID CHECKS IN THE ONLINE ENVIRONMENT. FRS010 CONTROLS ALL USER/ TERMINAL/PRINTER INPUTS AND OUTPUTS AND PASSES THE DATA NECESSARY FOR FIN099S TO RETRIEVE DATA OR UPDATE NEW OR VOIDED DISBURSEMENTS. FRS010 WILL GENERALLY CALL FIN099S TWICE FOR EACH STUDENT, THE FIRST TIME TO RETRIEVE FINANCIAL AID DATA, AND THE SECOND TIME TO UPDATE NEW DISBURSEMENT OR VOID DISBURSEMENT INFORMATION IN THE FINANCIAL AID DATA BASE. THE SUBPROGRAM PERFORMS THREE MAJOR FUNCTIONS: RETRIEVAL OF FINANCIAL AID DATA TO BE PASSED BACK TO FRS010, UPDATING OF CHECK INFORMATION IN THE FINANCIAL AID DISBURSEMENT SEGMENTS OF THE AID DATA BASE, AND CREATING VOID DISBURSEMENTS IN THE AID DATA BASE. THE SUBPROGRAM CAN RETRIEVE REMAINING AWARD INFORMATION FOR ALL COLLEGE-DISBURSED AWARDS (THOSE THAT ARE NOT ENTIRELY STATE-FUNDED) OR CAN BE DIRECTED TO RETRIEVE REMAINING AWARD INFORMATION FOR ONLY STATE-FUNDED AWARDS. FRS010 WILL PRINT CHECKS FOR NON-STATE AWARDS AND WILL CREATE ELECTRONIC DISBURSEMENT REQUESTS FOR THE STATE-FUND AWARDS. IN ADDITION, THE SUBPROGRAM CAN RETRIEVE INFORMATION FOR A SPECIFIC CHECK NUMBER AS THE FIRST STEP IN VOIDING AN EXISTING CHECK. FRS010 DISPLAYS THE INDIVIDUAL CHECK INFORMATION FOR THE USER TO VERIFY THAT THE VOID SHOULD BE PROCESSED. THIS SUBPROGRAM CALLS FIVE SUBPROGRAMS TO CALCULATE REMAINING AWARD BALANCES. FIN321S INITIALIZES THE PROGRAM WORK AREAS AND CALCULATES THE TUITION AND FEE TOTALS, CHARGES TO ALL AID PROGRAMS, AMOUNTS PAID BY ANY OTHER SOURCE, AND NET DUE. FIN331S IS USED TO CALCULATE A REMAINING ENROLLMENT-BASED AWARD FOR PELL GRANT RECIPIENTS. FIN341S PERFORMS THE SAME FUNCTION FOR SEOG, AS DOES FIN351S FOR CSAP. FIN361S CALCULATES TERM REMAINING AWARDS FOR ALL OTHER STUDENT AID. THE SUBPROGRAMS USE THE MOST CURRENT ACADEMIC STATUS AND FINANCIAL AID ELIGIBILITY, TERM AWARD ADJUSTMENTS AND PRIOR DISBURSEMENTS TO DETERMINE THE AMOUNT REMAINING TO BE DIS- BURSED TO THE STUDENT, AND RETURNS THIS INFORMATION TO FIN099S, WHICH IN TURN SENDS THE INFORMATION TO FRS010 IN A TABLE FORMAT. FIN099S USES THE "CHKDATA" LINKAGE AREA TO RECEIVE CONTROL INFORMATION FROM FRS010 AND TO PASS THE AWARD INFORMATION. THE FIELDS IN CHKDATA ARE DESCRIBED BELOW. CHECK-CAMPUS - CAMPUS PASSED FROM FRS010 - USED TO DETERMINE CAMPUS-BASED ACCOUNTS RECEIVABLES CODES FOR COLLEGES WHEN CTLFINYR FLAG INDICATES COLLEGE USES SUCH CODES CHECK-SSN - SOCIAL SECURITY NUMBER OF FINANCIAL AID STUDENT TO BE PROCESSED - SET BY FRS010 BEFORE CALLING FIN099S THE FIRST TIME FOR A STUDENT STATE-FLAG - IF SET TO "Y", REMAINING BALANCES WILL ONLY BE RETRIEVED FOR STATE-FUNDED AID PROGRAMS. IF "N" OR BLANK, REMAINING BALANCES WILL BE RETRIEVED FOR ALL NON-STATE AWARDS. - SET BY FRS010 BEFORE CALLING FIN099S THE FIRST TIME CHECK-TRMYR - ACADEMIC TERM FOR WHICH AWARD BALANCES ARE TO BE CALCULATED OR A CHECK IS ISSUED OR VOIDED - SET BY FRS010 BEFORE CALLING FIN099S THE FIRST TIME CHECK-FINAID-YEARS- FINANCIAL AID YEAR IN WHICH CHECK-TRMYR FALLS - SET BY FRS010 BEFORE CALLING FIN099S THE FIRST TIME LOG-FIN-FRS-FLAG - FLAG TO INDICATE IF FRS LOGGING IS TO TAKE PLACE - FIN099S MOVES VALUE FROM FRS-LOG-DISB FLAG IN CTLFINYR SEGMENT STATUS-FLAG - USED TO CONVEY PROCESSING DIRECTIONS FROM FRS010, AND TO RETURN STATUS INFORMATION FROM FIN099S SET BY FRS010: - "I" - INITIAL CALL FOR THE STUDENT USED FOR BOTH REMAINING BALANCE CALC- ULATIONS AND RETRIEVAL OF SPECIFIC CHECK INFORMATION "U" - UPDATE DISBURSEMENT DATA AS INDICATED BY SWITCHES IN TABLE OF AVAILABLE AWARDS "V" - CREATE VOID DISBURSEMENT SEGMENTS FOR CHECK INDICATED IN CHECK-NUMBER FIELD RETURNED FROM FIN099S: SPACE-INDICATES SUCCESSFUL PROCESSING OF UPDATES OR VOIDS "W" - INDICATES SUCCESSFUL RETRIEVAL OF REMAINING BALANCE OR SPECIFIC CHECK INFORMATION "F" - FIN AID MASTER RECORD NOT FOUND OR NO AVAILABLE AWARDS - DESCRIPTION WILL BE RETURNED IN RETURN-MESSAGE FIELD "D" - DATA BASE ERROR ON IMS CALL - SEGMENT WILL BE IDENTIFIED IN RETURN-MESSAGE "E" - OTHER ERROR CONDITION, DESCRIPTION WILL BE PASSED IN RETURN-MESSAGE, SEE SECTION 5.0 FOR LIST OF MESSAGES CHECK-NUMBER - BLANK WHEN REQUESTING AVAILABLE REMAINING AWARD BALANCES (STATUS-FLAG = "I") - SPECIFIC CHECK NUMBER TO RETRIEVE FROM FIN AID DATA BASE FOR SUBSEQUENT VOID PROCESSING (STATUS-FLAG = 'I', SET ON FIRST CALL) - SPECIFIC CHECK NUMBER FOR UPDATING FIN AID DISBURSEMENTS FROM PROGRAMS INDICATED BY SWITCHES IN AWARD TABLE (STATUS-FLAG = "U", FRS010 SETS ON SECOND CALL) CHECK-BATCH-NUMBER- BATCH NUMBER FOR CHECK ISSUED BY FRS010, USED IN UPDATING DISBURSEMENTS OR VOID BATCH NUMBER USED IN CREATING VOID DISBURSEMENTS - SET BY FRS010 ON UPDATE/VOID CALL CHECK-DATE - DATE FOR CHECK ISSUED BY FRS010, UPDATED IN DISBURSEMENTS OR VOID DATE USED IN CREATING VOID DISBURSEMENTS - SET BY FRS010 ON UPDATE/VOID CALL VOUCHER-CHECK - INDIVIDUAL VOUCHER NUMBER FOR STATE FUNDS - USED IN DISBURSEMENT SEGMENTS AS THE COMPUTER CHECK NUMBER WHEN STATE FUNDS ARE REQUESTED - SET BY FRS010 RETURN-MESSAGE - MESSAGE AREA FOR PASSING ERROR MESSAGES FROM FIN099S TO FRS010 AID-DATA-TABLE - CONTAINS 15 ENTRIES, INITIALIZED IN FIN099S, CONTAINS FOLLOWING FIELDS: ACCT-TYPE - IDENTIFIER FOR AID PROGRAM, CONSISTING OF 4-CHAR. PROGRAM ID AND 1-CHAR. LOAN CONTROL - SET BY FIN099S ACCT-NAME - 30 CHARACTER NAME OF AID ACCOUNT RETRIEVED FROM ACCOUNT MASTER IF POSSIBLE, FROM CTLFAPGM IF NOT FROM ACCOUNT MASTER, DEFAULTS TO ACCT-TYPE IF NEITHER IS FOUND - SET BY FIN099S REMAIN-BAL - REMAINING AWARD BALANCE FOR ACCT-TYPE - WILL BE ZEROS WHEN SPECIFIC CHECK IS TO BE RETRIEVED - SET BY FIN099S CHECK-PAY-SW - USED TO INDICATE IF CHECK IS TO BE PROCESSED FOR ACCOUNT, SET AS FOLLOWS: SPACE - SET INITIALLY BY FIN099S "L" - SET BY FIN099S IF THE AID ACCOUNT ALREADY HAS 10 DISBURSEMENT RECORDS FOR THE TERM, INDICATES THAT A CHECK CANNOT BE ISSUED FOR AWARD OR A VOID CANNOT BE CREATED. - FRS010 SHOULD INFORM THE USER THAT THERE ARE ALREADY 10 CHECKS FOR THE AID PROGRAM WHEN THE DATA IS DISPLAYED FOR VERIFICATION. "Y" - SET BY FRS010 IF THE USER DOES ISSUE A CHECK FROM THE PROGRAM, INDICATES THAT THE UPDATE OF DISBURSEMENT DATA SHOULD BE PERFORMED CHECK-PAID-AMT - USED TO REFLECT AMOUNT ACTUALLY USED FROM AWARD WHEN CHECK IS ISSUED, SET TO ZEROS INITIALLY BY FIN099S. FRS010 MOVES ACTUAL AMOUNT USED BEFORE UPDATE CALL. THIS WILL BE THE AMOUNT USED IN THE DISBURSEMENT SEGMENT FOR THE AWARD. IF THE AMOUNT IS ZERO, NO UPDATE WILL BE PERFORMED. PROCESSING LOGIC: ---------------- THE BASIC PROCESSING LOGIC OF FIN099S IS DESCRIBED BELOW IN THREE SECTIONS, IDENTIFIED BY THE STATUS-FLAG SETTING. STATUS-FLAG = "I" ----------------- WHEN RETRIEVING FINANCIAL AID INFORMATION FOR STUDENTS, THE FIRST THING FIN099S DOES IS INITIALIZE THE AID-DATA-TABLE FIELDS TO SPACES AND ZEROS. THEN THE FINANCIAL AID SUBPROGRAMS (FIN321S, FIN331S, FIN341S, FIN351S, AND FIN361S) ARE CALLED TO RETRIEVE EXISTING DISBURSEMENTS AND REMAINING AWARD BALANCES. IF FRS010 IS REQUESTING REMAINING BALANCE INFORMATION, IT IS OBTAINED FROM THE REMAINING TERM AWARD FIELDS IN THE LINKAGE AREAS FOR THE VARIOUS AID PROGRAMS. IF THE STATE-FLAG FIELD IS SET TO "Y", ONLY LOAN/GRANT AWARDS WITH A FUND-CODE OF "S" ARE INCLUDED. IF NOT, THE REMAINING BALANCES FOR PELL, SEOG, CSAP, AND NON-STATE LOANS/GRANTS ARE INCLUDED. IN ALL CASES, THE REMAINING TERM BALANCES MUST BE GREATER THAN ZERO FOR THE AWARD TO BE INCLUDED. IF AN AWARD ALREADY HAS 10 DISBURSEMENT SEGMENTS FOR THE TERM, IT WILL BE INCLUDED, BUT THE CHECK-PAY-SW WILL BE SET TO "L" TO INDICATE THAT THE LIMIT ON TERM DISBURSEMENTS HAS BEEN REACHED AND MANIPULATION OF THE EXISTING DISBURSEMENT RECORDS MUST BE DONE BEFORE ANOTHER SEGMENT CAN BE CREATED. IF FRS010 IS REQUESTING INFORMATION FOR A SPECIFIC CHECK NUMBER, THE REMAINING BALANCES WILL NOT BE PASSED, AND ONLY THOSE AWARDS WHICH HAVE A DISBURSEMENT RECORD WITH THE CHECK NUMBER WILL BE INCLUDED IN THE TABLE. THE CHECK AMOUNTS FROM EACH AWARD WILL BE PLACED IN THE CHECK-PAID-AMT FIELD. AS ABOVE, IF THE STUDENT HAS 10 EXISTING DISBURSEMENT SEGMENTS FROM AN AWARD AN "L" WILL BE PLACED IN THE CHECK-PAY-SW TO INDICATE THAT A VOID CANNOT BE CREATED FOR THE AWARD/CHECK SINCE THE LIMIT ON TERM DISBURSEMENT SEGMENTS HAS BEEN REACHED. WHEN THE REQUESTED INFORMATION HAS BEEN CORRECTLY MOVED TO THE TABLE, FIN099S WILL MOVE A "W" TO THE STATUS-FLAG AND SPACES TO THE RETURN-MESSAGE FIELD. STATUS-FLAG = "U" ----------------- FIN099S CREATES DISBURSEMENT SEGMENTS FOR ALL AWARDS FOR WHICH FRS010 HAS PLACED A "Y" IN THE CHECK-PAY-SW AND A NON-ZERO AMOUNT IN THE CHECK-PAID-AMT FIELD. THE CHECK NUMBER, TERM, BATCH NUMBER, DATE, AND PAID AMOUNT ARE PLACED IN THE APPROPRIATE SEGMENT FIELDS, AND THE CHECK TYPE IS SET TO "CC" (COMPUTER CHECK). THE VOID-DATE AND BANK-CHECK-NUMBER FIELDS ARE SET TO SPACES. WHEN ALL CHECK SEGMENTS ARE CORRECTLY INSERTED, FIN099S WILL MOVE SPACES TO THE STATUS-FLAG AND RETURN-MESSAGE FIELDS. STATUS-FLAG = "V" ----------------- FIN099S CREATES VOID CHECK DISBURSEMENTS FOR ALL AWARDS THAT WERE INVOLVED IN THE ORIGINAL CHECK. THE ORIGINAL CHECK SEGMENT IS RETRIEVED FOR EACH AWARD, AND THE CHECK DATE AND AMOUNT ARE MOVED TO THE VOID DISBURSEMENT SEGMENT. THE ORIGINAL CHECK NUMBER IS USED TO CREATE THE VOID CHECK NUMBER BY REPLACING THE FIRST DIGIT WITH A "9". THE BATCH NUMBER FROM CHK-DATA IS USED AS THE VOID BATCH NUMBER, AND THE CHECK-DATE FIELD FROM CHK-DATA IS USED AS THE VOID DATE. IF A BANK-CHECK-NUMBER WAS ENTERED IN THE ORIGINAL CHECK SEGMENT, IT WILL BE CARRIED INTO THE VOID CHECK SEGMENT AS WELL. THE CHECK TYPE IS DETERMINED BY THE CHECK TYPE OF THE ORIGINAL SEGMENT. IF THE ORIGINAL CHECK WAS CODED AS "CC", THE VOID SEGMENT WILL BE A "VC" CHECK TYPE (VOID COMPUTER CHECK). IF THE ORIGINAL CHECK WAS CODED AS "MC" (MANUAL CHECK), THE VOID SEGMENT WILL BE A "VM" (VOID MANUAL CHECK). WHEN ALL VOID SEGMENTS ARE CORRECTLY INSERTED, FIN099S WILL MOVE SPACES TO THE STATUS-FLAG AND RETURN-MESSAGE FIELDS. 2.0 SAMPLE JCL - N/A ---------- 3.0 JOB SETUP - N/A --------- 4.0 FILES ----- 4.1 DATA BASE SEGMENTS USED: 1. ACCDBD A. ACCTMSTR (READ) 2. CTLDBD A. CTLFINYR (READ) B. CTLFAPGM (READ) 3. FINDBD A. FINMASTR (READ) B. PELLADJ (READ) C. PELLAWRD (READ) D. PELLDISB (READ,UPDATE) E. PELLQTOT (READ) F. LOANADJ (READ) G. LOANMSTR (READ) H. LOANDISB (READ,UPDATE) I. LOANQTOT (READ) J. SEOGADJ (READ) K. SEOGAWRD (READ) L. SEOGDISB (READ,UPDATE) M. SEOGQTOT (READ) N. CSAPADJ (READ) O. CSAPAWRD (READ) P. CSAPDISB (READ,UPDATE) Q. CSAPQTOT (READ) R. GRNTADJ (READ) S. GRNTAWRD (UPDATE) T. GRNTDISB (READ,UPDATE) U. GRNTQTOT (READ) 4. STUDBD - USED BY FIN321S A. STUDENTM (READ) B. STUACCTD (READ) C. STUREGIS (READ) 5. CLSDBD - USED BY REC531S, WHICH IS CALLED BY FIN321S A. CLSMASTR (READ) 4.2 ADDITIONAL FILES USED: N/A 4.3 INPUT/OUTPUT RECORD LAYOUT: N/A 5.0 SPECIAL PROCESSING MESSAGES --------------------------- THESE MESSAGES WILL BE PASSED WHEN STATUS-FLAG = "F": "FIN MASTER RECORD NOT FOUND" MEANING: ISSUED WHEN A FIN AID MASTER (FINMASTR) IS NOT FOUND FOR THE SOCIAL SECURITY/FIN AID YEAR "NO AVAILABLE AWARDS" MEANING: ISSUED WHEN NO AWARD SEGMENTS ARE FOUND OR AWARDS EXIST BUT THERE ARE NO FUNDS REMAINING THIS MESSAGE WILL BE PASSED WHEN STATUS-FLAG = "D": "IMS ERROR ACCESSING XXXXXXXX" MEANING: ISSUED WHEN AN INVALID STATUS CODE IS RETURNED BY AN IMS DATA BASE CALL. "XXXXXXXX" WILL BE THE NAME OF THE SEGMENT INVOLVED. THESE MESSAGES WILL BE PASSED WHEN STATUS-FLAG = "E": "STATUS RECEIVED NOT I, U, OR V" MEANING: THE STATUS-FLAG PASSED FROM FRS010 IS NOT ONE OF THE VALUES LISTED ABOVE. "CHECK NOT FOUND FOR SSN' MEANING: ISSUED WHEN THE CHECK NUMBER PASSED BY FRS010 CANNOT BE FOUND FOR THE STUDENT. "CTLFINYR SEGMENT NOT FOUND" MEANING: THE CTLFINYR SEGMENT FOR THE FIN AID YEAR CANNOT BE FOUND. "XXXX CONTROL SEGMENT NOT FOUND" MEANING: THE CTLFAPGM SEGMENT FOR A LOAN OR GRANT CANNOT BE FOUND FOR THE FIN AID YEAR. "XXXX" WILL BE THE 4- CHARACTER PROGRAM IDENTIFIER. "XXXXXXX INVALID STATUS CC" MEANING: AN INVALID STATUS CODE WAS RETURNED FROM ONE OF THE FIN3XXX SUBPROGRAMS. "XXXXXXX" WILL BE THE NAME OF THE SUBPROGRAM, AND "CC" WILL BE THE STATUS CODE. "DUPLICATE CHECK XXXXXX PPPPP" MEANING: THE SUBPROGRAM ATTEMPTED TO INSERT A CHECK RECORD WHICH ALREADY EXISTED. "XXXXXX" WILL BE THE CHECK NUMBER, AND "PPPPP" WILL BE THE AWARD IDENTIFIER. 6.0 SPECIAL FEATURES ---------------- 6.1 CALLING PROGRAMS: FRS010 6.2 SUBPROGRAMS CALLED: FIN321S REC531S (CALLED BY FIN321S) FIN331S FIN341S FIN351S FIN361S 6.3 MESSAGE CODES: N/A 7.0 PROGRAM OPTIONS: N/A --------------- 8.0 PROGRAM CHANGE HISTORY: ---------------------- 8.1 VERSION NO: V5.05 CHANGE DATE: 03/31/93 PROGRAMER NAME: KATHY CAMPER PROGRAM REQUEST NUMBER: 00010503 DESCRIPTION OF CHANGES: - INITIAL RELEASE OF PROGRAM. 8.2 VERSION NO: V5.06 CHANGE DATE: 11/12/93 PROGRAMER NAME: KATHY CAMPER PROGRAM REQUEST NUMBER: N/A DESCRIPTION OF CHANGES: - ADDED FLAG FOR FIN/FRS LOGGING TO CHKDATA COPY MEMBER AND MODIFIED PROGRAM TO MOVE VALUE OF FRS-LOG-DISB FOR APPROPRIATE FINANCIAL AID YEAR TO THE FIELD. 8.3 VERSION NO: V5.11 CHANGE DATE: 04/15/94 PROGRAMER NAME: RH.CLARK PROGRAM REQUEST NUMBER: 00013717 DESCRIPTION OF CHANGES: - MOVED THE VOUCHER-CHECK FIELD IN CHKDATA TO THE NON SUBSCRIPTED AREA. SET VOUCHER FIELD ON DISBURSEMENT SEGMENTS TO THIS VALUE WHEN APPROPRIATE. 8.4 VERSION: V5.19 CHANGE DATE: 12/15/94 PROGRAMMER: MACK PEACOCK CHANGE REQUEST #: 00014688 DESCRIPTION: PROGRAM RECOMPILED TO INCLUDE NEW COPYLIB DESCRIPTIONS FOR THE PELLAWRD AND THE PELLQTOT AND THE FINMASTR SEGMENTS 8.5 VERSION NO: V6.0 CHANGE DATE: 10/95 PROGRAMMER NAME: KATHY CAMPER PROGRAM CHANGE REQUEST NO: 00015409 DESCRIPTION OF CHANGE: - RECOMPILED TO PICK UP MODIFIED SUBPROGRAM LINKAGE AREAS. - INCREASED LIMIT ON TERM DISBURSEMENT RECORDS TO 45. - MODIFIED TO PLACE TERM CLOSED FLAG IN CHKDATA TABLE FOR EACH AWARD.