Skip to content

Rename Sheet Activity

The Rename Sheet activity enables users to modify the name of an existing sheet within an opened or created Excel file. This activity provides flexibility to specify the target sheet either by its current name or its numerical index, and then assign a new, desired name.

Field Description Requirement
Excel name The reference name of the Excel file that has already been opened or created. Required
Sheet name The current name of the sheet to be renamed in Excel. If not provided, the activity targets the first sheet by default. Optional
Sheet index The numerical index of the sheet to be renamed in Excel. If not provided, the activity targets the first sheet by default. Optional
New sheet name The desired new name for the specified sheet. Required

Action Types & Examples

Excel name

  • Format: string
  • Example Result: newExcel

Sheet name

  • Format: string
  • Example Result: Sheet1

Sheet index

  • Format: digit
  • Example Result: 5

New sheet name

  • Format: string
  • Example Result: newSheet

Implementation Examples

Field Setup - Excel name: ${newExcel} - New sheet name: newSheet

Execution Parameters - Sheet name: Sheet1 - Sheet index: 5

Technical Notes

When both Sheet name and Sheet index are left unconfigured, the activity defaults to targeting the first sheet in the specified Excel workbook. If both Sheet name and Sheet index are provided, the Sheet name parameter takes precedence. Ensure the New sheet name does not conflict with existing sheet names in the workbook to avoid potential errors.