--- title: "Action type: Compress" description: "## Action type Type of action to execute. - **[Compress](https://extensionkit.unitfly.com/documentation/archiving-action-type-compress/#compress)**: Compress the specified items to a given format. - **[Decompress](https://extensionkit.unitfly.com/documentation/archiving-action-type-decompress/#decompress)**: Extract the specified item. --- ## Compress *Displayed only if Action type is Compress.* Configuration settings for creating a compressed…" url: "https://extensionkit.unitfly.com/documentation/archiving-action-type-compress/" updated: "2025-05-01" category: Configurations / Archiving / Simple Rule Configuration --- # Action type: Compress ## Action type Type of action to execute. - **[Compress](https://extensionkit.unitfly.com/documentation/archiving-action-type-compress/#compress)**: Compress the specified items to a given format. - **[Decompress](https://extensionkit.unitfly.com/documentation/archiving-action-type-decompress/#decompress)**: Extract the specified item. --- ## Compress *Displayed only if Action type is Compress.* Configuration settings for creating a compressed archive. The default fields within this section are: - [Format of the target archive](https://extensionkit.unitfly.com/documentation/archiving-action-type-compress/#format-of-the-target-archive) - [Archive File Name](https://extensionkit.unitfly.com/documentation/archiving-action-type-compress/#archive-file-name) - [Password Protect Archive](https://extensionkit.unitfly.com/documentation/archiving-action-type-compress/#password-protect-archive) - [Source](https://extensionkit.unitfly.com/documentation/archiving-action-type-compress/#source) - [Destination](https://extensionkit.unitfly.com/documentation/archiving-action-type-compress/#destination) ### Format of the target archive *Compress > Format of the target archive* Defines the archive format for the compressed target. Choose the format of the compressed file: - **SevenZip** - **Tar** - **Zip** ### Archive File Name *Compress > Archive File Name* Specifies the name of the output archive file. ### Password Protect Archive *Compress > Password Protect Archive* *Displayed when Format of the target archive is SevenZip or Zip.* Enables password protection for the archive. Note: For .7z archives, this implicates AES256 encryption. - **No** (default) - **Yes:** If selected, the **Password** field becomes available. ### Password *Compress > Password Protect Archive: Yes > Password* *Displayed and required only if Password Protect Archive is set to Yes.* Set the password to protect the archive. ### Encryption type *Compress > Format of the target archive: Zip > Password Protect Archive: Yes > Encryption type* *Displayed only if Format of the target archive is Zip, and Password Protect Archive is set to Yes.* Specifies the encryption type for the archive (e.g., `Traditional`, `AES128`, `AES192`, `AES256`). --- ## Source *Compress > Source* Defines the source location for files to compress, i.e. where the files will be pulled from. ### Type *Compress > Source > Type* Specifies the source type for the file location. - **Vault**: If selected, the **Vault source** section is available for further configuration. - **Disk**: If selected, the **Disk source** section is available for further configuration. **Note**: Disk option is only available when Extension Kit is deployed on-premise. - **Sftp**: If selected, the **Sftp source** section is available for further configuration. --- ### Vault source *Compress > Source > Type: Vault > Vault source* *Displayed only if Type is Vault.* Settings for retrieving files from a Vault source. The following fields are displayed by default: **Type** and **Source filename wildcards**. #### Type *Compress > Source > Type: Vault > Vault source > Type* *Displayed only if Type is Vault.* Specifies the type of vault source. - **TriggerSource** - **TriggerSourceReference**: The **Reference** field opens up. - **Search**: The **Search** section opens up. - **VaultSearch** #### Source filename wildcards *Compress > Source > Type: Vault > Vault source > Source filename wildcards* Patterns for matching specific filenames in the source. Expand to **Add Filename wildcard**. --- ### Disk source *Compress > Source > Type: Disk > Disk source* *Displayed only if Type is Disk.* Settings for retrieving files from a Disk source. The following fields are available: **Folder path, Filename,** and **Use Authentication.** #### Folder path *Compress > Source > Type: Disk > Disk source* Absolute path to the folder with files for archiving/unarchiving. #### Filename *Compress > Source > Type: Disk > Disk source* File name of the file for unarchiving, or the search string to match against the names of files in the path. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters but doesn't support regular expressions. - *** (asterisk)**: Replaces zero or more characters in that position. - **? (question mark):** Replaces exactly one character in that position. #### Use Authentication *Compress > Source > Type: Disk > Disk source* Specifies whether the authentication is needed (is it a network drive). --- ### Sftp source *Compress > Source > Type: Sftp > Sftp source* *Displayed only if Type is Sftp.* Settings for retrieving files from an SFTP source. The following fields are displayed by default: **Host, Port, Username, Password, File path, Filename.** #### Host *Compress > Source > Type: Sftp > Sftp source > Host* *Displayed only when Type is Sftp.* Network address or server name. #### Port *Compress > Source > Type: Sftp > Sftp source > Port* *Displayed only when Type is Sftp.* Network port. The default value is 22. #### Username *Compress > Source > Type: Sftp > Sftp source > Username* *Displayed only when Type is Sftp.* Username to be used for server authentication. #### Password *Compress > Source > Type: Sftp > Sftp source > Password* *Displayed only when Type is Sftp.* Password for that username. #### File path *Compress > Source > Type: Sftp > Sftp source > File path* *Displayed only when Type is Sftp.* Absolute path to the folder with files for archiving/unarchiving. #### Filename *Compress > Source > Type: Sftp > Sftp source > Filename* File name of the file for unarchiving, or the search string to match against the names of files in the path. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters but doesn't support regular expressions. - *** (asterisk)**: Replaces zero or more characters in that position. - **? (question mark):** Replaces exactly one character in that position. --- ## Destination *Compress > Destination* Specifies the destination where the compressed archive will be stored. The following fields are available by default: **Mode** and **File Replace behaviour on Destination**. ### Mode *Compress > Destination > Mode* Specifies the mode for the target file location. - **Vault**: If selected, the **Vault destination** section is available for further configuration. - **Disk**: If selected, the **Disk destination** section is available for further configuration. **Note**: Disk option is only available when Extension Kit is deployed on-premise. - **Sftp**: If selected, the **Sftp destination** section is available for further configuration. ### File Replace behaviour On Destination *Compress > Destination > File Replace behaviour On Destination* Determines the behavior when a file with the same name exists on the destination. - **Skip** - **Overwrite** - **CreateNew** --- ### Vault Destination *Compress > Destination > Mode: Vault > Vault Destination* *Displayed only when Mode is Vault.* Specifies the vault destination configuration. The following field is displayed by default: **Type.** #### Type *Compress > Destination > Mode: Vault > Vault Destination > Type* *Displayed only when Mode is Vault.* Defines the type of destination in the vault, i.e. how the destination item will be added (e.g., on a new object or existing object). - **TriggerSource** - **TriggerSourceReference**: The **Reference** field opens up. - **Search**: The **Search** section opens up. - **VaultSearch** - **NewObject**: The **Object Replace behaviour On Destination** field and **New Object Settings** sections open up. #### Reference *Compress > Destination > Mode: Vault > Vault Destination > Type: TriggerSourceReference* *Displayed only when Type is TriggerSourceReference.* Specifies a reference from the trigger source. Select the property. The properties are referenced by a GUID, ID or alias. #### Search *Compress > Destination > Mode: Vault > Vault Destination > Type: Search > Search* *Displayed only when Type is Search.* Define search criteria to find target objects in the vault. The following fields are displayed by default: **Find targets, Reference, Reference Direction, Filter Conditions**. #### Find targets *Compress > Destination > Mode: Vault > Vault Destination > Type: Search > Search > Find targets* *Displayed only when Type is Search.* Specify how to find targets. - **ViaProperty** (default) - **ViaSearch** #### Reference *Compress > Destination > Mode: Vault > Vault Destination > Type: Search > Search > Reference* *Displayed only when Type is Search.* Property that acts as a reference between source and target objects. Select the property. The properties are referenced by a GUID, ID or alias. #### Reference Direction *Compress > Destination > Mode: Vault > Vault Destination > Type: Search > Search > Reference Direction* *Displayed only when Type is Search.* Specifies the type of reference between source and target objects. - **Direct** (default): The source object references the target object. - **Indirect**: The target object references the source object. #### Filter Conditions *Compress > Destination > Mode: Vault > Vault Destination > Type: Search > Search > Filter conditions* *Displayed only when Type is Search.* Optional search conditions used to find the targets. #### Object Replace behaviour On Destination *Compress > Destination > Mode: Vault > Vault Destination > Type: NewObject > Object Replace behaviour On Destination* *Displayed only when Type is NewObject.* Specifies how to handle objects with the same name on the destination. - **Skip** - **Overwrite** - **CreateNew** #### New Object settings *Compress > Destination > Mode: Vault > Vault Destination > Type: NewObject > New Object Settings* *Displayed only when Type is NewObject.* Additional settings for creating a new object on the destination. When expanded, the following fields are available by default: **Object type, Class, SingleFile** and **Properties**. #### Object type *Compress > Destination > Mode: Vault > Vault Destination > Type: NewObject > New Object Settings > Object Type* *Displayed only when Type is NewObject.* Select the type of object to create on the destination. #### Class *Compress > Destination > Mode: Vault > Vault Destination > Type: NewObject > New Object Settings > Class* *Displayed only when Type is NewObject.* Select the class type for the new object. #### SingleFile *Compress > Destination > Mode: Vault > Vault Destination > Type: NewObject > New Object Settings > SingleFile* *Displayed only when Type is NewObject.* Indicates if the destination object should be a single file. - **Yes** - **No** #### Properties *Compress > Destination > Mode: Vault > Vault Destination > Type: NewObject > New Object Settings > Properties* *Displayed only when Type is NewObject.* Set additional properties for the new object. Each property will have a corresponding value. When expanded, click on **Add PropertyValue**. The following fields are available by default: Property, Value from, Value type, Value, Multi select lookup & multi line text behaviour. --- ### Disk Destination *Compress > Destination > Mode: Sftp > Sftp Destination* *Displayed only when Mode is Sftp.* Specifies the disk destination configuration. The following fields are available: **Folder path, Filename,** and **Use Authentication.** #### Folder path *Compress > Destination > Mode: Disk > Disk Destination > Folder path* Absolute path to the folder with files for archiving/unarchiving. #### Filename *Compress > Destination > Mode: Disk > Disk Destination > Filename* File name of the file for unarchiving, or the search string to match against the names of files in the path. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters but doesn't support regular expressions. - *** (asterisk)**: Replaces zero or more characters in that position. - **? (question mark):** Replaces exactly one character in that position. #### Use Authentication *Compress > Destination > Mode: Disk > Disk Destination > Use Authentication* Specifies whether the authentication is needed (is it a network drive). --- ### Sftp Destination *Compress > Destination > Mode: Sftp > Sftp Destination* *Displayed only when Mode is Sftp.* Settings related to file storage on an SFTP server. The following fields are displayed by default: **Host, Port, Username, Password, File path.** For detailed descriptions, please refer to the [Sftp source](https://extensionkit.unitfly.com/documentation/archiving-action-type-compress/#sftp-source)section.