This guide is currently In-Progress. Over the next few months, content will be added to it.
If you have any suggestions or would like to add pages which talk about the functionality of Bahmni, please feel free to add them.
The app.json file
A typical app.json will look like this. It is the primary configuration file for an app. This will contain all app level configurations. It also defines extensions that can be used to extend the app.
app.json
{
"id": "org.bahmni.newapp", // Unique ID for an app
"extensionPoints": [
{
"id": "org.bahmni.newapp.newextension", // Unique ID for an extension
"description": "Makes cheese" // Description for what an extension can do
}
],
"config" : {"keySpecificTonewapp": true} //A custom object that can be used by the application. Each application has settings that it can use
}
The extension.json file
extension.json
{
// Multiple extensions can be configured within this file. Each needs a unique key, like someKey below
"someKey": { //Some key. It needs to be unique within the file, and describe what this extension does
"id": "org.bahmni.newapp.newextension.uniqueId", //Mandatory. Unique id for this extension
"extensionPointId": "org.bahmni.newapp.newextension", //Mandatory. Must match an extensionPoint defined in app.json. Describes the type of extension described by this extension
"type": "link", //Mandatory. Currently Bahmni only supports extensions of type link and config
"label": "A nice label", //Optional name for this extension. Extensions may use this to show titles etc
"translationKey":"OBSERVATIONS_BOARD_LABEL_KEY", // Optional. If
"url": "/newUrl", //Sets url of the extension to newUrl
"icon": "fa-user-md", // Optional. Used if extension supports an icon
"order": 1, // Optional. Used to order extensions of the same type if the extension supports it
"requiredPrivilege": "app:clinical:observationTab" // User privileges required to activate this extension
}
}
Other files are custom configuration that came out of the need to separate out configuration of specific functionality that grew too big.
Configurations possible for each app are provided below.