Skip to main content

SaveToFile

SaveToFile Node Documentation

Overview​

The SaveToFile node allows you to automatically save data from your workflow to files on your system. This powerful node can collect data over time and save it all to one file, or create separate files for each piece of data that flows through your workflow. It's perfect for creating reports, backing up data, or generating files for other systems to use.

Key Features​

  • Flexible File Writing: Choose to accumulate all data in one file or create separate files for each data item
  • Multiple Output Formats: Save data as plain text, structured JSON, or CSV spreadsheets
  • Dynamic File Naming: Use data from your workflow to automatically name files and folders
  • Data Selection: Choose specific parts of your data to save, or save everything

Configuration Parameters​

Data Source Settings​

File Writer Mode

  • Field Name: fileWriterModeId
  • Type: Dropdown menu with options:
    • Accumulate input data into a file: Adds all incoming data to a single file, building up content over time
    • Write each input data into a separate file: Creates a new file for every piece of data that comes through
  • Default Value: Accumulate input data into a file
  • Simple Description: Controls whether you create one growing file or many individual files
  • When to Change This: Choose "separate files" when you need individual records (like customer reports), or "accumulate" when building comprehensive logs or datasets
  • Business Impact: Accumulating data creates consolidated reports, while separate files enable individual processing and organization

Property Name

  • Field Name: valueGetter
  • Type: Smart text field (supports dynamic data)
  • Default Value: Empty (saves entire data object)
  • Simple Description: Specifies which part of your data to save to the file
  • When to Change This: When you only want to save specific information like customer names, order totals, or email addresses instead of all available data
  • Business Impact: Focusing on specific data creates cleaner, more targeted files and reduces file sizes

Output Settings​

Directory Path

  • Field Name: directoryPath
  • Type: Smart text field (supports dynamic data)
  • Default Value: Empty (saves to default location)
  • Simple Description: The folder location where your files will be saved
  • When to Change This: Organize files by department, date, or project by specifying different folder paths
  • Business Impact: Proper file organization improves data management and makes files easier to find and share

File Name

  • Field Name: fileName
  • Type: Smart text field (supports dynamic data)
  • Default Value: Empty (system generates name)
  • Simple Description: What to name your saved file
  • When to Change This: Create meaningful file names using customer names, dates, or report types for better organization
  • Business Impact: Descriptive file names save time when searching for specific data and prevent confusion

Output Format

  • Field Name: writeFormatId
  • Type: Dropdown menu with options:
    • Text: Saves data as plain text, readable by any text editor
    • JSON: Saves data in structured JSON format, ideal for technical systems
    • CSV: Saves data as a spreadsheet file, perfect for Excel and data analysis
  • Default Value: Text
  • Simple Description: The file format for your saved data
  • When to Change This: Use CSV for spreadsheet analysis, JSON for system integration, or Text for simple readable files
  • Business Impact: The right format ensures your files work with your intended tools and workflows

CSV Delimiter (Only appears when Output Format is set to CSV)

  • Field Name: csvDelimiter
  • Type: Text field
  • Default Value: , (comma)
  • Simple Description: The character used to separate columns in CSV files
  • When to Change This: Change to semicolon (;) for European Excel compatibility or tab for special formatting needs
  • Business Impact: Correct delimiters ensure your CSV files open properly in Excel and other spreadsheet applications

Option

  • Field Name: outTransformId
  • Type: Dropdown menu with options:
    • Pass Input Data: Sends the original input data to the next node unchanged
  • Default Value: Pass Input Data
  • Simple Description: Controls what data flows to the next node in your workflow
  • When to Change This: Currently only one option available - keeps data flowing through your workflow
  • Business Impact: Ensures your workflow continues processing data after saving files

Real-World Use Cases​

Customer Order Export System​

Business Situation: An online retailer wants to automatically save all daily orders to a CSV file for accounting review and inventory management.

What You'll Configure:

  • Set File Writer Mode to "Accumulate input data into a file"
  • Enter "Daily_Orders_{{currentDate}}" in the File Name field
  • Choose "CSV" from the Output Format dropdown
  • Set Directory Path to "Reports/Daily_Orders"
  • Leave CSV Delimiter as comma

What Happens: Each order automatically gets added to a daily CSV file that your accounting team can open in Excel for review and processing.

Business Value: Eliminates manual data export tasks, ensures no orders are missed, and provides ready-to-use spreadsheets for financial analysis.

Individual Customer Report Generation​

Business Situation: A consulting firm needs to create separate PDF-ready reports for each client containing their monthly performance data.

What You'll Configure:

  • Set File Writer Mode to "Write each input data into a separate file"
  • Enter "{{clientName}}Monthly_Report{{month}}" in the File Name field
  • Choose "Text" from the Output Format dropdown
  • Set Directory Path to "Client_Reports/{{month}}"
  • Set Property Name to "reportContent" to save only the formatted report text

