Skip to content

Latest commit

 

History

History
137 lines (96 loc) · 3.12 KB

module_instance.md

File metadata and controls

137 lines (96 loc) · 3.12 KB

module_instance

** indicates that the property is the primary key for this entity.

Description of module_instance entity

A module_instance is the specific offer of a module to students. It therefore has a specific venue and defined assessments.

MOD_INSTANCE_ID

Description

Institutions unique identifier for this module_instance

Purpose

For linking a module_instance to a student

Derivation

Jisc

Valid Values

Any

Format

String (255)

Notes

MOD_PERIOD

Description

Period to which module_instance relates (e.g. semester 1)

Purpose

Analytics

Derivation

Jisc

Valid Values

Each different code value in MOD_PERIOD should have a matching code value in period.PERIOD_CODE.

Format

String (255)

Notes

It is expected that sites / organisations will have their own code lists for MOD_PERIOD values.

MOD_ONLINE

Description

Whether or not this module_instance is delivered wholly online.

Purpose

Analytics

Derivation

Jisc

Valid Values

MOD_ONLINEDESCRIPTION(ENGLISH)DESCRIPTION(WELSH)
1YesIe
2NoNa

Format

String (255)

Notes

Omitting this property may hinder the development or use of an effective analytics model.

MOD_ACADEMIC_YEAR

Description

Academic year that this module runs within - this must represent the start year of that specific academic year eg. for 2014-15 this would be 2014.

Purpose

Analytics

Derivation

Jisc

Valid Values

Year as four digits - year that the academic year starts in, with valid values being from 1900 onwards.

Format

Int

Notes

This is the starting year for the academic year. Omitting this property may hinder the development or use of an effective analytics model.

MOD_OPTIONAL

Description

Whether or not this instance relates to an optional module. This property is deprecated in v1.3.2 for module_instance. It properly belongs on student_on_a_module_instance instead of module_instance, and has been added there.

Purpose

Analytics

Derivation

Jisc

Valid Values

MOD_OPTIONALDESCRIPTION(ENGLISH)DESCRIPTION(WELSH)
1YesIe
2NoNa

Format

String (255)

Notes

MOD_LOCATION

Description

Identifies where a module is to be run. This could be campus, country, or building depending on the needs of the institutions config. Allows modules to be have a different location from the one identified at the course level detail (COURSE_LOCATION).

Purpose

To provide details about a module and how it may differ from similar coded modules.

Derivation

As defined by the institution and their SRS

Valid Values

Any

Format

String (255)

Notes