Skip to content

Commit 15c9b31

Browse files
mgrochalskisoldevelomgrochalskisoldevelo
committed
Release 3.19.1 - Update release notes
1 parent 9a764e7 commit 15c9b31

1 file changed

Lines changed: 67 additions & 235 deletions

File tree

‎docs/source/releases/openlmis-ref-distro-v3.19.1.rst‎

Lines changed: 67 additions & 235 deletions
Original file line numberDiff line numberDiff line change
@@ -3,269 +3,101 @@
33
=====================================
44

55
Status: Stable
6-
===============
6+
==============
7+
Version 3.19.1 has been released to address a critical migration issue identified after the 3.19 deployment.
78

8-
3.19.1 is a stable release, and all users of `OpenLMIS version 3
9-
<https://openlmis.atlassian.net/wiki/spaces/OP/pages/88670325/3.0.0+Release+-+1+March+2017>`_ are
10-
encouraged to adopt it.
9+
New Features
10+
============
11+
- No new features have been added since version 3.19.
1112

12-
Release Notes
13-
=============
14-
The OpenLMIS Community is excited to announce the **3.19.1 release** of OpenLMIS! It is another major milestone in the version 3 `re-architecture <https://openlmis.atlassian.net/wiki/display/OP/Re-Architecture>`_ that allows more functionality to be shared among the community of OpenLMIS implementers.
13+
Improvements
14+
============
15+
- No improvements have been added since version 3.19.
1516

16-
For a full list of features and bug-fixes of 3.19.0 and 3.19.1, see `OpenLMIS 3.19.0 Jira tickets
17-
<https://openlmis.atlassian.net/issues/OLMIS-7999?jql=project%20%3D%20OLMIS%20AND%20text%20~%20%223.19_Release%22%20AND%20type%20%3D%20Epic%20ORDER%20BY%20%22Epic%20Link%22%20ASC%2C%20key%20ASC>`_.
17+
Bug Fixes
18+
==========
19+
- **Fixed migration issue**: Resolved an issue where migration scripts were failing for implementations using SUPERSET. Due to this, the Reference Data Service was unable to start after the upgrade. The migration process has been corrected to ensure a smooth upgrade and that all services, including the Reference Data Service, start and function correctly.
1820

1921
Compatibility
20-
-------------
21-
22+
=============
2223
**Important Notice** for Implementers Using a Custom Reports Service Forked from Core:
23-
If you are using a forked version of the core reports service, please ensure that your implementation is updated to incorporate the latest changes required for Dashboard reports in version 3.19.1
24+
If you are using a forked version of the core reports service, ensure your implementation is updated to include the latest changes required for Dashboard reports in version 3.19.1.
2425

25-
Refer to the following repository for the necessary updates:
26+
For the necessary updates, refer to the following repository:
2627
OpenLMIS Reports - `<https://github.com/OpenLMIS/openlmis-report/tree/rel-1.4.0-hotfix>`_
2728

