Skip to main content

Comment

This node adds a comment without impacting the flow of your automation.

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.

Options​

  • Text - Enter your markdown formatted comment.

How It Works​

The Comment node is a documentation tool that allows you to add explanatory notes to your automation workflow without affecting execution:

  1. The node accepts markdown-formatted text input
  2. During flow execution, the comment is stored but does not perform any operations
  3. The flow continues immediately to the next node
  4. Comments appear in the visual flow designer for documentation purposes

Requirements​

  • None - this is a passive node that requires no external resources or configuration

Usage Examples​

Example 1: Documenting Workflow Sections​

Use comments to separate and document different sections of your workflow:

Comment: "## Data Extraction Phase
This section handles extracting customer data from the Excel file.
Variables used:
- customerList: Array of customer objects
- processedCount: Number of records processed"

Example 2: Adding TODO Notes​

Leave reminders for future improvements:

Comment: "### TODO
- Add error retry logic for API calls
- Implement data validation before processing
- Add logging for audit trail"

Example 3: Explaining Complex Logic​

Document complex business logic for team members:

Comment: "**Business Rule**:
If customer type is 'Premium' AND order total > $1000,
apply 15% discount. Otherwise, use standard 5% discount.
Reference: Policy Document v2.3"

Usage Notes​

  • Comments support full markdown syntax including headers, lists, bold, italic, and code blocks
  • Comments are visible in the flow designer but do not appear in execution logs
  • Use comments liberally to make your automation easier to understand and maintain
  • Comments do not consume significant processing time or resources

Tips​

  • Use markdown headers (##, ###) to create visual hierarchy in your comments
  • Add comments before complex node sequences to explain the overall purpose
  • Document variable names and their purposes for better code maintenance
  • Include references to business requirements or policy documents
  • Use bullet points for listing multiple related items
  • Consider adding timestamps or version numbers for important workflow changes
  • Log - For runtime logging that appears in execution logs
  • Sub Flow - For organizing complex workflows into reusable components