Rename

Operation name

Rename

Function overview

Renames the specified files on FTP server.

Data model

The data model of this component is XML type.

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 that is used on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
Destination	Required	Not available	Select a connection resource. Add A new connection resource can be added. Edit list Connection resource settings can be edited in > HULFT INTEGRATE > Connections.
Path	Required	-	Specify paths. Each row can be operated with the following buttons: Up Moves the selected row upward by one row. Down Moves the selected row downward by one row. Add Adds a row. Delete Deletes the row.
Path/Path before renaming	Required	Available	Enter the file/directory in the FTP server with an absolute path starting with "/".	Case-sensitive.
Path/Path after renaming	Required	Available	Enter the renamed file/directory in the FTP server with an absolute path that starts with "/".	Case-sensitive.

Rename settings

Item name	Required/Optional	Use of variables	Description	Remarks
Do not rename when file/directory after renaming already exists	Optional	Not available	Select whether or not to rename when the file/directory specified in Path/Path after renaming already exists. Selected (Default) When the file/directory specified in Path/Path after renaming already exists, it won't be renamed. Not selected Even when the file/directory specified in Path/Path after renaming already exists, it will be renamed.	Note When the file/directory already exists, the behavior during renaming depends on the destination FTP server.
Create when parent directory doesn't exist	Optional	Not available	Select whether or not to create a directory automatically when the parent directory of the file/directory specified in Path/Path after renaming doesn't exist. Selected When the parent directory of the file/directory specified in Path/Path after renaming doesn't exist, it will be created automatically. Not selected (Default) When the parent directory of the file/directory specified in Path/Path after renaming doesn't exist, it won't be created automatically.

Item name

Required/Optional

Use of variables

Description

Remarks

Do not rename when file/directory after renaming already exists

Optional

Not available

Select whether or not to rename when the file/directory specified in Path/Path after renaming already exists.

Selected

(Default)

When the file/directory specified in Path/Path after renaming already exists, it won't be renamed.

Not selected

Even when the file/directory specified in Path/Path after renaming already exists, it will be renamed.

Note

When the file/directory already exists, the behavior during renaming depends on the destination FTP server.

Create when parent directory doesn't exist

Optional

Not available

Select whether or not to create a directory automatically when the parent directory of the file/directory specified in Path/Path after renaming doesn't exist.

Selected

When the parent directory of the file/directory specified in Path/Path after renaming doesn't exist, it will be created automatically.

Not selected

(Default)

When the parent directory of the file/directory specified in Path/Path after renaming doesn't exist, it won't be created automatically.

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

<?xml version="1.0"?>
<ftpserver name="" port="" user="">
  <pathnames>
    <pathname date="" filetype="" local="" remote="" size="" status="" type=""/>
  </pathnames>
</ftpserver>

Element name	Attribute name	Description
ftpserver	-
	name	Outputs the host name of the connected FTP server.
	port	Outputs the port number of the connected FTP server.
	user	Outputs the user name used when connecting to FTP server.
pathnames	-
pathname	-	Appears once for each file/directory to be renamed.
	date	Always outputs empty data.
	filetype	Outputs the file type of the file/directory to be renamed. File File Directory Directory
	local	Always outputs empty data.
	remote	Outputs the absolute path (after renaming) in the FTP server of the file/directory.
	size	Always outputs empty data.
	status	Outputs the renaming status. Renamed The file/directory has been renamed in FTP server. Exists The file/directory hasn't been renamed. This is output when Do not rename when file/directory after renaming already exists is selected and the file/directory specified in Path/Path after renaming already exists in the FTP server. NG The file/directory hasn't been renamed due to an error.
	type	Always outputs empty data.

Loading schema in Mapper

The schema is loaded automatically.

= Remarks =

For details, refer to Edit Schema.

Mass data processing

Mass data processing isn't supported.

Transaction

Transaction isn't supported.

Parallel Stream Processing

PSP isn't supported.

Available component variables

Component variable name	Description	Remarks
count	The number of files/directories to be renamed is stored.	The default value is null. The sum of "directory_count" and "file_count".
directory_count	The number of the directories to be renamed is stored.	The default value is null.
file_count	The number of the files to be renamed 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 follows. 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 FTP connector