Differences between revisions 2 and 7 (spanning 5 versions)
Revision 2 as of 2007-11-07 16:15:59
Size: 3221
Editor: ColinTatham
Comment: Saved current state in case of browser falling over...
Revision 7 as of 2007-11-09 12:19:08
Size: 5653
Editor: ColinTatham
Comment: Added dissemination list, fleshed out Implications a bit
Deletions are marked like this. Additions are marked like this.
Line 5: Line 5:
'''Project plan:'''
 * Adopt an incremental and iterative approach to development
 * Produce mock-ups of user interfaces to aid requirements analysis.
 * Focus initially on simple software deliverables, with a view to future expansion
'''Execution:'''
 * Standardised development environment (Eclipse, SVN)
 * Used prototypes of user interface which evolved as functionality was added/enabled.
 * Modified Bodington installer as features were added, in order to make deployment/demonstration simpler.
 * Made use of SVN externals to pull toolkit code in from external SVN repository.
 * Concentrated initially on development in Bodington, but based design on both Bodington and Sakai integration.
 * Developed code with intention of incorporating outcome into production VLE service.
 * Contributing feedback/code/updates/maintenance to original developers throughout project.
Following the project plan, we adopted an incremental and iterative approach to development. We produced an initial user interface within Bodington with place holders for the intended functionality. This was demonstrated to a small group of users to gauge requirements and initial response. We then enhanced the user interface and added further functionality, which we demonstrated to the !WebLearn User Group.

Throughout the development process we used a standardised development environment consisting of Eclipse, Ant and SVN, in order to make development collaboration within the team and with external developers easier. We assessed the eProfile toolkit code, build process, repository and documentation on an ongoing basis and gave feedback to the original developers where appropriate. We also modified the Bodington installer as development progressed, in order to produce an easily deployable demo of the new functionality, including dummy data. We anticipated incorporating the code into the production VLE service progressively during the project.
Line 19: Line 11:
Initial work was to install and experiment with the eProfile toolkit components (which proved to be more time-consuming than we had planned for). We then looked at how the eProfile web service and TouchGraph applet could be incorporated into both Bodington and Sakai, and decided to mirror the class hierarchy of Sakai's existing profile tool, in order to ease later integration into Sakai. We developed the initial user interface in Bodington, following the Bodington community's decision to write all new tools using Spring MVC and JSPs instead of either of the Bodington custom templating schemes (thereby also improving the possibility of re-use). We also researched the possibility of using Ruby on Rails for prototyping, and RSF (a templating scheme based on JSF, in use in the Sakai community) but decided that there wasn't sufficient time in the project.
Line 20: Line 13:
Initial work was to install and experiment with the EProfile toolkit components. We then looked at how the web service and applet could be incorporated into both Bodington and Sakai, and decided to model the implementation on Sakai's existing profile tool, in order to ease later integration into Sakai. An initial user interface was developed in Bodington with place holders for the intended functionality. This was demonstrated to a small group of users to gauge requirements and initial response. We then enhanced the user interface and added further functionality, which we demonstrated to the WebLearn User Group. We set up a publicly accessible SVN repository at the start of the project, and made use of SVN externals to pull the eProfile toolkit and Bodington (WebLearn) code in to the project, in order to ensure the code was up to date, and to avoid duplicating code held elsewhere. We produced Ant build files not only for the FROCKLE code, but also for the eProfile web service and eProfile applet, as well as JUnit tests for the eProfile web service, and contributed them along with any bugfixes and repository rationalisations we thought necessary. It became apparent that we'd like to make quite a few changes to the way the toolkit functioned, as well as needing a few modifications in order to make it suit our needs better, so, in agreement with the eProfile developers, we gained additional funding and an extension from JISC in order for the eProfile developers to do the work. The additional work [1] included delivering the FOAF profiles from the web service in an XML format, allowing more FOAF fields in the profiles, some enhancements to the applet, and some suggestions for re-factoring. The additional work has been completed, and updated versions of the toolkit components will be integrated into the demo installation in due course.
Line 22: Line 15:
Spring MVC and JSP pages
adopted Bodington policy to switch over to Spring MVC and JSP instead of the original custom template format.

During the development process we made contributions to the toolkit code in the SVN repository made available by the original developers (including modifications to the 3rd party applet code).

Received additional funding from JISC to contract original toolkit developers to enhance toolkit for our use.
Line 31: Line 18:
''Demo available at:'' http://flounder.oucs.ox.ac.uk:8080/wl-addon/ ''Demo available at:'' http://flounder.oucs.ox.ac.uk:8080/frockle/
Line 33: Line 20:
''Code downloads available at:'' http://downloads.oucs.ox.ac.uk/frockle/ ''Download available at:'' http://downloads.oucs.ox.ac.uk/frockle/
Line 35: Line 22:
''SVN repository:'' https://svn.oucs.ox.ac.uk/projects/vle/frockle ''FROCKLE repository:''

https://svn.oucs.ox.ac.uk/projects/vle/frockle

''eProfile repository (incl Frockle contributions):''

svn://chimera70.essex.ac.uk/eProfileClient

svn://chimera70.essex.ac.uk/eProfileWebService
Line 39: Line 34:
 * JUnit tests and Ant build files for EProfile toolkit.
 * Contributions to EProfile SVN, and feedback to developers.
 * JUnit tests and Ant build files for eProfile toolkit.
 * Contributions to eProfile SVN, and feedback to developers.
 * Dissemination:
   * Website: http://frockle.oucs.ox.ac.uk/
   * Wiki: http://wiki.oucs.ox.ac.uk/ltg-public/Frockle/
   * Blog: http://frockle.blogspot.com/
   * Demonstrated to users, WebLearn User Group.
   * Summary in Computing Services annual report.
   * Described in pre-conference seminar at Educause 2007.
