For the Canvas to PebblePad integration, the default username that is passed via the LTI connection can be changed to one of the following:



PebblePad Administration APICanvas JSON file (LTI)
Login_Id (Default)$Canvas.user.loginId
Email$Person.email.primary
Sis_user_id$Canvas.user.sisSourceId
Integration_Id$Canvas.user.sisIntegrationId


How to set-up


In PebblePad - login with a Global Administrator account:

  1. Open the burger menu, (top left, menu bar)
  2. Select Additional Settings and choose Administration
  3. Select the Integrations tab and choose the Canvas sub-tab 
  4. Change the Membership Username Parameter and choose the corresponding option from the table above. 
  5. Scroll to the bottom of the page and Save



In Canvas - login with an Administrator account:


  1. Choose Admin from the main menu
  2. Choose Developer Keys
  3. Select the Edit this key icon for the Developer Key you need to adjust.
  4. Choose Additional Settings
  5. In the Custom Fields area, adjust the custom_pebble_username
  6. Save changes




How to test

It's important to test both the LTI and the API routes to ensure duplicate accounts are not created.


LTI 

  1. Login into Canvas with a student account.
  2. Go to PebblePad via the course navigation or assignment link. 
  3. From the Pebble+, choose to open ATLAS from the top menu bar.
  4. In ATLAS, check the username in the top right-hand corner. 


API 

  1. Login into Canvas with an administrator account.
  2. Navigate to a (test) course.
  3. In People, check enrolled students are not in a pending state. 
  4. Follow the steps to add a new assignment. 
  5. When in ATLAS workspace click on Management > Members 
  6. Ensure the usernames have synched with the correct format.