Table of Contents
Vesuvius
The Modules of Vesuvius
For IT Adopters and Users
The tables below broadly delineate the modules of Vesuvius and provide an estimate of their maturity. At the overview level of description here, the tables generally apply to all versions (e.g., Vesuvius Trunk packaged, Vesuvius Trunk latest, and NLM People Locator) unless indicated otherwise. There may be more divergence with Kilauea. Modules within NLM's People Locator have been developed and supported as part of the NLM Lost Person Finder project.
Icon Definitions, used in the Tables Below
Stage of Development (as of 1st Q 2012):
Icon | Meaning |
---|---|
Stable, only minor development on-going | |
Under active development | |
New & unstable | |
An idea for the coming year |
Required versus Optional:
Other Attributes:
History:
* Vesuvius modules may have more and different features and capabilities than what are described in the Krakatoa table of User Guides. Beyond those modules indicated by this icon, many modules have some design or code influence from earlier Sahana versions.
Modules
Available modules are given by their formal names, as well as their technical abbreviations, sometimes helpful to know.
Name | Abbrev. | Req? | Brief Description | Stage | Comments |
---|---|---|---|---|---|
Administration | admin | This allows initial and on-going system configuration and control. | |||
User Preferences | pref | This permits user-specific settings. | |||
XML Streaming Module | xst | Allows streaming of XML content. | |||
Arrivals | arrive | AJAX modue to watch the realtime influx of persons. | |||
LPF Class Library | lpf | This defines PHP classes used by multiple modules. | Needed most notably by arrive, eap, em, eq, ha, inw, mpres, plus, pop, pref, rap, report, rez | ||
Hospital Administration | ha | This allows hospital administrators/emergency managers to enter & edit organizational & event data. | v2.0 completed recently with a snazzy new ajax appearance | ||
Search | inw | (Interactive Notification Wall) This offers search and display capabilities (including filtering and dynamic update) for missing and found persons reported from multiple sources (desktop web, mobile web, PFIF repository, TriagePic, ReUnite app) as replacement) to the old MPR module's search function. | Projected work involves search improvement by integration with Lucene/SOLR search engine; more flexible filters. | ||
MPR Email Service | mpres | The Missing Person Registery Email Service parses incoming information about missing & found people from TriagePic (Windows), ReUnite (iPhone), and semi-structured (vanilla) email. | Supplements the work of Person Object Provider (pop). | ||
Person Locator User Services | plus | Provides SOAP Document Literal web services, to support ReUnite, TriagePic, and other applications that wish to report or consume data from Vesuvius. | In constant fdevelopment lately : https://pl.nlm.nih.gov/plus | ||
Event Manager | em | This allows a hospital admin or Sahana admin to define and geolocate disasters/incidents/events. | |||
Resources | rez | This defines the content of the home and other web pages. It supports largely static web pages of information, arranged hierarchically, by a mini-content-management-system. HTML content is stored in the database, with a simple editor for the content provider. | Currently building out multi-language support, for context-rich whole-page translations (rather than Pootle-style phrase translation). | ||
Snapshot module | snap | This allows backup and restore of database instances, provided they are under 200MB. | Requires admin privileges. | ||
Post Office Provider | pop | This handles outbound email. | Takes over some of the 2009 functionality of mpres namely outbound email. | ||
Report | report | This is based on and supersedes mpr's 'report a person'. | Simply creates a 'stub' person record which is then handed off to EAP to edit. | ||
Edit a Person | eap | For a previously-reported person, whose record is retrieved, this allows revision or expansion. One view will support the use case of hospital personnel correcting data originally received from TriagePic. | Based on and supercedes part of mpr. | ||
Edit a Person 2 | edit | A complete re-write of the above EAP module using AJAX and DAO class objects provided by the LPF module. Will incorporate a myriad of new features. | Based on and supercedes EAP once complete. | ||
Flash Camera Picture Taking | cam | Using Flash/Shockwave technology, this allows controlled capture of a photo from a webcam. | Based on earlier Sahana framework code, modularized. | ||
Expiry Queue | eq | This allows the management of record expiration requests made by users without sufficient privileges to manually expire records. | Intended for admins. | ||
Abuse Queue | aq | This allows the management of reported abuse cases. | Intended for admins. | ||
Statistics | stat | For a particular event, this will provide all-person data in tabular and graphical form, categorized by time, status, and other features. | Analogous to hospital dashboard displays, it will offer cumulative and time-based views. | ||
TriagePic Module | tp | This exposes a face for the download of the TriagePic application for hospital personnel. | |||
People Finder Information Format | pfif | This supports supervision of data import/export in PFIF 1.2, 1.3 formats with accompanying photos. | Some of this functionality was previously within mpr. |
Third-Party Libraries Needed by Vesuvius
Name | Version (as of Jan 2012) | From | Separate Install? | Dependent Modules | Comments |
---|---|---|---|---|---|
ADODB | 5.14 | http://adodb.sourceforge.net/ | Included | required by framework | |
BrowserCaps | 0.7 | http://garetjax.info/projects/browscap/ | Included | required by framework | |
Feedwriter | http://www.ajaxray.com/projects/rss | Included | required by PFIF module | ||
HTML Purifier | 4.3.0 | http://htmlpurifier.org/ | Included | required by framework | |
NuSOAP | 0.9.5 | http://sourceforge.net/projects/nusoap/ | Included | required by PLUS module | |
PHP-Console | 1.1 | http://code.google.com/p/php-console/ | Included | optional for debugging purposes | |
PHPMailer | 5.1 | http://phpmailer.sourceforge.net | Included | required by POP module | |
SOLR | http://lucene.apache.org/solr/ | optional search enhancement for INW module | |||
XAJAX | 0.2 | http://xajax.sourceforge.net | Included | required by framework | |
ffmpeg | v0.6+ | http://ffmpeg.org/ | required by LPF module |