User Interface Modules

Why Are You Here?

You are probably seeing this page because you installed the OpenMRS Platform, and saw a nearly-empty screen that linked you here, instead of the EMR you were expecting to see.

Starting with version 2.0 the OpenMRS Platform does not include a built-in user interface. The rationale is that this will enable people to build all sorts of different OpenMRS distributions, using completely different web technologies to build different user interfaces. However, this can be confusing if you installed the raw OpenMRS Platform, but you were looking for a full OpenMRS Distribution (like the Reference Application).

What Can You Do?

If you are a "typical" OpenMRS user and you are looking for a complete OpenMRS application, you probably want to remove this installation, and replace it with one of the out-of-the-box OpenMRS Distributions (like the Reference Application).

If you're sure that you want this version of the OpenMRS Platform, and you want to add a community-supported user interface on top of it, you have a couple of options:

• OpenMRS Reference Application 2.x

• Legacy UI module (the same UI that was included with OpenMRS Platform 1.x)

Installing the Reference Application

If you are already running the OpenMRS Platform, then you need to add quite a few modules to be running the full Reference Application. You can get these by going to http://openmrs.org/download and looking for a link like "Download Reference Application (version number) Addons". (Make sure to get the version of the reference application that corresponds to the platform version that you are running. Unzip that file, and put all the OMOD files in your modules folder(e.g. ${HOME}/.OpenMRS/modules) or (Windows + R > %appdata%>OpenMRS>Modules), and all the OWA files in your owa folder, and restart the web server.

Installing the Legacy UI module

For Implementers

1. Get the latest version of the legacyui module from the OpenMRS Module Repository
   Go to https://addons.openmrs.org/#/show/org.openmrs.module.legacy-ui-module and download the latest version. 

2. Install the module
   After the download completes, copy the .omod file (legacyui-{versionNumber}.omod) into the modules directory of your OpenMRS app data folder (e.g. ${HOME}/.OpenMRS/modules) or (Windows + R > %appdata%>OpenMRS>Modules).

3. Restart OpenMRS
   You can do this by either stopping and starting openmrs from tomcat manager page or just restarting tomcat.

For Developers

1. Get the latest version of the legacyui module code
   
   

   git clone https://github.com/openmrs/openmrs-module-legacyui.git

    

2. Build the module

   cd openmrs-module-legacyui mvn clean install

    

3. Install the module
   After successfully building the legacyui module, you will find it at openmrs-module-legacyui/omod/target/legacyui-{version}-SNAPSHOT.omod.
   Take this file and install it, as described in the For Implementers section.

4. Restart OpenMRS
   If you are running jetty in a typical dev environment setup, then kill the already running instance of jetty (CTRL + C) and then run "mvn jetty:run" again.