Official |[Excel] Get Sheet Names

Operation name

Get Sheet Names

Function overview

Gets a list of sheet names included in an Excel file.

Data model

The data model of this component is XML type.

Properties

= Remarks =

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 that is used on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
File	Required	Available	Enter the Excel file path. The Browse button launches a file chooser that allows you to select a file.	A file with ".xlsx" or ".xlsm" extension is processed as an Excel workbook, and a file with other extensions is processed as an Excel 2003 workbook. Note Specify an absolute path of HULFT Square Storage for the file path. With the exception of the path separator "/", the Restricted characters of HULFT Square Storage can't be used.

Item name

Required/Optional

Use of variables

Description

Remarks

File

Required

Available

Enter the Excel file path.

The Browse button launches a file chooser that allows you to select a file.

A file with ".xlsx" or ".xlsm" extension is processed as an Excel workbook, and a file with other extensions is processed as an Excel 2003 workbook.

Note

Specify an absolute path of HULFT Square Storage for the file path.
With the exception of the path separator "/", the Restricted characters of HULFT Square Storage can't be used.

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this connector.

Schemas

Input schema

None.

Output schema

<?xml version="1.0" encoding="UTF-8"?>
<book>
 <sheet><![CDATA[Sheet1]]></sheet>
 <sheet><![CDATA[Sheet2]]></sheet>
 <sheet><![CDATA[Sheet3]]></sheet>
   :
   :
</book>

Loading schema in Mapper

The schema needs to be loaded manually.

Specify the schema of the data to be loaded.

= Remarks =

For details, refer to Edit Schema.

Mass data processing

Mass data processing isn't supported.

Parallel Stream Processing

PSP isn't supported.

Available component variables

Component variable name	Description	Remarks
count	The number of read sheets is stored.	The default value is null.
filePath	The file path is stored.	The default value is null.
message_category	When an error occurs, the category of the message code corresponding to the error is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the error is stored.	The default value is null.
message_level	When an error occurs, the severity of the message code corresponding to the error is stored.	The default value is null.
error_type	When an error occurs, the error type is stored.	The default value is null. The format of the error type is as follows. Example: java.io.FileNotFoundException
error_message	When an error occurs, the error message is stored.	The default value is null.
error_trace	When an error occurs, the trace information for the error is stored.	The default value is null.

Message codes, exception messages, and limitations

Connector	Message code	Exception message	Limitations
Messages and limitations of the Excel connector