Scope of State

Defines the scope of the State object, which is an OTD sub-node. 

The valid options for this parameter are: 

• Connection Level: The State has the same life cycle as the connection.

• Resource Adapter Level: The State has the same life cycle as the resource adapter. The life terminates when the resource adapter is recycled.

• OTD Level: The State has the same life cycle as the OTD object. This scope represents the life cycle of the State. The life terminates when the collaboration finishes.

  The default is Connection Level.

Packet Size

The number of bytes per packet of data. This number also determines the size of the buffers. 

A valid numeric value. 

The default is 1024.

Timeout

Specifies the milliseconds of pause before receiving a response from a server following a sent request. 

A valid numeric value. 

The default is 1000.

Initialize Conversation

Specifies how the adapter will establish a SNA conversation. Options are: 

• True: The adapter will initialize SNA conversations as an invoking TP.

• False: The adapter will accept SNA conversations as an invoking TP.

Select True or False.

The default is False.

Deallocation Type

Specifies the type of deallocation required at the end of a conversation when a shutdown is issued. Please refer to your SNA documentation for more information. 

Select one of the following four options: 

• 0 - SYNC_LEVEL.

• 1 - FLUSH

• 2 - CONFIRM

• 3 - ABEND

The default is 0 - SYNC_LEVEL.

Synchronization Level

Specifies the synchronization level parameter (CM_SYNC_LEVEL). Please refer to your SNA manual for more information. 

0 - None (Default)

1 - Confirm

Select the following: 

• 0 - None

• 1 - Confirm

The default is 0 - None..

Custom Handshake Class Name

Defines your SNA handshake logic (see Appendix B to deploy a custom handshake class). 

A fully qualified class name such as com.abc.MyClass. The class must implement the interface com.stc.connector.snalu62.api.snaCustomerHandshake. No value (leaving the property blank) indicates that no SNA conversation handshake logic is defined. Instead, a built-in standard handshake logic is used.

Max Connection Retry

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

A valid numeric value.  

The default is 3.

Retry Connection Interval

Specifies the milliseconds of pause before each attempt to reaccess the SNA LU62 destination. This setting is used in conjunction with the Max Connection Retry setting. 

For example, In the event that the adapter cannot connect to the SNA destination, the adapter will try to reconnect three times in 30 second intervals when the Connection Retries value is 3 and the Connection Retry Interval is 30000. 

A valid numeric value.  

The default is 30000.

Max Connection Pool Size

Defines the maximum number of concurrent connections for the particular listener/monitor over the specified SNALU62 destination. 0 (zero) indicates that there is no maximum. 

A valid numeric value. 

The default is 50.

Scope of Connection

Defines the scope of the accepted connection used by the adapter. Options are: 

• Collaboration Level: The connection will be closed once the execution of the Collaboration is completed. The connection has the same life cycle as the Collaboration.

• Resource Adaptor Level: The resource adapter will close the connection upon closure request. The connection may remain live across multiple executions of the Collaboration.

Select Collaboration Level or Resource Adaptor Level.

The default is Resource Adaptor Level.

Scheduler

Specifies the scheduler type for this inbound communication. Options are: 

• Timer Service: The task is scheduled according to the Schedule Type, Delay, Period, and At Fixed Rate values.

• Work Manager: The work is scheduled according to the Schedule Type, Delay, and Period values.

  If your container does not support JCA Work Management (prior to JCA1.5), select Timer Service.

Select Timer Service or Work Manager.

The default is Work Manager.

Schedule Type

Defines the type of schedule for inbound communication. Repeated indicates a task is scheduled for repeated execution at regular intervals defined by the parameter Period. 

The configured default is Repeated.

This value cannot be changed.

Delay

Specifies the delay in milliseconds before a task is executed. For further details, refer to the SNA Adapter Javadoc. 

A valid numeric value. 

The default is 0.

Period

Specifies the regular interval in milliseconds between successive task executions. This parameter is used in conjunction with the Schedule Type parameter when set to Repeated. 

A valid numeric value. 

The default is 100.

At Fixed Rate

Used in conjunction with the Repeated setting for the Schedule Type parameter and the Timer Service type of Scheduler. Options are: 

• True: Denotes a fixed rate. Each execution is scheduled relative to the scheduled time of the initial execution. If an execution is delayed for any reason, two or more executions will occur in rapid succession to return to the preset execution schedule. Overall, the frequency of executions will be exactly the reciprocal of the specified period.

• False: Denotes a fixed delay. Each execution is scheduled relative to the actual execution time of the previous execution. If an execution is delayed for any reason, subsequent executions are delayed as well. Overall, the frequency of executions will generally be lower than the reciprocal of the specified period.

Select True or False.

The default is False.

Scheduler

Specifies the scheduler type for this inbound communication. Options are: 

• Timer Service: The task is scheduled according to the Schedule Type, Delay, Period, and At Fixed Rate values.

• Work Manager: The work is scheduled according to the Schedule Type, Delay, and Period values.

  If your container does not support JCA Work Management (prior to JCA1.5), select Timer Service.

