Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • the User Manual FileTransferOptions article which contains a description of how the Transactional parameter used to ensure that transfer of a group of files has been completed.
  • the Atomicity Parameter Reference article for a description of the AtomicPrefix and AtomicSuffix parameters which are used to ensure that transfer of individual files has been completed..

...

File selection is specified in the Profiles branch of the configuration and can be applied to for all the Operations that can be defined for JADE: Copy, Move etc.

File selection is a source side operation , and the JADE file transfer options are all specified as child elements of the SourceFileOptions element.

This configuration hierarchy is shown for the Copy operation as follows:

...

Exact definitions for each file selection element and the interaction between elements can be found in the Selection Parameter Reference.

Checking files for availability before transfer (CheckSteadyState)

The CheckSteadyState option can be used as a method for checking that a file is fully available at the file transfer source, for example, when waiting for the receipt of large files before processing.

...

Directives can be seen as optional parameters that specify how JADE is to generally react at the file transfer source.

The Directives element itself is a child of the SourceFileOptions elements:

  • SourceFileOptions
    • Selection (required)
    • Directives (optional)
      • DisableErrorOnNoFilesFound

      • TransferZeroByteFiles

    • Other optional source file elements

...

  • DisableErrorOnNoFilesFound

    • The DisableErrorOnNoFilesFound parameter allows the default behavior of JADE to be changed.
      Note that the use of this parameter can modify the behavior of JADE when TransferZeroByteFiles is set.

  • TransferZeroByteFiles

    • The TransferZeroByteFiles parameter specifies how JADE is to handle zero byte files - i.e. whether they are to be transferred and processed by subsequent commands.
      See the Parameter Reference for a details about how this parameter interacts with the Remove and DisableErrorOnNoFilesFound parameters.

Polling for files

JADE can use Polling to wait for incoming files. The files to be polled are specified with the Selection element and polling can be is used to specify, for example, how often and how long should be polled.

...

A detailed list of the polling parameters that can be set and their definitions can be found in the Polling section of the Parameter Reference.

...

A detailed description of the file filtering elements listed above can be found in the SourceFileOptions Parameter Reference.

This configuration hierarchy relevant for the SourceFileOptions parameters where a Copy operation is specified is:

...

File handling is specified in the Profiles branch of the configuration and can be applied to those Operation elements that can be defined for JADE: Copy, Move etc.

File handling is a target side operation, and the JADE file handling options are all specified as child elements of the TargetFileOptions element.

This configuration hierarchy is shown for the Copy operation as follows:

...

If we have two files to be transferred: file_a and file_b and a file_a already exists in the target directory, then the contents of the file_a being transferred will be appended to the already existing file_a. file_b will be written to the target directory as usual.

Atomicity

The Atomicity parameter is used to mask the presence of a file being transferred to a directory that may be monitored until the file has been fully transferred.

See the parameter reference for a detailed description of this parameter and its interaction with other elements.

...

  • CheckSize

    When specified, the CheckSize parameter causes the size (i.e. the number of bytes) of the files in the source and target directories to be compared.

    This method is not as accurate as CheckIntegrityHash.

  • CheckIntegrityHash

    The CheckIntegrityHash element causes integrity hash sums to be calculated for the files at source and target after transfer. If the hashes are not equal then the transfer will be rolled back.

    This method is more accurate than the JADE User Manual - File Selection, Handling and Renaming and the Target Directory method.

...

This behavior can be altered with the DisableErrorOnNoFilesFound element, which is a child of the Directives element and which is itself a child of the SourceFileOptions elements.

See the DisableErrorOnNoFilesFound parameter reference article for more detailed information about this element, in particular on its interaction with the FileSpec, FilePath and FileList elements.

...

This option is protocol-dependent and requires that the necessary permissions are available.

See the TargetFileOptions Parameter Reference for more detailed information about this parameter and its functioning with different protocols.

...

The DisableMakeDirectories element specifies whether JADE is to create a target directory if the directory specified in the Directory parameter is not available.

This option is protocol-dependent and requires that the necessary permissions are available.

See the TargetFileOptions Parameter Reference for more detailed information about this parameter and its functioning with the Recursive parameter and different protocols.

...

File renaming is specified using the Rename element, and can be applied at either the source or target sides of a file transfer.

...

A detailed description of the possible file name replacement patterns can be found in the Rename element parameter reference.

See also Atomicity.

The Target Directory

The Directory Element

The Directory element defines the target folder for a file transfer and is required for the Copy and Move operations.

For a Copy operation, the Directory element is specified as a sibling element of the CopyTargetFragmentRef and TargetFileOptions elements as shown schematically below.

...

These elements are children of the TargetFileOptions element and are described in the JADE User Manual - File Selection, Handling and Renaming and the Target Directory section above.

...