Skip to main content

Activate Sheet

Selects a worksheet for subsequent operations. Note that Microsoft Graph API doesn't support worksheet activation like desktop Excel, so this node primarily validates the worksheet exists and returns its information for use in subsequent operations.

Common Properties

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

If the ContinueOnError property is set to true, no error is caught when the project is executed even if a Catch node is used.

Input

  • Client Id - The client ID from the Connect node (optional if using direct credentials).
  • Workbook Id - The workbook ID from Get Workbook or Create Workbook node.
  • Worksheet Name - Name of the worksheet to select.

Options

  • Credentials - OAuth2 credentials (optional, alternative to using Client ID).

Output

  • Success - True if the worksheet was found and selected.

  • Active Worksheet - Information about the selected worksheet:

    • Id: Worksheet ID
    • Name: Worksheet name
    • Position: Position in the workbook
    • Visibility: Worksheet visibility
    • IsActivated: true (conceptual flag)
    • UsedRange: Information about the used range (if data exists)
    • Note: Explanation about Graph API limitations
  • Worksheet Id - The worksheet ID for subsequent operations.

Examples

Activate Specific Sheet:

// Input
Client Id: ${client_id}
Workbook Id: ${workbook_id}
Worksheet Name: "Sales Data"

// Output - success
true

// Output - worksheet_id
"worksheet-id-789"

Workflow Pattern:

Get Workbook
→ Activate Sheet (name: "Data")
→ Get Range (read from activated sheet)
→ Set Cell Value (write to same sheet)

Understanding Activation

Unlike desktop Excel, Microsoft Graph API is stateless and doesn't maintain an "active" sheet concept. This node:

  1. Verifies the worksheet exists
  2. Retrieves its metadata
  3. Returns the worksheet ID for use in subsequent operations

All other Excel nodes accept a worksheet name parameter, so you don't strictly need to "activate" sheets. However, this node is useful for:

  • Validating a worksheet exists before processing
  • Getting worksheet metadata upfront
  • Organizing your flow logically (activate, then operate)

Use Cases

  • Verify worksheet exists before performing operations
  • Get worksheet information before reading/writing data
  • Validate worksheet accessibility
  • Prepare worksheet context for batch operations

Tips

  • In Graph API workflows, you typically pass worksheet names directly to operation nodes
  • Use this node when you need to validate worksheet existence first
  • Store the worksheet_id output for subsequent operations
  • Consider using Get Worksheet if you need information about all worksheets

Common Errors

ErrInvalidArg - "Workbook ID cannot be empty"

  • Solution: Ensure you've called Get Workbook first

ErrInvalidArg - "Worksheet name cannot be empty"

  • Solution: Provide the name of the worksheet to activate

ErrNotFound - "Worksheet not found"

  • Solution: Verify the worksheet name is correct. Worksheet names are case-insensitive.