README.md

Jisc Student Workload Tool

A web-based tool for recording, visualising and managing student workload on courses, developed by The Open University (IET) with support from Jisc micro-project funding.

• Background reading.

Requirements

• Linux, Max OS X or Windows
• Apache 2.2+ (mod_rewrite)
• PHP 5.4+ (JSON enabled)
  • Composer
• MySQL

Installation

Before installing the files in the document root of the web server, a few changes need to be made to a configuration file and a database needs to be created on the web server which can be accessed by the workload tool.

1. Run composer install && composer setup-config
2. Open the file site/config/config.php
3. Scroll to the bottom of the file
4. Change the mailer entry with the correct host, username and password for the mail server to be used
5. If you want to change the default database name and login details, change those in the db entry
6. Save the file
7. Copy the entire directory structure and files to the document root of the web server, or git clone
8. On the webserver, create a database named jisc_workload
9. Create a database user with the username jisc_workload and password w0rkl0ad! (You can use a different username and password but you'll need to change these in the config file)
10. Grant the user jisc_workload all privileges on database jisc_workload
11. Open the file framework/tables.sql
12. Scroll to the bottom of the file
13. Change [Name of your institution] on line 148 to the name of your institution
14. Change [First name], [Last name], [Email], [Login], and [Password] on line 151 to the details of the first system administrator (additional administrators can be created once the system is live)
15. Copy the entire file to the clipboard and run it as an SQL query on the newly created database (This is easiest using a tool such as phpMyAdmin)

You should now be able to access the tool on the domain name linked to the web server.

GDPR

Details of GDPR / privacy actions can be found in Bug #7.

Acknowledgements

• Contributors: @djitsz (original developer)
• Bundled libraries: jQuery, Bootstrap, PHP SwiftMailer.
• Funding: Jisc

License

• GNU General Public License 3.0+

---

© 2015 The Open University (Institute of Educational Technology).