Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

The new OpenMRS Platform (as from 2.0) does not have a user interface. After successfully installing the platform, you will need to install one of the available user interface modules. This wiki will document how to install the legacyUI and the Reference Application on top of the platform.

Note: A successful installation of Platform 2.0 means you reached up to the point where you see a page telling to install a user interface module.

...

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

      2. Building the code

           cd openmrs-module-legacyui
           mvn clean install

       3. Installing into openmrs

           After successfully building the legacyui, we now need to install it into our openmrs instance. To do this

  • Look for a .omod file inside  openmrs-module-legacyui/omod/target. It should be something like  legacyui-1.0-SNAPSHOT.omod.
  • Copy the file and paste to ${HOME}/.OpenMRS/modules. Note: if you are on windows,  ${HOME} is usually the my documents folder.

       4. Verifying the installation

           First you need to restart openmrs. To restart here means cancel the already running instance of jetty (using CTRL + C) and then run

           mvn jetty:run

...

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 were looking for a full OpenMRS distribution, you may want to remove this installation, and install one of the out-of-the-box OpenMRS Distributions (like the Reference Application).

If you intend to be running the OpenMRS Platform, and you want to add a community-supported user interface on top of it, you have a couple options:

Anchor
reference
reference
Installing the Reference Application

 

Warning

At the time of writing, the Reference Application does not run on top of OpenMRS Platform 2.x.

Reference Application 2.4 release (scheduled for the first half of 2016) will run on Platform 2.x. If you want detailed status on this you can follow it here:

Jira Legacy
serverOpenMRS JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId45c5771b-fa4b-3e43-b34a-c19dc45ccc95
keyRA-954

 

Anchor
legacyui
legacyui
Installing the Legacy UI module

Anchor
legacyui_impl
legacyui_impl

...

For Implementers

Warning

The Legacy UI module has not yet had its first public release, so it is not yet available at modules.openmrs.org. As of today you would need to manually build the legacyui module, as described in the For Developers section.

 

  1. Get a released version of the legacyui module from the OpenMRS Module Repository
    Go to https://modules.openmrs.org/#/search

    and

     and search for legacyui and download the latest version. 

  2. Installing Install the module
    After the download completes, copy the .omod file (legacyui-{versionNumber}.omod) into the modules directory  directory of your OpenMRS Installation app data folder (e.g. ${HOME}./OpenMRS/modules). Now you have to restart openmrs to load the module.
  3. Restart OpenMRS
    You can do this by either stopping and starting openmrs from tomcat manager page or just restart tomcat. The default username/password is admin/Admin123

...

  1. restarting tomcat.

 

Anchor
legacyui_dev
legacyui_dev
For Developers

  1. Get the latest version of the legacyui module code

    Code Block
    git clone https://github.com/openmrs/openmrs-module-legacyui.git
  2. Build the module

     

    Code Block
    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.