Select Timer Service or Work Manager.

The default is Work Manager.

Schedule Type

Defines the type of schedule for inbound communication. Options are: 

• One Time: A task is scheduled for a one-time execution.

• Repeated: A task is scheduled for repeated execution at regular intervals defined by the parameter Period.

Select One Time or Repeated.

The default is Repeated.

Delay

Specifies the delay in milliseconds before a task is executed. For further details, refer to the SNA Adapter Javadoc.

A valid numeric value. 

The default is 0.

Period

Specifies the regular interval in milliseconds between successive task executions. This parameter is used in conjunction with the Schedule Type parameter when set to Repeated. 

A valid numeric value. 

The default is 100.

At Fixed Rate

Used in conjunction with the Repeated setting for the Schedule Type parameter and the Timer Service type of Scheduler. Options are: 

• True: Denotes a fixed rate. Each execution is scheduled relative to the scheduled time of the initial execution. If an execution is delayed for any reason, two or more executions will occur in rapid succession to return to the preset execution schedule. Overall, the frequency of executions will be exactly the reciprocal of the specified period.

• False: Denotes a fixed delay. Each execution is scheduled relative to the actual execution time of the previous execution. If an execution is delayed for any reason, subsequent executions are delayed as well. Overall, the frequency of executions will generally be lower than the reciprocal of the specified period.

Select True or False.

The default is False.

Scope of State

Defines the scope of the State object, which is an OTD sub-node. 

The valid options for this parameter are: 

• Connection Level: The State has the same life cycle as the connection.

• Resource Adapter Level: The State has the same life cycle as the resource adapter. The life terminates when the resource adapter is recycled.

• OTD Level: The State has the same life cycle as the OTD object. This scope represents the life cycle of the State. The life terminates when the collaboration finishes.

  The default is Connection Level.

Packet Size

The number of bytes per packet of data. This number also determines the size of the buffers. 

A valid numeric value. 

The default is 1024.

Timeout

Specifies the milliseconds of pause before receiving a response from a server following a sent request. 

A valid numeric value. 

The default is 1000.

Initialize Conversation

Specifies how the adapter will establish a SNA conversation. Options are: 

• True: The adapter will initialize SNA conversations as an invoking TP.

• False: The adapter will accept SNA conversations as an invokable TP.

Select True or False.

The default is True.

Deallocation Type

Specifies the type of deallocation required at the end of a conversation when a shutdown is issued. Please refer to your SNA documentation for more information. 

Select one of the following four options: 

• 0 - SYNC_LEVEL.

• 1 - FLUSH

• 2 - CONFIRM

• 3 - ABEND

The default is 0 - SYNC_LEVEL.

Synchroniza-tion Level

Specifies the synchronization level parameter (CM_SYNC_LEVEL). Please refer to your SNA manual for more information.

• 0 - None (Default)

• 1 - Confirm

Select one of the following two options: 

• 0 - None

• 1 - Confirm.

The default is 0 - None.

Custom Handshake Class Name

Defines your SNA handshake logic (see Appendix B to deploy a custom handshake class). 

A fully qualified class name such as com.abc.MyClass. The class must implement the interface com.stc.connector.snalu62.api.sna CustomerHandshake. No value (leaving the property blank) indicates that no SNA conversation handshake logic is defined. Instead, a built-in standard handshake logic is used.

Connection Mode

Specifies how or when a connection will become available. Options are: 

• Automatic: The adapter will establish a SNA conversation automatically.

• Manual: The SNA conversation will become available to you only when you manually call the OTD function startConversation() from the Collaboration; the conversation will become unavailable when you call the OTD function endConversation().

  ---

  Note –

  The OTD functions startConversation() and endConversation() are expected for Manual mode only. Automatic mode does not allow you to call them explicitly.

  ---

Select Automatic or Manual.

The default is Automatic.

Max Connection Retry

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

A valid numeric value. 

The default is 3.

Retry Connection Interval

Specifies the milliseconds of pause before each attempt to reaccess the SNA LU62 destination. This setting is used in conjunction with the Max Connection Retry setting. 

For example, In the event that the adapter cannot connect to the SNA destination, the adapter will try to reconnect three times in 30 second intervals when the Connection Retries value is 3 and the Connection Retry Interval is 30000. 

A valid numeric value. 

The default is 30000.

Always Create New Connection

Specifies whether to ALWAYS attempt to create a new connection for a connection establishment request. Options are: 

• True: The adapter will always attempt to create a new connection without trying to match connection.

• False: The adapter will attempt to match an existing connection.

Select True or False.

The default is False.

Auto Reconnect Upon Matching Failure

Specifies whether or not to make an attempt to re-connect automatically after getting a matched connection from a container. Options are: 

• True: The adapter will discard the invalid matched connection and will attempt to establish another connection automatically.

• False: The adapter will not attempt to establish a new connection automatically. Instead, control will be deferred to your business rules which will detect this type of failure and perform the desired operations accordingly.

