Banner Accounts Receivablebanner7.utm.edu/manuals/banner_release_guides/arsys80405rg.pdf · Banner...

Banner Accounts ReceivableRelease Guide

Release 8.4.5August 2013

Banner®, Colleague®, Luminis® and Datatel® are trademarks of Ellucian or its affiliates and are registered in the U.S. and other countries. Ellucian™, PowerCampus™, Advance™, Degree Works™, fsaATLAS™, Course Signals™, SmartCall™, Recruiter™, and ILP™ are trademarks of Ellucian Company L.P. or its affiliates. Other names may be trademarks of their respective owners.

© 2013 Ellucian Company L.P. and its affiliates. The unauthorized possession, use, reproduction, distribution, display or disclosure of this material or the information contained herein is prohibited.

Contains confidential and proprietary information of Ellucian and its subsidiaries. Use of these materials is limited to Ellucian licensees, and is subject to the terms and conditions of one or more written license agreements between Ellucian and the licensee in question.

In preparing and providing this publication, Ellucian is not rendering legal, accounting, or other similar professional services. Ellucian makes no claims that an institution's use of this publication or the software for which it is provided will guarantee 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.

Prepared by: Ellucian4375 Fair Lakes CourtFairfax, Virginia 22033United States of America

Revision History

Publication Date Summary

August 2013 New version that supports Banner AR 8.4.5 software.

Re

Contents

Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Deposit and Fee Payment Configuration - Functional . . . . . . . . . . . . . . . . . . . . . . 5

Deposit and Fee Payment Configuration - Technical . . . . . . . . . . . . . . . . . . . . . . . 5

System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Deposit and Fee Payment Configuration - Functional . . . . . . . . . . . . . . 6

Summary of Accounts Receivable 8.4.5 Changes . . . . . . . . . . . . . . . . . . . . . . . . . 7