28-
All other changes to OpenLMIS 3.x are backwards-compatible. All changes to data
29-
or schemas include automated migrations from previous versions back to version 3.0.1. All new or
30-
altered functionality is listed in the sections below for New Features and Changes to Existing
31-
Functionality.
32-
33-
Upgrading from Older Versions
34-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35-
36-
If you are upgrading from OpenLMIS 3.0.x or 3.1.x (without first upgrading to 3.2.x), please review the `3.2.0
37-
Release Notes <http://docs.openlmis.org/en/latest/releases/openlmis-ref-distro-v3.2.0.html>`_ for
38-
important compatibility information about a required PostgreSQL extension and data migrations.
39-
40-
For information about upgrade paths from OpenLMIS 1 and 2 to version 3, see the `3.0.0 Release
41-
Notes <https://openlmis.atlassian.net/wiki/spaces/OP/pages/88670325/3.0.0+Release+-+1+March+2017>`_.
42-
43-
If you are upgrading to version 3.19.1 THE SUPERSET reports will need to be added manually by system administrators.
44-
Short manual can be found here: `<https://github.com/OpenLMIS/openlmis-report/blob/rel-1.4.0-hotfix/CHANGELOG.md#140-hotfix--2025-04-04>`_
45-
46-
Download or View on GitHub
47-
--------------------------
48-
49-
`OpenLMIS Reference Distribution 3.19.1
50-
<https://github.com/OpenLMIS/openlmis-ref-distro/releases/tag/v3.19.1>`_
51-
52-
Known Bugs
53-
==========
54-
55-
Bug reports are collected in Jira for troubleshooting, analysis and resolution on an ongoing basis. See `OpenLMIS 3.19.1
56-
Bugs <https://openlmis.atlassian.net/issues/?jql=type%20%3D%20Bug%20and%20project%20%3D%20%22OpenLMIS%20General%22%20AND%20status%20not%20in%20(Done%2CCanceled)&startIndex=200>`_ for the current list of known bugs.
57-
58-
To report a bug, see `Reporting Bugs
59-
<http://docs.openlmis.org/en/latest/contribute/contributionGuide.html#reporting-bugs>`_.
60-
61-
Bug fixes since 3.19.0
62-
======================
63-
64-
- Fixed issue with failing migrations.
65-
66-
New Features
67-
============
68-
69-
- **Dashboard Reports Functionality**: Allows managing SUPERSET or PowerBI reports via UI.
70-
- **User Import/Export Functionality**: Enables to import and export users.
71-
- **Catchment Population Management**: Includes import/export functionality for managing population data.
72-
- **New Stock Status Reports**:
73-
- Report showing stock status at a specific point in time.
74-
- Report showing stock status over a specified time range.
75-
76-
Changes to Existing Functionality
77-
=================================
78-
79-
- **Requisition Improvements**:
80-
- Added missing fields to requisition prints.
81-
- Corrected Stock Out Days from 29 to 30.
82-
- Fixed incorrect period names for emergency requisition.
83-
- **Administration & Configuration Fixes**:
84-
- Fixed issue where user was created with an incorrect email.
85-
- Added missing filter on Requisition Groups > Edit page.
86-
- Resolved Null Pointer Exception (NPE) when adding programs to products.
87-
- **Fulfillment & Proof of Delivery Enhancements**:
88-
- Proof of Delivery Manage Action page optimized to load only relevant Orderables.
89-
- Fixed issue where it was not possible to manage both fulfillment and PoD.
90-
- **Stock Management Enhancements**:
91-
- Improved filtering by geographic zone for better performance.
92-
- Introduced new public API endpoints for stock card summaries and stock events.
93-
94-
API Changes
95-
===========
96-
97-
- API changes can be found in each service CHANGELOG.md file, found in the root directory of the service repository.
98-
99-
Performance
100-
===========
101-
102-
- Improved filtering functionalities.
103-
- Upgraded dependencies.
104-
105-
Test Coverage
106-
=============
107-
108-
OpenLMIS 3.19.1 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.19.1. Manual tests were conducted using a set of 125 QAlity tests tracked in Jira. For more details about test executions and bugs found for this release please see `the 3.19 QA Release and Bug Triage wiki page <https://openlmis.atlassian.net/wiki/spaces/OP/pages/3027566594/The+3.19+Regression+and+Release+Candidate+Test+Plan>`_.
29+
All other changes to OpenLMIS 3.x remain backwards-compatible. Any changes to data or schemas are accompanied by automated migrations from previous versions back to version 3.0.1.
10930

11031
All Changes by Component
11132
========================
33+
Version 3.19.1 of the Reference Distribution contains updated versions of the components listed below. The Reference Distribution bundles these components together using Docker to create a complete OpenLMIS instance. Each component has its own public GitHub repository (source code) and DockerHub repository (release image). The Reference Distribution and components are versioned independently.
11234

