Canvas Data Release Notes (2017-02-21)

Document created by Eric Coan Employee on Feb 21, 2017Last modified by Erin Hallmark on Jul 15, 2018
Version 2Show Document
  • View in full screen mode

In this production release (February 20th), we have updated the schema to version v1.14.0. Changes to the schema for this release include adding in multiple brand new tables in order to supply "modules" data.

 

 

  Added Tables

  < BACK TO TABLE OF CONTENTS

 

Module Dim:

 

Column NameColumn TypeDescription
idBIGINTUnique surrogate ID for the module.
canvas_idBIGINTThe ID for this module inside of Canvas.
course_idBIGINTThe course that owns this module.
require_sequential_progressENUMShould module items be completed sequentially?  Valid values are 'required', 'not_required', 'unspecified'.
workflow_stateENUMWorkflow state for submission lifetime values. Possible values are 'locked', 'completed', 'unlocked' and 'started'.
positionINTPosition of the module on the modules page.
nameTEXTThe name of the module in Canvas.
created_attimestampTimestamp when the module was created.
deleted_attimestampTimestamp when the module was deleted.
unlock_attimestampTimestamp when the module will unlock.
updated_attimestampTimestamp when the module was last updated.

 

Module Fact:

 

Column NameColumn TypeDescription
module_idBIGINTUnique surrogate ID for the module.
account_idBIGINTForeign key to the account the module belongs to.
course_idBIGINTForeign key to the course associated with this assignment.
enrollment_term_idBIGINTForeign key to the enrollment_term associated with the module_fact course.
wiki_idBIGINTForeign key to the wiki associated with the module_fact course.

 

Module Item Dim:

 

 

Column Name

Column TypeDescription
idBIGINTUnique surrogate ID for the module_item.
canvas_idBIGINTOriginal primary key for module_item in the Canvas table.
assignment_idBIGINTKey into assignments table for 'Assignment' type items.
course_idBIGINTThe course that owns this module.
discussion_topic_idBIGINTKey into discussion_topics table for 'Discussion' type items.
file_idBIGINTKey into file table for 'File' type items.
module_idBIGINTParent module for this module item.
quiz_idBIGINTKey into quizzes table for 'Quiz' type items.
wiki_page_idBIGINTKey into wiki_pages table for 'Page' type items.
content_typeENUMThe type of content linked to this item. One of: 'Assignment', 'Attachment', 'DiscussionTopic', 'ContextExternalTool', 'ContextModuleSubHeader', 'ExternalUrl', 'LearningOutcome', 'Quiz', 'Rubric' or 'WikiPage'.
workflow_stateENUMState of the module item. Active, Unpublished, or deleted.
positionINTPosition of the module item within the module context.
titleTEXTTitle of the module item.
urlTEXTUrl for external url type module items.
created_atTIMESTAMPTimestamp when the module item was created.
updated_atTIMESTAMPTimestamp when the module item was last updated.

 

Module Item Fact:

 

Column NameColumn TypeDescription
module_item_idBIGINTUnique surrogate ID for the module_item.
account_idBIGINTForeign key to the account the module belongs to.
assignment_idBIGINTKey into assignments table for 'Assignment', 'DiscussionTopic', 'File', 'Quiz' type items.
assignment_group_idBIGINTKey into assignment_groups for 'Assignment', 'File' type items.
course_idBIGINTThe course that owns this module.
discussion_topic_idBIGINTKey into discussion_topics table for 'DiscussionTopic' type items.
discussion_topic_editor_idBIGINTKey into users table for user who edited 'DiscussionTopic' type items.
enrollment_rollup_idBIGINTKey into enrollment_rollup table for user associated with 'DiscussionTopic', 'File' type items.
enrollment_term_idBIGINTForeign key to the enrollment_term associated with the module course.
file_idBIGINTKey into file table for 'File' type items.
module_idBIGINTParent module for this module item.
quiz_idBIGINTKey into quizzes table for 'File', 'Quiz' type items.
user_idBIGINTKey into users table for 'DiscussionTopic', 'File', 'WikiPage' type items.
wiki_idBIGINTKey into wiki table for 'WikiPage' type items.
wiki_page_idBIGINTKey into wiki_pages table for 'WikiPage' type items.

 

Module Progression Dim:

 

Column NameColumn TypeDescription
idBIGINTUnique surrogate ID for the module progression.
canvas_idBIGINTOriginal primary key for module progression in the Canvas table.
module_idBIGINTParent module for this module progression.
user_idBIGINTUser being tracked in the module progression.
collapsedENUMCollapsed state of the module progression. Values are collapsed, not_collapsed, unspecified.
is_currentENUMThe current state of the module progression. Values are current, not_current, unspecified
workflow_stateENUMThe workflow state of the module progression. Values are locked, completed, unlocked, and started.
current_positionINTRepresents the users current position in the module.
lock_versionINTLock version of the module progression.
created_atTIMESTAMPTimestamp when the module progression was created.
completed_atTIMESTAMPTimestamp when the module progression was completed.
evaluated_atTIMESTAMPTimestamp when the module progression was evaluated.
updated_atTIMESTAMPTimestamp when the module progression was last updated.

 

