Sun Adapter for Batch User's Guide

Pre Transfer (BatchFTPOverSSL Connectivity Map)

The Pre Transfer section allows user to customize the behaviors of protection/backup/recovery. This section describes the operation that will be performed on remote end or locally before the real file transfer.

The Pre Transfer section of the BatchFTPOverSSL Connectivity Map properties contains the top-level parameters displayed in this table.

Table 16 Connectivity Map - BatchFTPOverSSL - Pre Transfer

Name 

Description 

Required Value 

Remote Dir Name

Specifies the directory and path on the remote external system where file the is renamed or copied. This is only for Rename or Copy of the Remote Pre Command.

The value can be a literal, regular expression (source), or pattern name (destination). When specifying a destination directory, the directory is created if it doesn’t already exist. 

Special characters are allowed. The expansion of any 

special characters is carried out each time this 

parameter is used. For example, the pattern %f means the original working directory name.

See Table 16.

See Using Regular Expressions or Using Name Patterns.

A directory name and path location on the target system. 

Special characters are allowed. 

Remote Dir Name Is Pattern

Specifies whether the pattern entered for the directory represents a literal, or a name pattern or regular expression, as follows:

  • Yes: indicates that the name value you enter is assumed to be a name pattern or regular expression.

  • No: Indicates that the name value entered represents a literal, an exact match. No pattern matching or name expansion is done.

    See Table 16.

Select Yes or No.

The configured default is Yes.

Remote File Name

Specifies the file name on the external system, to which a file is renamed or copied. The value represents the file name without the path. This setting is only for the Rename or Copy operations of Pre Transfer Command parameter.

The value can be a literal, regular expression (get), or pattern name (put). 

Special characters are allowed, for example, the pattern %f indicates the original working file name. The expansion of any special characters is carried out each time this parameter is used.

See Table 16.

See Using Regular Expressions or Using Name Patterns.

A remote file name. 

Remote File Name Is Pattern

Specifies whether the pattern entered for the file name represents a literal, or a name pattern or regular expression, as follows:

  • Yes: indicates that the name value you enter is assumed to be a name pattern or regular expression.

  • No: indicates that the name value entered is a literal, an exact match. No pattern matching or name expansion is done.

    See Table 16.

Select Yes or No.

The configured default is Yes.

Remote Pre Command

Allows you to execute a desired action directly before the actual file transfer. For an inbound transfer, the file can be made unavailable to other clients polling the target system with the same directory and file pattern or name. For an outbound transfer, you can perform an automatic backup/clean-up of the existing files. The options are:

  • Rename: Rename the target file for protection or recovery.

  • Copy: Copy the target file for backup or recovery.

  • None: Do nothing.

    To gain proper protection, backup, or recovery, you must choose the appropriate setting that serves your purpose. For example, to recover from failures on an outbound appending transfer, use the Copy setting.


    Note –

    When you are using Rename , if the destination file exists, different FTP servers can behave differently. For example, on some UNIX FTP servers, the destination file is overwritten without question. That is, no error or warning message is given. On other FTP servers, a Windows XP server for example, the system generates an error that results in exceptions being thrown in the called OTD method.Be sure you are familiar with the native behavior of the corresponding FTP server. If you are in doubt, try the action at the command prompt. If the action displays an error message, it may result in an exception being thrown in the Collaboration.


Select Rename, Copy, or None.

The configured default is None.


Note –

The Copy option could slow system performance, especially if you are copying a large file.


Local Dir Name

Specifies the directory name (path) to be used by Rename or Copy. The value can be a literal, regular expression (source), or pattern name (destination).

Special characters are allowed (name pattern). The expansion of any special characters is carried out each time this parameter is used. 

See Table 16.

See Using Regular Expressions or Using Name Patterns.


Note –

When entering a path separator, use the forward slash “ / ” instead of the back slash “ \ ”. The adapter interprets the back slash as a special character. For example, use c:/temp/dir.


A directory name. 

Local Dir Name Is Pattern

Specifies whether the Local Directory Name represents a literal, or a regular expression or name pattern, as follows:

  • Yes: indicates that the name value you enter is assumed to be a name pattern or regular expression.

  • No: indicates that the name value entered is a literal, an exact match. No pattern matching or name expansion is done.

    See Table 16.

Select Yes or No.

The configured default is No.

Local File Name

Specifies the file name to be used by Rename or Copy. The value can be a literal, regular expression (get), or pattern name (put).

Special characters are allowed. The expansion of any special characters is carried out each time this parameter is used. 

See Using Regular Expressions or Using Name Patterns.

See Table 16.

A file name. 

Local File Name Is Pattern

Specifies whether the Local File Name represents a literal, or a regular expression or name pattern, as follows:

  • Yes: indicates that the name value you enter is assumed to be a name pattern or regular expression.

  • No: indicates that the name value entered is a literal, an exact match.

    See Table 16.

Select Yes or No.

The configured default is No.

Local Pre Command

Allows you to execute a desired action directly before the actual file transfer. For an inbound transfer, the file can be made unavailable to other clients polling the target system with the same directory and file pattern or name. For an outbound transfer, you can perform an automatic backup of the existing files. The options are:

  • Rename: Rename the target file for protection or recovery.

  • Copy: Copy the target file for backup or recovery.

  • None: Do nothing.

    To gain proper protection, backup, or recovery, you must choose the appropriate setting that serves your purpose. For example, to recover from failures on an outbound appending transfer, use the Copy setting.


    Note –

    Rename and Copy overwrite the file specified by the Local Dir Name and Local File Name properties, if they exist.


Select Rename, Copy, or None.

The configured default is None.


Note –

The Copy option could slow system performance, especially if you are copying a large file.