113-
Version 3.19.1 of the Reference Distribution contains updated versions of the components listed
114-
below. The Reference Distribution bundles these component together using Docker to create a complete
115-
OpenLMIS instance. Each component has its own own public GitHub repository (source code) and
116-
DockerHub repository (release image). The Reference Distribution and components are versioned
117-
independently; for details see `Versioning and Releasing
118-
<http://docs.openlmis.org/en/latest/conventions/versioningReleasing.html>`_.
119-
120-
Reference Data Service 15.3.0-hotfix
121-
-----------------------------
122-
123-
`ReferenceData CHANGELOG <https://github.com/OpenLMIS/openlmis-referencedata/blob/rel-15.3.0-hotfix/CHANGELOG.md>`_
124-
125-
Report Service 1.4.0-hotfix
126-
--------------------
127-
128-
This service is intended to provide reporting functionality for other components to use. Built-in
129-
reports in OpenLMIS 3.4.0 are still powered by their own services. In future releases, they may be
130-
migrated to a new version of this centralized report service.
131-
132-
**Warning**: Developers should take note that the design of this service will be changing with
133-
future releases. Developers and implementers are discouraged from using this 1.4.x version to build
134-
additional reports.
135-
136-
`Report CHANGELOG <https://github.com/OpenLMIS/openlmis-report/blob/rel-1.4.0-hotfix/CHANGELOG.md>`_
35+
- **BE Components**:
36+
- **Reference Data Service 15.3.0-hotfix** - `ReferenceData CHANGELOG <https://github.com/OpenLMIS/openlmis-referencedata/blob/rel-15.3.0-hotfix/CHANGELOG.md>`_
37+
- **Report Service 1.4.0-hotfix** - `Report CHANGELOG <https://github.com/OpenLMIS/openlmis-report/blob/rel-1.4.0-hotfix/CHANGELOG.md>`_
38+
- This service provides 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 this centralized report service.
39+
- **Warning**: Developers should note that the design of this service will be changing in future releases. The 1.4.x version is not recommended for building additional reports.
13740

