Skip to main content

Progress

Displays a progress indicator widget in chat interfaces.

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

If the ContinueOnError property is true, no error is caught when the project is executed, even if a Catch node is used.

Inputs​

  • Session Id - Unique identifier for the UI client connection.
  • Progress Id - Unique identifier for the Progress Widget.
  • Title - Title of the progress indicator.
  • Description - Description of the progress indicator.

Options​

  • None

Output​

  • Progress Id - Unique identifier for the Progress Widget.

How It Works​

The Progress node creates a progress indicator widget that shows the status of a process. When executed, the node:

  1. Validates the provided Session ID, Title, and Description
  2. Retrieves the session information for the provided ID
  3. Creates a progress widget with the specified title, description, and progress ID
  4. Sends the widget to the client with the specified session ID
  5. Waits for a response from the client
  6. Parses the response as JSON
  7. Returns the widget ID as the output

Requirements​

  • A valid session ID for an active client connection
  • Valid title and description for the progress indicator
  • Properly configured client interface that can display progress widgets

Error Handling​

The node will return specific errors in the following cases:

  • Empty or invalid Session ID
  • Session not found for the provided ID
  • Title is required but not provided or empty
  • Description is required but not provided or empty
  • Failed to send widget to client
  • Timeout while waiting for client response
  • Failed to parse client response as JSON
  • Failed to set result

Usage Notes​

  • The Session ID must match an active client connection
  • The Progress Id input allows you to reference an existing progress widget
  • The Title and Description fields help users understand what process is being tracked
  • The output Progress Id can be used to reference this specific progress widget in other nodes
  • Progress widgets are typically used to indicate that a background process is running