Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

Usability issues - Access control

From MoodleDocs

Where certain files could be accessed and used within Moodle

One of the issues that plagued the quiz module was where the images were stored. Understanding how and in what contexts files are stored might be helpful by looking at each activity (module). The following table describes where files are uploaded in every activity module together with the places where the files are stored:

Comparison of where files are uploaded at activity modules
ID Activity module Locations to upload files Simple / detailed uploading file classification more information) Place where the files are stored Other comments
1 Quiz 1. Attached to the question, 2. Import from file upload..., 3. Import from file already in course files..., 4. Update quiz, 5. Attached to the grading 1. Detailed, 2. Simple, 3. Detailed, 4. Detailed, 5. Detailed 1. C:\server\moodledata\2 (with url http://localhost/file.php/2), 2. nowhere, 3. C:\server\moodledata\2, 4. C:\server\moodledata\2, 5. C:\server\moodledata\2 Nowhere means that the file is not stored, although it is stored the processed information extracted from the file
2 Glossary 1. Attached to the entry, 2. Import entries from XML file, 3. Update glossary 1. Detailed, 2. Simple, 3. Detailed 1. C:\server\moodledata\2 (with url http://localhost/file.php/2), 2. nowhere, 3. C:\server\moodledata\2 It is possible to comment glossary's entries and attach an image in the detailed view (and stored in C:\server\moodledata\2).
3 Chat 1. Update this chat 1. Detailed 1. C:\server\moodledata\2 It is not available to upload a file in the chat, but it is possible to associate an image to the chat.
4 Choice 1. Update choice 1. Detailed 1. C:\server\moodledata\2 No grading is possible.
5 Forum 1. Attached to the question/answer, 2. Update forum 1. Detailed, 2. Detailed 1. C:\server\moodledata\2, 2. C:\server\moodledata\2 It is possible to grade through the grades category of the administration of the course. It is possible to insert a picture in the detailed mode and stored in C:\server\moodledata\2.
6 Assignments 1. Uploading a file, 2. Grading, 3. Upload assignment 1. Simple, 2. Detailed, 3. Detailed 1. C:\server\moodledata\2\moddata\assignment\1\2, 2. C:\server\moodledata\2, 3. C:\server\moodledata\2 There is a special directory to store assignments.
7 Database 1. Adding entries of files / pictures, 2. Update this database 1. Simple, 2. Detailed 1. C:\server\moodledata\2\moddata\data\1\1\, 2. C:\server\moodledata\2 There is a special directory to store database entries. No grading is available.
8 Lesson 1. Attached to the question, 2. Import from file upload..., 3. Import from file already in course files... 1. Detailed, 2. Simple, 3. Detailed 1. C:\server\moodledata\2 (with url http://localhost/file.php/2), 2. nowhere, 3. C:\server\moodledata\2 No grading is available.
9 Survey None None None No grading is available
10 Wiki 1. Attached to the wiki, 2. Update wiki 1. Detailed, 2. Detailed 1. C:\server\moodledata\2, 2. C:\server\moodledata\2 No grading is available.
11 Journal 1. Attached to the journal, 2. Update journal 1. Detailed, 2. Detailed 1. C:\server\moodledata\2, 2. C:\server\moodledata\2 It is not possible to insert a file or image to the feedback.
12 Hotpotatoes 1. Update hot potatoes 1. Detailed 1. C:\server\moodledata\2 It is possible to grade through the grades category of the administration of the course. It is possible to insert a picture in the detailed mode and stored in C:\server\moodledata\2.
13 Exercise 1. Exercise description, 2. Attached exercise 1. Simple, 2. Simple 1. C:\server\moodledata\2\moddata\exercise\1, 2. C:\server\moodledata\2\moddata\exercise\1 There is a special directory to store submitted exercises and the exercise description.
14 Workshop 1. Attach file to the answer, 2. Upload workshop 1. Detailed, 2. Detailed 1. C:\server\moodledata\2, 2. C:\server\moodledata\2 Grading is possible but it does not allow to attach images.

What recommendations could we provide developers so that ultimately it seems easier for teachers to make use of the files in a variety of contexts?

  1. It should be considered the two types of uploading categories File Repository API.
  2. It should be considered that it must be considered possibilities where it could be possible to upload files like in the 1. grading system, 2. making comments, 3. adding an entry of an activity, 4. in the description of the activity, 5. import all the information of the activity module
  3. Usually there are two locations to upload files: C:\server\moodledata\2\moddata\activitymodule (it is used when students should upload files/images for the assignment / exercise or other module activity) and C:\server\moodledata\2 (for storing other images associated to an activity module but the file is not the main issue in the activity)
  4. The grading accessed in the Grades of the Administrator menu should be the same and allow the same functionality that the one accessed from the view of the activity module.

Forecast of any usability issues coming out of implementing the file repository api

This are some usability issues that can appear if developers don't followed the guidelines mentioned above:

  1. More types of uploading interfaces are added which confuses the user (to avoid them read File Repository API)
  2. In some places the user would like to upload a file and he/she can't
  3. Files are stored inconsistently in Moodle's installation directories
  4. The grading interface allows more / less functionalities than accessing to the grading system through the activity module interface. The look and feel is also different so it confuses to the user.

Are there places that are not using files that could?

Files are uploaded in:

  1. Grading system
  2. Making comments
  3. Adding an entry of an activity
  4. In the description of the activity
  5. Import all the information of the activity module


Next after making the table of comparison of where files are uploaded at activity modules, it will be mentioned the places where uploading a file could be possible:

  1. Glossary: it should be possible to attach a file to the grading of the glossary not only from the grading system but also from the activity module.
  2. Chat: it should be possible to upload a file from the chat (while chatting) or at least a link that allows to send a message from the chat.
  3. Choice: it should be possible to give feedback and upload a file, and import the information of the choice questions.
  4. Lesson: it should be able to comment a lesson with been able to upload an image.
  5. Survey: it should be able to comment a survey with been able to upload an image. Moreover it should be able to attach an image to the description of the survey.
  6. Wiki: perhaps it should be possible to import a wiki with XML.
  7. Journal: it should be possible to comment a journal and attach a file if wanted.
  8. Workshop: it should be able to attach an image to the grading (now this functionality is not available).
  9. Hot potatoes: it should be possible to attach a file to the grading of the hot potatoes not only from the grading system but also from the activity module.
  10. Moreover the uploaded file must follow the guidelines described at File Repository API