Official |[File Operations] Compress ZIP

Operation name

Compress ZIP

Function overview

Compresses a file or directory into a ZIP file.

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
Path to compress	Required	Available	Enter the path of the file or directory to compress. The Browse button launches a file chooser that allows you to select a file.	Note Specify an absolute path of HULFT Square Storage for the file path. With the exception of the path separator "/" and wildcards ("*","?"), the Restricted characters of HULFT Square Storage can't be used.
Output to	Required	Available	Enter the path to the output destination for the file or directory. The Browse button launches a file chooser that allows you to select a file. If you specify a directory path, the compressed file name will be "${directory name}.zip".	Note 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

Path to compress

Required

Available

Enter the path of the file or directory to compress.

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

Note

Specify an absolute path of HULFT Square Storage for the file path.
With the exception of the path separator "/" and wildcards ("*","?"), the Restricted characters of HULFT Square Storage can't be used.

Output to

Required

Available

Enter the path to the output destination for the file or directory.

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

If you specify a directory path, the compressed file name will be "${directory name}.zip".

Note

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.

Option

Item name	Required/Optional	Use of variables	Description	Remarks
Encoding	Optional	Available	Select or specify an encoding of the file name or directory name to be compressed. When you enter encoding, specify one of the encodings supported in Java SE Runtime Environment 8. = Remarks = For details, refer to "Supported Encodings" (http://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html).	The default encoding selected for Encoding of file type connectors is UTF-8. If omitted, the default value is set.
Error when file already exists at output destination	Optional	Not available	Select whether to raise an error when the compressed file or directory already exists in the compressing destination. Selected (Default) Raise an error. Not selected Overwrite.

Item name

Required/Optional

Use of variables

Description

Remarks

Encoding

Optional

Available

Select or specify an encoding of the file name or directory name to be compressed.

When you enter encoding, specify one of the encodings supported in Java SE Runtime Environment 8.

= Remarks =

For details, refer to "Supported Encodings" (http://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html).

The default encoding selected for Encoding of file type connectors is UTF-8.
If omitted, the default value is set.

Error when file already exists at output destination

Optional

Not available

Select whether to raise an error when the compressed file or directory already exists in the compressing destination.

Selected

(Default)

Raise an error.

Not selected

Overwrite.

Encryption

Item name	Required/Optional	Use of variables	Description	Remarks
Encrypt zip file	Optional	Not available	Select whether to encrypt the zip file or not. Not selected (Default) Don't encrypt. Selected Encrypt.
Password	Optional	Available	Specify a password to use for encryption.	Enabled when Encrypt zip file is selected.
Confirm password	Optional	Available	Specify the password to use for encryption again.	Enabled when Encrypt zip file is selected. If this value doesn't match Password, an error occurs during execution.
Encryption type	Optional	Not available	Select the encryption type. Standard (Default) Encrypt a file/directory with the standard method. AES-256 Encrypt a file/directory with AES-256.	Enabled when Encrypt zip file is selected.

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Required	Not available	You can write a short description of this connector.

Schemas

Input schema

None.

Output schema

None.

Transaction

Transaction isn't supported.

Parallel Stream Processing

PSP isn't supported.

Available component variables

Variable name	Description	Remarks
success	The result of the operation is stored.	The default value is null. When succeeded, "true" is stored. When failed, "false" is stored.
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 File Operation connector