Skip to main content

OutputData

OutputData Node Documentation

Overview​

The OutputData node is the final step in your TheoBuilder workflow that captures and formats the results of your automation process. Think of it as the "delivery mechanism" that takes all the work your workflow has done and presents it in the format you need - whether that's for display to users, saving to a database, or passing to another system.

This node is essential for any workflow where you need to collect, format, and output the final results of your automation process.

When to Use This Node​

Use the OutputData node when you need to:

  • Capture Final Results: Collect the end result of your workflow processing
  • Format Output Data: Structure your results in a specific format for display or storage
  • Control Data Flow: Determine exactly what information gets passed out of your workflow
  • Create Reports: Generate formatted summaries of your workflow's processing
  • Prepare Data for Export: Format results for integration with other systems

Configuration Parameters​

Output Data Content​

  • Field Name: data
  • Type: Rich text editor with dialog option
  • Default Value: \{\{Out\}\} (captures all workflow output)
  • Simple Description: The content and format of your final output data
  • When to Change This: Customize when you need specific formatting, want to include only certain data fields, or need to structure output for particular systems
  • Business Impact: Proper output formatting ensures your workflow results are immediately usable and don't require manual reformatting

Configuration Options:

  • Quick Edit: Make simple changes directly in the main form
  • Advanced Editor: Click "Open in Dialog" for a full-screen editor with syntax highlighting and advanced formatting tools

String Compiler​

  • Field Name: stringCompiler
  • Type: Dropdown menu with options:
    • botx_str_compiler: Standard text processing with variable replacement
    • handlebars: Advanced template processing with loops and conditionals
    • mustache: Simple template processing for basic variable substitution
  • Default Value: botx_str_compiler
  • Simple Description: Controls how your output template processes variables and dynamic content
  • When to Change This: Use handlebars for complex formatting with lists or conditional content, mustache for simple variable replacement, or keep default for standard processing
  • Business Impact: The right compiler ensures your output displays correctly and can handle the complexity of your data structure

Flow Options (Advanced Settings)​

Suppress Skipped Execution​

  • Field Name: flowOptSuppSkippedExec
  • Type: Checkbox (On/Off)
  • Default Value: Off
  • Simple Description: Controls whether this node runs even when previous nodes were skipped
  • When to Change This:
    • Enable (On): When you always want output generated, regardless of workflow path taken
    • Keep Disabled (Off): When output should only generate if all previous steps completed normally
  • Business Impact: Ensures consistent output generation in complex workflows with conditional branches

Allow Override​

  • Field Name: allowOverride
  • Type: Checkbox (On/Off)
  • Default Value: Off
  • Simple Description: Permits other workflow components to modify this node's output
  • When to Change This:
    • Enable (On): When you want flexibility for downstream processes to adjust the output
    • Keep Disabled (Off): When you want to guarantee the output format remains exactly as configured
  • Business Impact: Provides flexibility for dynamic workflows while maintaining control over output consistency

Step-by-Step Configuration​

Setting Up Basic Output​

  1. Add the Node:

    • Drag the OutputData node from the node panel onto your workflow canvas
    • Connect it to the final processing node in your workflow using the arrow connector

  2. Configure Output Content:

    • The default setting \{\{Out\}\} captures all workflow results
    • To customize, click in the output data field
    • For simple changes, edit directly in the field
    • For complex formatting, click "Open in Dialog" for the advanced editor

  3. Choose String Compiler:

    • Open the "String Compiler" dropdown
    • Select "botx_str_compiler" for standard processing (recommended for most users)
    • Choose "handlebars" if you need loops or conditional formatting
    • Select "mustache" for simple variable replacement only

  4. Set Flow Options (if needed):

    • Expand the "Flow Options" accordion
    • Check "Suppress Skipped Execution" if you always want output generated
    • Check "Allow Override" if other components should be able to modify the output

  5. Test Your Configuration:

    • Use the workflow test feature to verify your output appears correctly
    • Check that all expected data is included and properly formatted
    • Verify the output meets your business requirements

Real-World Use Cases​

Customer Service Report Generation​

Business Situation: A customer service team needs daily reports showing ticket resolution statistics, customer satisfaction scores, and agent performance metrics.

What You'll Configure:

  • Set output data to include ticket counts, resolution times, and satisfaction ratings
  • Choose "handlebars" compiler to create formatted tables and charts
  • Enable "Suppress Skipped Execution" to ensure reports generate even if some data sources are unavailable
  • Format output as HTML for email delivery or PDF generation

What Happens: Every day at 5 PM, the workflow generates a comprehensive report with charts and tables, automatically formatted and ready for management review.

Business Value: Saves 2 hours daily of manual report compilation and ensures consistent, professional reporting format.

E-commerce Order Confirmation​

Business Situation: An online store needs to generate formatted order confirmations that include customer details, itemized purchases, shipping information, and payment confirmation.

