Student Record Return: Instance Entity
If you select the Include Student Entities check box on the Create Extract Data page, the Create Extract process creates Instance entities based on distinct student careers and the related HESA Instance.
The process includes a student career as an Instance entity if the following three conditions are met:
The process has included the plan (or the subplan if the subplan rather than the plan is being reported) of the student program record as a Course entity in the extract. Note that if the student has multiple active plans the process considers the plan defined in the HESA Instance record.
The plan or subplan is selected for COURSEID based on the most recent Student Program/Plan record on or before the reporting period end date where the program action/reason is not defined in the Award Only Mapping for the return.
A related HESA Instance record exists for the career and academic institution with the Report To HESA check box selected.
The student must be a continuing student (that is, the derived commencement date is prior to the start of the reporting period) or a new student (that is, the derived commencement date falls on or after the start of the reporting period).
If the student is a continuing student, then one of the following conditions must be satisfied:
The student is in the HIN Population. That is, a HIN Population Year value exists in the HESA Instance record that matches the Reporting Period Year.
You have not selected the HIN Population Only check box and the student has not left or completed prior to the reporting period. To determine whether the student has not left or completed prior to the reporting period, the process first selects the Student Program record that has an effective date nearest to the Reporting Period Start Date. Then, it checks whether the selected record has a Program Status that matches one of the eligible Program Statuses defined for the return on the HESA Returns page.
Note: If you have selected the check box, for each student career, the process only evaluates whether the first condition is met (that is, student is in the HIN population) and does not evaluate the second condition (that is, the student has not left or completed prior to the reporting period). In other words, if you select the check box and if the first condition is not met, the student career is not included.
If the student is a new student, then one of the following conditions must be satisfied:
The student is in the HIN Population.
The student has been term activated for at least one term that begins within the reporting period and the student has at least one enrolled class related to that term.
The student has an FTE of greater than zero for the reporting period.
Note: The HIN Population Year value in the HESA Instance record may not exist for new students. Therefore, the process does not consider the HIN Population Only check box for selection of new students. It includes a new student based on either the class enrollment condition or the FTE condition, if the student is not in the HIN population.
The Create Extract process uses the following fields set up on the HESA Instance page for a student career:
Academic Plan: Indicates the plan to report if the student has multiple active plans.
Linked Career and Linked Career Number: Indicates that the student instance is associated with another instance.
Report To HESA: If the check box is cleared, the process does not include the instance data.
Start Date of Instance: The system calculates a value but you can use this field to override the calculated value.
HIN Population Year: Indicates the reporting year for which the system should include the Instance in the return. You must manually enter the HIN Population Year on the HESA Instance page or import the values using the Import HIN Target List process.
Year of Course: Indicates the year of course the student is undertaking for reporting in Instance.YEARPRG. You must update this value for each subsequent reporting period when the student has progressed to the next year of the program.
Year of Student: Indicates the number of years the student has been undertaking the program for reporting in Instance.YEARSTU. You must update this value for each subsequent reporting period when the student has progressed to the next year of the program.
The system does not automatically calculate the Year of Course and Year of Student values on the HESA Instance page. You must use the HESA Instance page to manually enter the Year of Course and Year of Student values.
The Create Extract process derives the fields relevant to further education (FE) students only if the Include FE check box is selected on the HESA Returns page. Although you can include or exclude individual FE fields using the derived value for FESTUMK, the Include FE check box enables you to skip derivation of FE fields completely.
While creating Instance entities, the process checks if the student's External System ID records has a HUSID. If no records are found, the process creates a HUSID External System ID for the student with an Effective Date of the reporting period start date.
If you have selected the Null Errors Only check box for the Include Student Entities on the Create Extract Data page, the Create Extract process selects distinct EMPLIDs from the existing active extract data, where at least one field in the Instance, EntryProfile, QualificationsOnEntry, QualificationsAwarded, RAEData, StudentOnModule or Student extract data has a derived value of NULL ERROR. The process then selects all the Instance entity records for these EMPLIDs (if an EMPLID has multiple instances and if at least one instance has a NULL ERROR, then all the instances are selected).
If you have selected the Validation Errors Only check box for the Include Student Entities, the Create Extract process first deletes any Validation Error staging records where all of the COURSEID, MODID and EMPLID fields are blank. Then, it selects distinct EMPLIDs from the Validation Error staging table where the EMPLID is not blank. The process selects Instance entity records for these EMPLIDs. Finally, the process deletes records from the Validation Error staging table where EMPLID is populated.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
ACTPROGROUTE |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = England
Instance.REDUCEDI = 00 or 01
Instance.FESTUMK = 1, 3, or 4
Instance.ENDDATE value exists
Instance.PROGTYPE = 02, 03, 10, 19, 20 or 21
Instance.AIMTYPE = 1
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
ADDSUPCT |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = England
Instance.FESTUMK = 1, 3, or 4
Instance.REDUCEDI = 00 or 01
Instance.FUNDMODEL = 25 or 82
LearnerFAM.LEARNFAMTYPE = HNS
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
AIMTYPE |
Plan HESA Data |
AIMTYPE |
Sub-Plan HESA |
AIMTYPE |
HESA Instance |
AIMTYPE |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = England
Instance.REDUCEDI = 00 or 01
Instance.FESTUMK = 1, 3, 4, or 5
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
BRIDGE |
Plan HESA Data |
BRIDGE |
Sub-Plan HESA |
BRIDGE |
Field Derivation Rule: Derive a value if one of the following conditions is met:
Country = England, Northern Ireland, or Scotland AND Instance.REDUCEDI = 00 AND Related Course.COURSEAIM is not Z99
Country = Wales, REDUCEDI = 00, AND COURSEAIM does not begin with P, Q, R, S, or X, and is not Z99.
Derivation Steps:
Use constant.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Student Program |
Campus |
Campus |
HESA Campus |
Field Derivation Rule: Include for all Instance entities.
Derivation Steps:
Use constant.
Use the mapping to derive the HESA Campus code for the Campus value entered in the Student Program page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
CSTAT |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = England or Wales
Instance.FESTUMK = 1, 3, 4, or 5
Instance.REDUCEDI = 00 or 01
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
COLFROMDATE |
Field Derivation Rule: Derive a value if related Course.COURSEAIM = D00, D01, L00, or L80.
Derivation Steps:
Derive from the HESA Instance page.
Derive as NULL.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
COLFROMPROV |
Field Derivation Rule: Derive a value if related Course.COURSEAIM = D00, D01, L00, or L80.
Derivation Steps:
Derive from the HESA Instance page.
Derive as NULL.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
COLTODATE |
Field Derivation Rule:
Derive a value if the following conditions are met:
Instance.RSEND = 12
Related Course.COURSEAIM = D00, D01, L00, or L80
Derivation Steps:
Derive from the HESA Instance page.
Derive as ENDDATE.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
COLTOPROV |
Field Derivation Rule:
Derive a value if the following conditions are met:
Instance.RSEND = 12
Related Course.COURSEAIM = D00, D01, L00, or L80
Derivation Steps:
Derive from the HESA Instance page.
Derive as NULL.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
Start Date of Instance Effective Date |
Field Derivation Rule: Include for all Instance entities.
Derivation Steps:
Derive as the Start Date of Instance from the HESA Instance page.
If there is a Research Candidate record for the instance:
Select the Begin Date (SSR_RS_BEGIN_DT) from the most recent active Consumption record where the effective date is on or before the reporting period end date.
Derive the Begin Date formatted to YYYY-MM-DD.
Match the Research Candidate record (SSR_RS_CAND_HDR) to the instance on EMPLID, Institution, Career and Career Number to find the Research Candidate Number (SSR_RS_CANDIT_NBR). If multiple records are found, the record with the highest candidate number is selected.
Associate consumption records (SSR_RS_CONSMPTN) with the Research Candidate record by EMPLID, Institution and Research Candidate Number.
The calculated value is stored in the HESA Instance Data record.
Use the following process to calculate the earliest class start date for enrolled classes related to the Instance being reported. This selection is similar to that done for StudentOnModule except that it is not restricted to classes overlapping the reporting period and considers enrollments for linked careers.
Select all activated terms for the student career of the Instance.
From each activated term, select classes that satisfy the following conditions:
– Status = Enrolled
– Units Taken value is greater than zero.
– Grading basis value matches one of the values defined in the Grading Basis Inclusion region with the Extract check box selected on the HESA Configuration page.
– Repeat Code value does not exist or does not match a value defined in the Repeat Code Exclusion region with the Extract check box selected on the HESA Configuration page.
– If the student has multiple careers with the same Academic Career value as the career being processed (that is, the same career value with different career numbers), then apply a further filter to the class enrollments. In such a case, select the class only if the program value of the enrollment record is does not exist or matches one of the program values in the Student Program records for that career and career number.
If the Instance has been linked to a prior student career using the Linked Career and Linked Career Number fields in the HESA Instance record, then also consider classes for the previous career.
Derive the earliest Class Start Date from all the selected classes as COMDATE.
The earliest Effective Date of the HESA Instance records.
For steps 2 and 3, the system stores the derived date as the Start Date of Instance value in the HESA Instance record.
Return: Student Record
Entity: Instance
Pages Used: None
Field Derivation Rule: Include for all Instance entities.
Derivation Steps:
-
If the student's subplan is reported in the Course extract, derive from the student's subplan.
-
Derive from the student's plan.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
DESTIN |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = Wales
Instance.FESTUMK = 1, 3, or 4
Instance.REDUCEDI = 00 or 01
Course.COURSEAIM begins with P, Q, R, S or X.
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program Offering/Year HESA |
DESTOCM, DESTOCM2, DESTOCM3 (Program Year HESA Data group box) |
Plan Offering/Year HESA |
DESTOCM, DESTOCM2, DESTOCM3 (Plan Year HESA Data group box) |
Sub-Plan Offering/Year HESA |
DESTOCM, DESTOCM2, DESTOCM3 (Sub-Plan Year Data group box) |
HESA Instance |
DESTOCM, DESTOCM2, DESTOCM3 |
Field Derivation Rule: Derive a value if the following conditions are met:
Country = England, Wales, or Northern Ireland
Instance.REDUCEDI = 00
(Instance.EXCHANGE = 7, B, C, D, or E) or (Instance.LOCSDY = F, G or S)
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant to create a single DESTOCM field.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance.
Derive from the Plan Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance.
Derive from the Program Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance.
Use default to create a single DESTOCM field.
Derive a single DESTOCM field as NULL ERROR.
Note: The system can derive up to three values. Each of the values is included as a separate DESTOCM field in the XML file.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
DHFUND |
Plan HESA Data |
DHFUND |
Sub-Plan HESA |
DHFUND |
HESA Instance |
DHFUND |
Field Derivation Rule: Derive a value if the following conditions are met:
Country = England
Instance.REDUCEDI = 00 or 01
Related Course.MSFUND = 37 or 38
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
External System ID |
External System ID |
Field Derivation Rule: Derive a value if the following conditions are met:
Instance.REDUCEDI = 00 or 01
Related Course.REGBODY = 06 or 07 or is in the range 40 to 55 inclusive or is in the range 60 to 65 inclusive
Related Course.COURSEAIM = M16, M26, M76, M86, H16, H62, H76, I16, I76, J26 or J76
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Select External System ID records for the person with the External ID Type defined for DHREGREF in the HESA Types page.
Use default.
Derive as NULL ERROR.
You can define a default of 99999999 for this field.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
DISALL |
Impairment AUS |
Support Services Request |
Disability (Records and Enrollment, HESA Reporting, Codes and Mappings, Code Mappings, Disability) |
HESA Disability Allowance |
Field Derivation Rule: Derive a value if one of the following conditions is met:
Country = England, Northern Ireland, or Scotland, Instance.REDUCEDI = 00 AND Student.DISABLE = 08 to 96 inclusive.
Country = Wales, Instance.REDUCEDI = 00, Student.DISABLE = 08 to 96 inclusive, AND Course.COURSEAIM does not begin with P, Q, R, S or X.
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If the student has a Support Services Request value defined on the Impairment AUS page, use the mapped HESA Disability Allowance code from the Disability page.
Use default.
Derive as NULL ERROR.
Note: The system derives Student.DISABLE before creating the Student entity in order to derive the Student.DISALL field.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
HESA Instance |
DISUPFAC |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = England
Instance.FESTUMK = 1, 3, or 4
Instance.REDUCEDI = 00 or 01
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
DISTLEARNSLN |
Plan HESA Data |
DISTLEARNSLN |
Sub-Plan HESA |
DISTLEARNSLN |
HESA Instance |
DISTLEARNSLN |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = England
Instance.REDUCEDI = 00 or 01
Instance.FESTUMK = 1 or 3
Instance.AIMTYPE = 2, 3 or 4
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Use default.
If Instance.FUNDMODEL = 21 or 22, derive as NULL ERROR.
Do not derive a value and leave the field blank.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
ELIDISUP |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = England
Instance.FESTUMK = 1, 3, or 4
Instance.REDUCEDI = 00
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
ELIGENFD |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = England
Instance.FESTUMK = 1, 3, or 4
Instance.REDUCEDI = 00
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
ELQ |
Field Derivation Rule: Derive a value if the following conditions are met:
Country = England
Instance.REDUCEDI = 00 or 01
Instance.FEEELIG = 1
Instance.FESTUMK = 2 or 3
Related Course.COURSEAIM begins E, M, H, I, J or C
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
EMPROLE |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = Wales
Instance.FESTUMK = 1, 3, or 4
Instance.REDUCEDI = 00 or 01
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Use default.
Do not derive a value and leave the field blank.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Student Program |
Program Action Action Reason Effective Date |
HESA Instance |
ENDDATE |
HESA Action Reasons |
Reason for Ending Instance Mapping |
Field Derivation Rule: Include for all Instance entities.
Derivation Steps:
Derive from the HESA Instance page.
Derive the effective date of the record formatted to YYYY-MM-DD if the most recent effective dated Student Program record has Program Action/Reason values mapped to a HESA Reason for Ending Instance code on the HESA Action Reasons page and, either Instance.INTERCALATE is not 01, or the mapped HESA RSNEND value is not 01.
Derive as null.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Further Education (Records and Enrollment, Career and Program Information, HESA Instance Details, Further Education) |
ENGGRADE |
Field Derivation Rule: Derive a value if all the following conditions are met.
Country = England
Instance.FESTUMK = 1, 3, or 4
Instance.REDUCEDI = 00 or 01
Instance.FUNDMODEL = 25 or 82
Derivation Steps:
Derive from the Further Education page.
Derive as NONE.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
ENTRYRTE |
Plan HESA Data |
ENTRYRTE |
Sub-Plan HESA |
ENTRYRTE |
HESA Instance |
ENTRYRTE |
Field Derivation Rule: Derive a value if all the following conditions are met.
Country = England
Instance.REDUCEDI = 00, 01, or 04
Related Course.TTCID = 1
Derivation Steps:
Use constant.
Derive from HESA Instance page.
If Instance.COURSEID is based on a sub-plan, derive value from the Sub-Plan HESA page.
Derive value from Plan HESA Data page.
Derive value from Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
EXCHANGE |
Program Offering/Year HESA |
EXCHANGE (Program Year HESA Data group box) |
Plan HESA Data |
EXCHANGE |
Plan Offering/Year HESA |
EXCHANGE (Plan Year HESA Data group box) |
Sub-Plan HESA |
EXCHANGE |
Sub-Plan Offering/Year HESA |
EXCHANGE (Sub-Plan Year HESA Data group box) |
HESA Instance |
EXCHANGE |
HESA Instance |
Year of Program |
Field Derivation Rule: Derive a value if one of the following conditions is met:
Country = England, Northern Ireland, or Scotland AND Instance.REDUCEDI = 00, 03 or 09 AND Instance.FESTUMK is not 5
Country = Wales, Instance.REDUCEDI = 00, 03 or 09 AND Instance.FESTUMK is not 5 AND Course.COURSEAIM does not begin with P, Q, R, S or X.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance. Only records where Offering Start Term, Offering Start Session, Campus, Year Term and Year Session are all blank are considered.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance. Only records where Offering Start Term, Offering Start Session, Campus, Year Term and Year Session are all blank are considered.
Derive from the Plan HESA Data page.
Derive from the Program Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Residency Official 1 (Campus Community, Personal Information (Student), Identification (Student), Residency Data, Residency Official 1) |
Residency |
Program HESA Data |
FEEELIG |
Program Offering/Year HESA |
FEEELIG (Program Offering HESA Data group box) |
Plan HESA Data |
FEEELIG |
Plan Offering/Year HESA |
FEEELIG (Plan Offering HESA Data group box) |
Sub-Plan HESA |
FEEELIG |
Sub-Plan Offering/Year HESA |
FEEELIG (Sub-Plan Offering HESA Data group box) |
HESA Instance |
FEEELIG |
Fee Eligibility (Records and Enrollment, HESA Reporting, Codes and Mappings, Code Mappings, Fee Eligibility) |
HESA Fee Eligibility |
Field Derivation Rule: Derive a value if the following conditions are met.
Instance.REDUCEDI = 00 or 01
Instance.FESTUMK is not 5
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Select the residency records for the EMPLID, institution, and academic career combination for the most recent effective term that starts on or before the end of the reporting period. Use the HESA Fee Eligibility code mapped to the selected residency value. If the mapping does not exist, log an error message and skip to the next step.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan Offering/Year HESA page for the academic load of the student instance. Only records where Offering Start Term, Offering Start Session, and Campus are all blank are considered.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan Offering/Year HESA page for the academic load of the student instance. Only records where Offering Start Term, Offering Start Session, and Campus are all blank are considered.
Derive from the Plan HESA Data page.
Derive from the Program Offering/Year HESA page for the academic load of the student instance.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
FEEREGIME |
Field Derivation Rule: Derive a value if one of the following sets of conditions is met. Otherwise, do not derive a value and leave the field blank.
Set |
Conditions |
---|---|
Northern Ireland Postgraduate |
|
Northern Ireland Undergraduate |
|
Scotland |
|
Derivation Steps:
Derive from the HESA Instance page.
If Instance.COMDATE is before 01-SEP-2012, derive as 10.
If Instance.COMDATE is on or after 01-SEP-2012 and Country = Scotland and either DOMICILE is Scotland (XH) or DOMICILE is European Union (excluding England, Northern Ireland and Wales), derive as 10.
The DOMICILE value is derived in the same way as EntryProfile.DOMICILE and is derived even if an EntryProfile is not being included in the extract (that is, for new and continuing students).
The check on European Union includes countries where the EU Member State check box is selected in the Country Table plus also the generic EU code (European Union not otherwise specified) and specifically excludes the individual country codes for England (XF), Northern Ireland (XG), Wales (XI) and UK not specified (XK).
If COMDATE is on or after 01-SEP-2012 and Country = Northern Ireland and either DOMICILE is Northern Ireland (XG) or DOMICILE is European Union (excluding England, Scotland and Wales), derive as 10.
If Instance.COMDATE is on or after 01-SEP-2012, derive as 20.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
FEOUTCOME |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = England
Instance.REDUCEDI = 00 or 01
Instance.FESTUMK = 1, 3, 4, or 5
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
FESTUMK |
Plan HESA Data |
FESTUMK |
Sub-Plan HESA |
FESTUMK |
HESA Instance |
FESTUMK |
HESA Returns |
Include FE |
Field Derivation Rule: Derive a value if the following conditions are met:
Country = England or Wales
Instance.REDUCEDI is 00, 01, 03 or 04
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Derive as 2 if Include FE check box is not selected on the HESA Returns page.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
FUNDADJOTH |
Field Derivation Rule: Derive a value if the following conditions are met:
Country = England
Instance.FESTUMK = 1, 3, 4, or 5
Instance.REDUCEDI = 00 or 01
Either (Instance.AIMTYPE = 1, 3, or 4 and Instance.FUNDMODEL = 35 or 81) OR (Instance.AIMTYPE = 4 and LearningDeliveryFAM.LEARNDELFAMTYPE = ADL)
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
FUNDADJPRIOR |
Field Derivation Rule: Derive a value if the following conditions are met:
Country = England
Instance.FESTUMK = 1, 3, 4, or 5
Instance.REDUCEDI = 00 or 01
Either (Instance.AIMTYPE = 1, 3, or 4 and Instance.FUNDMODEL = 35 or 81) OR (Instance.AIMTYPE = 4 and LearningDeliveryFAM.LEARNDELFAMTYPE = ADL)
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
FRANPART |
Plan HESA Data |
FRANPART |
Sub-Plan HESA |
FRANPART |
HESA Instance |
FRANPART |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = Wales
Instance.FESTUMK = 1, 3, or 4
Instance.REDUCEDI = 00
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
FROUTARR |
Plan HESA Data |
FROUTARR |
Sub-Plan HESA |
FROUTARR |
HESA Instance |
FROUTARR |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = England
Instance.FESTUMK = 1, 3, or 4
Instance.REDUCEDI = 00 or 01
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
FTEMETHOD |
Program Offering/Year HESA |
FTEMETHOD (Program Offering HESA Data group box) |
Plan HESA Data |
FTEMETHOD |
Plan Offering/Year HESA |
FTEMETHOD (Plan Offering HESA Data group box) |
Sub-Plan HESA |
FTEMETHOD |
Sub-Plan Offering/Year HESA |
FTEMETHOD (Sub-Plan Offering HESA Data group box) |
HESA Instance |
FTEMETHOD |
Field Derivation Rule: Derive a value if the following conditions are met:
Country = Scotland
Instance.REDUCEDI = 00, 01, or 03
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan Offering/Year HESA page for the academic load of the student instance. Only records where Offering Start Term, Offering Start Session, and Campus are all blank are considered.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan Offering/Year HESA page for the academic load of the student instance. Only records where Offering Start Term, Offering Start Session, and Campus are all blank are considered.
Derive from the Plan HESA Data page.
Derive from the Program Offering/Year HESA page for the academic load of the student instance.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
FUNDCODE |
Plan HESA Data |
FUNDCODE |
Sub-Plan HESA |
FUNDCODE |
HESA Instance |
FUNDCODE |
Field Derivation Rule: Derive a value if one of the following conditions is met:
Country is Northern Ireland, Scotland or Wales, and Instance.REDUCEDI = 00 or 01
Country is England, and Instance.REDUCEDI = 00 or 01, and Instance.FESTUMK is not 1 or 4
Do not derive a value and leave the field blank, if the condition is not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
FUNDCOMP |
Field Derivation Rule: Derive a value if the following conditions are met:
Country = England, Wales, or Northern Ireland
Instance.REDUCEDI = 00 or 01
Instance.FESTUMK is not 5
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
FUNDLEV |
Program Offering/Year HESA |
FUNDLEV (Program Year HESA Data group box) |
Plan HESA Data |
FUNDLEV |
Plan Offering/Year HESA |
FUNDLEV (Plan Year HESA Data group box) |
Sub-Plan HESA |
FUNDLEV |
Sub-Plan Offering/Year HESA |
FUNDLEV (Sub-Plan Year HESA Data group box) |
HESA Instance |
FUNDLEV |
Field Derivation Rule: Derive a value if the following conditions are met:
Country = England or Northern Ireland
Instance.REDUCEDI = 00 or 01
Instance.FESTUMK is not 5
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance. Only records where Offering Start Term, Offering Start Session, Campus, Year Term and Year Session are all blank are considered.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance.Only records where Offering Start Term, Offering Start Session, Campus, Year Term and Year Session are all blank are considered.
Derive from the Plan HESA Data page.
Derive from the Program Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
FUNDMODEL |
Plan HESA Data |
FUNDMODEL |
Sub-Plan HESA |
FUNDMODEL |
HESA Instance |
FUNDMODEL |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = England
Instance.REDUCEDI = 00 or 01
Instance.FESTUMK = 1, 3, 4, or 5
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
FWORKCODE |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = England
Instance.REDUCEDI = 00 or 01
Instance.FESTUMK = 1, 3, 4, or 5
Instance.PROGTYPE = 02, 03, 20, 21, 22 or 23
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
GLHRS |
Program Offering/Year HESA |
GLHRS (Program Offering HESA Data group box) |
Plan HESA Data |
GLHRS |
Plan Offering/Year HESA |
GLHRS (Plan Offering HESA Data group box) |
Sub-Plan HESA |
GLHRS |
Sub-Plan Offering/Year HESA |
GLHRS (Sub-Plan Offering HESA Data group box) |
HESA Instance |
GLHRS |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = England or Wales
Instance.FESTUMK = 1, 3, or 4
Instance.REDUCEDI = 00 or 01
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan Offering/Year HESA page for the academic load of the student instance.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan Offering/Year HESA page for the academic load of the student instance.
Derive from the Plan HESA Data page.
Derive from the Program Offering/Year HESA page for the academic load of the student instance.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
GOVINIT |
Plan HESA Data |
GOVINIT |
Sub-Plan HESA |
GOVINIT |
HESA Instance |
GOVINIT |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = England
Instance.FESTUMK = 1, 3, or 4
Instance.REDUCEDI = 00
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
HESA Returns |
Account Type Tuition |
Fees After Calculation (Student Financials, Tuition and Fees, Review Fees After Calculation) |
Amount |
Program HESA Data |
GROSSFEE |
Program Offering/Year HESA |
GROSSFEE (Program Offering HESA Data group box) |
Plan HESA Data |
GROSSFEE |
Plan Offering/Year HESA |
GROSSFEE (Plan Offering HESA Data group box) |
Sub-Plan HESA |
GROSSFEE |
Sub-Plan Offering/Year HESA |
GROSSFEE (Sub-Plan Offering HESA Data group box) |
HESA Instance |
GROSSFEE |
Field Derivation Rule: Derive a value if these conditions are met:
Country is Northern Ireland or Scotland
Instance.FEEREGIME = 20
Or derive a value if one of these sets of conditions is met:
Set |
Conditions to be Met |
---|---|
England Postgraduate |
|
England Undergraduate |
|
Otherwise, derive as null.
Derivation Steps:
Derive from the HESA Instance page.
Derive as total of all the tuition fee charges for the student career for terms that start within the reporting period. Fee records where the Item Type Code is Charge and the Account Type is one of those defined with the Tuition check box selected on the HESA Returns page. The derived value is rounded to the nearest pound.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan Offering/Year HESA page for the academic load of the student instance. Only records where Offering Start Term, Offering Start Session, and Campus are all blank are considered.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan Offering/Year HESA page for the academic load of the student instance. Only records where Offering Start Term, Offering Start Session, and Campus are all blank are considered.
Derive from the Plan HESA Data page.
Derive from the Program Offering/Year HESA page for the academic load of the student instance.
Derive from the Program HESA Data page.
Use default.
Do not derive a value and leave the field blank.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
IMPRATE |
Program Offering/Year HESA |
IMPRATE (Program Offering HESA Data group box) |
Plan HESA Data |
IMPRATE |
Plan Offering/Year HESA |
IMPRATE (Plan Offering HESA Data group box) |
Sub-Plan HESA |
IMPRATE |
Sub-Plan Offering/Year HESA |
IMPRATE (Sub-Plan Offering HESA Data group box) |
HESA Instance |
IMPRATE |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = England
Instance.FESTUMK = 1, 3, or 4
Instance.REDUCEDI = 00
Related Course.MSFUND = 86, 87, 88, AA, AB, AC, or AD
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan Offering/Year HESA page for the academic load of the student instance.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan Offering/Year HESA page for the academic load of the student instance.
Derive from the Plan HESA Data page.
Derive from the Program Offering/Year HESA page for the academic load of the student instance.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Student Program |
Campus |
Campus (Records and Enrollment, HESA Reporting, Codes and Mappings, Code Mappings, Campus) |
HESA Campus |
Field Derivation Rule: Include for all Instance entities.
Derivation Steps:
Use constant.
Use the mapping to derive the HESA Campus code for the Campus value entered in the Student Program page.
Use default.
If Country = Wales and Course.COURSEAIM = X41, X42, X43, X44, X45 or X46 then derive as NULL ERROR.
Do not derive a value and leave the field blank.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
INITIATIVES, INITIATIVES2, INITIATIVES3 |
Plan HESA Data |
INITIATIVES, INITIATIVES2, INITIATIVES3 |
Sub-Plan HESA |
INITIATIVES, INITIATIVES2, INITIATIVES3 |
HESA Instance |
INITIATIVES, INITIATIVES2, INITIATIVES3 |
Field Derivation Rule: Include for all entities
Do not derive a value and leave the field blank, if the condition is not met.
Derivation Steps:
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Do not derive a value and leave the field blank.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
INTENTLEV |
Plan HESA Data |
INTENTLEV |
Sub-Plan HESA |
INTENTLEV |
HESA Instance |
INTENTLEV |
Field Derivation Rule: Derive a value if the following conditions are met:
Country = England
Related Course.COURSEAIM = L99
Instance.REDUCEDI = 00, 01, 03 or 04
If the conditions are not met, do not derive a value and leave the field blank.
Derivation steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a sub-plan, derive value from Sub-Plan HESA.
Derive value from Plan HESA Data.
Derive value from Program HESA Data.
Use default.
Derive as null.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
INTERCALATE |
Program Offering/Year HESA |
INTERCALATE (Program Year HESA Data group box) |
Plan HESA Data |
INTERCALATE |
Plan Offering/Year HESA |
INTERCALATE (Plan Year HESA Data group box) |
Sub-Plan HESA |
INTERCALATE |
Sub-Plan Offering/Year HESA |
INTERCALATE (Sub-Plan Year HESA Data group box) |
HESA Instance |
INTERCALATE |
Field Derivation Rule: If Instance.REDUCEDI = 00, 01 or 03 derive a value. Otherwise, do not derive a value and leave the field blank.
Derivation Steps:
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance. Only records where Offering Start Term, Offering Start Session, Campus, Year Term and Year Session are all blank are considered.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance. Only records where Offering Start Term, Offering Start Session, Campus, Year Term and Year Session are all blank are considered.
Derive from the Plan HESA Data page.
Derive from the Program Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance.
Derive from the Program HESA Data page.
Use default.
Do not derive a value and leave the field blank.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
ITTAIM |
Plan HESA Data |
ITTAIM |
Sub-Plan HESA |
ITTAIM |
Field Derivation Rule: Derive a value if all the conditions are met.
Country = England
Instance.REDUCEDI = 00, 01 or 04
Related Course.TTCID = 1
Derivation Steps:
Use constant.
If a sub-plan is reported, derive value from Sub-Plan HESA page.
Derive value from Plan HESA Data page.
Derive value from Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
ITTPHSC |
Plan HESA Data |
ITTPHSC |
Sub-Plan HESA |
ITTPHSC |
HESA Instance |
ITTPHSC |
Field Derivation Rule: Derive a value if the following conditions are met:
Country = England or Wales
Related Course.TTCID = 1 or 2
Related Course.REDUCEDC = 00, 01, 04 or 07
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
ITTSCHMS |
Plan HESA Data |
ITTSCHMS |
Sub-Plan HESA |
ITTSCHMS |
HESA Instance |
ITTSCHMS |
Field Derivation Rule: Derive a value if the following conditions are met:
Country = England
Instance.REDUCEDI = 00, 01, or 04
Related Course.TTCID = 1, 2, 8, or G
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
LEARNDIF |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = England
Instance.FESTUMK = 1, 3, or 4
Instance.REDUCEDI = 00 or 01
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
LEARNPLANENDDATE |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = England
Instance.REDUCEDI = 00 or 01
Instance.FESTUMK = 1, 3, 4 or 5
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page (in YYYY-MM-DD format).
End Date of the Expected Graduation Term defined for the Student Program, converted to YYYY-MM-DD format
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used: None
Field Derivation Rule: Derive a value if the following conditions are met:
Country = England or Northern Ireland
Instance.INSTAPP = 1
Instance.TYPEYR = 2, 3, 4, or 5
Instance.REDUCEDI = 00 or 01
Course.COURSEAIM does not begin D, L, P, Q, R, S or X
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Step:
Note: For this release, this field is derived as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used: None
Field Derivation Rule: Derive a value if the following conditions are met:
Country = England or Northern Ireland
Instance.INSTAPP = 1
Instance.TYPEYR = 2, 3, 4, or 5
Instance.REDUCEDI = 00 or 01
Course.COURSEAIM does not begin D, L, P, Q, R, S or X
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Step:
Note: For this release, this field is derived as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
LOCSDY |
Program Offering/Year HESA |
LOCSDY (Program Year HESA Data group box) |
Plan HESA Data |
LOCSDY |
Plan Offering/Year HESA |
LOCSDY (Plan Year HESA Data group box) |
Sub-Plan HESA |
LOCSDY |
Sub-Plan Offering/Year HESA |
LOCSDY (Sub-Plan Year HESA Data group box) |
HESA Instance |
LOCSDY |
HESA Instance |
Year of Program |
Field Derivation Rule: If Instance.REDUCEDI = 00, 01 or 09 derive a value. Otherwise, do not derive a value and leave the field blank.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance. Only records where Offering Start Term, Offering Start Session, Campus, Year Term and Year Session are all blank are considered.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance. Only records where Offering Start Term, Offering Start Session, Campus, Year Term and Year Session are all blank are considered.
Derive from the Plan HESA Data page.
Derive from the Program Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Further Education (Records and Enrollment, Career and Program Information, HESA Instance Details, Further Education) |
MATHGRADE |
Field Derivation Rule: Derive a value if all the following conditions are met.
Country = England
Instance.FESTUMK = 1, 3, or 4
Instance.REDUCEDI = 00 or 01
Instance.FUNDMODEL = 25 or 82
Derivation Steps:
Derive value from the Further Education page.
Derive as NONE.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Student Program |
Program Action Action Reason |
HESA Instance |
MCDATE |
HESA Action Reasons |
HESA Mode Direction (Change of Mode Mapping group box) |
Field Derivation Rule: Derive a value if the following conditions are met:
Country = England or Northern Ireland
Instance.REDUCEDI = 00 or 04
Related Course.COURSEAIM begins with D, E, L, or M (excluding M22, M26 or M28)
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
If MODE derivation step = 1 (that is derived from HESA Instance page), then derive MCDATE from HESA Instance page.
If MODE derivation step = 2 and the most recent record was selected to derive MODE, select any other earlier change of mode from the Student Program records where effective end date is within the reporting period.
For each record, determine from the Mode Direction mapping whether the MODE changed from Active to Inactive or vice versa.
If any one of the following three conditions is met, derive MCDATE as the effective date of the record that was used to derive MODE, formatted to YYYY-MM-DD:
The earliest Mode Direction From = Active and the latest Mode Direction To = Inactive.
The earliest Mode Direction From = Inactive and the latest Mode Direction To = Active.
The earliest Mode Direction From = Inactive, the latest Mode Direction To = Inactive, and a minimum of one of the selected records for the reporting period has a Mode Direction To = Active (that is, student was active at some point).
Derive as null.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program Offering/Year HESA |
MODE (Program Year HESA Data group box) |
Program Offering/Year HESA |
MODE (Program Offering HESA Data group box) |
Program HESA Data |
MODE (Program HESA Data group box) |
Plan Offering/Year HESA |
MODE (Plan Year HESA Data group box) |
Plan Offering/Year HESA |
MODE (Plan Offering HESA Data group box) |
Plan HESA Data |
MODE (Plan HESA Data group box) |
Sub-Plan Offering/Year HESA |
MODE (Sub-Plan Year HESA Data group box) |
Sub-Plan Offering/Year HESA |
MODE (Sub-Plan Offering HESA Data group box) |
Sub-Plan |
MODE (Sub-Plan HESA Data group box) |
Student Program |
Program Action Action Reason |
Student Program |
Acad Load |
HESA Instance |
MODE |
HESA Instance |
Year of Program |
Mode of Study |
HESA Mode of Study |
HESA Action Reasons |
Change of Mode Mapping |
Term/Session Table (Set up SACR, Foundation Table, Term Setup, Term/Session Table) |
Term |
Enrollment Limit (Records and Enrollment, Student Term Information, Term Activate a Student, Enrollment Limit) |
Approved Academic Load |
Field Derivation Rule: Include for all Instance entities.
Derivation Steps:
Derive from the HESA Instance page.
Select the Student Program record that has Program Action/Reason values mapped to a HESA Mode in the HESA Action Reasons page. Derive the mapped HESA mode value. If the derived value is 73 or 74 and the effective date of the record is prior to the reporting period start date, convert 73 to 63 and 74 to 64.
If Instance.COURSEID is based on a subplan and the MODE value from the Sub-Plan Offering/Year HESA page for the combination of Academic Load and YEARPRG of the student instance is defined, then derive the Sub-Plan Offering/Year HESA MODE value. Only records where Offering Start Term, Offering Start Session, Campus, Year Term and Year Session are all blank are considered.
If Instance.COURSEID is based on a subplan and MODE is defined in Sub-Plan Offering HESA Data for the academic load of the student instance, then derive the Sub-Plan Offering HESA Data MODE value. Only records where Offering Start Term, Offering Start Session, and Campus are all blank are considered.
If Instance.COURSEID is based on a subplan and MODE is defined in Sub-Plan HESA page, then derive the Sub-Plan HESA MODE value.
If the MODE value from the Plan Offering/Year HESA page for the combination of Academic Load and YEARPRG of the student instance is defined, then derive the Plan Offering/Year HESA MODE value. Only records where Offering Start Term, Offering Start Session, Campus, Year Term and Year Session are all blank are considered.
If the MODE value is defined in Plan Offering HESA Data for the academic load of the student instance, then derive Plan Offering HESA Data MODE value. Only records where Offering Start Term, Offering Start Session, and Campus are all blank are considered.
If MODE is defined in Plan HESA Data page, then derive that value.
If the MODE value from the Program Offering/Year HESA page for the combination of Academic Load and YEARPRG of the student instance is defined, then derive the Program Offering/Year HESA MODE value.
If the MODE value is defined in Program Offering HESA Data for the academic load of the student instance, then derive the Program Offering HESA Data MODE value.
If MODE is defined in Program HESA Data, then derive that value.
Map the Approved Academic Load from the most recent activated student term record that overlaps the reporting period to a HESA code value using the HESA Mode mapping. A term is considered to overlap if the begin date or end date falls within the reporting period.
Map the Academic Load for the most recent effective-dated record in the Student Program/Plan stack that has an Effective Date on or before the reporting period end date to a HESA code using the HESA Mode mapping.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
MSTUFEE |
Program Offering/Year HESA |
MSTUFEE (Program Offering HESA Data group box) |
Plan HESA Data |
MSTUFEE |
Plan Offering/Year HESA |
MSTUFEE (Plan Offering HESA Data group box) |
Sub-Plan HESA |
MSTUFEE |
Sub-Plan Offering/Year HESA |
MSTUFEE (Sub-Plan Offering HESA Data group box) |
HESA Instance |
MSTUFEE |
Field Derivation Rule: Derive a value if all the conditions are met:
Instance.REDUCEDI = 00 or 01
Instance.MODE is not 63 or 64
Instance.EXCHANGE is not 4 or G
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan Offering/Year HESA page for the academic load of the student instance. Only records where Offering Start Term, Offering Start Session, and Campus are all blank are considered.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan Offering/Year HESA page for the academic load of the student instance. Only records where Offering Start Term, Offering Start Session, and Campus are all blank are considered.
Derive from the Plan HESA Data page.
Derive from the Program Offering/Year HESA page for the academic load of the student instance.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
HESA Returns |
Account Type Waiver |
Fees After Calculation (Student Financials, Tuition and Fees, Review Fees After Calculation) |
Amount |
Program HESA Data |
NETFEE |
Program Offering/Year HESA |
NETFEE (Program Offering HESA Data group box) |
Plan HESA Data |
NETFEE |
Plan Offering/Year HESA |
NETFEE (Plan Offering HESA Data group box) |
Sub-Plan HESA |
NETFEE |
Sub-Plan Offering/Year HESA |
NETFEE (Sub-Plan Offering HESA Data group box) |
HESA Instance |
NETFEE |
Field Derivation Rule: Derive a value if these conditions are met:
Country is Northern Ireland or Scotland
Instance.FEEREGIME = 20
Or derive a value if one of these sets of conditions is met:
Set |
Conditions to be Met |
---|---|
England Postgraduate |
|
England Undergraduate |
|
Otherwise, derive as null.
Derivation Steps:
Derive from the HESA Instance page.
If Instance.GROSSFEE is derived from Step 2, NETFEE is derived as the rounded GROSSFEE minus the total of all waivers for the Student Career for terms that start within the reporting period. Fee records where the Item Type Code is Waiver and the Account Type is one of those defined with the Waiver check box selected in HESA Returns page. The derived value is then rounded to the nearest pound.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan Offering/Year HESA page for the academic load of the student instance. Only records where Offering Start Term, Offering Start Session, and Campus are all blank are considered.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan Offering/Year HESA page for the academic load of the student instance. Only records where Offering Start Term, Offering Start Session, and Campus are all blank are considered.
Derive from the Plan HESA Data page.
Derive from the Program Offering/Year HESA page for the academic load of the student instance.
Derive from the Program HESA Data page.
Use default.
Derive as null.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
NHSEMP |
Plan HESA Data |
NHSEMP |
Sub-Plan HESA |
NHSEMP |
HESA Instance |
NHSEMP |
Field Derivation Rule: Derive a value if the following conditions are met:
Country = England
Instance.REDUCEDI = 00 or 01
Related Course.COURSEAIM = M76, H76, I76, or J76
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
NONPAY |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = England
Instance.FESTUMK = 1, 3, or 4
Instance.REDUCEDI = 00
Course.MSFUND does not equal 91
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Student Program |
Program Action Action Reason |
HESA Instance |
NOTACT |
HESA Action Reasons |
Suspension of Active Studies Mapping |
Field Derivation Rule: If Instance.RSNEND and Instance.ENDDATE values do not exist, derive a value. Otherwise, do not derive a value and leave the field blank.
Derivation Steps:
Derive from the HESA Instance page.
If the most recent effective dated Student Program record has Program Action/Reason values mapped to the a HESA Suspension of Studies code on the HESA Action Reasons page, then derive the mapped HESA code value.
If Instance.MODE = 73 or 74, derive as 1.
Do not derive a value and leave the field blank.
Note: For correct derivation, ensure that if you have mapped a Program Action/Reason to a MODE of 73 or 74, map the same Program Action/Reason to a NOTACT value of 1 on the HESA Action Reasons page.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
NOUNTACH |
Plan HESA Data |
NOUNTACH |
Sub-Plan HESA |
NOUNTACH |
HESA Instance |
NOUNTACH |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = Wales
Instance.FESTUMK = 1, 3, or 4
Instance.REDUCEDI = 00
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
Instance Identifier Linked Career Linked Career Number Academic Career Student Career Nbr |
Field Derivation Rule: Include for all Instance entities.
Derivation Steps:
Derive from HESA Instance page as Instance Identifier.
Derive from HESA Instance page as Linked Career and Linked Career Number.
Derive from HESA Instance page as Academic Career and Student Career Nbr, for example, UGRD1.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
NUMHUSPREV |
Field Derivation Rule: Derive a value if related Course.COURSEAIM = D00, D01, L00, or L80.
Derivation Steps:
Derive from the HESA Instance page.
Derive as NULL.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
NUMUNITS |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = Wales
Instance.FESTUMK = 1, 3, or 4
Instance.REDUCEDI = 00
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
OWNINST |
Field Derivation Rule: Include for all Instance entities.
Derivation Steps:
Derive from the HESA Instance page.
Use default.
Do not derive a value and leave the field blank.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
PARTNERUKPRN |
Field Derivation Rule: Derive a value if the following conditions are met:
Country = England
Instance.FESTUMK = 1, 3, or 4
Instance.REDUCEDI = 00 or 01 and Instance.AIMTYPE is not 1
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Student Program |
Program Action Action Reason |
HESA Instance |
PHDSUB |
HESA Action Reasons |
Phd Submission Action Reason Mapping |
Field Derivation Rule: Derive a value if the following conditions are met:
Instance.REDUCEDI = 00, 01, or 04
Related Course.COURSEAIM = D00 or D01
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Derive from the HESA Instance page.
If there is a Research Candidate record for the instance, select the earliest effective dated thesis record where Actual Submission Date has a value and the effective date is on or before the reporting period end date. Derive as the Actual Submission Date formatted to YYYY-MM-DD.
Note: The process matches the Research Candidate record (SSR_RS_CAND_HDR) to the instance on EMPLID, Institution, Career and Career Number to find the Research Candidate Number (SSR_RS_CANDIT_NBR). The process associates the thesis records (SSR_RS_THESIS) with the Research Candidate record by EMPLID, Institution and Research Candidate Number. It selects the earliest Research Candidate record (by EFFDT, EFFSEQ) that has an Actual Submission Date (SSR_RS_ACT_SUB_DT).
Select the earliest Student Program record (exclude records with an effective date greater than the end date of the reporting period) that has Program Action/Reason values mapped in the Phd Submission Action Reason Mapping group box. Derive as the effective date of the record formatted to YYYY-MM-DD.
Derive as null.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
PLANEEPHOURS |
Field Derivation Rule: Derive a value if the following conditions are met:
Country = England
Instance.FESTUMK = 1, 3, 4, or 5
Instance.REDUCEDI = 00 or 01
Instance.FUNDMODEL = 10, 25, 35, 81, 82 or 99 and Instance.PROGTYPE is not 20, 21, 22, 23 or 25
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
PLANLEARNHOURS |
Field Derivation Rule: Derive a value if the following conditions are met:
Country = England AND Instance.FESTUMK = 1, 3, 4, or 5 AND Instance.REDUCEDI = 00 or 01
Instance.FUNDMODEL = 10, 25, 35, 81, 82 or 99 AND Instance.PROGTYPE is not 20, 21, 22, 23 or 25
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
PROGRESS |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = Wales
Instance.FESTUMK = 1, 3, or 4
Instance.REDUCEDI = 00
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
PROGTYPE |
Plan HESA Data |
PROGTYPE |
Sub-Plan HESA |
PROGTYPE |
HESA Instance |
PROGTYPE |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = England
Instance.FESTUMK = 1, 3, 4, or 5
Instance.REDUCEDI = 00 or 01
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Use default.
If Instance.AIMTYPE = 1 or 3, derive as NULL ERROR.
Do not derive a value and leave the field blank.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
PROPFUNDREMAIN |
Plan HESA Data |
PROPFUNDREMAIN |
Sub-Plan HESA |
PROPFUNDREMAIN |
HESA Instance |
PROPFUNDREMAIN |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = England
Instance.FESTUMK = 1 or 3
Instance.REDUCEDI = 00 or 01
Instance.AIMTYPE = 2, 3 or 4
Instance.FUNDMODEL = 21, 22 or 45
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
PWAYCODE |
Plan HESA Data |
PWAYCODE |
Sub-Plan HESA |
PWAYCODE |
HESA Instance |
PWAYCODE |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = England
Instance.FESTUMK = 1, 3, 4, or 5
Instance.REDUCEDI = 00 or 01
Instance.PROGTYPE = 02, 03, 20, 21, 22 or 23
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
QTS |
Plan HESA Data |
QTS |
Sub-Plan HESA |
QTS |
HESA Instance |
QTS |
Field Derivation Rule: Derive a value if the following conditions are met:
Country = England or Northern Ireland
Instance.REDUCEDI = 00, 01, or 04
Related Course.TTCID = 5
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
External System ID |
External System ID |
Field Derivation Rule: Derive a value if the following conditions are met:
Instance.REDUCEDI = 00, 01, or 04
Instance.RCSTDNT is not 99
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
If there is a Research Candidate record for the instance, select the value of the CAF attribute defined for RCSTDID in Returns Setup from the most recent active consumption record where the effective date is on or before the reporting period end date.
Select External System ID records for the person with the External ID Type defined for RCSTDID in the HESA Types page.
Do not derive a value and leave the field blank.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
RCSTDNT |
Plan HESA Data |
RCSTDNT |
Sub-Plan HESA |
RCSTDNT |
HESA Instance |
RCSTDNT |
Field Derivation Rule: Derive a value if the following conditions are met:
Instance.REDUCEDI = 00, 01, or 04
Related Course.COURSEAIM begins D, E, L, or M (except M22, M26, M28, M71, or M73)
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If there is a Research Candidate record for the instance, select the value of the CAF attribute defined for RCSTDNT in Returns Setup from the most recent active consumption record where the effective date is on or before the reporting period end date.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
RECFEE |
Field Derivation Rule: Derive a value only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = England
Instance.FESTUMK = 1, 3, or 4
Instance.REDUCEDI = 00 or 01
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
REDUCEDI |
Field Derivation Rule: Include for all Instance entities.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Country = England, Scotland, or Northern Ireland and Instance.STULOAD is 10.0 or less, derive as 01.
If Instance.EXCHANGE is 2, 4, 8, 9, A or G, derive as 03.
If Instance.MODE = 63 or 64, derive as 04.
Derive as 00.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Student Program |
Program Action Registration Reason |
HESA Instance Data |
RSNENGEND |
Field Derivation Rule: Derive a value if the following conditions are met:
Instance.REDUCEDI = 00, 01, 04, 07, 08 or 09
Instance.ENDDATE is completed.
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Derive value from the HESA Instance page.
If the most recent effective dated Student Program record has Program Action/Reason values mapped to a HESA Reason for Ending Instance code on the HESA Action Reasons page, then derive the mapped HESA code value.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
SASDAYS |
Field Derivation Rule: Derive a value if the following conditions are met:
Country = England
Course.REDUCEDC = 06 (SAS) or Course.TTCID = E (SAS)
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
SASSCHL |
Field Derivation Rule: Derive a value if the following conditions are met:
Country = England
Course.REDUCEDC = 06 (SAS) or Course.TTCID = E (SAS)
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
Program HESA Data |
SDEMPLOY |
Plan HESA Data |
SDEMPLOY |
Sub-Plan HESA |
SDEMPLOY |
HESA Instance |
SDEMPLOY |
Field Derivation Rule: Derive a value if the following conditions are met:
Instance.ENTRYRTE = 03 or 10
Instance.MODE is not 63 or 64
Derivation Steps:
Use constant.
Derive from HESA Instance page.
If Instance.COURSEID is based on a sub-plan, derive value from the Sub-Plan HESA page.
Derive value from Plan HESA Data page.
Derive value from Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
Program HESA Data |
SDLEAD |
Plan HESA Data |
SDLEAD |
Sub-Plan HESA |
SDLEAD |
HESA Instance |
SDLEAD |
Field Derivation Rule: Derive a value if the following conditions are met:
Instance.ENTRYRTE = 02, 03, or 10
Instance.MODE is not 63 or 64
Derivation Steps:
Use constant.
Derive from HESA Instance page.
If Instance.COURSEID is based on a sub-plan, derive value from the Sub-Plan HESA page.
Derive value from Plan HESA Data page.
Derive value from Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
SKEITT |
Field Derivation Rule: Derive a value if the following conditions are met:
Country = England
Course.REDUCEDC = 07 (SKE) or Course.TTCID = F (SKE)
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program Offering/Year HESA |
SPECFEE (Program Year HESA Data group box) |
Plan Offering/Year HESA |
SPECFEE (Plan Year HESA Data group box) |
Sub-Plan Offering/Year HESA |
SPECFEE (Sub-Plan Year HESA Data group box) |
HESA Instance |
SPECFEE |
Field Derivation Rule: Derive a value if Instance.REDUCEDI = 00.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance. Only records where Offering Start Term, Offering Start Session, Campus, Year Term and Year Session are all blank are considered.
Derive from the Plan Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance. Only records where Offering Start Term, Offering Start Session, Campus, Year Term and Year Session are all blank are considered.
Derive from the Program Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
SPLENGTH |
Program Offering/Year HESA |
SPLENGTH (Program Offering HESA Data group box) |
Plan HESA Data |
SPLENGTH |
Plan Offering/Year HESA |
SPLENGTH (Plan Offering HESA Data group box) |
Sub-Plan HESA |
SPLENGTH |
Sub-Plan Offering/Year HESA |
SPLENGTH (Sub-Plan Offering HESA Data group box) |
HESA Instance |
SPLENGTH |
Field Derivation Rule: Derive a value if the following conditions are met.
Instance.REDUCEDI = 00 or 01
Instance.FESTUMK is not 5
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan Offering/Year HESA page for the academic load of the student instance. Only records where Offering Start Term, Offering Start Session, and Campus are all blank are considered.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan Offering/Year HESA page for the academic load of the student instance. Only records where Offering Start Term, Offering Start Session, and Campus are all blank are considered.
Derive from the Plan HESA Data page.
Derive from the Program Offering/Year HESA page for the academic load of the student instance.
Derive from the Program HESA Data page.
Use default.
Derive as null.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
ST13 |
Field Derivation Rule: Derive a value only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = Wales
Instance.FESTUMK = 1 or 3
Instance.REDUCEDI = 00
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
Calculated FTE Report Zero Override FTE |
Field Derivation Rule: Derive a value if the following conditions are met.
Instance.REDUCEDI = 00, 01, or 03
Instance.FESTUMK is not 5
Derivation Steps:
Derive as zero, if the Report Zero check box is selected on the HESA Instance page for the reporting period.
Derive as the Override FTE value on the HESA Instance page for the reporting period.
Derive as the Calculated FTE value on the HESA Instance page for the reporting period.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
External System ID |
External System ID |
Field Derivation Rule: Derive a value if the following conditions are met:
Country = England or Wales
Instance.REDUCEDI = 00 or 01, or 04 or 08
Related Course.TTCID = 1
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Select External System ID records for the person with the External ID Type defined for TREFNO in the HESA Types page.
Use default.
If Country = England, derive NULL ERROR.
Do not derive a value and leave the field blank.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
TYPEYR |
Program Offering/Year HESA |
TYPEYR (Program Year HESA Data group box) |
Plan HESA Data |
TYPEYR |
Plan Offering/Year HESA |
TYPEYR (Plan Year HESA Data group box) |
Sub-Plan HESA |
TYPEYR |
Sub-Plan Offering/Year HESA |
TYPEYR (Sub-Plan Year Data group box) |
HESA Instance |
TYPEYR |
Field Derivation Rule: Derive a value if the following conditions are met.
Instance.REDUCEDI = 00 or 01
Instance.FESTUMK is not 5
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Derive as 1 if COMDATE is in the range 01-AUG to 31-DEC (any year) and ENDDATE is in the range 01-JAN to 31-JUL (any year) and RSNEND = 01 or 98.
Derive as 1 if Instance.COURSEID is based on a subplan, and a TYPEYR value of 1 is defined on the Sub-Plan Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance. Only records where Offering Start Term, Offering Start Session, Campus, Year Term and Year Session are all blank are considered.
Derive as 2 if Instance.COURSEID is based on a subplan, a TYPEYR value of 2, 3, 4, or 5 is defined on the Sub-Plan Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance, and COMDATE is within the reporting period. Only records where Offering Start Term, Offering Start Session, Campus, Year Term and Year Session are all blank are considered.
Derive as 3 if Instance.COURSEID is based on a subplan, a TYPEYR value of 2, 3, 4, or 5 is defined on the Sub-Plan Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance, COMDATE is prior to the reporting period, ENDDATE value does not exist or is not within the reporting period, and Country is “England”. Else, derive as 2 if Country is Scotland, Northern Ireland, or Wales. Only records where Offering Start Term, Offering Start Session, Campus, Year Term and Year Session are all blank are considered.
Derive as 4 if Instance.COURSEID is based on a subplan, a TYPEYR value of 2, 3, 4, or 5 is defined on the Sub-Plan Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance, COMDATE is prior to the reporting period, ENDDATE is within the reporting period, and Country is “England”. Else, derive as 2 if Country is Scotland, Northern Ireland, or Wales. Only records where Offering Start Term, Offering Start Session, Campus, Year Term and Year Session are all blank are considered.
Derive as 1 if Instance.COURSEID is based on a subplan and a TYPEYR value of 1 is defined on the Sub-Plan HESA page.
Derive as 2 if Instance.COURSEID is based on a subplan, a TYPEYR value of 2, 3, 4, or 5 is defined on the Sub-Plan HESA page, and COMDATE is within the reporting period.
Derive as 3 if Instance.COURSEID is based on a subplan, a TYPEYR value of 2, 3, 4, or 5 is defined on the Sub-Plan HESA page, COMDATE is prior to the reporting period, ENDDATE value does not exist or is not within the reporting period, and Country is “England”. Else, derive as 2 if Country is Scotland, Northern Ireland, or Wales.
Derive as 4 if Instance.COURSEID is based on a subplan, a TYPEYR value of 2, 3, 4, or 5 is defined on the Sub-Plan HESA page, COMDATE is prior to the reporting period, ENDDATE is within the reporting period, and and Country is “England”. Else, derive as 2 if Country is Scotland, Northern Ireland, or Wales..
Derive as 1 if a TYPEYR value of 1 is defined on the Plan Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance. Only records where Offering Start Term, Offering Start Session, Campus, Year Term and Year Session are all blank are considered.
Derive as 2 if a TYPEYR value of 2, 3, 4, or 5 is defined on the Plan Offering/Year HESA page for the combination of Academic Load and YEARPRG of the student instance, and COMDATE is within the reporting period. Only records where Offering Start Term, Offering Start Session, Campus, Year Term and Year Session are all blank are considered.
Derive as 3 if a TYPEYR value of 2, 3, 4, or 5 is defined on the Plan Offering/Year HESA page for the combination of Academic Load and YEARPRG of the student instance, COMDATE is prior to the reporting period, ENDDATE value does not exist or is not within the reporting period, and Country is “England”. Else, derive as 2 if Country is Scotland, Northern Ireland, or Wales. Only records where Offering Start Term, Offering Start Session, Campus, Year Term and Year Session are all blank are considered.
Derive as 4 if a TYPEYR value of 2, 3, 4, or 5 is defined on the Plan Offering/Year HESA page for the combination of Academic Load and YEARPRG of the student instance, COMDATE is prior to the reporting period, ENDDATE is within the reporting period, and Country is “England”. Else, derive as 2 if Country is Scotland, Northern Ireland, or Wales. Only records where Offering Start Term, Offering Start Session, Campus, Year Term and Year Session are all blank are considered.
Derive as 1 if a TYPEYR value of 1 is defined on the Plan HESA Data page.
Derive as 2 if a TYPEYR value of 2, 3, 4, or 5 is defined on the Plan HESA Data page, and COMDATE is within the reporting period.
Derive as 3 if a TYPEYR value of 2, 3, 4, or 5 is defined on the Plan HESA Data page, COMDATE is prior to the reporting period, ENDDATE value does not exist or is not within the reporting period, and Country is “England”. Else, derive as 2 if Country is Scotland, Northern Ireland, or Wales.
Derive as 4 if a TYPEYR value of 2, 3, 4, or 5 is defined on the Plan HESA Data page, COMDATE is prior to the reporting period, ENDDATE is within the reporting period, and Country is “England”. Else, derive as 2 if Country is Scotland, Northern Ireland, or Wales.
Derive as 1 if a TYPEYR value of 1 is defined on the Program Offering/Year HESA page for the combination of Academic Load and YEARPRG of the student instance.
Derive as 2 if a TYPEYR value of 2, 3, 4, or 5 is defined on the Program Offering/Year HESA page for the combination of Academic Load and YEARPRG of the student instance, and COMDATE is within the reporting period.
Derive as 3 if a TYPEYR value of 2, 3, 4, or 5 is defined on the Program Offering/Year HESA page for the combination of Academic Load and YEARPRG of the student instance, COMDATE is prior to the reporting period, ENDDATE value does not exist or is not within the reporting period, and Country is “England”. Else, derive as 2 if Country is Scotland, Northern Ireland, or Wales.
Derive as 4 if a TYPEYR value of 2, 3, 4, or 5 is defined on the Program Offering/Year HESA page for the combination of Academic Load and YEARPRG of the student instance, COMDATE is prior to the reporting period, ENDDATE is within the reporting period, and Country is “England”. Else, derive as 2 if Country is Scotland, Northern Ireland, or Wales.
Derive as 1 if a TYPEYR value of 1 is defined on the Program HESA Data page.
Derive as 2 if a TYPEYR value of 2, 3, 4, or 5 is defined on the Program HESA Data page and COMDATE is within the reporting period.
Derive as 3 if a TYPEYR value of 2, 3, 4, or 5 is defined on the Program HESA Data page, COMDATE is prior to the reporting period, ENDDATE value does not exist or is not within the reporting period, and Country is “England”. Else, derive as 2 if Country is Scotland, Northern Ireland, or Wales.
Derive as 4 if a TYPEYR value of 2, 3, 4, or 5 is defined on the Program HESA Data page, COMDATE is prior to the reporting period, ENDDATE is within the reporting period, and Country is “England”. Else, derive as 2 if Country is Scotland, Northern Ireland, or Wales..
Use default.
Derive as NULL ERROR.
The derivation logic can use the TYPEYR values of 3, 4, or 5 set up for year, program, plan, or subplan. However, it is expected that only values 1 (Course academic year contained within the HESA reporting year 1 August - 31 July) or 2 (Course academic year not contained within the HESA reporting year 1 August - 31 July) are relevant because the remaining values of 3, 4, and 5 apply to the student instance rather than the year as a whole.
The system repeats Steps 3 to 6, depending on the level at which the TYPEYR value is defined in the academic structure.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
UNITLGTH |
Program Offering/Year HESA |
UNITLGTH (Program Offering HESA Data group box) |
Plan HESA Data |
UNITLGTH |
Plan Offering/Year HESA |
UNITLGTH (Plan Offering HESA Data group box) |
Sub-Plan HESA |
UNITLGTH |
Sub-Plan Offering/Year HESA |
UNITLGTH (Sub-Plan Offering HESA Data group box) |
HESA Instance |
UNITLGTH |
Field Derivation Rule: Derive a value if the following conditions are met.If or 09, derive a value. Otherwise, do not derive a value and leave the field blank.
Instance.REDUCEDI = 00 or 01
Instance.FESTUMK is not 5
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan Offering/Year HESA page for the academic load of the student instance. Only records where Offering Start Term, Offering Start Session, and Campus are all blank are considered.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan Offering/Year HESA page for the academic load of the student instance. Only records where Offering Start Term, Offering Start Session, and Campus are all blank are considered.
Derive from the Plan HESA Data page.
Derive from the Program Offering/Year HESA page for the academic load of the student instance.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
WITHDRAWNREASON |
Field Derivation Rule: Derive only if the Include FE check box is selected.
Derive a value if the following conditions are met:
Country = England
Instance.CSTAT = 3 (withdrawn)
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Pages Used:
Page |
Page Element |
---|---|
Program HESA Data |
YEARLGTH |
Program Offering/Year HESA |
YEARLGTH (Program Year HESA Data group box) |
Plan HESA Data |
YEARLGTH |
Plan Offering/Year HESA |
YEARLGTH (Plan Year HESA Data group box) |
Sub-Plan HESA |
YEARLGTH |
Sub-Plan Offering/Year HESA |
YEARLGTH (Sub-Plan Year Data group box) |
HESA Instance |
YEARLGTH |
Field Derivation Rule: Derive a value if one of the the following conditions is met:
Country = Scotland AND Instance.REDUCEDI = 00.
Country = Wales, Instance. REDUCEDI= 00 AND Course.COURSEAIM does not begin with P, Q, R, S or X
Do not derive a value and leave the field blank, if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Instance.LOCSDY = D, F or T, derive as null.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan Offering/Year HESA page for the combination of Academic Load and YEARPRG of the student instance. Only records where Offering Start Term, Offering Start Session, Campus, Year Term and Year Session are all blank are considered.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan Offering/Year HESA page for the combination of Academic Load and YEARPRG of the student instance. Only records where Offering Start Term, Offering Start Session, Campus, Year Term and Year Session are all blank are considered.
Derive from the Plan HESA Data page.
Derive from the Program Offering/Year HESA page for the combination of Academic Load and YEARPRG of the student instance.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
Year of Program |
Field Derivation Rule: Derive a value if one of the following conditions is met:
Country = England, Northern Ireland, or Scotland AND Instance.REDUCEDI = 00 or 01 AND Instance.FESTUMK is not 5
Country = Wales, Instance.REDUCEDI = 00 or 01 AND Instance.FESTUMK is not 5 AND Course.COURSEAIM does not begin with P, Q, R, S or X
Derivation Steps:
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: Student Record
Entity: Instance
Page Used:
Page |
Page Element |
---|---|
HESA Instance |
Year of Student |
Field Derivation Rule: Derive a value if one of the following conditions is met:
Country = England, Northern Ireland, or Scotland AND Instance.REDUCEDI = 00 AND Instance.FESTUMK is not 5
Country = Wales, Instance.REDUCEDI = 00 or 01 AND Instance.FESTUMK is not 5 AND Course.COURSEAIM does not begin with P, Q, R, S or X
Derivation Steps:
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.