en:dashboard:reports

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
en:dashboard:reports [2022/08/05 03:59] – Mai Inamotoen:dashboard:reports [2022/10/20 05:00] (current) – [Excel report e-mail scheduler] Mark Glover
Line 1: Line 1:
 =====Excel report e-mail scheduler===== =====Excel report e-mail scheduler=====
  
-Generate Excel reports from mSupply dashboard. Send the reports to custom created user-groups on pre-defined schedule. +Generate Excel reports from mSupply dashboard. Email the reports to custom created user-groups on pre-defined schedule. 
 Supported Grafana version is later v8.0.0 Supported Grafana version is later v8.0.0
  
 This is a custom plugin which will need to be installed on your server. Contact mSupply support if this plugin is not available to you. This is a custom plugin which will need to be installed on your server. Contact mSupply support if this plugin is not available to you.
  
-NOTE: you need to have Grafana administrative rights to set up and use this plugin. The plugin icon does not show in the sidebar for non-administrative accounts.+<WRAP center round important 60%> 
 +To use this plugin, the user needs to have Grafana administrative rights.  The plugin icon does not show in the sidebar for non-administrative accounts.  Therefore, if a local user needs to configure the Excel report e-mail scheduler, their user needs to be configured to have Grafana administrative rights.  Please contact [[support@msupply.org.nz]] to arrange this. 
 +</WRAP> 
  
 ====Initial Plugin Setup==== ====Initial Plugin Setup====
Line 91: Line 94:
 {{ :en:dashboard:dashboard-20220805-groups6.png?nolink&600 |}} {{ :en:dashboard:dashboard-20220805-groups6.png?nolink&600 |}}
  
-When you hover your mouse over the group, **Edit** and **DELETE** bottom appear. +When you hover your mouse over the group, **Edit** and **DELETE** buttons appear. 
  
 **Delete** will remove the report group. You will receive a prompt to confirm deletion. **Delete** will remove the report group. You will receive a prompt to confirm deletion.
Line 102: Line 105:
 ====Setting Up a Report Schedule==== ====Setting Up a Report Schedule====
  
-To access Report schedules, select the mSupply icon from the sidebar menu and select **Report schedules** from the drop-down menu.+To access Report schedules, select the mSupply icon from the sidebar menu and select **Schedules** from the drop-down menu.
  
 \\ \\
  
-{{ :en:dashboard:2021-05-04_12-09-29.png?direct&800 |}}+{{ :en:dashboard:dashboard-20220805-schedules.png?nolink&600 |}}
  
 \\ \\
  
-In the following window select **Add schedule**. This will create a **New report schedule** as below – click on this row to edit the schedule details.+In the following window select **Create new schedule**. This will create a **New report schedule** as below – click on this row to edit the schedule details.
  
 \\ \\
  
-{{ :en:dashboard:2021-05-04_12-52-29.png?direct&800 |}}+{{ :en:dashboard:dashboard-20220805-schedules2.png?nolink&600 |}}
  
 \\ \\
Line 122: Line 125:
 \\ \\
  
-{{ :en:dashboard:2021-05-04_12-56-41.png?direct&800 |}}+{{ :en:dashboard:dashboard-20220805-schedules3.png?nolink&600 |}}
  
 \\ \\
Line 142: Line 145:
 \\ \\
  
-{{ :en:dashboard:20201123-225456.png?direct&1200 |}}+{{ :en:dashboard:dashboard-20220805-schedules5.png?nolink&600 |}}
  
 \\ \\
Line 152: Line 155:
 Grafana macros are not supported with the following exception: Grafana macros are not supported with the following exception:
     * The $__   __timeFrom and $__   __timeTo and $__   __timeFilter macros are supported using a Lookback variable. The $__   __timeTo date is set to date of report creation.  The $__   __timeFrom will then be calculated as ($__   __timeTo – Lookback).      * The $__   __timeFrom and $__   __timeTo and $__   __timeFilter macros are supported using a Lookback variable. The $__   __timeTo date is set to date of report creation.  The $__   __timeFrom will then be calculated as ($__   __timeTo – Lookback). 
-    * For example, if you set a lookback period of 7 days and create a daily report starting on 1 January 2021. The first report’s $__   __timeFrom will be 24 December 2020 and the $__   __timeTo will be 1 January 2021.  The second report’s $__   __timeFrom will be 25 December 2020 and the $__   __timeTo will be 2 January 2021. ((For more information on macros, please refer to [[https://grafana.com/docs/grafana/latest/datasources/postgres/|Grafana macros]]))+    * For example, if you set a lookback period of 7 days and create a daily report starting on 1 January 2021. The first report’s $__   __timeFrom will be 24 December 2020 and the $__   __timeTo will be 1 January 2021.  The second report’s $__   __timeFrom will be 25 December 2020 and the $__   __timeTo will be 2 January 2021. ((For more information on macros, please refer to [[https://grafana.com/docs/grafana/latest/datasources/postgres/|Grafana macros]])) 
  
-Once you have selected your variables, you can press **Send Test** button (top right corner).  Please note:+Press **Create schedule** button on the bottom of the page.   
 + 
 +{{ :en:dashboard:dashboard-20220805-schedules8.png?nolink&600 |}} 
 + 
 +Once you saved the scheduler, you can press **Send Test** button (top right corner) from the edit schedules. Please note:
   * **Send Test** will not affect the timing of the schedule (the timing of the schedule is dependent on the time you save and close the report schedule)   * **Send Test** will not affect the timing of the schedule (the timing of the schedule is dependent on the time you save and close the report schedule)
   * **Send Test** will send the email to all users in the report group!   * **Send Test** will send the email to all users in the report group!
  
-To save and close press the **X** in the top right corner.   +**DELETE** will remove the report schedule. You will receive a prompt to confirm deletion.
- +
-**Delete** will remove the report schedule. You will receive a prompt to confirm deletion.+
  
 \\ \\
  
-{{ :en:dashboard:2021-05-04_13-17-55.png?direct&400 |}}+{{ :en:dashboard:dashboard-20220805-schedules9.png?nolink&600 |}}
  
 \\ \\
  • en/dashboard/reports.1659671994.txt.gz
  • Last modified: 2022/08/05 03:59
  • by Mai Inamoto