Module Progression Fact:

 

Column NameColumn TypeDescription
module_progression_idBIGINTUnique surrogate ID for the module progression.
account_idBIGINTForeign key to the account the module belongs to.
course_idBIGINTForeign key to the course associated with this module.
enrollment_term_idBIGINTForeign key to the enrollment_term associated with the module course.
module_idBIGINTParent module for this module progression.
user_idBIGINTUser being tracked in the module progression.
wiki_idBIGINTForeign key to the wiki associated with the module course.

 

Module Completion Requirement Dim:

 

Column NameColumn TypeDescription
idBIGINTUnique surrogate ID for the module completion requirement.
module_idBIGINTModule that contains the completion requirement.
module_item_idBIGINTItem that is the subject of the completion requirement.
requirement_typeENUMType of completion event that must be achieved to consider item complete. Values are: must_view,must_mark_done,min_score,must_submit.

 

Module Completion Requirement Fact:

 

 

Column NameColumn TypeDescription
module_completion_requirement_idBIGINTUnique surrogate ID for the module completion requirement.
account_idBIGINTForeign key to the account the module and the module item belong to.
assignment_idBIGINTAssignment associated with the module item.
assignment_group_idBIGINTAssignment group associated with the module item.
course_idBIGINTForeign key to the course associated with this module and the module item.
discussion_topic_idBIGINTDiscussion topic associated with the module item.
discussion_topic_editor_idBIGINTEditor of the discussion topic associated with the module item.
enrollment_rollup_idBIGINTEnrollment rollup associated with the module item.
enrollment_term_idBIGINTForeign key to the enrollment term associated with this module and the module item.
file_idBIGINTFile associated with the module item.
module_idBIGINTModule that contains the completion requirement.
module_item_idBIGINTItem that is the subject of the completion requirement.
quiz_idBIGINTQuiz associated with the module item.
user_idBIGINTUser associated with the module item.
wiki_idBIGINTForeign key to the wiki associated with this module and the module item.
wiki_page_idBIGINTWiki page associated with the module_item.
min_scoreDOUBLEFor min_score type requirements, the score that must be attained for completion..

 

Module Prerequisite Dim:

 

Column NameColumn TypeDescription
idBIGINTUnique surrogate ID for the module prerequisite.
module_idBIGINTModule that contains the prerequisite.
prerequisite_module_idBIGINTModule that must be completed to fulfill the prerequisite.

 

 

Module Prerequisite Fact:

 

Column NameColumn TypeDescription
module_prerequisite_idBIGINTUnique surrogate ID for the module prerequisite.
account_idBIGINTForeign key to the account the module belongs to.
course_idBIGINTForeign key to the course associated with this assignment.
enrollment_term_idBIGINTForeign key to the enrollment_term associated with the module_fact course.
module_idBIGINTModule that contains the prerequisite.
prerequisite_module_idBIGINTModule that must be completed to fulfill the prerequisite.
prerequisite_wiki_idBIGINT Foreign key to the wiki associated with the module_fact course.
wiki_idBIGINTForeign key to the wiki associated with the module_fact course.

 

 

Module Progression Completion Requirement Dim:

 

 

Column NameColumn TypeDescription
idBIGINTUnique surrogate ID for the module progression completion requirement.
module_progression_idBIGINTModule progression referenced by completion requirement.
module_item_idBIGINTItem that the user has not completed.
requirement_typeENUMType of completion event that must be achieved to consider item complete. Values are: must_view, must_mark_done, min_score, must_submit.
completion_statusENUM Denotes if the completion event is complete or not. Possible values are 'complete' and 'incomplete'.

 

Module Progression Completion Requirement Fact:

 

 

Column NameColumn TypeDescription
module_progression_completion_requirement_idBIGINTUnique surrogate ID for the module progression completion requirement.
account_idBIGINTKey to the account associated with the module progression and the module item.
assignment_idBIGINTKey to the assignment associated with the module item.
assignment_group_idBIGINTKey to the assignment group associated with the module item.
course_idBIGINTKey to the course associated with the module progression and the module item.
discussion_topic_idBIGINTKey to the discussion topic associated with the module item.
discussion_topic_editor_idBIGINTKey to the user editing the discussion topic associated with the module item.
enrollment_rollup_idBIGINTKey to the enrollment rollup associated with the module item.
enrollment_term_idBIGINTKey to the enrollment term associated with the module progression and the module item.
file_idBIGINTKey to the file associated with the module item.
module_idBIGINTParent module for this module progression and module item.
module_item_idBIGINTItem that the user has completed.
module_progression_idBIGINTModule progression referenced by the completion requirement.
quiz_idBIGINTKey to the quiz associated with the module item.
user_idBIGINTKey to the user associated with the module progression and the module item.
wiki_idBIGINTKey to the wiki associated with the module progression and the module item.
wiki_page_idBIGINTKey to the wiki page associated with the module item.
min_scoreDOUBLEFor min_score type requirements, the score that must be attained for completion.
scoreDOUBLEFor min_score type requirements, the score that the user has currently achieved.
1 person found this helpful

Attachments

    Outcomes