SystemNotification Node Documentation

Overview

The SystemNotification node is part of the ComfyUI-Custom-Scripts collection. This node is designed to send a system notification via the browser when it gets executed. It acts as an alert for the user, making it useful for various ComfyUI workflows where user attention is required after specific tasks are completed.

Node Functionality

What the Node Does

The SystemNotification node sends a browser-based notification to the system. This notification can be triggered after each prompt or only when the processing queue is empty. It allows users to remain informed of the progress or status of their workflows without needing to constantly monitor the user interface.

Inputs

The node accepts the following inputs:

1. Message (STRING)

   • This is a customizable text message that will appear in the notification. By default, it is set to "Your notification has triggered."

2. Mode

   • This input determines when the notification should be triggered.
   • Options include:
     • Always: Sends the notification after each prompt.
     • On Empty Queue: Sends the notification only when the queue is empty.

3. Wildcard Input

   • This input is a versatile placeholder used to integrate and align the node with other components in the ComfyUI environment.

Outputs

The node produces the following outputs:

1. Wildcard Output
   • This acts as a general connector, allowing the node to fit seamlessly into workflows without changing the behavior of other nodes.

Return Types

• The node's primary output is a special wildcard type, allowing it to interact flexibly within the workflow.

Usage in ComfyUI Workflows

The SystemNotification node is versatile and can be employed in workflows where user notifications are needed:

• Task Completion Alerts: Use the node to notify users when a specific task or set of tasks is completed in the workflow, ensuring they can act on results as soon as they are available.

• Status Updates: Integrate the node to send regular updates, particularly in workflows that may be lengthy, so that users are informed of the ongoing process's status.

• Queue Monitoring: Set the node to notify users when all tasks in a queue have been processed, which is particularly useful in automation workflows where manual intervention or inspection is required after processing.

Special Features and Considerations

• Notification Behavior: The node sends notifications directly through the browser, so make sure that browser notifications are enabled for the most effective use of this node.

• Customizable Messages: The ability to customize the notification message allows for personalized alerts, making them more relevant and informative based on the specific workflow requirements.

• Flexible Execution Modes: The two execution modes (Always and On Empty Queue) provide flexibility in configuring when notifications are sent, which can help reduce unnecessary alerts and ensure notifications are only received when truly needed.

• Integration with ComfyUI: The SystemNotification node is designed to integrate smoothly within existing ComfyUI workflows, thanks to its wildcard input and output, which ensures compatibility with a wide range of nodes and setups.

By leveraging the SystemNotification node, users can enhance their workflows with timely alerts and notifications, improving efficiency and ensuring they remain updated on the status of their tasks within ComfyUI.