UiPath Activities Guide

Excel Application Scope

UiPath.Excel.Activities.ExcelApplicationScope

Opens an Excel workbook and provides a scope for Excel Activities. When the execution of this activity ends, the specified workbook and the Excel application are closed. If a WorkbookApplication variable is provided in the Output > Workbook property field, the spreadsheet is not closed after the activity ends. If the specified file does not exist, a new Excel file is created. This activity can only be used if the Microsoft Excel application is installed on your machine.

Properties

File

  • EditPassword - The password required for editing password protected Excel workbooks, if necessary. Only String variables and strings are supported.
  • Password - The password required for opening password protected Excel workbooks, if necessary. Only String variables and strings are supported.

Note:

Strings must be placed between quotation marks.

  • WorkbookPath - The full path of the Excel spreadsheet that you want to use. If the Excel file to be used is located in the project folder, its relative path can be used. Only String variables and strings are supported.

Note:

Strings must be placed between quotation marks.

Options

  • AutoSave - Automatically saves the workbook on each change caused by an activity. If disabled, the changes will not be saved when the execution of the Excel Application Scope ends. By default, this checkbox is selected.
  • Create New File - When selected, if the workbook cannot be found at the specified path, a new Excel workbook is created with the name specified in the WorkbookPath property field. When cleared, if the workbook cannot be found at the specified path, an exception is thrown, informing the user. By default, this checkbox is selected.
  • Read-Only - Opens the specified workbook in Read-Only mode. Selecting this check box enables you to perform data extraction operations in an Excel file which is locked for editing or has an edit password. By default, this check box is not selected.
  • Visible - When selected, the Excel file is opened in the foreground while performing actions on it. When it is cleared, all operations are done in the background.

Output

  • Workbook - The entire information from the Excel spreadsheet stored in a WorkbookApplication variable. This variable can be used in another Excel Application Scope activity. Only WorkbookApplication variables are supported.

Use Existing Workbook

  • ExistingWorkbook - Use the data from an Excel file that was previously stored in a WorkbookApplication variable. Only WorkbookApplication variables are supported.

Common

  • DisplayName - The display name of the activity.

Misc

  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.