The only requirement is that they should connect to Kafka to communicate with the FlowX Engine. Communication is done through Kafka topics (handled by consumers and producers, see Kafka configuration section for more details).
Integration management enables you to keep track of each integration and its correspondent component and different scenarios used: creating an OTP, document generation, notifications, etc.After defining one integration (inside Integration management) you can open a compatible node and start using them.
You have multiple scenarios that you can configure on an integration. For example, for integration with the notification plugin, you can configure the following scenarios: generate email notification, generate email OTP, generate push notifications, etc.After you created a scenario you can configure the data model for it by following the next steps:
Select a scenario then click the eye icon to open the configuration.
SEND scenario: The message data model represents the content of the message that the adapters or plugins send to the FLOWX.AI Engine.RECEIVE scenario: The output data model represents the content of the message that FLOWX.AI Engine sends to the adapters or plugins.To configure a new message data model, follow the next steps:
Open FLOWX.AI Admin.
From the left-side menu, select Integration Management.
Select an integration.
Select the type of the scenario then click ”+” button.
The following details need to be configured:
Property name - the name of the property types:
STRING
NUMBER
BOOLEAN
OBJECT - you can add multiple values types inside an OBJECT
OBJECT_REF - used for values that are already defined in the process
ARRAY - for arrays you must specify the Item type
ARRAY_REF - used for values that are already defined in the process
ENUM - a special data type that enables for a variable to be a set of predefined constants
Description - description of the input
Example value - example value based on the type of the input
As mentioned earlier, you can use integrations management to configure integrations between FLOWX.AI Engine and different plugins and adapters. These configurations are defined so that when you create a process (and it is using Kafka-related activities) you will no longer have to manually search for suitable topics or environments. Use predefined integrations, that you have already configured, on different processes and nodes. Places where integrations will be used:
Node → Actions → Kafka Send Action (to send data to the integration)
Node → Node config → Data stream topics (the topic name where the process engine listens for the response)
Data stream topics are used to select the integration and the key on which the response is saved.
If your integration has scenarios that are already used in another process, you will always be notified.
Was this page helpful?
Assistant
Responses are generated using AI and may contain mistakes.