ABCDEFGHIJKLMNOPQ
1
Course Analysis Tool
2
The Course Analysis Tool is a Google spreadsheet that makes Canvas API calls to allow for a detailed analysis of a course's settings and configuration.

Copyright 2015 - Champlain College.
Credits and license at bottom of page.
3
4
Configure the tool
5
Admin: Configure the tool for your institution
6
In the Course Analysis Tool, you must modify a hidden tab.
Click on 'All Sheets' (bottom left tab) to unhide the 'Lists' sheet. You can hide it again after you enter the information.
7
Lists tab:Fill out the appropriate URL for your institution. Optionally, fill out the sub-account IDs and TermIDs to allow the drop down menus to function correctly. This is designed so that you can select the sub-accounts and terms relevant to you, so you may choose to use an abbreviated list. Remember, searching for a sub-account will reveal courses in all child sub-accounts as well.
8
>> At this point you may make copies of the spreadsheet for everyone who will use it in your institution/group. Each user must enter their own individual credential as instructed below.
9
10
Each user: Generate and enter Canvas Access Tokenhttp://guides.instructure.com/m/4214/l/40399-how-do-i-obtain-an-api-access-token
11
In the Course Analysis Tool, you must modify a hidden tab.
Click on 'All Sheets' (bottom left tab) to unhide 'Credentials' sheet. You should hide it again after you enter the information.
12
 In Canvas > Settings > Access tokenIn Canvas > Settings, each user should generate their own Access Token and set an expiration date for security.
13
In Course Analysis tool > Credentials tab:Click the arrow between rows 2 and 3 in the Credentials tab to unhide the cell and paste the Access Token string. Make sure you place this in B2.
14
! Security alert: The Access Token grants access to Canvas data. Do not share your token or your copy of this spreadsheet.
15
16
Settings and selecting the course to analyze
17
Before you begin checking courses, set the dates for that term and search termsThese steps are optional, but are needed for the date checker and search feature to work
18
If the course includes the week number in assignment and/or module names (i.e. "Week 1," Week 2,") the tool can check if an assignment is within the date range for that week. Click on the Dates tab and set the start and end dates for each week of the applicable term in this format: MM/DD/YYYY
19
You can also add terms to search in course content, for example the name of a previous instructor. Click on the Search tab and add terms your want to search for (case insensitive but do not add extra spaces at end of words). One term per line.
20
21
Select your course
22
You can use the dropdowns or type the Canvas Course ID manually:
23
AccountSelect from dropdown, then Repopulate SELECTION sheet.
24
TermSelect from dropdown, then Repopulate SELECTION sheet.
25
Course NameSelect from dropdown, then Repopulate SELECTION sheet.
26
Course IDWhen you select above, the Course ID is generated here. Or leave the previous three blank and paste the Course ID here.
27
28
Use the tool to check your course
29
Pull data on your course using Wipe and Repopulate
30
Once you have set everything up, this is the main action to tell the tool to return information about the course you've selected. It may take a few moments.
31
Wipe > 'Start from scratch' or 'Clear sheet'Clears all or current course data (Assignments through Folders tabs). Use this to clear old course data and begin again.
32
Repopulate > 'All' or choose sheetGenerates the data for all or single sheets based on SELECTION course. This is the main action.
33
34
Use Check menu for URLs, Assignment Dates and Search
35
Check > Links & SearchFor Assignments, Pages, Discussions sheets, checks URLs and looks for search terms on those pages in Canvas. This can take a few moments. If the operation times out, run it again and it will pick up where it left off.
36
Check > DatesFor Assignments, checks if date is within date range set for that week in Dates tab and colors the cell to indicate the information below:If the name of the assignment does not start with "Week #" but the module it is contained in does, then the Modules sheet must be populated before checking dates
37
Colors returned by Check > DatesDate is on last day of that week
38
Date is within that week but not on the last day
39
Date is outside of that week
40
41
Dates
42
After the Repopulating the Assignments tab, select Check > Dates. If you return to the course and correct dates, Wipe and Repopulate the Assignments tab again and Check > Dates again.
43
44
Files and Folders
45
Folders sheet must be populated to fill File sheet. If hidden is 'TRUE' and lock is 'FALSE' then: "Let students download or view files if I
46
link to them, just don't show it in the file listing for students" was chosen as the option
47
48
If lock is 'TRUE' then: "Lock until I manually unlock it" was chosen
49
50
51
Copyright
52
Copyright 2015 Champlain College
53
Licensed under the Apache License, Version 2.0 (the "License");
54
you may not use this file except in compliance with the License.
55
You may obtain a copy of the License at
56
http://www.apache.org/licenses/LICENSE-2.0
57
Unless required by applicable law or agreed to in writing, software
58
distributed under the License is distributed on an "AS IS" BASIS,
59
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
60
See the License for the specific language governing permissions and
61
limitations under the License.
62
All scripts in this spreadsheet are covered by this copyright
63
64
Developed by Carl Chaffatt and Josh Blumberg for Champlain College
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100