Introduction

This document describes the steps to create a plugin to change the UI labels and API error messages. This guide is intended for developers or technical IT staff.

Steps

1. Download the sample plugin.
2. Extract the downloaded plugin zip into a directory. Henceforth the exploded plugin directory is referred as $PLUGIN_HOME.
3. Change UI labels :- We need to add key and value of the labels into en.js file. It will override the default labels specified in OpenSpecimen. Follow below steps 
   1. Open the file $PLUGIN_HOME/src/main/webapp/app/i18n/en.js
   2. Suppose we want to change below labels 
      1. "Collection Protocols" to "Studies"
      2. "Create Collection Protocol" to "Create Study"
      3. "Title" to "Study Name"

   3.  Add below JSON in en.js file. To know what key values to be overridden, please search en.js of core app by UI labels. 

      {
      	"cp": {
            "list": "Studies",
            "create_cp_title": "Create Study",
            "title": "Study Name"
        }
      }

4. Change API error messages :- We need to change the messages specified in messages.properties file. It will override the default messages specified in OpenSpecimen.
   1. Open the file $PLUGIN_HOME/src/main/resources/errors/messages.properties
   2. Suppose we want to change below error message 
      1. "Collection Protocol with same title {0} already exists." => "Study with same title {0} already exists."

      2. Add below property in messages.properties file. To know what key values to be overridden, please search messages.properties of core app by messages. 

         cp_dup_title=Study with same title {0} already exists.

5. To create the plugin JAR, execute the below commands from $PLUGIN_HOME directory :
   gradle clean; gradle build
6. The plugin JAR will get created at ${PLUGIN_HOME}/build/libs/os-messages-1.0.0.jar
7. Copy the plugin JAR to OS plugins directory.
8. Restart the Tomcat app server.