Subscribe

UiPath Activities

The UiPath Activities Guide

Use Excel File

UiPath.Excel.Activities.Business.ExcelApplicationCard

Lets you select an Excel file to use in the automation and enables StudioX to integrate with Excel. The data in the file is available to all the activities added inside Use Excel File. This means that when you configure child activities, you can select data from the file directly from StudioX. If the Excel file does not exist at the time you design the automation, you can define an existing Excel file with the same structure as a template for use at design time.

📘

Note:

If you use a file with the .xls extension, all activities supported by Excel for .xls files will work at runtime. However the contents of the file are not available for selection directly from the Plus plus buttonplus button menu when creating the automation in the designer. To select data from the file, either use the Indicate in Excel and Custom Input options, or save a .xlsx copy of the file and add it as a Template file.

To learn how to use this activity, see:

Configuring the Activity

In the Body of the Activity

  • Excel file - Click Browse browse filesbrowse files next to the field, and then browse to and select an Excel file to use in the automation. To create a new file when the automation is executed, browse to the folder where to create it and enter the file name.
    If you need to work with a file with a dynamic name, such as a file downloaded daily under a different name, you can provide the file path using one of the options in the Plus plus buttonplus button menu on the right side of the field. For example, select a cell in the Project Notebook where the file path can be extracted daily using the provided formulas, or select Ask when run to enter the path of the file when executing the project. In this situation, if you want to be able to easily configure the activities that use data from the file, select another Excel file with the same format as a Template file.
  • Reference as - Enter a name by which to refer to the file in the automation project.
  • Save changes - Select this option if you want the file to be saved after all the activities added inside Use Excel File are completed. Otherwise, the file is returned to the initial state after child activities are executed. This option is selected by default.
    When the option to save changes is disabled, the message save off is displayed next to the Excel resource in the Data Manager panel.
  • Create if not exists - If selected, a new Excel workbook is created if the workbook is not found at the specified path. If not selected, an error occurs if the workbook is not found at the specified path. This option is selected by default.
  • Template file - If the Excel file you want to automate is dynamic or does not exist at the time you design the automation (for example, the file is downloaded or created by the automation), select this option to use another Excel file that has the same structure at design time.
    The data in this file is available for selection from the Plus plus buttonplus button menu, allowing you to easily configure the activities added inside Use Excel File. The template file is used only at design time. When the automation is executed, it processes the file defined in the Excel file field.

In the Properties Panel

Common

  • DisplayName - The name displayed for the activity in the Designer panel.

File

  • Edit password - The password required for editing the Excel workbook, if the file is password-protected.
  • Password - The password required for opening the Excel workbook, if the file is password-protected.
  • Workbook path - The path to the Excel file. If the file does not exist and you select the CreateNewFile option, StudioX creates the file.

Misc

  • Private - If selected, the data used in the activity is not logged by StudioX.

Options

  • Create if not exists - See the description in the body of the activity.
  • Read-only - If selected, the specified workbook is opened 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. This option is not selected by default.
  • Save changes - See the description in the body of the activity.

Updated 2 months ago



Use Excel File


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.