Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revisionLast revisionBoth sides next revision | ||
web_interface:dashboard_setup [2022/02/14 15:58] – [Dashboard tabs] Gary Willetts | web_interface:dashboard_setup [2024/04/09 01:58] – [Configure the dashboards] Mark Glover | ||
---|---|---|---|
Line 4: | Line 4: | ||
August 2020: | August 2020: | ||
- | * The instructions on this page are for configuring both | + | * The instructions on this page are for configuring both: |
* [[web_interface: | * [[web_interface: | ||
- | * [[https:// | + | * [[https:// |
</ | </ | ||
Line 26: | Line 26: | ||
- Set the number of minutes in the **Update Period (mins)** column to set how often each of these reports is generated. | - Set the number of minutes in the **Update Period (mins)** column to set how often each of these reports is generated. | ||
- | The //Dashboard Tab// tab is for setting up Dashboard tabs (see the [[web_interface: | + | * The **Export settings** tab is for telling mSupply when and how to update the data behind the dashboard (see the [[web_interface: |
+ | * The //Dashboard Tab// tab is for setting up Dashboard tabs (see the [[web_interface: | ||
===== Available dashboard reports ===== | ===== Available dashboard reports ===== | ||
There are several built-in dashboard reports that everyone can use. The table below documents what they show and what properties can be edited: | There are several built-in dashboard reports that everyone can use. The table below documents what they show and what properties can be edited: | ||
Line 154: | Line 155: | ||
{{ : | {{ : | ||
+ | === Parameters tab === | ||
* If there are any properties shown in the list, these can be edited to change what is displayed. | * If there are any properties shown in the list, these can be edited to change what is displayed. | ||
* To edit a property or value, click once to select the row, and then click again in the appropriate cell to edit it. | * To edit a property or value, click once to select the row, and then click again in the appropriate cell to edit it. | ||
* To add or delete a row use the **New line** and **Delete line(s)** buttons at the top of the window. | * To add or delete a row use the **New line** and **Delete line(s)** buttons at the top of the window. | ||
* In the example shown in the screenshot above (a map report), the coordinates of two of the map corners and the item code of the item whose stocks will be shown on the map have been entered. Note that if you add extra properties to the default reports they' | * In the example shown in the screenshot above (a map report), the coordinates of two of the map corners and the item code of the item whose stocks will be shown on the map have been entered. Note that if you add extra properties to the default reports they' | ||
+ | |||
+ | === Method code tab === | ||
+ | This tab is password protected. After entering the password you are shown the code used to execute the report, which you can edit as necessary. | ||
+ | |||
+ | === Json tab === | ||
+ | This tab shows the JSON formatted text that was returned from the last successful execution of the report. | ||
+ | |||
+ | === Notification Rules tab === | ||
+ | On this tab you can enter JSON formatted text to define the rules for notifying users with the results of the report. To Add, edit or delete any rules you must first click on the **Click to unlock** button and enter the password to allow editing. | ||
+ | |||
+ | An example of a valid rule is: | ||
+ | < | ||
+ | |||
+ | The elements are as follows: | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | |||
+ | ===== Exporting mSupply data to the dashboard ===== | ||
+ | The mSupply Grafana dashboard has its own separate Postgres database to improve performance and prevent use of the dashboard slowing mSupply down. This means that the data for the dashboard must be exported from the mSupply database to the dashboard' | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | === Postgres server section === | ||
+ | Enter the details of the dashboard' | ||
+ | * **Server**: the URL of the server the database resides on | ||
+ | * **Port**: the port the database is being served on | ||
+ | * **User**: the username mSupply will use to login to the dashboard' | ||
+ | * **Password**: | ||
+ | * **Database name**: the name the dashboard' | ||
+ | |||
+ | Test connection button: when you have enetered all the details in this section, click on this button to test the connection to the dashboard' | ||
+ | |||
+ | === Export settings section === | ||
+ | In the table select the tables in the mSupply database that you want to export to the dashboard. Care needs to be taken here; you need to choose all the tables that will provide the information you need in the dashboard but not those you do not need as this may impact on the speed of the export, and therefore how quickly your dashboard can be updated. | ||
+ | |||
+ | Use the **All/ | ||
+ | |||
+ | The **URL** field shows you the URL that mSupply is exporting the data to. | ||
+ | |||
+ | **Full export of Checked Tables button:** Clicking this will force mSupply to empty the dashboard database and export all the data from the selected tables to the dashboard database. | ||
+ | |||
+ | **Run Next Scheduled Export Now button:** Clicking this will make mSupply immediately export to the dashboard database all the data that has changed in its database since the last export to the dashboard. | ||
+ | |||
+ | When these settings have been saved, mSupply will use them to automatically export the selected data to the dashboard according to the schedule that has been set. | ||
+ | |||
<WRAP center round alert 60%> | <WRAP center round alert 60%> | ||
Line 210: | Line 258: | ||
* [[admin: | * [[admin: | ||
* [[admin: | * [[admin: | ||
- | + | \\ | |
- | + | \\ | |
- | ===== Exporting mSupply data to the dashboard ===== | + | |
- | + | ||
| // Previous: | | // Previous: | ||
---- struct data ---- | ---- struct data ---- |