cloud service financial planning oracle vocado student · by intellectual property laws. except as...

Oracle Vocado StudentFinancial PlanningCloud Service

Implementing Vocado StudentFinancial Planning

20B

Oracle Vocado Student Financial Planning Cloud ServiceImplementing Vocado Student Financial Planning

20B

F27767-02

Copyright © 2019, 2020, Oracle and/or its aliates.

Authors: The Student Management Information Development Team

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protectedby intellectual property laws. Except as expressly permied in your license agreement or allowed by law, you may not use, copy, reproduce, translate,broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering,disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you nd any errors, please reportthem to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, thenthe following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed oractivated on delivered hardware, and modications of such programs) and Oracle computer documentation or other Oracle data delivered to oraccessed by U.S. Government end users are "commercial computer software" or “commercial computer software documentation” pursuant tothe applicable Federal Acquisition Regulation and agency-specic supplemental regulations. As such, the use, reproduction, duplication, release,display, disclosure, modication, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system,integrated software, any programs embedded, installed or activated on delivered hardware, and modications of such programs), ii) Oracle computerdocumentation and/or iii) other Oracle data, is subject to the rights and limitations specied in the license contained in the applicable contract. Theterms governing the U.S. Government’s use of Oracle cloud services are dened by the applicable contract for such services. No other rights aregranted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended foruse in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardwarein dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safeuse. Oracle Corporation and its aliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its aliates. Other names may be trademarks of their respective owners.

Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarksor registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced MicroDevices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. OracleCorporation and its aliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, andservices unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its aliates will not be responsiblefor any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicableagreement between you and Oracle.

The business names used in this documentation are ctitious, and are not intended to identify any real companies currently or previously in existence.


Contents

Preface .................................................................................................................................. i

1 Geing Started 1Implementing Student Financial Planning Cloud Service: Overview ................................................................................... 1

Supported Browsers ....................................................................................................................................................................... 1

Brand The Environment ................................................................................................................................................................ 1

2 Conguration 3Overview of Conguration ........................................................................................................................................................... 3

Conguration Paradigms .............................................................................................................................................................. 3

Baseline Conguration .................................................................................................................................................................. 4

Extensibility of Conguration ...................................................................................................................................................... 5

Conguration Workbooks ............................................................................................................................................................. 5

Conguration Tools ........................................................................................................................................................................ 8

Deploy a Conguration Update ................................................................................................................................................. 10

Load Conguration Processing Steps ...................................................................................................................................... 19

3 Integration 21Integration Overview .................................................................................................................................................................... 21

Integration Guiding Principles .................................................................................................................................................... 21

Message Processing Gateway ................................................................................................................................................... 22

Vocado U.S. Department of Education Gateway ................................................................................................................... 22

Integration Messages .................................................................................................................................................................. 23

Frequently Used Integration Tool(s) ......................................................................................................................................... 25

Integration of SAML 2.0 and SSO ............................................................................................................................................ 25

Integration with Oracle PeopleSoft Campus Solutions ........................................................................................................ 32

Batch Jobs and TD Client Communications .......................................................................................................................... 35

Frequently Asked Integration Questions ................................................................................................................................. 41

4 Conversion 43Overview of Data Conversion .................................................................................................................................................... 43


Conversion Methods ................................................................................................................................................................... 43

Components of Data Conversion ............................................................................................................................................. 44

Executing Conversion .................................................................................................................................................................. 45

Frequently Asked Conversion Questions ............................................................................................................................... 46

5 Reports 47Overview of Reports .................................................................................................................................................................... 47

Geing Started: Reports ............................................................................................................................................................. 47

Connect to the JasperServer ..................................................................................................................................................... 48

Create Reports .............................................................................................................................................................................. 48

Upload Reports .............................................................................................................................................................................. 51

Execute Reports ............................................................................................................................................................................ 52

Promote Reports to Production ................................................................................................................................................ 53

Report Folder Hierarchy ............................................................................................................................................................. 54

6 Leers 57Overview of Leers Communication ....................................................................................................................................... 57

Leer Process ................................................................................................................................................................................ 57

Leer Templates ........................................................................................................................................................................... 57

Out-of-the-Box Leers ............................................................................................................................................................... 58

Leer Batch Jobs ......................................................................................................................................................................... 58

At-Will (Ad Hoc) Leers .............................................................................................................................................................. 59

Leers Frequently Used Tools .................................................................................................................................................. 59

Leer Components ...................................................................................................................................................................... 60

Event Messages That Can Trigger a Leer ............................................................................................................................ 61

Update Sample Leers ................................................................................................................................................................ 61

Disable a Leer ............................................................................................................................................................................. 62


Preface

PrefaceThis preface introduces information sources that can help you use the application and this guide.

Using Oracle Applications

To nd guides for Oracle Applications, go to the Oracle Help Center at hp://docs.oracle.com/.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website.

Videos included in this guide are provided as a media alternative for text-based topics also available in this guide.

Contacting Oracle

Access to Oracle SupportOracle customers that have purchased support have access to electronic support through My Oracle Support. Forinformation, visit My Oracle Support or visit Accessible Oracle Support if you are hearing impaired.

Comments and SuggestionsPlease give us feedback about Oracle Applications Help and guides! You can send an e-mail to:[email protected].

i

http://docs.oracle.com/

http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc

http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info

http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs

mailto:[email protected]


Preface

ii


Chapter 1Geing Started

1 Geing Started

Implementing Student Financial Planning Cloud Service:Overview For a successful implementation, begin by reviewing this implementation guide.

This list contains tasks to get prepared for your Student Financial Planning implementation.

1. Conrm you received the Welcome e-mail from Oracle.2. Verify access to your instance of the Student Financial Planning application.3. Verify access to your instance of the Student Self Service (if applicable).4. Verify access to your instance of the Jaspersoft Web UI.5. Create users in the Student Financial Planning application for anyone that will be completing the

implementation process and make sure they have the Role of System Administrator. To learn how to add users,create and edit roles, and update the password policy: See Security Management .

6. To start an implementation of Oracle Vocado Student Financial Planning Cloud Service, you need to access MyOracle Support. Search for and bookmark Doc ID 2514673.1: Introducing Oracle Student Financial Planning CloudService.

7. You might also refer to the Student Financial Planning User Guide on Oracle Help Center.8. Bookmark Oracle Vocado Student Financial Planning Cloud Service: Release Notes (Doc ID 2613016.1) on My

Oracle Support. The release notes are organized by year and month. For example 20.2 for 2020, February.9. Download the latest API assets and the Baseline Conguration Release Extract from Oracle Vocado Student

Financial Planning Cloud Service: Release Notes.10. Use the Toolbox chapter in the user guide for quick access during your implementation.

Supported Browsers

This table illustrates which browsers are supported for SFP and SFP Student Self Service.

Web/Mobile Browser Student Self Service UI Student Financial Planning UI

Chrome 63 or later 62 or later

Chrome Mobile 63 or later Not Supported

Firefox 52 or later 52 or later

Firefox Mobile 52 or later Not Supported

Brand The Environment

1

http://www.oracle.com/pls/topic/lookup?ctx=cloud&id=SecurityManagement

https://support.oracle.com





Chapter 1Geing Started

OverviewIf maintaining a consistent look and feel across all of your applications is important, you can request your provisionedenvironments to be updated with your institutions primary color and logo through My Oracle Support at hps://support.oracle.com. When you request a branding update, you need to request the update for each environment in aseparate ticket. Oracle Development will hard code the updates for each environment and the new theme will becomevisible in the user interface once IT deploys the updated release.

Request Environment Branding Update1. Submit a Service Request on My Oracle Support at hps://support.oracle.com2. Provide the following information:

a. Institution's Logob. One primary color (hex or rgb)

Branding SuggestionsLogo

• Vector graphics is preferred when available (.svg)

• Otherwise raster graphics, .png is rst preference, .jpeg is second preference

• Maximum le size of 256K

• Minimum height of 40px

• Maximum height of 400px

• Horizontal logos appear most cohesive placed in the top navigation bar of the applications

Color Code:

