Versions Compared

Key

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

To open the FTPS collection forwarding agent configuration, click Build>New click Build → New Configuration. Select Workflow Select Workflow from the Configurations dialog. When prompted to to Select workflow type, select select Batch. Click Add agent and select the Forwarding tab in the Agent Selection dialog. Select the Ftps agent. Double-click the agent icon or right-click the icon and select Edit agent, to display the Agent Configuration dialog.

...

For information of the settings in this tab, see the FTPS Collection Agent Configuration - Connection Tab , in section FTPS Collection Agent Configuration.

Target Tab

Image RemovedImage Added

The FTPS forwarding agent configuration - Target tab


ItemSettingDescription

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 bytearraysInput Type bytearray or MultiForwardingUDR. By default, the agent expects bytarrays. If nothing else is stated, the documentation refer refers to input of bytearray.If the input type is MultForwardingUDR, the behavior is different. For further information about the agent's behavior with MultiForwardingUDR input, refer to 9.34.2.3 bytearrays. For Input Type MultForwardingUDR, refer to FTPS Forwarding Agent MultiForwardingUDR Input for more information

Directory

Absolute pathname Enter the absolute path of the remote host's target directory on the remote host, where of where you want to place the forwarded files will be placed. The pathname may path can also be given specified relative to the home directory of the user's account.

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

Create Directory

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

Note
titleNote!

The directories are created when the workflow is executed.


Compression

Compression type of the target files. Determines Select the compression type to determine if the agent will should compress the target files before storage or not.:

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

  • Gzip - The agent compresses the files using gzip.

    Note
    titleNote!

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



Produce Empty Files

If you require Select this checkbox if you need to create empty files, check this setting.

Handling of Already Existing FilesFile

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

  • Overwrite - The old file will be is overwritten and a warning will be is logged in the System Log.

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

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

Use Temporary Directory

If this option is selected, the agent will move 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 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 message has been received, the temporary file will be is renamed.

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

Abort Handling

Select how to handle the file in case of cancelBatch or rollback, either . Choose between Delete Temporary File or  or  Leave Temporary File .

Note
titleNote!

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


Advanced Tab

The FTPS forwarding agent configuration - Advanced tab


ItemSettingDescription

Command Port

The value in this field defines which Enter the port number that the FTPS service will should use on to connect to the remote host.

Timeout(s)

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

Passive Mode (PASV)

Must This checkbox must be enabled selected if FTPS passive mode is used for data connection.

In passive mode, the channel for data transfer between client and server is initiated by the client instead of by the server. This is useful when a firewall is situated between the client and the server.

Additional Hosts

List of additional host names Select Add to enter additional hosts or IP addresses that may be used to access the target directory for file storage. These hosts are tried, in sequence from top to bottom, if If the agent fails to connect to the remote host set Host specified in the Connection  tabtab, it tries to connect to the hosts listed here, in sequence from top to bottom.

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


Note
titleNote!

The names of Go to the Filename Template tab to configure what to name the created files are determined by the settings in the Filename Template tab. The use and setting of . Go to the Thread Buffer tab to configure how to use private threads for an agent, enabling to enable multi-threading within a workflow, is configured in the Thread Buffer tab. For further information, see 3.1.6 Workflow Template.

Backlog Tab

The Backlog tab contain tab contains configurations related to backlog functionality. If the backlog is not enabled, the files will be

Image Added

The FTPS forwarding agent configuration - Backlog tab


SettingDescription

Enable Backlog

Select this checkbox to enable backlog functionality. If Enable Backlog is cleared, files are moved directly to their final destination when an end batch message is received.

If

...

Enable Backlog is selected, files are first moved to a directory called DR_POSTPONED_MOVE_DIR and then to their final destination. Refer to the section

...

Retrieves, in

...

...

for more information about transaction behavior.

...

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

...

Image Removed

The FTPS forwarding agent configuration - Backlog tab

ItemDescription

Enable Backlog

Select to enable backlog functionality

Directory

Base Enter the base directory in into which the agent will should create sub directories subdirectories to handle backlogged files. Absolute or relative path names can be used.

Type

Select Files is to be able to enter the maximum number of files allowed in the backlog folder Bytes is into the Size field.

Selet Bytes to be able to enter the total sum (size) of the files that resides reside in the backlog folder.

If a limit is exceeded the workflow will abortaborts.

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 will be processed once connection is reestablished, select between First In First Out (FIFO) or Last In First Out (LIFO).

Duplicate File Handling

Specifies the behavior Select Abort or Overwrite to specify what should happen if a file with the same file name as the one being transferred is detected. The options are Abort or Overwrite and the action is taken This action will apply both when a file is transferred to the target directory or and to the backlog.