3.4.0 Release Notes - 17 August 2018¶
3.4.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.4.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. It is also the first release since the Gap Project has started. We are excited to announce that four organizations collaboratively worked on the 3.4 release!
For a full list of features and bug-fixes since 3.3.1, see OpenLMIS 3.4.0 Jira tickets.
For information about future planned releases, see the Living Product Roadmap. Pull requests and contributions are welcome.
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.4.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.
Download or View on GitHub¶
Bug reports are collected in Jira for troubleshooting, analysis and resolution on an ongoing basis. See OpenLMIS 3.4.0 Bugs for the current list of known bugs.
To report a bug, see Reporting Bugs.
3.4 offers a wide range of new features and enhancements:
Reporting: The new reporting infrastructure is dockerized and deployed within the OpenLMIS deployment. See the Reporting service for more details.
- Configurable templates for one-click requisitions based on current stock on hand records within stock management. We call this a stock based requisition.
- Ability to hide and add new products to improve end user usability.
- Ability to convert requisitions without creating an order.
- New R&R column to account for “additional quantities” from new demand.
Orders: New FTP retry feature when orders fail to transmit initially.
- New “opting out” feature for email notifications.
- Improving the user profile so that users can manage their own data.
- New reset password options.
- New user profile information (roles and rights).
Notifications: Redesigned to support more personalization and future work on supporting more channels.
Changes to Existing Functionality¶
Some APIs have changes to their contracts and/or their request-response data structures. These changes impact developers and systems integrating with OpenLMIS:
- Authentication Service v4.0.0 - Changes to the user resource structure: auth changelog
- Notification Service v4.0.0 - Changes to the user contact details resource and the /api/notification endpoint: notification changelog
- Reference Data Service v11.0.0 - Changes to the user resource structure: ref-data changelog
- Requisition Service v7.0.0 - Changes to the periodsForInitiate endpoint: requisition changelog
- Stock Management UI Service v3.1.0 - Renamed admin-reason-modal module: stockmanagement changelog
- UI Components Service v6.0.0 - Changed syntax for using datepicker: ui-components changelog
- Dev-UI Service v8.0.0 - Replaced syncTransifex grunt option: dev-ui changelog
There are minor regressions in the sync, submit, authorize and single approve within the requisition service with slight improvements in convert to order.
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. For more details about the specific work done to improve performance for 3.4.0, please reference this list of tasks.
The following chart displays the 3.4.0 UI loading times in seconds for both 3.3.1 and 3.4.0 using the same test data.
OpenLMIS 3.4.0 is the second release using the new 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.4.0. Manual tests were conducted using a set of 142 Zephyr tests tracked in Jira. A total of 34 bugs were found during testing. See the spreadsheet of all test executions for this release: 3.4.0 release test case executions.csv.
All Changes by Component¶
Version 3.4.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.
Auth Service 4.0.0¶
CCE Service 1.0.1¶
Fulfillment Service 7.0.1¶
Notification Service 4.0.0¶
Reference Data Service 11.0.0¶
Report Service 1.1.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.1.1 version to build additional reports.
Requisition Service 7.0.0¶
Stock Management 3.1.0¶
Reference UI 5.1.0¶
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:
Reference Data-UI 5.4.0¶
Stock Management-UI 3.1.0¶
Dev UI v8¶
The Dev UI developer tooling has advanced to v8.
Components with No Changes¶
The components that have not changed are:
- Service Util
- Logging Service
- Consul-friendly distribution of nginx
- Docker Postgres 9.6-postgis image
- Docker scalyr image
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.
Please see the Implementer Toolkit on the OpenLMIS website to learn more about best practicies in implementing OpenLMIS. Also, learn more about the OpenLMIS Community and how to get involved!