Appendix: (GBR) HESA Field Derivation

This chapter provides an overview of the Higher Education Statistics Agency (HESA) derivation steps and describes how Campus Solutions derives the field values for the HESA Student, ITT, DLHE, and Aggregate Offshore returns.

Click to jump to parent topicUnderstanding HESA Derivation Steps

Academic institutions submit the student-based statistical returns to HESA as an XML file. The XML file is composed of entities. Each entity, in turn, is composed of data fields. For example, the Institution entity in the student return 2009/10 has three data fields: INSTAPP, RECID, and UKPRN. The specifications for HESA returns are available from the HESA website. The specifications on the HESA website also include field validations and the valid field values for the various returns.

This chapter lists the:

The chapter does not list the Constant and Default fields on the HESA Fields page that the system uses for derivation. However, it does note the step where the system uses a constant and default value for derivation. For information about the HESA Fields page, refer to the “(GBR) Managing HESA Returns” chapter in this PeopleBook.

The system performs a sequence of steps to derive a field. If the system finds a value in a certain step, it does not perform the next step. For example, the system performs the following steps to derive the Course.BITTM field value:

  1. Use constant.

  2. If Course entity is based on a subplan, derive from the Sub-Plan HESA page.

  3. Derive from the Plan HESA Data page.

  4. Derive from the Program HESA Data page.

  5. Use default.

  6. Derive as NULL ERROR.

If a constant value exists for Course.BITTM, then the system uses the constant value in the return and does not perform Step 2 and the remaining steps. If a constant value does not exist, the system performs the next step in the sequence, which Step 2. If the system is not able to derive the value after performing Steps 1 through 5, it performs the last step and sets the Course.BITTM value to NULL ERROR in the HESA return.

The last derivation step for most fields is to assign the value as NULL ERROR or NULL. If HESA requires a value for a field, the last derivation step is to assign the field a value of NULL ERROR. If HESA does not require a value for a field, the last derivation step is to assign the field a value of NULL. For example, if the system cannot derive a Course.FEQAIMC value, it sets the Course.FEQAIMC value as NULL because HESA does not require a value for Course.FEQAIMC for all Course entities.

We recommend that you use the Extract Data pages to review and correct all the values that are derived as NULL ERROR before submission to HESA. The "(GBR) Managing HESA Returns" chapter discusses the Extract Data pages.

In some cases, before executing the derivation steps, the system checks the Field Derivation Rule to determine whether a value should be derived. If a value is not required, the system sets the field value as NULL. For example, before performing the derivation steps for Course.BITTM, the system first checks whether:

The system starts performing the derivation steps for Course.BITTM only if all three conditions are met. If all three conditions are not met, the system derives the field value as NULL.

Note. To derive a field value, the system uses the most recent effective-dated record that falls on or before the end of the reporting period. Exceptions to this rule are noted in this chapter.

The following table lists the navigation paths for the pages mentioned throughout this chapter:

Page

Navigation

Program HESA Data

Set Up SACR, Foundation Tables, Academic Structure, Academic Program Table, Program HESA Data

Program Offering/Year HESA

Set Up SACR, Foundation Tables, Academic Structure, Academic Program Table, Program Offering/Year HESA

Plan HESA Data

Set Up SACR, Foundation Tables, Academic Structure, Academic Plan Table, Plan HESA Data

Plan Offering/Year HESA

Set Up SACR, Foundation Tables, Academic Structure, Academic Plan Table, Plan Offering/Year HESA

Sub-Plan HESA

Set Up SACR, Foundation Tables, Academic Structure, Academic SubPlan Table, Sub-Plan HESA

Sub-Plan Offering/Year HESA

Set Up SACR, Foundation Tables, Academic Structure, Academic SubPlan Table, Sub-Plan Offering/Year HESA

HESA Module Data

Curriculum Management, Course Catalog, HESA Module Details

HESA Returns

Records and Enrollment, HESA Reporting, HESA Returns Setup, Returns Setup, HESA Returns

Student Program

Records and Enrollment, Career and Program Information, Student Program/Plan

HESA Instance Data

Records and Enrollment, Career and Program Information, HESA Instance Details, HESA Instance Data

Entry Profile Data

Records and Enrollment, Career and Program Information, HESA Instance Details, Entry Profile Data

HESA Action Reasons

Records and Enrollment, HESA Reporting, HESA Returns Setup, Returns Setup, HESA Action Reasons

HESA Types

Records and Enrollment, HESA Reporting, HESA Returns Setup, Returns Setup, HESA Types

External System ID

Campus Community, Personal Information (Student), Identification (Student), External System ID

Person HESA Data

Campus Community, Personal Information, Add/Update a Person, Person HESA Data

Enter DLHE Survey (self-service)

Click the Enter Survey button on the Survey Management page (Records and Enrollment, HESA Reporting, Destination of Leavers, Survey Management).

Click the Enter DLHE Survey link on the Student Center page (Self Service, Student Center).

Survey Details

Click the Details button on the Survey Management page.

For information about these pages and how to generate HESA Returns, refer to the chapter "(GBR) Managing HESA Returns."

Note. This chapter describes the delivered functionality for deriving the HESA return fields. You can use the Institution Data Capture page to determine at which level you can enter data for field derivation. Refer to the Setting Up and Entering Data for HESA Reporting section of the "(GBR) Managing HESA Returns" chapter for more information about the Institution Data Capture page.

We recommend that you review the return type specification that is available from the HESA website for field descriptions, validations, and valid field values.

See http://www.hesa.ac.uk.

Click to jump to parent topicStudent Record Return: Institution Entity

The Create Extract Application Engine (SSR_HE_DATA) process creates a single Institution entity. The Institution entity is composed of three fields.

Click to jump to top of pageClick to jump to parent topicIndicator for HEFCE Funding Approximations (INSTAPP)

Return: Student Record

Entity: Institution

Page Used:

Page

Page Element

HESA Returns

INSTAPP

Field Derivation Rule: If the country is England or Northern Ireland, derive a value. Otherwise, derive as NULL.

Derivation Steps:

  1. Derive from the HESA Returns page.

  2. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicRecord Type Indicator (RECID)

Return: Student Record

Entity: Institution

Pages Used:

Page

Page Element

Reporting Periods (Records and Enrollment, HESA Reporting, HESA Returns Setup, Reporting Periods)

Record Year

Returns (Records and Enrollment, HESA Reporting, HESA Returns Setup, Returns)

Record ID

Field Derivation Rule: Include for all Institution entities.

Derivation Steps:

  1. Derive as YYNNN, where YY is the final two digits of the Record Year (for example, 09 for 2009) and NNN is the 3-digit Record ID for the seeded return.

  2. Derive as NULL ERROR.

For Student Return 2009/10, the Record ID must be 051 and the Record Year for the Reporting Period must be 2009. The correct Record ID and Record Year for Student Return 2009/10 are delivered with your system.

Click to jump to top of pageClick to jump to parent topicUK Provider Reference Number (UKPRN)

Return: Student Record

Entity: Institution

Page Used:

Page

Page Element

HESA Configuration

UKPRN

Field Derivation Rule: Include for all Institution entities.

Derivation Steps:

  1. Derive from the HESA Returns page.

  2. Derive as NULL ERROR.

Click to jump to parent topicStudent Record Return: Course Entity

If you select the Include Course Entities check box on the Create Extract Data page, the Create Extract process creates Course entities based on the academic plans and academic subplans of the institution that are active and have been set up as eligible for reporting to HESA on the Plan HESA Data or the Sub-Plan HESA page.

If you select the Enable Sub-Plan Reporting check box on the HESA Returns page, the Create Extract process looks at both subplans and plans with the Report to HESA check box selected. If you did not select the Enable Sub-Plan Reporting check box on the HESA Returns page or if no subplan records are marked for reporting to HESA, then the extract process looks at only plan records for deriving the Course fields.

Note. You can specify an academic subplan, academic plan, or both on the Create Extract Data page to test the Create Extract process for a single plan or subplan. The process then uses the specified subplan or plan to create the Course entities. You must select the Enable Sub-Plan Reporting check box on the HESA Returns page if you want to specify a subplan on the Create Extract Data page.

If you have specified an academic career on the Create Extract Data page and no plan, the process includes only those plans that are related to the specified academic career either by looking at the Academic Career field on the Academic Plan Table page or by looking at the parent Academic Program settings (Academic Program field on the Academic Plan Table page and then Academic Career field on the Academic Program Table page).

If you have specified an academic career on the Create Extract Data page and no subplan, the process includes only those subplans whose parent Academic Plan is related to the Academic Career either directly (Academic Career field on the Academic Plan Table page) or by looking at the parent Academic Program settings (Academic Program field on the Academic Plan Table page, and then the Academic Career field on the Academic Program Table page).

If you have specified an academic plan on the Create Extract Data page and no subplan, the process includes only those subplans that are related to the specified plan by looking at the Academic Plan field on the Academic Sub-Plan Table page.

If you have selected the Null Errors Only check box for the Include Course Entities on the Create Extract Data page, the process selects distinct COURSEID values from the existing active Course extract data, where at least one field in the Course or Course Subject extract data has a Derived Value of NULL ERROR. The process then selects Course entity records for these COURSEIDs.

If you have selected the Validation Errors Only check box for the Include Course Entities, the process first deletes any Validation Error staging records where all of the COURSEID, MODID and EMPLID fields are blank. Then, it selects distinct COURSEID values from the Validation Error staging table for rows where COURSEID is not blank and EMPLID is blank. The process selects Course entity records for these COURSEIDs. Finally, it deletes records from the Validation Error staging table where COURSEID is populated and EMPLID is blank.

Click to jump to top of pageClick to jump to parent topicBilingual ITT Marker (BITTM)

Return: Student Record

Entity: Course

Pages Used:

Page

Page Element

Program HESA Data

BITTM

Plan HESA Data

BITTM

Sub-Plan HESA

BITTM

Field Derivation Rule: Derive a value only if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. If Course entity is based on a subplan, derive from the Sub-Plan HESA page.

  3. Derive from the Plan HESA Data page.

  4. Derive from the Program HESA Data page.

  5. Use default.

  6. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicClosed Course (CLSDCRS)

Return: Student Record

Entity: Course

Pages Used:

Page

Page Element

Program HESA Data

CLSDCRS

Plan HESA Data

CLSDCRS

Sub-Plan HESA

CLSDCRS

Field Derivation Rule: Derive a value only if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. If Course entity is based on a subplan, derive from the Sub-Plan HESA page.

  3. Derive from the Plan HESA Data page.

  4. Derive from the Program HESA Data page.

  5. Use default.

  6. Derive as 0.

Click to jump to top of pageClick to jump to parent topicCollaborating Organization (COLLORG)

Return: Student Record

Entity: Course

Pages Used:

Page

Page Element

Program HESA Data

COLLORG

Plan HESA Data

COLLORG

Sub-Plan HESA

COLLORG

Field Derivation Rule: Derive a value only if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. If Course entity is based on a subplan, derive from the Sub-Plan HESA page.

  3. Derive from the Plan HESA Data page.

  4. Derive from the Program HESA Data page.

  5. Use default.

  6. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicGeneral Qualification Aim of Course (COURSEAIM)

Return: Student Record

Entity: Course

Pages Used:

Page

Page Element

Program HESA Data

COURSEAIM

Plan HESA Data

COURSEAIM

Sub-Plan HESA

COURSEAIM

Field Derivation Rule: Include for all Course entities.

Derivation Steps:

  1. Use constant.

  2. If Course entity is based on a subplan, derive from the Sub-Plan HESA page.

  3. Derive from the Plan HESA Data page.

  4. Derive from the Program HESA Data page.

  5. Use default.

  6. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicCourse Identifier (COURSEID)

Return: Student Record

Entity: Course

Pages Used: None

Field Derivation Rule: Include for all Course entities.

Derivation Steps:

  1. If the Course entity is based on a subplan, derive from the Academic Sub-Plan Table record.

  2. Derive from the Academic Plan Table record.

Click to jump to top of pageClick to jump to parent topicCourse Title (CTITLE)

Return: Student Record

Entity: Course

Pages Used:

Page

Page Element

Plan HESA Data

Course Title

Sub-Plan HESA

HESA Course Title

Academic Plan Table (Set Up SACR, Foundation Tables, Academic Structure, Academic Plan Table )

Academic Plan

Academic Sub-Plan Table (Set Up SACR, Foundation Tables, Academic Structure, Academic SubPlan Table)

Academic Subplan

Field Derivation Rule: Include for all Course entities.

Derivation Steps:

  1. If the Course entity is based on a subplan, derive from the Sub-Plan HESA page.

    If the Course Title field does not have a value, use a combination of the plan and subplan descriptions from the Academic Plan Table and Academic Sub-Plan Table pages.

  2. Derive from the Plan HESA Data page.

    If the Course Title field does not have a value, use the plan description from the Academic Plan Table page.

Click to jump to top of pageClick to jump to parent topicFE General Qualification Aim (FEQAIMC)

Return: Student Record

Entity: Course

Pages Used:

Page

Page Element

Program HESA Data

FEQAIMC

Plan HESA Data

FEQAIMC

Sub-Plan HESA

FEQAIMC

Field Derivation Rule: Include for all Course entities.

Derivation Steps:

  1. Use constant.

  2. If Course entity is based on a subplan, derive from the Sub-Plan HESA page.

  3. Derive from the Plan HESA Data page.

  4. Derive from the Program HESA Data page.

  5. Use default.

  6. Derive as NULL.

Click to jump to top of pageClick to jump to parent topicMajor Source of Funding (MSFUND)

Return: Student Record

Entity: Course

Pages Used:

Page

Page Element

Program HESA Data

MSFUND

Plan HESA Data

MSFUND

Sub-Plan HESA

MSFUND

Field Derivation Rule: Derive a value if Course.REDUCEDC = 00, 01, 02, or 04. Otherwise, derive as NULL.

Derivation Steps:

  1. Use constant.

  2. If Course entity is based on a subplan, derive from the Sub-Plan HESA page.

  3. Derive from the Plan HESA Data page.

  4. Derive from the Program HESA Data page.

  5. Use default.

  6. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicNHS Bursaries (NHSBURSARY)

Return: Student Record

Entity: Course

Pages Used:

Page

Page Element

Program HESA Data

NHSBURSARY

Plan HESA Data

NHSBURSARY

Sub-Plan HESA

NHSBURSARY

Field Derivation Rule: Derive a value if Country = Northern Ireland, England or Wales and REDUCEDC = 00

Derivation Steps:

  1. Use Constant.

  2. If the Course entity is based on a sub-plan, derive from the Sub-Plan HESA page.

  3. Derive from Plan HESA Data.

  4. Derive from Program HESA Data

  5. Use default.

  6. Derive as Null Error.

Click to jump to top of pageClick to jump to parent topicReduced Course Return Indicator (REDUCEDC)

Return: Student Record

Entity: Course

Pages Used:

Page

Page Element

Program HESA Data

REDUCEDC

Plan HESA Data

REDUCEDC

Sub-Plan HESA

REDUCEDC

Field Derivation Rule: Include for all Course entities.

Derivation Steps:

  1. Use constant.

  2. If Course entity is based on a subplan, derive from the Sub-Plan HESA page.

  3. Derive from the Plan HESA Data page.

  4. Derive from the Program HESA Data page.

  5. Use default.

  6. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicRegulatory Body for Health and Social Care Students (REGBODY)

Return: Student Record

Entity: Course

Pages Used:

Page

Page Element

Program HESA Data

REGBODY

Plan HESA Data

REGBODY

Sub-Plan HESA

REGBODY

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. If Course entity is based on a subplan, derive from the Sub-Plan HESA page.

  3. Derive from the Plan HESA Data page.

  4. Derive from the Program HESA Data page.

  5. Use default.

  6. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicSubject Knowledge Enhancement Units (SKEUNITS)

Return: Student Record

Entity: Course

Pages Used:

Page

Page Element

Program HESA Data

SKEUNITS

Plan HESA Data

SKEUNITS

Sub-Plan HESA

SKEUNITS

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use Constant.

  2. If the Course entity is based on a sub-plan, derive from the Sub-Plan HESA page.

  3. Derive from Plan HESA Data.

  4. Derive from Program HESA Data

  5. Use default.

  6. Derive as Null Error.

Click to jump to top of pageClick to jump to parent topicSubject Knowledge Enhancement Placement (SKEOS)

Return: Student Record

Entity: Course

Pages Used:

Page

Page Element

Program HESA Data

SKEOS

Plan HESA Data

SKEOS

Sub-Plan HESA

SKEOS

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use Constant.

  2. If the Course entity is based on a sub-plan, derive from the Sub-Plan HESA page.

  3. Derive from Plan HESA Data.

  4. Derive from Program HESA Data

  5. Use default.

  6. Derive as Null Error.

Click to jump to top of pageClick to jump to parent topicTeaching Qualification Sought Sector (TQSSEC)

Return: Student Record

Entity: Course

Pages Used:

Page

Page Element

Program HESA Data

TQSSEC

Plan HESA Data

TQSSEC

Sub-Plan HESA

TQSSEC

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. If Course entity is based on a subplan, derive from the Sub-Plan HESA page.

  3. Derive from the Plan HESA Data page.

  4. Derive from the Program HESA Data page.

  5. Use default.

  6. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicTeaching Qualification Sought Subject (TQSSUB)

