Workflow Definitions in Kogito Serverless Workflow Tools extension

In Kogito Serverless Workflow Tools extension, the Workflow Definitions page displays the list of available workflow definitions, which are used to trigger the cloud events and start the workflow instances. Also, the Workflow Definitions page enables you to add filters to the workflow definitions list.

kogito swf tools workflow definitions
Figure 1. Workflow Definitions page

The table on the Workflow Definitions page displays the following details:

  • Workflow Name: Displays the name of a workflow definition.

  • Endpoint: Displays the URL to a workflow definition.

  • Actions: Provides a button to start a new workflow.

The filters on the Workflow Definitions page enables you to add filters to the table. To search for a specific workflow definition, enter the name of the workflow in the Filter by workflow name field and click Apply Filter button. The matching workflow definitions appear as a chip below the search field.

To clear the applied filters, you can click the Reset to default button. Also, to fetch newly added workflow definitions, click on the refresh icon next to the Apply Filter button.

kogito swf tools workflow definitions filter
Figure 2. Workflow Definitions filters

Start New Workflow page

The Start New Workflow page is used to start a workflow instance through a cloud event or a custom form, depending on the workflow configuration. To navigate to the Start New Workflow page, click the play button in the Actions column of the workflow definitions table.

If there is no JSON schema for the workflow, then the workflow is started by triggering a cloud event. To trigger a cloud event, you can use the *Cloud Event Type and Cloud Event Data input fields to set the type of a cloud event and event payload in JSON format respectively and click the Start button to start a workflow. The Reset button on the page resets the values entered in the given fields.

kogito swf tools trigger cloud events
Figure 3. Starting a workflow using a cloud event

If there is a JSON schema for the workflow configured in the dataInputSchema property, then a form is displayed to start a new workflow instance. You can fill in the required form details and click the Start button to trigger the workflow. The Reset button is used to clear the form data.

kogito swf tools trigger cloud events custom form
Figure 4. Starting a workflow using the form

You can also use the Business key text box to define a custom business key value to the workflow instance. If the Business Key field is blank, then an auto-generated business key is defined for the workflow instance.

When a workflow instance starts successfully, a success alert appears on the top of the screen, which contains a Go to workflow list option. The Go to workflow list option enables you to navigate to the Workflow Instances page.

kogito swf tools start workflow success alert
Figure 5. Example of trigger workflow success alert

If there is an issue while starting a workflow, then a failure alert appears on the top of the screen, containing View Details and Go to workflow list options. The View Details enables you to view the error message.

kogito swf tools start workflow fail alert
Figure 6. Example of trigger workflow failure alert

Found an issue?

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