Versions Compared

Old Version 1

changes.mady.by.user Jenni Wallin

Saved on

compared with

New Version Current

changes.mady.by.user Yuri Au Yong

Saved on

Key

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

The agent configuration consists of the following tabs:

  • Connection
  • Source
  • Advanced
  • Security


Note
titleNote!

You can configure part of the parameters in the Filename Sequence or Sort Order service tabs. For further information, see Workflow Template (4.3.0).

Connection Tab

The Connection tab contains configuration settings related to the remote host and authentication. 

...

SettingDescription

Move to Temporary Directory

If you select this option, the source files are moved to the automatically created subdirectory DR_TMP_DIR in the source directory, prior to collection. This option supports safe collection of a source file reusing the same name.

Append Suffix to Filename

Enter the suffix that you want added to the file name prior to collecting it.

Warning
titleImportant!

Before you execute your workflow, make sure that none of the file names in the collection directory include this suffix.


Inactive Source Warning (h)

IIf the value that you enter is greater than zero, and if no file has been collected during the specified number of hours, the following message is logged:

The source has been idle for more than <n> hours, the last inserted file is <file>.

Move to

If you select this option, the source files are moved from the source directory (or from the directory DR_TMP_DIR, if using Move Before Collecting) after collection, to the directory specified in the Destination field.

If Prefix or Suffix are set, the file will be renamed as well.

Enter the absolute pathname of the directory on the remote host into which the source files will be moved after the collection.

This
Note
titleNote!

If By default, if a file with the same filename already exist exists in the target directory, this the file will be overwritten and the workflow will not abort.

Destination

only if the contents of the file are the same. If the contents are not the same, the workflow will abort for SFTP Batch agent and log an error for SFTP batch-based real-time agent. If you want the workflow to overwrite the files unconditionally, select the Overwrite checkbox described in this table below.


Destination

Enter the absolute 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 Move to is enabled.

Note
titleNote!

The  Directory  has to be located in the same file system as the collected files at the remote host. Also, absolute pathnames must be defined. Relative pathnames cannot be used.


Prefix and Suffix

Enter the prefix and/or suffix that will be appended to the source files after the collection.

These fields are only available if Move to or Rename is enabled.

Search  and  Replace

To apply Search and Replace, select either Move to or Rename.

  • 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 following agent in the workflow.

This functionality also allows you to perform advanced filename modifications:

  • Use regular expression in the Search entry to specify the part of the filename that you want to extract.

    Note
    titleNote!

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


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

    Info
    titleSearch 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
    titleNote!

    The search value divides the file name into two parts by using brackets. 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 the collection. To delete the source files, the workflow has to be executed again (scheduled or manually), after the configured number of days.

Note
titleNote!

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


OverwriteIf selected, the existing file with the same name will be overwritten unconditionally. This field is only available for Default Collection Strategy and if Move to or Rename is enabled.

Rename

If this option is selected, the source files are renamed after the collection, remaining (or moved back from the directory DR_TMP_DIR, if using Move Before Collecting) in the source directory from which they were collected.

Keep (days)

Enter the number of days to keep moved or renamed source files on the remote host after the collection. To delete the source files, the workflow has to be executed again (scheduled or manually), after the configured number of days

Note
titleNote!

You must avoid creating new file names still matching the criteria for what files to be collected by the agent, or else the files will be collected over and over again.


Note
titleNote!

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

Rename

If this option is selected, the source files are renamed after the collection, remaining (or moved back from the directory DR_TMP_DIR, if using Move Before Collecting) in the source directory from which they were collected.

Note
titleNote!

You must avoid creating new file names still matching the criteria for what files to be collected by the agent, or else the files will be collected over and over againBy default, if a file with the modified name already exists, this file will be overwritten only if the contents of the file are the same. If the contents are not the same, the workflow will abort for SFTP Batch agent and log an error for SFTP batch-based real-time agent. If you want the workflow to overwrite the files unconditionally, select the Overwrite checkbox described in this table above.


Remove

If this option is selected, the source files are removed from the source directory (or from the directory DR_TMP_DIR, if using Move Before Collecting), after collection.

Ignore

If this option is selected, the source files remain in the source directory after the collection. This option is not available if Move Before Collecting is enabled.

...

SettingDescription
Duplicate Criteria - FilenameSelect this option to have only the filename compared for the duplicate check. If the filename is in the list of files which have already been collected once, the file is ignored by the agent.
Duplicate Criteria - Filename and Timestamp

Select this option to have both the filename and the time stamp of the last modification, compared when checking for duplicates.

Note
titleNote!

If the number of files to be collected is greater than the file list size, files older than the oldest file in the list are not collected.



Advanced Tab

The Advanced tab contains configurations related to more specific use of the SFTP Advanced service.

...