Return: Student Record

Entity: Course

Pages Used:

Page

Page Element

Program HESA Data

TQSSUB, TQSSUB2, TQSSUB3

Plan HESA Data

TQSSUB, TQSSUB2, TQSSUB3

Sub-Plan HESA

TQSSUB, TQSSUB2, TQSSUB3

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant to create a single TQSSUB field.

  2. If Course entity is based on a subplan, derive from the Sub-Plan HESA page.

  3. Derive from the Plan HESA Data page.

  4. Derive from the Program HESA Data page.

  5. Use default to create a single TQSSUB field.

  6. Derive a single TQSSUB field as Null Error.

Note. The system can derive up to three values. Each of the values is included as a separate TQSSUB field in the XML file.

Click to jump to top of pageClick to jump to parent topicTeacher Training Course (TTCID)

Return: Student Record

Entity: Course

Pages Used:

Page

Page Element

Program HESA Data

TTCID

Plan HESA Data

TTCID

Sub-Plan HESA

TTCID

Field Derivation Rule: Derive a value if one of the following conditions is met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. If Course entity is based on a subplan, derive from the Sub-Plan HESA page.

  3. Derive from the Plan HESA Data page.

  4. Derive from the Program HESA Data page.

  5. Use default.

  6. Derive as NULL ERROR.

Click to jump to parent topicStudent Record Return: Course Subject Entity

If you select the Include Course Entities check box on the Create Extract Data page, the Create Extract process creates Course Subject entity records for each Course entity. The process can create a maximum of three Course Subject entity records for each Course entity.

The derivation of Course Subject fields may vary depending on whether the parent Course entity is based on a subplan or plan record.

Click to jump to top of pageClick to jump to parent topicSubject of ITT Specialism Indicator (ITTSUBJECT)

Return: Student Record

Entity: Course Subject

Pages Used:

Page

Page Element

Program HESA Data

HESA Subject

ITT Subject Flag

Plan HESA Data

HESA Subject

ITT Subject Flag

Sub-Plan HESA

HESA Subject

ITT Subject Flag

Note. The system identifies a HESA subject as an ITT subject only if the ITT Subject Flag check box is selected for the HESA subject.

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. If Course entity is based on a subplan, derive from the Sub-Plan HESA page.

  2. Derive from the Plan HESA Data page.

  3. Derive from the Program HESA Data page.

Click to jump to top of pageClick to jump to parent topicSubject of Course (SBJCA)

Return: Student Record

Entity: Course Subject

Pages Used:

Page

Page Element

Program HESA Data

HESA Subject

Plan HESA Data

HESA Subject

Sub-Plan HESA

HESA Subject

Field Derivation Rule: Include for all Course Subject entities.

Derivation Steps:

  1. If Course entity is based on a subplan, derive from the Sub-Plan HESA page.

  2. Derive from the Plan HESA Data page.

  3. Derive from the Program HESA Data page.

Click to jump to top of pageClick to jump to parent topicSubject Percentage (SBJPCNT)

Return: Student Record

Entity: Course Subject

Pages Used:

Page

Page Element

Program HESA Data

HESA Subject Percentage

Plan HESA Data

HESA Subject Percentage

Sub-Plan HESA

HESA Subject Percentage

Field Derivation Rule: Include for all Course Subject entities.

Derivation Steps:

  1. If Course entity is based on a subplan, derive from the Sub-Plan HESA page.

  2. Derive from the Plan HESA Data page.

  3. Derive from the Program HESA Data page.

Click to jump to parent topicStudent Record Return: Module Entity

If you select the Include Module Entities check box on the Create Extract Data page, the Create Extract process creates the Module entities. To create Module entities, the process uses the institution's Course Offering records that are active and have been set up as eligible for reporting to HESA. You must select the Report to HESA check box on the HESA Module Data page to make a course offering record eligible for HESA reporting.

If HESA Module Data records do not exist, the process does not include the course offerings in the Module entity. The process includes dummy modules in the module entity.

Note. When you run the Create Extract process, you can choose to enter the course ID or course offering number as a run parameter for testing purposes. The Create Extract process then uses the specified course ID or course offering number to create the Module entities.

If you have selected an academic career and no course offering on the Create Extract Data page, then the process selects only those course offerings that are related to the selected career.

If you have selected the Null Errors Only check box for the Include Module Entities on the Create Extract Data page, the Create Extract process selects distinct MODID values from the existing active Module extract data, where at least one field in the Module or Module Subject extract data has a Derived Value of NULL ERROR. The process then selects Module entity records for these MODIDs.

If you have selected the Validation Errors Only check box for the Include Module 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 MODID values from the Validation Error staging table for rows where MODID is not blank and EMPLID is blank. The process selects Module entity records for these MODIDs. Note that the File Parser process removes the leading zeroes from MODID, therefore, the comparison of MODID with Course ID and Course Offering Number includes the logic to correctly match the values. The system makes an assumption that the Course Offering Number is a single digit. Finally, the Create Extract process deletes records from the Validation Error staging table where MODID is populated and EMPLID is blank.

Click to jump to top of pageClick to jump to parent topicCredit Value of Module (CRDTPTS)

Return: Student Record

Entity: Module

Page Used:

Page

Page Element

HESA Module Data

CRDTPTS

Catalog Data (Curriculum Management, Course Catalog, Catalog Data)

Maximum Units, Academic Progress Units, Enrollment Unit Load Calc Type

Field Derivation Rule: Include for all Module entities.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Module Data page.

  3. Select the Course Catalog record for the Course ID. If the Enrollment Unit Load Calc Type value is Academic Progress Units, derive from the Academic Progress Units value. If the Enrollment Unit Load Calc Type value is any other value, derive from the Maximum Units value. Round off the fractional values to the nearest whole number. This step is not performed for dummy modules.

  4. Use default.

  5. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicCredit Transfer Scheme (CRDTSCM)

Return: Student Record

Entity: Module

Page Used:

Page

Page Element

HESA Module Data

CRDTSCM

Field Derivation Rule: Include for all Module entities.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Module Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicModule FTE (FTE)

Return: Student Record

Entity: Module

Page Used:

Page

Page Element

HESA Module Data

FTE

Field Derivation Rule: Include for all Module entities.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Module Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicLevel of Credit Points (LEVLPTS)

Return: Student Record

Entity: Module

Page Used:

Page

Page Element

HESA Module Data

LEVLPTS

Field Derivation Rule: If Module.CRDTPTS does not equal 999, derive a value. Otherwise, derive as NULL.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Module Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicModule Identifier (MODID)

Return: Student Record

Entity: Module

Page Used:

Page

Page Element

HESA Module Data

Course ID

Course Offering Nbr

Field Derivation Rule: Include for all Module entities.

Derivation Steps:

1. Derive as combination of Course ID plus Course Offering Number (CRSE_ID and CRSE_OFFER_NBR column values from PS_CRSE_OFFER). For example, if Course ID = 001248 and Offering Number = 2, then MODID = 0012482.

Click to jump to top of pageClick to jump to parent topicModule Taught in a Celtic Language (MODLANG)

Return: Student Record

Entity: Module

Page Used:

Page

Page Element

HESA Module Data

MODLANG

Field Derivation Rule: If Country = Northern Ireland, Scotland, or Wales, derive a value. Otherwise, derive as NULL

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Module Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicModule Title (MTITLE)

Return: Student Record

Entity: Module

Page Used:

Page

Page Element

HESA Module Data

Short description that appears on the right of Course ID page element

HESA Dummy Module Data

Year

Field Derivation Rule: Include for all Module entities.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Module Data page for standard modules. If short description is unavailable on the HESA Module Data page, derive as the description of the parent Course Catalog record.

    For dummy modules, the MTITLE is derived as a combination of the Plan description, the text Year, and the year value of the dummy module record separated by spaces. For example, for Academic Plan = BA ENG with description BA English and Year = 2, MTITLE is derived as BA English Year 2.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicPercentage Not Taught By This Institution (PCOLAB)

Return: Student Record

Entity: Module

Page Used:

Page

Page Element

HESA Module Data

PCOLAB

Field Derivation Rule: Include for all Module entities.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Module Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicOther Institution Providing Teaching (TINST)

Return: Student Record

Entity: Module

Page Used:

Page

Page Element

HESA Module Data

TINST

Field Derivation Rule: If Module.PCOLAB is greater than zero, derive a value. Otherwise, derive as NULL.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Module Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to parent topicStudent Record Return: Module Subject Entity

If you select the Include Module Entities check box on the Create Extract Data page, the Create Extract process creates a maximum of 16 Module Subject entity records for each Module entity. To create the Module Subject entity records, the process uses the subject records for each Module record. Each module subject is a combination of Cost Center and Subject. The Module HESA Data page ensures that each combination of Cost Center and Subject is unique and the total percentage equals 100.

If you have not defined subjects on the Module Subjects region of the HESA Module Data page, then the process creates a single Module Subject entity record. The process derives the values for each field within the entity using the constant or default value defined on the HESA Fields page (Records and Enrollment, HESA Reporting, HESA Returns Setup, Returns Setup, HESA Fields). If a constant or default is not available, the process derives the value as NULL ERROR. Note that if you have defined a constant, the process does not examine any subjects defined on the HESA Module Data page (that is, the process does not execute derivation step 2 for the Module Subject fields).

Click to jump to top of pageClick to jump to parent topicCost Centre (COSTCN)

Return: Student Record

Entity: Module Subject

Page Used:

Page

Page Element

HESA Module Data

Cost Centre

Field Derivation Rule: Include for all Module Subject entities.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Module Data page.

  3. Use Default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicSubject of Module (MODSBJ)

Return: Student Record

Entity: Module Subject

Page Used:

Page

Page Element

HESA Module Data

Subject

Field Derivation Rule: Include for all Module Subject entities.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Module Data page.

  3. Use Default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicSubject/Cost Centre Percentage (MODSBJP)

Return: Student Record

Entity: Module Subject

Page Used:

Page

Page Element

HESA Module Data

Percentage

Field Derivation Rule: Include for all Module Subject entities.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Module Data page.

  3. Use Default.

  4. Derive as NULL ERROR.

Click to jump to parent topicStudent Record Return: Student Entity

The Create Extract process creates a single Student entity for each student included in the Instance entity. However, it is possible for a student to have multiple distinct Instances for a particular return. In this case, only one Student entity will be created.

The process creates the Student entities only if the Include Student Entities check box is selected on the Create Extract Data page.

The process uses each distinct HESA unique student identifier (HUSID) to create a Student entity. The process also uses the student's EMPLID to link the HUSID with the person data to derive fields within the Student entity. The process creates the Student entity after creating all the other entities because of the dependency on values derived for the Course, Instance, and Entry Profile fields.

Click to jump to top of pageClick to jump to parent topicDate of Birth (BIRTHDTE)

Return: Student Record

Entity: Student

Page Used:

Page

Page Element

Biographical Details (Campus Community , Personal Information (Student), Add/Update a Person, Biographical Details)

Date of Birth

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Derive from the Biographical Details page in the format YYYY-DD-MM.

  2. Derive as NULL with ReasonForNull = 1.

Click to jump to top of pageClick to jump to parent topicDisability (DISABLE)

Return: Student Record

Entity: Student

Pages Used:

Page

Page Element

Person HESA Data

DISABLE

Impairment AUS (Campus Community, Personal Information, Health Information, Impairment AUS )

Type of Impairment

Disability (Records and Enrollment, HESA Reporting, Codes and Mappings, Code Mappings, Disability)

HESA Disability Code

Field Derivation Rule: If the student has at least one Instance with REDUCEDI = 00, 01, 06 or 07, derive a value. Otherwise, derive as NULL.

Derivation Steps:

  1. Derive from the Person HESA Data page.

  2. If the student has multiple impairment records in the Impairment AUS page, derive as 08 (multiple disabilities). If the student has a single impairment record, use the HESA Disability code from the mapping between the impairment type and the HESA disability code.

  3. Use default.

  4. Derive as NULL ERROR.

You can define a default as either 00 (no known disability) or 99 (not known).

Click to jump to top of pageClick to jump to parent topicEthnicity (ETHNIC)

Return: Student Record

Entity: Student

Pages Used:

Page

Page Element

Person HESA Data

ETHNIC

Ethnicity (Campus Community , Personal Information (Student), Biographical (Student), Personal Attributes, Ethnicity)

Regulatory Region, Ethnic Group

Ethnicity (Records and Enrollment, HESA Reporting, Codes and Mappings, Code Mappings, Ethnicity)

HESA Ethnic Code

Country Description (Set Up HRMS, Install, Country Table, Country Description)

See Integrating Campus Solutions with Human Capital Management.

2-Char Country Code

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Derive from the Person HESA Data page.

  2. Select Person Ethnicity records as follows:

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicForenames (FNAMES)

Return: Student Record

Entity: Student

Page Used:

Page

Page Element

Names (Campus Community, Personal Information (Student), Add/Update a Person, Biographical Details, Names)

First Name

Middle Name

Field Derivation Rule: If a student has at least one Instance with REDUCED = 00, 01, or 04, derive a value. Otherwise, derive as NULL.

Derivation Steps:

  1. Use the First Name and Middle Name values from the Primary Name record.

  2. Derive as NULL with ReasonForNull = 9.

Click to jump to top of pageClick to jump to parent topicGender (GENDER)

Return: Student Record

Entity: Student

Page Used:

Page

Page Element

Biographical Details (Campus Community , Personal Information (Student), Add/Update a Person, Biographical Details)

Gender

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Use the Gender value from the Biographical History record.

    If the gender value is Male, derive as 1.

    If the gender value is Female, derive as 2.

    If the gender value is unknown, derive as 9.

  2. Use default.

  3. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicHESA Unique Student Identifier (HUSID)

Return: Student Record

Entity: Student

Page Used:

Page

Page Element

External System ID

External System ID

Field Derivation Rule: Include for all Student entities.

Derivation Step:

1. Select External System ID records for the person with the External ID Type defined for HUSID in the HESA Types page.

Validate that the derived value is in the correct format (refer to the Notes section for HUSID available on the HESA website). If the value is invalid, log an error message.

Click to jump to top of pageClick to jump to parent topicNationality (NATION)

Return: Student Record

Entity: Student

Pages Used:

Page

Page Element

Person HESA Data

NATION

Citizenship and Passport (Campus Community , Personal Information (Student), Identification (Student), Citizenship, Citizenship and Passport)

Country

Nationality (Records and Enrollment, HESA Reporting, Codes and Mappings, Code Mappings, Nationality)

HESA Nationality Code

Field Derivation Rule: Derive a value if Country = England, Scotland or Wales. Otherwise, derive as NULL.

Derivation Steps:

  1. Derive from the Person HESA Data page.

  2. Select person citizenship records and retrieve the related two-character code (COUNTRY_2CHAR) from the Country table (PS_COUNTRY_TBL). If a mapping exists in the HESA Nationality Code page for the Campus Solutions Country code, use the mapped HESA value else use the COUNTRY_2CHAR value.

    If a single record exists, derive the Campus Solutions country code or HESA country code.

  3. If multiple person citizenship records are found and a record has a value of GB, derive as GB.

  4. If multiple records are found, and none have the GB country value but a minimum one record has a country value that is marked as European Union (EU) country then derive the EU country. If there are multiple EU countries report the one with the lowest alphabetic HESA code. Note that the PS_COUNTRY_TBL contains an indicator (EU_MEMBER_STATE) to specify if the country is a member of the EU.

  5. If multiple records are found and none have the UK or EU value, select the lowest alphabetic code

  6. Use default.

  7. If the student has at least one Instance with REDUCEDI = 00 or 03 and COMDATE on or after 2007-08-01, derive as NULL ERROR else derive as NULL.

In most cases, you can use the Campus Solutions two-character country code to report the NATION value. However, some Campus Solutions country codes are not valid for HESA reporting. For example, the Campus Solutions Cyprus code (CY) cannot be reported. Cyprus has to be reported as XA, XB, or XC. In these cases, you must use the Nationality code mapping page to ensure the correct NATION values are reported to HESA.

Click to jump to top of pageClick to jump to parent topicNational Identity (NATIOND)

Return: Student Record

Entity: Student

Page Used:

Page

Page Element

Person HESA Data

NATIOND

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Derive from the Person HESA Data page.

  2. Use default

  3. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicInstitution's Own Identifier for Student (OWNSTU)

Return: Student Record

Entity: Student

Pages Used: None

Field Derivation Rule: Include for all Student entities.

Derivation Step:

1. Derive as EMPLID.

Note. Although the OWNSTU field is optional for HESA reporting, the system derives this field value for all students to assist with record identification.

Click to jump to top of pageClick to jump to parent topicScottish Candidate Number (SCN)

Return: Student Record

Entity: Student

Page Used:

Page

Page Element

External System ID

External System ID

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Select External System ID records for the person with the External ID Type defined for SCN in the HESA Types page. Value should not be 999999999.

  2. Derive as NULL with ReasonForNull = 1.

Click to jump to top of pageClick to jump to parent topicDependants in Reporting Year (SDEPEND)

Return: Student Record

Entity: Student

Page Used:

Page

Page Element

Person HESA Data

