Get Sheet Names

Operation Name

Get Sheet Names

Function Overview

Get sheet names included in an Excel file.

Data Model

XML type.

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 the name to show on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
File	Required	Available	Enter the Excel file path. You can click [Browse] button to launch file chooser and find the file.	A file with ".xlsx" or ".xlsm" extension is processed as an Excel workbook, and a file with other extension is processed as an Excel 2003 workbook. 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.

Comment

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.

Schema

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

Schema should be loaded manually.
Specify the schema of the data to be loaded.

Refer to “Edit Schema” for more details.

Mass Data Processing

Mass data processing is not supported.

PSP Usage

PSP is not supported.

Available Component Variables

Component variable name	Description	Remarks
count	The number of read sheets is stored.	Default value is null.
filePath	The file path is stored.	Default value is null.
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.

Specification Limits

File encrypted with a password
- You cannot read data from an Excel file that is encrypted with a password.

Major Exceptions

Exception name	Cause	Solution
InvalidPropertyConfigurationException <property name> is not specified.	[<property name>] is not specified.	Specify [<property name>].
FileIsDirectoryException	The path entered in [File] is directory.	Enter a file path in [File].
java.io.FileNotFoundException	The file specified in [File] does not exist.	Check [File].
jxl.read.biff.PasswordException	A password to open is set in the Excel 2003 workbook specified in [File].	Enter an Excel 2003 workbook in which a password to open is not set in [File].
jxl.read.biff.BiffException Unable to recognize OLE stream	The Excel 2003 workbook specified in [File] is in an invalid state.	Check the following. Whether the file specified in [File] is an Excel 2003 workbook included in Supported Versions Whether a file that is not Excel 2003 workbook is specified with ".xls" extension in [File] Whether the file is corrupted
jxl.read.biff.BiffException The file format is corrupt	The Excel 2003 workbook specified in [File] might be corrupted.	Check the following. Check whether the file specified in [File] is corrupted.
ZipEntryBrokenException: The entry of the operating ZIP file is broken.	The Excel workbook specified in [File] is in an invalid state.	Check the following. Whether the file specified in [File] is an Excel workbook Whether a file that is not Excel workbook is specified with ".xlsx" / ".xlsm" extension in [File] Whether the file is corrupted
ZipEntryNotFoundException: Entry of the specified name does not exist in the zip file	The Excel workbook specified in [File] is protected with password to open or is in an invalid state.	Check whether password to open is set to the Excel workbook specified in [File], and whether the file is corrupted.