CSC/ECE 517/M601 Design Document

Add ability to update css through webapp

Team

Yuri Kolesnikov
Jonathan Wills
Jeffrey Plemmons
Roshna Agarwal

Our Work

Link to the OpenMRS ticket: https://tickets.openmrs.org/browse/TRUNK-3415
Link to our code in GitHub: https://github.com/ykolesn/openmrs-module-m601

Purpose

The purpose of this module 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 (See 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

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

Development Tools

1. Eclipse: Eclipse was the Integrated Development Environment <ref>http://en.wikipedia.org/wiki/Integrated_development_environment</ref> used to develop, modify, and compile the code for our module.
2. Maven: Maven<ref>http://en.wikipedia.org/wiki/Apache_Maven</ref> was used through a plug-in in Eclipse to compile, run unit tests, and package all of the Java files in the module.
3. Tomcat: Tomcat<ref>http://en.wikipedia.org/wiki/Apache_Tomcat</ref> was the web-server used to run the application.
4. Hibernate: Hibernate was a built-in utility in the OpenMRS module, that was used to connect the Java classes to the database tables in the application. It configured the database table through an xml file: UpdateCSS.hbm.xml

<?xml version="1.0"?>
<!DOCTYPE hibernate-mapping PUBLIC
    "-//Hibernate/Hibernate Mapping DTD 3.0//EN"
    "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd" >

<hibernate-mapping package="org.openmrs.module.updatecss">

<class name="UpdateCSS"
	table="css_properties">
        <id name="id" type="int" column="id">
            <generator class="native"/>
        </id>
		<property name="cssData" type="java.lang.String" column="css_location"
			length="255" not-null="true" />
		<property name="homeDirectory" type="java.lang.String" column="tomcat_home"
			length="255" not-null="true"/>
</class>
</hibernate-mapping>

Here in the UpdateCSS.hbm.xml we specify the table name and columns. Hibernate generates the table with the fields specified.
5. MySQL: MySQL<ref>http://en.wikipedia.org/wiki/Mysql</ref> is the RDBMS that was used to store the CSS data for the application.

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.

Design Patterns and Principles

MVC
This module retains the MVC architecture.

References

<references />