Read List-only

Operation Name

Read List-only

Function overview

Get a list of files.

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
Destination Required Not Available Select Global Resources.
Refer to "the global resource properties" to set up a global resource.
  • [Add]:
    Adds new global resource.
  • [Edit list]:
    Global resource settings can be edited with "Edit Resource list".
  
Path Required - The path.

Each column can be operated with the following buttons.
  • [Add]:
    Adds the column.
  • [Up]:
    Moves the order of the selected column upwards by one.
  • [Down]:
    Moves the order of the selected column downwards by one.
  • [Delete]:
    Deletes the column.
  
Path / Remote path Required Available Enter file/directory on the FTP server with absolute path beginning from "/".
  • The file name can use wildcard ("*","?").
    • Example: /upload/*.csv
      • Files with csv extension is under /upload directory correspond.
    • Example: /upload/sales data??.xls
      • Xls files which begins with "sales data" followed by two characters under /upload directory correspond.
  • Case-sensitive.
Read settings
Item name Required / Optional Use of Variables Description Remarks
Directory option Required Not available Select the directory when retrieved data.
  • [Only specified path]: (default)
    Directory information will be retrieved from only specified path.
  • [Recursive]:
    For a specified directory path, get recursively.
  
Date option Required Not available Select whether to include date information.
  • [Exclude]: (default)
    Results do not include date information.
  • [Include]:
    Results include date information.
  
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 Host name of connected FTP server  
port Port number of connected FTP server  
user User name to connect to the server  
pathnames -    
pathname - Emerge accordingly to the received file/directory.  
date Get the last modified date of files. The output format is yyyyMMddHHmmss.
Example:
"20071016131522" means 1:15 pm and 22 seconds on October 16, 2007.
  • [Date option] is gotten only when [Include] .
  • The data of directory is empty.
filetype Outputs the file type of received file/directory.
  • File:File
  • Directory:Directory
  
local Always empty data  
remote Outputs the absolute path on FTP server of the received file/directory.  
size Size of retrieved filesThe unit is byte.
  • The data of directory is empty.
status Data is always empty  
type Data is always empty  

Loading schema in Mapper

Schema is loaded automatically.
See "Edit Schema" for details with regards to defining a 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 Stores numbers of the loaded file/directory.
  • The value defaults to null.
  • This value is the sum of "directory_count" and "file_count".
directory_count The number of directory retrieved returns.
  • The value defaults to null.
file_count The number of files retrieved returns.
  • 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 DataSpider Servista version.
error_message Return the error message when error occurred.
  • The value defaults to null.
  • The message may vary depending on DataSpider Servista version.
error_trace Return trace information when error occurred.
  • The value defaults to null.
  • The message may vary depending on DataSpider Servista version or the client application used.

Specification Limits

Main exception

Exception name Causes Solution
ResourceNotFoundException
Resource definition could not be found.Name: []		 [Destination] is not specified. Please specify [Destination] .
ResourceNotFoundException
Resource definition could not be found.Name: [<name of Global Resources>]		 Resource definition selected in [Destination] is not found. Please check the global resource specified in [Destination]
RemoteFileListParseException
Failed analyze the list of remote files. The encoding specified may be incorrect.		 Failed analyze the list of remote files. Ensure the [Encoding] specified in [Destination] and the FTP server settings are correct.
FTPException Exception if any error returned by the FTP server. Check the contents of the message.
com.enterprisedt.net.ftp.FTPException Exception if any error returned by the FTP server. Check the contents of the message.
java.net.UnknownHostException Exception if FTP server is not found. Please check your FTP server configuration.
java.net.ConnectException Exception if can not Connect to FTP Server. Check if port number or FTP is running.

Notes