Select True or False.

The default is True.

Auto Disconnect Connection

Specifies whether the adapter disconnects automatically after the work on the connection is completed. Options are: 

• True: The adapter connection will be disconnected and it will not be re-used.

• False: The connection will be left for reuse.

Select True or False.

The default is False.

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

  ---

  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, 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 the Service Bus. 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.

Select Delimited, Fixed, or Single Record.

The configured default is Delimited.

Pre Directory Name

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

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

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

See Pre Directory Name Is Pattern property.

See Using Name Patterns.

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

• %f

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

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

• %f.copy

• %f.rename

Pre Directory Name Is Pattern

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

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

  See Pre Directory Name property.

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

Select Yes or No.

The configured default is Yes.

Pre File Name

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

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

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

See Pre Directory Name Is Pattern property.

See Using Name Patterns.

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

• %f

• %f%#

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

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

• %f.copy

• %f.rename

Pre File Name Is Pattern

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

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

  See Pre File Namesproperty.

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

Select Yes or No.

The configured default is Yes.

Pre Transfer Command

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

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

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

• None: Do nothing.

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

  ---

  Note –

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

  ---

Select Rename, Copy, or None.

The configured default is None.

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 Host Name 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 the User Defined Directory Listing Style property). 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)

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

This property works in conjunction with the Directory Listing Style and User Defined Heuristics Configuration File properties.

For details on how to use the User Defined Directory Listing Style see To 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 %#.

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.

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 Post Directory Name Is Pattern property.

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,

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

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

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 Post Directory Name Is Pattern property.

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,

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

  See Post File Name property.

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

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 Target Directory Name Is Pattern property.

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,

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

  See Target Directory Name property.

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

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 Target Directory Name property.

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,

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

  See Target File Name property.

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

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 the Service Bus, 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 the Service Bus 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 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.

  ---

A valid SSH command line. 

SSH Command Line

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. 

For example, 

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.

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

  ---

Select Yes or No.

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

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

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

Select Yes or No.

The configured default is Yes.

Remote File Name

Specifies the file name on the external system, to which a file is renamed or copied. 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 the Remote File Name Is Pattern property.

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

Select Yes or No.

The configured default is Yes.

Remote Pre Command

Allows you to execute a desired action directly before the actual file transfer. For an inbound transfer, the file can be made unavailable to other clients polling the target system with the same directory and file pattern or name. For an outbound transfer, you can perform an automatic backup and/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.

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

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

A directory name. 

Local Dir Name Is Pattern

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

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

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

See the Local Dir Name property.

Select Yes or No.

The configured default is No.

Local File Name

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

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

See the Local File Name Is Pattern property.

A file name. 

Local File Name Is Pattern

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

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

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

See the Local File Name property.

Select Yes or No.

The configured default is No.

Local Pre Command

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

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

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

• None: Do nothing.

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

  ---

  Note –

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

  ---

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

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

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

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

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 the Local Directory Name Is Pattern property.

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

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

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

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

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

Select Yes or No.

The configured default is Yes.

Remote File Name

Specifies the file name on the external system, to which a file is renamed or copied. This setting is only for the Rename or Copy operations of Post Transfer Command parameter.

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

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

See the Remote File Name Is Pattern property.

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

Select Yes or No.

The configured default is Yes.

Remote Post Command

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

• Rename: Rename the transferred file.

• Delete: Delete the transferred file.

• None: Do nothing.

  ---

  Note –

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

  ---

Select Rename, Delete, or None.

The configured default is None.

Local Dir Name

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

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

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

A file name. 

Local File Name Is Pattern

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

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

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

See the Local File Name property.

Select Yes or No.

The configured default is No.

Local Post Command

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

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

• Rename: Rename the target file.

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

• None: Do nothing.

  ---

  Note –

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

  ---

Select Rename, Delete, or None.

The configured default is None.

Use Firewall

Specifies whether you are using a firewall. If a firewall is used, supports SOCKS 4 and 5.

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 .

Synchronized

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

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

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

  ---

  Note –

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

  ---

Select Yes or No.

The configured default is No.

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 the Directory Name is Pattern property.

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.

  ---

  Note –

  Improper use may cause recursive matching.

  ---

See the Directory Name property.

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

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

Select True or False.

The configured default is True.

Schedule Interval

Specifies the polling interval, or number of milliseconds 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).

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.

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 the Pre Directory Name Is Pattern property.

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 the Pre Directory Name Is Pattern property.

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

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 the Pre File Name property.

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 through 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 up the target 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.

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

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 the Post Directory Name Is Pattern property.

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 the Post Directory Name property.

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

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.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 Post File Name property.

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.

Select 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 adapters behavior. The selections are: 

• Yes: Provides backward compatibility for legacy (pre-5.0.8 Batch adapter) Projects. The adapter 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.

  ---

  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.

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 the Target Directory Name Is Pattern property.

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 the Target Directory Name property.

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 the Target Directory Name Is Pattern property.

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

Select Yes or No.

