Gzip Task

Properties   Config Settings  

The GZIP task implements a gzip compressor and decompressor, compliant to RFC 1952 and compatible with the UNIX gzip and gunzip utilities.

Remarks

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

GZIP Assembler/Encoder Task

The Assembler/Encoder takes a group of files as input which contains raw data, and generates a GZIP archive file as output.

Compression strength is regulated by the CompressionLevel property.

GZIP Disassembler/Decoder Task

The Disassembler/Decoder takes a zipped file as input, and generates a group of unzipped files 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.

Append	Append files to the specified archive.
ArchiveFile	The name of the gzip archive.
CompressionLevel	The compression level to use.
FileCompressedName	Filename, as stored inside 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 gzip archive.
ExtractToPath	A base path to decompress to.
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.

SuggestCompressedName	Whether to suggest a file name.

Append Property (Gzip Task)

Append files to the specified archive.

Data Type

Boolean

Default Value

false

Remarks

During compression, the file specified by the FileDecompressedName property will be appended to the ArchiveFile.

This property is not available in the Disassembler/Decoder.

ArchiveFile Property (Gzip Task)

The name of the gzip 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 scanning or 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 "zip"); an extension will not automatically be appended by the task.

CompressionLevel Property (Gzip Task)

The compression level to use.

Data Type

Integer

Default Value

4

Remarks

This property specifies the level of compression to be used, between 1 and 6. Higher values will cause the task to compress better; lower values will cause the task to compress faster.

Storing without compression is not supported for Gzip.

This property is not available in the Disassembler/Decoder.

ExtractToPath Property (Gzip Task)

A base path to decompress to.

Data Type

String

Default Value

""

Remarks

Setting this property to a nonempty string will cause all decompressed files to be written to the specified path.

If the specified directory does not exist, it will be created when extraction is done.

ExtractToPath should always be specified in the format native to the host operating system, and with a trailing slash or backslash. If the path is specified otherwise, it will be immediately converted and stored in the converted format. For example, "/temp" would be immediately converted to "\temp\" on a Windows system.

This property is not available in the Assembler/Encoder.

FileCompressedName Property (Gzip Task)

Filename, as stored inside of the archive.

Data Type

String

Default Value

""

Remarks

FileCompressedName contains the name of the compressed file, as stored within the gzip header.

This field should generally be set with a relative path or with no path at all. The exact interpretation of the path is left to the decompression software; generally, pathnames will be interpreted as relative to a base directory, and these subdirectories will be created as needed. Absolute pathnames will not be interpreted correctly by the task, and may or may not be interpreted correctly by other decompression software.

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

It is not usually necessary to manually set the value of this property; it will be assigned by the task when compressing if it is not specified.

This property is not available in the Disassembler/Decoder.

FileDecompressedName Property (Gzip 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. Note: When extracting an archive if FileDecompressedName is specified, only the first file in the archive will be extracted.

LogFile Property (Gzip 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 (Gzip 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

3

Remarks

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

Other Property (Gzip 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 (Gzip 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 (Gzip 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.

GZip Config Settings