SIS - Banner
Table of Contents
- 1 Table of Contents
- 1.1 1. Overview
- 1.2 2. Integration Requirements
- 1.2.1 Step 1: Create Database User Account
- 1.2.2 Step 2: Add Required Permissions to Database User Account
- 1.2.2.1 Option 1: Automatically Add Permissions
- 1.2.2.2 Option 2: Manually Add Permissions
- 1.2.2.3 Permission List By Integration:
- 1.2.2.3.1 Courses Integration
- 1.2.2.3.2 Holds Integration
- 1.2.2.3.3 Financial Aid Integration
- 1.2.2.3.4 Bursar/Account Balance
- 1.2.3 Step 3: Create Test User
- 1.3 3. Provide the following information to your Technical Consultant
- 1.3.1 1. Banner TEST
- 1.3.2 2. Banner PROD
- 1.3.3 3. Special Requirements
- 1.3.4 4. Test User
1. Overview
Ready Education integrates with Banner through a direct database connection to bring in personalized Course Schedule, Grades, Bursar, Holds, Financial Aid, and Enrollment integrations to the mobile app. We require mostly "read-only" access to tables for the majority of our integrations including courses, holds, financial aid, and bursar. For more details, refer to the Permissions section.
Note: If your institution’s policies do not allow vendors to integrate with Banner in this manner, please speak with your Implementation Consultant regarding alternative options, including the addition of a VPN connection and our SFTP flat-file integration.
2. Integration Requirements
We require the following information for your Test and Production Banner Instances:
Database User Account (username/password) with required permissions
Hostname/IP
Banner Port Number
Connection SID or Service Name
Step 1: Create Database User Account
Create a database user account for Ready Education, and save the username and password.
Step 2: Add Required Permissions to Database User Account
In order to access the data required for our integrations, we will need a specific set of permissions granted to our database user in Banner.
Two options:
[Recommended] Run the Ready Education Banner Permissions Script to automatically add required permissions to the database user.
Manually add permissions. Consult the list of permissions required for each integration and manually add to the database user.
Option 1: Automatically Add Permissions
Download and run the below script on your database to provide the required access to your tables, procedures, and views for the Banner integrations.
Instructions for New Integrations:
In your Test Banner instance, create a database user e.g. 'READYEDUCATION'
Download and open the provided SQL permission script
Edit the user_name variable to the username created e.g. user_name = 'READYEDUCATION'
(Optional): Change the name of the role created; default is 'dl_default_q'
Run the SQL permission script
Repeat steps 1-5 for your Production instance
Instructions for Updating Permissions on an Existing Integration:
Download and open the provided SQL permission script
Edit the user_name variable to the username already assigned to Ready Education e.g. 'DUBLABS' or 'READYEDUCATION'
(Optional): Change the name of the role created; default is 'dl_default_q'
Run the SQL permission script
Repeat steps 1-5 for your Production instance
Option 2: Manually Add Permissions
Manually add permissions to the database user by consulting the tables below.
For New Integrations:
In your Test Banner instance, create a database user e.g. 'READYEDUCATION'
Consult the required permissions for your integrations and add to the created database user
Repeat steps 1-2 for your Production instance.
For Updating Permissions on an Existing Integration:
Consult the permission list for your integrations and add to the existing database user e.g. 'READYEDUCATION'
Repeat step 1 for your Production instance.
Permission List By Integration:
To manually add permissions, refer to the below list of permissions by integration type. If you choose to automatically add permissions via the script, you do not need to reference the of permissions by integration type:
Courses
Holds
Financial Aid
Bursar
The Bursar Integration is covered in the section after Permission List by Integration as it requires a custom view to be created.
Courses Integration
The Courses Integrations allows students to view their Course Schedule and Banner Mid-term and Final Grades.
Required Access: We require 'Read-only' database access to the below tables
Table Name | Permissions | Notes |
|---|---|---|
GOBTPAC | SELECT | PIDM Lookup |
GOREMAL | SELECT | Faculty Email Lookup |
SIRASGN | SELECT | Faculty Assignments |
SPRIDEN | SELECT | Student Information |
SPBPERS | SELECT | SPBPERS_CONFID_IND flag for directory "opt-out" |
SFRSTCR | SELECT | Registered Students |
SCBCRSE | SELECT | Course Information |
SSBSECT | SELECT | Course Information |
SSRMEET | SELECT | Course Meeting Information |
SSRTEXT | SELECT | Course Notes |
STVCAMP | SELECT | Campus Description |
STVBLDG | SELECT | Building Description |
STVTERM | SELECT | Term Description |
STVSUBJ | SELECT | Subject Description |
STVRSTS | SELECT | Registration Status Validation |
SHRTCKN | SELECT | Final Grade |
SHRTCKG | SELECT | Final Grade |
Holds Integration
This feature is not yet available in the Ready Campus platform, but it is in development. We encourage you to grant these permissions so this feature can be enabled once it is ready.
The Holds integration allows students to view Financial and Administrative holds.
Required Access: We require 'Read-only' database access to the below tables
Table Name | Permissions | Notes |
|---|---|---|
SPRHOLD | SELECT | Student Administrative Holds |
RORHOLD | SELECT | Student Financial Aid Holds |
RTVHOLD | SELECT | Fin Aid Hold Description |
STVHLDD | SELECT | Admin Hold Description |
STVORIG | SELECT | Hold Originator Description |
RFRBASE | SELECT | Financial aid hold Fund Code |
ROBINST | SELECT | Aid year description |
Please also provide one (1) phone number and one (1) email address to direct students to resolve their holds.
Financial Aid Integration
This feature is not yet available in the Ready Campus platform, but it is in development. We encourage you to grant these permissions so this feature can be enabled once it is ready.
The Financial Aid integration allows students to view financial aid, and to accept or decline pending offers.
Required Access: We require:
'Read-only' database access to the listed tables and packages
Grant 'execute access' on the listed procedures, and functions
Packages
Package Name | Notes |
|---|---|
RP_AWARD | Financial Aid Award APIs |
RP_AWARD_STRINGS | Error text APIs |
Procedures
Procedure Name | Permission | Notes |
|---|---|---|
RP_AWARD.p_update | EXECUTE | Student Financial Aid update |
Functions
Function Name | Permission | Notes |
|---|---|---|
RP_AWARD.f_query_all | EXECUTE | Student Financial Aid lookup |
RP_AWARD_STRINGS.f_get_error | EXECUTE | Error text lookup |
Tables
Table Name | Permission | Notes |
|---|---|---|
RFRBASE | SELECT | Fund Code/Description mapping |
RPRAWRD | SELECT | Fund Codes Validation |
RFRASPC | SELECT | Partial Amount Indicator |
RTVAWST | SELECT | Financial aid status description |
STVTERM | SELECT | Term information |
RORSTAT | SELECT | Financial aid Student |
ROBINST | SELECT | Financial aid Status |
RFRASPC | SELECT | Financial aid Status |
Bursar/Account Balance
The Bursar (Account Balance) integration allows students to view their Account Balance including charges, payments, and account summary.
Step 1: Required Access
We require:
Grant 'execute access' on function
f_amount_owedto the database user : e.g. 'READYEDUCATION'A custom 'read-only' database bursar view
Database Bursar View:
There are two options for creating the view:
Option 1 [Recommended]: Run the below select query and create a view. Name the view 'READY_BURSAR'.
Please confirm that the view provides the expected charges, payments, and balance due. Students on the mobile app will select a term. Our integration service will issue a SQL query to the above view(s) filtered by the selected term and the student's unique ID.
For example:
SELECT * FROM READY_BURSAR WHERE PIDM=’600440’ and TERM=’201401’
If the default view does not provide the correct amounts, please use option 2: manually create the views.
Option 2: Manually create the view.
Either create:
Single view containing both payments and charges
Two views: one for charges and one for payments
Sample Charge View
PIDM | TERM | CHRG_AMT | CHRG_DESC | CHRG_DATE |
|---|---|---|---|---|
600440 | 201401 | 1500.00 | Tuition | 2013-12-03 |
600440 | 201309 | 12.00 | Parking | 2013-10-11 |
600440 | 201309 | 150.00 | Athletic Fee | 2013-09-09 |
Sample Payment View
PIDM | TERM | PAY_AMT | PAY_DESC | PAY_DATE |
|---|---|---|---|---|
600440 | 201401 | 1500.00 | Tuition | 2013-12-03 |
600440 | 201309 | 12.00 | Parking | 2013-10-11 |
600440 | 201309 | 150.00 | Athletic Fee | 2013-09-09 |
Please confirm querying the view provides the expected charges, payments, and balance due. Students on the mobile app will select a term. Our integration service will issue a SQL query to the above view(s) filtered by the selected term and the student's unique ID.
For example for a single view with both charges and payments:
SELECT * FROM READY_BURSAR WHERE PIDM=’600440’ and TERM=’201401’Step 3: Create Test User
Provide a test user account that can pass authentication, and has overlapping course data in both your SIS and LMS. Click here to view more information about our test user requirements: Test User and Test Data Requirements.
3. Provide the following information to your Technical Consultant
Provide the following information to your Technical Consultant by emailing integrations@readyeducation.com to create a ticket.
1. Banner TEST
Confirm Banner Server is set-up and accessible
Confirm Ready Education Middleware Servers IPs are whitelisted: 54.165.247.9, 44.205.146.231, 44.215.89.61, 54.224.36.245, 3.97.24.129, 15.135.2.173, 79.125.26.52
Database User Account (username/password) with required permissions
Hostname/IP
Banner Port Number
Connection SID or Service Name
Test User - username and password
2. Banner PROD
Confirm Banner Server is set-up and accessible
Confirm Ready Education Middleware Servers IPs are whitelisted: 54.165.247.9, 44.205.146.231, 44.215.89.61, 54.224.36.245, 3.97.24.129, 15.135.2.173, 79.125.26.52
Database User Account (username/password) with required permissions
Hostname/IP
Banner Port Number
Connection SID or Service Name
3. Special Requirements
For Account Balance/Bursar only:
Provide the name of the Bursar View
(optional): Provide a payment URL for students to pay their bills
For Holds Integration only:
Provide one (1) phone number and one (1) email address to direct students to resolve their holds.
4. Test User
Must be enrolled in overlapping courses in both Banner and your LMS. Click here to view more information about our test user requirements: Test User and Test Data Requirements.