Introduction
The selection & handling of the objects being transferred can be divided into three areas: selection, polling and directives
Object Selection
A tutorial covering the use of the dir, file_spec and recursive parameters for the selection of file objects is available.
file_path
This parameter is used to specify an individual file or files for transfer. It is an alternative to the file_spec parameter. More than one file can be specified by using a ";" between the file names.
The following parameters are ignored should this parameter be used: file_spec and remote_dir.
This is a prefixed parameter.
dir
directory
This is a prefixed parameter.
file_spec - File filtering using a regular expression
This parameter specifies a regular expression, which is used to select files from a directory. All file names that correspond to the regular expression are transferred to a results list. All files whose names are contained in this list will be transferred.
file_list_name - Name of a file which contains a file list
Each record in this file contains a file name which has to be processed. All files in the file list will be processed in the the sequence they appear in the file.
recursive - Include subfolders in operation
This parameter specifies whether files from subdirectories should be included recursively.
Only effective if file is a directory.
Regular expression matches apply to files from subdirectories as specified by the parameter file_spec.
recursive is a data source only parameter.
Polling for objects
JADE can poll a source directory at regular intervals until it finds a file name match, until a specified length of time has elapsed or until a minimum number if files have been found. If it finds a file name match with one or more files it will then transfer the matching file(s) and then stop polling.
A tutorial and download configuration showing the use of the main polling parameters is available.
poll_interval - Wait time interval between two poll actions
This parameter specifies the time in seconds to wait, until a new try to poll for the files is made.
poll_minfiles - Minimum Number of Files expected
This parameter specifies the minimum number of files that have to be found during the polling period in order to cause the transfer to start.
This parameter is effective only with the parameter poll_timeout.
poll_timeout - Max time to poll for files
This parameter specifies the time in minutes, how long a file is polled for. Polling will not be carried out if the value of this parameter is zero.
If a file becomes available within the time specified then it will be transferred, otherwise an error will be raised.
poll_keep_connection - Keep connection while polling
Keep connection between polling actions.
waiting_for_late_comers - Should late-comers be waited on?
Should late-comers be waited on after poll_timeout has been exceeded but poll_minfiles has not yet been met? NOT TESTED
poll_error_state - Name of next node in job-chain if polling failed
Specifies the name of an (error) state to which the order is set if the poll_timeout has expired, without getting a file.
If no state if specified, an error will be raised.
Directives
A tutorial covering the use of the zero-byte parameter directive is available
force_files - Raise Error, if no files found for transfer
This parameter specifies whether an error should be raised if no files could be found for transfer. If the value is false no error is reported.
The number of files to be transferred is determined by the file_spec or file_path parameters and can be restricted by the overwrite_files parameter should this be specified with the value false.
Note that the force_files parameter strongly affects the behavior of the zero_byte_transfer parameter.
force_files is a data source only parameter.
zero_byte_transfer
The JADE Client can filter files with zero bytes using the zero_byte_transfer parameter.
This parameter specifies whether or not zero byte files should be transferred and processed by subsequent commands and whether an error should be raised if a zero byte file is found.
Note that the use of the zero_byte_transfer parameter strongly depends on whether the force_files and force_files parameters are set.
zero_byte_transfer is a data source only parameter.
remove_files
This parameter specifies whether files on the source server should be removed after transfer.
Note that the remove_files parameter has unrestricted validity: files with zero byte size will be removed regardless of whether or not they have been transferred.
remove_files is a data source only parameter.