CSC/ECE 517/M601 Design Document

Design Document for M601 - Add ability to update css through webapp Team members: Yuri Kolesnikov, Jonathan Wills, Jeffrey Plemmons, Roshna Agarwal

Purpose

The purpose is to add the functionality of allowing the admin to customize the OpenMRS css file to their own specifications. By having the ability to customize the OpenMRS css file, the admin will be free to change the look and feel in their installation of OpenMRS.

Problem Definition

Add admin page for customization of the openmrs css file. Admins can 'override' any openmrs css with their own file by specifying that file in the openmrs runtime properties file. See https://wiki.openmrs.org/display/docs/Overriding+OpenMRS+Default+Runtime+Properties This would be best as a new module in openmrs. https://wiki.openmrs.org/display/docs/Modules Or perhaps just adding a new feature in the Custom Logo module? The admin should see a page with a large text box. The text box value should be persisted in the database as a new object/table/column somehow. When the module starts up, the Activator is called. Modify the activator to update the filesystem css file with whatever is defined by the admin. https://wiki.openmrs.org/display/docs/Module+Activator

Requirements

The admin should be able to customize the openmrs css file through an admin page. The admin should see a page with a large text box. The text box content should be stored in the database. The activator needs to be modified so that it updates the filesystem css file with whatever is defined by the admin. Need to use Eclipse, Maven, and Ant as development tools for the module.

Tasks

Week 1:

• Get OpenMRS Id
• Get ticket assigned and in progress
• Get openmrs module name assigned
• Create openmrs module
• Commit module to github
• Check out module on partner machines
• Get new admin page link
• Create new spring controller and jsp page

Week 2:

Create object for storing css in db Create service layer and dao layer methods to save object Connect controller to db object for saving + retrieving Add unit tests for saving/retrieving Week 3:

Create settings page to allow admin to choose where tomcat is running Add some magic so that module tries to guess where tomcat is running Add ability to put the saved css into the right folder in tomcat so that the css is actually overriding the openmrs style.css file.