16.05. Mobile Dashboard set up (before v4.0)

To setup the dashboard (refer figure below):

1. Open File > Preferences > Dashboard
2. Check the “We use the web dashboard” checkbox.
3. In the Dashboard web URL field enter the base URL to reach the dashboard, e.g. http://yoursystem.msupply.org:2048/.
   Don't forget the trailing slash (/) otherwise it won't work!
   If you are running from localhost, use your IP address, e.g. http://127.0.0.1:8080/ rather than http://localhost/.
4. The URL users type in to the address bar of their browser to access the dashboard will be this base URL with dashboard on the end, e.g. https://yoursystem.msupply.org:2048/dashboard/
5. Tick the reports in the Is active column to select them for display on your dashboard.
6. You can choose how often these reports are updated by clicking in the Update Period (mins) column and entering a number of minutes.
7. Setup which reports appear on which tabs - refer Dashboard tabs.
8. Setup which dashboard reports each user can access - refer The dashboard.

Double-click a report in the list shown above and the following window will open:

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 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'll be ignored.

See the section below for details of the various dashboard reports available and the settings that can be edited.

There are several built-in dashboard reports that everyone can use. Here's what they show and what properties can be edited to change what they show:

If you can't make a dashboard report that does what you want then please speak to us, it's usually a fairly simple matter for us to create one for you.

You set up Dashboard tabs which will display on your dashboard. Dashboard tabs are “containers” for one or more dashboard reports. To edit them go to File > Preferences and click on the Dashboard tabs tab on the left hand side:

To add a tab click the Add button. To edit a tab, double-click it. You will be shown a window for editing a dashboard tab:

Now you add reports that will show on this tab.

Take this example dashboard tab:

• The tabs themselves occupy their own space on the left of the window- they aren't considered when laying out the dashboard
• The first row has two reports- each report takes up half the row. So for the first report:
  • Row 1, Col 1, width 6 (“12” means it takes up the full width of the cell it is in- “4” would mean it would take up 1/3 of the width)
• For the report at the top right:
  • Row 1, Col 2, width 6
• For the map
  • Row 2, Col 1, width 12
• The next two reports are on the same row, but are divided into 5/12 and 7/12 of the width of the window, so we put them in the same cell but change the width settings:
  • Row 3, Col 1, width 5
  • Row 3, Col 1, width 7

Click New Line to add a new report to the tab. Then edit the values in each column

• Row: The row it will be in
• Column: The column within the row- set to “1” if you don't have multiple reports on this row.
• Report tite: The title that will show in the Orange heading bar for the report. Note that the same report can display different information depending on the parameters you set for that report- hence the need for the ability to customise report names
• Type: You'll need to know the appropriate type for the report you're displaying. The options are
  • bar_chart
  • table
  • pie_chart
  • time_series
  • map
  • line_chart
• Width: The fraction of the cell width in “twelfths” that this report will take up (“6” will make it take up half the cell width)
• Report: Choose the report name from the drop-down list of available reports

This is the final step in setting up dashboards: once the tabs have been setup you have to choose which users will see which tabs. You do this in individual users' settings. See managing users for instructions on how to do this.