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

User can open external tool submission from the gradebook

XMLWordPrintable

    • MOODLE_39_STABLE, MOODLE_400_STABLE
    • MOODLE_401_STABLE
    • MDL-69275-submissionreview-resquashed
    • Hide

      In this test, we will check that the Robotest app can be launched from the Moodle Gradebook in context of the student's grade by checking the for_user is passed with the id of the student for which the grade needs to be shown.

      We will also use an LTI 1.1 tool since there is no way to disable the launch option from Gradebook per LTI version, and we don't want to have a broken launch from gradebook for any tool.

      Install the Tools

      pre-requisite

      1. LTI Advantage requires your site to be reachable from the internet. If not, Install ngrok to expose your moodle setup externally. Refer here for additional guidelines
      2. Have a course with an instructor and at least one student
      3. Have the Robotest Test app installed
        1. As site administrator, navigate to Site Admin > Plugins > Activity Modules > External Tool > Manage Tools
        2. In the box that says tool url enter: https://robotest.theedtech.dev/register
        3. Click the Add LTI Advantage button
        4. The test tool should open with a trace of the communication with Moodle, all should be green (thumbs up).
        5. Click the close button - the test app UI should disappear and the list of tools refreshing
        6. Verify the Robotest app has been added and is not yet activated
        7. Click the Activate button
      4. For LTI 1.1 we use saLTIre (https://saltire.lti.app/)
        1. As site administrator, navigate to Site Admin > Plugins > Activity Modules > External Tool > Manage Tools -> Configure Tool Manually
        2. Tool URL: https://saltire.lti.app/tool
        3. Set as LTI 1.1
        4. Key: any value
        5. Secret: secret
        6. Privacy: allow grading instructor's choice

      LTI Advantage Support for Submission Review

      We enter the course as instructor, add a couple of links, one supporting submission review, one not. Then verify the launches from the gradebook.

      Since multiple or single import have slightly different logic, we import both using multiple and single item.

      1. Enter a course as instructor
      2. Turn editing on
      3. Add an activity > external tool:
        1. Select Robotest from the list of tools
        2. Click the Select Content button
        3. Select a single item: "A single Graded Activity with Submission Review Full"
        4. Back to Moodle, modify the title to prefix it with SINGLE, as to remember that link was imported as a single item import
        5. Submit
      4. Now let's import multiples: Add an activity > external tool:
        1. Select Robotest from the list of tools
        2. Click the Select Content button
        3. Select "One of Each"
        4. Back to Moodle, verify all the links listed in Robotest are going to be imported (should be 4 of them, 3 graded)
        5. Submit
      5. Now let's check the Submission review actually works by going to the gradebook: navigate to grades
        1. Verify that each cell for the graded imported links has a mag icon
        2. For each of those links, click on the mag icon
          1. Verify the launch is successful
          2. For submission review launch, it should mention it's a submission review (The 2nd header row should say 'Submission Review Launch')
          3. Verify the for_user field (User id found) is indicated as successfully populated. Note that it should be the id of the student for which the grade was clicked on.
      6. Let's verify the regular launches are still... regular launches
        1. Navigate to the Course main page (where the topics are listed)
        2. Click on one of the Robotest activity
        3. In Robotest, verify the type of launch is Resource Link Launch (The 2nd header row should start with ('Resource Link Launch')

      Let's verify Submission Review from a Student viewpoint now:

      1. Enter course as a Student
      2. Click on one of the imported links, one starting with Graded with Sub. Review (IFrame)
        1. Verify the launch is a successful and  the type of launch is Resource Link Launch (The 2nd header row should start with ('Resource Link Launch')
        2. It should have sent a grade back (one row should have a green title saying 'Score Post without error ')
      3. Navigate back the Moodle Course home (by clicking on the course name in the Moodle UI)
      4. Clcik on Grade
      5. On the list of activities, find the one you clicked on in step 2
        1. Verify it has a grade
      6. Click on the activity link
        1. Verify the launch type is submission review (The 2nd header row should say 'Submission Review Launch')
        2. Verify the User Id value and the For User Id have the same numeric value

      LTI 1.1 Regular Launch

      While this feature is not intended for 1.1 launches, by the way Moodle External Tool is built, there is no way to prevent the mag glass to show up. So since it shows, it should work (the link should launch successfully).

      1. In the course, turn edit on, add an external tool activity
      2. Choose saLTIre tool
      3. Make the activity gradable and set maximum points to some no 0 value
      4. Save
      5. Open the gradebook
      6. Verify a column exists for that new link
      7. Click on the Mag glass
      8. Verify the tool launches successfully

       

       

      Show
      In this test, we will check that the Robotest app can be launched from the Moodle Gradebook in context of the student's grade by checking the for_user is passed with the id of the student for which the grade needs to be shown. We will also use an LTI 1.1 tool since there is no way to disable the launch option from Gradebook per LTI version, and we don't want to have a broken launch from gradebook for any tool. Install the Tools pre-requisite LTI Advantage requires your site to be reachable from the internet. If not, Install ngrok to expose your moodle setup externally. Refer here for additional guidelines Have a course with an instructor and at least one student Have the Robotest Test app installed As site administrator, navigate to Site Admin > Plugins > Activity Modules > External Tool > Manage Tools In the box that says tool url enter: https://robotest.theedtech.dev/register Click the Add LTI Advantage button The test tool should open with a trace of the communication with Moodle, all should be green (thumbs up). Click the close button - the test app UI should disappear and the list of tools refreshing Verify the Robotest app has been added and is not yet activated Click the Activate button For LTI 1.1 we use saLTIre ( https://saltire.lti.app/ ) As site administrator, navigate to Site Admin > Plugins > Activity Modules > External Tool > Manage Tools -> Configure Tool Manually Tool URL: https://saltire.lti.app/tool Set as LTI 1.1 Key: any value Secret: secret Privacy: allow grading instructor's choice LTI Advantage Support for Submission Review We enter the course as instructor, add a couple of links, one supporting submission review, one not. Then verify the launches from the gradebook. Since multiple or single import have slightly different logic, we import both using multiple and single item. Enter a course as instructor Turn editing on Add an activity > external tool: Select Robotest from the list of tools Click the Select Content button Select a single item: "A single Graded Activity with Submission Review Full" Back to Moodle, modify the title to prefix it with SINGLE, as to remember that link was imported as a single item import Submit Now let's import multiples: Add an activity > external tool: Select Robotest from the list of tools Click the Select Content button Select "One of Each" Back to Moodle, verify all the links listed in Robotest are going to be imported (should be 4 of them, 3 graded) Submit Now let's check the Submission review actually works by going to the gradebook: navigate to grades Verify that each cell for the graded imported links has a mag icon For each of those links, click on the mag icon Verify the launch is successful For submission review launch, it should mention it's a submission review (The 2nd header row should say 'Submission Review Launch') Verify the for_user field (User id found) is indicated as successfully populated. Note that it should be the id of the student for which the grade was clicked on. Let's verify the regular launches are still... regular launches Navigate to the Course main page (where the topics are listed) Click on one of the Robotest activity In Robotest, verify the type of launch is Resource Link Launch (The 2nd header row should start with ('Resource Link Launch') Let's verify Submission Review from a Student viewpoint now: Enter course as a Student Click on one of the imported links, one starting with Graded with Sub. Review (IFrame) Verify the launch is a successful and  the type of launch is Resource Link Launch (The 2nd header row should start with ('Resource Link Launch') It should have sent a grade back (one row should have a green title saying 'Score Post without error ') Navigate back the Moodle Course home (by clicking on the course name in the Moodle UI) Clcik on Grade On the list of activities, find the one you clicked on in step 2 Verify it has a grade Click on the activity link Verify the launch type is submission review (The 2nd header row should say 'Submission Review Launch') Verify the User Id value and the For User Id have the same numeric value LTI 1.1 Regular Launch While this feature is not intended for 1.1 launches, by the way Moodle External Tool is built, there is no way to prevent the mag glass to show up. So since it shows, it should work (the link should launch successfully). In the course, turn edit on, add an external tool activity Choose saLTIre tool Make the activity gradable and set maximum points to some no 0 value Save Open the gradebook Verify a column exists for that new link Click on the Mag glass Verify the tool launches successfully    

      As an instructor, I wish to be able to launch from the gradebook to the external tool, and if the tool supports it, launch in the context of the student's work. For example, an instructor could launch from the grade in the gradebook by clicking on the magnifying glass in the gradebook cell and open the student's work for that submission.

      The work is based on the possibility for an activity module to include a link back (a mag glass icon) by including a grade.php in the module. This is similar to the quiz, scorm, h5p and lesson activity modules.

      It uses a new claim in the LTI specification (https://www.imsglobal.org/spec/lti-sr/v1p0) to express who the user is launching (the for_user claim).

      Background:

      Since the ability to launch from the gradebook is presently an all or nothing proposition for an activity module (See: https://docs.moodle.org/dev/Gradebook_API#Gradebook_redirection_page), this option will not require (support) a tool opting in/out. Any LTI tool with a gradebook column can be launched from the gradebook. Tools may then decide to use the new for_user claim to show the student's work rather than the default instructor view of the activity.

      To comply with the submission review specification, if submission review is explicitly declared when importing the link, the message type wil be set to LtiSubmissionReviewRequest and explicit url/parameters applied if specified

       

        1. lti1.1.webm
          967 kB
        2. mdl-69275-subreviewdemo.mp4
          10.45 MB
        3. single_opennewwindow.png
          single_opennewwindow.png
          41 kB
        4. submission review_student_1.png
          submission review_student_1.png
          382 kB
        5. submission review_student_2.png
          submission review_student_2.png
          127 kB
        6. submission review_student_3_1.png
          submission review_student_3_1.png
          430 kB
        7. submission review_student_3_2.png
          submission review_student_3_2.png
          389 kB
        8. submission review_student_3_3.png
          submission review_student_3_3.png
          385 kB
        9. submission review_student_3_4.png
          submission review_student_3_4.png
          431 kB
        10. submission review_teacher_1_1.png
          submission review_teacher_1_1.png
          410 kB
        11. submission review_teacher_1_2.png
          submission review_teacher_1_2.png
          369 kB
        12. submission review_teacher_1_3.png
          submission review_teacher_1_3.png
          372 kB
        13. submission review_teacher_1_4.png
          submission review_teacher_1_4.png
          426 kB
        14. submission review_teacher_2.webm
          777 kB
        15. useridvsforuserid.png
          useridvsforuserid.png
          58 kB

            claudevervoort Claude Vervoort
            claudevervoort Claude Vervoort
            Jake Dallimore Jake Dallimore
            Sara Arjona (@sarjona) Sara Arjona (@sarjona)
            Angelia Dela Cruz Angelia Dela Cruz
            Votes:
            2 Vote for this issue
            Watchers:
            10 Start watching this issue

              Created:
              Updated:
              Resolved:

                Estimated:
                Original Estimate - 0 minutes
                0m
                Remaining:
                Remaining Estimate - 0 minutes
                0m
                Logged:
                Time Spent - 3 days
                3d

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