UiPath Integrations

The UiPath Integrations Guide

Welcome to the UiPath Integrations guide. You will find comprehensive guides and documentation to help you start working with UiPath Integrations, as well as support if you get stuck.

In order to download the solutions mentioned here please visit the official UiPath Go! Marketplace here.

*Note that only integrations built in-house at UiPath are detailed below. For a complete list of UiPath's technology partners, see here.

Read Column

Overview

The Read Column activity uses the Microsoft Graph GetRange API to retrieve cell values from a specified column (StartingCell) in a workbook (Workbook) worksheet (SheetName).

After retrieving the cell value, the activity returns the column value in a Object[] (Column).

How it works

The following steps and message sequence diagram is an example how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

  1. Complete the Setup steps.
  2. Add the Microsoft Office 365 Scope activity to your project.
  3. Add an activity or run an external process that outputs a DriveItem object (e.g., Find Files and Folders, Create Workbook, Copy Item).
  4. Add the Read Column activity inside the Microsoft Teams Scope activity.
  5. Enter values for the Input properties.
  6. Create and enter a Object[] variable for the Output property.
  7. Run the activity.
    • Your input property values are sent to the GetRange API.
    • The API returns the Object[] value to your output property variable.

Properties

The values for the following properties are specified when adding this activity to your project in UiPath Studio.

Common

DisplayName

The display name of the activity.

Attributes
Details

Type

String

Required

Yes

Default value

Read Cell

Allowed values

Enter a String or String variable.

Notes

N/A


Input

StartingCell

The cell that you want to start reading values from. This activity returns all cells from the StartingCell to the last completed cell in the column.

Attributes
Details

Type

String

Required

Yes

Default value

"A1"

Allowed values

Enter a String or String variable.

Notes

  • Enter the address of a single cell in A1-style notation.This property does not support a range of cells (e.g., "A1:A5").

SheetName

The name of the sheet that contains the column (indicated by StartingCell).

Attributes
Details

Type

String

Required

Yes

Default value

Sheet1

Allowed values

Enter a String or String variable.

Notes

N/A


Workbook

The workbook that contains the sheet (SheetName).

Attributes
Details

Type

DriveItem

Required

Yes

Default value

Empty

Allowed values

Enter a DriveItem variable.

Notes

  • Use the output property variable from either
    the Find Files and Folders (First or Results) or Create Workbook (Workbook) activities (see example image below).
  • When using the Results output property from the Find Files and Folders activity, specify the item in the array that you want to use (e.g., myWorkbooks(0)).

Misc

Private

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

Attributes
Details

Type

Checkbox

Required

No

Default value

Not Selected

Allowed values

Selected or Not Selected

Notes

N/A


Options

ValueType

The type of cell data that you want to retrieve.

Attributes
Details

Type

Drop-down list

Required

No

Default value

Values

Allowed values

Use the drop-down list to select one of the three options:

  • Values - Retrieves the coded value (i.e., backend) of the cells in the column.
    • This might different from the format value shown in the Excel worksheet (e.g., if the cell displays 23.00 in the worksheet, the coded value returned is 23).
  • Formulas - Retrieves the formula of the specified cell only (e.g., =SUM(A1,B1)).
  • Text - Retrieves the Excel worksheet value of the cell (e.g., if the cell displays 23.00 in the worksheet, the text value returned is 23.00).

Notes

  • If you select Formulas and the specified cell doesn't contain a formula, the returned value defaults to Values.

Output

Column

The contents of the column, returned according to the specified ValueType.

Attributes
Details

Type

Object[]

Required

No (recommended if you plan to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a Object[] variable.

Notes

N/A


Example

The following image shows an example of the activity dependency relationship and input/output property values.

For step-by-step instructions and examples, see the Quickstart guides.

Updated 3 months ago


Read Column


Suggested Edits are limited on API Reference Pages

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