Canvas Data Release Notes (2019-02-21)

Document created by Emily Allen Employee on Feb 7, 2019
Version 1Show Document
  • View in full screen mode

In this Canvas Data release, the schema version has been updated to 4.2.2. An initial set of tables with Canvas Catalog data have been added. Additionally, several Canvas Outcomes tables include a new column.

 

 

Canvas Data is a service that provides institutions with optimized access to all their data for reporting and queries. Learn more about Canvas Data.

 

 

Added Tables

< BACK TO TABLE OF CONTENTS

 

catalog_dim

Attributes for catalogs in Canvas Catalog

NameTypeDescription
idbigintUnique surrogate id for the catalog
parent_idbigintSelf-referencing key that points to the parent catalog for this catalog. Null if this catalog has no parent
namevarcharName of the catalog
currencyvarcharType of currency used in the catalog
countryvarcharCountry used in this catalog
time_zonevarcharTimezone used in this catalog
created_attimestampWhen the catalog was created
updated_attimestampWhen the catalog was last updated

 

 

catalog_product_dim

Attributes for products in Canvas Catalog. A product can be either a course or a program listing.

NameTypeDescription
idbigintUnique surrogate id for the catalog product
catalog_idbigintForeign key to the catalog dim
start_datetimestampThe start date for the course or program
end_datetimestampThe end date for the course or program
course_idbigintForeign key to the course dim if this product is a course
product_typevarcharCan be either "Program" or "Course"
titlevarcharThe title of the course or program listing
visibilityvarcharCan be one of “listed”, “unlisted”, or “hidden”
enrollment_openbooleanWhether the course or program is open for enrollment
has_waitlistbooleanWhether the course or program has a waitlist
created_attimestampThe date when the product was created
updated_attimestampThe date when the product was last updated

 

 

catalog_product_fact

Facts for products in Canvas Catalog. A product can be either a course or a program listing

NameTypeDescription
catalog_product_idbigintForeign key to the catalog product dim
catalog_idbigintForeign key to the catalog dim
parent_catalog_idbigintForeign key to the catalog dim. References the parent of the catalog that this product belongs to
course_idbigintForeign key to the course dim if this product is a course
enrollment_term_idbigintForeign key to the enrollment term dim
enrollment_feedouble precisionCost of the catalog product. Units are found in catalog_dim.currency
creditsdouble precisionNumber of credits the course is worth if the product is a course
waitlist_capacityintThe maximum capacity of the waitlist. Null if the waitlist has no maximum capacity
enrollment_capacityintThe maximum enrollment capacity for the course or program

 

 

catalog_enrollment_dim

Attributes for an enrollment in a Canvas Catalog program or course.

NameTypeDescription
idbigintUnique surrogate key for the catalog enrollment
catalog_product_idbigintForeign key to the catalog product dim. Refers to the course or program associated with the enrollment
user_idbigintForeign key to the user dim. Refers to the user associated with this enrollment
root_program_idbigintForeign key to the catalog product dim. Refers to the root program associated with this enrollment
statusvarcharThe status of the enrollment. One of either “active” or “dropped”
requirements_completed_attimestampTime when the user completed all requirements for the course or program. Null if the requirements have not yet been met
ends_attimestampTime by which the user must complete the course or program requirements. Null if there is no required end date
created_attimestampTime when the enrollment was created
updated_attimestampTime when the enrollment was last updated

 

 

catalog_user_registration_dim

Attributes for user registration in a Canvas Catalog. See catalog_enrollment for data about programs and courses the user is enrolled in.

NameTypeDescription
idbigintUnique surrogate key for the catalog user registration
catalog_idbigintForeign key to the catalog dim. Refers to the catalog that this registration belongs to
user_idbigintForeign key to the user dim. Refers to the registered user
created_attimestampTime when the user registration record was created
updated_attimestampTime when the user registration record was last updated

 

 

catalog_program_requirement_fact

Facts for the courses or programs required for completion of a program

NameTypeDescription
idbigintUnique surrogate key for the program requirement
catalog_idbigintForeign key to the catalog dim. Refers to the catalog in which this requirement is defined
catalog_program_idbigintForeign key to the catalog product dim. This ID refers to the program that requires the program or course referred to by “catalog_product_id”
catalog_product_idbigintForeign key to the catalog product dim. This ID refers to the program or course required by the program referred to by “catalog_program_id”
course_idbigintForeign key to the course dim. Refers to the required course if the requirement refers to a course.

 

 

Added Columns

< BACK TO TABLE OF CONTENTS


learning_outcome_dim

NameTypeDescription
outcome_import_idbigintForeign key to the outcome import associated with this outcome, if this outcome was imported

 


learning_outcome_fact

NameTypeDescription
outcome_import_idbigintForeign key to the outcome import associated with this outcome, if this outcome was imported

 


learning_outcome_group_dim

NameTypeDescription
outcome_import_idbigintForeign key to the outcome import associated with this outcome, if this outcome was imported

 


learning_outcome_group_fact

NameTypeDescription
outcome_import_idbigintForeign key to the outcome import associated with this outcome, if this outcome was imported

Attachments

    Outcomes