SFTP Forwarding Agent Configuration(3.3)

The SFTP forwarding agent consists of five tabs: Connection, Target, Advanced, Backlog and Security.

Connection Tab

For information on the Connection tab, see SFTP Collection Agent Configuration(3.3).

Target Tab

The Target tab contains configuration settings related to the remote host, target directories and target files.

SectionDescription

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 SFTP Forwarding Agent MultiForwardingUDR Example .

Directory

Enter the absolute pathname of the target directory on the remote host, where the forwarded files are to be placed. You can also enter the pathname relative to the home directory of the Username account.

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 check box to create the directory, or the directory structure, of the path that you specify in Directory.

Note!

The directories are created when the workflow is executed.

Compression

Select the compression type of the destination files. This determines if the agent compresses the output files as it writes them.

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

  • Gzip - The agent compresses the files using gzip.

    Note!

    No extra extension will be appended to the target filenames, even if compression is selected.

Produce Empty Files

If you select this check box, the agent creates empty output files for empty batches rather than omitting those batches.

Handling of Already Existing Files

Select the behavior of the agent when the file already exists, the alternatives are:

  • Overwrite - The old file is overwritten and a warning is logged.

  • Add Suffix - If the file already exists the suffix ".1" is added. If this file also exists the suffix ".2" is tried instead and so on.

  • Abort - This is the default selection and is the option used for upgraded configurations, that is workflows from an upgraded system.

Use Temporary Directory

If you select this option, the agent moves the file to a temporary directory before moving it to the target directory. After the whole file has been transferred to the target directory, and the endBatch message has been received, the temporary file is removed from the temporary directory.

Use Temporary File

If there is no write access to the target directory and, hence, a temporary directory cannot be created, the agent can move the file to a temporary file that is stored directly in the target directory. After the whole file has been transferred, and the endBatch message has been received, the temporary file will be renamed.

The temporary filename is unique for every execution of the workflow. It consists of a workflow and agent ID, and a file number.

Abort Handling

Select how to handle the file in case of cancelBatch or rollback: Delete Temporary File or Leave Temporary File.

Note!

When a workflow aborts, the file will not be removed until the next time the workflow is started.

Advanced Tab

The Advanced tabs contain settings related to more specific use of the SCP service, which might not be frequently used.

SettingDescription

Port

Enter the port number that the SFTP service is to use on the remote host.

Timeout (s)

Enter the maximum time, in seconds, to wait for response from the server. 0 (zero) means to wait forever.

Accept New Host Keys

If selected, the agent overwrites the existing host key when the host is represented with a new key. The check box is empty by default so that the default behavior is to abort when the key does not match.

Note!

Selecting this option causes a security risk since the agent accepts new keys regardless if they may belong to another machine.

Enable Key Re-Exchange

Use this check box to enable and disable automatic re-exchange of session keys during ongoing connections. This can be useful if you have long lived sessions as you may experience connection problems for some SFTP servers if one of the sides initiates a key re-exchange during the session.

Buffered ModeSelect this check box if you want to enable buffered mode on the SFTP client.

Additional Hosts

You can add additional host names or IP-addresses that may be used to establish a connection. These hosts are tried, in sequence from top to bottom, if the agents fail to connect to the remote host set in the Connection tab.

Use the Add, Edit, Remove, Move up and Move down buttons to configure the host list.

Execute

During transfer a temporary file is written, which is then moved to the final file. Select if the script should be executed on the transferred working copy or the final file with the following two options:

  • Before Move: Execute the following command and its arguments on the temporary file.

  • After Move: Execute the following command and its arguments on the final file. This is the default setting

Command

Enter a command or a script. The script will be executed on the remote system from its working directory.

Argument

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 Arguments field, the arguments are set as:

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

If  After Move has been selected, the argument with <temporary filename> is excluded.


Backlog Tab

The Backlog tab contains settings related to backlog functionality. If the backlog is not enabled, the files are moved directly to their final destination when an end batch message is received. However, if the backlog is enabled, the files are first moved to a directory called DR_POSTPONED_MOVE_DIR and then to their final destination.

When backlog is initialised, and when backlogged files are transferred, a note is registered in the System Log.

SettingDescription

Enable Backlog

Select this check box to enable backlog functionality.

Directory

Enter the base directory in which the agent will create sub directories to handle backlogged files. You can use absolute or relative path names.

Type

You can select Files or Bytes. Files is the maximum number of files permitted in the backlog folder. Bytes is the total sum (size) of the files in the backlog folder.

If a limit is exceeded, the workflow aborts.

Size

Enter the maximum number of files or bytes that the backlog folder can contain.

Processing Order

Determine the order by which the backlogged data is to be processed once connection is reestablished: you can select First In First Out (FIFO) or Last In First Out (LIFO).

Duplicate File Handling

Select the behavior that you want if a file with the same file name as the one being transferred is detected. You can select Abort or Overwrite and the action is taken both when a file is transferred to the target directory or to the backlog.


Security Tab

For information about the Security tab, see the description under SFTP Collection Agent Configuration(3.3)

Note!

 has upgraded its Maverick library to version 1.7.30, this has resulted in a change in the default handling for SFTP advanced security. Users should take note of the behaviour change for the Advanced Security Option for the SFTP agents. The Advanced Security Option will be disabled by default. Users will have to enable it on their own accord from the Security Tab in the SFTP agents configuration.

With Advanced Security Option disabled, Maverick will manage the connection between the SFTP agent and the server. Maverick will attempt to connect with the STRONG security level. Failing to do so, it will auto downgrade the security level to WEAK and attempt to connect, this behaviour will allow our agents to work well with backwards compatibility for servers with older instances of the Maverick library.  Furthermore, having STRONG security level will result in a performance degradation for .

However, when a user manually enables the Advanced Security Option from the security tab, Maverick will instead assign the WEAK security level, which will not be as strict or resource intensive as the STRONG security level.

For more information about security levels, you can refer to this page: https://www.jadaptive.com/managed-security-in-our-java-ssh-apis/