Amazon S3 Forwarding Agent Configuration(4.2)

To open the Amazon S3 forwarding 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 forwarding agent in a Batch workflow, part of the configuration may be done in the Filename Template tab in Workflow Template(4.2).

For Real-Time workflow, additional configurations in File Closing Criteria tab are available in Batch-Based Real-Time Agents - Agent Configuration(4.2).

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

Amazon S3 forwarding agent configuration dialog - Amazon S3 tab

SettingDescription

Profile

Select the File System profile you want the agent to use, see File System Profile - Amazon S3 (4.2) for further information about this profile.

Input Type

The agent can act on two input types: bytearray or MultiForwardingUDR. The default input type is bytearray. If nothing else is stated, the documentation refers to input of type bytearray.

For more information, see MultiForwardingUDR(3.0).

For an example see Amazon S3 Forwarding MultiForwardingUDR Example(4.2).

Directory

Absolute pathname of the target directory on the location stated in the referenced File System profile, where the forwarded files will be stored.

The files will be temporarily stored in the automatically created subdirectory DR_TMP_DIR, in the target directory. When an End Batch message is received, the files are moved from the subdirectory to the target directory.

Create Directory

Select this setting to create the directory, or the directory structure, of the path that you specify in the Directory field.

Note!

The directories are created when the workflow is executed.

Compression

Select the compression type of the target files:

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

  • Gzip - agent compresses the files using gzip.

This determines if the agent will compress the files or not.

Note!

No extra extension will be appended to the target filenames, even if compression is selected. The configuration of the filenames is managed in the Filename Template tab only.

Command

If a UNIX command is supplied, it will be executed on each successfully closed temporary file, using the parameter values declared in the Arguments field.

Note!

At this point the temporary file is created and closed, however the final filename has not yet been created.

The entered command has to exist in the  execution environment, either including an absolute path, or to be found in the PATH for the execution environment.

Arguments

This field is optional. Each entered parameter value has to be separated from the preceding value with a space.

The temporary filename is inserted as the second last parameter, and the final filename is inserted as the last parameter, automatically. This means that if, for instance, no parameter is given in the field, the arguments will be as follows:

$1=<temporary_filename>   $2=<final_filename>

If three parameters are given in the field Arguments, the arguments are set as:

$1=<parameter_value_#1> $2=<parameter_value_#2> $3=<parameter_value_#3> $4=<temporary_filename> $5=<final_filename>

Produce Empty Files

If enabled, files will be produced although containing no data.