Late Disbursement PWD Criteria Guide
Use this workbook to define how to disburse late disbursements and post-withdrawal disbursements.
Workbook Description
The file name for this workbook is LATE_DISBURSEMENT_PWD_CRITERIA.csv.
Configuration Workbooks are delivered in the form of Excel spreadsheets. In these
spreadsheets, every configurable field is represented as a spreadsheet column and
there are as many spreadsheet rows as needed for that particular configuration. Here
are the column descriptions:
- Field Name.
- Column: Spreadsheet column associated with the field.
- Required?: Denote if you're required to populate the field or not.
- Field Type and Accepted Values:
- String: These are usually alphanumeric.
- Integer: Numeric, a whole number.
- Double: Numeric with places to the right of the decimal.
- Enumeration: List of values.
- Boolean: True or False, Yes or No.
- Groovy script: A logical query using groovy script.
- Date: yyyy-mm-dd format.
- Description.
Field Name | Column | Required? | Field Type and Accepted Values | Description |
Fund_Code | A | Y | Alphanumeric ASCII text, up to 255 characters. | Fund Code for which you are defining disbursement rules. |
Disbursement_Criteria_Type | B | Y | Enumeration:
|
Define whether the criteria apply to Late Disbursements, Post-withdrawal Disbursements. or Both. |
Disbursement_Criteria_Description | C | Y | Alphanumeric ASCII text, up to 255 characters. | Disbursement Criteria Description for the UI. |
Disbursement_Criteria | D | N | Groovy script or blank. | Disbursement logic returning a value of TRUE, meaning criteria are met, or FALSE, meaning criteria weren't met, or null. If null, criteria aren't evaluated and not displayed on the UI. |
Trigger_Cancellation | E | Y | Enumeration: TRUE or FALSE. | If the Disbursement Criteria are FALSE, then
|
Enabled | F | Y | Enumeration: TRUE or FALSE. |
|
- This workbook is optional.
- You can add, edit, or disable disbursement criteria using this workbook.
- These validation parameters apply to this workbook:
- Values are required for the FUND_CODE, DISBURSEMENT_CRITERIA_DESCRIPTION, or ENABLED fields if any other field value is provided.
- Values are required for the DISBURSEMENT_CRITERIA_TYPE, DISBURSMENT_CRITERIA, and TRIGGER_CANCELLATION fields if the ENABLED field column = TRUE.
- If validation fails, the file will not load and an error will display on the configuration loading page in FAS (administrative) UI.
-
To add new criteria, populate the applicable fields using the validation parameters.
- To edit existing pre-defined criteria, ensure the configured DISBURSEMENT_CRITERIA_DESCRIPTION value matches an existing pre-defined criteria and the DISBURSEMENT_CRITERIA field is populated. This will override pre-defined criteria.
-
To disable an existing pre-defined criteria, ensure the configured DISBURSEMENT_CRITERIA_DESCRIPTION value matches an existing pre-defined criteria description and set the ENABLED column equal to FALSE. In this case, the pre-defined criteria is not evaluated.
- The DISBURSEMENT_CRITERIA groovy script is flexible enough to determine which students should shouldn't have criteria evaluated. If the output for the DISBURSEMENT_CRITERIA = NULL, then it will not be evaluated for that student. One scenario of this would be evaluating one enrollment status versus another. For example, you can write a script to be evaluated for active enrollment statuses versus Withdrawn or Graduated statues.