MSH / eTBManager2

e-TB Manager is a web or desktop-based tool for managing all the information needed by national TB control programs. This tool was created by the USAID-funded Systems for Improved Access to Pharmaceutical and Services (SIAPS) Program implemented by Management Sciences for Health. See the README below for more info.

  

e-TB-manager-Server

The SIAPS Program is funded by the U.S. Agency for International Development (USAID) under cooperative agreement AID-OAA-A-11-00021 and implemented by Management Sciences for Health. The information provided on this web site is not official U.S. Government information and does not represent the views or positions of the U.S. Agency for International Development or the U.S. Government.

Disclaimer of warranties and limitation of liability

The e-TB Manager software, documentation and other products, information, materials and services provided by Management Sciences for Health (MSH or Licensor) are provided “as is.” Licensor hereby disclaims all warranties, whether express, implied, statutory or other (including all warranties arising from course of dealing, usage or trade practice), and specifically disclaims all implied warranties of merchantability, fitness for a particular purpose, title and non-infringement. Without limiting the foregoing, licensor makes no warranty of any kind that this software or documentation, or any other licensor or third-party goods, services, technologies or materials (including any software or hardware), or any products or results of the use of any of them, will meet the users’ or other persons' requirements, operate without interruption, achieve any intended result, be compatible or work with any other goods, services, technologies or materials (including any software, hardware, system or network), or be secure, accurate, complete, free of harmful code or error-free. Licensor is not responsible for further development or any future versions of e-TB Manager.

Copyright Management Sciences for Health.

Architecture

In terms of software architecture, e-TB Manager has the following specification:

• Database: MySQL 5.6+
• Language: Java 1.6+ using JEE 1.5
• Application server: JBOSS AS 4.2.3.GA (customized)

Getting started

Pre requisites In order to build e-TB Manager from the source code, you will need the following programs installed:

• Java JDK 1.6+
• Maven 3+
• JBOSS 4.2.3.GA, in order to run the application in development side

The version of JBOSS AS in use was customized with some specific libraries, like the MySQL and Hibernate libraries. You may download JBOSS AS used in e-TB Manager here.

Development tools

Any JEE development environment of your choice - Recommended: IntelliJ for development

Installation instructions can be found in the site of each one of these programs.

Frameworks and libraries

Below is the list of frameworks and libraries used in e-TB Manager.

• JPA 1.0 (baked by Hibernate 3.3);
• JSF 1.2;
• JBOSS SEAM 2.1;
• Spring JPA, using Hibernate;
• Apache common libs;
• Liquibase for automatic database upgrade;

Client side

• jQuery 1.8;
• RichFaces 3 (JSF components);

All these frameworks are automatically loaded by Maven, so the list is just a reference.

Development environment

You need the following tools in order to start development:

• Git
• Java 1.6+
• Maven 3+
• MySQL 5.6+

A development environment of your choice (IntelliJ recommended)

Downloading the source code

The source code is stored in a Git repository. To download the code, issue the git command.

git clone https://github.com/MSH/eTBManager2.git

You will need a user name and password for that. Inside the repository, there are two main branches: master and development. The master contains the stable version, and should be merged with stable versions achieved in the development branch. So, if you want to change the code, move to the development branch:

git checkout development

When you finish your changes, perform the following git sequence (as described in the git documentation): Add all changed files to be committed

git add .

Commit the changes providing a good description

git commit -m "description of the changes"

Upload the changes to the remote server

git push origin development

Building from the source code

In order to generate a new version of e-TB Manager from the source code, you must issue the following Maven command:

mvn clean package

This will download all necessary dependencies and generate a new version in `target/etbmanager.war.

Configuration file

Before running e-TB Manager, it is necessary to create two configuration files in the /server/default/deploy/MSH:

• etbmanager-ds.xml - Configure how e-TB Manager will connect to the database;
• etbmanager-service.xml - Configure a SMTP server that e-TB Manager will use to dispatch e-mail messages;

There is an example of both files in the /resources folder.

Running e-TB Manager

1. In order to run e-TB Manager, you need to have installed the following softwares:

• Java Virtual Machine 1.6+
• custom JBOSS 4.2.3.GA

Go to the vendor website and search for instructions on how to install these products.

2. Copy the generated file \target\etbmanager.war to the folder <jboos>/server/default/deploy/MSH This version of JBOSS supports hot deployment, so you may replace the war file at any time to have it deployed again by JBOSS AS.

3. Make sure the configuration files are correctly configured (check previous section).

4. When you run JBOSS AS, e-TB Manager will be available in the local machine at http://localhost:8080/etbmanager.