Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.flowx.ai/llms.txt

Use this file to discover all available pages before exploring further.

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.8.05.7.05.6.05.5.05.4.05.3.0
process-engine10.104.010.96.010.77.010.60.010.38.010.29.0
admin10.91.010.83.010.66.010.53.010.38.010.26.1
designer10.180.810.164.010.127.310.91.010.59.110.32.4
cms-core10.66.010.58.010.43.010.35.010.22.010.16.0
scheduler-core10.52.010.45.010.31.010.25.010.15.010.11.1
events-gateway10.54.010.47.010.33.110.27.010.17.010.12.1
notification-plugin10.63.010.56.010.42.110.35.010.22.010.17.0
document-plugin10.73.010.64.010.46.010.35.010.23.010.16.0
task-management-plugin10.64.010.57.010.41.110.35.010.25.010.18.0
data-search10.51.010.44.010.30.110.25.010.14.010.10.1
audit-core10.61.010.54.010.40.010.31.010.21.010.15.1
advancing-controller10.53.010.45.010.33.110.27.010.16.010.11.0
integration-designer10.126.010.113.010.84.010.63.010.38.010.24.0
application-manager10.95.010.88.010.69.110.53.010.37.010.24.0
runtime-manager10.95.010.88.010.69.110.53.010.37.010.24.0
data-sync10.56.010.50.010.38.010.31.110.20.110.14.1
authorization-system10.75.010.68.010.51.010.42.110.28.010.18.1
nosql-db-runner10.55.010.48.010.34.010.27.010.17.010.10.1
email-gateway10.54.010.47.010.32.110.24.010.9.0-
organization-manager10.51.010.44.010.26.110.19.2--
webhook-gateway10.23.010.15.010.1.1---
license10.44.010.36.0----

​
Embedded components

  • SpiceDB
  • DGraph

​
Renderers

Component5.8.05.7.05.6.05.5.05.4.05.3.0
@flowx/angular-sdk10.180.810.164.010.127.310.68.010.59.110.32.4
@flowx/angular-theme10.180.810.164.010.127.310.68.010.59.110.32.4
@flowx/angular-ui-toolkit10.180.810.164.010.127.310.68.010.59.110.32.4
@flowx/react-sdk10.180.810.164.010.127.310.68.010.59.110.32.4
@flowx/react-theme10.180.810.164.010.127.310.68.010.59.110.32.4
@flowx/react-ui-toolkit10.180.810.164.010.127.310.68.010.59.110.32.4
@flowx/core-sdk10.180.810.164.010.127.310.68.010.59.110.32.4
@flowx/core-theme10.180.810.164.010.127.310.68.010.59.110.32.4
iOS renderer10.3.010.3.010.3.010.3.010.2.010.1.0
Android renderer10.3.010.3.010.3.010.3.010.2.010.1.0

​
Plugins

Component5.8.05.7.05.6.05.5.05.4.05.3.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.8.05.7.05.6.05.5.05.4.0
ai-assistant10.2.310.2.310.2.310.1.210.1.2
ai-platform-ai-assistant10.7.010.6.2---
di-platform10.3.010.3.010.3.010.2.610.2.5
ai-platform-ai-developer10.7.010.6.210.6.010.4.010.1.3
ai-platform-connected-graph10.7.010.6.210.6.010.4.010.1.3
ai-platform-knowledge-graph10.7.010.6.210.6.010.4.010.1.3
ai-platform-agents10.7.010.6.210.6.010.4.010.1.3
ai-platform-conversations10.7.010.6.210.6.010.4.010.1.3
ai-platform-tenants10.7.010.6.210.6.010.4.010.1.3
ai-platform-planner10.7.010.6.210.6.010.4.010.1.3
ai-platform-ai-analyst10.7.010.6.210.6.010.4.010.1.3
ai-platform-ai-designer10.7.010.6.210.6.010.4.010.1.3
ai-platform-agent-builder10.7.010.6.210.6.010.4.010.1.3
ai-platform-binaries10.7.010.6.210.6.010.4.010.1.3
embedder10.7.010.6.2---
knowledgebase-rag10.7.010.6.210.6.010.2.0-
knowledgebase-indexer-v210.7.010.6.210.6.010.2.0-
mcp10.7.010.6.210.6.010.2.0-
doc-converter10.2.310.2.310.2.2--
doc-parser10.7.010.6.210.5.1--
web-crawler10.3.510.3.2---
data-privacy10.1.010.0.8---
speech-to-text10.3.310.3.3---
modpod10.0.710.0.7---
FlowX.AI Version3rd Party DependencySupported Versions
5.8.0Keycloak26+
5.8.0Kafka3.8 - 3.9
5.8.0PostgreSQL16 - 17
5.8.0Oracle Database21c, 23ai
5.8.0MongoDB7 - 8
5.8.0Redis7.4 - 8.0
5.8.0Angular (Web SDK)19.2
5.8.0React (Web SDK)18.x

