YADE Parameter Reference - Selection

This parameter specifies the Selection of files from a source by the following settings:

• FilePath: one or a number of file names that can be specified with an absolute or relative path.
• Directory: a folder to which the file selection is applied if no absolute path has been used for the FilePath parameter.

The specified files are expected to be available from the source for transfer by YADE.

• Schema: FilePath, FilePath
• Mapping:
  • file_path
  • FileNames
  • file_names

This parameter is used to specify an individual file or a number of files for processing. It is an alternative to the FileSpecSelection and FileListSelection.

More than one file can be specified by using a ";" between the file names. All files will be processed in the order in which they are defined in this parameter.

This parameter accepts absolute, relative and runtime paths of files that are to be processed.

In case of a relative path:

• if the parameter Directory is specified, the path of each specified file is set relative to that directory.
• otherwise the path is relative to the server's working directory, where the working directory depends on the server configuration.

In case of a runtime path (file to process for a file-order in a file_order_source job chain):

• the value must be set to ${scheduler_file_path}

• Schema: Directory, Directory
• Mapping:
  • dir

This parameter is used to specify a directory on one of the involved servers. Directories can be adressed using a folder structure, e.g. /folder1/folder2.

For Windows systems when used with the LocalSource parameter then a Windows path including a drive letter can be specified. For all server systems the standard syntax using can be used which includes forward slashes to separate folder names.

The directory can be set absolute or relative to the working directory, where the working directory depends on the server configuration. If for example a user "test" connects to an SFTP server then this user might have /home/test/ as a working directory. This applies to servers that use the home directory as the working directory. In this case you can use relative and absolute adressing as in

• data
• /home/test/data

• Schema: Recursive
• Mapping:
  • recursive
  • IncludeSubdirectories
  • include_sub_directories
  • RecurseSubFolders

This parameter specifies wether files from subdirectories should be included recursively. Recursion is effective exclusively if files are found in a directory.

• FileSpecSelection
  • Regular expression matches apply to files from subdirectories as specified by the FileSpec and ExcludedDirectories parameters.
• FilePathSelection/FileListSelection
  • YADE-600. Availability starting with 1.13.18
  • Specifies how the files should be transferred: flat in one Target folder or by creating the same sub-directories in the target system as from the source system.

This parameter specifies the Selection of files from a source by the following settings:

• FileSpec: a regular expression to select files.
• Directory: a folder to which the file selection is applied.

All files with names that correspond to the regular expression are added to a results list and are transferred by YADE.

• Schema: FileSpec, FileSpec
• Mapping:
  • file_spec
  • FileNameRegExp
  • FileNamePatternRegExp

This parameter specifies a regular expression, which is used to select files from a Directory .

All files with names that correspond to the regular expression are added to a results list and are transferred by YADE.

This parameter cannot be used with the HTTPFragment or HTTPSFragment in any file transfer operation as the respective protocols would not support to select files based on wildcards.

• Schema: Directory, Directory
• Mapping:
  • dir

This parameter is used to specify a directory on one of the involved servers. Directories can be adressed using a folder structure, e.g. /folder1/folder2.

For Windows systems when used with the LocalSource parameter then a Windows path including a drive letter can be specified. For all server systems the standard syntax using can be used which includes forward slashes to separate folder names.

The directory can be set absolute or relative to the working directory, where the working directory depends on the server configuration. If for example a user "test" connects to an SFTP server then this user might have /home/test/ as a working directory. This applies to servers that use the home directory as the working directory. In this case you can use relative and absolute adressing as in

• data
• /home/test/data

• Schema: ExcludedDirectories, ExcludedDirectories
• Mapping:
  • excluded_directories
• Release:
  • YADE-601 Availability starting with 1.13.18.

This parameter specifies a regular expression that matches the path to directories to be excluded when recursively traversing a Source directory.

• Schema: Recursive
• Mapping:
  • recursive
  • IncludeSubdirectories
  • include_sub_directories
  • RecurseSubFolders

This parameter specifies wether files from subdirectories should be included recursively. Recursion is effective exclusively if files are found in a directory.

• FileSpecSelection
  • Regular expression matches apply to files from subdirectories as specified by the FileSpec and ExcludedDirectories parameters.
• FilePathSelection/FileListSelection
  • YADE-600. Availability starting with 1.13.18
  • Specifies how the files should be transferred: flat in one Target folder or by creating the same sub-directories in the target system as from the source system.

This parameter specifies the Selection of files from a source by the following settings:

• FileList: specifies a file that contains records with file names in each line. This file is expected to be in reach of the YADE Cllient.
• Directory: a folder to which the file selection is applied.

The specified files are expected to be available from the source for transfer by YADE.

• Schema: FileList, FileList
• Mapping:
  • File_List_Name
  • FileListName

This parameter is used to specify a number of files for processing. It is an alternative to the FileSpecSelection and FilePathSelection.

This parameter specifies a file that contains records with file names in each line. The files can be specified with absolute or relative paths. Each record in this file contains the name of a file which is to be processed. All files in the file list will be processed in the sequence they appear in the file. If a file in the list does not exist then the processing will be aborted.

Future behaviour:
In case of a relative path...

• if the parameter Directory is specified, the path of each specified file is relative to that directory.
• otherwise the path is relative to the servers working directory, where the working directory depends on the server configuration.

• Schema: Directory, Directory
• Mapping:
  • dir

This parameter is used to specify a directory on one of the involved servers. Directories can be adressed using a folder structure, e.g. /folder1/folder2.

For Windows systems when used with the LocalSource parameter then a Windows path including a drive letter can be specified. For all server systems the standard syntax using can be used which includes forward slashes to separate folder names.

The directory can be set absolute or relative to the working directory, where the working directory depends on the server configuration. If for example a user "test" connects to an SFTP server then this user might have /home/test/ as a working directory. This applies to servers that use the home directory as the working directory. In this case you can use relative and absolute adressing as in

• data
• /home/test/data

• Schema: Recursive
• Mapping:
  • recursive
  • IncludeSubdirectories
  • include_sub_directories
  • RecurseSubFolders

This parameter specifies wether files from subdirectories should be included recursively. Recursion is effective exclusively if files are found in a directory.

• FileSpecSelection
  • Regular expression matches apply to files from subdirectories as specified by the FileSpec and ExcludedDirectories parameters.
• FilePathSelection/FileListSelection
  • YADE-600. Availability starting with 1.13.18
  • Specifies how the files should be transferred: flat in one Target folder or by creating the same sub-directories in the target system as from the source system.