Official |[File Operation] Get List of File Names

Operation name

Get List of File Names

Function overview

Gets a list of file names in a directory.

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
Directory path	Required	Available	Enter the directory path to get the list. The Browse button launches a directory chooser that allows you to select a directory.	Note Specify an absolute path of HULFT Square Storage for the file path. With the exception of the path separator "/", the Restricted characters of HULFT Square Storage can't be used.
Sort file name list	Optional	Not available	Select whether to sort the list of file names. Selected Sort file names according to the specification in Sort order. Not selected (Default) Don't sort.
Sort order	Optional	Not available	Select the sort order. Ascending (Default) Sort by name in ascending order. Descending Sort by name in descending order.	Enabled when the Sort file name list is selected. The order of the file name is based on the Unicode order. For example (in ascending order): number (single-byte) < alphabet letter (single-byte) < Hiragana (multibyte) <katakana (multibyte) < Kanji < number (multibyte) < alphabet letter (multibyte) < Katakana (single-byte).

Item name

Required/Optional

Use of variables

Description

Remarks

Directory path

Required

Available

Enter the directory path to get the list.

The Browse button launches a directory chooser that allows you to select a directory.

Note

Specify an absolute path of HULFT Square Storage for the file path.
With the exception of the path separator "/", the Restricted characters of HULFT Square Storage can't be used.

Sort file name list

Optional

Not available

Select whether to sort the list of file names.

Selected

Sort file names according to the specification in Sort order.

Not selected

(Default)

Don't sort.

Sort order

Optional

Not available

Select the sort order.

Ascending

(Default)

Sort by name in ascending order.

Descending

Sort by name in descending order.

Enabled when the Sort file name list is selected.
The order of the file name is based on the Unicode order.

For example (in ascending order): number (single-byte) < alphabet letter (single-byte) < Hiragana (multibyte) <katakana (multibyte) < Kanji < number (multibyte) < alphabet letter (multibyte) < Katakana (single-byte).

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" encoding="UTF-8" ?>
  <filelist>
    <file name="" size="" type="" updated=""/>
  </filelist>

Element name	Attribute name	Description	Remarks
filelist	-	Root element
file	name	The name of the file or the directory retrieved is output.
	size	The size of the file or the directory retrieved is output. The unit is byte.	"0" is output when directories are retrieved.
	type	The type of the file or the directory retrieved is output. file File directory Directory
	updated	The last modified date and time of the file or the directory retrieved is output.

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

Variable name	Description	Remarks
success	The result of the operation is stored.	The default value is null. When succeeded, "true" is stored. When failed, "false" is stored.
directoryCount	The number of retrieved directories is stored.	The default value is null.
fileCount	The number of retrieved 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 File Operation connector