​
Self-hosted deployment changes

​
Supported upgrade paths

Source versionPathNotes
5.7.0SupportedStandard upgrade.
5.1.x LTSFlowX-assisted onlyRecommended path is via 5.7.0; direct 5.1.x → 5.8.0 is not validated.
5.5 - 5.6SaaS onlyThese were SaaS-only releases with no on-premises deployment.

​
Kafka integration changes

​
New Kafka topics

TopicProducerProducer env varConsumerConsumer env var
ai.flowx.license.events.v1organization-managerKAFKA_TOPIC_LICENSE_EVENTS_OUTlicenseKAFKA_TOPIC_LICENSE_IN_EVENTS
ai.flowx.application-version.correction-after-app-operation.custom-component.request.v1application-managerKAFKA_TOPIC_APPLICATION_RESOURCE_CORRECTIONAFTERAPPOPERATION_OUT_CUSTOMCOMPONENTadminKAFKA_TOPIC_APPLICATION_CORRECTIONAFTERAPPOPERATION_IN_CUSTOMCOMPONENT
ai.flowx.ai-platform.knowledgebase.internal.embedding-request.v1knowledgebase-indexer-v2n/a (Python constant)embeddern/a (Python constant)
ai.flowx.ai-platform.knowledgebase.internal.embedding-response.v1embeddern/a (Python constant)knowledgebase-indexer-v2n/a (Python constant)
ai.flowx.plugin.document.trigger.persist.document.session.bulk.v1process-engine(no env var; resolved from kafka.topic.naming.*)document-pluginKAFKA_TOPIC_DOCUMENT_PERSIST_SESSION_BULK_IN
License lifecycle events are delivered from FlowX SaaS to the on-prem license service. Custom-component correction requests complement the existing process / business-rule / reusable-template / ui-flow correction topics that the admin orchestrator already consumed. UI Flow multi-file upload sends a single bulk command to document-plugin in place of the per-file pattern. The plugin persists each file in the session, emits one SSE frame (UI_FLOW_FILE_UPLOAD_MULTIPLE, namespace = uploadBatchId) at the end of the batch via events-gateway, and forwards per-file results to the existing ai.flowx.core.trigger.ui-flow.update.v1 topic. KB embedding-request / embedding-response replace the previous gRPC EmbedderService path (BulkGenerateEmbeddings / GenerateEmbeddings); the indexer now publishes one embedding job per chunk and the embedder writes points to Qdrant directly, emitting KbStoreEntryStateChanged once all chunks for an entry are persisted.
The two core-services topic names (license.events, application-version.correction-after-app-operation.custom-component.request) resolve from the standard ${kafka.topic.naming.prefix} / ${kafka.topic.naming.suffix} machinery: default prefix ai.flowx. (empty environment segment), default suffix .v1. Operators that want an environment-prefixed topic name (e.g., ai.flowx.dev.license.events.v1) set kafka.topic.naming.environment globally rather than overriding individual topics. The two AI Platform topics are hard-coded constants in the indexer and embedder and do not participate in the prefix machinery.

