Netia FTP Agent Configuration(4.3)
You open the Netia FTP agent configuration dialog from a workflow configuration. To open the Archiving forwarding agent configuration, click Build → New Configuration. Select Workflow in the Configurations list. When prompted to select workflow type, select Batch. Click Add agent and select NetiaFTP from the Collection tab in the Agent Selection list.
Connection Tab
The Connection tab contains configuration data that is relevant to a remote server.
Field | Description |
---|---|
Host | Enter the 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. Note!The FTP Agent supports both IPv4 and IPv6 addresses |
Username | Enter the username for an account on the remote host, enabling the FTP session to login. |
Password | Enter the password for the Username stated. |
Transfer Type | Select the data transfer type to be used during file retrieval.
|
File System Type | Select the type of file system on the remote host.
Note!If you select VAX/VMS, there are some additional 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 apply: A VAX/VMS filename consists of <file name>.<extension>;<version>, where the maximum number of characters for each part is: <file name>: 39 characters <extension>: 39 characters <version>: 5 characters If the new filename turns out to be longer than 39 characters, the agent moves 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. Example - How characters are truncated
is converted to
|
Enable Collection Retries | Select this check box to enable repetitive attempts to connect and collect data. |
Retry Interval (s) | Enter the time interval in seconds, between retries. |
Max Retries | Enter the maximum number of retries to connect. Note!This number does not include the original connection attempt. |
Source Tab
The Source tab contains configurations related to the remote host, source directories and source files.
Setting | Description |
---|---|
Collection Strategy | Only the Default Collection Strategy is available for the Netia FTP collection agent, so this option should always be selected in this drop-down-list. |
Include Subfolders | This is not supported for the Netia FTP collection agent and selecting this checkbox will not have any effect. |
Directory | The directory setting is not used for the Netia FTP collection agent. However, since this field needs to be populated for the agent to validate, enter "." or ““/” in this field. |
Filename | This field is used for determining the name of the source file(s) on the remote host. If you have disabled the Filename Sequence settings, you have to enter the complete name of the file to be collected in this field. If you have enabled the Filename Sequence settings, enter the filename up to the point where the sequence number begins in this field. For example, if the names of the files are "IX.ICAMA.<sequence number>", enter "IX.ICAMA." in this field. For more information, see Filename Sequence Tab below. |
Compression | Compression type of the source files. This setting determines if the agent will decompress the files before passing them on in the workflow.
|
Before Collection | |
Move to Temporary Directory | If this option is enabled, the source files will be moved to a subdirectory called |
Append Suffix to Filename | Enter the suffix that you want to be added to the file name prior to collection. |
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 |
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 |
Remove | If enabled, the source files will be removed from the directory (or from the directory |
Ignore | If enabled, the source files will remain in the source directory after the collection. This field is not available if the Move to Temporary Directory option is enabled. |
Destination | Enter the full pathname to the directory on the remote host into which the source files will be moved after the collection. This field is only available 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. |
Search and Replace | Select either the Move or Rename option.
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 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.
|
Keep (days) | Enter the number of days to keep moved or renamed source files on the remote host after 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.
For example, if the FTP server used does not return the file listed in a well-defined format, the Disable File Detail Parsing option can be useful, see Disable File Detail Parsing.
Setting | Description |
---|---|
Command Port | The value in this field defines which port number the FTP service will use on the remote host. |
Timeout (s) | The maximum time, in seconds, to wait for a response from the server. 0 (zero) means to wait forever. |
Passive Mode (PASV) | This setting must be enabled if FTP passive mode is used for data connection. In passive mode, the channel for data transfer between client and server is initiated by the client instead of by the server. This is useful when a firewall is situated between the client and the server. |
This setting disables parsing of file detail information received from the FTP server. This enhances the compatibility with unusual FTP servers but disables some functionality. If file detail parsing is disabled, file modification timestamps are unavailable to the collector. The collector does not have the ability to distinguish between directories and simple files. For that reason, subdirectories in the input directory must not match the filename regular expression. The agent assumes that a file named DR_TMP_DIR is a directory because a directory named DR_TMP_DIR is used when Move to Temporary Directory in the Source tab is activated. Therefore, you cannot name a regular file in the collection directory DR_TMP_DIR. | |
Additional Hosts | List of additional host names or IP addresses that may be used to access the source directory, from which the source files are collected. These hosts are tried, in sequence from top to bottom, if the agent fails to connect to the remote host, set in the Connection tab. Use the Add, Edit, Remove, Move up and Move down buttons to configure the host list. |
Filename Sequence Tab
The Filename Sequence settings are used when you want to collect files containing a sequence number in the file name. The sequence number is expected to be found on a specific position in the file name and will have a fixed or dynamic size.
Setting | Description |
---|---|
Enable Filename Sequence | This setting determines if the service will be used or not. If the Filename Sequence settings are enabled, a list with possible files ending with the range of numbers defined by the Wrap On and Wrap To values will be generated before collection. Otherwise, a list with only one file with the name stated in the Source tab will be generated. |
Start Position | The offset in the file name where the sequence number starts. The first character has offset 0 (zero). In the example file name |
Length | The length of the sequence number, if the sequence number has a static length (padded with leading zeros). If the sequence number length is dynamic this value is set to 0 (zero). |
Wrap On | If the Filename Sequence service is enabled, a value must be specified on which the sequence will wrap. This number must be larger than the value entered for Wrap To. |
Wrap To | Enter the value that the sequence will wrap to. This value must be less than the value entered for Wrap On. |
Warn On Out of Sequence | If you select this check box, the agent will log an informative message to the System Log when detecting an out of sequence file, before deactivating. |