Payment Code Validation Form (TTVPTYP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Deposit Crosswalk Form (TGADEPX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Web Payment Rules Form (TSAWPAY) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Summary of Student Self Service Patch 8.5.4.4 Changes . . . . . . . . . . . . . . . . . . . 8

Deposit/Fee Payment Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Account Information Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Application Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Accounts Receivable 8.4.5 Detailed Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Setup for Deposit and Fee Payment Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

New Forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Payment Code Validation Form (TTVPTYP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Deposit Crosswalk Form (TGADEPX). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Web Payment Rules Form (TSAWPAY) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Key Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Display Rules Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Web Payment Rules Block. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Web Payment Matching Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Transaction Rules Block. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Copy Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Changed Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

AR Validation Menu [*TARVALD]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20AR General Controls [*TGENERALA] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Student AR Control [*TSTUDENTB] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

3lease Guide | Contents

Re

Student Self Service Patch 8.5.4.4 Detailed Changes . . . . . . . . . . . . . . . . . . . . . . . 21

New Web Pages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Deposit/Fee Payment Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Account Information Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Modified Web Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Application Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Deposit and Fee Payment Configuration - Technical . . . . . . . . . . . . . . . 26

Accounts Receivable 8.4.5 Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

New Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Deposit Code Crosswalk (TBBDEPX). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Multi-Part Payment Validation Table (TTVPTYP) . . . . . . . . . . . . . . . . . . . . . . . . . . 27Web Payment Processing Header Record (TBBWPYH). . . . . . . . . . . . . . . . . . . . . 28Web Payment Processing Matching Rules (TBRWPYM) . . . . . . . . . . . . . . . . . . . . 29Web Payment Processing Detail Rules (TBRWPYD) . . . . . . . . . . . . . . . . . . . . . . . 30Multi-Part Transaction Paid (TBRPYTR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

New Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

New APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Deposit Code Crosswalk API (tb_dep_xwalk) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Deposit Type Validation API (tb_ttvdtyp) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Multi-Part Payment Validation API (tb_ttvptyp) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Web Payment Processing Header API (tb_webpay_header) . . . . . . . . . . . . . . . . . 37Web Payment Processing Matching Rules API (tb_webpay_match) . . . . . . . . . . . 37Web Payment Processing Detail Rules API (tb_webpay_detail). . . . . . . . . . . . . . . 38Multi-Part Transaction API (tb_pay_trans) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Student Self Service Patch 8.5.4.4 Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

New Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Deposit/Fee Payment Processing (BWSKPAYG) . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Changed Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Application Menu (BWSKALOG). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Account Information Page (BWSKOACC). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Seed Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

4lease Guide | Contents

5Release Guide | Introduction

Introduction

This Release Guide documents Release 8.4.5 of the Banner Accounts Receivable (AR) system. Release 8.4.5 includes a Community Source Initiative (which also addresses Change Request/Enhancement 1-TA1FRF).

The functionality delivered in AR 8.4.5 works in conjunction with changes to Student Self Service. The Student Self Service changes are delivered in the 8.5.4.4 patch of Banner Student Self-Service and are also discussed in this document.

Deposit and Fee Payment Configuration - Functional

This section discusses functional changes related to the Deposit and Fee Payment Configuration enhancement. Changes to AR release 8.4.5 and Student Self Service patch 8.5.4.4 are discussed.

Deposit and Fee Payment Configuration - Technical

This section discusses technical changes related to the Deposit and Fee Payment Configuration enhancement. Changes to AR release 8.4.5 and Student Self Service patch 8.5.4.4 are discussed.

System Requirements

Before you install and use Banner Accounts Receivable release 8.4.5, you must install the Banner General release 8.5.0.2 and Banner Accounts Receivable releases 8.4, 8.4.1, 8.4.2, 8.4.3, and 8.4.4.

Note: The Student Self-Service patch 8.5.4.4 is required in order to use the functionality delivered in AR 8.4.5. The AR 8.4.5 release must be installed before the Student Self-Service patch can be installed.

General 8.5.0.2 and Student Self-Service patch 8.5.4.2 must be installed before the Student Self-Service patch 8.5.4.4 can be installed. Refer to Student Self-Service Interdependency grid for other Student Self-Service 8.5.4 dependencies.

Re

Deposit and Fee Payment Configuration - Functional

The AR 8.4.5 release and Student Self Service patch 8.5.4.4 allows an applicant or student to submit payment for deposits and other fees via banner self service. Banner uses this authorization to create deposits, and to charge and pay a fee based on institution-configured setup and rules.

If a rule involves just one transaction, banner authorizes and processes one Deposit or paid Fee; if a rule involves multiple transactions, then banner authorizes the total and processes the Deposit/Fee group.

The Deposit (TBRDEPO) and Receivable (TBRACCD) tables are updated as applicable; deposits are created in TBRDEPO and Fees/Payments are created in TBRACCD and linked by Transaction Number Paid.

A new self service page, the Account Information page, has also been added to display account transactions and outstanding deposits.

6lease Guide | Deposit and Fee Payment Configuration - Functional

Re

Summary of Accounts Receivable 8.4.5 Changes

Three forms are new for this release.

Payment Code Validation Form (TTVPTYP)

This validation form is used to maintain the valid codes for payment or transaction types. These codes are used on the Web Payment Rules Form (TSAWPAY). Some examples of a Payment Type are a Freshman Commuter and Freshman Resident. Some examples of a Transaction Type are a Housing Deposit and Orientation Fee.

This form has been added to the AR Validation menu [*TARVALD].

Deposit Crosswalk Form (TGADEPX)

This form is used to establish the crosswalk between the payment detail code used in credit card processing, as defined on the Credit Card Merchant ID Form (GOAMERC), and the deposit and payment detail codes used to create a deposit.

This form has been added to the AR General Controls menu [*TGENERALA].

Web Payment Rules Form (TSAWPAY)

This form allows users to create the Web Payment Processing, Matching and Transaction Rules.

This form has been added to the Student AR Control menu [*TSTUDENTB].


Re

Summary of Student Self Service Patch 8.5.4.4 Changes

Two web pages are new and one web page is changed for this release.

Deposit/Fee Payment Processing

A new Payment Processing section displays links to the new Payment Processing Transaction and Summary pages. These links and pages provide the baseline processing of Web Payment Rules for both students and applicants.

Account Information Page

A new Account Information page displays account transactions and deposits in Self Service.

Application Menu

This menu was modified to enable the Deposit/Fee Payment Processing section on the Application Choices Menu of self-service banner.


Re

Accounts Receivable 8.4.5 Detailed Changes

Setup for Deposit and Fee Payment Configuration

The following setup is required for this release.

1. Valid entries must exist in GTVCCRD for the payment types in use and the External ID as used by the payment vendor.

2. The release inserts a value in GTVSDAX for the Internal Group WEBPAYGCCID and Internal Code DEFAULT with External code <UPDATE_ME>.This should be set to the Merchant ID expected by the Payment Vendor and used as “Third Party Transaction” in GOAMERC.

3. There is also a record created in GTVSDAX for the Internal Group ADDRESS and Internal Code WPAYADDR as a placeholder for an address hierarchy. If populated, address information is captured into the GORCCAU record, and may be passed on to the payment vendor if that functionality is enabled in the referral to the vendor.

4. The release inserts a record WEBCCARGATEWAY in GTVPROC. Entries are needed in GOAMERC for this Process code with definitions for all the Credit Card types from step 1) above, with Third Party Transaction code set to the value from step 2) above.

5. Note that this Third Party Transaction code is also passed to gokpven.f_collect_payment_info to go to the payment vendor when the redirect is made. Appropriate coordination with the individual payment vendors is an individual client responsibility.

6. In order for non-student Applicants to see information via the SSB Admissions Login, the Term must be activated in Admissions Web Calendar Rules (SAAWAAD) based on View Application being checked and a date range. (This is not required if Applicants have been assigned pidms and log in through the secure Student login).

7. Appropriate values are needed in Web Tailor –

• Enable bwskpayg.P_DispList on an appropriate Menu (as delivered, it is on the Student Financial Menu). Release scripts enable the individual pages for the STUDENT role; additional roles may be added as desired.

• Customize Web Tailor Parameters for PAYVEND_URL and PAYVEND TRANS_TIMEOUT if that has not previously been done.

8. Create codes for payment or transaction types on the new Payment Code Validation Form (TTVPTYP) with pay_tran_ind = P for the payment types, and pay_tran_ind = T for the transaction types.

9. Create deposit cross-walk values on the new Deposit Crosswalk Form (TGADEPX).

10. Set up deposit/fee payment processing matching and transaction rules on the new Web Payment Rules Form (TSAWPAY). Copy functionality is available from the Web Payment Rules block. You may want to use the copy feature where similar match or transaction rules exist for student vs. applicant.


Re

New Forms

The forms in this section are new with this release.

Payment Code Validation Form (TTVPTYP)

This validation form is used to maintain the valid codes for payment or transaction types. These codes are used on the Web Payment Rules Form (TSAWPAY). Some examples of a Payment Type are a Freshman Commuter and Freshman Resident. Some examples of a Transaction Type are a Housing Deposit and Orientation Fee.

Fields Descriptions

Code The Code field is used to define the payment code, which is used to differentiate various payment and transaction types.

Description The Description field describes the payment or transaction type code. Provides default values for Link Text and Transaction description when creating rules.

Type The Type field indicates whether the code is a Payment type code or a Transaction type code.

Activity Date The Activity Date field is the date that the record was last modified. The value is automatically populated upon save. Display only.

User ID The User ID field is the ID of the person who has updated the record. Display only.


Re

Figure 1: Payment Code Validation Form (TTVPTYP)


Re

Deposit Crosswalk Form (TGADEPX)

This form is used to establish the crosswalk between the payment detail code used in credit card processing, as defined on the Credit Card Merchant ID Form (GOAMERC), and the deposit and payment detail codes used to create a deposit.

Figure 2: Deposit Crosswalk Form (TGADEPX)

Fields Descriptions

Base Code The Base Code field is the detail code used for credit card processing, as defined on the Credit Card Merchant ID Form (GOAMERC).

Deposit Type The Deposit Type field is the type of deposit as defined on the Deposit Type Code Validation Form (TTVDTYP).

Deposit Code The Deposit Code field is the detail code code used as the deposit code to create a deposit.

Payment Code The Payment Code field is the detail code used as the payment code to create a deposit.

Activity Date The Activity Date field is the date that the record was last modified. The value is automatically populated upon save. Display only.

User ID The User ID field is the ID of the person who has updated the record. Display only.


Re

Web Payment Rules Form (TSAWPAY)

This form allows users to create the Web Payment Processing, Matching and Transaction Rules.

For a given term and payment type, links to pay various deposit/fee groups are displayed in Banner Self Service to applicants/students matching the rule criteria. The information entered on this form determines primarily:

• Whether the rule is applicable to applicants, students or both.

• The applicant/student matching criteria used to determine whether the deposit/fee group is displayed to the individual logged into Self-Service (for example, by admission decision code, campus, level, and many more).

• The specific deposit/fee transactions collected from the applicant/student (for example, housing deposit, orientation fee, etc).

This form has two tabs, the Display Rules tab and the Transaction Rules tab.

Key Block

The key block is used to establish the term code and payment type combination for the rule. For example, you may build a rule for the fall term 2013 applicable to freshman residents.

Display Rules Tab

The Display Rules tab is used to enter information for web payment rules and matching. The Display Rules tab consists of two blocks, the Web Payment Rules block and the Web Payment Matching block.

Web Payment Rules Block

This block is used to enter general display information associated with the rule.

Fields Descriptions

Term The Term field is the term for Deposit/Fee Rules group.

Payment Type The Payment Type is the payment type for the group, valid in TTVPTYP with Type = P.

Fields Descriptions

Active The Active field is a check box supporting Y/N values to indicate if the Deposit/Fee Group is active for display in Self Service.


Re

Web Payment Matching Block

This block is used to enter applicant/student matching criteria applicable for this rule. The Type data used for matching is as follows:

• Admission Decision (Admission only)

• Attribute

• Campus

• Class (Student classification only)

• Cohort

• Degree Objective

• Level

Applicants The Applicants field is a check box supporting Y/N values to indicate if the Deposit/Fee Group is intended to display for Applicants on Admissions Menu in Self Service, matching to the Application record by EntryTerm.

Students The Students field is a check box supporting Y/N values to indicate if the Deposit/Fee Group is intended to display for Students in Self Service, matching to the Learner record by Effective Term.

Start Date(optional)

The Start Date field is the first day the Link to this group displays in Self Service.

End Date(optional)

The End Date field is the last day the Link to this group displays in Self Service.

Sequence The Sequence number is used to order the links within Term when displayed in Self Service.

Link Text The Link Text is the text used in a Hyperlink in Self Service to invoke processing of this Deposit/Fee group.

Link Description(optional)

The Link Description is additional text to display below the Hyperlink in Self Service menus. Note this can include HTML formatting including embedded links.

Activity Date The Activity Date field is the date that the record was last modified. The value is automatically populated upon save.

User ID The User ID field is the ID of the person who has updated the record. It is a display item. Cannot be updated.

Fields Descriptions


Re

• Major

• Program

• Rate Code

• Residency

• Student Type

• Visa

Applicant admissions matching data is displayed on the Admissions Application form (SAAADMS). General Student matching data is displayed on the General Student form (SGASTDN); and student cohort and attribute matching data is displayed on the Additional Student Information form (SGASADD). Visa matching data is displayed on the International Information form (GOAINTL).

Note: When matching against admissions applicants, only the first major of primary or secondary curriculum are matched. All the curriculum types, when defined, are matched as a group. Curriculum types are program, major, degree, campus and level (with admission decision for applicant).

Fields Descriptions

Type The Type field is the type of data to be matched to the accompanying value. Supported types and their descriptions are pre-defined, and are maintained in the TB_WEBPAY_MATCH API

Value The Value field is the data value to be matched (not validated – values and case must match data as used by the Institution).


Re

Figure 3: Web Payment Rules Form (TSAWPAY) - Display Rules Tab

Transaction Rules Block

The Transaction Rules tab is used to enter the group of deposit/fee payments that will display in Banner Self-Service to applicants/students matching criteria entered on the Display Rules tab. Examples of deposit/fee transactions displayed to the applicant/student are tuition deposits and parking permits.This block has two tabs, the Procedure tab and the Deposit tab.

Fields Descriptions

Tran Type The Tran Type field is the transaction type, valid in TTVPTYP with type = T

Description The Description field is the Description to display in Self Service (defaults from Type).

Sequence The Sequence number is used to determine the order in which transactions are displayed, and also used to provide Info Text before and after the default description in Self Service. Note that values must be distinct, but do not need to be contiguous.


Re

Amount The Amount field is the amount for the Deposit or Fee (per unit amount for Multiple transactions). Amount cannot exceed 99999.99 when Process field value is Deposit. Amount cannot exceed 9999999999.99 when Process field value is Accounts Receivable.

Required The Required field is a check box supporting values Y/N to indicate if a deposit/fee must be paid, or is optional. For Single (flat amount) transactions a check box is shown to accept or bypass the transaction, For Multiple (per Unit) transactions, 0 is allowed if not required.

Multiple The Multiple field is a check box supporting values S/M to indicate Single (flat amount per transaction) or Multiple (amount times number of occurrences for transaction).

Release Deposit The Release Deposit field is a check box supporting Y/N values used to populate Auto Release Indicator when creating new Deposits.

Process The Process field indicates if transaction creates a new Deposit (value DEPO) or creates a Fee/Payment pair in receivables (value ACCD). Valid values are Deposit, for deposit transactions and Accounts Receivable for Fee/Payment transactions.

Procedure The Procedure field is the database procedure used to display a page to the Student/Applicant when processing this transaction, valid in Web Tailor Menu rules (TWGBWMNU). Defaults to the baseline processing page, but may be changed to use a locally created version with additional functionality.

Code The Code field for deposits is a valid Deposit Type in TTVDTYP; for Fees, a valid Charge Detail Code in TSADETC.

Release Date(optional)

The Release Date field populates the Release Date when creating new Deposits.

Expiration Date(optional)

The Expiration Date field Populates the Expiration Date when creating new Deposits.

Minimum Deposit(optional)

The Minimum Deposit field populates the Minimum when creating new Deposits. Minimum Deposit cannot exceed 99999.99.

Fields Descriptions


Re

Figure 4: Web Payment Rules Form (TSAWPAY) - Transaction Rules Tab

Copy Functionality

Copy functionality is available from the Web Payment Rules block. You may want to use the copy feature where similar match or transaction rules exist, for example, from one term to another term, for a student vs. applicant rule, etc.

Fields Descriptions

Copy From Term Term to copy rules from.

Copy Payment Type Payment Type to copy. If blank, all Payment Types are copied for a term

Copy To Term Term to which the rules will be copied

Copy To Type Payment Type to copy to. If blank same payment type is copied to another term

Active If selected rules will be created as active

Copy Matching Rules If selected Matching Rules will be copied

Copy Transactions If selected Transaction Rules will be copied

Start Date The Start Date field is the first day the Link to this group displays in Self Service.

End Date The End Date field is the last day the Link to this group displays in Self Service.


Re

The copy functionality is subject to the following requirements in order for rules to be copied.

• Both the Copy From Term and the Copy To Term should be entered.

• If Copy From Term = Copy To Term, then Copy Payment Type and Copy To Type should be entered.

• If Copy Payment Type is blank, then the Copy To Term should be different and Copy To Type should be blank. All rules of From Term are copied into To Term where the header does not already exist.

• If Copy Payment Type is populated, then for a different To Term the Copy To Type will default from the source but can be changed.

• Values for Active Indicator, Start Date and End Date are set by the values in the Copy window.

• Values for Applicant and Student checkboxes, Sequence and Link Description are brought forward from the source record. Value for Link Text is reset the same way they initially default:

<payment type description> for <term description>

• If Copy Matching Rules is selected, then the records in the Web Payment Matching block are copied to the new term/payment type for any new header record created.

• If Copy Transactions is selected, then the records in the Transaction Rules block are copied to the new term/payment type for any new header record created.

Figure 5: Copy Web Payment Rules Window (TSAWPAY)


Re

Changed Menus

The following menus have been changed for this enhancement.

AR Validation Menu [*TARVALD]

The new Payment Code Validation Form (TTVPTYP) has been added to this menu.

AR General Controls [*TGENERALA]

The new Deposit Crosswalk Form (TGADEPX) has been added to this menu.

Student AR Control [*TSTUDENTB]

The new Web Payment Rules Form (TSAWPAY) has been added to this menu.


Re

Student Self Service Patch 8.5.4.4 Detailed Changes

New Web Pages

The pages in this section are new with this release.

Deposit/Fee Payment Processing

A new Payment Processing section displays links to the new Payment Processing Transaction and Summary pages. These links and pages provide the baseline processing of Web Payment Rules for both students and applicants.

Available deposit/fee transactions are displayed in the new Payment Processing section on the Application Menu (students and applicants) and on the Payment and Deposit Processing page of the Student Account Menu (students only). Selecting the link displays the Payment Processing Transaction pages. After navigating through all the payment transactions, the user is presented with the Payment Processing Summary page to review prior to making a payment.

Figure 6: Application Menu Link

Figure 7: Payment and Deposit Processing Link on the Student Account Menu


Re

Figure 8: Payment Processing Transaction Pages - Required Deposit Transaction

Figure 9: Payment Processing Transaction Pages - Optional, Single Fee Transaction


Re

Figure 10: Payment Processing Transaction Pages - Optional, Multiple Fee Transaction

Figure 11: Payment Processing Summary Page - The “Proceed to Payment Page” Buttondisplays the Banner Payment Gateway


Re

Account Information Page

A new Account Information page displays in Self Service. The Account Information page has two tabs, Account Transactions and Deposits. The Account Transactions tab displays a list of charges and credits posted to a student account. The Deposit tab displays deposits posted to the student account. Only deposits with an outstanding balance are displayed.

Figure 12: Account Information Page - Account Transactions Tab

Figure 13: Account Information Page - Deposits Tab


Re

Modified Web Page

The page in this section has been modified with this release.

Application Menu

This menu was modified to enable the new Payment Processing section on the Application Menu of self-service banner. The Payment Processing section displays the links to the new pages that provide the baseline processing of Web Payment Rules for both students and applicants.

Figure 14: Payment Processing Section on the Application Menu (BWSKALOG)


Re

Deposit and Fee Payment Configuration - Technical

This section describes the technical changes that support the 8.4.5 release of Accounts Receivable and the 8.5.4.4 patch of Student Self Service.

Accounts Receivable 8.4.5 Changes

New Tables

The tables in this section are new for this release:

Deposit Code Crosswalk (TBBDEPX)

This table allows you to define base rules table used to create the crosswalk between payment, deposit and credit card codes.

ColumnNULL? Type Comment

TBBDEPX_DTYP_CODE No VARCHAR2(3) Identifies the deposit type code, valid in TTVDTYP.

TBBDEPX_BASE_CODE No VARCHAR2(4) Identifies the a payment code used in credit card processing, as defined in gormerc.

TBBDEPX_DEPOSIT_CODE No VARCHAR2(4) Identifies the detail code (TBBDETC) used as the deposit code to create a deposit.

TBBDEPX_PAYMENT_CODE No VARCHAR2(4) Identifies the detail code (TBBDETC) used as the payment code to create a deposit.

TBBDEPX_USER_ID No VARCHAR2(30) Identifies the user who last updated record.

26lease Guide | Deposit and Fee Payment Configuration - Technical

Re

Multi-Part Payment Validation Table (TTVPTYP)

This table allows you to define payment and transaction codes for Multi-Part Payments.

TBBDEPX_ACTIVITY_DATE

No Date Identifies the date that record was last updated.

TBBDEPX_SURROGATE_ID Yes NUMBER(19) Unique identifier for each row in the table.

TBBDEPX_VERSION Yes NUMBER(19) Integer that is incremented every time a row is updated.

TBBDEPX_VPDI_CODE Yes VARCHAR2(6) Code of entity to which the data belongs.

TBBDEPX_DATA_ORIGIN Yes VARCHAR2(30) System from where data came, if not from banner.

Primary Key: (PK_TBBDEPX):TBBDEPX_DTYP_CODE, TBBDEPX_BASE_CODE

Foreign key:1. TBBDEPX_PAYMENT_CODE on TBBDETC_DETAIL_CODE2. TBBDEPX_DTYP_CODE on TTVDTYP_CODE3. TBBDEPX_DEPOSIT_CODE on TBBDETC_DETAIL_CODE


TTVPTYP_CODE No VARCHAR2(3) Payment code, used to differentiate various payment and transaction types.

TTVPTYP_DESC No VARCHAR2(30) Description of the payment or transaction type.

TTVPTYP_PAY_TRAN_IND No VARCHAR2(1) Value P for payment types, value T for transaction types.

TTVPTYP_USER_ID No VARCHAR2(30) User who last updated record.

TTVPTYP_ACTIVITY_DATE

No DATE Date that record was last updated.

TTVPTYP_SURROGATE_ID Yes NUMBER(19) Unique identifier for each row in the table.

TTVPTYP_VERSION Yes NUMBER(19) Integer that is incremented every time a row is updated.



Re

Web Payment Processing Header Record (TBBWPYH)

This table allows you to define Web Payment Processing Header records.

TTVPTYP_VPDI_CODE Yes VARCHAR2(6) Code of entity to which the data belongs.

TTVPTYP_DATA_ORIGIN Yes VARCHAR2(30) System from where data came, if not banner.

Primary Key: (PK_TTVPTYP): TTVPTYP_CODE


TBBWPYH_TERM_CODE No VARCHAR2(6) TERM: A term associated with the rule

TBBWPYH_PTYP_PMNT_CODE

No VARCHAR2(3) PAYMENT TYPE CODE: A payment code valid in the TTVPTYP validation table

TBBWPYH_SEQNO No NUMBER(2) SEQUENCE NUMBER: Determines the relative order in which deposit rule will display on Banner Self Service.

TBBWPYH_ACTIVE_IND No VARCHAR2(1) ACTIVE INDICATOR (Y/N): Indicates whether the rule is active. Y is active and N is inactive with N as default with record creation.

TBBWPYH_ADM_IND No VARCHAR2(1) ADMISSIONS INDICATOR (Y/N): Indicates whether the rule is associated with admissions. Y is active and N is inactive with N as default with record creation.

TBBWPYH_ENR_IND No VARCHAR2(1) ENROLLMENT INDICATOR (Y/N): Indicates whether the rule is associated with enrollment. Y is active and N is inactive with N as default with record creation.

TBBWPYH_URL_TEXT No VARCHAR2(120) RULE URL TEXT: The URL Text for Banner Self Service.



Re

Web Payment Processing Matching Rules (TBRWPYM)

This table allows you to define Web Payment Processing Matching Rules.

TBBWPYH_URL_DESC Yes VARCHAR2(2000)

RULE URL DESCRIPTION: The description of the deposit rule used for Banner Self Service.

TBBWPYH_START_DATE Yes DATE START DATE: Date the rule is valid From

TBBWPYH_END_DATE Yes DATE END DATE: Date the rule is valid to

TBBWPYH_USER_ID No VARCHAR2(30) USER ID: The user ID of the person who inserted or last updated this record.

TBBWPYH_ACTIVITY_DATE

No DATE ACTIVITY DATE: The date that information in this record was entered or last updated.

TBBWPYH_SURROGATE_ID Yes NUMBER(19) SURROGATE ID: Unique identifier for each row in the table.

TBBWPYH_VERSION Yes NUMBER(19) VERSION: Integer that is incremented every time a row is updated.

TBBWPYH_VPDI_CODE Yes VARCHAR2(6) VPDI CODE: Code of entity to which the data belongs.

TBBWPYH_DATA_ORIGIN Yes VARCHAR2(30) DATA ORIGIN: Source system that created or updated the row.

Primary Key: TBBWPYH_TERM_CODE, TBBWPYH_PTYP_PMNT_CODE

Foreign Key:1. TBBWPYH_TERM_CODE on STVTERM_CODE2. TBBWPYH_PTYP_PMNT_CODE on TTVPTYP_CODE


TBRWPYM_TERM_CODE No VARCHAR2(6) Term code for which web payment matching rules are defined.



Re

Web Payment Processing Detail Rules (TBRWPYD)

This table allows you to define Web Payment Processing Detail Rules.

TBRWPYM_PTYP_PMNT_CODE

No VARCHAR2(3) Payment type, valid in TTVPTYP.

TBRWPYM_TYPE No VARCHAR2(4) Type for matching, which will determine associated data query to be used.

TBRWPYM_VALUE No VARCHAR2(30) Data value to be matched as determined by Type, to qualify student access to the Payment Rule.

TBRWPYM_USER_ID No VARCHAR2(30) User who last updated record.

TBRWPYM_ACTIVITY_DATE


TBRWPYM_SURROGATE_ID Yes NUMBER(19) Unique identifier for each row in the table.

TBRWPYM_VERSION Yes NUMBER(19) Integer that is incremented every time a row is updated.

TBRWPYM_VPDI_CODE Yes VARCHAR2(6) Code of entity to which the data belongs.

TBRWPYM_DATA_ORIGIN Yes VARCHAR2(30) System where data came from, if not Banner.

Primary Key: TBRWPYM_TERM_CODE, TBRWPYM_PTYP_PMNT_CODE, TBRWPYM_TYPE, TBRWPYM_VALUE

Foreign Key:1. TBRWPYM_TERM_CODE, TBRWPYM_PTYP_PMNT_CODE on TBBWPYH_TERM_CODE, TBBWPYH_PTYP_PMNT_CODE


TBRWPYD_TERM_CODE No VARCHAR2(6) Term code for which web payment processing rules are defined.



Re

TBRWPYD_PTYP_PMNT_CODE

No VARCHAR2(3) Payment type, valid in TTVPTYP with pay-tran indicator P.

TBRWPYD_PTYP_TRAN_CODE

No VARCHAR2(3) Transaction type, valid in TTVPTYP with pay-tran indicator T.

TBRWPYD_SEQNO No NUMBER(2) Sequence number for sorting, which may be tied to web tailor infotext display.

TBRWPYD_DESC No VARCHAR2(30) Description of the transaction, for display to the student.

TBRWPYD_REQ_IND No VARCHAR2(1) Indicator whether this element of the deposit is required (Y/N).

TBRWPYD_MULT_IND No VARCHAR2(1) Indicator whether the amount is assessed once (S), or multiplied by number of occurrences (M).

TBRWPYD_AMOUNT No NUMBER(12,2) Amount for this transaction type.

TBRWPYD_PROCESS No VARCHAR2(4) ACCD - process to receivable (TBRACCD) table; DEPO - process to deposit (TBRDEPO) table.

TBRWPYD_CODE No VARCHAR2(4) The detail code (TBBDETC) for process ACCD transactions, or deposit type (TTVDTYP) for process DEPO transactions.

TBRWPYD_PROCEDURE No VARCHAR2(100) Database procedure to be called to display web interface for this transaction.

TBRWPYD_DEP_RELEASE_IND

No VARCHAR2(1) Value for release indicator when processing a deposit transaction.

TBRWPYD_DEP_REL_DATE Yes DATE Value for release date when processing a deposit transaction.

TBRWPYD_DEP_EXP_DATE Yes DATE Value for expiration date when processing a deposit transaction.



Re

Multi-Part Transaction Paid (TBRPYTR)

This Accounts Receivable table holds detail of multi-part payment pending processing.

TBRWPYD_DEP_MIN_AMOUNT

Yes NUMBER(7,2) Value for minimum amount when processing a deposit transaction.

TBRWPYD_USER_ID No VARCHAR2(30) User who last updated record.

TBRWPYD_ACTIVITY_DATE


TBRWPYD_SURROGATE_ID Yes NUMBER(19) Unique identifier for each row in the table.

TBRWPYD_VERSION Yes NUMBER(19) Integer that is incremented every time a row is updated.

TBRWPYD_VPDI_CODE Yes VARCHAR2(6) Code of entity to which the data belongs.

TBRWPYD_DATA_ORIGIN Yes VARCHAR2(30) System from where data came, if not banner.

Primary Key: (PK_TBRWPYD): TBRWPYD_TERM_CODE, TBRWPYD_PTYP_PMNT_CODE, TBRWPYD_PTYP_TRAN_CODE

Foreign Key:1. TBRWPYD_TERM_CODE, TBRWPYD_PTYP_PMNT_CODE on TBBWPYH_TERM_CODE, TBBWPYH_PTYP_PMNT_CODE2. TBRWPYD_PTYP_TRAN_CODE on TTVPTYP_CODE


TBRPYTR_PAY_TRANS_ID No Number Unique payment transaction ID for the credit card payment, valid in gorccau.

TBRPYTR_PTYP_CODE No VARCHAR2(3) Transaction type reflecting tuition or housing deposit, orientation fee or guest, valid in TTVPTYP.

TBRPYTR_PROCESS No VARCHAR2(4) ACCD - process to receivable (TBRACCD) table;DEPO - process to deposit (TBRDEPO) table.



Re

TBRPYTR_CODE No VARCHAR2(4) The detail code (TBBDETC) for process ACCD transactions, or deposit type (TTVDTYP) for process DEPO transactions.

TBRPYTR_AMOUNT No NUMBER(12,2) Amount for this transaction.

TBRPYTR_DEP_RELEASE_IND

No VARCHAR2(1) Value for release indicator when processing a deposit transaction.

TBRPYTR_DEP_REL_DATE Yes Date Value for release date when processing a deposit transaction.

TBRPYTR_DEP_EXP_DATE Yes Date Value for expiration date when processing a deposit transaction.

TBRPYTR_DEP_MIN_AMOUNT

Yes NUMBER(7,2) Value for minimum amount when processing a deposit transaction.

TBRPYTR_SORT_SEQNO Yes NUMBER(2) A sequence number used to order a set of transactions for display.

TBRPYTR_USER_ID No VARCHAR2(30) User who last updated record.

TBRPYTR_ACTIVITY_DATE

No Date Date that record was last updated.

TBRPYTR_SURROGATE_ID Yes NUMBER(19) Unique identifier for each row in the table.

TBRPYTR_VERSION Yes NUMBER(19) Integer that is incremented every time a row is updated.

TBRPYTR_VPDI_CODE Yes VARCHAR2(6) Code of entity to which the data belongs.

TBRPYTR_DATA_ORIGIN Yes VARCHAR2(30) System from where data came, if not from banner.

Primary Key: (PK_TBRPYTR): TBRPYTR_PAY_TRANS_ID, TBRPYTR_PTYP_CODE

Foreign Key: TBRPYTR_PTYP_CODE on TTVPTYP_CODE



Re

New Scripts

The following scripts are delivered for this enhancement.

Script Result

Scripts for TBBDEPX

tbbdepx_080405_01.sql Create table TBBDEPX

tbbdepx_080405_02.sql Add primary key constraint to this table

tbbdepx_080405_03.sql Add foreign key constraint to this table



tbbdepx_080405_06.sql Table and column comments for Deposit Code Crosswalk

Scripts for TBRPYTR

tbrpytr_080405_01.sql Create table TBRPYTR

tbrpytr_080405_02.sql Add primary key constraint to this table

tbrpytr_080405_03.sql Add foreign key constraint to TTVPTYP

tbrpytr_080405_04.sql Table and column comments for Multi-Part Payment Transaction Detail

Scripts for TBBWPYH

tbbwpyh_080405_01.sql Create table TBBWPYH

tbbwpyh_080405_02.sql Add primary key constraint to this table

tbbwpyh_080405_03.sql Add Index by Active Indicator

tbbwpyh_080405_04.sql Add foreign key constraint to STVTERM

tbbwpyh_080405_05.sql Add foreign key constraint to TTVPTYP

tbbwpyh_080405_06.sql Table and column comments for Web Payment Processing Header

Scripts for TBRWPYM

tbbwpym_080405_01.sql Create table TBRWPYM

tbbwpym_080405_02.sql Add primary key constraint to this table

tbbwpym_080405_03.sql Add foreign key constraint to TBBWPYH

tbbwpym_080405_04.sql Table and column comments for Web Payment Processing Matching Rules


Re

Note: Unless otherwise noted, new scripts are run as part of the upgrade process for a release.

New APIs

The following APIs are new for this enhancement.

Deposit Code Crosswalk API (tb_dep_xwalk)

These packages contain TBBDEPX table API functions and procedures, editing, and error strings.

The following packages are in this API:

• tokd_tbbdepx0.sql

• tokd_tbbdepx1.sql

• tgkb_depwalk0.sql

Scripts for TBRWPYD

tbrwpyd_080405_01.sql Create table TBRWPYD

tbrwpyd_080405_02.sql Add primary key constraint to this table

tbrwpyd_080405_03.sql Add foreign key constraint to TBBWPYH

tbrwpyd_080405_04.sql Add foreign key constraint to TTVPTYP

tbrwpyd_080405_05.sql Table and column comments for Web Payment Processing Detail rules

Scripts for TTVPTYP

ttvptyp_080405_01.sql Create table TTVPTYP

ttvptyp_080405_02.sql Add primary key constraint to this table

ttvptyp_080405_03.sql Table and column comments for Multi-Part Payment Transaction Type

Table ObjectsAPI Object Name

API Entity Name Task Performed

TBBDEPX TBBDEPX tb_dep_xwalk Package contains TBBDEPX API functions and procedures

Script Result


Re

• tgkb_depwalk1.sql

• tgkb_depwalk_r0.sql

• tgkb_depwalk_r1.sql

• tgkb_depwalk_s0.sql

• tgkb_depwalk_s1.sql

Deposit Type Validation API (tb_ttvdtyp)

These packages contain standard functions for the Deposit Type Validation table.


• tvkb_ttvdtyp0.sql

• tvkb_ttvdtyp1.sql

Multi-Part Payment Validation API (tb_ttvptyp)

These packages contain standard functions for the payment transaction type table.


• tvkb_ttvptyp0.sql

• tvkb_ttvptyp1.sql



TTVDTYP TTVDTYP tb_ttvdtyp Package contains TTVDTYP API functions and procedures



TTVPTYP TTVPTYP tb_ttvptyp Package contains TTVPTYP API functions and procedures


Re

Web Payment Processing Header API (tb_webpay_header)

These packages contain TBBWPYH table API functions and procedures, editing, and error strings, and also copy functionality.


• tokd_tbbwpyh0.sql

• tokd_tbbwpyh1.sql

• tgkb_wpayhead0.sql

• tgkb_wpayhead1.sql

• tgkb_wpayhead_r0.sql

• tgkb_wpayhead_r1.sql

• tgkb_wpayhead_s0.sql

• tgkb_wpayhead_s1.sql

Web Payment Processing Matching Rules API (tb_webpay_match)

These packages contain TBRWPYM table API functions and procedures, editing, and error strings, and also functions to return a list of the supported match types and a collection of active rules based on the matching criteria.


• tokd_tbrwpym0.sql

• tokd_tbrwpym1.sql

• tgkb_wpaymtch0.sql

• tgkb_wpaymtch1.sql



TBBWPYH TBBWPYH tb_webpay_header

Package contains TBBWPYH API functions and procedures



TBRWPYM TBRWPYM tb_webpay_match

Package contains TBRWPYM API functions and procedures


Re

• tgkb_wpaymtch_r0.sql

• tgkb_wpaymtch_r1.sql

• tgkb_wpaymtch_s0.sql

• tgkb_wpaymtch_s1.sql

Web Payment Processing Detail Rules API (tb_webpay_detail)

These packages contain TBRWPYD table API functions and procedures, editing, and error strings.


• tokd_tbrwpyd0.sql

• tokd_tbrwpyd1.sql

• tgkb_wpaydetl0.sql

• tgkb_wpaydetl1.sql

• tgkb_wpaydetl_r0.sql

• tgkb_wpaydetl_r1.sql

• tgkb_wpaydetl_s0.sql

• tgkb_wpaydetl_s1.sql

Multi-Part Transaction API (tb_pay_trans)

These packages contain TBRPYTR table API functions and procedures, editing, and error strings, and additional functions and procedures to process payment transactions via TB_RECEIVABLE and TB_DEPOSIT according to the rules defined.



TBRWPYD TBRWPYD tb_webpay_detail

Package contains TBRWPYD API functions and procedures



TBRPYTR TBRPYTR tb_pay_trans Package contains TBRPYTR API functions and procedures


Re


• tokd_tbrpytr0.sql

• tokd_tbrpytr1.sql

• tgkb_paytran0.sql

• tgkb_paytran1.sql

• tgkb_paytran_r0.sql

• tgkb_paytran_r1.sql

• tgkb_paytran_s0.sql

• tgkb_paytran_s1.sql


Re

Student Self Service Patch 8.5.4.4 Changes

New Package

Package in this section is new with this release.

Deposit/Fee Payment Processing (BWSKPAYG)

This package display links for a student, and provides the baseline processing of Web Payment Rules for both students and applicants. The following objects are new:

• bwskpayg.sql

• bwskpay1.sql

Changed Packages

The packages in this section have been modified with this release.

Application Menu (BWSKALOG)

Procedure P_DispChoices was modified to enable the Payment Processing section on the Application Menu of self-service banner. The following object was modified:

• bwskalo1.sql

Account Information Page (BWSKOACC)

This package was modified to enable display of a new page in Self Service called Account Information. New procedures were added to the following objects:

• bwskoacc.sql

• bwskoac1.sql


Re

Seed Data

The following seed data is delivered for this release.

Script Result

tgtvproci_080405.sql Inserts a record in GTVPROC (WEBCCARGATEWAY - Web Credit Card AR Payment Gateway Process) to use for Credit Card processing set-up.

tgtvsdaxi_080405.sql 1) Inserts a new GTVSDAX entry of Internal Group WEBPAYGCCID that needs to have a valid External Code populated, and a new process type WEBCCARGATEWAY for which rules need to be created via GOAMERC.

2) Inserts a new GTVSDAX entry of Internal Group ADDRESS that needs to have a valid External Code populated. This is an Address Hierarchy used by bwskpayg to populate fields in the Credit Card Audit table GORCCAU. We’ll deliver a marker row with <UPDATE ME> - for an address hierarchy.

