Read List

Operation Name

Read List

Function Overview

Gets list of files.

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
Destination Required Not available Select a global resource.
For details about how to configure global resource, refer to “Global Resource Properties”.
  • [Add]:
    Add a new global resource.
  • [Edit list]:
    Global resource settings can be edited in “Edit resource list” screen.
  
Path Required - Specify paths.

Each column can be operated with the following buttons.
  • [Add]:
    Add a column.
  • [Up]:
    Move the selected column upwards by one row.
  • [Down]:
    Move the selected column downwards by one row.
  • [Delete]:
    Delete the column.
  
Path/Remote path Required Available Enter the file/directory in the FTP server with an absolute path starting with “/”.
  • Wild cards ("*" and "?") can be used in file name.
    • Example: /upload/*.csv
      • It corresponds to the file with csv extension which exists directly under /upload directory.
    • Example: /upload/sales_data??.xls
      • It corresponds to the file with xls extension, starting with “sales_data” followed by two characters, which exists directly under /upload directory.
  • Case-sensitive.
Read settings
Item name Required/Optional Use of variables Description Remarks
Directory option Required Not available Select directory handling when getting data.
  • [Only specified hierarchy]: (default)
    Get directory information of only the specified hierarchy.
  • [Recursive]:
    Download directories under the specified hierarchy recursively.
  
Date option Required Not available Select whether or not to include date information.
  • [Exclude]: (default)
    Date information will not be included in the result.
  • [Include]:
    Date information will be included in the result.
  
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"?>
<ftpserver name="" port="" user="">
  <pathnames>
    <pathname date="" filetype="" local="" remote="" size="" status="" type=""/>
  </pathnames>
</ftpserver>
Element name Attribute name Description Remarks
ftpserver -    
name Outputs the host name of the connected FTP server.  
port Outputs the port number of the connected FTP server.  
user Outputs the user name used when connecting to FTP server.  
pathnames -    
pathname - Appears for each got file/directory.  
date Outputs the last updated date and time of the file in yyyyMMddHHmmss format.
Example:
“20071016131522” shows October 16, 2007 13:15:22.
  • It is got only when [Date option] is [Include].
  • Empty, in the case of directory.
filetype Outputs the file type.
  • File: File
  • Directory: Directory
  
local Always outputs empty data.  
remote Outputs the absolute path in the FTP server of the file/directory.  
size Outputs the file size. Unit is byte.
  • Empty, in the case of directory.
status Always outputs empty data.  
type Always outputs empty data.  

Loading schema in Mapper

Schema is loaded automatically.
For more details, refer to “Edit Schema”.

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 files/directories is stored.
  • Default value is null.
  • The sum of “directory_count” and “file_count”.
directory_count The number of read directories is stored.
  • Default value is null.
file_count The number of read files 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

Major Exceptions

Exception name Cause Solution
ResourceNotFoundException
Resource definition is not found. Name: []		 [Destination] is not specified. Specify [Destination].
ResourceNotFoundException
Resource definition is not found. Name: [<global resource name>]		 The resource definition selected in [Destination] is not found. Check the global resource specified in [Destination].
RemoteFileListParseException
Failed to parse the remote file list. The encoding may be incorrect.		 Failed to parse the remote file list. Check the settings of [Encoding] selected in [Destination] and the settings of FTP server.
FTPException This is an exception raised when FTP server returns some error. Check the contents of the message.
com.enterprisedt.net.ftp.FTPException This is an exception raised when FTP server returns some error. Check the contents of the message.
java.net.UnknownHostException This is an exception raised when the specified FTP server is not found. Check the FTP server settings.
java.net.ConnectException This is an exception raised when unable to connect to FTP server. Check whether the port number is correct and the FTP server is running.

Notes