PDF Reports Framework
How PDF reports are scheduled, generated and distributed within SYLVA. An overview of all the systems involved.
last updated on
March 14, 2020

Overview

In general pdf generation is performed by backend services in an asynchronous flow with schedulers and assisting components by GCP (PubSub, Cloud tasks, Cloud functions, Cloud storage)

PDF scheduling Flow

  1. Event trigger which starts the pipeline
  2. DB request to gather all resources for pdf data
  3. fill pdf template and schedule the pdf process depending on assessment grading type (manual or auto)
  4. Store pdf file in google cloud storage
  5. Link pdf file in the db

Report Types

Final Grade reports

They are scheduled for creation upon publishing final grade for a course.

These reports are handled by SYLVA API, more specifically using the pdfMaker cloud function

The final grade pdf reports are generated by 2 templates:

Evaluation reports

They are scheduled for creation upon publishing an assessment evaluation.

They can be divided in 2 sub-types based on grading functionality (manual or auto) :

In addition, all evaluation reports are generated by 4 templates:

Filename templates for PDF files

The filename of each pdf should be downloaded as follows:


Evaluation Results

  1. {User Name}-{Assessment Name}-Results.pdf
  2. {Team Name}-{Assessment Name}-Results.pdf
  3. {Course short name}-{Assessment Name}-Evaluation-report.pdf <-- for Staff

Final Grade results

  1. {User Name}-{Course short name}-Final-grade.pdf
  2. {Course name}-Final-grade-report.pdf <-- for Staff

Evaluation Archive ZIP

This is a zip file generated after the evaluation results have been published.

It contains the evaluation reports for all the students as well as the staff report.

Final Grade Archive ZIP

This is a zip file generated after the final grade has been published.

It contains all final grade reports for all the students as well as the staff report.

Example PDF reports

Link
File
Student Final Grade Report
File
Educator Final Grade Report
File
Student Assignment Report