Description:

The UnZipFile step enables a FlowWright workflow to extract the contents of an existing ZIP archive into a specified destination folder.

ZIP archives are commonly used to package multiple files into a single compressed file for storage, transfer, and distribution. This step automatically opens the specified ZIP file, extracts its contents, and makes the files available for subsequent workflow processing.

Unlike the ZipFile step, which creates compressed archives, UnZipFile performs the reverse operation by restoring the original files and folder structure from an existing ZIP archive.

Typical uses include:

• Extracting downloaded document packages
• Processing archived workflow files
• Importing compressed CSV or Excel files
• Restoring backup archives
• Preparing files for ETL processing
• Extracting customer-uploaded documents
• Processing compressed integration packages
• Preparing files for document management workflows

This step simplifies automated file extraction and enables workflows to seamlessly process compressed content received from external systems.

Usage:

The UnZipFile step is typically placed before workflow activities that need to process the extracted files.

During execution:

1. Read the configured ZIP file path.
2. Validate that the archive exists.
3. Open the ZIP archive.
4. Extract all files and folders into the specified destination folder.
5. Continue workflow execution through either the True or False return path.

A typical workflow might look like this:

Typical workflow scenarios include:

• Processing ZIP files received through email
• Importing compressed customer data
• Extracting documents before DMS upload
• Restoring archived workflow files
• Processing compressed integration payloads
• Extracting software deployment packages
• Loading compressed business reports

Example:

Let’s build and execute the “unZipFileDef” example.          

• Create a new definition called “unZipFileDef” and open the definition in designer mode. 
• Drag a "zipFile, unZipFile" step to the canvas. 
• Connect the dots between the “Start” step and “unZipFile” steps, as shown above.  
• Define a variable or a global variable to store the result. 
• Click the “ZipFile” step to configure its properties. Enter the source file or folder path on the FlowWright server. Click the Save button. Note: Click the "AI Predict" button to have the Copilot add new process steps that match your process description. 

• Click the “unZipFile” step to configure its properties. Enter the destination file or folder path on the FlowWright server. Click the Save button. Note: Click the "AI Predict" button to have the Copilot add new process steps that match your process description. 

• Save the process definition, create a process instance, and execute it. Render the completed process instance to view the step properties. The step should have extracted the files to the destination folder. Note: The File Management feature is not available in FW v10.x. Use the File Explorer utility to view the same file path. 

Tips:

• Verify that the ZIP file exists before executing this step.
• Use a dedicated processing folder to avoid mixing extracted files from different workflow instances.
• Ensure the FlowWright application has write access to the destination folder.
• Validate extracted files before importing or processing them.
• Route the False path to logging and notification activities to simplify troubleshooting.
• Combine this step with Read Values from CSV and Excel, Import Data, REST Call, Upload Document, ZipFile, or document-processing steps to automate complete archive processing workflows.

Notes:

• Both configuration properties are required.
• The step extracts all files and folders contained in the specified ZIP archive.
• The source ZIP archive remains unchanged after extraction.
• The extracted files are created in the configured destination folder.
• Both the True and False return paths should be implemented to provide complete workflow handling.
• Ensure sufficient disk space is available before extracting large archives.
• Execution details are recorded in the FlowWright workflow execution log.

UnZipFile vs. ZipFile:

Although both steps work with ZIP archives, they perform opposite operations.

As a general guideline:

• Use UnZipFile when a workflow needs to extract and process the contents of an existing ZIP archive.
• Use ZipFile when a workflow needs to compress files or folders for storage, transfer, backup, or distribution.

Definition Sample:

You may download the sample workflow definition from the link provided and import it into your FlowWright environment.

Note: Verify and complete any missing configuration after importing the sample, including:

• ZIP file path
• Destination folder
• Success and failure workflow branches
• Validation that the destination folder is accessible
• Downstream activities that process the extracted files

After verifying the configuration, save and publish the workflow before execution.

Click here to download the sample file.