Copy File/Folder

Operation name

Copy File/Folder

Function overview

Copies the file/folder on Amazon S3 to the specified bucket folder on Amazon S3.

Data model

The data model of this component is XML type.

Tutorials

For details about how to create a connection to Amazon S3, refer to the following tutorial:

Create a connection to Amazon S3

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.
Copy source bucket name	Required	Available	Select or enter a copy source bucket.	If you specify a bucket in which a large number of files exist, it may take time to update the list in Copy source folder path.
Copy source folder path	Required	Available	Select or enter Amazon S3 folder path of copy source.	Note Specify the absolute path of Amazon S3 as the folder path. With the exception of the path separator "/", the Restricted characters of HULFT Square Storage can't be used.
Copy source file/folder name	Required	Available	Select or enter a copy source file/folder.	Wildcards ("*" and "?") can be used. "/" can't be included. The folder is copied recursively when it's specified.
Copy destination bucket name	Required	Available	Select or enter a copy destination bucket.	If you specify a bucket in which a large number of files exist, it may take time to update the list in Copy destination folder path.
Create copy destination bucket when it doesn't exist	Optional	Not available	Select whether to create a bucket when the specified copy destination bucket doesn't exist. Selected If the specified copy destination bucket doesn't exist, create a bucket. Not selected (Default) If the specified copy destination bucket doesn't exist, don't create bucket, and raise an error.
Copy destination folder path	Required	Available	Select or enter Amazon S3 folder path of copy destination.	Note Specify the absolute path of Amazon S3 as the folder path. With the exception of the path separator "/", the Restricted characters of HULFT Square Storage can't be used.
Create copy destination folder when it doesn't exist	Optional	Not available	Select whether to create a folder when the specified copy destination folder doesn't exist. Selected (Default) If the specified copy destination folder doesn't exist, create a folder. Not selected If the specified copy destination folder doesn't exist, don't create a folder, and raise an error.
Copy destination file/folder name	Optional	Available	Select or enter a copy destination file/folder.	"/" can't be included. When omitted, it's copied with the name of copy source file/folder. When wildcard is used in Copy source file/folder name, it's copied with the name of copy source file/folder.
Overwrite a copy destination file when it exists	Optional	Not available	Select whether to overwrite the file when a file with the same name exists on the specified copy destination folder. Selected (Default) Overwrite when a file with the same name exists in the specified copy destination folder. Not selected Output an error without overwriting when a file with the same name exists in the specified copy destination folder.
Include permissions in result	Optional	Not available	Select whether to include information of copy destination file/folder access rights in the result. Selected Include information of access rights in the result. Not selected (Default) Don't include information of access rights in the result.

Data processing method

Item name	Required/Optional	Use of variables	Description	Remarks
Data processing method	Required	Not available	Select a data processing method. Apply script settings (Default) The setting for mass data processing in the script properties is applied to the connector. Do not perform mass data processing Mass data processing isn't performed. Perform mass data processing Mass data processing is performed.	Note This setting is used to configure the output processing method of result data. It doesn't affect files/folders to be copied.

Item name

Required/Optional

Use of variables

Description

Remarks

Data processing method

Required

Not available

Select a data processing method.

Apply script settings

(Default)

The setting for mass data processing in the script properties is applied to the connector.

Do not perform mass data processing

Mass data processing isn't performed.

Perform mass data processing

Mass data processing is performed.

Note

This setting is used to configure the output processing method of result data. It doesn't affect files/folders to be copied.

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"?>
<server>
  <bucket source_name="" destination_name="" status="" >
    <file etag="" name="" public="" source_remotepath="" destination_remotepath="" size="" status="" storageclass="" type="" source_updated="" destination_updated="" />
  </bucket>
</server>

Element name	Attribute name	Description	Remarks
server	-
bucket	-	Appears for the bucket that is specified in Bucket name.
	source_name	Outputs the name of the copy source that is specified in Bucket name.
	destination_name	Outputs the name of the copy destination that is specified in Bucket name.
	status	Outputs the status of the copy source and copy destination buckets that are specified in Bucket name. Exist The copy source and copy destination buckets exist. ErrorSourceBucketNotFound The bucket specified in Copy source bucket name doesn't exist in Amazon S3. The specified bucket name may be incorrect. ErrorDestinationBucketNotFound The bucket specified in Copy destination bucket name doesn't exist in Amazon S3. The specified bucket name may be incorrect. Error The copy source or copy destination bucket couldn't be gotten because an error has occurred.
file	-	Appears once for each copied file/folder.
	etag	Outputs ETag of the copied file/folder.	The value is blank when the file/folder isn't copied correctly.
	name	Outputs the name of the copied file/folder.	If status is "ErrorSourceFolderNotFound", then the value is blank. If status is "ErrorDestinationFolderNotFound", then the value is blank.
	public	Outputs the access right of the copied file/folder. true Public false Private	The value is blank when the file/folder isn't copied correctly. When "READ" permissions is given to "AllUsers Group", it's "Public". If Include permissions in result isn't selected, then the value is blank.
	source_remotepath	Outputs the file path available on Amazon S3 of copy source file/folder.
	destination_remotepath	Outputs the file path available on Amazon S3 of copy destination file/folder.
	size	Outputs the size of the copied file/folder. The unit is byte.	Output when the file/folder is copied correctly.
	status	Outputs the status of copy source and copy destination files/folders. Exist The copy destination file/folder exists. Virtual The folder specified in Copy destination folder path doesn't exist on Amazon S3 but files and/or folders exist in the folder. ErrorSourceFolderNotFound The specified Copy source folder path doesn't exist on Amazon S3, or a file is specified. ErrorSourceFileNotFound The specified file/folder doesn't exist in the specified Copy source folder path on Amazon S3. ErrorDestinationFolderNotFound The specified Copy destination folder path doesn't exist on Amazon S3, or a file is specified. ErrorDestinationFileExist Overwrite a copy destination file when it exists isn't selected, and a file with the same name exists in specified Copy destination folder path on Amazon S3. Error The file/folder couldn't be copied due to an error.
	storageclass	Outputs the Storage Class of the copied file/folder. STANDARD Standard REDUCED_REDUNDANCY RRS(Reduced Redundancy Storage) STANDARD_IA Standard_IA	The value is blank when the file/folder isn't copied correctly.
	type	Outputs the classification of the copied file/folder. File File Folder Folder
	source_updated	Outputs the last updated date of the copy source file/folder.	The value is blank when the file/folder isn't retrieved correctly.
	destination_updated	Outputs the last updated date of the copy destination file/folder.	The value is blank when the file/folder isn't copied correctly.

Loading schema in Mapper

The schema is loaded automatically.

= Remarks =

For details, refer to Edit Schema.

Mass data processing

Mass data processing is supported.

Parallel Stream Processing

PSP isn't supported.

Available component variables

Component variable name	Description	Remarks
count	The number of copied files and folders is stored.	The default value is null. The sum of "folder_count" and "file_count".
folder_count	The number of copied folders is stored.	The default value is null. Folders whose status attribute of file element is "Virtual" aren't included in the count.
file_count	The number of copied files 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 Amazon S3 connector