CSV Renderer
Description
A renderer that creates CSV output.
May be used by
Properties
Header Names (
headerNames) Description
Defines the header line of the CSV. Each of the Strings is used as the header for column at its position in the List. This list may be empty, if no header is to be written.
Attributes
String-List
Optional
Data Column Names (
dataColumnNames) Description
Defines the column names of the data to be written to the CSV. The columns are written in the order they have in this list. Columns that are in the data, but not defined here, will not be written.
Attributes
String-List
Mandatory
Charset (
charset) Description
Defines the character set to use when creating the CSV output.
Attributes
String
Optional
Default value
UTF-8
Allowed values
UTF-8, ISO-8859-1, UTF-16, UTF-16BE, UTF-16LE, US-ASCII, ISO-8859-15
Field Delimiter (
fieldDelimiter) Description
This property specifies the separation character used in the generated CSV output in order to separate fields from each other. Usually, a comma is used but, e.g., Excel requires this to be a semicolon. To use the generated file with Excel, use a semicolon, to use it with most other programs, use a comma.
If the field delimiter is a valid character in one of the exported fields, then a text delimiter has to configured! Lack of doing so might result in erroneous CSV output.
Attributes
String
Optional
Default value
,
Suggested values
,, ;, :, |
Text Delimiter (
textDelimiter) Description
Specifies the character used to enclose the text of a single field. Such a delimiter is required if the field delimiter character is allowed to be used inside the field texts.
Attributes
String
Optional
Suggested values
", '
YAML Template (with default values)
type: CsvRenderer
id: CsvRenderer-xxxxxx
displayName:
comment:
properties:
charset: UTF-8
dataColumnNames:
fieldDelimiter: ,
headerNames:
textDelimiter: