Open Excel

Opens an existing Excel file and returns a file descriptor for subsequent operations. This node supports password-protected files and can optionally share the same Excel application instance for files with cross-references (like VLOOKUP to another workbook).

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 the node.
• Continue On Error - Automation will continue regardless of any error. The default value is false.

info

If ContinueOnError property is true, no error is caught when the project is executed even if the Catch node is used.

Input

• Path - Full path to the Excel file to open (e.g., C:\Documents\data.xlsx).
• In File Descriptor - (Optional) Input file descriptor to open the Excel file within the same Excel application instance. This is necessary when an Excel file has VLOOKUP or other references to another Excel file, and both need to be opened by the same instance.

Output

• Out File Descriptor - File descriptor for the opened Excel file. This identifier is used by all subsequent Excel nodes to reference this file.

Options

• Visible - Whether to display the Excel application window. Default is true.
  • true - Excel window is visible (useful for debugging)
  • false - Excel runs in the background (better for automation performance)
• Update Links - Whether to update external links when opening the file. Default is false.
  • true - Updates links to external workbooks automatically
  • false - Does not update external links
• Password To Open - Password required to open the file if the file is password-protected.
• Password To Modify - Password required to modify the file if the file has write protection.

Example

Opening a simple Excel file:

// The file descriptor will be stored in message.excel_fd
// Path: C:\Data\sales_report.xlsx

Opening a password-protected file:

// Path: C:\Data\confidential.xlsx
// Password To Open: Use a credential vault entry

Opening multiple files with cross-references:

// First file (contains source data)
// Path: C:\Data\source.xlsx
// Out File Descriptor: excel_fd

// Second file (has VLOOKUP to first file)
// Path: C:\Data\report.xlsx
// In File Descriptor: message.excel_fd (from first Open Excel)
// This ensures both files use the same Excel instance

Tips

• Always store the file descriptor in a variable (default is message.excel_fd) to use in subsequent Excel nodes.
• When opening multiple files that reference each other, use the In File Descriptor input to share the same Excel application instance.
• Set Visible to false for better performance in production automations.
• Use the Update Links option when your file depends on external data sources that need to be current.

Common Errors

Error	Solution
File not found	Verify the full path is correct and the file exists
Invalid password	Check that the password credential is correct
File is already open	Close the file manually or use a different Excel instance
Microsoft Excel is not installed	This package requires Microsoft Excel to be installed on Windows