Canvas LMS Connector 

This section of the user guide is focused on the Canvas Connector. To help you navigate the article we have broken it down into the following sections:

• What is the Canvas Connector?
• Who has access to set up the Canvas Connector?
• How do I set up the Canvas Connector?
  • Complete the Sales Process 
  • Configure the Canvas Connector
• What questions can Canvas for Virtual Assistant answer?

What is the Canvas Connector?

The Canvas Connector tool enables students to receive answers to specific questions directly from their LMS, streamlining the learning process. By empowering students to proactively engage with the platform, the Virtual Assistant fosters academic success without requiring staff intervention. 

Who has access to set up the Canvas Connector?

The Canvas Connector feature is available to individuals with the following permissions: 

	Administrative	Standard	Limited	View Other Offices
Set Up Connector

For more information on user permissions, review the User Roles & Permissions article.

How do I set up the Canvas Connector?

Complete the Sales Process 

To initiate the sales process you can complete the steps below, or contact your CSM or sales representative you already have a relationship with.

1. In the Ocelot Admin Portal, under Connectors, select Applications.
   

1.  On the Canvas card select Contact Sales

b. Complete the Contact Form and complete the sales process. Once complete, the Canvas Connector will be enabled. 

Configure the Canvas Connector

1.  On the Connectors page, in the Canvas card, select Configure

2. Login to Canvas and create a developer API key

Note: A walk through can be found at How do I add a developer API key for an account?

 A minimally working API should look like the below screenshot. Be sure NOT to enable Enforce Scopes
The Redirect URI can be found in the admin Connectors > Applications > Canvas > Redirect URI

3. From within Canvas under Developer Keys

1. Enable the API key 
2. Take note of the Secret Key. You will use it in Step 5. 

4. Under Canvas Base Url, Enter the base URL you use to access Canvas 

5. Under Client Secret copy/paste the Secret Key from Step 3.

6. Select the SSO provider students will use to authenticate under SSO Authentication Provider

For more information on setting up an authentication provider, review the Adding an Authentication Provider for Live Assistant and SIS Connector article

7. Save the configuration by selecting Save

8. Select Authorize. Once authorized, you'll be prompted to log in to Canvas. After logging in, you'll be redirected to the Client Admin.

9. Select Test Connection. You should receive a message stating that the connection is stable. 

10. Under LMS settings, select the API account

What questions can Canvas for Virtual Assistant answer?

Once the Canvas for virtual assistant connector has been enabled and configured, it will prompt the student to authenticate in order to provide an integrated individual response if one of the following questions are asked:

1. What is my current grade in ‘x’? (e.g. What is my current grade in  BIOL 101?)
   
   

2. Do I have an assignment due?
   
   

NOTE: Be sure to add the questions above as custom questions. For more information on custom questions, review the Creating and Editing a Knowledge Base Question