Canvas: Setup Roster Sync

Configure the Integration Details

1. Select the Configure button.

   

2. On this screen, you will select different values from Canvas to pass to ExamSoft.

   

   • Course ID Type: Course value from Canvas which will be passed into ExamSoft as the Course ID.
   • External ID Type: User value from Canvas which will be passed into ExamSoft as the External ID. Note: Only applicable to clients using our SAML integration.
   • User ID Type: User value from Canvas which will be passed into ExamSoft as the Student ID.
3. In the bottom section, select student roles from Canvas to include in the sync to ExamSoft.
   1. With the ‘Student’ role selected, you may not need to make additional adjustments.

   2. If you want to add an additional role, click on the + Add a student role button.

      

4. For any additional role, select the checkbox for each role. Confirm your selection with the Save button.

   

5. With all selections confirmed, select the Save button on the Configure page.

   

Edit the Course Sync List

1. Select the Edit Courses button.

   

2. To add courses to the sync list, select Import Courses.

   

3. With the modal window open, drag and drop a file into the tool or select the Choose File button to choose one using the file picker. This will query Canvas for the courses contained in your XLS/XLSX file.

   

   • Import Type: Choose Add, Remove, or Replace depending on the behavior you want
     1. Add: Adds new courses to the list and leaves any existing courses on the sync list intact
     2. Remove: Removes courses from the sync list based on the course IDs in the file
     3. Replace: Removes all courses from the sync list and replaces them with only the courses from the file
   • Download Template: Provides an example advising how to format your import file

   Note: Using the drag and drop method will automatically process the file. Using the file picker requires you to select the Upload button once you’re ready to import your course file into the tool.

   

4. After closing the modal window, the Course Sync List with the course(s) you added will display in the table.

   

5. Add a Start Date, End Date, and Department Name to each course. 
   Note: All three values are required for a course to sync to the ExamSoft system.

   

6. Once you’re done, click the Close button.

Syncing Courses

1. With your courses added to the Course Sync List, you can sync them into your ExamSoft portal with the Sync Now button.

   

2. To schedule an automated daily sync, select the Edit Schedule button.

   

3. Toggle the Auto Sync either ON or OFF, and choose the specific time you’d like the sync to process. Click Save when you’re done.

   

Sync History

1. To view previous syncs and any errors, choose the View Sync History button.

   

2. The amount under the Successes or Failures columns are totals. To see the errors, choose a blue number under the Failures column.

   

3. Each button here will download a CSV file with detailed information on each failure.

   

4. Some errors may necessitate another sync, but others can be cleared by fixing specific data.