Difference between revisions of "Canvas Sync"

From Studentnet Wiki
Jump to navigation Jump to search
Line 10: Line 10:
 
**Relationships: Create an Observer Link between Parent and Student. Note: The observer links are visible only after the Student has been enrolled on a course
 
**Relationships: Create an Observer Link between Parent and Student. Note: The observer links are visible only after the Student has been enrolled on a course
  
 +
===In your Canvas Instructure:===
 +
#In '''Global Navigation''', click the '''Admin''' link and select the account
 +
#On the '''Account Navigation Panel''', click on the '''Developer Keys''' > Add '''Developer Key''' > '''API Key'''
 +
#On Key Settings-required fields:
 +
#:'''Key Name''': Cloudwork
 +
#:'''Redirect URIs''': <Cloudwork URL>/canvas/authorize
 +
#::'''Example''': https://demo-login.cloudworkengine.net/canvas/authorize
 +
#Once set up, switch ON the state of the developer key. Both Client ID and Secret Key will be listed under Details
  
This allows for syncing with a Canvas site. Only the URL is required and this is for class and user provisioning in Canvas rather than Canvas single sign on.
+
===Back in Cloudwork Canvas Settings:===
 +
#Enter all details and submit: '''Canvas URL''', '''Canvas Client Id''' and '''Canvas Secret'''
 +
#After clicking on Submit, it will redirect you to the canvas site to authorise.  
 +
#Once authorized, it will redirect to your Cloudwork Canvas Settings and you should see an Authentication success message.
 +
#Connect Account to finalize setup. Select the Canvas Account to be synced with Cloudworks and enable Sync Accounts.
 +
#Submit to save changes.
  
An example of the form for Canvas syncing can be found below
 
 
[[File:canvas_sync.png]]
 
  
 
[[Category:Cloudwork Dashboard]]
 
[[Category:Cloudwork Dashboard]]

Revision as of 07:48, 7 August 2023

Canvas Sync

What information will be synced from Cloudworks into Canvas

  • Parents and Student will be synced
  • For users, the following information from users will be synced
    • Full Name
    • Default Email
    • Username
    • SIS ID
    • Relationships: Create an Observer Link between Parent and Student. Note: The observer links are visible only after the Student has been enrolled on a course

In your Canvas Instructure:

  1. In Global Navigation, click the Admin link and select the account
  2. On the Account Navigation Panel, click on the Developer Keys > Add Developer Key > API Key
  3. On Key Settings-required fields:
    Key Name: Cloudwork
    Redirect URIs: <Cloudwork URL>/canvas/authorize
    Example: https://demo-login.cloudworkengine.net/canvas/authorize
  4. Once set up, switch ON the state of the developer key. Both Client ID and Secret Key will be listed under Details

Back in Cloudwork Canvas Settings:

  1. Enter all details and submit: Canvas URL, Canvas Client Id and Canvas Secret
  2. After clicking on Submit, it will redirect you to the canvas site to authorise.
  3. Once authorized, it will redirect to your Cloudwork Canvas Settings and you should see an Authentication success message.
  4. Connect Account to finalize setup. Select the Canvas Account to be synced with Cloudworks and enable Sync Accounts.
  5. Submit to save changes.