Note: You are currently viewing documentation for Moodle 3.6. Up-to-date documentation for the latest stable version of Moodle is likely available here: moodle-report myfeedback.

moodle-report myfeedback: Difference between revisions

From MoodleDocs
moodle-report myfeedback
Type report
Set N/A
Downloads https://moodle.org/plugins/view.php?plugin=report_myfeedback
Issues https://github.com/jgramp/moodle-report_myfeedback/issues
Discussion Enter the link to the forum or discussion thread
Maintainer(s) Jessica Gramp
Line 16: Line 16:


==Install instructions:==
==Install instructions:==
1. Copy the myfeedback directory to the report directory of your Moodle instance.
1. Copy the myfeedback directory to the report directory of your Moodle instance. E.g. moodle/report/myfeedback


2. Login to Moodle as site admin, click on Site Administration > Notifications and verifying that the plugin is listed to be upgraded. Then select 'Upgrade the database'.
2. Login to Moodle as site admin, click on Site Administration > Notifications and verifying that the plugin is listed to be upgraded. Then select 'Upgrade the database'.


3. Check the language file for the My feedback report reflects language common to your institution, and if not, update the strings in Site Administration > Language> Language customisation. E.g. you might want to change 'module tutor', to 'teacher'.
3. The My feedback settings page will appear. These are the explanation of each field:


4. Follow the steps below to set up staff access to the report for personal tutors, module tutors and programme admins.
i. The 'Current Academic Year Database Settings' section is to add the replicated database that is used for MyFeedback queries.


