How to build OpenSpecimen plugin jar?

 

Introduction

This document describes the steps to build plugin from source code and to set up the development environment for OpenSpecimen plugin development. This guide is intended for developers or technical IT staff. The following are the high level steps of building OpenSpecimen plugin code:

  1. Install/Setup pre-requisite software. These pre-requisites can be downloaded at http://demo.openspecimen.org/releases/Prerequisites/
  2. Checkout the code from GitHub: https://github.com/krishagni/os-extensions
  3. Run Gradle commands to build the plugin.

Prerequisites

The following table lists the supported versions of prerequisites.

Pre-requisite

Version

JDK

1.8

tomcat

7

MySQL

5.7

Oracle

11g

Gradle

2.0

GIT1.8
node.js10+
npm 
bower 
grunt 

Note: For database, you can choose between Oracle or MySQL. 

Environment Variables

The following table lists and describes the environmental variables

Environment Variable

Description

JAVA_HOME

The path where JDK is installed, for example: C:\JDK1.8

 

Please refer to the following notations used throughout the document.

Keyword

Comment

OS_HOME

The folder location in which the os-extensions source code is copied, for example, F:\os-extensions.

JAVA_HOME

The folder location where JDK is installed, for example, C:\JDK1.8

 

Steps to deploy

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

  1. Open command prompt. Change your current directory to the one where you checked out the code.
  2. Change directory to the respective plugin directory e.g. cd miabis for MIABIS plugin
  3. Use the following commands to build the plugin archive:

    gradle clean
    gradle build
  4. The above target will create the archive in the build directory under respective plugin module. e.g. For above module MIABIS the jar will get created at ${OS_HOME}/miabis/build/libs/os-miabis*.jar

Setup OpenSpecimen project in eclipse

Import os-extensions in eclipse

You can use the Import Wizard to import an existing project into workspace by following the below steps:

  1. From the main menu bar, File > Import.... The Import wizard opens.
  2. Select General > Existing Project into Workspace and click Next.
  3. Choose either Select root directory or Select archive file and click the associated Browse to locate the directory or file containing the projects.
  4. Under Projects select the project or projects which you would like to import.
  5. Click Finish to start the import.
  6. To set the classpath, please run the below command. The command should be run from the workspace home:
    gradle eclipse
  7. For more details refer eclipse documentation here.