LTI Tool Use
Last updated
Last updated
The mart_general.lti_tool keeps track of use of LTI tools in the learning environment.
mart_general
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.
udp_course_offering_id
INTEGER
The UDP ID for the Course offering associated with the LTI tool.
lms_course_offering_id
STRING
The LMS ID for the Course offering associated with the LTI tool.
sis_course_offering_id
STRING
The SIS ID for the Course offering associated with the LTI tool.
udp_person_id
INTEGER
The UDP ID for the person who used the LTI tool.
lms_person_id
STRING
The LMS ID for the person who used the LTI tool.
sis_person_id
STRING
The SIS ID for the person who used the LTI tool.
role
STRING
The role of the person who used the LTI 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 name of the academic organization(s).
academic_organization_display
STRING
An array of the name of the academic organization(s) written as a comma-separated string.
course_offering_title
STRING
The title of the Course offering associated with the LTI tool, i.e. Linear Algebra.
course_offering_start_date
DATE
The start date of the Course offering associated with the LTI tool.
course_offering_subject
STRING
The subject of the Course offering associated with the LTI tool, i.e. MATH
course_offering_number
STRING
The number of the Course offering associated with the LTI tool, i.e. 310.
course_offering_code
STRING
The code of the Course offering associated with the LTI tool, i.e. MATH 310.
num_students
INTEGER
The number of students enrolled in the Course offering associated with the LTI tool.
udp_course_section_id
INTEGER
The UDP ID of the Course section associated with the LTI tool.
lms_course_section_id
STRING
The LMS ID of the Course section associated with the LTI tool.
sis_course_section_id
STRING
The SIS ID of the Course section associated with the LTI tool.
instructor_name_array
ARRAY<STRING>
An array of the instructors’ names for the Course offering associated with the LTI tool.
instructor_lms_id_array
ARRAY<STRING>
An array of the instructors’ LMS IDs for the Course offering associated with the LTI tool.
instructor_display
STRING
The array of the instructors’ names for the Course offering associated with the LTI 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 instructors' email addresses for the Course offering written as a comma-separated string
event_time
DATETIME
The time that the LTI tool was launched.
event_day
DATE
The date that the LTI tool was launched.
event_hour
INTEGER
The hour that the LTI tool was launched.
launch_app_url
STRING
The URL of the application launched.
launch_app_domain
STRING
The domain of the application launched.
launch_app_name
STRING
The name of the application launched.
tool_name
STRING
The name of the LTI tool.
is_lti_tool
BOOLEAN
A boolean indicating if the tool launched is a LTI tool.
is_redirect_tool
BOOLEAN
A boolean indicating if the tool launched is a redirect tool.
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’.
The field event_time defines the time the event associated with when the tool launch took place from the LMS. This field is derived from the UDP’s event store.
This is the fully resolved URL of the launched tool. We pull this from the object.extensions chunk of the JSON Caliper event. Usually the URL comes from the url key of this chunk, but depending on the tool, it can also come from the domain key. We coalesce these values with preference to the url key if it exists.
The launch_app_domain is extracted from the domain key of the object.extensions chunk of the JSON Caliper event. Usually, this will be a subset of the full url value. Often, the launch_app_domain field can be useful to group events together in the event that a single tool has multiple resolved URL values.
The launch_app_name is extracted from the asset_name field of the object.extensions chunk of the JSON Caliper event. This is often a more human-readable name of the tool that is helpful for front-end reporting and visualization.
Unizin has compiled a list of common tools that are used across the consortium. The tool_name field does not exist natively in the Caliper event, but instead is a mapping table we crafted to further help with grouping and organizing LTI tool launches. Both the launch_app_name and launch_app_url fields are used for this mapping to tool_name, with the preference being launch_app_url. Currently 940 URLs and 313 app name values are mapped to tool_name values; if a value shows up that is not in the managed mapping table, a value of ‘unknown tool’ is returned.
This field alongside launch_app_name is intended to be the most useful for visualization and reporting. The launch_app_name field comes directly from the Caliper event, and the tool_name field comes from Unizin’s managed list.
We separate LTI tool launches from Redirect tool launches. Two areas of the event are critical to determine whether the event in scope is an LTI tool launch or a redirect launch:
The domain key from object.extensions.[‘com.instructure.canvas’]
The url key from object.extensions.[‘com.instructure.canvas’]
