Client Configuration Management: Programs and Terms
User Steps for Setup Process:
Navigate to the Export Processes screen
- Processes > Export Processes
- The user must have the appropriate permissions to the Export Setup Configuration Process.
- Permissions are set at Global Permissions > Process Permissions > Export Processes > Export Setup Configuration
Set parameters:
- Process Type - "Export Setup Configuration"
- Format - "CSV" or "XML"
3. Enterprise - Select One
4. Institution(s) - Select "All", one or multiple
5. Campus(es) - Select "All", one or multiple
6. Site(s) - Select "All", one or multiple
7. Setup Template(s) - Select "All", one or multiple
Click the "Export" button
- The system will export data from the Regent Database tables.
- The Process Log will record the export process
3. The user will see the following items:
A Process Log entry for the completed Export Setup Configuration process.
Exported file(s) are ready for the user.
With XML format, 1 file will be exported. When multiple templates are selected, all parent nodes will be exported to show the associations; however, sibling nodes that are not requested will not be included.
Clicking the "Cancel" button, cancels the export process and takes the user to a previous screen.
All export process errors will be logged in the Process Log.
Export Format
XML Format
The set-up configuration data will be exported in XML format by the system. The end result is that the DEX XSD template should mimic the Import Setup Configuration (XML) template and should be available for bulk export.
- The file is saved as a .xml file.
- Filename format: SetupConfiguration_XML_CCYYMMDD_HHMMSSmss.xml
- The date fields on the output file are in UTC time format
User Steps for Setup Import Process:
- Navigate to the Import Processes screen
- Processes > Import Processes
- The user must have the appropriate permissions to the Import Setup Configuration Process.
- Permissions are set at Global Permissions > Process Permissions > Import Processes > Import Setup Configuration
- The user must have the appropriate permissions to the Import Setup Configuration Process.
- Processes > Import Processes
2. Set Process Type to "Import Setup Configuration (XML)" ("Import Setup Configuration (CSV) is not currently available)
3. Select the file
4. Click on the Import button to update the Setup Configuration.
The system will:
- import data into Regent Database staging tables
- match records using external ID.
- If external ID is not found, a new record is inserted.
- If external ID is found, a record is updated.
- Ensure that Process Log records the import process
- Update appropriate reports and screens
Once the import process is complete, users can expect to see the following:
- A "File Submitted for Processing" message, immediately after importing on the Import Setup Configuration screen
A Process Log entry for the completed Import Setup Configuration process.
Setup screens are updated with new/updated data.
Additional Notes
In order for the batch program and terms update import and export processes to work properly, all of the following setup entities need to have a unique external Id: Enterprise, Institution, Campus, Site, Program, Term, EnrollmentLevelSetup, ProgramGroup. Enterprise, Institution, Campus, Site, Programs, Terms and ProgramGroups have required an externalId prior to the current release.
For EnrollmentLevelSetup, an 'externalId' field is available as of 4.1.1.0. On the Enrollment Level Setup screen in Regent Award, this field is called 'External Enrollment Level Id'. This is now a required field and it needs to be pre-populated with a unique value across the Regent Award database. Regent needs this field to have external ID value to allow import of ProgramTerm association. As a part of the 4.1.1.0 Release Regent ran a script to pre-populate this field with a temporary value. Customers must update the values for this field for their currently existing and new enrollment level set up to ensure that program and terms update import and export processes work correctly. The value for this field must conform to the following standards:
- cannot be null
- can be letters or numbers
- 60 characters maximum
- the value must be unique across the database
Appendices
Data Dictionary for Import-Export Templates
Please, note that an Excel version of the data dictionary containing lookup values and reference tables is available as well.
General Instructions
Template Rules: |
1. If external ID is not found, a new record is inserted. If external ID is found, a record is updated. |
2. The following are the rules when updating data:
|
Programs
Field Ref. | Common Field Name | XML Schema Field Name | Description | Required/ Optional | Inheritable? | Type | Min Length | Max Length | Values | Business Rules |
---|---|---|---|---|---|---|---|---|---|---|
1 | External Enterprise ID | <Enterprise> externalId | Associated Enterprise | Required | No | string | 1 | 60 | Used for matching | |
2 | External Institution ID | <Institution> externalId | Associated Institution | Required | No | string | 1 | 60 | Used for matching | |
3 | External Campus ID | <Campus> externalId | Associated Campus | Required | No | string | 1 | 60 | Used for matching | |
4 | External Program ID | externaIId | Program ID from the SIS. | Required | No | string | 1 | 60 |
| |
5 | Program Name | name | Name of the Academic Program | Required | No | string | 1 | 80 | Must be unique within a give Campus | |
6 | Program Display Name | displayName | Display name of the Academic Program | Required | No | string | 1 | 500 | ||
7 | Program Sites | allSites | Indicates whether the program is associated with all sites or not | Required | No | boolean |
|
| ||
8 | Default Enrollment Level Setup | externalDefaultEnrolment LevelSetupId | Type of Academic Period | Optional | No | string | 0 | 60 | Enrollment Level Setup values as set up in the system |
|
9 | School Of | schoolOf | Optional | No | string | 0 | 500 |
| ||
10 | Specialization | specialization | Optional | No | string | 0 | 500 | |||
11 | Program Type | programTypeCode | Type of Program | Required | No | string |
| |||
12 | Program Credentials | programCredentialCode | This data element will be sent to COD as part of the 14/15 SULA requirements. | Optional | No | string | Values must be validated using the following rules: {Program Type} - {permitted Program Credential}
| |||
13 | HPPA | hppaTypeCode | Indicator if students in the program are eligible for additional unsub loan amount. | Required | No | string | Values must be validated against HPPAType table | |||
14 | Anticipated Enrollment Type | defaultEnrollment LevelTypeCode | This is the value that will be used to anticipate a students enrollment level for this program, when packaging is run, if the student does not have actual enrollment. | Required | No | string |
| |||
15 | CIP Code | cipCode | Classification of Instructional Programs (CIP) Code | Required | No | string | 7 | 7 | xx.xxxx |
|
16 | Pell Formula | pellFormulaTypeCode | The Pell Formula to be used for packaging for this program. | Optional | No | string |
| |||
17 | Pell COA | pellCOA | Cost of Attendance used for Pell Calculation. This COA amount is based on a specific calculation for the Pell COA. | Optional | No | double | 0 | 7 | Value range from 0.00 to 99999.99 |
|
18 | FSA Eligible Start Date | FSAEligibleStartDate | These dates can be used to control when a program is eligble for FSA. | Optional | No | date | YYYY-MM-DD |
| ||
19 | FSA Eligible End Date | FSAEligibleEndDate | These dates can be used to control when a program is eligble for FSA. | Optional | No | date | YYYY-MM-DD |
| ||
20 | Teach Eligible | teachEligible | Indicator if the program is eligible for TEACH funds | Required | No | boolean |
|
| ||
21 | Attendance Taken | useAttendance | This uses attendance to determine disbursement eligibility for the student. | Optional | Yes | boolean |
| |||
22 | Instructional Days Per Week | daysPerWeekInstruction | Determines whether schools will use weekend days in their disbursement scheduling. | Optional | Yes | integer |
| |||
23 | Special Program | specialProgram IndicatorCode | Indicator of the special program type being covered by aid. | Required | No | string |
| |||
24 | AY Units | academicYearUnits | Defines number of units per Academic Year. | Optional | Yes | double | 0 |
| ||
25 | AY Weeks | academicYearWeeks | Defines number of weeks per Academic Year. | Optional | Yes | integer | 0 |
| ||
26 | PC Years | numberOfYears | Program completion time span in years | Required | No | integer | 1 | 1 | Values 1 through 7 | |
27 | PC Units | numberOfUnits | Program completion time span in units | Required | No | double | 1 | 9 | Value must be between 0.00 to 99999.99 | |
28 | PC Weeks | numberOfWeeks | Program completion time span in weeks | Required | No | integer | 1 | 3 | Value must be between 0 - 999 | |
29 | PC Courses | numberOfCourses | This field is needed to display the number of courses required to complete the program in the financial planner. | Optional | No | integer | 0 | 4 | Value must be between 1 and 9999. | |
30 | Estimate Non FSA Eligible | estimateNonFSAEligible | Indicates whether awards can be estimated for anticipated periods. | Required | No | boolean |
|
| ||
31 | Open For Transfer or Program Changes | openForTransfersProgram Change | Applies to both internal transfers (program changes) and external transfers. | Required | No | bollean |
|
| ||
32 | Open for New Enrollment | openForNewEnrollment | Indicates whether this program is available to new/prospective students. SNAP uses this flag in REM to determine which programs to display for selection. | Required | No | boolean |
|
| ||
33 | Stop Positive Disb Date | stopPositiveDisbursementDate | The date when positive disbursements for students in this program will be stopped. | Optional | No | date | YYYY-MM-DD |
| ||
34 | Allow Anticipated Track Switch | allowAnticipatedTrackSwitch | Indicator if Track switches are allowed in the program. | Required | No | boolean |
|
| ||
35 | Batch Package | batchPackage | Indicates whether the prograam can be batch packaged | Required | No | boolean |
|
| ||
36 | Academic Calendar Type | academicCalendarTypeCode | The field is an indicator of how the loan eligibility should be calculated for the term. | Optional | Yes | string |
| |||
37 | Academic Period Type | academicPeriodTypeCode | Type of Academic Period | Optional | Yes | string |
| |||
38 | Unit Type | unitTypeCode | Type of Unit | Optional | Yes | string |
| |||
39 | GLP L2 Units | unitsForGradeLevel2 | Total Number of units required to be completed in order to reach designated grade level. | Required | No | double | 1 | 8 | Value must be between 0.00 to 99999.99 | Grade Level Progression Units are determined by Program Type
|
40 | GLP L3 Units | unitsForGradeLevel3 | Total Number of units required to be completed in order to reach designated grade level. | Required | No | double | 1 | 8 | Value must be between 0.00 to 99999.99 | |
41 | GLP L4 Units | unitsForGradeLevel4 | Total Number of units required to be completed in order to reach designated grade level. | Required | No | double | 1 | 8 | Value must be between 0.00 to 99999.99 | |
42 | GLP L5 Units | unitsForGradeLevel5 | Total Number of units required to be completed in order to reach designated grade level. | Required | No | double | 1 | 8 | Value must be between 0.00 to 99999.99 | |
43 | GLP L6 Units | unitsForGradeLevel6 | Total Number of units required to be completed in order to reach designated grade level. | Required | No | double | 1 | 8 | Value must be between 0.00 to 99999.99 | |
44 | GLP L7 Units | unitsForGradeLevel7 | Total Number of units required to be completed in order to reach designated grade level. | Required | No | double | 1 | 8 | Value must be between 0.00 to 99999.99 | |
45 | AY Crossover Date Note: The month and day for the AY will display in separate columns. | AYCrossoverMonth | Crossover date on which to use the next Federal Award Year ISIR | Optional | Yes | integer | 0 | 2 | Values 1 though 12 |
|
46 | AY Crossover Date Note: The month and day for the AY will display in separate columns. | AYCrossoverDay | integer | 1 | 2 | Values 1 though 31 | ||||
47 | Payment Period Crossover Date Note: The month and day for the PP will display in separate columns. | PPCrossoverMonth | Crossover date on which to use the next Federal Award Year ISIR. | Optional | Yes | integer | 0 | 2 | Values 1 though 12 |
|
48 | PPCrossoverDay | integer | 1 | 2 | Values 1 through 31 | |||||
49 | R2T4 Inadvertent Overpayments Date | dateUsedToIdentR2T4Inadvert OverpaymentCode | Date Used to Identify R2T4 Inadvertent Overpayments | Optional | Yes | string |
| |||
50 | Date Used to Identify R2T4 Inadvert Overpayments Disbursement Option Code | dateUsedToIdentR2T4 InadvertentOverpayments DisbursementOptionCode | Date Used to Identify R2T4 Inadvertent Overpayments Disbursement Options | Optional | Yes | string |
| |||
51 | Alt-EFC Months | altEFCMonths | This is period of months in a standard academic year of this program. It defines number of months for Alt-EFC period. | Optional | Yes | double | 0 | 2 | Values 1 through 12 |
|
52 | Academic Plan Payment Period Projection Method | nonTermDisbAdjMethodCode | The option chosen here dictates how Regent Award will extend a payment period end date when there is not enough registration units to anticipate completion the payment period. | Optional | No | string |
| |||
53 | Number of Days | nonTermDisbAdjDays | Defines the number of days when the adjustment method is fixed. | Optional | No | integer |
| |||
54 | Courses for Anticipation | coursesForAnticipation | Used to calculated per course costs for anticipated packaging | Optional | Yes | integer | 0 | 3 | Values between 0 and 999. | For BBAY3 Programs Only. |
55 | Extend Academic Years for Non-Standard Term | extendAcademicYears ForNonStdTerm | Allows for the extension of Academic Years for Non-standard term. | Optional | Yes | boolean |
|
| ||
56 | Auto Include Header Trailer | autoIncludeHeaderTrailer | Indicates whether Regent Award will automatically package a 3-term loan based on registration adjacent to a header/trailer term. The award would be split evenly across each of the three terms, if this setting is "true" and the student is in a SAY program with registration for header/trailer. | Required | No | boolean |
|
| ||
57 | Days Between Course Drop And Task | daysBetweenCourse DropAndTask | This field pertains only to the "Review Completed Courses No Current Registration" task. When a student completes their current course(s) and is not registered for another course(s) within X number of days, the student should be reviewed for R2T4. This task will trigger on the X day after the last completed course for the student. In this field, enter the number of days after the last completed course in which the R2T4 review should be triggered / completed. | Optional | Yes | integer | 0 | 3 | Values 0 through 999 | The field 'Days between last completed course and task' on program set up will inherit it's value from campus set up based on the program's academic type. For example, if campus set up is the following:
|
58 | Days Between Last Completed Course and Task | daysBetweenLastCompleted CourseAndTask | The number of days between the last day of the last course the student withdrew from and the day you want the task triggered in order to review for R2T4. | Optional | Yes | integer | 0 | 3 | Values 0 through 999 | |
59 | Days Between Term End Date and Task | daysBetweenTerm EndDateAndTask | Configurable field to support the 'Review Unofficial Withdrawal for R2T4' task. This field should contain the number of days after the term end date that the "Review Unofficial Withdrawal for R2T4" task should be triggered. | Optional | Yes | integer | 0 | 3 | Values 0 through 999 |
|
60 | Enable Abbreviated Periods | enableAbbreviatedPeriods | When this option is set to "true", schools will have the option, on the Program Management Wizard, to designate an academic year as an "Abbreviated Period" for external transfer students with an open academic year at a prior school, who are transferring into a non-term program. Schools will also have the ability to set up separate disbursement schedules for these abbreviated periods. | Optional | Yes | boolean |
|
| ||
61 | Uses Modules | usesModules | Indicates whether the school has modular programs | Optional | Yes | boolean |
|
| ||
62 | R2T4 Consider NonRebuild Loans As Originated Date | dateUsedToConsider NonRebuildLoansAs OriginatedCode | This field gives schools the ability to define when a loan is considered "Originated" for the purposes of R2T4 calculations and included as "Aid that could have been disbursed" to the student. | Optional | Yes | string |
| |||
63 | Assume Attendance | assumeAttendance | Optional | Yes | boolean |
|
| |||
64 | assumeAttendance_ EffectiveAsOfDate | This indicates the date at which a school wants to begin using this functionality. Regent Award will not assume attendance for courses that end prior to this date (course end date is a date prior to the date entered in the “Effective as of” field). | Optional | No | date | YYYY-MM-DD |
| |||
65 | First day of Instructional Week | firstDayOfInstructionalWeek | Allows the school to set a specific day of the week as the first day of the instructional week for all students enrolled in this Program. | Optional | Yes | string |
| |||
66 | Split Weeks Across Payment Period | splitWeeksAcrossPaymentPeriod | Required | Yes | boolean |
|
| |||
67 | Criteria Used to Consider an MPN Linked to a Loan | mpnLinkedToLoanCriteriaTypeCode | Allows the school to specify if the MPN must be Accepted at COD prior to including Title IV Loans in the R2T4 | Optional | Yes | string | 0 | 5 |
|
|
68 | Identify Whether Potential R2T4 is Required | isPotentialR2T4Required | This field will determine whether a potential R2T4 is required. | Optional | Yes | boolean |
|
| ||
69 | Offset from DOD for Evaluation of Need for R2T4s | evaluationR2T4NeedDODOffset | This field will determine the number of days after the DOD that an R2T4 will first be evaluated to determine if the R2T4 is not needed. | Optional | Yes | integer | When a value is provided in this field, Regent Award will attempt to automatically close those R2T4s that are not required. | |||
70 | Offset from DOD to Auto-Finalize R2T4s | dodToAutoFinalizeRT24Offset | This field will determine the number of days after the DOD that an R2T4 can be assessed for auto-finalization. | Optional | Yes | integer | When a value is provided in this field, Regent Award will attempt to automatically finalize those types of R2T4s that are configured under the "Types of R2T4s to Auto-Finalize" option | |||
71 | Types of R2T4s to Auto-Finalize | autoFinalizeR2T4TypeCode | This field will determine the types of R2T4s that can be finalized during Automation | Optional | Yes | string |
| When R2T4 Automation is turned on, Regent Award will attempt to automatically auto-Finalize the types of R2T4s selected from this dropdown. | ||
72 | Auto-Cancel Excluded Title IV Disbursements for R2T4 | autoCancelExcludedTitleIVDisbursementsForR2T4 | When this setting is selected, any Title IV funds (except for the Federal Work Study) on a student’s account, during the R2T4 period, that are not included in the R2T4 calculation, are cancelled automatically when the R2T4 is finalized. | Optional | Yes | boolean |
|
| ||
73 | Method for Projecting Nonterm R2T4 PP End Date | projectingNontermR2T4PPEndDateMethodCode | This field allows schools to determine the method for which the school will project a nonterm payment period for R2T4 purposes. | Optional | No | string |
|
| ||
74 | Days in R2T4 PP When 0 Units Completed | daysInR2T4PPWhen0UnitsCompleted | This field allows a school to determine a fixed payment period denominator when there are 0 completed units in the R2T4 period. | Optional | No | integer | When the Academic Plan Payment Period Projection Method chosen is "R2T4-Only Payment Period Extrapolation Formula," provide a fixed payment period length to be used for students who have zero successfully completed units in the R2T4 payment period. | |||
75 | Types of R2T4s to Auto-Finalize | autoFinalizeR2T4TypesInherited | This field allows a school to define whether "Types of R2T4s to Auto-Finalize" will be inherited from Campus R2T4 setup or not | Required | No | boolean |
| When R2T4 Automation set as "true", Regent Award will use values for autoFinalizeR2T4TypeCode inherited from Campus level setup. When R2T4 Automation set as "false", Regent Award will use values defined in the autoFinalizeR2T4TypeCode option at the program level. | ||
76 | Offset to Establish PWD Response Deadline | establishPWDResponseDeadlineOffset | This field allows a school to define the number of days during which student is able to respond to awards proposed during R2T4 resulted in PWD after finalization date. | Optional | Yes | integer |
| When a value is provided in this field, Regent Award will add the number of days entered here to the R2T4 Finalization Date to determine the value and auto-populate the "Deadline for student and/or parent to respond" field on the R2T4 Wizard PWD Tab Value could be defined explicitly in this program level attribute or be inherited from Campus level when this attribute is not provided | ||
77 | Offset to Establish Fund Auto-cancellation Date for IOP PWDs | establishFundAutoCancellationDateForIOPPWDsOffset | This field allows a school to define the number of days after R2T4 Finalization prior to auto-cancelation of IOP awards from PWD. | Optional | Yes | integer |
| When a value is provided in this field, Regent Award will add the number of days entered here to the R2T4 Finalization Date to determine the value and auto-populate the "Auto Cancel Date" field for IOP PWDs on the R2T4 Wizard PWD Tab Value could be defined explicitly in this program level attribute or be inherited from Campus level when this attribute is not provided | ||
78 | Offset to Establish Fund Auto-cancellation Date for non-IOP PWDs | establishFundAutoCancellationDateForNonIOPPWDsOffset | This field allows a school to define the number of days after R2T4 Finalization prior to auto-cancelation of IOP awards from PWD. | Optional | Yes | integer |
| When a value is provided in this field, Regent Award will add the number of days entered here to the R2T4 Finalization Date to determine the value and auto-populate the "Auto Cancel Date" field for non-IOP PWDs on the R2T4 Wizard PWD Tab Value could be defined explicitly in this program level attribute or be inherited from Campus level when this attribute is not provided | ||
79 | Automatically Return Grant Amounts in Step 10 | automaticallyReturnGrantAmounts | This field allows a school to enable or disable Grant awards return based on Step 10 R2T4 information. | Optional | Yes | boolean |
| When a value is set to "true", Regent Award will return the STEP 10: Return of Grant Funds by the Student within the R2T4 Worksheet. When a value is set to "No", Regent Award will not act upon the STEP 10: Return of Grant Funds by the Student within the R2T4 Worksheet. When this attribute is not provided - value would be inherited from the Campus level. Value could be defined explicitly in this program level attribute or be inherited from Campus level when this attribute is not provided | ||
80 | Include Loan Disbursements Cancelled for Below Half Time Status | includeLoanDisbursementsCancelledForBelowHTStatus | This field allows to configure R2T4 calculations such that the R2T4 "Could Have Been Disbursed" amounts will include unpaid, originated Title IV Loan disbursements that were canceled due to the student dropping below Half-Time (HT) enrollment status after beginning attendance in the term. The canceled loan amounts will increase a student's overall Title IV aid in a term, potentially increasing a student's grant funding. | Optional | Yes | boolean |
| If this setting is set to "true", when the system zeroes out a Direct Loan amount due to a student dropping to below Half Time enrollment status or lower in a term, Regent Award will apply that cancelled amount to the "Net Amount that Could Have Been Disbursed" in Step 1 of the R2T4 calculation. The setting applies to term and nonstandard term programs only. Value could be defined explicitly in this program level attribute or be inherited from Campus level when this attribute is not provided | ||
81 | Auto-Assign Loan Crossover FAY Based on ISIR Availability | autoAssignLoanCrossoverFAYBasedonISIRAvailability | This field allows to automatically package Title IV Loans in "crossover" Academic Years when student does not have any ISIR from the prior-year FAY in a crossover AY and do have an ISIR for the next FAY. Regent Award will automatically package loans from the next-year ISIR. | Optional | Yes | boolean |
| When this setting is set to "true", and a student does not have an ISIR from the preferred FAY per the configured Default Academic Year Crossover Date, but the student has an ISIR from the other FAY in a crossover AY, the system will award loans using the other FAY's ISIR. Value could be defined explicitly in this program level attribute or be inherited from Campus level when this attribute is not provided |
Program Group
Field Ref. | Common Field Name | XML Schema Field Name | Description | Required/ Optional | Inheritable? | Type | Min Length | Max Length | Values | Business Rules |
---|---|---|---|---|---|---|---|---|---|---|
1 | External Enterprise ID | <Enterprise> externalId | Associated Enterprise | Required | No | string | 1 | 60 | Used for matching | |
2 | External Institution ID | <Institution> externalId | Associated Institution | Required | No | string | 1 | 60 | Used for matching | |
3 | External Program Group ID | externalId | Program Group from SIS | Required | No | string | 1 | 60 | Used for matching | |
4 | Name | name | Program Group name | Required | No | string | 1 | 50 | ||
5 | Program Group Type | programGroupTypeCode | Program Group Type | Required | No | string | Program Group Type Code | |||
6 | Description | description | Program Group description | Optional | No | string | 1 | 255 |
Program Group Program
The entire set of ProgramGroupProgram records for the ProgramGroup must be specified. The list in the file will update/replace the list in Regent Award. This gives the school a way to remove associations. The concept does not apply to any other cross-reference (i.e. ProgramSite, ProgramTerm, etc.).
Field Ref. | Common Field Name | XML Schema Field Name | Description | Required/ Optional | Inheritable? | Type | Min Length | Max Length | Values | Business Rules |
---|---|---|---|---|---|---|---|---|---|---|
1 | External Enterprise ID | <Enterprise> externalId | Associated Enterprise | Required | No | string | 1 | 60 | Used for matching | |
2 | External Institution ID | <Institution> externalId | Associated Institution | Required | No | string | 1 | 60 | Used for matching | |
3 | External Program Group ID | externalProgramGroupId | Associated Program Group | Required | No | string | 1 | 60 | Used for matching | |
4 | External Program ID | externalProgramId | Program ID associated with the Program Group | Required | No | string | 1 | 60 |
Program Term
Field Ref. | Common Field Name | XML Schema Field Name | Description | Required/ Optional | Inheritable? | Type | Min Length | Max Length | Values | Business Rules |
---|---|---|---|---|---|---|---|---|---|---|
1 | External Enterprise ID | <Enterprise> externalId | Associated Enterprise | Required | No | string | 1 | 60 | Used for matching | |
2 | External Institution ID | <Institution> externalId | Associated Institution | Required | No | string | 1 | 60 | Used for matching | |
3 | External Campus ID | <Campus> externalId | Associated Campus | Required | No | string | 1 | 60 | Used for matching | |
4 | External Program ID | externalProgramId | Associated Program | Required | No | string | 1 | 60 | Program values that are already set up in the system | |
5 | External Term External ID | externalTermId | Term ID from SIS | Required | No | string | 1 | 60 | Term Values that are already set up in the system | |
6 | External Enrollment Level Setup ID | externalEnrollmentLevelSetupId | Enrollment Level Setup ID from SIS | Required | No | string | 1 | 60 | Enrollment level setup values that are already set up in the system | |
7 | Term Type | termTypeCode | Term Type | Optional | No | string | Term Type Code | |||
8 | Completes SAY | completesSAY | Indicator to designate which term is the final term in the SAY for a program. | Required | No | boolean | true / false (case sensitive) | Should only be provided for Academic Calendar Type = "SAY - Federal Award Year Based" |
Program Site
Field Ref. | Common Field Name | XML Schema Field Name | Description | Required/ Optional | Inheritable? | Type | Min Length | Max Length | Values | Business Rules |
---|---|---|---|---|---|---|---|---|---|---|
1 | External Enterprise ID | <Enterprise> externalId | Associated Enterprise | Required | No | string | 1 | 60 | Used for matching | |
2 | External Institution External ID | <Institution> externalId | Associated Institution | Required | No | string | 1 | 60 | Used for matching | |
3 | External Campus ID | <Campus> externalId | Associated Campus | Required | No | string | 1 | 60 | Used for matching | |
4 | External Program ID | externalProgramId | Associated Program | Required | No | string | 1 | 60 | Used for matching | |
5 | External Site ID | externalSiteId | Site ID from SIS | Required | No | string | 1 | 60 | ||
6 | Inherit Defaults | inheritProgramSettings | Indicates whether the site should inherit all the values set at the program level. | Required | No | boolean | true / false (case sensitive) | If "true", this site should inherit all of the values set at the program level | ||
7 | Stop All Positive Disbursements Date | stopPositiveDisbursementDate | Date when the positive disbursement for students in this program will be stopped | Optional | No | date | YYYY-MM-DD | If this date is populated, stop positive disbursements for students in this program beginning on the date provided. | ||
8 | Open for Enrollment | openForNewEnrollment | Indicates whether this program is available to new/prospective students. | Optional | No | boolean | true / false (case sensitive) | |||
9 | Open for Transfers | openForTransferProgramChange | Indicates whether the program is available to transfer students and students who change program | Optional | No | boolean | true / false (case sensitive) | |||
10 | Batch Package | batchPackage | Indicates whether the prograam can be batch packaged | Optional | No | boolean | true / false (case sensitive) |
| ||
11 | Estimate Non-FSA | estimateNonFSAEligible | Indicates whether awards can be estimated for anticipated periods. | Optional | No | boolean | true / false (case sensitive) | If "true", awarding for this program can be estimated, even though it is not yet FSA eligible | ||
12 | Track Switch | allowAnticipatedTrackSwitch | Indicates whether this site will allow students in the program to switch to a different track | Optional | No | boolean | true / false (case sensitive) | |||
13 | FSA Start Date | FSAEligibleStartDate | Any payment period that has an end date that’s after the specified start date is eligible, and start date that is before the end date specified. | Optional | No | date | YYYY-MM-DD | This date range can not be outside of the data range indicated at the Program Level. | ||
14 | FSA End Date | FSAEligibleEndDate | Optional | No | date | YYYY-MM-DD |
Term
Field Ref. | Common Field Name | XML Schema Field Name | Description | Required/ Optional | Inheritable? | Type | Min Length | Max Length | Values | Business Rules |
---|---|---|---|---|---|---|---|---|---|---|
1 | External Enterprise ID | XML: <Enterprise> externalId CSV: externalEnterpriseId | Associated Enterprise | Required | No | string | 1 | 60 |
| |
2 | External Institution ID | XML: <Institution> externalId CSV: externalInstitutionId | Associated Institution | Required | No | string | 1 | 60 |
| |
3 | External Campus ID | XML: <Campus> externalId CSV: externalCampusId | Associated Campus | Required | No | string | 1 | 60 |
| |
4 | External Term ID | externaIId | Term ID from SIS | Required | No | string | 1 | 60 | ||
5 | Term Name | name | Display name for Term | Required | No | string | 1 | 60 |
| |
6 | Track | track | Defines the track field for BBAY academic calendars. | Optional | No | string | 0 | 2 |
| |
7 | Academic Calendar Type | academicCalendarTypeCode | Indicator of how the loan eligibilty should be calculated for the term. | Optional | Yes | string | Academic Calendar Type Code |
| ||
8 | Academic Period Type | academicPeriodTypeCode | Type of Academic Period | Optional | Yes | string | Academic Period Type Code |
| ||
9 | Unit Type | academicUnitTypeCode | Type of Unit | Optional | Yes | string | Academic Unit Type Code |
| ||
10 | Start Date | startDate | Start date of the Term | Required | No | date | YYYY-MM-DD | |||
11 | End Date | endDate | End date of the Term | Required | No | date | YYYY-MM-DD |
| ||
12 | Alt EFC Months | altEFCMonths | Defines number of months for Alt-EFC period. | Optional | Yes | double | 0 | 2 | Values 1 through 12 | |
13 | Instructional Weeks | instructionalWeeks | Value used to determine the instructional weeks for the term in order to calculate Pell using Pell Formula 3 | Optional | No | integer | 0 | 2 | Values 1 through 52 |
|
14 | Accelerate Begin Actual | accelerateBeginActual ForRegCreditsCode | Used as the enrollment threshold to specify when (prior to the census date) to use actual units in packaging a student | Optional | Yes | string | Accelerate Begin Actual Code |
| ||
15 | Completes SAY | completesSAY | Indicator to designate which term is the final term in the SAY for a program | Required | Yes | boolean |
|
| ||
16 | Is Header or Crossover | isHeader | Defines if a Term is a Header when the Academic Calendar Type = SAY - Federal Award Year Based. If the Term Academic Calendar Type is Non-SAY, then this field is used to define Crossover. | Optional | No | boolean |
|
| ||
17 | Allow Term to Start Anticipated AY | allowTermToAnticpatedAY | Indicates whether this term can be used to start an AY | Required | No | boolean |
|
| ||
18 | Anticipate 0 Units for Term | anticipate0UnitsForTerm | Indicates whether 0 anticipated units will be used for the term rather than the Anticpated Enrollment Level Type defined for the student's program | Required | No | boolean |
|
| ||
19 | Use for Anticipation | useForPlanningYN | Indicator to designate when the Term should be used when anticipating enrollment. If the student has a courseenrollment (registration) for that term, it will be used regardless of this flag. | Required | No | boolean |
|
| ||
20 | Begin Actual Date | beginActualDate | Date actual enrollment data will be used for awarding. It is used to specify when (prior to census date) to use actual units in packaging a student. | Required | No | date | YYYY-MM-DD |
| ||
21 | Pell Recalculation Date | pellRecalculationDate | Date that Pell will be recalculated for students attending this term. | Optional | No | date | YYYY-MM-DD |
| ||
22 | SAP Date | SAPDate | The earliest date the school can begin SAP evaluation for the term | Required | No | date | YYYY-MM-DD |
| ||
23 | Census Date | censusDate | The initial calculation date | Required | No | date | YYYY-MM-DD |
| ||
24 | Census Date 2 | censusDate2 | Supports an ability to provide a census date for students who are enrolled in ony the 2nd module of a term. | Optional | No | date | YYYY-MM-DD |
| ||
25 | Auto Withdraw Date | autoWithdrawDate | Defines the date for auto withdrawal | Required | No | date | YYYY-MM-DD |
| ||
26 | State Grant Census Date 1 | stateGrantCensusDate1 | This date will be used to calculate attended remedial qualified units and attended program applicable units with courses that has withdrawn date after this State Grant Date.Some State grants have set date after which they will get paid even if they withdrew from the courses. CCC will use this for their MAP state grant. | Optional | No | date | YYYY-MM-DD |
| ||
27 | State Grant Census Date 2 | stateGrantCensusDate2 | Optional | No | date | YYYY-MM-DD |
| |||
28 | State Grant Census Date 3 | stateGrantCensusDate3 | Optional | No | date | YYYY-MM-DD |
| |||
29 | State Grant Census Date 4 | stateGrantCensusDate4 | Optional | No | date | YYYY-MM-DD |
| |||
30 | Financial Aid Determination Date | financialAidDeterminationDate | Defines a specific, point-in-time date for a Term. Regent Award can check a student's enrolled units as of this date, for use in Custom Fund Rulesets. | Optional | No | date | YYYY-MM-DD | |||
31 | External Term Code | externalTermCode | Optional | No | string | 0 | 60 |
| ||
32 | BBAY Anchor Determination | bbayAnchorDeterminationDateTypeCode | Defines how a term is anchored i.e. start an AY as the first term in an Academic Year, for a BBAY1 or BBAY2 calendar. | Optional | Yes | string | 1 | 50 |
| Stipulates when Regent Award can "anchor" a term-based BBAY. Regent Award determines "anchor" eligibility based on a configured Term Date or when Direct Loans are greater than $0 in the term.
|
33 | Last Day for Drop/Add | lastDayDropAdd | Defines the last date within the term that a school allows a student to drop or add courses for that term. | Optional | No | date | This field specifies the date to be used for Drop/Add periods for SAP calculations. | |||
34 | COD Term Start Date Override | allowOverrideCODPaymentPeriodStartDate | Indicates if RNA will or will not consume term start date from COD WB which falls outside of normal term start date. RNA will subsequently use it for COD export only. Originally designed for Intersession terms. Doesn't affect the terms displayed in the Academic Plan. | Required | No | boolean |
|
|