Introduction

This document describes the steps to create a plugin to change the UI labels in UI 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. Lets say Henceforth the exploded plugin directory is referred as $PLUGIN_HOME to exploded directory. 
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 to labels 
      1. "Collection Protocols" to "Studies"
      2. "Create Collection Protocol" to "Create Study"
      3. "Title" to "Study Name"

   3.  Add below JSON into opened in en.js file.  For keys of the values search in To know what key values to be overridden, please search en.js file of the OS code with existing name of core app by UI labels. 

      Code Block
      language js
      { "cp": { "list": "Studies", "create_cp_title": "Create Study", "title": "Study Name" } }

      
      

4. Change server 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 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 opened in messages.properties file. For keys of the messages search in messages.properties file of the OS code with existing message To know what key values to be overridden, please search messages.properties of core app by messages. 

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

         
         

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