​

Component versions

​

Recommended Versions for FLOWX.AI 3.4.0 ☑️

​

Additional configuration

This section outlines the supplementary configurations required to leverage the newly introduced features within FLOWX.AI.

​

Data Model Update Procedure

Follow the next steps:

1. Access Kibana: Start by connecting to Kibana and locate the data model index, which is typically named “process-data-model.”

2. Open Kibana Devtools: Navigate to Kibana → Devtools. In the Console tab, you should proceed with the following steps.

3. Check Index Documents: Copy and paste the following script into the left-hand window, replacing any existing content, and then execute it. This script will retrieve the existing documents in the index to validate that the index name is correct.

GET process-data-model/_search
{
  "query": {
    "match_all": {}
  }
}

4. Update Documents: Replace any existing content in the left window with the following script, and then run it. This script updates the documents in the index by adding a new attribute, “processDefinitionVersionId,” with the same value as “processDefinitionId.”

POST process-data-model/_update_by_query?wait_for_completion=false
{
    "query": {
        "match_all": {}
    },
    "script": {
        "source": "ctx._source.processDefinitionVersionId=ctx._source.processDefinitionId",
        "lang": "painless"
    }
}

5. Verify the Update: Re-run the script from step 3 to confirm that the new attribute, “processDefinitionVersionId,” has been added with the same value as “processDefinitionId.”

These steps will ensure a smooth migration of the data model index when deploying the new version.

​

Access rights for Fonts

In order to utilize the new fonts feature in the CMS microservice, it’s mandatory to configure the following access rights:

​

Markdown support

New lib added:

• marked@^5.0.0 refers to a specific version of the “marked” library or package in the npm ecosystem. “marked” is an open-source JavaScript library used for parsing and rendering Markdown text into HTML.

To install the lib please make sure to run the following command:

npm install marked@^5.0.0

​

Timer events

Incorporating new Kafka Topics and Consumer Groups.

​

Admin

1. KAFKA_TOPIC_PROCESS_SCHEDULED_TIMER_EVENTS_OUT_SET:

   • Facilitates the transmission of scheduled message requests from the Admin microservice to the Scheduler.
   • Utilize when setting up scheduled messages for precise timing and orchestration.

2. KAFKA_TOPIC_PROCESS_SCHEDULED_TIMER_EVENTS_OUT_STOP:

   • Responsible for forwarding requests from the Admin microservice to the Scheduler to halt scheduled messages.
   • Utilize to cease previously scheduled messages for streamlined management.

3. KAFKA_TOPIC_PROCESS_START_FOR_EVENT_IN:

   • Enabling the initiation of process definitions that commence with a timer start event node.
   • Aids in the launch of process flows driven by time-based triggers.

​

Scheduler

1. KAFKA_TOPIC_PROCESS_SCHEDULED_TIMER_EVENTS_IN_SET:

   • Receives scheduled message setting requests from the Admin and Process engine microservices.
   • Utilized for setting up precise message scheduling with a focus on timing accuracy.

2. KAFKA_TOPIC_PROCESS_SCHEDULED_TIMER_EVENTS_IN_STOP:

   • Handles requests from the Admin and Process engine microservices to terminate scheduled messages.
   • Essential for promptly halting scheduled messages according to operational requirements.

3. KAFKA_TOPIC_AUDIT_OUT:

   • Introduction of audit functionality to the Scheduler microservice through Kafka.
   • Enables tracking and management of scheduling activities.

New consumer groups:

kafka:
  consumer:
    threads: 1
    scheduled-timer-events:
      threads: 1
      group-id: scheduled-timer-events
    stop-scheduled-timer-events:
      threads: 1
      group-id: stop-scheduled-timer-events

​

Process engine

1. KAFKA_TOPIC_PROCESS_SCHEDULED_TIMER_EVENTS_OUT_SET:

   • Sent to the scheduler for setting scheduled messages.

2. KAFKA_TOPIC_PROCESS_SCHEDULED_TIMER_EVENTS_OUT_STOP:

   • Sent to the scheduler for stopping scheduled messages.

New consumer groups:

kafka:
  consumer:
    threads: 1
    scheduled-timer-events:
      threads: 1
      group-id: scheduled-timer-events
    stop-scheduled-timer-events:
      threads: 1
      group-id: stop-scheduled-timer-events

​

New service account

A new service account has been introduced. This service account is essential for enabling the usage of the Start Timer Event node. Detailed information is available in the following section:

Service accounts

​

Scheduler: New timer-event-scheduler (Cron)

Introducing a new timer event scheduler designed to manage timer events. This scheduler scans for expired messages every second, processing batches of 100 messages per iteration. For situations with higher message volumes, the scheduler ensures thorough message consumption:

timer-event-scheduler:
  batchSize: 100 
  cronExpression: "*/1 * * * * *" #every 1 seconds

​

Scheduler: new recovery mechanism

flowx:
  timer-calculator:
    delay-max-repetitions: 1000000

• FLOWX_TIMER_CALCULATOR_DELAY_MAX_REPETITIONS - This means that, for example, if our cycle step is set to one second and the system experiences a downtime of two weeks, which is equivalent to 1,209,600 seconds, and we have the “max repetitions” set to 1,000,000, it will attempt to calculate the next schedule. However, when it reaches the maximum repetitions, an exception is thrown, making it impossible to calculate the next schedule. As a result, the entry remains locked and needs to be rescheduled. This scenario represents a critical case where the system experiences extended downtime, and the cycle step is very short (e.g., 1 second), leading to the inability to determine the next scheduled event.