4.13.23 Decompressing a file
Function
This plug-in decompresses the specified compressed file on the execution-target server in a Windows or UNIX environment. If the OS of the execution-target server is Windows, the plug-in can decompress ZIP files. If the OS of the execution-target server is UNIX, the plug-in can decompress GZIP files (compressed collections of files archived as TAR files). The names of the files output by this plug-in are the names of the original files or folders (before compression). The decompressed files are output to the folder specified by the common.outputDestFolderPath property. The decompression-target file in the path specified by the common.uncompressSourceFilePath property is not deleted after being decompressed. The value of the common.uncompressSourceFilePath property cannot include wildcard characters.
Notes on the decompression-target file path (common.uncompressSourceFilePath property):
- Specify the decompression-target file by its full path name.
Notes on the output destination folder path (common.outputDestFolderPath property):
- Specify the output destination folder by its full path name. If the specified folder does not exist, it will be automatically created.
Use situation
This plug-in can be used to decompress files.
Prerequisites
For the most recent information about the prerequisite products in the system, the prerequisite products on the execution-target server, and the supported OSs on the execution-target server, see the Release Notes.
[Prerequisite products in the system]
JP1/Automatic Operation 11-00 or later
[Prerequisite products on the execution-target server]
None.
[Supported OSs on the execution-target server]
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter or Windows Server 2012 R2 Standard/Datacenter
(3) Windows Server 2016 Standard/Datacenter
(4) Windows Server 2019 Standard/Datacenter
(5) Red Hat Enterprise Linux Server 6 (32-bit x86) or Red Hat Enterprise Linux Server 6 (64-bit x86_64)
(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)
(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)
(8) CentOS 6 (64-bit x86_64)
(9) CentOS 7 (64-bit x86_64)
(10) CentOS 8 (64-bit x86_64)
(11) Oracle Linux 8 (64-bit x86_64)
[Conditions for using the execution-target server]
If the OS of the execution-target server is Windows, .NET Framework 4.5.2 (or later) and Windows PowerShell 3.0 (or later) must be installed.
Cautions
(1) For the properties of this plug-in, do not specify any strings that include double quotation marks (") or single quotation marks (').
(2) If the OS of the execution-target server is UNIX, do not include single-byte backslashes (\) in the values of properties.
(3) You cannot specify multiple compressed files for the decompression-target file path (common.uncompressSourceFilePath property).
(4) If the output destination folder (specified by the common.outputDestFolderPath property) already contains a file that has the same name as a file to be decompressed, this plug-in terminates abnormally without overwriting the existing file.
(5) If the OS of the execution-target server is Windows, the length of the output destination folder path must not exceed 247 characters, and the total length of the folder path and file name must not exceed 259 characters. If the specified path is too long, the plug-in cannot decompress the file. If the plug-in terminates abnormally before decompression finishes, only files that were successfully decompressed will remain.
(6) This plug-in must wait until decompression finishes for synchronization.
(7) The time required for decompression depends on the file size.
Version
02.00.00
Plug-in tags
Control OS,Windows,Linux
Plug-in name displayed in the task log
osUncompressFile
Return code
0: Normal
12: Error (Mistake by user) Invalid property
23: Error (Invalid environment) The environment requirements are not met.
27: Error (Check with the task log about the error detail) Unidentified error
41: Error (An error has been detected in the plug-in) Property not entered (An error has been detected in the component script)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
|
common.uncompressSourceFilePath |
File path to be decompressed |
Enter the full path of the compressed file to be decompressed. |
-- |
Input |
R |
|
common.outputDestFolderPath |
Folder output path |
Enter the full path of the folder output path. |
-- |
Input |
R |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
-- |