The configured default is No.

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.

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

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

  ---

  Note –

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

  ---

Select Yes or No.

The default setting is No.

Remote Dir Name

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

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

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

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

See the Remote Dir Name Is Pattern property.

A directory name. 

Remote Dir Name Is Pattern

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

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

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

See the Remote Dir Name property.

Select Yes or No.

The configured default is Yes.

Remote File Name

Specifies the file name on the external system, to which a file is renamed or copied. This setting is only for the Rename or Copy operations of Pre Transfer Command parameter. The value can be a literal, regular expression (get), or pattern name (put).

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

See the Remote File Name Is Pattern property.

The file name. 

Remote File Name Is Pattern

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

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

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

See the Remote File Name property.

Select Yes or No.

The configured default is Yes.

Remote Pre Command

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

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

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

• None: Do nothing.

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

  ---

  Note –

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

  ---

Select Rename, Copy, or None.

The configured default is None.

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

Local Dir Name

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

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

See the Local Dir Name Is Pattern property.

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

A directory name. 

Local Dir Name Is Pattern

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

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

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

See the Local Dir Name property.

Select Yes or No.

The configured default is No.

Local File Name

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

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

See the Local File Name Is Pattern property.

A file name. 

Local File Name Is Pattern

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

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

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

See the Local File Name property.

Select Yes or No.

The configured default is No.

Local Pre Command

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

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

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

• None: Do nothing.

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

  ---

  Note –

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

  ---

See the Using Name Patterns.

Select Rename, Copy, or None.

The configured default is None.

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

Transfer Mode

Specifies whether the transfer is binary code or ASCII text. 

Select BINARY or ASCII.

The configured default is BINARY.

Remote EOL

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

Select CR, LF, or CRLF.

CRLF is the configured default.

Transfer Block Size

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

An integer indicating the block size used when transferring files. 

The configured default is 32768.

Local Read Buffer Size

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

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

Authentication Type

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

• PASSWORD

• HOSTBASED

• PUBLICKEY

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

Select PASSWORD, HOST BASED, or PUBLICKEY.

The configured default is PASSWORD.

Do Host Key Verification

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

Select Yes or No.

Yes enables SSH server authentication by verifying the public key.

The configured default is Yes.

Remote Directory

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

See the Remote Directory Name is Pattern property.

The remote directory name. 

Remote Directory Name is Pattern

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

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

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

See the Remote Directory property.

Select Yes or No.

The configured default is No.

Remote File

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

See the Remote File Name Is Pattern property.

The remote file. 

Remote File Name Is Pattern

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

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

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

See the Remote File property.

Select Yes or No.

The configured default is No.

Local Directory

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

See the Local Directory Name Is Pattern property.

A local directory. 

Local Directory Name Is Pattern

Specifies the meaning of the Local Directory Name property as follows:

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

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

See the Local Directory property.

Select Yes or No.

The configured default is No.

Local File

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

See the Local File Name Is Pattern property.

The local file. 

Local File Name Is Pattern

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

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

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

See the Local File property.

Select Yes or No.

The configured default is No.

Remote Dir Name

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

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

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

See the Remote Dir Name Is Pattern property.

A directory name. 

Remote Dir Name Is Pattern

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

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

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

See the Remote Dir Name Is Pattern property.

Select Yes or No.

The configured default is Yes.

Remote File Name

Specifies the file name on the external system. This setting is only for the Rename or Copy operations of Post Transfer Command parameter. The value can be a literal, regular expression (get), or pattern name (put).

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

See the Remote File Name Is Pattern property.

A file name. 

Remote File Name Is Pattern

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

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

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

See the Remote File Name property.

Select Yes or No.

The configured default is Yes.

Remote Post Command

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

• Rename: Rename the transferred file.

• Delete: Delete the transferred file.

• None: Do nothing.

  ---

  Note –

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

  ---

Select Rename, Delete, or None.

The configured default is None.

Local Dir Name

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

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

See the Local Dir Name Is Pattern property.

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

A directory name. 

Local Dir Name Is Pattern

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

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

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

See the Local Dir Name property.

Select Yes or No. The configured default is No.

Local File Name

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

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

See the Local File Name Is Pattern property.

A file name. 

Local File Name Is Pattern

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

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

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

See the Local File Name property.

Select Yes or No.

The configured default is No.

Local Post Command

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

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

• Rename: Rename the target file.

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

• None: Do nothing.

  ---

  Note –

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

  ---

Select Rename, Delete, or None.

The configured default is None.

Use Firewall

Specifies whether a firewall is used.

Select Yes or No.

Yes indicates that you are using a firewall.

The configured default is No.

SOCKS Version

Specifies the SOCKS version of the firewall.

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

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

The configured default is 5

Synchronized

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

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

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

  ---

  Note –

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

  ---

Select Yes or No.

The default setting is No.

Remote Directory

Specifies the virtual directory server where data is published or subscribed. 

The remote directory name 

Remote Directory Name Is Pattern

Specifies the meaning of the remote directory name.  

