EXCEL rename sheet function

The EXCEL rename sheet function allows you to rename a sheet within an Excel workbook.

Help CentreBuilding Processes

This article describes the RPA Excel functionality to rename an existing sheet in a workbook.

For a full list of available functions, please read EXCEL functions.


Description

The EXCEL rename sheet function allows you to rename an existing sheet's name.


Setting it up

To use the EXCEL navigate function, follow these instructions:

{{popups:rpas/add:action=excel-rename-sheet}}

Once on a process map:

  1. Navigate to the process where you would like to add the EXCEL rename sheet function
  2. Click on the green button’s drop-down (right side of the green button labelled “Process”)
  3. On the menu that appears, click on the “+ Activity” item, which will make a new form appear
  4. From here you can select the EXCEL rename sheet option
  5. Click "Add" once you are done

Inputs

  • File path: The full path to the document you want to work with
  • Sheet: The name of the sheet you wish to rename
  • New name: The new name for the excel sheet
  • Overwrite if exists: Toggle to allow the sheet to rename a similarly named sheet to be overwritten.

Input parameters

ParameterRequiredTypeDefaultDescription
File pathYesTextFull path to the Excel file.
SheetYesTextCurrent name of the sheet.
New nameYesTextNew name for the sheet.
Overwrite if existsNoBooleanOffOverwrite an existing sheet with the same name.

Output variables

This action does not produce any output variables.


Errors

ErrorDescription
Sheet not foundThe specified sheet does not exist.
Name already existsA sheet with the new name already exists and overwrite is off.

Related functions

See it working on your own data

Everything documented here ships with the platform – try the document tools free, or go live in 7 days.