Page Comparison

Background

1. The Bahmni EMR is a client-side application, built in AngularJS and HTML, and it interacts with the OpenMRS back end using REST web services. 
2. Bahmni also includes a regular OpenMRS module called bahmni-core that provides additional server-side functionality. 
3.  Bahmni team has forked OpenELIS for Lab Test Workflow, and reporting. And the team has written modules for OpenERP (Odoo) for Inventory and Billing. 
4. To integrate all three sub-systems (OpenMRS, OpenERP and OpenELIS) the team wrote an ATOM Feed based integration module, that allows data to flow across the three sub-systems.
5. You can refer to Bahmni Architecture here: Architecture 

Dependencies to Install

Please ensure that the following dependencies are installed on your machine.

1. Git version control

2. Node.js

3. Oracle (Sun) JDK 7

4. Maven

5. Ruby v2.1 (or above) - Needed by Compass to compile the SCSS files.

First Time Setup

# Soft Link bahmni_config to default-config folder
sudo ln -s /bahmni/default-config /var/www/bahmni_config

One time setup steps

To get started as a Developer, who will contribute to Bahmni Hospital Management system, you need to install appropriate libraries, pull the code from GIT, compile the code, and then link your vagrant sub-folders, to your code folders - so that any changes you make to the Bahmni code will reflect in vagrant box. If you don't link the folders, then you will need to copy the compiled artifacts to the right location in the vagrant box. 

Dependencies to Install

Please ensure that the following dependencies are installed on your machine:

1. Git version control

2. Yarn

3. Node.js (v10.11.0)

4. Oracle (Sun) JDK 8

5. Maven

6. Ruby v2.1 (or above) - Needed by Compass to compile the SCSS files.

7. Install Firefox to run tests in bahmni apps.

8. Talisman as a Pre-Commit Hook. (It is highly recommended to setup talisman for secret scanning)

TIP: node can be easily installed using nvm

Install Compass

Install Bower, Grunt and Compass

npm install -g bower
npm install -g grunt-cli
gem install compass         # you may need to use sudo to install Ruby gem compass ...

If you have problems with the installation, e.g. of compass, please have a look here: Troubleshooting development tool installation problems

Clone the code

Clone bahmni code into a folder (shown here as /Projects/bahmni)in the same folder where you have bahmni-environment sub-folder. Each clone command creates a sub-folder with the repository name.

cd /Projects/bahmni
# clone the default configuration (some folks may choose their project specific config like jss-config)
git clone https://github.com/BahmniBhamni/default-config.git
# clone Bahmni EMR UI project
git clone https://github.com/BahmniBhamni/openmrs-module-bahmniapps.git
# clone the Bahmni Core backend project
git clone https://github.com/BahmniBhamni/bahmni-core.git
# clone the common java utils used across the project
git clone https://github.com/BahmniBhamni/bahmni-java-utils.git

Clone all the Bahmni related repos using a Script

The script below helps to clone all the Bahmni related repos one by one.

# This command will clone all repositories of Bahmni to /tmp/src/bahmni path. It will create /tmp/src/bahmni path if its not already there
curl -s https://raw.githubusercontent.com/Bahmni/utilities/master/dev/clone-bahmni-repos.sh > /tmp/clone-bahmni-repos.sh
bash /tmp/clone-bahmni-repos.sh -d /tmp/src/bahmni

Prepare and Build Bahmni EMR UI

The following commands will build the Bahmni EMR UI application. Make sure yarn have npm, bower and grunt-cli have been installed on your machine as mentioned on top of this document.

# Go into the UI directory
cd openmrs-module-bahmniapps/ui

 
# Install node dependencies (Installed node dependencies into node_modules).
npm UIinstall
dependencies# areSet installedup inUI node_modules/@bower_components and create a soft link tocomponent/dependencies (This installs all the UI dependencies into app/components).
yarnbower install

# Run tests, and check test coverage (required before the next step)
yarn clean test

# Build the application (into dist folder) yarnusing Grunt
defaultgrunt
 

Create Links to your Host Machine Folders for EMR UI

Now link your host machine compiled code with the Vagrant vagrant filesystem, so that Apache running inside Vagrant vagrant picks up your compiled code (basically softlinks are created inside Vagrantvagrant)

# DoGo thisback from insideinto the vagrant boxopenmrs-module-bahmniapps folder (usenot 'vagrant ssh' to enter it)ui folder)
cd openmrs-module-bahmniapps

# WARNING DO THIS ONLY IF YOU HAVE COMPILED THE UI CODE ALREADY ON YOUR MACHINE. ELSE YOUR EMR UI WON'T WORK
# IF YOU ARE ONLY DOING IMPLEMENTATION SPECIFIC UI CHANGES, THEN MAYBE YOU ONLY NEED TO LINK READ THE CONFIGWARNING FOLDER
# AND NOT THE bahmniapps FOLDER. IF YOU ARE UNSURE, PLEASE ASK SOMEONE FROM BAHMNI COMMUNITYNOTE ABOVE.

# renamelinks theapp original folder
for backup
sudo mv /var/www/bahmniapps /var/www/bahmniapps-original

# (Option 1 - Simple) Create a link to your UI 'dist' folder
# - run the 'yarn default' build command (from your dev machine) to see your changes reflected
sudo ln -s /bahmni/openmrs-module-bahmniapps/ui/dist/ /var/www/bahmniapps

