5.2.0 Release : Readme, changelog and env changes (AOT-Technologies#1514

)

CHANGELOG.md

@@ -2,6 +2,78 @@
 
 Mark  items as `Added`, `Changed`, `Fixed`, `Removed`, `Untested Features`, `Upcoming Features`, `Known Issues`
 
+## 5.2.0 - 2023-06-30
+
+`Added`
+
+**forms-flow-web**
+
+* Added `Form bundling` premium feature, refer [here](https://aot-technologies.github.io/forms-flow-ai-doc/#formBundling) for more details.
+* Added RBAC(Role Based Access Control) support in form listing for designer and client.
+* Added admin module for adding keycloak roles and user assignment.
+* Added formsflow-admin group for RBAC support.
+
+
+**forms-flow-web-root-config**
+
+* Added micro-frontend integration using single-spa, for more details checkout [here](./forms-flow-web-root-config/README.md#integrate-micro-front-end-modules-into-host-applications).
+* Added environment variables `MF_FORMSFLOW_WEB_URL`, `MF_FORMSFLOW_NAV_URL`, `MF_FORMSFLOW_SERVICE_URL`, `MF_FORMSFLOW_ADMIN_URL`, `MF_FORMSFLOW_THEME_URL` to get MicroFrontend Components Created.
+* Added environment variables `ENABLE_FORMS_MODULE`, `ENABLE_TASKS_MODULE`, `ENABLE_DASHBOARDS_MODULE`, `ENABLE_PROCESSES_MODULE`, `ENABLE_APPLICATIONS_MODULE` to disable a particular module in forms-flow-web.
+* Added environment variable `CUSTOM_THEME_URL` for providing theming configuration.
+
+
+**forms-flow-bpm**
+
+* Added migration to support new Role Based Access(RBAC) with existing camunda authorizations.
+
+**forms-flow-api**
+
+* Added RBAC(Role Based Access Control) support in form listing for designer and client.
+* Added migration script for existing users to get all forms listed, checkout [here]( ./forms-flow-api/README.md#migration-script-for-existing-users).
+* Added admin module for adding keycloak roles and user assignment.
+* Added formsflow-admin group for RBAC support.
+
+
+`Modified`
+
+**forms-flow-web**
+
+* Application history is modified to Application status and Request status.
+* Environment variable `USER_ACCESS_PERMISSIONS` is replaced with `ENABLE_APPLICATION_ACCESS_PERMISSION_CHECK` to enable Role level permission.
+
+**forms-flow-analytics**
+
+* Redash upgraded from version 10.1.4 to 10.1.5.
+
+`forms-flow-api`
+
+*Upgrade notes:*
+
+* Flask upgraded from version 2.1.3 to 2.3.2.
+
+
+`Fixed`
+
+**forms-flow-web**
+
+* Fixed resubmit issue in form adapter for custom submission.
+
+**forms-flow-bpm**
+
+* Task list variables not updated on re-submission by client issue fixed.
+
+`Generic Changes`
+
+* forms-flow-web is replaced by forms-flow-web-root-config as the deafult web application, for the setup refer [here](./forms-flow-web-root-config)
+* Added Micro-frontend feature to enable component level customisation  which includes
+     * forms-flow-admin (includes functionalities available for the user with admin privilages)
+     * forms-flow-navbar (trigger the routing, internationalization, and login/logout functionalities for all users)
+     * forms-flow-service (contains all the common functionalties used by micro front-ends like authentication service, storage APIs etc.)
+     * forms-flow-theme (contains the common style sheet shared by all micro-front-ends)<br>
+        Refer the [forms-flow-ai-micro-front-ends](https://github.com/AOT-Technologies/forms-flow-ai-micro-front-end) repository for further details.
+* Dashboard authorization is moved from designer role to admin user.
+
+
 ## 5.1.1 - 2023-05-18
 
 `Added`

DEPENDENCIES.md

@@ -8,7 +8,7 @@ In the following document, we’ll describe the details of dependencies of vario
 
   | Component | Version|  
   | ---       | -----   |
-  |  Redash   | 10.1.4 |
+  |  Redash   | 10.1.5 |
 
 <br>
 
@@ -19,7 +19,7 @@ In the following document, we’ll describe the details of dependencies of vario
    | Component | Version |  
    | ---       | -----   |
    |  Python   |  3.9    |
-   | Flask     |  2.1.3  |
+   | Flask     |  2.3.2  |
    |  Postgres |  11.0   |
 
   <br>
@@ -30,8 +30,8 @@ In the following document, we’ll describe the details of dependencies of vario
 
    | Component | Version|  
    | ---       | -----  |
-   |  Camunda  |  7.18|
-   |  SpringBoot  | 2.7.11 |
+   |  Camunda  |  7.18.0|
+   |  SpringBoot  | 2.7.12 |
    | Postgres    | Latest |
   <br>
 
@@ -69,3 +69,14 @@ In the following document, we’ll describe the details of dependencies of vario
    | React  | 17.0.2 |
    | Formio | 2.4.1 |
    <br>
+
+## 7. forms-flow-web-root-config
+
+   To create new front-end modules<br>
+
+   | Component | Version |
+   |  --- | --- |
+   | React  | 17.0.2 |
+   | Formio | 2.4.1 |
+   | Webpack| 5.76.0|
+   <br>

deployment/README.md

@@ -64,7 +64,8 @@ Install the components in the listed order. *(NOTE: Keycloak, form.io and redash
  * [forms-flow-analytics](../forms-flow-analytics) Redash analytics components
  * [forms-flow-bpm](../forms-flow-bpm) Camunda Workflow deployment and integration
  * [forms-flow-api](../forms-flow-api) REST API of formsflow.ai
- * [forms-flow-web](../forms-flow-web) formsflow.ai integration web UI
+ * [forms-flow-web-root-config](../forms-flow-web-root-config) formsflow.ai integration web UI
+ * [forms-flow-web](../forms-flow-web) formsflow.ai custom web UI
 
 ### Openshift Based Installation
 
@@ -82,6 +83,7 @@ Install the components in the listed order. *(NOTE: Keycloak, form.io and redash
 1|`Keycloak`|Authentication|`http://localhost:8080`| `admin/changeme`
 2|`forms-flow-forms`|form.io form building. This must be started earlier for resource role id's creation|`http://localhost:3001`|`[email protected]/changeme`
 3|`forms-flow-analytics`|Redash analytics server, This must be started earlier for redash key creation|`http://localhost:7000`|Use the credentials used for registration / [Default user credentials](../forms-flow-idm/keycloak/README.md#formsflow-ai-user-credentials)
-4|`forms-flow-web`|formsflow Landing web app|`http://localhost:3000`|[Default user credentials](../forms-flow-idm/keycloak/README.md#formsflow-ai-user-credentials)
+4|`forms-flow-web-root-config`|formsflow Landing web app|`http://localhost:3000`|[Default user credentials](../forms-flow-idm/keycloak/README.md#formsflow-ai-user-credentials)
 5|`forms-flow-api`|API services|`http://localhost:5000`|`Authorization tocken from keycloak role based user credentials`
 6|`forms-flow-bpm`|Camunda integration|`http://localhost:8000/camunda`| [Default user credentials](../forms-flow-idm/keycloak/README.md#formsflow-ai-user-credentials) 
+7|`forms-flow-web`|Custom web UI|`http://localhost:3004`|[Default user credentials](../forms-flow-idm/keycloak/README.md#formsflow-ai-user-credentials)

forms-flow-analytics/README.md

@@ -1,6 +1,6 @@
 # Analytics Engine
 
-![Redash](https://img.shields.io/badge/Redash-10.1.4-blue)
+![Redash](https://img.shields.io/badge/Redash-10.1.5-blue)
 
 **formsflow.ai** leverages [Redash](https://github.com/getredash/redash) to build interactive
 dashboards and gain insights. To create meaningful visualization for

forms-flow-api-utils/README.md

@@ -1,6 +1,6 @@
 # formsflow.ai UTILS
 
-![Python](https://img.shields.io/badge/python-3.9-blue) ![Flask](https://img.shields.io/badge/Flask-1.1.4-blue) ![postgres](https://img.shields.io/badge/postgres-11.0-blue)
+![Python](https://img.shields.io/badge/python-3.9-blue) ![Flask](https://img.shields.io/badge/Flask-2.3.2-blue) ![postgres](https://img.shields.io/badge/postgres-11.0-blue)
 [![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)[![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/PyCQA/pylint)
 
 

forms-flow-api/README.md

@@ -1,7 +1,7 @@
 # formsflow.ai API
 
 [![FormsFlow API CI](https://github.com/AOT-Technologies/forms-flow-ai-dev/actions/workflows/forms-flow-api-ci.yml/badge.svg?branch=develop)](https://github.com/AOT-Technologies/forms-flow-ai-dev/actions)
-![Python](https://img.shields.io/badge/python-3.9-blue) ![Flask](https://img.shields.io/badge/Flask-2.1.3-blue) ![postgres](https://img.shields.io/badge/postgres-11.0-blue)
+![Python](https://img.shields.io/badge/python-3.9-blue) ![Flask](https://img.shields.io/badge/Flask-2.3.2-blue) ![postgres](https://img.shields.io/badge/postgres-11.0-blue)
 [![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)[![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/PyCQA/pylint)
 
 **formsflow.ai** has built this adaptive tier for correlating form management, BPM and analytics together.
@@ -19,6 +19,7 @@ the system. It is built using Python :snake: .
    * [Step 4 : Verify the Application Status](#verify-the-application-status)
 3. [API Documentation](#api-documentation)
 4. [Unit Testing](#unit-testing)
+5. [Migration Script for existing users](#migration-script-for-existing-users) (For listing existing forms for clients)
 
 ## Prerequisites
 
@@ -147,6 +148,13 @@ Things to note when writing tests:
 * Isolated: Each test should be an introvert, working in their own isolated bubble. You should never have to think about what other tests have put in the database.
 * Tests functions should contain always `app, client, session`
 
+## Migration Script for existing users
+
+#### If existing forms are to be listed for clients, you need to migrate the existing Camunda authorizations. <br><br> For this, do the following:
+* Run a bash script inside the forms-flow-api. If you need to run this script in the instance or server, such as a Kubernetes cluster or Nginx, you have to access the Docker container of the FormsFlow web API and execute the bash script called [migration.sh](./migration.sh). 
+* Alternatively, if you are setting up the environment locally and running the Docker container locally, you can get inside the FormsFlow web API container and run the `migration.sh` command.
+* In the case of running the web API with Flask locally, you should activate the virtual environment and run the bash script within it. You can create the virtual environment by following the instructions provided in the [Makefile](./Makefile) inside the forms-flow-api.
+
 #### References for Testing in Python
 
 * [pytest](https://docs.pytest.org/en/latest/getting-started.html)

forms-flow-bpm/README.md

@@ -1,7 +1,7 @@
 # Workflow Engine
 
 [![FormsFlow BPM CI](https://github.com/AOT-Technologies/forms-flow-ai-dev/actions/workflows/forms-flow-api-ci.yml/badge.svg?branch=develop)](https://github.com/AOT-Technologies/forms-flow-ai-dev/actions)
-![Camunda](https://img.shields.io/badge/Camunda-7.18.0-blue)  ![Spring Boot](https://img.shields.io/badge/Spring_Boot-2.7.11.RELEASE-blue)  ![postgres](https://img.shields.io/badge/postgres-latest-blue)  
+![Camunda](https://img.shields.io/badge/Camunda-7.18.0-blue)  ![Spring Boot](https://img.shields.io/badge/Spring_Boot-2.7.12.RELEASE-blue)  ![postgres](https://img.shields.io/badge/postgres-latest-blue)  
 **formsflow.ai** leverages Camunda for workflow and decision automation.
 
 To know more about Camunda, visit https://camunda.com/.

forms-flow-data-analysis-api/README.md

@@ -1,8 +1,8 @@
 # formsflow.ai Sentiment Analysis Component
 
-![Python](https://img.shields.io/badge/Python-3.8-blue) ![Flask](https://img.shields.io/badge/Flask-2.1.3-blue) ![postgres](https://img.shields.io/badge/postgres-11.0-blue)
-![Transformers](https://img.shields.io/badge/Transformers-4.25.1-blue)
-![Torch](https://img.shields.io/badge/Torch-1.13.1-blue)
+![Python](https://img.shields.io/badge/Python-3.8-blue) ![Flask](https://img.shields.io/badge/Flask-2.3.2-blue) ![postgres](https://img.shields.io/badge/postgres-13.0-blue)
+![Transformers](https://img.shields.io/badge/Transformers-4.30.2-blue)
+![Torch](https://img.shields.io/badge/Torch-2.0.1-blue)
 
 Sentiment Analysisis used to understand the sentiments of the customer for products, movies, and other such things, whether they feel positive, negative, or neutral about it. BERT is a very good pre-trained language model which helps machines learn excellent representations of text with respect to context in many natural language tasks. 
 

forms-flow-documents/README.md

@@ -1,6 +1,6 @@
 # formsflow.ai Documents API
 
-![Python](https://img.shields.io/badge/python-3.9-blue) ![Flask](https://img.shields.io/badge/Flask-2.1.3-blue) ![postgres](https://img.shields.io/badge/postgres-11.0-blue)
+![Python](https://img.shields.io/badge/python-3.9-blue) ![Flask](https://img.shields.io/badge/Flask-2.3.2-blue) ![postgres](https://img.shields.io/badge/postgres-11.0-blue)
 [![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/PyCQA/pylint)