Yes: Indicates that the remote directory name represents a pattern to be used as a regular expression for pattern matching.

No: Indicates that the remote directory name represents the exact name to be used, without pattern matching

Select Yes or No.

Remote File

Specifies the name of a file on the remote server used to receive or hold data for retrieval. 

The remote file name. 

Remote File Name Is Pattern

Specifies the meaning of the remote file name:  

Yes Indicates that the remote file name represents a pattern to be used as a regular expression for pattern matching.

Noindicates that the remote file name represents the exact name to be used, without pattern matching

Select Yes or No.

Local Directory

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

The local directory name 

Local Directory Name Is Pattern

Specifies the meaning of the local directory name:  

Yes: Indicates that the local directory name represents a pattern to be used as a regular expression for pattern matching.

No: Indicates that the local directory name represents the exact name to be used, without pattern matching.

Select Yes or No.

Local File

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

The local file name 

Local File Name Is Pattern

Specifies the meaning of the local file name:  

Yes: Indicates that the local file name represents a pattern to be used as a regular expression for pattern matching.

No: Indicates that the local file name represents the exact name to be used, without pattern matching

Select Yes or No.

Transfer Mode

Specifies whether the transfer is binary code or ASCII 

Select Binary or ASCII.

Append

Specifies whether to overwrite or append the data to the existing file.  

Yes: Means the data will be appended to an existing file.

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

Local File Overwrite

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

Select Yes or No.

Remote Directory

Specifies the virtual directory server where data is published or subscribed. 

The remote directory name 

Remote File

Specifies the name of a file on the remote server used to receive or hold data for retrieval. 

The remote file name. 

Local Directory

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

The local directory name 

Local File

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

The local file name 

Transfer Mode

Specifies whether the transfer is binary code or ASCII 

Select Binary or ASCII.

Copy Recursive

Specifies whether the copy is recursive (copied to all subdirectories) 

Select Yes or No.

Remote Directory

Specifies the virtual directory server where data is published or subscribed. 

The remote directory name 

Remote Directory Name Is Pattern

Specifies the meaning of the remote directory name.  

Yes: Indicates that the remote directory name represents a pattern to be used as a regular expression for pattern matching.

No: Indicates that the remote directory name represents the exact name to be used, without pattern matching

Select Yes or No.

Remote File

Specifies the name of a file on the remote server used to receive or hold data for retrieval. 

The remote file name. 

Remote File Name Is Pattern

Specifies the meaning of the remote file name:  

Yes: Indicates that the remote file name represents a pattern to be used as a regular expression for pattern matching.

No: Indicates that the remote file name represents the exact name to be used, without pattern matching

Select Yes or No.

Local Directory

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

The local directory name. 

Local Directory Name Is Pattern

Specifies the meaning of the local directory name:  

Yes: Indicates that the local directory name represents a pattern to be used as a regular expression for pattern matching.

No: Indicates that the local directory name represents the exact name to be used, without pattern matching.

Select Yes or No.

Local File

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

The local file name. 

Local File Name Is Pattern

Specifies the meaning of the local file name:  

Yes: Indicates that the local file name represents a pattern to be used as a regular expression for pattern matching.

No: Indicates that the local file name represents the exact name to be used, without pattern matching

Select Yes or No.

Transfer Mode

Specifies whether the transfer is binary code or ASCII. 

Select Binary or ASCII.

#

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

#   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

Commands Supported by FTP Server

Specifies the commands that the FTP server on the given host supports. 

One or more FTP commands as selected from the list. 

Header Lines To Skip

Specifies the number of beginning lines from a LIST command to be considered as a potential header (subject to the Header Indication Regex Expression configuration parameter, discussed below) and skipped.

A non-negative integer. Enter zero if there are no headers. 

For an example, see Header Lines To Skip.

Header Indication Regex Expression

Specifies a regular expression used to help identify lines which comprise the header in the output of a LIST command. All the declared lines of the header (see Header Lines To Skip, above) must match the regular expression.

A regular expression. The default varies based on the FTP server’s operating system. If there is no reliable way of identifying the header lines in the LIST command’s output, leave this parameter undefined.

Additional Information

The regular expression “^ *total” indicates that each line in the header starts with “total,” possibly preceded by blanks. For an example, see Header Indication Regex Expression.

If the regular expression is undefined, then the header is solely determined by the value of the configuration parameter Header Lines To Skip.

Trailer Lines To Skip

Specifies the number of ending lines from a LIST command that are to be considered as a potential Trailer (subject to the Trailer Indication Regex Expression) and skipped.

A non-negative integer. Enter zero if there are no trailers. 

Trailer Indication Regex Expression

Specifies the regular expression used to help identify lines which comprise the trailer in the output of a LIST command. All the declared lines of the trailer (see Trailer Lines To Skip) must match the regular expression.

A regular expression. If there is no reliable way of identifying the trailer lines in the LIST output, then leave this parameter undefined.

If the regular expression is undefined, then the header is determined solely by the value of the Trailer Lines To Skip configuration parameter.

