Common Properties of File Operations

The File Operation components manipulate with files and directories.

The overview of all File Operation components is presented below:

Table 60.1. File Operations Comparison

ComponentInputsOutputs
CopyFiles0-10-2
CreateFiles0-10-2
DeleteFiles0-10-2
MoveFiles0-10-2
ListFiles0-11-2

As you can see, the components have one input port and two output ports, one for results and the other for errors. The ports are optional.

Common Attributes of File Operation Components

For the overview of URL formats supported by File Operations, see Supported URL Formats for File Operations.

AttributeReqDescriptionPossible values
Input mapping[1]Defines the mapping of input records to component attributes. 
Output mapping[1]Defines the mapping of results to a standard output port. 
Error mapping[1]Defines the mapping of errors to an error output port. 
Redirect error outputno

If enabled, errors will be sent to an output port instead of the error port.

false (default) | true

[1]  If the mapping is omitted, a default mapping based on identical names will be used.

Input Mapping

The operation will be executed for each input record. If the input edge is not connected, the operation will be performed exactly once.

Attributes of the components may be overridden by values read from an input port, as specified by the Input mapping.

Output Mapping

It is essential to understand the meaning of records on the left-hand side of the Output mapping and Error mapping editor. There may be one or two records displayed.

The first record is only displayed if the component has an input edge connected, because it is the real input record which has been read from the edge. This record has Port 0 displayed in the Type column.

The other record on the left-hand side named Result is displayed always and is the result record generated by the component.

Error Handling

By default, a component will cause the graph to fail if it fails to perform the operation. This can be prevented by connecting the error port. If the error port is connected, the failures will be sent to the error port and the component will continue. The standard output port may also be used for error handling, if the Redirect error output option is enabled.

In case of a failure, the component will not execute subsequent operations unless the Stop processing on fail option is disabled. The information about skipped operations will be sent to the error output port.

See Chapter 60, File Operations next.