The plugin takes data from panels of mSupply dashboard to generate excel reports which are then emailed to a custom user group created with mSupply users pulled from mSupply Dashboard's datasource. The timing of the scheduler can be set in the plugin.
APACHE-2.0 License
The Open mSupply Dashboard Excel report e-mail scheduler plugin which takes data from panels of mSupply dashboard to generate excel reports.
The reports are then emailed to a custom user report group, this report group is curated from the list of mSupply users, pulled from mSupply Dashboard's datasource.
The timing of the scheduler can be set in the plugin.
The app plugin is built with Golang as backend and react as frontend.
The plugin has three main pages
Once a schedule is created it will run automatically on the date and time specified in the schedule options on the interval specified.
msupply_example.db
file.
msupply.db
database in the designated grafana plugins/data
folder. We have included an empty msupply_example.db
file in the plugins/data
folder in this repo. Rename it to msupply.db
and add it to your Grafana installation's plugins/data
folder. Please do not skip this as the plugin would not work without this database file.template.xlsx
file in the designated grafana plugins/data
folder. We have included a template.xlsx
file in the plugins/data
folder in this repo, add it to your Grafana installation's plugins/data
folder. Please do not skip this as the plugin would not work without this template file.If you want to develop and change this plugin's file, you can install the plugin in your system through one if the two routes explained below.
The Docker route need docker installed in your system along with Node.js, Golang and yarn but it gives you fresh grafana install. It will also auto-setup grafana for you (to some extent) so it is the recommended path.
mage clean
to delete the dist folder. A fresh start.mage -v
to build for all platforms
mage build:windows
if you want to build for Windows onlymage build:linuxARM64
if you want to build for Linux onlyyarn build:frontend
to build the Javascript partsyarn sign
to sign the plugin.
sign
script, in package.json before building.yarn build
, it will run all of the above commands for you. (I just wanted to explain what this will do to you.)plugins/data
mSupply.db
, please update the data type of ReportContent.lookback
field to TEXT
. Previously it was INTEGER
. If you are using older content, you might have to re-select Lookups from Panel variables form fields, in Scheduler edit page.