Get List and Data

Operation name

Get List and Data

Function overview

Gets a file list and the contents of the files.

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
Destination	Required	Not available	Select a connection resource. Add A new connection resource can be added. Edit list Connection resource settings can be edited in > HULFT INTEGRATE > Connections.
Path	Required	-	Specify paths. Each row can be operated with the following buttons: Up Moves the selected row upward by one row. Down Moves the selected row downward by one row. Add Adds a row. Delete Deletes the row.
Path/Remote path	Required	Available	Enter the file/directory in the FTP server with an absolute path starting with "/".	Wildcards ("" and "?") can be used in file names. Example: /upload/.csv It corresponds to the file with the csv extension which exists directly under the /upload directory. Example: /upload/sales_data??.xls It corresponds to the file with the xls extension, starting with "sales_data" followed by two characters, which exists directly under the /upload directory. Case-sensitive.
Path/Local path	Required	Available	Enter the file/directory in HULFT Square Storage with an absolute path starting with "/".	When the wildcard (""/"?") is used in Remote path*, enter the directory name. Case-insensitive.
Path/Data type	Required	Not available	Select a data type. ASCII BINARY (Default)

Read settings

Item name	Required/Optional	Use of variables	Description	Remarks
Directory option	Required	Not available	Select how to handle directories when getting data. Ignore (Default) Ignore directories and don't transfer them. Further, the directory information won't be included in the result list. Recursive Download files/directories under the specified directory recursively.
Date option	Required	Not available	Select whether or not to include date information. Exclude (Default) Date information won't be included in the results. Include Date information will be included in the result.
Check for update when transferring file	Optional	Not available	Select whether or not to check for updates of the local file when transferring files. Selected (Default) Transfer files only when the criteria specified in Criteria for updating are satisfied. Not selected Transfer files forcibly.
Criteria for updating	Required	Not available	Select criteria for updating files. Updated time (Default) Compare the updated time of the file on the FTP server side with that on the HULFT Square Storage side, and transfer when the one on the FTP server side is newer. Note The FTP server must support MDTM command. If a large number of files exist on the FTP server, the load on the CPU and memory might increase significantly due to the date and time comparison processing for the files. Existence Transfer the file/directory when the file/directory doesn't exist in the HULFT Square Storage side path.	Enabled when Check for update when transferring file is selected.

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"?>
<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 once for each obtained file/directory.
	date	Outputs the last updated date and time of the obtained file in yyyyMMddHHmmss format. Example: "20071016131522" shows October 16, 2007 13:15:22.	Note It's gotten only when Date option is Include. It's empty data in the case of directory.
	filetype	Outputs the file type of the obtained file/directory. File File Directory Directory
	local	Outputs the absolute path in HULFT Square Storage of the obtained file/directory.
	remote	Outputs the absolute path in the FTP server of the obtained file/directory.
	size	Outputs the file size of the obtained file. The unit is byte.	Note It's empty data in the case of directory.
	status	Outputs the download status. Updated The file has been downloaded, and the file in HULFT Square Storage has been updated. Uptodated The file hasn't been downloaded. This is output when Updated time is selected in Criteria for updating and the file in the FTP server isn't newer than the file in HULFT Square Storage. Exists The file hasn't been downloaded. This is output when Existence is selected in Criteria for updating and the file in the FTP server exists in HULFT Square Storage. NG The file hasn't been downloaded due to an error.
	type	Outputs the data type. ASCII Outputs when downloaded in ASCII format. BINARY Outputs when downloaded in BINARY format.	Note It's empty data in the case of directory.

Loading schema in Mapper

The schema is loaded automatically.

= 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 files/directories is stored.	The default value is null. The sum of "directory_count" and "file_count".
directory_count	The number of read directories is stored.	The default value is null.
file_count	The number of read files 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 FTP connector