Deployment guidelines v3.2.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.2.0 FLOWX.AI release, importing old processes definitions in the new platform release is not possible (available for exports from < 3.2.0 releases).

Component versions

:ballot_box_with_check:	3.2.0	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.2.1	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.2.2	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.21.1	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.21.1	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-toolkit	3.21.1	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.21.1	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.2.0	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.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.5	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.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	1.0.2	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.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.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.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.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.5	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.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.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.7	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	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

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 will be deprecated. Instead, the new components can be found in @flowx/ui-toolkit.

3.2.0 Minimum Recommended Versions

FLOWX.AI Platform Version	Component name	Minimum recommended version (tested versions)
3.2	Keycloak	18.0.x
3.2	Kafka	3.2.0
3.2	PostgreSQL	14.3.0
3.2	MongoDB	5.0.8
3.2	Redis	6.2.6
3.2	Elasticsearch	7.17
3.2	S3 (Min.IO) / minio-operator	2022-05-26T05-48-41Z / 4.5.4
3.2	OracleDB	19.8.0.0.0
3.2	Angular (Web SDK)	15.0.0

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

CMS audit log

New environment variable that needs to be configured on CMS microservice:

• KAFKA_TOPIC_AUDIT_OUT - the identifier for the Kafka topic used to receive audit logs

CMS setup guide

Notifications plugin

New environment variables added to configure the error handler on Notifications plugin - Kafka consumer (default values below):

KAFKA_CONSUMER_ERROR_HANDLING_ENABLED: FALSE
KAFKA_CONSUMER_ERROR_HANDLING_RETRIES: 0
KAFKA_CONSUMER_ERROR_HANDLING_RETRY_INTERVAL: 1000

More information about the new environment variables:

Notifications plugin setup guide

Client and environment

Only users with the following admin role can set/edit the new client and environment feature:

• ROLE_ADMIN_MANAGE_PLATFORM_ADMIN

OCR plugin

Replaced MINIO_ prefix with STORAGE_S3_ for storage related environment variables.

New environment variables:

• STORAGE_S3_ACCESS_KEY
• STORAGE_S3_SECRET_KEY
• STORAGE_S3_HOST
• STORAGE_S3_LOCATION
• STORAGE_S3_OCR_SCANS_BUCKET
• STORAGE_S3_OCR_SIGNATURE_BUCKET
• STORAGE_S3_OCR_SIGNATURE_FILENAME

The following environment from previous releases must be removed in order to use OCR plugin: CELERY_BROKER_URL.

More information available in the below section:

OCR setup guide