Skip to main content

What can we help you with?

Read Excel Range

Ivan Kuznetsov
  • Updated

Description

‌Gets the value of the range from the Excel file.‌ The 'Save value to variable' activity appears automatically when choosing the 'Read Excel Range' activity. It automatically saves the value to a variable. However, the activity is not mandatory to use and can be removed from the workflow.

Studio Pro supports Microsoft Excel .xls and .xlsx file formats.

 

As of the 8.3 update, there are two ways of interacting with MS Excel - Microsoft Native and Generic. Navigate to the menu "Settings"  → "Microsoft activities" to choose a method.

Microsoft Native uses standard Microsoft methods to interact with the Excel application. It requires Excel to be installed on your computer and extends the capabilities of interacting with all Excel functionalities.
Generic does not require Excel to be installed and may have some Excel functionalities limitations.

 

Parameters

Path

  1. Set a value: enables you to directly write the desired path. Clicking the 'Pick' button allows you to manually choose the path.

  2. Save the previous step result: chooses the previous activity result as a path.

  3. Calculate a value: enables you to use available properties and methods to form a path.

     

 
From Row

Allows you to specify a start row for reading.‌

  1. Set a value: enables you to directly write the desired number of the start row.

  2. Save the previous step result: chooses the previous activity result as a number of the start row.

  3. Calculate a value: enables you to use available properties and methods to form a number of the start row.

     

To Row

Allows you to specify an end row for reading.‌

  1. Set a value: enables you to directly write the desired number of the end row.

  2. Save the previous step result: chooses the previous activity result as a number of the end row.

  3. Calculate a value: enables you to use available properties and methods to form a number of the end row.

     

From Column

Allows you to specify a start column for reading.‌

  1. Set a value: enables you to directly write the desired Excel column index of the start column.

  2. Save the previous step result: chooses the previous activity result as Excel column index of the start column.

  3. Calculate a value: enables you to use available properties and methods to form Excel column index of the start column.

     

To Column

Allows you to specify an end column for reading.‌

  1. Set a value: enables you to directly write the desired Excel column index of the end column.

  2. Save the previous step result: chooses the previous activity result as Excel column index of the end column.

  3. Calculate a value: enables you to use available properties and methods to form Excel column index of the end column.

     

Excel sheet name

By default, the first sheet in an Excel file is used.‌

  1. Set a value: enables you to directly specify the sheet name, for example, Employees.

  2. Save the previous step result: chooses the previous activity result as the sheet name.

  3. Calculate a value: enables you to use available properties and methods to form the sheet name.

     

Get dictionary key

The default method is "Use table headers".‌

  1. Use table headers: select this option if the header contains of words specified by the user.

  2. Use column letters: select this option if the header contains of the standard 'Excel' column names: 'A', 'B', 'C' and so on.

     

Comment

Contains an annotation to the activity. The input text will be displayed above the activity name.‌

 

Result

The excel data is stored in the excel_range_content variable by default. This variable is an array of "key-value" objects. Each object of the array represents one row of the table.

For example, if we read the range between the first three rows (1-3) and columns (A-C) we can get such a record:

 
Format of the variable with excel data ('use table headers' option enabled):
 
[

 {

 "Column 1": "Value (1,1)",

 "Column 2": "Value (1,2)",

 "Column 3": "Value (1,3)"

 },

 {

 "Column 1": "Value (2,1)",

 "Column 2": "Value (2,2)",

 "Column 3": "Value (2,3)"

 }

]
 

This record present the following table:

Column 1

Column 2

Column 3

Value (1,1)

Value (1,2)

Value (1,3)

Value (2,1)

Value (2,2)

Value (2,3)

Related articles