Banner Accounts Receivable TRM Supplement May 2006 Release 7.3 What can we help you achieve? Confidential Business Information This documentation is proprietary information of SunGard Higher Education and is not to be copied, reproduced, lent or disposed of, nor used for any purpose other than that for which it is specifically provided without the written permission of SunGard Higher Education. Prepared By: SunGard Higher Education 4 Country View Road Malvern, Pennsylvania 19355 United States of America © 2000-2006 SunGard. All rights reserved. The unauthorized possession, use, reproduction, distribution, display or disclosure of this material or the information contained herein is prohibited. In preparing and providing this publication, SunGard Higher Education is not rendering legal, accounting, or other similar professional services. SunGard Higher Education makes no claims that an institution's use of this publication or the software for which it is provided will insure compliance with applicable federal or state laws, rules, or regulations. Each organization should seek legal, accounting and other similar professional services from competent providers of the organization's own choosing. Without limitation, SunGard, the SunGard logo, Banner, Campus Pipeline, Luminis, PowerCAMPUS, Matrix, and Plus are trademarks or registered trademarks of SunGard Data Systems Inc. or its subsidiaries in the U.S. and other countries. Third-party names and marks referenced herein are trademarks or registered trademarks of their respective owners. TRM Supplement Accounts Receivable System Preface How to Use This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 How to Contact SunGard Higher Education . . Documentation Ordering Information. Customer Support Center . . . . . . . ActionLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 8 9 9 1 Database Schematics Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1 Accounts Receivable Processing (Part 1) . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 Accounts Receivable Processing (Part 2) . . . . . . . . . . . . . . . . . . . . . . . . . 1-3 Automated Clearing House (ACH) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4 Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . Automated Clearing House (ACH) . . . . . . . . Accounts Receivable Processing . . . . . . . . . Accounts Receivable Collector/Temporary Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5 1-5 1-5 1-7 Entity Relationship Diagrams (ERD) Auto/Hold Release Setup . Detail Code Setup. . . . . Third Party Contract Setup Exemption Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9 1-9 1-10 1-11 1-12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Reports and Processes AR Reports and Processes Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7 Legend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7 Accounts Receivable Reports and Processes . . . . . . . . . . . . . . . . . . . . . . . 2-7 3 Table of Contents Sleep/Wake-up. . . . . . . . . . . . . . . . . . . . . . . . . . Setting Up Sleep/Wake Processes Using Method One . . Setting Up Sleep/Wake Processes Using Method Two . . Operating Systems Without Sleep/Wake-up Commands . Collector File Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9 2-9 2-10 2-11 2-12 Running Oracle Reports with Accounts Receivable . . . . . . . . . . . . . . . . . . . 2-13 3 Interfaces Accounts Receivable Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1 Interfaces within Banner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1 Lockbox Payment Processing . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1 4 Conversion Conversion Tables for Accounts Receivable . . . . . . . . . . . . . . . . . . . . . . . 4-1 Accounting Feed Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4 Title IV Setup Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5 5 APIs Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1 APIs and Supporting Packages used in Banner API Packages . . . . . . . . . . . . DML Packages. . . . . . . . . . . . Support Packages . . . . . . . . . . Utility Packages . . . . . . . . . . . Validation Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2 5-2 5-6 5-7 5-8 5-8 6 System-Required Data Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1 Accounts Receivable Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2 System-Required Rows for Validation Tables . . . . . . . . . . . . . . . . . . 6-3 4 Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential Table of Contents A Frequently Asked Questions about Storing and Viewing Statement Files Do I have to create Adobe Portable Document Format (PDF) files to use the e-Bill enhancement?. . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1 How can I parse the TSRCBIL output into multiple files?. . . . . . . . . . . . . . . . . A-1 Sample Perl Script. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1 How can I Store Statements from the File System? . . . . . . . . . . . . . . . . . . . . A-2 PL/SQL Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-3 How might local modifications or Third Party tools be used in processing statements?. . A-4 Where does the statement number appear in the billing output? . . . . . . . . . . . . . A-5 Why do I see the same statement when I try to look at a different bill date? . . . . . . . A-5 Index May 2006 Confidential Accounts Receivable Release 7.3 TRM Supplement 5 Table of Contents This page intentionally left blank 6 Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential Preface How to Use This Manual Preface This manual is the Accounts Receivable TRM Supplement to the General Technical Reference Manual. It provides information needed by the technical staff members who support your Accounts Receivable product, including operations personnel, DBAs, programmer analysts, systems analysts, and other technical specialists. Staff members should be familiar with the hardware system in use at your site and all should have a basic understanding of Oracle products. How to Use This Manual This manual is organized into seven sections. Chapter 1, “Database Schematics,” includes lists of Accounts Receivable (AR) tables and entity relationship diagrams (ERD) that show details of these tables. Chapter 2, “Reports and Processes,” contains brief descriptions of AR reports, and information about how to run Oracle Reports with AR. Chapter 3, “Interfaces,” identifies the applications with which AR interface and provides detailed information about Lockbox Payment processing. Chapter 4, “Conversion,” explains how to convert your data. Chapter 5, “APIs,” includes information about Application Programming Interfaces (APIs) and supporting packages. Chapter 6, “System-Required Data,” lists system-required data for AR. Appendix A, “Frequently Asked Questions about Storing and Viewing Statement Files,” includes helpful information to reference when you implement e-Bill functionality. Related Documentation In addition to the Accounts Receivable TRM Supplement, the following documentation supports your work: Accounts Receivable User Guide—a user/reference manual that provides information needed by the administrative staff who handle the daily activities of the offices supported by the Accounts Receivable product. May 2006 Confidential Accounts Receivable Release 7.3 TRM Supplement 7 Preface How to Contact SunGard Higher Education Accounts Receivable Release Guide—a document containing notes about a release of the product, including descriptions of the enhancements and other modifications in the new release. Banner Documentation Bookshelf Getting Started Guide—a how-to manual directing the installation and maintenance of the Bookshelf. Banner Getting Started Guide—a user/reference manual that describes the features and components of the Banner system and Banner Online Help. GTVSDAX Handbook—a user/technical/reference manual describing the setup and use of the Crosswalk Validation Form (GTVSDAX), which is used with the Object:Access views. General User Guide—a user’s guide to the General module, its functions and features. Accounts Receivable Upgrade Guide—a technical guide to support your institution’s conversion to the newest release. General Technical Reference Manual—a technical reference manual on General utilities, with application-specific supplements. API —an Application Program Interface provides an overview, documents the parameters, and describes the logic of fundamental business units of Banner. How to Contact SunGard Higher Education Documentation Ordering Information You may order a Banner documentation CD by mail, by telephone, by FAX, by ActionLine, by Customer Support Center, or by e-mail. Use the address and phone numbers listed below. Address SunGard Higher Education Distribution Services SunGard Higher Education 4 Country View Road Malvern, PA 19355 Telephone (800) 522 - 4827, option 5 Distribution Services is staffed Monday through Friday, 9:00 am to 5:00 pm (EST). FAX 8 (610) 578 - 6033 Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential Preface How to Contact SunGard Higher Education Customer http://connect.sungardhe.com Support Center E-mail distserv@sungardhe.com Customer Support Center The Customer Support Center refers to the secured area of SunGard Higher Education's World Wide Web site dedicated to ActionLine and other related services available to clients. Users must be registered to obtain access to the secured site. Users can request an account to gain access to SunGard Higher Education's secured web pages by accessing http://connect.sungardhe.com. ActionLine ActionLine personnel provide support to SunGard Higher Education maintenance customers. They help users resolve any questions or concerns that relate to SunGard Higher Education products. The ActionLine telephone number for Bronze Maintenance level clients is: 800-522-4827 The ActionLine telephone number for Silver Maintenance level clients is: 866-265-9264 The ActionLine telephone number for Platinum Maintenance level clients is: 888-543-8094 May 2006 Confidential Accounts Receivable Release 7.3 TRM Supplement 9 Preface How to Contact SunGard Higher Education This page intentionally left blank 10 Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential 1 Chapter 1 Database Schematics Symbols Database Schematics This section includes lists of tables used by Accounts Receivable, entity relationship diagrams that identify columns contained in these tables, and graphics that display the relationships among various tables. The following conventions are used to display those relationships. Symbols Table Table Common column name(s); one-to-many table relationship Table Indicates a process has been completed Table Table Common column name(s); many-to-one table relationship Table Rule tables Table Table Common column name(s); one-to-one table relationship Table May 2006 Confidential Accounts Receivable Release 7.3 TRM Supplement 1-1 1 Database Schematics Accounts Receivable Processing (Part 1) Accounts Receivable Processing (Part 1) TBBEXPT EXEMPTION CODE, TERM TBBESTU PIDM TBBCPRF PIDM TBRRRAS PIDM PIDM PIDM PIDM SPRIDEN TBRCOLC TBBCONT PIDM TBRACCD PIDM CONTRACT PRIORITY, TERM TBBCSTU TBTFADB PIDM PIDM TBBPIDM PIDM PIDM PIDM PIDM TBRCMNT PIDM PIDM TBBRQST TBRDEPO PIDM, TRAN NO. TBRACDT TBRAPPL TBRMEMO TBBDETC DETAIL CODE DETAIL CODE TBBACCT TBBISTC TBRACCT DETAIL CODE DETAIL CODE TBBRETC TBBDEPC INSTALL PLAN TBRISTL 1-2 Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential 1 Database Schematics Accounts Receivable Processing (Part 2) Accounts Receivable Processing (Part 2) TBBUPRF USERID TBRUPRF TBBSBRL TSRTERM TBRCLCT PIDM, TERM SESSION ID USERID TBRCOLR GXVBANK TBRCASN TBRCTEX TBRLBOX TURVERS TBRCBRQ TBRCRCP TBBMISC TBRSBMS TGRCOLR TGRCLR2 RECEIPT NUMBER RULE CODE TBRMESG TBBCSHR TBRMISD TBRSBRL May 2006 Confidential TBRCMIS TBRCCRC TGRCLR3 TBBCCLR Accounts Receivable Release 7.3 TRM Supplement 1-3 1 Database Schematics Automated Clearing House (ACH) Automated Clearing House (ACH) GXRDIRD Product-specific Human Resources Interface Bank Routing Number GXVBANK GXVDIRD Product-specific Finance Interface Product-specific Accounts Receivable Interface 1-4 Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential 1 Database Schematics Tables Tables Automated Clearing House (ACH) Table Name Description GXRDIRD Direct Deposit Recipient Table GXVDIRD Bank Routing Number Validation Table GXVBANK Bank Code Table Accounts Receivable Processing May 2006 Confidential Table Name Description SPRIDEN Person Identification/Name Repeating Table TBBACCT Account Header Table TBBCCLR Collector Table Used for Various Cashiering Operations TBBCONT Contract Header Table TBBCPRF Customer Profile Attributes Table TBBCSHR Cashier Session Table TBBCSTU Contract Student Authorization Table TBBDEPC Deposit Detail Definition Table TBBDETC Detail Charge/Payment Code Definition Table TBBESTU Exemption Student Authorization Table TBBEXPT Exemption Header Table TBBISTC Installment Plan Definition Table TBBMISC Miscellaneous Transaction Receipt Header Table TBBPIDM PIDM Application of Payments Collector Table TBBRETC Returned Check Code Definition Table Accounts Receivable Release 7.3 TRM Supplement 1-5 1 Database Schematics Tables 1-6 Table Name Description TBBRQST Application/Reapplication of Payment Request Table TBBSBRL Schedule/Bill Rules Table TBBTERM Accounts Receivable Term Control Table TBBUPRF Accounts Receivable Userid Profile Table TBRACCD Account Charge/Payment Detail Table TBRACCT Detail Code Account Definition Table TBRACDT Account Charge/Payment Detail Text Table TBRAPPL Detail Application of Payment Table TBRCASN Cashier Assignment Table TBRCBRQ Collector Table Used For Recursive Invoice Processing TBRCCRC Collector Table Used by the TBVRCPT View TBRCLCT Collector File Used In Credit Calculations TBRCMIS Collector Table Used For Recursive Miscellaneous Receipt Printing TBRCMNT Comment Table TBRCOLC Account Collection Repeating Table TBRCOLR Cashiering Collector Table TBRCRCP Collector Table Used For Recursive Receipt Printing TBRCTEX Intermediate File Containing Credit Amounts TBRDEPO Deposit Table TBRISTL Installment Plan Table TBRLBOX Lock Box Intermediate Table TBRMEMO Charge/Payment Detail Memo Table TBRMESG Billing Message Table TBRMISD Miscellaneous Transaction Charge/Payment Detail Table TBRRRAS Recurring Receivables Assignment Table TBRSBMS Schedule/Bill Message Table Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential 1 Database Schematics Tables Table Name Description TBRSBRL Schedule/Bill Collector Table TBRUPRF Accounts Receivable User Restrictions Table TBTFADB Financial Aid Intermediate Disbursement Table TGRCLR2 Reconciliation Reporting Collector Table TGRCLR3 Chart of Accounts Data Storage Collector Table TGRCOLR Reconciliation Reporting Collector Table TSRTERM Voice Response Accounts Receivable Term Table TURVERS Accounts Receivable Version Tracking Table Accounts Receivable Collector/Temporary Tables Table Name Function/Purpose Clear (M= Manual, A= Auto) Description TBBCCLR Cashiering Collector Table A Cashier Detail Report TBBPIDM Pidm Collector Table for TBVAPPL views, TSRCBIL A Application of Payment TBRCBRQ Collector Table Used For Recursive Invoice Processing A Invoice Print TBRCCRC Collector Table used by the TBVRCPT view M Receipt Form TBRCISP Installment Payment Collector Table M Installment Plan Amount Form Web, Voice Response TBRCLCT Credit Calculation Collector Table M Student Payment Form TBRCLCT Credit Calculation Collector Table A Student Invoice/Billing Statement and Third Party Billing Statement TBRCOLR Cashiering Collector Table M Cashier Session Review Form and Cashier Delete Report May 2006 Confidential Accounts Receivable Release 7.3 TRM Supplement 1-7 1 Database Schematics Tables Table Name Function/Purpose Clear (M= Manual, A= Auto) Description TBRCMIS Miscellaneous Receipt Collector Table A Miscellaneous Receipt print TBRCRCP Collector Table used for Recursive Receipt Printing A* Receipt Print * The TBRCRCP table automatically takes care of itself, because the records are deleted when the receipt is printed. If you want to generate a receipt number but do not want to print them, create a script to delete the records with TBRCRCP_PRINTER = RPEDISB. 1-8 TGRCOLR Reconciliation Report Collector Table A Reconciliation Report TGRCLR2 Store Summary Information for Reconciliation Report A Reconciliation Report TGRCLR3 Chart of Accounts Parameter Collector Table A Reconciliation Report TTRDTLC TRA Tax Reporting Collector A 1098 Student Tax Detail Report TBRCHLD Collector Table used for Auto Hold Report processing Collector Table TBRCSUM Collector Table used for Recursive Student Summary Report Processing Collector Table TBRSBRL Schedule/Bill Collector Table Collector Table TSRCTPB Collector Table used for TSRTBIL Report processing Collector Table TTBIRSC Collector Table for IRS 220 data Collector Table TTBPROC Collector Table for TSP1098 process Collector Table TTBTSPC Collector Table for TSP 1098 process Collector Table TTBXSMC Collector Table for the TTVXSUM View Collector Table TTRDTLC Collector Table which holds the student report code details with the single amount for a single report code Collector Table Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential 1 Database Schematics Entity Relationship Diagrams (ERD) Entity Relationship Diagrams (ERD) Auto/Hold Release Setup STVHLDD (Person Hold Type Validation) TPRRHLD (Auto Hold/release Rules) TTVRHLD (Auto Hold/release Rules Code Validation) CODE DESC May 2006 Confidential X(06) X(30) HOLD_RULE_CODE X(06) HLDD_CODE NONPERS_IND FIN_AID_IND FUT_IND AR_MEMO_IND CONT_MEMO_IND FINAID_MEMO_IND PURGE_PRIOR_IND NONCON_HOLD_IND RELEASE_IND FROM_DATE TO_DATE REASON AMOUNT_OWED ORIG_CODE FIN_AID_TERM_OP FIN_AID_TERM_CODE MEMO_TERM_OP MEMO_TERM_CODE MIN_CURR_BALANCE MAX_CURR_BALANCE AS_OF_DATE AGING_DATE_CODE MIN_AGING_DAYS MAX_AGING_DAYS MIN_AGING_BALANCE MAX_AGING_BALANCE X(02) X(01) X(01) X(01) X(01) X(01) X(01) X(01) X(01) X(01) DATE DATE X(30) 9(07) X(04) X(02) X(06) X(02) X(06) 9(07) 9(07) DATE X(01) 9(07) 9(07) 9(07) 9(07) Accounts Receivable Release 7.3 TRM Supplement CODE X(02) REG_HOLD_IND TRANS_HOLD_IND GRAD_HOLD_IND GRADE_HOLD_IND DESC AR_HOLD_IND ENV_HOLD_IND VR_MSG_NO DISP_WEB_IND X(01) X(01) X(01) X(01) X(30) X(01) X(01) 9(06) X(01) Legend X 9 Alphanumeric Numeric 1-9 1 Database Schematics Entity Relationship Diagrams (ERD) Detail Code Setup TBRACCD (Amount Charge/Payment Detail Information) PIDM 9(22) TRAN_NUMBER 9(22) TERM_CODE X(6) DETAIL_CODE X(4) USER X(30) ENTRY_DATE DATE AMOUNT 9(22) BALANCE 9(22) EFFECTIVE_DATE DATE BILL_DATE DATE DUE_DATE DATE DESC X(30) RECEIPT_NUMBER 9(22) TRAN_NUMBER_PAID 9(22) CROSSREF_PIDM 9(22) CROSSREF_NUMBER 9(22) CROSSREF_DETAIL_CODE X(4) SRCE_CODE X(1) ACCT_FEED_IND X(1) ACTIVITY_DATE DATE SESSION_NUMBER 9(22) CSHR_END_DATE DATE CRN X(5) CROSSREF_SRCE_CODE X(1) LOC_MDT X(1) LOC_MDT_SEQ 9(22) RATE 9(22) UNITS 9(22) DOCUMENT_NUMBER X(8) TRANS_DATE DATE PAYMENT_ID X(20) INVOICE_NUMBER X(8) STATEMENT_DATE DATE INV_NUMBER_PAID X(8) CURR_CODE X(4) EXCHANGE_DIFF 9(22) FOREIGN_AMOUNT 9(22) LATE_DCAT_CODE X(3) FEED_DATE DATE FEED_DOC_CODE X(8) ATYP_CODE X(2) ATYP_SEQNO 9(22) CARD_TYPE_VR X(1) CARD_EXP_DATE_VR DATE CARD_AUTH_NUMBER_VRX(12) CROSSREF_DCAT_CODE X(3) 1-10 TBBDETC (Detail Change/Payment Code Definition) TBRACCT (Detail Code Account Definition_ DETAIL_CODE ACCOUNT_A ACCOUNT_B PERCENT ACTIVITY_DATE TBDS_CODE DETC_EFF_DATE USER_ID X(4) X(60) X(60) 9(22) DATE X(2) DATE X(30) DETAIL_CODE DESC TYPE_IND PRIORITY LIKE_TERM_IND DCAT_CODE AMOUNT TERM_CODE EFFECTIVE_DATE REFUNDABLE_IND RECEIPT_IND REFUND_IND ACTIVITY_DATE PAYT_CODE PREBILL_PRINT_IND GL_NOS_ENTERABLE TAXT_CODE TBDC_IND DETAIL_CODE_IND DETC_ACTIVE_IND DIRD_IND X(4) X(30) X(1) X(3) X(1) X(3) 9(22) X(6) DATE X(1) X(1) X(1) DATE X(1) X(1) X(1) X(2) X(1) X(1) X(1) X(1) TBBETBD (Effective Date Term-based Designator Definition) EFF_DATE NCHG_DATE ACTIVITY_DATE USER_ID TERM_DATE DATE DATE DATE X(30) DATE TBBTBDS (Term-based Designator Rules) TBDS_CODE OPERATOR TERM_CODE PRIOR_SUM_OP PRIOR_SUM_TERM_SUFX ACTIVITY_DATE USER_ID EFF_DATE X(2) X(1) X(6) X(2) X(2) DATE X(30) DATE TBBEACT (Effective Date Detail Code Amount Definition) DETAIL_CODE X(4) EFF_DATE NCHG_DATE ACTIVITY_DATE USER_ID TBDC_IND TERM_DATE DATE DATE DATE X(30) X(1) DATE Accounts Receivable Release 7.3 TRM Supplement Legend X 9 Alphanumeric Numeric May 2006 Confidential 1 Database Schematics Entity Relationship Diagrams (ERD) Third Party Contract Setup TBRCREQ (Contract Course Requirements) TBRMESG (??????????) Legend PIDM CONTRACT_NUMBER TERM_CODE SEQNO SUBJ_CODE CRSE_NUMB X Alphanumeric 9 Numeric 9(22) 9(22) 9(22) X(6) 9(22) X(1) DATE X(30) X(60) TTVTPRC (Rule Code Validation) CODE DESC X(10) X(30) STU_PIDM CONTRACT_PRIORITY CONTRACT_PIDM CONTRACT_NUMBER TERM_CODE AUTH_NUMBER AUTH_IND STUDENT_CONT_ROLL_IND MAX_STUDENT_AMOUNT 9(22) 9(22) 9(22) 9(22) X(6) X(30) X(1) X(1) 9(22) 9(22) 9(22) 2(60) PIDM CONTRACT_NUMBER TERM_CODE MIN_AMOUNT MAX_AMOUNT PERCENT SRCE_CODE ACC_PRIORITY 9(22) 9(22) X(6) 9(22) 9(22) 9(22) X(1) 9(22) CODE X(1) DESC X(30) TBRCCSI (Include/Exclude Category Code by Source) PIDM CONTRACT NUMBER TERM_CODE 9(22) 9(22) X(6) DESC DETAIL_PAY_CODE DETAIL_CHG_CODE CONTRACT_ROLL_IND STUDENT_CONT_ROLL_IND TPRL_CODE X(30) X(4) X(4) X(1) X(1) X(10) TBRCCAT (Category Code Level Authentication) PIDM CONTRACT_NUMBER TERM_CODE DCAT_CODE MIN_AMOUNT MAX_AMOUNT PERCENT I_E_SOURCE_IND DCAT_PRIORITY 9(22) 9(22) X(6) X(3) 9(22) 9(22) 9(22) X(1) 9(22) PIDM CONTRACT_NUMBER TERM_CODE DCAT_CODE 9(22) 9(22) X(6) X(4) TTVDCAT (Category Code Validation) CODE DESC X(3) X(30) TBBCCTX (Contract/Contract Number Text) TBBTPRL (Rule Code Definition) TPRC_CODE PRINT_SCHEDULE_IND PRINT_SUMMARY_IND INDIVIDUAL_BILL_IND AUTHORIZE_NUM_IND COLC_AGENCY_PIDM SEQ_NUMBER TEXT TBBCONT (Contract Information) TBBCSTU (Student Authorization Information) TBBCSTT (Student Text) PIDM CONTRACT_PIDM CONTRACT_NUMBER TERM_CODE SEQ_NUMBER PRINT_IND ACTIVITY_DATE USER_ID TEXT 9(22) 9(22) X(6) 9(22) X(4) X(5) TTVSRCE (Source Validation) TBRCACC (Account Level Authentication) X(10) X(1) X(1) X(1) X(1) CONTRACT_PIDM CONTRACT_NUMBER TERM_CODE SEQ_NUMBER PRINT_IND 9(22) 9(22) X(6) 9(22) X(1) TBRCDSI (Included/Excluded Detail Code by Source) TBRCDET (Detail Code Level Authentication) PIDM CONTRACT_NUMBER TERM_CODE DETAIL_CODE MIN_AMOUNT MAX_AMOUNT PERCENT I_E_SOURCE_IND DETAIL_PRIORITY 9(22) 9(22) X(6) X(4) 9(22) 9(22) 9(22) X(1) 9(22) PIDM CONTRACT_NUMBER TERM_CODE DETAIL_CODE SOURCE_CODE 9(22) 9(22) X(6) X(4) X(1) TBBDETC (Detail Code Definition) DETAIL_CODE DESC DETC_ACTIVE_IND May 2006 Confidential Accounts Receivable Release 7.3 TRM Supplement X(4) X(30) X(1) 1-11 1 Database Schematics Entity Relationship Diagrams (ERD) Exemption Setup TBREACC (Account Level Authorization) TTVSRCE (Source Validation) Legend X 9 EXEMPTION_CODE TERM_CODE SRCE_CODE MIN_AMT MAX_AMT PERCENT ACC_PRIORITY Alphanumeric Numeric EXEMPTION CODE TERM_CODE SEQ_NUMBER SUBJ_CODE CRRSE_NUMB X(8) X(6) 9(22) X(4) X(5) EXEMPTION_CODE TERM_CODE DESC DETAIL_CODE EXEMPTION_ROLL_IND EXPT_ROLL_IND X(8) X(6) X(30) X(4) X(1) X(1) EXEMPTION_CODE TERM_CODE DCAT_CODE MIN_AMT MAX_AMT PERCENT DCAT_PRIORITY I_E_SOURCE_IND X(8) X(6) X(3) 9(22) 9(22) X(22) X(3) X(1) TBREDET (Detail Code Level Authorization) TBBESTU (Student Authorization Information) PIDM EXEMPTION_PRIORITY EXEMPTION_CODE TERM_CODE STUDENT_EXPT_ROLL_IND MAX_STUDENT_AMOUNT 1-12 9(22) 9(22) X(8) X(6) X(1) 9(22) TBRBCSI (Included/Exclude Category Code by Source) EXEMPTION_CODE TERM_CODE DCAT_CODE SOURCE_CODE SRCE_CODE DESCRIPTION X(1) X(30) X(8) X(6) X(3) X(1) TBRECAT (Category Code Level Authorization) TBBEXPT (Exemption Information) TBREREQ (Exemption Course Requirements) X((8) X(6) X(1) 9(22) 9(22) 9(22) X(22) EXEMPTION_CODE TERM_CODE DETAIL_CODE MIN_AMT MAX_AMT PERCENT DETAIL_PRIORITY I_E_SOURCE_IND X(3) X(6) X(4) 9(22) 9(22) 9(22) X(3) X(1) Accounts Receivable Release 7.3 TRM Supplement TTVDCAT (Category Code Validation) DCAT_CODE DESCRIPTION X(3) X(30) TBREDSI (Include/Exclude Detail Code by Source) EXEMPTION_CODE TERM_CODE DETAIL_CODE SOURCE_CODE X(8) X(6) X(4) X(1) TBBDETC (Detail Code Definition) DETAIL_CODE DESCRIPTION DETC_ACTIVE_IND X(4) X(30) X(1) May 2006 Confidential 2 Chapter 2 Reports and Processes Reports and Processes The Accounts Receivable User Guide contains descriptions and report samples of the Accounts Receivable reports in the General, Student, and Finance modules. Please refer to that manual for functional information about the use of the Accounts Receivable reports. The following pages contain brief descriptions of reports in the Accounts Receivable module. Report Identifier Report Name Report Description TFRBILL Invoice/Bill Process Processes invoices by invoice number and produces a billing statement for a userdefined timeframe. TFRDETL Account Detail Report Shows account transaction ledger by date. TFRLATE Assess Penalty/Interest Charges Report Shows assessment of late charges for outstanding Accounts Receivable accounts. TFRRFND Auto Refunding of Credit Amounts Identifies accounts which have a credit balance identified, flagged and reported. TGPBILL Billing Purge Process Enables you to identify which customer accounts may have their individual charge and payment transactions purged and creates Balance Forward Transactions to identify this summarization based on effective date, due date, and bill dates with user defined time frames. TGPHOLD Auto Hold Release Process Based on the parameters and rules form, automatically adds and releases holds on a student account. TGRAGES Aging Analysis Report Used to analyze all past-due accounts. TGRAPPL Application of Payment Report Applies payments to charges for accounts based on priority. TGRCDEL Cashier Delete Process Deletes the cashiering records for which all corresponding detail records have been fed to accounting. May 2006 Confidential Accounts Receivable Release 7.3 TRM Supplement 2-1 2 Reports and Processes Report Identifier Report Name Report Description TGRCLOS Cashier Session Close Process Automates the closing and/or finalizing of cashier sessions. TGRCOLC Collection Agency Report Reviews collection agency performance. TGRCSHR Cashier Delete Report Shows daily bank deposit and user audit. TGRDELI Batch Update of Delinquencies Identifies past due accounts and those with a delinquency code. TGRDETC Detail Code Report An Oracle report that displays detail codes and their associated accounting distributions. TGRFEED Accounting Feed Process Shows audit trail of all cashier transactions. TGRMISC Miscellaneous Receipt Report Shows receipt printouts for miscellaneous transactions. TGRRCON Accounts Receivable Reconciliation Report Enables you to specify various parameters to create a receivables reconciliation report. TGRRCPT Account Receipt Report Shows receipt printout for account related transactions. TGRUNAP Unapplication of Payment Report Unapplies previous application of payment before re-applying with new transaction. TGRAGES Aging Analysis Report Reviews past due status of accounts. TRRAGES Grant Aging Analysis Report Provides analysis of the grant receivables. You can print this report for aging of both billed and unbilled receivables. 2-2 Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential 2 Reports and Processes Report Identifier Report Name Report Description TRRAPPL Grants Application of Payment Process This process enables you apply payments to the charges. This process has no parameters. It applies payments to charges by grant. If a Tpay number or invoice paid number is entered by the user in the payments entry form (FRAAREV), this process first applies the payment to that specific charge transaction number or for that specific bill invoice number. If these two fields are not entered by the user, then the process will apply the payment against a grant to the oldest charge TRRCOLL Grants Collections Report Prints information about collection efforts that have been entered on the Grant Billing Collections Form (TRACOLL). You can run the report by status of the bill (open or closed), or by user ID, grant, or agency. TRRRCON Grant Reconciliation Report This report reconciles data between the Accounts Receivable module and the Finance module for Grant Billing transactions only. You can reconcile by chart or by grant or by payment management system code. You can also print just the grants that are out of balance or just the Payment management system codes that are out of balance. This report reconciles between billed summary and billed detail, Payments in AR against payments in General ledger and billed charges in AR against charges in the general ledger. TRRUNAP Unapplication of Payments Process Enables you to unapply payments that have been incorrectly applied to a charge. After you run this process, you can apply the payment to the appropriate charge TRRUNPL Unapplied Payments Listing This report prints a list of all payments that have not been applied to charges. It also prints the fund codes the exact payment was posted to. This report is sorted by grant May 2006 Confidential Accounts Receivable Release 7.3 TRM Supplement 2-3 2 Reports and Processes Report Identifier Report Name Report Description TSP1098 1098 Student Tax Notification Process The TSP1098 process retrieves existing data from the Tax Information Form (TSATAXI), and other fields within Banner and populates the Student Tax Notification Form (TSATAXN). TSPISTA Assign Installment Plans This process is used to assign students to an installment plan. TSPISTT Create Installment Transaction This process is used to create the installment plan transactions in the Accounts Receivable Transaction Detail Table (TBRACCD). Rules created on the new Installment Plan Rules Form (TSAISTR) are used for processing. TSR1098 1098 Student Tax Report Process Use the TSR1098 Process to print 1098-T paper forms for IRS/ Student Notifications on Moore Business Forms or produce the IRS file. TSRBTOT Total Billed Report The A/R Supervisor uses this report to review the billing amounts by detail code by term. TSRCBIL Billing Invoice/Student Billing Statement Processes deposits, contracts, exemptions, and/or financial aid. You can request either invoices or statements. The A/R Supervisor uses this report on a monthly or user-defined timeline. TSRDETL Account Detail Report The A/R Supervisor uses this report to review the account transaction ledger by term. TSRLATE Assess Penalty/Interest Charges Report The A/R Supervisor uses this report to assess penalty and interest charges for outstanding student accounts. TSRLBOX Lockbox Tape Unload Process Posts payments received through electronic funds transfer to a person’s account. TSRPDRV Lockbox Result Print Program Prints the results of the action performed by the Lockbox Tape Unload Process (TSRLBOX). 2-4 Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential 2 Reports and Processes Report Identifier Report Name Report Description TSRRFND Auto Refunding of Credit Amounts Identifies and flags those accounts which have a credit balance with a refund detail code. In addition, it lists the generated refund transactions with an address. TSRROLL Contract and Exemption Roll Process Allows contracts and/or exemptions and associated students to roll from one term to the next term. TSRSSUM Student Transaction Summary Report Displays a student’s balance and individual charges and payments. TSRTBIL Third Party Billing Statement Processes third party charges and payments in either invoice or statement mode. The A/R supervisor uses this report on a monthly or user-defined time frame. TSRTRAF 1098 Student Detail Tax Report Use the TSRTRAF process to produce a flat file of Tax Notification Data to send to third party servicers and/or to print the detail for all tax report codes created for the given tax year. This detail may be included in Student Notification mailings. TSRTSUM Transaction Summary Report Displays billed and unbilled transactions by date range in summary or detail mode for individual students or groups of students. May 2006 Confidential Accounts Receivable Release 7.3 TRM Supplement 2-5 2 Reports and Processes Report Identifier Report Name Report Description TVPREQA Create Title IV Authorizations from Requirements Use this process to create authorizations from financial aid tracking requirements for students with statuses that have been updated since a date that you specify. You can use this process on an as-needed basis to keep track of students as they complete their financial aid requirements. TVRCRED Students with Title IV Credit Report Use the TVRCRED process to produce a report that displays Title IV students who have a credit account balance. Run the report after Disbursements (RPEDISB) and Application of Payments (TGRAPPL). Students who have authorized the institution to hold Title IV funds are shown separately on this report. You may contact other students with a Title IV credit balance regarding authorization to apply Title IV aid to other amounts due or initiate a refund for them. 2-6 Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential 2 Reports and Processes AR Reports and Processes Matrix AR Reports and Processes Matrix Legend Report or Process The report/batch process name Language Identifies the language for the process - COBOL, C Update/Query Does the process update any tables, or is it strictly a query-only report? Audit Can you run the update process in Audit Mode, so that you can produce the report without an update taking place? Job Submission Can you run the process via job submission? Sleep/Wake Is the process used in conjunction with Sleep/Wake? Off Peak Does SunGard Higher Education recommend that you defer this program to an off peak processing time (late night, weekends) for performance reasons? Restart If the process aborts or is terminated after the process is initiated, can you restart the process without any adverse consequences? Accounts Receivable Reports and Processes Report or Process Language Update/ Query TFRBILL C Update Yes TFRDETL C Query Yes TFRLATE C Update Yes Yes Yes TFRRFND C Update Yes Yes Yes TGPBILL C Query Yes Yes TGPHOLD C Update TGRAGES C Query Yes TGRAPPL C Update TGRCDEL C Update TGRCLOS C Update TGRCOLC C Query TGRCSHR C Query May 2006 Confidential Audit Yes Yes Job Submission Yes Sleep/ Wake Yes Off Peak Restart Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Accounts Receivable Release 7.3 TRM Supplement Yes Yes 2-7 2 Reports and Processes Accounts Receivable Reports and Processes Report or Process Language Update/ Query Audit TGRDELI C Update Yes TGRDETC Oracle Query TGRFEED C Update Yes TGRMISC C Query Yes TGRRCON C Query Yes TGRRCPT C Query Yes TGRUNAP C Update Yes Yes TRRAGES C Query Yes Yes TRRAPPL C Update Yes Yes TRRCOLL C Query Yes Yes TRRRCON C Query Yes Yes TRRUNAP C Update Yes Yes TRRUNPL C Query Yes Yes TSP1098 C Update TSPISTA C Update Yes TSPISTT C Update Yes Yes TSR1098 C Update Yes Yes TSRBTOT C Query TSRCBIL C Update TSRDETL C Query TSRLATE C Update TSRLBOX COBOL Update Yes TSRPDRV COBOL N/A Yes TSRRFND C Update 2-8 Job Submission Sleep/ Wake Off Peak Restart Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential 2 Report or Process Language Update/ Query Audit Job Submission TSRROLL C Update Yes Yes TSRSSUM C Query TSRTBIL C Update Yes Yes TSRTRAF C Update Yes Yes TSRTSUM C Query Yes TVPREQA C Update Yes TVRCRED C Query Yes Yes Sleep/ Wake Reports and Processes Sleep/Wake-up Off Peak Restart Yes Yes Yes For a more detailed description of each report and its parameters, generate a List of Reports and Parameters (GJRRPTS). This report also includes batch processes. Sleep/Wake-up Banner provides two different mechanisms for running jobs in a cyclical or sleep/ wake-up manner. Setting Up Sleep/Wake Processes Using Method One The first method uses OS command scripts and an SQL*Plus script to cause the job to run in a cyclical fashion. These jobs must be submitted from the operating system prompt and must be terminated manually. To compile programs to run in this fashion, you must define the NO_SLEEP_SW as a pre-compiler directive to exclude the code used by the second technique. UNIX The first command procedure, sleepunx, prompts for parameters needed by the second procedure and SQL*Plus scripts, sleepunx.shl and sleepunx.sql respectively. This procedure then starts (or submits) sleepunx.shl, which in turn starts sleepunx.sql. The SQL*Plus script sleepunx.sql will spool OS-specific commands to run the job into a file, provided there is actually work to do as determined by the parameters previously entered. When the SQL*Plus script exits, sleepunx.shl executes the spool file. The parameters needed by the program are contained in a XXXXXXX.dat file which are read via input redirection when the job executes. The second command procedure sleepunx.shl then sleeps for the specified interval, awakes, and loops back to start the SQL*Plus script again. May 2006 Confidential Accounts Receivable Release 7.3 TRM Supplement 2-9 2 Reports and Processes Sleep/Wake-up VMS This is essentially the same as for UNIX. The script names are sleep.com, sleepdec.com, and sleepdec.sql. Command input redirection is accomplished by defining sys$input as the .dat file. The sleeping is done with the wait command. CMS In this environment, there is only one command script, sleepcms.exec. Each job run in sleep/wake mode must have its own .exec script. The command script sleepcms.exec is provided as the model. You also need to set up separate CMS accounts for each job or you may combine the execs to run sequentially on a single account. The .dat file is read via input redirection. Sleeping is performed using the CP SLEEP command. Setting Up Sleep/Wake Processes Using Method Two Note: The following Banner systems and processes are valid for the Sleep/Wake processing described in this section: Report/Process Description TGRRCPT TSRCBIL TGRMISC TSRSSUM Account Receipt Student Billing Statement (Invoices) Miscellaneous Receipt Student Transaction Summary Report 1. Operating System Print Command UNIX example: lp -d talaris1 @ VMS example: print/queue=ln01 @ 2. 2-10 Define printer and print command on the Printer Validation Form (GTVPRNT). In the (Printer) Code field, enter a name to reference each specific printer that may be used for printing output from sleep/wake processing. In the Comment (Printer Command) field, enter the correct operating system print command as it would normally be entered from the command line prompt, substituting an at sign (@) as the place holder for the filename to be printed. On the appropriate System Distribution Initialization Information Form (SOADEST for Student or TOADEST for Accounts Receivable), enter the printer code from GTVPRNT that should be identified with the collector table rows that will be inserted to the appropriate tables when online application forms create a request for output that can be generated by sleep/wake processing. Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential 2 Reports and Processes Sleep/Wake-up Note: The collector tables are as follows: Process Collector Table TGRMISC TGRRCPT TSRCBIL TSRSSUM TBRCMIS TBRCRCP TBRCBRQ TBRCSUM 3. On the Process Submission Control Form (GJAPCTL), for the valid sleep/ wake jobs listed previously, enter the correct response for the parameter that specifies that the job should be processed for collector table entries. Refer to the documentation for each specific process to determine the appropriate response in each case (correct responses may be COLLECTOR, Y, %, etc.). In addition, each sleep/wake job has a printer code parameter. You must specify exactly the same code for this parameter answer that was entered on either SOADEST or TOADEST. A value of Y should be entered for the run in sleep/wake mode parameter, and a number of seconds should be specified for the sleep/wake interval (cycle) for each process. Note: Do not enter the printer code in the top section of GJAPCTL; only enter it in the parameter section of the form. 4. The Sleep/Wake Maintenance Form (GJASWPT) should be used to stop the sleep/wake process or to change the sleep interval. A process name and printer code must be entered in the Key Information. A List of Values is available in each field to see the valid list of processes and printer codes that have ever been submitted for sleep/wake processing. To stop the process, enter N in the Continue to Run field and do a Save function. The job will not stop immediately, but rather will stop after the next time the process wakes up and finishes the next processing cycle. To change the sleep interval, enter the desired interval in the Next Cycle Time field and do a Save function. The GJASWPT form can also be used to view statistics regarding how many rows were processed for the most recent wakeup cycle and the total number of rows processed since the process was initiated. You can also determine if the processes terminated abnormally. by viewing the Abnormal Termination field. If there is a Y in Abnormal Termination, something caused the process to fail. You should review log files to determine the cause. Operating Systems Without Sleep/Wake-up Commands Operating systems which do not have sleep commands, or whose sleep commands may not be executed by user programs, must use the first method. May 2006 Confidential Accounts Receivable Release 7.3 TRM Supplement 2-11 2 Reports and Processes Sleep/Wake-up Collector File Entries The following forms can be used to generate the collector file entries: Form Description/Generate Report/Process Description TGARCPT Receipt Form Can generate: TGRRCPT A/R Receipt Account Detail Query Form Can generate: TGRRCPT A/R Receipt Foreign Currency Detail Form Can generate: TGRRCPT A/R Receipt Account Detail Form Can generate: TGRRCPT A/R Receipt Billing Mass Data Entry Form Can generate: TGRRCPT A/R Receipt Billing Mass Entry Detail Form Can generate: TGRRCPT A/R Receipt Currency Code Calculation Form Can generate: TGRRCPT A/R Receipt Student Foreign Currency Detail Form Can generate: TGRRCPT A/R Receipt Student Account Detail Form Can generate: TGRRCPT A/R Receipt Billing Mass Data Entry Form Can generate: TGRRCPT A/R Receipt Student Payment Form Can generate: TGRRCPT A/R Receipt Miscellaneous Transaction Form Can generate: TGRMISC Miscellaneous Receipt Miscellaneous Transaction Form Can generate: TGRMISC Miscellaneous Receipt TFAAREV TFADETF TFADETL TFAMASS TFAMDET TSAAREV TSADETF TSADETL TSAMASS TSASPAY TSAMISC TFAMISC 2-12 Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential 2 Reports and Processes Running Oracle Reports with Accounts Receivable Running Oracle Reports with Accounts Receivable When running through Banner, Reports is not currently able to access the default role defined for the Report in the bansecr schema. Therefore, product-specific roles are being created with the base privileges needed to run the Reports, which must be granted to any user who will run Reports for that product using Banner. In the Accounts Receivable product plus sub-directory, you will find tasorep.sql. This script will create the necessary role and assign the privileges needed to run the Reports. Please review this script before applying it to your production database. 1 Invoke SQL*Plus and run the procedure: sql_cmd system/password [ENTER] start tasorep 2 [ENTER] Next, grant the role to the users who will be running the reports and set it as one of their default roles. sql_cmd system/password [ENTER] grant ban_arsys_rep to “your_user” [ENTER] alter user “your_user” default role ban_default_connect, ban_arsys_rep Note: The alter user statement should include all of the user’s default roles. Refer to sys.dba_role_privs for existing roles where default_role=YES for your_user as grantee. Additional documentation on Oracle reports is available in the General Technical Reference Manual. May 2006 Confidential Accounts Receivable Release 7.3 TRM Supplement 2-13 2 Reports and Processes Running Oracle Reports with Accounts Receivable This page intentionally left blank 2-14 Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential 3 Interfaces Accounts Receivable Interfaces Chapter 3 Interfaces This chapter identifies Banner products that interface with Banner Accounts Receivable and tables used by these interfaces. This chapter also provides detailed information about the Lockbox Tape Unload Process (TSRLBOX). Accounts Receivable Interfaces The Banner Accounts Receivable system interfaces with the following Banner products: Higher Education • Banner Finance System • Banner Student System • Banner General System Interfaces within Banner Table Name Description GURFEED Table This table contains financial transactions from other Banner applications or client-developed applications which are to be processed into Banner Finance using the FURFEED and FGRTRNI processes. GURAPAY Table This table contains single line invoices from other Banner applications or client-developed applications, which are to be processed into Banner using the FURAPAY process. Lockbox Payment Processing The Lockbox Tape Unload Process (TSRLBOX) posts payments received through electronic funds and transferred to a person’s account. May 2006 Confidential Accounts Receivable Release 7.3 TRM Supplement 3-1 3 Interfaces Interfaces within Banner Note: The tape format must include at least one detail record and one batch summary record in order for the tape to be processed. If the data received from the bank via the tape is in error, use the Lockbox Correction Form (TSALBOX) to correct errors. ID transaction date and invoice number paid can be modified. After corrections have been made, rerun TSRLBOX using the Lockbox Intermediate Table (TBRLBOX) as input. Processing Details: This process unloads the Lockbox electronic funds transfer tape data to a database table (TBRLBOX) and/or attempts to post the information from the Lockbox Intermediate Table to the Account Detail Table (TBRACCD). If the input to the process is TAPE, the Lockbox tape is read. File header, batch header, and file summary records are not loaded to the TBRLBOX table. The TBRLBOX table contains only batch detail and batch summary records. Each batch detail record read from the tape is loaded to TBRLBOX. When a batch summary record is encountered, information about the batch is loaded to an internal table (which will be printed on the control report), the record is loaded to TBRLBOX, the batch is committed to the database and the TBRLBOX_BATCH_VERIFY_IND is set. A batch is marked as verified (TBRLBOX_BATCH_VERIFY_IND = Y) when the computed total of the batch detail amounts is the same as the total on the batch summary record. An entire batch is either verified on unverified (that is, the indicator is set on the batch summary record and on all the batch detail records). Once the data have been loaded to the database, or the input to the process is TABLE, the Lockbox Intermediate Table (TBRLBOX) is processed. The ID must be a valid ID on SPRIDEN. The invoice number paid (if present) must be a valid invoice number on TBRACCD for the ID. The amount to be paid against an invoice must also be valid. When it is determined that at least one payment will be posted to the Account Detail Table (TBRACCD), a cashiering session is created. For each payment to be posted to TBRACCD, a tran number will be generated, the payment will be inserted into TBRACCD, and the TBRLBOX record processed will be deleted. When all batch details are deleted from TBRLBOX, the batch summary will be deleted from TBRLBOX. A control report will be generated. Note: The Lock Box process must be tailored to your specific input format, including the check digit algorithm if you choose to use one. The tape layout provides for check digits for further verification of data. Check digit verification should occur when validating ID, invoice number paid, etc. Add logic to use your check digit algorithm. Technical staff should refer to the Cobol source code TSRLBOX.pco. Note: The program inserts a year 2000 compliant date into TBRLBOX when reading from TAPE. There is a SUBSTR function used and the format for the SUBSTR function is YYMMDD. The date being read from the tape should be in YYMMDD format. This gets inserted into 3-2 Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential 3 Interfaces Interfaces within Banner TBRLBOX_BATCH_TRANS_DATE with appropriate century. If the format is different on the tape, then the code for the SUBSTR function needs to be changed. Tailoring the Lock Box Process to your Institution The Lock Box process must be tailored to your specific input format. The record length of the Lock Box input file is 80 characters. The basis of this layout is that each record contains a record type and a batch number. If this basic premise cannot be kept intact, the BANNER AR Lock Box process should not be used since this is inherent in the design. The record length may be changed, but the record must contain a record type and a batch number. The length of record type and batch number may be modified. There are five record types: 1. File Header Record; denoted by a record type of 1 2. Batch Header Record; denoted by a record type of 2 3. Batch Detail Record; denoted by a record type of 3 4. Batch Summary Record; denoted by a record type of 4 5. File Summary Record; denoted by a record type of 5 To modify the record types, change the value of the following 05-level variables under the 01 level DECLARE-SPECIFIC: 05 DECL-FILE-HEADER PICTURE X(01) VALUE '1' 05 DECL-BATCH-HEADER PICTURE X(01) VALUE '2' 05 DECL-BATCH-DETAIL PICTURE X(01) VALUE '3' 05 DECL-BATCH-SUMMARY PICTURE X(01) VALUE '4' 05 DECL-FILE-SUMMARY PICTURE X(01) VALUE '5' To modify the lock box record layout: May 2006 Confidential 1. Modify the LBOXFILE File Definition (FD); change the RECORD CONTAINS clause and the picture clause on the 01 level LBOX-RECORD. This is only necessary if record length is being modified. 2. Modify the 05-level and 07-level variables under the 03 level WS-LBOX-RECORD in the WORKING-STORAGE SECTION. Keep in mind that the different record types were defined using a REDEFINES clause. When the length of the 05 level LBOX-DATA (length 76) is added to the length of the 05 levels LBOX-BATCHNUMBER (length 3) and LBOX-RECORD-TYPE (length 1), the total is 80. Therefore, any change in record length must be accounted for when redefining. Accounts Receivable Release 7.3 TRM Supplement 3-3 3 Interfaces Interfaces within Banner Modify the 07-level variables under the 05-level variables (WS-LBOX-FILEHEADER, WS-LBOX-BATCH-HEADER, WS-LBOX-DETAIL, WS-LBOX-BATCHSUMMARY, WS-LBOX-FILE-SUMMARY) to define the layout of your input file. Remember that the total of the lengths of 07-level variables under the 05-level variables (WS-LBOX-FILE-HEADER, WS-LBOX-BATCH-HEADER, WS-LBOXDETAIL, WS-LBOX-BATCH-SUMMARY, WS-LBOX-FILE-SUMMARY) must be the same length as WS-LBOX-DATA. 3. The 01 level DECL-LBOX-RECORD is a combination of the record type, batch number, and the detail record (WS-LBOX-DETAIL in the WORKING-STORAGE SECTION); make the appropriate changes. 4. Keep in mind that any references, whether direct (that is, the field itself) or implied (for example, hold fields), to fields that have been modified or deleted, must be modified or removed Once the record layout has been modified: • If the file header record has been modified or dropped, modify or delete paragraph MBB-FILE-HEADER. • If the batch header record has been modified or dropped, modify or delete paragraph MBC-BATCH-HEADER. • If the batch detail record has been modified or dropped, modify or delete paragraph MBD-BATCH-DETAIL. • If the batch summary record has been modified or dropped, modify or delete paragraph MBE-BATCH-SUMMARY. • If the file summary record has been modified or dropped, modify or delete paragraph MBD-FILE-SUMMARY. • If the total batch amount has been removed from the batch summary record, remove logic to verify the batch (that is, delete paragraphs MBG-VERIFY-BATCH and MBH-UPDATE-BATCH-IND). • All references to any deleted paragraph should be removed. • If check digits are being used, add paragraph(s) to further verify data using check digits. These paragraph(s) should be performed prior to inserting into the Lock Box Intermediate Table. An internal table, used to display information about what was contained on the lock box file, is loaded in paragraph MBI-LOAD-BATCH-TABLE. The table can hold information for a maximum of 100 batches. If your input file contains more than 100 batches, modify the OCCURS clause on the 03 level BATCH-INFO and change the reference to 100 in MBI-LOAD-BATCH-TABLE. The record layout for the extract record, which is passed to a sort program and a print program, resides in the include module TSRLBOXO. If any changes are made to the extract record, the sort program (TSRSORT) and the print program (TSRPDRV) must be modified to accommodate the changes. 3-4 Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential 3 Interfaces Interfaces within Banner Note: The program inserts a year 2000 compliant date into TBRLBOX when reading from TAPE. There is a SUBSTR function used and the format for the SUBSTR is YYMMDD. So the date being read from the tape should be in YYMMDD format. This gets inserted into TBRLBOX_BATCH_TRANS_DATE with appropriate century. If the format is different on the tape, then the code for the SUBSTR function needs to be changed. If the value of record type has been changed in TSRLBOX, the Lock Box Correction Form (TSALBOX) must also be modified. Specifically: May 2006 Confidential • Modify KEY-STARTUP to assign your values to TBRLBOX_REC_TYPE. • Modify KEY-CLRFRM to assign your values to TBRLBOX_REC_TYPE. Accounts Receivable Release 7.3 TRM Supplement 3-5 3 Interfaces Interfaces within Banner This page intentionally left blank 3-6 Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential 4 Conversion Conversion Tables for Accounts Receivable Chapter 4 Conversion To successfully convert your data, you should have a basic understanding of the Banner Data Element Dictionary (DED), and a report called Tables and Views. You should print hard copies of the General DED and the Accounts Receivable DED when SunGard Higher Education delivers each new tape. The DED displays the following information: Conversion Tables for Accounts Receivable Column Name Column Description Field Name Field name Type Character or date field indicator Width Field length Scale Number of digits to the right of the decimal point. For example, a scale of 2 indicates one-hundredths of a unit, as in .99. Nulls Null/Not Null Indicator Column Comments Description of the column, abbreviation of the validation table, etc. On the following pages are the conversion tables you need to convert your data for Banner Accounts Receivable. Step 1 Add IDs using the Identification Form. Step 2 Populate the Detail Charge/Payment Code Definition Table (TBBDETC) and the Detail Code Account Definition Table (TBRACCT) using the Detail Code Control Form. If you will be loading transactions in detail, you must build an entry for each unique detail code contained in your existing file. If you will be loading only summary information, you only need to build one or two codes. You would create two if you will identify credits with a detail code different from charges. You would build one if you use the same detail code for credits or charges. For example: BFWP - Balance forward payment, BFWC - Balance forward charge, or BFWD - Balance forward. May 2006 Confidential Accounts Receivable Release 7.3 TRM Supplement 4-1 4 Conversion Conversion Tables for Accounts Receivable Step 3 Load the Account Detail Table (TBRACCD) according to the following: Column Name Column Description TBRACCD_PIDM Internal identification number as calculated by the Identification Form. TBRACCD_TRAN_NUMBER A one-up number, beginning with one, to identify each transaction on the account. All accounts will start with 1. TBRACCD_TERM_CODE Value is ARTERM'. TBRACCD_DETAIL_CODE Valid detail code as entered on the Detail Code Control Form. TBRACCD_USER Userid of the cashier posting the transaction to the account. TBRACCD_ENTRY_DATE System date including hours, minutes and seconds. TBRACCD_AMOUNT Dollar amount of transaction in base currency. TBRACCD_BALANCE If the amount represents a credit to the person, this will be the amount multiplied by -1. If the amount represents a charge, this must be equal to the amount. 4-2 TBRACCD_EFFECTIVE_DATE System date excluding hours, minutes and seconds. TBRACCD_BILL_DATE See Note following this table. TBRACCD_DUE_DATE See Note following this table. TBRACCD_DESC Description of the detail code as found in the Detail Charge/Payment Code Definition Table for TBRACCD_DETAIL_CODE. TBRACCD_RECEIPT_NUMBER Null TBRACCD_TRAN_NUMBER_PAID Null TBRACCD_CROSSREF_PIDM Null TBRACCD_CROSSREF_NUMBER Null Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential 4 Conversion Conversion Tables for Accounts Receivable May 2006 Confidential Column Name Column Description TBRACCD_CROSSREF_DETAIL_CODE Null TBRACCD_SRCE_CODE Must be T. TBRACCD_ACCT_FEED_IND Refer to “Accounting Feed Options” on page 4-4. TBRACCD_ACTIVITY_DATE System date including hours, minutes and seconds. TBRACCD_SESSION_NUMBER Refer to “Accounting Feed Options” on page 4-4. TBRACCD_CSHR_END_DATE Refer to “Accounting Feed Options” on page 4-4. TBRACCD_CRN Null TBRACCD_CROSSREF_SRCE_CODE Null TBRACCD_LOC_MDT Null TBRACCD_LOC_MDT_SEQ Null TBRACCD_RATE Null TBRACCD_UNITS Null TBRACCD_DOCUMENT_NUMBER Null TBRACCD_TRANS_DATE System date excluding hours, minutes and seconds. TBRACCD_PAYMENT_ID Null TBRACCD_INVOICE_NUMBER Null TBRACCD_STATEMENT_DATE See Note following this table. TBRACCD_INV_NUMBER_PAID Null TBRACCD_CURR_CODE Null TBRACCD_EXCHANGE_DIFF Null TBRACCD_FOREIGN_AMOUNT Null TBRACCD_LATE_DCAT_CODE Null TBRACCD_FEED_DATE Null TBRACCD_FEED_DOC_CODE Null Accounts Receivable Release 7.3 TRM Supplement 4-3 4 Conversion Conversion Tables for Accounts Receivable Note: If you wish the transactions you create to appear in detail when statements are produced, these fields must be null. If you wish them to appear in summary as a previous balance, you should include the system date excluding hours, minutes, and seconds. Accounting Feed Options If you do not process these transactions through the Accounting Feed Process (TGRFEED), supply the following values for these columns: Column Name Column Description System date including hours, minutes and seconds. TBRACCD_ACCT_FEED_IND Must be F. TBRACCD_SESSION_NUMBER 001 TBRACCD_CSHR_END_DATE Same value as TBRACCD_ENTRY_DATE ________________________________________________________________________ TBRACCD_ENTRY_DATE If you run these transactions through the Accounting Feed Process (TGRFEED), supply the following values for these columns: Column Name Column Description System date including hours, minutes and seconds. TBRACCD_ACCT_FEED_IND Must be Y. TBRACCD_SESSION_NUMBER 001 TBRACCD_CSHR_END_DATE Same value as TBRACCD_ENTRY_DATE ________________________________________________________________________ TBRACCD_ENTRY_DATE All transactions you create during a given conversion run must have the same value for the TBRACCD_ENTRY_DATE and TBRACCD_CSHR_END_DATE. You also need to create an entry in the Cashier Session Table with the following values: Column Name TBBCSHR_USER TBBCSHR_SESSION_NUMBER TBBCSHR_START_DATE TBBCSHR_END_DATE TBBCSHR_SESSION_IND TBBCSHR_ACTIVITY_DATE TBBCSHR_BANK_DEPOSIT_ NUMBER TBBCSHR_BANK_CODE Column Description Same value as TBRACCD_USER. Same value as TBRACCD_SESSION_NUMBER. Same value as TBRACCD_CSHR_END_DATE. Same value as TBRACCD_CSHR_END_DATE. Must be R or F'. System date including hours, minutes and seconds. Null Null ________________________________________________________________________ 4-4 Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential 4 Conversion Conversion Tables for Accounts Receivable Run the Cashiering Report (TGRCSHR) to verify your work. Once satisfied, proceed by running the Accounting Feed Process (TGRFEED). Title IV Setup Considerations In its enhancement of the Accounts Receivable module, three data elements were added to the Detail Code Table (TBBDETC) to process Title IV credits and returns. These elements must be populated to use the new features related to handling Title IV credits in application of payments and refunding. Furthermore, one data element was added to the Accounts Receivable Detail Table (TBRACCD), to be used in calculating original charges for Title IV returns. This data element needs to be updated for any term(s) for which calculations are likely to be made under the new methodology. May 2006 Confidential Accounts Receivable Release 7.3 TRM Supplement 4-5 4 Conversion Conversion Tables for Accounts Receivable This page intentionally left blank 4-6 Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential 5 APIs Introduction Chapter 5 APIs Introduction Application Programming Interfaces (APIs) enhance processing and simplify code. This chapter contains information about the APIs and supporting packages that process Accounts Receivable information. For additional information, refer to the API Technical Documentation available via the Customer Support Center. Overview The API is actually a program comprised of four different packages: a primary package containing query functions and create, update, and delete procedures, a Rules package containing subprograms that support the primary package, a Strings package containing error messages, and an associated DML package that performs the actual database maintenance of the edited data. In addition to the API packages, there are three supporting package types. • Utility - Provides utility functions and procedures for the Banner APIs. • Validation - Contains standard functions and procedures for a specific validation table. • Support - Contains supporting programs that may be called by other APIs and error messages related to these edits. The APIs are called by programs within Banner (for example, forms, C processes, self-service packages), and may be called by external systems that need to create, update, or delete information stored in Banner tables. May 2006 Confidential Accounts Receivable Release 7.3 TRM Supplement 5-1 5 APIs APIs and Supporting Packages used in Banner Various institutions requested that SunGard Higher Education support schoolspecific validation logic with the APIs. The Banner APIs include connection points that you can use to interface with your own code to enable your validation logic without having to change baseline code. Note: In addition to standard User Exits for Create and Update functionality throughout the APIs, the tb_misc_detail_rules package includes a User Exit to enable editing of the Accounting String (Banner Finance not installed) or FOAPAL information (Banner Finance installed) when ledger numbers are enterable for miscellaneous detail. APIs and Supporting Packages used in Banner The following charts identify the API packages and supporting packages used to process Accounts Receivable data in Banner. The APIs replace the corresponding code in the Banner forms. API Packages Object Name Entity Name Task Performed Associated Table Associated Forms & Processes Associated Packages tb_customer_ profile CUSTOMER_ PROFILE Contains the Common Business interface for Customer Profile (CUSTOMER_ PROFILE). TBBCPRF TGACPRF tb_customer_ profile_rules Provides supporting subprograms for CUSTOMER_PROFILE. tb_customer_ profile_str Provides error messages and error message functions for CUSTOMER_ PROFILE. 5-2 Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential 5 APIs APIs and Supporting Packages used in Banner Object Name Entity Name Task Performed Associated Table Associated Forms & Processes Associated Packages tb_deposit DEPOSIT Contains the Common Business interface for DEPOSIT. TBRDEPO TFADETF, TFADETL, TFAMASS, TGACREV, TGPBILL, TGRCLOS, TGRFEED, TSADETF, TSADETL, TSAMASS, TSASPAY, TSRCBIL, TSRTBIL tb_deposit_rules tb_memo tb_misc_ detail MEMO MISC_DETAIL Contains the Common Business interface for the MEMO API (MEMO). Contains the Common Business interface for Miscellaneous Receipt Detail (MISC_DETAIL). TBRMEMO TBRMISD Provides supporting subprograms for DEPOSIT. tb_deposit_str Provides error messages and error message functions for DEPOSIT. TFADETL TGPBILL TSAACCT TSACONP TSACONT TSADETL TSASPAY TSRCBIL TB_DEPOSI T tb_memo_rules TFAMISC, TGACREV, TGRCLOS, TGRFEED, TSAMISC, TSKMODS, BWSKAPMT , BWSKWCCP tb_misc_detail_ rules Provides supporting subprograms for MEMO. tb_memo_str Provides error messages and error message functions for MEMO. Provides supporting subprograms for MISC_DETAIL and includes a User Exit to edit Accounting Information when ledger numbers are enterable. tb_misc_detail_ str Provides error messages and error message functions for MISC_DETAIL. May 2006 Confidential Accounts Receivable Release 7.3 TRM Supplement 5-3 5 APIs APIs and Supporting Packages used in Banner Object Name Entity Name Task Performed Associated Table Associated Forms & Processes Associated Packages tb_misc_ header MISC_HEADER Contains the Common Business interface for Miscellaneous Receipt Header (MISC_HEADER). TBBMISC TFAMISC, TGACREV, TGRCLOS, TGRFEED, TSAMISC, TSKMODS, BWSKAPMT , BWSKWCCP tb_misc_header_ rules Provides supporting subprograms for MISC_HEADER. tb_misc_header_ str Provides error messages and error message functions for MISC_HEADER. tb_receivable 5-4 RECEIVABLE Contains the Common Business interface for Student and NonStudent Accounts Receivable (RECEIVABLE). TBRACCD Accounts Receivable Release 7.3 TRM Supplement TFAADSP, TFADETF, TFADETL, TFAISTL, TFAMASS, TFAMDET, TFAUNAP, TFRBILL, TFRLATE, TFRRFND, TGACREV, TGPBILL, TGRAPPL, TGRCLOS, TGRFEED, TGRUNAP, TSAADSP, TSAAREV, TSADETF, TSADETL, TSAISTL, TSAMASS, TSASPAY, TSAUNAP, TSKFUNC, TSKMODS, TSP1098, TSPISTT, TSRLATE, TSRLBOX, TSRRFND, tb_receivable_ rules Provides supporting subprograms for RECEIVABLE. tb_receivable_str Provides error messages and error message functions for RECEIVABLE. May 2006 Confidential 5 APIs APIs and Supporting Packages used in Banner Object Name Entity Name Task Performed Associated Table tb_receivable (continued) tb_statement Associated Forms & Processes Associated Packages TSRTBIL, TTKMODS, RPEDISB, ISRKBIL, ISRKTRN, SAAADMS, SFAWDRL, SFKFEES, SFKMODS, SFRRNOP, SHACATT, SHADEGR, SHADIPL, SHAMCAT, SHAMDEG, SHAMDIP, SHREDIY, SHRTRTC SLAMASG, SLAPASG, SPARASG, SLRFASM, SMACACT, SMARQCM STATEMENT Contains the Common Business interface for the Statement API (STATEMENT). TBBSTMT TSRCBIL, TGPSTMT tb_statement_str Provides error message and error message functions for STATEMENT. tb_statement_ rules Provides supporting subprograms for STATEMENT. Note: This API will interact with the LARGE_OBJECT API (gb_large_object) to store a binary file. Please refer to the API Technical documentation of LARGE_OBJECT for details regarding the parameters handling file storage. May 2006 Confidential Accounts Receivable Release 7.3 TRM Supplement 5-5 5 APIs APIs and Supporting Packages used in Banner Object Name Entity Name Task Performed Associated Table Associated Forms & Processes Associated Packages tb_term_ control_ar TERM_CONTROL_ AR Contains the Common Business interface for Term Control (TERM_ CONTROL_AR). TBBTERM TSATERM tb_term_control_ ar_rules Provides supporting subprograms for TERM_CONTROL_AR. tb_term_control_ ar_str Provides error messages and error message functions for TERM_CONTROL_AR. DML Packages The DML packages in the following chart provide the procedures to insert, update, and delete from various Banner Accounts Receivable tables. 5-6 Package Name Associated Tables dml_tbbcprf Customer Profile Attributes Table (TBBCPRF) dml_tbbmisc Miscellaneous Transaction Receipt Header Table (TBBMISC) dml_tbbterm Accounts Receivable Term Control Table (TBBTERM) dml_tbrmemo Charge/Payment Detail Memo Table (TBRMEMO) dml_tbrmisd Miscellaneous Transaction Charge/Payment Detail Table (TBRMISD) dml_tbraccd Account Charge/Payment Detail Table (TBRACCD) dml_tbrdepo Deposit Table (TBRDEPO) Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential 5 APIs APIs and Supporting Packages used in Banner Support Packages The following chart identifies API utility packages that contain supporting programs that may be called by other APIs and error messages related to these edits. Object Name Entity Name Task Performed Associated Table Associated Forms & Processes Associated Packages tb_cashier_ session CASHIER_ SESSION Provides functional support for Cashiering (CASHIER_ SESSION). In a future release, this package may provide the Common Business interface for Cashier Session. TBBCSHR Not Applicable tb_cashier_ session_rules Provides the Common Business interface for Deposit Control (DEPO_CONTROL). TBBDEPC tb_depo_ control DEPO_CONTROL Provides supporting subprograms for cashiering. tb_cashier_ session_str Provides error messages and error message functions for cashiering. Not Applicable tb_deposit_ control_rules Provides supporting subprograms for DEPOSIT_CONTROL. tb_deposit_ control_str Provides error messages and error message functions for DEPOSIT_ CONTROL. tb_detail_ code DETAIL_CODE Provides functional support for Detail Codes. In a future release, this package may provide the Common Business interface for TBBDETC DETAIL_CODE. May 2006 Confidential Accounts Receivable Release 7.3 TRM Supplement Not Applicable tb_detail_code_ str Provides error messages and error message functions for DETAIL_CODE. 5-7 5 APIs APIs and Supporting Packages used in Banner Utility Packages The following chart identifies API utility packages that provide utility functions and procedures for the Banner Accounts Receivable APIs. Object Name Entity Name Task Performed Associated Tables Associated Forms & Processes Associated Packages tb_common COMMON Provides utility functions and procedures for Banner Accounts Receivable APIs. Not Applicable Not Applicable tb_common_str Provides interface to Finance packages for FOAPAL and security validations. Not Applicable TFAMISC tgkfoap Not Applicable Provides error messages and error message functions for COMMON. ffkfoap,fakrdef Validation Packages The following chart identifies API utility packages that provide standard functions and procedures for the specified Accounts Receivable validation tables. Object Name Task Performed Associated Table tb_ttvdcat Contains standard functions and procedures for the Detail Charge/Payment Category Code Validation Table. TTVDCAT tb_ttvecat Contains standard functions and procedures TTVECAT for the Entity Category Code Validation Table. tb_ttvsrce Contains standard functions and procedures for Billing Detail Source Validation Table. 5-8 Accounts Receivable Release 7.3 TRM Supplement TTVSRCE May 2006 Confidential 6 Chapter 6 System-Required Data Overview System-Required Data Banner is a comprehensive system with many parts that work together to manage your institution’s data and to interact with users. When any one of the components of the system is missing, some of the system’s functions may fail or may not work as intended. In some cases, data itself can be considered an essential component of the system. The complete contents of certain tables, and specific rows in other tables, must be present for the system to work correctly. This special data is called system-required data. System-required data is a subset of the seed data delivered with a new Banner installation. Banner software releases often include seed data scripts that deliver additional system-required data. Generally, Banner forms and processes will prevent you from deleting systemrequired data. But when you are using database tools or scripts to delete rows from the database—for example, during database cleanup to remove sample data before migrating into production—there is nothing to prevent system-required data from being accidentally deleted. In those situations, you should take care not to delete any system-required data. This chapter lists system-required data for Banner Accounts Receivable. For more information on system-required data, please see the Banner General Technical Reference Manual. Overview This chapter summarizes system-required data in the following charts: May 2006 Confidential • “Accounts Receivable Tables” on page 6-2 - This chart identifies tables for which seed data rows should not be deleted. • “System-Required Rows for Validation Tables” on page 6-3 - This chart identifies specific values in system-required rows for the listed tables. Accounts Receivable Release 7.3 TRM Supplement 6-1 6 System-Required Data Overview Accounts Receivable Tables This section identifies tables for which data must be created before the system can be used. In some tables the delivered seed data rows can be modified or deleted as necessary for the business model of the institution, while in others (flagged with an asterisk (*) below) the delivered seed data rows should not be deleted. You can add your own specific data and can also modify delivered data—but exercise caution when doing so. It is recommended that you save a data export of these tables before making any changes. 6-2 TBBCTRL Accounts Receivable Billing Control Table TBBDEPC Deposit Detail Definition Table TBBDETC Detail Charge/Payment Code Definition Table TBBEACT Detail Code Effective Date Table TBBETBD Term-Based Designator Effective Date Table TBBTBDS Term-Based Designator Rules Table TBRACCT Detail Code Account Definition Table TTVBILL* Bill Code Validation Table TTVDCAT* Detail Charge/Payment Category Code Validation Table TTVDTYP* Deposit Type Validation Table TTVPAYT* Detail Code Payment Type Validation Table TTVSRCE* Billing Detail Source Validation Table TURVERS Accounts Receivable Version Tracking Table TVVAUTH* Title IV Authorization Validation Table Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential 6 System-Required Data Overview System-Required Rows for Validation Tables This section identifies specific values in system-required rows for the validation tables in the following list. These tables may contain additional values. • Bill Code Validation Form (TTVBILL) • Detail Category Code Validation Form (TTVDCAT) • Deposit Type Code Validation Form (TTVDTYP) • Payment Type Code Validation Form (TTVPAYT) • Charge/Payment Source Code Validation Form (TTVSRCE) • Title IV Authorization Validation Table (TVVAUTH) TTVBILL Bill Code Validation Form NO TTVDCAT Detail Category Code Validation Form APF DEP FEE HOU MEA PHO TRN TUI TTVDTYP Admissions Application Charges Deposit Registration Fees Housing Charges Meal Plan Phone Plan Transcript Charges Registration Tuition Deposit Type Code Validation Form FEE HOU MEA PHO TUI May 2006 Confidential No Bill Will Be Generated Fee Deposit Housing Deposit Meal Deposit Phone Deposit Tuition Deposit Accounts Receivable Release 7.3 TRM Supplement 6-3 6 System-Required Data Overview TTVPAYT Payment Type Code Validation Form N TTVSRCE Miscellaneous Credits Charge/Payment Source Code Validation Form Except where noted, System Required is Y (selected) and Allowed on Transaction Entry is N (not selected). A B C D E F G H I L M N P R S T U V TVVAUTH Title IV Authorization Validation Table HLD PY TIV 6-4 Admissions Module Location Management Room Chg Contract Deposit Exemptions Financial Aid Recurring Receivables Assessments Academic History Module Installment Process Billing Late Charge Memo Non-Sufficient Fund Charge Application of Payment Process Registration Module Miscellaneous Transaction Charge/Payment Transaction (Allowed on Transaction Entry = Y) Location Management Phone Charge Location Management Meal Charge Hold excess TIV funds for future Pay Prior Year minor inst charges Pay non-inst charges with Title IV Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential A Frequently Asked Questions about Storing and Viewing Statement Files Do I have to create Adobe Portable Document Format (PDF) files to use the e-Bill enhancement? Appendix A Frequently Asked Questions about Storing and Viewing Statement Files This section includes guidance on questions that may be encountered as you implement e-Bill functionality to store and view statement files. Do I have to create Adobe Portable Document Format (PDF) files to use the e-Bill enhancement? No, it is not a requirement that the PDF format be used, only that the output from TSRCBIL be divided into multiple files: one per statement. The plain text output from the billing process may be parsed, stored, and viewed. However, the conversion to PDF allows for a much better presentation of the statement through the addition of graphical elements including column separators and the branding of this important communication with your logo. Since third-party tools exist to perform this conversion, SunGard Higher Education has not attempted to recreate this functionality. How can I parse the TSRCBIL output into multiple files? Each statement includes a unique number (although there may be more than one page for a statement), and it is recommended that this number be used to name the individual files as they are parsed. Here is an example of a Perl script that can be used to perform the parsing of the TSRCBIL output. Note that the correct value must be set for the $stmt_line variable depending on whether you are parsing STATEMENT or SCHEDSTMT output. If the page break appears as something other than CTRL-L in your output, the escape sequence needs to be changed in both places it occurs. Sample Perl Script #!/usr/bin/perl # # parse_cbil.pl - splits tsrcbil output into separate files, # basing the file names on the stmt_number in the output. # For STATEMENT mode, initialize $stmt_line = 3; to find the stmt_number # on the 3rd line of each page. # For SCHEDSTMT mode, initialize $stmt_line = 58; to find the stmt_number May 2006 Confidential Accounts Receivable Release 7.3 TRM Supplement A-1 A Frequently Asked Questions about Storing and Viewing Statement Files How can I Store Statements from the File System? # on line 58 of each page. If you have changed the BLANK_PAPER_ line # definitions in the TSRCBIL source code, adjust this value as needed. # Note that the script is searching for CTRL-L as a page break using \cL # in two places below. Change as necessary for the environment. # # Usage is: perl parse_cbil.pl <tsrcbil_nnnnnnn.lis # open (SLOG, ">>tempfile.lis")||die "Cannot open temp file out\n"; $stmt_line = 3; $i = 0 ; $k = 0 ; while (<STDIN>) { $i++; if ($i==$stmt_line) { @fields = split; $fname=$fields[0]; } if (/\cL/) # Start of a page { if ($k==1) # Continue writing multi-page statement { print SLOG $_; $i = 1 ; $k=0; } else # Close and rename file, start next file { close (SLOG); # rename it to the correct name rename ("tempfile.lis","${fname}.lis"); # open next open (SLOG, ">>tempfile.lis")||die "Cannot open temp file out\n"; $i = 1 ; $_ =~ s/\cL//; # Omit the page break print SLOG $_; # Print the line out } } elsif ((/ * CONTINUED /) && ($i > 8)) { $k=1; # Mark as multi-page statement print SLOG $_; } elsif (/REPORT CONTROL INFORMATION /) { $fname="control"; # This is the Control Report print SLOG $_; } else { print SLOG $_; # Print the line out } } close (SLOG); rename ("tempfile.lis","${fname}.lis"); How can I Store Statements from the File System? Once individual files for each statement have been created, use BANINST1 to create an Oracle directory that points to the folder where the files are located. Grant read access as necessary if a user other than BANINST1 will run the script: A-2 Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential A Frequently Asked Questions about Storing and Viewing Statement Files How can I Store Statements from the File System? create or replace directory AR_LOAD_DIR as '/server/banner/dataload/ar'; create public synonym AR_LOAD_DIR for AR_LOAD_DIR; grant read on directory AR_LOAD_DIR to <my-user>; PL/SQL Script The tb_statement API is used to store each file in the database. This example is for Plain Text files, assuming that the tsrcbil.lis output was parsed into files named <stmt_number>.lis. It uses the Job Submission number from the TSRCBIL run to identify all of the statement numbers produced, and updates the record with the file with that number: Be sure to use the correct large object type (p_blot_code) for the file being stored, as this determines how the browser will display the file when it is viewed. set echo off; set serveroutput on; ACCEPT bill_run_in PROMPT 'Enter Job Submission Number ' DECLARE lv_file_name stmt_refcur stmt_rec bill_run lv_count COMMIT_POINT CONSTANT VARCHAR2(30); tb_statement.statement_ref; tb_statement.statement_rec; tbbstmt.tbbstmt_bill_run%TYPE; NUMBER := 0; PLS_INTEGER := 10; BEGIN bill_run := &bill_run_in; stmt_refcur := tb_statement.f_query_all( p_bill_run => bill_run); LOOP FETCH stmt_refcur INTO stmt_rec; IF stmt_refcur%FOUND THEN IF stmt_rec.r_media_id IS NULL THEN lv_file_name := TO_CHAR(stmt_rec.r_stmt_number)||'.lis'; tb_statement.p_update( p_stmt_number => stmt_rec.r_stmt_number, p_user_id => 'APITEST', p_data_origin => 'STATEMENT_LOAD', p_blot_code => 'TXT', p_directory => 'AR_LOAD_DIR', p_filename => lv_file_name, p_loadfromfile => 'Y'); END IF; lv_count := lv_count + 1; IF lv_count > COMMIT_POINT THEN gb_common.p_commit; lv_count := 0; END IF; END IF; EXIT WHEN stmt_refcur%NOTFOUND; END LOOP; CLOSE stmt_refcur; gb_common.p_commit(); EXCEPTION WHEN OTHERS THEN gb_common.p_rollback(); dbms_output.put_line('Error processing statement:'|| stmt_rec.r_stmt_number); DBMS_OUTPUT.PUT_LINE(SQLERRM); END; / May 2006 Confidential Accounts Receivable Release 7.3 TRM Supplement A-3 A Frequently Asked Questions about Storing and Viewing Statement Files How might local modifications or Third Party tools be used in processing statements? Note: If you prefer to keep the files in the physical file system you could do so by changing the value of p_loadfromfile above to V (validate) or N (No validation) in order to store only a file location pointer in the database. Please refer to the General Release Guide and the technical documentation for additional information about the file storage parameters and options available for handling the statement files. How might local modifications or Third Party tools be used in processing statements? Handling statements for the e-Bill enhancement has three basic steps, two required and one optional. 1. Create individual statement files. (required) 2. Enhance and brand the output, convert to binary file type. (optional) 3. Store the file. (required) Local modifications or tools from other vendors might help with any or all of these steps. For step 1), if a local process has been written to do the billing, it might be modified to use the tb_statement API to generate a statement number. The output could be a single file including the statement number, or the process might be altered to create individual output files named with the statement number. For either baseline TSRCBIL or a local process creating one file, a third-party tool that can parse a plain text file could be used in place of the Perl script above to create the individual files. For step 2), any tool which can read a plain text file, enhance it with user-defined changes, and create a binary document file with which the resulting output can be used. A tool that can do steps 1) and 2) together simplifies the processing. For step 3), any tool that can communicate with the Banner database through a PL/Sql block can use the tb_statement API to store the file. The sample script above shows the basic form such a call would take as an update to an existing record in tbbstmt. For additional information, please refer to the following FAQs available in the Solutions section of the Customer Support Center: FAQ #1-IHS99 (Using AR e-Bill) and FAQ #1-IPPO9 (Using Evisions with AR e-Bill). A-4 Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential A Frequently Asked Questions about Storing and Viewing Statement Files Where does the statement number appear in the billing output? Where does the statement number appear in the billing output? • When you run TSRCBIL in STATEMENT mode, the statement number appears on the 3rd line, beginning in the first position. • When you run TSRCBIL in SCHEDSTMT mode, the statement number link appears on line 58 (unless the value of the BLANK_PAPER_BOTTOM_TOTALS_ START_LINE has been modified in the TSRCBIL source code). The column in which it begins is dependant on the width of the schedule bill; the width varies with the choices made for columns to display on TSASBRL, but will be aligned to the beginning of the Student Id literal in the next line of the payment stub. • When you run TSRCBIL in INVOICING or SCHEDINV mode, values from the statement number sequence are used during processing, but these values will be deleted from the TBBSTMT table. As a result, there will be gaps in the values that are in the tbbstmt_stmt_number column. Why do I see the same statement when I try to look at a different bill date? Your Internet Options can affect your ability to view statements. If you are having difficulty viewing the statement you selected, access the Internet Options for your browser and check the following. May 2006 Confidential 1. Ensure that your preferences for temporary file handling are set up to look for newer versions of stored pages. 2. Clean out the cache. Accounts Receivable Release 7.3 TRM Supplement A-5 A Frequently Asked Questions about Storing and Viewing Statement Files Why do I see the same statement when I try to look at a different bill date? This page intentionally left blank A-6 Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential Index Index A Automated Clearing House (ACH) diagram 1-4 list of tables 1-5 Accounting Feed Options 4-4 Accounting Feed Process (TGRFEED) 4-4, 4-5 Accounts Receivable Collector/Temporary Tables 1-7 Accounts Receivable Processing Database Schematic diagram 1-2 list of tables 1-5 ActionLine 9 APIs overview 5-1 APIs and supporting packages dml_tbbcprf 5-6 dml_tbbmisc 5-6 dml_tbbterm 5-6 dml_tbraccd 5-6 dml_tbrdepo 5-6 dml_tbrmemo 5-6 dml_tbrmisd 5-6 tb_cashier_session_rules 5-7 tb_cashier_session_str 5-7 tb_common 5-8 tb_common_str 5-8 tb_customer_profile 5-2 tb_customer_profile_rules 5-2 tb_customer_profile_str 5-2 tb_depo_control 5-7 tb_deposit 5-3 tb_deposit_control_rules 5-7 tb_deposit_control_str 5-7 tb_deposit_rules 5-3 tb_deposit_str 5-3 tb_detail_code 5-7 tb_detail_code_str 5-7 tb_memo 5-3 tb_memo_rules 5-3 tb_memo_str 5-3 tb_misc_detail 5-3 tb_misc_detail_rules 5-3 tb_misc_detail_str 5-3 tb_misc_header 5-4 tb_misc_header_rules 5-4 tb_misc_header_str 5-4 tb_receivable 5-4 tb_receivable_rules 5-4 tb_receivable_str 5-4 tb_statement 5-5 tb_statement_rules 5-5 tb_statement_str 5-5 tb_term_control_ar 5-6 tb_term_control_ar_rules 5-6 tb_term_control_ar_str 5-6 tb_ttvdcat 5-8 tb_ttvecat 5-8 tb_ttvsrce 5-8 Auto/Hold Release Setup ERD 1-9 May 2006 Confidential C Cashiering Report (TGRCSHR) 4-5 CMS 2-10 Collector File Entries 2-12 contacting SunGard Higher Education 8 Conversion 4-1 Conversion Tables 4-1 Detail Code Control Form 4-1 TBBDETC Detail Charge/Payment Code Definition Table 4-1 TBRACCD Account Detail Table 4-2 TBRACCT Detail Code Account Definition Table 4-1 Customer Support Center 9 D Data Element Dictionary (DED) Accounts Receivable DED 4-1 Banner DED 4-1 General DED 4-1 database schematics Accounts Receivable Processing 1-2 Automated Clearing House (ACH) 1-4 symbols 1-1 Detail Code Control Form 4-1 Detail Code Setup ERD 1-10 documentation related documentation General Technical Reference Manual 2-13 E e-Bill storing and viewing statement files A-1 Customer Support Center FAQs A-4 entity relationship diagrams see ERDs ERDs Auto/Hold Release Setup 1-9 Detail Code Setup 1-10 Exemption Setup 1-12 Third Party Contract Setup 1-11 Exemption Setup 1-12 Accounts Receivable Release 7.3 TRM Supplement I-1 Index F forms GJAPCTL Process Submission Control Form 2-11 GJASWPT Sleep/Wake Maintenance Form 2-11 GTVPRNT Printer Validation Form 2-10 SOADEST System Distribution Initialization Information Form 2-10 TOADEST System Distribution Initialization Information Form 2-10 Interfaces with Finance System 3-1 with General System 3-1 with Student System 3-1 within Banner 3-1 L List of Reports and Parameters (GJRRPTS) 2-9 O Oracle Reports, running 2-13 OS command scripts 2-9 T P pre-compiler directive 2-9 Preface How to Use This Manual 7 Related Documentation 7 Printer Validation Form (GTVPRNT) 2-10 Procedures Lockbox Processing 3-1 Process Submission Control Form (GJAPCTL) 2-11 reports and processes descriptions 2-1 GJRRPTS List of Reports and Processes 2-9 legend 2-7 I-2 S Setting 2-9 Sleep/Wake Maintenance Form (GJASWPT) 2-11 Sleep/Wake-up processes 2-9 changing the interval 2-11 collector tables 2-11 operating without sleep/wake-up commands 2-11 OS command scripts 2-9 reports and processes 2-10 setting up Method One 2-9 Method Two 2-10 stopping the process 2-11 viewing statistics 2-11 SQL*Plus scripts 2-9, 2-13 System Distribution Initialization Information Form (SOADEST) 2-10 System Distribution Initialization Information Form (TOADEST) 2-10 system-required data rows for validation tables 6-3 tables 6-2 I R list of 2-1 matrix 2-7 running Oracle Reports 2-13 Sleep/Wake-up 2-9 TGRCSHR Cashiering Report 4-5 TGRFEED Accounting Feed Process 4-4, 4-5 Third Party Contract Setup ERD 1-11 Title IV Setup 4-5 TBBDETC Detail Code Table 4-5 TBRACCD Accounts Receivable Detail Table 4-5 U UNIX 2-9, 2-10 using this manual 7 V VMS 2-10 Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential Index W Wait command 2-10 May 2006 Confidential Accounts Receivable Release 7.3 TRM Supplement I-3 Index SunGard Higher Education 4 Country View Road Malvern, PA 19355 1-800-223-7036 www.sungardhe.com I-4 Accounts Receivable Release 7.3 TRM Supplement May 2006 Confidential