Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning

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 appThe Home app provides the ability to create links to multiple urls/apps based on a user's privileges. Typical implementations use this as the landing page to users after login. The app.json should look like this (mostly without any change)

 

Code Block
languagejs
titleapp.json
linenumberstrue
{
  
     "id": "org.bahmni.newapphomepage", // Unique ID for an app
        "extensionPoints": [
      
     {
   
            "id": "org.bahmni.newapphome.newextensiondashboard", // Unique ID for an extension
         
      "description": "MakesBahmni Home cheese" // Description for what an extension can do
            Page"
    }
        ],
        "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

}

 

The extension.json file

The home page will contain multiple icons that will take you to urls configured for that icon in the extension.json. An extension configured in extension.json can have multiple instances of the "org.bahmni.home.dashboard" extension, with the url pointing to the url we require. The icon can be modified using the "icon" parameter. Any icon that is part of FontAwesome can be used in the home page. 

 

Code Block
languagejs
titleextension.json
linenumberstrue
{
  // Multiple extensions can be configured within this file. Each needs a unique key, like someKey below

  "someKey"registration": { //Some
key. It needs to be unique within the file, and describe what this extension does      "id": "org.bahmni.newapp.newextension.uniqueIdregistration", //Mandatory. Unique
id for this extension 
    "extensionPointId": "org.bahmni.newapphome.newextensiondashboard", //Mandatory. Must match an extensionPoint defined in app.json.'s id. 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":"OBSERVATIONSMODULE_BOARDLABEL_LABELREGISTRATION_KEY", // Optional.
If       "url": "../registration/newUrl", //SetsDetermines the app/url ofthat the extensionicon toshould newUrlpoint to
     "icon": "fa-user-md", // Optional. Used if extension supports an
icon      "order": 1, // Optional. Used to determine order extensions of the same type ifapps on the extensionpage
supports it      "requiredPrivilege": "app:clinical:observationTabregistration" // User privileges required Configure your own privilege that a user requires to activateview this extensionapp
  }
} 

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. 

Child pages (Children Display)

 

 

 

 

 

 

 

 

 

 

 

 

 

Tip
iconfalse
titleOn this Page

Table of Contents
stylenone