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/04 23:27] – [Scheduled Emailed Reports] 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=====
 +
 +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
  
-=====Scheduled Emailed Reports===== 
 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====
-  -Click on **Settings**on the sidebar menu (on the left-hand side of the mSupply Dashboard).+  -Click on **Settings** on the sidebar menu (on the left-hand side of the mSupply Dashboard).
   -Select the **Plugins** tab.   -Select the **Plugins** tab.
   -Search for “mSupply”.   -Search for “mSupply”.
-  -Click on the mSupply option.   +  -Click on **Excel report e-mail scheduler**. 
-  -Click **Enable** for the mSupply plugin.  +
 \\ \\
-{{ :en:dashboard:2021-05-04_10-15-39_1_.png?direct&0x500 |}}+{{ :en:dashboard:dashboard-20220805-config.png?nolink&600 |}}
  
 \\ \\
- 
-Once enabled, the mSupply icon will be displayed on the sidebar menu above the settings button. 
  
  
 The App Configuration window will open and you will need to complete this form before you start to use the reporting functionality. The App Configuration window will open and you will need to complete this form before you start to use the reporting functionality.
  
-\\+Click Enable for the plugin. 
 +{{ :en:dashboard:dashboard-20220805-config2.png?nolink |}} 
 + 
 +Once enabled, the mSupply icon will be displayed on the sidebar menu above the settings button. 
 +{{ :en:dashboard:dashboard-20220805-config3.png?nolink |}}
  
-{{ :en:dashboard:2021-05-04_11-31-33.png?direct&0x600 |}} 
  
-\\ 
 Please enter your administrator **Grafana Details**: Please enter your administrator **Grafana Details**:
   *Username and password   *Username and password
Line 37: Line 42:
 For **Datasource**, please select the source location for your mSupply data. In most cases this will be //PostgreSQL//.  If you are not sure, please check with your mSupply consultant. For **Datasource**, please select the source location for your mSupply data. In most cases this will be //PostgreSQL//.  If you are not sure, please check with your mSupply consultant.
  
-Once completed, please select **Submit**.  +Once completed, please select **Save settings**.  
   *If the form is incomplete or the information provided is incorrect, you will receive an error message on submission.  Please follow the instructions given in the error message.     *If the form is incomplete or the information provided is incorrect, you will receive an error message on submission.  Please follow the instructions given in the error message.  
   *On successful submission, you will receive the following message:    *On successful submission, you will receive the following message: 
Line 54: Line 59:
 \\ \\
  
-{{ :en:dashboard:2021-05-04_12-09-24.png?direct&800 |}}+{{ :en:dashboard:dashboard-20220805-groups.png?nolink&600 |}}
  
 \\ \\
Line 62: Line 67:
 \\ \\
  
-{{ :en:dashboard:2021-05-04_12-23-38.png?direct&800 |}}+{{ :en:dashboard:dashboard-20220805-groups2.png?nolink&600 |}}
  
 \\ \\
Line 68: Line 73:
  
 \\ \\
-{{ :en:dashboard:2021-05-04_12-32-05.png?direct&600 |}}+{{ :en:dashboard:dashboard-20220805-groups3.png?nolink&600 |}}
 \\ \\
 \\ \\
Line 74: Line 79:
 In the **Edit details** section there are free-text boxes for: In the **Edit details** section there are free-text boxes for:
   *Name    *Name 
-  *Group description+  *Group description 
  
-Then select the users that you want to be in your report group.  +Selected Users 
 +  * List of selected users shown here 
 + 
 +Select the users that you want to be in your report group.  
   *A list is provided of all mSupply users   *A list is provided of all mSupply users
-  *mSupply users without an email address will appear in the list but are not selectable+  *You can show only mSupply users with an email address when **Hide users without email** toggle is on.  
 + 
 +<WRAP center round info 50%> New users (or changes to a user’s details) will not be updated from mSupply into the Dashboard immediately. It is depending on the timing of the dashboard export scheduler in mSupply. If you require an immediate update for Reports, please complete a manual export of **user** table from mSupply to the Dashboard. </WRAP><WRAP clear /> 
 + 
 +Click on **Create Report Group** or **Update Report Group** (When you edit) to save. 
  
-<WRAP center round info 50%> New users (or changes to a user’s details) will only be updated from mSupply into the Dashboard every 24 hours.  If you require an immediate update for Reports, please complete a manual export from mSupply to the Dashboard. </WRAP><WRAP clear />+{{ :en:dashboard:dashboard-20220805-groups6.png?nolink&600 |}}
  
-To save and close press the **X** in the top right corner.  +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 88: Line 100:
 \\ \\
  
-{{ :en:dashboard:2021-05-04_12-35-54.png?direct&400 |}}+{{ :en:dashboard:dashboard-20220805-groups7.png?nolink&600 |}}
  
 \\ \\
 ====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 113: Line 125:
 \\ \\
  
-{{ :en:dashboard:2021-05-04_12-56-41.png?direct&800 |}}+{{ :en:dashboard:dashboard-20220805-schedules3.png?nolink&600 |}}
  
 \\ \\
Line 133: Line 145:
 \\ \\
  
-{{ :en:dashboard:20201123-225456.png?direct&1200 |}}+{{ :en:dashboard:dashboard-20220805-schedules5.png?nolink&600 |}}
  
 \\ \\
Line 143: 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.1659655650.txt.gz
  • Last modified: 2022/08/04 23:27
  • by Mai Inamoto