3.10.0 Release Notes - November 18, 2020¶
3.10.0 is a stable release, and all users of OpenLMIS version 3 are encouraged to adopt it.
The OpenLMIS Community is excited to announce the 3.10.0 release of OpenLMIS! It is another major milestone in the version 3 re-architecture that allows more functionality to be shared among the community of OpenLMIS implementers.
For a full list of features and bug-fixes since 3.10.0, see OpenLMIS 3.10.0 Jira tickets.
Unless noted here, all other changes to OpenLMIS 3.x are backwards-compatible. All changes to data or schemas include automated migrations from previous versions back to version 3.0.1. All new or altered functionality is listed in the sections below for New Features and Changes to Existing Functionality.
Upgrading from Older Versions¶
If you are upgrading to OpenLMIS 3.10.0 from OpenLMIS 3.0.x or 3.1.x (without first upgrading to 3.2.x), please review the 3.2.0 Release Notes for important compatibility information about a required PostgreSQL extension and data migrations.
For information about upgrade paths from OpenLMIS 1 and 2 to version 3, see the 3.0.0 Release Notes.
Bug reports are collected in Jira for troubleshooting, analysis and resolution on an ongoing basis. See OpenLMIS 3.10.0 Bugs for the current list of known bugs.
To report a bug, see Reporting Bugs.
The OpenLMIS community focused on the following work in version 3.10.0:
- Stock Management - Offline Functionality The Stock Management service has been updated to support limited offline functionality. This offline functionality is currently limited to the Physical Inventory page and adds the ability to make edits and save the changes locally while offline. Future releases will extend this offline functionality to the other areas of Stock Management.
- Reporting Stack - Deployment and Configuration Improvements As part of an ongoing effort to improve and streamline the OpenLMIS Reporting system, we have made significant changes to bring the deployment and configuration tasks in line with the other OpenLMIS services. This work is ongoing and we welcome any feedback about future areas to improve.
Reference the 3.10 epics for more details.
API changes can be found in each service CHANGELOG.md file, found in the root directory of the service repository.
As expected, the performance of version 3.10.0 is similar to version 3.9.0. Performance remains a high priority for the OpenLMIS community and we will be revisiting the overall performance picture in our next release, version 3.11.
OpenLMIS conducted manual performance tests of the same user workflows with the same test data we used in testing v3.2.1 to establish that last-mile performance characteristics have been retained at a minimum. For details on the test results and process, please see this wiki page.
The following chart displays the UI loading times in seconds for 3.7, 3.8, 3.9, and 3.10 using the same test data.
OpenLMIS 3.10.0 was tested using the established OpenLMIS Release Candidate process. As part of this process, full manual test cycles were executed for each release candidate published. Any critical or blocker bugs found during the release candidate were resolved in a bug fix cycle with a full manual test cycle executed before releasing the final version 3.10.0. Manual tests were conducted using a set of 99 Zephyr tests tracked in Jira and 7 manual tests for reporting. For more details about test executions and bugs found for this release please see the 3.10 QA Release and Bug Triage wiki page.
All Changes by Component¶
Version 3.10.0 of the Reference Distribution contains updated versions of the components listed below. The Reference Distribution bundles these component together using Docker to create a complete OpenLMIS instance. Each component has its own own public GitHub repository (source code) and DockerHub repository (release image). The Reference Distribution and components are versioned independently; for details see Versioning and Releasing.
Report Service 1.2.1¶
This service is intended to provide reporting functionality for other components to use. Built-in reports in OpenLMIS 3.4.0 are still powered by their own services. In future releases, they may be migrated to a new version of this centralized report service.
Warning: Developers should take note that the design of this service will be changing with future releases. Developers and implementers are discouraged from using this 1.2.x version to build additional reports.
Reference UI 5.1.9¶
The Reference UI is the web-based user interface for the OpenLMIS Reference Distribution. This user interface is a single page web application that is optimized for offline and low-bandwidth environments. The Reference UI is compiled together from module UI modules using Docker compose along with the OpenLMIS dev-ui. UI modules included in the Reference UI are:
Components with No Changes¶
The components that have not changed are:
Many organizations and individuals around the world have contributed to OpenLMIS version 3 by serving on our committees (Governance, Product and Technical), requesting improvements, suggesting features and writing code and documentation. Please visit our GitHub repos to see the list of individual contributors on the OpenLMIS codebase. If anyone who contributed in GitHub is missing, please contact the Community Manager.
Thanks to the Malawi implementation team who has continued to contribute a number of changes that have global shared benefit.