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/16 15:14] – Gary Willetts | web_interface:dashboard_setup [2024/04/09 01:58] – [Configure the dashboards] Mark Glover | ||
---|---|---|---|
Line 6: | Line 6: | ||
* 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. | ||
Line 159: | Line 161: | ||
* 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 ===== | ===== Exporting mSupply data to the dashboard ===== |