...
Part of the configuration may be done in the Filename Sequence or Sort Order service tabs described in the sections, Filename Sequence Tab, and Sort Order Tab in Workflow Template (3.0).
Configuration
The FTP Collection agent consists of three tabs: Connection, Source and Advanced.
Connection Tab
The
tab contains configuration data that is relevant to a remote server....
Setting | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Host | Primary host name or IP address of the remote host to be connected. If a connection cannot be established to this host, the Additional Hosts specified in the Advanced tab, are tried. | ||||||||||
Username | Username for an account on the remote host, enabling the FTP session to login. | ||||||||||
Password | Password related to the Username. | ||||||||||
Transfer Type | Data transfer type to be used during file retrieval.
| ||||||||||
File System Type | Type of file system on the remote host.
| ||||||||||
Collection Retries | Select this check box to enable repetitive attempts to connect and start a file transfer. When this option is enabeled, the agent will attempt to connect to the host as many times as is stated in the Max Retries field described below. If the connection fails, a new attempt will be made after the number of seconds entered in the Retry Interval (s) field described below. | ||||||||||
Retry Interval (s) | Enter the time interval in seconds, between retries. If a connection problem occurs, the actual time interval before the first attempt to reconnect will be the time set in the Timeout field in the Advanced tab plus the time set in the Retry Interval (s) field. For the remaining attempts, the actual time interval will be the number seconds entered in this field. | ||||||||||
Max Retries | Enter the maximum number of retries to connect. In case more than one connection attempt has been made, the number of used retries will be reset as soon as a file transfer is completed successfully.
| ||||||||||
RESTART Retries | Select this check box to enable the agent to send a RESTART command if the connection has been broken during a file transfer. The RESTART command contains information about where in the file you want to resume the file transfer. Before selecting this option, ensure that the FTP server supports the RESTART command. When this option is selected, the agent will attempt to re-establish the connection, and resume the file transfer from the point in the file stated in the RESTART command, as many times as is entered in the Max RESTARTS field described below. When a connection has been re-established, a RESTART command will be sent after the number of seconds entered in the Retry RESTARTS Interval (s) field described below.
For further information about the RESTART command, see http://www.w3.org/Protocols/rfc959/. | ||||||||||
Retry RESTARTS Interval (s) | Enter the time interval, in seconds, you want to wait before initiating a restart in this field. This time interval will be applied for all restart retries. If a connection problem occurs, the actual time interval before the first attempt to send a RESTART command will be the time set in the Timeout field in the Advanced tab plus the time set in the Retry Interval (s) field. For the remaining attempts, the actual time interval will be the number seconds entered in this field. | ||||||||||
Max RESTARTS | Enter the maximum number of restarts per file you want to allow. If more than one attempt to send the RESTART command has been made, the number of used retries will be reset as soon as a file transfer is completed successfully. |
Source Tab
The
tab contains configurations related to the remote host, source directories and source files. The following text describes the configuration options available when no custom strategy has been chosen....
Setting | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Collection Strategy | If there are more than one collection strategy available in the system, a Collection Strategy drop down list will also be visible. For further information about the nature of the collection strategy, see Collection Strategies(3.0). | ||||||||||
Directory | Absolute pathname of the source directory on the remote host, where the source files reside. If the FTP server is of UNIX type, the path name might also be given relative to the home directory of the User Name account. | ||||||||||
Include Subfolders | Select this check box if you have subfolders in the source directory from which you want files to be collected.
If you select Enable Sort Order in the Sort Order tab, the sort order selected will also apply to subfolders. | ||||||||||
Filename | Name of the source files on the remote host. Regular expressions according to Java syntax applies. For further information, see http://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.
| ||||||||||
Compression | Compression type of the source files. Determines if the agent will decompress the files before passing them on in the workflow.
| ||||||||||
If enabled, the source files will be moved to the automatically created subdirectory | |||||||||||
Append Suffix to Filename | Enter the suffix that you want added to the file name prior to collecting it.
| ||||||||||
Inactive Source Warning (h) | If enabled, when the configured number of hours have passed without any file being available for collection, a warning message (event) will appear in the System Log and Event Area: The source has been idle for more than <n> hours, the last inserted file is <file>. | ||||||||||
If enabled, the source files will be moved from the source directory (or from the directory
| |||||||||||
If enabled, the source files will be renamed after the collection, and remain (or moved back from the directory
| |||||||||||
If enabled, the source files will be removed from the source directory (or from the directory | |||||||||||
If enabled, the source files will remain in the source directory after the collection. This field is not available if is enabled. | |||||||||||
Destination | Full pathname of the directory on the remote host into which the source files will be moved after the collection. This field is only available if is enabled. | ||||||||||
Prefix and Suffix | Prefix and/or suffix that will be appended to the beginning and the end of the name of the source files, respectively, after the collection. These fields are only available if or is enabled.
| ||||||||||
Search and Replace | Select either Move to or Rename option to enable Search and Replace.
Search and Replace operate on your entries in a way that is similar to the Unix sed utility. The identified filenames are modified and forwarded to the following agent in the workflow. This functionality enables you to perform advanced filename modifications, as well:
| ||||||||||
Keep (days) | Number of days to keep moved or renamed source files on the remote host after the collection. In order to delete the source files, the workflow has to be executed (scheduled or manually) again, after the configured number of days.
|
Advanced Tab
The Advanced tab contains configurations related to the use of the FTP service.
...