Package Schedule Attributes Guide

Use this workbook to configure a calculation to determine the number of months for a student, and how to treat the summer term if there is enrollment in the summer.

Workbook Description

The file name for this workbook is PKGSCHEDATTRIB.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
OPEID	A	Y	String 8 digit number	U.S. Department of Education assigned OPEID. Refer to the OPEID column of School Guide and ensure the OPEIDs in both this workbook and the School workbook remain in sync. List the primary OPEID first if multiples exist. Separate each OPEID with the "~" character. Example: 12345677~12345678~12345679 First 6 characters of first valid value will be updated to SCHOOL_CONFIGURATION.OPEID
NonTerm ACY Months	B	No	Groovy script	Non-Term ACY Months Calculation. Applies to all OPEIDs listed in School Workbook.
Term PP Months	C	No	Groovy script	Term Payment Period Months Calculation. Applies to all OPEIDs listed in School Workbook.
Minimum Number of Credits	D	Yes	Integer	Minimum Number of Credits in Final Academic Year before Moving Courses into Previous Academic Year. Applies to all OPEIDs listed in School Workbook.
Summer Term Script	E	N	Groovy script Returns an enumeration value.	Defines if the Summer Term should be treated as a Header or Trailer. This is where you can control if the Summer Term should be packaged and if it should be packaged as a Header or Trailer. If this field is blank the system automatically defaults students with an enrollment in a Summer Term to be a Summer Trailer unless the Summer Term is prior to the 1st academic year, then the Summer Term is considered a Header
Grade Level Progression	F	N	Groovy script Returns an integer.	Returns a grade level which is used to determine annual borrowing limits for student loans. If not script is provided, or script produces an error, than the grade level calculation is made using an existing hardcoded script.

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

See Set General Permissions Matrix.

Understanding How the Baseline Configuration Works

Configure the Summer Term as a Header or Trailer

Using groovy script, you can configure the system to add a Summer Term automatically as a Header or a Trailer, if there is enrollment in the term. The configuration to control this behavior has two controls, first the CSV file and second, the groovy script.

1. The CSV File
   1. PKGSCHEDATTRIB.csv
   2. Column: SUMMER_TERM_SCRIPT (this will be the file path)
   3. Data Type: Groovy Script

• Level: Set per OPEID
  • The Groovy Script

The following code block is a simple sample Groovy Script that would return a Summer Term as a Summer Trailer. Sample Summer Trailer Groovy Script

1	return "trailer";

Summer Header or Trailer Groovy Script: Explained

You have complete flexibility through Groovy Scripting to treat Summer Terms as Headers or Trailers globally or for very specific student populations.

Review the following table to see an example of a few simple scripts and their descriptions.

Sample Groovy Script	Description
return "header";	The system automatically defaults students with an enrollment in a Summer Term to be a Summer Header
return "trailer";	The system automatically defaults students with an enrollment in a Summer Term to be a Summer Trailer If the Summer Term is prior to the 1st academic year, then the Summer Term is considered a Header
null	The system automatically defaults students with an enrollment in a Summer Term to be a Summer Trailer If the Summer Term is prior to the 1st academic year, then the Summer Term is considered a Header