13841
Components with No Changes
13942
==========================
43+
- **BE Components**:
44+
- **Auth Service 4.3.5** - `Auth CHANGELOG <https://github.com/OpenLMIS/openlmis-auth/blob/rel-4.3.5/CHANGELOG.md>`_
45+
- **CCE Service 1.3.5** - `CCE CHANGELOG <https://github.com/OpenLMIS/openlmis-cce/blob/rel-1.3.5/CHANGELOG.md>`_
46+
- **Fulfillment Service 9.2.0** - `Fulfillment CHANGELOG <https://github.com/OpenLMIS/openlmis-fulfillment/blob/rel-9.2.0/CHANGELOG.md>`_
47+
- **Notification Service 4.3.5** - `Notification CHANGELOG <https://github.com/OpenLMIS/openlmis-notification/blob/rel-4.3.5/CHANGELOG.md>`_
48+
- **Requisition Service 8.4.0** - `Requisition CHANGELOG <https://github.com/OpenLMIS/openlmis-requisition/blob/rel-8.4.0/CHANGELOG.md>`_
49+
- **Stock Management 5.2.0** - `Stock Management CHANGELOG <https://github.com/OpenLMIS/openlmis-stockmanagement/blob/rel-5.2.0/CHANGELOG.md>`_
50+
- **Hapifhir 2.0.4** - `Hapifhir CHANGELOG <https://github.com/OpenLMIS/openlmis-hapifhir/blob/rel-2.0.4/CHANGELOG.md>`_
51+
- **Diagnostics 1.1.4** - `Diagnostics CHANGELOG <https://github.com/OpenLMIS/openlmis-diagnostics/blob/rel-1.1.4/CHANGELOG.md>`_
52+
- **BUQ 1.0.2** - `BUQ CHANGELOG <https://github.com/OpenLMIS/openlmis-buq/blob/rel-1.0.2/CHANGELOG.md>`_
53+
- **Dhis2 Integration 1.0.1** - `Dhis2 Integration CHANGELOG <https://github.com/OpenLMIS/openlmis-dhis2-integration/blob/rel-1.0.1/CHANGELOG.md>`_
54+
55+
- **UI Components and Services**:
56+
- **Reference UI 5.2.11** - `The Reference UI <https://github.com/OpenLMIS/openlmis-reference-ui/tree/rel-5.2.11>`_
57+
- 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. Compiled together from module UI modules using Docker compose along with the OpenLMIS dev-ui.
58+
- **Reference Data-UI 5.6.16** - `ReferenceData-UI CHANGELOG <https://github.com/OpenLMIS/openlmis-referencedata-ui/blob/rel-5.6.16/CHANGELOG.md>`_
59+
- **Auth-UI 6.2.15** - `Auth-UI CHANGELOG <https://github.com/OpenLMIS/openlmis-auth-ui/blob/rel-6.2.15/CHANGELOG.md>`_
60+
- **CCE-UI 1.1.7** - `CCE-UI CHANGELOG <https://github.com/OpenLMIS/openlmis-cce-ui/blob/rel-1.1.7/CHANGELOG.md>`_
61+
- **Fulfillment-UI 6.1.6** - `Fulfillment-UI CHANGELOG <https://github.com/OpenLMIS/openlmis-fulfillment-ui/blob/rel-6.1.6/CHANGELOG.md>`_
62+
- **Report-UI 5.2.14** - `Report-UI CHANGELOG <https://github.com/OpenLMIS/openlmis-report-ui/blob/rel-5.2.14/CHANGELOG.md>`_
63+
- **Requisition-UI 7.0.14** - `Requisition-UI CHANGELOG <https://github.com/OpenLMIS/openlmis-requisition-ui/blob/rel-7.0.14/CHANGELOG.md>`_
64+
- **Stock Management-UI 2.1.8** - `Stock Management-UI CHANGELOG <https://github.com/OpenLMIS/openlmis-stockmanagement-ui/blob/rel-2.1.8/CHANGELOG.md>`_
65+
- **UI-Components 7.2.13** - `UI-Components CHANGELOG <https://github.com/OpenLMIS/openlmis-ui-components/blob/rel-7.2.13/CHANGELOG.md>`_
66+
- **UI-Layout 5.2.8** - `UI-Layout CHANGELOG <https://github.com/OpenLMIS/openlmis-ui-layout/blob/rel-5.2.8/CHANGELOG.md>`_
67+
- **Dev UI 9.0.7** - `Dev-UI CHANGLOG <https://github.com/OpenLMIS/dev-ui/blob/rel-9.0.7/CHANGELOG.md>`_
14068

141-
Auth Service 4.3.5
142-
------------------
143-
144-
`Auth CHANGELOG <https://github.com/OpenLMIS/openlmis-auth/blob/rel-4.3.5/CHANGELOG.md>`_
145-
146-
CCE Service 1.3.5
147-
-----------------
14869

