web_interface:unfpa_reports_app

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
web_interface:unfpa_reports_app [2022/04/10 22:59] – [What is it?] Mark Gloverweb_interface:unfpa_reports_app [2024/12/13 03:14] (current) – [What is it?] Mark Glover
Line 1: Line 1:
 {{indexmenu_n>110}} {{indexmenu_n>110}}
-====== 19.11. UNFPA LMA reports app ======+====== 19.12. UNFPA LMA reports app ======
 ===== What is it? ===== ===== What is it? =====
  
-Some of our [[https://www.unfpa.org/|UNFPA]] users are periodically required to produce [[https://www.unfpa.org/supplychain#last-mile|Last Mile Assurance (LMA)]] reports. These can be time consuming and difficult to produce manually so we've created an app for that!+Some [[https://www.unfpa.org/|UNFPA]] users are periodically required to produce [[https://www.unfpa.org/supplychain#last-mile|Last Mile Assurance (LMA)]] reports. These can be time consuming and difficult to produce manually so we've created an app for that!
  
 This app runs on the central server of your mSupply installation and will create a selection of UNFPA formatted LMA reports as spreadsheet files for you; all you have to do is make some selections to define what transactions and stock should be included in the reports. This app runs on the central server of your mSupply installation and will create a selection of UNFPA formatted LMA reports as spreadsheet files for you; all you have to do is make some selections to define what transactions and stock should be included in the reports.
 +
 +The reports take data from the mSupply dashboard and generate excel reports in pre-defined templates.  The mSupply server exports data to the mSupply dashboard periodically, normally no less frequently than daily, so the data is 'near-live'
 +
 +So, for the app to reliably generate data, all three services need to be operating:
 +
 +  * mSupply server
 +  * mSupply dashboard
 +  * UNFGPA LMA reports app
 +  * mSupply Web server - refer [[preferences:general#server_tab|Server tab]] page for details.
  
  
Line 17: Line 26:
 For details of how to add tags to stores, please see the [[other_stuff:virtual_stores#tags|Store tags]] page. For details of how to add tags to stores, please see the [[other_stuff:virtual_stores#tags|Store tags]] page.
  
 +==== User permission ====
 +Make sure that the user has right to "Use the Dashboard". This check box control the login rights to the "UNFPA LMA reports app", without this the user will not be able to login.
  
 +
 +{{ :web_interface:user_logon_dashbaord.png?600 |}}
 ===== Using the app ===== ===== Using the app =====
-To get to the app, the webserver must be running in mSupply (see the [[preferences:general#server_tab|Server tab]] page for details on that). 
  
-In your browser, enter the URL of your server followed by the port the app is running on (if you don't know what this is, ask Sustainable Solutions).  It should be something like this:+<WRAP center round alert 60%> 
 +  * Since this is a web application, it cannot generate reports larger than 6 MB in size. If the report exceeds 6 MB in size, the generation process could fail. 
 +  * We recommend using the filters (date, master-list and donors) to reduce the size of reports.  Leaving these filters blank would include //all// data, except for:  
 +    * The store by tag filter which defaults to all ''UNFPA_Central'' and ''UNFPA_decentralised'' stores. 
 +    * The date range filter which defaults to a single day, 'Today'.  You will likely want to change this, especially since unless you run this at the very end of the day, your will not even get a full day's worth of data! 
 +  * We recommend keeping the number of stores to a minimal number. 
 +  * The report that generates the largest size file is the **Item Ledger report**, the above recommendations should specially be followed for it, however, sometimes other reports may also generate large reports. 
 +</WRAP> 
 + 
 + 
 +In your browser, enter the URL of your server followed by the port the app is running on (if you don't know what this is, ask the mSupply Foundation <support@msupply.foundation>.  It should be something like this:
 <code>https://example.com:4000</code> <code>https://example.com:4000</code>
  
Line 36: Line 58:
 On this window, make your selections to define what will go in your report: On this window, make your selections to define what will go in your report:
   * **Report to create drop down list:** Select one of the following options:   * **Report to create drop down list:** Select one of the following options:
-    * Quarterley review report +    * **Quarterley review report** 
-    * LMA IP SC Fact Sheet report +    * **LMA IP SC Fact Sheet report** 
-    * Stock on date +    * **Stock on date** 
-    * Ledger+    * **Ledger**
   * **Include transactions in this date range in the report fields**: click on the **From** and **To** dates to select the dates from calendars. Only transactions with a confirmed date that falls between the **From** and **To** dates will be included in the report.   * **Include transactions in this date range in the report fields**: click on the **From** and **To** dates to select the dates from calendars. Only transactions with a confirmed date that falls between the **From** and **To** dates will be included in the report.
   * **Items to include in report drop down list:** Contains a list of all the master lists in your datafile. Select one to include only items from that master list in the report.   * **Items to include in report drop down list:** Contains a list of all the master lists in your datafile. Select one to include only items from that master list in the report.
-  * **Include stock from these donors in the report drop down list:** You can choose one or more donors - if you do then only stock that came from them will be included in the report. You can also choose //None// (the default option), in which case a donor filter will not be applied. +  * **Include stock from these donors in the report drop down list:** You can choose one or more donors - if you do then only stock that came from them will be included in the report. You can also choose //None// (the default option), in which case a donor filter will not be applied, and //all// transactions will be included. 
- +  * Store selection 
-If you select any report in the **Report to create** drop down list //EXCEPT// the **Quarterley review report**, an additional store filter is added to the bottom of the options:+    * If you selected the **Quarterley review report**, then it is only run on the ''UNFPA_Central'' store and you are not given a list of stores to include.  If no store is tagged as ''UNFPA_Central'', then this report is likely to fail. 
 +    * If you select any report in the **Report to create** drop down list //EXCEPT// the **Quarterley review report**, an additional store filter is added to the bottom of the options:
  
 {{ :web_interface:screenshot_2022-02-17_at_12.17.10.png?600 |}} {{ :web_interface:screenshot_2022-02-17_at_12.17.10.png?600 |}}
Line 62: Line 85:
  
 ===== Example report outputs ===== ===== Example report outputs =====
-==== Quarterley review report ====+==== Quarterly review report ====
 {{ :web_interface:screenshot_2022-02-17_at_12.41.07.png?1000 |}} {{ :web_interface:screenshot_2022-02-17_at_12.41.07.png?1000 |}}
  
Line 78: Line 101:
 |  //  Previous:  **[[web_interface:sync_api]]** | | Next: **[[cold_chain_equipment:]]** //  | |  //  Previous:  **[[web_interface:sync_api]]** | | Next: **[[cold_chain_equipment:]]** //  |
 ---- struct data ---- ---- struct data ----
-pagestatus.status    : +pagestatus.status    : All Good
 ---- ----
  
  • Last modified: 2022/04/10 22:59
  • by Mark Glover