# (Option 2 - Advanced) Create a link to your UI 'app' folder
# - changes to HTML and JS files will be reflected immediately
# - run the 'yarn compass' command (from your dev machine) to see CSS changes reflected
sudo ln -s /bahmni/openmrs-module-bahmniapps/ui/app /var/www/bahmniapps
 
# Make the user bahmni owner of this new link
sudo chown -h bahmni:bahmni /var/www/bahmniapps./scripts/vagrant-link.sh
# links dist folder
./scripts/vagrant-link.sh dist

You will notice that after executing the above link commands, new soft links will get created in /var/www inside your vagrant box, linking to your machine. 

BEFORE: 

AFTER:

Linking Implementation Configuration Folder

# Do this from inside the vagrant box (use 'vagrant ssh' to enter it)
 
# backup the original config folder
sudo mv -b /var/www/bahmni_config /var/www/bahmni_config-original
# Link your config folder (here we are linking the default-config folder)
sudo ln -s /bahmni/default-config /var/www/bahmni_config
# Make bahmni user the owner for this new link
sudo chown -h bahmni:bahmni /var/www/bahmni_config cd /Project/default-config  # or jss-config, etc
 
# Link the configuration
./scripts/vagrant-link.sh

CONFIG LINKED:

Development on the Bahmni AngularJS app

You have checked out the Bahmni application code (remember, it’s a client-side AngularJS application) on your local machine at

/Projects/bahmni/openmrs-module-bahmniapps/ui/.

You may use whatever development tools you prefer, for editing html + js + css. If you are going to be working on both client-side and server-side code, you’ll probably want to use a Java IDE like IntelliJ or Eclipse. But if you’re purely working on the client-side app you can use something more web-focused.

Editing HTML files

(If you took the advanced linking approach) You can directly edit HTML files and see the changes reflected.

Editing JS files

files

(If you took the advanced linking approach) You can directly edit javascript files and see the changes reflected.

Editing CSS files

In Bahmni, CSS is written using SASS, and therefore after you edit a .scss file you need to compile everything by going to openmrs-module-bahmniapps/ui and running:

# if you took the simple linking approach
yarn default


# if you took the advanced linking approach
yarn compassgrunt

For example, edit the file /Project/bahmni/openmrs-module-bahmniapps/ui/app/styles/bahmni-helper/_base.scss by changing the color of the body element from $text to #ff0000, then build with `yarn default`grunt.

Developing OpenMRS Java modules

All OpenMRS modules that Bahmni uses (as third party modules), or those created by Bahmni team themselves, are stored in either: /home/bahmni/.OpenMRS/modules (old location) or in /opt/openmrs/modules (new location) folder. Check your vagrant box to see the current location. If you want to change or add a new OpenMRS/Bahmni module, you should perform the following steps.

# Stop OpenMRSTomcat
sudo service systemctltomcat stop openmrs
 
# Copy the module to the modules
directory
cp module_name.omod /opt/openmrs/modules
 
# For older installations prior to 0.81, copy to the older modules directory
cp module_name.omod /home/bahmni/.OpenMRS/modules
 
# Start OpenMRSTomcat
sudo systemctlservice tomcat start openmrs

This section is for implementers who wish to debug / extend Bahmni Java modules

# Go to the appropriate project directory
cd bahmni-core
 
# Build the module using maven
mvn clean install 

Debugging Code Running in Tomcat

Set up Host - Guest Port Connection for Debug

After that you will need to connect the port 8000 of your guest and host, by editing the VagrantFile on the host OS in bahmni-vagrant folder.

in

Tomcat

To debug code running in tomcat, you need to start tomcat in debug mode, so that it opens a port for you to connect your IDE to it (via Remote Debugger). You will need to do the following: 

title

Code Block
Debugging through vagrant	# LogInside intoyour yourvagrant, Vagrantstop boxtomcat usingvagrant ssh orsudo su PuTTYbahmni cdsudo bahmni-vagrantservice vagranttomcat sshstop   # RestartStart openmrstomcat in debug mode. By default, openmrs opens port 8000 for java debugging # CAUTION: It is to be noted that, alternate usage of systemctl and service command may lead to inconsistency of the openmrs service being started. (jdpa) sudo service openmrs stop sudo service openmrs debug # Stop iptables so that host machine can connect to port 8000 successfully sudo service iptables stop # Optional. From your host machine. Run following command and check if port 8000 is open. nmap -v -sT 192.168.33.10

Now on the host OS

cd /home/bahmni/apache-tomcat/bin sh catalina.sh jpda start   #In the log file you should see the debug port is opened 8000 cd /home/bahmni/apache-tomcat/logs cat catalina.out | grep 8000 # Output: Listening for transport dt_socket at address: 8000

After that you will need to connect the port 8000 of your guest and host, by editing the VagrantFile

Code Block
# Add this line in your Vagrantfile config.vm.network :forwarded_port, guest: 8000 host: 8000

Now you can open the Remote Debugger in Eclipse/IntelliJ (or any IDE), and connect to port 8000 to debug your code.

Debug ports for Bahmni related projects

To debug other projects, the required forward port should be set in vagrantfile as mentioned above

Project

Debug Port

Audit Log

8000

Bahmni-core

8000

Bahmni-labs

8001

Bahmni-erp-connect

8002

Bahmni-reports

8003