WARNING: This is archived. Please see openlmis-stockmanagement-validator-extension and docs.openlmis.org instead

OpenLMIS Example Extension Module

This example is meant to show an OpenLMIS 3.x Example Extension Module at work.

Prerequisites

• Docker 1.11+

Quick Start

1. Fork/clone this repository from GitHub.

git clone https://github.com/weronika-ciecierska/openlmis-example-extension.git

2. Fork/clone openlmis-example repository from GitHub.

git clone https://github.com/OpenLMIS/openlmis-example.git

3. To assemble the outputs of project and create jar file run docker-compose run builder.
4. To be able to use extension module with openlmis-example put jar file from build/libs to etc/openlmis/extensions.
5. Edit configuration file extensions.properties from openlmis-example repository to use your defined extension.
6. Run openlmis-example and go to http://<yourDockerIPAdress>:8080/extensionPoint to see that the extended implementation of OrderQuantity interface is used.

Example of extensions usage

In the sample repository, the following classes are example of extensions usage:

• AmcOrderQuantity.java - class extending OrderQuantity interface from openlmis-example repository with Component annotation that contains extension ID.

Extensions & configuration file directory

It is possible to change the path where the jar files and configuration file should be placed. It is defined in docker-compose.yml file of openlmis-example service:

volumes:
    - '/etc/openlmis/extensions:/extensions'