To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Pipeline step that inserts, updates or upserts an incoming row as a sales data record in a configured series. Each row must supply an amount, an "attributed to" value (an organisation ID for an org-scoped series, or an email or user ID for a profile-scoped series), a from date, and a to date (defaulting to the from date for a single point in time), plus any extra fields defined on the data series. The columns list maps these field names onto column positions in the incoming row. Behaviour is controlled by mode: insert always creates a new record, update only updates an existing matching record (and does nothing if none is found), and updateOrInsert does whichever applies. Configured in pipeline XML as SalesDataInserter.
Implements: PipelineStep
Properties
| Property | Returns | Description |
|---|---|---|
| columns | List<Column> | Column mappings configured for this step, mapping standard field names (amount, attributedTo, fromDate, toDate) and any extra series fields onto positions in the incoming row. |
| description | String | Short, human-readable description of this step shown to administrators managing a pipeline. |
| disabled | boolean | Whether this step is switched off. When true, exec returns immediately without inserting or updating any sales data records, though rows still pass through to the next step. |
| extraFieldNames | List<String> | |
| formPath | String | Path to the velocity template that renders this step's management UI form. |
| ignoreEvents | boolean | Whether inserting a new sales data record should suppress the platform events that would normally fire for it (only applies in insert mode). |
| ignoreMissingEntity | boolean | Whether a row whose attributed-to value does not resolve to an existing profile or organisation is quietly skipped, rather than raising a pipeline warning. |
| logInserts | boolean | Whether each inserted record is recorded as an informational message on the pipeline's execution log. |
| logUpdates | boolean | Whether each updated record is recorded as an informational message on the pipeline's execution log. |
| mode | String | Which operation this step performs against the sales data series for each row: insert (the default, always creates a new record), update (only updates an existing matching record, and does nothing if none is found), or updateOrInsert (updates a matching record if one exists, otherwise creates one). |
| nextStep | PipelineStep | The single step that follows this one in the pipeline, or null if none has been configured. |
| seriesName | String | Name of the sales data series this step writes records into, looked up within the pipeline's organisation. |
Methods
getFormPath() · getDescription() · getSeriesName() · getColumns() · getMode() · isIgnoreMissingEntity() · isDisabled() · isIgnoreEvents() · isLogInserts() · isLogUpdates() · getNextStep()
getFormPath()
Returns: String
Path to the velocity template that renders this step's management UI form.
getDescription()
Returns: String
Short, human-readable description of this step shown to administrators managing a pipeline.
getSeriesName()
Returns: String
Name of the sales data series this step writes records into, looked up within the pipeline's organisation.
getColumns()
Returns: List<Column>
Column mappings configured for this step, mapping standard field names (amount, attributedTo, fromDate, toDate) and any extra series fields onto positions in the incoming row.
getMode()
Returns: String
Which operation this step performs against the sales data series for each row: insert (the default, always creates a new record), update (only updates an existing matching record, and does nothing if none is found), or updateOrInsert (updates a matching record if one exists, otherwise creates one).
isIgnoreMissingEntity()
Returns: boolean
Whether a row whose attributed-to value does not resolve to an existing profile or organisation is quietly skipped, rather than raising a pipeline warning.
isDisabled()
Returns: boolean
Whether this step is switched off. When true, exec returns immediately without inserting or updating any sales data records, though rows still pass through to the next step.
isIgnoreEvents()
Returns: boolean
Whether inserting a new sales data record should suppress the platform events that would normally fire for it (only applies in insert mode).
isLogInserts()
Returns: boolean
Whether each inserted record is recorded as an informational message on the pipeline's execution log.
isLogUpdates()
Returns: boolean
Whether each updated record is recorded as an informational message on the pipeline's execution log.
getNextStep()
Returns: PipelineStep
The single step that follows this one in the pipeline, or null if none has been configured.
© 2025 Kademi Ltd