Connectors are the vital gateway to enhancing FlowX.AI’s capabilities. They seamlessly integrate external systems, introducing new functionalities by operating as independently deployable, self-contained microservices.
At its core, a connector acts as an anti-corruption layer. It manages interactions with external systems and crucial data transformations for integrations.
Connectors act as lightweight business logic layers, performing essential tasks:
Data Transformation: Ensure compatibility between different data formats, like date formats, value lists, and units.
Information Enrichment: Add non-critical integration information like flags and tracing GUIDs.
Create a Kafka Consumer: Follow this guide to configure a Kafka consumer for your Connector.
Create a Kafka Producer: Refer to this guide for instructions on setting up a Kafka producer.
Adaptable Kafka settings can yield advantageous event-driven communication patterns. Fine-tuning partition counts and consumers based on load testing is crucial for optimal performance.
Efficient Connector design within an event-driven architecture demands:
Incorporate all received Kafka headers in responses to ensure seamless communication with the FlowX Engine.
Here’s a basic setup example for a connector:
Follow these steps and check the provided code snippets to effectively implement your custom FLOWX connector:
quickstart-connector/src/main/resources/config/application.yml
):quickstart-connector/src/main/resources/config/application-kafka.yml
):If the connector needs to listen to multiple topics, ensure you add settings and configure a separate thread pool executor for each needed topic (refer to KafkaConfiguration
, you can find it at quickstart-connector/src/main/java/ai/flowx/quickstart/connector/config/KafkaConfiguration.java
).
Define Reply Topic: Determine the reply topic, aligning with the Engine’s topic pattern.
Adjust Consumer Threads: Modify consumer thread counts to match partition numbers.
quickstart-connector/src/main/java/ai/flowx/quickstart/connector/dto/KafkaRequestMessageDTO.java
.quickstart-connector/src/main/java/ai/flowx/quickstart/connector/dto/KafkaResponseMessageDTO.java
.Optional Configuration Steps:
Upon completion, your configuration files (application.yaml
and application-kafka.yaml
) should resemble the provided samples, adjusting settings according to your requirements:
And your Kafka configuration file (application-kafka.yaml
) should look like this:
For detailed setup instructions, refer to the Setting Up FLOWX.AI Quickstart Connector Readme:
Prerequisites:
To integrate and utilize the connector within FLOWX.AI Designer, follow these steps:
You can check another example of a more complex connector by checking the following repository:
Connectors are the vital gateway to enhancing FlowX.AI’s capabilities. They seamlessly integrate external systems, introducing new functionalities by operating as independently deployable, self-contained microservices.
At its core, a connector acts as an anti-corruption layer. It manages interactions with external systems and crucial data transformations for integrations.
Connectors act as lightweight business logic layers, performing essential tasks:
Data Transformation: Ensure compatibility between different data formats, like date formats, value lists, and units.
Information Enrichment: Add non-critical integration information like flags and tracing GUIDs.
Create a Kafka Consumer: Follow this guide to configure a Kafka consumer for your Connector.
Create a Kafka Producer: Refer to this guide for instructions on setting up a Kafka producer.
Adaptable Kafka settings can yield advantageous event-driven communication patterns. Fine-tuning partition counts and consumers based on load testing is crucial for optimal performance.
Efficient Connector design within an event-driven architecture demands:
Incorporate all received Kafka headers in responses to ensure seamless communication with the FlowX Engine.
Here’s a basic setup example for a connector:
Follow these steps and check the provided code snippets to effectively implement your custom FLOWX connector:
quickstart-connector/src/main/resources/config/application.yml
):quickstart-connector/src/main/resources/config/application-kafka.yml
):If the connector needs to listen to multiple topics, ensure you add settings and configure a separate thread pool executor for each needed topic (refer to KafkaConfiguration
, you can find it at quickstart-connector/src/main/java/ai/flowx/quickstart/connector/config/KafkaConfiguration.java
).
Define Reply Topic: Determine the reply topic, aligning with the Engine’s topic pattern.
Adjust Consumer Threads: Modify consumer thread counts to match partition numbers.
quickstart-connector/src/main/java/ai/flowx/quickstart/connector/dto/KafkaRequestMessageDTO.java
.quickstart-connector/src/main/java/ai/flowx/quickstart/connector/dto/KafkaResponseMessageDTO.java
.Optional Configuration Steps:
Upon completion, your configuration files (application.yaml
and application-kafka.yaml
) should resemble the provided samples, adjusting settings according to your requirements:
And your Kafka configuration file (application-kafka.yaml
) should look like this:
For detailed setup instructions, refer to the Setting Up FLOWX.AI Quickstart Connector Readme:
Prerequisites:
To integrate and utilize the connector within FLOWX.AI Designer, follow these steps:
You can check another example of a more complex connector by checking the following repository: