Skip to end of metadata
Go to start of metadata

Diagram

Elements

CumulateFiles
References Notes

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.

Element Type Required Description
CumulativeFileSeparator string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 0..1
Optional
References Notes

This parameter is used to specify a string that is placed in the target file as a separator between the content of the individual files in order to be able to parse file boundaries later on.

The following special variables are available:

  • See:
  • Date/time variables:
    • $date - the current date in yyyy-MM-dd format.
    • $time - the current time in Format HH:mm:ss format.
  • Directory variables:
    • ${TargetDirFullName} - the directory where files are stored on the target system.
    • ${SourceDirFullName} - the directory where files are stored on the source system.
  • The name of a file on the target host:
    • ${TargetFileFullName}
    • ${TargetFileRelativeName}
    • ${TargetFileBaseName}
    • ${TargetFileParentFullName}
    • ${TargetFileParentBaseName}
  • The name of a file on the target host during transfer (a file name can be prefixed or suffixed):
    • ${TargetTransferFileFullName}
    • ${TargetTransferFileRelativeName}
    • ${TargetTransferFileBaseName}
    • ${TargetTransferFileParentFullName}
    • ${TargetTransferFileParentBaseName}
  • The name of a file on the source host:
    • ${SourceFileFullName}
    • ${SourceFileRelativeName}
    • ${SourceFileBaseName}
    • ${SourceFileParentFullName}
    • ${SourceFileParentBaseName}
  • The name of a file on the source host after Rename operation:
    • ${SourceFileRenamedFullName}
    • ${SourceFileRenamedRelativeName}
    • ${SourceFileRenamedBaseName}
    • ${SourceFileRenamedParentFullName}
    • ${SourceFileRenamedParentBaseName}
CumulativeFilename string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 0..1
Optional
References Notes

The CumulativeFilename parameter specifies the name of the cumulative file.

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

The CumulativeFileDelete parameter causes the target file into which the content of the source files is concatenated to be deleted before transfer. Otherwise the content of the source files will be appended to the target file.

 

  • No labels
Write a comment…