Configuring Batch Adapter BatchSFTP Adapter Connectivity Map Properties

Remote Dir Name

Specifies the directory name (path) on the remote external system where the 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).

For outbound (destination), 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 the Remote Dir Name Is Pattern property.

A directory name. 

Remote Dir Name Is Pattern

Specifies whether the Remote 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 the Remote Dir Name property.

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. 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 the Remote File Name Is Pattern property.

The file name. 

Remote File Name Is Pattern

Specifies whether the Remote 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. No pattern matching or name expansion is done.

See the Remote File Name property.

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.

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

Local Dir Name

Specifies the local 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. The expansion of any special characters is carried out each time this parameter is used. 

See the Local Dir Name Is Pattern property.

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.

See the Local Dir Name property.

Select Yes or No.

The configured default is No.

Local File Name

Specifies the local 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 the Local File Name Is Pattern property.

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. No pattern matching or name expansion is done.

See the Local File Name property.

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.

  ---

See the Using Name Patterns.

Select Rename, Copy, or None.

The configured default is None.

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

Transfer Mode

Specifies whether the transfer is binary code or ASCII text. 

Select BINARY or ASCII.

The configured default is BINARY.

Remote EOL

Specifies the remote server - end of line. Options are CR, LF, CRLF.

Select CR, LF, or CRLF.

CRLF is the configured default.

Transfer Block Size

Specifies the block size used when transferring files. Do not increase the default, as the remote server may not be able to support higher blocksizes.

An integer indicating the block size used when transferring files. 

The configured default is 32768.

Local Read Buffer Size

Specifies the size (in bytes) of the buffer which is used to read from the local file system.

An integer indicating the size (in bytes) of the local read buffer. A value of -1 indicates that the whole local file is read at once.

Authentication Type

Specifies the client authentication type. The options are as follows:

• PASSWORD

• HOSTBASED

• PUBLICKEY

  Refer to your specific SSH server documentation for information regarding your authentication type.

Select PASSWORD, HOST BASED, or PUBLICKEY.

The configured default is PASSWORD.

Do Host Key Verification

Specifies whether SSH server authentication by verification of the public key, is enabled.

Select Yes or No.

Yes enables SSH server authentication by verifying the public key.

The configured default is Yes.

Remote Directory

Specifies the directoryname (path) on the SSH (with SFTP sub-system) server where data is sent or received. The accessibility of the directory usually depends on the login user. The value can be a literal, regular expression (source), or pattern name (destination).

See the Remote Directory Name is Pattern property.

The remote directory name. 

Remote Directory Name is Pattern

Specifies whether the Remote 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 the Remote Directory property.

Select Yes or No.

The configured default is No.

Remote File

Specifies the name of a file on the remote server. The value can be a literal, regular expression (get), or pattern name (put).

See the Remote File Name Is Pattern property.

The remote file. 

Remote File Name Is Pattern

Specifies whether the Remote 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. No pattern matching or name expansion is done.

See the Remote File property.

Select Yes or No.

The configured default is No.

Local Directory

Specifies the local directory name (path) for sending or recieve files on the remote server. The value can be a literal, regular expression (source), or pattern name (destination).

See the Local Directory Name Is Pattern property.

A local directory. 

Local Directory Name Is Pattern

Specifies the meaning of the Local Directory Name property 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 the Local Directory property.

Select Yes or No.

The configured default is No.

Local File

Specifies the local file to be sent or received on the remote server. The value can be a literal, regular expression (get), or pattern name (put).

See the Local File Name Is Pattern property.

The local file. 

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. No pattern matching or name expansion is done.

See the Local File property.

Select Yes or No.

The configured default is No.

Remote Dir Name

Specifies the directory name (path) on the remote system where the file the will be renamed or copied. T This is only for Rename or Copy of the Post Transfer Command. The value can be a literal, regular expression (source), or pattern name (destination).

For outbound (destination), the directory is created if it doesn’t already exist. 

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

See the Remote Dir Name Is Pattern property.

A directory name. 

Remote Dir Name Is Pattern

Specifies whether the Remote 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 the Remote Dir Name Is Pattern property.

Select Yes or No.

The configured default is Yes.

Remote File Name

Specifies the file name on the external system. This setting is only for the Rename or Copy operations of Post 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 the Remote File Name Is Pattern property.

A file name. 

Remote File Name Is Pattern

Specifies whether the Remote 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. No pattern matching or name expansion is done.

See the Remote File Name property.

Select Yes or No.

The configured default is Yes.

Remote Post Command

Allows you to execute a desired action directly after the actual file transfer. For an inbound transfer, it can be applied to mark the transferred file as consumed by making an automatic backup (Rename) or by destroying it permanently (Delete). For an outbound transfer, it can be applied to make the transferred file available to other clients by renaming it.

• Rename: Rename the transferred file.

• Delete: Delete the transferred file.

• None: Do nothing.

  ---

  Note –

  For Rename , if the destination file exists, different FTP servers may behave differently. For example, on some UNIX FTP servers, the destination file will be overwritten without extra message. On an NT FTP server, this will fail and get an exception. It does not define unified behavior, rather, it follows the native behavior of the corresponding FTP server.

  ---

Select Rename, Delete, or None.

The configured default is None.

Local Dir Name

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

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

See the Local Dir Name Is Pattern property.

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 the Local Dir Name property.

Select Yes or No. The configured default is No.

Local File Name

Specifies the local file name to be used by Rename. 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 the Local File Name Is Pattern property.

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. No pattern matching or name expansion is done.

See the Local File Name property.

Select Yes or No.

The configured default is No.

Local Post Command

Allows you to execute a desired action directly after the actual file transfer. For an inbound transfer, the target file can be marked as consumed by making an automatic backup (Rename) or by destroying it permanently (Delete).

For an outbound transfer the target file can be made available to other clients by renaming it. The options are: 

• Rename: Rename the target file.

• Delete: Delete the target file (inbound transfers only).

• None: Do nothing.

  ---

  Note –

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

  ---

Select Rename, Delete, or None.

The configured default is None.

Use Firewall

Specifies whether a firewall is used.

Select Yes or No.

Yes indicates that you are using a firewall.

The configured default is No.

SOCKS Version

Specifies the SOCKS version of the firewall.

The supported options are 4 for SOCKS version 4, or 5 for SOCKS version 5.

Select 4 for SOCKS version 4, or 5 for SOCKS version 5.

The configured default is 5

Synchronized

Specifies whether the adapter simulates the pre- version 5.1 adapter behavior in which the adapter runs synchronized or in parallel. The selections are: 

• Yes: The adapter run in synchronized mode, one instance of the Collaboration after the other.

• No: The adapter run in parallel, creating multiple instances of the Collaboration that run in parallel.

  ---

  Note –

  All OTD instances used in a Project should have the same value for this property.

  ---

Select Yes or No.

The default setting is No.