User Guide > Process Steps and Components > Aggregator Step > Zip Aggregator 1.0
Was this helpful?
Zip Aggregator 1.0
Zip Aggregator reads multiple files one at a time, allowing you to processes them one at a time, in a loop, until no input is received, and then generates a zip file as a part of the workflow in process designer. Thus Zip Aggregator will process one file per execution of the step, unlike Zip Invoker which compresses one or multiple files within a single execution of the step.
Note:  Zip Aggregator 1.0 is not compatible with Zip Aggregator 2.0, hence if a component that was created in version 1.0 is opened in version 2.0, its property values will not be retained.
Supported Actions
Action
Description
PutMessage
The PutMessage action is used to "put" the data into Zip Aggregator component. You can use PutMessage property File Name to specify a file. Similarly, the DJMessage property FileName performs the same function.
GetMessage
The GetMessage action "gets" or retrieves the data that has been "put" into the Zip Aggregator component and produces a zip file with the compression and encoding specified in the GetMessage properties.
The EZscript function, FileWrite, can be used to physically write the zip file created by Zip Aggregator component to disk.
Disconnect
Closes an existing connection and performs clean up as needed.
 
Supported PutMessage Parameters
Parameter
Description
Message
The DJMessage parameter for the PutMessage action can be used to load, or input, data into the Zip Aggregator component.
Supported PutMessage Properties
Parameter
Description
File Name
Click Browse to select and load the required file into the Zip Aggregator component.
Note:  The FileName DJMessage property overrides this property value. At least one of these values must be specified or else an error is returned.
Target Folder
Specify a target folder name. This folder is created in the target zip file and in this folder the file is added.
Note:  The TargetFolder DJMessage property overrides this property value.
Duplicates
The following options are available for duplicate zip entries (the same file name and target folder name):
• Error (default) - Throw exception
• Ignore - Keep first zip entry
• Replace - Keep last zip entry
• Rename - Keep all files by adding a number before the file extension.
Supported GetMessage Parameters
Parameter
Description
Message
The DJMessage parameter for GetMessage retrieves all the files or data residing within the Zip Aggregator component.
Supported GetMessage Properties
Parameter
Description
Password
This property sets a password for the zip file created by Zip Aggregator component.
Compression Method
The algorithm used for compression:
• DEFLATE (default) - The Deflate compression
• STORE - No compression
Compression Level
The level of compression for the DEFLATE compression method:
• FASTEST - Level 1 Deflate compression
• FAST - Level 3 Deflate compression
• NORMAL (default) - Level 5 Deflate compression
• MAXIMUM - Level 7 Deflate compression
• ULTRA - Level 9 Deflate compression
Encryption Method
The encryption method used in the zip file:
• NONE - No encryption is performed
• ZIP_STANDARD (default) - Encrypted with a weak zip standard algorithm
• AES - Encrypted with AES, the strongest standard algorithm
Note:  When creating a zip file that uses the "AES" encryption method, make sure that your zip utility supports it.
AES Key Strength
AES Key Strength is only applied to the AES Encryption Method with the following options:
• KEY_STRENGTH_128 - 128-bit AES key length
• KEY_STRENGTH_256 (default) - 256-bit AES key length
Additional Information
After executing GetMessage action, the contents of the Aggregator component can be physically written to a zip file using the FileWrite function in a Script Step. To do this, specify the path and zip file name that you want to create, the djmessage body used in the Aggregator GetMessage action, and the encoding as arguments in the FileWrite function. For example, FileWrite("C:\mypath\MyFile.zip", mydjmessage.body, ENC_ISO8859_1)
You can override PutMessage properties in the following table using a DJMessage property. When set, DJMessage properties takes precedence over the property values specified in the component.
Following is the syntax to set DJMessage property for the Zip Aggregator:
Mydjmessagename.Properties("PropertyName") = value
Following is an example to set the FileName property using a DJMessage:
Mydjmessage.Properties("FileName") = "C:\MyPath\MyFileName.txt"
Property
Description
FileName
Specify the file path to load the required file into the aggregator.
TargetFolder
Specify a target folder name. This folder is created in the target zip file and in this folder the file is added.
If the TargetFolder property is set using a DJMessage, then the DJMessage value overrides the Target Folder property available within the component step.
Duplicates
The following options are available for duplicate zip entries (the same file name and target folder name):
• Error (default) - Throw exception
• Ignore - Keep first zip entry
• Replace - Keep last zip entry
• Rename - Keep all files by adding a number before the file extension.
Errors
Code
Description
Reason
2
FileName error
DJMessage misses 'FileName' property
4
Read error
Read file message from the DJMessage
8
Write error
Write message to a zip file
12
No source error
No message file input to zip
46
License error
Zip Aggregator is not licensed or expired
Last modified date: 10/22/2024