YADE Parameter Reference - TargetFileOptions

• Schema: AppendFiles
• Mapping:
  • append_files

This parameter specifies wether the content of a source file should be appended to the target file, should the target file exist.

• By default no file content is appended to the target file wich corresponds to the value "false".
• With a value "true" the content of source files will be appended to the corresponding target files.

If AppendFiles is specified with the value "true" then the parameter DisableOverwriteFiles will be ignored.

• Schema: Atomicity, Atomicity

YADE uses a temporary (atomic) prefix and/or suffix to mask the presence of a file being transferred until the transfer has completed.

• Schema: CheckSize
• Mapping:
  • check_size
  • CheckFileSizeAfterTransfer

This parameter specifies that after transfer of each file to a target server YADE will try to read the file from the target server and compare the number of bytes of the original file on the source server and the file on the target server.

• The default value of this parameter is "true".
• If set to "false" the the size of the source and target file will not be checked.

• Schema: CumulateFiles, CumulateFiles
• Mapping:
  • cumulate_files
  • CumulateFiles

This option determines whether the individual files from the results list should be transferred individually and then should be cumulated (i.e. concatenated into a single file) to the transfer target. The name of the cumulative file is specified using the CumulativeFilename parameter.

The CumulativeFileSeparator parameter is used to specify a string that is added to the target file, between the individual files in order to allow these files to be separated later on.

• By default no files are cumulated which corresponds to the value "false".
• When set to "true" then files will be cumulated.

Should the source files be deleted after transfer then the Move operation can be used.

• Schema: CompressFiles, CompressFiles
• Mapping:
  • compress_files

This parameter specifies whether or not the content of the source files should be compressed for the target files using a zip algorithm.

In case of sending files each file will be compressed in a single zip file. The extension of the filename is configured with the parameter CompressedFileExtension. A gzip-compatible compression is used, no further software components are required.

• By default no files will be compressed which corresponds to the value "false".
• Setting this parameter to the value "true" will cause target files to be compressed.

The following parameters are ignored should CompressFiles be used:

• AppendFiles
• CheckSize

• Schema: CreateIntegrityHashFile
• Mapping:
  • create_security_hash_file
  • CreateSecurityHashFile

This parameter causes a checksum file to be created on the target server that contains the integrity hash value. The file name is created by using the target file name and adding the hash algorithm as an extension, e.g. a target file "myFiles.tar.gz" will cause the integrity hash file "myFiles.tar.gz.md5" to be created when using MD5 with the HashAlgorithm parameter.

• Schema: KeepModificationDate
• Mapping:
  • keep_modification_date

This parameter specifies that YADE will try to assign the modification date of the source file to the target file.

• By default the current date is used when creating or modifying files on a target server which corresponds to the value "false".
• If set to the value "true" then the modification date of each source file is assigned to the target file.

This functionality makes use of commands that are specific for the file transfer protocol, e.g. FTP, SFTP, and is therefore not available for all protocols. In addition server side settings might restrict the use of such commands.

• Schema: DisableMakeDirectories
• Mapping:
  • make_dirs
  • createFoldersOnTarget
  • create_folders_on_target

This parameter specifies that YADE will try to create the directory on the target server that is specified with the Directory parameter should this directory not exist. This parameter has no effect on the subfolders during a recursive transfer. Subfolders of recursive transfer are always created if they do not exist.

• By default target server directories will be created which corresponds to the value "false".
• A value "true" would prevent directories from being created on target servers.

This functionality makes use of commands that are specific for the file transfer protocol, e.g. FTP, SFTP, and is therefore not available for all protocols. Please consider that server side settings might restrict the use of such commands.

• Schema: DisableOverwriteFiles
• Mapping:
  • overwrite_files

This parameter specifies whether existing target files can be overwritten in a file transfer.

• By default target files will be overwritten which corresponds to the value "false".
• A value "true" would prevent target files from being overwritten.