Skip to main content
Version: Current

Rename Worksheet

Description

The Rename Worksheet activity changes the name of an existing worksheet within an Excel workbook.

This activity can identify the worksheet by name or worksheet index and assign a new worksheet name.


Common Capabilities

Process Data Support

info

This activity supports dynamic configuration using variables from the Process Data drawer.

You can bind values from Model Data, Form Data, System Data, Enterprise Variables, and Activity Outputs.

Learn more → Using Process Data


Design-Time Configuration

Workbook Configuration

This activity requires an Excel workbook.

Learn more → Excel Workbook Configuration


Worksheet Selection

Selects the worksheet to rename.

Learn more → Excel Worksheet Selection


New Sheet Name

New name to assign to the worksheet.

The worksheet name must be unique within the workbook.

Examples:

  • Customers
  • Orders
  • Summary
  • Sales Report

Behavior

When the activity executes:

  • The selected worksheet is renamed.
  • Worksheet contents, formatting, formulas, and other worksheet properties remain unchanged.
  • References to the worksheet within workbook formulas may be updated automatically by Excel.

Outputs

This activity does not produce any activity-specific outputs.


Wait All Incoming

Execution Control

Controls how this activity behaves when multiple incoming execution paths converge.

Determines whether the activity executes when any incoming path completes, or only after all relevant paths have completed.

Learn more → Execution Control


On Error

Error Handling Strategy

Defines how the workflow behaves if this activity encounters a runtime error.

Supported strategies include Fault, Continue, Suspend, and Retry.

Learn more → Error Handling