Handleiding koppeling Canvas - Edubadges voor de instelling

Omschrijving

Met de LTI functionaliteit kunnen gebruikers in een (Canvas-)LMS gebruikmaken van het edubadges systeem.

Na toevoegen van de edubadges LTI functionaliteit in het LMS kunnen leerkrachten:

  • Badgeclasses aanmaken
  • Badgeclasses toekennen aan een cursus /module in het LMS
  • eduBadges uitdelen aan studenten die de cursus met succes hebben afgerond

Studenten kunnen:

  • Zien welke eduBadge(s) beschikbaar zijn voor de cursus/module
  • eduBadges aan vragen
  • De status van hun eduBadge zien:
    1. aangevraagd (requested)
    2. toegekend (awarded)
    3. niet toegekend (denied)

Configuratie in Canvas door de instellings Canvas Admin

Voordat je een koppeling kunt maken tussen de Canvas server van een instelling en edubadges, zal de instelling eerst een aantal zaken moeten configureren in Canvas.
De Canvas admin moet dan een developer key genereren en een externe app toevoegen.

Stap 1. Toevoegen van een developer key

NOTE: In order to create an LTI Key, 'Developer Keys - Manage' and 'LTI - add/edit/delete' permissions are required. Contact your account admin about setting up an LTI Developer Key if permissions are not met.

  • Menu Admin → Kies het account waaronder de keys worden gemaakt (Site Admin) → kies Developer Keys. Een overzicht van de bestaande keys wordt getoond.


    • Vink bij de LTI Advantage Services alle opties aan:


    • Voeg bij de Additional Settings, bij de Custom fields, de volgende key-value pairs toe:
      cce=$Canvas.course.endAt
      ccn=$Canvas.course.name
      ccs=$Canvas.course.startAt
      ccw=$Canvas.course.workflowState
      ces=$Canvas.enrollment.enrollmentState
      ctn=$Canvas.term.name



    • Zet bij de Additional Settings de Privacy Level op PUBLIC

    • Selecteer bij de Additional Settings, Placements alleen de optie: Course Navigation



  • Sla de ingevoerde data op en zet dan de nieuwe key aan:


  • Noteer de Key-ID: 10000000000005
    Deze wordt doorgegeven aan de beheerders van edubadges.


Stap 2. Voeg edubadges als App aan de Course(s) toe

  • Per course dient een koppeling met edubadges gemaakt te worden.
    Selecteer een Course → Settings → Tabblad Apps → Voeg een nieuwe App toe via de button.



  • Selecteer bij Configuration Type de optie 'By Client ID' en voer de Client ID van de LTI Key in stap 1 in  (10000000000005)


  • Je krijgt dan als het goed is een bevestiging om de App Edubadges DEMO toe te voegen. Klik hier op Install

  • Een nieuwe Externe App getiteld 'Edubadges DEMO' zal verschijnen.
    Klik op het tandwiel icoon rechts van de Externe App en klik op 'Deployment Id'.
    Net als bij de Client ID, sla de deployment Id ergens veilig op, aangezien zowel de Client ID als de Deployment ID nodig zullen zijn.

Stap 3. Geef de volgende informatie door aan support@edubadges.nl

  1. Het Key-ID uit stap 1 → vb: 10000000000005
  2. Het Deployment ID van de toegevoegde App uit de vorige stap.
  3. Issuer: <This will usually look something like 'http://example.com'. Value provided by LTI 1.3 Platform> → vb: canvas.edubadges.nl
  4. Auth login url: <The platform's OIDC login endpoint. Value provided by LTI 1.3 Platform> → vb: https://canvas.edubadges.nl/api/lti/authorize_redirect
  5. Auth token url: <The platform's service authorization endpoint. Value provided by LTI 1.3 Platform> → vb: https://canvas.edubadges.nl/login/oauth2/token
  6. Key set url: <The platform's JWKS endpoint. Value provided by LTI 1.3 Platform> → vb: https://canvas.edubadges.nl/api/lti/security/jwks


Guide to linking Canvas - Edubadges for the institution

Description

The LTI functionality allows users in a (Canvas) LMS to use the eduBadges system.

After adding the edubadges LTI functionality in the LMS, teachers can:

  • Single signon to the eduBadges issuerportal
  • Create badgeclasses
  • Assign a badgeclass to a course / module in the LMS
  • Distribute eduBadges to students who have successfully completed the course

Students can:

  • See which eduBadge(s) are available for the course/module
  • Request edubadges
  • See the status of their eduBadge:
    • requested
    • awarded
    • not awarded (denied)

Configuration in Canvas by the institution Canvas Admin

Before you can create a link between an institution's Canvas server and edubadges, the institution will need to configure a few things in Canvas.
The Canvas admin will need to generate a developer key and add an external app.

Step 1. Add a developer key

NOTE: In order to create an LTI Key, 'Developer Keys - Manage' and 'LTI - add/edit/delete' permissions are required. Contact your account admin about setting up an LTI Developer Key if permissions are not met.

  • Menu Admin → Choose the account under which the keys are created (Site Admin) → choose Developer Keys. An overview of the existing keys is displayed.


    • Tick all options for the LTI Advantage Services:


    • In the Additional Settings, under Custom fields, add the following key-value pairs:
      cce=$Canvas.course.endAt
      ccn=$Canvas.course.name
      ccs=$Canvas.course.startAt
      ccw=$Canvas.course.workflowState
      ces=$Canvas.enrollment.enrollmentState
      ctn=$Canvas.term.name



    • In the Additional Settings, set the Privacy Level to PUBLIC

    • In the Additional Settings, Placements, select only the option: Course Navigation



  • Save the entered data and then turn on the new key:


  • Note the Key-ID: 10000000000005
    This is passed on to the edubadges administrators.


 Step 2. Add edubadges as App to the course(s)

  • A link with edubadges must be made for each course.
  • Select a Course → Settings → Apps tab → Add a new App using the button.



  • Under Configuration Type, select the option 'By Client ID' and enter the Client ID of the LTI Key in step 1 (1000000005).


  • You should then receive a confirmation to add the Edubadges DEMO app. Click here on Install

  • A new External App entitled 'Edubadges DEMO' will appear.
    Click on the cog icon to the right of the External App and click on 'Deployment Id'.
    As with the Client ID, save the Deployment Id somewhere safe as both the Client ID and Deployment ID will be required.


Step 3. Please provide the following information to support@edubadges.nl

  1. The Key-ID uit stap 1 → vb: 10000000000005
  2. The Deployment ID of the added App from the previous step.
  3. Issuer: <This will usually look something like 'http://example.com'. Value provided by LTI 1.3 Platform> → vb: canvas.edubadges.nl
  4. Auth login url: <The platform's OIDC login endpoint. Value provided by LTI 1.3 Platform> → vb: https://canvas.edubadges.nl/api/lti/authorize_redirect
  5. Auth token url: <The platform's service authorization endpoint. Value provided by LTI 1.3 Platform> → vb: https://canvas.edubadges.nl/login/oauth2/token
  6. Key set url: <The platform's JWKS endpoint. Value provided by LTI 1.3 Platform> → vb: https://canvas.edubadges.nl/api/lti/security/jwks




  • No labels