Skip to content

Project: Add PDF reporting to questionnaire

Mike Churchward edited this page Jul 24, 2019 · 1 revision

Functional Design - Questionnaire Report PDF

Purpose

In the current version of the Questionnaire plugin teachers have the option to download all answers given as csv. Of course it is possible to “work the data” into a neat looking report with various other programma’s, but we actually think it is best that we can download it directly into a PDF format.

The goal of this functional design is to define the details on generating a PDF report from the Tab Summary in the Questionnaire activity.

General questions that needs to be answered:

Should the response been shown actually as the summary? Should the response take the Questionnaire Chart feature in consideration regarding Personality tests? Is there specific information that should always shown in the header of the PDF report? And if so which Moodle role decides this?

Answers: in the first work we will just focus in making the current view of the Summary report printer friendly.

The details will be worked out through various user stories, which will be transformed into technical details and/or mockups.

User story

A user story is written in the context of a standard moodle user role with the idea that user in this role should be able to do something or able to see.

A user story should be defined in a simple way. When a user story contains more than 1 sentence it should already be cut in 2 user stories. Sometimes it is difficult to form clearly in 1 sentence what you want a user to see or able to do, that is why I added example . This part could be used for extra definition.

  1. As a teacher I should be able to download the summary as a PDF report, so that I have a print friendly version of the summary overview.
  2. As a teacher I want to be able to decide if I want to print the PDF report in landscape or in portrait, so that I can choose the best way to present.
  3. As a teacher I want to be able to choose if I want to print the PDF report for all the responses or only for a group of response if I am using the group modus “separated” or “visible” groups at my activity.
  4. As a teacher I want to be able to select the items that need to be shown in the header of the report, so that I can personalize the report to my needs.

Items to select:

  1. The logo of my site as uploaded at site administration > appearance > Logos
  2. The course name
  3. The activity name
  4. The activity description
  5. The date the report is generated by me
  6. The name of the group (if group modus is used and a group is selected)

Mock-ups

Download PDF report page

Download PDF

Note: The items marked with a * only need to show when Group Modus in the activity setting is used

PDF report Landscape

PDF Report Landscape

PDF report portrait

PDF Report Portrait

Extra input / ideas for the developer

If you want an organisation to build their own PDF report Looking at https://moodle.org/plugins/mod_customcert you could add a site administration function where an organisation can build up their own PDF report page.

This does mean you need extended settings, because certainly the next question would be that they want to choose the layout for each activity they set.

This could be the place where they by example decided which fields show where on the PDF report, instead you building / programming it.