You open the FTP collection agent configuration dialog from a workflow configuration: you can right-click the agent icon and select Configuration..., or double-click the agent icon.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 3.1.6 . To open the FTP collection agent configuration, click Build → New Configuration. Select Workflow from the Configurations dialog. When prompted to Select workflow type, select Batch. Click Add agent and select FTP from the Collection tab of the Agent Selection dialog.
The Filename Sequence and Sort Order tabs are described in Workflow Template.
Connection Tab
The tab contains configuration data that is relevant to a tab is used to configure the remote server connection.
Image RemovedImage Added
The FTP Collection Agent Configuration - Connection tab
...
Server ProviderHost | Primary host name The standard behavior is Single Server . If your system is installed with the Multi Server File functionality, you can configure the FTP agent to collect from more than one server. For further information, contact your System Administrator. | Host | Enter the hostname or IP address of the remote host |
to be connected. If a connection cannot be established to this host, |
the the Additional Hosts specified in the Advanced tab, are tried. |
Username |
Username for an account on Enter the username for the remote host |
, enabling the FTP session to loginPassword related to the Username.Enter the associated password. |
Transfer Type |
Data Select the data transfer type to be used during file retrieval. |
File System Type | Type of file system on the remote host. Unix - remote host using Unix file system. Default setting. Windows NT - remote host using Windows NT file system. VAX/VMS - remote host using VAX/VMS file system.
|
Enable Collection RetriesCollection Retries |
Enable | Select this check box to enable repetitive connection attempts |
to connect and start a file transfer. When this option is selected, the agent will attempt to connect to the host as many times as is stated in the Max Retries |
field described below field. If the connection fails, a new attempt will be made after the number of seconds entered in the Retry Interval (s) |
field described below field. |
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 field. For the remaining attempts, the actual time interval will be the number of seconds entered |
in this field RetriesIntervals | Enter the maximum number of |
retries to connectIn 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.
Note |
---|
|
This number does not include the original connection attempt. |
Enable RESTART Retries |
Restart Retries Settings |
Enable | Select this check box to enable the agent to send a RESTART command if the connection |
has been broken is lost during a file transfer. The RESTART command contains |
information about where in the file you want to resume the file transfer.the necessary interrupt information and will continue from that spot. Before selecting this option, ensure that the target 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 belowRestarts field. When a connection has been re-established, a RESTART command will be sent after the number of seconds entered in the Retry |
RESTARTS field described below settings settings will not work if you have selected to decompress the files in |
|
the , see the section below, Source Tab. is is not always supported for transfer type ASCII. |
|
RESTARTS 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 issue occurs, the actual time interval before the first attempt to send a RESTART command will be the time set in |
the the Timeout field in the Advanced tab plus the time set in the Retry Interval(s) |
field field. For the remaining attempts, the actual time interval will be the specified number of seconds |
entered in this field RESTARTSRestarts | 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 tab contains configurations configuration options 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.
Image RemovedImage Added
The FTP collection agent configuration - Source tab
Setting | Description |
---|
Collection Strategy | If there |
are is more than one collection strategy available |
in the system a drop also be made visible. For further information about |
the nature of the strategy11. Absolute pathname of Enter the absolute path to 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 given specified as relative to the home directory of |
the User Name accountthe account. |
Include Subfolders | Select this check box if you have subfolders in the collection source directory |
from which you want files to be collected. Note |
---|
| Subfolders that are in the form of a link are not supported. |
If you select Enable Sort Order in the Sort Order tab, the sort order selected will also apply to subfolders. |
Filename |
Name Enter the name of the source files on the remote host. Regular expressions according to Java syntax |
applies
Info |
---|
| To match all file names beginning with TTFILE , type: TTFILE.* |
Note |
---|
| When collecting files from VAX file systems, the names of the source files must include both the path and filename |
|
, which has to be considered when entering the regular expression. |
|
Compression |
Compression type of the source files. Determines Select the compression type. This option determines if the agent will decompress the files before passing them |
on in decompress decompress the files. Gzip
|
gzip |
Before Collection |
Move to Temporary Directory | If this option is enabled, the source files will be moved to |
the automatically created subdirectory a subdirectory called DR_TMP_DIR |
in in the source directory, before collection. This option supports safe collection when source files repeatedly |
uses use the same name. |
Append Suffix to Filename | Enter the suffix that you want to be added to the file name prior to |
collecting itcollection. Warning |
---|
| Before you execute your workflow, make sure that none of the file names in the collection directory include this suffix. |
|
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>. |
After Collection |
Move to | If enabled, the source files will be moved from the source directory (or from the directory DR_TMP_DIR if using Move |
Before Collecting, to the directory specified in |
the the Destination field, after collection. |
has has to be located in the same file system as the collected files |
|
at the remote host. Also, absolute pathnames . The absolute path names must be defined |
|
(relative pathnames cannot be used). If a file with the same filename, but with |
|
a different content, already exists in the target directory, the workflow will abort. If a file with the same file name, |
|
AND and the same content, already exists in the target directory, this file will be overwritten and the workflow |
|
will not abort. |
Rename Options |
Rename | If this option is enabled, the source files will be renamed after the collection, and remain (or moved back from the |
directory directory DR_TMP_DIR if using Move |
Before Collectingto Temporary Directory) in the source directory |
from which they were collected. Note |
---|
| When the File System Type |
|
for some issues must be consideredthere are special considerations. If a file is renamed after collection on a VAX/VMS system, the filename might become too long. In that case, the following rules |
|
will apply: A VAX/VMS filename consists of <file name>.<extension>;<version>, where the maximum number of characters for each part is: If the new filename turns out to be longer than 39 characters, the agent will move part of the filename to the extension part. If the total sum of the filename and extension part exceeds 78 characters, the last characters are truncated from the extension. An example: A_VERY_LONG_FILENAME_WITH_MORE_THAN_39_ CHARACTERS.DAT;5 will be converted to: A_VERY_LONG_FILENAME_WITH_MORE_THAN_39_. CHARACTERSDAT;5 |
Note |
---|
| Creating a new file on the FTP server with the same file name as the original file, but with |
|
another other content, will cause the workflow to abort. Creating a new file with the same file name AND the same content as the original file |
|
, cause to be overwritten |
Remove | If enabled, the source files will be removed from the |
source directory using Move Before Collecting)using the Move to Temporary Directory option, after |
the collection. |
Ignore | If enabled, the source files will remain in the source directory after the collection. This field |
is not available if Move Before Collectingis not available if the Move to Temporary Directory option is enabled. |
Destination |
Full of to the directory on the remote host into which the source files will be moved after the collection. This field is only available |
if if Move to 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 Move to or Rename is enabled. Warning |
---|
| If Rename is enabled, the source files will be renamed in the current (source or DR_TMP_DIR ) directory. Be sure not to assign a Prefix or Suffix , giving files new names still matching the Filename regular expression. That will cause the files to be collected over and over again. |
|
Search and Replace | |
either to or Rename option to enable Search and Replaceor Rename option. Search and Replace |
operate operate on your entries in a way that is similar to the Unix sed |
utilityutility. The identified filenames are modified and forwarded to the |
following target agent in the workflow. This functionality enables you to perform advanced filename modifications, as well: Use regular expression in the Search entry to specify the part of the filename that you want to extract. Note |
---|
| A regular expression that fails to match the original file name will abort the workflow. |
|
Enter with - with characters and meta characters that define the pattern and content of the replacement text
|
.
Info |
---|
title | Search and Replace Examples |
---|
| To rename the file file1.new to file1.old , use: - Search:
.new - Replace:
.old
To rename the file JAN2011_file to file_DONE , use: - Search:
([A-Z]*[0-9]*)_([a-z]*) - Replace:
$2_DONE
Note that the search value divides the file name into two parts by using parentheses. The replace value applies to the second part by using the place holder $2 . |
|
Keep (days) |
Number Enter the 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. Note |
---|
| A date tag is added to the filename, determining when the file may be removed. This field is only available |
|
if or is |
UDR Type Section |
Route FileReferenceUDR | Select this check box if you want to forward the data to an SQL Loader agent. |
See the description of the SQL Loader agent in 9.75 for further information Advanced Tab
The Advanced tab contains configurations related to the use of the tab contains advanced FTP service configuration options.
For example, if the used FTP server does not return the file listed in a well-defined format the , you can use Disable File Detail Parsing option can be useful. For further information, see the setting description belowavailable options.
Image RemovedImage Added
The FTP collection agent configuration - Advanced tab