Data Requirements
The data requirements for the functional components of the Communication Template Setup are included below.
Type Code
File
Optional Screen Only visible for "File" content types. Upload File and "Select..." button Allows the user to choose a File to send to the system Required when Content Type is "File" Text and Button Select... (nothing selected) CFP Tab CFP Settings Career Level This field determines if the Undergraduate or Graduate College Financing Plan is sent when generating a communication configured with this template. Optional
pdf.
3
| Section | Field Name | Description | Required/Optional | Type | Values | Business Rules |
|---|---|---|---|---|---|---|
| Template Name | Name of the Template | Required | textbox | alpha-numeric | ||
| Content Type | Type of communication | Required | drop-down |
|
When a user selects a Content Type of "File", hide all areas except "Upload File" When a user selects a Content Type other than "File," hide the "Upload File" area and show all other areas. | ||||||
| Description | Description of the communication | Required | textbox | alpha-numeric | ||
| Context Load Settings | Context Load Settings are only available for Content Types of Text, HTML, and PDF. If the user selects a Content Type of "File," then the Context Load Settings should be hidden and the "File Upload" area should be displayed instead. | |||||
| Load Academic Plan Data | Optional | Check box |
| Defaults to unchecked | ||
| Load EST Record Disbursements Data | Optional | Check box |
| Checking this box will allow the communications engine to report adjustments on the disbursements. Defaults to unchecked. | ||
| Load Documents Context Data | Optional | Check box |
| Defaults to unchecked | ||
| Load R2T4 Context Data | Optional | Check box |
| Defaults to unchecked | ||
| Load R2T4 PWD Context Data | Optional | Check box |
| Defaults to unchecked | ||
| Load Last Payment Period Name | Optional | Check box |
| Defaults to unchecked | ||
| Load Last Enrollment End Date | Optional | Check box |
| Defaults to unchecked | ||
| Load Address Data | Optional | Check box |
| Defaults to unchecked | ||
| Load Phone Number Data | Optional | Check box |
| Defaults to unchecked | ||
| Load Email Address Data | Optional | Check box |
| Defaults to unchecked | ||
| Load Parent/Spouse/Reference Data | Optional | Check box |
| Defaults to unchecked | ||
| Load Portal Data | Optional | Check box |
| Defaults to unchecked | ||
| Load Student Information System Record Data | Optional | Check box |
| Defaults to unchecked | ||
| Load Student Additional Information Data | Optional | Check box |
| Defaults to unchecked | ||
| Load ISIR Data | Optional | Check box |
| Defaults to unchecked | ||
| Load Complete ISIR Data | Optional | Check box |
| Defaults to unchecked | ||
| Load Student SAP Context | Optional | Check box |
| Defaults to unchecked | ||
| Load Student Communication History | Optional | Check box |
| Defaults to unchecked | ||
| Load College Financing Plan Data | Optional | Checkbox |
| Defaults to unchecked | ||
Content | Content stores the text or HTML content for the template. | Required for all Types except File | Text area | HTML or alpha-numeric | Content is a required field for all Content Types except File. | |
Testing | Student (e.g. ExternalId or SSN) | Allows user to provide a Student ID for testing | Optional | textbox | alpha-numeric | |
| Preview With Student | Generates a pop-up with a simulated output of the current HTML content, using the specified student's information. | Optional | Button | read-only | The Preview uses the selected student's data. |
File Upload
When a user adds a new Template and selects a Content Type of "File," the File Upload area becomes visible.
This area should be hidden for all non-File content types.
When a user clicks Select, show all files with a supported Content Type.
If the selected file's size is greater than 2MB, R8 should prevent uploading and show an error message.
The initial file list should be filtered to show only supported Content Types (MS Word .doc, .docx, PDF).
When a user has provided a file:
- Populate the "File Name" field.
- Attempt to detect the Content Type.
- Populate the MIME type.
- If the Template Name is blank, then populate the Template Name with the file's name.
- Allow the user to Preview the file by clicking the Preview button.
| CFP Tab | ||||||
| CFP Settings | Career Level | This field determines if the Undergraduate or Graduate College Financing Plan is sent when generating a communication configured with this template. | Optional | Drop-down |
| |
| Cost of Attendance Settings | Housing and Meals | The housing status selected here is used to associate cost items to the Off Campus Residence or On Campus Residence category in relation to the ISIR Housing Status for the Housing and Meals section on the College Financing Plan . | ||||
pdf. There is also the option to define costs and choose the column to display those costs on the CFP (On Campus Residence or Off Campus Residence) when the student does not have an ISIR for the FAY. | Optional |
4 section grid with dropdowns |
| |||||
| EFC Settings | EFC Based on FAFSA | The default value for this field is 9 months. | Optional | Drop-down | 1,2,3,4,5,6,7,8,9,10,11,12 | The default value for this field is 9 months. |
| EFC Based on Institutional Methodology | If no value is provided in this field, the field is left blank on the College Financing Plan pdf. | Optional | Numeric | Allows up to 5 positive characters, no decimals, no negative values | ||
| Scholarship Settings | Employer Paid Tuition Benefits | The total amount of any awards in payment periods with the specified Federal Award Year for the funds selected here is used for the Employer Paid Tuition Benefits field in the Scholarships section of the College Financing Plan pdf. | Optional | 6 column grid |
| |
| School-Paid Tuition Benefits | The total amount of any awards in payment periods with the specified Federal Award Year for the funds selected here is used for the School-Paid Tuition Benefits field in the Scholarships section of the College Financing Plan pdf. | Optional | 6 column grid |
| This field only displays if Career Level = Graduate and does not display if Career Level = Undergraduate. | |
| Tuition Remission/Waiver | The total amount of any awards in payment periods with the specified Federal Award Year for the funds selected here is used for the Tuition Remission/Waiver field in the Scholarships section of the College Financing Plan pdf. | Optional | 6 column grid |
| This field only displays if Career Level = Graduate and does not display if Career Level = Undergraduate. | |
| Grant Settings | Scholarship for Disadvantaged Students | The total amount of any awards in payment periods with the specified Federal Award Year for the funds selected here is used for the Scholarship for Disadvantaged Students field in the Scholarships section of the College Financing Plan pdf. | Optional | 6 column grid |
| |
| Loan Option Settings | Institutional Loan Origination Fee | The value listed here displays as the Institutional Loan Origination Fee in the Loan Options section on the College Financing Plan pdf. Text is an allowable value of up to 12 characters (e.g. variable). If no value is configured, the field displays as blank. | Optional | Text | alpha-numeric field; allowable characters up to 12 | |
| Institutional Loan Interest Rate | The value listed here displays as the Institutional Loan Interest Rate in the Loan Options section on the College Financing Plan pdf. Text is an allowable value of up to 12 characters (e.g. variable). If no value is configured, the field displays as blank. | Optional | Text | alpha-numeric field; allowable characters up to 12 | ||
| HRSA Loans | The total amount of any awards in payment periods with the specified Federal Award Year for the funds selected here is used for the HRSA Loans field in the Loan Options section of the College Financing Plan pdf. | Optional | 6 column grid |
| This field only displays if Career Level = Graduate and does not display if Career Level = Undergraduate. | |
| HRSA Loans Interest Rate | Specifies Interest Rate | Optional | Text | alpha-numeric field; allowable characters up to 12 | This field only displays if Career Level = Graduate and does not display if Career Level = Undergraduate. | |
| HRSA Loans Origination Fee | Specifies Origination Fee | Optional | Text | alpha-numeric field; allowable characters up to 12 | This field only displays if Career Level = Graduate and does not display if Career Level = Undergraduate. | |
| Work Options Settings | Work Study Hours Per Week | The value listed here displays as the Hours Per Week in the Work Options section on the College Financing Plan pdf. Text is an allowable value of up to 12 characters (e.g. 20 to 30). If no value is configured, the field displays as blank and if no work study award is present for the student the field displays as blank. | Optional | Text | alpha-numeric field; allowable characters up to 12 | |
| Other Campus Job | The total amount of any awards in payment periods with the specified Federal Award Year for the funds selected here is used for the Other Campus Job field in the Work Options section of the Undergraduate College Financing Plan pdf. | Optional | 6 column grid |
| This field only displays if Career Level = Undergraduate and does not display if Career Level = Graduate. | |
| Assistantships | The total amount of any awards in payment periods with the specified Federal Award Year for the funds selected here is used for the Assistantships field in the Work Options section of the Graduate College Financing Plan pdf. | Optional | 6 column grid |
| This field only displays if Career Level = Graduate and does not display if Career Level = Undergraduate. | |
| Other Options Settings | Income Share Agreement | The total amount of any awards in payment periods with the specified Federal Award Year for the funds selected here is used for the Income Share Agreement field in the Other Options section of the College Financing Plan pdf. | Optional | 6 column grid |
| |
| Percentage of Income | The value entered here displays as the Percentage of Income for the Income Share Agreement in the Other Options section on the College Financing Plan pdf. Text is an allowable value of up to 12 characters if 'Specify % is selected (e.g. 20 to 30). If no value is configured, the field displays as a zero. | Optional | Textbox | Displays text field to enter % (alpha-numeric field; allowable characters up to 12). | ||
| Months | The value entered here displays as the Number of Months for the Income Share Agreement in the Other Options section on the College Financing Plan pdf. Text is an allowable value of up to 12 characters if 'Specify Number of Months is selected (e.g. 20 to 30). If no value is configured, the field displays as a zero. | Optional | Textbox | Displays text field to enter number (alpha-numeric field; allowable characters up to 12) | ||
| Next Step Settings | Next Steps Text | Unlimited characters, but must keep the document to 2 pages. | Optional | WYSIWYG Editor | ||
| Customized Information from UUS Settings | Customized Info for UUS Text | Unlimited characters, but must keep the document to 2 pages. | Optional | WYSIWYG Editor |