Write File/Folder

Operation name

Write File/Folder

Function overview

Writes a file/folder on HULFT Square Storage to Google Cloud Storage.

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.
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.	Case-insensitive. 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.
Local file/directory name	Required	Available	Select or enter the file/directory on HULFT Square Storage.	Wildcards ("*" and "?") can be used. "/" can't be included.
Process recursively	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 of the write destination	Required	Available	Select or enter the destination bucket.
Folder paths of the write destination	Required	Available	Select or enter the folder path on Google Cloud Storage.	Note Specify an absolute path of Google Cloud Storage for the folder path.
Create folder if one does not 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 when one exists	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.

Property actions

Item name	Description	Remarks
Update the list of bucket names of the write destination	Get bucket names in the specified destination and set them in Bucket name of the write destination.	If Destination is edited or a bucket has been edited on Google Cloud Storage, the changes can be reflected using this property action. Disabled when Destination isn't specified.
Update the list of folder paths of the write destination	Get folder paths in the specified bucket and set them in Write destination folder path.	If Bucket name of the write destination is edited or a folder path has been edited on Google Cloud Storage, the changes can be reflected using this property action. Disabled when Destination or Bucket name of the write destination isn't specified.

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"?>
<bucket name="" status="" >
  <file errorcode="" localpath="" name="" remotepath="" size="" status="" statuscode="" type="" updated=""/>
</bucket>

Element name	Attribute name	Description	Remarks
bucket	-	Appears once for each retrieved bucket.
	name	Outputs the name of the retrieved bucket.
	status	Outputs the status of the retrieved bucket. Exist The bucket exists. ErrorBucketNotFound The specified Bucket name of the write destination doesn't exist on Google Cloud Storage. The specified bucket name may be incorrect.
file	-	Appears once for each written file/folder.
	errorcode	When an error occurs on Google Cloud Storage, outputs the API error code defined on Google Cloud Storage.	If no error has occurred on Google Cloud Storage, the value is blank. For more details about API error code defined on Google Cloud Storage, refer to the following Web site: https://cloud.google.com/storage/docs/json_api/v1/status-codes
	localpath	Outputs local path of written file/folder.	If status is "RemoteFileNotFound", the value is blank. If status is "RemoteFileExist" and type is "Folder", the value is blank. If status is "Uploaded" and type is "Folder", the value is blank. If status is "Error", the value may be blank.
	name	Outputs name of the written file/folder.	If status is "LocalFileNotFound", the value is blank. If status is "RemoteFileNotFound", the value is blank. If status is "Error", the value is blank.
	remotepath	Outputs the file path on Google Cloud Storage of written file/folder.	If status is "LocalFileNotFound", the value is blank. If status is "Error", the value may be blank.
	size	When the written file/folder is a file, outputs the file size. The unit is byte.	If file/folder isn't written correctly, the value is blank. If it's a folder, the value is blank.
	status	Outputs status of written file/folder. Uploaded The file/folder has been written. LocalFileNotFound The specified Local directory doesn't exist, or the file/directory specified in Local file/directory name doesn't exist. RemoteFileNotFound Either Create folder if one does not exist isn't selected but the folder path specified in Folder paths of the write destination doesn't exist, or a file is specified in Folder paths of the write destination. RemoteFileExist A file/folder with the same name as specified Local file/directory name exists in Folder paths of the write destination. However, when Overwrite file when one exists is selected, the file is overwritten and then the status changes to "Uploaded". Error The file/folder hasn't been written because an error has occurred.
	statuscode	When an error occurs on Google Cloud Storage, outputs the API status code defined on Google Cloud Storage.	If no error has occurred on Google Cloud Storage, the value is blank. For more details about the API status codes defined on Google Cloud Storage, refer to the following Web site: https://cloud.google.com/storage/docs/json_api/v1/status-codes
	type	Outputs classification of written file/folder. File File Folder Folder
	updated	Outputs the last updated date when the written file/folder is a file.	If file/folder isn't written correctly, the value is blank. If it's a folder, 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 target files/folders 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 Google Cloud Storage connector