Document toolboxDocument toolbox

CSV Parser

Description

This unit is a Processor unit type.

This unit parses events containing a correctly formatted CSV.

An event comes in through the in port and the data field content is parsed.
Successful input events are enriched with a new field containing the parse result, and the event is output through the out port.
If an error occurs, the input event is enriched with new fields describing the error and the event is output through the error port.

Configuration

After dragging this unit into the Flow canvas, double-click it to access its configuration options. The following table describes the configuration options of this unit:

TabFieldDescription

General

NameEnter a name for the unit. It must start with a letter, and cannot contain spaces. Only letters, numbers, and underscores are allowed.
In fieldThe name of the input event field containing CSV data.
SeparatorThe character delimiter to use for separating entries. The default value is ','
Quote character The character to use for quoted elements. The default value is '"'
Has headerIf set to "on", the first line of the CSV is considered as a header.
Out header fieldThe name of the output event field containing the header of the CSV. If the CSV does not have a header, this field is empty.
Out data fieldThe name of the output event field containing the result.

Input ports

PortDescription
inEvents containing a properly formatted CSV to be parsed.

Output ports


PortDescription
outOutputs events enriched with an extra field containing the parsed CSV.
error

Signals when an error occurred. Outputs input events enriched with standard error fields.