COMPRESSION Create TAR function

The COMPRESSION Create TAR function in RPA.

Help CentreBuilding Processes

This article describes the RPA Compression functionality to create a TAR archive.

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


Description

The Create TAR function creates a new TAR archive from a file or directory. Optionally compresses the archive with gzip to produce a .tar.gz file.


Setting it up

To use the Create TAR function, follow these instructions:

{{popups:rpas/add:action=tar-create}}

Once on a process map:

  1. Navigate to the process where you would like to add the Create TAR 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 Create TAR option
  5. Click "Add" once you are done

Input parameters

ParameterRequiredTypeDefaultDescription
Archive PathYesText-The path for the output TAR file
SourceYesText-The file or directory to include in the archive
CompressNoBooleantrueWhether to compress with gzip (produces .tar.gz)

Output variables

This action does not produce output variables.


Errors

ErrorDescription
Source not foundThe source file or directory does not exist
File write errorCould not write the archive to the specified path

Tips

  • Set compress to true to produce a .tar.gz file for smaller archive size
  • TAR preserves Unix file permissions, making it ideal for Linux/macOS file transfers

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.