Enterprise Portal: Set Up Your Canvas Integration

Before You Begin

In your LMS, publish the courses. Courses must be published before they can be synced in Examsoft.




Generate the Access Token

The Access Token is a unique identifier that allows our services to connect with your Canvas instance.

  1. Log in to your Canvas account.
  2. Select Account in the upper left-hand corner.
  3. Select Settings from the pop-out menu.


  4. Select the New Access Token button under Approved Integrations.


  5. In the Purpose field, enter: ExamSoft
  6. Leave the expiration field blank.


  7. Select Generate Token.
  8. Copy the value generated in the row that says Token to a separate document.

    Important: Once you close out of this window, you will not be able to access the token again. You can generate another token later, but we strongly recommend copying and pasting the token into a separate document for later reference.


Configure Your Portal 

  1. Navigate to the ExamSoft portal and log in as an Institution Admin.
  2. Select Admin
  3. Select Global Settings.

    Exam Soft - Frame 137.jpg

  4. Select LMS Settings.
    Exam Soft - Frame 138.jpg
  5. For LMS Type, select Canvas, and enter the configuration settings:
    • Canvas Instance URL: Enter the URL that you use to access your Canvas Instance.
    • Authorization Token: Paste the Access token that you copied in the previous section.

      Note: After you enter the token, the portal will confirm that the connection between the ExamSoft Portal and your Canvas instance is configured. If it is successful, a green check mark and Verified will appear and the remaining options are made available.

      Exam Soft - Frame 139.jpg



  6. Select the Configure button.
    Exam Soft - Frame 143.jpg 
    • Note: You will now see a Settings page. The following example shows what a completed configuration section looks like.

  7. Select the desired CourseSection& User ID Types from their respective drop-down menus.

    Note: These values are the elements from the Canvas environment that will end up being the User ID and Course ID within ExamSoft.

    Exam Soft - Frame 144.jpg

  8. Select the applicable Course Admin and Student Roles.

    Note: The value selected for Course Admin roles will dictate which Canvas users are synced to ExamSoft as admins. The value selected for Student roles will dictate which Canvas users are synced to ExamSoft as students.

  9. Select Save at the top of the screen.


Run the Sync Process

  1. Select Edit Sync Settings.
    Exam Soft - Frame 150.jpg
  2. If this is your first time visiting this page, select Refresh Courses to retrieve the list of the courses from Canvas.
    Note: Keep in mind that you are not yet syncing the courses, just retrieving the full list of courses from your Canvas instance. 
  3. Within the Select Courses tab, select the desired courses using the + icon to add them to the sync list.


  4. Select the Edit Sync List tab, and then adjust the start and end dates for courses, as needed.
  5. Select the department within the ExamSoft portal where you want them to be imported.

    Note: This step can be done in bulk. Select the checkboxes on the left, and use the bulk options that appear at the bottom of the screen.


  6. Select Save.


  7. Select Sync Now to manually sync.

    Exam Soft - Frame 148.jpg
    Note: If the sync is successful, you will receive a success message in the upper-right hand corner of the screen confirming your sync.

  8. (Optional) Select to automatically sync your courses at a pre-determined time daily, by enabling Auto Sync On/Off and entering your preferred time.
    Exam Soft - Frame 149.jpg

Verify the Import

  1. Select the ExamSoft logo in the top-left corner to navigate to My Departments.
  2. Select a department that was included in the sync list.


  3. Select the Course Name to open the imported courses.


  4. Select the Students menu (at the top), and verify that the roster has synced from Canvas.



Next Steps

If you do not see the data that was supposed to sync over, see: Enterprise Portal: LMS Sync Errors


Was this article helpful?
1 out of 1 found this helpful

Articles in this section