Understanding Equations
Equation Engine replaces the equation processor previously used in PeopleSoft Campus Solutions applications. The Equation Engine is a powerful tool that enables you to develop a variety of formulas that can be used to identify a specific student population, establish the assignment of an award, provide a calculated value, or provide a customization point in a process.
This chapter provides an overview of equations and discusses how to:
Prepare to write equations.
Name equations.
Use views and tables in equations.
Define an equation.
Testing equations.
View equations as algebraic expressions.
Round in PeopleSoft Financial Aid packaging using equations.
Review delivered equations.
View sample equations.
Understanding Equations
An equation is a defined series of statements that can calculate amounts or check criteria. In general, an equation is most often used to return one of the following items:
A True or False result. This is an equation that checks to determine whether certain criteria are met.
An amount. This is a calculation equation that results in a numeric value.
Equations can:
Use algebraic statements.
Use Boolean conditional statements.
Look up information in tables.
Update information in tables.
Branch or link to another equation.
Preparing to Write Equations
This section discusses how to prepare to write equations.
Before you write an equation, decide what information you want the equation to provide. You must know which fields exist in which tables to use an equation. For example, to determine whether all new transfer students who are receiving an FFELP loan have completed the required interview, you must know that a field exists to track the completion of the interview and in which table it is stored.
If you want the equation to select a population of students for a process, define the criteria exactly as well as the steps to make in selecting those students. If you want the equation to provide you with a calculated value such as an award maximum, determine where the value comes from and how it is calculated.
These criteria must be met to write an equation:
A table or view must exist to be named in an equation.
You must have security access to the table or view.
Table security must be turned on for you to access the table or view.
Any table or view that you access must not have a long VAR_CHAR field in it.
You must write equations using keywords and operands. A keyword is an instruction for the equation to perform. Equation keywords include:
|
ASSIGN |
Assigns a value to a global or local variable in an equation. |
|
CALL |
Calls a subequation or an external routine or an SQL statement. When you CALL something, control returns to the statement after the CALL when the called item finishes. For a subequation, control might not return if that subequation issues a HALT statement. Calls to subequations pass parameters through local and global variables and pass values back through global variables. An equation can call itself. Calls to external routines pass parameters back and forth using global variables. Calls to SQL pass parameters back and forth as well and can be used to get an array of data or update relational tables. |
|
CHOOSE |
Can be used with the keywords INSERT, UPDATE; or DELETE, INSERT, UPDATE and DELETE. Use a WHERE clause to select a rowset. If the CHOOSE returns a global variable with the same name or the global variable A-SELECT with a value of TRUE, then that row will remain in the rowset. That is, the CHOOSE equation can be used to further limit the rows deleted. |
|
EXIST |
Tests for the existence of a local variable, a global variable, or a table. It returns numeric zero for false and numeric 1 for true. It yields false for a local or global variable that has not been assigned or a table with zero rows selected from a find. |
|
FIND FIRST |
Finds the first row in the specified table using the specified key values with relational operators (Equal or Greater-or-Equal) comparing these to either local or global variables. FIND NEXT does not have any key value parameters, but it finds the next row relating to the previously issued FIND FIRST. If a FIND is successful, then references to the table and fields for that FIND are valid and return the corresponding field values. |
|
FIND NEXT |
Points to the next occurrence of the row of fields in a FIND table You can set up the equation so that failure to find an occurrence can be handled, for example, by the equation returning to the calling equation or program. |
|
IF |
Indicates a conditional statement that must be followed by a THEN keyword and can contain an ELSE or an ELSE IF keyword. It must be terminated by the keyword END IF. It compares one operand against another operand. |
|
LOOP |
Causes the equation to repeat the statements between the LOOP and the END LOOP statement in a loop until an EXIT LOOP statement is encountered within that loop, usually within an IF statement. |
|
MESSAGE |
Writes a message to the log. |
|
SKIP |
Used to make a progam more readable. It enables you to break up the program statements, and it can simplify your IF logic. |
|
TRACE |
Writes debugging statements to the log and is used for problem resolution. |
See Equation Engine Programmer's Guide.
Equations employ operand types that identify the type of information contained in the operand that follows it. Type choices differ depending on where the operand type is located in the equation. Options include:
|
Table |
Table or view name. |
|
Value |
Valid values for a field. |
|
SQL |
This operand applies only to the CALL statement. |
|
Global |
User-defined global variable. |
|
Local |
User-defined local variable. |
See Equation Engine Programmer's Guide.
Equations use operands and operators. Operands are based on the previous type. Operators are entered in the keyword column and can be:
|
Arithmetic |
(+, —, *, /) Add, Minus or Subtract, Multiply, Divide Arithmetic operators apply to two expressions and provide an arithmetic result. You can use parentheses to group expressions or to make the equation more readable. |
|
Boolean |
(AND, OR, NOT) These are logical operators. You use them within an IF statement. AND is used between two conditions. It indicates that both statements must be met for the selection to be made. For example, A and B must be true for a selection. OR is used between two conditions. It indicates that only one of the statements must be met for selection to be made. For example, A OR B can be true for a selection. NOT is used in conjunction with a condition to show that the condition does not exist. For example, NOT <condition>. |
|
Relational |
(=, <, <=, >, >=, < >) Equal, Less than, Less than or equal, Greater than, Greater than or equal, Less than or Greater than (for example, not equal). Relational operators compare two expressions and provide a truth value. You can use parentheses to group expressions or to enhance readability. |
See Equation Engine Programmer's Guide.
Two types of variables are available in the equation engine—local and global. The data is passed to the equation engine by means of the global variable array in a process instance of a copy of the global variables that is defined by the Equation Test Data page or by a calling program. Global variables are visible and are referenced by an equation that is running or called. Local variables are visible only to the currently running equation, but copies of local variables can be passed to called subequations as parameters.
See Equation Engine Programmer's Guide.
Naming Equations
This sections discusses how to name equations.
When you write a new equation, you must give it a name that follows strict naming guidelines. Your IT department will help you establish rules for equations within the institution. Do not use a naming convention that begins with the letters of a PeopleSoft product name or subproduct name. For example, do not use AA (academic advisement), AD (admissions), CC (campus community), CS (campus solutions), FA (financial aid), HR (human resources), SF (student financials), or SR (student records). Each department in the institution should have its own equation name prefix as well to avoid naming conflicts.
Note. You must not modify any system-specific equations because compromising those equations will cause negative processing ramifications for the specific feature.
See Also
Page Used to Name Equations
|
Page Name |
Definition Name |
Navigation |
Usage |
|
EQUATION_EDITOR |
Set Up SACR, Common Definitions, Equation Engine, Equation Editor |
Name an equation. |
Naming an EquationAccess the Equation Editor page (Set Up SACR, Common Definitions, Equation Engine, Equation Editor).
Create an equation name based on established naming conventions for your organization.
Using Views and Tables in Equations
This section discusses how to use views and tables in equations.
A view consists of information drawn from a table or multiple tables and can be accessed by an equation. Use a view whenever it can make the equation logic simpler. You should use a view only to access information contained in core tables.
Note. If you need to access information contained in a core table or a very large table, ask your organization's IT department to create a view of that table and add the view to the Equation Table Authorization Security Tree.
Defining an Equation
This section provides an overview of application prompts, lists a prerequisite, and discusses how to define equations and application prompts.
Understanding Application PromptsIf you are working on a particular feature, such as a packaging plan, and need to create one or more equations for that plan, you must define those equations here and include a short description and long description for the new equation.
You must then associate that equation with an application prompt. For example, the equation that you are creating is a packaging selection equation. Because this equation will be used to access a population of students—that is, it is a selection equation—you must assign the Fin Aid Packaging Enter Eqtn application prompt to the equation. You do that by selecting Fin Aid Packaging Select Eqtn from the drop-down list box. By associating the application prompt value with an equation here, this equation will appear in the list of available selection equations that you can use when creating your packaging plan in the Packaging Plan Setup table.
As another example, if you are working on a Student Financials tuition calculation feature, and you want to create an equation that will return an amount, you must associate your new equation with an application prompt. You would select Stdnt Fin Tuition Amount Eqtns or Stdn Fin Tuit Amount Limited. After selecting one of these application prompts here, your new equation will appear on the list of possible equations to use when working with the tuition calculation setup feature.
Warning! Do not make any changes to the Application Prompt values.
The application prompts Stdnt Fin Tuit Select Limited and Stdnt Fin Tuit Amount Limited are used by equations that use only global variables from the STDNT_CAR_TERM record. Both prompts eliminate the need to repeatedly call the Equation Engine.
This table lists the application prompt to use based on the global variable:
|
Student Financials Global Variables |
Stdnt Fin Tuition Amount Eqtns |
Stdnt Fin Tuition Select Eqtns |
Stdnt Fin Tuition Amount Limited |
Stdnt Fin Tuit Select Limited |
|
INSTITUTION |
X |
X |
X |
X |
|
BUSINESS UNIT |
X |
X |
X |
X |
|
ACAD_CAREER (academic career) |
X |
X |
X |
X |
|
STRM (term) |
X |
X |
X |
X |
|
EMPLID |
X |
X |
X |
X |
|
STDNT_CAR_NBR (student career number) |
X |
X |
X |
X |
|
BILLING_CAREER |
X |
X |
X |
X |
|
A_AMOUNT |
X |
X |
X |
X |
|
A_SELECT (yes/no check box) |
X |
X |
X |
X |
|
SESSION_CODE |
X |
X |
NA |
NA |
|
CLASS_NBR (class number) |
X |
X |
NA |
NA |
|
CRSE_ID (course ID) |
X |
X |
NA |
NA |
|
TRANS_DATE (enrl_drop_dt) |
X |
X |
NA |
NA |
|
ENRL_ACTN_RSN_LAST (enrolment action reason last) |
X |
X |
NA |
NA |
|
TRANS_TIME (last drop term stamp) |
X |
X |
NA |
NA |
Note. NA = Not Applicable
PrerequisiteBefore you define an equation on the Equation Editor page, you should devise a flow chart that considers what your end result should be. Using a flow chart will help you develop proper equation syntax.
Page Used to Define an Equation
|
Page Name |
Definition Name |
Navigation |
Usage |
|
EQUATION_EDITOR |
Set Up SACR, Common Definitions, Equation Engine, Equation Editor |
Define an equation and application prompts. |
Defining Equations and Application PromptsAccess the Equation Editor page (Set Up SACR, Common Definitions, Equation Engine, Equation Editor).
Equation Table
|
Eff Date(effective date) |
Enter a date after which the equation will be effective. |
|
Active |
This check box is selected when an equation is available for use. |
|
Enable Preview Results |
Select to preview results based on the parameters that you selected before you run the process. This check box can be selected on the Selection Tool page and is associated with the Pop Select feature. |
|
Short Desc(short description) |
Enter a short description for the equation based on the equation naming guidelines. |
|
Descr(description) |
Enter a description for this equation. |
|
Equation Edit Function |
Select an equation edit function value. This drop-down list box contains a selection of predefined edit functions to assist with tasks such as cutting and pasting, compiling, and printing an equation. |
Equation Detail
|
Keyword |
Select equation keywords that are necessary for your equation. |
|
Operand Type |
Select an operand type from the available options. This operand identifies the type of information contained in the operand that follows. |
|
Operand |
Enter the operand based on the operand type selected in the previous field. |
|
Comment |
Enter a short comment. This is not part of the equation. |
Application Prompts
|
Application Prompt ID |
Select an application prompt value. These prompt values control which equations will be available for you to choose from when defining equations for a particular feature. If you do not select an application prompt value for an equation here, that equation will not appear on the list of available equations for selection during feature processing. Prompt values include: Fin Aid Loan Edits for CL4 Fin Aid Loan Edits for CRC Fin Aid Packaging Amount Eqtns Fin Aid Packaging Select Eqtns Stdnt Fin Tuition Amount Eqtns Stdnt Fin Tuition Selct Eqtns Stdnt Fin Tuit Select Limited Stdnt Fin Tuit Amount Limited |
Parameters
|
Global |
Enter a global variable value. |
|
Type |
Select an operand type from the available options. The operand type identifies the type of information contained in the operand that follows. |
Testing EquationsThis section discusses how to:
Define equation test data.
View equation test run details.
To test the equation, you may need to set up test data. In an equation for which the sole function is to add a few numbers together, no test data is needed because all the data elements are provided. However, to test an equation that references keys in the table or passes global variables, the equation must have test data present.
Pages Used to Test Equations|
Page Name |
Definition Name |
Navigation |
Usage |
|
EQTN_TEST_DATA |
Set Up SACR, Common Definitions, Equation Engine, Equation Test Data, Equation Test Data |
Define equation test data. |
|
|
EQTN_PRCS_MSGS |
Click the Test button on the Equation Test Data page. |
View the equation test run details. |
Defining Equation Test DataAccess the Equation Test Data page (Set Up SACR, Common Definitions, Equation Engine, Equation Test Data).
Use this page to define the name of the global variable, type, and operand.
After you have defined all the necessary variables and entered data on the Equation Test Data page, click the Test button.
The system displays the Equation Test Results - Process Messages page.
Note. You can also run this process as a batch process
rather than initiating it by the Test button.
To test the equation in batch, select the Run Equation option (Set
Up SACR, Common Definitions, Equation Engine, Run Equation, Run an Equation).
You can also print the equation that has been established in batch by
selecting the Print Equation option (Set
Up SACR, Common Definitions, Equation Engine, Print Equations, Print an Equation).
Viewing Equation Test Run DetailsAccess the Equation Test Results page: Process Messages tab (click the Test button on the Equation Test Data page).
The page displays the messages associated with the equation test run.
Access the Global Variables tab.
The Global Variable page displays the global variables used within the current equation run.
Viewing Equations as Algebraic Expressions
This section discusses how to view equations as algebraic expressions.
You can view any equation that you are authorized to read on the Review Equations component (EQUATION_VIEW).
Page Used to View Equations as Algebraic Expressions|
Page Name |
Definition Name |
Navigation |
Usage |
|
SCC_EQUATION_VIEW |
|
View equations as algebraic equations. |
Viewing Equations as Algebraic ExpressionsAccess the Review Equations page (Set Up SACR, Common Definitions, Equation Engine, Review Equations).
This page displays the equation name and an approximate algebraic representation of the equation. You cannot edit the equation in this page. Use the scroll bar to view the entire equation.
Note. This summary is a representation of the equation that you created on the Equation Editor page. The Equation Editor page determines how your equation functions.
Rounding in PeopleSoft Financial Aid Packaging Using Equations
This section provides an overview of rounding in Financial Aid Packaging.
Understanding Rounding in Financial Aid PackagingThe Packaging routine does not round up to whole dollar amounts when your equation yields a decimal result for a packaging limit. If the result contains decimals, the Packaging routine produces the following error message: "Message # 9146 Cannot disburse in whole dollars; award contains cents."
For those equations that need to yield a whole dollar result, you must use a rounding equation. You could accomplish this by employing one of two options:
Option 1
Create your A_AMOUNT equation, and at the bottom of the equation insert a Call statement to the delivered sample equation FAPDROUNDAWD.
Review the FAPDROUNDAWD equation to determine the number of places beyond the decimal point that you want (0=integers or whole numbers, 1, 2, and so forth).
Ensure that the Equation EQROUND is called as part of FAPDROUNDAWD.
Option 2
Create your A_AMOUNT equation, and at the bottom of the equation insert a Call statement to the delivered sample equation FAPDROUNDAWD.
Review the FAPDROUNDAWD equation to determine the number of places beyond the decimal point that you want (0=integers or whole numbers, 1, 2, and so forth).
Ensure that the Equation EQROUND is called as part of FAPDROUNDAWD.
Important! For this rounding logic to work properly, all elements of FAPDROUNDAWD must be employed, and EQROUND must be called as part of that routine. Do not modify these components.
Here are two of the rounding equations that PeopleSoft Campus Solutions delivers:
Reviewing Delivered Equations
This section lists the PeopleSoft-delivered equations.
Oracle delivers a set of feature-specific equations as part of Equation Engine. These represent either system-specific or demonstration-based equations.
Warning! Do not modify any system-specific equations, because compromising those equations has negative processing ramifications for the specific feature.
You can view any equation that you are authorized to read on the Review Equations component (Set Up SACR, Common Definitions, Equation Engine, Review Equations).
EQ* — Delivered System and Demo Equations
|
Equation Name |
Description |
|
EQCOMPILEALL |
Compile All Active Equations |
|
EQFACTORIAL |
Factorial Sub Equation |
|
EQROUND |
Round to spec decimal places |
|
EQROUNDBANK |
Banker's Rounding |
|
EQTNRUNCTL |
Default Equation Run Control |
|
EQTSTADD1 |
Test Add 1 |
|
EQTSTASGN1 |
Test Assignment Statement |
|
EQTSTASSIGN2 |
Test Assign 2 |
|
EQTSTCALL1 |
Test Call 1 |
|
EQTSTCALL2 |
Test Call 2 |
|
EQTSTCALL3 |
Test Call 3 |
|
EQTSTCALL4 |
Test Call 4 |
|
EQTSTCALL5 |
Test Call 5 |
|
EQTSTCALL6 |
Test Call 6 - sql multi select |
|
EQTSTCALL7 |
Test Call 7 - sql sel count |
|
EQTSTCALL8 |
Call Test 8 |
|
EQTSTDDF |
Test Date Difference |
|
EQTSTDIV1 |
TEST DIVIDE 1 |
|
EQTSTEXIST1 |
Test Exist 1 |
|
EQTSTEXIST2 |
Test Exit 2 |
|
EQTSTEXIST3 |
Test Exit 3 |
|
EQTSTEXT1 |
Test External 1 |
|
EQTSTEXT2 |
Test External 2 |
|
EQTSTFIND1 |
Test Find 1 |
|
EQTSTFIND2 |
Test Find 2 |
|
EQTSTFIND3 |
Test Find 3 |
|
EQTSTFIND4 |
Test Find 4 |
|
EQTSTFIND5 |
Test Find 5 |
|
EQTSTFIND6 |
Find 6 |
|
EQTSTHALT1 |
Halt Test 1 |
|
EQTSTIF1 |
Test If 1 |
|
EQTSTIF2 |
Test If 2 |
|
EQTSTIF3 |
Test If 3 |
|
EQTSTIF4 |
If Test 4 |
|
EQTSTLOOP1 |
Test Loop 1 |
|
EQTSTMSG1 |
Test Msg 1 |
|
EQTSTMSG2 |
Test Msg 2 |
|
EQTSTMSG3 |
Test Msg 3 |
|
EQTSTMSG4 |
Test Msg 4 |
|
EQTSTMSG5 |
Test Msg 5 |
|
EQTSTMSG6 |
Test Msg 6 |
|
EQTSTMSG7 |
Test Msg 7 |
|
EQTSTMULT1 |
Test Multiply 1 |
|
EQTSTPAREN1 |
Test Paren 1 |
|
EQTSTPRECED1 |
Test Operator Precedence 1 |
|
EQTSTRETN1 |
Test Return 1 |
|
EQTSTRETN2 |
Test Return 2 |
|
EQTSTROUND1 |
Test Rounding 1 |
|
EQTSTSTEM1 |
Test Stem 1 |
|
EQTSTSTEM2 |
Test Stem 2 |
|
EQTSTSTEM3 |
Test Stem 3 |
|
EQTSTSTEM4 |
Test Stem 4 |
|
EQTSTSUB1 |
Test Subtract 1 |
FACE* — CommonLine Delivered Edits
|
Equation Name |
Description |
|
FACEDDELERRS |
Delete Old Loan Edit Errors |
|
FACEDGET1ST |
Get First Run Control Info |
|
FACEDGETCATG |
Get Dest Category |
|
FACEDGETCLPN |
Get CL Pnote |
|
FACEDGETDEST |
Get Loan Dest Edit Data |
|
FACEDGETORIG |
Get Loan Origination Data |
|
FACEDGETTYPE |
Get Loan Type Data |
|
FACEDLOGERR |
Log Loan Edit Errors |
|
FACEDUPDSTAT |
Update Loan Action Status |
FACL* — CommonLine Delivered Edits
|
Equation Name |
Description |
|
FACLOANEDITS |
Fin Aid Loan Edits |
|
FACLOANONEUP |
One Up CRC Loan Validation |
FACR* — Common Record CommonLine Delivered Edits
|
Equation Name |
Description |
|
FACRADDR01 |
Permanent address missing |
|
FACRADDR02 |
Mailing address missing |
|
FACRADDR03 |
Borrower perm address missing |
|
FACRADDR04 |
Borrower mailing addr missing |
|
FACRBORROW01 |
Borrower missing |
|
FACRCHNG01 |
Loan incr w/undisbursed check |
|
FACRCOSIGN01 |
Cosigners Required |
|
FACRCOSIGN02 |
Cosigner Signatures Required |
|
FACRDEBT01 |
Total Loan Debt Missing |
|
FACRDEPSTAT1 |
Dependency stat missing |
|
FACRDEST01 |
Loan Dest Nbr is Zero |
|
FACRDISBDT01 |
Disb 91 days after Ln Per End |
|
FACRDISBDT02 |
Ln Per Strt - Disb Dt > 13 |
|
FACRDISBDT03 |
Disb dts require chron order |
|
FACRDRVLIC01 |
Borrower DL or state missing |
|
FACRGRADDT01 |
Grad dt before Loan End dt |
|
FACRHOLDFED1 |
Disbursement Hold on Fed Aid |
|
FACRNAME01 |
Student name missing |
|
FACRNAME02 |
Borrower name missing |
|
FACRPER01 |
Loan Per gt 1 Yr |
|
FACRPLUS01 PLUS borr/stdnt SSN |
same |
|
FACRPLUS02 |
No PLUS for grad student |
|
FACRPLUSMPN |
Serial PLUS MPN Check |
|
FACRREFS01 |
References Required |
|
FACRSRVCIN01 |
Service Indicators Exist |
|
FACRSSN01 |
Borrower SSN is blank |
|
FACRSSN02 |
Student SSN is blank |
FAED* — CommonLine 4 Delivered Edits
|
Equation Name |
Description |
|
FAEDADDR01 |
Permanent address missing |
|
FAEDADDR02 |
Mailing address missing |
|
FAEDADDR03 |
Borrower perm address missing |
|
FAEDADDR04 |
Borrower mailing addr missing |
|
FAEDBORROW01 |
Borrower missing |
|
FAEDCHNG01 |
Loan incr w/undisbursed check |
|
FAEDCOSIGN01 |
Cosigners Required |
|
FAEDCOSIGN02 |
Cosigner Signatures Required |
|
FAEDDEBT01 |
Total Loan Debt Missing |
|
FAEDDEPSTAT1 |
Dependency stat missing |
|
FAEDDEST01 |
Loan Dest Nbr is Zero |
|
FAEDDISBDT01 Disb |
91 days after Ln Per End |
|
FAEDDISBDT02 |
Ln Per Strt - Disb Dt > 13 |
|
FAEDDISBDT03 |
Disb dts require chron order |
|
FAEDDRVLIC01 |
Borrower DL or state missing |
|
FAEDGRADDT01 |
Grad dt before Loan End dt |
|
FAEDNAME01 |
Student name missing |
|
FAEDNAME02 |
Borrower name missing |
|
FAEDPER01 |
Loan Per gt 1 Yr |
|
FAEDPLUS01 |
PLUS borr/stdnt SSN same |
|
FAEDPLUS02 |
No PLUS for grad student |
|
FAEDPLUSMPN |
Serial PLUS MPN Check |
|
FAEDREFS01 |
References Required |
|
FAEDSRVCIN01 |
Service Indicators Exist |
|
FAEDSSN01 |
Borrower SSN is blank |
|
FAEDSSN02 |
Student SSN is blank |
FAHD* — Hold and Release Delivered Edits
|
Equation Name |
Description |
|
FAHDLOADLVL |
Load Level Status Check |
|
FAHDSAPSTAT |
Satisfactory Academic Progress |
FALTR*— Forms Engine FAN Delivered Equations
|
Equation Name |
Description |
|
FANLTRDTRANG |
Award Ltrs within a date range |
|
FANLTRNONEED |
No Need |
|
FANLTRSCHONL |
Scholarship Only |
|
FANLTRSEL |
Award Ltr Selection Criteria |
FA_CRC* — CRC Loan Edits Delivered Edits
|
Equation Name |
Description |
|
FA_CRCEDITS |
FA CRC Loan Edits |
FA_* — CommonLine Delivered Edits
|
Equation Name |
Description |
|
FACEDDELERRS |
Delete Old Loan Edit Errors |
|
FACEDGET1ST |
Get First Run Control Info |
|
FACEDGETCATG |
Get Dest Category |
|
FACEDGETCLPN |
Get CL Pnote |
|
FACEDGETDEST |
Get Loan Dest Edit Data |
|
FACEDGETORIG |
Get Loan Origination Data |
|
FACEDGETTYPE |
Get Loan Type Data |
|
FACEDLOGERR |
Log Loan Edit Errors |
|
FACEDUPDSTAT |
Update Loan Action Status |
|
FA_LOANEDITS |
Fin Aid Loan Edits |
FAPK* — Packaging System Equations
|
Equation Name |
Description |
|
FAPKAFDCPAR |
Set global AFDC_PAR |
|
FAPKAFDCSTU |
Set global AFDC_STU |
|
FAPKAGIPAR |
Set global AGI_PAR |
|
FAPKAGISTU |
Set global AGI_STU |
|
FAPKCHLSPPAR |
Set global CHILD_SUPPORT_PAR |
|
FAPKDEPENDST |
Set global DEPNDNCY_STAT |
|
FAPKDEPNDNTS |
Set global DEPENDENTS |
|
FAPKDTAPPREC |
Set global DT_APP_RECEIVED |
|
FAPKERNINPAR |
Set global ERND_INC_CRED_PAR |
|
FAPKEXEMPT |
Set global NUM_EXEMPTIONS |
|
FAPKEXEMPTPR |
Set global NUM_EXEMPTIONS_PAR |
|
FAPKGDATASRC |
Get Packaging Data Source |
|
FAPKLEGALRES |
Set global LEGAL_RESIDENCE |
|
FAPKMARSTPAR |
Set global MARITAL_STAT_PAR |
|
FAPKMAR_STAT |
Set global MARITAL_STAT |
|
FAPKMONVETBN |
Set global MONTHLY_VET_BEN |
|
FAPKNMFAMMEM |
Set global NUM_FAMILY_MEMBERS |
|
FAPKNMINCOLL |
Set global NUMBER_IN_COLLEGE |
|
FAPKNMMNVTBN |
Set global NUM_MONTH_VET_BEN |
|
FAPKNUMINCOL |
Set global NUM_IN_COLLEGE |
|
FAPKNUMINFAM |
Set global NUMBER_IN_FAMILY |
|
FAPKORPHAN |
Set global ORPHAN |
|
FAPKRDINSTCT |
Read INST_CONTROL |
|
FAPKRDINSTIN |
Read INST_INTERPRET |
|
FAPKRDINSTPR |
Read Inst Parent |
|
FAPKRDINSTST |
Read Inst Student |
|
FAPKRDISIRCT |
Read ISIR_CONTROL |
|
FAPKRDISIRPR |
Read Isir Parent |
|
FAPKRDISIRST |
Read Isir Student |
|
FAPKSPERNINC |
Set global SPS_EARNED_INCOME |
|
FAPKSSBENPAR |
Set global SS_BENEFIT_PAR |
|
FAPKSSBENSTU |
Set global SS_BENEFIT_STU |
|
FAPKSTATERES |
Get State Residence |
|
FAPKSTERNINC |
Set global STD_EARNED_INCOME |
|
FAPKTOTWKAP |
Set global TOTAL_FROM_WKA_P |
|
FAPKUNTAXIN |
Set global UNTAXED_INC |
|
FAPKUNTAXINP |
Set global UNTAXED_INC_PAR |
|
FAPKVETERAN |
Set global VETERAN |
FAPD* — Packaging Demo Equations
Oracle strongly recommends that you not modify these equations. You can clone them to use a basis for your own similar equations.
|
Equation Name |
Description |
|
FAPDADJPCONT |
Stored Value ADJ_PAR_CONTRIB |
|
FAPDANNLOAD |
Annual Load 1 |
|
FAPDANNLOAD2 |
Annual_Load 2 |
|
FAPDANNLOAD3 |
Annual Load 3 |
|
FAPDAPP_DATE |
If Then Example DT_APP_RECEIVED |
|
FAPDCLCIFAGI |
Calc Variables based on AGI |
|
FAPDCLCTLEFC |
Calculate Award based on EFC |
|
FAPDDEPENDNT |
Dependent Students |
|
FAPDDEPNDNTS |
Dependents |
|
FAPDDL_STATE |
Award based on License State |
|
FAPDDOBPRIOR |
If Then Example of DOB_PRIOR |
|
FAPDEARLYADM |
If Then Else Example EARLY_ADM |
|
FAPDEFC3000 |
Award based on FED_EFC <= 3000 |
|
FAPDEFC4000 |
Award based on FED_EFC <= 4000 |
|
FAPDEFC6000 |
Award based on FED_EFC > 6000 |
|
FAPDEFCBOTH |
Handles Both Award Periods |
|
FAPDEFC_STAT |
If Then Example of EFC STAT |
|
FAPDFROSH |
Award based on Freshman level |
|
FAPDGAPBDGT1 |
Gap_Bdgt#1 |
|
FAPDGAPBDGT2 |
Gap_Bdgt#2 |
|
FAPDGRADELVL |
Award based on NSLDS_LOAN_YEAR |
|
FAPDGRADS |
GRADUATES |
|
FAPDHIGHEFC |
Award where FED_EFC >= 10,000 |
|
FAPDINDPNDNT |
Independent |
|
FAPDJMET5000 |
Select if Unmet Need >= 5,000 |
|
FAPDLASTAWRD |
Last Award |
|
FAPDMDLABRAT |
Award based on VARIABLE_FLAG7 |
|
FAPDMDSPCLTY |
Award based on VARIABLE_CHAR3 |
|
FAPDMDTSTSCR |
Award using VARIABLE_NUM5 |
|
FAPDPELLELIG |
Select Pell Eligible Candidate |
|
FAPDPELL_ELG |
Pell Eligibility Flag Example |
|
FAPDPLUS_INT |
Example: Interest in PLUS Loan |
|
FAPDPRIM_EFC |
Stored Val Example Primary EFC |
|
FAPDPRJYRINC |
If Then Example on PROJ_YR_INC |
|
FAPDP_AFDC |
Stored Value of Parents' AFDC |
|
FAPDP_AGI |
Stored Value of PAR_AGI |
|
FAPDP_IM#COL |
Inst Parent Number in College |
|
FAPDP_IM_AGI |
Inst Parent Number in College |
|
FAPDP_MARSTT |
If Then using MARITAL_STAT_PAR |
|
FAPDP_NMCOLL |
If Then: PAR NUM_IN_COLLEGE |
|
FAPDP_WORK1 |
Parent 2005 ISIR WORKSHEET_A |
|
FAPDP_WORK2 |
Parent 2005 ISIR WORKSHEET_B |
|
FAPDP_WORK3 |
Parent 2005 ISIR WORKSHEET_C |
|
FAPDREMNEED1 |
Remaining Need 1 |
|
FAPDREMNEED2 |
Remaining Need 2 |
|
FAPDREMNEED3 |
Remaining Need 3 |
|
FAPDROUNDAWD |
Round A_AMOUNT |
|
FAPDRUNGAWDS |
Running TOTAL AWD AMT |
|
FAPDSEC_EFC |
Stored Value of SECONDARY_EFC |
|
FAPDSPS_ERND |
Stored Value of SPS_EARNED_INC |
|
FAPDSSA_CITZ |
If Then: SSA_CITIZENSHP_IND |
|
FAPDS_AFDC |
Stored Value: AFDC_STU |
|
FAPDS_AGI |
Stored Value: AGI_STU |
|
FAPDS_CHLSUP |
Store Value CHILD_SUPPORT_RCVD |
|
FAPDS_DEP_ST |
If Then Example DEPNDNCY_STAT |
|
FAPDS_EARNED |
Stored Val: STD_EARNED_INCOME |
|
FAPDS_IM_AGI |
Award using IM Student AGI |
|
FAPDS_IM_INC |
Inst Student Income |
|
FAPDS_MARRD |
If Then Example of STU MARRIED |
|
FAPDS_MAR_ST |
If Then Example MARITAL_STAT |
|
FAPDS_NUMCOL |
If Then STU NUMBER_IN_COLLEGE |
|
FAPDS_NUMFAM |
If Then STU NUM_FAMILY_MEMBERS |
|
FAPDS_ORPHAN |
If Then And Example of ORPHAN |
|
FAPDS_ST_SEL |
If Then Example STATE_AGNCY_RLS |
|
FAPDS_VA_BEN |
Stored Value MONTHLY_VET_BEN |
|
FAPDS_VETERN |
If Then Example VETERAN status |
|
FAPDS_WORK1 |
STUDENT_WORKSHEET_A |
|
FAPDS_WORK2 |
STUDENT_WORKSHEET_B |
|
FAPDS_WORK3 |
STUDENT_WORKSHEET_C |
|
FAPDTGTRMNED |
Award using I_TRGT_FED_RMNEED |
|
FAPDTIV_ELIG |
If Then Example: TITLEIV_ELIG |
|
FAPDTOTALINC |
Stored Value of TOTAL_INCOME |
|
FAPDTOTPRCNT |
Stored Value TOTAL_PAR_CONTRIB |
|
FAPDTOTSCONT |
Stored Value TOTAL_STU_CONTRIB |
|
FAPDTRANS_DT |
Award using TRANS_PROCESS_DT |
|
FAPDUGRADS |
UNDERGRADS |
|
FAPDUMET1000 |
Select FED_RMNEED >= 10,000 |
|
FAPDUNGRADS |
Undergraduates |
|
FAPDVALIDEFC |
Award using VALID_EFC_CALC |
|
FAPDVGAPAWRD |
VGAP Award Amount |
|
FAPDVIRGNRES |
If Then: STATE_RESIDENCE = VA |
|
FAPD_APPDATE |
IF THEN DATE > 2003/01/01 |
|
FAPD_IM_#COL |
Award using Stu Nbr in College |
SFTD* — SF Tuition Calculation Delivered Equations
|
Equation Name |
Description |
|
SFTDBILLUNIT |
Billing Units |
|
SFTDCSSTDYFE |
Case Study Fees |
|
SFTDMDLABRAT |
Medical School Laboratory Fees |
|
SFTDMDSCTUIT |
Medical School Tuition |
|
SFTDMDSPECLT |
Medical Speciality |
|
SFTDMDTESTSC |
Medical School Test Scores |
|
SFTDRSRCHFEE |
Research Project Fees |
|
SFTDUGRAD |
Undergraduate |
|
SFTDUGRDAMT |
SF UGRD Pay Amount |
|
SFTDUGRDSEL |
SF UGRD Select |
|
SFTDTFTRMTRM |
Term Fee Charge by Term Adjust by Term |
|
SFTDTFTRMSES |
Term Fee Charge by Term Adjust by Session |
|
SFTDTFTRMCLS |
Term Fee Charge by Term Adjust by Class |
|
SFTDTFSESTRM |
Term Fee Charge by Session Adjust by Term |
|
SFTDTFSESCLS |
Term Fee Charge by Session Adjust by Class |
|
SFTDCLSTRM |
Term Fee Charge by Class Adjust by Term |
|
SFTDCLASSNBR |
Class Fee A_Amount |
|
SFTDCLSSEL |
Class Fee A_Select |
|
SFTDCOURSEID |
Course ID A_Amount |
|
SFTDCLSWVR |
Course Fee A_Amount Negative |
Viewing Sample EquationsThis section discusses the syntax of sample equations delivered by Oracle.
You can view any equation that Oracle delivers on the Equation Editor page (Set Up SACR, Common Definitions, Equation Engine, Equation Editor).
Loan Validation Edit Equation
This is a loan validation edit that checks whether the borrower has been defined on the loan origination table.
|
Line Number |
Equation Keyword |
Operand Type |
Operand |
Comment |
|
1 |
SKIP |
Borrower Missing |
||
|
2 |
ASSIGN |
Local Variable |
EQUATION_NAME |
|
|
3 |
String |
FACRBORROW01 |
||
|
4 |
END ASSIGN |
|||
|
5 |
CALL |
Equation |
FACEDGETDEST |
|
|
6 |
CALL PARMS |
|||
|
7 |
Local Variable |
EQUATION_NAME |
||
|
8 |
END CALL PARMS |
|||
|
9 |
IF |
|||
|
10 |
Global Variable |
DEST_ACTV |
||
|
11 |
<> |
|||
|
12 |
String |
Y |
Edit not active |
|
|
13 |
THEN |
|||
|
14 |
RETURN |
|||
|
15 |
END IF |
|||
|
16 |
IF |
|||
|
17 |
Table |
LOAN_ORIGNATN |
||
|
18 |
Field |
BORR_EMPLID |
||
|
19 |
= |
|||
|
20 |
String |
|||
|
21 |
THEN |
|||
|
22 |
CALL |
Equation |
FACEDLOGERR |
|
|
23 |
CALL PARMS |
|||
|
24 |
Local Variable |
EQUATION_NAME |
||
|
25 |
END CALL PARMS |
|||
|
26 |
END IF |
|||
|
27 |
RETURN |
Satisfactory Academic Progress Equation
This is a hold/release demonstration equation to verify satisfactory academic progress for a student.
|
Line Number |
Equation Keyword |
Operand Type |
Operand |
Comment |
|
1 |
SKIP |
Satisfactory Academic Progress Check |
||
|
2 |
FIND FIRST |
Local Variable |
FOUND_STDNT_AID_ATRBT |
|
|
3 |
Table |
STDNT_AID_ATRBT |
||
|
4 |
Keyed Global Equal |
EMPLID |
||
|
5 |
Keyed Global Equal |
INSTITUTION |
||
|
6 |
Keyed Global Equal |
AID_YEAR |
||
|
7 |
Keyed Global Equal |
TABLE_ID |
||
|
8 |
END FIND |
|||
|
9 |
IF |
|||
|
10 |
NOT |
|||
|
11 |
Local Variable |
FOUND_STDNT_AID_ATRBT |
||
|
12 |
Then |
|||
|
13 |
Message |
String |
No row in STDNT_AID_ATRBT |
|
|
14 |
String |
for key values |
||
|
15 |
Global Variables |
EMPLID |
||
|
16 |
Global Variable |
INSTITUTION |
||
|
17 |
Global Variable |
AID_YEAR |
||
|
18 |
Global Variable |
TABLE_ID |
||
|
19 |
END MESSAGE |
|||
|
20 |
ASSIGN |
Global Variable |
RESULT |
|
|
21 |
String |
FAILED |
||
|
22 |
END ASSIGN |
|||
|
23 |
ASSIGN |
Global Variable |
HR_MSG_SET_NBR |
|
|
24 |
String |
14432 |
||
|
25 |
END ASSIGN |
|||
|
26 |
ASSIGN |
Global Variable |
HR_MSG_NBR |
|
|
27 |
String |
00001 |
||
|
28 |
END ASSIGN |
|||
|
29 |
RETURN |
|||
|
30 |
END IF |
|||
|
31 |
IF |
|||
|
32 |
Table |
STDNT_AID_ATRBT |
||
|
33 |
Field |
SAT_ACADEMIC_PRG |
||
|
34 |
= |
|||
|
35 |
Prompted Value |
Y |
||
|
36 |
OR |
|||
|
37 |
Table |
STDNT_AID_ATRBT |
||
|
38 |
Field |
SAT_ACADEMIC_PRG |
||
|
39 |
= |
|||
|
40 |
Prompted Value |
P |
||
|
41 |
THEN |
|||
|
42 |
ASSIGN |
Global Variable |
RESULT |
|
|
43 |
String |
PASS |
||
|
44 |
END ASSIGN |
|||
|
45 |
ELSE |
|||
|
46 |
ASSIGN |
Global Variable |
HR_MSG_SET_NBR |
|
|
47 |
String |
14432 |
||
|
48 |
END ASSIGN |
|||
|
49 |
ASSIGN |
Global Variable |
HR_MSG_NBR |
|
|
50 |
String |
00002 |
||
|
51 |
END ASSIGN |
|||
|
52 |
ASSIGN |
Global Variable |
RESULT |
|
|
53 |
String |
FAILED |
||
|
54 |
END ASSIGN |
|||
|
55 |
END IF |
Undergraduate Status Equation
This is a packaging selection equation that checks for undergraduate status.
|
Line Number |
Equation Keyword |
Operand Type |
Operand |
Comment |
|
1 |
IF |
|||
|
2 |
Global Variable |
ACAD_CAREER |
||
|
3 |
= |
|||
|
4 |
String |
UGRD |
||
|
5 |
THEN |
|||
|
6 |
ASSIGN |
Global Variable |
A_SELECT |
|
|
7 |
String |
T |
||
|
8 |
END ASSIGN |
|||
|
9 |
ELSE |
|||
|
10 |
ASSIGN |
Global Variable |
A_SELECT |
|
|
11 |
String |
F |
||
|
12 |
END ASSIGN |
|||
|
13 |
END IF |