Connect Canvas LMS to your OneCampus instance.

Using the Connector tool, OneCampus Administrators can seamlessly connect Canvas to their OneCampus instance. Once the connection is authorized by the individual end users, their courses will display as tasks on the main OneCampus page.

IMPORTANT: Prior to following the configuration steps below, you will need to setup a Developer Key inside of Canvas and make sure to specify https://{your onecampus domain}/connectors/canvasConnectorCallback as the Redirect URIs.

Use the Canvas Connector

1. Begin by clicking the Advanced menu, then click Connectors.
2. On the Connectors page, click the Configure button next to Canvas Connector.
   
3. From the Configure Canvas Connector page, you can determine the status of the Canvas Connector by switching it on or off. For example, you may leave it off while you are finalizing your configurations and then turn it on when you are ready to go live with your end users. The default status is off.
   
4. Next, begin your configurations by entering your Canvas URL.
   
5. Enter your Canvas Client ID.
   • The Client ID comes from your developer keys within Canvas.
     • In your Canvas instance go to Admin>{your instance name}>Developer Keys.
     • The Client ID will be listed in the details column as “ID”.
     • Your Canvas Administrator should be able to give you this information.
6. Enter your Canvas Secret.
   • The Canvas Secret also comes from your developer keys within Canvas.
     • In your Canvas instance go to Admin>{your instance name}>Developer Keys.
     • The Client Secret will be listed in the details column as “Key”.
     • Your Canvas Administrator should be able to give you this information.
7. Indicate what you want the Oauth Redirect Modal Title to say.
   • This step controls the text that is displayed in the title of the modal window that informs the individual end users that they need to authorize the Canvas connection.
   • The default oauth redirect modal title is “Authorize OneCampus to Access Canvas”.
8. Indicate what you want the Oauth Message to say.
   • This step controls the text that is displayed within the modal window that informs the individual end users that they need to authorize the Canvas connection.
   • The default oauth message is “Canvas and OneCampus are now connected but you need to authorize the connection. Do you want to authorize the connection?”
     
     
     
9. Indicate what you want the Oauth Deauthorization Message to say.
   • This step controls the text that is displayed within the deauthorization modal window that informs the individual end users of what they are about to do should they click the deauthorize button located within their options button.
   • The default oauth deauthorization message is “Do you want deauthorize the connection? This will remove the section Canvas Connector from the store page but you can re-authorize in the Preferences panel if you change your mind.”
     
10. Next, customize the OneCampus Front Page Fields. Start by choosing a Title.
    • The title will be the header for the section where the Canvas courses appear on your OneCampus main page.
    • The default title is “Canvas Connector Tasks” but you can change this to whatever is appropriate.
      
11. Choose an Image Set to represent the Canvas tasks.
    • The image you choose will appear on the task tile for each Canvas course within OneCampus.
    • You may check the box that says “Use the Canvas Course image if one is available” and OneCampus will attempt to pull in any image that is associated with a course within Canvas. If there is no image associated with the course within Canvas, OneCampus will default to the image set you selected.
12. Choose a Task to associate with this Connector for Announcements. [Optional]
    • You may or may not already have a Canvas task set up in OneCampus. If you do, select it from the drop down. If you don't, you will need to create one and revisit this configurations page to associate it with this connector.
    • Please see additional instructions below for Adding announcements to the Canvas section.
13. Choose the area within Canvas that you want the Task Tiles to Link to. [Optional]
    • You have the option of selecting “Course Page”, “Course Announcements” or “Canvas Dashboard” from the drop down.
      • If "Canvas Dashboard" is selected, end users will be directed to the Canvas dashboard each time they click on a Canvas task.
      • If "Course Announcements" is selected, end users will be directed to the announcements section within Canvas.
      • If "Course Page" is selected, end users will land on the specific course details page within Canvas.
    • The default value for this drop down is “Course Page”.
14. Configure an ACL Expression/s. [Optional]
    • Leaving the ACL section empty will allow everyone access to the connector.
    • Administrators can add ACL expressions to restrict this connector to specific users. Only those identified users will see the connector authorization modal windows as well as see their courses pull through onto the OneCampus main page.
      • Select Or from ACL Expression drop down
      • Click the green [+] sign
      • Select Condition from Expression Type
      • Select a unique identifier from the Value dropdown
      • In the Is Equal To box, enter the data that matches the Value selected
      • Click Add
15. Click Save. (Once the configurations have been saved, and if the status switch described in step three is turned on, your end users will be presented with the Canvas Authorization modal window upon their next login).
    • You also have options to Cancel or Delete the configurations at this point.
      • Clicking cancel before clicking save will discard anything you entered, however, if an existing configuration had been saved previously, that saved configuration will NOT be changed OR discarded.
      • Clicking Delete will remove the configurations you have set up and disable the Canvas Connection.

Notes:

• Once an end user confirms that they want to authorize the Canvas Connection, they will be presented with a similar Canvas authorization modal window.
  
  
  • Clicking Authorize in this window is the final step and will cause their Canvas courses to appear as tasks on the main OneCampus page.
    
    
  • By default, Canvas tasks will appear at the bottom of the main OneCampus page. Administrators can change this by visiting the Main Page Layout module within the Branding Section. From the Main Page Layout screen, drag and drop the Canvas section to the desired location on the page.
• If an end user inadvertently dismisses the Canvas Authorization modal window, they can authorize the Canvas connection by clicking the “Authorize” button that is located within their Preferences section beneath the sign in drop down.
• If an end user clicks the gear image next to the Canvas Connector Tasks header they will be presented with options to “Deauthorize” their Canvas connection or change the display size of their Canvas task tiles.
  
  
• Please refer to the Quick Start Guide for the Connectors Error Log for additional information in regards to connector related errors that your end users might be receiving.
• Please refer to the Quick Start Guide for the Users Report for additional information in regards to how a OneCampus Administrator can deauthorize the Canvas Connector for a specific user.
  
  
• Be advised, if you do not specify https://{your onecampus domain}/connectors/canvasConnectorCallback as the Redirect URIs as advised at the beginning of this guide, your end users will encounter a similar Canvas error when attempting to authorize their connection.

Adding an Announcement to the Canvas tasks section

To add an Announcement to the Canvas Tasks section, please follow these steps:

1. You will first need to make sure that an actual task for Canvas (not a course task but an actual task for Canvas) exists in your tenant. If there isn't a Canvas task set up in your system currently you will need to make one.
2. Next, go to the Announcements module and create a task level announcement for that Canvas task. Please see the Quick Guide for Announcements for additional info on how to create an announcement.
3. Go to the Canvas configuration page, scroll to the bottom of the page and select the Canvas task from the drop down.
4. Click Save.

Once saved, you will see an announcement indicator next to the Canvas Tasks section on the main OneCampus page. If you click on any of your courses the announcement modal window will pop up.

• Canvas Connector - Quick Start Guide.pdf400 KB

Updated July 29, 2024 14:41