Release Notes

The release of 3.1.2 is primarily a bug-fix and performance release, with over 20 bugs fixed since 3.1.0 and major improvements in performance.

This release also includes notable new features:

• in stock management for vaccines: capture VVM (vaccine vial monitor) values while recording stock data
   and 
• in requisition: new "Rejected" status that improves the requisition workflow
• new admin screens to view Supervisory Nodes
  

Compatibility

All changes are backwards-compatible. Any changes to data include automated migrations from previous versions back to 3.0.1. Any exceptions are identified in the Components sections below.

For background information on OpenLMIS version 3's new micro-service architecture, extensions/customizations, and upgrade paths for OpenLMIS versions 1 and 2, see the 3.0.0 Release - 1 March 2017.

Download or View on GitHub

OpenLMIS Reference Distribution 3.1.2

Components

Version 3.1.2 of the Reference Distribution has updated versions of the components listed below. The Reference Distribution bundles these component together using Docker to create a complete OpenLMIS instance.

For background info about how components and the Reference Distribution are versioned, see Versioning and Releasing.

Reference UI 5.0.2

The reference UI bundles the following UI components together.

auth-ui 5.0.2

New functionality added in a backwards-compatible manner:

• OLMIS-2553: Removed login offline functionality and added warning when logging out while offline.
  This feature change impacts users working offline and is a significant security improvement.

Bug fixes:

• OLMIS-2548: Fixed lack of loading modal after re-authenticating.
• OLMIS-2637: Red password error message will no longer show when logging in.

See auth-ui CHANGELOG.

fulfillment-ui 5.0.2

Bug fixes

• OLMIS-2567: Incorperated openlmis-facility-program-select.
• OLMIS-2532: Fixed manage PODs view always displayed the previously facility.

See fulfillment-ui CHANGELOG.

referencedata-ui 5.2.0

New functionality added in a backwards-compatible manner:

• OLMIS-2567: Added openlmis-facility-program-select component.

Improvements:

• OLMIS-2444: Added new "add" button class.
• OLMIS-2384: Changed "email verified" label from text to checkbox and added cancel button to user edit page.
• OLMIS-2385: Changed type message.
• OLMIS-2495: Changed links to buttons on user list screen.
• OLMIS-2494: Name, description and rights will now properly be marked as required on the Role creation/edit screen.
• OLMIS-2648: When changing user's home facility, system also prompts for removing roles for old home facility.
• OLMIS-2689: When filtering by home facility on initiate requisition view, only programs supported by home facility are shown.
• OLMIS-2280: Added supervisory list + edit screens.

See referencedata-ui CHANGELOG.

report-ui 5.0.2

Bug fixes:

• Pull Request #7 in report-ui: Added missing error message translation string for "no reports"

See report-ui CHANGELOG.

requisition-ui 5.1.0

New functionality added in a backwards-compatible manner:

• Pull Request #9 in requisition-ui: Added support for requisition REJECTED status.
  This is a new feature to improve the Rejected requisition workflow. It was contributed by a country implementation. See the updated Requisition States and Workflow documentation.
• Pull Request #4 in requisition-ui: Added filter to convert to order page.
• Pull Requests #6, #7 and #8 in requisition-ui: Improves performance of requisitions with large numbers of products.
  This UI improvement depends on the new version of the Requisition service which has smaller JSON payloads; see below.

Improvements:

• OLMIS-2444: Added new "add" button class.
• OLMIS-2533: Allowed for smaller requests from UI to server.
• OLMIS-2572: Column definition will now show when hovering over whole header instead of only the button.
• OLMIS-2567: Implements openlmis-facility-program-select.

Bug fixes:

• OLMIS-2638: Updated read-only check to make sure user right and requisition status match
• OLMIS-2664: Requisition will now be saved before getting rejected to preserve the status message.
• OLMIS-2704: Added warning if cached requistion is outdated.

See requisition-ui CHANGELOG.

stockmanagement-ui 1.0.0-beta

(no changes from this same beta version released with ref-distro 3.1.0)

ui-components 5.1.0

New functionality added in a backwards-compatible manner:

• OLMIS-2704: Added style for button inside alert.
• OLMIS-2657: Added openlmis-cache service to support openlmis-facility-program-select.
• OLMIS-2572: Added popover-trigger-area attribute to the popover directive which lets user chose whether the whole element or just the added button should trigger the popover.
• OLMIS-2509: Fixed calculation of the tbody title width, which was causing some strange behavior of the tables.
• OLMIS-2476: Simplified select implementation with select2
• OLMIS-2444: Added new "add" button class.
• OLMIS-2494: Added textarea-required directive responsible for displaying "This field is required" when form have been submitted, but didn't pass the validations. Recolored the "This field is required" to red.
• OLMIS-2548: Added isOpened flag to loadingModalService.
• OLMIS-2648: Added possibility to customize cancel button message in confirm service, added support for messages with parameters.

