User Guide > Objects > Alphabetical Listing > FileTransfer Tab

File Transfer Tab

The FileTransfer tab is objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task-type specific and in this form is only available in FileTransfer objects. It is used to define parameters for file transfers and settings for the handling of files.

Object: FileTransfer
Object class:
Executable object
Object type (short name):
JOBF

Description

Field/Control

Description

From

The source of the file transferTransfers files from one computer to another. A particular Automation Engine object type (FileTransfer object)..

Host

Here you select the name of the agentA program that enables the de-centralized execution of processes (such as deployments) on target systems (computers or business solutions) or a service that provides connectivity to a target system (such as for databases or middleware). An agent is also an object type in the Automation Engine. [Formerly called "Executor."] See also: host where the file that should be transferred is available. You can also specify an agent group.

Agent groups can either be used as the source OR as the target. You cannot use both.

Code

Name of the CodeTable that is valid for the hostComputer, target system..

In addition to the CodeTable objects, this combo box provides options that can be used to transfer Unicode files. You can select the relevant Unicode format: 

  • <UTF 8>
  • <UCS 2BE>
  • <UCS 2LE>

Setting one of the above values has the effect that the code is not converted and the selection field Code for the file transfer target is grayed out.

Login

The name of a Login object.

Compression

The files are transferred in compressed form.

File

Specify the name of the source file, thereby using the directory, folderTop level entities such as Environment, Deployment Target, Activity, … are stored in folders. The permissions a user has on an entity depend on the permissions that are set on the folder for the entities. or ID.

Partially-qualified FileTransfers: Use a filter that is composed of wildcard charactersThese are placeholders for characters when you specify filters. ? stands for exactly one character, * for any number of characters. and fixed parts of the file name instead of specifying a complete file.

VMS

Note that the VMS agent does not resolve logical names. Directly specify the directory and file name as otherwise, the file cannot be found.

 

z/OS

The specification of z/OS files depends on the file system that you use (USS or Host). For example:

USS file system (absolute path): /dir1/dir2/datei
USS file system (relative path): ./dir1/dir2/datei
Host file system: FLQN.DATASET.NAME

UNIX

Please refer to the topic UNIX-Agent for parameters to be used and conditions that apply to file transfers under UNIX agents.

File Attributes

Additional entries for file attributes.

Note that there are platform-specific features.

Keep original file attributes

Check this box to assume the source file(s) file attributes to the target file(s).

Requirements:

Otherwise, this option is ignored.

In BS2000, OS/400 and z/OS, you cannot overwrite the original attributes with additional specifications in the FileTransfer object (target). Any attempt to do so results in an error message and the file transfer fails.

Automic recommends activating this setting because the target file can become corrupt if the attributes are not sent or modified when you transfer text files between two OS/400 computers..

Use wildcards

File transfer with wildcard characters.
With this check box being activated, file transfers can be executed with wildcards.

Include sub directories

A file transfer with wildcard characters
Check this box in order to include files in subdirectories of a file transfer with wildcard characters. This is only available if both platforms support this functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,… and the option Use wildcards is selected.

administrators can use the parameter WorkDirMatch= in the INI files of UNIX agents in order to specify whether sub-directories should be included in the search for files.

Transfer complete subfolder structure

This is for partially qualified file transfers.

By default, empty folders are not considered when subdirectories are transferred. Activate this option to include empty directories in transfers.

Note that you can only use this setting when the option Include sub-directories is active.

Max. parallel running transfers

File transfer with wildcard characters.
Set the number of files that should be transferred at the same time as a file transfer that includes wildcard characters. The higher the number, the higher the load on the participating computers. Only available if "Use wildcards" is selected.

This setting is only relevant for the old file transfer protocol. It is applied if at least one of the agents uses Automation Engine version 8.00A or below. This setting is not evaluated if both agents are of version 9.00A or later. 

Abort at first error

For partially qualified FileTransfers.

Activate this check box if the file transfer should end after the first error that occurs. Files that have not been transferred are ignored. With this setting NOT being activated, the file transfer continues with the next file.

File transfers cancelled due to this option receive the statusThis represents the condition of a task (such as active, blocked, generating). ENDED_NOT_OK.

This option is only relevant if the new file transfer protocol is used (source and target agent are of version 9.00A or later). The old protocol continues the file transfer even if the transfer of a particular file fails.

Erase source file

Activate this check box in order to have the file deleted after the transfer.

Note that particular rights are required under UNIX if this file should be deleted.

A file transfer also ends with the status ENDED_OK if all files have successfully been transferred but the source file could not be deleted for some reason.

Format

 

Text

Activate this option button if the file is a text file.

Binary

Activate this option button if the file is a binary file.

Selecting a binary format can save you time when you transfer text files. In this case, the text file is not changed (formatting such as line breaks).

To

The target of the file transfer.

Host

Select the name of the host that should receive the file from the listShows entities in a grid view box. You can also define an agent group.

Agent groups can either be used as the source or as the target. You cannot use a combination of both.

Code

The target of the file transfer.
Activate the code tableAn Automation Engine object type that defines a complete set of characters. from the list box that is valid for the target host.

Login

The source of the file transfer, name of a Login object.

File

Enter the location (directory, folder or ID) and the name of the target file. You can also rename the file.

The following variableIt stores or retrieves values dynamically at runtime. An individual Automation Engine object type. can be inserted in the target file name: &<FT_SRC_HOST>. The file transfer replaces this variable with the name of the file's original host.

For example: C:\temp\&<FT_SRC_HOST>_test*.txt

Partially-qualified FileTransfers:Use a filter that is composed of wildcard characters and fixed parts of the file name instead of specifying a complete file. 

File Attributes

Additional entries for file attributes.

Note that there are platform- specific features.

File exists

 

Cancel

This is an option that cancels the file transfer if the file already exists in the target system.

Overwrite

This is an option that overwrite the existing file in the target system.

Append

The transferred file is appended to an existing file in the target system.

Note that there are platform-specific features.

Comments

You can read and modify all settings that are specified in this tab at runtimeThe duration of a task's execution. It refers to the period between a task's start and end. It does not include its activation period (see also: activation and start).. for this purpose, you use scriptA particular Automation Engine object type. elements that access the object's attributes. A userIn the Automation Engine, a user is an instance of a User object, and generally the user is a specific person who works with Automic products. The User object is assigned a user ID and then a set of access rights to various parts of the Automation Engine system and product suite. These access rights come in the form of Automation Engine authorizations and privileges, Decision user roles and EventBase rights and ARA web application object rights. You can manage all these centrally in the ECC user management functions. See also, Unified user management. can activate the checkbox "Attribute dialog" in the Attributes tab in order to manipulate the attributes. In the script, the attributes are accessed at a later point in time.

Platform-Specific Features

You can also specify file attributes for the file names of file transfer targets.

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH