COMPRESSION Gzip decompress function

The COMPRESSION Gzip decompress function in RPA.

Help CentreBuilding Processes

This article describes the RPA Compression functionality to decompress a gzip file.

For a full list of available functions, please read COMPRESSION functions.


Description

The Gzip decompress function decompresses a gzip (.gz) file. The output file defaults to the original filename with the .gz extension removed.


Setting it up

To use the Gzip decompress function, follow these instructions:

{{popups:rpas/add:action=gzip-decompress}}

Once on a process map:

  1. Navigate to the process where you would like to add the Gzip decompress function
  2. Click on the green button’s drop-down (right side of the green button labelled “Process”)
  3. On the menu that appears, click on the “+ Activity” item
  4. From here you can select the COMPRESSION Gzip decompress option
  5. Click "Add" once you are done

Input parameters

ParameterRequiredTypeDefaultDescription
File PathYesText-The path to the gzip file to decompress
Output PathNoText-The path for the decompressed output file. Defaults to removing the .gz extension.
VariableNoTextdecompressed_fileVariable name to store the output file path

Output variables

VariableTypeDescription
{decompressed_file}StringThe path to the decompressed output file

Errors

ErrorDescription
File not foundThe gzip file does not exist
Invalid gzipThe file is not a valid gzip archive

Tips

  • The default output path removes the .gz extension from the input filename
  • Use an explicit output path if you want to decompress to a different location

Related functions

See it working on your own data

Everything documented here ships with the platform – try the document tools free, or go live in 7 days.