Help Centre › Building Processes
This article describes the RPA Compression functionality to extract files from a TAR archive.
For a full list of available functions, please read COMPRESSION functions.
Description
The Extract TAR function extracts files from a TAR or TAR.GZ archive to a destination directory. You can extract all files or specify individual files.
Setting it up
To use the Extract TAR function, follow these instructions:
{{popups:rpas/add:action=tar-extract}}
Once on a process map:
- Navigate to the process where you would like to add the Extract TAR 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 Extract TAR option
- Click "Add" once you are done
Input parameters
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| Archive Path | Yes | Text | - | The path to the TAR or TAR.GZ file to extract |
| Destination | Yes | Text | - | The directory where files should be extracted to |
| Files | No | Text | - | Specific files to extract (comma-separated). Omit to extract all. |
| Variable | No | Text | extracted_files | Variable name to store the list of extracted files |
Output variables
| Variable | Type | Description |
|---|---|---|
| {extracted_files} | Array | Array of file paths that were extracted |
Errors
| Error | Description |
|---|---|
| Archive not found | The TAR file does not exist |
| Invalid archive | The file is not a valid TAR archive |
Tips
- Handles both .tar and .tar.gz files automatically
- Use tar-list to preview contents before extracting