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

Update grade sync task to support 1.3 messages

    XMLWordPrintable

    Details

    • Testing Instructions:
      Hide

      Prerequisites

      1. You'll need two Moodle sites running on localhost for this test - one designated 'platform', one 'tool'.
      2. A course called "Platform course 1", in the platform site with:
        • 5 Students: s1, s2, s3, s4, s5
        • 2 Teachers: t1 and t2
      3. A course called "Tool course 1" in the tool site with:
        • An assignment called "Assign 1" with a max grade of 80.
        • An assignment called "Assign 2" with default settings (max grade of 100)
        • A file resource (representing a non-graded activity)
        • A single teacher, t1, enrolled.
      4. A course called "Tool course 2" in the tool site with:
        • A single teacher t2 enrolled
      5. In the tool site admin settings:
        • Enable enrol_lti and auth_lti plugins
        • Enable "Allow frame embedding"

      Register the tool and platform

      Note: This is a shortened process of setting up the Moodle LTI Advantage Tool. If you've already set this up as part of another test, you can safely skip this section.

      1. On the tool site, go to Admin > Plugins > Enrolments > Publish as LTI tool > Tool registration
      2. Keep this page open, we'll need it shortly.
      3. On the platform site, go to 'Admin > Plugins > Activity modules > External tool > Manage tools'
      4. Click 'Configure a tool manually'
      5. Enter the following values:
        • In "Name" enter "Moodle LTI Advantage Tool"
        • Set 'LTI Version' to 1.3
        • Set public key type to 'Keyset URL'
        • In 'Tool URL', paste the value copied from "Tool URL" in the tool.
        • In 'Public keyset' paste the value copied from"JWKS URL" in the tool
        • In 'Initiate login URL', paste the value copied from "Initiate login URL" in the tool
        • In 'Redirection URI(s)' paste the value copied from BOTH "Tool URL" and "Deep linking URL" rows in the tool. Make sure each is on its own line.
        • Check 'Supports deep linking'
        • In 'Content selection URL', paste the value copied from "Deep linking URL" in the tool
        • Under "Services" set "IMS LTI Assignment and Grade Services" to "Use this service for grade sync and column management"
        • Under "Services" set "IMS LTI Names and Role Provisioning" to "Use this service to retrieve members' information as per privacy settings"
        • Set tools settings to "Do not use this service"
        • Set "Tool configuration usage" to "Show in activity chooser and as a preconfigured tool"
      6. Save the tool (you'll be taken to the manage tools page again)
      7. For the tool you just created, click "View configuration details"
      8. Copy these configuration details somewhere, or be ready to access them again.
      9. Now, switch back to the tool site
      10. Under "Registered platforms" click "Register a platform"
      11. Enter the following values:
        • Set "Platform name" to 'Moodle platform'
        • In "Platform Id (Issuer)" paste the value you copied from the "Platform ID" field in the configuration details
        • In "Client ID" paste the value you copied from the "Client ID" field in the configuration details
        • In "Authentication request URL" paste the value you copied from "Authentication request URL" in the configuration details
        • In "Public keyset URL" paste the value you copied from "Public keyset URL" in the configuration details
        • In "Access token URL" paste the value you copied from "Access token URL" in the configuration details
      12. Save changes
      13. Click "Manage deployments" next to the registration you just created
      14. Click "Add a deployment"
      15. Set the following values:
        • In "Name" enter "Site wide deployment"
        • In "Deployment Id" paste the value you copied from "Deployment Id" in the the configuration details
      16. Save the deployment
      17. Log out of both tool and platform.

      Publish activities and set up platform resource links

      1. Log in to the tool site as t1
      2. Click "Published as LTI Tools" in course setting
      3. Click "Add new"
      4. Publish the "Assign 1" resource, using all default settings (this ensures membersync is enabled)
      5. Repeat the process and publish the "Assign 2" resource
      6. Repeat the process and publish the "Tool Course 1" resource
      7. Now log out of the tool.
      8. In the platform, log in as teacher t1
      9. Go to "Platform course 1"
      10. Click to add an activity/resource
      11. Select "Moodle LTI Advantage Tool"
      12. Click "Select content"
      13. Select all check boxes next to "Assign 1"
      14. Click "Add content"
      15. Make sure "Share emails with the tool" and "share names with the tool" is selected.
      16. Save
      17. Repeat the process to publish "Assign 2" the same way.
      18. Repeat the process to publish "Tool Course 1" the same way. You will need to change the maxgrade to 100 before you can save the activity.
      19. Verify both activities are created.
      20. Now, log out of the platform.
      21. Log in to the platform as student s1
      22. Go to course "Platform course 1"
      23. Launch the lti resource "Assign 1"
      24. Submit to the assignment
      25. Launch the lti resource "Assign 2"
      26. Submit to the assignment
      27. Launch the lti resource "Tool Course 1"
      28. Log out of both the tool and the platform.
      29. Log in to the platform as student s2
      30. Go to course "Platform course 1"
      31. Launch the lti resource "Assign 2"
      32. Submit to the assignment
      33. Now, log in to the platform as the teacher t1
      34. Go to "Platform course 1"
      35. Launch "Assign 1"
      36. Grade the user s1, scoring them 45/80
      37. Launch "Assign 2"
      38. Grade the user s2, scoring them 60/80
      39. Go to the gradebook page in the platform
      40. Verify there are no grades present yet.
      41. Now, run the grade sync task (in the tool) via cli:

        php admin/cli/scheduled_task.php --execute='\enrol_lti\local\ltiadvantage\task\sync_grades'
        

      42. Verify the task runs without any errors.
      43. Go back to the platform gradebook page and reload.
      44. Verify:
        • You see a grade 45/80 for user s1 in "Assign 1"
        • You see no grade for user s1 in "Assign 2"
        • You see a grade of 25/100 for the user s1 in "Tool course 1" - this is because the user has scored 45/180 in that course in the tool.
        • You see a grade of 60/80 for user s2 in "Assign 2"
        • You see no grade for user s2 in "Assign 1"
        • You see a grade of 33.33/100 for the user s1 in "Tool course 1" - this is because the user has scored 60/180 in that course in the tool.
      Show
      Prerequisites You'll need two Moodle sites running on localhost for this test - one designated 'platform', one 'tool'. A course called "Platform course 1", in the platform site with: 5 Students: s1, s2, s3, s4, s5 2 Teachers: t1 and t2 A course called "Tool course 1" in the tool site with: An assignment called "Assign 1" with a max grade of 80. An assignment called "Assign 2" with default settings (max grade of 100) A file resource (representing a non-graded activity) A single teacher, t1, enrolled. A course called "Tool course 2" in the tool site with: A single teacher t2 enrolled In the tool site admin settings: Enable enrol_lti and auth_lti plugins Enable "Allow frame embedding" Register the tool and platform Note: This is a shortened process of setting up the Moodle LTI Advantage Tool. If you've already set this up as part of another test, you can safely skip this section. On the tool site, go to Admin > Plugins > Enrolments > Publish as LTI tool > Tool registration Keep this page open, we'll need it shortly. On the platform site, go to 'Admin > Plugins > Activity modules > External tool > Manage tools' Click 'Configure a tool manually' Enter the following values: In "Name" enter "Moodle LTI Advantage Tool" Set 'LTI Version' to 1.3 Set public key type to 'Keyset URL' In 'Tool URL', paste the value copied from "Tool URL" in the tool. In 'Public keyset' paste the value copied from"JWKS URL" in the tool In 'Initiate login URL', paste the value copied from "Initiate login URL" in the tool In 'Redirection URI(s)' paste the value copied from BOTH "Tool URL" and "Deep linking URL" rows in the tool. Make sure each is on its own line. Check 'Supports deep linking' In 'Content selection URL', paste the value copied from "Deep linking URL" in the tool Under "Services" set "IMS LTI Assignment and Grade Services" to "Use this service for grade sync and column management" Under "Services" set "IMS LTI Names and Role Provisioning" to "Use this service to retrieve members' information as per privacy settings" Set tools settings to "Do not use this service" Set "Tool configuration usage" to "Show in activity chooser and as a preconfigured tool" Save the tool (you'll be taken to the manage tools page again) For the tool you just created, click "View configuration details" Copy these configuration details somewhere, or be ready to access them again. Now, switch back to the tool site Under "Registered platforms" click "Register a platform" Enter the following values: Set "Platform name" to 'Moodle platform' In "Platform Id (Issuer)" paste the value you copied from the "Platform ID" field in the configuration details In "Client ID" paste the value you copied from the "Client ID" field in the configuration details In "Authentication request URL" paste the value you copied from "Authentication request URL" in the configuration details In "Public keyset URL" paste the value you copied from "Public keyset URL" in the configuration details In "Access token URL" paste the value you copied from "Access token URL" in the configuration details Save changes Click "Manage deployments" next to the registration you just created Click "Add a deployment" Set the following values: In "Name" enter "Site wide deployment" In "Deployment Id" paste the value you copied from "Deployment Id" in the the configuration details Save the deployment Log out of both tool and platform. Publish activities and set up platform resource links Log in to the tool site as t1 Click "Published as LTI Tools" in course setting Click "Add new" Publish the "Assign 1" resource, using all default settings (this ensures membersync is enabled) Repeat the process and publish the "Assign 2" resource Repeat the process and publish the "Tool Course 1" resource Now log out of the tool. In the platform, log in as teacher t1 Go to "Platform course 1" Click to add an activity/resource Select "Moodle LTI Advantage Tool" Click "Select content" Select all check boxes next to "Assign 1" Click "Add content" Make sure "Share emails with the tool" and "share names with the tool" is selected. Save Repeat the process to publish "Assign 2" the same way. Repeat the process to publish "Tool Course 1" the same way. You will need to change the maxgrade to 100 before you can save the activity. Verify both activities are created. Now, log out of the platform. Log in to the platform as student s1 Go to course "Platform course 1" Launch the lti resource "Assign 1" Submit to the assignment Launch the lti resource "Assign 2" Submit to the assignment Launch the lti resource "Tool Course 1" Log out of both the tool and the platform. Log in to the platform as student s2 Go to course "Platform course 1" Launch the lti resource "Assign 2" Submit to the assignment Now, log in to the platform as the teacher t1 Go to "Platform course 1" Launch "Assign 1" Grade the user s1, scoring them 45/80 Launch "Assign 2" Grade the user s2, scoring them 60/80 Go to the gradebook page in the platform Verify there are no grades present yet. Now, run the grade sync task (in the tool) via cli: php admin/cli/scheduled_task.php --execute='\enrol_lti\local\ltiadvantage\task\sync_grades' Verify the task runs without any errors. Go back to the platform gradebook page and reload. Verify : You see a grade 45/80 for user s1 in "Assign 1" You see no grade for user s1 in "Assign 2" You see a grade of 25/100 for the user s1 in "Tool course 1" - this is because the user has scored 45/180 in that course in the tool. You see a grade of 60/80 for user s2 in "Assign 2" You see no grade for user s2 in "Assign 1" You see a grade of 33.33/100 for the user s1 in "Tool course 1" - this is because the user has scored 60/180 in that course in the tool.
    • Affected Branches:
      MOODLE_311_STABLE, MOODLE_400_STABLE
    • Pull from Repository:
    • Pull Master Branch:
      MDL-69544-master
    • Story Points:
      1
    • Sprint:
      4.0 holding pattern 12, 4.0 Navigation blitz, 4.0 Navigation blitz 2, 4.0 Navigation blitz 3

      Description

      This issue deals with updating the grade sync task in:
      enrol/lti/classes/task/sync_grades.php

      Grade sync should use assignment grade services 2:
      https://www.imsglobal.org/spec/lti-ags/v2p0

      This task should use the AGS score publish service to set the learner's score in the platform. This should also work in conjunction with MDL-70354, in that a prior declared line item should be updated if created during the resource link creation process.

        Attachments

          Activity

            People

            Assignee:
            jaked Jake Dallimore
            Reporter:
            jaked Jake Dallimore
            Participants:
            Component watchers:
            Adrian Greeve, Jake Dallimore, Mathew May, Mihail Geshoski, Peter Dias, Sujith Haridasan
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:

                Time Tracking

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0 minutes
                0m
                Logged:
                Time Spent - 1 week, 2 days, 3 hours, 45 minutes
                1w 2d 3h 45m