Dashboard setup

In versions up to 4.0 dashboard setup was accessed from preferences. The following instruction are for versions 4.0 and above. For versions prior to 4.0, please use the instructions here: https://docs.msupply.org.nz/preferences:dashboard

Before the settings in this section will work you must make sure your webserver is currently running. See Webserver. Most users will find it easier to request mSupply support to set this up for you.

Before you set the dashboard up you must:

  • know what ports are already in use on the server
  • have an appropriate SSL Certificate set up. Sustainable Solutions can help with this if needed.

To setup the dashboard:

  1. Check the Use the dashboard checkbox in the user settings:
  2. Click on the Dashboard button on the Admin screen:
  3. In the Dashboard web URL field enter the base URL to reach the dashboard e.g. http://dashboard.msupply.org:2048/. Don't forget the trailing slash (/) otherwise it won't work!)
    1. if you are running from localhost, use your IP rather than http://localhost both here and in the browser
    2. the URL that users type in to the address bar of their browser to access the dashboard will be this with Dashboard on the end e.g. http://dashboard.msupply.org:2048/dashboard.
  4. Tick the reports in the Is active column to select them for display on your dashboard.
  5. You can choose how often these reports are updated by clicking in the Update Period (mins) column and entering a number of minutes.
  6. Setup which reports appear on which tabs - refer Dashboard tabs.
  7. Setup which dashboard reports each user can access - refer The dashboard.\
  8. Setup Email Notifications for reports - this feature allows for reports to be emailed on a schedule to a user or group of users. Multiple reports for a User will appear on different tabs of an excel workbook. Note - this needs to be configured at our end, so get in touch if you're interested and we'll set this up for you.

Editing Dashboard Reports

Double-click a report in the list shown above and the following window will open:

If there are any properties shown in the list, these can be edited to change what is displayed.

To edit a property or value, click once to select the row, and then click again in the appropriate cell to edit it.

To add or delete a row use the New line and Delete line(s) buttons at the top of the window.

In the example shown in the screenshot above (a map report), the coordinates of two of the map corners and the item code of the item whose stocks will be shown on the map have been entered. Note that if you add extra properties to the default reports they'll be ignored.

See the section below for details of the various dashboard reports available and the settings that can be edited.

What the dashboards show and what can be edited

There are several built-in dashboard reports that everyone can use. Here's what they show and what properties can be edited to change what they show:

Report Method Format Parameters
Expiring items list for Store Shows a list of items, for a given store, which will expire within a specified number of months. v4.01 dashboardReportExpiringItemList Table, Bar chart monthsToInclude The number of months before expiry that the report includes (defaults to 3 if this parameter is missing)
storeCode search for a single store matching this code
dataElement Looks for the dataElement in aggregator here it takes “AMC”
customisation allows for a client customisation: currently supports MAM for the MAM specific changes.
ven_category V,E,N or E,N or V,E ..etc will filter the VEN items. If blank all visible items for the store are chosen
Expiring Stock Shows a graph of total value of stock expiring grouped by the number of months in which the stock will expire. dashboard_rep_expiring_stock Bar chart None
Items issued this month Shows a list of items, per store, which were issued in the last 30 days. Uses store tag and master list to select items to be displayed. dashboard_itemRow_storeCol_usag Table store_tag Identifies stores to display. Multiple stores can be selected by separating them by comma or space e.g. “bacau,CHC” or “bacau CHC”
master_list Show items which are included in this master list
period Number of days from the current date to look back
Map stock on hand Shows a map of the area specified, with an “X” if the facility is out of stock of the item, or a dot representing the amount of stock on hand. dashboard_map_stock_on_hand Map country Name of country - compulsory but not shown
item_code the code of the item to display
lat_nw_corner the latitude of the North-West corner of the map
long_nw_corner the longitude of the North-West corner of the map
lat_se_corner the latitude of the South-East corner of the map
long_se_corner the longitude of the South-East corner of the map
store_tags A comma separated list of tags - or omit this parameter if you want to show stock for all stores
Monthly transactions Shows a bar chart of the number of purchase orders, goods receipts, supplier and customer invoices created this month. dashboard_rep_month_transacs Bar or Line chart None
Stock_for_category1_stores_by_item_list Shows a table of items in rows and stores in columns, with the stock on hand for that item in that store in each cell. dashboard_rep_stk_StoreCols_Itm Table store_code code or codes of stores to show. to specify multiple stores enter multiple store_code params (append @ for a “starts with” search)
master_list VHP - All Items Will search for items that are part of the master list : “VHP - All Items”
item_code items whose code matches this code (append @ for a “starts with” search)
Category1_description private Will search for names whose name category 1 is “private”
Store Transaction Count Shows a count of each store's transactions for the past 7 and 30 days dashboard_rep_count_store_trans Line or Bar chart store_tags matches stores with this tag
Sync sites last connection date dashboard_report_last_sync_date Table None
Sync sites sent and received statistics dashboard_report_sync_stat Table None
Sync sites statistics Shows a range of statistics related to synchronisation v4.02+ dashboardSyncSiteStatistics table storeTag (default = %) - report will select stores where tags match %{storeTag} and sync_id_remote_site > 1
syncDayThreshold (default = 5) - color cell red when days since last sync > syncDayTreshold
unfinalisedSIThreshold (default = 0) - color cell red when number of unfinalised supplier invoices > unfinalisedSIThreshold
stocktakeDayThreshold (default = 30) - color cell red when days since last stocktake > stocktakeDayThreshold
requisitionDayThreshold (default = 30) - color cell red when days since last requisition > requisitionDayThreshold
lookBackPeriod (default = 50) - Look back number of days for Supplier Invoice, Stocktake and Requisitions
lookBackPeriodCI (default = 30) - Look back number of days for Customer Invoice
daysWithCIThreshold (default = 0.2) - color cell red where 'days with customer invoice' divided by `number of working days` < daysWithCIThreshold
This month's transactions Shows a bar chart of the number of purchase orders, goods receipts, supplier and customer invoices created this month. dashboard_rep_month_transacs Bar chart store_name If provided the report shows details for the given store, otherwise the default store is used
Top facilities supplied The 10 customers in your store to which you have sent the greatest value of stock. Shows the value of stock for each customer. dashboard_rep_top_facilities Bar chart None
Total stock value A single figure in your default currency, showing the total value of the stock you have in the store you are viewing the dashboard for. dashboard_rep_total_stock_value h2 None
Transactions per store Shows a table of the transactions per stores within 30 days dashboard_rep_month_transacs Table store_code Specify a store by entering a store code, or leave blank for the default store
Trends in critical stock dashboard_rep_in_stock_trends Time series chart store_id the ID of the store you're interested in, or no value for all stores
critical_stock TRUE if you want to include items with this field checked, false for all items
Unfinalised Stock transfers Shows unfinalised stock transfers within the specified time period for each facility which matches the “store_tags” parameter. If no store tags are passed in, transactions are shown for all stores. dashboardReportUnfinalisedStock Table store_tags Queries only stores with matching store tags
days_older_than Queries transactions that were created 'x' number of days ago
VEN items in stock Shows stock on hand of each items that belongs to the VEN (Vital, Essential, Necessary) category dashboard_rep_item_ven Line or bar chart store_code store code - if empty then default store is chosen
ven_category V,E,N or E,N or V,N ..etc will filter the VEN items. If blank all visible items for the store are chosen
Vital items in stock Shows a bar graph of the percentage of medicines of the chosen category in stock at each facility dashboard_store_stock_percent Bar chart ven_category v or e or n if you want to include items that are Vital or Essential or Necessary
user_field_4 TRUE if you want to include items with this field checked
user_field_7 TRUE if you want to include items with this field checked
Note that the labels for fields 4 and 7 may be different, as they are set up in the mSupply preferences (misc tab)
critical_stock TRUE if you want to include items with this field checked, false for all items
store_tags entering healthcentre will only include stores with the “healthcentre” tag

If you can't make a dashboard report that does what you want then please speak to us, it's usually a fairly simple matter for us to create one for you.

Dashboard tabs

You set up Dashboard tabs which will display on your dashboard. Dashboard tabs are “containers” for one or more dashboard reports. To edit them go to File > Preferences and click on the Dashboard tabs tab on the left hand side:

To add a tab click the Add button. To edit a tab, double-click it. You will be shown a window for editing a dashboard tab:

Now you add reports that will show on this tab.

Understanding Rows and Columns

Take this example dashboard tab:

  • The tabs themselves occupy their own space on the left of the window- they aren't considered when laying out the dashboard
  • The first row has two reports- each report takes up half the row. So for the first report:
    • Row 1, Col 1, width 12 (“12” means it takes up the full width of the cell it is in- “4” would mean it would take up 1/3 of the width)
  • For the report at the top right:
    • Row 1, Col 2, width 12
  • For the map
    • Row 2, Col 1, width 12
  • The next two reports are on the same row, but are divided into 5/12 and 7/12 of the width of the window, so we put them in the same cell but change the width settings:
    • Row 3, Col 1, width 5
    • Row 3, Col 1, width 7

To add a report to a Dashboard tab

Click New Line to add a new report to the tab. Then edit the values in each column

  • Row: The row it will be in
  • Column: The column within the row- set to “1” if you don't have multiple reports on this row.
  • Report tite: The title that will show in the Orange heading bar for the report. Note that the same report can display different information depending on the parameters you set for that report- hence the need for the ability to customise report names
  • Type: You'll need to know the appropriate type for the report you're displaying. The options are
    • bar_chart
    • table
    • pie_chart
    • time_series
    • map
    • line_chart
  • Width: The fraction of the cell width in “twelfths” that this report will take up (“6” will make it take up half the cell width)
  • Report: Choose the report name from the drop-down list of available reports

Add a dashboard tab to a user's dashboard

This is the final step in setting up dashboards: once the tabs have been setup you have to choose which users will see which tabs. You do this in individual users' settings. See managing users for instructions on how to do this.

Previous: Printing Preferences Next: Entering a New Logo

  • Last modified: 2019/03/04 13:30
  • by Gary Willetts