Product Knowledge Base

Space shortcuts

Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Diagram

Unable to render 'XSD Viewer' macro

Could not find the given XSD (xsd_macro7c8a4cfd5745840fb0841b7142b6445c.png) on page (JADE Parameter Reference - TransferOptions)

Elements

TransferOptions
References Notes

Transfer options specify the optional behavior of file transfer, e.g. the transactional behavior.

Element Type Required Description
BufferSize int
  • Pattern: [\-+]?[0-9]+
  • Whitespace: collapse
  • Occurrence: 0..1
Optional
References Notes

The maximum size of a data block is defined with this option.

Transactional boolean
  • Whitespace: collapse
  • Occurrence: 0..1
Optional
References Notes

This parameter specifies whether a transfer should be processed within a single transaction, i.e. either all objects are successfully transferred or none.

Should an error occur during a transfer operation then all transfers will be rolled back.

When specifying the value true then the following applies:

  • The AtomicSuffix parameter and AtomicPrefix parameter are used that cause target files to be created with a suffix such as "~" (default) and that causes the respective files to be renamed to their target file name after the transfer of all files has been successfully completed.
  • If at least one file out of a set of files cannot be transferred successfully then no files will be renamed, instead the temporarily created files are removed from the target system.
  • The parameter remove_files that causes files to be removed after successful transfer will be effective only after all files have been successfully transferred. Otherwise no files will be removed.
RetryOnConnectionError
  • Occurrence: 0..1
Optional
References Notes

To control reconnect behavior, the YADE has two options:

  • RetryCountMax - number of reconnection attempts (for each single file transfer) if there is a connection failure
  • RetryInterval - the wait interval between attempts

Transactional Transfer

This parameter specifies whether a transfer should be processed within a single transaction,

        i.e. either all objects are successfully transferred or none.

Should an error occur during a transfer operation then all transfers will be rolled back.

The following applies when the value true is specified:

  • The atomic_suffix and/or atomic_prefix parameters have to be specified to cause target files to be created on the target system with a suffix and/or prefix such as "~". 
    After the transfer has been completed, the names of these files will then be changed back to their original values.
    (See Atomicity)
  • If at least one file out of a set of files cannot be transferred successfully then no files will be renamed.
    Instead the files that were written on the target system under their temporary names will be removed.
  • The remove_files parameter that causes files to be removed after successful transfer will only be effective after all files have been successfully transferred.
    Otherwise no files will be removed.

Note:

  • Transactional transfer requires rename permission on the target host (to remove the atomic prefix / suffiux).
  • Transactional transfer is is a two phase operation and is not 100% reliable - there are situations where rollback is not possible.
    • For example, consider the situation where a number of files are transferred transactionally to a remote system, and update - i.e. overwrite - already existing files.

      • If, during the rename/overwrite transfer phase, one of the files to be overwritten has been opened by another process, access to this file will be denied and the transfer will fail.

      • The file copy or move transfer phase can be rolled back but the files that have been overwritten cannot be reverted to their previous state.

  • No labels