Home

mSupply Dashboard: Excel report e-mail scheduler

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.

How it works

The plugin has three main pages

• Configuration
• Report Groups
• Schedules

Once a schedule is created it will run automatically on the date and time specified in the schedule options on the interval specified.

Requirements

• Golang version 1.16 or above
  • Mage build tool
• Node.JS version 16 or above
• Grafana version 8 (Not required if you are using Docker, it will install this for you in a container)
• Yarn
• If you are using Docker for development the files are moved automatically, just have to rename the msupply_example.db file.
  • You must have 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.
  • You must have 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.

Installation instructions

Development

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.

• Docker development installation (recommended)
• Normal development installation

Build for Production

• Do everything instructed in the Development section above.
• Now it's time to build for Production
  • Do mage clean to delete the dist folder. A fresh start.
  • Do mage -v to build for all platforms
    • Do mage build:windows if you want to build for Windows only
    • Do mage build:linuxARM64 if you want to build for Linux only
  • Do yarn build:frontend to build the Javascript parts
  • Do yarn sign to sign the plugin.
    • Note: You would need a GRAFANA_API_KEY to sing the plugin.
    • Also you would need to add the url of the site you are deploying to, in the sites in sign script, in package.json before building.
    • Once you have signed the plugin you cannot change the content of the plugin folder (dist). Any add, edit or deletion of files in the folder would render the plugin invalid and it would not work in Grafana.
    • If you want to use the signed plugin in development mode but you have not been abled to, there is manifest file that gets generated when the plugin is singed. That file must be deleted if you want to use the plugin unsigned for development.
• Alternatively, if you do yarn build, it will run all of the above commands for you. (I just wanted to explain what this will do to you.)

Migrating from v1

• The plugin expect Grafana v8 to be installed in your system.
• Please make sure you have created the mSupply dashboard datasource, without it this plugin would not work.
• Please make sure the mSupply.db SQLite database and Template.xlsx files is in the expected path plugins/data
• The Settings have changed slightly so you might have to re-enter them for the plugin to work. If you see errors, make sure you have reentered the plugin settings.
• If you are using legacy 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.
• The remain data stays unchanged so you can use the legacy database with newer version of the plugin.