Sun Adapter for Batch User's Guide

BatchLocalFile Connectivity Map Properties

This section explains the properties for the BatchLocalFile OTD, accessed from the Connectivity Map.

The BatchLocalFile properties include the following sections:

Pre Transfer (BatchLocalFile Connectivity Map)
Sequence Numbering (BatchLocalFile Connectivity Map)
Post Transfer (BatchLocalFile Connectivity Map)
General Settings (BatchLocalFile Connectivity Map)
Target Location (BatchLocalFile Connectivity Map)

Caution –
Several of these configuration options allow regular expressions to be used. This advanced feature is useful but must be used carefully. An improperly formed regular expression can cause undesired data or loss of data. You must have a clear understanding of regular-expression syntax and construction before attempting to use this feature. It is recommended that you test such configurations thoroughly before moving them to production.

Pre Transfer (BatchLocalFile Connectivity Map)

This section provides information about configuring the Pre Transfer parameters. Pre-transfer operations are those operations executed right before the actual data transfer.

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

Table 44 Connectivity Map - BatchLocalFile - Pre Transfer


Name	Description	Required Value
Pre Directory Name	Specifies the directory name (path) on the external system in which a file is renamed or copied. This setting is only for the Rename or Copy operations of Pre Transfer Command parameter. The value can be a literal, or pattern name. For outbound transfers, the directory is created if it does not already exist. Special characters are allowed. For example, the pattern %f indicates the original working directory name. The expansion of any special characters is carried out each time this parameter is used. See Note – For path separator, use the forward slash “ / ” instead of the back slash “ \ ”. The adapter interprets the back slash as a special character. For example, use `c:/temp/dir`. See Table 44. See Using Name Patterns.	Enter the exact name of the directory (with the path), enter a pattern name, or select one of the following values: %f %f.%y%y%y%y%M%M%d%d. %h%h%m%m%s%s%S%S%S %f.copy %f.rename
Pre Directory Name Is Pattern	Specifies whether the Pre Directory Name represents a literal or a name pattern, as follows: Yes: indicates that the name value you enter is assumed to be a name pattern. No: indicates that the name value entered is a literal, an exact match. No pattern matching or name expansion is done. See Table 44.	Select Yes or No. The configured default is No.
Pre File Name	Specifies the file name on the external system, to which a file is renamed or copied. This setting is only for the Rename or Copy operations of Pre Transfer Command parameter. The value can be a literal or pattern name. Special characters are allowed, for example, the pattern %f indicates the original working file name. The expansion of any special characters is carried out each time this parameter is used. See Table 44. See Using Name Patterns	Enter the exact name of the file, enter a pattern name, or select one of the following values: %f %f%# %f.%y%y%y%y%M%M%d%d.%h %h%m%m%s%s%S%S%S %f.copy %f.rename
Pre File Name Is Pattern	Specifies whether the Pre File Name represents a literal or a name pattern, as follows: Yes: indicates that the name value you enter is assumed to be a name pattern. No: indicates that the name value entered is a literal, an exact match. No pattern matching or name expansion is done. See Table 44.	Select Yes or No. The configured default is No.
Pre Transfer Command	Allows you to determine the action executed directly before the actual file transfer. In the case of an inbound file transfer, you can make the file unavailable to other clients polling the target system via the same directory and file pattern or name. In the case of an outbound transfer, you can make an automatic backup of the existing file. The options are as follows: Rename: Rename the target file. Copy: Copy the target file. None: Do nothing.	Select Rename, Copy, or None; the default is None. Note – Rename and Copy overwrite the file or directory specified by the Pre Directory Name and Pre Transfer Name parameter, if it exists.

Note –

For more information on this feature, see Pre/Post File Transfer Commands .

Sequence Numbering (BatchLocalFile Connectivity Map)

The Sequence Numbering section of the BatchLocalFile Connectivity Map properties contains the top-level parameters displayed in this table.

Table 45 Connectivity Map - BatchLocalFile - Sequence Numbering


Name	Description	Required Value
Max Sequence Number	Use this parameter when you have set the target file name to contain a sequence number. It tells the adapter to reset the sequence number to the Starting Sequence Number value when this value (the Max Sequence Number) has been reached. This parameter is used for the name pattern %#. See Using Name Patterns.	An integer from 1 to 2147483647. The value of Max Sequence Number must be greater than that of Starting Sequence Number. The configured default value is 999999.
Starting Sequence Number	Use this parameter when you have set up the target file name to contain a sequence number. It tells the adapter which value to start with in the absence of a sequence number from a previous run. Also, when the Max Sequence Number value is reached, the sequence number rolls over to the Starting Sequence Number value. This parameter is used for the name pattern %#. See Using Name Patterns.	An integer from 0 to 2147483647. The value of the Starting Sequence Number must be less than the Max Sequence Number. The configured default value is 1.

Note –

The Synchronized property, under General Settings, must be set to “Yes” to use Sequence Numbering.

Post Transfer (BatchLocalFile Connectivity Map)

Post-transfer operations are those performed after the data transfer.

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

