Home App

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.

Description

The 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.

Configuration files should be under bahmni_config/openmrs/apps/home of your web server. This app configuration needs an app.json and an extension.json file.

app.json

The app.json should look like this (mostly without any change).

app.json

{
  "id": "bahmni.homepage",
  "extensionPoints": [
    {
      "id": "org.bahmni.home.dashboard",
      "description": "Bahmni Home Page"
    }
  ]
}

extension.json

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. See sample below

extension.json

{
  "registration": { 
    "id": "bahmni.registration", //Mandatory. Must be unique within the file
    "extensionPointId": "org.bahmni.home.dashboard", //Mandatory. Must match an extensionPoint's id. Describes the type of extension described by this extension
    "type": "link", //Mandatory
    "label": "Some nice label", // Label for the app. Will be overridden if translationKey is present
    "translationKey":"MODULE_LABEL_REGISTRATION_KEY", // Optional. Required if you need internationalization
    "url": "../registration/", //Determines the app/url that the icon should point to
    "icon": "fa-user-md", // Optional 
    "order": 1, // Used to determine order of apps on the page
    "requiredPrivilege": "app:registration" // Configure your own privilege that a user requires to view this app
  }
}

On this Page