Versions Compared

Old Version 2

changes.mady.by.user Henrik Pålsson

Saved on

compared with

New Version Current

changes.mady.by.user Jenni Wallin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

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

Transfer Type

Select the data transfer type to be used during file retrieval.

  • Binary - The agent uses the binary transfer type. This is the default setting.

  • ASCII - The agent uses ASCII transfer type.

File System Type

Select the type of file system on the remote host.

  • Unix - The remote host uses a Unix file system. This is the default setting.

  • Windows NT - The remote host uses a Windows NT file system.

  • VAX/VMS - The remote host uses a VAX/VMS file system.

Example - How characters are truncated

A_VERY_LONG_FILENAME_WITH_MORE_THAN_39_ CHARACTERS.DAT;5

is converted to

A_VERY_LONG_FILENAME_WITH_MORE_THAN_39_. CHARACTERSDAT;5

Note

Note!

When the File System Type for If you select VAX/VMS is selected, some issues must be considered. 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.

Info
title

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

Note!

This number does not include the original connection attempt.

...

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

Note

Note!
Filename must be one specific filename. Multiple filenames or wildcards cannot be used.

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

  • No Compression - The agent does not decompress the files.

  • Gzip - The agent decompresses the files using gzip.

Before Collection

Move to Temporary Directory

If this option is enabled, the source files will be moved to a subdirectory called DR_TMP_DIR in the source directory, before collection. This option supports safe collection when source files repeatedly use the same name.

Append Suffix to Filename

Enter the suffix that you want to be added to the file name prior to collection.

Warning

Important!

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 to Temporary Directory) to the directory specified in the Destination field, after collection.

Note

Note!

The Directory has to be located in the same file system as the collected files. The absolute path names must be defined.

If a file with the same filename, but with different content, already exists in the target directory, the workflow will abort.

If a file with the same file name, and the same content, already exists in the target directory, this file will be overwritten and the workflow continue running.

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 DR_TMP_DIR if using Move to Temporary Directory) in the source directory.

Note

Note!

When the  File System Type for VAX/VMS is selected, there 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 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 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: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

Note!

Creating a new file on the FTP server with the same file name as the original file, but with 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 will overwrite the file.

Remove

If enabled, the source files will be removed from the directory (or from the directory DR_TMP_DIR, if using the Move to Temporary Directory option, after collection.

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.

Warning

Warning!

If  Rename is selected, 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

Select either the Move or Rename option.

  • Search: Enter the part of the filename that you want to replace.

  • Replace: Enter the replacement text.

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.

Note

Note!

A regular expression that fails to match the original file name will abort the workflow.

  • Enter Replace with characters and meta characters that define the pattern and content of the replacement text

Info

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)

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.

Note

Note!

A date tag is added to the filename, determining when the file may be removed. This field is only available if the Move to or Rename option is enabled.

...

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.

...