IntroductionIntroduction

...

A Refresh button above the grid functions to update the grid with newly created data. Clicking the ‘Add' button above the grid causes fields on the Awarding Tool: Selections subpage to be enabled for new entry.

Add screen shot

Awarding Tool: Selections Subpage

...

There are three functional buttons on the Selections subpage, for users with ‘Edit Awarding Tool: Selections’ permission: Execute, Cancel, and Save Selected Parameters.

1. Execute: Initiates the Selections Process. Compiles and saves/stores the selected data and calculates award amounts based on that data, to be presented on the Results page, for the period selected.

   1. Process creates a list of students based on a run of the selected query plus the Period Start Date range entered and sort sorts the list based on Ranking score and sorting priority, including renewal prioritization, as determined by Ranking and Priority selection, if present. (If no Ranking and Priority is selected, students will be sorted in alphabetic order only, by last name then first name.)

      1. Process determine determines Existing Award value Amount values for students based on amounts already awarded to an eligible student from the selected fund, for the selected period. 

      2. Process calculates Eligible Amount of values for awards for the students, from the selected fund, for the selected period, based on Packaging Philosophy/Fund rules, without consideration of Fund Budgets, and including any amounts already awarded.

      3. Process calculates Award Amount values for each student for the period selected:

         1. Awards will be calculated only for open periods (FAYs, Academic Years, or Payment Periods.)

            1. In the instance of multiple open periods for a student, amounts will only be calculated for the first open period chronologically.

         2. Amount will include any existing award amounts for the selected period (not the difference.)

         3. Award Amount value will match the Eligible Amount value unless:

            1. A budget exists for the selected fund and, based on a running total of Award Amount values assigned to students in priority/sort order, the fund budget has been exhausted.

               1. When fund budgets have been exhausted, remaining Award Amount values for students, based on priority/sort order, should be $0 .

               Award Amount could not be

               1. (or reflect part of the Eligible Amount, if the student is the last to be awarded before the budget is exhausted.)

            2. Award Amount could not be calculated because of a packaging blocker for the student.

         4. When the Period Type selected is ‘Payment Period,’ the FAY or AY award (depending on Fund Scope) will be adjusted to reflect an amount to be awarded for a single Payment Period. Awards for any future Payment Periods within the FAY/AY will be created as $0 awards.

   2. A row is created in the process grid when the process Selections Process is initiated, with data from the Selections page and including a Selections Process Date and , a Selections Process ID, and a Selections Process User.

      1. Process grid record Status:

         1. While process is running, the status will be ‘Processing’ and all fields/buttons on the Selections page will be disabled for editing.

         2. If Selections Process completes successfully, the Status will update to ‘In Review’ and all fields/buttons on the Selection page will remain disabled for editing.

         3. If Selections Process fails, the Status will update to ‘Error’ and fields/buttons on the page will be re-enabled for editing/selection.

2. Cancel: Clears all selected/entered values without saving and closes the page.

3. Save Selected Parameters: Appends the entered ‘Awarding Selections Name' value to a 'Process Type' of 'Awarding Selections’ as the parameter set name and saves the selected/entered data with the name to Saved Parameter Sets.

   1. After saving, the set must be retrieved from Saved Parameter Sets in order to Execute.

   2. If the Awarding Tool: Selections process has been run for the parameter set, selecting to Execute again from the Saved Parameter Set will initiate a new process for the same parameters.  

   3. Saved Parameter Sets are available in Scheduled Processes options.

Add screen shot

Awarding Tool: Results Subpage

...

Button Options/Executing the Results Process (Step 2 of the Awarding Tool)

Execute: Initiates the Results Process.

...

There are three functional buttons on the Selections subpage, for users with

...

‘Edit Awarding Tool:

...

Results’ permission: Execute, Terminate, and Download Report.

1. Execute: Initiates the Results Process. Button will be disabled until at least one record in the Student and Awarding Information table has an '

   Approved

   Approve' checkbox selected.

   Should launch

   Clicking the button will launch a confirmation pop-up with buttons OK and Cancel.

   Message

   : Executing

   of the pop-up reads: “Executing this process will apply positive Award Amounts to the students' Academic Plans. If the system is unable to award a student, that student will be skipped in the awarding process. Please review the Process Log and output file to confirm awarding, after the process has completed.

2. Cancel button should return the user to the Results page.

OK button should

” Clicking ‘Cancel’ will close the pop-up and the Results process is not kicked off. Clicking ‘OK’ will kick off the Results Process:

Awarding (or attempting to award) the Award  Amount value greater than zero to each student for the selected fund. (See FR 4.3.1)

3. When the Results process starts:

   1. Launch a toast message: "Process Executed" and disable all buttons on the page. 

   2. Update Status in the Awarding Tool process grid to 'Processing'.

   3. Assign and populate 'Results Process Date' value, 'Results Process ID' value, and 'Results Process User' value in the process grid.

4. If the process completes successfully:

   1. Update the Status in the process grid to 'Complete'

   2. Re-enable the Download Report button for the selection

If the Process fails:

5. Update the Status in the process grid to 'Error'

Re-enable

1. System will attempt to package all approved Award Amounts for students. If there is an Existing Award amount, the existing award will be updated to reflect the new approved amount. Awards created through the Awarding Tool process will have an ‘AT’ icon on the Academic Plan.

2. Record in Process Grid will be updated with a Results Process Date, a Results Process ID, and a Results Process User value, and the Status in the record will be updated.

3. While the Results Process is running, status will be 'Processing' and all buttons/fields on the page will be disabled for

   that

   editing/selection.

6. Terminate

   1. Should only be enabled for users with 'Edit Awarding Tool: Results' permission.

   2. Should launch pop-up message with button options OK and Cancel.

      1. Message: You have selected to terminate this process. Options to Edit/Approve amounts and execute awarding will no longer be available. 

      2. Cancel button should close the pop-up.

      3. OK button should:

         1. Disable Execute button, Edit icon, and Approved column checkboxes. 

         2. Update the Status for the record in the process grid to 'Terminated'.

7. Download Report

Add screen shot

Output

Process Log

Reports

1. 1. If the process completes successfully, status will updated to ‘Complete' and 'Download Report’ button will be re-enabled

   2. If the process fails, status will be updated to ‘Error’ and buttons/fields on the page will be re-enabled for editing/selection.

2. Terminate: Disables the Results Process from ever being run for the selections. Clicking the button willlaunch a pop-up message with button options OK and Cancel. Message of the pop-up reads: “You have selected to terminate this process. Options to Edit/Approve amounts and execute awarding will no longer be available.” Clicking ‘Cancel’ will close the pop-up. Clicking ‘OK’ will disable the Execute button as well as the Pencil Icon and Approve column checkboxes, and the Status for the record in the process grid will be updated to 'Terminated'.

3. Download Report: Downloads .csv file report for the Selections and Results processes. After the Selections Process has run successfully, but before the Results Process has been executed, the spreadsheet report contains all data displayed on the Results page plus student-level data values for each data element that was part of the selected Query and the selected Ranking and Priority (if applicable.) The same spreadsheet report is available after the Results Process completes successfully, except it will include a column that displays the amount of award actually applied to the student’s Academic Plan. A comparison of the Award Amount (value approved for the Results Process) and Amount Awarded (amount actually packaged for the student) will confirm if the student received the same amount approved within the Awarding Tool. Reports are also available within the Process Log (see sections below) and, after the Results Process has completed, as a link in the Awarding Tool process grid.

Add screen shot

Output for Awarding Tool Processes

Process Log

Selections

Results

Reports

Additional Information

option for ALL AT awards to be Manual- explain configuration optionAward Amount with Existing Awards- existing award will be updated to new amount