Write File/Folder

Operation name

Write File/Folder

Function overview

Writes file/folder on HULFT Square Storage to 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.
Local directory	Required	Available	Enter a directory path of HULFT Square Storage. The Browse button launches a directory chooser that allows you to select a directory.	Note Specify an absolute path of HULFT Square Storage for the directory path. With the exception of the path separator "/", the Restricted characters of HULFT Square Storage can't be used. Case-insensitive.
Local file/directory name	Required	Available	Specify a file/directory on HULFT Square Storage.	Wildcards ("*" and "?") can be used. "/" can't be included.
Recursive processing	Optional	Not available	For the specified local directory, select whether to process file/directory recursively. Selected If a directory is contained in the specified local directory, process file/directory recursively. Not selected (Default) Only process files in the specified local directory.
Bucket name	Required	Available	Specify a bucket.	For Bucket name, if you specify a bucket in which a large number of files exist, it may take time to update the list in Folder path.
Create a bucket when it doesn't exist	Optional	Not available	Select whether to create a bucket when the specified bucket doesn't exist. Selected If the specified bucket doesn't exist, create a bucket. Not selected (Default) If the specified bucket doesn't exist, don't create a bucket, and raise an error.
Folder path	Required	Available	Enter an Amazon S3 folder path.	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 folder when it doesn't exist	Optional	Not available	Select whether to create the folder when the specified folder doesn't exist. Selected (Default) Create the folder when the specified folder doesn't exist. Not selected Raise an error without creating the folder when the specified folder doesn't exist.
Overwrite	Optional	Not available	Select whether to overwrite when a file with the same name exists in the specified folder. Selected (Default) Overwrite when a file with the same name exists in the specified folder. Not selected Raise an error without overwriting when a file with the same name exists in the specified folder.
Storage class	Required	Not available	Select Storage Class of the specified file. STANDARD (Default) Set Storage Class of the file to be written to Standard. REDUCED_REDUNDANCY Set Storage Class of the file to be written to RRS (Reduced Redundancy Storage). STANDARD_IA Set Storage Class of the file to be written to Standard_IA
Permissions	Required	Not available	Select the access permission of the specified file. Public Set access permissions of the file to be written to "public". Private (Default) Set access permissions of the file to be written to "private".	If setting "public", "READ" permission is granted to "AllUsers Group".
Include permissions in result	Optional	Not available	Select whether to include file access right information in the results. Selected Include file access right information in the results. Not selected (Default) Don't include file access right information in the results.

Encryption settings

Item name	Required/Optional	Use of variables	Description	Remarks
Encryption	Required	Not available	Select whether to encrypt file or not. No (Default) Don't encrypt. Server side Encrypt in Amazon S3 after uploading. Client side Write in Amazon S3 after encryption.
Public Key	Required	Available	Enter file path of public key to encrypt. The Browse button launches a file chooser that allows you to select a file.	Enabled when you select Client side in Encryption. Note Public Key needs to be the key created with RSA method of cryptographic algorithm. Specify an absolute path of HULFT Square Storage for the file path. With the exception of the path separator "/", the Restricted characters of HULFT Square Storage can't be used.

Item name

Required/Optional

Use of variables

Description

Remarks

Encryption

Required

Not available

Select whether to encrypt file or not.

No

(Default)

Don't encrypt.

Server side

Encrypt in Amazon S3 after uploading.

Client side

Write in Amazon S3 after encryption.

Public Key

Required

Available

Enter file path of public key to encrypt.

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

Enabled when you select Client side in Encryption.

Note

Public Key needs to be the key created with RSA method of cryptographic algorithm.
Specify an absolute path of HULFT Square Storage for the file path.
With the exception of the path separator "/", the Restricted characters of HULFT Square Storage can't be used.

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 written.

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 written.

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 name="" status="" >
    <file etag="" localpath="" name="" public="" remotepath="" size="" status="" storageclass="" type="" updated="" />
  </bucket>
</server>

Element name	Attribute name	Description	Remarks
server	-
bucket	-	Appears for the bucket that is specified in Bucket name.
	name	Outputs the name that is specified in Bucket name.
	status	Outputs the status of the bucket that is specified in Bucket name. Exist The bucket exists. ErrorBucketNotFound The specified bucket doesn't exist in Amazon S3. The specified Bucket name may be incorrect. Error The existence of the bucket couldn't be confirmed because an error has occurred.
file	-	Appears once for each written file/folder.
	etag	Outputs ETag of written file/folder.	If file/folder isn't written correctly, the value is blank.
	localpath	Outputs local path of written file/folder.	If status is "ErrorRemoteFolderNotFound", then the value is blank.
	name	Outputs name of the written file/folder.	If status is "ErrorLocalFolderNotFound", then the value is blank. If status is "ErrorRemoteFolderNotFound", then the value is blank.
	public	Outputs access right of written file/folder. true Public false Private	If file/folder isn't written correctly, the value is blank. When "READ" permissions is given to "AllUsers Group", it's "Public". If Include permissions in result isn't selected, then the value is blank.
	remotepath	Outputs file path on Amazon S3 of written file/folder.	If status is "ErrorLocalFolderNotFound", then the value is blank.
	size	Outputs size of written file/folder. The unit is byte.	Output when a file/folder is written correctly. In the case of a folder, "0" is always output.
	status	Outputs status of written file/folder. Exist The file/folder exists. Virtual The folder specified in Folder path doesn't exist on Amazon S3 but files and/or folders exist in the folder. ErrorLocalFileNotFound The specified Local directory doesn't exist, or the specified file/directory doesn't exist. ErrorUnsupportedFileSize Writing has failed because size of the specified Local file/directory name exceeds 5 gigabytes. ErrorRemoteFolderNotFound The specified Folder path doesn't exist on Amazon S3, or a file is specified. ErrorRemoteFileExist Overwrite isn't selected, and files with the same name exist in specified Folder path on Amazon S3. ErrorClientEncryption Writing has failed because the specified Public Key is incorrect. Error The file/folder couldn't be written due to an error.
	storageclass	Outputs Storage Class of the retrieved file/folder. STANDARD Standard REDUCED_REDUNDANCY RRS(Reduced Redundancy Storage) STANDARD_IA Standard_IA	If file/folder isn't written correctly, the value is blank.
	type	Outputs classification of written file/folder. File File Folder Folder
	updated	Outputs the last updated date of written file/folder.	If file/folder isn't written correctly, the value is blank.

Loading schema in Mapper

The schema is loaded automatically.

= Remarks =

For details, refer to Edit Schema.

Mass data processing

Mass data processing is 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 written folders and files is stored.	The default value is null. The sum of "folder_count" and "file_count".
folder_count	The number of written folders is stored.	The default value is null.
file_count	The number of written 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