Mark items as Added, Changed, Fixed, Modified, Removed, Untested Features, Upcoming Features, Known Issues
Added
forms-flow-api
- Added new endpoints to manage form flow creation and updates:
/form-flow-builder- Create form design, workflow, authorizations, and mapper details./form-flow-builder/<mapper-id>- Update existing configurations.
Modified
forms-flow-web
- Form.io token fetching logic has been moved to the service micro-frontend.
Fixed
- Sorting is now available for all columns on the review task listing page.
- Fixed minor issues in Reviewer & Analyze Submissions page.
- Fixed PDF generation issue with a generic custom theme.
Modified
forms-flow-web
- Form.io token fetching logic has been moved to the service micro-frontend.
Fixed
- Sorting is now available for all columns on the review task listing page.
- Fixed minor issues in Reviewer & Analyze Submissions page.
- Fixed PDF generation issue with a generic custom theme.
Upgrade notes:
forms-flow-bpm
- SpringBoot version upgraded to 3.3.11
Generic Changes
- Fixed security vulnerabilities
Known Issues
- Select boxes are not displayed in the review filter search and analyze-submission side filter due to existing limitations.
- If a new major version of a form is created after the Task filter is configured on the reviewer page, the filter will continue retrieving submissions from the previous form version. The new version will only be reflected once the form is reselected in the filter.
- In single domain instances, Reviewer action may fail. As a quick fix refer here.
- A fix has been implemented allowing users with only the “Manage Advanced Flows” permission to publish subflows and DMNs. In a multitenant environment, this change may apply to existing tenants only after creating a new tenant or adding authorizations in the Camunda deployment. Refer here
- When editing filters in the reviewer page, unchecking or checking one variable (e.g., name) causes another variable (task) to be unintentionally affected.
- Deploying workflows(subflows) with a Message Start Event fails if another deployed workflow already uses the same message name. This results in a Camunda deployment error indicating a duplicate message event subscription.
Added
forms-flow-tools
- Added Git management tools
- Added pre-push check for testing changes
forms-flow-web
- Added collapsible search UI to support data-layer in analyze submissions.
forms-flow-documents
- Added new environment variable:
- CHROME_DRIVER_TIMEOUT to specify timeout for the chrome driver to wait for the page to load
forms-flow-api
- Added the
submissions_filtertable to store user-specific filter preferences for analyzing submissions. - Added the
default_submissions_filtercolumn to the user table to record each user's default filter for submission analysis. - Implemented new endpoints for managing analyze submissions filters:
/submissions-filterfor creating, updating, and listing filters./submissions-filter/<id>for retrieving or deleting a filter by its ID.
- Added alembic migration script to set roles to empty for attribute filters with no users. This prevents the need to update attribute filters every time a task filter is modified, except in the case of private attribute filters.
forms-flow-idm
- To migrate the new roles(permissions) to the exsiting groups Refer here
Modified
forms-flow-api
- Updated create_filters description from "Manage filters you create" to “Manage personal filters”
- Introduced the allForms parameter in the form list endpoint to retrieve both active and inactive forms.
forms-flow-data-layer
- Updated data layer to support field-level searches within individual forms or across all submissions in analyze-submissions.
Fixed
- Task filters no longer require manual selection for 'tasks accessible to'; the current user is automatically selected when not explicitly chosen.
- Fixed the issue where the SUBMIT tab was incorrectly highlighted instead of the ANALYZE > SUBMISSIONS tab when viewing submission details from ANALYZE.
Upgrade notes:
forms-flow-api
- Flask version upgraded from 3.1.0 to 3.1.1
forms-flow-data-analysis-api
- Flask version upgraded from 3.1.0 to 3.1.1
Generic Changes
- Added UI changes to support data-layer implementation for Analyze submissions in micro-frontend.
Known Issues
- Selectboxes, textAreaWithAnalysis and survey form components cannot be selected in the variable selection modal.
- Some advanced components (with data types other than text or number) may not function correctly when used in field filters on the reviewer listing page.
- Certain advanced components may not display their values in the reviewer listing page.
- Sorting is not available for all columns on the review task listing page.
- The date field filter in Analyze Submissions currently supports only the DD-MM-YYYY date format.
Added
forms-flow-web
- Added new User Interfaces: for task page, submissions
- Added environment variables:
ENABLE_COMPACT_FORM_VIEWSet to true to reduce extra space between form components and display more components in the viewport.USER_NAME_DISPLAY_CLAIMto specify if the app should use a different attribute than the default 'username' claim from KeycloakGRAPHQL_API_URLto connect to the datalayerMF_FORMSFLOW_REVIEW_URLfor reviewer micro-frontendMF_FORMSFLOW_SUBMISSIONS_URLfor submissions micro-frontend
formsflow-api
- Below fields added to application list endpoint
- Added parentFormId filter parameter to filter the submissions for a specific form
- Added the includeDrafts parameter to include drafts along with submissions.
- Added the onlyDrafts parameter to retrieve only drafts.
- Added the createdUserSubmissions parameter to filter submissions created by a specific user.
- Added a new column, is_draft, to the application table to identify draft entries.
- Added Alembic script to update existing active drafts by setting is_draft to true in the application table.
- Added the includeSubmissionsCount=true parameter to the form list endpoint to include the submissions count.
- Added below endpoints
- Public draft update:
/public/application/<id> - Draft submit by id:
/application/<id>/submit - Public draft submit by id:
/public/application/<id>/submit - Delete draft by id:
/application/<id>
- Public draft update:
- Added columns filter_type, parent_filter_id to the filter table.
- Added script to migrate existing filters to TASK filter type.
- Added variables(task_variables) as part of import and export.
- Added Endpoint
/filter/filter-preferencefor saving user's filter preference data - Added new table called filter_preferences to handle filter preference of a user
- Added new table task_outcome_configuration to store workflow transition rules
- Added
/tasks/task-outcome-configurationendpoint for task configuration storage - Added
/tasks/task-outcome-configuration/<task_id>endpoint for task configuration lookup - Added new permissions and enhanced permission definitions with categories to
/permissionsendpoint - Added new environment variables:
USER_NAME_DISPLAY_CLAIMto specify if the app should use a different attribute than the default 'username' claim from KeycloakFORMIO_JWT_EXPIREto handle formio jwt token expire time
formsflow-bpm
- Added new environment variables:
USER_NAME_DISPLAY_CLAIMto specify if the app should use a different attribute than the default 'username' claim from KeycloakSERVER_MAX_HTTP_REQUEST_HEADER_SIZEto configure the maximum size of the HTTP request header
formsflow-documents
- Added new environment variable:
ENABLE_COMPACT_FORM_VIEWSet to true to reduce extra space between form components and display more components in the viewport.FORMIO_JWT_EXPIREto handle formio jwt token expire time
forms-flow-idm
- Added view_submissions permission to the service account roles to support export PDF with service account token
- Added new permissions to the forms-flow-ai realm
- To migrate the new roles(permissions) to the realm Refer here
Modified
forms-flow-web
- Modified User Interfaces of:
- Client Table
- Draft and Submission list table
- Form submission view
- Permission selection modal
formsflow-api
- Modified the
/application/<id>GET and UPDATE endpoints to support draft get and update. - Updated the anonymous draft POST API URL from
/draft/public/createto/public/draft. - Updated the theme GET API URL from
/themesto/public/themes. - Updated API authorization with new permissions
Removed
formsflow-api
- Removed below endpoints
- Get/Update/Delete draft by id:
/draft/<id> - Draft list:
/draft - Public draft update:
/draft/public/<id> - Draft submit by id:
/draft/<id>/submit - Public draft submit by id:
/draft/public/<id>/submit
- Get/Update/Delete draft by id:
- Removed fields: order, resourceId, description, and taskVisibleAttributes from filter table
formsflow-bpm
- FormAccessTokenCacheListener is removed from the codebase (As outlined in the Removed section of the forms-flow-bpm v4.0.5)
- Exposed Camunda delete API for process-instance, process-definition, task, deployment.
Upgrade notes:
forms-flow-web
- webpack version upgraded to 5.94.0
forms-flow-api
- Python version upgraded to 3.13.2
forms-flow-idm
- Keycloak Version upgraded to 26.1.2
forms-flow-documents
- Python version upgraded to 3.13.2
Generic Changes
- Added new micro-frontends: forms-flow-review, forms-flow-submissions
Known Issues
- If a form's version changes and it is already selected in an existing task filter, the user must reselect the form in the filter edit to ensure proper form name in UI.
- In Task Filters, specifying "Tasks Accessible To" either a role or an assignee is mandatory starting from version v7.1.0 when saving a filter. As a result, after upgrading from v7.0.0 to v7.1.0, any existing filters created in v7.0.0 or earlier that do not have a role or assignee selected will still function as expected, but cannot be updated unless one of these fields is provided.
- When a user views the details of a submission from the ANALYZE tab in the sidebar, the active tab is incorrectly highlighted as SUBMIT instead of ANALYZE.
Modified
forms-flow-documents
- Migrated CSS and JS dependencies from CDN links to local static files
- Refactored
index.htmlto reference local static assets for CSS and JS - Increased PDF generation wait time to 60 seconds
Added
forms-flow-bpm
- Addition of security level config to bpmn docker compose to resolve Inconsistent CSRF token behavior
Added
forms-flow-bpm
- Addition of ssl certificate in bpm layer to work on secured environments and updated the docker file
Added
- Additional Custom theme variables added for extensive customizations
- Added shared realm support for application
Modified
- Issue with Simple conditional logic option of formio components not returning component names fixed
Added
forms-flow-web
- Added redesigned form and workflow UI for designer
- Layout and Flow listing
- Layout and Flow Create/ Edit page:
- Import, export, duplicate, delete, history, preview, authorization settings
- Added flow builder to design page
- Added new user settings option in sidebar
- Added new css variables to support dynamic theming of application using customTheme file
- Added advanced logic conditioning in formio component settings to allow chaining of conditions for forms
- Added the displayForRole custom property to the form component to display data for a specific role
- Added certain user data as hidden variables in the form design by default:
- Current User
- Submitter Email
- Submitter First Name
- Submitter Last Name
- Current User Roles
forms-flow-api
-
Added new endpoints for:
- Form validation:
/form/validate - Layout + Flow import:
/import - Layout + Flow export:
/form/<mapper_id>/export - Flow migration -
/process/migrate - Layout + Flow publish:
/form/<mapper_id>/publish - Layout + Flow unpublish:
/form/<mapper_id>/unpublish - List permissions:
/roles/permissions - Theme customization:
- Create, Get, Update theme:
/themes
- Create, Get, Update theme:
- Subflow and decision table redesign
- Create/List:
/process - Get/Update/Delete by id:
/process/<id> - Get by key:
/process/<key> - Get history:
/process/<key>/versions - Validate:
/process/validate - Publish:
/process/<id>/publish - Unpublish:
/process/<id>/unpublish
- Create/List:
- Form validation:
-
Added Alembic scripts to implement the following changes:
- Created tables for theme customization(Themes), Process, and User
- Updated the filter table to include filter_order, the form history table to add major_version and minor_version, and the form_process_mapper table to include prompt_new_version & is_migrated
- Populated major_version and minor_version columns in existing form history records
- Altered audit datetime fields to be timezone-aware
- Updated the process_name format from process_name(process_key) to process_name
- Increased the length of form_name, process_key, and process_name fields in the form_process_mapper table to 200
forms-flow-bpm
- Added support to fetch secrets from Vault
- Added BPM authorizations dynamically upon startup
Modified
formsflow-web
-
Modified Flow and Layout to a one-to-one association, with the combination now referred to as a Form
-
Modified Navbar and converted to Sidebar:
- Categorized UI to menus and sub-menus based on functionality
- Menus visibility is controlled based on user permissions
- Moved language selection to the user settings modal, accessible by clicking the username in the bottom-left corner of the sidebar
- Moved client submission from the Forms menu to the Submit menu (Submit → Forms → All Forms)
- Moved form design to Design menu
- Moved Subflows (BPMN) and Decision Tables (DMN) to individual submenus under the Design
- Moved Manage roles, users and dashboards under Manage menu
- Moved Insights and Metrics under Analyze menu
- Moved Tasks under Review menu
-
Modified form history management to include major and minor versions
-
Modified RBAC mechanism:
- Users can create new roles with specific permissions for more granular application access control. Refer here for more
-
Authorization updates:
- Permissions options in settings for Designers are changed :
- 'All Designers' option is removed
- Permissions options in settings for reviewer to view submission are changed to generic view Submission permissions:
- 'All Reviewers' changed to 'Submitter',
- 'Specific Reviewers' changed to 'Submitter and specified roles'
- Permissions options in settings for Designers are changed :
forms-flow-api
- Modified authorization endpoints for:
- updated permissions
- sub flow and decision table redesign
- Form create, mapper create and authorization create apis combined into form-design
forms-flow-bpm
- Existing users, refer here for forms-flow-bpm migration changes
forms-flow-documents
- Modified endpoint authorizations based on updated permission mechanism
forms-flow-idm
- Refer here for Permission matrix migration changes in IDM
Removed
formsflow-web
- Removed workflow selection from form edit page
forms-flow-api
- Removed form_mapper create API
Upgrade notes:
forms-flow-web
- Npm package version upgraded to 16.20.0
forms-flow-api
- Python version upgraded to 3.12.6
forms-flow-bpm
- SpringBoot version upgraded to 3.3.5
- Camunda version upgarded to 7.21
- spring-websocket version upgarded to 6.1
forms-flow-idm
- Keycloak Version upgraded to 25.0.0
forms-flow-documents
- Python version upgraded to 3.12.6
forms-flow-data-analysis-api
- Python version upgraded to 3.12.6
forms-flow-analytics
- Redash version upgraded to 24.04.0
Generic Changes
- Designer page redesign
- Workflow selection from edit page is not available now, instead users have to create workflow while form creation itself
- Added new micro-frontend : forms-flow-components
- Fixed security vulnerabilities
- Refer version documentation for environment variable changes
Known Issues
- The language translation of the entire UI is not perfect at the moment, so some glitches may be expected.
- forms-flow-web test cases are not fully covered
Added
forms-flow-web
- Added no-code creation
- Added regenerate option for form creation with Flow-E
forms-flow-api
- Added process_type column to templates
forms-flow-documents
- Added export pdf for bundle
forms-flow-data-analysis-api
- Added regenerate support in chat bot form creation
Modified
forms-flow-web
- Modified premium icons
- Moved Bundle as separate sub-menu under Design menu in sidebar
- Moved Build using AI feature (Flow-E) to form creation page from edit page.
- Moved select from template feature to form listing page from edit page.
- Modified design for save as template
- Modified the bundle submission logic to retrieve submission data for the currently viewed form instead of fetching all submission data.
forms-flow-api
- Updated the
bundles/execute-rulesAPI to expect only the currently edited data instead of the entire data. The API fetch the necessary data from Form.io to execute rule.
Removed
forms-flow-web
- Forms that should be included in the bundle no longer require selecting 'enable bundling' from the edit page.
- Removed short intro from template creation modal
Added
forms-flow-web-root-config
- Added env variable
LANGUAGEfor default language setting
Fixed
forms-flow-web-root-config
- Fixed service worker cache issue
forms-flow-bpm
- Fixed white label error on login to bpm
Modified
forms-flow-web
- The tenant user's default language is set from their data, tenant data, or the default application language.
Added
forms-flow-web-root-config
- Added resouce bundle for Spanish
Fixed
forms-flow-web-root-config
- Fixed service worker cache issue
Added
forms-flow-web
- Added user search by role for Admin
- Added option to add registered user to the tenant
- Implemented functionality to generate filters based on form
forms-flow-bpm
- Added new field to notify listener to support email address injection
forms-flow-api
- Added the feature to capture task variables on application creation without
FormBPMFilteredDataPipelineListenerduring initial submission - Added user search by role for Admin
- Added option to add registered user to the tenant
forms-flow-data-analysis-api
- Added environment variable API_LOG_ROTATION_WHEN for specifying the frequency of log file rotation
- Added environment variable API_LOG_ROTATION_INTERVAL for setting the time interval for log file rotation
- Added environment variable API_LOG_BACKUP_COUNT for determining the number of backup log files to keep
Modified
forms-flow-web
- Task filter enhancements:
- Updated default Tasks Filter to display tasks authorized for current logged-in user
- Modified candidate group listing based on logged user access in filter create
- Modified Assignee in create filter from manual input to select from list
- Modified Candidate group label to User group/ User role
- Modified definition key to workflow name select for workflow selection
- Modified "Show task based on logged user roles" to "Display authorized tasks based on user roles" which is visible to admin users only, will be true by default
- Task variable create UI and UX change
- Adjusted task variables according to task attributes in card view
- Updated default All Tasks Filter to display tasks authorized for current logged-in user
- Modified user listings to exclusively display users associated with the respective tenant for multi-tenant admin
forms-flow-api
- Changes have been made to the Roles and Groups endpoint to accommodate modifications related to subgroups in Keycloak 23.
Upgrade notes:
forms-flow-bpm
- SpringBoot version upgraded to 3.1.10
- groovy version upgraded to 3.0.21
- postgresql version upgraded to 42.7.2
- graalvm version upgraded to 23.0.0
- snakeyaml version upgraded to 2.2
forms-flow-api
- Python version upgraded to 3.12.1
forms-flow-documents
- Python version upgraded to 3.12.1
forms-flow-data-analysis-api
- Python version upgraded to 3.11.7
Generic Changes
- Fixed security vulnerabilities
Added
froms-flow-web
- Added IPASS integration
- Added task variables from forms of a bundle to filter creation
forms-flow-data-analysis-api
- Added new env variable
CHAT_BOT_CONTEXT_KEYto define the context for chat bot
forms-flow-bpm
- Added
iPaasListenerto support IPASS integration
forms-flow-api
- Added new endpoints to support IPASS
Modified
forms-flow-data-analysis-api
- CHAT_URL port number updated
Fixed
froms-flow-web
- Fixed task details view of bundle in list view
Fixed
forms-flow-web
- Fixed task page infinity loading issue
- Fixed task list filter API breaking on initial time
- Fixed tenant based all tasks not showing issue
forms-flow-documents
- Fixed security vulnerabilities
forms-flow-data-analysis-api
- Fixed security vulnerabilities
Modified
forms-flow-api
- Changes have been made to the Roles and Groups endpoint to accommodate modifications related to subgroups in Keycloak 23.
Fixed
- Fixed category listing for pre-built templates for multi-tenant environment.
Added
forms-flow-bpm
- Added new field injection
emailAddressin Notify Listener to allow email addresses in addition to group names.
Added
forms-flow-web
- Added new UI for forms, submissions, tasks, processes, dashboards, navbar
- Added RBAC support in form listing for reviewer
- Added RBAC support in submission(application) listing for client and reviewer
- Added form description to form
- Added a description input field for the form.
- Added create custom filter for task in task page
- Added environment variable
DATE_FORMATto change the date format - Added environment variable
TIME_FORMATto change the time format - Added environment variable
CUSTOM_THEME_URLto override the theme - Added environment variable
CUSTOM_RESOURCE_BUNDLE_URLto customize resource bundle for internationalization
forms-flow-api
- Added RBAC support in form listing for reviewer
- Added RBAC support in submission(application) listing for client and reviewer
- Added migration script to move existing task filters from forms-flow-bpm to forms-flow-api, checkout here
- Added environment variable
API_LOG_ROTATION_WHENfor specifying the frequency of log file rotation - Added environment variable
API_LOG_ROTATION_INTERVALfor setting the time interval for log file rotation - Added environment variable
API_LOG_BACKUP_COUNTfor determining the number of backup log files to keep
forms-flow-bpm
- Added task filter custom implementation
- Added multi-modules
forms-flow-documents
- Added environment variable
API_LOG_ROTATION_WHENfor specifying the frequency of log file rotation - Added environment variable
API_LOG_ROTATION_INTERVALfor setting the time interval for log file rotation - Added environment variable
API_LOG_BACKUP_COUNTfor determining the number of backup log files to keep
Modified
forms-flow-web
- Modified Tasks page with List view and Card view of tasklist
- Modified Applications to Submissions in UI
- Modified accessibility enhancement
- Modified Name, Type, Path as advanced options while form create
Removed
forms-flow-web
- Removed filter by form type from form listing table
Generic Changes
- Move task filters from forms-flow-bpm to forms-flow-web
- Support Resubmit/ Edit Submission dynamically in the application flow with respect to isResubmit Key
Solution Component Upgrades
forms-flow-api
- Flask upgraded to 2.3.3 and fixed security vulnerabilities
forms-flow-web
- Fixed security vulnerabilities
forms-flow-bpm
- Camunda upgraded to 7.20.0, SpringBoot upgraded to 3.1.5 and fixed security vulnerabilities
forms-flow-documents
- Flask upgraded to 2.3.3 and fixed security vulnerabilities
Added
forms-flow-web
- Added RBAC(Role Based Access Control) support in form bundling, refer here.
- Added Templates feature, refer here for more.
- Added AI chat assist support in form creation, refer here for more.
- Added environment variables
ENABLE_CHATBOT,CHATBOT_URLfor AI chat assist support.
forms-flow-data-analysis-api
- Added environment variables
OPENAI_API_KEY,CHAT_BOT_MODEL_IDfor AI chat assist support.
forms-flow-api
- Added RBAC(Role Based Access Control) support in form bundling.
Fixed
forms-flow-api
- Fixed task variable updation issue on resubmit in form bundling.
Fixed
forms-flow-web
- Fixed bpmn property panel css issue.
forms-flow-documents
- Fixed the problem of conflicting versions between Chrome and Chrome Driver when downloading forms.
Added
forms-flow-web
- Added
Form bundlingpremium feature, refer here for more details. - Added RBAC(Role Based Access Control) support in form listing for designer and client, for more details checkout here.
- 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.
- Added environment variables
MF_FORMSFLOW_WEB_URL,MF_FORMSFLOW_NAV_URL,MF_FORMSFLOW_SERVICE_URL,MF_FORMSFLOW_ADMIN_URL,MF_FORMSFLOW_THEME_URLto get MicroFrontend Components Created. - Added environment variables
ENABLE_FORMS_MODULE,ENABLE_TASKS_MODULE,ENABLE_DASHBOARDS_MODULE,ENABLE_PROCESSES_MODULE,ENABLE_APPLICATIONS_MODULEto disable a particular module in forms-flow-web. - Added environment variable
CUSTOM_THEME_URLfor 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, click here for more details.
- Added migration script for existing users to get all forms listed, checkout here.
- 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_PERMISSIONSis replaced withENABLE_APPLICATION_ACCESS_PERMISSION_CHECKto 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
- 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)
Refer the forms-flow-ai-micro-front-ends repository for further details.
- Dashboard authorization is moved from designer role to admin user.
Added
forms-flow-web
- Added
form bundlingfeature as a premium feature, refer here for more details.
forms-flow-bpm
- Added CombineSubmissionBundleListener to support form bundling feature.
- Added RequestStateListener to support Request status.
- Added skip-sanitize flag to request header for calls from BPM to Form.io.
Modified
forms-flow-web
- To enable tracking of individual requests within the bundle, the application history has been updated to Application status and Request status.
Generic changes
- During the process of form bundling, it is necessary to configure task variables while designing each individual form.
Added
forms-flow-bpm
External TaskAPIs are exposed in bpm abstraction layer.
Modified
forms-flow-bpm
Upgrade notes:
- camunda upgraded from version 7.17.0 to 7.18.0.
- camunda-keycloak upgraded from version 2.2.3 to 7.18.0.
- camundaConnect upgraded from 1.5.0 to 1.5.4.
- camundaMail upgraded from 1.3.0 to 1.5.0.
- camunda-template-engines upgraded from 1.0.0 to 2.1.0
- spring boot upgraded from version 2.6.6 to 2.7.11.
- spring security Oauth2 upgraded from version 2.6.6 to 2.6.7.
- camunda-bpm-assert upgraded from 12.0 to 13.0.
- groovy upgraded from 3.0.13 to 3.0.17.
- graalVm upgraded from 22.1.0.1 to 22.3.2.
- jackson upgraded from version 2.14.0 to 2.15.0.
Added
forms-flow-web
- Added form versoning.
- Added discard option for draft feature.
- Added form embedding.
- Added support for resources
forms-flow-forms
- Added environment variable
FORMIO_CLIENT_UI. - Added health check API-end point
/checkpoint
forms-flow-api
- Added DB changes to accomodate form type, parent form id.
- Added migration scripts in the alembic file to resolve schema conflicts while db upgrade and downgrade, check out here.
- Added new table for form history
- Added new api to get form history by form id.
- Added new api to delete draft.
- Added new api to get the list of users for a role/group from keycloak.
forms-flow-bpm
- Added environment variables
REDIS_ENABLED,REDIS_HOST,REDIS_PORT,REDIS_PASSCODEandSESSION_COOKIE_SECURE.
forms-flow-documents
- Added support for PDF templating.
Modified
forms-flow-api
- Updated certifi to 2022.12.7, protobuf to 3.20.2 and joblib to 1.2.0.
- Modified swagger documentation.
forms-flow-bpm
Upgrade notes:
- spring boot upgraded from version 2.6.4. to 2.6.6.
- spring websocket upgraded from version 5.3.4 to 5.3.20.
- spring messaging upgraded from version 5.3.4 to 5.3.20.
- spring security Oauth2 upgraded from version 2.6.4. to 2.6.6.
- postgresql upgraded from version 42.4.1 to 42.4.3.
- jackson upgraded from version 2.13.3 to 2.14.0.
Fixed
forms-flow-api
- Fixed Python security vulnerabilities.
Generic Changes
-
In Quick Installation:
Fixed versions for databases.
Reduced script size.
Added IP confirmation to avoid IP issues. -
Moved form list of designer to forms-flow-api.
Known Issues
forms-flow-bpm
- Camunda Integration shows Invalid Credentials with formsflow.ai docker deployment, for more details refer here.
Note: Temporary fix added. Setting the value of environment variable SESSION_COOKIE_SECURE to false makes the camunda login works with ip.
For a production setup value should be true, which will work with Kubernetes and docker deployments with nginx.
forms-flow-web
Fixed
- Frozen UI during form design.
forms-flow-web
Added
- Added websocket support for multitenancy.
Modified
- Modified task page UI.
- Modified alignment of wizard.
Removed
- Removed environment variable
REACT_APP_FORMIO_JWT_SECRETform config.sample.js.
forms-flow-api
Added
- Return the role name as path for authorization.
- Added formsflow API support to start application with data.
forms-flow-bpm
Added
- Added new endpoints for process instance variables.
- Added web socket support files to build.
Added
forms-flow-web
- Added pagination, search and sort for metrics page.
- Added default workflow for designer.
- Added Internationalization.
- Added multi-tenancy support.
- Added modal for submission details on metrics page.
- Added support for wizard forms.
- Added Export to PDF feature.
- Added application status
draftfor unfinished applications. - Added Processes page for camunda web modeller.
- Added Form Adapter to support form submission data to other data stores than Mongo with custom data URLs.
- Added environment variable
MULTI_TENANCY_ENABLED,MT_ADMIN_BASE_URL,MT_ADMIN_BASE_URL_VERSIONto support multitenancy. - Added environment variable
CUSTOM_SUBMISSION_URL,CUSTOM_SUBMISSION_ENABLEDfor support form adapter. - Added environment variables
DRAFT_ENABLED,DRAFT_POLLING_RATEto manage draft feature. - Added environment variable
EXPORT_PDF_ENABLEDfor pdf service. - Added environment variable
PUBLIC_WORKFLOW_ENABLEDfor enabling public workflow creation for multitenancy users. - Added environment variable
DOCUMENT_SERVICE_URLfor document service.
forms-flow-forms
- Added new Repository , for more details checkout here.
- Added environment variable
MULTI_TENANCY_ENABLEDto support mulitenancy.
forms-flow-api
- Added multi-tenancy support.
- Added support for default workflow with form.
- Added API support for
draftfeature. - Added API support for
Form Adapter. - Added environment variable
MULTI_TENANCY_ENABLED,KEYCLOAK_ENABLE_CLIENT_AUTHto support mulitenancy. - Added new environment variable
FORMIO_JWT_SECRET.
forms-flow-bpm
- Added default workflow.
- Added
Form Adapterto support form submission data to other data stores than Mongo with custom data URLs. - Added bpm gateway with jersey implementation.
- Added environment variable
MULTI_TENANCY_ENABLED,KEYCLOAK_ENABLE_CLIENT_AUTH,KEYCLOAK_WEB_CLIENTID,FORMSFLOW_ADMIN_URLfor multitenancy support. - Added environment variable
CUSTOM_SUBMISSION_URL,CUSTOM_SUBMISSION_ENABLEDfor support form adapter.
forms-flow-documents
- Added document API to provide generate pdf with form submission data.
- Added environment variable
MULTI_TENANCY_ENABLED,KEYCLOAK_ENABLE_CLIENT_AUTHto support mulitenancy .
forms-flow-analytics
- Added environment variable
REDASH_MULTI_ORGto support multitenancy.
Modified
forms-flow-web
- Metrics page UI modified.
- Form page UI modified.
- Accessibility enhancement.
- service-worker updated.
- React build size optimized.
Upgrade notes:
- Environment variables modified
CAMUNDA_API_URLtoBPM_API_URL. - Environment variables modified
REACT_APP_CAMUNDA_API_URItoREACT_APP_BPM_URLin config.sample.js
forms-flow-forms
- Modified Docker-compose to point to create image from the new Repository.
forms-flow-api
- Dependencies like utils, formio, JWT authentication moved to
forms-flow-api-utils.
Upgrade notes:
- Environment variables modified
BPM_API_BASEtoBPM_API_URL.
forms-flow-bpm
Upgrade notes:
- Camunda upgraded from 7.15 to 7.17.
- Java upgraded from 11 to 17.
- springboot upgraded from 2.4.8 to 2.6.4.
- camundaKeycloak upgraded from 2.2.1 to 2.2.3.
- camundaConnect upgraded from 7.15.0 to 1.5.0.
- camundaMail upgraded from 1.2.0 to 1.3.0.
- Environment variables modified
BPM_BASE_URLtoBPM_API_URL. - formUrl parameter is changed to webFormUrl in DMN template.
Removed
forms-flow-web
- Removed View submissions button from reviewer form list and view submissions route.
- Removed the environment variables
CLIENT_ROLE_ID,DESIGNER_ROLE_ID,REVIEWER_ROLE_ID,ANONYMOUS_ID,USER_RESOURCE_ID. - Removed the environment variable
FORMIO_JWT_SECRET.
Generic Changes
- Docker-compose files changed to single one.
- Added CI/CD pipeline.
- Environment variables updated with dynamic role-id fetching.
- Added new detailed documentation, checkout here.
Fixed
forms-flow-web
- Fixed public form authentication check.
Modified
forms-flow-data-analysis-api
- Modified DataAnalysis API and Sentiment-analysis Jobs.
Added
forms-flow-web
- Added
anonymous userfeature . - Added count for Filter Tasks .
- Added form list page search and sort.
- Added new UI for task variable.
- Added form name as part of filename when downloaded.
- Added the status of the earlier version as inactive when a new version of the form is created/deleted.
- Added submitter name in the application history table.
- Added Cancel button for form edit.
- Added task variable in tasklist page at LHS.
- Added CD pipeline.
forms-flow-api
- Added public application create api for anonymous forms.
- Added migration scripts in the alembic file to resolve schema conflicts while db upgrade and downgrade, check out here.
- Added new api for updating user locale attribute in Keycloak with the help of Keycloak admin API.
- Added form list page search and sort.
- Added CD pipeline.
- Added DB changes to accomodate task variable.
forms-flow-data-analysis-api
- Added DataAnalysis API and Sentiment-analysis Jobs.
forms-flow-idm
- Added
manage-usersgroup to assigned client roles in realm-management.Check out the details at Service Accounts Tab from here. - Added project specific custom login theme , check out the steps here.
forms-flow-bpm
- New (Task / Execution) Listener FormBpmFilteredDataPipelineListener Included for the effective form to bpm data copy.
- Added CD pipeline.
Fixed
forms-flow-web
- Uploaded forms cannot submit by client issue fixed .
- Application not getting in iOS issue fixed.
- Fixed process variable's data type in task filter.
forms-flow-api
- Postgres schema upgraded to enable updating the workflow after publising the form
- Disabled internal workflows for process API.
forms-flow-bpm
- Security context/authorization was not propogated to web-client while enabling asynchronous continutaion/intermediate timer events.
- Many minor performance optimizations and fixes are done.
Modified
forms-flow-web
- Modified application name search with lowercase and by intermediate search.
- Front-end support for the form process mapper versioning and database normalization.
- User is not be able to change the workflow of published form.
- Form Url support both pathname and formid to fetch the form.
forms-flow-api
- API support for application name search with lowercase and by intermediate search.
- Postgres database normalization and provided support for form process mapper versioning.
Upgrade notes:
KEYCLOAK_BPM_CLIENT_SECRET is not mandatory.
Due to the architectural changes to the Postgres database, it is recommended to back up the data before the upgrade.
forms-flow-bpm
Upgrade notes:
KEYCLOAK_BPM_CLIENT_SECRET is not mandatory.
Removed
forms-flow-web
- Removed 'PDF' from display as option while creating form as designer.
forms-flow-api
Upgrade notes:
Environment variables KEYCLOAK_ADMIN_USERNAME and KEYCLOAK_ADMIN_PASSWORD are removed since now the
admin APIs are accessed using the service account.
forms-flow-bpm
- FormAccessTokenCacheListener is deprecated ,will be removed from the codebase in the upcoming releases.
- formio-access-token.bpmn workflow is permanently removed from the codebase.
Upgrade notes:
- For the upgrading user's formio-access-token.bpmn workflow should be manually stopped and deleted using these instructions from here.
Generic Changes
- Added docker based automated installation. For installation guide, check out here.
- Existing users should build forms-flow-bpm,forms-flow-webapi and forms-flow-web together.
Added
forms-flow-bpm
- Added test cases and code coverage.
Upgrade notes:
New environment variables DATA_BUFFER_SIZE, IDENTITY_PROVIDER_MAX_RESULT_SIZE.
forms-flow-web
- Admin page to map insights dashboards to keycloak groups.
- Added test cases and code coverage, check out the details here.
Upgrade notes:
New environment variables FORMIO_JWT_SECRET. It's highly recommended to change this environment variable for existing installations.
forms-flow-api
- Added
pagination,sortingandfilteringfor Application Page. - Added new APIs which acts as a gateway for calling forms-flow-analytics APIs.
- Added new API for modifying group details in Keycloak with the help of Keycloak admin APIs.
- Add application status list API.
- Added unit test cases and new script for CI operations.
Upgrade notes:
New environment variables KEYCLOAK_ADMIN_USERNAME, KEYCLOAK_ADMIN_PASSWORD, INSIGHT_API_URL, INSIGHT_API_KEY.
forms-flow-analytics
- Added Dashboard authorisation at Redash dashboard level.
forms-flow-forms
- Added indexes in Submission collection for applicationId, process_pid.
- Added authentication for publicly exposed urls.
Upgrade notes:
New environment variables FORMIO_JWT_SECRET. It's highly recommended to change this environment variable for existing installations.
forms-flow-idm
- Added new groups and mapper for Dashboard authorisation at Redash dashboard level.
Upgrade notes:
- To enable dashboards, and provide authorization the following changes are required in existing installations:
- Create a new main group called
formsflow-analytics, and create as many subgroups as you want to associate various dashboards from Admin UI(in Designer) - Create a new mapper under forms-flow-web client in Keycloak, by following below steps:
* Name = dashboard-mapper
* Mapper Type = User Attribute
* User Attribute = dashboards
* Token Claim Name = dashboards
* Add to ID Token = ON
* Add to access token = ON
* Add to userinfo = ON
* Multivalued = ON
* Aggregate attribute values = ON
* Click Save
- Corresponding to each user, add the dashboard-groups you want to enable for dashboard authorization. This will give users permission to as many dashboards which the group have been enabled with from Admin.
Fixed
forms-flow-api
- Fixed application metrics showing incorrect results by changing date to filtered based on timezone.
forms-flow-bpm
- Improved token creation logic using Oauth2RestTemplate.
- Code cleanup and optimization.
forms-flow-web
- Fixed total task count shown on the task LHS side and updated only after refreshing the page.
- Tasklist API updated.
Modified
forms-flow-web
Upgrade notes:
Removed environment variables INSIGHT_API_URL, INSIGHT_API_KEY
Solution Component Upgrades
forms-flow-bpm
- Camunda upgrade from
7.13.0to7.15.0. - Upgraded springboot from
2.4.2to2.4.8 - Upgraded spring-security-oauth2 from
2.4.2to2.4.8
Upgrade notes:
After v4.0.4 version upgrade, Run the migrations with upgrade file.
forms-flow-analytics
- Upgraded redash library to version from
9.0.0-betato10.1.0
Upgrade notes:
After v4.0.4 version upgrade, run the following command first to run the necessary migrations with the command:
docker-compose -f docker-compose-linux.yml run --rm server manage db upgrade
docker-compose -f docker-compose-linux.yml up --force-recreate --build
In case you want to downgrade to the v9.0-beta of forms-flow-analytics component after formsflow.ai version upgrade. To update the migrations and rebuild formsflow.ai. Use the below commands which was used in setup. Also note that we are not supporting downgrade to any version below Redash v9.0(which has be used from formsflow.ai v4.0 onwards).
forms-flow-forms
- Formio upgrade from
2.0.0-rc.34to2.3.0.
Known Issues
- In case you are facing mongodb connection refused error for forms-flow-forms, downgrade to the next lowest mongo stable version
- Consoles related to http://localhost:3001/current Api Failing. The console messages can be ignored. Please refer to Issue-#106 for more details.
Added
forms-flow-bpm
- Added new postman collections for camunda API.
- Runtime logger level updation
forms-flow-web
- Added upload/download forms feature.
- Added a feature to search submissions in metrics based on created or modified date range.
forms-flow-api
- Better logging for Python API including coloured logs and API time details.
- Add pessimistic Database disconnection handling mechanism.
Fixed
forms-flow-bpm
- Fixed the issue of Oauth2 RestTemplate was recreating each time, so the session was getting created so many times.
- Exception handling & Retry for External form submission listener in ExternalFormSubmissionListener
- Usage issue fixed with ApplicationAuditListener.
forms-flow-analytics
- Resolve analytics component breaking due to SIGSEV Memory issue.
forms-flow-web
- Fixed server side pagination for
Taskpage. - Fixed Items per page dropdown in the form page for designer.
Modified
forms-flow-bpm
- Upgraded Camunda BPM Identity Keycloak to 2.2.1
forms-flow-api
- Add orderBy field to
metricsAPI to display API based on created date and modified date. - Changed default timezone to UTC time instead of being set as users local time.
forms-flow-web
- Footer was modified to display formsflow.ai with the version number.
- Optimized task list page by limiting the number of backend calls.
Added
forms-flow-bpm
- Added task listener events as configurable one's in application property. New property added is websocket.messageEvents .
Fixed
forms-flow-analytics
- Fixed the issue of new datasource failing on creating.
forms-flow-bpm
- Approver action dropdown appearing on the clerk's task section once the approver returns the form is fixed for the
New Business License Application form.
forms-flow-idm
- Removed additional parameters from the default configuration, which was causing keycloak import to fail in v11.0.
forms-flow-web
- Fixed in the
Taskssection on completing a particular task, the task list is not being removed from LHS. - Solution vulnerability fixes.
- Resolved the issue of form data is not being updated from cache on claiming the form.
- Identified & removed redundant calls on updating the task details.
Modified
forms-flow-api
- Rename Application Audit to Application History(without affecting database table).
- Removed Sentiment Analysis component and database, which will be separate micro-service in upcoming release.
forms-flow-bpm
- Refined the keycloak group query to improve API performance.
- Formio Access Token Cache (Internal) workflow is modified to start after deployment and added scripts for cleanup.
forms-flow-web
- Application status component created as a hidden element by default during form design.
Generic Changes
- Added gitter community
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 ProcessandTwo-Step Approval Process.
forms-flow-forms
- Added new forms-
Create New Business License ApplicationandFreedom 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 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
Known Issues
- Consoles related to http://localhost:3001/current Api Failing. The console messages can be ignored. Please refer to Issue-#106 for more details.
Added
- Added support for http calls which introduces the ability to make http calls across components for quicker and easier setup. Earlier versions required SSL support which required a lot of time and effort to setup, with a need for Keycloak server with SSL support.
- User can claim/view the Tasklist in realtime. It provides live updates to tasks, allowing teams to collaborate on a single task list in real time. Used websockets support under the hood to make real time communication(component: forms-flow-web, forms-flow-bpm)
- Automated installation steps for keycloak setup. It provides a bundled, pre-configured keycloak package for a local setup to simplify the installation process
- Automated manual steps for resource id generation, included batch and shell scripts to simplify the process.
- New UI for formsflow.ai based on Vue.js for easy integration of formsflow.ai to existing projects. To know more details checkout formsflow-ai-extension repository and to install our NPM package go here.(component: forms-flow-ai-extensions)
- New API for health check has been included. (component : forms-flow-api)
- Added confirmation messages to notify the users on save actions. (component: forms-flow-web)
- Users can click on External shared links (eg. from email) to get redirected to a particular task/submission/form if the user has right permissions. (component: forms-flow-web)
- Claiming of tasks are restricted to users belonging to reviewer group(formsflow/formsflow-reviewer) of keycloak.(component: forms-flow-web)
- Application/Submission view for client role users are restricted to own submission view.(component: forms-flow-bpm, forms-flow-web)
- Added Semantic UI css for forms design (component: forms-flow-web)
- Listeners are well-documented with information on purpose, how-it-works and how-to-use (component : forms-flow-bpm) Link
- Support to associate an unique form at every manual task in workflow process (Component: forms-flow-bpm)
Modified
- Task dashboard has been revamped with new look and feel- which would allow more control on data and stream updates.
- Enhanced Form Process Mapper API and Application API endpoints (component : forms-flow-api)
- Improved exception handling of python to provide meaningful error messages (component : forms-flow-api)
- Improved README for better readability and easy installation.
- The Task menu has been moved to Header section. In Task Section, filters are available in the main menu and a new Dashboard section has been added which includes metrics and Insights. (component: forms-flow-web)
- Dynamic property to set Application Name and logo in the header. (component: forms-flow-web)
- Default route for user having reviewer role is pointed to tasks page and that of client/designer is to forms page.(component: forms-flow-web)
- Removed edit/delete submission buttons from submission list view of reviewers.
Fixed
- Cosmetic changes to show success message after loading is completed.
- Custom component (Text Area with analytics) not retaining the value after submission. (component: forms-flow-forms)
- UI layout fixes (component: forms-flow-web)
Solution Component Upgrades
- React library upgraded to latest version-17.0.2 and fixed security vulnerabilities (Component : forms-flow-web)
- Spring boot upgraded to latest version-2.4.2 (Component : forms-flow-bpm)
- Redash upgraded to latest version:v9 (component : forms-flow-analytics)
- Fixed Python security vulnerabilities and updated flask to 1.1.4 version (component : forms-flow-api)
- Fixed Form.io security vulnerabilities. (component : forms-flow-forms)
Known Issues
- Consoles related to http://localhost:3001/current Api Failing. The console messages can be ignored. Please refer to Issue-#106 for more details.
Modified
- Formio upgraded to latest version-2.0.0.rc34 (Component : forms-flow-forms)
- In application & task dashboard, the process diagram navigation is highlighted on the diagram (Component : forms-flow-web)
- Made cosmetic changes to menu icons (Component: forms-flow-web)
- Update on swagger documentation (Component: forms-flow-api)
- For the designer's edit scenario, by default the workflow selection & association is rendered as read-only with an option to toggle and edit(Component: forms-flow-web)
Untested Features
- Support to associate an unique form at every manual task in workflow process (Component: forms-flow-bpm)
Fixed
- Support to access forms-flow-ai solution in mobile(Component: forms-flow-web)
- Forms flow Edit/submission Routing Fix for User with Multiple Role (Component: forms-flow-web)
Upcoming Features
- Refactoring python api to use module flask-resk-jsonapi (Component: forms-flow-api)
- Enhanced sorting, searching and pagination (Component: forms-flow-web)
Known Issues
- Custom component (Text Area with analytics) not retaining the value after submission
- Cosmetic changes to show success message after loading is completed
Modified
- In application dashboard, the "Application Status" column search component has been enhanced to show all possible values in dropdown (Component : forms-flow-web)
- In application dashboard, the button label has been modified to show as "Acknowledge" for status "Awaiting Acknowledgement" (Component : forms-flow-web)
Added
- Logo & UI Styling
- Introduced Applications menu
- Versioning of form submissions
- Task menu - Process Diagram, Application History
- UI for configuration of forms with workflow (Designer)
- Custom component
Text Area with analytics(with configurable topics) - Sentiment analysis API using nltk and spacy
Known Issues
- Custom component (Text Area with analytics) not retaining the value after submission
- Cosmetic changes to show success message after loading is completed
Added
- This file (CHANGELOG.md)
- CONTRIBUTING.md
Added
- ReDash implementation under forms-flow-analytics
- Deployment folder with docker and nginx
- formsflow.ai UI task dashboard
- formsflow.ai UI metrics dashboard
- Single component installations with docker and docker-compose
- Native windows intallation docker-compose-windows.yml
- Native Linux installation docker-compose-linux.yml
Removed
- forms-flow-db folder
Changed
- All README.md files cleaned up throughout project
- Environment variables rationalised and renamed to be globally generic
Added
- Initial release