1

Sets the JobMode to be used in the Transfer step

Yes

If this option is set to “Yes”, the log file is deleted in the beginning before each Transfer run. This is useful if many runs are expected which only wait for new data.

<ColdBinDirectory>/<ENV_OS>/smbclient

This parameter specifies the path and filename of an executable command that is used to transfer files. In JobMode 1, for example, the Samba Client is used (smbclient).

Most of the following parameters represent settings that are required by any kind of file transfer tool such as typically user credentials and connection parameters. Further details, however, can depend on the exact tool that is used.

myFileShareUser

The username of the login credentials for file transfer

In JobMode 1 is a Samba file share user

myPassWord012XaBcD

The password of the login credentials for file transfer

In JobMode 1 is a Samba file share user’s password

Workgroup

The workgroup expected by the file transfer tool

In JobMode 1 is a Samba file share workgroup

//78.113.123.189/myShare

This parameter specifies the source location from which files are transferred.

In JobMode 1 the Samba format is used with IP/ name (e.g. //78.113.123.189/myShare).

Subdirectories are specified via <TransWorkDir>.

<SpoolType>

This parameter specifies the working directory on the remote share. It must be left empty if the top level directory is to be used.

timestamp<SpoolType>

This parameter specifies the name of a directory that is used for temporal coordination.

This directory is recreated on the file share in each connection to enable a comparison of system times and it must not contain any files. In any file transfer session only such files are transferred, which are older than this directory.

This is also needed for technical reasons since the time can differ between the source and the target system, and enables the internal mechanism to restrict the processing scope to files with some given age condition (such as a minimum age).

0-9]{4}_[0-9]{10}_DTI[0-9]{5}.<IndexFileExtension>

This parameter specifies a filename pattern based on a regular expression to determine which files are to be transferred from the source location. The pattern represents a complete filename with its file type extension.

In JobMode 1 this pattern refers to the indexing file (whereas the content file is automatically associated and managed along the way).

Regular expression quick guide:

• [0-9]{4} exactly 4 digits, e.g. 0000, 0001, 0002 up to 9999

