Deployment guidelines v3.3.0

​

Component versions

​

Recommended Versions for FLOWX.AI 3.3.0 ☑️

​

Additional configuration

This section describes the additional configuration that is required to use the new features in FlowX.AI.

​

Process engine

​

Process Instance Indexing through Kafka transport

Introducing a new Kafka transport strategy for sending details about process instances to be indexed in Elasticsearch. To enable indexing of process instances in Elasticsearch through Kafka, configure the following environment variables:

• FLOWX_INDEXING_ENABLED

• FLOWX_INDEXING_PROCESSINSTANCE_INDEXING_TYPE

• FLOWX_INDEXING_PROCESSINSTANCE_INDEX_NAME: specify the name of the index used for process instances

• FLOWX_INDEXING_PROCESSINSTANCE_SHARDS: set the number of shards for the index

• FLOWX_INDEXING_PROCESSINSTANCE_REPLICAS: set the number of replicas for the index

​

Topics related to process event messages

Process engine new kafka topics

For more details please check the following section:

Process Instance Indexing through Kafka transport

​

New service account

Added a new service account flowx-process-engine-sa. This service account is needed so the use of Start Catch Event node is possible.

Service accounts

​

Events gateway

Added a new events-gateway microservice, which requires the following configuration.

The events-gateway is designed specifically for handling events. Previously, each process-engine pod had a WebSocket (WS) server, and the front-end (FE) would connect to the process-engine to receive messages.

Now, instead of a server holding the messages, they are stored in Redis. However, the process-engine sends the messages to the events-gateway, which is responsible for sending them to Redis. Users connect to the events-gateway using an HTTP request and wait for Server-Sent Events (SSE) to flow in that request. They keep the request open for as long as they want SSE on a specific instance.

​

Events-gateway kafka topics

New Kafka topics have been added for the events-gateway. These topics are used to send and receive messages between the events-gateway and the process-engine.

New kafka topics that should be added in the events-gateway configuration.

Events gateway

Events gateway setup guide

Process engine topics

​

SSE

1. Uninstall socket.io-client:

Before proceeding, ensure that you uninstall socket.io-client from your project. You can do this using the following command:

npm uninstall socket.io-client

2. Install event-source-polyfill@1.0.31:

To replace the functionality provided by socket.io-client, you will need to use a new package called event-source-polyfill@1.0.31 (as mentioned in the Installing the library section). This package serves as a polyfill for the EventSource API, which enables servers to send events to clients over HTTP. The EventSource API is commonly used for server-sent events (SSE) and real-time web applications.

npm install event-source-polyfill@1.0.31

​

Message events

​

Topics related to message events

New kafka topics that should be added in the process-engine configuration.

​

Bulk updates

New kafka topics that should be added in the process-engine configuration, related to task management plugin - bulk updates.

​

Example

{
    "operations": [
    {
       "operationType": "TERMINATE",
        "processInstanceUuid": "6ae8274a-2778-4ff9-8fcb-6c84a5eb2bc6",
        "taskId": "doesn't matter"
    },
    {
       "operationType": "HOLD",
        "processInstanceUuid": "6ae8274a-2778-4ff9-8fcb-6c84a5eb2bc6",
        "taskId": "doesn't matter"
    }
    ]
}

Process engine topics

​

Migration Steps

To upgrade to FLOWX.AI 3.3.0, follow these steps:

• Make sure you have taken a backup of your current platform and database configurations.
• Verify that your current installed component versions match the versions specified in the release notes.
• Update the FLOWX.AI platform and all related components to the recommended versions.
• Update the necessary configuration files according to the additional configuration requirements.
• Restart the FLOWX.AI platform and related services.
• Verify that the platform is running correctly and all processes are functioning as expected.
• If you encounter any issues or errors during the upgrade process, refer to the troubleshooting section in the release notes or contact FLOWX.AI support for assistance.

​

Troubleshooting

If you encounter any issues during the upgrade process or while running the FLOWX.AI platform, refer to the troubleshooting section in the release notes or contact FLOWX.AI support for assistance.