What Happens: Each client gets their own individual report file, automatically organized by month in separate folders.

Business Value: Saves hours of manual report generation, ensures consistent formatting, and creates professional deliverables for client billing.

System Integration Data Backup​

Business Situation: A healthcare practice needs to backup patient appointment data in a format that their billing system can import if needed.

What You'll Configure:

  • Set File Writer Mode to "Accumulate input data into a file"
  • Enter "Patient_Appointments_Backup_{{timestamp}}" in the File Name field
  • Choose "JSON" from the Output Format dropdown
  • Set Directory Path to "Backups/Appointments"
  • Leave Property Name empty to save all appointment data

What Happens: All appointment data gets saved in a structured JSON format that can be easily imported into other systems if needed.

Business Value: Provides reliable data backup, ensures HIPAA compliance through proper data handling, and enables system recovery capabilities.

Step-by-Step Configuration​

Adding the Node​

  1. Drag the SaveToFile node from the left panel onto your workflow canvas
  2. Connect it to the previous node using the arrow connector
  3. Click on the SaveToFile node to open the configuration panel

Configuring Data Source​

  1. In the "Data Source" section, select your File Writer Mode:
    • Choose "Accumulate" for building one comprehensive file
    • Choose "Write each" for creating individual files per data item
  2. If you only want to save specific data, enter the property name in the "Property Name" field
  3. Leave "Property Name" empty to save all available data

Setting Up Output Options​

  1. In the "Output" section, enter your desired folder path in "Directory Path"
  2. Type your file name in the "File Name" field (you can use dynamic data like dates or customer names)
  3. Select your preferred format from the "Output Format" dropdown:
    • Text for simple, readable files
    • JSON for structured data
    • CSV for spreadsheet compatibility
  4. If you chose CSV format, adjust the "CSV Delimiter" if needed (comma works for most cases)
  5. Keep "Option" set to "Pass Input Data" to continue your workflow

Testing Your Configuration​

  1. Click the "Test Configuration" button to verify your settings
  2. Check that files are created in the expected location with the correct format
  3. Verify the file contents match your expectations
  4. Save your configuration when satisfied

Industry Applications​

Healthcare Organizations​

Common Challenge: Patient data needs to be exported for insurance claims, regulatory reporting, and backup purposes while maintaining HIPAA compliance.

How This Node Helps: Automatically exports patient records, appointment data, and billing information in the exact formats required by insurance companies and regulatory bodies.

Configuration Recommendations:

  • Use "Accumulate" mode for daily/monthly regulatory reports
  • Choose "JSON" format for system interoperability
  • Set Directory Path to "HIPAA_Compliant_Exports/{{reportType}}"
  • Use Property Name to exclude sensitive fields when appropriate

Results: Healthcare practices reduce manual export time by 85% and eliminate compliance errors through consistent, automated data handling.

E-commerce Businesses​

Common Challenge: Order data, inventory updates, and customer information need to be shared with accounting systems, fulfillment centers, and marketing platforms.

How This Node Helps: Creates properly formatted data files that integrate seamlessly with existing business systems and third-party services.

Configuration Recommendations:

  • Use "CSV" format for accounting system imports
  • Set File Writer Mode to "Accumulate" for daily sales reports
  • Choose "Write each" mode for individual order fulfillment files
  • Use dynamic file naming with dates and order numbers

Results: E-commerce companies see 60% faster order processing and 40% fewer data entry errors across their business systems.

Professional Services​

Common Challenge: Client reports, project data, and billing information must be organized and delivered in professional formats for different stakeholders.

How This Node Helps: Generates client-ready reports, project summaries, and billing exports automatically formatted for professional presentation.

Configuration Recommendations:

  • Use "Write each" mode for individual client deliverables
  • Choose "Text" format for report content that will be formatted later
  • Set Directory Path to organize by client and project
  • Use Property Name to extract specific report sections

Results: Professional services firms reduce report preparation time by 70% and improve client satisfaction through consistent, timely deliverables.

Best Practices​

File Organization​

  • Use descriptive folder structures like "Reports/{{Department}}/{{Year}}"
  • Include dates and timestamps in file names for easy sorting
  • Create separate folders for different data types or business units

Format Selection​

  • Choose CSV for data that will be analyzed in spreadsheets
  • Use JSON for data that needs to integrate with other systems
  • Select Text format for human-readable reports and logs

Performance Optimization​

  • Use "Accumulate" mode for high-volume data to avoid creating too many small files
  • Consider file size limits when accumulating large amounts of data
  • Implement regular cleanup processes for old files

Security Considerations​

  • Ensure directory paths point to secure, backed-up locations
  • Use Property Name to exclude sensitive information when creating shared files
  • Implement proper file permissions on saved directories

The SaveToFile node transforms your workflow data into organized, accessible files that integrate seamlessly with your existing business processes, saving time and reducing errors while maintaining professional standards.