Amazon S3 Collection Agent Configuration

Owned by Yeok Hong Ng (Deactivated)
Last updated: Jul 24, 2024
4 min read

To open the Amazon S3 collection agent configuration dialog from a workflow configuration, you can do the following:

  • right-click the agent icon and select Configuration...

  • select the agent icon and click the Edit button

Note!

If you are using the Amazon S3 collection agent in a Batch workflow, part of the configuration may be done in the Filename Sequence and Sort Order tabs in Workflow Template.

For Real-Time workflow, additional configurations in Decoder, Decompression and Execution tabs are available in Batch-Based Real-Time Agents - Agent Configuration.

 

The Amazon S3 tab contains settings related to the placement and handling of the source files to be collected by the agent.

Amazon S3 collection agent configuration - Amazon S3 tab

Setting

Description

Setting

Description

Profile

Select the File System profile you want the agent to use, see File System Profile for further information about this profile.

File Information

Directory

Enter the absolute pathname of the source directory on the location stated in the File System profile, where the source files reside.

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

Enter the name of the source files in the location stated in the File System profile. Regular expressions according to Java syntax applies. For further information, see http://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.

Example

To match all filenames beginning with TTFILE , type: TTFILE.*

Compression

Select the compression type of the source files:

  • No Compression - agent does not decompress the files. This is the default setting.

  • Gzip - agent decompresses the files using gzip.

This determines if the agent will decompress the files before passing them on in the workflow.

Before Collection

Move to Temporary Directory

If enabled, the source files will be 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 to be added to the file name prior to collecting it.

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 the specified value 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>.

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 the collection.

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

Destination

Enter The absolute pathname of the directory on the location specified in the referenced File System profile into which the source files will be moved after collection.

This field is only enabled if Move to is selected.

Rename

If enabled, the source files will be renamed after the collection, remaining in the source directory from which they were collected (or moved back from the directory DR_TMP_DIR, if using the Move To Temporary Directory setting).

Prefix/Suffix

Enter the Prefix and/or suffix that will be appended to the beginning respectively the end of the name of the source files, after the collection.

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

Search and Replace

Select this option if you want to apply the Search and Replace function. Select either the Move to or Rename setting.

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

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

Remove

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

Keep (days)

Number of days to keep source files 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.

Ignore

If enabled, the source files will remain in the source directory after collection.

UDR Type

Route FileReferenceUDR

Select this check box if you want to forward the data to an SQL Loader agent. See SQL Loader Agent for further information.