Line 45: Line 46:
 * Work will be taken up again in later stages of our migration of the institutional VLE from Bodington to Sakai All of the code produced is available in the FROCKLE and eProfile repositories. The Frockle repository does depend on the eProfile repository being available, so it is arguable that we should keep a local snapshot as a backup. The software developed was not integrated into the production VLE service during the life of the project, due to time constraints and concerns about its maturity, but the work will be taken up again during the current migration of the institutional VLE from Bodington to Sakai.
Line 47: Line 48:
==== Conclusions ==== ==== Conclusions (optional) ====
Line 49: Line 50:
 * better not to try to produce outcome suitable for integration into production VLE service during project life, as time scales were too short, and it complicated development, would've been better to concentrate on a simple demonstrator to be enhanced after the project ended.
Line 53: Line 53:
 * lots of interesting research
 * better not to try to produce outcome suitable for integration into production VLE service during project life, as time scales were too short, and it complicated development, would've been better to concentrate on a simple demonstrator to be enhanced after the project ended.
 * would've been better to undertake a project where work was already underway, or there is an overlap with other work, as time scales are too short to go through full cycle of initial concept, execution
Line 54: Line 57:
==== Recommendations ====
==== Recommendations (optional) ====


[1] http://wiki.oucs.ox.ac.uk/ltg-public/Frockle/ToolkitEnhancementRequirements

Final Report

Methodology

Following the project plan, we adopted an incremental and iterative approach to development. We produced an initial user interface within Bodington with place holders for the intended functionality. This was demonstrated to a small group of users to gauge requirements and initial response. We then enhanced the user interface and added further functionality, which we demonstrated to the WebLearn User Group.

Throughout the development process we used a standardised development environment consisting of Eclipse, Ant and SVN, in order to make development collaboration within the team and with external developers easier. We assessed the eProfile toolkit code, build process, repository and documentation on an ongoing basis and gave feedback to the original developers where appropriate. We also modified the Bodington installer as development progressed, in order to produce an easily deployable demo of the new functionality, including dummy data. We anticipated incorporating the code into the production VLE service progressively during the project.

Implementation

Initial work was to install and experiment with the eProfile toolkit components (which proved to be more time-consuming than we had planned for). We then looked at how the eProfile web service and TouchGraph applet could be incorporated into both Bodington and Sakai, and decided to mirror the class hierarchy of Sakai's existing profile tool, in order to ease later integration into Sakai. We developed the initial user interface in Bodington, following the Bodington community's decision to write all new tools using Spring MVC and JSPs instead of either of the Bodington custom templating schemes (thereby also improving the possibility of re-use). We also researched the possibility of using Ruby on Rails for prototyping, and RSF (a templating scheme based on JSF, in use in the Sakai community) but decided that there wasn't sufficient time in the project.

We set up a publicly accessible SVN repository at the start of the project, and made use of SVN externals to pull the eProfile toolkit and Bodington (WebLearn) code in to the project, in order to ensure the code was up to date, and to avoid duplicating code held elsewhere. We produced Ant build files not only for the FROCKLE code, but also for the eProfile web service and eProfile applet, as well as JUnit tests for the eProfile web service, and contributed them along with any bugfixes and repository rationalisations we thought necessary. It became apparent that we'd like to make quite a few changes to the way the toolkit functioned, as well as needing a few modifications in order to make it suit our needs better, so, in agreement with the eProfile developers, we gained additional funding and an extension from JISC in order for the eProfile developers to do the work. The additional work [1] included delivering the FOAF profiles from the web service in an XML format, allowing more FOAF fields in the profiles, some enhancements to the applet, and some suggestions for re-factoring. The additional work has been completed, and updated versions of the toolkit components will be integrated into the demo installation in due course.

Output and Results

Demo available at: http://flounder.oucs.ox.ac.uk:8080/frockle/

Download available at: http://downloads.oucs.ox.ac.uk/frockle/

FROCKLE repository:

https://svn.oucs.ox.ac.uk/projects/vle/frockle

eProfile repository (incl Frockle contributions):

svn://chimera70.essex.ac.uk/eProfileClient

svn://chimera70.essex.ac.uk/eProfileWebService

Implications

All of the code produced is available in the FROCKLE and eProfile repositories. The Frockle repository does depend on the eProfile repository being available, so it is arguable that we should keep a local snapshot as a backup. The software developed was not integrated into the production VLE service during the life of the project, due to time constraints and concerns about its maturity, but the work will be taken up again during the current migration of the institutional VLE from Bodington to Sakai.

Conclusions (optional)

  • applet not ideal, caused problems in some browsers
  • FOAF not particularly widely used
  • Uptake by users would probably be slow, as the potential benefits aren't clear.
  • lots of interesting research
  • better not to try to produce outcome suitable for integration into production VLE service during project life, as time scales were too short, and it complicated development, would've been better to concentrate on a simple demonstrator to be enhanced after the project ended.
  • would've been better to undertake a project where work was already underway, or there is an overlap with other work, as time scales are too short to go through full cycle of initial concept, execution

Recommendations (optional)

[1] http://wiki.oucs.ox.ac.uk/ltg-public/Frockle/ToolkitEnhancementRequirements

LTGPublicWiki: Frockle/FinalReport (last edited 2013-05-20 11:29:48 by localhost)