​
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
FLOWX_LICENSE_ORGANIZATIONIDOrganization ID provided by FlowX. Initialized with the notset sentinel so the SaaS-identity OAuth client can start before the on-prem operator injects the real value. Type changed from UUID to String in 5.8.0.notsetlicense
SPRING_SECURITY_OAUTH2_CLIENT_PROVIDER_SAASAUTHPROVIDER_TOKENURIToken URI of the SaaS-side identity provider that the on-prem license service authenticates against. Resolves from ${flowx.license.auth-server-url} and the SaaS realm.derivedlicense
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_SAASIDENTITY_CLIENTIDOAuth client-id used by the license service to authenticate to FlowX SaaS. Resolves to ${flowx.license.organization-id}.derivedlicense
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_SAASIDENTITY_CLIENTSECRETOAuth client secret used by the license service to authenticate to FlowX SaaS. Resolves to ${flowx.license.key}.derivedlicense
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_SAASIDENTITY_CLIENTNAMELogical client name.saasIdentitylicense
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_SAASIDENTITY_PROVIDERIdentity provider key referenced by the registration.saasAuthProviderlicense
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_SAASIDENTITY_AUTHORIZATIONGRANTTYPEOAuth2 grant type for the SaaS identity registration.client_credentialslicense
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_SAASIDENTITY_CLIENTAUTHENTICATIONMETHODOAuth2 client authentication method.client_secret_postlicense
SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_SAASIDENTITY_SCOPEOAuth2 scopes requested.(empty)license
KAFKA_CONSUMER_GROUPID_LICENSE_EVENTSKafka consumer group used by the license service to receive license events.license-eventslicense
KAFKA_CONSUMER_THREADS_LICENSE_EVENTSListener container concurrency for the license-events consumer.1license
KAFKA_TOPIC_LICENSE_IN_EVENTSLicense events topic consumed by the license service.ai.flowx.license.events.v1license
KAFKA_TOPIC_LICENSE_EVENTS_OUTSame topic, producer-side binding on organization-manager.ai.flowx.license.events.v1organization-manager
KAFKA_TOPIC_APPLICATION_RESOURCE_CORRECTIONAFTERAPPOPERATION_OUT_CUSTOMCOMPONENTCustom-component correction-request topic, producer-side.ai.flowx.application-version.correction-after-app-operation.custom-component.request.v1application-manager
KAFKA_TOPIC_APPLICATION_CORRECTIONAFTERAPPOPERATION_IN_CUSTOMCOMPONENTSame topic, consumer-side.ai.flowx.application-version.correction-after-app-operation.custom-component.request.v1admin
MANAGEMENT_HEALTH_REDIS_TIMEOUTSpring Boot Actuator timeout for the Redis health indicator (in ms).5000all services using Redis
SPRING_CACHE_REDIS_PERSISTENCEKEYPREFIXPrefix applied to Redis keys for the advancing-controller cache.flowx:core:cache:advancing-controller:advancing-controller
REDIS_COMMAND_TIMEOUTRedis command timeout in ms. Fail-fast during master failover. Bound via ${REDIS_COMMAND_TIMEOUT:5000} placeholder on spring.data.redis.timeout.5000all services using Redis
REDIS_CONNECT_TIMEOUTRedis connection establishment timeout in ms. Bound via ${REDIS_CONNECT_TIMEOUT:5000}.5000all services using Redis
REDIS_POOL_MAX_ACTIVEMaximum number of active Redis connections in the pool.10all services using Redis
REDIS_POOL_MAX_IDLEMaximum number of idle Redis connections retained in the pool.5all services using Redis
REDIS_POOL_MIN_IDLEMinimum number of idle Redis connections kept warm in the pool.1all services using Redis
REDIS_POOL_MAX_WAITMaximum time to wait for an available connection from the pool, in ms.2000all services using Redis
FLOWX_METRICS_STUCKCHECKINTERVALMSInterval at which the stuck-events metric scheduler runs (ms). Bound from the inline @Value("${flowx.metrics.stuck-check-interval-ms:60000}") default; not in application.yml.60000advancing-controller
FLOWX_METRICS_STUCKTHRESHOLDMINUTESAge threshold (in minutes) above which an advancing event is considered stuck. Bound from @Value("${flowx.metrics.stuck-threshold-minutes:5}").5advancing-controller
FLOWX_DATAPRIVACY_BASEURLBase URL for the new Data Privacy service. Required when any AI workflow node enables the Personal Information Guard.http://data-privacy:80integration-designer
FLOWX_DATAPRIVACY_TIMEOUTSECONDSRequest timeout (seconds) for Data Privacy WebClient calls. Sized to accommodate cold-start of the Presidio model on the data-privacy worker.60integration-designer
KAFKA_TOPIC_DOCUMENT_PERSIST_SESSION_BULK_INTopic consumed by document-plugin to persist a list of UI Flow temp-files in a single batch. Producer-side is the matching kafka.topic.session.upload.bulk.out on process-engine, which resolves from the standard naming machinery.ai.flowx.plugin.document.trigger.persist.document.session.bulk.v1document-plugin

​
Removed environment variables

Environment VariableReplaced byComponent
FLOWX_SCHEDULER_MASTERELECTION_CRONEXPRESSIONRemoved with the move to single-pod scheduler execution (plat-1549, commons-scheduler-lib). No replacement; only one scheduler pod runs now.application-manager, license
FLOWX_SCHEDULER_MASTERELECTION_ENABLEDSame.application-manager, license
FLOWX_SCHEDULER_MASTERELECTION_PROVIDERSame.application-manager, license
SCHEDULER_MASTERELECTION_CRONEXPRESSIONSame.integration-designer, process-engine
Last modified on May 11, 2026