RC4.0.1 changes (#134)

v4.0.1 Changes Co-authored-by: nikhila-aot <[email protected]> Co-authored-by: Josephalexantony-aot <[email protected]> Co-authored-by: Kurian Benoy <[email protected]> Co-authored-by: Abil P Raju <[email protected]> Co-authored-by: shibin-aot <[email protected]> Co-authored-by: unknown <[email protected]> Co-authored-by: sumathi-thirumani-aot <[email protected]> Co-authored-by: Shibin Thomas <[email protected]> Co-authored-by: seethalelias-aot <[email protected]> Co-authored-by: seethalelias-aot <[email protected]> Co-authored-by: twinkleaot <[email protected]> Co-authored-by: kurianbenoy-aot <[email protected]> Co-authored-by: sumathi-thirumani-aot <[email protected]> Co-authored-by: Kurian Benoy <[email protected]> Co-authored-by: Josephalexantony-aot <[email protected]> Co-authored-by: Abil P Raju <[email protected]> Co-authored-by: shibin-aot <[email protected]> Co-authored-by: unknown <[email protected]> Co-authored-by: sumathi-thirumani-aot <[email protected]> Co-authored-by: Shibin Thomas <[email protected]> Co-authored-by: seethalelias-aot <[email protected]> Co-authored-by: seethalelias-aot <[email protected]> Co-authored-by: kurianbenoy-aot <[email protected]> Co-authored-by: sumathi-thirumani-aot <[email protected]>
AOT-Technologies · Jul 13, 2021 · d012566 · d012566
1 parent a1a447f
commit d012566
Show file tree

Hide file tree

Showing 155 changed files with 19,999 additions and 10,354 deletions.
diff --git a/.images/Designer_form-edit.png b/.images/Designer_form-edit.png
diff --git a/.images/client-landing.PNG b/.images/client-landing.PNG
diff --git a/.images/client-submission-success.PNG b/.images/client-submission-success.PNG
diff --git a/.images/client-submission.PNG b/.images/client-submission.PNG
diff --git a/.images/designer-feedback-1.PNG b/.images/designer-feedback-1.PNG
diff --git a/.images/designer-final-submit.PNG b/.images/designer-final-submit.PNG
diff --git a/.images/designer-landing.PNG b/.images/designer-landing.PNG
diff --git a/.images/designer-publish.PNG b/.images/designer-publish.PNG
diff --git a/.images/designer-workflow.PNG b/.images/designer-workflow.PNG
diff --git a/.images/reviewer-action.png b/.images/reviewer-action.png
diff --git a/.images/reviewer-form-view.PNG b/.images/reviewer-form-view.PNG
diff --git a/.images/reviewer-landing-1.png b/.images/reviewer-landing-1.png
diff --git a/.images/reviewer-landing.PNG b/.images/reviewer-landing.PNG
diff --git a/.images/reviewer-print.PNG b/.images/reviewer-print.PNG
diff --git a/.images/reviewer-view-forms.PNG b/.images/reviewer-view-forms.PNG
diff --git a/.images/reviewer_beforeclaim.png b/.images/reviewer_beforeclaim.png
diff --git a/.images/reviewer_diagram.png b/.images/reviewer_diagram.png
diff --git a/.images/reviewer_history.png b/.images/reviewer_history.png
diff --git a/.images/reviewer_history_changed.png b/.images/reviewer_history_changed.png
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,63 @@
 # Changelog for formsflow.ai
 Mark  items as `Added`, `Changed`, `Fixed`, `Removed`, `Untested Features`, `Upcoming Features`
 
+## 4.0.1 - 2021-07-13
+
+`Added`
+
+**forms-flow-api**
+* Support for allowing CORS with multiple comma-separated origins.
+* Added authorization on the application details page based on user roles.
+
+**forms-flow-bpm**
+* Added new workflows - `One-Step Approval Process` and `Two-Step Approval Process`.
+
+**forms-flow-forms**
+* Added new forms- `Create New Business License Application` and `Freedom of Information and Protection of Privacy`.
+
+**forms-flow-web**
+* Show/hide Application Menu based on keycloak group.
+* Show/hide View Submissions button in form webpage based on keycloak group.
+* Add 404 page.
+* Add 403 page.
+
+`Fixed`
+
+**forms-flow-analytics**
+* Fixed the failing installation of the analytics component.
+
+**forms-flow-api**
+* Fix application details API not displaying values to client users.
+* Fixed the issue of not creating applications when called from the BPM side with process-instance-id.
+
+**forms-flow-bpm**
+* Fix done for authentication issue with Keycloak in the Keycloak configuration.
+* Fix done for single result query fetching multiple record's during formio REST call.
+
+**forms-flow-web**
+* Resolve Last Modified column on the client Application page is not working. 
+* Fix Application search icons breaking. 
+* Resolve Mime type issue in the webpage. 
+
+`Modified`
+
+**forms-flow-bpm**
+* formio token generation cycle reduced from 24 hours to 3.50 Hours.
+* Modified checked exception's on Listener services to Runtime exception.
+* Modified application logging package to Camunda base package level.
+
+**forms-flow-web**
+* Modify WebSocket implementation to support reconnection in Task Menu.
+* Footer was modified to display formsflow.ai with the version number.
+
+`Generic Changes`
+* Improved the README to document supported version for Keycloak.
+* Updated [usage docs](./USAGE.md) with the latest form and workflow.
+* v1.0.7 release for `camunda-formio-tasklist-vue`,a Vue.js-based package for easy integration of formsflow.ai to existing projects. To know more details checkout [formsflow-ai-extension repository](https://github.com/AOT-Technologies/forms-flow-ai-extensions/tree/master/camunda-formio-tasklist-vue) 
+
+`Known Issues`
+* Consoles related to http://localhost:3001/current Api Failing. The console messages can be ignored. Please refer to [Issue-#106](https://github.com/AOT-Technologies/forms-flow-ai/issues/106) for more details.
+
 ## 4.0.0 - 2021-06-11
 
 `Added`
@@ -85,7 +142,6 @@ Mark  items as `Added`, `Changed`, `Fixed`, `Removed`, `Untested Features`, `Upc
 * Custom component (Text Area with analytics) not retaining the value after submission
 * Cosmetic changes to show success message after loading is completed
 
-
 ## 2.0.1 - 2020-07-27
 `Added`
 * This file (CHANGELOG.md)

diff --git a/USAGE.md b/USAGE.md
diff --git a/deployment/docker/README.md b/deployment/docker/README.md
@@ -116,7 +116,7 @@ Start the **analytics server** by following the instructions given [here](../../
 Variable name | Meaning | Possible values | Default value |
 --- | --- | --- | ---
 `KEYCLOAK_URL`:triangular_flag_on_post:| URL to your Keycloak server || `http://{your-ip-address}:8080`
-`KEYCLOAK_URL_REALM`|	The Keycloak realm to use|eg. forms-flow-ai | `forms-flow-ai`
+`KEYCLOAK_URL_REALM`|The Keycloak realm to use|eg. forms-flow-ai | `forms-flow-ai`
 `KEYCLOAK_BPM_CLIENT_ID`|Client ID for Camunda to register with Keycloak|eg. forms-flow-bpm|`forms-flow-bpm`
 `KEYCLOAK_BPM_CLIENT_SECRET`:triangular_flag_on_post:|Client Secret of Camunda client in realm|eg. 22ce6557-6b86-4cf4-ac3b-42338c7b1ac12|must be set to your Keycloak client secret. Follow the 'Get the keycloak client secret' steps from [Here](../../forms-flow-idm/keycloak/README.md#get-the-keycloak-client-secret)
 `KEYCLOAK_WEB_CLIENT_ID`|Client ID for formsflow.ai to register with Keycloak|eg. forms-flow-web|`forms-flow-web`
@@ -163,13 +163,16 @@ Variable name | Meaning | Possible values | Default value |
 --- | --- | --- | ---
 `NODE_ENV`| Define project level configuration | `development, test, production` | `development`
 `APPLICATION_NAME`| Application_Name | eg: formsflow.ai| `formsflow.ai`
-`FORMSFLOW_API_CORS_ORIGINS`| formsflow.ai Rest API allowed origins, for multiple origins you can separate host address using a comma |eg:`host1, host2`| `*`
+`FORMSFLOW_API_CORS_ORIGINS`| formsflow.ai Rest API allowed origins, for allowing multiple origins you can separate host address using a comma seperated string or use * to allow all origins |eg:`host1, host2, host3`| `*`
 `CAMUNDA_API_URL` :triangular_flag_on_post: |Camunda Rest API URL||`http://{your-ip-address}:8000/camunda`
 `FORMSFLOW_API_URL`:triangular_flag_on_post:|formsflow.ai Rest API URL||`http://{your-ip-address}:5000`
 `FORMSFLOW_API_ANALYTICS_DB_USERNAME`|Mongo DB Connection username|Used on installation to create the database. Choose your own|`mongo`
 `FORMSFLOW_API_ANALYTICS_DB_PASSWORD`|Mongo DB Connection password|Used on installation to create the database. Choose your own|`changeme`
 `FORMSFLOW_API_ANALYTICS_DB_NAME`|Mongo DB Connection database name|Used on installation to create the database. Choose your own|`analytics`
 `FORMSFLOW_API_ANALYTICS_DB_URL`|Mongo DB Connection URL of formio for sentiment analysis|Used on installation to create the database. Choose your own|`mongodb://mongo:changeme@forms-flow-webapi-analytics-db:27019/analytics?authSource=admin&authMechanism=SCRAM-SHA-256`
+`USER_ACCESS_PERMISSIONS`| JSON formatted permissions to enable / disable few access on user login.|| `{"accessAllowApplications":false,"accessAllowSubmissions":false}`
+
+* NOTE - While configuring USER_ACCESS_PERMISSIONS the accessAllowApplications will hide / show application tab, the same way accessAllowSubmissions does for viewSubmission button. To enable this feature you need to add access-allow-applications, access-allow-submissions with the respective user group in keycloak.
 
 ##### CAMUNDA_JDBC : Dedicated camunda database.
 --------------------------------------
@@ -236,13 +239,12 @@ Modify the file **mail-config.properties** (under `forms-flow-bpm/src/main/resou
   * Run `docker-compose -f docker-compose-windows.yml stop` to stop.
 
 ### Health Check
-  * Analytics should be up and available for use at port defaulted to 7000 i.e. http://localhost:7000/
-  * Business Process Engine should be up and available for use at port defaulted to 8000 i.e. http://localhost:8000/camunda/
-  * FormIO should be up and available for use at port defaulted to 3001 i.e. http://localhost:3001/
-  * formsflow.ai Rest API should be up and available for use at port defaulted to 5000 i.e. http://localhost:5000/checkpoint
-  * formsflow.ai web application should be up and available for use at port defaulted to 3000 i.e. http://localhost:3000/
-
- * Access credentials are mentioned [here](../README.md#verifying-the-installation-status).
+* Analytics should be up and available for use at port defaulted to 7000 i.e. http://localhost:7000/
+* Business Process Engine should be up and available for use at port defaulted to 8000 i.e. http://localhost:8000/camunda/
+* FormIO should be up and available for use at port defaulted to 3001 i.e. http://localhost:3001/
+* formsflow.ai Rest API should be up and available for use at port defaulted to 5000 i.e. http://localhost:5000/checkpoint
+* formsflow.ai web application should be up and available for use at port defaulted to 3000 i.e. http://localhost:3000/
+* Access credentials are mentioned [here](../README.md#verifying-the-installation-status).
 
 ### Usage Instructions
 

diff --git a/deployment/docker/docker-compose-linux.yml b/deployment/docker/docker-compose-linux.yml
@@ -58,7 +58,7 @@ services:
       - FORMIO_ROOT_EMAIL=${FORMIO_ROOT_EMAIL:[email protected]}
       - FORMIO_ROOT_PASSWORD=${FORMIO_ROOT_PASSWORD:-changeme}
       - APP_SECURITY_ORIGIN=${APP_SECURITY_ORIGIN:-*}
-      - WEBSOCKET_SECURITY_ORIGIN=${WEBSOCKET_SECURITY_ORIGIN:-*}
+      - WEBSOCKET_SECURITY_ORIGIN=${WEBSOCKET_SECURITY_ORIGIN}
       - WEBSOCKET_MESSAGE_TYPE=${WEBSOCKET_MESSAGE_TYPE:-TASK_EVENT}
       - WEBSOCKET_ENCRYPT_KEY=${WEBSOCKET_ENCRYPT_KEY:-giert989jkwrgb@DR55}
     networks:
@@ -135,6 +135,7 @@ services:
         - REACT_APP_KEYCLOAK_URL_REALM=${KEYCLOAK_URL_REALM:-forms-flow-ai}
         - REACT_APP_KEYCLOAK_URL=${KEYCLOAK_URL}
         - REACT_APP_APPLICATION_NAME=${APPLICATION_NAME:-formsflow.ai}
+        - REACT_APP_USER_ACCESS_PERMISSIONS=${USER_ACCESS_PERMISSIONS}
     volumes:
       - '.:/app'
       - '/app/node_modules'

diff --git a/deployment/docker/docker-compose-windows.yml b/deployment/docker/docker-compose-windows.yml
@@ -58,7 +58,7 @@ services:
       - FORMIO_ROOT_EMAIL=${FORMIO_ROOT_EMAIL:[email protected]}
       - FORMIO_ROOT_PASSWORD=${FORMIO_ROOT_PASSWORD:-changeme}
       - APP_SECURITY_ORIGIN=${APP_SECURITY_ORIGIN:-*}
-      - WEBSOCKET_SECURITY_ORIGIN=${WEBSOCKET_SECURITY_ORIGIN:-*}
+      - WEBSOCKET_SECURITY_ORIGIN=${WEBSOCKET_SECURITY_ORIGIN}
       - WEBSOCKET_MESSAGE_TYPE=${WEBSOCKET_MESSAGE_TYPE:-TASK_EVENT}
       - WEBSOCKET_ENCRYPT_KEY=${WEBSOCKET_ENCRYPT_KEY:-giert989jkwrgb@DR55}
     networks:
@@ -136,6 +136,7 @@ services:
         - REACT_APP_KEYCLOAK_URL_REALM=${KEYCLOAK_URL_REALM:-forms-flow-ai}
         - REACT_APP_KEYCLOAK_URL=${KEYCLOAK_URL}
         - REACT_APP_APPLICATION_NAME=${APPLICATION_NAME:-formsflow.ai}
+        - REACT_APP_USER_ACCESS_PERMISSIONS=${USER_ACCESS_PERMISSIONS}
     volumes:
       - '.:/app'
       - '/app/node_modules'

diff --git a/deployment/docker/sample.env b/deployment/docker/sample.env
@@ -106,6 +106,8 @@ USER_RESOURCE_ID={User forms form-Id}
 #NODE_ENV=development
 #Application_Name
 APPLICATION_NAME=formsflow.ai
+#Role level permission defining
+USER_ACCESS_PERMISSIONS={"accessAllowApplications":false,"accessAllowSubmissions":false}
 ##Camunda Rest API URI
 CAMUNDA_API_URL=http://{your-ip-address}:8000/camunda
 ##web Api End point

diff --git a/forms-flow-analytics/README.md b/forms-flow-analytics/README.md
@@ -34,7 +34,8 @@ your use case with formsflow.ai checkout [Redash Knowledge base](https://redash.
 
    * Make sure you have a Docker machine up and running.
    * Make sure your current working directory is "forms-flow-ai/forms-flow-analytics".
-   * Modify the environment variables inside [redash.env](./redash.env) file if needed. Environment variables are given in the table below
+   * Rename the file [sample.env](./sample.env) to **.env**.
+   * Modify the environment variables inside [.env](./sample.env) file if needed. Environment variables are given in the table below
    * **NOTE : `{your-ip-address}` given inside the [redash.env](./redash.env) file should be changed to your host system IP address. Please take special care to identify the correct IP address if your system has multiple network cards**
 
 > :information_source: Variables with trailing :triangular_flag_on_post: in below table should be updated in the `redash.env` file
@@ -82,6 +83,7 @@ Variable name | Meaning | Possible values | Default value |
    The application should be up and available for use at port defaulted to 7000 in  http://localhost:7000/
     and register with any valid credentials.
 
+
 ### Configuration of Keycloak SAML Setup
 
    * Post registration, login to the application with admin credentials.
@@ -102,3 +104,6 @@ Variable name | Meaning | Possible values | Default value |
       * Go to Account Section
       * Copy API Key to Clipboard
 
+### Redash how to use guide 
+
+Check our guide on [how to configure Redash and come up with awesome visualization using redash](./docs/README.md). Also [sample queries for default forms](./docs/sample_queries.md).
diff --git a/forms-flow-analytics/docker-compose-linux.yml b/forms-flow-analytics/docker-compose-linux.yml
@@ -6,35 +6,28 @@ x-redash-service: &redash-service
   depends_on:
       - postgres
       - redis
-  env_file: redash.env
+  env_file: .env
   restart: always
 
 services:
   server:
     <<: *redash-service
-    command: server
+    command: dev_server
     ports:
       - '7000:5000'
     environment:
       REDASH_WEB_WORKERS: 4
   scheduler:
     <<: *redash-service
-    command: scheduler
-    environment:
-      QUEUES: "celery"
-      WORKERS_COUNT: 1
-  scheduled_worker:
+    command: dev_server
+    depends_on:
+      - server
+  worker:
     <<: *redash-service
     command: worker
     environment:
-      QUEUES: "scheduled_queries,schemas"
+      QUEUES: "periodic emails default"
       WORKERS_COUNT: 1
-  adhoc_worker:
-    <<: *redash-service
-    command: worker
-    environment:
-      QUEUES: "queries"
-      WORKERS_COUNT: 2
   redis:
     image: redis:latest
     restart: always
@@ -43,6 +36,6 @@ services:
     ports:
       - '7432:5432'
     restart: always
-    env_file: redash.env
+    env_file: .env
     volumes:
       - ./postgres/analytics:/var/lib/postgresql/data
diff --git a/forms-flow-analytics/docker-compose-windows.yml b/forms-flow-analytics/docker-compose-windows.yml
@@ -2,39 +2,32 @@
 version: "3.7"
 
 x-redash-service: &redash-service
-  build: https://github.com/AOT-Technologies/redash.git 
+  build: https://github.com/AOT-Technologies/redash.git
   depends_on:
       - postgres
       - redis
-  env_file: redash.env
+  env_file: .env
   restart: always
 
 services:
   server:
     <<: *redash-service
-    command: server
+    command: dev_server
     ports:
       - '7000:5000'
     environment:
       REDASH_WEB_WORKERS: 4
   scheduler:
     <<: *redash-service
-    command: scheduler
-    environment:
-      QUEUES: "celery"
-      WORKERS_COUNT: 1
-  scheduled_worker:
+    command: dev_server
+    depends_on:
+      - server
+  worker:
     <<: *redash-service
     command: worker
     environment:
-      QUEUES: "scheduled_queries,schemas"
+      QUEUES: "periodic emails default"
       WORKERS_COUNT: 1
-  adhoc_worker:
-    <<: *redash-service
-    command: worker
-    environment:
-      QUEUES: "queries"
-      WORKERS_COUNT: 2
   redis:
     image: redis:latest
     restart: always
@@ -43,6 +36,6 @@ services:
     ports:
       - '7432:5432'
     restart: always
-    env_file: redash.env
+    env_file: .env
     volumes:
       - ./postgres/analytics:/data/postgres
diff --git a/forms-flow-analytics/docs/README.md b/forms-flow-analytics/docs/README.md
@@ -0,0 +1,41 @@
+# forms-flow-analytics Usage Documentation
+
+1. [How to use forms-flow-analytics](#how-to-use-forms-flow-analytics)
+2. [Sample Queries](#sample-queries)
+
+## How to use forms-flow-analytics?
+
+
+The process of how to use Redash is [well documented in official docs](https://redash.io/help/). Some of the basic steps for working with Redash are:
+
+1. *Add Data sources*
+
+You can connect with about 30+ supported data sources mentioned in docs from the browser itself.
+![image](https://user-images.githubusercontent.com/70306694/125465830-2b6d3985-4dc8-423c-9947-5ae3d689cab0.png)
+
+2. *Write Queries*
+ Once data is connected we can write queries. It’s always ideal to create individual queries for the necessary visualizations. Writing queries is a data preparation step to process data for visualization.
+
+ ![image](https://user-images.githubusercontent.com/70306694/125465939-cf68ce67-c589-49d1-9110-067d0e896054.png)
+
+
+3. *Create Visualizations*
+
+There are a variety of visualizations supported in Redash. Ten different categories of visualization can be created with just drag and select features to visualize from the queried data. Redash supports visualization types like BoxPlot, Counter, BarCharts, Sunburst, Sankey, Word Cloud, line chart, Area charts, etc. To learn how to create visualizations checkout Redash visualization docs.
+
+![image](https://user-images.githubusercontent.com/70306694/125466037-7b66530f-235b-4198-8c6f-46d556726963.png)
+
+
+4. *Create Dashboards*
+
+We can create interactive dashboards that can be embedded anywhere and shared with colleagues easily. The queries can be refreshed periodically as more data comes in.
+
+![image](https://user-images.githubusercontent.com/70306694/125466079-02a24f12-58ed-40e4-a669-b88dbb456645.png)
+
+
+## Sample Queries
+
+To check the sample queries provided with our default forms [check our documentation](./sample_queries.md)
+
+
+To learn more about Redash check the [Tools we love article about Redash](https://www.aot-technologies.com/tools-we-love-redash/).