LogoLogo
About
  • Home
  • Guides
  • BDK
  • REST API
  • Release Notes
  • Getting Started
    • Excel Overview
  • Workbooks
    • Create an Excel File
  • Worksheets
    • Add a Worksheet
    • Get a Worksheet
    • Get Worksheets
    • Get an Item from an Excel Worksheet
    • Extract Text from a Worksheet
    • Remove a Worksheet
    • Save a Worksheet
  • Tables
    • Insert a Table
    • Extract a Table from a Worksheet
    • Get a Singular Table from an Excel Worksheet
    • Delete a Table
  • Rows
    • Get a Row
    • Get a Row's Cell
    • Insert a Row
  • Columns
    • Insert a Column
  • Cells
    • Get a Cell Value
    • Get a Cell's Column Label
    • Get a Cell's Formula
    • Get a Cell's Row Number
    • Set a Cell's Value
  • Changelogs
    • Get Changelog
    • Apply Changelog
Powered by GitBook
On this page
  • Overview
  • Prerequisite Data
  • Syntax
  • Examples

Was this helpful?

Export as PDF
  1. Worksheets

Get a Worksheet

Gets a specific worksheet from an Excel file.

Overview

This procedure gets a worksheet from an Excel file, provided the worksheet's name.

Prerequisite Data

These required data elements must be present in the automation before using the procedure.

Data Name
Data Type

the excel

Excel File

Syntax

Below is a line-by-line overview of the automation syntax. Expand each line to learn more.

get the excel's worksheet where

What does it do? References an Excel file for the system to retrieve a worksheet from.

Where does it go? This phrase should be written on a new line.

Does it require input data? ⛔ No — This phrase does not require input data.

Is it required? ✅ Yes — This phrase is required in the syntax.

the worksheet name is

What does it do? Specifies the name of the worksheet to retrieve. If not specified, a question will be raised prompting to provide the worksheet name.

Where does it go? This phrase should be indented beneath get the excel's worksheet where.

Does it require input data? ✅ Yes — A Text value should be specified.

Is it required? ✅ Yes — This phrase is required in the syntax.

Examples

1. Get the Worksheet with a Specific Sheet Name

get the excel's worksheet where
    the worksheet name is "Sheet1"

Last updated 4 days ago

Was this helpful?