SonataFlow extension in Quarkus Dev UI

Quarkus applications come integrated with a Dev UI, providing a number of tools that help in developing the applications in Quarkus. You can plug in such tools to your Quarkus application as extensions, such as SonataFlow extension.

Installing SonataFlow Dev UI extension

The SonataFlow Dev UI extension provides a console to view, manage, and start the workflow instances.

Prerequisites
  • Quarkus 3.2.9.Final is installed.

  • Quarkus command line interface (CLI) is installed. For more information, see Installing the Quarkus CLI.

Procedure
  1. In a command terminal, enter the following command to install the SonataFlow Dev UI extension:

    Install SonataFlow Dev UI extension
    quarkus ext add org.kie.kogito:kogito-quarkus-serverless-workflow-devui

    Executing the previous command adds the following dependency to pom.xml file of your project:

    SonataFlow Dev UI extension dependency in pom.xml file
    <dependency>
      <groupId>org.apache.kie.sonataflow</groupId>
      <artifactId>sonataflow-quarkus-devui</artifactId>
    </dependency>
  2. Enter the following command to add the kie-addons-quarkus-source-files extension that provides the source code to generate the Serverless Workflow diagram in the consoles:

    Install Kogito source files add-on extension
    quarkus ext add org.kie.kogito:kie-addons-quarkus-source-files

    Executing the previous command adds the following dependency to pom.xml file of your project:

    source files add-on dependency in pom.xml file
    <dependency>
      <groupId>org.kie</groupId>
      <artifactId>kie-addons-quarkus-source-files</artifactId>
    </dependency>
  3. Run the following command to start the Quarkus application:

    Start Quarkus application
    quarkus dev
  4. To access the Quarkus Dev UI, go to http://localhost:8080/q/dev/.

    kogito swf tools quarkus dev ui
    Figure 1. SonataFlow extension in Quarkus Dev UI

    The SonataFlow Dev UI extension contains the following pages:

Found an issue?

If you find an issue or any misleading information, please feel free to report it here. We really appreciate it!