149-
`CCE CHANGELOG <https://github.com/OpenLMIS/openlmis-cce/blob/rel-1.3.5/CHANGELOG.md>`_
150-
151-
Fulfillment Service 9.2.0
152-
-------------------------
153-
154-
`Fulfillment CHANGELOG <https://github.com/OpenLMIS/openlmis-fulfillment/blob/rel-9.2.0/CHANGELOG.md>`_
155-
156-
Notification Service 4.3.5
157-
--------------------------
158-
159-
`Notification CHANGELOG <https://github.com/OpenLMIS/openlmis-notification/blob/rel-4.3.5/CHANGELOG.md>`_
160-
161-
Requisition Service 8.4.0
162-
-------------------------
163-
164-
`Requisition CHANGELOG <https://github.com/OpenLMIS/openlmis-requisition/blob/rel-8.4.0/CHANGELOG.md>`_
165-
166-
Stock Management 5.2.0
167-
----------------------
168-
169-
`Stock Management CHANGELOG <https://github.com/OpenLMIS/openlmis-stockmanagement/blob/rel-5.2.0/CHANGELOG.md>`_
170-
171-
Hapifhir 2.0.4
172-
----------------------
173-
174-
`Hapifhir CHANGELOG <https://github.com/OpenLMIS/openlmis-hapifhir/blob/rel-2.0.4/CHANGELOG.md>`_
175-
176-
Diagnostics 1.1.4
177-
----------------------
178-
179-
`Diagnostics CHANGELOG <https://github.com/OpenLMIS/openlmis-diagnostics/blob/rel-1.1.4/CHANGELOG.md>`_
180-
181-
BUQ 1.0.2
182-
----------------------
183-
184-
`BUQ CHANGELOG <https://github.com/OpenLMIS/openlmis-buq/blob/rel-1.0.2/CHANGELOG.md>`_
185-
186-
Dhis2 Integration 1.0.1
187-
----------------------
188-
189-
`Dhis2 Integration CHANGELOG <https://github.com/OpenLMIS/openlmis-dhis2-integration/blob/rel-1.0.1/CHANGELOG.md>`_
190-
191-
192-
Reference UI 5.2.11
193-
------------------
194-
195-
`The Reference UI <https://github.com/OpenLMIS/openlmis-reference-ui/tree/rel-5.2.11>`_
196-
is the web-based user interface for the OpenLMIS Reference Distribution. This user interface is
197-
a single page web application that is optimized for offline and low-bandwidth environments.
198-
The Reference UI is compiled together from module UI modules using Docker compose along with the
199-
OpenLMIS dev-ui. UI modules included in the Reference UI are:
200-
201-
Reference Data-UI 5.6.16
202-
~~~~~~~~~~~~~~~~~~~~~~~
203-
204-
`ReferenceData-UI CHANGELOG <https://github.com/OpenLMIS/openlmis-referencedata-ui/blob/rel-5.6.16/CHANGELOG.md>`_
205-
206-
Auth-UI 6.2.15
207-
~~~~~~~~~~~~~
208-
209-
`Auth-UI CHANGELOG <https://github.com/OpenLMIS/openlmis-auth-ui/blob/rel-6.2.15/CHANGELOG.md>`_
210-
211-
CCE-UI 1.1.7
212-
~~~~~~~~~~~~
213-
214-
`CCE-UI CHANGELOG <https://github.com/OpenLMIS/openlmis-cce-ui/blob/rel-1.1.7/CHANGELOG.md>`_
215-
216-
Fulfillment-UI 6.1.6
217-
~~~~~~~~~~~~~~~~~~~~
218-
219-
`Fulfillment-UI CHANGELOG <https://github.com/OpenLMIS/openlmis-fulfillment-ui/blob/rel-6.1.6/CHANGELOG.md>`_
220-
221-
Report-UI 5.2.14
222-
~~~~~~~~~~~~~~~
223-
224-
`Report-UI CHANGELOG <https://github.com/OpenLMIS/openlmis-report-ui/blob/rel-5.2.14/CHANGELOG.md>`_
225-
226-
Requisition-UI 7.0.14
227-
~~~~~~~~~~~~~~~~~~~~
228-
229-
`Requisition-UI CHANGELOG <https://github.com/OpenLMIS/openlmis-requisition-ui/blob/rel-7.0.14/CHANGELOG.md>`_
230-
231-
Stock Management-UI 2.1.8
232-
~~~~~~~~~~~~~~~~~~~~~~~~~
233-
234-
`Stock Management-UI CHANGELOG <https://github.com/OpenLMIS/openlmis-stockmanagement-ui/blob/rel-2.1.8/CHANGELOG.md>`_
235-
236-
UI-Components 7.2.13
237-
~~~~~~~~~~~~~~~~~~~
70+
Upgrading from Older Versions
71+
=============================
72+
If you are upgrading from OpenLMIS 3.0.x or 3.1.x (without first upgrading to 3.2.x), please review the `3.2.0
73+
Release Notes <http://docs.openlmis.org/en/latest/releases/openlmis-ref-distro-v3.2.0.html>`_ for important compatibility information about a required PostgreSQL extension and data migrations.
23874

