Return to Navigation

ITT Return: Student Entity

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

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:

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

Biographical Details select (Campus Community , then select Personal Information (Student), then select Add/Update a Person, then select 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.

Return: ITT

Entity: Student

Page Used:

Page

Page Element

HESA Instance

BURSLEV

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance page.

  3. Use default.

  4. Derive as NULL ERROR.

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.

Return: ITT

Entity: Student

Pages Used:

Page

Page Element

Plan HESA Data

Course Title

Sub-Plan HESA

HESA Course Title

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

Academic Plan

Academic Sub-Plan Table select (Set Up SACR, then select Foundation Tables, then select Academic Structure, then select 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).

Return: ITT

Entity: Student

Page Used:

Page

Page Element

HESA Instance

Start Date of Instance

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Derive from the HESA Instance 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 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.

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

Return: ITT

Entity: Student

Page Used:

Page

Page Element

HESA Instance

CRMODE

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Derive from the HESA Instance 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. Do not derive a value and leave the field blank.

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:

  • Student.COMDATE is in the current reporting period

  • Student.ITTAIM = 110, 113, 020, 027 or 031

  • Student.DEGEST does not exist

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

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:

  • Student.COMDATE is in the current reporting period.

  • Student.ITTAIM = 110, 113, 020 or 031.

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.

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:

  • Student.COMDATE is in the current reporting period.

  • Student.ITTAIM = 110, 113, 020, 027 or 031.

Do not derive a value and leave the field blank, 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. Do not derive a value and leave the field blank.

Return: ITT

Entity: Student

Page Used: None

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

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.

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:

  • Student.COMDATE is in the current reporting period.

  • Student.ITTAIM = 110, 113, 020 or 031.

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.

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:

  • 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:

  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.

Return: ITT

Entity: Student

Pages Used:

Page

Page Element

Person HESA Data

DISABLE

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

Type of Impairment

Disability select (Records and Enrollment, then select HESA Reporting, then select Codes and Mappings, then select Code Mappings, then select 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).

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:

  1. Use constant.

  2. Derive from the HESA Instance 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.

Return: ITT

Entity: Student

Page Used:

Page

Page Element

HESA Instance

DISCFUND

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance page.

  3. Use default.

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

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. Do not derive a value, leave the field blank and set ReasonForNull = 9.

Return: ITT

Entity: Student

Pages Used:

Page

Page Element

Person HESA Data

ETHNIC

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

Regulatory Region, Ethnic Group

Ethnicity select (Records and Enrollment, then select HESA Reporting, then select Codes and Mappings, then select Code Mappings, then select 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:

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

  3. Use default.

  4. Derive as NULL ERROR.

Return: ITT

Entity: Student

Page Used:

Page

Page Element

Names select (Campus Community, then select Personal Information (Student), then select Add/Update a Person, then select Biographical Details, then select 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. 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

FUNDCODE

Plan HESA Data

FUNDCODE

Sub-Plan HESA

FUNDCODE

HESA Instance

FUNDCODE

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Instance 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.

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:

    • First 2 digits: Year of entry into institution (last 2 digits of year, for example, 09 for 2009).

    • Next 4 digits: HESA Institution Identifier + 1000 (for example, QUB = 0184 which becomes 1184).

    • Next 6 digits: 6-digit reference number internally allocated by institution (this is a sequence number, institutions may need to manually increase the sequence number to avoid reusing the same number in the same year of entry).

    • Last digit: Check digit

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

  1. Derive from the Entry Profile page.

  2. Use default.

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

  1. Derive from the HESA Instance 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. 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:

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

  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.

Return: ITT

Entity: Student

Page Used:

Page

Page Element

HESA Instance

ITTCOMDATE

Field Derivation Rule: Include for all Student entities.

Derivation Steps:

  1. Derive from the HESA Instance page.

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

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:

  1. Use constant.

  2. Derive from the HESA Instance 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.

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:

  1. Use constant.

  2. Derive from the HESA Instance 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.

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 select (Records and Enrollment, then select HESA Reporting, then select Codes and Mappings, then select Code Mappings, then select 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 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.

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:

  1. Use constant.

  2. Derive from the HESA Instance 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 ERROR.

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. Do not derive a value and leave the field blank.

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:

  1. Derive from HESA Instance page as Instance Identifier.

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

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

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:

  1. Use constant.

  2. Derive from the Entry Profile page.

  3. Use default.

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

  1. Use constant to create a single PGCESBJ field.

  2. Derive from the Entry Profile 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.

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:

  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. Do not derive a value and leave the field blank.

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.

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 Identifier

Field Derivation Rule: Include for all Student entities.

Derivation Step:

  1. Select the Gender value from the Biographical History record. Derive as the mapped HESA value for the selected Gender value.

  2. If no mapping is found, then derive as

    • If the gender value is Male, derive as 1.

    • If the gender value is Female, derive as 2.

  3. Use default.

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

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

  1. Use constant.

  2. Derive from the HESA Instance 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. Do not derive a value, leave the field blank and set ReasonForNull = 9 .

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.

Return: ITT

Entity: Student

Page Used:

Page

Page Element

Names select (Campus Community, then select Personal Information (Student), then select Add/Update a Person, then select Biographical Details, then select 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. 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:

  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. Do not derive a value and leave the field blank.

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.

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

  1. Use constant.

  2. Derive from the HESA Instance 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. 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:

  1. Derive from the HESA Instance page.

  2. Use default.

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

  1. Derive from the HESA Instance page.

  2. Use default.

  3. Derive as NULL ERROR.