Student Record Return: Module Entity

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

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

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

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

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

If you have selected the Validation Errors Only check box for the Include Module Entities, the Create Extract process first deletes any Validation Error staging records where all of the COURSEID, MODID and EMPLID fields are blank. Then, it selects distinct MODID values from the Validation Error staging table for rows where MODID is not blank and EMPLID is blank. The process selects Module entity records for these MODIDs. Note that the File Parser process removes the leading zeroes from MODID, therefore, the comparison of MODID with Course ID and Course Offering Number includes the logic to correctly match the values. The system makes an assumption that the Course Offering Number is a single digit. Finally, the Create Extract process deletes records from the Validation Error staging table where MODID is populated and EMPLID is blank.

Return: Student Record

Entity: Module

Page Used:

Page

Page Element

HESA Module Data

CRDTPTS

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

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

Field Derivation Rule: Include for all Module entities.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Module Data page.

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

  4. Use default.

  5. Derive as NULL ERROR.

Return: Student Record

Entity: Module

Page Used:

Page

Page Element

HESA Module Data

CRDTSCM

Field Derivation Rule: Include for all Module entities.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Module Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Return: Student Record

Entity: Module

Page Used:

Page

Page Element

HESA Module Data

FRANIND

Field Derivation Rule: If Country = Wales, derive a value. Otherwise, do not derive a value and leave the field blank.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Module Data page.

  3. Use default.

  4. Do not derive a value and leave the field blank.

Note: The HESA specification indicates that the Module.FRANIND coverage also includes Course.COURSEAIM that begins with D, E, L, M, H, I, J or C, however, the extract process cannot check this as there is no direct link to the Course entity.

Return: Student Record

Entity: Module

Page Used:

Page

Page Element

HESA Module Data

FTE

Field Derivation Rule: Include for all Module entities.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Module Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Return: Student Record

Entity: Module

Page Used:

Page

Page Element

HESA Module Data

LEVLPTS

Field Derivation Rule: If Module.CRDTPTS does not equal 999, derive a value. Otherwise, do not derive a value and leave the field blank.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Module Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Return: Student Record

Entity: Module

Page Used:

Page

Page Element

HESA Module Data

Course ID

Course Offering Nbr

Field Derivation Rule: Include for all Module entities.

Derivation Steps:

Derive as combination of Course ID plus Course Offering Number (CRSE_ID and CRSE_OFFER_NBR column values from PS_CRSE_OFFER), or the combination of Academic Plan and Year for dummy modules. For example, if Course ID = 001248 and Offering Number = 2, then MODID = 0012482.

Return: Student Record

Entity: Module

Page Used:

Page

Page Element

HESA Module Data

MODLANG

Field Derivation Rule: If Country = Northern Ireland, Scotland, or Wales, derive a value. Otherwise, do not derive a value and leave the field blank.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Module Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Return: Student Record

Entity: Module

Page Used:

Page

Page Element

HESA Module Data

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

HESA Dummy Module Data

Year

Field Derivation Rule: Include for all Module entities.

Derivation Steps:

  1. Use constant.

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

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

  3. Use default.

  4. Derive as NULL ERROR.

Return: Student Record

Entity: Module

Page Used:

Page

Page Element

HESA Module Data

PCOLAB

Field Derivation Rule: Include for all Module entities.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Module Data page.

  3. Use default.

  4. Derive as NULL ERROR.

Return: Student Record

Entity: Module

Page Used:

Page

Page Element

HESA Module Data

TINST

Field Derivation Rule: If Module.PCOLAB is greater than zero, derive a value. Otherwise, do not derive a value and leave the field blank.

Derivation Steps:

  1. Use constant.

  2. Derive from the HESA Module Data page.

  3. Use default.

  4. Derive as NULL ERROR.