ITT Return: Student Entity
The Create Extract process creates ITT Student entities only if all the following conditions are satisfied:
Report to HESA check box is selected on the HESA Instance page for the HESA Instance record.
The student's program commencement date is before or within the reporting period.
Either: (a) the student has been term activated for a term that begins within the reporting period and the student has at least one enrolled class related to that term or (b) the student has an FTE value of greater than zero for the reporting period. The process determines the FTE value for the reporting period from the HESA Instance record as either the Override FTE value or else the Calculated FTE value.
The most recent effective dated Student Program stack record has a Program Status matching one of the Eligible Program Statuses defined for the return on the HESA Returns page.
-
The Report to HESA check box is selected and either the derived TTCID value is 1, or the derived TTCIDC value is 01.
Note: Students are not included in the return if TTCID is 0 (zero) or is one of the codes only relevant to the Student return (5, 9, D, F, J, K) or is blank or is NULL ERROR.
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:
EMPLID
HUSID: The process determines this value from External System ID record for the EMPLID, where the ID type is the same as that defined for HUSID on the HESA Types page. If HUSID does not exist, the process creates a new HUSID.
NUMHUS (Student Instance Number): The process determines this value from the HESA Instance record as either Linked Career and Linked Career Number (if defined). Otherwise, it uses a combination of Career and Career Number as the NUHMUS value, that is ACAD_CAREER and STDNT_CAR_NBR. For example, UGRD1.
COURSEID: If a sub-plan is selected as the run parameter, the process uses the Sub-Plan code as the COURSEID, If the subplan is not selected, the process uses the plan code.
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.
Return: ITT
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
HESA Instance |
ALLPLACE |
Field Derivation Rule: Include for all Student entities.
Derivation Steps:
Use constant.
Derive value from HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: ITT
Entity: Student
Pages Used:
|
Page |
Page Element |
|---|---|
|
HESA Instance Data - Entry Profile |
APPLYAPPLICATIONID |
|
Application Data () |
External Application Nbr |
Field Derivation Rule: Include for all students
Derivation Steps:
-
Derive from HESA Instance Data.
-
Reference the Student Program record for the related instance to find the admission application number (ADM_APPL_NBR). This is then used to reference the admissions data record (ADM_APPL_DATA) to find the external application number (EXT_ADM_APPL_NBR) that holds the application ID plus the choice number for Apply applications. For example, 60018-1.
If the external application number isn't null and doesn't start with UC or GT, then the ID value minus the dash '-' and choice elements is derived: 60018.
-
Derive as null.
Return: ITT
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
Biographical Details |
Date of Birth |
Field Derivation Rule: Include for all Student entities.
Derivation Steps:
Derive from the Biographical Details page in the format YYYY-MM-DD.
Derive as NULL ERROR.
Return: ITT
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
HESA Instance |
BURSLEV |
Field Derivation Rule: Include for all Student entities.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: ITT
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
HESA Instance |
Start Date of Instance |
Note: This field is included as ITTSTARTDATE in the XML file.
Field Derivation Rule: Include for all Student entities.
Derivation Steps:
Derive from the HESA Instance page.
If there is a Research Candidate record for the instance:
Select the Begin Date (SSR_RS_BEGIN_DT) from the most recent active Consumption record where the effective date is on or before the reporting period end date.
Derive the Begin Date formatted to YYYY-MM-DD.
Match the Research Candidate record (SSR_RS_CAND_HDR) to the instance on EMPLID, Institution, Career and Career Number to find the Research Candidate Number (SSR_RS_CANDIT_NBR). If multiple records are found, the record with the highest candidate number is selected.
Associate consumption records (SSR_RS_CONSMPTN) with the Research Candidate record by EMPLID, Institution and Research Candidate Number.
The calculated value is stored in the HESA Instance Data record.
Use the following process to calculate the earliest class start date for enrolled classes related to the Instance being reported. This selection is similar to that done for StudentOnModule except that it is not restricted to classes overlapping the reporting period and considers enrollments for linked careers.
Select all activated terms for the student career of the Instance.
From each activated term, select classes that satisfy the following conditions:
– Status = Enrolled
– Units Taken value is greater than zero.
– Grading basis value matches one of the values defined in the Grading Basis Inclusion region with the Extract check box selected on the HESA Configuration page.
– Repeat Code value does not exist or does not match a value defined in the Repeat Code Exclusion region with the Extract check box selected on the HESA Configuration page.
– If the student has multiple careers with the same Academic Career value as the career being processed (that is, the same career value with different career numbers), then apply a further filter to the class enrollments. In such a case, select the class only if the program value of the enrollment record does not exist or matches one of the program values in the Student Program records for that career and career number.
If the Instance has been linked to a prior student career using the Linked Career and Linked Career Number fields in the HESA Instance record, then also consider classes for the previous career.
Derive the earliest Class Start Date from all the selected classes as COMDATE.
Derive as the earliest Effective Date of the HESA Instance records.
Return: ITT
Entity: Student
Pages Used: None
Field Derivation Rule: Include for all Student entities.
Derivation Steps:
If subplan is being reported to HESA, derive as COURSEID from the Academic Sub-Plan Table record.
If plan is being reported to HESA, derive as COURSEID from the Academic Plan Table record.
Return: ITT
Entity: Student
Pages Used:
|
Page |
Page Element |
|---|---|
|
Plan HESA Data |
Course Title |
|
Sub-Plan HESA |
HESA Course Title |
|
Academic Plan Table |
Academic Plan |
|
Academic Sub-Plan Table |
Academic Subplan |
Field Derivation Rule: Include for all Student entities.
Derivation Steps:
Derive as the HESA Course Title value 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 (that is, .DESCR from PS_ACAD_PLAN_TBL + space + DESCR from PS_ACAD_SUBPLN_TBL).
Derive as the Course Title value 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 (that is, DESCR from PS_ACAD_PLAN_TBL).
Return: ITT
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
HESA Instance |
CRMODE |
Field Derivation Rule: Include for all Student entities.
Derivation Steps:
Derive from the HESA Instance page.
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).
Do not derive a value and leave the field blank.
Return: ITT
Entity: Student
Pages Used:
|
Page |
Page Element |
|---|---|
|
Person HESA Data |
DISABILITY to DISABILITY 8 |
|
Impairment AUS |
Type of Impairment |
|
Disability |
HESA Disability |
Field Derivation Rule: Include for all entities.
Derivation Steps:
Derive from the Person HESA Data page.
-
If no values are defined in Person HESA Data, derive as the HESA code for each of the mapped Impairment record. Unmapped records aren't considered.
Use default, DISABILITY2 to 8 derive as null.
Derive as NULL ERROR.
Return: ITT
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
HESA Instance |
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, do not derive a value and leave the field blank.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If the student has a Support Services Request value defined on the Impairment AUS page, use the mapped HESA Disability Allowance code from the Disability page.
Use default.
Derive as NULL ERROR.
Return: ITT
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
HESA Instance |
DISCFUND |
Field Derivation Rule: Include for all Student entities.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Note: DISCFUND is not derived when TTCID = 2. Valid values for DISCFUND are 1 (Received) and 2 (Not received).
Return: ITT
Entity: Student
Pages Used:
|
Page |
Page Element |
|---|---|
|
|
Residency Self-Report — State and Country |
|
Entry Profile |
DOMICILE |
Field Derivation Rule: Include for all Student entities.
Derivation Steps:
Derive from the Entry Profile page.
Select Residency Self-Report records. If the Country value is not GBR, then select the related two-character code (COUNTRY_2CHAR) from the Country table (PS_COUNTRY_TBL).
If a mapping exists in the HESA Nationality/Domicile Mapping for the Campus Solutions Country code, use the mapped HESA value. Otherwise, use the COUNTRY_2CHAR code.
If a Residency Self-Report record exists, Country value is GBR, and State is defined, then map the Country and State to a HESA Country Code in the UCAS APR Mapping. Otherwise, log an error message and derive XK.
If State is not defined, report XK.
Use default.
Derive as NULL ERROR.
Return: ITT
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
HESA Instance Data |
ENGEXPECTEDENDDATE |
|
Student Program |
Expected Graduation Term |
|
Term Table — Attributes () |
Date attribute for ENGEXPECTEDENDDATE |
|
HESA Returns Setup — Common Attributes |
Common Attributes |
Note: This is included as EXPECTEDENDDATE in the XML file in a similar way to PGCECLSS in Previous Qualification.
Field Derivation Rule: Include for all entities
Derivation Steps:
-
Derive from the HESA Instance page.
-
Derived as the date attribute for the Expected Graduation Term in the most recent Student Program record converted to the YYYY-MM-DD format.
-
Derive as the Term End Date for the Expected Graduation Term in the most recent Student Program record converted to the YYYY-MM-DD format.
-
Use default.
-
Derive as NULL ERROR.
Return: ITT
Entity: Student
Pages Used:
|
Page |
Page Element |
|---|---|
|
Program HESA Data |
ENTRYRTEE |
|
Plan HESA Data |
ENTRYRTEE |
|
Sub-Plan HESA |
ENTRYRTEE |
|
HESA Instance |
ENTRYRTEE |
Field Derivation Rule: Include for all entities
Derivation Steps:
Use constant.
Derive from HESA Instance page.
If Instance.COURSEID is based on a sub-plan, derive value from the Sub-Plan HESA page.
Derive value from Plan HESA Data page.
Derive value from Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: ITT
Entity: Student
Pages Used:
|
Page |
Page Element |
|---|---|
|
Person HESA Data |
ETHNICS |
|
Ethnicity |
Regulatory Region, Ethnic Group |
|
Ethnicity |
HESA Ethnicity |
Field Derivation Rule: Include for all entities.
Derivation Steps:
Derive from the Person HESA Data page.
Select Person Ethnicity records as follows:
If a single record exists, use that record.
If multiple records exist and one is marked as Primary on the Campus Community Ethnicity page, use that record.
If multiple records exist and none are marked as Primary, select the record with the highest Percentage defined in the Ethnicity Detail page.
If multiple records are indistinguishable, select the lowest alphabetic Ethnic Group code.
For the selected record, use the HESA Ethnic code from the mapping between the Ethnic Group, Regulatory Region, and the HESA Ethnic code. If no mapping exists, log an error message and skip to next step.
Use default.
Derive as NULL ERROR.
Return: ITT
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
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:
Use the First Name and Middle Name values from the Primary Name record.
Derive as NULL.
Return: ITT
Entity: Student
Pages Used:
|
Page |
Page Element |
|---|---|
|
Program HESA Data |
FUNDCODE |
|
Plan HESA Data |
FUNDCODE |
|
Sub-Plan HESA |
FUNDCODE |
|
HESA Instance |
FUNDCODE |
Field Derivation Rule: Include for all Student entities.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Student.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: ITT
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
External System ID |
External System ID |
Field Derivation Rule: Include for all students.
Derivation Step:
-
Derive from the most recent non-future external system ID records matched on EMPLID where the ID type is the same as that defined for SID in the HESA configuration record.
-
If an SID isn't found, a new SID is created according to the Create Student Identifiers process, and that value is derived.
If the student has an existing HUSID, that is used to create the SID. Otherwise, a new SID is created.
-
First two digits: Last two digits of the year from earlier MATR or ACTV row in the student program.
-
Next eight digits: The provider's UKPRN.
-
Next 6 digits: The next 6-digit sequence number from HESA configuration. The sequence number is automatically incremented when a value is used.
-
Last digit: Check digit.
The new SID is stored as an External System ID using the current effective date.
-
Derive as NULL ERROR.
Return: ITT
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
Entry Profile |
INDSLFCRT |
Field Derivation Rule: If Student.COMDATE is in the current reporting period, derive a value. Otherwise, derive as NULL ERROR.
Derivation Step:
Derive from the Entry Profile page.
Use default.
Derive as NULL ERROR.
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.
Return: ITT
Entity: Student
Pages Used:
|
Page |
Page Element |
|---|---|
|
Program HESA Data (Program Instance HESA Data) |
INITIATIVES-ITT, INITIATIVES-ITT2 |
|
Plan HESA Data (Plan Instance HESA Data) |
INITIATIVES-ITT, INITIATIVES-ITT2 |
|
Sub-Plan HESA (Sub-plan Instance HESA Data) |
INITIATIVES-ITT, INITIATIVES-ITT2 |
|
HESA Instance |
INITIATIVES-ITT, INITIATIVES-ITT2 |
Field Derivation Rule: Include for all Student entities.
Derivation Steps:
Derive from the HESA Instance page.
If Instance.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Do not derive a value and leave the field blank.
Return: ITT
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
External System ID |
External System ID |
Field Derivation Rule: Include for all Student entities.
Derivation Steps:
Determine from the External System ID records for the person with the External ID Type defined for ISANUM in the HESA Types page.
Do not derive a value and leave the field blank.
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:
Use constant.
If subplan is being reported, derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: ITT
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
HESA Instance |
ITTCOMDATE |
Note: This field is included as TRAINEESTARTDATE in the XML file.
Field Derivation Rule: Include for all students.
Derivation Steps:
Derive from the HESA Instance page.
Derive as null.
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 |
ITTPhase/Scope |
Field Derivation Rule: Include for all Student entities.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: ITT
Entity: Student
Pages Used:
|
Page |
Page Element |
|---|---|
|
Program HESA Data |
ITTSCHMS |
|
Plan HESA Data |
ITTSCHMS |
|
Sub-Plan HESA |
ITTSCHMS |
|
HESA Instance |
ITTSCHMS |
Field Derivation Rule: Include for all Student entities.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
Derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: 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 |
MODE |
|
Mode of Study |
HESA Mode of Study |
|
HESA Action Reasons |
Change of Mode Mapping |
Field Derivation Rule: Include for all Student entities.
Derivation Steps:
Derive from the HESA Instance page.
Select the Student Program record that has Program Action/Reason values mapped to a HESA Mode in the HESA Action Reasons page. Derive the mapped HESA mode value.
If the derived value is 73 or 74, convert 73 to 63 and 74 to 64.
If the derived value is 01, 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 02, derive as 02.
If the derived value is 31, 32, 33, 34, 35, 36, 37, 38, 39, 44, then convert as 31.
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 01, 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 02, derive as 02.
If the derived value is 31, 32, 33, 34, 35, 36, 37, 38, 39, 44, then convert as 31.
Derive as NULL ERROR.
Return: ITT
Entity: Student
Pages Used:
|
Page |
Page Element |
|---|---|
|
Program HESA Data |
MSTUFEE |
|
Program Offering/Year HESA |
MSTUFEE (Program Offering HESA Data group box) |
|
Plan HESA Data |
MSTUFEE |
|
Plan Offering/Year HESA |
MSTUFEE (Plan Offering HESA Data group box) |
|
Sub-Plan HESA |
MSTUFEE |
|
Sub-Plan Offering/Year HESA |
MSTUFEE (Sub-Plan Offering HESA Data group box) |
|
HESA Instance |
MSTUFEE |
Field Derivation Rule: If Student.TTCID = G or Q, derive a value. Otherwise, do not derive a value and leave the field blank.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
If Student.COURSEID is based on a subplan, derive from the Sub-Plan Offering/Year HESA page for the academic load of the student instance.
If Student.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan Offering/Year HESA page for the academic load of the student instance.
Derive from the Plan HESA Data page.
Derive from the Program Offering/Year HESA page for the academic load of the student instance.
Derive from the Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: ITT
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 |
Field Derivation Rule: Include for all Student entities.
Derivation Steps:
Derive from the Person HESA Data page.
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.
If multiple person citizenship records are found and a record has a value of GB, derive as GB.
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.
If multiple records are found and none have the UK or EU value, select the lowest alphabetic code
Use default.
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.
Return: Student Record
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
Person HESA Data |
NATIOND |
Field Derivation Rule: Include for all Student entities.
Derivation Steps:
Derive from the Person HESA Data page.
Use default.
Derive as NULL.
Return: Student Record
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
Person HESA Data |
NATIOND2 |
Field Derivation Rule: Include for all Student entities.
Derivation Steps:
Derive from the Person HESA Data page.
Use default.
Derive as NULL.
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:
Determine from the External System ID records for the person with the External ID Type defined for NIN in the HESA Types page.
Do not derive a value and leave the field blank.
Return: ITT
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
Electronic Addresses |
Email Address (preferred) |
Field Derivation Rule: Include for all students.
Derivation Steps:
Derive from preferred email address defined for the student if the email type is defined in Email Types in HESA Returns Setup.
-
Derive from a non-preferred email address if the email type is defined in Email Types in HESA Returns Setup. If there's more than one record, the record with the lowest alpha type is derived.
Derive as null.
Return: ITT
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
HESA Instance |
Instance Identifier Linked Career Linked Career Number Academic Career Student Career Nbr |
Field Derivation Rule: Include for all Student entities.
Derivation Steps:
Derive from HESA Instance page as Instance Identifier.
Derive from HESA Instance page as Linked Career + Linked Career Number.
Derive from HESA Instance page as Academic Career + Student Career Nbr, for example, UGRD1.
Return: ITT
Entity: Student
Pages Used: None
Field Derivation Rule: Include for all Student entities.
Derivation Step:
1. Derive as EMPLID.
Return: ITT
Entity: Student
Pages Used:
|
Page |
Page Element |
|---|---|
|
Program HESA Data (Program Instance HESA Data) |
PGAPPSTDT |
|
Plan HESA Data (Plan Instance HESA Data) |
PGAPPSTDT |
|
Sub-Plan HESA Data (Sub-plan Instance HESA Data) |
PGAPPSTDT |
|
HESA Instance Data |
PGAPPSTDT |
Field Derivation Rule: Include for all entities.
Derivation Steps:
Use the value from HESA Instance Data.
If COURSEID is based on a sub-plan, use the value from Sub-Plan Instance HESA Data.
Derive the value from Plan Instance HESA Data.
Derive the value from Program Instance HESA Data
Use the default value.
Derive as null.
Return: ITT
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
Entry Profile |
PGCECLSS |
Field Derivation Rule: Derive a value if the following conditions are met:
Student.COMDATE is in the current reporting period
Student.ITTAIM = 110,113, 020, 027 or 031
Derive as NULL ERROR if the conditions are not met.
Derivation Steps:
Use constant.
Derive from the Entry Profile page.
Use default.
Derive as NULL ERROR.
Return: ITT
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
Entry Profile |
PGCESBJ PGCESBJ2 PGCESBJ3 |
Field Derivation Rule: Derive a value if the following conditions are met:
Student.COMDATE is in the current reporting period
Student.ITTAIM = 110,113, 020, 027 or 031
Derive as NULL ERROR if the conditions are not met.
Derivation Steps:
Use constant to create a single PGCESBJ field.
Derive from the Entry Profile page.
Use default to create a single PGCESBJ field.
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.
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, do not derive a value and leave the field blank.
Derivation Steps:
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.
Do not derive a value and leave the field blank.
Return: ITT
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
Program HESA Data |
QLAIM |
|
Plan HESA Data |
QLAIM |
|
Sub-Plan HESA |
QLAIM |
Field Derivation Rule: Derive a value if Student.ITTAIM = 202.
Derivation Steps:
Use constant.
If a sub-plan is reported, derive value from Sub-Plan HESA page.
Derive value from Plan HESA Data page.
Derive value from Program HESA Data page.
Use default.
Derive as NULL ERROR.
Return: ITT
Entity: Student
Pages Used:
|
Page |
Page Element |
|---|---|
|
Program HESA Data (Program Instance HESA Data) |
SDEMPLOY |
|
Plan HESA Data (Plan Instance HESA Data) |
SDEMPLOY |
|
Sub-Plan HESA Data (Sub-plan Instance HESA Data) |
SDEMPLOY |
|
HESA Instance Data |
SDEMPLOY |
Field Derivation Rule: If all the following conditions are met, derive a value:
Student.ENTRYRTEE = 03 or 10
Student.MODE isn't 63 or 64
All School Direct trainees should be associated with a lead school. When the lead school does not have a unique reference number (URN), these generic codes are used:
900000 — Establishments outside England and Wales
900010 — Not applicable nor available
Derivation Steps:
Use constant.
Derive from HESA Instance Data.
If COURSEID is based on a sub-plan, derive from Sub-Plan Instance HESA Data.
Derive from Plan Instance HESA Data.
Derive from Program Instance HESA Data.
Use default.
Derive as NULL ERROR.
Return: ITT
Entity: Student
Pages Used:
|
Page |
Page Element |
|---|---|
|
Program HESA Data (Program Instance HESA Data) |
SDLEAD |
|
Plan HESA Data (Plan Instance HESA Data) |
SDLEAD |
|
Sub-Plan HESA Data (Sub-plan Instance HESA Data) |
SDLEAD |
|
HESA Instance Data |
SDLEAD |
Field Derivation Rule: If all the following conditions are met, derive a value:
Student.ENTRYRTEE = 02, 03, or 10
Student.MODE isn't 63 or 64
All School Direct trainees should be associated with a lead school. When the lead school does not have a unique reference number (URN), these generic codes are used:
900000 — Establishments outside England and Wales
900010 — Not applicable nor available
Derivation Steps:
Use constant.
Derive from HESA Instance Data.
If COURSEID is based on a sub-plan, derive from Sub-Plan Instance HESA Data.
Derive from Plan Instance HESA Data.
Derive from Program Instance HESA Data.
Use default.
Derive as NULL ERROR.
Return: ITT
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
HESA Instance Data |
SERLEAVE |
Dependant Fields: COMDATE, ITTCOMDATE
Field Derivation Rule: Derive if either COMDATE or ITTCOMDATE is after 2018-07-31. If not, derive as null.
Derivation Steps:
Derive the value from the HESA Instance Data page.
Use the default.
Derive as null.
Return: ITT
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
Biographical Details (Campus Community , Personal Information (Student), Add/Update a Person, Biographical Details) |
Gender |
|
Gender (Records and Enrollment, HESA Reporting, Codes and Mappings, Code Mappings, Gender) |
HESA Sex Identifier |
|
Campus Community, Personal Information, Add/ Update a Person, HESA Student Data Campus Community, Personal Information, Add/Update a Person, HESA Restricted Data |
SEXIDS |
Field Derivation Rule: Include for all entities.
Derivation Step:
Derive from Person HESA Data.
Select the Gender value from the Biographical History record. Derive as the mapped HESA value for the selected Gender value.
If no mapping is found, then derive as
If the gender value is Male, derive as 11.
If the gender value is Female, derive as 10.
Use default.
Derive as NULL ERROR.
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:
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.
Do not derive a value and leave the field blank.
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 |
SPLENGTH |
Field Derivation Rule: Include for all Student entities.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
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. Only records where Offering Start Term, Offering Start Session and Campus are all blank are considered.
If Student.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan Offering/Year HESA page for the academic load of the student instance. Only records where Offering Start Term, Offering Start Session and Campus are all blank are considered.
Derive from the Plan HESA Data page.
Derive from the Program Offering/Year HESA page for the academic load of the student instance.
Derive from the Program HESA Data page.
Use default.
Do not derive a value, leave the field blank and set ReasonForNull = 9 .
Return: ITT
Entity: Student
Pages Used:
|
Page |
Page Element |
|---|---|
|
Program HESA Data |
STUACCID |
|
Plan HESA Data |
STUACCID |
|
Sub-Plan HESA Data |
STUACCID |
|
HESA Instance |
STUACCID |
Note: This field is included as ITTPHSC in the XML file.
Field Derivation Rule: Include for all entities
Derivation Step:
-
Derive from HESA Instance Data.
-
Derive from Sub-Plan HESA Data.
-
Derive from Plan HESA Data.
-
Derive from Program HESA Data.
-
Derive as NULL ERROR.
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:
Use the Last Name value from the Primary Name record.
Derive as NULL ERROR.
Return: ITT
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
Names |
Name Title |
Field Derivation Rule: Include for all Student entities.
Derivation Steps:
Use the Name Title value from the Primary Name record.
Do not derive a value, leave the field blank, and set ReasonForNull = 9.
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:
Select External System ID records for the person with the External ID Type defined for TREFNO in the HESA Types page.
Use default.
Do not derive a value and leave the field blank.
Return: ITT
Entity: Student
Pages Used:
|
Page |
Page Element |
|---|---|
|
Program HESA Data |
TTCIDC |
|
Plan HESA Data |
TTCIDC |
|
Sub-Plan HESA |
TTCIDC |
Field Derivation Rule: Include for all entities.
Derivation Steps:
Derive from the Sub-Plan HESA page.
Derive from the Plan HESA Data page.
Derive from the Program HESA Data page.
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:
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.
Do not derive a value and leave the field blank.
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 |
UNITLGTH |
Field Derivation Rule: Include for all Student entities.
Derivation Steps:
Use constant.
Derive from the HESA Instance page.
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. Only records where Offering Start Term, Offering Start Session and Campus are all blank are considered.
If Student.COURSEID is based on a subplan, derive from the Sub-Plan HESA page.
Derive from the Plan Offering/Year HESA page for the academic load of the student instance. Only records where Offering Start Term, Offering Start Session and Campus are all blank are considered.
Derive from the Plan HESA Data page.
Derive from the Program Offering/Year HESA page for the academic load of the student instance.
Derive from the Program HESA Data page.
Use default.
Do not derive a value, leave the field blank and set ReasonForNull = 9.
Return: ITT
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
HESA Instance |
Year of Program |
Field Derivation Rule: Include for all Student entities.
Derivation Steps:
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.
Return: ITT
Entity: Student
Page Used:
|
Page |
Page Element |
|---|---|
|
HESA Instance |
Year of Student |
Include for all Student entities.
Derivation Steps:
Derive from the HESA Instance page.
Use default.
Derive as NULL ERROR.