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 Table 1.

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:

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

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

  See Table 1.

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 Table 1.

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:

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

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

  See Table 1.

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.

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

Socks Enabled

Specifies whether the FTP command connection goes through a SOCKS server.

If you choose No, the adapter does not connect to a SOCKS server. In this case, all other parameters under the SOCKS section are ignored.

If this parameter is set to Yes , the host name under the FTP configuration could fail to resolve some names, such as localhost or 127.0.0.1 correctly. Use real IP or machine names to represent the hosts. See Table 11 for more details.

Select Yes or No.

The configured default is No.

Socks Version

Specifies the SOCKS server version. If you choose Unknown, the adapter detects the actual version for you.

For the best performance, specify the version number, 4 or 5.

Select 4, 5, or Unknown.

The configured default is Unknown.

Command Connection Timeout

Allows you to set the timeout of the FTP command/control connection socket. Normally, the larger the file you are transferring, the higher this value must be. Of course, the quality of the network connection also affects this setting.

The value is in milliseconds. A timeout of zero is interpreted as an infinite timeout. 

An integer from 0 to 2147483647.

The configured default is 45000.

Data Connection Timeout

Allows you to set the timeout of the FTP data connection socket. Normally, a slow or busy network connection requires a higher timeout setting.

The value is in milliseconds. A timeout of zero is interpreted as an infinite timeout. 

For setting the timeout of the command/control connection socket, see the parameter Command Connection Timeout.

An integer from 0 to 2147483647.

The configured default is 45000.

Directory Listing Style

Specifies the system that reflects the remote host. This parameter is used to determine the format in which the LIST command returns file-listing information.The Directory Listing Style values include User Defined1 - User Defined10 values. These user defined properties allow you to create multiple user-defined FTP heuristic configurations, and make these selectable from the BatchFTP Adapter properties.

You can create corresponding heuristic configurations in the FtpHeuristics.cfg file under the User Defined sections. For more information on setting user defined FTP heuristic properties, see To Modify the FTP Heuristics Configuration File).

This property is superseded by any value specified in the User Defined Directory Listing Style property (see Table 3 ). The User Defined Directory Listing Style property value must be blank (empty) to enable the Directory Listing Style property

One of the following values: 

• UNIX

• AS400

• AS400-UNIX

• HCLFTPD 6.0.1.3

• HCLFTPD 5.1

• HP NonStop/Tandem

• MPE

• MSFTPD 2.0

• MSP PDS (Fujitsu)

• MSP PS (Fujitsu)

• MVS GDG

• MVS PDS

• MVS Sequential

• Netware 4.11

• NT 3.5

• NT 4.0

• UNIX