239-
`UI-Components CHANGELOG <https://github.com/OpenLMIS/openlmis-ui-components/blob/rel-7.2.13/CHANGELOG.md>`_
75+
For information about upgrade paths from OpenLMIS 1 and 2 to version 3, see the `3.0.0 Release
76+
Notes <https://openlmis.atlassian.net/wiki/spaces/OP/pages/88670325/3.0.0+Release+-+1+March+2017>`_.
24077

241-
UI-Layout 5.2.8
242-
~~~~~~~~~~~~~~~
78+
If you are upgrading to version 3.19.1, the SUPERSET reports will need to be added manually by system administrators.
79+
A `short manual is available here: <https://github.com/OpenLMIS/openlmis-report/blob/rel-1.4.0-hotfix/CHANGELOG.md#140-hotfix--2025-04-04>`_
24380

244-
`UI-Layout CHANGELOG <https://github.com/OpenLMIS/openlmis-ui-layout/blob/rel-5.2.8/CHANGELOG.md>`_
81+
Test Coverage
82+
=============
83+
Version 3.19.1 was released due to the critical migration issue identified after 3.19. Full regression testing was conducted for version 3.19. Since version 3.19.1 contains no new features and only fixes the migration issue, full regression testing was not required.
24584

246-
Dev UI 9.0.7
247-
~~~~~~~~~~~~
85+
Download or View on GitHub
86+
==========================
87+
`OpenLMIS Reference Distribution 3.19.1
88+
<https://github.com/OpenLMIS/openlmis-ref-distro/releases/tag/v3.19.1>`_
24889

249-
The `Dev-UI CHANGLOG <https://github.com/OpenLMIS/dev-ui/blob/rel-9.0.7/CHANGELOG.md>`_
90+
Known Issues
91+
============
92+
Bug reports are collected in Jira for troubleshooting, analysis, and resolution on an ongoing basis. See `OpenLMIS 3.19.1 Bugs <https://openlmis.atlassian.net/issues/?jql=type%20%3D%20Bug%20and%20project%20%3D%20%22OpenLMIS%20General%22%20AND%20status%20not%20in%20(Done%2CCanceled)&startIndex=200>`_ for the current list of known bugs.
25093

251-
Others
252-
~~~~~~~~~~~~
253-
`Service Util <https://github.com/OpenLMIS/openlmis-service-util>`_
254-
`Logging Service <https://github.com/OpenLMIS/openlmis-rsyslog>`_
255-
Consul-friendly distribution of `nginx <https://github.com/OpenLMIS/openlmis-nginx>`_
256-
Docker `Postgres 9.6-postgis image <https://github.com/OpenLMIS/postgres>`_
257-
Docker `scalyr image <https://github.com/OpenLMIS/openlmis-scalyr>`_
94+
To report a bug, see `Reporting Bugs
95+
<http://docs.openlmis.org/en/latest/contribute/contributionGuide.html#reporting-bugs>`_.
25896

25997
Contributions
26098
=============
261-
262-
Many organizations and individuals around the world have contributed to OpenLMIS version 3 by
263-
serving on our committees (Governance, Product and Technical), requesting improvements, suggesting
264-
features and writing code and documentation. Please visit our GitHub repos to see the list of
265-
individual contributors on the OpenLMIS codebase. If anyone who contributed in GitHub is missing,
266-
please contact the Community Manager.
99+
Many organizations and individuals around the world have contributed to OpenLMIS version 3 by serving on committees (Governance, Product, and Technical), requesting improvements, suggesting features, and writing code and documentation. Please visit our GitHub repositories to see the list of individual contributors to the OpenLMIS codebase. If anyone who contributed on GitHub is missing, please contact the Community Manager. Technical development of OpenLMIS is conducted by `SolDevelo <https://soldevelo.com>`_.
267100

268101
Further Resources
269102
=================
270-
271103
Please see the Implementer Toolkit on the `OpenLMIS website <http://openlmis.org/get-started/implementer-toolkit/>`_ to learn more about best practices in implementing OpenLMIS. Also, learn more about the `OpenLMIS Community <http://openlmis.org/about/community/>`_ and how to get involved!

0 commit comments

Comments
 (0)