Official |[File Operation] Delete File/Directory

Operation name

Delete File/Directory

Function overview

Deletes the file or directory.

Properties

= Remarks =

For details on use of variables, refer to Variables.

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter a name to use on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
Target path	Required	Available	Enter the path of the file or directory to delete. The Browse button launches a file chooser that allows you to select a file.	Note Specify an absolute path of HULFT Square Storage for the file path. With the exception of the path separator "/" and wildcards ("*","?"), the Restricted characters of HULFT Square Storage can't be used.

Item name

Required/Optional

Use of variables

Description

Remarks

Target path

Required

Available

Enter the path of the file or directory to delete.

The Browse button launches a file chooser that allows you to select a file.

Note

Specify an absolute path of HULFT Square Storage for the file path.
With the exception of the path separator "/" and wildcards ("*","?"), the Restricted characters of HULFT Square Storage can't be used.

Option

Item name	Required/Optional	Use of variables	Description	Remarks
Disable force delete	Optional	Not available	Select whether to force delete a directory that isn't empty. Selected (Default) Don't force delete. If the directory to delete isn't empty, an error occurs. Not selected Force delete.	When you use a wildcard in 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 raise an error when the specified file or directory doesn't exist. Selected (Default) Raise an error. Not selected Don't raise an error.

Item name

Required/Optional

Use of variables

Description

Remarks

Disable force delete

Optional

Not available

Select whether to force delete a directory that isn't empty.

Selected

(Default)

Don't force delete. If the directory to delete isn't empty, an error occurs.

Not selected

Force delete.

When you use a wildcard in 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 raise an error when the specified file or directory doesn't exist.

Selected

(Default)

Raise an error.

Not selected

Don't raise an error.

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this connector.

Schemas

Input schema

None.

Output schema

None.

Transaction

Transaction isn't supported.

Parallel Stream Processing

PSP isn't supported.

Available component variables

Variable name	Description	Remarks
success	The result of the operation is stored.	The default value is null. When succeeded, "true" is stored. When failed, "false" is stored.
deleteCount	The number of files or directories deleted is stored.	The default value is null.
message_category	When an error occurs, the category of the message code corresponding to the error is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the error is stored.	The default value is null.
message_level	When an error occurs, the severity of the message code corresponding to the error is stored.	The default value is null.
error_type	When an error occurs, the error type is stored.	The default value is null. The format of the error type is as shown below. Example: java.io.FileNotFoundException
error_message	When an error occurs, the error message is stored.	The default value is null.
error_trace	When an error occurs, the trace information for the error is stored.	The default value is null.

Message codes, exception messages, and limitations

Connector	Message code	Exception message	Limitations
Messages and limitations of the File Operation connector