Remove File

The Remove File activity is a synchronous activity that removes the specified files from the directory. If the specified directory is not empty, it generates an exception.

General

The General tab has the following fields.

Field Literal Value/ Process Property/ Module Property Description
Name None The name of the file to be displayed as the label of the activity in the process.
FileName Yes The path and name of the file to be removed from the directory.
Include Timestamp None Select the check box to display timestamp, in addition to the date.

Description

Provide a short description of the activity.

Input

The following is the input for the activity.

Input Item Datatype Description
fileName string The path and name of the file to be removed from the directory.

Output

The following is the output for the activity.

Output Item Datatype Description
fileInfo complex This element contains the fullName, fileName, location, type, readProtected, writeProtected, size, and lastModified data.
fullName string The name of the file (or empty directory) and the file path information.
fileName string The name of the file (or empty directory) without file path information.
location string The path to the file or the empty directory.
ConfiguredFileName string An optional element. This element is not populated by this activity.
type string The file type.
readProtected boolean Signifies whether the file or (or empty directory) is protected from reading
writeProtected boolean Signifies whether the file or (or empty directory) is protected from writing
size integer The size of file in bytes.
lastModified string The timestamp indicating when the file was last modified.

Fault

The Fault tab lists the possible exceptions generated by this activity. For more information about error codes and the corrective action, see the TIBCO ActiveMatrix BusinessWorks™ Error Codes guide.

Fault Generated When..
FileNotFoundException The file does not exist.
FileIOException An input/output exception occurs, when trying to remove the file or empty directory.