Skip to main content

Usage

Workflows are currently developed and debugged using a specific workflow editor.

Workflow Creation​

Access the workflow creation entry to start the workflow creation process. During creation, you can choose to create using a template or directly create a blank workflow.

Using templates to create workflows enables rapid completion of workflow creation for specific application scenarios, and allows for subsequent adjustments based on the created workflows to adapt and integrate with actual business functions.

After creating a blank workflow, you need to first select the trigger node of the workflow and determine the trigger method. After completing the trigger node selection, you can proceed to subsequent process editing and configuration.

Workflow Editing​

In the workflow editor, the main canvas provides capabilities for arranging nodes and editing processes. The right sidebar enables adding new nodes and configuring selected nodes.

In the main canvas, nodes can be moved and arranged by dragging them, and the process can be configured by dragging the connection lines between nodes.

When no node is selected, the right sidebar provides nodes that can be added. New nodes can be added by selecting and dragging them to the main canvas.

Debug Workflow​

Workflow debugging can be divided into full-process debugging and node debugging. Full-process debugging is initiated via the process debugging button above the editor, and node debugging is initiated by selecting a single node and then clicking the node debugging button.

During workflow debugging or node debugging, the workflow runs in the debug environment without affecting the published workflow. Meanwhile, all modifications, edits, and debugging of the workflow are performed in the debug environment and will not alter the configuration of the published workflow.

Debug Workflow​

When initiating process debugging, the trigger method for the workflow will be provided, and corresponding debugging startup methods will be offered based on different trigger methods. When the trigger method is an http request, the request instructions or CURL command for triggering this debugging session will be provided.

When the workflow is triggered in debug mode, it will complete the full process execution and use the debug input parameters as the workflow's input parameters for execution.

After the workflow debugging execution is completed, the operation status and execution path of the nodes will be displayed. If there are workflow branches, the actual execution branch path during debugging will also be shown.

Debugging Nodes​

In addition to initiating process debugging, each node in the workflow can also be debugged individually. Individually initiated node debugging will only run the current node. If the current debug node depends on outputs from other nodes in the workflow, you can first debug the corresponding nodes to generate outputs before debugging the currently required node.

When debugging workflows or nodes, you can view the output content of the nodes to understand their actual operation status and determine whether the output is correct.

Publish Workflow​

After completing the editing and debugging of the workflow, you can publish the workflow to the runtime environment via the publish operation in the upper right corner. During publishing, the platform will use the currently saved workflow configuration for the publish operation. After the publish operation, the trigger will become active and trigger the workflow based on requests, events, or scheduled times. The detailed working method of the trigger can be further understood from the trigger node introduction.

Release Version and Version History​

When a workflow is published, the latest version number is automatically generated and continuously incremented. During publishing, you can fill in a simple version description to record the relevant content or details of that version release.

After releasing a version, you can view the released versions through the version history in the upper right corner. In the published version history, you can view the version number, release time, and version description.

In the version history list, the specific version marked as "Current Release Version" is the one currently in effect for the release.

Published versions can perform the following operations:

  • Re-release: Re-release the operated version to make it effective. The current release version will point to the specific operated version. You can use this operation to roll back to a historical version after release.
  • Copy to Development Canvas: Copy the configuration content of the operated version to the current development canvas. The current development canvas content will be overwritten. This operation can be used when you need to resume development on a specific version.
  • Delete Version: Delete the operated version. The current release version cannot be deleted.

Runtime Logs​

Published workflows can be monitored through runtime logs. Each trigger event of the workflow is recorded as a log set. The logs capture the execution sequence and results of each node, and any log output generated within nodes can also be accessed and viewed in the workflow runtime logs.