Annotation Node - Synthreo Builder
Annotation node for Builder - add inline comments, instructions, and notes to your workflow canvas to document logic and guide collaborators without affecting workflow execution.
Purpose
Section titled “Purpose”The Annotation node provides a way to insert descriptive text, notes, or instructions directly on a workflow canvas. This node does not process data, execute logic, or affect workflow execution in any way. It is used exclusively for documentation and visual organization within the workflow editor.
Annotations help teams maintain shared understanding of workflow intent, configuration decisions, and maintenance notes without requiring external documentation.
Inputs
Section titled “Inputs”None. The Annotation node does not accept or process input connections from other nodes.
Outputs
Section titled “Outputs”None. The Annotation node does not emit any output or trigger downstream nodes.
Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| Text | Text area | No | (empty) | The note, instruction, or comment text to display on the workflow canvas. Supports multi-line text. |
How It Works
Section titled “How It Works”The Annotation node renders its text content as a visible label on the workflow canvas. It has no runtime behavior - when a workflow executes, the Annotation node is completely ignored by the execution engine. Only its visual presence on the canvas is relevant. You can place it anywhere on the canvas, resize it, and reposition it to suit the layout of your workflow.
When to Use Annotations
Section titled “When to Use Annotations”Annotations are most valuable in workflows that will be maintained, reviewed, or shared with other team members. Consider adding annotations when:
- A workflow contains non-obvious logic that benefits from an explanation of intent.
- Configuration decisions were made for specific reasons that may not be apparent from the node settings alone.
- A section of the workflow is undergoing changes or experimentation and needs to be flagged.
- The workflow is being handed off to another team member or reviewed by a stakeholder.
- You want to divide a complex workflow into labeled logical sections for easier navigation.
Step-by-Step (Quick Start)
Section titled “Step-by-Step (Quick Start)”- Add Annotation to your workflow canvas from the node panel.
- Click on the node to open its configuration and enter your note, instruction, or comment text.
- Optionally resize or reposition the annotation on the canvas to place it near the nodes it describes.
- Use multiple annotations to label different sections of your workflow.
- Save your workflow.
Best Practices
Section titled “Best Practices”- Use annotations for complex branches: When a workflow has conditional logic or multiple branching paths, place annotations near decision points to explain the conditions and expected behavior of each branch.
- Separate logical sections visually: Use annotations as section headers to group related nodes. For example, label a cluster of nodes as “Data Validation” or “API Submission” to make the workflow easier to navigate.
- Document configuration decisions: If a parameter value was set to something non-obvious (such as a specific folder path, a timeout value, or a transformation format), add an annotation explaining why that value was chosen.
- Flag work in progress: Use annotations to mark areas under active development or experimentation so other team members know to treat that section with care.
- Keep annotation text concise: Annotations are most useful when they deliver targeted information. Avoid long paragraphs - prefer bullet points or brief sentences that can be read at a glance.
- Update annotations when workflows change: Outdated annotations that describe old behavior are worse than no annotations. When modifying a workflow, review nearby annotations to confirm they still accurately describe the logic.
Real-World Use Cases
Section titled “Real-World Use Cases”- Workflow documentation: Describe the purpose of a node cluster, the expected inputs and outputs of a section, or the business rule being implemented.
- Team collaboration: Leave setup instructions, reminders about external dependencies, or notes about API keys and credentials needed for certain nodes.
- Debugging aid: Mark areas under review, flag nodes that are temporarily disabled for testing, or note known limitations in a section of the workflow.
- Onboarding: Add annotations that explain the overall workflow structure to help new team members understand the logic without needing a separate briefing.
- Change history context: Note the reason for a recent change or flag that a section was updated as part of a specific project or requirement.
Test Cases
Section titled “Test Cases”Not applicable. This node does not perform computations or produce measurable outputs. There is no runtime behavior to validate.
Related Nodes
Section titled “Related Nodes”No functional relationships exist between the Annotation node and other nodes. It is compatible with any workflow regardless of the other nodes present. Placement is at the discretion of the workflow author.