web_interface:dashboard_setup

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
web_interface:dashboard_setup [2022/02/16 15:45] – [Editing dashboard reports] Gary Willettsweb_interface:dashboard_setup [2026/09/30 12:12] (current) – [19.06. Mobile Dashboard set up (after v4.0)] Gary Willetts
Line 2: Line 2:
 ====== 19.06. Mobile Dashboard set up (after v4.0) ====== ====== 19.06. Mobile Dashboard set up (after v4.0) ======
 <WRAP center round alert 80%> <WRAP center round alert 80%>
-August 2020:+The instructions on this page are for configuring both: 
 +  * [[web_interface:dashboard_using#legacy_web_dashboard|mSupply's legacy web dashboard]] 
 +  * [[https://docs.msupply.foundation/mobile/introduction/mobile-dashboard/|mSupply Mobile dashboards]].
  
-  * The instructions on this page are for configuring both: +These instruction are for setting up dashboards for mSupply versions, please see the [[preferences:dashboard]] page for details. 
-    * [[web_interface:dashboard_using#legacy_web_dashboard|mSupply's legacy web dashboard]].  This is now superseded by the [[https://docs.msupply.foundation/en:dashboard|mSupply Grafana web dashboard]]  + 
-    * [[https://docs.msupply.foundation/en:mobile:user_guide:mobile_dashboard|mSupply Mobile dashboards]].  The instruction on this page are still the only way to configure them for mSupply versions 4.0 and later+**These dashboards have now been superseded** by the [[https://docs.msupply.foundation/en:dashboard|mSupply Grafana web dashboard]]). For details on setting up the export for that, please see the [[import_and_export:export_to_dashboard|]] page.
 </WRAP> </WRAP>
- 
-<WRAP center round alert 80%> 
-The following instruction are for setting up dashboards for mSupply versions 4.0 and later.  For mSupply versions earlier than v4.0, the dashboard setup is accessed and configured via the mSupply Preferences menu, refer to [[preferences:dashboard|Dashboard set up (prior to mSupply v4.0)]].</WRAP> 
  
 <WRAP center round important 80%> <WRAP center round important 80%>
Line 18: Line 17:
   * make sure your [[preferences:general#server_tab|webserver]] is currently running.   * make sure your [[preferences:general#server_tab|webserver]] is currently running.
    
-Sustainable Solutions can help with these.</WRAP>+The mSupply Foundation can help with these.</WRAP>
  
-===== Configure the dashboards =====+===== Access the dashboards configuration =====
   - On the **Admin** tab of the Navigator click on the **Dashboard** button: {{ :web_interface:dashboard2.png?600 |}}   - On the **Admin** tab of the Navigator click on the **Dashboard** button: {{ :web_interface:dashboard2.png?600 |}}
   - This will show you a list of the available dashboard reports: {{ :web_interface:dashboard_report_list.png?600 |}}   - This will show you a list of the available dashboard reports: {{ :web_interface:dashboard_report_list.png?600 |}}
 +
 +==== Configure the dashboards ====
   - Tick the box in the **Is active** column for each report that you want generated. Note that if one or more reports are selected, the scheduled process for generating and refreshing the dashboard reports is automatically started, there is no separate setting for turning it on and off. Similarly, if no reports are selected the dashboard report generating process will be turned off automatically.    - Tick the box in the **Is active** column for each report that you want generated. Note that if one or more reports are selected, the scheduled process for generating and refreshing the dashboard reports is automatically started, there is no separate setting for turning it on and off. Similarly, if no reports are selected the dashboard report generating process will be turned off automatically. 
   - Set the number of minutes in the **Update Period (mins)** column to set how often each of these reports is generated.  ''1440'' is one full day.   - Set the number of minutes in the **Update Period (mins)** column to set how often each of these reports is generated.  ''1440'' is one full day.
  
-The //Dashboard Tab// tab is for setting up Dashboard tabs (see the [[web_interface:dashboard_setup#dashboard_tabs|Dashboard tabs]] section below) and the Export settings tab is for telling mSupply when and how to update the data behind the dashboard (see the [[web_interface:dashboard_setup#exporting_msupply_data_to_the_dashboard|Exporting msupply data to the dashboard]] tab section below). +  * The **Export settings** tab is for telling mSupply when and how to update the data behind the dashboard (see the [[web_interface:dashboard_setup#exporting_msupply_data_to_the_dashboard|Exporting msupply data to the dashboard]] tab section below). 
-===== Available dashboard reports =====+  * The //Dashboard Tab// tab is for setting up Dashboard tabs (see the [[web_interface:dashboard_setup#dashboard_tabs|Dashboard tabs]] section below) for the Legacy mSupply dashboard.  As of 2024, this section is most likely irrelevant. 
 +==== Available dashboard reports ====
 There are several built-in dashboard reports that everyone can use.  The table below documents what they show and what properties can be edited: There are several built-in dashboard reports that everyone can use.  The table below documents what they show and what properties can be edited:
  
Line 149: Line 151:
  
  
-===== Editing dashboard reports =====+==== Editing dashboard reports ====
 Double-click a report in the list shown above and the following window will open: Double-click a report in the list shown above and the following window will open:
  
Line 176: Line 178:
   * ''notificationPeriod'' the period in whole days between sendings of the report.   * ''notificationPeriod'' the period in whole days between sendings of the report.
   * ''lastSentAt'' the date and time the report was last sent, in the format YYYY-MM-DDTHH:MM:SSZ. If set to "" (blank) this will trigger the sending of the report when the time in ''notificationPeriod'' has elapsed, measured from the time the **OK** button is clicked on this window.   * ''lastSentAt'' the date and time the report was last sent, in the format YYYY-MM-DDTHH:MM:SSZ. If set to "" (blank) this will trigger the sending of the report when the time in ''notificationPeriod'' has elapsed, measured from the time the **OK** button is clicked on this window.
- 
-===== Exporting mSupply data to the dashboard ===== 
-The mSupply Grafana dashboard has its own separate Postgres database to improve performance and prevent use of the dashboard slowing mSupply down. This means that the data for the dashboard must be exported from the mSupply database to the dashboard's database. You control the settings for this process by clicking on the //Export settings// tab of the window which is displayed when you click on the //Dashboard// icon on the //Admin// tab of the Navigator: 
- 
-{{ :web_interface:screenshot_2022-02-14_at_16.01.43.png?600 |}} 
- 
-=== Postgres server section === 
-Enter the details of the dashboard's Postgres server in here: 
-  * **Server**: the URL of the server the database resides on 
-  * **Port**: the port the database is being served on 
-  * **User**: the username mSupply will use to login to the dashboard's database 
-  * **Password**: the password ms will use ot login to the dashboard's database 
-  * **Database name**: the name the dashboard's database has been given in Postgres 
- 
-Test connection button: when you have enetered all the details in this section, click on this button to test the connection to the dashboard's database. mSupply will tell you whether the connection is successful or not. 
- 
-=== Export settings section === 
-In the table select the tables in the mSupply database that you want to export to the dashboard. Care needs to be taken here; you need to choose all the tables that will provide the information you need in the dashboard but not those you do not need as this may impact on the speed of the export, and therefore how quickly your dashboard can be updated. 
- 
-Use the **All/None** checkbox to quickly check or uncheck all the tables in the list. 
- 
-The **URL** field shows you the URL that mSupply is exporting the data to. 
- 
-**Full export of Checked Tables button:** Clicking this will force mSupply to empty the dashboard database and export all the data from the selected tables to the dashboard database. 
- 
-**Run Next Scheduled Export Now button:** Clicking this will make mSupply immediately export to the dashboard database all the data that has changed in its database since the last export to the dashboard. 
- 
-When these settings have been saved, mSupply will use them to automatically export the selected data to the dashboard according to the schedule that has been set. 
- 
- 
-<WRAP center round alert 60%> 
-August 2020:  The remaining instructions on this page are for configuring mSupply's legacy web dashboard.  This may still work, but is no longer supported as it has been superseded by the [[https://docs.msupply.foundation/en:dashboard|mSupply Grafana web dashboard]].  The instructions are left here for historic reference only. 
-</WRAP> 
  
  
  • Last modified: 2022/02/16 15:45
  • by Gary Willetts