To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Configuration for a single custom field on a sales data series record-editing form, one entry within a DataSeriesContent's field list. XStream-serialised as a datafield element. Controls the field's label and help text, whether it is hidden or required, and offers an options map so a select box can be shown when there are choices to make.
Group: Queries
Properties
| Property | Returns | Description |
|---|---|---|
| helpText | String | Help text displayed alongside this field on the record-editing form. |
| hidden | boolean | Whether this field should be hidden on the record-editing form. |
| label | String | The display label shown for this field on the record-editing form. |
| name | String | The name (identifier) of the custom field this configuration applies to, such as "amount" or "salesTeam". |
| options | Map<String,String> | The selectable values for this field, as a map of value to display label. When present, the field is rendered as a select box instead of a free text input. |
| required | boolean | Whether this field is mandatory on the record-editing form, overriding its normal default. |
Methods
getName()
Returns: String
The name (identifier) of the custom field this configuration applies to, such as "amount" or "salesTeam".
isHidden()
Returns: boolean
Whether this field should be hidden on the record-editing form.
getLabel()
Returns: String
The display label shown for this field on the record-editing form.
getHelpText()
Returns: String
Help text displayed alongside this field on the record-editing form.
isRequired()
Returns: boolean
Whether this field is mandatory on the record-editing form, overriding its normal default.
getOptions()
Returns: Map<String,String>
The selectable values for this field, as a map of value to display label. When present, the field is rendered as a select box instead of a free text input.
© 2025 Kademi Ltd