1. Configuration Reference for Student Financial Planning
  2. ISIR Verification Codes Guide

ISIR Verification Codes Guide

Use this workbook to define verification clearing logic, document requests, and additional student notification messages by verification comment code and tracking group.

Workbook Description

The file name for this workbook is ISIR_VERIFICATION_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

String

Alphanumeric ASCII text, up to 255 characters.

ISIR verification code Number.
Aid Year B Y

String

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.

Groovy Return Values:

return true; (Clears Code)

return false; (Manual Review)
Documents Required D N

Groovy script

Documents required to resolve verification requirements. If an acceptable document is on file previously, another request won't be triggered.

Additional Notification Message E N

String

Alphanumeric ASCII text, up to 4000 characters.

Additional notification to student exclusive of document notifications.
Verification Tracking Group F N

String

Alphanumeric ASCII text, up to 255 characters.
  • Verification_Tracking_Group
  • AGGREGATE
  • CHILD_SUPPORT
  • CUSTOM
  • HOUSEHOLD_RESOURCES
  • STANDARD

Only applies to Verification codes.
Verification Status Code G Y

Enumeration

  • VERIFIED
  • WITHOUT_DOCUMENTATION
  • SELECT_NOT_VERIFIED
  • BLANK

Select the verification status code to communicate to COD.

If ED regulations change mid-Award Year, you can add a new row to this workbook for the same verification tracking group, comment code, and award year to communicate different values based on the Effective_Date.

Since the Effective_Date is only related to the Verification_Status_Code, all other values must be equal to the prior row to avoid triggering a validation error when loading the configuration workbook.

Columns that must communicate the same values in all rows for the same verification tracking group, comment code, and award year:
  • Code_Number.
  • Aid_Year.
  • Auto_Code_Clearing_Logic.
  • Documents_Required.
  • Additional_Notification_Message.
  • Verification_Tracking_Group.
Note: If the field is left empty, the V (Verified) code is sent.
Effective Date H Y

Date

Select the date to start communicating the Verification Status Code to COD. This is compared to the date that the ISIR was set to Valid status; not the date the ISIR was received.

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 Permissions and/or Document Permissions 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