Introduction
The selection & handling of the objects being transferred can be divided into three areas: selection, polling and directives.
Checking files for completeness is handled in the next page.
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.
All files will be processed in the order they are defined in this parameter.
The following applies when files are being received:
- This parameter accepts the absolute name and path of file at the server that should be transferred.
- The file name has to include both name and path of the file at the server.
- The file will be stored under its name in the directory that is specified by the local_dir parameter.
- The following parameters are ignored should this parameter be used:
- file_spec and
- remote_dir.
The following applies when files are being sent:
- This parameter accepts the absolute name and path of file that should be transferred.
- The file will be stored under its name in the directory at the FTP/SFTP server that has been specified by the remote_dir parameter.
- The following parameters are ignored should this parameter be used:
- file_spec and
- local_dir.
Data-Type: SOSOptionString
This is a prefixed parameter.
dir - The path to the source or target directory
This is a prefixed parameter.
local_dir - The local directory to be used for file transfer
Local directory into which or from which files should be transferred. By default the current working directory is used.
Besides paths in the local file system UNC path names are supported that could be used to address remote server systems: \\somehost\somedirectory can be used in the same way as //somehost/somedirectory to transfer files from a server to a different remote server system.
In addition, URIs can be specified using the schema file:////somehost/somedirectory (with close attention being paid to the number of slashes). File URIs are subject to the following limitations due to constraints of the underlying Java JRE:
File names and path names must not contain any spaces.
file:////user:password@somehost/somedirectory is not supported.
local_dir is a data source only parameter.
The default value for this parameter is ..
This parameter is mandatory.
remote_dir - The remote directory to be used for file transfer
Directory on a server which files should be transferred to or from.
By default this is the home directory of the user on the server.
The default value for this parameter is ..
This parameter is mandatory.
alternative_remote_dir
Alternative parameter for the primary remote_dir 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.
The default value for this parameter is .*.
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.
If a file in the list does not exist the processing will be aborted. OF ALL FILES?
/home/test/abc.de /inbound/daily/cde.dat /work/hello.world
The above file llist files contains three records. Each record contains the name of a file to be processed.
The default value for this parameter is .
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.
Polling parameters are not prefixed.
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.
The default value for this parameter is 60.
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.
The default value for this parameter is 1.
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.
If a (or more) file(s) are received the polling will be stopped.
The default value for this parameter is 0.
poll_keep_connection - Keep connection while polling
Keep connection between polling actions.
The default value for this parameter is false.
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
Valid values: true, 1, on, yes, y, ja, j and false, 0, off, no, n, nein.
The default value for this parameter is false.
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.
The default value for this parameter is .
polling_end_at
wait for source folder
Poll_Error_State
Next state in Chain if no files found
polling_server
Act as a polling server
polling_server_duration
How long the Polling Server should run
polling_server_poll_forever
Poll forever
pollingdurationIS ALIAS FOR POLL_TIMEOUT?
The duration of the polling period.
Directives
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.
Valid values: true, 1, on, yes, y, ja, j and false, 0, off, no, n, nein.
The default value for this parameter is true.
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 remove_files parameters are set (see below).
The following settings are available:
- yes
Files with zero byte size are transferred (default). - no
Files with zero byte size are transferred, should at least one of the files have more than zero byte size. - strict
Files with zero byte size are not transferred. An error will be raised if any zero byte file is found. - relaxed
Files with zero byte size will not be transferred. However, no error will be raised if this results in no files being transferred.
Use of this parameter can be refined using the force_files parameter: should force_files have the value false, then processing will be treated as successful in the event of no files having been transferred.
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.
zero_byte_transfer is a data source only parameter.
The default value for this parameter is yes.
A tutorial covering the use of the zero-byte parameter directive is available.
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.
The default value for this parameter is false.
Skip transfer of files
skip_first_files - Remove files from the top of the result set
The number of files to remove from the top of the result-set.
skip_last_files - Remove files from the bottom of the result set
The number of files to remove from the bottom of the result-set.
skip_transfer - Execute all options except transfer
If this Parameter is set to true then all operations except for the transfer itself will be performed. This can be used to just trigger for files or to only delete files from a server.