...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
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.
...
Download plugin
...
Download or clone the sample plugin and extract the downloaded plugin zip into a directory. Henceforth from git. Henceforth the exploded plugin directory (i.e: custom-resources) is referred as $PLUGIN_HOME.
Resources files
All labels and messages are stored in the locale based resource files. There are two resource files:
en.js: The default English resource file for user interface labels /and messages (e.g. fields displayed in a page).messages.properties: The default English resource file for messages generated by the backend (e.g. an unique constraint violation error).
Changing UI labels
You can create your own en.js file in your plugin and override the resources you need to change.
...
| Code Block | ||
|---|---|---|
| ||
{
"cp": {
"list": "Studies",
"create_cp_title": "Create Study",
"title": "Study Name"
}
} |
Change API error messages
- Open the file
$PLUGIN_HOME/src/main/resources/errors/messages.properties - Suppose we want to change below error message
"Collection Protocol with same title {0} already exists." to "Study with same title {0} already exists."
...