To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Configuration for how the record-editing UI presents a single named sales data series, such as a promotion's sales records or a recognition topic's data source. XStream-serialised as a series element inside controllers.xml alongside the account's other query configuration, and looked up by series name through Queries.findDataSeriesContent or DataSeriesManager.findDataSeriesContent. Controls the help text shown on the editor, whether unlisted custom fields are hidden, which of the tags, points and title areas are hidden, and the per-field configuration for any custom fields on the series.
Group: Queries
Properties
| Property | Returns | Description |
|---|---|---|
| fieldConfigs | List<DataSeriesFieldConfig> | The per-field configuration for this series' custom fields. |
| hidePoints | boolean | Whether the points value should be hidden on the series record-editing page. |
| hideTags | boolean | Whether the tags control should be hidden on the series record-editing page. |
| hideTitle | boolean | Whether the title field should be hidden on the series record-editing page. |
| name | String | The name of the sales data series this configuration applies to, used to look it up via findDataSeriesContent. Never null. |
| seriesHelpText | String | Help text displayed to the user on the series record-editing page. |
| showOnlyKnownFields | boolean | Whether the record-editing UI should show only the custom fields listed in getFieldConfigs, hiding any other custom field found on the series. |
Methods
findField(String name)
Returns: DataSeriesFieldConfig
Finds the field configuration for a named custom field on this series, by exact name match.
| Parameter | Description |
|---|---|
name | the name (identifier) of the field to find, such as "amount" or "my-custom-field" |
getName()
Returns: String
The name of the sales data series this configuration applies to, used to look it up via findDataSeriesContent. Never null.
getSeriesHelpText()
Returns: String
Help text displayed to the user on the series record-editing page.
isShowOnlyKnownFields()
Returns: boolean
Whether the record-editing UI should show only the custom fields listed in getFieldConfigs, hiding any other custom field found on the series.
isHidePoints()
Returns: boolean
Whether the points value should be hidden on the series record-editing page.
isHideTags()
Returns: boolean
Whether the tags control should be hidden on the series record-editing page.
isHideTitle()
Returns: boolean
Whether the title field should be hidden on the series record-editing page.
getFieldConfigs()
Returns: List<DataSeriesFieldConfig>
The per-field configuration for this series' custom fields.
© 2025 Kademi Ltd