Table 46 Connectivity Map - BatchLocalFile - Post Transfer


Name	Description	Required Value
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. Note – For path separator, use the forward slash “ / ” instead of the back slash “ \ ”. The adapter interprets the back slash as a special character. For example, use `c:/temp/dir`. See Table 46. See Using Name Patterns.	Enter the exact name of the directory (with the path), enter a pattern name, or select one of the following values: %f %f%# %f.%y%y%y%y%M%M%d%d. %h%h%m%m%s%s%S%S%S %f.copy %f.rename
Post Directory Name Is Pattern	Specifies whether the Post Directory Name represents a literal or a name pattern, as follows: Yes: indicates that the name value you enter is assumed to be a name pattern. No: indicates that the name value entered is a literal, an exact match. No pattern matching or name expansion is done. See Table 46.	Select Yes or No. The configured default is No.
Post File Name	Specifies either the name of the file that the transferred file is renamed to (Rename) or the directory it is moved to (Move), depending on the setting in the parameter Post Transfer Command. The value can be a literal or pattern name. Special characters are allowed. The expansion of any special characters are carried out each time this parameter is used. See Table 46. See Using Name Patterns.	Enter the exact name of the file, enter a pattern name, or select one of the following values:Select one of the following values: %f %f.%y%y%y%y%M%M%d%d. %h%h%m%m%s%s%S%S%S %f.copy %f.rename
Post File Name Is Pattern	Specifies whether the Post File Name represents a literal or a name pattern, as follows: Yes: indicates that the name value you enter is assumed to be a name pattern. No: indicates that the name value entered is a literal, an exact match. No pattern matching or name expansion is done. See Table 46.	Select Yes or No. The configured default is No.
Post Transfer Command	Allows you to execute a desired action directly after the actual file transfer. For an inbound transfer, you can mark the transferred file as “consumed” by making an automatic backup (Rename) or by destroying it permanently (Delete). For an outbound transfer, you can make the transferred file available to other clients by renaming it. The options are as follows: Rename: Rename the target file. Rename overwrites the file specified by the Post File Name and Post Directory Name, if it exists Copy: Copy the target file. Delete: Delete the target file (inbound transfers only). None: Do nothing.	Select Rename, Copy, Delete, or None. The configured default is None.

General Settings (BatchLocalFile Connectivity Map)

The General Settings section of the BatchLocalFile Connectivity Map properties contains the top-level parameters displayed in this table.

Table 47 Connectivity Map - BatchLocalFile - General Settings


Name	Description	Required Value
Resume Reading Enabled	Specifies whether the OTD handles the Resume Reading feature as follows: Yes: Enables the OTD to store any state information necessary to resume reading from the current file in a subsequent execution of the Collaboration Rule. No: Indicates that the file is considered “consumed” even if the streaming consumer did not read until the end of file.	Yes or No The configured default is No. Note – Synchronized must be set to “Yes” to use Resume Reading.
Synchronized	Specifically applies to legacy Batch Adapter Projects. Provides backward compatibility to allow Projects that were created using the Batch Adapter version 5.0.7 or earlier to be imported and deployed without a change in the adapter's behavior. The selections are: Yes: Provides backward compatibility for legacy (pre-5.0.8 Batch Adapter) Projects. The adapter runs in synchronized mode, one instance of the Collaboration after the other. No: For use with new Batch Adapter Projects. The adapter run in parallel, creating multiple instances of the Collaboration that run in parallel. Note – All OTD instances used in a Project should have the same value for this property.	Yes or No. The default setting is Yes, simulating Projects created with Batch Adapter version 5.0.7 or earlier. Note – Synchronized must be set to “Yes” to use Sequence Numbering or Resume Reading.

Target Location (BatchLocalFile Connectivity Map)

The Target Location section of the BatchLocalFile Connectivity Map properties contains the top-level parameters displayed in this table.

Table 48 Connectivity Map - BatchLocalFile - Target Location


Name	Description	Required Value
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. Note – For path separator, use the forward slash “ / ” instead of the back slash “ \ ”. The adapter interprets the back slash as a special character. For example, use `c:/temp/dir`. See Table 48. See Using Regular Expressions or Using Name Patterns.	The directory name.
Target Directory Name Is Pattern	Specifies whether the Target Directory Name represents a literal, or a regular expression or name pattern, as follows: Yes: indicates that the name value you enter is assumed to be a name pattern or regular expression. No: indicates that the name value entered is a literal, an exact match. No pattern matching or name expansion is done. See Table 48.	Select Yes or No The configured default is Yes.
Target File Name	Specifies the name of the file on the local system either to be retrieved or sent. The value can be a literal, regular expression (get), or pattern name (put). See Table 48. See Using Regular Expressions or Using Name Patterns	A file name.
Target File Name Is Pattern	Specifies whether the Target File Name represents a literal, or a regular expression or name pattern, as follows: Yes: indicates that the name value you enter is assumed to be a name pattern or regular expression. No: indicates that the name value entered is a literal, an exact match. See Table 48.	Select Yes or No The configured default is No.