• UNIX (EUC-JP

• UNIX (SJIS)

• User Defined

• User Defined (1-10)

• VM/ESA

• VMS

• VOS3 PDS (Hitachi)

• VOS3 PS (Hitachi)

• VOSK (Hitachi)

For more information, see Using FTP Heuristics.

User Defined Directory Listing Style.

Specifies the name of a user-defined directory listing style (heuristics) that is available in the user-created FTP heuristics configuration file located on the logical host.

This property works in conjunction with the properties Table 3 and Table 11.

For details on how to use the User Defined Directory Listing Style seeTo Create a Custom Heuristics Configuration File

The BatchFTP OTD will generate an exception if a selected User Defined Directory Listing Style or the User Defined Heuristics Configuration File path is not defined correctly. If a User Defined Directory Listing Style is specified, a corresponding value must also be provided for the User Defined Heuristics Configuration File property.

A text string value (default to blank) representing the directory listing style (heuristics) name which is defined in a user supplied heuristics configuration file. 

Use PASV

Allows you to prompt the adapter to enter either the passive or active mode.

Normally, when you connect to an FTP site, the site establishes the data connection to your computer. However, some FTP sites allow passive transfers, meaning that your computer establishes the data connection. 

By default, the passive mode is used. It is recommended that you use this mode for transfers to and from FTP sites that support it. 

The passive mode can be required in the following situations: 

• For users on networks behind some types of router-based firewalls

• For users on networks behind a gateway requiring passive transfers

• If transfers are erratic

• If data-channel errors are prevalent in your environment

Select Yes or No.

The configured default is Yes.

Mode

Specifies the mode used to transfer data to or from the FTP server, using the Ascii, Binary, or Ebcdic mode.

If you choose Ebcdic, make sure of the following: 

• Your FTP server supports the EBCDIC mode.

• You are processing EBCDIC data.

Select Ascii, Binary, or Ebcdic.

The configured default is Binary.

Post Transfer Raw Commands

Specifies the FTP raw commands to be used directly after the file-transfer command. For example, some SITE commands use a ; (semi-colon) to separate the command set, as displayed in this example:

SITE RECFM=FB;SITE LRECL=50;SITE BLOCKSIZE=32750;SITE

    TRACKS;SITE PRI=5;SITE SEC=5

These commands are sent one by one, in the sequence they are listed. 

Certain combinations of post-transfer raw commands can cause the loss of data if there is a failure on the FTP server. For example, if the inbound post-transfer command is Delete , and your post-transfer raw commands fail, the deleted file is not recoverable.

One or more valid FTP raw commands. 

These commands are sent to the FTP server directly and are not interpreted by the adapter in any way.

Pre Transfer Raw Commands

Specifies the FTP raw commands to be used directly before the file-transfer command. For example, some SITE commands use a ; (semi-colon) to separate the command set:

SITE RECFM=FB;SITE LRECL=50;SITE BLOCKSIZE=32750;SITE

    TRACKS;SITE PRI=5;SITE SEC=5

These commands are sent one by one, in the sequence they are listed. 

One or more valid FTP raw commands. 

These commands are sent to the FTP server directly and are not interpreted by the adapter in any way.

Max Sequence Number

Use this parameter when you have set up the target directory or file name to contain a sequence number. It tells the adapter that when this value (the Max Sequence Number) is reached, to reset the sequence number to the Starting Sequence Number value.

This parameter is used for the name pattern %#.

See Using Name Patterns.

An integer from 1 to 2147483647. The value of Max Sequence Number must be greater than that of Starting Sequence Number.

Starting Sequence Number

Use this parameter when you have set up the target directory or file name to contain a sequence number. It tells the adapter which value to start with in the absence of a sequence number from the previous run.

This parameter is used for the name pattern %#.

When the Max Sequence Number value is reached, the sequence number rolls over to the Starting Sequence Number value.

See Using Name Patterns.

An integer from 0 to 2147483647. The value of the Starting Sequence Number must be less than the Max Sequence Number value.

Post Directory Name

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

For an outbound transfer (to destination), the directory is created if it does not already exist. This setting is only for the Rename operation of the Post Transfer Command parameter.

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

See Table 6.

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%#

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

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

• %f.rename

Post Directory Name Is Pattern

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

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

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

  See Table 6.

Select Yes or No.

The configured default is Yes.

Post File Name

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

This setting is only for Rename operation of Post Transfer Command parameter.

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

See Table 6.

See Using Name Patterns.

Enter the exact name of the file, 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.rename

Post File Name Is Pattern

Specifies whether the pattern entered for the file name is interpreted as literal or as a name pattern , as follows:

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

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

  See Table 6.

Select Yes or No.

The configured default is Yes

Post Transfer Command

Allows you to execute a desired action directly after the actual file transfer or during the “commit” phase.

For an inbound transfer, you can mark the transferred file as “consumed” by making an automatic backup (Rename) or by destroying it permanently (Delete). For an outbound transfer, you can make the transferred file available to other clients by renaming it. The options are:

• Rename: Rename the transferred file.

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

• None: Do nothing.

  ---

  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 is likely to result in an exceptions being thrown in the Collaboration.

  ---

Select Rename, Delete, or None.

The configured default is None.

Append

Specifies whether to overwrite or append the data to the existing file. Use this parameter for outbound FTP transfers only. Choose the appropriate setting as follows:

• If you select Yes and the target file already exists, the data is appended to the existing file.

• If you select No, the adapter overwrites the existing file on the remote system.

  If a file with the same name does not exist, both Yes and No create a new file on the external host.

Select Yes or No.

The configured default is No.

Target Directory Name

Specifies the directory on the external system from which files are retrieved or sent. The directory name and path is preferred, otherwise, the path is relative to your home directory when you log on to the FTP server.

The value can be a literal, regular expression (source), or pattern name (destination). 

For outbound FTP operations (destination), the directory is created if it does not already exist. 

See Table 7.

See Using Regular Expressions or Using Name Patterns.

A directory name and path on the target external system. 

Target Directory Name Is Pattern

Specifies whether the directory name is represented as literal, or as a regular expression or name pattern, as follows:

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

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

  See Table 7.

Select Yes or No.

The configured default is No.

Target File Name

Specifies the name of the remote FTP file to be retrieved or sent. The value can be a literal, regular expression (get), or pattern name (put).

For MVS GDG systems, the target file name can be the version of the data set, for example: 

• Target directory name = ”STC.SAMPLE.GDGSET’

• Target file name = (0) to indicate the current version

  See Table 7.

  See Using Regular Expressions or Using Name Patterns.

For inbound: a literal file name or a regular expression. 

For outbound: a literal file name or name pattern. 

Target File Name Is Pattern

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

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

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

  See Table 7.

Select Yes or No.

The configured default is Yes.

SSH Channel Established

Specifies whether the adapter needs to launch an SSH subprocess.

Selecting No indicates that the SSH channel has not yet been established. The adapter spawns a subprocess internally then establishes the channel on your behalf.

If you select No, you must set the following parameters:

• SSH Command Line

• SSH Listen Port (Environment property)

  If you select No, setting the following parameters is optional:

• SSH User Name (Environment property)

• SSH Password (Environment property)

  Selecting Yes indicates that an SSH channel has already been established. That is, the channel has already been started outside the adapter, and the adapter does not need to establish it. For example, you could have issued a command outside of Java CAPS, or you could know that another Batch Adapter instance has already established the channel by the time this adapter runs.

  If you select Yes, you must set the following parameters:

• SSH Listen Host (Environment property)

• SSH Listen Port (Environment property)

Select Yes or No.

The configured default is No.

SSH Command Line

Specifies the command line used to establish an SSH channel. This parameter is required only when you set the SSH Channel Established parameter to No.

This entry must be the complete, correct command line required by the additional software application you are using to support SSH tunneling. This command line is executed as it is, so you must be sure of the following: 

• It contains all the necessary arguments

• The syntax is correct

• It is compliant with your SSH-environment

  To verify these requirements, test this command line manually outside of Java CAPS to make sure it works correctly. Execute the command line from the shell and ensure that it does not prompt for any additional user input. If it does, continue to add whatever additional parameters are required until it no longer prompts for additional input, then use that command line in the adapter’s configuration.

  You can specify any other options that are based on your SSH-environment. However, if you do so, you must still be sure this command line is correct and complete. For example, port forwarding could be specified using the following command-line option:

  -L ListenPort:FtpServerHost:FtpServerPort

  In this example, ListenPort must be the same value as that given for the parameter SSH Listen Port. The value given for FtpServerHost overwrites the parameter setting for Host Name under the FTP parameters. The value given for FtpServerPort overwrites the parameter setting for Server Port under the FTP parameters. All other settings under the FTP parameters operate for the specified FTP server: FtpServerHost:FtpServerPort.

  If the SSH channel established by an SSH command line must be shared by other Batch Adapter instances located on different Java CAPS client hosts, you must configure SSH port forwarding to allow non-local connections from other hosts. For some SSH clients, you can use the option -g.

  ---

  Note –

  You can also specify port forwarding in your SSH configuration file.

  ---

  (Continued on the next page)

A valid SSH command line. 

SSH Command Line (continued)

(Continued from last page)

The command-line syntax can differ, depending on the type of SSH client implementation you are using. See your SSH-tunneling support software user documentation for details. 

Examples: 

ssh -L 3456:ftp.sun.com:21 -o BatchMode=yes apple 

ssh -L 4567:apple:21 -o BatchMode=yes apple 

ssh -L 5678:orange:21 -o BatchMode=yes apple 

ssh -L 6789:orange:21 -g -o BatchMode=yes apple 

plink -L 4567:apple:21 apple 

plink -L 5678:orange:21 apple 

plink -L 6789:orange:21 -g apple 

SSH Tunneling Enabled

Specifies whether the FTP command connection is secured through an SSH tunnel.

If you choose No, all other parameters in this section are ignored.

If you want to use the SSH port-forwarding feature, you may need to reconfigure your FTP server, depending on what kind of server you are using and how it is currently configured. See your SSH documentation for more information.

Select Yes or No.

The configured default is No.

ssh -L 4567:apple:21 -o BatchMode=yes apple

Synchronized

Specifically applies to legacy Batch Adapter Projects. Provides backward compatibility to allow Projects that were created using the Batch Adapter version 5.0.7 or earlier to be imported and deployed without a change in the adapters behavior. The selections are: 

• Yes: Provides backward compatibility for legacy (pre-5.0.8 Batch Adapter) Projects. The adapters run in synchronized mode, one instance of the Collaboration after the other.

• No: For use with new Batch Adapter Projects. The adapter run in parallel, creating multiple instances of the Collaboration that run in parallel.

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

  ---

  Note –

  Synchronized must be set to “Yes” to use Sequence Numbering.

  ---

Yes or No.

The default setting is Yes, simulating Projects created with Batch Adapter version 5.0.7 or earlier.

Socks Host Name

Specifies the SOCKS server (host) name. If you are communicating with a SOCKS server enter the SOCKS server name in this parameter. 

The name of the SOCKS server. 

Socks Server Port

Specifies the port number to use on the SOCKS server, when connecting to it.

An integer from 1 to 65,535.

The configured default is 1080.

Socks User Name

Specifies the user name to use (together with the password specified under the Socks Password parameter) for authentication with a SOCKS5 server, if necessary. This parameter is used for the user/password negotiation method.

A valid SOCKS5 user name. 

Socks Password

Specifies the password to use (together with the user name specified under the Socks User Name parameter) for authentication with a SOCKS5 server, if necessary. This parameter is used for the user/password negotiation method.

The corresponding Java accessors are getSocksPassword() , setSocksPassword(java.lang.String p) and setSocksEncryptedPassword(java.lang.String p).

A valid SOCKS5 password. 

Host Name

Specifies the name of the external system that the adapter connects to.

If the parameter SSH Tunneling Enabled under the SSH Tunneling configuration settings is set to Yes, the parameters Host Name and Server Port, under the FTP settings, are ignored. In this case, the FTP host name is determined by an SSH option, according to the following model:

ssh -L ListenPort:FtpServerHost:FtpServerPort SSHServer

In the previous example, the FTP feature communicates with the FTP server FtpServerHost:FtpServerPort using an existing SSH tunnel. See SSH Tunneling (BatchFTP Connectivity Map) for details.

If the parameter Socks Enabled under the SOCKS configuration parameters is set to Yes, the host name under the FTP configuration could fail to resolve some names, for example, localhost or 127.0.0.1 correctly. Use real IP or machine names to represent the hosts. See SOCKS (BatchFTP Connectivity Map) for details.

The host name. 

Server Port

Specifies the port number to use on the FTP server when connecting to it.

If the parameter SSH Tunneling Enabled under the SSH Tunneling configuration is set to Yes, the parameters Host Name and Server Port under the FTP configuration are ignored. In this case, the FTP server port number is determined by an SSH option, according to the following model:

ssh -L ListenPort:FtpServerHost:FtpServerPort SSHServer

In the previous example, the FTP feature communicates with the FTP server FtpServerHost:FtpServerPort using an existing SSH tunnel. See SSH Tunneling (BatchFTP Connectivity Map) for details.

The server port number. 

User Name

Specifies the user name used to log onto the external system, when required.

A user name that provides access to the external system. 

Password

If a password is required to log on to an external system, enter the password that corresponds to the user name.

The corresponding Java accessor methods are getPassword(), setPassword(), and setEncryptedPassword().

The password. 

User Defined Heuristics Configuration File

Specifies the name and location of the user defined FTP heuristics configuration file. The format of the files content must be in the same form as that of the FTPHeuristics.cfg file. See To Create a Custom Heuristics Configuration File for more details.

This property works in conjunction with the property Table 3 User Defined Directory Listing Style property

The BatchFTP OTD will generate an exception if a selected User Defined Directory Listing Style or the User Defined Heuristics Configuration File path is not defined correctly. If a User Defined Directory Listing Style is specified, a corresponding value must also be provided for the User Defined Heuristics Configuration File property.

The location and name of the user defined FTP heuristics configuration file on the local host. 

State Persistence Base Location

Specifies a working directory for storing intermediary results. 

Options: 

• Leave value blank: BatchFTP will use a default folder as the working directory.

• Specify a path to a local file system folder with read/write permissions.

A working directory with read/write permissions, or leave blank (no value) to accept a default directory. 

Connection Mode

Specifies whether a physical connection is established when an external connection is instantiated. The options are: 

• Automatic: Establishes a physical connection when an external connection is instantiated.

• Manual: Does not automatically establish a physical connection when an external connection is instantiated.

  If a physical connection is not automatically established, a physical connection must be established from the Collaboration (for example, by calling the connect() method).

Select Automatic or Manual.

The configured default is Automatic. 

SSH Listen Host

Specifies the name of the host where the SSH support software runs, and to which the host listens. This parameter is required when and only when SSH Channel Established is set to Yes. The reason for this is, if you choose No this Listen Host will always be localhost because the SSH client will always be started from localhost. For optimum security, it is recommended that you use localhost as your choice.

The connection to the corresponding port number on this host is forwarded to the FTP server through an SSH-secure channel. 

On the listen host, the SSH support software must be configured and started with the Port-Forwarding option.

The FTP command connection is forwarded through the secure tunnel. The corresponding SSH command uses the following model: 

ssh -L ListenPort:FtpServerHost:FtpServerPort -o BatchMode=yes SSHServer

If this host name is not localhost, the data transport between the local host and the SSH listen host is not secure. Also, your SSH support software should be configured to allow connections to other hosts (for some SSH clients, it is an option -g).

For example, on an SSH listen host, you could issue a command, such as: 

ssh -L 4567:apple:21 -o BatchMode=yes apple 

or 

ssh -L 5678:orange: 21 -o BatchMode=yes apple 

Regardless, the transport between the SSH listen host and the FTP server is still secure. 

The SSH listen host name. 

The configured default is localhost.

SSH Listen Port

Specifies the port number that the SSH-tunneling support software uses to check for incoming connections. This port number can be any unused port number on the SSH listen host.

The connection to this port is forwarded to the FTP server through an SSH-secure channel. This parameter is required and it must be exactly same as the ListenPort value in the SSH command you issue either inside or outside the Java CAPS system. The corresponding SSH command line uses the following model:

ssh -L ListenPort:FtpServerHost:FtpServerPort -o BatchMode=yes SSHServer Required Values

An integer from 1 to 65535.

SSH User Name

Specifies an SSH user name. This parameter can be required when the setting for the SSH Channel Established parameter is No.

This parameter is required only if the SSH support software is started from within the adapter (refer to the corresponding SSH command line). Even then, it is only required if your SSH implementation executes in an interactive way that requires you to enter a user name. Again, this requirement depends on how you specify the SSH command line and how your SSH environment is configured. 

The SSH user name. 

SSH Password

Specifies an SSH password corresponding to the user name entered under SSH User Name. This parameter can be required only when the setting for the SSH Channel Established parameter is No. For more information, see SSH User Name.

The SSH password. 

Steady pool size

Specifies the minimum number of physical EIS connections that the pool keeps available at all times. 

An integer indicating the maximum number of connections available at all times. A value of 0 (zero) indicates that there are no physical connections in the pool and that new connections are created as needed.

The configured default is 2.

Maximum pool size

Specifies the maximum number of physical EIS connections the pool contains.

An integer indicating the maximum number of connections allowed. A value of 0 (zero) indicates that there is no maximum.

The default value is 10.

Max Idle Timeout In Second

Specifies the maximum idle timeout (in seconds). This is a hint to the server. A timer thread periodically removes unused connections. This parameter defines the interval at which this thread runs. This thread removes unused connections after the specified idle time expires. It allows the user to specify the maximum amount of time that a connection can remain in the pool.

. 

An integer indicating the maximum idle timeout in seconds. When this is set to a number greater than 0 (zero), the container removes or destroys any connections that are idle for the specified duration. A value of 0 specifies that idle connections can remain in the pool indefinitely.

The configured default is 300 (5 minutes).

Connection Retries

Specifies the number of retries to establish a connection upon failure to acquire a connection. 

An integer indicating the maximum number of retries to establish a connection upon failure to acquire a connection. 

The Configured default value is 0.

Connection Retry Interval

Specifies the length of time (in milliseconds) between each reattempt to access the destination file. This is used in conjunction with the Connection Retries setting. 

An integer indicating length of the pause (in milliseconds). 

The configured default value is 1000 (1 second).

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.

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.

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.

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

Secure Mode

Specifies the secure mode. Selections are: 

• None: FTP is in clear text.

• Implicit SSL: The SSL handshake is started right after the socket connection is done.

• Explicit SSL: The SSL handshake is started by the client sending AUTH SSL/TLS FTP command.

Select None, Implicit SSL, or Explicit SSL.

None is the configured default.

Directory Listing Style

Specifies the directory listing style of the FTP Server as UNIX, NT, or MVS. This provides a “hint” to the client side for parsing the directory listing response from the FTP Server.

Leave as UNIX. Currently the only supported option is UNIX.

The configured default is UNIX.

Enabled Passive Mode

Specifies whether FTP passive mode is enabled. 

Select Yes or No. Yes indicates that FTP passive mode is enabled.

The configured default is Yes.

Transfer Mode

Specifies whether the transfer is binary code or ASCII text. 

Select BINARY or ASCII. The configured default is BINARY.

Append

Specifies whether new data transferred to a remote server is appended to data that was previously transferred. 

Select Yes or No. Yes indicates that data will be appended.

The configured default is No.

Required Server Authentication

Specifies whether server authentication is required. The selections are: 

• Yes: Indicates that server authentication is required, and that all parameters used for authentication (for example, Key Store Location , Key Store Password, Key Store Type, and so forth) must be set correctly so that the server certificate can be verified against the local trusted CA certificates.

• No: Indicates that server authentication is not required.

Select Yes or No.

The configured default is Yes.

Distinguished Name for User

Specifies the distinguished name (DN) for the login user. This is imported from a CSR reply, and used to configure client authentication. 

The Distingusihed Name, as in X.509. 

Alias in Key Store

Specifies the alias for a key pair in a JKS type Key Store. This value is used to configure client authentication. 

The alias. 

Alias Password

Specifies the password that protects the key pair entry in the keystore, identified by the alias. 

The alias password. 

Remote Directory

Specifies a directory on the FTP 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 17.

See Using Regular Expressions or Using Name Patterns.

The name of the remote directory. 

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.

  See Table 17.

Select Yes or No.

The configured default is No.

Remote File

Specifies the file name on the remote server. 

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

  See Table 17.

  See Using Regular Expressions or Using Name Patterns.

The name of 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.

  See Table 17.

Select Yes or No.

The configured default is No.

Local Directory

Specifies the local directory (path) for files that are sent to or received from a remote system. The value can be a literal, regular expression (source), or pattern name (destination). 

See Table 17.

See Using Regular Expressions or Using Name Patterns.

The local directory name. 

Local Directory 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 17.

Select Yes or No.

The configured default is No.

Local File

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

See Table 17.

See Using Regular Expressions or Using Name Patterns.

The local 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 Table 17.

Select Yes or No.

The configured default is No.

Local File Overwrite

Specifies whether new data downloaded from the remote will overwrite existing data. 

Select Yes or No.

The configured default is No.

Remote Dir Name

Specifies the directory name (path) on the remote external system where the file the will be renamed or copied. 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 18.

See Using Regular Expressions or Using Name Patterns.

A directory name and path on the external system. 

Special characters are allowed. 

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 Table 18.

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 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 18.

See Using Regular Expressions or Using Name Patterns.

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.

  See Table 18.

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 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. 

For 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.

See Table 18.

See Using Regular Expressions or Using Name Patterns.

The local 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 18.

Select Yes or No.

The configured default is No.

Local File Name

Specifies the 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. 

For path seperator, 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.

See Table 18.

See Using Regular Expressions or Using Name Patterns.

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 Table 18.

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 you are using a firewall. If a firewall is used, supports SOCKS 4 and 5.

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 .

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 runs in synchronized mode, one instance of the Collaboration after the other.

• No: The adapter runs 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 configured default is No.

FTP Host

Specifies the FTP server host name or IP address.

The FTP server host name or IP address. 

The configured default is localhost.

Explicit port for FTP over SSL

Specifies the FTP port for explicit SSL. default is 21 (data port 20).

The FTP port number for explicit SSL. 

The configured default is 21 (data port 20).

Implicit port for FTP over SSL

Specifies the FTP port for implicit SSL.

The FTP port for implicit SSL

The configured default is 990 (data port 989).

User ID

Specifies the user login for FTP server. 

The user login name for FTP server. 

Password

Specifies the password for the FTP server user login. 

The password for the FTP server user login. 

Key Store Location

Specifies the path to the keystore that contains the trusted CA certificates required for server authentication. 

The fully qualified path to the keystore file.

Key Store Password

Specifies the password to access the keystore file. 

The password for the keystore.

Key Store Type

Specifies the keystore format type. Selections include JKS or other.

JKS is currently the only supported keystore type. If “other” is selected as the value, an exception is thrown when the OTD is initialized, with the error message, “Unknown type key store”.

Select JKS. JKS is currently the only supported keystore type, and the configured default.

Firewall Host

Specifies the proxy server host name or IP.

The proxy server host name or IP address. 

Firewall Port

Specifies the proxy server port.

The proxy server port number. 

User ID

Specifies the user login on the proxy server.

User login ID. 

Password

Specifies the password for the user login.

The user password. 

Connection Mode

Specifies whether a physical connection is established when an external connection is instantiated. Options are: 

• Automatic: Establishes a physical connection when an external connection is instantiated.

• Manual: Does not automatically establish a physical connection when an external connection is instantiated.

  If a physical connection is not automatically established, a physical connection must be established from the Collaboration (for example, by calling the connect() method).

  If BatchFTPOverSSL Connection Mode is set to Automatic, the following Environment parameters must be set with valid values:

  FTP and SSL Settings ⇒ FTP Host

  FTP and SSL Settings ⇒ Explicit port for FTP over SSL (this must be set if the BatchFTPOverSSL Connectivity Map property, FTP and SSL Settings ⇒ Secure Mode is set to Explicit SSL)

  FTP and SSL Settings ⇒ Implicit port for FTP over SSL (this must be set if the BatchFTPOverSSL Connectivity Map property, FTP and SSL Settings ⇒ Secure Mode is set to Implicit SSL)

  FTP and SSL Settings ⇒ User ID

  FTP and SSL Settings ⇒ Password

  FTP and SSL Settings ⇒ Key Store Location (this must be set if the BatchFTPOverSSL Connectivity Map property, FTP and SSL Settings ⇒ Require Server Authentication is set to Yes, or if the BatchFTPOverSSL Connectivity Map property, FTP and SSL Settings ⇒ Distinguished Name for User contains a value, indicating that client authentication is required)

  FTP and SSL Settings ⇒ Key Store Password (this must be set if Key Store Location is set)

  Also, if a firewall is enabled and the Connectivity Map property, Firewall Settings ⇒ Use Firewall, is set to Yes, the following Environment parameters must be set with valid values:

  Firewall Settings ⇒ Firewall Host

  Firewall Settings ⇒ Firewall Port

  Firewall Settings ⇒ User

  Firewall Settings ⇒ Password

Select Automatic or Manual. The default is Automatic.

Temp Dir

Specifies a working directory for storing intermediary results. 

Options include: 

• Leave value blank: BatchFTPOverSSL will use a default location as the temporary directory.

• Specify a path to a local file system folder with read/write permissions.

A working directory with read/write permissions, or leave blank (no value) to accept a default directory. 

Steady pool size

Specifies the minimum number of physical connections the pool keeps available at all times. 

An integer indicating the maximum number of connections available at all times. A value of 0 (zero) indicates that there are no physical connections in the pool and that new connections are created as needed.

The configured default is 2.

Maximum pool size

Specifies the maximum number of physical connections the pool contains. 0 (zero) indicates that there is no maximum.

An integer indicating the maximum number of connections allowed. A value of 0 (zero) indicates that there is no maximum.

The configured default is 10.

Max Idle Timeout In Seconds

Specifies the maximum idle timeout (in seconds). This is a hint to the server. A timer thread periodically removes unused connections. This parameter defines the interval at which this thread runs. This thread removes unused connections after the specified idle time expires. It allows the user to specify the amount of time a connection can remain idle in the pool.

An integer indicating the maximum idle timeout in seconds. When this is set to a number greater than 0, the container removes or destroys any connections that are idle for the specified duration. A value of 0 specifies that idle connections can remain in the pool indefinitely.

The configured default is 300 (5 minutes).

Connection Retries

Specifies the number of retries to establish a connection upon failure to acquire a connection. 

An integer indicating the maximum number of retries to establish a connection upon failure to acquire a connection. The default value is 0.

Connection Retry Interval

Specifies the length of the pause (in milliseconds) between each reattempt to access the destination file. Used in conjunction with the Connection Retries setting.

An integer indicating length of the pause (in milliseconds). The default value is 1000 (1 second).

Authentication Type

Specifies the client authentication type. The options are:

• 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 directory on the SSH (with SFTP sub-system) server where data is sent or received. The accessibility of the directory is usually dependent upon the login user..

The remote directory. 

Remote File

Specifies the name of a file on the remote server used to either receive published data, or hold data to be retrieved.

The remote file. 

Local Directory

Specifies the local directory for files be sent to the remote server, or received from remote server.

A local directory. 

Local File

Specifies the local file under local directory to be sent to remote, or receive data from remote.

The local file. 

Is Copy Recursive

Specifies whether the copy is recursive (for example, copy all sub directories).

Select Yes or No. Yes indicates that the copy is recursive.

The configured default is No. 

Use Firewall

Specifies whether a firewall is used.

Yes or No. Yes indicates that you are using a firewall.

The configured default is No.

SOCKS Version

Specifies the SOCKS version required by 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 runs in synchronized mode, one instance of the Collaboration after the other.

• No: The adapter runs 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.

  ---

Yes or No.

The default setting is No.

SSH Host

Specifies the host name or IP address of the SSH server. 

The host name or IP address of the SSH server. 

SSH Port

Specifies the port number of the SSH server. 

The port number of the SSH server. 

User

Specifies the user login name for the SSH server. 

A user login name for the SSH server. 

Password

Specifies a login password for the user. 

A login password. 

Key File

Specifies the folder (path) that holds the private key for client authentication.

The folder (path) that holds the private key for client authentication. 

Key File Password

Specifies the password used to protect the key file (key pair).

The Key File password. 

Server Public Key

Specifies the folder (path) that holds the public key used by the SSH server. This key is generated on the server and sent to the client through a, safe channel, and stored on the client machine for host key verification.

See your specific SSH server documentation for more information. 

The the folder (path) that contains the server public key for host key verification. 

Server Name For Host Key Verification

Specifies the full domain name of the SSH server used for host key verification.

The expected SSH host name when doing host key verification. 

Preferred Public Key Algorithm

Specifies the preferred public key algorithm for SSH authentication. The options are DSA and RSA.

DSA or RSA.

The configured default is DSA. 

Firewall Host

Specifies the proxy server host name or IP address.

The proxy server host name or IP address. The configured default is localhost.

Firewall Port

Specifies the proxy server port number.

The proxy server port number. The configured default is 1080.

Password

Specifies a login password for the proxy server.

A password for the proxy server login ID. 

User

Specifies a user login ID for the proxy server.

A user login ID for the proxy server.

Connection Mode

Specifies whether a physical connection is established when an external connection is instantiated. Options are: 

• Automatic: Establishes a physical connection when an external connection is instantiated.

• Manual: Does not automatically establish a physical connection when an external connection is instantiated.

  If a physical connection is not automatically established, a physical connection must be established from the Collaboration (for example, by calling the connect() method).

  If BatchSCP Connection Mode is set to Automatic, the following Environment parameters must be set with valid values:

  SCP Settings ⇒ SSH Host

  SCP Settings ⇒ SSH Port

  SCP Settings ⇒ User

  SCP Settings ⇒ Password

  SCP Settings ⇒ Key File (this must be set if the BatchSCP Connectivity Map property, SCP Settings ⇒ Authentication Type is set to HOSTBASED or PUBLICKEY)

  SCP Settings ⇒ Key File Password (required by the Key File property)

  SCP Settings ⇒ Server Public Key (this must be set if the BatchSCP Connectivity Map property, SCP Settings ⇒ Do Host Key Verification is set to Yes)

  SCP Settings ⇒ Server Name for Host Key Verification (this must be set if the BatchSCP Connectivity Map property, SCP Settings ⇒ Do Host Key Verification is set to Yes)

  Also, if a firewall is enabled and the Connectivity Map property, Firewall Settings ⇒ Use Firewall, is set to Yes, the following Environment parameters must be set with valid values:

  Firewall Settings ⇒ Firewall Host

  Firewall Settings ⇒ Firewall Port

  Firewall Settings ⇒ User

  Firewall Settings ⇒ Password

Select Automatic or Manual.

The configured default is Automatic.

Steady pool size

Specifies the minimum number of physical connections the pool keeps available at all times. 

An integer indicating the maximum number of connections available at all times. A value of 0 (zero) indicates that there are no physical connections in the pool and that new connections are created as needed.

The configured default is 2.

Maximum pool size

Specifies the maximum number of physical connections the pool contains. 0 (zero) indicates that there is no maximum. 

An integer indicating the maximum number of connections allowed. A value of 0 (zero) indicates that there is no maximum.

The configured default is 10.

Max Idle Timeout In Seconds

Specifies the maximum idle timeout (in seconds). This is a hint to the server. A timer thread periodically removes unused connections. This parameter defines the interval at which this thread runs. This thread removes unused connections after the specified idle time expires. It allows the user to specify the amount of time a connection can remain idle in the pool. 

An integer indicating the maximum idle timeout in seconds. When this is set to a number greater than 0, the container removes or destroys any connections that are idle for the specified duration. A value of 0 specifies that idle connections can remain in the pool indefinitely.

The configured default is 300 (5 minutes).

Connection Retries

Specifies the number of retries to establish a connection upon failure to acquire a connection. 

An integer indicating the maximum number of retries to establish a connection upon failure to acquire a connection. The default value is 0.

Connection Retry Interval

Specifies the length of the pause (in milliseconds) between each reattempt to access the destination file. Used in conjunction with the Connection Retries setting. 

An integer indicating length of the pause (in milliseconds). The default value is 1000 (1 second).

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.

See Using Regular Expressions or Using Name Patterns.

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 Table 34.

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.

See Using Regular Expressions or Using Name Patterns.

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 Table 34.

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 Table 34.

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:

• 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 34.

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.

See Using Regular Expressions or Using Name Patterns.

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:

• 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 34.

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 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 Table 35.

See Using Regular Expressions or Using Name Patterns.

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 Table 35.

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 Table 35.

See Using Regular Expressions or Using Name Patterns.

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 Table 35.

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 Table 35.

See Using Regular Expressions or Using Name Patterns.

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 Table 35.

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 Table 35.

See Using Regular Expressions or Using Name Patterns.

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 Table 35.

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 Table 36.

See Using Regular Expressions or Using Name Patterns.

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 Table 36.

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.

See Using Regular Expressions or Using Name Patterns.

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 Table 36.

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 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:

• 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 36.

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.

See Using Regular Expressions or Using Name Patterns.

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 Table 36.

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 runs in synchronized mode, one instance of the Collaboration after the other.

• No: The adapter runs 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.

SSH Host

Specifies the host name or IP address of the SSH server. 

The host name or IP address of the SSH server. 

SSH Port

Specifies the port number of the SSH server. 

The port number of the SSH server. 

User ID

Specifies the user login name for the SSH server. 

A user login name for the SSH server. 

Password

Specifies a login password for the user. 

A password. 

Key File

Specifies the folder (path) that holds the private key for client authentication of type PUBLIC KEY or HOST BASED..

The folder (path) that holds the private key for client authentication. 

Key File Password

Specifies the password used to protect the key file.

The Key File password. 

Server Public Key

Specifies the folder (path) that holds the public key used by the SSH server. This key is generated on the server and sent to the client through a, safe channel, and stored on the client machine for host key verification.

The the folder (path) that contains the server public key for host key verification. 

Server Name For Host Key Verification

Specifies the full domain name of the SSH server used for host key verification.

The expected SSH host name when doing host key verification. 

Preferred Public Key Algorithm

Specifies the preferred public key algorithm for SSH authentication. The options are DSA and RSA

DSA or RSA.

The configured default is DSA. 

Firewall Host

Specifies the proxy server host name or IP address.

The proxy server host name or IP address. 

The configured default is localhost.

Firewall Port

Specifies the proxy server port number.

The proxy server port number. 

The configured default is 1080.

User ID

Specifies a user login ID for the proxy server.

A user login ID for the proxy server.

Password

Specifies a login password for the proxy server.

A password for the proxy server login ID. 

Connection Mode

Specifies whether a physical connection is established when an external connection is instantiated. Options: 

• Automatic: Establishes a physical connection when an external connection is instantiated.

• Manual: Does not automatically establish a physical connection when an external connection is instantiated.

  If a physical connection is not automatically established, a physical connection must be established from the Collaboration (for example, by calling the connect() method).

  If BatchSFTP Connection Mode is set to Automatic, the following Environment parameters must be set with valid values:

  SFTP Settings ⇒ SSH Host

  SFTP Settings ⇒ SSH Port

  SFTP Settings ⇒ User

  SFTP Settings ⇒ Password

  SFTP Settings ⇒ Key File (this must be set if the BatchSFTP Connectivity Map property, SFTP Settings ⇒ Authentication Type, is set to HOSTBASED or PUBLICKEY)

  SFTP Settings ⇒ Key File Password (required by the Key File property)

  SFTP Settings ⇒ Server Public Key (this must be set if the BatchSFTP Connectivity Map property, SFTP Settings ⇒ Do Host Key Verification is set to Yes)

  SFTP Settings ⇒ Server Name for Host Key Verification (this must be set if the BatchSFTP Connectivity Map property, SFTP Settings ⇒ Do Host Key Verification is set to Yes)

  Also, if a firewall is enabled and the Connectivity Map property, Firewall Settings > Use Firewall, is set to Yes, the following Environment parameters must be set with valid values:

  Firewall Settings ⇒ Firewall Host

  Firewall Settings ⇒ Firewall Port

  Firewall Settings ⇒ User

  Firewall Settings ⇒ Password

Select Automatic or Manual.

The configured default is Automatic.

Steady pool size

Specifies the minimum number of physical connections the pool keeps available at all times. 

An integer indicating the maximum number of connections available at all times. A value of 0 (zero) indicates that there are no physical connections in the pool and that new connections are created as needed.

The configured default is 2.

Maximum pool size

Specifies the maximum number of physical connections the pool contains. 0 (zero) indicates that there is no maximum.

An integer indicating the maximum number of connections allowed. A value of 0 (zero) indicates that there is no maximum.

The configured default is 10.

Max Idle Timeout In Seconds

Specifies the maximum idle timeout (in seconds). This is a hint to the server. A timer thread periodically removes unused connections. This parameter defines the interval at which this thread runs. This thread removes unused connections after the specified idle time expires. It allows the user to specify the amount of time a connection can remain idle in the pool.

An integer indicating the maximum idle timeout in seconds. When this is set to a number greater than 0, the container removes or destroys any connections that are idle for the specified duration. A value of 0 specifies that idle connections can remain in the pool indefinitely.

The configured default is 300 (5 minutes).

Connection Retries

Specifies the number of retries to establish a connection upon failure to acquire a connection. 

An integer indicating the maximum number of retries to establish a connection upon failure to acquire a connection. The default value is 0.

Connection Retry Interval

Specifies the length of the pause (in milliseconds) between each reattempt to access the destination file. Used in conjunction with the Connection Retries setting.

An integer indicating length of the pause (in milliseconds). The default value is 1000 (1 second).

Pre Directory Name

Specifies the directory name (path) on the external system in 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, or pattern name.

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

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

For 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.

See Table 44.

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 Pre Directory 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.

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

  See Table 44.

Select Yes or No.

The configured default is No.

Pre 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 or pattern name.

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 44.

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

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

  See Table 44.

Select Yes or No.

The configured default is No.

Pre Transfer Command

Allows you to determine the action executed directly before the actual file transfer.

In the case of an inbound file transfer, you can make the file unavailable to other clients polling the target system via the same directory and file pattern or name. In the case of an outbound transfer, you can make an automatic backup of the existing file. The options are as follows: 

• Rename: Rename the target file.

• Copy: Copy the target file.

• None: Do nothing.

Select Rename, Copy, or None; the default is None.

Rename and Copy overwrite the file or directory specified by the Pre Directory Name and Pre Transfer Name parameter, if it exists.

Max Sequence Number

Use this parameter when you have set the target file name to contain a sequence number. It tells the adapter to reset the sequence number to the Starting Sequence Number value when this value (the Max Sequence Number) has been reached.

This parameter is used for the name pattern %#. 

See Using Name Patterns.

An integer from 1 to 2147483647. The value of Max Sequence Number must be greater than that of Starting Sequence Number.

The configured default value is 999999.

Starting Sequence Number

Use this parameter when you have set up the target file name to contain a sequence number. It tells the adapter which value to start with in the absence of a sequence number from a previous run.

Also, when the Max Sequence Number value is reached, the sequence number rolls over to the Starting Sequence Number value.

This parameter is used for the name pattern %#. 

See Using Name Patterns.

An integer from 0 to 2147483647. The value of the Starting Sequence Number must be less than the Max Sequence Number.

The configured default value is 1.

Post Directory Name

Specifies the directory name (path) on the external system in which a file is renamed. This setting is only for the Rename operation of the Post Transfer Command parameter. The value can be a literal or pattern name.

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

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

For 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.

See Table 46.

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%#

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

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

• %f.copy

• %f.rename

Post Directory Name Is Pattern

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

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

  See Table 46.

Select Yes or No.

The configured default is No.

Post File Name

Specifies either the name of the file that the transferred file is renamed to (Rename) or the directory it is moved to (Move), depending on the setting in the parameter Post Transfer Command.

The value can be a literal or pattern name. 

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

See Table 46.

See Using Name Patterns.

Enter the exact name of the file, enter a pattern name, or select one of the following values: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

Post File Name Is Pattern

Specifies whether the Post 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.

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

  See Table 46.

Select Yes or No.

The configured default is No.

Post Transfer Command

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

• Rename: Rename the target file. Rename overwrites the file specified by the Post File Name and Post Directory Name, if it exists

• Copy: Copy the target file.

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

• None: Do nothing.

Select Rename, Copy, Delete, or None.

The configured default is None.

Resume Reading Enabled

Specifies whether the OTD handles the Resume Reading feature as follows:

• Yes: Enables the OTD to store any state information necessary to resume reading from the current file in a subsequent execution of the Collaboration Rule.

• No: Indicates that the file is considered “consumed” even if the streaming consumer did not read until the end of file.

Yes or No

The configured default is No.

Synchronized must be set to “Yes” to use Resume Reading.

Synchronized

Specifically applies to legacy Batch Adapter Projects. Provides backward compatibility to allow Projects that were created using the Batch Adapter version 5.0.7 or earlier to be imported and deployed without a change in the adapter's behavior. The selections are: 

• Yes: Provides backward compatibility for legacy (pre-5.0.8 Batch Adapter) Projects. The adapter runs in synchronized mode, one instance of the Collaboration after the other.

• No: For use with new Batch Adapter Projects. 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.

  ---

Yes or No.

The default setting is Yes, simulating Projects created with Batch Adapter version 5.0.7 or earlier.

Synchronized must be set to “Yes” to use Sequence Numbering or Resume Reading.

Append

Specifies whether to overwrite or append the data to the existing file. Use this parameter for outbound file transfers only. Choose the appropriate setting as follows:

• Yes: If the target file already exists, the data is appended to the existing file.

• No: The adapter overwrites the existing file on the remote system.

  If a file with the same name does not exist, both Yes and No create a new file on the external host.

Select Yes or No

The configured default is No.

Target Directory Name

Specifies the directory name (path) on the local system from which files are retrieved or where they are sent. The value can be a literal, regular expression (source), or pattern name (destination).

For outbound transfer (destination), the directory is created if it does not already exist. 

For 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.

See Table 48.

See Using Regular Expressions or Using Name Patterns.

The directory name. 

Target Directory Name Is Pattern

Specifies whether the Target 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 48.

Select Yes or No

The configured default is Yes.

Target File Name

Specifies the name of the file on the local system either to be retrieved or sent. The value can be a literal, regular expression (get), or pattern name (put).

See Table 48.

See Using Regular Expressions or Using Name Patterns

A file name. 

Target File Name Is Pattern

Specifies whether the Target 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 48.

Select Yes or No

The configured default is No.

State Persistence Base Location

Specifies a working directory for storing intermediary results.

Options: 

• Leave value blank: BatchLocalFile will use a default folder as the working directory.

• Specify a path to a local file system folder with read/write permissions.

A working directory with read/write permissions, or leave blank (no value) to accept a default directory. 

Steady pool size

Specifies the minimum number of physical connections the pool keeps available at all times. 

An integer indicating the maximum number of connections available at all times. A value of 0 (zero) indicates that there are no physical connections in the pool and that new connections are created as needed.

The configured default is 2.

Maximum pool size

Specifies the maximum number of physical connections the pool contains. 0 (zero) indicates that there is no maximum.

An integer indicating the maximum number of connections allowed. A value of 0 (zero) indicates that there is no maximum.

The configured default is 10.

Max Idle Timeout In Seconds

Specifies the maximum idle timeout (in seconds). This is a hint to the server. A timer thread periodically removes unused connections. This parameter defines the interval at which this thread runs. This thread removes unused connections after the specified idle time expires. It allows the user to specify the amount of time a connection can remain idle in the pool.

An integer indicating the maximum idle timeout in seconds. When this is set to a number greater than 0, the container removes or destroys any connections that are idle for the specified duration. A value of 0 specifies that idle connections can remain in the pool indefinitely.

The configured default is 300 (5 minutes).

Parse or Create Mode

Specifies how this adapter Connection for the record-processing OTD is used. Set this parameter as follows:

• Parse: To use the OTD for parsing an inbound payload.

• Create: To use the OTD for creating an outbound payload.

  An instance of the OTD can be used for parsing an inbound payload (only) or for creating an outbound payload (only). A single OTD cannot be used for both purposes at the same time in the same Collaboration.

Select Create or Parse.

The configured default is Parse.

Synchronized

Specifically applies to legacy Batch Adapter Projects. Provides backward compatibility to allow Projects that were created using the Batch Adapter version 5.0.7 or earlier to be imported and deployed without a change in the adapters behavior. The selections are: 

• Yes: Provides backward compatibility for legacy (pre-5.0.8 Batch Adapter) Projects. The adapter runs in synchronized mode, one instance of the Collaboration after the other.

• No: For use with new Batch Adapter Projects. The adapter runs 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 Yes, simulating Projects created with Batch Adapter version 5.0.7 or earlier.

Delimiter on Last Record

Allows you to supply the delimiter to be used with the final record. Use this parameter only when the Record Type is set to Delimited.

Some message formats insist that the final message in a record set has no trailing delimiter. However, in most cases, you can safely leave this parameter set to Yes.

Select Yes or No.

The configured default setting is Yes.

Record Delimiter

Specifies the delimiter to be used for records. Use this parameter when the Record Type is set to Delimited.

The value entered is interpreted as a sequence of one or more bytes. If there are multiple bytes in the delimiter, each must be separated by a comma. You can enter the delimiters in the following formats: 

• ASCII Characters: The adapter supports all ASCII characters.Example: *,*,* (records separated by ***)Example: | (records separated by a |)

• Escaped ASCII: The adapter supports \r, \n, \t, and \f.Example: \r,\n (records separated by CR NL)Example: \n (records separated by NL only)

• Hex: The adapter supports 0x00 to 0x7EExample: \0x0D,\0x0A (records separated by CR NL)

• Octal: The adapter supports 000 to 0177.Example: \015,\012 (same as \0x0D,\0x0A)

  ---

  Note –

  When using character delimiters with DBCS data, use single byte character(s), or equivalent hex values that do not coincide with either byte of the double byte characters.When using escaped ASCII, Hex, or Octal, the “\” character is required.

  ---

A valid character to use as data record delimiter. 

Record Size

Specifies a number indicating the record size (byte count). Use this parameter when the Record Type is set to Fixed, and a number indicating length must be supplied.

A number from 1 to 2,147,483,647 indicating the record size (byte count).

Record Type

Specifies the format of the records in the data payload in the Collaboration.

Each payload contains zero or more records. Using this and related parameters, you can pass records individually to another component within Java CAPS. Available options: 

• Delimited: The records are separated by the delimiter specified under the Record Delimiter parameter.

• Fixed: The records are all of a given size, specified by the Record Size parameter.

• Single Record: If the payload is to be processed “as-is,” select this option.

• User Defined: This option is not supported.

Delimited, Fixed, or Single Record.

The configured default is Delimited.

Steady pool size

Specifies the minimum number of physical connections the pool keeps available at all times. 

An integer indicating the maximum number of connections available at all times. A value of 0 (zero) indicates that there are no physical connections in the pool and that new connections are created as needed.

The configured default is 2.

Maximum pool size

Specifies the maximum number of physical connections the pool contains. 0 (zero) indicates that there is no maximum.

An integer indicating the maximum number of connections allowed. A value of 0 (zero) indicates that there is no maximum.

The configured default is 10.

Max Idle Timeout In Seconds

Specifies the maximum idle timeout (in seconds). This is a hint to the server. A timer thread periodically removes unused connections. This parameter defines the interval at which this thread runs. This thread removes unused connections after the specified idle time expires. It allows the user to specify the amount of time a connection can remain idle in the pool.

An integer indicating the maximum idle timeout in seconds. When this is set to a number greater than 0, the container removes or destroys any connections that are idle for the specified duration. A value of 0 specifies that idle connections can remain in the pool indefinitely.

The configured default is 300 (5 minutes).

Directory Name

Specifies the input directory name (path). It indicates the directory that the BatchInbound Adapter polls for trigger or data files. The value can be a literal or a regular expression. 

For 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.

See Table 54.

See Using Regular Expressions .

The directory name. 

Directory Name is Pattern

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

• True: indicates that the name value you enter is assumed to be a regular expression

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

  See Table 54.

  ---

  Note –

  Improper use may cause recursive matching.

  ---

Select True or False.

The configured default is False.

File Name

Specifies the input filename. The value can be a literal or a regular expression. 

See Table 54.

See Using Regular Expressions .

A file name. 

File Name is Pattern

Specifies whether the target file name represents a literal or a regular expression, as follows:

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

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

  See Table 54.

Select True or False.

The configured default is True. 

Schedule Interval

Specifies the polling interval, or number of seconds between each poll of the input directory by the adapter for input files. 

A number indicating the length of time in Milliseconds between adapter polls of the directory. 

The configured default is 5000 (or 5 seconds).

Max Pool Size

Specifies the maximum size of the MDB (Message Driven Bean) pool. 

An integer indicating the maximum MDB pool size.

The configured default is 1000.

#

# --------------------------------------------------------------------------

#   Section:    MY AS400-UNIX

# --------------------------------------------------------------------------

#

MY AS400-UNIX!Commands Supported By FTP 
Server!value=APPE%CWD%DELE%LIST%MKD%NOOP%PASS%QUIT%RETR%RNFR%RNTO
%SITE%STOR%TYPE%USER!set=APPE%CWD%DELE%LIST%MKD%NOOP%PASS%QUIT%RETR
%RNFR%RNTO%SITE%STOR%TYPE%USER

MY AS400-UNIX!Header Lines To Skip!value=0!set=0

MY AS400-UNIX!Header Indication Regex Expression!value=!set=

MY AS400-UNIX!Trailer Lines To Skip!value=0!set=0

MY AS400-UNIX!Trailer Indication Regex Expression!value=!set=

MY AS400-UNIX!Directory Indication Regex Expression!value=!set=

MY AS400-UNIX!File Link Real Data Available!value=No!set=No%Yes

MY AS400-UNIX!File Link Indication Regex Expression!value=!set=

MY AS400-UNIX!File Link Symbol Regex Expression!value=!set=

MY AS400-UNIX!List Line Format!value=Fixed!set=Blank Delimited%Fixed

MY AS400-UNIX!Valid File Line Minimum Position!value=52!set=52

MY AS400-UNIX!File Name Is Last Entity!value=Yes!set=No%Yes

MY AS400-UNIX!File Name Position!value=52!set=52

MY AS400-UNIX!File Name Length!value=0!set=0

MY AS400-UNIX!File Extension Position!value=0!set=0

MY AS400-UNIX!File Extension Length!value=0!set=0

MY AS400-UNIX!File Size Verifiable!value=No!set=No%Yes

MY AS400-UNIX!File Size Position!value=0!set=0

MY AS400-UNIX!File Size Length!value=0!set=0

MY AS400-UNIX!Special Envelope For Absolute Pathname!value=!set=’’

MY AS400-UNIX!Listing Directory Yields Absolute Pathnames!value=No!set=No%Yes

MY AS400-UNIX!Absolute Pathname Delimiter Set!value=///!set=///

MY AS400-UNIX!Change Directory Before Listing!value=Yes!set=No%Yes

MY AS400-UNIX!Directory Name Requires Terminator!value=No!set=No%Yes

#

#

# --------------------------------------------------------------------------

#   Section:   UDH NT 4.0

# --------------------------------------------------------------------------

#

UDH NT 4.0!Commands Supported By FTP
 Server!value=APPE%CWD%DELE%LIST%MKD%NOOP%PASS%QUIT%RETR%RNFR%RNTO%SITE%
STOR%TYPE%USER!set=APPE%CWD%DELE%LIST%MKD%NOOP%PASS%QUIT%RETR%RNFR%RNTO%SITE%
STOR%TYPE%USER

UDH NT 4.0!Header Lines To Skip!value=0!set=0

UDH NT 4.0!Header Indication Regex Expression!value=!set=

UDH NT 4.0!Trailer Lines To Skip!value=0!set=0

UDH NT 4.0!Trailer Indication Regex Expression!value=!set=

UDH NT 4.0!Directory Indication Regex Expression!value=<DIR>!set=<DIR>

UDH NT 4.0!File Link Real Data Available!value=No!set=No%Yes

UDH NT 4.0!File Link Indication Regex Expression!value=\.lnk$!set=\.lnk$

UDH NT 4.0!File Link Symbol Regex Expression!value=!set=

UDH NT 4.0!List Line Format!value=Blank Delimited!set=Blank Delimited%Fixed

UDH NT 4.0!Valid File Line Minimum Position!value=4!set=4

UDH NT 4.0!File Name Is Last Entity!value=Yes!set=No%Yes

UDH NT 4.0!File Name Position!value=4!set=4

UDH NT 4.0!File Name Length!value=0!set=0

UDH NT 4.0!File Extension Position!value=0!set=0

UDH NT 4.0!File Extension Length!value=0!set=0

UDH NT 4.0!File Size Verifiable!value=Yes!set=No%Yes

UDH NT 4.0!File Size Position!value=3!set=3

UDH NT 4.0!File Size Length!value=0!set=0

UDH NT 4.0!Special Envelope For Absolute Pathname!value=!set=

UDH NT 4.0!Listing Directory Yields Absolute Pathnames!value=No!set=No%Yes

UDH NT 4.0!Absolute Pathname Delimiter Set!value=\\\\\\!set=\\\\\\

UDH NT 4.0!Change Directory Before Listing!value=No!set=No%Yes

UDH NT 4.0!Directory Name Requires Terminator!value=No!set=No%Yes

      total 6
      -rw-r-----   1 ed        usr           110 Apr 15 13:43 AAA
      -rw-r--r--   1 ed        usr           110 Apr 15 13:33 aaa

      total 6
      -rw-r-----   1 ed        usr           110 Apr 15 13:43 AAA
      -rw-r--r--   1 ed        usr           110 Apr 15 13:33 aaa

      drwxr-xr-x   2 ed    usr     2048 Apr 17 17:43 public_html

      lrwxr-xr-x   2 ed        usr   2048 Apr 17 17:43 p ->       public_html

     lrwxrwxrwx   2 ed        usr  4 Apr 17 17:43 p -> public_html

      -rw-r--r--   1 ed        usr           110 Apr 15 13:33 aaa
      ^^^^^^^^^^   ^ ^^        ^^^           ^^^ ^^^ ^^ ^^^^^ ^^^
           1       2  3         4             5   6  7    8    9

      -rw-r--r--   1 ed        usr           110 Apr 15 13:33 aaa
      ^^^^^^^^^^   ^ ^^        ^^^           ^^^ ^^^ ^^ ^^^^^ ^^^
           1       2  3         4             5   6  7    8    9
                                                         File Name

      -rw-r--r--   1 ed        usr           110 Apr 15 13:33 aaa
      ^^^^^^^^^^   ^ ^^        ^^^           ^^^ ^^^ ^^ ^^^^^ ^^^
          1        2  3         4             5   6  7    8    9
                                                         File Name

       -rw-r--r--   1 ed        usr           110 Apr 15 13:33 aaa
                                              ^^^
                                              File Size

       -rw-r--r--   1 ed        usr           110 Apr 15 13:33 aaa
       ^^^^^^^^^^   ^ ^^        ^^^           ^^^ ^^^ ^^ ^^^^^ ^^^
            1        2  3         4             5   6  7    8    9
                                           File
                                              Size

      1234 or 1,234,567 or -12345 or +12345 or ’  1234  ’ or 12/34       or 1,234/56

      ’12 34’ or 123,45,678 or 123-456-789 or --123 or 123-
         ^          ^                 ^        ^          ^
      or 12345678901 or any number > 4294967295 or < -2147483647
         ^ (too large)
      or 123.45 or 12AB34 or 0x45 or ,123,456 or 12//34
            ^        ^        ^      ^              ^
      or /123 or 123/ or 12,3/45
         ^          ^        ^

UNIX 

/dir1/dir2/file.ext

/ 

/ 

/ 

/// 

Windows 

C:\dir1\dir2\file.ext

\\ 

\\ 

\\ 

\\\\\\ 

VMS 

disk1:[dir1.dir2]file.ext;1

[ 

. 

] 

; 

[.]; 

MVS PDS 

dir1.dir2(member)

\0 

. 

( 

) 

\0.() 

MVS Sequential 

dir1.dir2.filename

\0 

. 

. 

\0.. 

MVS GDG 

dir1.dir2.file(version#) (see Note)

\0 

. 

. 

\0.. 

AS400 

dir1/file.ext

\0 

/ 

. 

\0/.