What You'll Configure:

  • Create output template with customer name, order items, totals, and shipping details
  • Use "botx_str_compiler" for reliable variable replacement
  • Keep "Allow Override" disabled to ensure consistent order confirmation format
  • Structure output for both email display and PDF generation

What Happens: When customers complete purchases, they receive professionally formatted order confirmations with all relevant details clearly presented.

Business Value: Reduces customer service inquiries by 40% and increases customer confidence in order processing.

Marketing Campaign Results Dashboard​

Business Situation: A marketing team needs to compile campaign performance data from multiple sources into a single, formatted dashboard view.

What You'll Configure:

  • Combine data from email opens, click rates, conversion tracking, and social media metrics
  • Use "handlebars" compiler to create conditional formatting based on performance thresholds
  • Enable "Suppress Skipped Execution" to show available data even if some sources are offline
  • Format output as JSON for dashboard integration

What Happens: Campaign managers get real-time, formatted performance summaries that highlight successes and areas needing attention.

Business Value: Enables data-driven decision making and reduces campaign analysis time from hours to minutes.

Industry Applications​

Healthcare Organizations​

Common Challenge: Medical practices need to compile patient visit summaries, treatment plans, and follow-up instructions into standardized formats for patient records and insurance documentation.

How This Node Helps: Automatically formats clinical data into required templates for different purposes - patient summaries, insurance claims, and regulatory reporting.

Configuration Recommendations:

  • Use "botx_str_compiler" for reliable medical data processing
  • Enable "Suppress Skipped Execution" to ensure documentation is always generated
  • Keep "Allow Override" disabled to maintain compliance with medical documentation standards
  • Structure output to meet HIPAA and regulatory formatting requirements

Results: Reduces documentation time by 60% while ensuring consistent, compliant medical record formatting.

Financial Services​

Common Challenge: Banks and financial institutions need to generate various reports and statements with precise formatting for regulatory compliance and customer communication.

How This Node Helps: Creates consistently formatted financial reports, account statements, and compliance documents that meet regulatory standards.

Configuration Recommendations:

  • Choose "handlebars" compiler for complex financial calculations and conditional formatting
  • Disable "Allow Override" to ensure regulatory compliance
  • Use "Suppress Skipped Execution" for critical reporting that must always complete
  • Format output for both digital delivery and print requirements

Results: Ensures 100% compliance with financial reporting standards while reducing manual formatting work by 75%.

Manufacturing Operations​

Common Challenge: Manufacturing companies need to compile production data, quality metrics, and inventory levels into actionable reports for different departments.

How This Node Helps: Transforms raw operational data into formatted reports tailored for production managers, quality control, and inventory teams.

Configuration Recommendations:

  • Use "handlebars" compiler to create department-specific views of the same data
  • Enable "Suppress Skipped Execution" to ensure reports generate even during equipment downtime
  • Allow override for flexible reporting during special production runs
  • Format output for both dashboard display and printed shift reports

Results: Improves production visibility by 50% and reduces report preparation time from 3 hours to 15 minutes daily.

Best Practices​

Output Template Design​

  • Start Simple: Begin with the default \{\{Out\}\} template and customize gradually
  • Test Frequently: Use the dialog editor to preview your output formatting before saving
  • Plan for Missing Data: Design templates that handle cases where some data might be unavailable
  • Consider Your Audience: Format output appropriately for who will be viewing or using it

Compiler Selection​

  • Use botx_str_compiler for most business applications - it's reliable and handles standard variable replacement well
  • Choose handlebars when you need conditional formatting, loops, or complex data structures
  • Select mustache only for very simple variable replacement in legacy systems

Performance Optimization​

  • Keep Templates Focused: Include only the data you actually need in your output
  • Use Appropriate Compilers: Don't use complex compilers for simple variable replacement
  • Test with Real Data: Verify performance with actual data volumes, not just test data

Error Prevention​

  • Validate Templates: Always test your output templates with sample data before deploying
  • Handle Missing Variables: Design templates that gracefully handle missing or null data
  • Document Your Format: Keep notes about your output structure for future maintenance

Troubleshooting Common Issues​

Output Not Displaying Correctly​

  • Check Template Syntax: Verify that variable names match exactly with your workflow data
  • Test Compiler Choice: Try switching between compilers if formatting isn't working as expected
  • Review Data Structure: Ensure your template matches the actual structure of incoming data

Missing Data in Output​

  • Verify Connections: Ensure the OutputData node is properly connected to your data sources
  • Check Variable Names: Confirm that variable references in your template match the actual data field names
  • Test Data Flow: Use workflow testing to verify data is reaching the OutputData node correctly

Performance Issues​

  • Simplify Templates: Complex formatting can slow down output generation
  • Optimize Data Selection: Include only necessary data in your output template
  • Consider Compiler Impact: Handlebars processing takes more time than simple variable replacement

The OutputData node is your workflow's final presentation layer - invest time in getting the formatting right, and your automated processes will deliver professional, immediately usable results that save time and improve business operations.