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/14 15:57] – [Configure the dashboards] 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:
  
 {{ :web_interface:dashboard_report_edit.png?400 |}} {{ :web_interface:dashboard_report_edit.png?400 |}}
  
 +=== Parameters tab ===
   * If there are any properties shown in the list, these can be edited to change what is displayed.   * 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 edit a property or value, click once to select the row, and then click again in the appropriate cell to edit it.
Line 159: Line 162:
   * 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.   * 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.
  
-<WRAP center round alert 60%> +=== Method code tab === 
-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. +This tab is password protected. After entering the password you are shown the code used to execute the report, which you can edit as necessary.  
-</WRAP>+ 
 +=== Json tab === 
 +This tab shows the JSON formatted text that was returned from the last successful execution of the report. 
 + 
 +=== Notification Rules tab === 
 +On this tab you can enter JSON formatted text to define the rules for notifying users with the results of the report. To Add, edit or delete any rules you must first click on the **Click to unlock** button and enter the password to allow editing. 
 + 
 +An example of a valid rule is: 
 +<code>{"Rules":[{"userTags":["Monthly_report_emails"],"notificationPeriod":1,"lastSentAt":"2022-02-07T08:28:42Z"}]}</code> 
 + 
 +The elements are as follows: 
 +  * ''userTags'' defines the tags the users must have to be sent the report. Add as many as you wish. 
 +  * ''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.
  
  
 ===== Dashboard tabs ===== ===== 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 click on the //Dashboard Tabs// tab of the File > Preferences > Dashboard window shown above:+You set up Dashboard tabs which will display on your dashboard. Dashboard tabs are "containers" for one or more dashboard reports. To edit them click on the //Dashboard Tabs// 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_15.22.40.png?600 |}} {{ :web_interface:screenshot_2022-02-14_at_15.22.40.png?600 |}}
Line 210: Line 226:
   * [[admin:managing_users#user_can|Managing users > General tab > Users can:]] (Use the Dashboard permission)   * [[admin:managing_users#user_can|Managing users > General tab > Users can:]] (Use the Dashboard permission)
   * [[admin:managing_users#the_dashboard_tab|Managing users > Dashboard tab]]   * [[admin:managing_users#the_dashboard_tab|Managing users > Dashboard tab]]
- + \\ 
- + \\
-===== Exporting mSupply data to the dashboard ===== +
- +
 |  //  Previous:  **[[web_interface:dashboard_using]]** | | Next: **[[web_interface:online_catalogue]]** //  | |  //  Previous:  **[[web_interface:dashboard_using]]** | | Next: **[[web_interface:online_catalogue]]** //  |
 ---- struct data ---- ---- struct data ----
  • Last modified: 2022/02/14 15:57
  • by Gary Willetts