Encrypt

Operation name

Encrypt

Function overview

Encrypts the file and outputs it to the specified directory.

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
Source directory	Required	Available	Enter a directory path of HULFT Square Storage to specify the location of the file to encrypt. 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.
Input file name	Required	Available	Specify the name of the file to encrypt.	Wildcards ("*" and "?") can be used.
Destination directory	Required	Available	Enter a directory path of HULFT Square Storage to specify the location of the encrypted file. 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.
Output file extension	Required	Available	Specify the extension of the encrypted file. .gpg (Default) .pgp	You can edit or add an extension.
Public key	Required	Available	Enter a directory path of HULFT Square Storage to specify the location of the public key used for encryption. 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 directory path. With the exception of the path separator "/", the Restricted characters of HULFT Square Storage can't be used.

Output settings

Item name	Required/Optional	Use of variables	Description	Remarks
Overwrite the output file when it exists	Optional	Not available	Select whether to overwrite when a file with the same name exists in the specified directory. Selected Overwrite when a file with the same name exists in the specified directory. Not selected (Default) Output an error without overwriting if a file with the same name exists in the specified local directory.
Stop on error	Optional	Not available	When you are processing multiple files at the same time, select whether to continue processing the remaining files if an error occurs while some files are being processed. Selected (Default) Stops all processing if an error occurs. Not selected Continues processing even if an error occurs.

Item name

Required/Optional

Use of variables

Description

Remarks

Overwrite the output file when it exists

Optional

Not available

Select whether to overwrite when a file with the same name exists in the specified directory.

Selected

Overwrite when a file with the same name exists in the specified directory.

Not selected

(Default)

Output an error without overwriting if a file with the same name exists in the specified local directory.

Stop on error

Optional

Not available

When you are processing multiple files at the same time, select whether to continue processing the remaining files if an error occurs while some files are being processed.

Selected

(Default)

Stops all processing if an error occurs.

Not selected

Continues processing even if an error occurs.

Encryption settings

Item name	Required/Optional	Use of variables	Description	Remarks
Encryption cipher	Optional	Not available	Select the method for encrypting the file contents. IDEA Triple DES CAST5 Blowfish AES-128 AES-192 AES-256 (Default) TwoFish Camellia-128 Camellia-192 Camellia-256
Compressed type	Optional	Not available	Select the compression type before you encrypt the file contents. UNCOMPRESSED ZIP (Default) ZLIB BZIP2
ASCII Armor	Optional	Not available	Select whether to output the contents of the encrypted file in the ASCII format or in binary. Selected Outputs in the ASCII format. Not selected (Default) Outputs in binary.
Sign	Optional	Not available	Select whether to use a digital signature. Selected Performs a digital signature. Not selected (Default) Doesn't perform a digital signature.
Sign key	Optional	Available	Enter a directory path of HULFT Square Storage to specify the location of the private key used for the signature. 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 directory path. With the exception of the path separator "/", the Restricted characters of HULFT Square Storage can't be used. The keys that can be used are private keys only.
Passphrase	Optional	Available	You can set a passphrase for the private key with GnuPG. If you set a passphrase, you will be prompted to enter the passphrase every time the private key is used.

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

<pgp>
    <encryption>
        <sourceDir>Source directory</sourceDir>
        <inFile>Input file name</inFile>
        <targetDir>Destination directory</targetDir>
        <outExtension>Output file extension</outExtension>
        <pathnames>
            <pathname>
                <input>File to encrypt</input>
                <output>Encrypted file</output>
            </pathname>
            <pathname>
              : 
            </pathname>
        </pathnames>
    </encryption>
</pgp>

Element name	Description	Remarks
sourceDir	The source directory is output.
inFile	The value that has been set for Input file name is output.
targetDir	The value that has been set for Destination directory is output.
outExtension	The value that has been set for Output file extension is output.
pathnames
pathname	Repeats for the number of encrypted files.
input	The name of the input file is output.
output	The name of the output file is output.

Loading schema in Mapper

The schema is loaded automatically.

= Remarks =

For details, refer to Edit Schema.

Mass data processing

Mass data processing isn't supported.

Parallel Stream Processing

PSP isn't supported.

Available component variables

Component variable name	Description	Remarks
sourceDir	The input source directory is stored.	Enter a "/" at the end of the variable.
inFile	The input file name is stored.
targetDir	The output destination directory is stored.	Enter a "/" at the end of the variable.
outExtension	The output file extension is stored.
succeeded_count	The number of input items that were processed successfully is stored.	The default value is 0.
failed_count	The number of input items that failed in the processing is stored.	The default value is 0.
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 PGP connector