Medsphere FM Projection

Copyright (c) 2007-2010 Medsphere Systems Corporation

----

Medsphere FM Projection is a set of tools that allow developers and analysts
to inspect File Manager (aka FileMan and FM) data and structures using SQL
like representations.  FM Projection does this by "projecting" the FM data
and structures which can be viewed via standard database query and reporting
tools.  Included is a Java-based visualizer tool that can also be used to
configure what files and fields to project.

Architecture
------------

The FM Projection technology enables the ability to "project" the native
FileMan data structures into a form that looks like standard relational
database structures. "Projection" means that the data continues to be stored
natively in FileMan structures, but is presented in an alternate format.  There
is no duplication or synchronization of data, however the performance is better
suited to reporting and dashboard type applications.

FM Projection leverages (and thus is dependent on) the MySQL project in two
major areas:

1) By creating a data storage engine to MySQL, FM Projection does not need to
know, understand or maintain any knowledge of the SQL query language/standard.
FM Projection simply presents the necessary interfaces to MySQL and allows
MySQL's mature, optimized, and supported query engine to manage the requests
and results.

2) Because the FileMan data is provided to MySQL for management, any projected
data elements are available natively within the MySQL client tools.  That means
that pure SQL queries are available, as are data access interfaces such as
those used by Ruby, PHP, PERL, etc.  Additionally, MySQL has several open
database connectivity interfaces (ODBC/JDBC) that allow "off the shelf" query
and reporting tools access to the underlying data.

In other words, FM Projection enables access to OpenVista data in standard
tools that analysts can use without requiring specific skills or knowledge of
FileMan.  It also could be expanded to integrate more closely with other open
source projects such as Pentahoe or Jasper.

FM Projection is currently of pre-alpha quality, with little packaging and
documentation. The tool is limited to read-only access. We believe this is the
type of tool that is ripe for open source collaboration as generalized
reporting is something that all organizations are interested in improving.

There are three main components to FM Projection:

1) The MySQL storage engine code that interfaces with OpenVista's RPC Broker
2) The MUMPS code that uses FileMan data to respond to requests from MySQL
3) FMVis, a Java-based user interface for browsing the FileMan data structures
and controlling which files and fields are projected

Licensing
---------

Various pieces of Medsphere FM Projection are made available under different
licenses.  The details of all the pieces are laid out in the LICENSES file.

Collaboration
-------------

Medsphere FM Projection is part of the larger open source project. Aspects of
the design, requirements definition, development, and testing are done in the
community. Medsphere.org is the central location for this collaborative
development process.

Medsphere.org provides all participants access to the solution development
process and a voice in how the system evolves.  You can download open source
software, start discussions, host projects, build clinical content/best
practices, ask questions, make suggestions and blog about progress.

 * Collaborate 24 x 7
 * Share in the improvement of healthcare
 * Influence the OpenVista roadmap
 * Get answers to your questions from experts, peers, colleagues and others

For a tour of the community or to register go here: http://medsphere.org/tour/

Requirements
------------

The MySQL storage engine requires a recent version of MySQL.  We have tested
the storage engine on MySQL 5.1.37 and 5.1.38, but older versions may work.

The KIDS build should be installed on OpenVista Server 1.5 Service Pack 2.  As
the code matures, it may be included upstream in OpenVista Server.

FMVis requires Java 1.6.

Building & Running
------------------

Please review the INSTALL document for information on building and running the
application.

Release Notes
-------------

The accompanying NEWS file lists defect corrections and enhancements included
in each release.