This article is for instructors who want to set up and manage Canvas and Courseware Deep integration for their courses. In addition to single sign-on functionality, the benefit of Deep integration is it will automatically sync selected assignments and grades with your Canvas gradebook. Read this article for more about Canvas and Courseware integration features.
Canvas administrator prerequisite steps
Canvas and Courseware Deep integration functionality requires the Lite integration be set up first. You will need to work with a Canvas administrator on a one-time setup process. See this article for what you will need. You can also schedule a call with Visible Body to help you set up your deep integration.
Do I have Canvas and Courseware integration already?
When you log in to Courseware, you will see an “LMS integration” menu item on the left navigation panel on your My Courses page.
Check the "Current Sync Status" in the "For Canvas" tab (pictured below).
If "Deep Integration" is indicated, you are already set up with a Canvas and Courseware Deep integration.
If "Lite Integration" is indicated, your Canvas administrator has not submitted their Developer Key to Visible Body, and the "Enable Deep Integration" button is disabled (pictured below). Your Canvas administrator will need to perform these one-time Deep integration steps, which include making a Developer Key.
Note: To proceed with Deep integration, if your Canvas and Courseware Lite integration was established before 12/1/21, you will need to delete and re-add your existing Lite integration. This will provide the updated configuration that enables opening assignments. You can use the same secret and key that you used the first time you established Lite integration. For help with this process, contact our support team.
If "Lite Integration; Dev Key Detected" is indicated, your Canvas administrator has submitted their Developer Key, and the "Enable Deep Integration" button is enabled (pictured below). When you select "Enable Deep Integration", you will be prompted to log in to Canvas to establish Deep Integration for the first time.
If "None" is indicated, please ask your Canvas administrator to follow the steps in this article. If your institution is a new Courseware customer or a Courseware customer with no Lite integration set up, Deep integration functionality requires the Lite integration be set up first. From there, your Canvas administrator will need to follow this one-time administrator developer key setup process for Deep integration.
My Canvas administrator set up the Developer Key for Deep integration. What's next?
Once your Canvas administrator has set up a Deep integration, you or your administrator will need to give one-time authorization to Canvas and enable Deep integration. See Step 3 in this article for more information. When you enable Deep integration, your LMS Integration page will appear, with the Deep Integration slider set to "On".
Navigate to the My Courses page, and you will see the Canvas Deep icon next to courses that are fully integrated with Canvas. It's easy to establish Canvas Deep integration for other courses in your My Courses page. Simply return to Canvas, and link your Canvas course to the appropriate Courseware course.
Within a course with Deep integration, you can also select individual assignments to deploy to Canvas. Select the "Deploy to Canvas" button under the Bulk Editing tool, then "Sync Assignments".
A "Sync Assignments" notification will inform you that your assignments are about to be synced between Courseware and Canvas. Note: To make these assignments visible to students in your Canvas course, be sure they are published in Courseware first.
Conversely, you can remove assignments from the sync option (pictured below) by deselecting them using the Bulk Editing tool.
- Select the assignments
- Select "Deploy to Canvas"
- Select "Remove Assignments" from the dropdown menu
Note: You can deploy individual assignments to Canvas as well. Open the assignment, and select the "Deploy to Canvas" button in the assignment page (pictured below). To confirm that an individual assignment is no longer synced, the "Deploy to Canvas" button will read "Remove from Canvas".
In Canvas, you will see all Courseware assignments you've synced, grouped the way you did in Courseware. You can always reorder them in Canvas to suit your needs; it won't break the integration for these assignments.
Canvas will automatically place ungrouped Courseware assignments in their own folder, "Visible Body Ungrouped Assignments"(pictured below).
Can I change back to my previous integration sync status?
You can change your Canvas sync status at any time.
- If you currently have a Deep integration and want to switch to Lite, you will not lose any grades in either system, but any subsequent scores from Visible Body will no longer be automatically reported to the Canvas gradebook. Simply switch the Deep Integration slider to the "off" position.
- If you currently have a Lite integration and want to switch to Deep, you can select which assignments to sync so that those scores will be automatically reported to the Canvas gradebook.
Find more information here about features of Canvas and Courseware Deep integration.