Write File/Folder (Data)

Operation name

Function overview

Writes file/folder to Amazon S3.

Data model

The data model of this component is table model type for input data and XML type for output data.

= Remarks =

For more details on input/output schema, refer to Schemas.

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.
Input data	Required	Not available	Select a component on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description
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.
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.
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.

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.

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.

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

<?xml version="1.0"?>
<table>
  <row>
    <column>bucketname</column>
    <column>public</column>
    <column>remotepath</column>
    <column>storageclass</column>
    <column>type</column>
    <column>data</column>
    <column>contenttype</column>
  </row>
  <row>
    :
  </row>
</table>

Column name	Description	Remarks
bucketname	Specify a name of a bucket to write a file/folder.
public	Specify access right of a file/folder to write. true Public false Private	If setting "public", "READ" permission is granted to "AllUsers Group". If omitted, "false" is set.
remotepath	Specify a path on Amazon S3 of the file/folder to write.	The delimiter of a path is "/". A path needs to start with "/". A path of a folder doesn't need to end with "/". The root folder ("/") can't be written to.
storageclass	Specify a Storage Class of a file/folder to write. STANDARD Standard REDUCED_REDUNDANCY RRS(Reduced Redundancy Storage) STANDARD_IA Standard_IA	If omitted, "Standard" is set.
type	Specify a type of a file/folder to write. File File Folder Folder
data	Specify the file contents to write in Base64 format or binary format.	If omitted for files, an empty file is written. For folders, an entered value is ignored.
contenttype	Specify Content-Type for the file/folder to write on Amazon S3.	If you omit Content-Type for the file to write, Content-Type is set based on the file name. If you omit a Content-Type of the folder to write, this isn't set. application/octet-stream is usually used.

= Remarks =

One row is input per file or folder.

Output schema

<?xml version="1.0"?>
<server>
  <bucket name="" status="" >
    <file etag="" name="" public="" remotepath="" size="" status="" storageclass="" type="" updated="" />
  </bucket>
</server>

Element name	Attribute name	Description	Remarks
server	-
bucket	-	Appears once for each bucket of written file/folder.
	name	Outputs bucket name of written file/folder.	The value of bucketname specified in the input data.
	status	Outputs the status of the retrieved bucket. Exist The bucket exists. ErrorBucketNotFound The bucket specified in bucketname in the input data doesn't exist on Amazon S3. Error The bucket couldn't be created 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.
	name	Outputs name of the written file/folder.	The value generated from remotepath specified in the input data.
	public	Outputs the access right of the retrieved 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.	The value of remotepath specified in the input data.
	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. 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