ii. The 'Archived Database Settings' section is as follows:
WARNING: The Moodle Archive functionality should be thoroughly tested before being implemented on a production system, to check it does not reveal grades or feedback that have been hidden from students (e.g. by unenrolling them from the course, hiding a section, hiding an activity, hiding a Gradebook entry. Older versions of Moodle may not use the same functionality for checking permissions as the current version where the plugin is installed, so some of these checks may not take place correctly. It is recommended that instead of using the Moodle Archive functionality, you instead install My feedback within each archived instance of Moodle separately, in order to avoid potential issues where students see grades and feedback that they shouldn't.
>> Archived years - Select the number of years you want the archive to show in the report. Set to zero (0) means it will not check for archived years.
>> The Archived Fully Qualified domain name is needed so that when users try to view a feedback from an archived year it takes them to the correct archived Moodle site where they can log in and see the feedback in that instance of Moodle for that year. For e.g., looking at feedback for a workshop in the 14/15 academic year would take them to 'https://moodle-archive.com/14-15/mod/workshop/submission.php?cmid=21&id=3'.
>> The Archived DB naming convention should be set to the name of the archives, minus any years. E.g. 'moodle_archive_' for  archives that use this moodle database naming convention (e.g. moodle_archive_1415).
>> Archived DB Host name is the server where the Archive Moodle exists.  E.g. 'moodle-archive.com'.
>> The Archived DB username and passwords will also need to be entered.
iii. The 'Dept Admin Second Level Category Course Limit' section sets a course limit on the Dept admin dashboard. This is because when too many courses are queried from a single second level category, this causes a PHP memory error. The PHP memory limit is reached and so we try to limit the amount of courses. Set this to the default of 200.
iv. The 'Overview Tab Course Limit' section sets a limit on the number of courses that will be displayed on the overview tab of a user when looking at their report. Set this to the default of 10. If the user is enrolled on more than this number of active courses then a '...more' button will be displayed after the limit that is set here, which takes the user to their profile page where they can see the remaining courses.
4. Check the language file for the My feedback report reflects language common to your institution, and if not, update the strings in Site Administration > Language> Language customisation. E.g. you might want to change 'module tutor', to 'teacher'.
5. Follow the steps below to set up staff access to the report for personal tutors, module tutors and programme admins.


==Setting up Access==
==Setting up Access==

Revision as of 11:40, 25 January 2017

About this page

This is in the installation guide, intended for Moodle site admins. For user guides please see report/myfeedback/index.

About the report

The Moodle My feedback report appears in the My Profile > Activity Reports menu and allows students to see an overview of all their grades and feedback for assessment activities such as Moodle Assignments, Turnitin Assignments (v1 & v2), Workshops and Quizzes. It provides their visible grades and a link to their submission and any feedback that has been released to them. The My feedback report displays this information in a searchable and sortable table. When clicking a link from this table, the user is directed to that course activity information (in some cases the link will be directly to the submission or feedback files - e.g. Turnitin Assignments open directly in a new window). When clicking on feedback this will usually take you to the user's result page for that activity.

The report is intended to help students understand the variety of feedback they receive. It can also be used to identify similarities between feedback received from across modules and years to help students see how they can improve their work in future assessments. This is intended to be done in partnership with teaching staff (such as personal tutors at university, or a home group teacher in a school setting). See setting up staff access below.

Install instructions:

1. Copy the myfeedback directory to the report directory of your Moodle instance. E.g. moodle/report/myfeedback

2. Login to Moodle as site admin, click on Site Administration > Notifications and verifying that the plugin is listed to be upgraded. Then select 'Upgrade the database'.

3. The My feedback settings page will appear. These are the explanation of each field:

i. The 'Current Academic Year Database Settings' section is to add the replicated database that is used for MyFeedback queries.

ii. The 'Archived Database Settings' section is as follows:

WARNING: The Moodle Archive functionality should be thoroughly tested before being implemented on a production system, to check it does not reveal grades or feedback that have been hidden from students (e.g. by unenrolling them from the course, hiding a section, hiding an activity, hiding a Gradebook entry. Older versions of Moodle may not use the same functionality for checking permissions as the current version where the plugin is installed, so some of these checks may not take place correctly. It is recommended that instead of using the Moodle Archive functionality, you instead install My feedback within each archived instance of Moodle separately, in order to avoid potential issues where students see grades and feedback that they shouldn't.

>> Archived years - Select the number of years you want the archive to show in the report. Set to zero (0) means it will not check for archived years.

>> The Archived Fully Qualified domain name is needed so that when users try to view a feedback from an archived year it takes them to the correct archived Moodle site where they can log in and see the feedback in that instance of Moodle for that year. For e.g., looking at feedback for a workshop in the 14/15 academic year would take them to 'https://moodle-archive.com/14-15/mod/workshop/submission.php?cmid=21&id=3'.

>> The Archived DB naming convention should be set to the name of the archives, minus any years. E.g. 'moodle_archive_' for archives that use this moodle database naming convention (e.g. moodle_archive_1415).

>> Archived DB Host name is the server where the Archive Moodle exists. E.g. 'moodle-archive.com'.

>> The Archived DB username and passwords will also need to be entered.

iii. The 'Dept Admin Second Level Category Course Limit' section sets a course limit on the Dept admin dashboard. This is because when too many courses are queried from a single second level category, this causes a PHP memory error. The PHP memory limit is reached and so we try to limit the amount of courses. Set this to the default of 200.

iv. The 'Overview Tab Course Limit' section sets a limit on the number of courses that will be displayed on the overview tab of a user when looking at their report. Set this to the default of 10. If the user is enrolled on more than this number of active courses then a '...more' button will be displayed after the limit that is set here, which takes the user to their profile page where they can see the remaining courses.

4. Check the language file for the My feedback report reflects language common to your institution, and if not, update the strings in Site Administration > Language> Language customisation. E.g. you might want to change 'module tutor', to 'teacher'.

5. Follow the steps below to set up staff access to the report for personal tutors, module tutors and programme admins.

Setting up Access

Student access to the report is available as soon as you install it. If staff are also enrolled as students on any Moodle course, they will see this appear in their own report, alongside the My students tab and other dashboard(s) that enable them an overview of their students' feedback and grades. Staff access (teachers, personal tutors and programme administrators) need to be configured.

Set up the My feedback roles for staff access

Log in as a site admin and go to Site Administration> Users > Permission > Define Roles. At the bottom of the page 'Add a new role' with the following permissions enabled:

  • Personal tutor:
    • Allow report/myfeedback:personaltutor
    • Allow moodle/user:readuserblogs (optional)
    • Allow moodle/user:readuserposts (optional)
    • Allow moodle/user:viewalldetails (optional)
    • Allow moodle/user:viewuseractivitiesreport (optional)
    • Allow moodle/user:viewdetails (optional)
  • Programme administrator:
    • Allow enrol/category:synchronised#
    • Allow report/myfeedback:progadmin
  1. The programme administrator role can be used to assign staff at category level to all courses within the category using the category enrolments plugin. See: Category_enrolments

It may be possible to use this role using Cohorts, but this has not been tested yet. If you do know if this works or not, please update this help file to reflect this - thank you.

  • Module tutor (or teacher)

You will also need to modify the teacher and non-editing teacher role to enable teacher (known as 'module tutor'#) access to the report:

    • Allow gradereport/myfeedbacklink:view

This will enable anyone who is enrolled as a teacher, or non-editing teacher, to see feedback and grades from any courses they teach in the report. Feedback and grades for each student that reside within courses the teacher does not teach upon will not be visible. This is done deliberately in an attempt to avoid staff looking at student progress in other courses and letting this bias the marking process. However, if the staff member is also a personal tutor they will get a full view across moodle courses within the report, regardless of whether they are teaching these courses, but only for those students who are their personal tutees. This is to enable personal tutors to provide full support to students within personal tutoring meetings.

  1. The names of the reports can be changed in the strings to match the terms used at your institution. To do this, log in as a site admin and use the language editing interface in Site Administration > Language> Language customisation.

Personal Tutor access

To set up personal tutor access, the staff member needs to be assigned as a personal tutor of each student they are supporting, using the 'assign roles relative to this user' in each student's profile. See [1].

Assigning parent roles can be automated using the dbuserrel plugin. See: [2]

How do users access the report

Once installed, the report can be accessed via the user profile (Reports > My Feedback). Access is controlled by the user context, teachers will be able to see grades and feedback for students enrolled on the courses that they teach. Students (who aren't also teachers) can only see their own grades. Programme Administrators can see all grades for all students in the category they have been assigned access to (unless permissions prohibit this).

This is what the feedback comments tab looks like. Moodle31-MyFeedback-FeedbackComments.PNG For more user guidance, please see report/myfeedback/index.