• [B9a#] one of the characters “B”, “9”, “a” or “#”

• [e-h] one of the characters “e”, “f”, “g” or “h”

• (SIG|RECH) the string “SIG” or the string “RECH”

• . an arbitrary character

• [0-9]+ at least one digit, but any more digits are also allowed

Also see appendix “Regular Expressions” in [UM AdminClient], which provides a few more control elements and examples.

<ColdLogsBaseDirectory>/
<SpoolType>/transfer.log

This parameter specifies a log filename. If this is set, a special log file is generated which lists all files processed in the Transfer step (similar to <AcceptSummaryLogFile>).

If this value is left empty, no such file is generated.

No

If this option is set to “Yes”, no error notification is sent in case of a connection failure with the remote system, and further retry attempts are triggered later on.

A maximum number of retries is set via <TransIgnoreConnectErrorsRetryCount>, where the default is 100, which means that the Transfer retries are stopped after 100 failed connection attempts. An empty input directory does not count as a failed connection.

By default after 10 connection failures an automated e-mail is sent. If a successful connection can be re-established after such a failure, a success notification is sent. The exact number for triggering this e-mail notification is set via <TransIgnoreConnectErrorsSendEmailOnRetry>. If the value 0 is set for this parameter, the mechanism is deactivated.

<ColdDocsBaseDirectory>/
<SpoolType>/<SpoolType.Generation>

In JobModes where files are moved from the local host to a remote host, this directory represents the input directory on the local host.

Delivery_<SpoolType.Generation>

If a single file is transferred in JobMode 50 or 60, this can be renamed before the Transfer step. The new name is specified with this parameter. This is not supported for multiple files.

MD5

This parameter specifies the content that is written into an OK file. If “MD5” is set, an MD5 checksum is calculated and written into the OK file.

ok

This parameter specifies the file type extension that is used for an OK file, which signals a successful file transfer. The OK file always has the same name as the file that is transferred, with this extension that is appended.

<ColdConfigDirectory>/transfer.ini

InJobMode 98 – transfer management multiple Transfer modes can be managed via an additional configuration file whose name (and path) is set with this parameter.

Yes

If this option is set to “Yes”, all successfully transferred files in JobMode 50 and 60 are deleted from the source directory. Otherwise, the original files remain available after transfer.

1000

This parameter checks if enough space is available on the peer in an SFTP transfer. In this case an SSH login and the execution of the command “df -k” must be possible with the given user credentials. If the space is not enough, a retry attempt is undertaken later on.

The value 0 deactivates this check. Otherwise the number is a size in megabyte (MB), i.e. a value of 1000 indicates a size of 1 gigabyte (GB).

binary

This parameter specifies a transfer mode in JobMode 14, which can be one of “binary” or “ascii”.

660

In case of an SFTP transfer an additional command to change file permissions can be executed for each file. This number parameter is used in the underlying “chmod” command: chmod <number>

get 'ZH051.Z.TGA69H(-0)' tga69H.<Generation>.txt

In an SFTP transfer an additional command can be executed, which is specified via this parameter. This is explicitly required in JobMode 19, for example, in a scenario where files, which do not yet exist, need to be fetched and must be generated on the fly.

/finished

This parameter sets a directory for moving transferred files. SCP uses the rename command to achieve this (used in JobMode 13 and 14). If no directory is set with this parameter, no move is executed.

ls –l

With this parameter the list directory command “ls -l” must be set, which is used before a transfer to show the content of a directory via SFTP. However, there are SFTP servers which require a different command such as only “ls” (without the parameter “-l“) or the command “dir” (on a Windows system).

This parameter is commented out by default.

ready.txt

If a filename is set via this parameter, an empty file with this name is generated in the target directory after transfer.

<ColdSpoolBaseDirectory>/<SpoolType>/
<SpoolType.Generation>

If specified, it refers to the directory where a copy of the transferred files is stored.

ok

If a file extension is set via this parameter, in JobMode 11 files with this extension are deleted after transfer, whereas the remaining files are moved to the path <DataInputPath>.

100

See <TransIgnoreConnectErrors> (TRANS-0211)

10

See <TransIgnoreConnectErrors> (TRANS-0211)

No

This parameter is used for JobModes where files AND subdirectories can be transferred from the input directory (for example in JobMode 60).

If set to “Yes”, no files are transferred.

Also see <TransIgnoreDirs> (TRANS-0231)

No

This parameter is used for JobModes where files AND subdirectories can be transferred from the input directory (for example in JobMode 60).

If set to “Yes”, no directories are transferred.

Also see <TransIgnoreFiles> (TRANS-0230)

No

If set to “Yes”, when transfer gets finished, an overview of all data manipulating actions is sent via e-mail to <TransEmailRecipients>. The e-mail system must be configured in advance and <eMailNotification> must be also activated.

{9}

This is the recipient e-mail address of the transfer notification. Placeholders {i} are populated from <TransInputFile>.

Status – ImageMaster legal audit export

The e-mail subject of the transfer notification. Placeholders {i} are populated from <TransInputFile>.

The requested audit export with number {4}: is now ready. You can retrieve it from [FILES]

The text used for the notification e-mail if there are transfer files. There are the following placeholders:

• Placeholders {i} are populated from <TransInputFile>
• [ENTER] is replaced by a line break
• [FILES] is replaced by the names of the transfer files

The requested audit export with number {4} has no hits

The text used for the notification e-mail, if there are no transfer files. There are the following placeholders:

• Placeholders {i} are populated from <TransInputFile>
• [ENTER] is replaced by a line break

<ColdSpoolBaseDirectory>/<SpoolType>/

<SpoolType.Generation>/index.csv

Input file from which the placeholders {i} are filled.

NO-HITS\.tar\.gz$

Regular expression indicating which transfer files are not listed in the notification e-mail. This allows filtering out "NO-DATA" flag files.

Yes

Supported in JobMode 11:

Determines the behavior when there is no disk space for download:

• By default the behavior is set to “No” and processing is stopped with an error.

• With the alternative setting “Yes” processing is halted in status “Retry”.

^([FILETYPEREGEX])([^ ])[ ][^ ][ ]([0-9A-Za-z-_\.\?])[ ]([0-9A-Za-z-_\.\?])[ ][^ ][ ]([0-9])[ ](.)[ ](.+)$

Regular expression which filters the entries of the file listing created by <TransDirectoryListCmd> command. There must be exactly 7 capturing groups defined in the regular expression.

The default mask is adapted to the listing using the “ls -l” command.

1

This is the maximum number of files that will be transferred in one transfer run.