tFileList Standard properties - 6.5

tFileList

author
Talend Documentation Team
EnrichVersion
6.5
EnrichProdName
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for ESB
Talend Open Studio for MDM
Talend Real-Time Big Data Platform
task
Data Governance > Third-party systems > File components (Integration) > File management components > tFileList
Data Quality and Preparation > Third-party systems > File components (Integration) > File management components > tFileList
Design and Development > Third-party systems > File components (Integration) > File management components > tFileList
EnrichPlatform
Talend Studio

These properties are used to configure tFileList running in the Standard Job framework.

The Standard tFileList component belongs to the File and the Orchestration families.

The component in this framework is available in all Talend products.

Basic settings

Directory

Path to the directory where the files are stored.

Warning: Use absolute path (instead of relative path) for this field to avoid possible errors.

FileList Type

Select the type of input you want to iterate on from the list:

Files if the input is a set of files,

Directories if the input is a set of directories,

Both if the input is a set of the above two types.

Include subdirectories

Select this check box if the selected input source type includes sub-directories.

Case Sensitive

Set the case mode from the list to either create or not create case sensitive filter on filenames.

Generate Error if no file found

Select this check box to generate an error message if no files or directories are found.

Use Glob Expressions as Filemask

This check box is selected by default. It filters the results using a Global Expression (Glob Expressions).

Files

Click the plus button to add as many filter lines as needed:

Filemask: in the added filter lines, type in a filename or a filemask using special characters or regular expressions.

Order by

The folders are listed first of all, then the files. You can choose to prioritise the folder and file order either:

By default: alphabetical order, by folder then file;

By file name: alphabetical order or reverese alphabetical order;

By file size: smallest to largest or largest to smallest;

By modified date: most recent to least recent or least recent to most recent.

Note:

If ordering by file name, in the event of identical file names then modified date takes precedence. If ordering by file size, in the event of identical file sizes then file name takes precedence. If ordering by modified date, in the event of identical dates then file name takes precedence.

Order action

Select a sort order by clicking one of the following radio buttons:

ASC: ascending order;

DESC: descending order;

Advanced settings

Use Exclude Filemask

Select this check box to enable Exclude Filemask field to exclude filtering condition based on file type:

Exclude Filemask: Fill in the field with file types to be excluded from the Filemasks in the Basic settings view.

Note:

File types in this field should be quoted with double quotation marks and seperated by comma.

Format file path to slash(/) style(useful on Windows)

Select this check box to format the file path to slash(/) style which is useful on Windows.

tStatCatcher Statistics

Select this check box to gather the Job processing metadata at a Job level as well as at each component level.

Global Variables

Global Variables

CURRENT_FILE: the current file name. This is a Flow variable and it returns a string.

CURRENT_FILEPATH: the current file path. This is a Flow variable and it returns a string.

CURRENT_FILEEXTENSION: the extension of the current file. This is a Flow variable and it returns a string.

CURRENT_FILEDIRECTORY: the current file directory. This is a Flow variable and it returns a string.

NB_FILE: the number of files iterated upon so far. This is a Flow variable and it returns an integer.

ERROR_MESSAGE: the error message generated by the component when an error occurs. This is an After variable and it returns a string. This variable functions only if the Die on error check box is cleared, if the component has this check box.

A Flow variable functions during the execution of a component while an After variable functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl + Space to access the variable list and choose the variable to use from it.

For further information about variables, see Talend Studio User Guide.

Usage

Usage rule

tFileList provides a list of files or folders from a defined directory on which it iterates

Connections

Outgoing links (from this component to another):

Row: Iterate

Trigger: On Subjob Ok; On Subjob Error; Run if; On Component Ok; On Component Error.

Incoming links (from one component to this one):

Row: Iterate.

Trigger: Run if; On Subjob Ok; On Subjob Error; On component Ok; On Component Error; Synchronize; Parallelize.

For further information regarding connections, see Talend Studio User Guide.