Writes incoming rows to the pipeline's output stream as CSV, for use as the final step in a pipeline whose output is downloaded or emailed to a user. Each execution receives either a list of values or a variable-length array of arguments and writes them as one CSV line, using a configurable separator, quote and escape character. Optionally writes a header row of configured column names before the first data row.

Implements: PipelineStep

Properties

Methods

getFormPath()

Returns: String

Path to the Velocity template used by the pipeline management UI to edit this step's configuration.

getDescription()

Returns: String

Human-readable summary of this step, shown to administrators managing the pipeline.

isWriteHeaderRow()

Returns: boolean

Whether a header row of the configured column names is written before the first data row.

getColumnNames()

Returns: List<String>

Column names written as the header row when writeHeaderRow is true.

getSeparator()

Returns: String

Field separator character used to write the CSV, or null to use the default separator.

getQuoteChar()

Returns: String

Quote character used to write the CSV, or null to use the default quote character. An empty string disables quoting.

getEscapeChar()

Returns: String

Escape character used to write the CSV, or null to use the default escape character.