root/his/trunk/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 DATABASE build_his DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
   - Create the MySQL user 'build'
   - Grant user 'build' access to the 'build_his' database
     GRANT ALL ON build_his.* to 'build'@'localhost' IDENTIFIED BY 'build';
     GRANT ALL ON build_his.* to 'build'@'%' IDENTIFIED BY 'build';

   - Create a new database called 'build_questionnaire'.
     CREATE DATABASE build_questionnaire DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
   - Grant user 'build' access to the 'build_questionnaire' database
     GRANT ALL ON build_questionnaire.* to 'build'@'localhost' IDENTIFIED BY 'build';
     GRANT ALL ON build_questionnaire.* to 'build'@'%' IDENTIFIED BY 'build';

   - 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 DATABASE his DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
   - Create the MySQL user 'his-user'
   - Grant users 'build' and 'his-user' access to the 'his' database
     GRANT ALL ON his.* to 'his-user'@'localhost' IDENTIFIED BY 'password';
     GRANT ALL ON his.* to 'his-user'@'%' IDENTIFIED BY 'password';
     GRANT ALL ON his.* to 'build'@'localhost' IDENTIFIED BY 'build';
     GRANT ALL ON his.* to 'build'@'%' IDENTIFIED BY 'build';

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

   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.type=apple
        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

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