Versions Compared

Key

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

Table of Contents

...

This document describes the steps to create a plugin for OpenSpecimen. This guide is intended for developers or technical IT staff. To write a plugin one should be aware of the OpenSpecimen domain structure.

As a developer you are expected to have working knowledge of:

  1. Using REST APIs.
  2. Java Spring
  3. Angular JS

Following are high level steps:

  1. Install /Setup pre-requisite prerequisite software which can be downloaded from http://demo.openspecimen.org/releases/Prerequisites/
  2. Download the plugin skeleton os-plugin.zip  
    View file
    nameos-plugin.zip
    height250
  3. Unzip the downloaded file into a directory.

Prerequisites

Following table lists pre-requisites prerequisites and their supported versions.

...

Keyword

Comment

PLUGIN_HOME

Directory where plugin source code is kept. For example, F:\os-plugin.

JAVA_HOME

Directory where JDK is installed. For example, C:\JDK1.8

Steps to add custom

...

Java classes:

  1. Please add all your java Java classes under PLUGIN_HOME/src/main/java/com/krishagni/openspecimen
  2. All the Spring configuration should be done in PLUGIN_HOME/src/main/resources/pluginContext.xml

Steps to create plugin archive

The build system uses Gradle to manage code compilation, building plugin jar archive. 

...