CSC/ECE 517/M601 Design Document: Difference between revisions

From Expertiza_Wiki
Jump to navigation Jump to search
Line 25: Line 25:
4. The activator needs to be modified so that it updates the filesystem css file with whatever is defined by the admin. <br>
4. The activator needs to be modified so that it updates the filesystem css file with whatever is defined by the admin. <br>
5. Need to use Eclipse and Maven as development tools for the module. <br>
5. Need to use Eclipse and Maven as development tools for the module. <br>
==Development Tools==
==Development Tools==
'''Eclipse'''<br>
'''Eclipse'''<br>

Revision as of 00:46, 23 April 2013

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 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

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.
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.
Tomcat

Hibernate
MySQL

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.

Use Cases

References

<references />