• HTML Color Code (Hex Code) (e.g. Red (#FF0000), Blue (#0000FF))

• RGB Color Code (e.g. Red (255, 0, 0), Blue (0, 0, 255))

2





Chapter 2Conguration

2 Conguration

Overview of Conguration Student Financial Planning provides the Institution with a set of congurations based on best-practices, which havebeen standardized and can be leveraged immediately or further tweaked to an Institution’s specic processes, goals,and objectives.

Conguration is simply geing the institution's information into the database in order for the application to processstudent nancial aid based on the school’s business rules. You may maintain some conguration through the userinterface; however, the majority of the conguration is maintained in a series of csv les, which are then loaded throughthe SFP User Interface on the Conguration Administration screen.

Conguration Paradigms There are essentially two conguration paradigms.

• Reference Table Lookup Values: A simple lookup, similar in theory to a key/value pair.

• Groovy Scripts: A dynamically-typed, Java-syntax scripting language used to evaluate complex expressions anddrive systemic automation

Conguring Reference Table Lookup Values can be as trivial as updating your school's Federal School Code, OPEID(s),or COD Routing ID. Other congurations can be a bit more complex because the application has to orchestrate a seriesof decisions or a series of IF Then OR Else statements in order to Request Documents, evaluate Document AcceptanceCriteria, Submit ISIR Corrections, Clear C-Codes, Verify an ISIR, or evaluate Disbursement Criteria. For these types ofcomplex congurations, the application leverages Groovy Scripts. In brief, Groovy is a scripting language built on a JavaPlatform. It runs in it’s own virtual machine, it has it’s own sandbox and uses the same syntax as Java.

Conguring your school's Cost of Aendance (COA) includes updating Reference Table Lookup values includingProgram Type, Enrollment Status, and Modality, but also utilizes Groovy Scripts in order to calculate more granular COAvalues that may be based on the student's ISIR grade level, permanent address, and specic program details.

Below is an example of the complex choreography completed through a series of groovy scripts.

If Student Financial Planning receives an ISIR with C-Code 171, the Financial Aid System (FAS) evaluates the student'sISIR and determines the student is selected for Independent Verication, for Verication Group 1, their Tax Return isAlready Completed, and the student's IRS Request Flag has a value of 02 which means, IRS data for the student wastransferred from the IRS and was not changed by the user prior to submission of an application or correction.

Based on this information, SFP requests Independent Verication Worksheet and a Rollover Statement IF, Field 191:Student IRS IRA Distributions Data Field Flag and/or Field 192: Student IRS Untaxed Pensions Data Field Flag has a valueequal to:

• 1 = IRS data was transferred and not changed by user OR

• 2 = IRS data was transferred and changed by user to a dierent value OR

• 3 = IRS Request ag is equal to 02, 03, 04, or 07, and eld has been corrected on this transaction OR

• 4 = IRS Request ag is equal to 02, 03, 04, or 07, and eld has been corrected on a previous transaction

3



Upon receipt of the requested documents, Student Financial Planning compares the document metadata against theISIR metadata. If the values match, Student Financial Planning clears the C-Code and completes the Valid ISIR Process,but if the values do not match, Student Financial Planning submits ISIR Corrections using the document meta-data.

Note: Student Financial Planning compares received document meta-data to ISIR meta-data andautomatically submits ISIR corrections based on ISIR Discrepancy Rules.

Baseline Conguration

Overview of Baseline CongurationAs part of the product, Student Financial Planning provides a comprehensive set of baseline congurations thatstrictly adheres to the rules and regulations set by the U.S. Department of Education. As you read through the baselineconguration, you can see it follows the guidance provided in the IFAP handbook and U.S. Department of EducationTech Refs. Any deviations are the result of feedback from regulatory auditors, consultants in the industry, and schoolocials.

Baseline conguration is constructed primarily around the U.S. Department of Education regulations in order tofacilitate quick and ecient implementations. If you elect to not implement any institution-specic conguration,installing the baseline conguration alongside the Oracle Student Financial Planning Cloud Service allows yourinstitution to process nancial aid within the U.S. Department of Education’s regulations. Oracle automatically updatesthe baseline conguration as part of the product if the regulations are updated annually as expected or mid-year. If youare leveraging the baseline conguration, Oracle provides an updated set of conguration workbooks with the ProductRelease Notes for you to use if you choose to implement the updated baseline conguration. See Doc ID 2613016.1 on MyOracle Support.

How the Baseline Conguration was DeterminedOracle focused on what would return the highest automation rate for most institutions, while strictly adhering toDepartment of Education regulations as outlined in the FSA Handbook, EDE Tech Specications, Dear Colleague Leers,and other public communications from the Department. Oracle sought to congure the automation to cover 70% of aschool's population, requiring only 30% manual user interaction with Student Financial Planning.

Oracle worked very closely with institutions and leveraged their historical ISIR data to determine what would allowthe application to reach a 70% automation rate. Using historical ISIR data allowed Oracle to analyze all the dierentscenarios that occur for a particular school and determine which ones occurred most frequently. For example, oneinstitution's student population was largely Independent and the students selected for verication generally fell intoVerication Group 1 and 5. When Oracle built the conguration to support that population, the school achieved afavorable automation rate, but they elected to modify their conguration and achieved an automation rate a lile over80%.

Another case study for a dierent institution determined their automation rate using baseline conguration would clear75% of their students selected for Verication and 60% of the automatically requested documents would be acceptedwithout user review. The packaging process automation rate resulted in 80%, Disbursements, Credit Balances andReturns resulted in an automation rate of 85%, and Call Center activities were even automated by 10%.

4





CongurationBaseline Conguration is designed to automatically request documents, clear over 200 Comment Codes (C-Codes),package, award, disburse and return funds based on U.S. Department of Education Regulations.

The following workbooks require updates in order to implement the congurations for Student Financial Planning:

• School Workbook

◦ Federal School Code

◦ OPEID(s)

◦ COD Routing ID

• Cost of Aendance (COA) Workbook

◦ COA Breakdown

Extensibility of Conguration The Out-of-the-Box Conguration is extensible.

You may elect to modify the conguration a lile bit, or extensively. Data can be updated specically to meet yourschool’s business needs. However, if you modify the conguration workbooks, you are responsible for maintaining themodications when the Out-of-the-Box conguration is updated due to annual regulatory updates or due to marketdemands.

Oracle does not warranty institutional-specic conguration because Oracle cannot guarantee it is compliant or that itproduces desired results.

Conguration Workbooks There are some congurations that can be maintained in the Student Financial Planning User Interface, but the majorityof the conguration is maintained in csv les.

Conguration that can be maintained in the User Interface is only accessible if your Role has the Administrationpermission enabled. Users can congure the FAFSA Completion Start and End Dates, whether QC Holds are enabledor disabled, congure Fund Allocation Periods and the amounts in each period, congure the Award, Fund, and CODCloseout dates, congure User Roles and assign specic General Permissions and Document Permissions for each, andcongure the password policy.

Change Management of CongurationThe baseline conguration consists of approximately 40 csv les. One of the things customers have mentioned as areal benet is the ability to take a holistic set of those les and use that as a conguration release. Being able to takea snapshot of each conguration release allows the customer to release manage conguration just like they releasemanage code. Anytime the conguration is updated by Oracle, the changes or enhancements are documented inrelease notes and if anything catastrophic goes wrong, the customer can always rollback the conguration to the priorconguration release. Anytime you update the conguration to meet your schools specic needs, you may want to save

5



a zip le (i.e. CongRelease_%) of the conguration les and maintain a set of release notes for your school associatedwith the name of your zip le.

Suggested Sequence to Update Conguration WorkbooksYou can implement Student Financial Planning (SFP) in phases.

• Phase 1: ISIR Processing

• Phase 2: Rest of SFP

This table illustrates the suggested go live phase, group, and sequence the Conguration Workbooks should be updatedand deployed over two distinct Go-Live Phases.

Group Category Workbook Type NamingStandard

Dependency Go Live Phase#

Group Sequence AnnualUpdatesRequired

School School %_SCHOOL.csv N/A ISIR Processing 1 1 N

School Roles %_ROLE.csv N/A ISIR Processing 1 2 N

Documents Documents %_DOCUMENTS.csv

N/A ISIR Processing 1 3 Y

Documents Document Data %_DOCMETADATA.csv

Documents ISIR Processing 1 4 Y

ISIR ISIR C Codes %_ISIR_C_CODES.csv

Documents, Document Data

ISIR Processing 1 5 Y

ISIR ISIR RejectCodes

%_ISIR_REJECT_CODES.csv



ISIR ISIR DiscrepancyRules

%_ISIR_DISCREP.csv



ISIR ISIRAssumptions

%_ISIR_ASSUMPT.csv



ISIR ISIR Highlights %_HIGHLIGHT.csv



ISIR ISIRManagement

%_ISIR_MGMT.csv



ISIR PJ %_PJ.csv Documents, Document Data


ISIR ISIR C Codes toFields

%_ISIR_C_CODES_TO_FIELDS.csv

Documents,Document Data, ISIR C Codes


ISIR ISIR VericationCodes

%_ISIR_VERIFICATION_CODES.csv

Documents,Document Data, ISIR C Codes


ISIR ISIR Reject to CCodes

%_ISIR_REJECT_TO_C_CODES.csv

Documents,Document Data, ISIR C Codes, ISIR RejectCodes


6



ISIR ISIR Reject toFields

%_ISIR_REJECT_CODES_TO_FIELDS.csv

Documents,Document Data, ISIR RejectCodes


Notications Leers %_LETTER.csv N/A ISIR Processing 2 16 N

Packaging Fund Priority %_FUND_PRIORITY.csv

N/A Packaging, Disbursing, Returns

1 17 N

Packaging FAS Fund Cong %_FAS_FUND_CONFIG.csv

Fund Priority Packaging, Disbursing, Returns

1 18 Y

Packaging Non FederalFund Aributes

%_NFR_ATTRIB.csv

Documents,Document Data, Fund Priority

Packaging, Disbursing, Returns

1 19 Y

Packaging PackageSchedule

%_PACKAGE_SCHEDULE.csv


1 20 N

Packaging PackageScheduleAributes

%_PKGSCHEDATTRIB.csv


1 21 N

Packaging COA %_COA.csv N/A Packaging, Disbursing, Returns

1 22 Y

Packaging COA Term AcY %_COA_TERM_ACY.csv


1 23 N

Packaging Title IV AwardCriteria

%_T4_CRIT.csv N/A Packaging, Disbursing, Returns

1 24 Y

Packaging OriginationProperties

%_ORIGINATION_PROPERTY.csv


1 25 N

Disbursements Disbursement %_DISB.csv N/A Packaging, Disbursing, Returns

2 26 N

R2T4 R2T4 Charge %_R2T4_CHARGE.csv


2 27 N

R2T4 R2T4 %_R2T4.csv N/A Packaging, Disbursing, Returns

2 28 Y

R2T4 R2T4 BreakTypes

%_R2T4_BREAK_TYPE.csv


2 29 N

R2T4 R2T4 SAFIRequest

%_R2T4_SAFI_REQUEST.csv


2 30 N

7



R2T4 R2T4 CHBD %_R2T4_CHBD.csv

FAS Fund Cong Packaging, Disbursing, Returns

2 31 N

R2T4 GrantRepayment

%_GRANTREPAY.csv

FAS Fund Cong Packaging, Disbursing, Returns

3 32 N

School Student RecordHold

%_HOLD.csv N/A Packaging, Disbursing, Returns

3 33 N

School RegulatoryDeadlines

%_REGULATORY_DEADLINE.csv


4 34 Y

Notications CCM %_CCM.csv N/A Packaging, Disbursing, Returns

4 35 N

Notications NoticationTriggers

%_TRIGGER.csv N/A Packaging, Disbursing, Returns

4 36 N

Notications Exit Counseling %_EXIT_COUNSELING.csv


4 37 N

School Student Holds %_STUDENT_HOLD.csv

N/A ISIR Processing 4 38 N

Conguration Tools You may nd the following tools helpful to manage conguration.

• Groovy Compiler.

• CSV Conversion Tool.

• Conguration Updates within the Product Release Notes.

• Student Groups Event Message.

Groovy CompilerA Groovy Compiler compiles scripts prior to loading them to the database, ensuring no compilation errors occur.

When you are mapping out conguration you may want to use pseudo code to get your thoughts and ideasdocumented. However, when you write the actual code, you may benet from using a groovy compiler to ensure thereare no scripting, syntax or stack trace errors. The groovy compiler allows you to enter code and when you run the tool, itdisplays errors in an easy user friendly format.

CSV Conversion ToolA CSV conversion tool can easily convert an entire set of conguration workbooks to .csv les in one-click in an eort toquickly and eciently load the conguration into an environment. Using a CSV conversion tool reduces the risk of user

8



error and makes the process a whole lot faster. Without out it, you have to convert each workbook separately and someworkbooks are not a 1:1 ratio and result in multiple csv les.

Conguration Updates Within the Product Release NotesProduct Release Notes are a valuable resource because they include Conguration Updates to keep you informed.Conguration Updates include:

• Technical updates

• Knowledge updates

• Latest set of Conguration Workbooks

For conguration updates, see Oracle Vocado Student Financial Planning Cloud Service: Release Notes (Doc ID2613016.1) on My Oracle Support. Select the latest release version. You can download conguration workbooks from anyof the available releases.

Student Groups Event MessageThe Student Groups Message, FasStudentGroupsIn, is an inbound event that allows users to import Student Groupaributes from their Student Information System (SIS) into SFP. The message includes these aributes:

• A Student element and a Group Events element.

• The Group Events element communicates the status of the Student Group associated with the student anddenes whether the student’s association with the Student Group is added or removed.

• Data included in this message event provides a comprehensive list of Student Groups for the Student. Whenreceived, the message replaces a student’s existing Student Groups information. Therefore, the Student Groupmessage for a given student should always contain all of the student’s Student Group entries and activity; notjust the dierence. Sending only Student Group changes for the student can result in creating orphaned rowsanywhere a Groovy script uses the Student Group data.

When the data is loaded, a Student History Entry within a Student Groups category is created and award packaging logicis triggered to evaluate the data in the related Groovy statements.

Using Student Groups in Groovy Statements

These Conguration Workbooks and elds support Student Groups and allow you to create Groovy statement criteriathat include the Student Group Name and the time period for which the Student Group should or should not beapplicable:

• COA.csv

◦ Additional_COA_Components

• FAS_FUND_CONFIG.csv

◦ Origination_Criteria

◦ Award_Overriding_Criteria

◦ Enrollment_Status_Override_Census_Dates

• NFR_ATTRIB.csv

◦ Fund_Eligibility

◦ Fund_Maximum_Projected_Award_Amount

◦ Fund_Annual_Year_Limit

9




◦ NFR_Fund_Disbursement_Dates

◦ NFR_Periods

• DISBURSEMENT.csv

◦ Disbursement_Criteria

A Student Initiation Message (SDI) Event must be loaded to create the student in SFP before loading a Student GroupsMessage Event for the student. The Student Group Message Event can be loaded either before or after the StudentAcademic and Financial Information (SAFI) Event.

Example to Remove a Fund from a Student Group-Based Financial Aid Package

To remove a fund (Federal or Non-Federal), Oracle recommends that, in the Student Group Message Event, send in the"Added to Group" Group Event element and the "Removed from Group" Group Event element for the relevant StudentGroup. For the removal, the process looks for a pairing of “Added to Group” and “Removed from Group” so this practicehelps ensure that there are no orphaned disbursements. For example, send “Added to Group” for ATHLETE with theeective date and “Removed from Group” for ATHLETE with the eective date. Don’t send the ”Removed from Group"Student Group element by itself.

Example to Include or Exclude a Cost of Aendance Item

When using Student Groups data with the Cost of Aendance (COA) Conguration Workbook in particular, you have tocreate two Groovy statements to distinguish which populations should or should not be assigned any Student Group-related COA Item.

For example if you want to assign a COA Item based on the presence or absence of a Student Group for Disabledstudents, you should update your COA.csv workbook similar to the following:

• For the six standard COA Items plus a new Disabled COA Item, you need to create a Groovy statement thataccounts for that student cohort having that Student Group for Disabled students assigned. For example, def isEligible = studentGroups.isInGroupAtAnyPointInThePeriod ("disabled", term);return isEligible;"

• For the cohort of students who do not qualify for the Disabled COA Item, you need to create a Groovystatement that accounts for the "non-Disabled" cohort that excludes the Student Group for Disabled students.For example, "def isEligible = !studentGroups.isInGroupAtAnyPointInThePeriod("disabled", term);returnisEligible;"

Note: If you use multiple Student Groups for assigning COA Items, you have to create Groovy statements forall combinations of including and not including all of the Student Groups.

Deploy a Conguration Update Student Financial Planning enables schools to manage and deploy conguration with a simple user-friendlyConguration Administration option available in the User Interface.

To deploy a conguration update you will rst have to download the latest conguration on your environment, modifycsv and/or groovy les, and then save an upload the updates through the Load Conguration page of the userinterface.

10



CSV Naming Convention and File StructurePlease follow the naming conventions and le structure described within the Conguration Administration page. Youcan view a pop-out dialog box with details by clicking on the "here" link on the Conguration Administration page. Thepop out dialog box displays a list of all csv les based on a very specic le structure Hierarchy and denes Dependentcsv les.

For Example, if you want a new document to clear a particular C-Code, update the ISIR C Codes workbook to referencethe new document, then update the dependent Document and Document Data csv les. When uploading the updatedconguration les, upload all the workbooks in one zip le or if you want to segment the uploads for any reasons,upload the Dependent Document and Document Data les before you upload the ISIR C Code le.

Conguration File Guide

This table illustrates the conguration categories and their corresponding relation to each other in terms of hierarchyand dependencies. Each csv le requires a standard naming convention and specic le type extension (.csv).

Note: While there is a hierarchy associated with the group categories, the zip le containing the workbookscan include one or any combination of categories as the system sequences them automatically in hierarchicalorder during the load process.

Group Category Hierarchy Workbook Type Naming Standard Dependency Description

School 1.0 School %_SCHOOL.csv N/A This workbook allowsinstitutions to denepermissions for eachuser account role thatshould be establishedfor accessing thenancial aid system.

School 1.1 Roles %_ROLE.csv N/A This workbookallows institutionsto establish generalschool level detailsnecessary forprocessing nancialaid. Some parametersdened here include:Federal School ID,

11



OPEIDs, Right toCancel Deadline, etc.

Documents 2.0 Documents %_DOCUMENTS.csv N/A This workbook allowsinstitutions to denetheir institutionaldocuments and setadditional relatedparameters (i.e.manual reviewrequired, studentnotication messages, etc.)

Documents 2.1 Document Data %_DOCMETADATA.csv Documents This workbook allowsinstitutions to deneassociated metadataelds for DocumentCodes based onthe Documentsworkbook, and setadditional relatedparameters (i.e. datatype, enumerationvalues, etc.)

ISIR 3.00 ISIR C Codes %_ISIR_C_CODES.csv Documents, Document Data

This workbookallows institutions todene code clearinglogic, any documentrequests, and anyadditional studentnotication messagesper SAR c-code.

ISIR 3.01 ISIR Reject Codes %_ISIR_REJECT_CODES.csv


This workbook allowsinstitutions to denecode clearing logicand associate anyadditional studentnotication messagesper SAR reject code.

ISIR 3.02 ISIR Discrepancy Rules %_ISIR_DISCREP.csv Documents, Document Data

This workbook allowsinstitutions to deneverication clearinglogic, any documentrequests, and anyadditional studentnotication messagesper vericationcomment code andtracking group.

ISIR 3.03 ISIR Assumptions %_ISIR_ASSUMPT.csv Documents, Document Data

This workbookallows institutions todene logic per ISIReld to determinediscrepancies(i.e. conictinginformation) thatshould trigger ISIRcorrections.

ISIR 3.04 ISIR Highlights %_HIGHLIGHT.csv Documents, Document Data

This workbook allowsinstitutions to dene

12



material changecriteria to determinewhat record shouldbe agged whensubsequent ISIRtransactions arereceived, per awardyear.

ISIR 3.05 ISIR Management %_ISIR_MGMT.csv Documents, Document Data

This workbook allowsinstitutions to denecode clearing logicand associate anyadditional studentnotication messagesper ISIR assumptioneld.

ISIR 3.06 PJ %_PJ.csv Documents, Document Data

This workbook allowsinstitutions to denecode clearing logicand associate anyadditional studentnotication messagesper ISIR highlight eld.

ISIR 3.07 ISIR C Codes to Fields %_ISIR_C_CODES_TO_FIELDS.csv

Documents,Document Data, ISIR CCodes

This workbookallows institutionsto associate SARreject codes to SARcomment codes.

ISIR 3.08 ISIR Verication Codes %_ISIR_VERIFICATION_CODES.csv

Documents,Document Data, ISIR CCodes

This workbookallows institutions toassociate SAR c-codesto ISIR eld names.

ISIR 3.09 ISIR Reject to C Codes %_ISIR_REJECT_TO_C_CODES.csv

Documents, Document Data, ISIRC Codes, ISIR RejectCodes

This workbookallows institutions toassociate SAR rejectcodes to ISIR eldnames.

ISIR 3.10 ISIR Reject to Fields %_ISIR_REJECT_CODES_TO_FIELDS.csv

Documents, Document Data, ISIRReject Codes

This workbook allowsinstitutions to denetheir ProfessionalJudgment types, and associate anyinitiating documentsand criteria for each PJprocess.

Notications 4.0 Leers %_LETTER.csv N/A This workbook allowscustomers to associateleer codes that havebeen dened in thereporting tool, to theappropriate messagetriggering action.

Packaging 5.0 Fund Priority %_FUND_PRIORITY.csv

N/A This workbook allowsinstitutions to set theorder at which SFPevaluates the student'seligibility for funds(e.g. Pell is rst, then

13



other grants, andnally loans)

Packaging 5.1 FAS Fund Cong %_FAS_FUND_CONFIG.csv

Fund Priority This workbook allowsschools to congure/dene specic detailsaround each fund, such as went to freezethe fund, the criteriarequired to be metbefore originating TitleIV funds, etc.

Packaging 5.2 Non Federal FundAributes

%_NFR_ATTRIB.csv Documents, Document Data, FundPriority

This workbook allowsschools to congureany non-federal fundthey would like topackage students for(whether automatedor manual).

Packaging 5.3 Package Schedule %_PACKAGE_SCHEDULE.csv

N/A For nonterminstitutions, thiscongurationdetermines whethera student's paymentperiod or academicyear can end in themiddle of a course.

Packaging 5.4 Package ScheduleAributes

%_PKGSCHEDATTRIB.csv

N/A This workbookallows institutions tocongure calculationto determine thenumber of months fora student, and how totreat the summer termif there is enrollmentin the summer.

Packaging 5.5 COA %_COA.csv N/A This workbook iswhere institutionscongure the Cost ofAendance items.

Packaging 5.6 COA Term AcY %_COA_TERM_ACY.csv

N/A This workbookdenes what makesa student a full timefull year student. Thiswill be used whendetermining the PellCOA.

Packaging 5.7 Title IV Award Criteria %_T4_CRIT.csv N/A This workbookallows institutionsto congure theawarding criteria forTitle IV funds.

Packaging 5.8 Origination Properties %_ORIGINATION_PROPERTY.csv

N/A This workbookallows institutionsto congure theorigination criteria forTitle IV funds requiringCOD communication.

14



Disbursements 6.0 Disbursement %_DISB.csv N/A This workbook allowsinstitutions to denedisbursement criteriaper fund code, thatwill be leveraged inaddition to regulatorydisbursement rulesthat exist in thenancial aid system. Italso allows institutionsto dene how longa disbursementhas to meet thecriteria before it iscanceled and whethera disbursementmessage shouldbe triggered upondisbursing the fund.

R2T4 7.0 R2T4 Charge %_R2T4_CHARGE.csv N/A This workbook allowsinstitutions to denethe charge typesthat should be usedwhen determiningcharges in the R2T4calculation.

R2T4 7.1 R2T4 %_R2T4.csv N/A This workbookallows institutionsto dene any delaytimeframe thatshould be consideredwhen triggering anR2T4 calculation, based on the typeof withdrawal (e.g.Ocial vs Unocialwithdrawal).

R2T4 7.2 R2T4 Break Types %_R2T4_BREAK_TYPE.csv

N/A This workbook allowsnonterm institutionsto dene how breaksshould be treatedwhen calculatingthe R2T4 Rate ofProgression (i.e.whether unapprovedcourse breaks areconsidered or whetherLOA breaks should beinclusive of the LOAstart date).

R2T4 7.3 R2T4 SAFI Request %_R2T4_SAFI_REQUEST.csv

N/A This workbook allowsinstitutions to denehow many days aftera student withdrawals, that the nancial aidsystem should requestthe R2T4 SAFI (i.e.SAFI that is aggedto trigger the R2T4calculation).

15



R2T4 7.4 R2T4 CHBD %_R2T4_CHBD.csv FAS Fund Cong This workbook allowsinstitutions to setadditional criteria thatshould be consideredwhen determiningCould Have BeenDisbursed criteria perfund code, based onAdmissions and/orAcademic statusesfrom the SAFI.

R2T4 7.5 Grant Repayment %_GRANTREPAY.csv FAS Fund Cong This workbook allowsinstitutions to denethe repayment fundcode that should beused to indicate agrant overpaymentrepayment in the SAFI.

School 1.2 Student Reocrd Hold %_HOLD.csv N/A This workbook allowsinstitutions to denereasons to hold futureprocessing of FinancialAid.

School 1.3 Regulatory Deadlines %_REGULATORY_DEADLINE.csv

N/A This workbookallows institutions todene the regulatorydates that should beconsidered per awardyear for transmiingles with CPS and COD(i.e. ISIR CorrectionStart/End Dates, CODOrigination Start/EndDates).

Notications 4.1 CCM %_CCM.csv N/A This workbook allowsinstitutions to denemessage content thatshould be populatedin outbound messagesfor dened processes(e.g. ISIR Verication).

Notications 4.2 Notication Triggers %_TRIGGER.csv N/A This workbookallows institutions todene criteria andstudent messagingfor nancial aidnotications, e.g.when an MPN orEntrance CounselingCompletion isrequired.

Notications 4.3 Exit Counseling %_EXIT_COUNSELING.csv

N/A This workbookallows institutions todene criteria andstudent messagingfor exit counselingnotications.

16



Things to Know Before you Begin1. Baseline Conguration is uploaded to your environment during the provisioning process.2. At minimum you will have to update the following .csv les for your school:

◦ SCHOOL.csv

- Federal School Code- OPEID(s)- COD Routing ID

◦ COA.csv

- COA Breakdown3. The Conguration Administration page only accepts .zip les.4. You must strictly adhere to the .csv Naming Standard in the Conguration File Guide for the system to

recognize and accept the request to load the conguration.

◦ You can add data you want where the % symbol exists.

5. All dependent .csv les and groovy directories must be included in the .zip le being uploaded.6. DO NOT compress or zip a parent folder. Select only the .csv les and groovy directories you want to upload

and zip/compress only those les. Zipping a parent folder will break the path to the groovy script that isdocumented in the .csv le.

7. DO NOT remove the groovy scripts from their directory, change the directory name or directory structure.Doing so will break the path to the groovy script that is documented in the .csv le.

8. Here are the ways you can use Groovy:

◦ Reference a .groovy le in a .csv le, but you must also provide all the relevant groovy directories withthe .csv le in the .zip folder.

◦ Insert a Groovy script directly in the relevant cell of the .csv le.

9. You CANNOT upload just an updated groovy le. In order for the system to know what conguration to update,the .zip le must contain the associated .csv le that references the groovy script in the full groovy directory.

10. When you open a .csv le, some columns are automatically reformaed by Microsoft Excel. The format mustbe updated before you aempt to upload the conguration or an error will be returned and the upload will fail.Known data impacted by auto formaing:

◦ Number values with leading zeros (e.g. C-Codes, Reject Codes, OPEIDs).

◦ Dates.

11. All Date columns in any of the .csv les need to be converted to YYYY-MM-DD. Example .csv les:

◦ FAS_FUND_CONFIG

◦ FUND_PRIORITY

◦ NFR_ATTRIB

◦ Microsoft Excel Instructions: More Number Formats > Date > Type > YYYY-MM-DD

12. The CODE_NUMBER in the following .csv les need to be converted to 3 digits in length or the system willreturn an error (e.g. Invalid code length for entry):

◦ ISIR_C_CODES

◦ ISIR_C_CODES_TO_FIELDS

◦ ISIR_REJECT_TO_C_CODES

17



◦ Microsoft Excel Instructions: More Number Formats > Custom > Type > 000

13. The following .csv les contain a CODE_NUMBER, but DO NOT update the format to a 3 digit value:

◦ ISIR_REJECT_CODES

◦ ISIR_VERIFICATION_CODES

◦ ISIR_REJECT_CODES_TO_FIELDS

14. If you copy/type any data onto a new blank line in the .csv le, then clear the eld/row contents, you mustdelete the entire row. Even if the .csv shows a blank record, Microsoft Excel stores hidden data within that row,which can result in an error.

15. If you want the latest Baseline Conguration, download it from the latest release notes: Doc ID 2613016.1 on MyOracle Support.

16. Do not upload the Baseline Conguration you download from the release notes in a Production environment asit will overwrite important institutional data contained in your SCHOOL.csv.

◦ Extract the data or script from the baseline .csv or .groovy you want to implement and update your localconguration les downloaded from the Conguration Administration screen.

17. In the SCHOOL.csv you will provide your school's OPEID. If your school has multiple OPEIDs it is important thatyour main OPEID is listed rst as it sets the SCHOOL_CONFIGURATION (using just this main OPEID, not others).

◦ In the csv provide all opeids in opeid1~opeid2~opeid3… format, but please note that really means, opeidmain~opeid2~opeid3 etc...

◦ Make sure the main one is rst and then input all other OPEIDs, understanding that the rst one on thelist has additional signicance.

Note:

• You are only able to upload a .zip le on the Conguration Administration page in the UI.

• DO NOT zip or compress a parent le containing the .csv and .groovy les because the le path to thegroovy les will be incorrect.

• Select all the les in the parent folder and zip/compress them without a parent directory.

• While there is a hierarchy associated with the group categories, the zip le containing the workbookscan include one or any combination of categories as the system sequences them automatically inhierarchical order during the load process.

Required Role PermissionsThe user must have a role with the following General Permission(s) through Roles Management in order to complete themanual processing steps listed below.

• Administration

• Conguration Administration

For more information see Set General Permissions Matrix .

Want to Review the Conguration Deployed to your Environment?If you want to review an exact copy of the latest conguration deployed to your environment you can downloadthe current conguration directly from the user interface on the Conguration Administration page. When you

18



http://www.oracle.com/pls/topic/lookup?ctx=cloud&id=SetGeneralPermissionsMatrix



Download Current Conguration a zip le containing every .csv and .groovy script that makes up your institution's latestconguration is downloaded to your local drive (based on your personal seings. It is also recommended that you pullthe latest conguration from the UI to make updates.

Note:

• If the conguration les change structure from one release to the next, the system automaticallyupdates the workbook structure to the latest when the user chooses to Download CurrentConguration.

• It’s important to look at updates to baseline conguration in the release notes. You may want toimplement the new conguration for your institution (i.e. newly available elds).

Load Conguration Processing Steps Load updated csv and groovy les through the user interface to update your institution’s conguration.

Log into the Student Financial Planning user interface.

1. Navigate to: Administration > System Management > Conguration Administration2. Download Current Conguration on the Conguration Administration screen of the UI.3. Unzip the downloaded .zip le4. Open the .csv le(s) you want to update.5. Update elds as needed.6. Format columns with Dates (i.e. YYYY-MM-DD) and/or CODE_NUMBERS (i.e. 3 Digits) as instructed in Things

to Know Before you Begin.7. Conrm columns that reference .groovy les have the correct le path.8. Save the .csv le according to CSV Naming Convention and File Structure.9. Open the .groovy le(s) you want to update.

10. Update the groovy script as needed.11. Save the .groovy le (le name and path need to match the .csv le).12. Select all updated .csv les and all folders that contain dependent groovy les.13. Compress/Zip Files (DO NOT zip the parent folder).14. Select Files to Upload or drag and drop the .zip le on the drop here box on the Conguration Administration

page of the UI.15. Submit the Files.16. Conrm you want to proceed and upload the conguration les.17. Review Load History for Errors and Successes.

a. If one le errors out none of the .csv or .groovy les are uploaded to the environment.18. View Details (Failed, Skipped, Successful).19. Correct any Errors (if applicable).20. Repeat steps 11-17 until the conguration is uploaded successfully.

The updated conguration should be deployed to your environment.

19



20


Chapter 3Integration

3 Integration

Integration Overview Integrations empower the exchange of information between two or more systems.

Integration messages contain information or the payload, which is being transmied between Student FinancialPlanning and at least one school system. Student Financial Planning uses XML for its integration payload. Any externalsystem may integrate with Student Financial Planning, as long as a consistent language is maintained; this language isdened in the XML Schema Denition (XSD) le(s). Student Financial Planning leverages its own integration messagesto communicate between the Student Portal and itself.

Messages are sent to and from Student Financial Planning through the Message Processing Gateway (MPG), whichcontains built-in error handling and message retry mechanisms to handle exception cases. Integration messages maybe sent in real-time or aggregated and sent in a batch at pre-determined intervals.

Integration Guiding Principles Student Financial Planning has a REST-Based Interface and uses two primary message types, event based andasynchronous.

Student Financial Planning Primary Message Types:

• Event-Based: Triggered at the time certain events occur

• Asynchronous Request/Reply: Triggered when a system makes a request for the information

Messages are Directional and are considered to be either Inbound or Outbound. Inbound messages are transmiedto Student Financial Planning from an external system. Outbound messages are created by Oracle Vocado StudentFinancial Planning Cloud Service and are intended to be consumed by an external system or the Student Portal.

Every message contains a Globally Unique Identier (GUID) in the MessageId content to identify it as a unique message.Each message is validated before the data in the message is persisted to database. If an invalid message is received, anerror is logged to the database and the message is discarded.

A message is considered invalid if:

• It does not match the XML schema.

• It has at least one eld that is not compliant with the business validation rule(s) specied for that eld.

XML Schema DenitionThe latest XSD les can be found in the API Update in the Release Notes. See Doc ID 2613016.1 on My Oracle Support.You may nd downloading the latest API assets benecial as you work through the implementation process.

21




Message Processing Gateway Messages and les from the institution and student are sent to the Message Processing Gateway (MPG) application.

Outbound event messages are pulled from the MPG in rst in rst out (FIFO) sequence. Once a message is pulled fromthe MPG, it disappears from the outbound queue.

Messages and les from the institution and/or student must be saved with an .xml extension, as they contain xmlpayloads.

Post a File to the MPGThis is an example using Mac OS X's built-in curl functionality. Any other web service integration tool you arecomfortable with may be leveraged (for example Postman), as long as the username, password, le, and web serviceendpoint is maintained.

Example Command

curl -kv -X POST -u 'user:password' --key fasapi https://sfp.ocs.oraclecloud.com/customer/mpg/channels/in.ev/publish -H 'Vocado-Message-Class: FasStudentInitiationEvent' -H "Content-Type: application/vocado-message+xml" --data-binary "@/Users/Username/Desktop/student/FasStudentInitiationEvent.xml" -H'Vocado-Message-Id: 11111111-1111-1111-1111-111111111111'

Pull a File from the MPGThis is an example using Mac OS X's built-in curl functionality. Any other web service integration tool you arecomfortable with may be leveraged (for example Postman), as long as the username, password, le, and web serviceendpoint is maintained.

Example Command to Pull a message based on it’s Message ID

curl -k -X POST -u user:password https://sfp.ocs.oraclecloud.com/mpg/info/store/messages?messageId=11111111-1111-1111-1111-111111111111

Example Command to Pull a message based on First-In-First-Out

curl -X POST -u user:password -H 'Accept: application/vocado-message+xml' https://sfp.ocs.oraclecloud.com/mpg/channels/out.ev/consume -H 'Vocado-Pull-Id:11111111-1111-1111-1111-111111111111'

Create unique Message-Ids using the Online GUID Generator.

Vocado U.S. Department of Education Gateway Messages and Files sent from the U.S. Department of Education via the Student Aid Internet Gateway (SAIG) are sent tothe Vocado U.S. Dept of Ed Gateway (VUG) application.

Institutional Student Information Reports (ISIRs) and National Student Loan Data System (NSLDS) nancial aidhistory information les are considered at les must be saved a .dat extension. Files from Common Originations andDisbursements (COD) are xml payloads and must be saved with a .xml extension.

22

https://curl.haxx.se/

https://www.getpostman.com/



https://www.guidgenerator.com/



Post an SAIG File to the VUGThis is an example using Mac OS X's built-in curl functionality. Any other web service integration tool you arecomfortable with may be leveraged (for example Postman), as long as the username, password, le, and web serviceendpoint is maintained.

curl -ki -X POST -u 'user:password' --key fasapi -F "file=@/Users/Username/Desktop/student/idap20op-a.dat" https://sfp.ocs.oraclecloud.com/customer/vug/in/publish

Pull an SAIG File from the VUGThis is an example using Mac OS X's built-in curl functionality. Any other web service integration tool you arecomfortable with may be leveraged (for example Postman), as long as the username, password, le, and web serviceendpoint is maintained.

curl -X POST -u user:password https://sfp.ocs.oraclecloud.com/vug/out/consume?limit=1

SAIG File Types: Naming ConventionsIt is imperative that during the testing and demo phases of implementation that mock SAIG les adhere to the namingconventions found in FSA Software and Manuals Message Class File Table: hps://ifap.ed.gov/ilibrary/document-types/saig-message-class-le.

File Name Direction Description

FAHEXTOP

Inbound

Financial Aid History File

IDAPXXOP

Inbound

Daily Electronic Application ISIRs

CRPNXXOP

Inbound

Master Promissory Note

CRECMYOP

Inbound

Entrance Counseling Response

Note: If the U.S. Department of Education makes changes to any of the record le layouts, Student FinancialPlanning is updated in order to support the new le layout.

Integration Messages There are over 160 integration messages that are part of Student Financial Planning Out-of-the-Box.

Delivered Integration Messages include messages sent to and received from the U.S. Department of Education (SAIG,CPS, NSLDS, and COD etc...) through the Vocado U.S Department of Education Gateway (VUG), Messages sent to andreceived from the Message Processing Gateway (MPG) between Student Financial Planning and the School and theStudent Portal.

23





https://ifap.ed.gov/ilibrary/document-types/saig-message-class-file




Core MessagesThere are a few core messages that institutions are required to create if they are not a current Campus Solutionscustomer.

Message Source Description Type Direction

FasStudentInitiationEvent

Contact RecordsManagement (CRM) Student InformationSystem (SIS)

Creates the Student Record.

Event

Inbound

FasSaSyncEvent

Student InformationSystem (SIS) Student Accounting System(SAS)

Contains informationrelated to the student’sacademic progress andnancial account. Referred to as the: StudentAcademic and FinancialInformation Message orSAFI Message.

Event

Inbound

FasStudentLoaAndBreaksInAendanceEventStudent InformationSystem (SIS)

Provides information aboutbreaks in aendance fromthe academic program.

Event

Inbound

FasDisbursementInformationEventStudent Accounting System(SAS) General Ledger (GL)

Updates the school’saccounting system andreconciles the systembased on the student’sgeneral ledger information.

Event & AsynchronousRequest/Reply

Outbound

FasReturnToLenderEvent Student Accounting System(SAS) General Ledger (GL)

Indicates there is a Title IVpayment due to the lenderfrom accounting.


Outbound

FasCreditBalanceInformationEventStudent Accounting System(SAS) General Ledger (GL)

Indicates a credit balanceexists so accounting canprovide money to thestudent.

Event

Outbound

FasSapAcademicInformationEventStudent InformationSystem (SIS)

Shares the student'ssatisfactory academicprogress data.


Outbound

24



Frequently Used Integration Tool(s) You may nd the following tools helpful during the integration process.

• Text Editor

• SAFI Builder

• Command Line Tool

• XML Validation Tool

• Application Event Error Report

Application Event Error Report

The Application Event Error Report helps you to troubleshoot message validation errors.

Integration of SAML 2.0 and SSO Student Financial Planning (SFP) uses SAML 2.0 SP-initiated SSO exchange to provide access (authentication andauthorization) for client users into the SFP System.

Access Student Financial Planning Via SSO and SAMLIf your faculty and sta are logging into other web-applications through your enabled SAML 2.0 Identity Provider,you already know the identity of these users, so it only makes sense to use this information to log them into theStudent Financial Planning Cloud Service. Security Assertion Markup Language (SAML) enables a Single Sign-On(SSO) exchange and provides your institutions users access (authentication and authorization) to the Student FinancialPlanning System.

Student Financial Planning uses the SAML 2.0 model where the Service Provider (SP) is dened as Student FinancialPlanning (SFP) and the Identity Provider (IDP) is dened as your Institution.

The Authentication Response SAML Assertion is sent by the IDP to the SP and contains necessary data about the userand the user authorization. The following aributes must be included in the SAML Assertion XML document:

• FirstName

• LastName

• EmailAddress

• Roles

Note: A unique identier (usually the user login) should be used for the NameID.

Access Student Portal Via SAML 2.0The Student Financial Planning Student Portal supports Security Assertion Markup Language (SAML) basedauthentication to the user interface.

25



To enable institutions to invoke Single Sign On (SSO) the Student Portal has a URL that can be exposed. When a useraempts to access the user interface, the user is redirected to the IDP system congured in Student Portal. The user isthen authenticated into the IDP and redirected to the Student Portal with the proper authorization. Users entering theSelf Service Ul via SAML, will not have to create separate SFP Self Service accounts, and will have access to all functionsbased on the role requested in their SAML assertion.

SAML assertion should contain these aributes, in addition to the (required) NameID:

• FirstName (required)

• LastName (required)

• EmailAddress (optional)

• PhoneNumber (optional)

• Student ID:◦ Role: Student and Parent (required)

◦ Role: Admin (optional)

• Roles (required): Value can be (one-of): Admin, Student, or Parent

SAML/SSO integration allows the student (or parent) to access the Student Financial Planning Student Portal in thecontext of the student. The student's prole screen populates based on the values received in the SAML assertionmessage. However, navigating to the portal via SSO does not automatically create a student portal account.

When external users access the Student Portal via SAML this user prole information is displayed upon successfulauthentication:

• First Name

• Last Name

• Student ID

• Email Address (if available)

Authentication ScenariosIn the authentication functional ow the Service Provider (SP) is dened as Student Financial Planning (SFP) and theIdentity Provider (IDP) is dened as your Institution.

There are three authentication scenarios users may encounter:

• No SP Session and No IDP Session

• No SP Session but a Valid IDP Session

• Valid SP Session

Login Scenario 1: No SP Session and No IDP Session

1. User tries to reach the Oracle application (SP).2. SP generates the SAML request (e.g. AuthnRequest).3. SP redirects the browser to the congured IDP URL.

a. Institution's Browser redirects the browser to the IDP URL.4. IDP authenticates user by presenting login form.5. IDP constructs SAML response.6. IDP returns SAML response to institution's browser.

26



a. Institution's browser sends SAML response to SFP.7. SFP Assertion Consumption Service (ACS) veries SAML response, auto provisions and auto syncs user & roles.8. User is logged into the SFP application.

27



Login Scenario 2: No SP Session but a Valid IDP Session

1. User tries to reach the Oracle application (SP).2. SP generates the SAML request (e.g. AuthnRequest).3. SP redirects the browser to the congured IDP URL.

a. Institution's Browser redirects the browser to the IDP URL.4. IDP identies a valid session.5. IDP constructs SAML response.6. IDP returns SAML response to institution's browser.

a. Institution's browser sends SAML response to SFP.7. SFP Assertion Consumption Service (ACS) veries SAML response, auto provisions and auto syncs user & roles.8. User is logged into the SFP application.

28



Login Scenario 3: Valid SP Session

1. User tries to reach the Oracle application (SP).2. SP identies a valid session.

29



3. User is logged into the SFP application.

30



Enable SSO-SAML 2.0Once your environment(s) have been provisioned and you are ready to setup Single Sign On you need to log a ServiceRequest (SR) for each environment (e.g. Test, Stage, Production) and request IT setup the Financial Aid System(FAS) authentication redirect message. Because each Identity Provider and Service Provider need to agree upon theconguration for SAML, both ends need to have the exact conguration for the SAML authentication to work. You mustalso aach the IDP Metadata XML document to each SR. You may use a dierent IDP for accessing the FAS than you usefor accessing Self Service.

Steps to Enable SSO-SAML 2.0

1. Ensure the target environment has been provisioned and is ready to use.2. Go to My Oracle Support and create an SR titled Enable SSO-SAML 2.0 (environment) for each provisioned

target environment.3. Include the IDP Metadata XML le (or link) in the SR.4. Include the IDP entityID (or link) in the SR5. Once Oracle Operations completes the SR, you will be able to download the SP/SFP metadata.6. Update the environment_name in the following non-production/production links to download the SP/SFP

metadata.a. Non-Production Link: hps://sfp.ocs.oc-test.com/environment_name/vm-ui/saml/metadatab. Production Link: hps://sfp.ocs.oraclecloud.com/environment_name/vm-ui/saml/metadata

Note: The IDP Metadata XML document is required for each environment as the aributes may be dierentfrom one environment to another.

Provisioning ScenariosFor users to be properly provisioned and synced, ideally the user and every role that can be mapped to a user shouldexist in Student Financial Planning System. But at a minimum, each role needs to exist to ensure unintended roles arenot assigned to a user. To learn more about user and/or roles management, see:

User Mangement

Create a New Role .

The following table provides common scenarios and their expected behaviors based on your school’s user and rolessetup in Student Financial Planning (SFP).

Scenario Expected Behavior

User and all roles that should be mappedto the user exist in SFP.

• User is retrieved from the SFP user record.

• User is mapped to appropriate roles in SFP.

• User aributes and user-role assignments are synced in SFP.

• User session is initiated with SFP.

User exists in SFP, but none or only someof the roles that should be mapped to theuser exist in SFP.

• User is retrieved from the SFP user record

• User is mapped to all existing roles in SFP.

• User aributes and user-role assignments are synced in SFP.

• User session is initiated with SFP.

31

https://support.oracle.com/

http://www.oracle.com/pls/topic/lookup?ctx=cloud&id=UserManagement

http://www.oracle.com/pls/topic/lookup?ctx=cloud&id=CreateANewRole



Scenario Expected Behavior

User does not exist SFP, but all roles thatshould be mapped to the user exist in SFP.

• User lookup by userId.

• User not found, but user record is created.

• User is mapped to the appropriate roles in SFP.

• User session is initiated.

User does not exist in SFP and none oronly some of the roles that should bemapped to the user exist in SFP.

• User lookup by userId.

• User not found, but user record is created.

• User is mapped to all existing roles in SFP.

• User session is initiated.

SAML assertion invalid/malformed.

• User is denied access.

• An integration error message is returned and displayed to the user.

Note:

• This use case does not support the use of Transient Identiers in NameId due to auto provisioningand syncing of the user.

• SFP Internal Users are managed under a dierent namespace than the SAML Provisioned Users.

Session and Session Logout ManagementWhen users are logged into Student Financial Planning they are in engaged in an active local application session.The local application session is invalidated upon a system logout. A logout is triggered either explicitly by the user orimplicitly by a session timeout. Based on your preferences, Student Financial Planning can be congured to invokeglobal session invalidation with the Client IDP.

Sample SAML XML MessagesSee SFP Sample SAML XML Documents in Oracle Student Financial Planning Cloud Service: Integration Management2514682.1 on My Oracle Support to download the following aachments:

• SAML_Roles_Aribute_Format.xml

• SAML_Sample_SP_Metadata.xml

• SAML_Sample_SP_AuthnRequest_Message.xml

• SAML_Sample_IDP_Response_Message.xml

Integration with Oracle PeopleSoft Campus Solutions Oracle PeopleSoft Campus Solutions (CS) customers can opt to integrate with the Oracle Vocado Student FinancialPlanning Cloud Service (SFP) as an alternative to using CS Financial Aid.

32




Student Financial Planning supports student nancial aid programs in the United States including Standard AcademicYear (SAY), Borrower Based Academic Year (BBAY), and Non-Term (NT) nancial aid, but can also be used globally.Student Financial Planning does not presently support nancial aid localizations for Great Britain or Canada.

The integration between CS and Student Financial Planning is an exchange of data in the form of sending and receivingintegration messages between the two systems.

SFP Receives Inbound Messages from CS

Event Message Inbound Message Description

Student Initiation Event

FasStudentInitiationEvent

Initiates a new Student Record in SFP withbiographical information from CS

The Student Academic and FinancialInformation (SAFI) Message

FasSaSyncEvent

CS provides SFP with Student Record data suchas Academic Program, Enrolled Classes, Grades, etc. and Student Financial data includingCharges and Student Resources

The Leaves of Absence and Breaks inAendance Event

FasStudentLoaAndBreaksInAendanceEvent

CS provides SFP with Student Records Leave ofAbsence information

SFP Sends Outbound Messages to CS

Event Message Outbound Message Description

The Disbursement Information Event

FasDisbursementInformationEvent

SFP sends disbursements to CS by populatingSF Group Data Entry for follow on Group Post

Return to Lender Event

FasReturnToLenderEvent

SFP sends CS information about disbursedpayments that have been reduced (triggeredfrom repackaging, R2T4, etc.). The transactionsupdate CS SF Group Data Entry for follow-onGroup Post.

CS to SFP Mapping FilesFor more information, see SFP Data Mapped to CS in Oracle Student Financial Planning Cloud Service: IntegrationManagement 2514682.1 on My Oracle Support.

Learn More About the Campus Solutions/Student Financial PlanningIntegrationSee the Integrating with Oracle Student Financial Planning Cloud Service chapter in the Campus CommunityFundamentals book.

Note: Check the box to “Expand all sections” and read each section carefully and review each link providedfor additional details.

33




Create New Student Self Service User Accounts via IntegrationUsing the User Creation API, you can create student user accounts in the Student Portal leveraging REST basedmessages. In addition to the Student Portal User Interface user create functionality, this API can be used to script bulkcreation of student portal users.

Complete these steps:

1. Set Up Connectivity and Authenticationa. Authenticate using an admin account username and password:

curl -v --cookie-jar ./cookie.txt https://admin-username:[email protected]/customerName/portal/fas

b. Perform an initial GET request to acquire an XSRFtoken:

curl -v --cookie ./cookie.txt --cookie-jar cookie.txt https://sfp.ocs.oc-test.com/customerName/portal/

Steps 1a and 1b are only needed once per session. These steps create connectivity data in cookie.txt (SESSIONand XSFR tokens) that is used to create one or more students repeating step 2.

2. Create a Student Usera. Create Student:

curl -v -k \

-H "Content-Type: application/json" \

-H "X-XSRF-TOKEN: 60d9e1ee-ba14-4a95-9a0d-5de007ce2c02" \

--cookie ./cookie.txt \

https://sfp.ocs.oc-test.com/customerName/portal/api/v1/students -d @- << EOF

{

"firstName": "Test0001",

"lastName": "Student",

"externalId": "0001"

}

EOFThe X-XSRF-TOKEN value in this command must be set from the cookies.txtgenerated during Step 1bof the session.# Netscape HTTP Cookie File#HpOnly_localhost FALSE /portal FALSE 0 JSESSIONID 92860D187E6B23D0E09802AE388A476Alocalhost FALSE /portal FALSE 0 XSRF-TOKEN 60d9e1ee-ba14-4a95-9a0d-5de007ce2c02

b. Create User for Student:

curl -v -k \

-H "Content-Type: application/json" \

-H "X-XSRF-TOKEN: 60d9e1ee-ba14-4a95-9a0d-5de007ce2c02" \

--cookie ./cookie.txt \

https://sfp.ocs.oc-test.com/customerName/portal/api/v1/users -d @- << EOF

34



{

"username": "test0001",

"password": "0001",

"firstName": "Test0001",

"lastName": "Student",

"email": "[email protected]",

"phone": "(800) 555-1212",

"externalId": "0001",

"student": "https://sfp.ocs.oc-test.com/customerName/portal/api/v1/students/100"

}

EOF

The X-XSRF-TOKEN value in this command must be set from the cookies.txtgenerated during Step 1bof the session.

# Netscape HTTP Cookie File

#HpOnly_localhost FALSE /portal FALSE 0 JSESSIONID 92860D187E6B23D0E09802AE388A476A

localhost FALSE /portal FALSE 0 XSRF-TOKEN 60d9e1ee-ba14-4a95-9a0d-5de007ce2c02

The student data element value is an unique url identifying the student and must be set from theLocation header of the HTTP response output of Step 2a execution.

< HTTP/1.1 201

...

< X-Frame-Options: SAMEORIGIN

< Last-Modied: Wed, 24 Oct 2018 19:05:40 GMT

< Location: hps://sfp.ocs.oc-test.com/customerName/portal/api/v1/students/100

Steps 2a and 2b can be repeated to create multiple students per session.

Additional NotesFor Production: hps://sfp.ocs.oraclecloud.com/customerName/portal/

For Test: hps://sfp.ocs.oc-test.com/customerName/portal/

Batch Jobs and TD Client Communications

35



OverviewStudent Financial Planning triggers Batch Jobs at scheduled times or based on specic events.

TD Client CommunicationThe following table provides details about the TD Client communication schedule.

Communication Description Production Schedule Non-Production Schedule

Inbound Downloads Files from the SAIGMailbox

Every Day, at the top of every otherodd hour

N/A

Outbound Uploads Files to the SAIG Mailbox Every Day, at the top of every otherodd hour

N/A

Batch Job ScheduleThe following table provides SFP batch job details. Batch jobs are based on the school's local time zone. If the school haslocations in multiple time zones, the time zone identied as the primary time zone is used.

Batch Job Description Production Schedule Non-Production Schedule Additional Information

Award Year Re-Opened forDisbursements

Checks to see if thereare disbursements thatneed to be communicatedto COD when awardyear is reopened afteradministrative relief.

Every Day at Midnight Every Day at Midnight Does this need to run morefrequently in Non-Prod, (i.e.Every 10 Minutes)?

Awarding Closeout Job This job runs each timethe system date equals theAwarding Closeout Date forthe fund type. The systemtriggers a re-packageand cancels all funds notawarded (fund status =projected/estimated) bythe Awarding CloseoutDate.

Every Day at Midnight Every Day at Midnight N/A

Awarding Eligibility Checks if a fund/fundpayment period has metawarding criteria. Whenawarding criteria is met, this job marks the fund/fund payment period asawardable.


COD Closeout Job Checks for disbursementsthat need to be set toOrigination/DisbursementPending Re-openedaward year when the CODCloseout Date is met.


36



COD Disbursement Request Create/Send CODCommon Record Files fordisbursements to VUG

Every 20 Minutes startingat the top of the hour


N/A

COD Origination Request Create/Send CODCommon Record Files fororiginations to VUG.

1st Minute of Every Hour Every 20 Minutes startingat the top of the hour

N/A

COD Reopen Job Checks for disbursementsthat require communicationto COD when the CODaward year is reopened dueto Administrative Relief.


Disbursement AcceptanceDeadline

This job is run to ensureSFP cancels all LateDisbursements or PWDsthat are not accepted bydisbursement acceptancedue date


Disbursing Eligibility (Disbursement CriteriaEvaluation)

Evaluate the disbursementcriteria for eachdisbursement where thescheduled anticipateddisbursement date as beenreached

Every Day at 12:05 AM Every 4 Hours In production this job isrun after midnight so thatany other batch jobs thatmight impact disbursementcriteria can run before thisjob runs. It is recommended torun once daily just afterMidnight to allow SFP tosend communication toCOD, receive the responseback from COD andthen send origination/disbursement data to theschool's accounting systemwithin the same 24 hourperiod.

Exit Counseling Follow-UpNotication

Send Exit CounselingFollow Up notications, if no exit counselingcompletion record has beenreceived

Every Day at Midnight Every 20 Minutes startingat the top of the hour

N/A

FAFSA New Award YearNotication

Triggers the FAFSAnotication for studentswho have a paymentperiod that crosses intoa new award year and anew award year FAFSA isrequired


Force R2T4 Calculation Forces an R2T4 Calculationfor any student that hasreached the conguredregulatory deadlinebased on the Date ofDetermination for theWithdrawal.

Every Day at 1:00 AM Every Day at 1:00 AM This should run after theResume Scheduled R2T4,Request R2T4 SAFI, and theValid ISIR Deadline batchjobs.

37



Fund Acceptance Deadline Checks to see if there arefunds that have not beenaccepted by the studentby the congured fundacceptance time frame, then cancels disbursementwith an expired FundAcceptance Deadline.

Every Day at 4:00 AM Every Day at 4:00 AM Run at an o time so it doesnot prevent or delay anyother processing.

Fund Closeout Date This job runs each timethe system date equals theFund Closeout Date for thefund type and checks forpending disbursementsand cancels non-disburseddisbursements uponmeeting the AwardingCloseout Date.


Grant Overpayment ReviewNotication

Triggers a task for manualreview for any GrantOverpayment that isoverdue.

Every Day at 12:05 AM Every 20 Minutes startingat the top of the hour

This triggers the task theday the Grant Overpaymentbecomes overdue andbecause it runs just afterMidnight.

ISIR Corrections Award YearClose Out

Closes any pendingISIR processes for theaward year upon the ISIRcorrections end date.

Every 4 Hours Every 4 Hours N/A

Match Financial Aid HistoryFiles

Match NSLDS FinancialAid History extract le tostudent records.


Process ISIRs for NewAward Year

Matches any ISIRs thatwere received prior to theaward year start date tostudent records to beginprocessing.

Every Day at 2:30 AM Every 20 Minutes startingat the top of the hour

In Production this onlyhappens once a year, butthe job runs one timeeach day. Because thismay result in a lot of dataprocessing, the job runswhen processing is low.

Recalculating the Numberof Credits and InstructionalWeeks Completed

Calculates the number ofinstructional weeks andcredits the student hascompleted for non-termprograms.


Request R2T4 SAFI Requests the R2T4 SAFIwhen the R2T4 SAFIRequest Deadline isreached, in order to processthe R2T4 calculation

Every Day at Midnight Update to Run every 20Minutes starting at 10 after

This job needs to runbefore the ResumeScheduled R2T4Calculation.

Resume Scheduled R2T4Calculation

Resumes any scheduledR2T4 calculation when thescheduled date is reached.

Every Day at 11:00 PM Update to Run every 20Minutes starting at 5 after

This job is set to occurone hour prior to theDisbursing Eligibility jobin order to allow Returnto Title IV calculationstime to complete beforeDisbursement Criteria isevaluated. This job should run afterthe Request R2T4 SAFI.

38



TEACH SequestrationUpdate

Checks if TEACH sequesterrepackages have beenscheduled and triggers thethem based on the defaultbatch size, (e.g. 1000).The remaining scheduledrepackages are held andred in future executions ofthis job.



N/A

Trigger Leer Event This job creates and sendsthe appropriate leers thathave been triggered for thestudent.

Every Day at 11:45 PM Every 20 Minutes startingat the top of the hour

In a productionenvironment it isrecommended to run thisjob at the end of the dayprior to midnight in order tocapture all events for thatdate and generate leersthat are dated with thesame date as the triggeringevent(s).

Update Loan Fees Job that will check ona daily basis if loan feepercentage or interestrebate is changing for thatday.


Valid ISIR Deadline Run the valid ISIR deadlineprocess, and evaluateany disbursements thathave met the conguredValid ISIR Deadline, andupdate any ineligibledisbursements to canceled.


Send Batch Inform/Financial Aid HistoryRequest File - 2013

Creates and Sends theBatch Inform/Financial AidHistory Request File forspecic Award Year.

Every 20 Minutes startingon the 19th Minute of everyhour


NSLDS Request Batch Jobsare triggered at dierenttimes to prevent the systemfrom canceling a job fora dierent award year, because the batch job hasalready been triggered.















NSLDS Request Batch Jobsare triggered at dierenttimes to prevent the systemfrom canceling a job fora dierent award year,

39



because the batch job hasalready been triggered.








Every 20 Minutes startingat 10 minutes after the hour

Every 20 Minutes startingat 10 minutes after the hour












Send ISIR Correction Files -2016

Creates and Sends the ISIRCorrection Export Recordfor a specic Award Year.



N/A





N/A





N/A





NA





N/A

Cancellation Process Every Day at Midnight Every Day at Midnight N/A

Request New Batch Job ScheduleTo request an update to an existing Batch Job, please log a Service Request through My Oracle Support.

1. Submit a Service Request on My Oracle Support at hps://support.oracle.com2. Provide the following information:

40

https://support.oracle.com/



a. Environment Type (Production/Non-Production)b. Environment URLc. Batch Jobd. Schedule Details

1. If the batch job needs to run at a specic time, provide the time including am or pm and time zone, (e.g. EveryDay at 6:00 AM PST, Every Day at MIDNIGHT PST)

2. If the batch job needs to run based intervals, make sure to include how often the job needs to run, (e.g. EveryHour, Run every 20 minutes; Starting on the 10th minute each hour)

3. If the batch job needs to run based on some other criteria please be specic, (e.g. Every Monday at 9:00 AMPST, The last Friday of each Month at 4:00 AM PST).

Note: Oracle has the right to deny any request if it impacts the stability of the environment.

Related ReportsThe following reports provide details related to the batch jobs available in your environment.

• The Batch Job Schedule Report pulls the environment's current Batch Job Schedule.

• The Batch Job Execution Report shows the status of Batch Jobs within the specied hour interval. Possiblestatuses are Started, Completed, Abandoned (job exceeded duration threshold), or Failed.

Frequently Asked Integration Questions The following are a few questions frequently asked about integration.

Q: Can we request NSLDS le from U.S. Department of Education from a Test SFP system?

A: No, the test environment does not communicate with the U.S. Department of Education via the SAIG mailbox.

Q: What is the web service end point for VUG where the SAIG les would be loaded into?

A: The test SAIG le repository URL is hps://sfp.ocs.oc-test.com/customer-test/vug

Q: What are the commands to Post SAIG (i.e. ISIR, NSLDS, COD) les and les from the institution or student?

A: An example curl command that demonstrates how to load les into the SAIG le repository can be found here:Vocado U.S. Department of Education Gateway. An example curl command that demonstrates how to load les intoMPG application can be found here:Message Processing Gateway. If you need the credentials, contact your serviceadministrator.

Q: How many consumers can we connect to the MPG?

A: You can connect multiple consumers, but please note messages are pulled from the MPG in rst in rst out sequenceand once a message is pulled from the MPG it disappears from the outbound queue. Therefore, for consistency, werecommend connecting only one consumer for event-based outbound messages.

41



42


Chapter 4Conversion

4 Conversion

Overview of Data Conversion The U.S. Department of Education (ED) rigidly denes the exchange requirements for Financial Aid data. This enablesOracle Vocado Student Financial Planning Cloud Service (SFP) to use a delivered standardized set of code to quicklymigrate data to SFP, rather than requiring custom code for each school.

Oracle is focused on ensuring nancial aid continuity for all students migrating from a legacy system to Oracle VocadoSFP Cloud Service.

Data conversion typically has a four phase lifecycle, exploration, planning, testing, and execution.

• Exploration: Review data requirements, foster understanding of data sources, and devise conversion strategy tominimize custom development for extracting data from legacy system(s).

• Planning: Establish cut-over plan and method; devise and rene strategy and time line for development,testing, and execution with consideration for student lifecycle and institutional requirements (e.g. academicterms and end-of-life support for legacy system(s)).

• Testing: Perform testing and end-to-end dress rehearsals iterations to gain condence in the data conversionprocess.

• Execution: Migrate students to SFP in accordance to the cut-over plan.

Conversion Methods Student Financial Planning can support converting students at the beginning of a new academic year.

Academic Year ConversionsConvert students to Student Financial Planning at the beginning of a new academic year to minimize the need forlegacy data extraction. This method does not Require disbursement or award data from the legacy system, simplifyingthe legacy extraction process. However, depending on student lifecycles, this method may take longer to migrate allstudents from the legacy system to Student Financial Planning.

Big Bang Conversions“Big Bang” conversions are a type of Academic Year conversion where all students are migrated from the school’slegacy system to SFP at one time. Using this method of conversion depends on timing, institutional requirements, andcustomer preference. This method works beer for schools with traditional semester-based calendars.

43


Chapter 4Conversion

Components of Data Conversion The tables below illustrate the le type it's associated naming convention, a description of the le, and the conversionmethod that could be used for the le type.

SAIG Pre-Load ProcessIn order to continue student nancial aid, legacy data from ED may be required.

Since SFP acts as the SAIG intermediary for an institution upon go-live, the conversion tool suite has a mechanism toload historical SAIG prior to go-live to maintain nancial aid continuity for all students, even if the students are notimmediately cutover to the system.

At the time of cutover, students are reunited with their appropriate and holistic set of Student Aid Internet Gateway(SAIG) data necessary to seamlessly continue nancial aid, whether the data was received prior to go-live or during thepilot phase.

SAIG File Types and Naming Convention

File Type Naming Convention

Institutional Student Information Record(ISIR)

idsaXXop-UUID.yyy

Financial Aid History (FAH)

fahextop-UUID.yyy

Common Origination and Disbursement(COD) File Types are: crpn, crec, crsp, crcs, crco, crac, crat, crib

<File Type>XXop-UUID.yyy

Where:

• “XX” is the last two digits of the Award Year; except for COD File Type crec which is not Award Year-striped, butalways crecmy-UUID.yyy.

• UUID is the SFP-generated Universally Unique Identier (UUID).

• “yyy” is initially “dat”, and then a sequence of numbers: “001”, “002”, “003”and so on.

For le name descriptions, see hps://ifap.ed.gov/ilibrary/document-types/saig-message-class-le.

44



Chapter 4Conversion

Executing Conversion In SFP, data is converted by sending the relevant payloads to the applicable web service interfaces: the MessageProcessing Gateway (MPG) and the Vocado USDE Gateway (VUG).

Conversion is conducted in iterative steps starting with the institution identifying the location and type of legacydata that needs to be migrated to SFP and ends with Oracle validating the data migrated to SFP successfully. Uponcompletion of the last step, the SFP support team transitions maintenance and further execution of conversion to theinstitution's support resources.

Executing conversion includes the following steps:

• Identify Conversion Data

• Cleanse Legacy Data

• Extract Legacy Data

• Validate Legacy Data

• Transform Legacy Data

• Load Legacy Data into SFP

Identify Conversion DataOracle is focused on ensuring nancial aid continuity for all students migrating from a legacy system to SFP rather thanpersistence of historical student data.

As a best practice, it is recommended to only convert data necessary to continue a student's going-forward nancial aid,without converting historical academic years for two reasons:

• Once nancial aid is established for a prior academic year in the legacy system, it is generally unadvisable forSFP to aempt to re-state historical packages, disbursements, or returns.

• Not having the data in SFP inherently prevents accidental user errors in editing historical data.

Instead of converting historical data to SFP, it is recommended that historical data be exposed by means of a datawarehouse solution, reporting engine, and so on in order to make the information available to users or auditors whennecessary. As a byproduct, the implementation process is typically shorter and less costly.

Note: SFP does not support Financial Aid Award Years prior to 2012-2013. Although it is possible from atechnology perspective to bring over all historical data, the level of eort and cost may be prohibitive to buildthe tools required to do so. Therefore, as a rule, it is recommended to focus on nancial aid continuity ratherthan history, especially because closed out award years should be read-only.

Cleanse Legacy DataThe school should make every eort to detect and correct corrupt or inaccurate records from a record set, table, ordatabase. If the school identies incomplete, incorrect, inaccurate or irrelevant parts of the data they should replace,modify, or delete that data prior to the execution of converting it to SFP.

45


Chapter 4Conversion

Extract Legacy DataTo lessen the burden on the institution and/or implementer as it relates to data extraction and data cleansing, SFP'sstandard data conversion tools leverage as much data directly from the U.S. Department of Education as possible suchas ISIR rebuild les and NSLDS Financial Aid History.

For a Campus Solutions (CS) installations, SFP can convert all data (in most common scenarios) without requiring anycustom data extraction. All data comes directly from the ED's Electronic Data Exchange (EDE) Systems or through adelivered interface between CS and SFP.

For a non-CS installations, SFP's standard data conversion tools leverage as much data directly from ED as possible.This includes Institutional Student Information Report (ISIR) rebuild les from the Central Processing System (CPS),Common Origination and Disbursement (COD) rebuild les, Pell Year-to-Date les, Master Promissory Notes (MPNs),Credit Decision les from COD, and Financial Aid History les from the National Student Loan Data System (NSLDS).Furthermore, the conversion tools also aempt to leverage as much integration XML payloads as possible, including thestandard Student Initiation, LOA and Breaks in Aendance, and SAP Information event messages.

Load DataLoading data to SFP entails sending relevant payloads to the applicable web service interface: the Message ProcessingGateway (MPG) or the Vocado USDE Gateway (VUG).

Frequently Asked Conversion Questions The following are a few questions frequently asked about Data Conversion

Q: Can we convert student aid for prior years?

A:For federal funding, SFP automatically leverages a student’s NSLDS Financial Aid History, which is a completehistorical view of the student’s federal funding. For non-federal funds, this decision can be made at time ofimplementation; the system can support as many historical years as there is historical non-federal data. However,please see Identify Conversion Data for additional information regarding historical nancial aid information.

Q: How does SFP handle continuing the Pell disbursement numbering from existing disbursements in the Pell awardyear?

A: SFP's message API includes a historical fund information message, allowing SFP to be informed of Pelldisbursements from the prior academic year in situations where the same award year crosses over two academicyears. This message may be leveraged during the data conversion process to ensure SFP is able to seamlessly continuenancial aid processing post-conversion.

46


Chapter 5Reports

5 Reports

Overview of Reports Vocado Student Financial Planning includes a exible leers & reports engine leveraging TIBCO’s Jaspersoft BusinessIntelligence platform.

Out of the box, Vocado Student Financial Planning provides a set of Financial Aid-mandated product reports(e.g. FISAP) and Leers templates (e.g. Award Leer). As a part of the Leers & Reports services, the VocadoStudent Financial Planning support team works with the University to dene additional leers & reports for studentcommunications and university business analytics. The Vocado Student Financial Planning support team providesvisuals for how leers appear to students through the student portal, and how to develop leers & reports on theJaspersoft platform. Oracle Student Financial Planning’s Leers & Reports services begin with identifying the leersand reports needed and concludes with a transition of maintenance of core and customized Leers & Report to theUniversity’s support resources.

Review Best Practices Before Geing Started1. If you haven't already done so, save your source les. Oracle strongly recommends that you save your revisions

frequently and implement some form of versioning via naming convention or folders, so you have the option toget back to a known version of your report or leer.

a. Click File from the menu bar.b. Click Save, a window will pop up.c. You will see a directory tree in the pop up window. Select the folder you want to save the jrxml in.d. If you want to change the le name, you can do so by typing the name in the box next to the word "File

Name". Be sure that the le name ends with the .jrxml le extension.e. Click Ok.

After you initially save your le in a specic folder, doing steps a and b automatically saves the le in thefolder you originally specied. If you want to save your le in a dierent directory, repeat steps a to e, butin step b click "Save as" instead of "Save".

2. When you write a query you need to qualify the schema owner (e.g. VM) so that the database knows where thetable (e.g. FAS_STUDENT) is.

◦ For example: VM.FAS_STUDENT where VM is the schemaOwner and FAS_STUDENT is the tableName,(e.g. schemaOwner.tableName).

Geing Started: Reports In order to work with Student Financial Planning Reports your school's implementer will need to download JaspersoftStudio v6.2.0.

There are later versions of Jaspersoft Studio, but Oracle cannot guarantee that later versions are compatible with theJasper Server used by Oracle.

47


Chapter 5Reports

Connect to the JasperServer Connect Jaspersoft Studio servers associated with your institution.

You should create a JasperReports Server Connections for each type of environment associated with your school suchas, Test, Dev, and Production.

Server Prole Wizard Use the Server Prole Wizard to create connections to the server(s) in Jaspersoft Studio.

1. Download Jaspersoft Studio v6.2.0.a. To download Jaspersoft Studion v6.2.0 visit: hps://sourceforge.net/projects/jasperstudio/les/

JaspersoftStudio-6.2.0/2. Open the Jaspersoft Studio.3. Click on Repository Explorer Tab.4. Select item Server and right click on it to select Create JasperReports Server Connection.

a. You will need the Oracle Cloud Welcome e-mail you received from an Oracle Support.5. Fill out the following elds of Server Prole Wizard.

a. Name: Test CustomerName Jasperserver.b. URL: URL provided in the Oracle Cloud Welcome e-mail (hps://sfp.ocs.oc-test.com/CustomerName-

test/jasperserver).c. Organization: Optional.d. User: User name provided in the Oracle Cloud Welcome e-mail.e. Password: Password provided in the Oracle Cloud Welcome e-mail. Click Test Connection.

6. Click Test Connection.a. If the connection is not successful double check input elds from Step 5.

7. Repeat Steps 5 - 7 for each environment type (Test, Dev, Production).

Upon completing this step you should be connected to one or multiple servers and see the connections in theRepository Explorer Tab.Additional Resources:

• Working with Database JDBC Connections

• Creating and Editing Data Adapters

Create Reports When creating reports it is recommended to create new or updated reports in a Non-Production environment beforepromoting them to a Production environment. It is also suggested that you save your work frequently.

48

https://sourceforge.net/projects/jasperstudio/files/JaspersoftStudio-6.2.0/

https://sourceforge.net/projects/jasperstudio/files/JaspersoftStudio-6.2.0/

https://community.jaspersoft.com/documentation/tibco-jaspersoft-studio-user-guide/v630/working-database-jdbc-connections

https://community.jaspersoft.com/documentation/tibco-jaspersoft-studio-user-guide/v630/creating-and-editing-data-adapters


Chapter 5Reports

New Report Wizard Create a new reporting using the New Report Wizard.

1. Open Jasersoft Studio.2. From the File menu, click New, and select Jasper Report to open the New Report Wizard.3. Choose a category/template such as All/Blank Leer Landscape.4. Click Next.5. Enter or select the parent folder: (i.e. My Reports).6. Enter a File Name (i.e. FileName.jrxml).7. Select a Data Adapter.

a. Choose One Empty Record - Empty Rows.8. Click Next.9. When the Congratulations message is returned, click Finish.

Upon completion of this step a new report is created.

Data Set and Query Editor Create reports based on queries built by your institution to meet your schools specic needs

1. Click on the Data Set and Query editor dialog icon.a. Icon found in Main Report tool bar, use the mouse to hover over icons to view tool description.

2. Copy and Paste a Query into the dialog box of the Query tab.

SELECT fs.EXTERNAL_STUDENT_ID , p.LAST_NAME , p.FIRST_NAME , p.DATE_OF_BIRTHFROM VM.FAS_STUDENT fs JOIN VM.PERSON p on fs.PERSON_ID = p.PERSON_ID

3. In the Fields Tab, Click Add.4. The Field Name defaults to Field_# and the Class Type defaults to java.lang.String.5. Update the Field Name and Class Type.6. Repeat for each Field Name required based on your query.7. For Example (based on sample query above):

a. EXTERNAL_STUDENT_ID, Stringb. LAST_NAME, Stringc. FIRST_NAME, Stringd. DATE_OF_BIRTH, Date

8. Click Ok.

Upon completion of this step, your report is built and formaed based on the entered query and layout preferences.

Note: You cannot use the "Preview" function in Jaspersoft Studio. In order to test the query, publish the reportto the JasperReports Server on your Oracle Student Financial Planning Cloud Service test or developmentinstance using the Report Publishing Wizard.

49


Chapter 5Reports

Document Outline View Format new reports by dragging and dropping data from the Outline Tab into the Main Report window.

Outline Tab1. Click on the Fields node in the Outline Tab.2. Conrm the Fields you created while using the Data Set and Query Editor are listed as children under the Fields

node.3. Highlight the Fields and drag and drop them into the in the Details section of the Main Report Window.4. Format as desired.

For more information on formaing reports in Jaspersoft, see hps://community.jaspersoft.com/documentation/tibco-jaspersoft-studio-user-guide/v62/geing-started-jaspersoft-studio.

5. Navigate to: File > Save or Save As.6. Save to the folder of your choice (i.e. MyReports).7. Click Ok.


Leverage an Existing Product Report You can leverage an existing Product Report if you do not want to create a report from scratch. If you do so, it is veryimportant to rename the report even though you are saving it to a separate repository.

1. Open Jaspersoft Studio.2. Navigate to: Server > Reports > Product Reports > Report you want to leverage.3. Click on the main.jrxml le.4. Navigate to: File Menu > Save As.5. Save to the folder of your choice (i.e. MyReports).6. Use the Data Set and Query Editor as needed.7. Format as desired.

For more information on formaing reports in Jaspersoft Studio, see hps://community.jaspersoft.com/documentation/tibco-jaspersoft-studio-user-guide/v62/geing-started-jaspersoft-studio.

8. Navigate to: File > Save or Save As.9. Click Ok.

Note: At any point, if a pop-out window is displayed and asks you if you want to publish to the Jasperserver,click no! By clicking yes, the system makes assumptions that may not return desired results.


50

https://community.jaspersoft.com/documentation/tibco-jaspersoft-studio-user-guide/v62/getting-started-jaspersoft-studio





Chapter 5Reports

Upload Reports By completing these steps you will be able to view and execute reports you create in the Jaspersoft Web Server.

To access your reports in the Jaspersoft Web Server, navigate to the user interface using the URL provided to you in theOracle Cloud Welcome e-mail.

Report Publishing Wizard — Non-Production Environment Oracle recommends completing the rst iteration and each draft iteration in a Non-Production environment. Reportnames should always be unique. If you leverage a product report, make sure to save the report in the Custom Reportsfolder with an updated, unique le name.

1. Open Jaspersoft Studio.2. Navigate to: Menu Bar > Project > Publish the le on JasperReports Server.

Alternate option: click on the Publish Report to JasperReports Server Icon in the Main Report tool bar (icon is tothe left of the Seings options).

3. Click on the arrow of the server you created for the target environment (Oracle recommends completing therst iteration in a Non-Production environment).

4. Navigate to: Reports > Custom Reports.5. Select the Create Report Unit check box.6. Enter a Report Unit Label.

a. Displayed in the Jaspersoft UI.7. Enter a Unit Name (ID).8. Optional Step: Enter Unit Description.

a. Displayed in the Jaspersoft UI.b. Character Limit (250).

9. Click Next.10. Input Controls (If your report does not include any Input Controls, skip this step).

a. Select Resources to Publish (Input Controls).b. Overwrite, on the initial publication, if you do not overwrite, this Resource will not be published (i.e.

Parameters).c. Ignore, on subsequent publications, if you do not want to make any change to the Input Control.

11. Congure the Data Source: Select the Data Source from Repository radio buon.12. Click on the ellipsis.

a. Click on the Data Sources le.b. Choose the Data Source, (VMDatabase for a report or VMLeers for a leer).c. Click Finish.

13. Click Finish.14. Click Ok on the Success message dialog box.

a. If you do not get a success message, double check previous steps, connectivity issues, or make sure youhave the appropriate permissions to publish to the selected directory.

51


Chapter 5Reports

Execute Reports Run and review new or existing report results in the Reports Web Server.

Login to the Reports URL for the target environment. The URL is provided to your school in the Oracle Cloud Welcom e-mail and contains your user name and password credentials in addition to the URL.

JasperServer You can execute or run reports in the JasperServer once they have been successfully uploaded to a target environment.

1. Navigate to the Reports URL for the target environment.Provided in your Cloud Welcome e-mail

2. Enter your User ID.Provided in your Cloud Welcome e-mail

3. Enter your Password.Provided in your Cloud Welcome e-mail

4. Click Login.5. Navigate to: Root > Reports > Custom Reports.6. Click on the newly created report name.7. If your report does not include Input Controls, skip this step.

a. Enter Valid Values for Input Controls (i.e. Parameters).b. Click Apply - Report runs and dialog box remains.c. Click Ok - Report runs and dialog box disappears.

8. Validate the returned results in the report contain the expected output.

Report should run successfully and return results based on the provided query.

Update Where the Input Controls are Displayed in a Report Initially when you create a report, the Input Controls are displayed in a pop-out dialog window. You can leave this setupif you prefer it, but there are other options available.

1. Navigate to: Reports URL > Root > Reports > Custom Reports > Select the report you want to update.2. Right click on the selected report.3. Click Edit.4. Click on Controls & Resources (left side bar).5. Select Display Mode.

◦ Pop-up window (default).

◦ Separate page.

◦ Top of page (Format used to create Product Reports provided by Oracle).

◦ In page.

6. Click Submit.7. Execute the Report to validate the update persisted.

52


Chapter 5Reports

The Input Controls are displayed based on the Display Mode you choose.For Example, if you choose the default, Pop-up window, they will pop up when the report is run. However, if you chooseTop of page, they are displayed at the top of the page when you run the report and do not cover up the report resultswhen the report is executed.

Update the Logo You can update the logo that is displayed on every report in your school’s instance. The logo is saved in the Imagesdirectory.

1. Login to the Jaspersever using the Reports URL provided in your Cloud Welcome e-mail.2. Login using the credentials provided in your Cloud Welcome email.3. Navigate to: Root > Images > Logo.4. Right Click on Logo.5. Click Edit.6. Choose File under the Path to File (required).7. Click Open/Save.8. Update the Name to: Logo.

This step is very important. The logic calls on the image name Logo. If it is titled anything other than Logo, thedisplay will not be accurate.Do not include the le extension (i.e. .png).

9. Click Submit.You can use any image type that is acceptable by an internet browser, but it is recommended to use a highresolution png image with an alpha (transparent) background.

Promote Reports to Production Once you have completed all report iterations and veried the report is ready to promote to production, you will selectles you saved on your local drive and repeat the steps to Upload Reports, but select the production server instead ofthe test server.

Report Publishing Wizard1. Open Jaspersoft Studio.2. Navigate to: Menu Bar > Project > Publish the le on JasperReports Server.

Alternate option: click on the Publish Report to JasperReports Server Icon in the Main Report tool bar (icon is tothe left of the Seings options).

3. Click on the arrow of the server you created for the Production environment.4. Navigate to: Reports > Custom Reports.5. Select the Create Report Unit check box.6. Enter a Report Unit Label.

a. Displayed in the Jaspersoft UI.7. Enter a Unit Name (ID).8. Optional Step: Enter Unit Description.

53


Chapter 5Reports

a. Displayed in the Jaspersoft UI.b. Character Limit (250).

9. Click Next.10. Input Controls (If your report does not include any Input Controls, skip this step).

a. Select Resources to Publish (Input Controls).b. Overwrite, on the initial publication, if you do not overwrite, this Resource will not be published (i.e.

Parameters).c. Ignore, on subsequent publications, if you do not want to make any change to the Input Control.

11. Congure the Data Source: Select the Data Source from Repository radio buon.12. Click on the ellipsis.

a. Click on the Data Sources le.b. Choose the Data Source, (VMDatabase for a report or VMLeers for a leer).c. Click Finish.

13. Click Finish.14. Click Ok on the Success message dialog box.

a. If you do not get a success message, double check previous steps, connectivity issues, or make sure youhave the appropriate permissions to publish to the selected directory.

Report names should always be unique. If you leverage a product report, make sure to save the report in theCustom Reports folder with an updated, unique le name.

Upon completion of these steps, you should see the new report in the Production Reports Web Server.

Report Folder Hierarchy

This table outlines the Report Folder Hierarchy.

Level 0 Level 1 Level 2 Level 3 Client Perm Desc Notes

Root N/A N/A N/A N/A N/A N/A

N/A Reports N/A N/A N/A N/A N/A

N/A N/A Custom Reports N/A RWD Reports created byschools.

N/A

N/A N/A Leers N/A RWD N/A WARNING: Foldermust not bealtered or theintegration withSFP will break.

N/A N/A Product Reports N/A R N/A N/A

N/A N/A N/A SAIG Management R Out-of-the-Box Reportsassociated withSAIG Processing

N/A

N/A N/A N/A Regulatory Reports R Out-of-the-BoxReports associatedwith regulationsand requirements

N/A

54


Chapter 5Reports

N/A N/A N/A Executive Reports R Out-of-the-BoxReports associatedwith executive leveldecision making(i.e. Cash Flowreports)

N/A

N/A N/A N/A MonitoringReports

R Out-of-the-BoxReports associatedwith system health

N/A

N/A N/A N/A ProductOperationalReports

R Out-of-the-BoxReports associatedwith day to dayoperations

N/A

N/A N/A Sample Leers N/A R Out-of-the-BoxReports associatedwith Leers

This folder willbe updated eachversion withany new leertemplates that areadded or updated

55


Chapter 5Reports

56


Chapter 6Leers

6 Leers

Overview of Leers Communication Leers Management is how Student Financial Planning engages in correspondence with student’s and the U.S.Department of Education.

When an event occurs within Student Financial Planning, it triggers a leer communication. Leer communicationis sent outbound from Student Financial Planning and is intended to be consumed by an external system. From theexternal system, maintained by the school, the leer communication can be turned into an email, text message, pdf orother format to be sent to the student.

The following are just a few examples:

• Award Leer

• Right To Cancel Leer

• Late Disbursement Acceptance Leer

• Exit Counseling Leer

• Professional Judgement Decision Leer

Leer Process There is a distinct order of events that must occur to trigger and generate leer communications.

A triggering action within Student Financial Planning occurs such as the student’s fund status updating to Awarded ormaybe an enrollment status changes to Withdrawn. These triggering actions result in the initiation of an integrationevent message which are the driving force behind leers being created and sent out of Student Financial Planning.Integration events can be associated to a specic leer template using conguration. In the Leers congurationworkbook you can review the relationship between the integration event message and the leer template that residesin the reporting engine. An integration event message can trigger multiple leers from a single leer template, but thatconnection is managed through conguration. The generation of Leers can be in real-time, congured to a specictime interval or generated at-will by user.

To view conguration updates view the Product Release Notes: Doc ID 2613016.1 on My Oracle Support. Select the latestrelease version. You can download conguration workbooks from any available release and from the user interface ifyour role has the Administration and Load Conguration permission.

Leer Templates There are Out-of-the-Box (OTB) leer templates that contain lorem Ipsum text and dynamic elds that are populated bysimple queries.

57



Chapter 6Leers

The schools' business or regulatory oce should provide the leer text/verbiage. The implementer or school's technicalsupport team maybe called upon to create simple queries to populate the dynamic elds within the leer templates.

Out-of-the-Box Leers There are 10 Out-of-the-Box Leers.

These leers are generated in-process and can be printed by a user from the Student Financial Planning user interface.

Leer Code Description Template Name Triggering Event

110

Verication Leer

FasValidIsirProcessStatusInformationReport

FasValidIsirProcessStatusInformationEvent

200

Exit Interview

FasStudentNoticationReport

FasStudentNoticationEvent

310

Right to Cancel Leer

FasDisbursementInformationReport

FasDisbursementInformationEvent

325

Late DisbursementNotication

FasDisbursementAcceptanceInformationReport

FasDisbursementAcceptanceInformationEvent

520

Cancellation FA Notication

FasDisbursementCancelReport

FasDisbursementCancelEvent

610

SAP RG Notication Leer

FasSapAcademicInformationReport

FasSapAcademicInformationEvent

620

SAP FA Warning Leer



625

SAP FA DisqualicationLeer



725

Post Withdrawal Notication

FasDisbursementAcceptanceInformationReport

FasDisbursementAcceptanceInformationEvent

FN1

Award Leer

FasStudentAwardInformationReport

FasStudentAwardInformationEvent

Leer Batch Jobs Student Financial Planning prevents duplicate leers by leveraging a congured delay and a scheduled batch job.

To prevent duplicate leers being sent to the student Student Financial Planning utilizes a batch job and a congurabledelay between the rst triggering action and the moment the batch job runs. For example, let’s assume the leer has a

58


Chapter 6Leers

congured delay of one minute and the Leers batch job is scheduled to run at 11:45 PM. The triggering actions occur atthe noted times and the Leers Batch Job runs at 11:45 PM.

• 5:00:00 pm

• 5:00:30 pm

• 6:30:45 pm

• 9:20:15 pm

The system adds one minute to the creation time of the 1st Leer (5:00:00 PM + 1 minute) and checks if the calculatedtime (5:01:00 PM) is less than or equal to 11:45:00 PM. If true, the 1st Leer is considered obsolete and the systemproceeds to evaluate the next triggering action 5:00:30 pm, then 6:30:45pm and so on. If false, the system does notgenerate the leer for the student.

When the Leers batch job runs:

• The parameter values provided by the latest triggering event, along with the data it persists to the database, areused to populate its corresponding Leer.

• All Leers with a congured delay are generated and published to the Student Financial Planning user interface.

The leers batch job can be scheduled to run once or multiple times per day. The delay can be congured in minutes inthe Leers Conguration Workbook. Leers that do not have a congured delay are generated in real-time. Authorizedusers can manually trigger the Leers Batch Job as needed.

At-Will (Ad Hoc) Leers Authorized users can generate leers at-will from the JasperReports Server WebUI.

At-Will Leers can only be generated from the JasperReports Server WebUI. There is nowhere in the Student FinancialPlanning user interface to generate a leer at-will. At-Will Leers can be generated from leer templates that are nottied to specic Integration Events. In order to generate leers At-Will, you must provide the parameter values that havebeen persisted in the Student Financial Planning systems database. Failure to do so may result in an inaccurate orempty leer.

Leers Frequently Used Tools There are few tools most frequently used when creating leers:

• Jaspersoft Studio 6.2.0

• JasperReports Server WebUI

• Relational Database Management System

Jaspersoft Studio 6.2.0Eclipse-based report development tool used to build the leer templates (JRXML les).

59


Chapter 6Leers

JasperReports Server WebUIJasperReports Server WebUI is the user interface of the reporting engine and the JasperReports Server is used by thesystem to generate Leers. Uses Include: Unit testing, generate/regenerate leers, generate at-will leers and generateproduct reports.

Relational Database Management SystemVisual database design tool used to formulate the queries used by Leers.

Leer Components There are three main components to leers, structure, query and parameters.

StructureThe structure of Leer template is composed of a Header, Body, and Footer. The Header of all Leer templates displaysyour school's logo and the Footer of all Leer templates displays general information such as address, phone number,fax number, and email address. Most, if not all, of the components of a Leer are placed in the detail band which residesin the Body of a Leer template.

Examples of components that are placed inside the detail band:

• Dynamic Text Boxes: Used to display dynamic elds and static text.

• Tables: Used to list funds and their information (name, amount, payment period).

QueryThe query of a Leer template is what populates the dynamic elds of a Leer. Leer templates can have multiplequeries. The ltering criteria of queries can used parameter values. Queries must conform to the SQL syntax.

ParametersThe parameters are external values that are passed to their corresponding Leer templates by the JasperReports Server,Student Financial Planning, or users.

A Leer template has inherent parameters that are created by JasperSoft Studio and used by JasperReports Serverbehind-the-scenes. These parameters are grayed out in the JRXML le and cannot be modied. The Leer template canalso have parameters created by the Leers implementer. These parameters are created during the development of theLeer template.

Note: If the purpose of these "custom" parameters is for them to be used in queries, the Leers implementermust ensure the Class matches that of the database eld they will lter. These values can also be directlydisplayed in a Leer. Leers implementers can also use these values to manipulate the behavior of a Leerstemplate. (e.g. If the value of a parameter equals this, display this).

60


Chapter 6Leers

Event Messages That Can Trigger a Leer

These event messages can be leveraged to trigger a leer.

• FasDocumentRequestEvent

• FasDocumentRejectedEvent

• FasDocumentRequestCanceledEvent

• FasStudentNoticationEvent

• FasFinancialPlanOutboundEvent

• FasSapAppealsProcessInformationEvent

• FasSapAcademicInformationEvent

• TitleIvEligibilityCheckFailed

• FasStudentAwardInformationEvent

• FasCreditBalanceInformationEvent

• FasDisbursementInformationEvent

• FasDisbursementCancelEvent

• FasDisbursementAcceptanceInformationEvent

• FasGrantOverpaymentReferralEvent

• FasValidIsirProcessStatusInformationEvent

• FasProfessionalJudgementProcessOutboundEvent

• FasReturnToLenderEvent

• FasStudentRecordHoldPlacedEvent

• FasStudentAwardInformationV2Event

• FasDisbursementAcceptanceInformationV2Event

• TeachEligibilityCheckFailed

Update Sample Leers To update a leer you will follow the same process for creating, uploading, executing and deploying a report.

1. For more information see the following documentation:a. Create Reportsb. Upload Reportsc. Execute Reportsd. Promote Reports to Production

61


Chapter 6Leers

Disable a Leer

Here are the suggested steps to disable a leer.

1. Access the Leer Conguration Workbook from the Conguration Administration page of the SFP userinterface. Conguration Administration .

2. To disable a single leer or leer code, update Column D, DEFN_ACTIVE to FALSE for the leer or leer codeyou want to disable.

3. To disable the triggering event, update Column A, MAPPING_ACTIVE to FALSE for the leer or leer code youwant to disable.

62

http://www.oracle.com/pls/topic/lookup?ctx=cloud&id=ConfigurationAdministration