Differences

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

--- en:dashboard:plugins:excel-report-email-scheduler [2022/11/11 07:47] – [Create/Edit schedule] Sworup Shakya
+++ en:dashboard:plugins:excel-report-email-scheduler [2022/11/22 16:23] (current) – [How to use] Gary WIllets
@@ Line 11: / Line 11: @@
 ===== How to use =====
 <WRAP center round alert 60%>
-We are giving certain authorised personnels, admin access to dashboard so that they would create report groups and schedules. Other normal users would not be able to access this plugin page and hence would not see it in their dashboard interface.
+This setup functionality is only avilable to users with administrator access to the dashboard. Other non-admin users will not be able to access this plugin page and hence will not see it in the dashboard interface.
-Since admin access has been granted, the authorised personnel would also get access to other features in the dashboard that normal users would not have access to. We strongly warn the users to only make changes in the plugin pages, and do so carefully. Although we try to take backup of data as much as possible, if something break, it would be some extra work to revert the dashboard back to normal.
+Administrator access is dangerous because it also gives access to the other areas of dashboard setup and changes can prevent the dashboard working or damage the underlying data. We strongly warn the users to only make changes in the plugin pages, and to do so carefully. You have been warned ;-)
 </WRAP>
 If you can see the Excel report e-mail scheduler plugin icon, you have the rights to create report groups and schedules.
@@ Line 123: / Line 120: @@
 </WRAP>
-==== Add/Edit schedule page ====
+==== Add schedule page ====
 This is the main page where all the magic happens
@@ Line 129: / Line 126: @@
 {{ :en:dashboard:plugins:scr-20221111-inj.png |}}
+=== 1. Name and description  ===
+The name of the schedule.
+=== 2. Report group  ===
+Select the report group you want the schedule to send excel reports to. It will be sent to all user's emails in the group.
+=== 3. Interval  ===
+You can choose if you want to send a report email daily, weekly, fortnightly, monthly, quarterly or yearly. Based on what you choose, you can also choose which day of the week, month or year you want the emails to be sent.
+=== 4. Time of day  ===
+You can choose the exact time when the emails will be sent. The time is in 24 hours format, so 13:00 would be 1pm.
+=== 4. Selected Panels  ===
+Once you start selecting panels you could see them here.
+=== 5. Available panels ===
+The plugin supports a select group of panels.
+  * You can only use panels of Table type.
+  * You can only select panels where the query has lookup variables called in certain format.
+Those panels that are not supported are not shown in the list. So if are wonder why a certain panel is not showing in available panels list, maybe its because the type of the panel is not table.
+=== 7. Panel name ===
+The name of the panel.
+=== 8. No checkbox ===
+If you see a panel in the list but do not see a checkbox in front of it, the variables and lookup the panel uses are not supported. Therefore it would not be selectable even if the panel type is table.
+<wrap em>Ask somebody for the mSupply support group to maybe update the panel settings to fix this.</wrap>
+=== 9. Variables ===
+This is where you would customise the panel variables.
+Some panels allow you to filter the data by some variables. For instance you can only ask the plugin to build the excel report from certain stores. To do that you can go to Store variable list and select the stores you want the data to be filtered by.
+<WRAP center round info 60%>
+Variables can be text boxes, drop-downs and drop-downs with multi-select option.
+</WRAP>
+The variables you apply here will filter data based on the variable. So if you select certain item in the variable list, only that items' data would be shown in the report email.
+Leaving the variable blank will select all as the option.
+==== Edit schedule page ====
+Edit schedule page is pretty much the same as add but you get an extra **Send Text email** button at the top.
+{{ :en:dashboard:plugins:scr-20221111-its.png |}}
+=== Send test ===
+You can use Send test to immediately send the report email regardless of what Interval you had set. This is good to send on demand report certain users or to generally test to see if the report is getting data as you wish it to.
+==== Lookup ====
+Some of the Available panels would have Lookup option in it.
+These are like the data range you set while viewing panels.
+This will allow you to only see data from last 1 day, 1 week, 1 month etc.