Files¶

Compression¶

Packs attachments into a ZIP archive and unpacks ZIP archives into items or attachments; compresses and decompresses single attachments with GZip.

Inputs: main · Outputs: main

Parameter	Type	Description
Operation `operation`	one of: `zip`, `unzip`, `gzip`, `gunzip`	Default: `zip`.
Binary properties `binaryProperty`	text	Zip: attachments to pack, separated by commas; empty packs all. Unzip, GZip, GUnzip: the attachment to read.
Zip `scope`	one of: `eachItem`, `allItems`	One archive per item, or one of all items. Default: `eachItem`.
Archive name `fileName`	text	Zip: file name of the archive. Supports expressions.
Unzip into `output`	one of: `itemPerEntry`, `attachments`	One item per entry, or all entries as attachments of the input item. Default: `itemPerEntry`.
Max size (MB) `maxMegabytes`	integer	Unzip, GUnzip: stop when the unpacked content gets larger, against archives that unpack to huge sizes. Default: `500`.
Output property `outputProperty`	text	Zip, GZip, GUnzip: attachment for the result.

Convert to File¶

Turns items into a file attachment, e.g. to send it by mail, upload it or save it with Write File: CSV, JSON, XML, text, and Excel with the Office plugin.

Inputs: main · Outputs: main

Parameter	Type	Description
Format (required) `format`	text	Format of the file. Excel needs the Office plugin.
Files `mode`	one of: `allItems`, `eachItem`	All items into one file, or one file per item (JSON, XML, Text). CSV and Excel always make one file. Default: `allItems`.
File name `fileName`	text	Name of the file; empty: data plus the format's extension. One file of all items uses the first item for expressions. Supports expressions.
Binary property `binaryProperty`	text	Attachment to write.
Header row `header`	true/false	CSV, Excel: write the column names as the first row. Default: `true`.
Delimiter `delimiter`	text	CSV: e.g. , or ; or \t.
Encoding `encoding`	text	CSV, JSON, XML, Text: e.g. utf-8, windows-1252, iso-8859-1, utf-16.
Sheet `sheet`	text	Excel: name of the sheet. Supports expressions.
Sheet per field `sheetPerField`	text	Excel: one sheet per value of this field, e.g. region.
Root element `rootElement`	text	XML: name of the root element; for one file per item, the element of the item. Supports expressions.
Item element `itemElement`	text	XML, all items into one file: the element of each item.
Text field `textField`	text	Text: the field of the items to write, one item per line.

Extract from File¶

Turns an attachment (a file from a webhook, a mail, an HTTP response, Read File) into items: CSV, JSON, XML, text, and Excel with the Office plugin. Runs once per input item.

Inputs: main · Outputs: main

Parameter	Type	Description
Format (required) `format`	text	Format of the file. Excel needs the Office plugin.
Binary property `binaryProperty`	text	Attachment to read.
Output `output`	one of: `items`, `field`	Items: one item per row or object. Field: the input item with all of them in one field. Default: `items`.
Field `field`	text	Output 'Field': name of the field.
Header row `header`	true/false	CSV, Excel: the first row holds the column names; otherwise the columns are column1, column2, …. Default: `true`.
Delimiter `delimiter`	text	CSV: e.g. , or ; or \t; empty detects it from the first row.
Encoding `encoding`	text	CSV, JSON, XML, Text: e.g. utf-8, windows-1252, iso-8859-1, utf-16; a byte order mark wins.
Sheet `sheet`	text	Excel: name of the sheet to read. Supports expressions.
Item element `itemElement`	text	XML: every element of this name becomes an item, e.g. order.
Always array `alwaysArray`	text	XML: element names, separated by commas, read as arrays even when they occur once.

Read File¶

Reads files from a folder released by the host, as binary, text, JSON or CSV. Runs once per input item.

Inputs: main · Outputs: main

Parameter	Type	Description
Folder (required) `folder`	text	Name of a folder released by the host.
Path (required) `path`	text	Relative to the folder; * and ? are allowed in the file name. Supports expressions.
Read as `format`	one of: `binary`, `text`, `json`, `csv`	Default: `binary`.
Include subfolders `includeSubfolders`	true/false	With wildcards: search below the path's folder too. Default: `false`.
CSV delimiter `csvDelimiter`	text	e.g. , or ; or \t.
Binary property `binaryProperty`	text	Name of the attachment (binary format).

Write File¶

Writes attachments or text (one file per item), or all items as JSON or CSV (one file), into a folder released by the host.

Inputs: main · Outputs: main

Parameter	Type	Description
Folder (required) `folder`	text	Name of a folder released by the host.
Path (required) `path`	text	Relative to the folder; missing subfolders are created. Supports expressions.
Write `content`	one of: `binary`, `text`, `itemsAsJson`, `itemsAsCsv`	Default: `binary`.
Binary property `binaryProperty`	text	Attachment to write (binary).
Text `text`	text	Content to write (text). Supports expressions.
If the file exists `ifExists`	one of: `overwrite`, `append`, `fail`	Append adds CSV rows without a header; it isn't possible for JSON. Default: `overwrite`.
CSV delimiter `csvDelimiter`	text	e.g. , or ; or \t.