Deployment guidelines v3.1.0

Do not forget, when upgrading to a new platform version, always check and make sure your installed component versions match the versions stated in the release. To do that, go to FLOWX.AI Designer > Platform Status.

After updating to 3.1.0 FLOWX.AI release, importing old processes definitions in the new platform release is not possible (available for exports from < 3.1.0 releases).

Component versions

With the release of FLOWX.AI 3.0, there have been some changes that you need to be aware when upgrading to the latest version:

The flowx-process-renderer has been migrated to @flowx\ui-sdk.
As of FlowX 4.0, the paperflow-web-components library is no longer being maintained. Instead, the new components can be found in @flowx/ui-toolkit.

For more information, check Using the Angular Renderer section.

:ballot_box_with_check:	3.1.0	3.0.0	2.14.0	2.13.0	2.12.0	2.11.0	2.10.0	2.9.0	2.8.1	2.8.0	2.7.0	2.6.0	2.5.0	2.4.0	2.3.0	2.2.0	2.1.0
Process engine	2.1.2	2.0.7	0.4.104	0.4.95	0.4.90	0.4.83	0.4.60	0.4.49	0.4.44	0.4.42	0.4.42	0.4.36	0.4.29	0.4.22	0.4.21	0.4.18	0.4.13
Admin	2.1.3	2.0.8	0.3.119	0.3.103	0.3.92	0.3.81	0.3.60	0.3.55	0.3.47	0.3.43	0.3.40	0.3.36	0.3.34	0.3.29	0.3.23	0.3.21	0.3.13
Designer	3.15.1	3.2.1	2.78.4-1	2.63.6	2.60.7	2.48.9	2.39.2	2.33.0	2.28.1	2.24.2	2.23.0	2.19.2	2.18.2	2.17.4	2.15.2	2.14.4	2.11.2
@flowx/ui-sdk	3.15.1	3.2.1	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	2.23.0	n/a	n/a	n/a	n/a	n/a	n/a
@flowx/ui-toolkit	3.15.1	3.2.1	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a
@flowx/ui-theme	3.15.1	3.2.1	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a
paperflow-web-components	-	-	2.78.4-1	2.63.6	2.60.7	0.2.10	0.2.10	0.2.10	0.2.6	0.2.6	0.2.6	0.2.6	0.2.6	0.2.6	0.2.6	0.2.5	0.2.4
flowx-process-renderer	-	-	2.78.4-1	2.63.6	2.60.7	2.48.9	2.39.2	2.33.0	2.28.1	2.24.2	2.23.0	2.19.2	2.18.2	2.17.4	2.15.2	2.14.4	2.11.2
CMS Core	1.0.3	1.0.2	0.2.38	0.2.36	0.2.33	0.2.30	0.2.25	0.2.23	0.2.23	0.2.23	0.2.23	0.2.23	0.2.20	0.2.20	0.2.18	0.2.17	0.2.17
Scheduler Core	1.0.4	1.0.1	0.0.34	0.0.34	0.0.34	0.0.33	0.0.28	0.0.27	0.0.27	0.0.27	0.0.27	0.0.27	0.0.24	0.0.24	0.0.23	0.0.23	0.0.23
Notification Plugin	2.0.3	2.0.1	1.0.206	1.0.206	1.0.206	1.0.205	1.0.200	1.0.198	1.0.198	1.0.197	1.0.194	1.0.194	1.0.191	1.0.191	1.0.190	1.0.190	1.0.186-1
Document Plugin	2.0.3	2.0.2	1.0.53	1.0.53	1.0.53	1.0.52	1.0.47	1.0.42	1.0.41	1.0.38	1.0.37	1.0.37	1.0.35	1.0.35	1.0.31	1.0.31	1.0.30
OCR Plugin	0.1.33	0.1.33	0.1.33	0.1.33	0.1.5	0.1.5	0.1.5	0.1.5	0.1.5	0.1.5	0.1.5	0.1.5	0.1.5	0.1.5	0.0.109	0.0.109	0.0.109
License Core	1.0.2	1.0.1	0.1.28	0.1.28	0.1.28	0.1.27	0.1.23	0.1.19	0.1.18	0.1.18	0.1.18	0.1.18	0.1.15	0.1.15	0.1.13	0.1.13	0.1.12
Customer Management Plugin	0.2.3	0.2.1	0.1.28	0.1.28	0.1.28	0.1.27	0.1.23	0.1.22	0.1.22	0.1.22	0.1.22	0.1.22	0.1.20	0.1.20	0.1.18	0.1.18	0.1.18
Task Management Plugin	1.0.4	1.0.1	0.0.42	0.0.42	0.0.40	0.0.37	0.0.29	0.0.28	0.0.28	0.0.27	0.0.27	0.0.27	0.0.22	0.0.22	0.0.21	0.0.21	0.0.16
Data search	0.1.4	0.1.3	0.0.8	0.0.8	0.0.6	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a
Audit Core	1.0.4	1.0.1	0.0.8	0.0.5	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a
Reporting	0.0.40	0.0.39	0.0.39	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a
advancing-controller	0.1.4	0.1.2	0.0.6	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a
iOS renderer	2.0.4	2.0.0	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a
Android renderer	2.0.1	2.0.1	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a	n/a

