Configuring Java CAPS Project Components for Communication Adapters

Pre Transfer (BatchFTP Connectivity Map)

Pre-transfer operations are those performed before the file transfer.

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

Table 12 Connectivity Map - BatchFTP - Pre Transfer

Name 

Description 

Required Value 

Pre Directory Name

Specifies the directory name (path) on the external system to which a file is renamed or copied. The value can be a literal or a pattern name.

This setting is only for the Rename or Copy operations of the Pre Transfer Command parameter.

For outbound transfers, the directory is created if it does not already exist. 

See Pre Directory Name Is Pattern property.

See Using Name Patterns.

Enter the exact name of the directory (with the path), enter a pattern name, or select one of the following values: 

  • %f

  • %f.%y%y%y%y%M%M%d%d

    .%h%h%m%m%s%s%S%S%S

  • %f.copy

  • %f.rename

Pre Directory Name Is Pattern

Specifies whether the directory name is interpreted as literal or as a name pattern, as follows:

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

    See Pre Directory Name property.

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

Select Yes or No.

The configured default is Yes.

Pre File Name

Specifies the file name on the external system, to which a file is renamed or copied. The value represents the file name. The value can be a literal or pattern name.

This setting is only for the Rename or Copy operations of the Pre Transfer Command parameter.

Special characters are allowed, for example, the pattern %f indicates the original working file name.

See Pre Directory Name Is Pattern property.

See Using Name Patterns.

Enter the exact name of the file, enter a pattern name, or select one of the following values: 

  • %f

  • %f%#

  • %f.%y%y%y%y%M%M%d%d.%h%h

    %m%m%s%s%S%S%S

  • %f.copy

  • %f.rename

Pre File Name Is Pattern

Specifies whether the file name represents a literal or a name pattern, as follows:

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

    See Pre File Namesproperty.

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

Select Yes or No.

The configured default is Yes.

Pre Transfer 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 or 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.


Where to Go Next

For information on Batch FTP SOCKS configuration, go to SOCKS (BatchFTP Connectivity Map).

More Information

Related Topics

For links to the other topics for this Adapter, go to Related Topics for Sun Adapter for Batch/FTP.