Workflow action: Compress files

Modified on Tue, 18 Jul, 2023 at 9:17 AM

The Compress files action type allows to compress files in zip format created by previous actions. Furthermore, multiple files can also be combined into one zip archive and sent to the user as one file.

INHALTSVERZEICHNIS

Parameters
- Files to compress
- Storage options for the created files
Action variables
- Standard action variables
- Action specific action variables

User to set up action of type Compress files. This can be used to store multiple files in a ZIP archive.

Parameters

Files to compress

Files: Selection of files to be included in the zip archive. See actions for a list of supported URL protocols.

Storage options for the created files

Output file name: Name of the output file.
Attach file to form record: If this option is selected, files created in this action will be attached to the form record. Otherwise, they are only available for other actions within the workflow processing in the same processing chain.

Action variables

Actions of type Compress files provide Action variables which can be used in subsequent actions.

Standard action variables

[%$<action name>.SUCCESS%]: Return whether action was successfully executed. Returns Boolean (true/false).
[%$<action name>.RESULT%]: Return all results provided by the action in structured form.

[%$<action name>.ERROR_CODE%]: The error code thrown in case of an error in the action. Empty if no error occurred.
[%$<action name>.ERROR_MESSAGE%]: The thrown error message in the action's error case. Empty if no error occurred.

Action specific action variables

[%$<action name>.RESULT.compressedSize%]: Size of the created ZIP archive, in bytes.
[%$<actionname>.ERROR.message%]: Error message returned if the compressing file could not be written to or read from the file system.