To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Parses an incoming CSV file into rows and feeds them to the next pipeline step, one row at a time or all together as a list. Reads the input stream from the previous step using a configurable separator, quote and escape character and charset, optionally skipping a number of header rows and capping the number of rows read. Rows that have a blank value in any of the configured skipIfBlankColumns are skipped and reported to the pipeline as an informational message rather than being passed on.
Implements: PipelineStep
Properties
| Property | Returns | Description |
|---|---|---|
| charsetName | String | Name of the character set used to decode the incoming CSV stream, or null to use the JVM's default charset. |
| clearSession | Boolean | Whether the pipeline's session is cleared periodically while reading, done every 100 rows to keep memory usage down on large files. |
| description | String | Human-readable summary of this step, shown to administrators managing the pipeline. |
| disabled | boolean | Whether this step is disabled, in which case it does nothing when executed. Useful for temporarily turning off a step while debugging a pipeline. |
| escapeChar | String | Escape character used to parse the CSV, or null to use the default escape character. |
| formPath | String | Path to the Velocity template used by the pipeline management UI to edit this step's configuration. |
| maxRows | Integer | Maximum number of data rows to read before stopping, or null for no limit. |
| next | PipelineStep | The single next step that parsed rows are passed to. |
| nextStep | PipelineStep | The single next step that parsed rows are passed to. Equivalent to getNext. |
| passAsList | Boolean | If true, all data rows are read into a list and passed to the next step in a single execution, instead of calling the next step once per row. |
| passAsList | boolean | |
| quoteChar | String | Quote character used to parse the CSV, or null to use the default quote character. An empty string disables quoting. |
| separator | String | Field separator character used to parse the CSV, or null to use the default separator. |
| skipIfBlankColumns | List<Integer> | Zero-indexed column numbers that, if blank in a row, cause that row to be skipped rather than passed to the next step. |
| startRow | int | Zero-indexed number of leading rows to skip before parsing begins, typically used to skip a header row. |
Methods
getFormPath() · getDescription() · getClearSession() · isDisabled() · getMaxRows() · getSeparator() · getQuoteChar() · getEscapeChar() · getCharsetName() · getPassAsList() · getNext() · getNextStep() · getSkipIfBlankColumns() · getStartRow()
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.
getClearSession()
Returns: Boolean
Whether the pipeline's session is cleared periodically while reading, done every 100 rows to keep memory usage down on large files.
isDisabled()
Returns: boolean
Whether this step is disabled, in which case it does nothing when executed. Useful for temporarily turning off a step while debugging a pipeline.
getMaxRows()
Returns: Integer
Maximum number of data rows to read before stopping, or null for no limit.
getSeparator()
Returns: String
Field separator character used to parse the CSV, or null to use the default separator.
getQuoteChar()
Returns: String
Quote character used to parse the CSV, or null to use the default quote character. An empty string disables quoting.
getEscapeChar()
Returns: String
Escape character used to parse the CSV, or null to use the default escape character.
getCharsetName()
Returns: String
Name of the character set used to decode the incoming CSV stream, or null to use the JVM's default charset.
getPassAsList()
Returns: Boolean
If true, all data rows are read into a list and passed to the next step in a single execution, instead of calling the next step once per row.
getNext()
Returns: PipelineStep
The single next step that parsed rows are passed to.
getNextStep()
Returns: PipelineStep
The single next step that parsed rows are passed to. Equivalent to getNext.
getSkipIfBlankColumns()
Returns: List<Integer>
Zero-indexed column numbers that, if blank in a row, cause that row to be skipped rather than passed to the next step.
getStartRow()
Returns: int
Zero-indexed number of leading rows to skip before parsing begins, typically used to skip a header row.
© 2025 Kademi Ltd