Rename Sheet

Operation Name

Rename Sheet

Renames the sheet of the specified Excel workbook.

For details on use of variables, refer to “Variables”.

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter the name to show on the script canvas.

Item name	Required/Optional	Use of variables	Description	Remarks
File	Required	Available	Enter the file path of Excel workbook. You can click [Browse] button to launch file chooser and find the file.	Specify a file path of Excel workbook with “.xlsx” or “.xlsm” extension. Specify the file path as an absolute path of DataSpider File System. Except for the path separator “/”, restricted characters of DataSpider File System cannot be used.
Sheet list	Optional	-	Specify the sheet name to be renamed.
Sheet list/Sheet name before change	Required	Available	Select or enter the sheet to be renamed available in the Excel file specified in [File].	Case-sensitive.
Sheet list/Sheet name after change	Required	Available	Enter the changed sheet name.	Case-sensitive. Specify the sheet name that does not exist in the Excel file specified in [File].

Item name	Required/Optional	Use of variables	Description	Remarks
Execute transaction processing	Optional	Not available	Select whether or not to execute transaction processing. [Checked]: Transaction processing will be executed. [Not checked]: (default) Transaction processing will not be executed. Refer to “Transaction of file category adapters” for more details.

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this adapter. The description will be reflected in the specifications.

None.

None.

Transaction is supported.

Transaction is enabled only when [Execute transaction processing] of [Transaction] is checked.

PSP is not supported.

Component variable name	Description	Remarks
message_category	When an error occurs, the corresponding message code's category is stored.	Default value is null.
message_code	When an error occurs, the corresponding message code is stored.	Default value is null.
message_level	When an error occurs, the corresponding message code's severity is stored.	Default value is null.
error_type	When an error occurs, the error type is stored.	Default value is null. The error type will be in the following format. Example: “java.io.FileNotFoundException” The contents that will be stored may vary depending on DataSpider Servista versions.
error_message	When an error occurs, the error message is stored.	Default value is null. The contents that will be stored may vary depending on DataSpider Servista versions.
error_trace	When an error occurs, the error's trace information is stored.	Default value is null. The contents that will be stored may vary depending on DataSpider Servista versions and client applications.

Exception name	Cause	Solution
InvalidPropertyConfigurationException File path is not specified.	[File] is not specified.	Specify [File].
InvalidPropertyConfigurationException A workbook of unsupported format is specified.	A workbook of unsupported format is specified in [File].	Specify a workbook with supported format in [File].
FileIsDirectoryException	The path entered in [File] is directory.	Enter a file path in [File].
FileIsLockedException	The file specified in [File] is being locked.	Unlock it from Explorer or CLI.
java.io.FileNotFoundException	The file specified in [File] does not exist.	Check [File].
java.io.FileNotFoundException Some other process is using the file.	The file specified in [File] is being used by some other process.	Make sure that it is not being used by some other process.
SheetNotFoundException The sheet name that does not exist is specified.	The sheet specified in [Sheet name before change] does not exist.	Specify an existing sheet name in [Sheet name before change].
SheetAlreadyExistsException Specified sheet already exists.	The sheet specified in [Sheet name after change] already exists.	Specify an not existing sheet name in [Sheet name after change].