Integration management helps you configure integrations between the following components, FlowX Engine, plugins or different adapters.
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.
Integrations are used with the following nodes: task nodes, user task nodes, send message task, and receive message task.
You can easily create or import an integration using the Integration management feature just by accessing FLOWX Designer → Integration management.
To access Integration management:
For more details on how to configure access rights for Integrations Management, check the following section:
Configuring access rights for Integration Management
To create a new integration, see the steps described in Accessing Integration management, then follow the next steps:
After you added a new integration, you can configure scenarios by following the next steps:
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:
Send scenario:
Receive scenario:
Topics are defined depending on the environment where you want to use them. You need to configure the following details:
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:
The following details need to be configured:
Property name - the name of the property types:
Description - description of the input
Example value - example value based on the type of the input
Mandatory - could be mandatory or not
All integrations have processInstanceId
as a default header parameter.
If you have actions that contain callbacks, multiple headers can be added, like the action name or the name of the node.
Headers may also contain Kafka authorization (token in the header).
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:
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.