Skip to main content
Version: V3 (Ignition 8.3)

tamaki.mes.utils.datasetsToZip

Description​

Zips multiple datasets into a single ZIP archive returned as a byte array. Each dataset is written as a CSV entry whose file name comes from the corresponding element of fileNames. The two lists are paired by position, so fileNames and datasets should be the same length.

Syntax​

tamaki.mes.utils.datasetsToZip(fileNames, datasets)

Parameters​

ParameterTypeNullableDescription
fileNamesListFalseA list of file names (Strings), one per dataset (for example "locations.csv").
datasetsListFalseA list of Datasets to write as CSV entries, paired with fileNames by position.

Returns​

A byte[] containing the ZIP archive.

Code Examples​

# Zip a set of result datasets and download them (from the backup-compare results view)
results = self.view.custom.resultDatasets
fileNames = [str(name) + ".csv" for name in results]
datasets = [dataset for name, dataset in results.items()]
byteArray = tamaki.mes.utils.datasetsToZip(fileNames, datasets)
date = system.date.format(system.date.now())
system.perspective.download(filename="Backup-Compare-Results-{}.zip".format(date), data=byteArray)