tgubobjsi_080405.sql Adds new forms.

tgurmenui_080405.sql Adds new forms to menu.

tguroptmi_080405.sql Adds copy option to TSAWPAY.

bwstwgbwmnui_08050404.sql

Adds Name of the web page

•bwskpayg.P_DispFailure•bwskpayg.P_DispList•bwskpayg.P_DispTransaction•bwskpayg.P_Display_Totals•bwskpayg.P_ProcList•bwskpayg.P_ProcFailure•bwskpayg.P_ProcTotals•bwskpayg.P_ProcTransaction•bwskoacc.P_ViewAR•bwskoacc.P_DisplayTabs

bwstwgrwmrli_08050404.sql

Adds new procedures/ pages in Web Tailor Menu Roles table. All pages as mentioned for TWGBWMNU.

bwstwgrinfoi_08050404.sql

Adds into Web Tailor Repeating Information Text table. Adds text on web pages.

bwstwgrmenui_08050404.sql

Adds menu for Payment and Deposit Processing and Account Information.


Banner Accounts Receivablebanner7.utm.edu/manuals/banner_release_guides/arsys80405rg.pdf · Banner...

Documents

Transcript of Banner Accounts Receivablebanner7.utm.edu/manuals/banner_release_guides/arsys80405rg.pdf · Banner...