This section describes the configuration properties for the BatchSFTP OTD, accessed from the Connectivity Map.
The BatchSFTP Adapter Connectivity Map properties include the following sections:
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 BatchSFTP Connectivity Map properties contains the top-level parameters displayed in this table.
Table 34 Connectivity Map - BatchSFTP - Pre Transfer
Name |
Description |
Required Value |
---|---|---|
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 Table 34. |
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:
|
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 Table 34. |
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:
|
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:
|
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 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 Table 34. 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:
|
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 Table 34. |
A file name. |
Local File Name Is Pattern |
Specifies whether the Local File Name name represents a literal, or a regular expression or name pattern, as follows:
|
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:
|
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. |
The SFTP Settings section of the BatchSFTP Connectivity Map properties contains the top-level parameters displayed in this table.
Table 35 Connectivity Map - BatchSFTP - SFTP Settings
Name |
Description |
Required Value |
---|---|---|
Specifies whether the transfer is binary code or ASCII text. |
Select BINARY or ASCII. The configured default is BINARY. |
|
Specifies the remote server - end of line. Options are CR, LF, CRLF. |
Select CR, LF, or CRLF. CRLF is the configured default. |
|
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. |
|
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. |
|
Specifies the client authentication type. The options are as follows:
|
Select PASSWORD, HOST BASED, or PUBLICKEY. The configured default is PASSWORD. |
|
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. |
|
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 Table 35. |
The remote directory name. |
|
Specifies whether the Remote Directory Name represents a literal, or a regular expression or name pattern, as follows:
|
Select Yes or No. The configured default is No. |
|
Specifies the name of a file on the remote server. The value can be a literal, regular expression (get), or pattern name (put). See Table 35. |
The remote file. |
|
Specifies whether the Remote File Name represents a literal, or a regular expression or name pattern, as follows:
|
Select Yes or No. The configured default is No. |
|
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 Table 35. |
A local directory. |
|
Specifies the meaning of the Local Directory Name property as follows:
|
Select Yes or No. The configured default is No. |
|
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 Table 35. |
The local file. |
|
Specifies whether the local file name represents a literal, or a regular expression or name pattern, as follows:
|
Select Yes or No. The configured default is No. |
The Post Transfer section of the BatchSFTP Connectivity Map properties contains the top-level parameters displayed in this table.
Table 36 Connectivity Map - BatchSFTP - Post Transfer
Name |
Description |
Required Value |
---|---|---|
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 Table 36. |
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:
|
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 Table 36. |
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:
|
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.
|
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 Table 36. See Using Regular Expressions or Using Name Patterns. 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:
|
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 Table 36. |
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:
|
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:
|
Select Rename, Delete, or None. The configured default is None. |
The Firewall Settings section of the BatchSFTP Connectivity Map properties contains the top-level parameters displayed in this table.
Table 37 Connectivity Map - BatchSFTP - Firewall Settings
The Synchronization section of the BatchSFTP Connectivity Map properties contains the top-level parameters displayed in this table.
Table 38 Connectivity Map - BatchSFTP - Synchronization