Home Search

DriveWorks Pro 22
Zip Files

Send Feedback

Zip Files

This task creates a Zip file based on a given full file path with file name and a list of files to Zip. The task allows the user to decide whether to overwrite the Zip file if it exists or not and will report to a specified reporting Constant that will list the number of files added to the Zip, or an error condition prefixed with #ZPERROR.

Zip Files Properties

Property NameDescription
TitleChanges the Title (not the name) of the task.
ZIP File NameFull file name and path for the Zip file to create, including extension.
File Name ListPipe bar (|) delimited file list with full paths and extensions.
Overwrite ZIPTRUE to overwrite an existing Zip, FALSE to keep existing file.
Result ConstantThe name of the Constant that the result will be posted to (with or without the DWConstant prefix).


When this Task is added the properties are static. To be able to build rules on a static property see How To: Change A Static Property To A Dynamic Property.

Property NameExample RuleExample ResultMeaning
ZIP File Name"C:\MyDocuments\Specifications\" &DWSpecificationId&"Info.zip"C:\MyDocuments\Specifications\Shelving 9999\Info.zipThis will be the name and full file path of where the zip file will be located.
File Name List"C:\MyDocuments\Documents\WarrentyPolicy.pdf| C:\MyDocuments\Documents\Catalog.pdf"C:\MyDocuments\Documents\WarrantyPolicy.pdf| C:\MyDocuments\Documents\Catalog.pdfThis is a pipebar (|) delimited list of all the files and there full paths to be included in the Zip file. This example shows a warranty policy and catalog that would be zipped.
Overwrite ZIPTRUETRUETRUE will overwrite the Zip file if it already exists FALSE will not.
Result Constant"DWConstantReport"DWConstantReportThis is the name of the Constant that the Macro Task will report to.

Using the Task in a Specification Macro

This task has different types of Outputs. For more information about Outputs see Specification Macros Task Node.

Outputs are only available within Specification Macros. Currently Outputs are not available for Specification Flow.

Status Outputs

This task supports Status Outputs. These can be used to perform different actions depending on what the status outcome of the task is. For more information see Status Outputs in the Task Node Outputs section of Specification Macros Task Node.

The status output navigation is as follows:

Success (one of the following occurred)

  • Zip file name Delete will not be extracted.
  • Zip file has been created successfully.

Success with Warnings (one of the following occurred)

  • Zip file was found and deleted (Overwrite ZIP Property set to true).
  • Existing ZIP File Name was found (Overwrite ZIP Property set to false).
  • Not all files were successfully zipped. Some files were not found or not able to be zipped.

Failed (one of the following occurred)

  • Zip file name cannot be left empty.
  • Task failed to overwrite or close files correctly.
  • General failure - Check the Specification report for more details.