The Course Evaluations & Surveys User Integration with Instructure’s Canvas LMS has several components which allow students and instructors to seamlessly pass from Canvas into their Course Evaluations & Surveys account. As you get ready to kick off another round of evaluations on which you’ll want to get students’ feedback, we recommend upgrading your Canvas User Integration to make sure everything is optimal for a great experience, and you’re ready to achieve your response rate goals!
Upgrading the Canvas User Integration to the latest version carries over all the same functionality as the original version and there are no new features with the latest version, however, fewer external apps are deployed to Canvas with this latest version, enhancing the Canvas mobile experience while making ongoing management easier and more efficient.
The following provides further details on upgrading your Canvas User Integration between Course Evaluations & Surveys and Canvas.
How to identify the version of your Canvas User Integration
- In Course Evaluations & Surveys, navigate to Account > Integrations (section) > Canvas > User Settings tab.
- Under the Installation section, Step 1: Customize the CSS in Your Canvas, if you find a "v=x" (where x could be any number) at the end of your CSS code as shown in the example below, then you are on the original version of the Canvas User Integration. If you do not find a "v=x" at the end of your CSS code, then you are on the latest version of the Canvas User Integration and no further action is needed.
Step 1: Remove the current user integration from Canvas
NOTE
It is recommended you take a screenshot or note the User Integration Setup settings on the Canvas User Settings tab prior to completing the below steps, as some of the settings may need to be reset as a final step.- In Course Evaluations & Surveys, navigate to Account > Integrations (section) > Canvas > User Settings tab. Please take a screenshot or note the User Integration Setup settings on this tab.
- Under the Installation section, Step 3, click the Remove button. This will automatically remove Course Evaluations & Surveys External Apps and Course Evaluations & Surveys LTI links from your instance of Canvas.
Step 2: Create a Developer Key in Canvas
-
Log into your Canvas instance as a Canvas Administrator
-
Navigate to Admin > (select root level Canvas account) > Developer Keys
-
Click the + Developer Key button and choose + LTI Key
-
Key Name field = enter the name of your Developer Key (i.e. CE&S Canvas User integration)
-
Method = select Paste JSON
-
LTI 1.3 Configuration =
-
In Course Evaluations & Surveys logged in as a CES Administrator: go to Account > Integrations (column) > Canvas > User Settings tab and expand the Installation section at the top if not already expanded.
-
Select “Developer Key Install JSON” link (a secondary dialog will open)
-
Copy the entire JSON code, including beginning and ending brackets, then you may close the dialog
-
Canvas: in the Key Settings screen, paste the JSON code copied from your instance of CES into the LTI 1.3 Configuration field. NOTE: The Redirect URI is automatically filled once the JSON code has been correctly copied and pasted into the configuration field.
-
-
Click Save
-
(Returned to list of Developer Keys) Turn ON the Developer Key you created > click OK button in confirmation dialog
-
Under the Details column a ClientID is provided for your new Developer Key. Highlight and copy the ClientID
-
Course Evaluations & Surveys:
-
ClientID = paste the ClientID you copied from step 9
-
Step 3: Replace the existing Course Evaluations & Surveys code that is in your current Canvas CSS and Javascript files with the updated Course Evaluations & Surveys CSS and Javascript code
For institutions that use their OWN custom CSS and JS files, follow the steps below to ADD the Course Evaluations & Surveys code to your existing CSS and Javascript files:
- In Course Evaluations & Surveys, navigate to Account > Integrations (section) > Canvas > User Settings tab.
- Under the Installation section, Step 1, copy the CSS code and paste it into your CSS file that is uploaded to your Canvas theme.
- Next, under the Installation section, Step 2, copy the Javascript Code and paste it into your JS file.
- Ensure that the Course Evaluations & Surveys Javascript Code comes before all other content and comments in your Javascript file.
- Ensure that the Course Evaluations & Surveys Javascript Code comes before all other content and comments in your Javascript file.
- Confirm that the changes have been completed and saved within your CSS and JS files.
- Within Canvas, go to Admin and select your Canvas account.
- On the left-hand side of the page select Themes.
- Select Open in Theme Editor for your current theme under Themes.
- Make sure that the correct version of your global files have been updated within the Theme Editor.
NOTE: Once you make the update, preview Your Changes. If everything appears correct, select Save theme, Apply theme, and OK in the confirmation dialog.
- Within Course Evaluations & Surveys go back to Account > Integrations (section) > Canvas > User Settings tab. Under the Installation section, Step 3, click on Deploy so that Course Evaluations & Surveys can create and add the necessary External Tools within your Canvas instance – this is required for the Course Evaluations & Surveys User Integration.
- Within Canvas, go into Admin and choose your account again.
- To verify the LTI setup, in Canvas, click on Settings > Apps > View App Configurations, and you should now see the below External App. No further action is required here; this step is simply a verification:
NOTE: If setting up the integration at a Canvas subaccount level the same External App will appear.
- Within Course Evaluations & Surveys go back to Account > Integrations (section) > Canvas > User Settings tab, you can now configure your desired settings for the Automated LTI Links & Customized Survey Notification for Students under the User Integration Setup section.
For institutions that DO NOT use their OWN custom CSS and JS files, follow the steps below:
- In Course Evaluations & Surveys, navigate to Account > Integrations (section) > Canvas > User Settings tab.
- Create a new text document in a text editor application, i.e. Notepad or TextEdit.
- Next, under the Installation section on the User Settings tab, Step 1, copy the CSS Code in full and paste it into your CSS (Notepad or TextEdit) file.
- Open another new text document in Notepad or TextEdit for instance, and this time under the Installation section on the User Settings tab, Step 2, paste the JS code into your (Notepad or TextEdit) file.
Complete the following to save the CSS and JavaScript files:- In Notepad click on Save As and under Save as type select All Files, OR in TextEdit under the Format menu, select Make Plain Text.
- When saving your files, include the correct file extension (.css or .js) as seen in the examples above.
- Within Canvas, go to Admin and select your account.
- On the left-hand side of the page select Themes.
- Select Open in Theme Editor for your current theme under Themes.
- Click on Upload to select and upload your JS and CSS files respectively, as shown in the screenshots below.
- After the files are uploaded, Preview Your Changes.
NOTE: If you Preview Your Changes after uploading either the CSS or JS file, you will need to return to the Upload tab to upload the second file. - After verifying your changes, click Save theme, then Apply theme.
- When presented with the confirmation dialog window, click OK to confirm the changes and apply the changes to the entire account in Canvas. This will initialize the User Integration for Course Evaluations & Surveys.
- Within Course Evaluations & Surveys go back to Account > Integrations (section) > Canvas > User Settings tab. Under the Installation section, Step 3, click on Deploy so that Course Evaluations & Surveys can create and add the necessary External Tool within your Canvas instance – this is required for the Course Evaluations & Surveys User Integration.
- Within Canvas, go into Admin and choose your account again.
- To verify LTI setup, in Canvas, click on Settings > Apps > View App Configurations, and you should now see the below External App. No further action is required here; this step is simply a verification:
- Within Course Evaluations & Surveys under Account > Integrations (section) > Canvas > User Settings tab, you can now configure your desired settings for the Automated LTI Links & Customized Survey Notification for Students under the User Integration Setup section.
Re-Deploy or Remove the User Integration
- A Re-Deploy button will appear on the User Settings tab only IF the deployed Course Evaluations & Surveys External Tool has been removed in your Canvas instance, causing the settings to become out of sync with the integration, or changes have been made to the Token Primary Account option for the Canvas Web Service Token on the Canvas Integration > Data Settings tab in Course Evaluations & Surveys. Click Re-Deploy to re-install the Course Evaluations & Surveys User Integration in your Canvas instance. Once deployed, the required Course Evaluations & Surveys External App will be automatically re-added to your Canvas instance.
NOTE: If you Re-Deploy, you MAY need update both the .css and .js files in your Canvas instance with the CSS and JS code listed in Steps 1 & 2 above.
- To remove the External Tool added to Canvas after Deploying the integration, return to Account > Integrations (section) > Canvas > User Settings and click Remove to automatically remove the Course Evaluations & Surveys External App from your Canvas instance.
Now that you have completed the Canvas User Integration Setup, continue to the Canvas User Integration Settings article to configure the behavior and user experience of your Canvas User Integration.
