Delete File/Directory

Operation Name

Delete File/Directory

Function overview

Delete the file or directory.

Properties

For information about using variables, refer to "variables".

Basic settings

Item name	Required/Optional	Use of Variables	Description	Remarks
Name	Required	Not available	Enter the name on the script canvas.

Required settings

Item name	Required/Optional	Use of Variables	Description	Remarks
Target path	Required	Available	Enter the path to delete a file or directory. Click [Browse] button to activate the file Selectr and Select the file.	Please specify the absolute path of the DataSpider file system as the file path. Constrained Characters of DataSpider File System cannnot be used except for the path separator "/" and wildcard ("*","?").

Option

Item name	Required/Optional	Use of Variables	Description	Remarks
Disable force delete	Optional	Not available	Select whether to delete forcibly a directory is not empty. [Checked]: (default) Forced removal performed. If the directory is not empty for removal will fail. [Not Checked]: Force and delete.	When you use a wildcard in the [Target path], this option is disabled and the path will be recursively deleted.
Error when file/directory doesn't exist	Optional	Not available	Select whether to fail if the specified file or directory does not exist. [Checked]: (default) Raise error. [Not Checked]: No errors.

Comment

Item name	Required/Optional	Use of Variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this adapter. The description will be reflected in the specifications.

Schema

Input Schema

None.

Output Schema

None.

Transaction

Transaction is not supported.

PSP Usage

PSP is not supported.

Available Component variables

Variable name	Description	Remarks
success	Wither success or failure of the process is stored.	The value defaults to null. If successful the operation is true, returns false if it fails.
deleteCount	Returns the number of files or directories deleted.	The value defaults to null.
message_category	Stroes the category to which corresponding message code belongs to, when an error occurs.	The value defaults to null.
message_code	Stores its corresponding message code of occured error.	The value defaults to null.
message_level	Stores the severity of the corresponding message code of the occured error.	The value defaults to null.
error_type	Stores the type of the occured error.	The value defaults to null. Error is represented in the format depicted below. Example:java.io.FileNotFoundException The message may vary depending on DataSpider Servista version.
error_message	Stores the error message for the occured error.	The value defaults to null. The message may vary depending on DataSpider Servista version.
error_trace	Stores stack trace of the occurred error.	The value defaults to null. The message may vary depending on DataSpider Servista version or the client application used.

Specification Limits

You can use wildcards in the [Target path] on "* (zero time or more)" and "? (1 or 0 time)". Regular expressions are not allowed.

The [Target path] is case-sensitive.

Main exceptions

Exception name	Cause	Solution
InvalidPropertyConfigurationException <Property name> is not specified.	[<Property name>] is not specified.	Specify the [<Property name>].
FileOperationException	The specified directory in the [Target path] is not empty.	Check the file or the directory in the [Target path].
FileIsLockedException	The file in the [Target path] is locked.	Please go to Windows Explorer or CLI to unlock.
java.io.FileNotFoundException	The specified file or directory not found.	Check the file or the directory in the [Target path].
java.io.FileNotFoundException Another processing is in use.	The file specified in the [Target path] is being used by another process.	Please check whether it is used by other processing.
PathIsNotAbsoluteException	The specified path is a relative path. The path only accepts an absolute path.	Specify an absolute path for the [Target path].