Skip to main content
After upgrading to a new platform version, always ensure that your installed component versions match the versions specified in the release notes. To verify this, navigate to FlowX.AI Designer > Platform Status.
Platform Status screen showing component versions

​
Component versions

Component5.7.05.6.05.5.05.4.05.3.05.2.0
process-engine10.87.010.77.010.60.010.38.010.29.010.12.0
admin10.74.010.66.010.53.010.38.010.26.110.12.0
designer10.143.110.127.310.91.010.59.110.32.410.12.1
cms-core10.51.010.43.010.35.010.22.010.16.010.7.0
scheduler-core10.38.010.31.010.25.010.15.010.11.110.4.1
events-gateway10.40.010.33.110.27.010.17.010.12.110.4.1
notification-plugin10.49.010.42.110.35.010.22.010.17.010.7.0
document-plugin10.57.010.46.010.35.010.23.010.16.010.6.0
task-management-plugin10.48.010.41.110.35.010.25.010.18.010.7.0
data-search10.37.010.30.110.25.010.14.010.10.110.4.1
audit-core10.47.010.40.010.31.010.21.010.15.110.6.0
advancing-controller10.38.010.33.110.27.010.16.010.11.010.4.1
integration-designer10.101.010.84.010.63.010.38.010.24.010.8.0
application-manager10.78.010.69.110.53.010.37.010.24.010.11.0
runtime-manager10.78.010.69.110.53.010.37.010.24.010.11.0
data-sync10.44.010.38.010.31.110.20.110.14.110.3.1
authorization-system10.60.010.51.010.42.110.28.010.18.110.7.0
nosql-db-runner10.41.010.34.010.27.010.17.010.10.110.4.1
email-gateway10.40.010.32.110.24.010.9.0--
organization-manager10.34.010.26.110.19.2---
webhook-gateway10.8.010.1.1----
license10.28.0-----

​
Embedded components

  • SpiceDB
  • DGraph

​
Renderers

Component5.7.05.6.05.5.05.4.05.3.05.2.0
@flowx/angular-sdk10.143.110.127.310.68.010.59.110.32.410.12.1
@flowx/angular-theme10.143.110.127.310.68.010.59.110.32.410.12.1
@flowx/angular-ui-toolkit10.143.110.127.310.68.010.59.110.32.410.12.1
@flowx/react-sdk10.143.110.127.310.68.010.59.110.32.410.12.1
@flowx/react-theme10.143.110.127.310.68.010.59.110.32.410.12.1
@flowx/react-ui-toolkit10.143.110.127.310.68.010.59.110.32.410.12.1
@flowx/core-sdk10.143.110.127.310.68.010.59.110.32.410.12.1
@flowx/core-theme10.143.110.127.310.68.010.59.110.32.410.12.1
iOS renderer10.3.010.3.010.3.010.2.010.1.010.0.0
Android renderer10.3.010.3.010.3.010.2.010.1.010.0.0

​
Plugins

Component5.7.05.6.05.5.05.4.05.3.05.2.0
ocr-plugin1.0.171.0.171.0.171.0.171.0.171.0.17
reporting-plugin0.2.30.2.30.2.30.2.30.2.30.2.3

​
AI Platform

Component5.7.05.6.05.5.05.4.05.3.05.2.0
ai-assistant10.2.310.1.210.1.210.1.110.0.1
di-platform10.3.010.2.610.2.510.2.510.2.0
ai-platform-ai-developer10.6.0TBD10.1.310.1.310.0.1
ai-platform-connected-graph10.6.0TBD10.1.310.1.310.0.1
ai-platform-knowledge-graph10.6.0TBD10.1.310.1.310.0.1
ai-platform-agents10.6.0TBD10.1.310.1.310.0.1
ai-platform-conversations10.6.0TBD10.1.310.1.310.0.1
ai-platform-tenants10.6.0TBD10.1.310.1.310.0.1
ai-platform-planner10.6.0TBD10.1.310.1.310.0.1
ai-platform-ai-analyst10.6.0TBD10.1.310.1.310.0.1
ai-platform-ai-designer10.6.0TBD10.1.310.1.310.0.1
ai-platform-agent-builder10.6.0TBD10.1.310.1.310.0.1
ai-platform-binaries10.6.0TBD10.1.310.1.310.0.1
knowledgebase10.6.0TBD---
knowledgebase-rag10.6.010.2.0---
knowledgebase-indexer-v210.6.010.2.0---
mcp10.6.010.2.0---
doc-converter10.2.2----
doc-parser10.5.1----
Note: The ai-platform-models service has been removed in 5.7.0. LLM provider and model configuration has moved to the AI Providers UI within the Organization Manager.
FlowX.AI Version3rd Party DependencySupported Versions
5.7.0Keycloak26+
5.7.0Kafka3.8 - 3.9
5.7.0PostgreSQL16 - 17
5.7.0Oracle Database21c, 23ai
5.7.0MongoDB7 - 8
5.7.0Redis7.4 - 8.0
5.7.0Angular (Web SDK)19.2
5.7.0React (Web SDK)18.x
The following versions of third-party dependencies are no longer supported:
  • Keycloak versions older than 26
  • Kafka versions older than 3.8
  • Redis versions older than 7.4

