Move File (RapidMiner Studio Core)

Synopsis

This operator moves the chosen file to the specified destination.

Description

The Move File operator moves the selected file from its original directory to the chosen location. If the inserted path does not already exist the needed folders and the file are created. It is also possible to overwrite an existing document.

Input

through (Data Table)
It is not compulsory to connect any object with this port. Any object connected at this port is delivered without any modifications to the output port. This operator can have multiple inputs. When one input is connected, another through input port becomes available which is ready to accept another input (if any). The order of inputs remains the same. The object supplied at the first through input port of the Move File operator is available at the first through output port.

Output

through (Data Table)
The objects that were given as input are passed without changing to the output through this port. It is not compulsory to attach this port to any other port, the file is moved even if this port is left without connections. The Move File operator can have multiple outputs. When one output is connected, another through output port becomes available which is ready to deliver another output (if any). The order of outputs remains the same. The object delivered at the first through input port of the Move File operator is delivered at the first through output port

Parameters

fileThe file that should be moved. Range: file
destinationThe new location of the file. Range: file
overwriteDetermines whether an already existing file should be overwritten. Range: boolean

Tutorial Processes

Writing the Labor-Negotiations data set into an Excel file and moving it

This Example Process shows how the Move File operator can be used to move a specified file. For this Example Process you first need a file to move. An Excel file is created by loading the 'Labor-Negotiations' data set with the Retrieve operator and writing it into an Excel file with the Write Excel operator. The file is saved as 'D:\Labor data set.xls' if this file does not already exist. A breakpoint is inserted so you can have a look at the Excel file in your D drive. For further understanding of this operator please read the description of the Write Excel operator.

The Move File operator is inserted without any connections. The file parameter is set to 'D:\Labor data set.xls' and the destination parameter to 'C:\Data\Labor data set.xls'. Run the process and the file in your D drive will be moved to a newly created folder named 'Data' in your C drive.