Logistics Summary Report Functional Requirement

Logistic Summary Report Functional Requirement
Specification
Summary
Displays stock movement of product(s) in the selected period. Facility view (Disaggregated) show stock movement at individual facility level, and the aggregated view show aggregated data based on the selected report filter.
Components
The Logistic Summary report will have the following columns
Disaggregated ( Facility level view)

• facility code
• facility name
• facility type
• product code
• product name
• opening balance
• Receipts
• Consumption
• Adjustment
• closing balance
• reorder amount

Aggregated (District level view)

• product code
• product name
• opening balance
• receipts
• consumption
• adjustment
• closing balance
• reorder amount

Report filters:

To access this report, first the user needs to login and should have the right to access the report. Once the user browse to the report, a page with the list of report filters mentioned above will appear.
Validation
When the page loads for the first time, all report filters should be unselected except Geographic zone and Report type filters. Geographic zone filter should be defaulted to the country (the upper most level) and under Report Type the checkbox with label 'All' should be selected.
To see report data in the report, the report viewer needs to select all the required filters - Program, Schedule, Year and Period. Once all the required fields are selected, the report will try to fetch data from server. If there are some un-selected filters which are required, the report won't try to load a data from server.
All the required filters have an asterisk signed red color coded ({}{*}) will be seen beside the filter label.
Fetching
Once all the required fields are selected the report will automatically loads the data. One can change the geographic level to fine tune the report data. It's also possible to use other non-optional fields to load the report.

Fig 1: Logistics Summary report mock up
If the report viewer selects, view disaggregate check box, the report will no more show the aggregate summary. Instead, facility based logistic summary will be shown and an additional Facility Name column will be visible before product code column.

Fig 2: Logistics Summary report based on facility. Note that 'View Disaggregate' is selected
Under Report type, 'ALL' will be selected by default. But if user selects Regular checkbox, the report only shows regular data. If only 'Emergency' is selected emergency will only be seen in the report. If both get selected, the report will be a combined data of emergency and regular.
User can compare specific products logistics only by filtering report by product.
Pagination
If there is a report data based on the selection, the data will be seen in a tabular format on the HTML page with pagination buttons at the bottom of the page. The pagination is on client side and requires all the data to be loaded prior. The pagination links will be based on the row count of the data.
Apart from the pagination, there are small, horizontally stacked list of buttons on the bottom of the page to define the number of rows to show in a single paginated page. The list of buttons will have the following labels 10, 25, 50 100 consecutively. For example, If user clicks button with label '10', the number of rows that will be shown in the current page will be 10.
Data Formatting
On the tabular report all the columns except Product code, Product name, Facility name, Facility type and Facility code shows a number, right aligned with thousands separator. Product code, Product name, Facility name, Facility type and Facility code shall be aligned to the right.
Exporting
On the upper side of the report there will be two buttons for exporting the current report to PDF or XLS format. When the user clicks the PDF button, PDF version of the report will be opened in a new tab or in a new page. When the Excel button clicked, XLS export of the report will be downloaded.
The PDF output will have the country logo and below to that Report filters data used to fetch the report.




eLMIS implementation
Logistics Summary report on eLMIS can be accessed from UAT site at https://uat.zm.elmis-dev.org or by running eLMIS locally by checking out the source code from {+}https://bitbucket.org/elmis-tzm/open-lmis.git+ and one can follow the README.md file to quickly setup the project on local machine.
To access the report from UAT server, one needs to have a login account with role 'View Reports' attached to it.

Fig 3: Report viewing role.
After successful login, user can got to the report from the upper navigation menu. If the report link is not there or not visible, check the report role 'View Reports' is added to the login account.






Developer Resources
The Logistics Summary report is developed using Jasper report from PDF and XLS output and HTML and AngularJS for the HTML preview.
In the eLMIS code base, all the reports are place under module called 'reports '

Under the report module we have three folders

1. Java - Java code for fetching data from the database and transforming it to REST API
2. Resources - This folder hold compiled jasper reports
3. Template - This folder hold Jasper JRXML files. This is the place where we can find the report design to change report implementation.

How to compile report design file
To compile report files, user should navigate to the home directory of the project and issue the following command.
gradle compileJasperReport
Apart from the above command, run gradle task also compiles the report files as part of running the application. compileJasperReport compiles the jrxml files found under Template folder and move the compiled file under folder Resources.
Report End point
Under java folder listed above, we can find all the backend resources for fetching and transforming report data from db. Under this folder there a number of other dedicated folder that their name can give some meaning. Amount all the folder there is one called controller which we can find a REST controller for the starting point for most report data.
For Logistics Summary report, the report will fetch data from InteractiveReportController. We can see lots of REST resource in the class but for our report we will focus on getSummaryData method. All export format of the report will call this resource via URL {_}http://ip:port/reports/reportdata/_summary.json?disaggregated=false&facility=&facilityType=&max=10000&period=70&productCategory=&program=2&schedule=2&year=2017 with parameter query string.



Call hierarchy
org.openlmis.report.controller.InteractiveReportController#getSummaryData
> org.openlmis.report.service.SummaryReportDataProvider#getReportBody
> org.openlmis.report.mapper.SummaryReportMapper#getReport
> org.openlmis.report.builder.SummaryQueryBuilder#getQuery
How is the HTML report organised
The HTML report is designed with HTML and AngularJS. Basically all report format PDF, XLS and HTML use the same java REST endpoint to fetch a report data from the db. All HTML reports gets loaded by the following file
modules/openlmis-web/src/main/webapp/public/pages/reports/main/index.html
All report related resources like js and css files and also html partial pages will be loaded in to the above file using AngularJS routing feature.
When one browse to the report URL on the site, AngularJs will load index.html page and render
modules/openlmis-web/src/main/webapp/public/pages/reports/main/partials/summary.html partial page in to it.
If one opens and see the summary.html file its possible to see HTML section that will render the list of report filters that we saw on the screenshot. For example, to add a program filter in summary.html we can add with the following code block.
<program-filter class="form-cell horizontalFilters" required="true"></program-filter>

The above code renders the program report filter in the report page. Each report filters are composed as angular directive. One can find the list of filter directive definitions at
modules/openlmis-web/src/main/webapp/public/js/reports/shared/directives/filters.js
Each report filter that one can see in the report can be found in filters.js. Those directives calls a backend service to populate the filter control with data. The angular services that will be called by each filters and reports are found in
modules/openlmis-web/src/main/webapp/public/js/shared/services/extension-services.js
Once the report get loaded and when the report viewer selected data on all required filters, $scope.OnFilterChanged method will be called in the following js file
modules/openlmis-web/src/main/webapp/public/js/reports/main/controller/summary-controller.js
With in this AngularJS controller method, the java REST endpoint will be called to fetch the report data.
On the report page, there are two buttons at the top of the page for exporting the report on other formats. If a user wants to export the current HTML report to PDF, he/she need to click the button with the label PDF. When that button get clicked, $scope.exportReport method of the summary-controller.js file will be called.