Property Name | Description |
|---|---|
Output Zip File | Specify the path and name of the output zip file. Include a .zip extension if required as an extension is not added automatically. |
Zip File Exists | The following options are available for an already existing zip file: • Error (default) - Throws exception if the zip file already exists. • Replace - Replaces the zip file if it already exists. • Update - Adds new entry to the already existing zip file. |
Zip File Password | Specify the password for a password protected zip file. Note: If you specify a password, then the Zip Encryption Method PutMessage property should be set to any value other than NONE. |
Action | Description |
|---|---|
PutMessage | The PutMessage action is used to "put" the data into Zip Aggregator component. You can use PutMessage property Zip Entry 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. The EZscript function, FileWrite, can be used to physically write the zip file created by Zip Aggregator component to the disk. |
Connect | Opens a persistent connection to the component source. |
Disconnect | Closes an existing connection and performs clean up as needed. |
Parameter | Description |
|---|---|
Message | The DJMessage parameter for the PutMessage action can be used to load, or input, data into the Zip Aggregator component. |
Parameter | Description |
|---|---|
Zip Entry 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. |
Zip Entry 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. |
Zip Entry 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. |
Zip Compression Method | The algorithm used for compression: • DEFLATE (default) - The Deflate compression • STORE - No compression |
Zip 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 |
Zip Encryption Method | The encryption method used in the zip file: • NONE - No encryption is performed. Select this only if you have not specified the Zip File Password component property. • 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. |
Zip 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 |
Parameter | Description |
|---|---|
Message | The DJMessage parameter for GetMessage retrieves all the files or data residing within the Zip Aggregator component. |
Action | Property | Description |
|---|---|---|
Input | FileName | The file name of the zip entry. This property overrides the Zip Entry File Name property. |
TargetFolder | Optional message property which specifies the folder in the target zip file under which the file will be created. | |
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. | |
CompressionMethod | The algorithm used for compression: • DEFLATE (default) - The Deflate compression • STORE - No compression | |
CompressionLevel | 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 | |
EncryptionMethod | 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. | |
AesKeyStrength | 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 |
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 |