Using Equation Engine in Packaging

Equation Engine can read any table for which you have security access and can perform various arithmetic operations and external call subroutines.

Note: If you plan to use equations, you must set them up before you set up packaging plans. Similarly, if you plan to use Mass Packaging, set up equations to be used as part of that process.

You must be familiar with the fields that you can use in equations to understand what student data is available for selection or calculation. Equations are written in statements similar to spoken phrases. For example, if you want to write an equation that calculates different award amounts based on a student's grade level, using the Global A_AMOUNT option, you would first write:

If the student's grade level is freshman, then I want to award 8,000.00 USD; if the student's grade level is sophomore, then I want to award 8,500.00 USD; if the student's grade level is junior, then I want to award 9,000.00 USD, and if the student's grade level is a senior or higher, then I want to award 9,500.00 USD.

This sentence can be written as an equation:

Line Number	Equation Keyword	Operand Type	Operand
1	SKIP
2	ASSIGN	Local	AWARD_PERIOD
3		String	A
4	END ASSIGN
5	FIND FIRST	Global	FOUND_FAN_AWD_PER_VW
6		Table	FAN_AWD_PER_VW
7		Global EQ	EMPLID
8		Global EQ	INSTITUTION
9		Global EQ	AID_YEAR
10		Local EQ	AWARD_PERIOD
11	END FIND
12	IF
13		Table	FAN_FA_TERM_VW
14		Field	NSLDS_LOAN_YEAR
15	<=
16		Value	1
17	THEN
18	ASSIGN	Global	A_AMOUNT
19		Number	8000.00000
20	END ASSIGN
21	ELSE IF
22		Table	FAN_FA_TERM_VW
23		Field	NSLDS_LOAN_YEAR
24	=
25		Value	2
26	THEN
27	ASSIGN	Global	A_AMOUNT
28		Number	8500.00000
29	END ASSIGN
30	ELSE IF
31		Table	FAN_FA_TERM_VW
32		Field	NSLDS_LOAN_YEAR
33	=
34		Value	3
35	THEN
36	ASSIGN	Global	A_AMOUNT
37		Number	9000.00000
38	END ASSIGN
39	ELSE IF
40		Table	FAN_FA_TERM_VW
41		Field	NSLDS_LOAN_YEAR
42	>=
43		Value	4
44	THEN
45	ASSIGN	Global	A_AMOUNT
46		Number	9500.00000
47	END ASSIGN
48	END IF

FAPDGRADELVL

In the example, NSLDS_LOAN_YEAR is the field name for academic level. The first section of the equation assigns the global variables needed by the equation engine to identify the proper NSLDS_LOAN_YEAR. The second section tells the system which table, field, and field values are to be evaluated by the equation (NSLDS_LOAN_YEAR value = freshman, sophomore, junior, and so on). Based on the table/field value, the 'Assign Global A_AMOUNT' statement instructs the system to award the student a particular dollar value (if the student is a sophomore, award the student 8,500.00). When using the Equation Engine, you are guided in the writing of your equation by the various field prompts and their values.

As another example, if you are creating a packaging plan for your graduate career and you need to select all students with a graduate career, you would write an equation using A_SELECT: I want to select all of my students whose career equals graduate.

This sentence can be written as an equation:

Line Number	Equation Keyword	Operand Type	Operand
1	ASSIGN	Global	STRM
2		String
3	END ASSIGN
4	FIND FIRST	Global	FOUND_FAN_FA_TERM_VW
5		Table	FAN_FA_TERM_VW
6		Global EQ	EMPLID
7		Global EQ	INSTITUTION
8		Global GE	STRM
9	END IF
10	IF
11		Table	FAN_FA_TERM_VW
12		Field	ACAD_CAREER
13	=
14		String	GRAD
15	THEN
16	ASSIGN	Global	A_SELECT
17		String	GRAD
18	END ASSIGN
19	ELSE
20	ASSIGN	Global	A_SELECT
21		String	F
22	END ASSIGN
23	END IF

FAPDGRADS

In the example, ACAD_CAREER is the field name for career. The first section of the equation assigns the global variables needed by the equation engine to identify the proper Career. The second section tells the system which table, field, and field values are to be evaluated by the equation (ACAD_CAREER = GRAD). Based on the table/field value, the 'Assign Global A_SELECT' statement instructs the system to select the student, in this example, for the particular packaging plan (if the student's career equals GRAD, assign the student to 'Graduate' packaging plan).