Rename Sheet
Operation name
Rename Sheet
Function overview
Renames the sheet of the specified Excel workbook.
Properties
For details on use of variables, refer to Variables.
Basic settings
| 
                                                                     Item name  | 
                                                                
                                                                     Required/Optional  | 
                                                                
                                                                     Use of variables  | 
                                                                
                                                                     Description  | 
                                                                
                                                                     Remarks  | 
                                                            
|---|---|---|---|---|
| 
                                                                     Name  | 
                                                                
                                                                     Required  | 
                                                                
                                                                     Not available  | 
                                                                
                                                                     Enter a name to use on the script canvas.  | 
                                                                
                                                                     
  | 
                                                            
Required settings
| 
                                                                     Item name  | 
                                                                
                                                                     Required/Optional  | 
                                                                
                                                                     Use of variables  | 
                                                                
                                                                     Description  | 
                                                                
                                                                     Remarks  | 
                                                            
|---|---|---|---|---|
| 
                                                                     File  | 
                                                                
                                                                     Required  | 
                                                                
                                                                     Available  | 
                                                                
                                                                     Enter the file path of the Excel workbook. The Browse button launches a file chooser that allows you to select a file.  | 
                                                                
                                                                    
 Note
                                                                         
                                                                
  | 
                                                            
| 
                                                                     Sheet list  | 
                                                                
                                                                     Optional  | 
                                                                
                                                                     -  | 
                                                                
                                                                     Specify the sheet to be renamed.  | 
                                                                
                                                                     
  | 
                                                            
| 
                                                                     Sheet list/Sheet name before change  | 
                                                                
                                                                     Required  | 
                                                                
                                                                     Available  | 
                                                                
                                                                     Select or enter the sheet to be renamed that is included in the Excel file specified in File.  | 
                                                                
                                                                    
  | 
                                                            
| 
                                                                     Sheet list/Sheet name after change  | 
                                                                
                                                                     Required  | 
                                                                
                                                                     Available  | 
                                                                
                                                                     Enter the new sheet name.  | 
                                                                
                                                                    
  | 
                                                            
Transaction
| 
                                                                     Item name  | 
                                                                
                                                                     Required/Optional  | 
                                                                
                                                                     Use of variables  | 
                                                                
                                                                     Description  | 
                                                                
                                                                     Remarks  | 
                                                            
|---|---|---|---|---|
| 
                                                                     Execute transaction processing  | 
                                                                
                                                                     Optional  | 
                                                                
                                                                     Not available  | 
                                                                
                                                                     Select whether or not to execute transaction processing. 
 = Remarks =
                                                                         
                                                                For details, refer to Transactions for the connectors in the File category.  | 
                                                            
Comment
| 
                                                                     Item name  | 
                                                                
                                                                     Required/Optional  | 
                                                                
                                                                     Use of variables  | 
                                                                
                                                                     Description  | 
                                                                
                                                                     Remarks  | 
                                                            
|---|---|---|---|---|
| 
                                                                     Comment  | 
                                                                
                                                                     Optional  | 
                                                                
                                                                     Not available  | 
                                                                
                                                                     You can write a short description of this connector.  | 
                                                                
                                                                     
  | 
                                                            
Transaction
Transaction is supported.
Transaction is enabled only when Execute transaction processing of Transaction is selected.
Parallel Stream Processing
PSP isn't supported.
Available component variables
| 
                                                                 Component variable name  | 
                                                            
                                                                 Description  | 
                                                            
                                                                 Remarks  | 
                                                        
|---|---|---|
| 
                                                                 message_category  | 
                                                            
                                                                 When an error occurs, the category of the message code corresponding to the error is stored.  | 
                                                            
                                                                
  | 
                                                        
| 
                                                                 message_code  | 
                                                            
                                                                 When an error occurs, the code of the message code corresponding to the error is stored.  | 
                                                            
                                                                
  | 
                                                        
| 
                                                                 message_level  | 
                                                            
                                                                 When an error occurs, the severity of the message code corresponding to the error is stored.  | 
                                                            
                                                                
  | 
                                                        
| 
                                                                 error_type  | 
                                                            
                                                                 When an error occurs, the error type is stored.  | 
                                                            
                                                                
  | 
                                                        
| 
                                                                 error_message  | 
                                                            
                                                                 When an error occurs, the error message is stored.  | 
                                                            
                                                                
  | 
                                                        
| 
                                                                 error_trace  | 
                                                            
                                                                 When an error occurs, the trace information for the error is stored.  | 
                                                            
                                                                
  | 
                                                        
Message codes, exception messages, and limitations
| 
                                                                 Connector  | 
                                                            
                                                                 Message code  | 
                                                            
                                                                 Exception message  | 
                                                            
                                                                 Limitations  | 
                                                        
|---|---|---|---|