root/his/tags/1.5.0/README.txt

HIS is a hospital information system currently in development.

For more information see http://www.joiningtracks.org

--------------------------------------------------------------------------------
Environment setup
--------------------------------------------------------------------------------

1. Installing MySQL 5.0.x.

   - Download MySQL 5.0.x from http://dev.mysql.com/downloads/mysql/5.0.html#downloads
   - Install MySQL according to the installation instructions.

  Development
   - Create a new database called 'build_his'.
   - Create the MySQL user 'build'
   - Grant user 'build' access to the 'build_his' database

   - Change 'data/src/test/resources/test.properties'
     with the right database connection parameters. For an overview of the parameters, see the previous item.
     The following properties need to be changed (default value is displayed):
        jdbc.url=jdbc:mysql://localhost:3306/his?useUnicode=true&characterEncoding=utf8&characterSetResults=utf8
        jdbc.username=build
        jdbc.password=build

   - Change 'configuration/default/tomcat/conf/his.properties'
     with the right database connection parameters. For an overview of the parameters, see the previous item.
     The following properties need to be changed (default value is displayed):
        jdbc.url=jdbc:mysql://localhost:3306/his?useUnicode=true&characterEncoding=utf8&characterSetResults=utf8
        jdbc.username=build
        jdbc.password=build

  Production / local testing
   - Create a new database called 'his'.
   - Create the MySQL user 'his-user'
   - Grant user 'his-user' access to the 'his' database
   - Change 'configuration/production/tomcat/conf/his.properties'
     with the right database connection parameters.
     The following properties need to be changed (default value is displayed):
        jdbc.url=jdbc:mysql://localhost:3306/his?useUnicode=true&characterEncoding=utf8&characterSetResults=utf8
        jdbc.username=his-user
        jdbc.password=password

2. Installing eXist 1.2.1.

   For healthrecords a XML database is used, in our case the open source XML
   database eXist. The release we use is: 1.2.1..

   - Download eXist 1.2.1 from http://exist.sourceforge.net/download.html
   - Start the installation by running 'java -jar eXist-xxx.jar'
   - See http://exist.sourceforge.net/quickstart.html for more information
   - Open http://localhost:8080/exist/admin/admin.xql with username admin
   - Create the collection: /his/healthrecords
   - Create user 'build'.
   - Assign build as owner of the collection /his/healthrecords
   - Change 'data/src/test/resources/test.properties'
            'configuration/default/tomcat/conf/his.properties'
            'configuration/production/tomcat/conf/his.properties'
     to contain the right eXist connection parameters.
        xmldb.url=xmldb:exist://localhost:8080/exist/xmlrpc/db
        xmldb.username=build
        xmldb.password=build

3. Installing LDAP

   Patients are also stored in an LDAP directory, to allow integration with the Calendar Server.
   So to fully test the system, you will have to setup an LDAP directory
   and configure his.properties file accordingly to match your setup.
   Installing LDAP is not covered here. We currently use Apple Open Directory in the production environment.

   - Change 'data/src/test/resources/test.properties'
            'configuration/default/tomcat/conf/his.properties'
            'configuration/production/tomcat/conf/his.properties'
     to contain the right LDAP connection parameters.
        ldap.url=ldap://localhost:389
        ldap.baseDn=dc=kantoor,dc=obesitaskliniek,dc=nl
        ldap.userDn=uid=helpdesk,cn=users,dc=kantoor,dc=obesitaskliniek,dc=nl
        ldap.password=password

4. Installing Calendar Server

   We currently use Apple Calendar Service (http://www.apple.com/server/macosx/features/ical.html)
   in the production environment. This is an open source calendar service that can be installed without using
   Mac OS X Leopard Server. You need to have Python installed, as it is written in Python.
   For more information, see: http://trac.calendarserver.org/
   - Install the Calendar Service by following the instructions found at
     http://trac.calendarserver.org/wiki/QuickStart
   - Normally, Calendar Server uses Open Directory for authentication. For testing locally, you can create
     an accounts-test.xml with usernames and passwords. See http://trac.calendarserver.org/wiki/XMLDirectoryService
     for more information. Create an admin user in the file accounts-test.xml:
     <accounts realm="Test Realm">
        <user>
            <uid>admin</uid>
            <guid>admin</guid>
            <password>admin</password>
            <name>Super User</name>
        </user>
     </accounts>

   - Change 'data/src/test/resources/test.properties'
            'configuration/default/tomcat/conf/his.properties'
            'configuration/production/tomcat/conf/his.properties'
     to contain the right Calendar Server connection parameters.
        caldav.host=localhost
        caldav.port=8010
        caldav.root=/calendars/
        caldav.username=admin
        caldav.password=admin

5. Installing the certificate for the communication with the Vecozo webservice.

    We use one of the Vecozo webservices to verify and support the creation of new patients in the system.
    To make a secure connection to the Vecozo webservice we need to do some configuration.

    - Open the 'vecozo/src/main/resources/vecozo-client.properties'
    Change the following properties to:
    webservice.endpoint.uri=https://uri.to.the.secure.webservice/webservice/
    truststore.location=/location/to/certificate.extention
    truststore.password=thepasswordofthecertificate

    Make sure you use secured http (https://) connection instead of a regular http connection (http://)

--------------------------------------------------------------------------------
Running HIS
--------------------------------------------------------------------------------

* Deployment / Development mode

        You have to specify a Java System property called "config.directory" and give
        it the value of the directory on the filesystem where the configuration files
        are located. Typically, this is done by using the -D option on the
        commandline. When using the StartSite convenience runner, this property is set
        to the development configuration directory for you automatically.

        There are three means to configure Wickets configuration mode and they are
        tested in the order given.

       1) A system property: -Dwicket.configuration
       2) servlet specific <init-param>
       3) context specific <context-param>

        The value might be either "development" (reloading when templates change)
        or "deployment". If no configuration is found, "development" is the default.

        ~

        By default, HIS internal frontend will run in "deployment" mode, as configured
        via option 2, in web.xml. The StartSite runner sets a system property.