Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-78132

Improve the workflow for creating badge backpack

    XMLWordPrintable

Details

    • MOODLE_403_STABLE
    • MOODLE_403_STABLE
    • MDL-78132-master
    • Hide

      Requirements

      1. Run your site with public access and HTTPS (use ngrok or similar).
      2. Outgoing server configured (mailcacher or similar).
      3. One account on https://badgr.com/
      4. Two accounts on https://eu.badgr.com/  
      5. Valid IMS account to access https://certification.imsglobal.org/certification/badgeconnect/launch.html

      Setup

      1. Login as admin.
      2. Edit the user profile and set the Moodle email to match the email used in the Badgr.com account.
      3. Create another user (s1) and set the Moodle email to match the email for one of the eu.badgr.com accounts.
      4. Create the “badgeuser1” user:
        • Username: badgeuser1
        • First name: Badge User1
        • Surname: IMS
        • Email: badgeuser1@imsglobal.org  
      5. Create a badge, publish it and award it to the admin, s1 and badgeuser1 users.
      6. Logout (to guarantee the email is updated properly in the $USER var).

      Testing scenario 1. Badgr (using OBv2.1)

      1. Login as admin.
      2. Go to "Site administration > Badges > Manage backpacks".
      3. Create a new backpack with the following information:
        • API version supported: Open Badges v2.1
        • Backpack URL: https://badgr.com
        • Check "Backpack API URL" is not displayed in the form when Open Badges v2.1 is selected.
      4. Go to "Site administration > Server > OAuth 2 services".
      5. Check a new OAuth service "Canvas Badges" has been created.
      6. Go to the Configure endpoints page for this issuer.
      7. Check "apiBase" is one of the endpoints displayed.
      8. Go to the user preferences page.
      9. Access to "Backpack settings".
      10. Select "https://badgr.com" from the list and connect using the user account in Badgr.com.
      11. Go to the user profile page and access the badge you've been awarded.
      12. Click the "Add to backpack" button.
      13. Check the message "Added badge to backpack " is displayed.

       

      Testing scenario 2. Badgr (using OBv2.0)

      1. Login as admin.
      2. Go to "Site administration > Badges > Manage backpacks".
      3. Create a new backpack with the following information:
        • API version supported: Open Badges v2.0
        • Backpack URL: https://eu.badgr.com/
        • Backpack API URL: https://api.eu.badgr.io/v2 
        • Check "Include authentication details with the backpack"
        • Badge issuer email address: the email of the other user account in eu.badgr.com
        • Badge issuer password: password for the previous user
      4. Click the "Test settings" icon near the delete one.
      5. Check the "Backpack connection successfully established" message is displayed.
      6. Login as s1.
      7. Go to the user preferences page.
      8. Access to "Backpack settings".
      9. Select "https://eu.badgr.com/" from the list and connect using the user account in Badgr.com.
      10. Open the verification email and open the URL to validate the account.
      11. Confirm status is set to Connected.
      12. Go to the user profile page and access the badge you've been awarded.
      13. Click the "Add to backpack" button.
      14. Check the message "Added badge to backpack " is displayed.

       

      Testing scenario 3. IMS Global

      IMPORTANT: If at any point you need to restart the process, you’ll need to click the “Restart Testing” button and logout and login the admin user. Apart from that, you'll also need to remove the oAuth service and the backpack (before creating them again).

      NOTE: If you haven't a valid IMS account, ping me (Sara) and I'll restart the process on your behalf and will share with you the results

       

      1. Access to using a valid IMS account: https://certification.imsglobal.org/certification/badgeconnect/launch.html 
      2. Read the information and press the “Get Started” button.
      3. Review your information (name, email address and organization) and “Confirm” it.
      4. Select the Moodle version (for the master branch you can select 4.2).
      5. Select the “Service Consumer (Write)”, which is the one implemented by Moodle.
      6. Read the testing instructions and save the information (some data will be used later, such as the base API URL or the password for badgeuser1).
      7. Click the “Done” button and keep the “Auto-registration” window open, to confirm the certification process is working as expected.
      8. Login as admin to your Moodle site.
      9. Go to "Site administration > Badges > Manage backpacks".
      10. Create a new backpack with the following information:
      11. Go to "Site administration > Server > OAuth 2 services".
      12. In the “IMS Global Badge Connect Validator“ tab, check that “Get manifest” and “Do Auto-Registration” have been executed.
      13. Check a new OAuth service "1EdTech Badge Host" has been created.
      14. Go to the Configure endpoints page for this issuer.
      15. Check "apiBase" is one of the endpoints displayed.
      16. Login as badgeuser1
      17. Go to the user preferences page.
      18. Access to "Backpack settings".
      19. Select "https://certification.imsglobal.org/badgeconnect" from the list and click the “Connect to backpack” button. You should be redirected to the login page for the IMS Global backpack service.
      20. Use the credentials for badgeuser1 defined in the “IMS Global Badge Connect Validator” page (right now they are “badgeuser1” / “user1rocks”). You can use the username instead of email.
      21. Accept the terms and conditions displayed.
      22. Check " Backpack is connected" is displayed.
      23. In the “IMS Global Badge Connect Validator“ tab, check that “Do Authorization Grant” and “Retrieve OAuth2 Token” have been executed too.
      Show
      Requirements Run your site with public access and HTTPS (use ngrok or similar). Outgoing server configured (mailcacher or similar). One account on https://badgr.com/ Two accounts on https://eu.badgr.com/   Valid IMS account to access  https://certification.imsglobal.org/certification/badgeconnect/launch.html Setup Login as admin. Edit the user profile and set the Moodle email to match the email used in the Badgr.com account. Create another user (s1) and set the Moodle email to match the email for one of the eu.badgr.com accounts. Create the “badgeuser1” user: Username: badgeuser1 First name: Badge User1 Surname: IMS Email: badgeuser1@imsglobal.org   Create a badge, publish it and award it to the admin, s1 and badgeuser1 users. Logout (to guarantee the email is updated properly in the $USER var). Testing scenario 1. Badgr (using OBv2.1) Login as admin. Go to "Site administration > Badges > Manage backpacks". Create a new backpack with the following information: API version supported: Open Badges v2.1 Backpack URL:  https://badgr.com Check "Backpack API URL" is not displayed in the form when Open Badges v2.1 is selected. Go to "Site administration > Server > OAuth 2 services". Check a new OAuth service "Canvas Badges" has been created. Go to the Configure endpoints page for this issuer. Check "apiBase" is one of the endpoints displayed. Go to the user preferences page. Access to "Backpack settings". Select "https://badgr.com" from the list and connect using the user account in Badgr.com. Go to the user profile page and access the badge you've been awarded. Click the "Add to backpack" button. Check  the message "Added badge to backpack " is displayed.   Testing scenario 2. Badgr (using OBv2.0) Login as admin. Go to "Site administration > Badges > Manage backpacks". Create a new backpack with the following information: API version supported: Open Badges v2.0 Backpack URL: https://eu.badgr.com/ Backpack API URL: https://api.eu.badgr.io/v2   Check "Include authentication details with the backpack" Badge issuer email address: the email of the other user account in eu.badgr.com Badge issuer password: password for the previous user Click the "Test settings" icon near the delete one. Check the "Backpack connection successfully established" message is displayed. Login as s1. Go to the user preferences page. Access to "Backpack settings". Select "https://eu.badgr.com/" from the list and connect using the user account in Badgr.com. Open the verification email and open the URL to validate the account. Confirm  status is set to Connected. Go to the user profile page and access the badge you've been awarded. Click the "Add to backpack" button. Check  the message "Added badge to backpack " is displayed.   Testing scenario 3. IMS Global IMPORTANT : If at any point you need to restart the process, you’ll need to click the “Restart Testing” button and logout and login the admin user. Apart from that, you'll also need to remove the oAuth service and the backpack (before creating them again). NOTE : If you haven't a valid IMS account, ping me (Sara) and I'll restart the process on your behalf and will share with you the results   Access to using a valid IMS account:  https://certification.imsglobal.org/certification/badgeconnect/launch.html   Read the information and press the “Get Started” button. Review your information (name, email address and organization) and “Confirm” it. Select the Moodle version (for the master branch you can select 4.2). Select the “Service Consumer (Write)”, which is the one implemented by Moodle. Read the testing instructions and save the information (some data will be used later, such as the base API URL or the password for badgeuser1). Click the “Done” button and keep the “Auto-registration” window open, to confirm the certification process is working as expected. Login as admin to your Moodle site. Go to "Site administration > Badges > Manage backpacks". Create a new backpack with the following information: API version supported: Open Badges v2.1 Backpack URL: https://certification.imsglobal.org/badgeconnect   Go to "Site administration > Server > OAuth 2 services". In the “IMS Global Badge Connect Validator“ tab,  check  that “Get manifest” and “Do Auto-Registration” have been executed. Check a new OAuth service "1EdTech Badge Host" has been created. Go to the Configure endpoints page for this issuer. Check "apiBase" is one of the endpoints displayed. Login as badgeuser1 Go to the user preferences page. Access to "Backpack settings". Select "https://certification.imsglobal.org/badgeconnect" from the list and click the “Connect to backpack” button. You should be redirected to the login page for the IMS Global backpack service. Use the credentials for badgeuser1 defined in the “IMS Global Badge Connect Validator” page (right now they are “badgeuser1” / “user1rocks”). You can use the username instead of email. Accept the terms and conditions displayed. Check  " Backpack is connected" is displayed. In the “IMS Global Badge Connect Validator“ tab,  check  that “Do Authorization Grant” and “Retrieve OAuth2 Token” have been executed too.
    • HQ 2023 Planning i2 Moppies

    Description

      In MDL-75552 it was identified that the workflow to create a badge backpack could be improved, to skip oAuth service creation and automatically create it when a backpack is saved.

      This issue is to improve this workflow. Apart from this, the following changes need to be done:

      • Remove the "Open Badges" oAuth issuer button from the "OAuth Services" admin page. As they are created/updated when a backpack is saved, this button is not required anymore.
      • In the Manage backpacks form, when "API version supported" is set to "Open Badges v2.1":
        • Remove the "Backpack API URL" parameter because it's obtained from the .well-known/badgeconnect.json
        • Remove the "OAuth2 services" parameter because it's created on the fly each time the backpack is saved.

      Attachments

        Issue Links

          Activity

            People

              sarjona Sara Arjona (@sarjona)
              sarjona Sara Arjona (@sarjona)
              Mikel Martín Corrales Mikel Martín Corrales
              Amaia Anabitarte Amaia Anabitarte
              Kim Jared Lucas Kim Jared Lucas
              Votes:
              0 Vote for this issue
              Watchers:
              8 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 2 days, 1 hour, 18 minutes
                  2d 1h 18m

                  Clockify

                    Error rendering 'clockify-timesheets-time-tracking-reports:timer-sidebar'. Please contact your Jira administrators.