There are different possible options to integrate the Heex SDK to your project and connect to your dataflows.

We recommend using your API or middleware to connect your Agents (Monitor and Recorders) to your Dataflows, and keep them separated from your main process as standalone executables. You can do so by looking at the folder get-started and go from there. Either copy the folder into your build process or use it in the SDK location to start creating your agents.

Another alternative is to create and build your custom agents directly in your code and build processes.

  1. Option with CMake building tool

To link the HeexSDK in a CMake C++ project, add the following lines to your project:

  • Import the HeexSDK with a specified version (eg. 2.30.0). You may use these lines to integrate the Heex SDK into your project:
    set(HEEX_SDK_DIR ~/heex/)
    find_package(HeexCustomerSide 2.30.0 REQUIRED)

ℹ️ Info: You may use

The HEEX_SDK_DIR required flag to import the SDK from a specific directory.

  • Add the Heex SDK alias library target to your executable using the target_link_libraries command
    add_executable(myProgram main.cpp)
    target_link_libraries(myProgram PRIVATE HeexCustomerSide::HeexCustomerSide)
  1. If you are using CMake to build, contact us at contact@heex.io, we will provide you with a custom integration.