​
Self-hosted deployment changes

First on-premises release since 5.4.0. This section covers critical configuration changes for self-hosted (on-premises) deployments.

​
Supported upgrade paths

Source versionPathNotes
Fresh installSupportedGuided setup flow on first launch. See Organization Manager setup.
5.1.x LTSSupportedRequires Organization ID on all 19 services. Liquibase migrates active process instances and realm data. Inactive instances require separate handling by FlowX. See details below.
5.2 - 5.4FlowX-assisted onlyThese versions may have partial realm or organization changes. Contact your FlowX representative for a custom migration plan. Do not follow the 5.1.x upgrade path.
5.5 - 5.6SaaS onlyThese were SaaS-only releases with no on-premises deployment.

​
Organization ID (mandatory for upgrades)

The Organization ID is how FlowX identifies your installation. How it is obtained depends on your deployment path:
  • Fresh install: The Organization ID is created automatically during the guided setup flow (Designer first-launch screen). No manual configuration needed.
  • Upgrade from 5.1.x: FlowX registers your organization in the SaaS licensing infrastructure and provides an Organization ID (UUID). Set ORGANIZATION_ID on all 19 services before deploying 5.7.0 images — Liquibase migrations use it to replace the default organization.
# Example — set on every service
ORGANIZATION_ID: "26ef7b5f-b463-4375-88c8-xxxxxxxxxxxx"  # UUID provided by FlowX
Affected services (all 19): process-engine, admin, audit-core, authorization-system, advancing-controller, events-gateway, cms-core, scheduler-core, data-search, document-plugin, nosql-db-runner, notification-plugin, task-management-plugin, integration-designer, organization-manager, email-gateway, application-manager, runtime-manager, license.
Do not deploy 5.7.0 images without setting ORGANIZATION_ID on upgrade scenarios. Services will fail to start if Liquibase migrations cannot find the organization ID.
Active vs inactive instances. Liquibase migrations automatically update the Organization ID on active process instances only. Inactive or archived instances require separate migration handled by the FlowX team during guided deployment. Contact your FlowX representative for details.

​
License service (new)

Self-hosted deployments must configure the License service to connect to FlowX SaaS for license validation and usage reporting. See the License service setup guide for complete configuration.

​
IAM / Keycloak changes

FlowX.AI now uses a two-realm architecture in Keycloak and JWT public key validation (replacing opaque-token introspection). These changes were introduced in 5.5.0 (SaaS) and are now relevant for self-hosted deployments.
  • Token validation: security.type switches from oauth2 to jwt-public-key on all services
  • Service accounts realm: A dedicated realm (00000002-0002-4002-8002-000000000002) holds all service account clients, separate from the user realm
  • Organization manager: Now a required dependency for all services (provides realm resolution)
  • flowx-platform-authorize client: No longer needed — remove from Keycloak
  • Master realm credentials: The authorization-system service needs Keycloak admin access for realm migrations. If you cannot provide admin credentials, see Manual Keycloak configuration.
  • SMTP: Must be configured in Keycloak for password reset and user invitations
For complete IAM setup instructions, see the Configuring an IAM solution guide.

​
Environment info deprecation

The Configure Environment Info feature (PATCH /api/platform/environment) is deprecated and removed. Environment name is now set during organization registration. The following are no longer used:
  • FLOWX_CLIENT_NAME environment variable
  • FLOWX_ENVIRONMENT_NAME environment variable
  • environmentDetails section in the /api/init response

​
Kafka integration changes

​
Fx-Organization-Id header (mandatory)

All FlowX Kafka consumers now validate the Fx-Organization-Id header on every incoming message. Messages without this header are rejected with a non-retryable MissingKafkaHeaderException.
Action required for custom Kafka integrations. If you have custom Kafka producers that publish directly to FlowX topics (starting processes, sending task events, responding to engine requests), you must add the Fx-Organization-Id header to every message. Set it to the Organization UUID (ORGANIZATION_ID value).
producerRecord.headers().add("Fx-Organization-Id",
    organizationId.getBytes(StandardCharsets.UTF_8));
See the Creating a Kafka producer guide for details.

​
New Kafka topics

TopicEnvironment VariableProducerConsumerDescription
ai.flowx.llm.config.changed.v1KAFKA_TOPIC_LLM_CONFIG_CHANGEDorganization-managerintegration-designer, AI Python servicesBroadcast when LLM provider or model configuration changes at the organization level

​
Environment variables

Environment variable names follow Spring relaxed binding conventions. For example, the YAML property security.oauth2.sa-realm maps to the environment variable SECURITY_OAUTH2_SAREALM (dots become underscores, hyphens are removed, all uppercase).

​
New environment variables

Environment VariableDescriptionDefault ValueComponent
ORGANIZATION_IDOrganization UUID provided by FlowX. Required on all services for upgrades. Fresh installs get this automatically via the setup flow.-all services
FLOWX_LICENSE_KEYLicense key for FlowX SaaS connection-license
FLOWX_LICENSE_AUTHSERVERURLFlowX SaaS auth URL-license
FLOWX_LICENSE_SERVERURLFlowX SaaS license API URL-license
FLOWX_ORG_MANAGER_URLOrganization Manager service URL for LLM provider configuration. Required on all Python AI services.-planner, ai-developer, ai-analyst, ai-designer, agent-builder, knowledgebase-rag, embedder, knowledgebase
SECURITY_MASTERREALM_CLIENTIDMaster realm admin client ID for Keycloak managementadmin-cliauthorization-system
SECURITY_MASTERREALM_NAMEKeycloak master realm namemasterauthorization-system
SECURITY_MASTERREALM_ADMIN_USERNAMEKeycloak admin username for realm migrations-authorization-system
SECURITY_MASTERREALM_ADMIN_PASSWORDKeycloak admin password for realm migrations-authorization-system
SECURITY_OAUTH2_SAREALMService accounts realm ID00000002-0002-4002-8002-000000000002all services
FLOWX_LIB_SECURITY_SERVICES_ORGANIZATIONMANAGER_BASEURLOrganization manager URL for security libhttp://organization-manager:80all services
FLOWX_SPEECH_TO_TEXT_BASE_URLBase URL for the Speech-to-Text servicehttp://speech-to-text:80integration-designer
KAFKA_TOPIC_LLM_CONFIG_CHANGEDTopic for LLM config change notificationsai.flowx.llm.config.changed.v1organization-manager
LLM_ENCRYPTION_MASTER_KEYEncryption key for LLM provider API keys at rest. Change from default in production.default-dev-key-change-in-prodorganization-manager

​
Removed environment variables

For upgrades: Remove these variables only after the Liquibase migrations have completed successfully. If you remove them before starting services for the first time on 5.7.0, the migrations may fail. The recommended sequence is: (1) add new variables, (2) deploy 5.7.0 images, (3) let migrations run, (4) verify services are healthy, (5) remove old variables in a follow-up deployment.
Environment VariableReasonComponent
FLOWX_CLIENT_NAMEReplaced by org code from registrationprocess-engine
FLOWX_ENVIRONMENT_NAMEReplaced by env name from registrationprocess-engine
AI_SERVICE_MODELS_ENDPOINTThe Models microservice (port 9104) has been removed. LLM provider and model configuration has moved to the AI Providers UI. Remove this service from your deployment.ai-platform (all Python services)
SECURITY_OAUTH2_REALMReplaced by per-organization realm resolution.all services
SECURITY_OAUTH2_CLIENT_CLIENTIDOpaque-token introspection client no longer needed.all services
SECURITY_OAUTH2_CLIENT_CLIENTSECRETOpaque-token introspection client secret no longer needed.all services
SPRING_SECURITY_OAUTH2_RESOURCESERVER_OPAQUETOKEN_*Entire opaque-token introspection config removed.all services
Last modified on April 9, 2026