Bug fixes:

• OLMIS-2660: Made "No options available" show when there is unknown option
• OLMIS-2328: Fixed table resizing bug.

See ui-components CHANGELOG.

ui-layout:5.0.1

(same version as with ref-distro 3.1.0)

Requisition Service 4.0.0

Contract breaking changes*:

• OLMIS-2566: Requisition search endpoint will now return new, smaller DTO object, which only contains basic information about the requisition, processing period, program and facility.
• OLMIS-2533: Requisition endpoints: initiate, update, submit, authorize, approve, requisitionsForConvert will now return new, smaller basic DTO object, which only contains basic information required for API client.
  This performance improvement depends on the corresponding UI improvements made in the requisition-ui; see above.
• Added support for requisition REJECTED status.
  This is a new feature to improve the Rejected requisition workflow. It was contributed by a country implementation. See the updated Requisition States and Workflow documentation.

*These are significant changes that alter previous API contracts. The API changes will impact developers who are using these Requisition APIs. For end-users, the changes bring significant performance improvements because the data returned by some endpoints has been reduced for efficiency.

New functionality added in a backwards-compatible manner:

• OLMIS-2664: Requisition reject endpoint saves status messages.
• OLMIS-2611: Added using locale from env file.

Bug fixes added in a backwards-compatible manner:

• OLMIS-2551: Use batch order creation endpoint from fulfilment when converting requisitions to orders - all orders are created in a single transaction.
• OLMIS-2596: Update endpoint returns better message when cannot update
• OLMIS-2280: Updated Referencedata Supervisory Node service to use paginated search endpoint.

Performance improvements added in a backwards-compatible manner:

• OLMIS-2641: Improve performance of RequisitionDto by utilizing bulk search of orderables
• Pull Requests #29, #28, #26 and #18 in requisition: Find orderables by IDs (a bulk search of orderables)
• OLMIS-2642: Improve performance of Requisition initialize
• Pull Request #32: change collections to use lazy fetch mode
• Pull Requests #34 and #35 in requisition: use a map of orderableId to lineItem instead of nested iteration
• Improve performance of view right checking for multiple requisitions

See requisition CHANGELOG.

Fulfillment Service 4.0.0

Contract breaking changes*:

• Order endpoints (except for POST /orders and GET /orders/{id}) will now return new, smaller Dto object, which only contains basic information about the order.

*This is a significant change that alters previous API contracts. This API change will impact developers who are using this Fulfillment API. For end-users, the change brings significant performance improvements because the data returned has been reduced for efficiency.

New functionality added in a backwards-compatible manner:

• OLMIS-2551: Added an endpoint for batch order creation, which allows creating multiple orders in one transaction
• Added pricePerPack to ProgramOrderableDto
• OLMIS-2611: Added using locale from env file

Performance improvements added in a backwards-compatible manner:

• Removed Products with Zero-Quantity Values from Order Export File
• Set LAZY flag for all collections inside Order and Proof of Delivery classes
• A single request with orderable IDs will be sent to reference-data service when Order Dto object is created
• Improve performance of view right checking for multiple orders
• Search endpoint performance fixes:
  • Create basic order dto object only for orders that would be returned.
  • Moved sort command into database layer.

See fulfillment CHANGELOG.

Stock Management 1.0.0-beta

This is the same beta version of the Stock component as was previously released in ref-distro 3.1.0. It is a first release of stock management features in OpenLMIS version 3.

Reference Data Service 7.0.0

Breaking changes*:

• OLMIS-2280: Added pagination, new parameters (zoneId, name, code) to supervisory node search endpoint

*impact APIs and developers, but no impact to users and their data

New functionality added in a backwards-compatible manner:

• OLMIS-2611: Added using locale from env file.

Bug fixes, security and performance improvements, also backwards-compatible:

• OLMIS-2606: Fix saving requisition groups with requisition group program schedules.

See referencedata CHANGELOG.

Auth Service 3.0.3

Improvements which are backwards-compatible:

• OLMIS-2611: Added using locale from env file.

See auth CHANGELOG.

Notification Service 3.0.2

New functionality added in a backwards-compatible manner:

• OLMIS-2611: Added using locale from env file.

See notification CHANGELOG.

Components with No Changes

Other tooling components have not changed, including: the logging service, the tailored docker-ized distribution of nginx and postgres, and a library for shared Java code called service-util.

Contributions

Thanks to the Malawi implementation team who has contributed a number of pull requests to add functionality and customization in ways that have global shared benefit.

Also, thanks to everyone who contributed to OpenLMIS 3.0.0.

Further Resources

View all JIRA Tickets in 3.1.2.

Learn more about the OpenLMIS Community and how to get involved!