ZCompress Task

Properties Config Settings

The ZCompress task implements an LZC compressor and decompressor, compatible with the UNIX compress utility.

Remarks

The ZCompress task is used when compressing or decompressing data in the form of files.

ZCompress Assembler Task

The Assembler takes a file as input which contains raw data, and generates an LZC archive file as output.

ZCompress Disassembler Task

The Disassembler takes a zipped file as input, and generates an unzipped file as output.

Assembler Property List

The following is the full list of the properties of the assembler task with short descriptions. Click on the links for further details.


ArchiveFile	The name of the archive.
FileDecompressedName	File name to decompress to, or compress from.
LogFile	The file to write logging information to at runtime.
LogMode	What information gets logged during component execution.
Other	Defines a set of configuration settings to be used by the task.
RuntimeLicense	Specifies the component runtime license key.

Disassembler Property List

The following is the full list of the properties of the disassembler task with short descriptions. Click on the links for further details.


ArchiveFile	The name of the archive.
FileDecompressedName	File name to decompress to, or compress from.
LogFile	The file to write logging information to at runtime.
LogMode	What information gets logged during component execution.
Other	Defines a set of configuration settings to be used by the task.
RuntimeLicense	Specifies the component runtime license key.

Config Settings

The following is a list of config settings for the task with short descriptions. Click on the links for further details.

ArchiveFile Property (ZCompress Task)

The name of the archive.

Data Type

String

Default Value

Remarks

This property specifies the name of the archive to be read or written. This property is required when compressing or extracting files.

If extracting, the file specified by ArchiveFile will be opened for read. If the file does not exist, a trappable error will be generated.

During compression, the file named by ArchiveFile will be written; if a file of this name already exists, the file will be overwritten.

The filename may be specified with or without a path. Paths may be relative or absolute, and should be specified in the format native to the host operating system. The filename should be specified with the appropriate extension (such as ".Z"); an extension will not automatically be appended by the task.

FileDecompressedName Property (ZCompress Task)

File name to decompress to, or compress from.

Data Type

String

Default Value

Remarks

FileDecompressedName contains the name of the file in the archive, as stored on the file system, outside the archive.

When compressing a file, this property should be specified with a path, if necessary, to allow the file to be found by the task. If the file cannot be found when compression begins, a trappable error will be generated, and the archive will not be correctly written.

Paths on the local file system should be specified in the format native to the host operating system. They may also be specified in standard (UNIX) format, in which case they will be immediately converted.

LogFile Property (ZCompress Task)

The file to write logging information to at runtime.

Data Type

String

Default Value

Remarks

To write logging information to a file instead of using the task's logging API, set this property to a valid file on disk.

When set, any logging information is appended to the specified file and not written to the task's logging API.

LogMode Property (ZCompress Task)

What information gets logged during component execution.

Data Type

Enumeration

Possible Values

Verbose (0)
Info (1)
Warning (2)
Error (3)
Fatal (4)

Default Value

Remarks

This property controls what information the task logs. The possible values have the following affect on the task's behavior:


Verbose	The task will report all information regarding the transport.
Info	The task will report all major operations, as well as all warnings and errors.
Warning	The task will report any conditions that could result in unpredictable behavior as well as errors.
Error	The task will report all errors that prevent normal operations from completing.
Fatal	The task will report only serious errors that cause the task to completely stop functioning.

Other Property (ZCompress Task)

Defines a set of configuration settings to be used by the task.

Data Type

String

Default Value

Remarks

The task accepts one or more configuration settings. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the task, access to these internal properties is provided through the Other property.

The Other property may be set to one or more configuration settings (name/value pairs). Set one setting per line. For example: configname1=value1 configname2=value2

RuntimeLicense Property (ZCompress Task)

Specifies the component runtime license key.

Data Type

String

Default Value

Remarks

You can use the RuntimeLicense property to set the runtime key for the task license.

Config Settings (ZCompress Task)

The task accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the task, access to these internal properties is provided through the Other property.