Details

  • Name: stickyNote

  • Label: Sticky Note

  • Version: 2.0

  • Type: StickyNote

  • Category: Utilities

  • Tags: Utilities

Description

This node allows users to add a sticky note to their workflow. It’s useful for adding comments, explanations, or reminders directly within the workflow diagram.

Input Parameters

The node has a single input parameter:

LabelNameTypeRowsPlaceholderOptional
-notestring1Type something hereYes

The ‘note’ parameter is where users can enter the text they want to display on the sticky note.

Usage

To use the StickyNote node:

  1. Drag and drop it onto the workflow canvas.

  2. Enter the desired text in the ‘note’ field.

  3. The note will be displayed visually in the workflow, helping to annotate or explain parts of the process.

Technical Implementation

  • The node is implemented as a TypeScript class that implements the INode interface.

  • It doesn’t process any data or affect the workflow execution; it’s purely for visual and documentation purposes.

  • The init() method simply returns a new instance of the StickyNote class.

Use Cases

  • Adding explanations to complex parts of a workflow

  • Leaving reminders or TODOs within the workflow

  • Annotating the purpose of specific nodes or branches in the workflow

  • Providing context or background information for other users or collaborators

Notes

  • The StickyNote node is a non-functional node in terms of data processing. It does not alter the flow of data or perform any operations.

  • It’s particularly useful in large or complex workflows where additional context or explanations can improve understanding and maintainability.