Setting Up a HESA Return
This section discusses how to:
Set up a HESA return.
Set up HESA fields.
Set up HESA types.
Set up HESA action reasons.
Configure HESA.
Generating student identifiers (SIDs or HUSIDs) during registration or enrollment.
Define session year records.
Page Name |
Definition Name |
Navigation |
Usage |
---|---|---|---|
Reporting Periods |
SSR_HE_REP_PERIODS |
|
View or create a reporting period. Reporting periods from 2000 onwards are delivered with your system. |
Returns |
SSR_HE_RETURNS |
|
View or create a return type. The STUDENT, OFFSHORE, DLHE, GRADOUT, Unistats/KIS, Data Futures, and ITT return types are delivered with your system. |
Entities |
SSR_HE_ENTITIES |
|
View or create an entity for a return type. The entities for Student, Offshore, DLHE, GRADOUT, Unistats/KIS, Data Futures, and ITT returns are delivered with your system. When you do a search, selecting the Active check box returns only active entities in the results. |
Fields |
SSR_HE_FIELDS |
|
View or create return fields. For Student, Offshore, DLHE, GRADOUT, Unistats/KIS, Data Futures, and ITT returns, the HESA fields are delivered with your system. |
HESA Returns |
SSR_HE_HESA_RETURN |
|
Create a return for a reporting period. To create a return, you can copy return setup data (such as the return fields) from another return you previously created. |
HESA Fields |
SSR_HE_HESA_FIELDS |
|
Add, edit, or view HESA fields in a return. If required, specify default and constant values for the HESA return fields. |
HESA Types |
SSR_HE_HESA_TYPES |
|
For the Student return, map HESA fields to the Campus Solutions name, address and external ID types. The system uses this mapping to derive HESA return field values. Also, define the program statuses that the system uses to determine which Instances records to include in the return. |
HESA Action Reasons |
SSR_HE_HESA_ACTN |
|
For the Student return, map HESA field codes to the Campus Solutions Program Action and Action Reason values. The system uses this mapping to derive HESA return field values. |
HESA Configuration |
SSR_HE_CONFIG |
|
Configure the system for Create Extract and Create HUSID processing. Control validation for DLHE survey. |
Create Student Identifiers |
SSR_HE_CRTHUSID |
|
Create SID or HUSID for students during the registration or enrollment period. |
Session Years |
SSR_HE_SESS_YR |
|
Define new session year records for an academic institution. |
Access the HESA Returns page (
).When adding a new return, you have to enter an academic institution and a return name. You must enter a unique return name for an academic institution.
Note: To test the Create Extract Application Engine (SSR_HE_DATA) process, you can define multiple returns for the same institution, return type, and reporting period.
Note: For the Data Futures return, the field derivation logic uses the Rules Engine. Rules are delivered for each field, and to activate the rules for the return you must run the Build Rules process for HESA DF Field Derivation Rules and HESA Derivation Steps Rule Categories. Make sure you have the appropriate security access to both categories. To run the process, go to .
When you access the HESA Returns page in add mode, the Copy Return Setup Data From group box appears.
To create a return using the Copy Return Setup Data From group box:
Select a previously defined return name from which you want to copy the setup data.
Select a reporting period for which you want to create the return.
Click Copy.
The other tabs in the page appear when you copy a return or click the Skip Copy button. If you want to manually create a return, if you are creating a return for the first time, or if no appropriate records are available to copy from, click the Skip Copy button.
The Create Fields button is available only when you click the Skip Copy button.
After selecting a return type, you can click the Create Fields button to have the system automatically create all the entities and the associated fields for the return. The system displays the created fields on the HESA Fields page.
Field or Control |
Description |
---|---|
Return Type |
Select any one of the following: STUDENT, OFFSHORE, DLHE, GRADOUT, ITT or KIS (Unistats). You can also select a return type that you have defined in the Returns page. Note: The system displays the HESA Types tab only for the Student and ITT returns. The system displays the HESA Action Reasons tab only for the Student, ITT and DLHE returns. |
Reporting Period |
Select the reporting period for which you want to create the return. |
Country |
Select a country code that the system uses to determine which fields to include in the return. Values for this field are delivered with your system as translate values. Values are England, Northern Ireland, Scotland, and Wales. This field is not applicable for the Aggregate Offshore return. |
INSTAPP |
Enter a value that you want the system to return in the Institution.INSTAPP field of the return. This field is not applicable for the Aggregate Offshore, DLHE, GRADOUT, Unistats/KIS and ITT, and Data Futures returns. |
Enable Sub-Plan Reporting |
Select if you want to enter the reporting data in the Sub-Plan HESA and the Sub-Plan Offering/Year HESA pages. Selecting this check box enables the system to use the entered subplan level data to generate the HESA return. This is not enabled for Graduate Outcomes (GRADOUT) return. |
Include FE (Include further education) |
Select to have the system derive fields relevant to further education (FE) students. This check box is not applicable for the Aggregate Offshore, DLHE, and GRADOUT returns. |
Active |
Clear this check box if you want to prevent old test returns from being displayed in the search results. |
For more information about the HUSID, INSTAPP, and UKPRN fields, refer to the HESA Student Record specification available from the HESA website. Specification for the HUSID digit structure can also be found on the HESA website.
Program Statuses
Select program statuses that the system can use for creating Instance entities.
Survey Details
The system enables the Survey Details region when you select the DLHE return type. Use this region to define the details of the two surveys (April and January) for each DLHE reporting period.
Field or Control |
Description |
---|---|
Survey |
For DLHE, select the survey translate values: 1 for the April survey or 2 for the January survey. For Graduate Outcomes, select the survey translate values:
Note: Because the CENSUS value is returned at the Provider rather than the Graduate level, it is expected that separate returns are defined for each of the survey populations. This allows the extracted data to be retained and not overwritten when the extract is run for a subsequent survey. The setup also allows a single return to be defined for multiple surveys where an institution does not want to retain the extract data. |
Qualifying Start Date |
|
Qualifying End Date |
|
Census Date |
Select the census date for the survey. This system also displays the date to the student on the Survey questionnaire For Graduate Outcomes, this field is optional. |
Survey Start Date |
Select the date when the survey is available for completion by the student. For Graduate Outcomes, this field is optional. But if you define a start date, then you must also define an end date. |
Survey End Date |
Select the date when the survey is no longer available for completion by the student. For Graduate Outcomes, this field is optional. |
Survey Statuses
The system enables the Survey Statuses region when you select the DLHE and GRADOUT return type. Use this region to define which surveys, based on the survey status, should be included by the Create Extract process.
Note: Unless other survey status values are set in Survey Management that should be included in the extract, you should define only New for a GRADOUT return.
Field or Control |
Description |
---|---|
Survey Status |
Select the translate values of the statuses to be included in the HESA extract. |
Account Types
The system enables the Account Types region when you select the Student return type. Use this region to specify the account types that your institution uses for tuition and waiver charges. The system uses the values that you enter in this region to derive Instance.GROSSFEE and Instance.NETFEE.
Research Options
This region appears only when the Return Type is STUDENT.
Field or Control |
Description |
---|---|
Primary Advisor Only |
By default, this check box is not selected. Use this check box to determine which student advisor records are used to create REF Data entities. |
Primary Supervisor Only |
By default, this check box is not selected. Use this check box to determine which supervisor records are used to create REF Data entities. |
Advisor Roles |
Select the advisor role. |
Supervisor Roles |
Optional. Use this field to define one or more roles to determine which supervisor records are used to create REF Data entities. If you do not define a role, supervisor records with any role value will be considered. |
Supervisor Statuses |
Use the Status field to define one ore more status values to determine which supervisor records are used to create REF Data entities. |
Research Attributes
Use this grid to map research fields to Common Attributes. This grid is hidden for Data Futures returns.
Field or Control |
Description |
---|---|
Field |
Select a Research field (ORCID, RCSTDID, RCSTDNT) to map to a single Common Attribute. |
Common Attribute |
Select a Common Attribute for mapping. Common Attributes are limited to the attributes defined for the Research Consumption record (SSR_RS_CONSMPTN). |
Common Attributes
Use this grid to map a field to a combination of record and Common Attributes for the Data Futures return. This grid is hidden for other HESA Return types.
Field or Control |
Description |
---|---|
Field |
Select a field to map to a record and attribute.
|
Record Name |
Select the Record (table) that includes the Common Attribute field to which you wish to map. |
Common Attribute |
Select a Common Attribute for mapping. Available Common Attributes are limited to the Record Name (table) selected. |
Access the HESA Fields page (
).This example illustrates the fields and controls on the HESA Fields page. You can find definitions for the fields and controls later on this page.
![HESA (Higher Education Statistics Agency) Fields page](img/i6604892an-768c.png)
Use a field constant when your institution wants to return the same value for an entity. For example, if you want the system to derive the Credit transfer scheme as No Scheme for all modules in the Student return 2008/09, set the Module.CRDTSCM constant value to 9.
Use the field default to reduce the amount of data entry by defining a default value to be used when no value is derived for a mandatory field. For example, if a default value of 999 is defined for the Module.CRDTPTS field, and no data is found for a module, then 999 is used.
Note that you must enter the value NULL if you want to define a null constant or default.
Note: The Constant Value field or the Default Value field can accept a maximum of 30 characters. Therefore, the system does not use these two fields in the derivation of the Unistats/KIS fields that exceed 30 characters (for example, the URL fields).
Note: For Unistats/KIS: The LEVELK field has K appended to distinguish it from the LEVEL field in the Aggregate Offshore return. The TITLEK field has K appended to distinguish it from the TITLE field in the ITT return. JACSA, JACSB and JACSC fields have A, B and C appended to allow three values to be returned and to distinguish the fields from the JACS field in the DLHE return.
Access the HESA Types page (
).This example illustrates the fields and controls on the HESA Types page. You can find definitions for the fields and controls later on this page.
![HESA (Higher Education Statistics Agency) Types page](img/i6604892an-778a.png)
Name Types
The system uses the Name Types mapping to derive Student.SNAME16 for ITT, Data Futures, and Student returns.
This region does not appear for Graduate Outcomes return. Name details are derived from Primary name records as per Student return.
Address Types
The system uses the Address Types mapping to derive the following fields:
EntryProfile.POSTCODE
Student.TTPCODE
EntryProfile.PERMADDCOUNTRY for the Data Futures return
For Graduate Outcomes, only the COUNTRY field is available. Users can define one or more address types that are considered when deriving the COUNTRY field and the Postal Address entity. If users do not define a type, all active address are considered during derivation.
Note: The Address Types region is not applicable for the ITT return.
External ID Types
The system uses the External ID Types mapping to derive the following fields for the Student return:
Instance.DHREGREF
Student.HUSID
Instance.RCSTDID
Student.SCN
Instance.TREFNO
Student.UCASPERID
Student.ULN
The system uses the External ID Types mapping to derive the following fields for the ITT return:
Student.HUSID
Student ISANUM
Student.NIN
Student.SKILLTEST
Student.TREFNO
Student.ULN
The system uses the External ID Types mapping to derive the following fields for the Data Futures return:
Engagement.RCSTDID
Engagement.TRN
Student.SCN
Student.UCASPERID
Student.ULN
For information about defining external systems and entering external system IDs for a person or an organization, see:
Email Types
Use this region to define one or more email types for the Graduate Outcomes return EMAIL field and for the ITT return NQTEMAIL field.
If you do not define a type, all emails are considered during derivation.
The system uses Email Types to derive the following fields for Graduate Outcomes return:
GRADUATE.EMAIL
GRADUATE.EMAIL2
GRADUATE.EMAIL3
Person ID Type
Use this region to define one or more ID types for the Data Futures return. The system uses the Person ID Type to derive PersonIdentifier.IDTYPECODE.
Phone Types
Use this region to define one or more phone types for the Graduate Outcomes return INTTEL, UKMOB, and UKTEL fields. If you do not define a type, all phone numbers are considered during derivation. The system uses Phone Types to derive the following fields for Graduate Outcomes return:
GRADUATE.INTTEL
GRADUATE.INTTEL2
GRADUATE.INTTEL3
GRADUATE.UKMOB
GRADUATE.UKMOB2
GRADUATE.UKMOB3
GRADUATE.UKTEL
GRADUATE.UKTEL2
GRADUATE.UKTEL3
Access the HESA Action Reasons page (
).This example illustrates the fields and controls on the HESA (Higher Education Statistics Agency) Action Reasons page. You can find definitions for the fields and controls later on this page.
![HESA (Higher Education Statistics Agency) Action Reasons page](img/i6604892an-79db.png)
Use this page to define the combinations of program action and action reason that the system uses to indicate PHD submission for research students, reason for ending studies, mode change, suspension of active studies, and award-only mapping.
For each region, if you edit the Program Action values the corresponding Action Reason fields are cleared to prevent an invalid combination from being saved.
Note: The Phd Submission Mapping and Suspension of Active Studies Mapping regions are not applicable for the ITT return.
Phd Submission Mapping
The system uses this mapping to derive the Instance.PHDSUB and StudentCourseSession.PHDSUB fields.
Reason for Ending Mapping
Select the Reason for Ending tab to enter the HESA codes. Map the program action and action reason values to the (HESA) Session Reason, Leaver Reason, and Instance Reason codes.
The system uses this mapping to derive Data Futures return Leaver.RSNREGEND field and StudentCourseSession.RSNSCSEND.
Change of Mode Mapping
Map the program action and action reason values to the HESA Mode of Study and HESA Mode Direction codes. Click the Mode of Study tab to enter the HESA mode of study and direction codes.
The system uses this mapping to derive the Student return's Instance.MODE field and ITT return's Student.MODE field.
Suspension of Active Studies Mapping
Map the program action and action reason values to the HESA Suspension of Studies codes. Click the Suspension of Studies tab to enter the HESA Suspension of Studies codes.
The system uses this mapping to derive the Instance.NOTACT field.
Award Only Mapping
The mapping in this grid is used in cases where the student’s program or plan is changed in order to make an intermediate award. When this happens, you must define the combinations of program action and reason that are used to make the change and complete the program. For example, Program Change/AWDP followed by Completion of Program/SUCC and those rows in Student Program/Plan are not considered when determining the COURSEID for the instance. This ensures continuity with what has been previously reported to HESA for that instance. The new program or plan is considered for the derivation of Qualifications Awarded. If you do not set a mapping as active, the program action and reason mapping continues to be considered.
This grid appears only for Student and ITT returns.
Field or Control |
Description |
---|---|
Action Reason |
(Optional) If you do not define a value, all action reasons (including blanks) are considered for the Program Action. |
Active |
By default, this check box is selected. You can deselect this check box to indicate that the mapping row is considered. |
Access the HESA Configuration page (
).Institution Details
Field or Control |
Description |
---|---|
UKPRN |
Enter a value that you want the system to return in the Institution.UKPRN field of the return. |
Show Further Education page |
Select to enable the Further Education page on the HESA Instance Details component (SSR_HE_INSTANCE). If this check box is deselected, you cannot access the Further Education page. Note: The fields on the Further Education page are relevant only to institutions in England and Wales. |
Show Financial Support region |
Select to enable the Financial Support region in HESA Instance Details component. Institutions in England can select this check box and institutions in Scotland, Northern Ireland and Wales can deselect this check box. |
Show ITT Placement region |
Select to enable the ITT Placement records in the HESA Instance Details component. |
Student Identifier Generation
Use this region to configure HUSID before running the Create HUSID process or the Create Extract process.
Note: For students without HUSIDs, the system creates HUSIDs when you run the Create Extract process for the Student return. However, if you want to create these IDs at the point of registration or enrollment for new students and before running the Create Extract process, run the Create HUSID process.
For information about defining external systems and entering external system IDs for a person or an organization, see:
Field or Control |
Description |
---|---|
HESA Institution Identifier |
(Optional) Set the institution identifier. This value is used to generate part of the HUSID. |
Sequence Number |
Enter the starting number for the system-assigned six-digit number included in the 13-digit HUSID number. For each student without an existing HUSID, the Create HUSID process or the Create Extract process assigns a unique 13-digit HUSID value in the return. |
HUSID External System |
(Optional) Select the ID type that the Create HUSID or Create Extract process uses for HUSID value. |
SID External System |
(Optional) Select the ID you want to use to generate SID records for the Data Futures return. |
Grading Basis Inclusion and Repeat Code Exclusion
These regions enable you to specify which Grading Basis values to include and which Repeat Codes to exclude in the Create Extract, Calculate Full-Time Equivalence, and Calculate Year of Student processes.
In the Grading Basis Inclusion region, when you select a Grading Basis and select a check box for the Extract, FTE, or the Year of Student process, the selected Grading Basis is considered by the selected process. In the Repeat Code Exclusion region, when you select a Repeat Code and select a check box for the Extract, FTE or Year of Student process, the selected process excludes class enrollments for the selected Repeat Code.
Drop Reason Exclusion
Use this region to define one or more reasons for dropping an enrollment. The Create Extract process for the Data Futures return, Calculate Full-Time Equivalence (FTE), and Calculate Year of Student processes utilizes the reasons you select to determine which records are excluded.
DLHE Survey
Field or Control |
Description |
---|---|
Allow incomplete submission |
Select to allow incomplete submission of the Enter Survey self-service page data. If this check box is:
This check box is applicable only for students accessing the Enter Survey self-service page. If you are accessing the Enter Survey self-service page by clicking the Enter Survey button on the Survey Management page, then this check box does not impact you. |
Hide Qualified Teacher Status |
If you select this check box, the system does not display the following on both student and administrator versions of the survey:
|
Hide Save and Return |
If you select this check box, the system does not display the Save and Return button and the Cancel button on each section of the student version of the survey (but the system will display the Save button on the administrator version of the survey). |
Require mandatory questions |
If you select the Allow incomplete submission check box, this check box becomes available. If the Allow incomplete submission is selected and the Require mandatory questions is not selected, then the students can submit the survey as long as Section A is complete (regardless of whether or not the Incomplete Questions list in section F contains optional or required fields). If both the Allow incomplete submission and Require mandatory questions check boxes are selected, then the students will not be able to submit if there are any required questions listed in the Incomplete Questions list; students will be able to submit if only optional questions or no questions are included in the Incomplete Questions list. This check box is applicable only for students accessing the Enter Survey self-service page. If you are accessing the Enter Survey self-service page by clicking the Enter Survey button on the Survey Management page, then this check box does not impact you. |
Access the Create Student Identifiers page (
).Use this page if you want to create Student identifiers (SIDs) or HUSIDs when registering or enrolling new students and before running the Create Extract process.
To create a HUSID, the process selects a student's earliest MATR Student Program record . If the MATR record is not available, then it selects the student's earliest ACTV record. If a record is found, the process uses the record's effective date for the entry year element. Then, the Create HUSID process uses the following logic to generate the HUSID value for a student who does not have a HUSID:
The first two digits of HUSID represent the year the student entered the Institution (for example, 08 for 2008). The entry year is determined as the final two digits of the year element of the effective date of the selected Student Program record.
The next four digits represent the institution identifier.
The process calculates the institution identifier as Institution Code plus 1000 (for example, 0184 is calculated as 1184)
Note that the process picks the Institution Code value from the HESA Configuration page.
The next six digits represent the system assigned sequence number.
Note that the starting number is defined in the HESA Configuration page. The process assigns this number for the first student for whom calculation is done.
The system automatically increases the starting number by one when it assigns a new sequence number.
The final digit is a check digit based on the existing ten digits. See the HESA website for details on check digit calculation.
Field or Control |
Description |
---|---|
ID Type |
Select:
|
Create from HUSID |
Select this check box to create SID records for students who don’t have SIDs by using their existing HUSID records. Students must also have an active Student Program record for the institution. By default, this check box is deselected. |
Create New |
Select this check box to create new SID records. By default, this check box is selected. To create an SID, the system uses a similar logic when creating a HUSID. However, the system formats the SID according to the UKPRN and SID external system values from the HESA configuration instead of the institution identifier and HUSID external system. For SIDs, the:
Note: If you select this check box and the Create from HUSID check box, the system first creates SIDs from existing HUSIDs before creating new SIDs. |
Start Date |
Specify a date if you want the process to only examine Student Program records that are active or matriculated on or after the specified date. For example, if you enter January 5, 2009, the process creates HUSIDS or SIDs for students who have records that have a program action of MATR or ACTV with an effective date of January 5, 2009 or later. |
Access the Session Years page (
).Use this page to define session year records for an academic institution. Academic Career, Term, and Session are optional. If required, these fields allow you to define non-standard years that aren't aligned with a term.
Field or Control |
Description |
---|---|
Own Identifier |
Optional. You can enter a maximum of 50 uppercase alphanumeric characters. |
Academic Career |
Optional. Select an active academic career for the selected academic institution. |
Term |
Optional. This is enabled only when you select an academic career. |
Session |
Optional. This is enabled only when you select a term. |
Start Date |
If you select a term, this value defaults to the Term Begin Date, but you can update it if necessary. |
End Date |
When you select a start date, this value defaults to Start Date plus 1 year, minus 1 day. For example, if your start date is 25 September 2021, the end date defaults to 24 September 2022. You can update this if necessary. |
Active |
By default, this is selected for new records. You can deselect this for obsolete records that don't need to be included in the Data Futures extract. |