Student Hold Guide

This workbook allows institutions to define types of student record holds, and whether the valid ISIR process will run for each student on the respectively defined type of Student Record Hold.

Workbook Description

The file name for this workbook is STUDENT_HOLD.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
Student_Record_Hold_Type A Y

String

Alphanumeric ASCII text,up to 255 characters

Label of the Student Record Hold.

Example Value:

  • Fraud
Allow_Val_Isir_Proc B Y

Boolean

  • TRUE
  • FALSE

To specify whether the system should run the Valid ISIR Process for any student on the respectively defined type of Student Record Hold.

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) through Roles Management in order to enable and view the configuration in the UI.

  • Student
  • Student Holds

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 Summary > Student Holds > Student Record Hold