Get List of Sheet Names

Operation Name

Get List of Sheet Names

Function Overview

Get Excel sheet name list in the file.

Data Model

Data model of this component is XML type.

Properties

For information about using variables, refer to "variables".
Basic settings
Item name Required / Optional Use of Variables Description Remarks
Name Required Not available Enter the name on the script canvas.  
Required settings
Item name Required / Optional Use of Variables Description Remarks
File Required Available Enter the path of the Excel file.

Click [Browse] button to activate the file Selectr and Select the file.
  • Files with extension ".xlsx" and ".xlsm" are treated as an Excel workbook. Files with other extension are treated as Excel 2003.
  • Specify the absolute path of the DataSpider file system as the file path.
  • Constrained characters of DataSpider File System except for path separator "/" 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 needs to be reloaded manually.
Specify the schema to be loaded.
See "Edit Schema" for any 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 Stores the count of the sheets.
  • The value defaults to null.
filePath Return file path.
  • The value defaults to null.
message_category Stroes the category to which corresponding message code belongs to, when an error occurs.
  • The value defaults to null.
message_code Stores its corresponding message code of occured error.
  • The value defaults to null.
message_level Stores the severity of the corresponding message code of the occured error.
  • The value defaults to null.
error_type Returns the error type when error occurred.
  • The value defaults to null.
  • Error is represented in the format depicted below.
    Example:java.io.FileNotFoundException
  • The message may vary depending on the DataSpider Servista version.
error_message Return the error message when error occurred.
  • The value defaults to null.
  • The message may vary depending on the DataSpider Servista version.
error_trace Return trace information when error occurred.
  • The value defaults to null.
  • The message may vary depending on the DataSpider Servista version or the client application used.

Specification Limits

Main exceptions

Exception name Causes Solution
InvalidPropertyConfigurationException
<Property name> is not specified.		 [<Property name>] is not specified. Specify [<Property name>].
FileIsDirectoryException Path input in [File] is directory. Input file path in [File].
java.io.FileNotFoundException Please check [File]. Please check [File].
jxl.read.biff.PasswordException Excel 2003 workbook specified in [File] is set with read password. Please input Excel 2003 workbook whose read password is not set in [File]
jxl.read.biff.BiffException
Unable to recognize OLE stream 		Excel 2003 workbook specified in [File] is not correct. Check the following.
  • If the file specified in [File] is Excel 2003 workbook included in version support or not.
  • If the extension of a non-excel 2003 workbook is set to [.xls] and is specified in [File].
  • If the file is damaged or not.
jxl.read.biff.BiffException
The file format is corrupt 		The Excel 2003 workbook specified in [File] may be damaged. Check the following.
  • If the Excel 2003 workbook specified in [File] is damaged or not.
ZipEntryBrokenException:
Working ZIP files entries are corrupt.		 Excel workbook specified in [File] is not correct. Check the following.
  • If the file specified in [File] is an Excel workbook.
  • If the extension of a non-excel workbook is set to "xlsx" or "xlsm" and is specified in [File]
  • If the file is damaged or not.
ZipEntryNotFoundException:
Entry of specified name didn't exist in zip file.		 Excel workbook specified in [File] is set with a read password or is not correct. Please confirm if the Excel workbook specified in [File] is set with a read password or not, or if the file is damaged or not.