ISIR C Codes Guide

Use this workbook allows to define code clearing logic, document requests, and additional student notification messages by SAR c-code.

Workbook Description

The file name for this workbook is ISIR_C_CODES.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
Code Number	A	Y	Alphanumeric Alphanumeric ASCII text, up to 255 characters.	ISIR Code Number
Aid Year	B	Y	Alphanumeric Alphanumeric ASCII text, up to 255 characters in YYYY-YYYY format	Aid Year ISIR Code is associated to
Auto Code Clearing Logic	C	Y	Groovy script	Logic to correct ISIR field from document data. return true; (Clears Code) return false; (Manual Review)
Documents Required	D	N	Groovy script	Logic for document types and document codes required to resolve code, including subsequent document requests, along with whether all documents are required versus some. If required document isn't already present in the system. N/A (no return needed, document requests are fired off through method calls such as: documentRequest.addDocument("Doc Code", "Doc Owner").
Additional Notification Message	E	N	String Alphanumeric ASCII text, up to 4000 characters.	Additional notification to student exclusive of document notifications.
Future Auto Clear	F	N	Boolean	True: If code cleared once already, it will clear automatically on future ISIRs for the same award year as well as future award years. False: If code cleared once already, it will clear automatically on future ISIRs for the same award year. Null: Ignore previous clearances of code.

Enable the Configuration in the UI

You do not have to complete any setup in the user interface to enable this configuration.

Required Permissions

You must have a role with the following General Permission(s) and/or Document Permission(s) through Roles Management in order to enable and view the configuration in the UI.

• Student

See Set General Permissions Matrix.

Configuration in the User Interface

The configuration is visible in the Student Financial Aid User Interface if you navigate to the following screens:

1. Student Search > Student Record > USDE > ISIR Information

Refer also to the Baseline Configuration documentation in the Toolbox chapter.