3.1.0 Minimum Recommended Versions

FLOWX.AI Platform Version	Component name	Minimum recommended version (tested versions)
3.1	Keycloak	18.0.x
3.1	Kafka	3.2.0
3.1	PostgreSQL	14.3.0
3.1	MongoDB	5.0.8
3.1	Redis	6.2.6
3.1	Elasticsearch	7.17
3.1	Any S3-compatible	-
3.1	OracleDB	19.8.0.0.0
3.1	Angular (Web SDK)	14.2.2

FlowX.AI supports any version of the third-party components listed as prerequisites.For optimal performance and reliability, our internal QA process validates new releases using specific versions as indicated in the provided table. While exploring alternative versions that suit your company’s specific requirements, we recommend referring to the compatibility matrix for guidance.In the unlikely event that you encounter any compatibility issues with FlowX.AI, please open a support ticket here, and our dedicated team will address and resolve any identified bugs following our standard support process.Compatibility Matrix:

FLOWX.AI Platform: Recommended and tested versions
Third-Party Components: Supported versions based on specific requirements and client preferences

Additional configuration

Process engine - scheduler

Configuration for scheduler to be added on Process engine setup.

scheduler:
  processCleanup:
    enabled: false
    cronExpression: 0 */5 0-5 * * ? #every day during the night, every 5 minutes, at the start of the minute.
    batchSize: 1000
  masterElection:
    cronExpression: 30 */3 * * * ? #master election every 3 minutes
  websocket:
    namespace:
      cronExpression: 0 * * * * *
      expireMinutes: 30

Undo/redo

Configuration for undo/redo actions in UI Designer to be added on Admin setup.

flowx:
  undo-redo:
    ttl: 86400 # in seconds
    cleanup:
      cronExpression: 0 0 2 ? * * # every day at 2am
      days: 2

Advancing controller with Oracle

To use advancing controller with OracleDBs, the following .yml files must be edited, configuring the right environment variables:

Advancing controller

If the parallel advancing configuration already exists, resetting the ‘advancing’ database must be done by executing the SQL command DROP DATABASE advancing;. Once the database has been dropped, the Liquibase script will automatically re-enable it.

SPRING_JPA_DATABASE - value: oracle
SPRING_JPA_DATABASE_PLATFORM
SPRING_DATASOUCE_URL
SPRING_DATASOURCE_DRIVERCLASSNAME

Advancing controller setup

Process engine

SPRING_JPA_DATABASE - value: oracle
SPRING_JPA_DATABASE_PLATFORM
SPRING_DATASOUCE_URL - environment variable used to configure a data source URL for a Spring application, it typically contains the JDBC driver name, the server name, port number, and database name
SPRING_DATASOURCE_DRIVERCLASSNAME - environment variable used to set the class name of the JDBC driver that the Spring datasource will use to connect to the database
ADVANCING_DATASOURCE_DRIVERCLASSNAME
ADVANCING_DATASOURCE_URL
ADVANCING_DATASOURCE_JDBC_URL

Process engine setup

​Component versions

​3.1.0 Minimum Recommended Versions

​Additional configuration

​Process engine - scheduler

​Undo/redo

​Advancing controller with Oracle

​Advancing controller

​Process engine

Component versions

3.1.0 Minimum Recommended Versions

Additional configuration

Process engine - scheduler

Undo/redo

Advancing controller with Oracle

Advancing controller

Process engine