Directory Indication Regex Expression

Specifies a regular expression used to identify external directories in the output of a LIST command. Directories cannot be retrieved and must be filtered out of the file list.

A regular expression. If there is no reliable way of identifying the directory in the LIST output, then leave this parameter undefined.

The regular expression “^ *d” specifies that a directory is indicated by a line starting with the lowercase ”d,’ possibly preceded by blanks. 

File Link Real Data Available

Specifies whether a file may be a file link (a pointer to a file) on those operating systems whereon an FTP server will return the data for the real file as opposed to the content of the link itself. 

Select Yes or No.

File Link Indication Regex Expression

Specifies a regular expression that identifies external file links in the output of a LIST command. File links are pointers to the real file and usually have some visual symbol, such as- >, mixed in with the file name in the output of the LIST command. Only the link name is desired within the returned list.

A regular expression. If there is no reliable way of identifying a file link within a LIST output, then leave this parameter undefined.

Additional Information

The regular expression “^ *l” specifies that a file link is indicated by a line starting with the lowercase “l,” preceded possibly by blanks. 

File Link Symbol Regex Expression

Specifies a regular expression that parses the external file link name in the output of a LIST command. Only the link name is required for the file list to be returned.

A regular expression. If there is no reliable way of identifying a file link within a LIST output, then leave this parameter undefined.

The regular expression “[ ] ->[ ]” defines that a file link symbol is represented by an arrow surrounded by spaces (“ -> “). When parsed, only the file name to the right of the symbol is used. 

In the example, File Link Symbol Regex Expression, only the public_html would be used, not the “p” character:

List Line Format

Specifies whether fields in each line are blank delimited or fixed, that is, whether information always appears at certain columns. 

Select Blank Delimited or Fixed.

For a Fixed list line format, enter a value equal to the number of columns, counting the first column at the far left as column 1. For a Blank Delimited list line format, enter a value equal to the number of fields, counting the first field on the far left as field 1.

For either case, if no minimum can be determined, set this value to zero (0). 

Additional Information

In the Blank Delimited line in the example in List Line Format, the minimum number of fields is 9:

Valid File Line Minimum Position

Specifies the minimum number of positions (inclusive) a listing line must have in order to be considered as a possible valid file name line. 

The URL FTP Proxy will fail on ascertaining file names that have leading blanks, trailing blanks, or both.

File Name Is Last Entity

Specifies whether the file name is the last entity on each line. This allows the file name to have imbedded blanks (however, leading or trailing blanks are not supported). 

Select Yes or No.

File Name Position

Specifies the starting position (inclusive) of a file name. 

For Fixed list line format, enter the column number, counting the first column on the far left as column 1. For Blank Delimited list line format, enter the field number, counting the first field on the extreme left as field 1.

Additional Information

For Blank Delimited List Line Format only, if the file name has imbedded blanks, then it can span over several fields. For an example, see File Name Position.

File Name Length

Represents the maximum width of a file name; valid only for Fixed list line format.

Enter any one of the following: 

• An Integer: Positive lengths imply that the file name is right-justified within the maximum field width, and thus leading-blanks are discarded.

  • Negative Lengths: That is, compared to the absolute length, imply that the file name is left-justified and trailing-blanks are discarded.

  • Zero (0) Value Length: If the file name is at the end of a file listing line, this value implies that the file name field extends to the end of the line.

    ---

    Note –

    For Blank Delimited list line format, this value is usually zero (0). However, if the File Name Length parameter is supplied even though a Blank Delimited list line format is specified, this implies that if the file name field exceeds the given length, then the rest of the List Line data occurs on the following line.

    ---

File Extension Position

Specifies the left-most position of the file extension for those operating systems that present the file name extension separated from the main file name. 

For Fixed list line format, enter the column number, counting the first column at the extreme left as column 1. For Blank Delimited list line format, enter the field number, counting the first field at the far left as field 1. If there is no file extension (as on UNIX systems) set the value to zero (0).

File Extension Length

Specifies the maximum width of the file extension; valid only for Fixed list line format.

Enter any one of the following: 

An Integer

• Positive Lengths: Imply that the file extension is right-justified within the maximum field width and therefore leading-blanks are discarded.

• Negative Lengths: Imply that the file extension is left-justified and trailing-blanks are discarded (the absolute length is used).

• Value of Zero (0): Always for the Blank Delimited list line format.

File Size Verifiable

Specifies whether the file size is verifiable, significant, and accurate within a directory listing. 

Select Yes or No. The File Size Stability Check configurable parameter must also be enabled.

Additional Information

Even if the file size field of a listing line is not significant (that is, it is there but only represents an approximate value), the value of this parameter must be No. However, the file size location must still be declared in the File Size Position to assist determining which line of listing represents a valid file name. For an example, see File Size Verifiable.

Use of this parameter does not guarantee that the file is actually stable. As this feature is intended only for backward compatibility with previous FTP implementations, we do not recommend that you rely on this functionality for critical data.

