Automated report of assignments in courses

Document created by Jaap Stelpstra on Apr 18, 2019Last modified by jivedocs@instructure.com on May 29, 2019
Version 5Show Document
  • View in full screen mode

Attached Excel workbook is able to download data from Canvas (exclusively using Get API calls) to create an overview of all assignments in all courses you specify using Course SIS IDs.

 

Report of assignments in courses

The worksheet contains the following columns to be filled with data from the API as specified in Assignments - Canvas LMS REST API Documentation :

sis_course_codegrade_group_students_individuallyonly_visible_to_overrides
course_codepeer_reviewslocked_for_user
workflow_stateautomatic_peer_reviewslock_explanation
course_namepeer_review_countquiz_id
ass. idpeer_reviews_assign_atanonymous_submissions
assignment_nameintra_group_peer_reviewsfreeze_on_copy
descriptiongroup_category_idfrozen
created_atneeds_grading_countfrozen_attributes
updated_atpositionuse_rubric_for_grading
due_atpost_to_sisrubric_settings
lock_atintegration_idrubric
unlock_atintegration_dataomit_from_final_grade
has_overridesmutedmoderated_grading
course_idpoints_possiblegrader_count
html_urlsubmission_typesfinal_grader_id
submissions_download_urlhas_submitted_submissionsgrader_comments_visible_to_graders
assignment_group_idgrading_typegraders_anonymous_to_graders
due_date_requiredgrading_standard_idgrader_names_visible_to_final_grader
max_name_lengthpublishedanonymous_grading
turnitin_enabledunpublishableallowed_attempts
vericite_enabled

 

Please note: if the returned data of an item is an object with multiple values (e.g. multiple due dates) instead of a single value, the cell will stay empty (may be fixed in the future).

 

Compatibility

  • MS Office 2010 on MS Windows (tested on 2010 version 14.0.7184.5000, higher versions work most likely, but are not tested)
  • MS Office 2011 on Mac OS X (not tested but should work. Excel 2016 for Mac barely supports VBA and is therefore not supported)


Enable editing and content

In case Excel displays the following warnings, enable editing and content for the Workbook to work properly:

Excel Protected View Warning

Excel Security Warning

 

Settings

First fill in the settings:

 

Download assignment details of all courses you specify

You can find Course SIS IDs:

  • by navigating to a course, view the course Settings page and see the SIS ID as described in How do I use course settings? 
  • by creating a provisioning report (admin rights needed) of courses in a (sub)account for a single term or all terms as described in How do I view reports for an account? Open the downloaded csv and copy the Course SIS IDs from the column sis_course_code.

 

In column A under sis_course_code you can enter a list of Course SIS IDs of which you want to receive details of the assignments:

 

Download list of assignment details from course list

The list of Course SIS IDs must be a consecutive list and also be part of the table which starts in cell A5.

 

When you have entered your list of Course SIS IDs to the first column, click Download data from Canvas to start the download progress. Any remaining data in the table from a previous run will be deleted from the sheet and any duplicates in the list of course SIS ID's will be deleted. The button Clear worksheet does the same regarding cleaning up the worksheet. It takes an average of one second per course to download the data. Clicking the Download data from Canvas button again before all the data has been downloaded will ask you if you want to abort the download.

 

Versions history:

  • 1.0 (18 April 2019)
    • Initial version
  • 1.1 (3 May 2019)
    • Bug fixed: limit of 10 assignments per course removed (correct api pagination applied)
  • 1.2 (13 May 2019)
    • Bug fixed: mixed date formats (mm dd yyyy versus dd mm yyyy) based on localisation where month and day could be in reversed order
    • Improved handling of dates and times, e.g. added functionality where in case multiple due dates and times assignment are stored in once cell as an array of values (to preserve the possibility for filtering and calculations). These are displayed in magenta.
    • In case multiple submission types are set for an assignment, both will be displayed in one cell and displayed in magenta
    • Added the count of rubric settings and rubric criteria

 

Remarks

  • Disclaimer: use this workbook at your own risk (I cannot be held responsible for any undesired consequences). This Excel workbook only reads from Canvas AND never writes to Canvas. It should not have any negative effect on Canvas in terms of integrity or performance.
  • First try it on your test environment https://yourinstitution.test.instructure.com (slow performance is expected and may cause time-out errors) before using it on production
  • Always check the results in Canvas or in case your student(s) get accounted for their activities in groups as Canvas is the most reliable source
  • Suggestion: save the workbook as a template (xltm file) after entering the settings so you can always start with a fresh and clean workbook so you will be prompted to save it. Keep in mind that if you don't save the file in a macro-enabled workbook format (xlsm), running the report again will not work any more as it requires the macro functionality to run.
  • I created this workbook largely in my own spare time (for fun, to learn, to help, to share and because I can), so huge amounts of support can't be expected
  • Leave your comments in case you are using it, if it makes your work easier or more fun

Outcomes