SDEPEND

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Derive from the Person HESA Data page.

  2. Use default.

  3. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicFamily Name on 16th Birthday (SNAME16)

Return: Student Record

Entity: Student

Page Used:

Page

Page Element

Names (Campus Community, Personal Information (Student), Add/Update a Person, Biographical Details, Names)

Last Name

Note. The Last Name page element can accept a maximum of thirty characters.

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Use the Last Name value from the Primary Name record. The last name must have a Type of Name value that corresponds with the Name Type set for SNAME16 in the HESA Types page.

  2. Derive as NULL.

Click to jump to top of pageClick to jump to parent topicFamily Name (SURNAME)

Return: Student Record

Entity: Student

Page Used:

Page

Page Element

Names (Campus Community, Personal Information (Student), Add/Update a Person, Biographical Details, Names)

Last Name

Note. The Last Name page element can accept a maximum of thirty characters.

Field Derivation Rule: If the student has at least one Instance with REDUCEDI = 00, 01, or 04 derive a value. Otherwise, derive as NULL.

Derivation Steps:

  1. Use the Last Name value from the Primary Name record.

  2. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicTerm-time Accommodation (TTACCOM)

Return: Student Record

Entity: Student

Page Used:

Page

Page Element

Person HESA Data

TTACCOM

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Derive from the Person HESA Data page.

  2. Use default

  3. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicTerm-time Postcode (TTPCODE)

Return: Student Record

Entity: Student

Page Used:

Page

Page Element

Person HESA Data

TTPCODE

Addresses (Campus Community, Personal Information (Student), Biographical (Student), Addresses/Phones, Addresses)

Postal

Field Derivation Rule: Derive a value if one of the following conditions is met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Derive from the Person HESA Data page.

  2. Select the most recent address record (exclude records with an effective date greater than the end date of the reporting period) that has a country code of GBR. The record must have an Address Type that corresponds with the Address Type set for TTPCODE in the HESA Types page.

  3. Use default.

  4. Derive as NULL with ReasonForNull = 1.

For steps 1 and 2, the system validates that the derived post code value is in the correct format (refer to the examples for TTPCODE available on the HESA website).

Click to jump to top of pageClick to jump to parent topicUCAS Personal Identifier (UCASPERID)

Return: Student Record

Entity: Student

Page Used:

Page

Page Element

External System ID

External System ID

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Select External System ID records for the person with the External ID Type defined for UCASPERID in the HESA Types page.

  2. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicUnique Learner Number (ULN)

Return: Student Record

Entity: Student

Page Used:

Page

Page Element

External System ID

External System ID

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Select External System ID records for the person with the External ID Type defined for ULN in the HESA Types page.

    Validate the derived value using the checksum method. For information on the checksum method, refer to the Notes section for the ULN field available on the HESA website.

  2. Derive as NULL.

Click to jump to top of pageClick to jump to parent topicWelsh Speaker Indicator (WELSSP)

Return: Student Record

Entity: Student

Page Used:

Page

Page Element

Person HESA Data

WELSSP

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the Person HESA Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to parent topicStudent 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 data.

The process includes a student career as an Instance entity if the following three conditions are met:

If the student is a continuing student, then one of the following conditions must be satisfied:

If the student is a new student, then one of the following conditions must be satisfied:

Note. The HIN Population Year value in the HESA Instance Data 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 Data page for a student career:

The system does not automatically calculate the Year of Course and Year of Student values on the HESA Instance Data page. You must use the HESA Instance Data 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.

Click to jump to top of pageClick to jump to parent topicAdditional Support Cost (ADDSUPCT)

Return: Student Record

Entity: Instance

Page Used:

Page

Page Element

HESA Instance Data

ADDSUPCT

Field Derivation Rule: Derive only if the Include FE check box is selected.

Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicFoundation Degree to Degree Bridging Course (BRIDGE)

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:

Derivation Steps:

  1. Use constant.

  2. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  3. Derive from the Plan HESA Data page.

  4. Derive from the Program HESA Data page.

  5. Use default.

  6. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicCampus Identifier (CAMPID)

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:

  1. Use constant.

  2. Use the mapping to derive the HESA Campus code for the Campus value entered in the Student Program page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicCompletion Status (CSTAT)

Return: Student Record

Entity: Instance

Page Used:

Page

Page Element

HESA Instance Data

CSTAT

Field Derivation Rule: Derive only if the Include FE check box is selected.

Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicStart Date of Instance (COMDATE)

Return: Student Record

Entity: Instance

Page Used:

Page

Page Element

HESA Instance Data

Start Date of Instance

Effective Date

Field Derivation Rule: Include for all Instance entities.

Derivation Steps:

  1. Derive as the Start Date of Instance from the HESA Instance Data page.

  2. 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.

    1. Select all activated terms for the student career of the Instance.

    2. 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 is null 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 NULL or matches one of the program values in the Student Program records for that career and career number.

    3. 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.

    4. Derive the earliest Class Start Date from all the selected classes as COMDATE.

  3. The earliest Effective Date of the HESA Instance Data records.

For steps 2 and 3, the system stores the derived date as the Start Date of Instance value in the HESA Instance record.

Click to jump to top of pageClick to jump to parent topicCourse Identifier (COURSEID)

Return: Student Record

Entity: Instance

Pages Used: None

Field Derivation Rule: Include for all Instance entities.

Derivation Steps:

  1. If the student's subplan is reported in the Course extract, derive from the student's subplan.

  2. Derive from the student's plan.

Click to jump to top of pageClick to jump to parent topicDestination (DESTIN)

Return: Student Record

Entity: Instance

Page Used:

Page

Page Element

HESA Instance Data

DESTIN

Field Derivation Rule: Derive only if the Include FE check box is selected.

Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicDestination of Outward Credit Mobile Students (DESTOCM)

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 Data

DESTOCM, DESTOCM2, DESTOCM3

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant to create a single DESTOCM field.

  2. Derive from the HESA Instance Data page.

  3. 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.

  4. Derive from the Plan Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance.

  5. Derive from the Program Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance.

  6. Use default to create a single DESTOCM field.

  7. 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.

Click to jump to top of pageClick to jump to parent topicDepartment of Health Funding Body (DHFUND)

Return: Student Record

Entity: Instance

Pages Used:

Page

Page Element

Program HESA Data

DHFUND

Plan HESA Data

DHFUND

Sub-Plan HESA

DHFUND

HESA Instance Data

DHFUND

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  4. Derive from the Plan HESA Data page.

  5. Derive from the Program HESA Data page.

  6. Use default.

  7. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicRegulatory Body Reference Number (DHREGREF)

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:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Select External System ID records for the person with the External ID Type defined for DHREGREF in the HESA Types page.

  2. Use default.

  3. Derive as NULL ERROR.

You can define a default of 99999999 for this field.

Click to jump to top of pageClick to jump to parent topicDisabled Student Allowance (DISALL)

Return: Student Record

Entity: Instance

Page Used:

Page

Page Element

HESA Instance Data

DISALL

