03 August 2023

Module message type

The module message type contains data relating to programme modules such as module dates.

Schema

The diagram Module schema shows how the entities of the module message type, such as ModuleAvailability, are linked to the other entities in the module message type, such as Module. The diagram also shows how the entities in the module message type are linked to entities in the applicant, learning and progression, and period message types.

Module schema
Schema diagram for the module message type

Entity and attribute mappings

The default entity and attribute mappings for the module message type are detailed below. The module message type also contains custom attributes for specific entities.

Data Engine to SITS:Vision mappings

The table Module message type mappings details the Data Engine to SITS:Vision entity and attribute mappings.

For each Data Engine entity, the following attributes are generated:

  • dataSource

  • sourceChangeDateTime

  • insertedDateTime

  • updatedDateTime

The default mappings provided by Tribal can be customised for the institution in SITS:Vision. For more information on customising the mappings, go to SITS:Vision Manuals and then Menu System and then Technical Guide and then Integration Guide and then Tribal Edge and then Tribal Data Engine.
Module message type mappings
Data Engine entity Data Engine attribute SITS:Vision entity SITS:Vision attribute
Modules id MEN_RID RID_UUID
Modules moduleId MEN_RID RID_UUID
Modules moduleCode INS_MOD MOD_CODE
Modules name INS_MOD MOD_NAME
Modules credit INS_MOD MOD_CRDT
Modules externalCreditLevelCode INS_MOD ECL_CODE
Modules creditBearing INS_MOD MOD_CRDT
Modules inUse INS_MOD MOD_IUSE
Modules schemeCode INS_MOD SCH_CODE
Modules levelCode INS_MOD LEV_CODE
Modules departmentCode INS_MOD DPT_CODE
Modules facultyCode INS_MOD MOD_FACC
Modules typeCode INS_MOD MOT_CODE
Modules status INS_MOD MOD_STAT
Modules numberOfPeriods INS_MOD MOD_NPER
Modules statusDescription SRS_STA STA_NAME
ModuleAvailabilities id MEN_RID RID_UUID
ModuleAvailabilities moduleAvailabilityId MEN_RID RID_UUID
ModuleAvailabilities moduleId MEN_RID RID_UUID
ModuleAvailabilities periodId MEN_RID RID_UUID
ModuleAvailabilities moduleTutorId MEN_RID RID_UUID
ModuleAvailabilities title INS_MOD MOD_NAME
ModuleAvailabilities moduleCode CAM_MAV MOD_CODE
ModuleAvailabilities occurrenceCode CAM_MAV MAV_OCCUR
ModuleAvailabilities academicYearCode CAM_MAV AYR_CODE
ModuleAvailabilities periodSlotCode CAM_MAV PSL_CODE
ModuleAvailabilities availabilityName CAM_MAV MAV_MAVN
ModuleAvailabilities availabilityStatusCode CAM_MAV SHS_CODE
ModuleAvailabilities locationCode CAM_MAV LCA_CODE
ModuleAvailabilities targetNumberOfStudents CAM_MAV MAV_TRGT
ModuleAvailabilities actualNoOfStudents CAM_MAV MAV_ACTL
ModuleAvailabilities beginsInPeriod CAM_MAV MAV_BEGP
ModuleAvailabilities endsInPeriod CAM_MAV MAV_ENDP
ModuleAvailabilities periodSequenceNumber CAM_MAV MAV_PSEQ
ModuleAvailabilities moduleAssessmentPatternCode CAM_MAV MAP_CODE
ModuleAvailabilities moduleTutorCode CAM_MAV PRS_CODE
ModuleAvailabilities day CAM_MAV DAY_CODE
ModuleAvailabilities startTime CAM_MAV MAV_STIME
ModuleAvailabilities modeOfAttendanceCollectionCode CAM_MAV MAV_MACC
ModuleAvailabilities beginWeek CAM_MAV MAV_BEGW
ModuleAvailabilities endWeek CAM_MAV MAV_ENDW
ModuleAvailabilities departmentCode CAM_MAV DPT_CODE
ModuleAvailabilities virtualEnvironmentUse CAM_MAV MAV_VLYN
ModuleAvailabilities availabilityStatusDescription CAM_SHS SHS_NAME
ModuleAvailabilities locationDescription INS_LCA LCA_NAME
ModuleAvailabilities moduleAssessmentPatternDescription CAM_MAP MAP_NAME
ModuleAvailabilities modeOfAttendanceCollectionDescription INS_MOA MOA_NAME
ModuleAvailabilities departmentDescription INS_DPT DPT_NAME
PathwayModules id MEN_RID RID_UUID
PathwayModules pathwayModuleId MEN_RID RID_UUID
PathwayModules moduleId MEN_RID RID_UUID
PathwayModules pathwayCode CAM_PMD PWY_CODE
PathwayModules pathwayTypeCode CAM_PMD PMD_PWTC
PathwayModules moduleCode CAM_PMD MOD_CODE
PathwayModules pathwayDescription INS_PWY PWY_NAME
PathwayModules pathwayTypeDescription INS_PWT PWT_NAME

Custom attributes

The table Custom attributes details the Data Engine entities that have custom attribute fields and the number of custom attribute fields for each entity.

Custom attributes
Data Engine entity Custom attribute fields
Modules 4
ModuleAvailabilities 4
PathwayModules 2