Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: I made some spelling and punctuation changes.

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

...

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:

Anchor
reference
reference
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

...

       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

           Now try accessing openmrs from the browser(localhost:8080/openmrs). You should be redirected to the login page. (default username/password is admin/Admin123)) or (Windows + R > %appdata%>OpenMRS>Modules), and all the OWA files in your owa folder, and restart the web server.

Anchor
legacyui
legacyui
Installing the Legacy UI module

Anchor
legacyui_impl
legacyui_impl

...

For Implementers

  1. Get the latest version of the legacyui module from the OpenMRS Module Repository
    Go to https://

    modules

    addons.openmrs.org/#/

    search and search for legacyui and download

    show/org.openmrs.module.legacy-ui-module 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. ) 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 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.