LMS Tool Use

The mart_general.lms_tool mart keeps track of interactions with LMS tools in the learning environment.

BQ Prod Dataset Location

mart_general

Interactive Mart Dependency Diagram

The following visualization shows the construction of this data mart defined in the UDP marts repository. More information on the repository and diagram can be found on this marts page.

Click here to open the interactive chart.

mart_general.lms_tool

Schema

Field Name	Type	Description
udp_course_offering_id	INTEGER	The UDP ID for the Course offering associated with the LMS tool.
lms_course_offering_id	STRING	The LMS ID for the Course offering associated with the LMS tool.
sis_course_offering_id	STRING	The SIS ID for the Course offering associated with the LMS tool.
udp_person_id	INTEGER	The UDP ID for the person who used the LMS tool.
lms_person_id	STRING	The LMS ID for the person who used the LMS tool.
sis_person_id	STRING	The SIS ID for the person who used the LMS tool.
role	STRING	The role of the person who used the LMS tool, i.e. Learner or Instructor.
academic_term_name	STRING	The name of the academic term, i.e. Fall 2020.
academic_term_start_date	DATE	The start date for the academic term.
academic_organization_array	ARRAY<STRING>	An array of the academic organization(s) associated with the course offering.
academic_organization_display	STRING	An array of the academic organization(s) associated with the course offering written as a comma-separated string
course_offering_title	STRING	The title of the Course offering associated with the LMS tool, i.e. Linear Algebra.
course_offering_start_date	DATE	The start date of the Course offering associated with the LMS tool.
course_offering_subject	STRING	The subject of the Course offering associated with the LMS tool, i.e. MATH
course_offering_number	STRING	The number of the Course offering associated with the LMS tool, i.e. 310.
course_offering_code	STRING	The code of the Course offering associated with the LMS tool, i.e. MATH 310.
num_students	INTEGER	The number of students enrolled in the Course offering associated with the LMS tool.
udp_course_section_id	INTEGER	The UDP ID of the Course section associated with the LMS tool.
lms_course_section_id	STRING	The LMS ID of the Course section associated with the LMS tool.
sis_course_section_id	STRING	The SIS ID of the Course section associated with the LMS tool.
instructor_name_array	ARRAY<STRING>	An array of the instructors’ names for the Course offering associated with the LMS tool.
instructor_lms_id_array	ARRAY<STRING>	An array of the instructors’ LMS IDs for the Course offering associated with the LMS tool.
instructor_display	STRING	The array of the instructors’ names for the Course offering associated with the LMS tool written as a string.
instructor_email_address_array	ARRAY<STRING>	An array of the instructors' email addresses for the Course offering.
instructor_email_address_display	STRING	An array of the instructor's email addresses for the Course offering written as a comma-separated string.
event_time	DATETIME	The time that the LMS tool was used.
event_day	DATE	The date that the LMS tool was used.
event_hour	INTEGER	The hour that the LMS tool was used.
canvas_tool	STRING	The Canvas tool that was used if the LMS is Canvas.
asset_type	STRING	The asset type of the LMS tool.
asset_type_id	STRING	The ID for the asset type of the LMS tool.
asset_subtype	STRING	The asset subtype of the LMS tool.
asset_subtype_id	STRING	The ID for the asset subtype of the LMS tool.
module_item_id	STRING	The ID of the module item if the LMS tool is associated with a module.
learner_activity_id	STRING	The ID of the learner activity if the LMS tool is associated with a learner activity.

Fields

num_students

The num_students field defines the number of enrolled students in a Course offering. This number is found from the course_section_enrollment table in UDP’s context store, which keeps track of enrollments in course sections. We count the number of enrollments with a role of ‘Student’ or ‘Observer’ and a role status that is not ‘Dropped’, ‘Withdrawn’, or ‘Not-enrolled’.

event_time

The field event_time defines the time the event associated with the LMS tool use took place. This field is derived from the UDP’s event store. An event is considered to be a LMS tool launch when the EdApp ID of the event is the LMS. For example, an event is a Canvas tool launch if the EdApp ID is ‘canvas’ or ‘instructure’.

canvas_tool

The field canvas_tool defines the Canvas tool used if the LMS is Canvas. The Canvas tool used is derived from the asset_type and asset_subtype fields. If the asset_type field is ‘course’, then the canvas_tool field is defined based on the asset_subtype field. For instance, if the asset_type is ‘course’ and the asset_subtype is ‘home’, then the canvas_tool is defined as ‘Homepage’. Otherwise, the canvas_tool is defined based on the asset_type field.

asset_type

The asset_type field defines the asset type of the LMS tool. This field is derived from the event store. As mentioned when discussing the event_time field, an event is a LMS tool launch if the EdApp ID of the event is the LMS. The asset type is generally extracted from the asset_type key from object.extensions.[‘com.instructure.canvas’]. However, if the asset_type key from object.extensions.[‘com.instructure.canvas’] is equal to ‘course’ and the request_url key from extensions_json[‘com.instructure.canvas’] is an URL with a path similar to ‘/course/…/grades/…’, then the asset type is defined as ‘gradebook’.

asset_type_id

The asset_type_id field defines the ID for the asset type of the LMS tool. This field is also derived from events in the event store with an EdApp ID of the LMS. The asset type ID is extracted from the extensions of the object, or the object.extensions field. Specifically, it is extracted from the entity_id key from object.extensions.[‘com.instructure.canvas’]. If this value is null, then the asset type ID is extracted from the object.id field.

asset_subtype

The asset_subtype field is defined as the asset subtype of the LMS tool. This field is derived from events in the event store with an EdApp ID of the LMS. If the asset_type key from object.extensions.[‘com.instructure.canvas’] is equal to ‘course’ and the request_url key from extensions_json[‘com.instructure.canvas’] is an URL with a path similar to ‘/course/…/grades/…’, then the asset subtype is ‘user’. If the asset_type key from object.extensions.[‘com.instructure.canvas’] is equal to ‘enrollment’, then the asset subtype is again defined as ‘user.’ Otherwise, the asset subtype is extracted from the asset_subtype key from object.extensions.[‘com.instructure.canvas’].

asset_subtype_id

The asset_subtype_id field is the asset subtype ID for the LMS tool. This field is taken from events in the event store with an EdApp ID of the LMS. If the asset_subtype key from object.extensions.[‘com.instructure.canvas’] is not null and the asset_type key from object.extensions.[‘com.instructure.canvas’] is not equal to ‘course’, then the asset subtype ID is extracted from the entity_id key from object.extensions.[‘com.instructure.canvas’]. When this key is null, the ID is instead extracted from the object.id field. If the asset_type key from object.extensions.[‘com.instructure.canvas’] is equal to ‘enrollment’, then the asset subtype ID is extracted from the request_url key from extensions_json.[‘com.instructure.canvas’]. If the asset_type key from object.extensions.[‘com.instructure.canvas’] is equal to ‘course’ and the request_url key from extensions_json[‘com.instructure.canvas’] is an URL with a path similar to ‘/course/…/grades/…’, then the asset subtype ID is extracted from the request_url key from extensions_json.[‘com.instructure.canvas’]. Otherwise, the asset subtype ID is null.

asset_subtype key from object.extensions	asset_type key from object.extensions	request_url from extensions_json	asset_subtype_id
Is not NULL	Is not equal to ‘course’		Is extracted from the entity_id key from object.extensions field. If this key is null, it is then extracted from the object.id field.
	Is equal to ‘enrollment’		Is extracted from request_url key from object.extensions field.
	Is equal to ‘course’	Similar path as ‘/course/…/grades/…’	Is extracted from request_url key from extensions_json field.