File Size Position

Specifies the left-most position in the listing line that represents the size of the file. Even though for some operating systems the value shown might not truly reflect the file size, this position is still important in ascertaining that the line contains a valid file name. 

A non-negative integer. For Fixed list line format, the position value is the column number (starting with one (1) on the far left). For Blank Delimited, this value represents the field number (starting with one (1) on the far left). If the LIST line does not have a size field, set this parameter to zero (0). For an example, see File Size Position.

File Size Length

Specifies the maximum width (number of columns) of the file size field, only valid for Fixed List Line Format.

A non-negative integer. For Blank Delimited list line format, set this value to zero (0).

Special Envelope For Absolute Path Name

Specifies special enveloping characters required to surround an absolute path name (for example, single quotes are used in MVS). Only use a single quote at the start of the directory name. 

A pair of enveloping characters. Even if the leading and trailing character is identical, enter it twice. 

If no enveloping characters are required for an operating system, leave this parameter undefined. 

On UNIX, this parameter is always undefined.

Listing Directory Yields Absolute Path Names

Specifies whether, when the DIR command is used on a directory name, the resulting file names are absolute.

Select Yes or No.

On UNIX, this character is always set to No.

Absolute Path Name Delimiter Set

Specifies any absolute path requiring certain delimiters to separate directory names (or their equivalent) from each other and from the file name. 

Enter the delimiters for the absolute path, starting from the left, for: 

• Initial (left-most) directory delimiter

• Intermediate directory delimiters

• Initial (left-most) file name delimiter

• Optionally, the ending (right-most) file name delimiter

Wherever there is no specific delimiter, use “\0” (backslash zero) to act as a placeholder. Delimiters that are backslashes need to be escaped with another backslash. 

Change Directory Before Listing

Determines whether a change directory (cd) command needs to be done before issuing the DIR command to get a listing of files under the desired directory.

Select Yes or No.

The current Batch Adapter implementation does not rely on this parameter.

Directory Name Requires Terminator

Determines whether a directory name that is not followed immediately by a file name requires the ending directory delimiter as a terminator (for example, as on VMS). 

Select Yes or No.

Header Lines To Skip

Header Indication Regex Expression

Directory Indication Regex Expression

File Link Indication Regex Expression

File Link Symbol Regex Expression

List Line Format

Directory Indication Regex Expression

File Name Position

File Size Verifiable

File Size Position

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

The following text represents valid number representations of file sizes: 

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

The following text represents invalid number representations of file sizes (the ^ indicates where the error occurs): 

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

Type

Specifies the connector type. 

Enter CICS. The value always defaults to CICS for CICS connections.

Connection Transport

Specifies the underlying connection transport used by the CICS Adapter to send requests to and get responses from a CICS region. 

Select one of the following underlying connection transports: 

• Sun CICS Listener

• CICS Transaction Gateway (specifies the IBM CICS Transaction Gateway)

Sun CICS Listeneris the configured default.

Class

Specifies the class name of the CICS Client connector object. 

The (class) package name for the CICS Client connector object. The default is com.stc.adapters.cics.CicsClientConnector.

Property.Tag

Specifies the data source identity. This parameter is required by the current EBobConnectorFactory.

The data source package name. 

ECI call type

Specifies whether the ECI call type is Synchronous. Synchronous calls wait for the transaction to complete, then return the contents of the COMMAREA. Only Synchronous calls are supported. 

Synchronous is the configured default.

CICS Program

Specifies the CICS program to be run on the server. Maximum length is eight characters. 

A CICS program name, eight characters or less. 

CICS TransId

CTG specific. Specifies the ID of a CICS transaction. Maximum length is four characters. Attributes are dependent upon the value set for Use TransId as ECI_TPN, as follows:

• If EciTPN is set to FALSE, the value of the transid is stored in EIBTRNID for the duration of the LINK to the program specified in the Program parameter. The called program runs under the mirror transaction CPMI, but is linked to under the Transid transaction name. This name is available to the called program for querying the transaction ID. Some servers use the transaction ID to determine security and performance attributes for the called program.

• If EciTPN is set to TRUE, the Transid will be interpreted as the ECI_TPN transid, a transaction that will be used in the server to process the ECI request. This transaction must be defined in the server as a CICS mirror transaction. If the ECI request is extended, this parameter has a meaning only for the first request.

A CICS transaction ID of four characters or less. 

Use TransId as ECI_TPN

CTG specific. Specifies whether the TransId is interpreted as ECI_TPN or if the called program runs under the default mirror transaction CPMI. Options are:

• True: Indicates that the TransId is interpreted as ECI_TPN.

• False: Indicates that the called program runs under the default mirror transaction CPMI, and is linked to under the TransId (if present).

Select True or False.

False is the configured default.

COMMAREA Length

Specifies the length (in bytes) of the COMMAREA passed to the ECI. 

A number indicating the byte length of the COMMAREA. 

When using the CICS Transaction Gateway transport, data sent to CICS must be padded with spaces, if necessary, to match the full size of the commarea.

