Help Centre › Building Processes
This article describes the RPA Compression functionality to compress a file using gzip.
For a full list of available functions, please read COMPRESSION functions.
Description
The Gzip compress function compresses a single file using gzip compression. The output file defaults to the original filename with a .gz extension appended.
Setting it up
To use the Gzip compress function, follow these instructions:
{{popups:rpas/add:action=gzip-compress}}
Once on a process map:
- Navigate to the process where you would like to add the Gzip compress function
- Click on the green button’s drop-down (right side of the green button labelled “Process”)
- On the menu that appears, click on the “+ Activity” item
- From here you can select the COMPRESSION Gzip compress option
- Click "Add" once you are done
Input parameters
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| File Path | Yes | Text | - | The path to the file to compress |
| Output Path | No | Text | file_path + .gz | The path for the compressed output file |
| Variable | No | Text | compressed_file | Variable name to store the output file path |
Output variables
| Variable | Type | Description |
|---|---|---|
| {compressed_file} | String | The path to the compressed output file |
Errors
| Error | Description |
|---|---|
| File not found | The source file does not exist |
| File write error | Could not write the compressed file |
Tips
- Gzip only compresses single files – use tar-create for directories
- The original file is not modified or deleted