ADLS2 File Forwarding Agent Configuration

Owned by Jenni Wallin
Last updated: Apr 10, 2024 by Former user (Deleted)
3 min read

You open the ADLS2 file forwarding agent configuration dialog from a workflow configuration. To open the ADLS2 file forwarding agent configuration, click  Build → New Configuration. Select Workflow from the Configurations dialog. When prompted to select workflow type, select Batch. Click Add agent and select ADLS2 from the Forwarding tab of the Agent Selection dialog.

To open the ADLS2 file forwarding agent configuration dialog from a workflow configuration, you can do the following:

  • double-click the agent icon, or,

  • select the agent icon and click on the   button 

ADLS2 file forwarding agent configuration dialog - ADLS2 file tab

SettingDescription

Profile

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

Container Name

Enter the name of the container where the files will be collected from. The container name can be found in the Containers section of the storage account that has been configured in the Azure Profile.

Example

An example container name.

Input Type

The agent can act on two input types. Depending on which one the agent is configured to work with, the behavior will differ.

The default input type is bytearray, that is the agent expects bytearrays. If nothing else is stated the documentation refer to input of bytearray.

If the input type is MultForwardingUDR, the behavior is different. For further information about the agent's behavior in MultiForwardingUDR input, see ADLS2 File Forwarding MultiForwardingUDR Input. 

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

Compression type of the target files. Determines if the agent will compress the files or not.

- No Compression - agent does not compress the files. Default setting.

- Gzip - agent compresses the files using gzip.

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.

Filename Template Tab

For a detailed description of the Filename Template tab, see Filename Template Tab in Workflow Template.