| Both sides previous revision Previous revision Next revision | Previous revision |
| en:mobile:setup:server_side:dashboard [2020/08/20 23:23] – [7. Setting up the mSupply Mobile app dashboard] Mark Glover | en:mobile:setup:server_side:dashboard [2020/08/21 00:04] (current) – [Mobile specific dashboard configuration] Mark Glover |
|---|
| ====== 7. Setting up the mSupply Mobile app dashboard ====== | ====== 7. Setting up the mSupply Mobile app dashboard ====== |
| |
| The mSupply Mobile app has the capability to display store specific information as a dashboard to be viewed on the mobile device. There is also a function to view data for other stores anonymised. | mSupply Mobile has the capability to display store specific information as a [[en:mobile:user_guide:mobile_dashboard|Mobile dashboard]]. There is also a function to view data for other stores anonymised. |
| |
| <WRAP center round important 60%> | <WRAP center round important 60%> |
| The Mobile app dashboard is completely different to the [[en:dashboard|mSupply Grafana web dashboard]] and is configured in a different manner. | The [[en:mobile:user_guide:mobile_dashboard|Mobile dashboard]] is completely different to the [[en:dashboard|mSupply Grafana web dashboard]] and is configured in a different manner. |
| </WRAP> | </WRAP> |
| |
| Mobile dashboards are built on the idea of reusing the same report sets as the [[https://docs.msupply.org.nz/web_interface:dashboard_using#legacy_web_dashboard|legacy (non-grafana) mSupply web dashboard]]. A lot of the legacy web dashboards can be used as mobile dashboards. <WRAP center round alert 60%> | Mobile dashboards are built on the idea of reusing the same report sets as the [[https://docs.msupply.org.nz/web_interface:dashboard_using#legacy_web_dashboard|legacy (non-grafana) mSupply web dashboard]]. A lot of the legacy web dashboards can be used as mobile dashboards. |
| If you set a report as mobile dashboard report then it looses its ability to be generated to the [[https://docs.msupply.org.nz/web_interface:dashboard_using#legacy_web_dashboard|legacy (non-grafana) mSupply web dashboard]] and vice versa. | <WRAP center round alert 60%> |
| | * If you configure a report to be a mobile dashboard report then it looses its ability to be generated to the [[https://docs.msupply.org.nz/web_interface:dashboard_using#legacy_web_dashboard|legacy (non-grafana) mSupply web dashboard]] and vice versa. |
| | * If you want the report to continue to be generated to the [[https://docs.msupply.org.nz/web_interface:dashboard_using#legacy_web_dashboard|legacy (non-grafana) mSupply web dashboard]], then duplicate the report first, and then configure the copy as described here. |
| </WRAP> | </WRAP> |
| |
| |
| <WRAP center round info 60%> | <WRAP center round info 60%> |
| Once a report is configured to be sent to mSupply Mobile sites, it will be sent to //every// mSupply Mobile site that has the Dashboard store preference turned on. \\ | * Once a report is configured to be sent to mSupply Mobile sites, it will be sent to //every// mSupply Mobile site that has the Dashboard store preference turned on. \\ |
| Remember reports configured to be sent to mSupply Mobile sites will <wrap em>NOT</wrap> be sent to the [[https://docs.msupply.org.nz/web_interface:dashboard_using#legacy_web_dashboard|legacy (non-grafana) mSupply web dashboards]]. | * Remember reports configured to be sent to mSupply Mobile sites will <wrap em>NOT</wrap> be sent to the [[https://docs.msupply.org.nz/web_interface:dashboard_using#legacy_web_dashboard|legacy (non-grafana) mSupply web dashboard]]. |
| </WRAP> | </WRAP> |
| |
| |
| ^ Property ^ Values ^ Description ^ | ^ Property ^ Values ^ Description ^ |
| | //isMobile// | ''True'' or ''False'' | This is the important one! Enable or disable sending this report to your mobile sites | | | //isMobile// | ''True'' or ''False'' | This is the important one! This enables or disables sending this report to mobile sites.\\ When //isMobile// is ''True'', [[en:mobile:user_guide:mobile_dashboard|Mobile dashboard]] reports are generated, and <wrap em>no</wrap> [[https://docs.msupply.org.nz/web_interface:dashboard_using#legacy_web_dashboard|legacy (non-grafana) mSupply web dashboard]] report is generated.\\ When //isMobile// is ''False'', a [[https://docs.msupply.org.nz/web_interface:dashboard_using#legacy_web_dashboard|legacy (non-grafana) mSupply web dashboard]] report is generated and <wrap em>no</wrap> [[en:mobile:user_guide:mobile_dashboard|Mobile dashboard]] reports are generated.| |
| | //reportType// | ''Table'', ''BarChart'', ''LineChart'' or ''PieChart'' | The report display type. When the //reportType// parameter is not set the data displays as a ''Table'' by default. This parameter is mobile specific. | | | //reportType// | ''Table'', ''BarChart'', ''LineChart'' or ''PieChart'' | The report display type. This parameter is mobile specific, but needs to be consistent with the report method's 'type'. If the //reportType// parameter is not set, it defaults to ''Table''.| |
| | //#[report property]// | ''[field on store table]'' | This allows you to pick a value from the [[https://docs.msupply.org.nz/tables_fields:other_tables:store|store table]], which is therefore store specific, and assign the value to the ''report property''. In this way you can create a report which is customised to each store. The ''report property'' must exist in your report for this to work. See [[https://docs.msupply.org.nz/web_interface:dashboard_setup#available_dashboard_reports|report options]] for available reports and properties. See example below | | | //#[report property]// | ''[field on store table]'' | This allows you to pick a value from the [[https://docs.msupply.org.nz/tables_fields:other_tables:store|store table]], which is therefore store specific, and assign the value to the ''report property''. In this way you can create a report which is customised to each store. The ''report property'' must exist in your report for this to work. See [[https://docs.msupply.org.nz/web_interface:dashboard_setup#available_dashboard_reports|report options]] for available reports and properties. See example below | |
| |
| {{ :en:mobile:setup:server_side:mobile_dashboard_configuration.png?400 |}} | {{ :en:mobile:setup:server_side:mobile_dashboard_configuration.png?400 |}} |
| |
| |
| <WRAP center round info 60%> | |
| |
| * Existing reports can be used and the above properties currently configured are used to generate the information. | |
| * When //isMobile// is set, then no [[https://docs.msupply.org.nz/web_interface:dashboard_using#legacy_web_dashboard|legacy (non-grafana) mSupply web dashboard]] report is generated for that report. It is only generated for mobile. However the grafana web dashboard is unaffected, this runs separately. | |
| * The mobile dashboard data - in particular the //mobileReportType// and the store specific data - are only sent to mobile stores (that have the Dashboard store preference turned on). | |
| * All remaining parameters are optional and dependent on the report method. The report method determines which parameters are available / required. These remaining 'report specific' parameters must be passed to the report method exactly as it expects, using the correct parameters names. | |
| </WRAP> | |
| |
| |