ECI extend mode

Specifies whether a logical unit of work is terminated at the end of a call. 

Select Yes or No.

Yes indicates that the work unit is terminated at the end of a call.

The configured default is No.

ECI LUW Token

CTG specific. Specifies an integer used to identify the logical unit of work (LUW) to which a call belongs. This must be set to 0 (zero) at the start of an LUW, even if the LUW is to be extended. The ECI updates the value upon the first (or only) call of the LUW. If the LUW is to be extended, this value is used as input to any subsequent calls associated with the same LUW.

If the return code is not ECI_NO_ERROR, and a call is ending or continuing an existing LUW, then this field is used to report the state of the LUW as follows: 

• A code of 0 (zero) indicates that the LUW has ended and its updates have been backed out.

• Any non-zero code indicates the current input value. It also indicates that the LUW is continuing, and updates are still pending.

  See the Logical units of work in ECI table in the CICS Transaction Gateway: Programming Guide for more information.

An integer used to identify the ECI logical unit of work. 

Encoding

Specifies the canonical name for the encoding set. 

The canonical name for any encoding set supported by Sun’s Java Runtime Environment 1.1.8 (contained in rt.jar and i18n.jar). Examples are ASCII and Cp500 (EBCDIC). When running the CICS Adapter on a z/OS platform, set the Encoding value to Cp500.

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

Polling Interval

Specifies the interval (in milliseconds) at which the e-mail source file is polled for new incoming e-mail messages. 

A number indicating the polling interval in milliseconds. 

The configured default is 5000 (5 seconds).

Input file name

Specifies the file mask for input data files.

A file mask. The default is input*.txt. You can provide only an extension with an asterisk (), for example, *.txt, to allow all files with that extension. An input file’s extension is renamed to .~in after it is picked up.

If a file with the same name as the rename name exists, for example, input1.txt.~in , picking up the input file fails. You must ensure no files with the rename names exist before the files are processed by the inbound file poller.

Polling interval

The number of milliseconds the adapter waits between poll attempts of the input directory.

The polling interval and the MDB pool size can be “tuned” based on the expected volume and frequency of incoming messages.  

An integer; the acceptable range is an integer from 2 to 99999, inclusive, and the default is 5000 (5000 milliseconds or 5 seconds). It is not advised to enter a value less than 5 seconds.

There is no error message if you enter an incorrect value.

Input type

Specifies the type of input file, for example, bytes.

A file type. The default is Bytes, the only valid value.

Remove EOL

Specifies whether the adapter excludes the terminating End-Of-Line (EOL) characters from records (messages) sent to a subscriber. This property only applies if the Multiple records per file property is set to True.

Select True or False

• True: Enables the feature.

• False: Disables the feature.

  The default is False.

Multiple records per file

Specifies whether multiple records (messages) are obtained per file. If this property is set to True, multiple records (messages) are generated per line, up to the number specified in the Maximum bytes per record property. Any data exceeding the maximum bytes per record size is sent in subsequent messages.

Select True or False.

• True: Enables the feature.

• False: Disables the feature.

  The default is False.

Maximum bytes per record

Specifies the maximum number of bytes per record (message) sent to a subscriber. This property only applies if the Multiple records per file property is set to True.

An integer; the acceptable range is an integer from 2 to 99999, inclusive, and the default is 4096.

There is no error message if you enter an incorrect value.

Encoding

Specifies the valid encoding names. For more information on Java encoding, refer to the following site: http://java.sun.com/j2se/1.3/docs/api/java/lang/package-summary.html

The encoding names. 

SerialMode

Specifies whether messages will be handled in serial mode (one after the other) or concurrently. 

Select True or False.

• True: Indicates that messages are handled in serial mode.

• False: Indicates that messages handled concurrently.

  The configured default is True.

Output file name

Specifies the file mask for output data files.

An appropriate file name. The default is output%d.dat. The %d in the file name is a counter and increments for each new file.

Instead of %d, you can use any other printf style that takes an integer or long value. For example, you can specify 1%d or %012d

In cases where the Multiple records per file property is set to False:

• If no output file exists at the time of the first execution, a new output file is created for each record.

• If an output file already exists at the time of the first execution, messages are appended to it.

  ---

  Note –

  For more information regarding the printf feature, see the appropriate C language documentation.

  ---

Add EOL

Specifies whether the system adds an end-of-line character to each record the adapter sends to the output file. 

Select True or False.

• True: Indicates that the system will add an EOL to each record.

• False: Indicates otherwise.

  The configured default is False.

Multiple records per file

Specifies whether multiple records (messages) can be written to the output file. New messages are appended to the output file. 

Select True or False.

• True: Indicates that the output file will contain multiple records (messages).

• False: Indicates that each output file contains a single record (message).

  The configured default is True.

Encoding

Specifies the valid encoding names. For all valid encodings, please refer to the following site: http://java.sun.com/j2se/1.3/docs/api/java/lang/package-summary.html

The encoding names. 

Allow Cookies