Impairment AUS (Campus Community, Personal Information, Health Information, 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:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. 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.

  4. Use default.

  5. Derive as NULL ERROR.

Note. The system derives Student.DISABLE before creating the Student entity in order to derive the Student.DISALL field.

Click to jump to top of pageClick to jump to parent topicDisadvantage Uplift Factor (DISUPFAC)

Return: Student Record

Entity: Instance

Pages Used:

Page

Page Element

HESA Instance Data

DISUPFAC

Field Derivation Rule: Derive only if the Include FE check box is selected.

Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicEligibility for Disadvantaged Uplift (ELIDISUP)

Return: Student Record

Entity: Instance

Page Used:

Page

Page Element

HESA Instance Data

ELIDISUP

Field Derivation Rule: Derive only if the Include FE check box is selected.

Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicEligibility for Enhanced Funding (ELIGENFD)

Return: Student Record

Entity: Instance

Page Used:

Page

Page Element

HESA Instance Data

ELIGENFD

Field Derivation Rule: Derive only if the Include FE check box is selected.

Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicEmployer Role (EMPROLE)

Return: Student Record

Entity: Instance

Page Used:

Page

Page Element

HESA Instance Data

EMPROLE

Field Derivation Rule: Derive only if the Include FE check box is selected.

Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicEnd Date of Instance (ENDDATE)

Return: Student Record

Entity: Instance

Pages Used:

Page

Page Element

Student Program

Program Action

Action Reason

Effective Date

HESA Action Reasons

Reason for Ending Instance Mapping

Field Derivation Rule: Include for all Instance entities.

Derivation Steps:

  1. 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 effective date of the record formatted to YYYY-MM-DD.

  2. Derive as NULL with ReasonForNull attribute = 9.

Click to jump to top of pageClick to jump to parent topicExchange Programmes (EXCHANGE)

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 Data

EXCHANGE

Field Derivation Rule: Derive a value if one of the following conditions is met:

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. 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.

  4. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  5. Derive from the Plan Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance.

  6. Derive from the Plan HESA Data page.

  7. Derive from the Program Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance.

  8. Derive from the Program HESA Data page.

  9. Use default.

  10. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicFee Eligibility (FEEELIG)

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 Data

FEEELIG

Fee Eligibility (Records and Enrollment, HESA Reporting, Codes and Mappings, Code Mappings, Fee Eligibility)

HESA Fee Eligibility

Field Derivation Rule: If Instance.REDUCEDI = 00 or 01 derive a value. Otherwise, derive as NULL.

Derivation Steps:

  1. Use constant.

  2. 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.

  3. Derive from the HESA Instance Data page.

  4. 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.

  5. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  6. Derive from the Plan Offering/Year HESA page for the academic load of the student instance.

  7. Derive from the Plan HESA Data page.

  8. Derive from the Program Offering/Year HESA page for the academic load of the student instance.

  9. Derive from the Program HESA Data page.

  10. Use default.

  11. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicFE Student Marker (FESTUMK)

Return: Student Record

Entity: Instance

Pages Used:

Page

Page Element

Program HESA Data

FESTUMK

Plan HESA Data

FESTUMK

Sub-Plan HESA

FESTUMK

HESA Instance Data

FESTUMK

HESA Returns

Include FE

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Derive as 2 if Include FE check box is not selected on the HESA Returns page.

  2. Derive from the HESA Instance Data page.

  3. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  4. Derive from the Plan HESA Data page.

  5. Derive from the Program HESA Data page.

  6. Use default.

  7. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicFranchise Partner (FRANPART)

Return: Student Record

Entity: Instance

Pages Used:

Page

Page Element

Program HESA Data

FRANPART

Plan HESA Data

FRANPART

Sub-Plan HESA

FRANPART

HESA Instance Data

FRANPART

Field Derivation Rule: Derive only if the Include FE check box is selected.

Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  4. Derive from the Plan HESA Data page.

  5. Derive from the Program HESA Data page.

  6. Use default.

  7. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicFranchised Out Arrangements (FROUTARR)

Return: Student Record

Entity: Instance

Pages Used:

Page

Page Element

Program HESA Data

FROUTARR

Plan HESA Data

FROUTARR

Sub-Plan HESA

FROUTARR

HESA Instance Data

FROUTARR

Field Derivation Rule: Derive only if the Include FE check box is selected.

Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  4. Derive from the Plan HESA Data page.

  5. Derive from the Program HESA Data page.

  6. Use default.

  7. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicFTE Method (FTEMETHOD)

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 Data

FTEMETHOD

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. 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.

  4. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  5. Derive from the Plan Offering/Year HESA page for the academic load of the student instance.

  6. Derive from the Plan HESA Data page.

  7. Derive from the Program Offering/Year HESA page for the academic load of the student instance.

  8. Derive from the Program HESA Data page.

  9. Use default.

  10. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicFundability Code (FUNDCODE)

Return: Student Record

Entity: Instance

Pages Used:

Page

Page Element

Program HESA Data

FUNDCODE

Plan HESA Data

FUNDCODE

Sub-Plan HESA

FUNDCODE

HESA Instance Data

FUNDCODE

Field Derivation Rule: If Instance.REDUCEDI = 00 or 01, derive a value. Otherwise, derive as NULL.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  4. Derive from the Plan HESA Data page.

  5. Derive from the Program HESA Data page.

  6. Use default.

  7. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicCompletion of Year of Instance (FUNDCOMP)

Return: Student Record

Entity: Instance

Page Used:

Page

Page Element

HESA Instance Data

FUNDCOMP

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicLevel Applicable to Funding Council HESES (FUNDLEV)

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 Data

FUNDLEV

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. 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.

  4. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  5. Derive from the Plan Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance.

  6. Derive from the Plan HESA Data page.

  7. Derive from the Program Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance.

  8. Derive from the Program HESA Data page.

  9. Use default.

  10. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicGuided Learning Hours (GLHRS)

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 Data

GLHRS

Field Derivation Rule: Derive only if the Include FE check box is selected.

Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. 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.

  4. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  5. Derive from the Plan Offering/Year HESA page for the academic load of the student instance.

  6. Derive from the Plan HESA Data page.

  7. Derive from the Program Offering/Year HESA page for the academic load of the student instance.

  8. Derive from the Program HESA Data page.

  9. Use default.

  10. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicGovernment Initiatives (GOVINIT)

Return: Student Record

Entity: Instance

Pages Used:

Page

Page Element

Program HESA Data

GOVINIT

Plan HESA Data

GOVINIT

Sub-Plan HESA

GOVINIT

HESA Instance Data

GOVINIT

Field Derivation Rule: Derive only if the Include FE check box is selected.

Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  4. Derive from the Plan HESA Data page.

  5. Derive from the Program HESA Data page.

  6. Use default.

  7. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicImplied Rate of Council Partial Funding (IMPRATE)

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 Data

IMPRATE

Field Derivation Rule: Derive only if the Include FE check box is selected.

Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. 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.

  4. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  5. Derive from the Plan Offering/Year HESA page for the academic load of the student instance.

  6. Derive from the Plan HESA Data page.

  7. Derive from the Program Offering/Year HESA page for the academic load of the student instance.

  8. Derive from the Program HESA Data page.

  9. Use default.

  10. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicInstitution's Own Campus Identifier (INSTCAMP)

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:

  1. Use constant.

  2. Use the mapping to derive the HESA Campus code for the Campus value entered in the Student Program page.

  3. Use default.

  4. If Country = Wales and Course.COURSEAIM = X41, X42, X43, X44, X45 or X46 then derive as NULL ERROR.

  5. Derive as NULL.

Click to jump to top of pageClick to jump to parent topicInitiatives (INITIATIVES)

Return: Student Record

Entity: Instance

Pages Used:

Page

Page Element

Program HESA Data

INITIATIVES

Plan HESA Data

INITIATIVES

Sub-Plan HESA

INITIATIVES

HESA Instance Data

INITIATIVES

Field Derivation Rule: Derive a value if Country = England.

Derive as NULL if the condition is not met.

Derivation Steps:

  1. Derive from the HESA Instance Data page.

  2. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  3. Derive from the Plan HESA Data page.

  4. Derive from the Program HESA Data page.

  5. Derive as NULL.

Click to jump to top of pageClick to jump to parent topicITT Phase/Scope (ITTPHSC)

Return: Student Record

Entity: Instance

Pages Used:

Page

Page Element

Program HESA Data

ITTPHSC

Plan HESA Data

ITTPHSC

Sub-Plan HESA

ITTPHSC

HESA Instance Data

ITTPHSC

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  4. Derive from the Plan HESA Data page.

  5. Derive from the Program HESA Data page.

  6. Use default.

  7. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicITT Schemes (ITTSCHMS)

Return: Student Record

Entity: Instance

Pages Used:

Page

Page Element

Program HESA Data

ITTSCHMS

Plan HESA Data

ITTSCHMS

Sub-Plan HESA

ITTSCHMS

HESA Instance Data

ITTSCHMS

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  4. Derive from the Plan HESA Data page.

  5. Derive from the Program HESA Data page.

  6. Use default.

  7. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicLearning Difficulty (LEARNDIF)

Return: Student Record

Entity: Instance

Page Used:

Page

Page Element

HESA Instance Data

LEARNDIF

Field Derivation Rule: Derive only if the Include FE check box is selected.

Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicFTE in Year A (LOADYRA)

Return: Student Record

Entity: Instance

Pages Used: None

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Step:

Note. For this release, this field is derived as Null Error .

Click to jump to top of pageClick to jump to parent topicFTE in Year B (LOADYRB)

Return: Student Record

Entity: Instance

Pages Used: None

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Step:

Note. For this release, this field is derived as Null Error .

Click to jump to top of pageClick to jump to parent topicLocation of Study (LOCSDY)

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 Data

LOCSDY

Field Derivation Rule: If Instance.REDUCEDI = 00 or 01 derive a value. Otherwise, derive as NULL.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. 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.

  4. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  5. Derive from the Plan Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance.

  6. Derive from the Plan HESA Data page.

  7. Derive from the Program Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance.

  8. Derive from the Program HESA Data page.

  9. Use default.

  10. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicChange of Mode Date (MCDATE)

Return: Student Record

Entity: Instance

Pages Used:

Page

Page Element

Student Program

Program Action

Action Reason

HESA Instance Data

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:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. If MODE derivation step = 1 (that is derived from HESA Instance Data page), then derive MCDATE from HESA Instance Data page.

  2. 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:

  3. Derive as NULL with ReasonForNull = 9.

Click to jump to top of pageClick to jump to parent topicMode of Study (MODE)

Return: Student Record

Entity: Instance

Pages Used:

Page

Page Element

Program Offering/Year HESA

MODE (Program Year HESA Data group box)

Plan Offering/Year HESA

MODE (Plan Year HESA Data group box)

Sub-Plan Offering/Year HESA

MODE (Sub-Plan Year Data group box)

Student Program

Program Action

Action Reason

Student Program

Acad Load

HESA Instance Data

MODE

Mode of Study (Records and Enrollment, HESA Reporting, Codes and Mappings, Code Mappings, 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:

  1. Derive from the HESA Instance Data page.

  2. 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.

  3. 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 equals 23, 24, or 25 (sandwich placement year), then derive the Sub-Plan Offering/Year HESA MODE value.

  4. If the MODE value from the Plan Offering/Year HESA page for the combination of Academic Load and YEARPRG of the student instance equals 23, 24, or 25, then derive the Plan Offering/Year HESA MODE value.

  5. If the MODE Value from the Program Offering/Year HESA page for the combination of Academic Load and YEARPRG of the student instance equals 23, 24, or 25, then derive the Program Offering/Year HESA MODE value.

  6. Select the most recent activated student term record that overlaps the reporting period. That is, the process selects the record with the latest term begin date from terms where the term begin date or the term end date falls within the reporting period. Select the approved academic load from the most recent term record and use the mapping on the Mode of Study page to retrieve the corresponding HESA mode for the selected academic load.

  7. Select the academic load from the Student Program record. Derive the mapped HESA code for the selected academic load from the Mode of Study page.

  8. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicMajor Source of Tuition Fees (MSTUFEE)

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 Data

MSTUFEE

Field Derivation Rule: If Instance.REDUCEDI = 00, 01, or 02 derive a value. Otherwise, derive as NULL.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. 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.

  4. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  5. Derive from the Plan Offering/Year HESA page for the academic load of the student instance.

  6. Derive from the Plan HESA Data page.

  7. Derive from the Program Offering/Year HESA page for the academic load of the student instance.

  8. Derive from the Program HESA Data page.

  9. Use default.

  10. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicNHS Employer (NHSEMP)

Return: Student Record

Entity: Instance

Pages Used:

Page

Page Element

Program HESA Data

NHSEMP

Plan HESA Data

NHSEMP

Sub-Plan HESA

NHSEMP

HESA Instance Data

NHSEMP

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  4. Derive from the Plan HESA Data page.

  5. Derive from the Program HESA Data page.

  6. Use default.

  7. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicReason for Partial and Full Non-payment of Tuition (NONPAY)

Return: Student Record

Entity: Instance

Page Used:

Page

Page Element

HESA Instance Data

NONPAY

Field Derivation Rule: Derive only if the Include FE check box is selected.

Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicSuspension of Active Studies (NOTACT)

Return: Student Record

Entity: Instance

Pages Used:

Page

Page Element

Student Program

Program Action

Action Reason

HESA Instance Data

NOTACT

HESA Action Reasons

Suspension of Active Studies Mapping

Field Derivation Rule: If Instance.RSNEND and Instance.ENDDATE are NULL derive a value. Otherwise, derive as NULL.

Derivation Steps:

  1. Derive from the HESA Instance Data page.

  2. 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.

  3. Derive as NULL.

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.

Click to jump to top of pageClick to jump to parent topicNumber of Units to Achieve Full Qualification (NOUNTACH)

Return: Student Record

Entity: Instance

Pages Used:

Page

Page Element

Program HESA Data

NOUNTACH

Plan HESA Data

NOUNTACH

Sub-Plan HESA

NOUNTACH

HESA Instance Data

NOUNTACH

Field Derivation Rule: Derive only if the Include FE check box is selected.

Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  4. Derive from the Plan HESA Data page.

  5. Derive from the Program HESA Data page.

  6. Use default.

  7. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicStudent Instance Identifier (NUMHUS)

Return: Student Record

Entity: Instance

Page Used:

Page

Page Element

HESA Instance Data

Instance Identifier

Linked Career

Linked Career Number

Academic Career

Student Career Nbr

Field Derivation Rule: Include for all Instance entities.

Derivation Steps:

  1. Derive from HESA Instance Data page as Instance Identifier.

  2. Derive from HESA Instance Data page as Linked Career and Linked Career Number.

  3. Derive from HESA Instance Data page as Academic Career and Student Career Nbr, for example, UGRD1.

Click to jump to top of pageClick to jump to parent topicNumber of Units Completed (NUMUNITS)

Return: Student Record

Entity: Instance

Page Used:

Page

Page Element

HESA Instance Data

NUMUNITS

Field Derivation Rule: Derive only if the Include FE check box is selected.

Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Derive from the HESA Instance Data page.

  2. Use default.

  3. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicInstitution's Own Instance Identifier (OWNINST)

Return: Student Record

Entity: Instance

Page Used:

Page

Page Element

HESA Instance Data

OWNINST

Field Derivation Rule: Include for all Instance entities.

Derivation Steps:

  1. Derive from the HESA Instance Data page.

  2. Use default.

  3. Derive as NULL.

Click to jump to top of pageClick to jump to parent topicPhD Submission Date (PHDSUB)

Return: Student Record

Entity: Instance

Pages Used:

Page

Page Element

Student Program

Program Action

Action Reason

HESA Instance Data

PHDSUB

HESA Action Reasons

Phd Submission Action Reason Mapping

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Derive from the HESA Instance Data page.

  2. 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.

  3. Derive as NULL with ReasonForNull = 9.

Click to jump to top of pageClick to jump to parent topicGood Standing Marker (PROGRESS)

Return: Student Record

Entity: Instance

Page Used:

Page

Page Element

HESA Instance Data

PROGRESS

Field Derivation Rule: Derive only if the Include FE check box is selected.

Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicQualified Teacher Status (QTS)

Return: Student Record

Entity: Instance

Pages Used:

Page

Page Element

Program HESA Data

QTS

Plan HESA Data

QTS

Sub-Plan HESA

QTS

HESA Instance Data

QTS

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  4. Derive from the Plan HESA Data page.

  5. Derive from the Program HESA Data page.

  6. Use default.

  7. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicResearch Council Student Identifier (RCSTDID)

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:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Select External System ID records for the person with the External ID Type defined for RCSTDID in the HESA Types page.

  2. Derive as NULL.

Click to jump to top of pageClick to jump to parent topicResearch Council Student (RCSTDNT)

Return: Student Record

Entity: Instance

Pages Used:

Page

Page Element

Program HESA Data

RCSTDNT

Plan HESA Data

RCSTDNT

Sub-Plan HESA

RCSTDNT

HESA Instance Data

RCSTDNT

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  4. Derive from the Plan HESA Data page.

  5. Derive from the Program HESA Data page.

  6. Use default.

  7. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicAmount of Tuition Fees Received/Expected for the Student (RECFEE)

Return: Student Record

Entity: Instance

Page Used:

Page

Page Element

HESA Instance Data

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:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicReduced Instance Return Indicator (REDUCEDI)

Return: Student Record

Entity: Instance

Page Used:

Page

Page Element

HESA Instance Data

REDUCEDI

Field Derivation Rule: Include for all Instance entities.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. If Country = England, Scotland, or Northern Ireland and Instance.STULOAD is 10.0 or less, derive as 01.

  4. If Country = England or Wales and Include FE = Y and Instance.FESTUMK = 4, derive as 02 .

  5. If Instance.EXCHANGE is 2, 4, 8, 9 or A, derive as 03.

  6. If Instance.MODE = 63 or 64, derive as 04.

  7. Derive as 00.

Click to jump to top of pageClick to jump to parent topicReason for Ending Instance (RSNEND)

Return: Student Record

Entity: Instance

Pages Used:

Page

Page Element

Student Program

Program Action

Action Reason

HESA Action Reasons

Reason for Ending Instance Mapping

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. 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.

  2. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicNumber of Student Associates Scheme Days Completed (SASDAYS)

Return: Student Record

Entity: Instance

Page Used:

Page

Page Element

HESA Instance Data

SASDAYS

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicStudent Associates Scheme Placement (SASSCHL)

Return: Student Record

Entity: Instance

Page Used:

Page

Page Element

HESA Instance Data

SASSCHL

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicSubject Knowledge Enhancement Institution (SKEITT)

Return: Student Record

Entity: Instance

Page Used:

Page

Page Element

HESA Instance Data

SKEITT

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicSpecial Fee Indicator (SPECFEE)

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 Data

SPECFEE

Field Derivation Rule: Derive if one of the following conditions is met:

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. 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.

  4. Derive from the Plan Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance.

  5. Derive from the Program Offering/Year HESA page for the combination of academic load and YEARPRG of the student instance.

  6. Use default.

  7. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicExpected Length of Study (SPLENGTH)

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 Data

SPLENGTH

Field Derivation Rule: If Instance.REDUCEDI = 00, 01, or 02 derive a value. Otherwise, derive as NULL.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. 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.

  4. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  5. Derive from the Plan Offering/Year HESA page for the academic load of the student instance.

  6. Derive from the Plan HESA Data page.

  7. Derive from the Program Offering/Year HESA page for the academic load of the student instance.

  8. Derive from the Program HESA Data page.

  9. Use default.

  10. Derive as NULL with ReasonForNull = 9 .

Click to jump to top of pageClick to jump to parent topicSLDD-Discrete Provision (ST13)

Return: Student Record

Entity: Instance

Page Used:

Page

Page Element

HESA Instance Data

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:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicStudent Instance FTE (STULOAD)

Return: Student Record

Entity: Instance

Page Used:

Page

Page Element

HESA Instance Data

Calculated FTE

Report Zero

Override FTE

Field Derivation Rule: If Instance.REDUCEDI = 00, 01, 02, or 03, derive a value. Otherwise, derive as NULL.

Derivation Steps:

  1. Derive as zero, if the Report Zero check box is selected on the HESA Instance Data page for the reporting period.

  2. Derive as the Override FTE value on the HESA Instance Data page for the reporting period.

  3. Derive as the Calculated FTE value on the HESA Instance Data page for the reporting period.

  4. Use default.

  5. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicTeacher Reference Number (TREFNO)

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:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Select External System ID records for the person with the External ID Type defined for TREFNO in the HESA Types page.

  2. Use default.

  3. Derive as NULL.

Click to jump to top of pageClick to jump to parent topicType of Instance Year (TYPEYR)

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 Data

TYPEYR

Field Derivation Rule: If Instance.REDUCEDI = 00 or 01 derive a value. Otherwise, derive as NULL.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. 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.

  4. 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.

  5. 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, and ENDDATE is null or not within the reporting period.

  6. 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, and ENDDATE is within the reporting period.

  7. 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.

  8. 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.

  9. 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, and ENDDATE is null or not within the reporting period.

  10. 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, and ENDDATE is within the reporting period.

  11. 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.

  12. 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.

  13. 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, and ENDDATE is null or not within the reporting period.

  14. 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, and ENDDATE is within the reporting period.

  15. Derive as 1 if a TYPEYR value of 1 is defined on the Plan HESA Data page.

  16. 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.

  17. 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, and ENDDATE is null or not within the reporting period.

  18. 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, and ENDDATE is within the reporting period.

  19. 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.

  20. 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.

  21. 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, and ENDDATE is null or not within the reporting period.

  22. 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, and ENDDATE is within the reporting period.

  23. Derive as 1 if a TYPEYR value of 1 is defined on the Program HESA Data page.

  24. 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.

  25. 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, and ENDDATE is null or not within the reporting period.

  26. 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, and ENDDATE is within the reporting period.

  27. Use default.

  28. 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.

Click to jump to top of pageClick to jump to parent topicUnits of Length (UNITLGTH)

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 Data

UNITLGTH

Field Derivation Rule: If Instance.REDUCEDI = 00, 01, or 02 derive a value. Otherwise, derive as NULL.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. 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.

  4. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  5. Derive from the Plan Offering/Year HESA page for the academic load of the student instance.

  6. Derive from the Plan HESA Data page.

  7. Derive from the Program Offering/Year HESA page for the academic load of the student instance.

  8. Derive from the Program HESA Data page.

  9. Use default.

  10. Derive as NULL ERROR..

Click to jump to top of pageClick to jump to parent topicLength of Current Year of Instance (YEARLGTH)

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 Data

YEARLGTH

Field Derivation Rule: Derive a value if one of the the following conditions is met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. If Instance.LOCSDY = D or F, derive as NULL with ReasonForNull = 9.

  4. 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.

  5. If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  6. Derive from the Plan Offering/Year HESA page for the combination of Academic Load and YEARPRG of the student instance.

  7. Derive from the Plan HESA Data page.

  8. Derive from the Program Offering/Year HESA page for the combination of Academic Load and YEARPRG of the student instance.

  9. Derive from the Program HESA Data page.

  10. Use default.

  11. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicYear of Program (YEARPRG)

Return: Student Record

Entity: Instance

Page Used:

Page

Page Element

HESA Instance Data

Year of Program

Field Derivation Rule: Derive a value if one of the the following conditions is met:

Derivation Steps:

  1. Derive from the HESA Instance Data page.

  2. Use default.

  3. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicYear of Student on This Instance (YEARSTU)

Return: Student Record

Entity: Instance

Page Used:

Page

Page Element

HESA Instance Data

Year of Student

Field Derivation Rule: Derive a value if one of the following conditions is met:

Derivation Steps:

  1. Derive from the HESA Instance Data page.

  2. Use default.

  3. Derive as NULL ERROR.

Click to jump to parent topicStudent Record Return: Entry Profile Entity

If you select the Include Student Entities check box on the Create Extract Data page, the Create Extract process creates a Entry Profile entity. The process creates a Entry Profile entity for each Instance entity if either the Instance.COMDATE is within the reporting period or if the Include Entry Profile check box is selected on the Entry Profile Data page. The process creates a single Entry Profile entity using the same key structure as the Instance record.

Click to jump to top of pageClick to jump to parent topicAccess Programmes (ACCESS)

Return: Student Record

Entity: Entry Profile

Page Used:

Page

Page Element

Entry Profile Data

ACCESS

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the Entry Profile Data page.

  3. Use default.

  4. Derive as NULL ERROR .

Click to jump to top of pageClick to jump to parent topicArticulation (ARTICLN)

Return: Student Record

Entity: Entry Profile

Page Used:

Page

Page Element

Entry Profile Data

ARTICLN

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the Entry Profile Data page.

  3. Use default.

  4. Derive as NULL ERROR .

Click to jump to top of pageClick to jump to parent topicDomicile (DOMICILE)

Return: Student Record

Entity: Entry Profile

Pages Used:

Page

Page Element

Residency Self-Report (Campus Community, Personal Information (Student), Identification (Student), Residency Data, Residency Self-Report)

State

Country

Entry Profile Data

DOMICILE

Nationality (Records and Enrollment, HESA Reporting, Codes and Mappings, Code Mappings, Nationality)

HESA Domicile

Area of Permanent Residence (Set Up SACR, Product Related, Recruiting and Admissions, UCAS, Mappings, Area of Permanent Residence)

HESA Code

Field Derivation Rule: Include for all Entry Profile entities.

Derivation Steps:

  1. Derive from the Entry Profile Data page.

  2. Select the Residency Self-Report record with the latest Date Reported before the Instance.COMDATE. If no record is found, then select the record with the earliest Date Reported date on or after Instance.COMDATE.

    If a Residency Self-Report record is found and the Country value is not GBR, retrieve the related two-character code (COUNTRY_2CHAR) from the Country table (PS_COUNTRY_TBL). If the mapping to a HESA Domicile exists on the Nationality page for the Campus Solutions country code, use the mapped HESA Domicile value; otherwise, use the COUNTRY_2CHAR value.

  3. If the Residency Self-Report record is found, the Country value is GBR, and a State value exists, select the country and state values. If a mapping exists on the Area of Permanent Residence page between a HESA country code and the selected country and state values, use the mapped HESA Country code. If no mapping is found, log an error message and derive XK.

  4. If a Residency Self-Report record is found, the Country value is GBR, and a State value does not exist, derive XK.

  5. Use default.

  6. Derive as NULL ERROR .

Note that some Campus Solutions country codes are invalid for HESA reporting. Use the Nationality page to map the valid HESA codes with the Campus Solutions country codes.

Click to jump to top of pageClick to jump to parent topicMarital Status (MARSTAT)

Return: Student Record

Entity: Entry Profile

Pages Used:

Page

Page Element

Biographical Details (Campus Community, Personal Information (Student), Add/Update Person, Biographical Details)

Marital Status

Entry Profile Data

MARSTAT

Marital Status (Records and Enrollment, HESA Reporting, Codes and Mappings, Code Mappings, Marital Status )

HESA Marital Status

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Derive from the Entry Profile Data page.

  2. Select the Marital Status value from the Biographical History record. Use the mapping on the Marital Status page to derive the HESA Martial Status code.

  3. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicNew Entrant to Higher Education (NEWENT)

Return: Student Record

Entity: Entry Profile

Page Used:

Page

Page Element

Entry Profile Data

NEWENT

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the Entry Profile Data page.

  3. Use default.

  4. Derive as NULL .

Click to jump to top of pageClick to jump to parent topicDependents on Entry (NIDEPEND)

Return: Student Record

Entity: Entry Profile

Page Used:

Page

Page Element

Entry Profile Data

NIDEPEND

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the Entry Profile Data page.

  3. Use default.

  4. Derive as NULL ERROR .

Click to jump to top of pageClick to jump to parent topicParental Education (PARED)

Return: Student Record

Entity: Entry Profile

Page Used:

Page

Page Element

Entry Profile Data

PARED

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the Entry Profile Data page.

  3. Use default.

  4. Derive as NULL ERROR .

Click to jump to top of pageClick to jump to parent topicPGCE Class of Undergraduate Degree (PGCECLSS)

Return: Student Record

Entity: Entry Profile

Page Used:

Page

Page Element

Entry Profile Data

PGCECLSS

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the Entry Profile Data page.

  3. Use default.

  4. Derive as NULL ERROR .

Click to jump to top of pageClick to jump to parent topicPGCE Subject of Undergraduate Degree (PGCESBJ)

Return: Student Record

Entity: Entry Profile

Page Used:

Page

Page Element

Entry Profile Data

PGCESBJ

PGCESBJ2

PGCESBJ3

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Use constant to create a single PGCESBJ field.

  2. Derive from the Entry Profile Data page.

  3. Use default to create a single PGCESBJ field.

  4. Derive a single PGCESBJ field as NULL ERROR .

Note. The system can derive up to three values. Each of the values is included as a separate PGCESBJ field in the XML file.

Click to jump to top of pageClick to jump to parent topicPostcode (POSTCODE)

Return: Student Record

Entity: Entry Profile

Pages Used:

Page

Page Element

Addresses (Campus Community, Personal Information (Student), Biographical (Student), Addresses/Phones, Addresses)

Postal

Entry Profile Data

POSTCODE

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Derive from the Entry Profile Data page.

  2. Select the most recent address record that a country code of GBR. The record must have an address type that matches the address type mapped with POSTCODE in the HESA Types page. Derive the post code from this record.

  3. Derive as NULL with ReasonForNull = 1.

For steps 1 and 2, the system validates that the derived post code value is in the correct format.

Click to jump to top of pageClick to jump to parent topicLast School Attended (PREVINST)

Return: Student Record

Entity: Entry Profile

Page Used:

Page

Page Element

Entry Profile Data

PREVINST

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Derive from the Entry Profile Data page.

  2. Use default.

  3. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicHighest Qualification On Entry (QUALENT2)

Return: Student Record

Entity: Entry Profile

Page Used:

Page

Page Element

Entry Profile Data

QUALENT2

Field Derivation Rule:

Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Derive from the Entry Profile Data page.

  2. Use default.

  3. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicHighest Qualification On Entry (QUALENT3)

Return: Student Record

Entity: Entry Profile

Page Used:

Page

Page Element

Entry Profile Data

QUALENT3

Field Derivation Rule:

Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Derive from the Entry Profile Data page.

  2. Use default.

  3. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicReligion (RELIGION)

Return: Student Record

Entity: Entry Profile

Pages Used:

Page

Page Element

Religious Preference (Campus Community, Personal Information (Student), Biographical (Student), Personal Attributes, Religious Preference)

Religious Preference

Entry Profile Data

RELIGION

Religion (Records and Enrollment, HESA Reporting, Codes and Mappings, Code Mappings, Religion )

HESA Religion

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Derive from the Entry Profile Data page.

  2. Select the religious preference from the personal information record. Use the mapping on the Religion page to derive the HESA Religion code.

    If the HESA religion code mapping does not exist, log an error message and skip to the next step.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicSocio-Economic Classification (SEC)

Return: Student Record

Entity: Entry Profile

Page Used:

Page

Page Element

Entry Profile Data

SEC

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Derive from the Entry Profile Data page.

  2. Use default.

  3. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicOccupation Code (SOC2000)

Return: Student Record

Entity: Entry Profile

Page Used:

Page

Page Element

Entry Profile Data

SOC2000

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Derive from the Entry Profile Data page.

  2. Use default.

  3. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicUCAS Application Number (UCASAPPID)

Return: Student Record

Entity: Entry Profile

Page Used:

Page

Page Element

Application Data (Student Admissions, Application Maintenance, Maintain Applications, Application Data)

External Application Nbr

Entry Profile Data

UCASAPPID

Field Derivation Rule: Include for all Entry Profile entities.

Derivation Steps:

  1. Derive from the Entry Profile Data page.

  2. Use the Student Program record of the instance to find the admission application number (ADM_APPL_NBR). Use this admission application number to find the Admissions Data record (PS_ADM_APPL_DATA). Then, from the Application Data page for this record, find the External Application Number. The External Application Number is used to record the UCAS Application Number or Application Code plus Choice Number for UCAS applications.

    If the External Application Number is not null and is a UCAS number — that is, the number is a 4-character application code that begins UC, plus - , plus single-digit choice number (for example, UC01-1), then the system derives the UCAS number value minus the - and choice elements (for example, UC01). Only values beginning UC are derived. If any other value is found, the derivation step is skipped.

  3. Use default.

  4. Derive as NULL.

Click to jump to top of pageClick to jump to parent topicWelsh Baccalaureate Advanced Diploma (WELBACC)

Return: Student Record

Entity: Entry Profile

Page Used:

Page

Page Element

Entry Profile Data

WELBACC

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Derive from the Entry Profile Data page.

  2. Use default.

  3. If Country is Wales in the HESA Returns page, derive as NULL ERROR.

  4. If Country is not Wales in the HESA Returns page, derive as NULL.

Click to jump to top of pageClick to jump to parent topicYear Left Last Institution (YRLLINST)

Return: Student Record

Entity: Entry Profile

Page Used:

Page

Page Element

Entry Profile Data

YRLLINST

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Derive from the Entry Profile Data page.

  2. Use default.

  3. Derive as NULL ERROR.

Click to jump to parent topicStudent Record Return: Qualifications On Entry Entity

The Create Extract process creates Qualifications On Entry entities for each Entry Profile entity in the return. The process creates the Qualifications On Entry entities only if the Include Student Entities check box is selected on the Create Extract Data page. To create the Qualifications On Entry entities, the process selects entry qualifications that have the Report To HESA check box selected and the QUALTYPE code imported from HESA.

Click to jump to top of pageClick to jump to parent topicQualification Grade (QUALGRADE)

Return: Student Record

Entity: Qualifications On Entry

Page Used:

Page

Page Element

Entry Profile Data

Grade

Field Derivation Rule: Include for all Qualifications On Entry entities.

Derivation Steps:

The system performs the following steps to derive the values:

  1. Derive from the Entry Profile Data page.

  2. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicQualification Subject (QUALSBJ)

Return: Student Record

Entity: Qualifications On Entry

Page Used:

Page

Page Element

Entry Profile Data

Subject

Field Derivation Rule: Include for all Qualifications On Entry entities.

Derivation Steps:

  1. Derive from the Entry Profile Data page.

  2. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicQualification Sitting (QUALSIT)

Return: Student Record

Entity: Qualifications On Entry

Page Used:

Page

Page Element

Entry Profile Data

Sitting

Field Derivation Rule: Include for all Qualifications On Entry entities.

Derivation Steps:

  1. Derive from the Entry Profile Data page.

  2. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicQualification Type (QUALTYPE)

Return: Student Record

Entity: Qualifications On Entry

Page Used:

Page

Page Element

Entry Profile Data

Type

Field Derivation Rule: Include for all Qualifications On Entry entities.

Derivation Steps:

  1. Derive from the Entry Profile Data page.

  2. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicQualification Year (QUALYEAR)

Return: Student Record

Entity: Qualifications On Entry

Page Used:

Page

Page Element

Entry Profile Data

Year

Field Derivation Rule: Include for all Qualifications On Entry entities.

Derivation Steps:

  1. Derive from the Entry Profile Data page.

  2. Derive as NULL ERROR.

Click to jump to parent topicStudent Record Return: Qualifications Awarded Entity

The Create Extract process creates Qualifications Awarded entities for each Instance entity where the student has completed the course and the academic institution has awarded a qualification to the student. The process uses the HESA Instance Data record for field derivation. If a field value does not exist in the HESA Instance Data record, the process uses the student degree records for derivation.

The process creates the Qualifications Awarded entities only if the Include Student Entities check box is selected on the Create Extract Data page.

The process selects Qualifications Awarded records for Instance records that have Instance.ENDDATE = not null, Instance.RSNEND = 01 (successful completion of course), and Instance.REDUCEDI = 00, 01 or 04 (not Reduced FE or Incoming Visiting/Exchange).

Click to jump to top of pageClick to jump to parent topicClassification (CLASS)

Return: Student Record

Entity: Qualifications Awarded

Pages Used:

Page

Page Element

HESA Instance Data

Classification (Qualifications Awarded group box)

Degree Honors (Records and Enrollment, Graduation, Student Degrees, Degree Honors)

Honors Code

Classification (Records and Enrollment, HESA Reporting, Codes and Mappings, Code Mappings, Classification)

Honors Code

Field Derivation Rule: Derive a value if one of the following conditions is met:

Derivation Steps:

  1. If the entity is derived from the HESA Instance Data - Qualifications Awarded record, derive as the Classification value.

  2. If the entity is derived from Student Degrees record, use the mapping on the Classification page to derive as the HESA Honors Code. On the Classification page the HESA Honors Code must be mapped to a HESA classification and a Honors Type where the Honors Type must be Degree Honors.

  3. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicOutcome of ITT Instance (OUTCOME)

Return: Student Record

Entity: Qualifications Awarded

Pages Used:

Page

Page Element

HESA Instance Data

Outcome of ITT Instance (Qualifications Awarded group box)

HESA Instance Data

OUTCOME (Instance HESA Data group box)

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. If the entity is derived from the HESA Instance Data - Qualifications Awarded record, derive as the Outcome of ITT Instance value.

  2. If the entity is derived from Student Degrees record, derive as the OUTCOME value.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicQualification Awarded (QUAL)

Return: Student Record

Entity: Qualifications Awarded

Pages Used:

Page

Page Element

HESA Instance Data

Qualification Awarded (Qualifications Awarded group box)

Degree (Records and Enrollment, Graduation, Student Degrees, Degree)

Degree

Qualification (Records and Enrollment, HESA Reporting, Codes and Mappings, Code Mappings, Qualification)

Degree

Field Derivation Rule: Include for all Qualifications Awarded entities.

Derivation Steps:

  1. If the entity is derived from the HESA Instance Data - Qualifications Awarded record, derive as the Qualification Awarded value.

  2. If the entity is derived from Student Degrees record, use the mapping on the Qualification page to derive as the mapped HESA Degree code.

  3. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicTeaching Qualifications Gained Sector (TQGSEC)

Return: Student Record

Entity: Qualifications Awarded

Pages Used:

Page

Page Element

HESA Instance Data

Sector (Qualifications Awarded group box)

HESA Instance Data

TQGSEC (Instance HESA Data group box)

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. If the entity is derived from the HESA Instance Data - Qualifications Awarded record, derive as the Sector value.

  2. If the entity is derived from Student Degrees record, derive as the TQGSEC value. If two awards are reported, use this value for both entities.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicTeacher Qualification Gained Subject (TQGSUB)

Return: Student Record

Entity: Qualifications Awarded

Pages Used:

Page

Page Element

HESA Instance Data (Qualifications Awarded group box)

Subject 1, Subject 2, Subject 3

HESA Instance Data (Instance HESA Data group box)

TQGSUB, TQGSUB2, TQGSUB3

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. If the entity is derived from the HESA Instance Data - Qualifications Awarded record, derive as the Subject 1, Subject 2, and Subject 3 values.

  2. If the entity is derived from Student Degrees record, derive as the TQGSUB, TQGSUB2, and TQGSUB3 values. Use these values for both entities if two awards are reported.

  3. Derive single TQGSUB field as NULL ERROR.

Note. The system can derive up to three values. Each of the values is included as a separate TQGSUB field in the XML file.

Click to jump to parent topicStudent Record Return: RAE Data Entity

The Create Extract process creates RAE Data entities for each Instance entity where the student is studying a research program and the academic institution is creating a full return for the student. The process :

For selecting a value from the Advisor HESA Data record, the process selects each student advisor record where:

If multiple advisors are found, the process selects the advisor with the lowest Advisor Number. The process then selects the Advisor HESA data for the selected advisor to derive the RAE Data fields.

Click to jump to top of pageClick to jump to parent topicRAE Unit of Assessment (OUA2008)

Return: Student Record

Entity: RAE Data

Pages Used:

Page

Page Element

HESA Instance Data

RAE Unit of Assessment

Advisor HESA Data (Curriculum Management, Instructor/Advisor Information, Instructor/Advisor Table, Advisor HESA Data)

RAE Unit of Assessment

Student Advisor (Records and Enrollment, Student Background Information, Student Advisor)

Academic Advisor

Field Derivation Rule: Include for all RAE Data entities.

Derivation Steps:

  1. If the entity is derived from Instance HESA Data - Research Data record, derive from the HESA Instance Data page.

  2. If the entity is derived from Advisor HESA Data record, derive from the Advisor HESA Data page.

Click to jump to top of pageClick to jump to parent topicUnit of Assessment Percentage (UOAPCNT)

Return: Student Record

Entity: RAE Data

Pages Used:

Page

Page Element

HESA Instance Data

Unit Of Assessment Percentage

Advisor HESA Data (Curriculum Management, Instructor/Advisor Information, Instructor/Advisor Table, Advisor HESA Data)

Unit Of Assessment Percentage

Student Advisor (Records and Enrollment, Student Background Information, Student Advisor)

Academic Advisor

Field Derivation Rule: Include for all RAE Data entities.

Derivation Steps:

  1. If the entity is derived from Instance HESA Data - Research Data record, derive from the HESA Instance Data page.

  2. If the entity is derived from Advisor HESA Data record, derive from the Advisor HESA Data page.

Click to jump to parent topicStudent Record Return: Student On Module Entity

The Create Extract process can create a maximum of 128 Student On Module records for each Instance in the return to indicate which modules (Campus Solutions courses) the student has been studying during the reporting period. The process selects Student On Module records based on the student's course enrollments and the course offering records included in the related Module entities of the return.

The process creates the Student On Module entities only if the Include Student Entities check box is selected on the Create Extract Data page.

HESA requires Student On Module records only if Instance.STULOAD is greater than zero. However, academic institutions can optionally include Student On Module records in the return when STULOAD = 0.

To choose student enrollment records for the Student on Module entity creation, the process:

When the process considers class start and end dates for class enrollments where the Session = OEE (open entry/exit), rather than selecting the class start/end dates, the process selects the values from the Student OEE Enrollment Data record for the class enrollment. If the end date is not defined in Student OEE Enrollment Data then the process uses the class end date. The start date is mandatory for a Student OEE Enrollment Data record. Note that the process does not consider linked careers for Student On Module.

For students with a STULOAD value of greater than zero, if there are no relevant class enrolments, the process creates a single Student On Module entity for the student. The process creates the single Student On Module entity only if the combination of Plan and Year has been defined as a dummy module and included in the Module entity.

Click to jump to top of pageClick to jump to parent topicPercentage of Module Taught in Celtic Language (LANGPCNT)

Return: Student Record

Entity: StudentOnModule

Page Used:

Page

Page Element

HESA Module Data

LANGPCNT

Field Derivation Rule: If Country = Northern Ireland, Scotland, or Wales, derive a value. Otherwise, derive as NULL.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Module Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicModule Identifier (MODID)

Return: Student Record

Entity: Student On Module

Pages Used: None

Field Derivation Rule: Include for all Student On Module entities.

Derivation Step:

1. For each student enrollment record valid for the reporting period, the process determines MODID as a combination of Course ID plus Course Offering Number from the related Course Offering record.

Click to jump to top of pageClick to jump to parent topicModule Countable (MODCOUNT)

Return: Student Record

Entity: Student On Module

Pages Used:

Page

Page Element

Module HESA Data

MODCOUNT

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Derive from the Module HESA Data page.

  2. Use default.

  3. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicModule Outcome (MODOUT)

Return: Student Record

Entity: Student On Module

Pages Used:

Page

Page Element

Enrollment (Records and Enrollment, Enroll Students, Enrollment)

Grading Basis

Grade In/Official

Module Outcome (Records and Enrollment, HESA Reporting, Codes and Mappings, Code Mappings, Module Outcome)

HESA Module Outcome

Field Derivation Rule: Include for all Student On Module entities.

Derivation Steps:

  1. Derive as the mapped HESA Module Outcome for the grade selected in the enrollment record.

  2. Use default.

  3. Derive as NULL ERROR.

If HESA Module Data dummy module flag for MODID = Y, derive as 07.

Click to jump to top of pageClick to jump to parent topicModule Status (MODSTAT)

Return: Student Record

Entity: Student On Module

Pages Used: None

Field Derivation Rule: Include for all Student On Module entities.

Derivation Steps:

  1. Use constant.

  2. Derive as 1 if the class start date is before the reporting period, and the class end date is within the reporting period.

  3. Derive as 2 if the class start and end dates are within the reporting period.

  4. Derive as 3 if the class start date is within the reporting period, and the class end date is after the reporting period.

  5. Derive as 4 if the class end date is before the reporting period and MODOUT is not 6.

  6. Derive as 6 if the class start date is before the reporting period and the class end date is after the reporting period.

  7. Use default.

  8. Derive as NULL ERROR.

Note that the derivation logic compares class start and end dates with the reporting period dates to determine the status.

If HESA Module Data dummy module flag for MODID = Y, derive as 05.

When considering class start and end dates for class enrollments where the Session = OEE, rather than selecting the class start and end dates, the derivation logic selects values from the Student OEE Enrollment Data record for the class enrollment. If the end date is not defined in Student OEE Enrollment Data record, then the logic uses the class end date. The start date is mandatory in the Student OEE Enrollment Data record.

Click to jump to top of pageClick to jump to parent topicModule Year (MODYR)

Return: Student Record

Entity: Student On Module

Page Used:

Page

Page Element

Module HESA Data

MODYR

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Derive from the Module HESA Data page.

  2. Use default.

  3. Derive as NULL ERROR.

For dummy modules:

  1. Derive from the HESA Dummy Module Data page.

  2. Use default.

  3. Derive as NULL ERROR.

Note: The field is only derived if INSTAPP = 1, therefore, usually this field will be null

Click to jump to parent topicAggregate Offshore Return: Institution Entity

The Create Extract process creates a single entity record for the institution with the RECID and UKRPN fields.

Click to jump to top of pageClick to jump to parent topicRecord Type Indicator (RECID)

Return: Aggregate Offshore

Entity: Institution

Pages Used:

Page

Page Element

Reporting Period

Record Year

Returns

Record ID

Field Derivation Rule: Include for all Institution entities.

Derivation Steps:

  1. Derive as YYNNN, where YY is the final two digits of the Record Year (for example, 09 for 2009) and NNN is the 3-digit Record ID for the seeded return.

  2. Derive as NULL ERROR.

For Aggregate Offshore Return, the Record ID must be 052. The Record ID is delivered with CS 9.0 bundle 12.

Click to jump to top of pageClick to jump to parent topicUK Provider Reference Number (UKPRN)

Return: Aggregate Offshore

Entity: Institution

Page Used:

Page

Page Element

HESA Configuration

UKPRN

Field Derivation Rule: Include for all Institution entities.

Derivation Steps:

  1. Derive from the HESA Returns page.

  2. Derive as NULL ERROR.

Click to jump to parent topicAggregate Offshore Return: Provision Entity

The Create Extract process creates Provision entities for Offshore plans and Offshore subplans. That is, the process selects only those subplans for which the Offshore Sub-Plan check box is selected on the Sub-Plan HESA page. If you have selected the Enable Sub-Plan Reporting check box on the HESA Returns page, the process selects only those subplans for which you have selected the Report to HESA and Offshore Sub-Plan check boxes on the Sub-Plan HESA Data page. Also, the process selects only those plans for which the Offshore Plan check box is selected on the Plan HESA Data page. If you have not selected the Enable Sub-Plan Reporting check box, the process selects only those plans for which you have selected the Report to HESA and Offshore Plan check boxes on the Plan HESA Data page.

Click to jump to top of pageClick to jump to parent topicCountry of Activity (COUNTRY)

Return: Aggregate Offshore

Entity: Provision

Pages Used:

Page

Page Element

Plan HESA Data

COUNTRY

Sub-Plan HESA

COUNTRY

Field Derivation Rule: Include for all Provision entities.

Derivation Steps:

  1. Use constant.

  2. If Provision entity is based on a subplan, derive from the Sub-Plan HESA page.

  3. Derive from the Plan HESA Data page.

  4. Use default.

  5. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicInstitutions Own Campus Identifier (INSTCAMP)

Return: Aggregate Offshore

Entity: Provision

Pages Used:

Page

Page Element

Campus (Records and Enrollment, HESA Reporting, Codes and Mappings, Code Mappings, Campus)

HESA Institutions Own Campus

Taxonomy/Campus (Set Up SACR, Foundation Tables, Academic Structure, Academic Program Table, Taxonomy/Campus)

Campus

Field Derivation Rule: Include for all Provision entities.

Derivation Steps:

  1. Use constant.

  2. If Provision entity is based on a subplan, select the associated program's campus from the Taxonomy/Campus page. Use the HESA Institutions Own Campus value mapped to the selected campus.

  3. If Provision entity is based on a plan, select the associated program's campus from the Taxonomy/Campus page. Use the HESA Institutions Own Campus value mapped to the selected campus.

  4. Use default.

  5. Derive as NULL.

Click to jump to top of pageClick to jump to parent topicLevel of Provision (LEVEL)

Return: Aggregate Offshore

Entity: Provision

Pages Used:

Page

Page Element

Plan HESA Data

LEVEL

Sub-Plan HESA

LEVEL

Field Derivation Rule: Include for all Provision entities.

Derivation Steps:

  1. Use constant.

  2. If Provision entity is based on a subplan, derive from the Sub-Plan HESA page.

  3. Derive from the Plan HESA Data page.

  4. Use default.

  5. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicNumber of Students (HEADCOUNT)

Return: Aggregate Offshore

Entity: Provision

Field Derivation Rule: Include for all Provision entities.

Derivation Steps:

  1. Derive this value by performing a similar selection as for the existing Instance return but restricting the selection to the plan and subplan of each Provision entity. The return will contain just the count. However, in the log file list each student included in the count including their EMPLID, and plan or subplan.

  2. If students are not found, derive as 0.

In the first step, the process includes students who have a plan or subplan that overlap the reporting period and have been enrolled; that is, the student either has a status of Enrolled or has an associated enrolled classes that the student enrolled on or before reporting period end date

Note. If the process does not return a HEADCOUNT value for the plan or subplan, include the student in the extract but do not include the student in the XML file.

Click to jump to top of pageClick to jump to parent topicType of Activity (TYPE)

Return: Aggregate Offshore

Entity: Provision

Pages Used:

Page

Page Element

Plan HESA Data

TYPE

Sub-Plan HESA

TYPE

Field Derivation Rule: Include for all Provision entities.

Derivation Steps:

  1. Use constant.

  2. If Provision entity is based on a subplan, derive from the Sub-Plan HESA page.

  3. Derive from the Plan HESA Data page.

  4. Use default.

  5. Derive as NULL ERROR.

Click to jump to parent topicITT Return: Institution Entity

The Create Extract process creates a single entity record for the institution with the RECID and UKRPN fields.

Click to jump to top of pageClick to jump to parent topicRecord Type Indicator (RECID)

Return: ITT

Entity: Institution

Pages Used:

Page

Page Element

Reporting Period

Record Year

Returns

Record ID

Field Derivation Rule: Include for all Institution entities.

Derivation Steps:

  1. Derive as YYNNN, where YY is the final two digits of the Record Year (for example, 09 for 2009) and NNN is the 3-digit Record ID for the seeded return.

  2. Derive as NULL ERROR.

For ITT Return, the Record ID is 053. The Record ID is delivered with CS 9.0 Bundle 13.

Click to jump to top of pageClick to jump to parent topicUK Provider Reference Number (UKPRN)

Return: ITT

Entity: Institution

Page Used:

Page

Page Element

HESA Configuration

UKPRN

Field Derivation Rule: Include for all Institution entities.

Derivation Steps:

  1. Derive from the HESA Returns page.

  2. Derive as NULL ERROR.

Click to jump to parent topicITT Return: Student Entity

The Create Extract process creates ITT Student entities only if all the following conditions are satisfied:

If all the conditions are satisfied, then the process create a record in the ITT Student Extract table with status set to ACTIVE using the following values:

If you provided an EMPLID for the Student ID run parameter, the process creates ITT Student entity records for only the selected EMPLID.

The Create Extract process selects External Degree records to derive the degree fields (such as DEGENDDT and DEGEST). If the student has multiple records, the process selects the most recent record.

If you have selected the Null Errors Only check box for the Include Student Entities on the Create Extract Data page, the process selects distinct EMPLIDs from the existing active ITT extract data, where at least one field in the Student or Course Subject extract data has a derived value of NULL ERROR. The process then selects Student entity records for these EMPLIDs.

If you have selected the Validation Errors Only check box for the Include Student Entities, the process first deletes any Validation Error staging records where EMPLID is blank. Then, it selects distinct EMPLIDs from the Validation Error staging table. The process selects Student entity records for these EMPLIDs. Finally, it deletes records from the Validation Error staging table where EMPLID is populated.

Click to jump to top of pageClick to jump to parent topicDate of Birth (BIRTHDTE)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

Biographical Details (Campus Community , Personal Information (Student), Add/Update a Person, Biographical Details)

Date of Birth

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Derive from the Biographical Details page in the format YYYY-MM-DD.

  2. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicCourse Identifier (COURSEID)

Return: ITT

Entity: Student

Pages Used: None

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. If subplan is being reported to HESA, derive as COURSEID from the Academic Sub-Plan Table record.

  2. If plan is being reported to HESA, derive as COURSEID from the Academic Plan Table record.

Click to jump to top of pageClick to jump to parent topicCourse Title (CTITLE)

Return: ITT

Entity: Student

Pages Used:

Page

Page Element

Plan HESA Data

Course Title

Sub-Plan HESA

HESA Course Title

Academic Plan Table (Set Up SACR, Foundation Tables, Academic Structure, Academic Plan Table )

Academic Plan

Academic Sub-Plan Table (Set Up SACR, Foundation Tables, Academic Structure, Academic SubPlan Table)

Academic Subplan

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Derive as the HESA Course Title value from the Sub-Plan HESA page.

  2. If the Course Title field does not have a value, use a combination of the plan and subplan descriptions from the Academic Plan Table and Academic Sub-Plan Table pages (that is, .DESCR from PS_ACAD_PLAN_TBL + space + DESCR from PS_ACAD_SUBPLN_TBL).

  3. Derive as the Course Title value from the Plan HESA Data page.

  4. If the Course Title field does not have a value, use the plan description from the Academic Plan Table page (that is, DESCR from PS_ACAD_PLAN_TBL).

Click to jump to top of pageClick to jump to parent topicStart Date of Instance (COMDATE)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

HESA Instance Data

Start Date of Instance

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Derive from the HESA Instance Data page.

  2. 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.

    1. Select all activated terms for the student career of the Instance.

    2. 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 is null 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 NULL or matches one of the program values in the Student Program records for that career and career number.

    3. 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.

    4. Derive the earliest Class Start Date from all the selected classes as COMDATE.

  3. Derive as the earliest Effective Date of the HESA Instance Data records.

Click to jump to top of pageClick to jump to parent topicCourse Mode (CRMODE)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

HESA Instance Data

CRMODE

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Derive from the HESA Instance Data page.

  2. Convert the MODE value to a CRMODE value as follows: if MODE = 01, 02, 12, 13, 14, 23, 24, 25, 63 or 73, derive as 1 (full-time) else derive as 2 (part-time).

  3. Derive as NULL.

Click to jump to top of pageClick to jump to parent topicPrevious Degree Country (DEGCTRY)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

External Organization Location (Campus Community, Organization, Create/Maintain Organizations, Organization Locations, Location Details, Location History)

Country

Nationality (Records and Enrollment, HESA Reporting, Codes and Mappings, Code Mappings, Nationality)

HESA Nationality

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL ERROR if the conditions are not met.

Derivation Steps:

  1. Derive from the External Organization Location page.

    Select the most recent External Education Organization record with a Degree status of complete associated with the current reporting period. Select the most recent effective dated location record, if there are multiple records.

    It is possible for the Ext Org to have multiple Location records with the same effective date. In this case, select the record with the lowest Location ID to determine the country.

    Use the mapping on the Nationality page to derive as the mapped HESA Nationality code. Otherwise, derive as the COUNTRY_2CHAR value if the mapping does not exist.

  2. Use default.

  3. Derive as NULL ERROR.

The normal 2-character GB code is not valid for DEGCTRY. Therefore, if the value GB is derived, the system changes GB to the valid code XK (United Kingdom, not otherwise specified).

Click to jump to top of pageClick to jump to parent topicPrevious Degree End Date (DEGENDDT)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

Courses and Degrees (Student Admissions, Application/Transcript Loads, Education, Courses and Degrees)

Degree Date

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL ERROR if the conditions are not met.

Derivation Steps:

  1. Select the most recent External Education Degree record with a Degree status of complete associated with the current reporting period. Derive from the Courses and Degrees page for the selected record.

  2. Use default.

  3. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicPrevious Degree Establishment (DEGEST)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

Region (Campus Community, Organization, Create/Maintain Organizations, Organization Table, Region)

HESA Degree Establishment

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL if the conditions are not met.

Derivation Steps:

  1. Select the most recent External Education Organization record associated with the current reporting period. Derive from the Region page for the selected record. Convert using 2-character code (COUNTRY_2CHAR) from the Country table (PS_COUNTRY_TBL).

  2. Use default.

  3. Derive as NULL.

Click to jump to top of pageClick to jump to parent topicPrevious Degree Length in Years (DEGLENGTH)

Return: ITT

Entity: Student

Page Used: None

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL ERROR if the conditions are not met.

Derivation Steps:

  1. Select the most recent External Education Degree record with a Degree status of complete associated with the current reporting period. Derive as Degree Date minus From Date from the External Education record. Convert number of days to years and round off to the nearest year.

  2. Use default.

  3. Derive as NULL ERROR.

The previous degree length is derived as the nearest number in whole years.

Click to jump to top of pageClick to jump to parent topicPrevious Degree Start Date (DEGSTDT)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

External Education (Student Admissions, Application/Transcript Loads, Education, External Education)

From Date

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL ERROR if the conditions are not met.

Derivation Steps:

  1. Select the most recent External Education Degree record with a Degree status of complete associated with the current reporting period. Derive from the External Education page for the selected record.

  2. Use default.

  3. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicPrevious Degree Type (DEGTYPE)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

Degree Table (Setup SACR, Foundation Tables, Academic Structure, Degree Table)

HESA Degree Type

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL ERROR if the conditions are not met.

Derivation Steps:

  1. Select the most recent External Education Degree record with a Degree status of complete associated with the current reporting period. Derive from the Degree Table page for the selected degree.

  2. Use default.

  3. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicDisability (DISABLE)

Return: ITT

Entity: Student

Pages Used:

Page

Page Element

Person HESA Data

DISABLE

Impairment AUS (Campus Community, Personal Information, Health Information, Impairment AUS )

Type of Impairment

Disability (Records and Enrollment, HESA Reporting, Codes and Mappings, Code Mappings, Disability)

HESA Disability Code

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Derive from the Person HESA Data page.

  2. If the student has multiple impairment records in the Impairment AUS page, derive as 08 (multiple disabilities). If the student has a single impairment record, use the HESA Disability code from the mapping between the impairment type and the HESA disability code.

  3. Use default.

  4. Derive as NULL ERROR.

You can define a default as either 00 (no known disability) or 99 (not known).

Click to jump to top of pageClick to jump to parent topicDisabled Student Allowance (DISALL)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

HESA Instance Data

DISALL

Impairment AUS (Campus Community, Personal Information, Health Information, Impairment AUS)

Support Services Request

Disability (Records and Enrollment, HESA Reporting, Codes and Mappings, Code Mappings, Disability)

HESA Disability Allowance

Field Derivation Rule: If related Student.DISABLE is between 02 and 96, derive a value. Otherwise, derive as NULL.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. 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.

  4. Use default.

  5. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicEnd Date of Instance (ENDDATE)

Return: ITT

Entity: Student

Pages Used:

Page

Page Element

Student Program

Program Action

Action Reason

Effective Date

HESA Action Reasons

Reason for Ending Instance Mapping

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. 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 effective date of the record formatted to YYYY-MM-DD.

  2. Derive as NULL with ReasonForNull attribute = 9.

Click to jump to top of pageClick to jump to parent topicEthnicity (ETHNIC)

Return: ITT

Entity: Student

Pages Used:

Page

Page Element

Person HESA Data

ETHNIC

Ethnicity (Campus Community , Personal Information (Student), Biographical (Student), Personal Attributes, Ethnicity)

Regulatory Region, Ethnic Group

Ethnicity (Records and Enrollment, HESA Reporting, Codes and Mappings, Code Mappings, Ethnicity)

HESA Ethnic Code

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Derive from the Person HESA Data page.

  2. Select Person Ethnicity records as follows:

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicForenames (FNAMES)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

Names (Campus Community, Personal Information (Student), Add/Update a Person, Biographical Details, Names)

First Name

Middle Name

Note. The First Name page element can accept a maximum of 30 characters.

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Use the First Name and Middle Name values from the Primary Name record.

  2. Derive as NULL with ReasonForNull = 9.

Click to jump to top of pageClick to jump to parent topicFundability Code (FUNDCODE)

Return: ITT

Entity: Student

Pages Used:

Page

Page Element

Program HESA Data

FUNDCODE

Plan HESA Data

FUNDCODE

Sub-Plan HESA

FUNDCODE

HESA Instance Data

FUNDCODE

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. If Student.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  4. Derive from the Plan HESA Data page.

  5. Derive from the Program HESA Data page.

  6. Use default.

  7. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicGender (GENDER)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

Biographical Details (Campus Community , Personal Information (Student), Add/Update a Person, Biographical Details)

Gender

Field Derivation Rule: Include for all Student entities.

Derivation Step:

1. Use the Gender value from the Biographical History record.

If the gender value is Male, derive as 1.

If the gender value is Female, derive as 2.

If the gender value is unknown, derive as 9.

Click to jump to top of pageClick to jump to parent topicHESA Unique Student Identifier (HUSID)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

External System ID

External System ID

Field Derivation Rule: Include for all Student entities.

Derivation Step:

  1. Select External System ID records for the person with the External ID Type defined for HUSID in the HESA Types page.

  2. If HUSID is not found, calculate using the following method:

  3. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicPositive Indication that self-certification complete (INDSLFCRT)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

Entry Profile Data

INDSLFCRT

Field Derivation Rule: If Student.COMDATE is in the current reporting period, derive a value. Otherwise, derive as NULL ERROR.

Derivation Step:

  1. Derive from the Entry Profile Data page.

  2. Use default.

  3. Derive as NULL ERROR.

As return is defined, the system does not derive Null. The system always returns a value, because the inclusion condition is always met and while selecting students for the extract, the system considers only those students for whom COMDATE is between reporting period start and end dates.

Click to jump to top of pageClick to jump to parent topicIndependent Safeguarding Authority Registration Number (ISANUM)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

External System ID

External System ID

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Determine from the External System ID records for the person with the External ID Type defined for ISANUM in the HESA Types page.

  2. Derive as NULL.

Click to jump to top of pageClick to jump to parent topicITT Qualification Aim (ITTAIM)

Return: ITT

Entity: Student

Pages Used:

Page

Page Element

Program HESA Data

ITTAIM

Plan HESA Data

ITTAIM

Sub-Plan HESA

ITTAIM

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Use constant.

  2. If subplan is being reported, derive from the Sub-Plan HESA page.

  3. Derive from the Plan HESA Data page.

  4. Derive from the Program HESA Data page.

  5. Use default.

  6. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicStart Date of ITT Course (ITTCOMDATE)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

HESA Instance Data

ITTCOMDATE

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Derive from the HESA Instance Data page.

  2. Derive as the same value as Student.COMDATE.

Click to jump to top of pageClick to jump to parent topicITT Phase/Scope (ITTPHSC)

Return: ITT

Entity: Student

Pages Used:

Page

Page Element

Program HESA Data

ITTPhase/Scope

Plan HESA Data

ITTPhase/Scope

Sub-Plan HESA

ITTPhase/Scope

HESA Instance Data

ITTPhase/Scope

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. Derive from the Sub-Plan HESA page.

  4. Derive from the Plan HESA Data page.

  5. Derive from the Program HESA Data page.

  6. Use default.

  7. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicITT Schemes (ITTSCHMS)

Return: ITT

Entity: Student

Pages Used:

Page

Page Element

Program HESA Data

ITTSCHMS

Plan HESA Data

ITTSCHMS

Sub-Plan HESA

ITTSCHMS

HESA Instance Data

ITTSCHMS

Field Derivation Rule: If related Student.TTCID = 1 or 2, derive a value. Otherwise, derive as NULL ERROR.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. Derive from the Sub-Plan HESA page.

  4. Derive from the Plan HESA Data page.

  5. Derive from the Program HESA Data page.

  6. Use default.

  7. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicMode of Study (MODE)

Return: ITT

Entity: Student

Pages Used:

Page

Page Element

Program Offering/Year HESA

MODE (Program Year HESA Data group box)

Plan Offering/Year HESA

MODE (Plan Year HESA Data group box)

Sub-Plan Offering/Year HESA

MODE (Sub-Plan Year Data group box)

Student Program

Program Action

Action Reason

Student Program

Acad Load

HESA Instance Data

MODE

Mode of Study (Records and Enrollment, HESA Reporting, Codes and Mappings, Code Mappings, Mode of Study)

HESA Mode of Study

HESA Action Reasons

Change of Mode Mapping

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Derive from the HESA Instance Data page.

  2. 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, convert 73 to 63 and 74 to 64.

    If the derived value is 02, 12, 13, 14, 23, 24 or 25 (that is, a sandwich placement year), 43, 65, 66, 67, 68, 69, then convert as 01. If the derived value is 31, 32, 33, 34, 35, 36, 37, 38, 39, 44, then convert as 31.

  3. Select the academic load from the Student Program record. Derive the mapped HESA code for the selected academic load from the Mode of Study page.

    If the derived value is 73 or 74, convert 73 to 63 and 74 to 64.

    If the derived value is 02, 12, 13, 14, 23, 24 or 25 (that is, a sandwich placement year), 43, 65, 66, 67, 68, 69, then convert as 01. If the derived value is 31, 32, 33, 34, 35, 36, 37, 38, 39, 44, then convert as 31.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicNational Insurance Number (NIN)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

External System ID

External System ID

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Determine from the External System ID records for the person with the External ID Type defined for NIN in the HESA Types page.

  2. Derive as NULL.

Click to jump to top of pageClick to jump to parent topicStudent Instance Identifier (NUMHUS)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

HESA Instance Data

Instance Identifier

Linked Career

Linked Career Number

Academic Career

Student Career Nbr

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Derive from HESA Instance Data page as Instance Identifier.

  2. Derive from HESA Instance Data page as Linked Career + Linked Career Number.

  3. Derive from HESA Instance Data page as Academic Career + Student Career Nbr, for example, UGRD1.

Click to jump to top of pageClick to jump to parent topicInstitution's Own Identifier for Student (OWNSTU)

Return: ITT

Entity: Student

Pages Used: None

Field Derivation Rule: Include for all Student entities.

Derivation Step:

1. Derive as EMPLID.

Click to jump to top of pageClick to jump to parent topicPGCE Class of Undergraduate Degree (PGCECLSS)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

Entry Profile Data

PGCECLSS

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL ERROR if the conditions are not met.

Derivation Steps:

  1. Use constant.

  2. Derive from the Entry Profile Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicPGCE Subject of Undergraduate Degree (PGCESBJ)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

Entry Profile Data

PGCESBJ

PGCESBJ2

PGCESBJ3

Field Derivation Rule: Derive a value if the following conditions are met:

Derive as NULL ERROR if the conditions are not met.

Derivation Steps:

  1. Use constant to create a single PGCESBJ field.

  2. Derive from the Entry Profile Data page.

  3. Use default to create a single PGCESBJ field.

  4. Derive a single PGCESBJ field as NULL ERROR .

Note. The system can derive up to three values. Each of the values is included as a separate PGCESBJ field in the XML file.

Click to jump to top of pageClick to jump to parent topicImmediately Prior Surname (PSURNAME)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

Names (Campus Community, Personal Information (Student), Add/Update a Person, Biographical Details, Names)

Surname

Field Derivation Rule: If the student has at least one Instance with REDUCEDI = 00, 01, or 04 derive a value. Otherwise, derive as NULL.

Derivation Steps:

  1. Derive the previous Last Name from the Primary Name Type History table. This is done by finding the most recent end dated record in which last name is different from the current one.

  2. Derive as NULL.

Click to jump to top of pageClick to jump to parent topicReason for Ending Instance (RSNEND)

Return: ITT

Entity: Student

Pages Used:

Page

Page Element

Student Program

Program Action

Action Reason

HESA Action Reasons

Reason for Ending Instance Mapping

Field Derivation Rule: If Student.ENDDATE is completed, derive a value. Otherwise, derive as NULL ERROR.

Derivation Steps:

  1. 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.

  2. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicSkills Test Number (SKILLTEST)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

External System ID

External System ID

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Determine from the External System ID records for the person with the External ID Type defined for SKILLTEST in the HESA Types page.

  2. Derive as NULL.

Click to jump to top of pageClick to jump to parent topicFamily Name on 16th Birthday (SNAME16)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

Names (Campus Community, Personal Information (Student), Add/Update a Person, Biographical Details, Names)

Last Name

Note. The Last Name page element can accept a maximum of thirty characters.

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Use the Last Name value from the Primary Name record. The last name must have a Type of Name value that corresponds with the Name Type set for SNAME16 on the HESA Types page.

  2. Derive as NULL.

Click to jump to top of pageClick to jump to parent topicExpected Length of Study (SPLENGTH)

Return: ITT

Entity: Student

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 Data

SPLENGTH

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. If Student.COURSEID is based on a subplan, derive from the Sub-Plan Offering/Year HESA page for the academic load of the student instance.

  4. If Student.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  5. Derive from the Plan Offering/Year HESA page for the academic load of the student instance.

  6. Derive from the Plan HESA Data page.

  7. Derive from the Program Offering/Year HESA page for the academic load of the student instance.

  8. Derive from the Program HESA Data page.

  9. Use default.

  10. Derive as NULL with ReasonForNull = 9 .

Click to jump to top of pageClick to jump to parent topicFamily Name (SURNAME)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

Names (Campus Community, Personal Information (Student), Add/Update a Person, Biographical Details, Names)

Last Name

Note. The Last Name page element can accept a maximum of thirty characters.

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Use the Last Name value from the Primary Name record.

  2. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicTitle (TITLE)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

Names (Campus Community, Personal Information (Student), Add/Update a Person, Biographical Details, Names)

Name Title

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Use the Name Title value from the Primary Name record.

  2. Derive as NULL with ReasonForNull = 9.

Click to jump to top of pageClick to jump to parent topicTeacher Reference Number (TREFNO)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

External System ID

External System ID

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Select External System ID records for the person with the External ID Type defined for TREFNO in the HESA Types page.

  2. Use default.

  3. Derive as NULL.

Click to jump to top of pageClick to jump to parent topicTeacher Training Course (TTCID)

Return: ITT

Entity: Student

Pages Used:

Page

Page Element

Program HESA Data

TTCID

Plan HESA Data

TTCID

Sub-Plan HESA

TTCID

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Derive from the Sub-Plan HESA page.

  2. Derive from the Plan HESA Data page.

  3. Derive from the Program HESA Data page.

  4. Use default.

  5. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicUnique Learner Number (ULN)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

External System ID

External System ID

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Select External System ID records for the person with the External ID Type defined for ULN in the HESA Types page.

    Validate the derived value using the checksum method. For information on the checksum method, refer to the Notes section for the ULN field available on the HESA website.

  2. Derive as NULL.

Click to jump to top of pageClick to jump to parent topicUnits of Length (UNITLGTH)

Return: ITT

Entity: Student

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 Data

UNITLGTH

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance Data page.

  3. If Student.COURSEID is based on a subplan, derive from the Sub-Plan Offering/Year HESA page for the academic load of the student instance.

  4. If Student.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.

  5. Derive from the Plan Offering/Year HESA page for the academic load of the student instance.

  6. Derive from the Plan HESA Data page.

  7. Derive from the Program Offering/Year HESA page for the academic load of the student instance.

  8. Derive from the Program HESA Data page.

  9. Use default.

  10. Derive as NULL with ReasonForNull = 9.

Click to jump to top of pageClick to jump to parent topicYear of Program (YEARPRG)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

HESA Instance Data

Year of Program

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Derive from the HESA Instance Data page.

  2. Use default.

  3. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicYear of Student on This Instance (YEARSTU)

Return: ITT

Entity: Student

Page Used:

Page

Page Element

HESA Instance Data

Year of Student

Include for all Student entities.

Derivation Steps:

  1. Derive from the HESA Instance Data page.

  2. Use default.

  3. Derive as NULL ERROR.

Click to jump to parent topicITT Return: Course Subject Entity

The Create Extract process creates a maximum of three Course Subject entity records for each Student entity.

Click to jump to top of pageClick to jump to parent topicSubject of ITT Course (SBJCA)

Return: ITT

Entity: Course Subject

Pages Used:

Page

Page Element

Program HESA Data

HESA Subject

Plan HESA Data

HESA Subject

Sub-Plan HESA

HESA Subject

Field Derivation Rule: Include for all Course Subject entities.

Derivation Steps:

  1. Use constant.

  2. Derive from the Sub-Plan HESA page.

  3. Derive from the Plan HESA Data page.

  4. Derive from the Program HESA Data page.

  5. Use default.

  6. Derive as NULL ERROR.

For steps 2, 3, or 4, the process:

Click to jump to parent topicDLHE Return: Institution Entity

The Create Extract Application Engine (SSR_HE_DATA) process creates a single Institution entity. The Institution entity is composed of two fields.

Click to jump to top of pageClick to jump to parent topicRecord Type Indicator (RECID)

Return: DLHE

Entity: Institution

Pages Used:

Page

Page Element

Reporting Periods (Records and Enrollment, HESA Reporting, HESA Returns Setup, Reporting Periods)

Record Year

Returns (Records and Enrollment, HESA Reporting, HESA Returns Setup, Returns)

Record ID

Field Derivation Rule: Include for all Institution entities.

Derivation Steps:

1. Derive as YYNNN, where YY is the final 2-digits of the Record Year (for example, 11 for 2011) and NNN is the 3-digit Record ID for the seeded return.

Click to jump to top of pageClick to jump to parent topicUK Provider Reference Number (UKPRN)

Return: DLHE

Entity: Institution

Pages Used:

Page

Page Element

HESA Configuration

UKPRN

Field Derivation Rule: Include for all Institution entities.

Derivation Steps:

1. Derive from the HESA Configuration page.

Click to jump to parent topicDLHE Return: Student Entity

The Create Extract process creates a Student entity for each distinct DLHE survey record.

If at least one survey status has been defined on the HESA Returns page, then the process includes a survey only if the survey has a status value that matches one of the defined statuses. If you have not defined a survey status on the HESA Returns page, then the process includes the survey irrespective of status value. Use the Survey Management component to verify the status of a survey (Records and Enrollment, HESA Reporting, Destination of Leavers, Survey Management).

If you have selected the Null Errors Only check box for the Include Student Entities on the Create Extract Data page, the process selects distinct EMPLIDs from the existing active DLHE extract data, where at least one field in the Student, Employment, Study, or Teaching extract data has a derived value of NULL ERROR. The process then selects the survey records for these EMPLIDs. If a student has more than one survey record, then the process selects all the student's surveys if any of them has any NULL ERROR values.

If you have selected the Student Override check box, the process considers the survey records for only the EMPLIDs you have selected.

Click to jump to top of pageClick to jump to parent topicAll Activities – Q1 (ALLACT1)

Return: DLHE

Entity: Student

Page Used:

Page

Page Element

Enter DLHE Survey (Section A) self-service

Q1 – Activities check box 1

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. If the check box is selected, derive as 1.

  2. If none of the check boxes has been selected (that is, Student.ALLACT2 to Student.ALLACT8 are all derived as NULL) and Student.STATUS = 07 or 08, derive as X.

  3. If none of the check boxes has been selected (that is, Student.ALLACT2 to Student.ALLACT8 are all derived as NULL), derive as NULL ERROR.

  4. Derive as null.

Click to jump to top of pageClick to jump to parent topicAll Activities – Q1 (ALLACT2-8)

Return: DLHE

Entity: Student

Page Used:

Page

Page Element

Enter DLHE Survey (Section A) self-service

Q1 – Activities check boxes 2 to 8

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive as follows:

  2. Derive as null.

Click to jump to top of pageClick to jump to parent topicApril or January Survey (APRJAN)

Return: DLHE

Entity: Student

Page Used:

Page

Page Element

Survey Details

Survey

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

1. Derive from the survey record, either 1 or 2.

Click to jump to top of pageClick to jump to parent topicHigher Education experience for business – Q31 (HEBUSNEXP)

Return: DLHE

Entity: Student

Page Used:

Page

Page Element

Enter DLHE Survey (Section E) self-service

Q31

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from the survey record.

  2. If Student.STATUS = 03, 05, 06, 07 or 08, derive as 6 (unable to code).

  3. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicHigher Education experience for study – Q30 (HESTUDYEXP)

Return: DLHE

Entity: Student

Page Used:

Page

Page Element

Enter DLHE Survey (Section E) self-service

Q30

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from the survey record.

  2. If Student.STATUS = 03, 05, 06, 07 or 08, derive as 6 (unable to code).

  3. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicHigher Education experience for work – Q29 (HEWORKEXP)

Return: DLHE

Entity: Student

Page Used:

Page

Page Element

Enter DLHE Survey (Section E) self-service

Q29

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from the survey record.

  2. If Student.STATUS = 03, 05, 06, 07 or 08, derive as 6 (unable to code).

  3. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicHESA unique student identifier (HUSID)

Return: DLHE

Entity: Student

Page Used:

Page

Page Element

Survey Details

HUSID

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

1. Derive from the survey record.

Click to jump to top of pageClick to jump to parent topicMost important activity – Q1 (MIMPACT)

Return: DLHE

Entity: Student

Page Used:

Page

Page Element

Enter DLHE Survey (Section A) self-service

Q1 – Most important option

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. If a Most important option has been selected, derive the value from 1 to 8 (depending on which Most important option is selected).

  2. If Student.STATUS = 07 or 08, derive as X (ineligibility or explicit refusal).

  3. Derive as NULL ERROR.

Click to jump to top of pageClick to jump to parent topicStatus of data collection (STATUS)

Return: DLHE

Entity: Student

Page Used:

Page

Page Element

Survey Details

Survey Method

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from the survey record.

  2. Use default value (this is derived from the HESA Fields page not from the Survey Status value on the HESA Returns page).

  3. Derive as NULL ERROR.

Click to jump to parent topicDLHE Return: Employment Entity

A single Employment entity is included in each Student entity.

Click to jump to top of pageClick to jump to parent topicEmployment basis – Q5 (EMPBASIS)

Return: DLHE

Entity: Employment

Page Used:

Page

Page Element

Enter DLHE Survey (Section B) self-service

Q5

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from the survey record (01 to 10).

  2. If Student.STATUS = 03, 05 or 06 and either Student.ALLACT1 = 1 or Student.ALLACT2 = 2, derived as 99 (unknown).

  3. If Student.ALLACT1 = 1 or Student.ALLACT2 = 2, derive as NULL ERROR

  4. Derive as null.

Click to jump to top of pageClick to jump to parent topicCountry of employment – Q11 (EMPCOUNTRY)

Return: DLHE

Entity: Employment

Page Used:

Page

Page Element

Enter DLHE Survey (Section B) self-service

Q11 – Employment Country *

* Not available in student self-service. The system displays this field only when you access the self-service page by clicking the Enter Survey button on the Survey Management page.

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from the survey record.

  2. If Employment.EMPPCODE is null and either Student.ALLACT1 = 1 or Student.ALLACT2 = 2, derive as NULL ERROR

  3. Derive as null.

Click to jump to top of pageClick to jump to parent topicImportance to employer – Q13 (EMPIMP)

Return: DLHE

Entity: Employment

Page Used:

Page

Page Element

Enter DLHE Survey (Section B) self-service

Q13

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from the survey record (1, 2, 4, 5 or 8).

  2. If Employment.QUALREQ = 11 or 12 and either Student.ALLACT1 = 1 or Student.ALLACT2 = 2, derive as NULL ERROR

  3. Derive as null.

Click to jump to top of pageClick to jump to parent topicEmployer name – Q9 (EMPNAME)

Return: DLHE

Entity: Employment

Page Used:

Page

Page Element

Enter DLHE Survey (Section B) self-service

Q9

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from the survey record.

  2. If Student.ALLACT1 = 1 or Student.ALLACT2 = 2, derive as NULL ERROR.

  3. Derive as null.

Click to jump to top of pageClick to jump to parent topicUK Postcode for place of employment – Q11 (EMPPCODE)

Return: DLHE

Entity: Employment

Page Used:

Page

Page Element

Enter DLHE Survey (Section B) self-service

Q11 – Postcode (UK only)

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from the survey record.

  2. Derive as null.

Note. The system derives the Employment.EMPPCODE field prior to the derivation of Employment.EMPCOUNTRY.

Click to jump to top of pageClick to jump to parent topicPlace of employment – Q11(EMPPLACE)

Return: DLHE

Entity: Employment

Page Used:

Page

Page Element

Enter DLHE Survey (Section B) self-service

Q11 – Town/city/area

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from the survey record.

  2. If Student.ALLACT1 = 1 or Student.ALLACT2 = 2, derive as NULL ERROR

  3. Derive as null.

Click to jump to top of pageClick to jump to parent topicUnpaid work – Q6 (EMPUNPAID)

Return: DLHE

Entity: Employment

Page Used:

Page

Page Element

Enter DLHE Survey (Section B) self-service

Q6 – Unpaid Work

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. If Employment.SALARY is null, derive from survey record (1 if Unpaid Work check box is selected)

  2. If Employment.SALARY is null and either Student.ALLACT1 = 1 or Student.ALLACT2 = 2, derive as NULL ERROR

  3. Derive as null.

Click to jump to top of pageClick to jump to parent topicTotal estimated earnings for a year – Q8 (ESTEARN)

Return: DLHE

Entity: Employment

Page Used:

Page

Page Element

Enter DLHE Survey (Section B) self-service

Q8

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record if the value is greater than zero.

  2. If Employment.JOBSNO is in range 2 to 9 and either Student.ALLACT1 = 1 or Student.ALLACT2 = 2, derive as NULL ERROR.

  3. Derive as null.

Note. The system applies a validation on the survey page to ensure that any non-zero value supplied is not less than the value supplied for Salary (Q6).

Click to jump to top of pageClick to jump to parent topicJob duties – Q4 (JOBDUTIES)

Return: DLHE

Entity: Employment

Page Used:

Page

Page Element

Enter DLHE Survey (Section B) self-service

Q4

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record.

  2. If either Student.ALLACT1 = 1 or Student.ALLACT2 = 2, derive as NULL ERROR.

  3. Derive as null.

Click to jump to top of pageClick to jump to parent topicHow found job – Q15 (JOBFOUND)

Return: DLHE

Entity: Employment

Page Used:

Page

Page Element

Enter DLHE Survey (Section B) self-service

Q15

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record (01 to 09).

  2. If Student.ALLACT1 = 1 or Student.ALLACT2 = 2, derive as NULL ERROR.

  3. Derive as null.

Click to jump to top of pageClick to jump to parent topicAll reasons for taking the job – Q14 (JOBRSNALL1)

Return: DLHE

Entity: Employment

Page Used:

Page

Page Element

Enter DLHE Survey (Section B) self-service

Q14 – Reasons check box 1

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive as 01 if the check box has been selected.

  2. If none of the check boxes has been selected and either Student.ALLACT1 = 1 or Student.ALLACT2 =2, derive as NULL ERROR.

  3. Derive as null.

Click to jump to top of pageClick to jump to parent topicAll reasons for taking the job – Q14 (JOBRSNALL2 to 9)

Return: DLHE

Entity: Employment

Page Used:

Page

Page Element

Enter DLHE Survey (Section B) self-service

Q14 – Reasons check boxes 2 to 9

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive as follows:

  2. Derive as null.

Click to jump to top of pageClick to jump to parent topicMain reason for taking the job – Q14 (JOBRSNMAIN)

Return: DLHE

Entity: Employment

Page Used:

Page

Page Element

Enter DLHE Survey (Section B) self-service

Q14 – Main reason

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record (01 to 09).

  2. If Student.ALLACT1 = 1 or Student.ALLACT2 = 2, derive as NULL ERROR.

  3. Derive as null.

Note. There is validation on the self-service page to ensure that the option selected for Main reason has also been selected as one of the Reasons.

Click to jump to top of pageClick to jump to parent topicNumber of jobs – Q2 (JOBSNO)

Return: DLHE

Entity: Employment

Page Used:

Page

Page Element

Enter DLHE Survey (Section B) self-service

Q2

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record if greater than 1 (2 to 9).

  2. Derive as null.

Note. There is validation on the self-service page to ensure the value entered is greater than 1. In step 1, the value is checked to ensure that zero is not derived.

Click to jump to top of pageClick to jump to parent topicJob title – Q3 (JOBTITLE)

Return: DLHE

Entity: Employment

Page Used:

Page

Page Element

Enter DLHE Survey (Section B) self-service

Q3

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record.

  2. If Student.ALLACT1 = 1 or Student.ALLACT2 = 2, derive as NULL ERROR.

  3. Derive as null.

Click to jump to top of pageClick to jump to parent topicNature of employer's business – Q10 (MAKEDO)

Return: DLHE

Entity: Employment

Page Used:

Page

Page Element

Enter DLHE Survey (Section B) self-service

Q10

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record.

  2. If Student.ALLACT1 = 1 or Student.ALLACT2 = 2, derive as NULL ERROR.

  3. Derive as null.

Click to jump to top of pageClick to jump to parent topicPostdoctoral research contract – derived from Q3 and Q4 (POSTDOC)

Return: DLHE

Entity: Employment

Page Used:

Page

Page Element

Enter DLHE Survey (Section B) self-service

Postdoctoral Research Contract *

* Not available in student self-service. The system displays this field only when you access the self-service page by clicking the Enter Survey button on the Survey Management page.

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record (1, 2 or 3).

  2. If Student.ALLACT1 = 1 or Student.ALLACT2 = 2, derive as NULL ERROR.

  3. Derive as null.

Click to jump to top of pageClick to jump to parent topicPreviously employed – Q16 (PREVEMP)

Return: DLHE

Entity: Employment

Page Used:

Page

Page Element

Enter DLHE Survey (Section B) self-service

Q16

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record (1, 2, 3, or 4).

  2. If Student.ALLACT1 = 1 or Student.ALLACT2 = 2, derive as NULL ERROR

  3. Derive as null.

Click to jump to top of pageClick to jump to parent topicCategory of previous employment – Q17 (PREVWORK1)

Return: DLHE

Entity: Employment

Page Used:

Page

Page Element

Enter DLHE Survey (Section B) self-service

Q17 – check box 1

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive as 01 if the check box has been selected.

  2. If none of the check boxes has been selected and Student.ALLACT1 = 1 or Student.ALLACT2 =2, and Employment.PREVEMP is 1, 2 or 3, derive as NULL ERROR.

  3. Derive as null.

Click to jump to top of pageClick to jump to parent topicCategory of previous employment – Q17 (PREVWORK2 to 7)

Return: DLHE

Entity: Employment

Page Used:

Page

Page Element

Enter DLHE Survey (Section B) self-service

Q17 – check boxes 2 to 7

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive as follows:

  2. Derive as null.

Click to jump to top of pageClick to jump to parent topicPart-time hours per week – Q7 (PTHOURS)

Return: DLHE

Entity: Employment

Page Used:

Page

Page Element

Enter DLHE Survey (Section B) self-service

Q7

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record if value is greater than zero

  2. If Student.ALLACT2 = 2, derive as NULL ERROR

  3. Derive as null.

Click to jump to top of pageClick to jump to parent topicQualification required for job – Q12 (QUALREQ)

Return: DLHE

Entity: Employment

Page Used:

Page

Page Element

Enter DLHE Survey (Section B) self-service

Q12

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record (11, 12, 13 or 14).

  2. If Student.ALLACT1 = 1 or Student.ALLACT2 = 2, derive as NULL ERROR.

  3. Derive as null.

Click to jump to top of pageClick to jump to parent topicSalary – Q6 (SALARY)

Return: DLHE

Entity: Employment

Page Used:

Page

Page Element

Enter DLHE Survey (Section B) self-service

Q6 - £

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record if the value is greater than zero.

  2. Derive as null.

Note. The system derives the Employment.SALARY field prior to Employment.EMPUNPAID and Employment.ESTEARN. Because a value is required for either Employment.SALARY or Employment.EMPUNPAID when Student.ALLACT = 1 or 2, Employment.EMPUNPAID is derived as NULL ERROR if Student.ALLACT is 1 or 2 and Employment.SALARY is null.

Click to jump to top of pageClick to jump to parent topicStandard Occupational Classification 2010 - derived from Q3 and Q4 (SOCDLHE2010)

Return: DLHE

Entity: Employment

Page Used:

Page

Page Element

Enter DLHE Survey (Section B) self-service

Occupational Classification *

* Not available in student self-service. The system displays this field only when you access the self-service page by clicking the Enter Survey button on the Survey Management page.

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record.

  2. If Student.ALLACT1 = 1 or Student.ALLACT2 = 2, derive as NULL ERROR

  3. Derive as null.

Click to jump to parent topicDLHE Return: Teaching Entity

A single Teaching entity is included in each Student entity.

Click to jump to top of pageClick to jump to parent topicEmployed as teacher – Q18 (EMPLDTEACH)

Return: DLHE

Entity: Teaching

Page Used:

Page

Page Element

Enter DLHE Survey (Section C) self-service

Q18

Enter DLHE Survey (Section C) self-service

Newly qualified teacher status – check box

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record (1 or 2).

  2. If the check box is selected, derive as NULL ERROR

  3. Derive as null.

Click to jump to top of pageClick to jump to parent topicGTC Scotland Teacher Induction scheme – Q19 (GTCSTIS)

Return: DLHE

Entity: Teaching

Page Used:

Page

Page Element

HESA Returns

Country

Enter DLHE Survey (Section C) self-service

Q19

Enter DLHE Survey (Section C) self-service

Newly qualified teacher status – check box

Field Derivation Rule: Include for all survey records in a DLHE return only if Country in HESA Returns page = Scotland.

Derivation Steps:

  1. Derive from survey record (1 or 2).

  2. If the check box is selected and Teaching.EMPLDTEACH = 1, derive as NULL ERROR

  3. Derive as null.

Click to jump to top of pageClick to jump to parent topicSeeking a teaching post – Q22 (SEEKTEACH)

Return: DLHE

Entity: Teaching

Page Used:

Page

Page Element

Enter DLHE Survey (Section C) self-service

Q22

Enter DLHE Survey (Section C) self-service

Newly qualified teacher status – check box

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record (1 or 2).

  2. If the check box is selected and Teaching.EMPLDTEACH = 2, derive as NULL ERROR

  3. Derive as null.

Click to jump to top of pageClick to jump to parent topicTeaching funded – Q20 (TEACHFUND)

Return: DLHE

Entity: Teaching

Page Used:

Page

Page Element

Enter DLHE Survey (Section C) self-service

Q20

Enter DLHE Survey (Section C) self-service

Newly qualified teacher status – check box

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record (1, 2, 3, or 4).

  2. If the check box is selected and Teaching.EMPLDTEACH = 1, derive as NULL ERROR

  3. Derive as null.

Click to jump to top of pageClick to jump to parent topicTeaching phase – Q21 (TEACHPHS)

Return: DLHE

Entity: Teaching

Page Used:

Page

Page Element

Enter DLHE Survey (Section C) self-service

Q21

Enter DLHE Survey (Section C) self-service

Newly qualified teacher status – check box

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record (1, 2, 3, or 4).

  2. If the check box is selected and Teaching.EMPLDTEACH = 1, derive as NULL ERROR

  3. Derive as null.

Click to jump to parent topicDLHE Return: Study Entity

A single Study entity is included in each Student entity.

Click to jump to top of pageClick to jump to parent topicCourse name – Q25 (COURSENAME)

Return: DLHE

Entity: Study

Page Used:

Page

Page Element

Enter DLHE Survey (Section D) self-service

Q25

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record (1, 2, 3, or 4).

  2. If Student.ALLACT5 = 5 or Student.ALLACT6 = 6, derive as NULL ERROR

  3. Derive as null.

Click to jump to top of pageClick to jump to parent topicNumber of courses – Q23 (COURSENO)

Return: DLHE

Entity: Study

Page Used:

Page

Page Element

Enter DLHE Survey (Section D) self-service

Q23

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record if the value is greater than zero.

  2. Derive as null.

Note. The survey self-service page ensures that any value entered is equal or greater than 2.

Click to jump to top of pageClick to jump to parent topicJACS 3.0 – derived from Q25 and Q26 (JACS)

Return: DLHE

Entity: Study

Page Used:

Page

Page Element

Enter DLHE Survey (Section D) self-service

JACS Subject *

* Not available in student self-service. The system displays this field only when you access the self-service page by clicking the Enter Survey button on the Survey Management page.

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record.

  2. If Student.ALLACT5 = 5 or Student.ALLACT6 = 6, derive as NULL ERROR

  3. Derive as null.

Click to jump to top of pageClick to jump to parent topicHow funding further study – Q28 (STUDYFUND)

Return: DLHE

Entity: Study

Page Used:

Page

Page Element

Enter DLHE Survey (Section D) self-service

Q28

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record (01, 02, 03, 04 or 05).

  2. If Student.ALLACT5 = 5 or Student.ALLACT6 = 6, derive as NULL ERROR.

  3. Derive as null.

Click to jump to top of pageClick to jump to parent topicSubject of study, training or research – Q26 (SUBJECT)

Return: DLHE

Entity: Study

Page Used:

Page

Page Element

Enter DLHE Survey (Section D) self-service

Q26

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record.

  2. If Student.ALLACT5 = 5 or Student.ALLACT6 = 6, derive as NULL ERROR.

  3. Derive as null.

Click to jump to top of pageClick to jump to parent topicType of qualification – Q24 (TYPEQUAL)

Return: DLHE

Entity: Study

Page Used:

Page

Page Element

Enter DLHE Survey (Section D) self-service

Q24

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record (01 to 07 or 98).

  2. If Student.ALLACT5 = 5 or Student.ALLACT6 = 6, derive as NULL ERROR.

  3. Derive as null.

Click to jump to top of pageClick to jump to parent topicName of university or college – Q27 (UCNAME)

Return: DLHE

Entity: Study

Page Used:

Page

Page Element

Enter DLHE Survey (Section D) self-service

Q27

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record.

  2. If Study.UCPROV is 1, 2, 3, 4, 5 or NULL ERROR, derive as NULL ERROR

  3. Derive as null.

Note. The system derives this field as null if Study.UCPROV is derived as 6 (unknown) or null and the institution name is not provided for Q27.

Click to jump to top of pageClick to jump to parent topicUniversity or college providing study – Derived from Q27 (UCPROV)

Return: DLHE

Entity: Study

Page Used:

Page

Page Element

Enter DLHE Survey (Section D) self-service

Q27 *

* Not available in student self-service. The system displays this field only when you access the self-service page by clicking the Enter Survey button on the Survey Management page.

Field Derivation Rule: Include for all survey records in a DLHE return.

Derivation Steps:

  1. Derive from survey record.

  2. If Student.ALLACT5 = 5 or Student.ALLACT6 = 6, derive as NULL ERROR

  3. Derive as null.

Note. The system derives this field prior to Study.UCNAME