Read Range

UiPath.MicrosoftOffice365.Activities.Excel.ReadRangeConnections

Description

Reads and saves the information from a specified Excel workbook cell range for use in other activities, such as Write Range.

Scopes

This activity requires the following scopes:

• Sites.Read.All

OR

• Sites.ReadWrite.All

Project compatibility

Windows | Cross-platform

Configuration

• Microsoft OneDrive & SharePoint connection - The connection for the Microsoft 365 account to use in the activity.
• Workbook - The Excel workbook to use. The method to specify the folder to be retrieved: Folder picker, Enter Id, Enter Url.
  • File/Folder picker option: Click the Folder icon to browse the OneDrive or SharePoint files/folders and select a spreadsheet. This option accepts input as IResource.

    • Use the See more button menu to use a variable or select the Reload Folder Data option if you've modified your folders and need to retrieve the latest data.

  • Enter Id option:

    • Workbook Id - The ID of the workbook of interest. This field supports String type input.
    • SharePoint site address - The URL of the SharePoint site that contains the file or folder. This field supports String type input.Open your SharePoint site in a browser and copy its URL, e.g., https://yourcompany.sharepoint.com/sites/ProductOfficial.
    • SharePoint document library - The document library within the indicated SharePoint site that contains the file or folder. This field supports String type input. Open the Documents tab in your SharePoint site and copy the URL, e.g., https://yourcompany.sharepoint.com/sites/ProductOfficial/Shared%20Documents/Forms/AllItems.aspx.

  • Enter Url option:

    • Workbook Url - The URL of the workbook of interest. This field supports String type input. Retrieve the URL by opening the file in a browser.
• Range - Select the Range to read from after configuring the workbook. This field is prepopulated with information retrieved from the selected spreadsheet or spreadsheet sample. You can also add a custom range, such as Sheet1C5:F10, a NamedRange, e.g., Clients, or a Table Name. This property supports String variables and string formatted values.

  • Select the Update Ranges option if you've modified your sheets and need to retrieve the latest data.

  • Select the Update Table option if you've modified your workbook and need to retrieve the latest data.

  Note: Some special character combinations in the Sheet/Range name property can cause the activity to throw an error. For example, Sheet%Test is a valid input, but Sheet%44 isn’t (%44 is transformed into D).

• Has headers - This property supports Boolean values. Set to True if the first row in the range represents a header row.

Additional options

Input

• What to read - The type of information that is read from the cell range: Values, Values and Formulas, Text.

Output

• Read range - Reference to the information retrieved by the activity (stored as a DataTable variable), for use in other activities, such as Write Range.
• Read information - Details of the selected range, stored in a RangeInformation variable.

Known limitations for requests

Be aware of request/response limits when working with ranges. The limit stands at 4 MB, e.g., on average 10,000 cells with 20 characters each for Read requests, 4,000 cells with 20 characters each for Write requests. For more information, see Excel specifications and limits.

Example

See also:

• Excel Online activities

• Create Workbook
• Delete Range
• Write Range