Defines one custom field computed onto a reward's point statements, evaluated when a statement is generated. Its func is executed as a JavaScript query against the profile or organisation the statement is for, and the result is stored on the statement under name - a numeric field if name starts with "num", or a text field if it starts with "text". Configured as a field element within the pointStatement document.

Group: Rewards


Properties

PropertyReturnsDescription
descriptionStringLonger explanation of what this field represents, shown alongside its title.
funcStringJavaScript query executed against the profile or organisation to compute this field's value.
nameStringName the computed value is stored under on the point statement. Its prefix determines how the result is stored: "num" for a numeric field, "text" for a text field.
titleStringDisplay label for this field, shown to the user viewing the point statement.

Methods

getName()

Returns: String

Name the computed value is stored under on the point statement. Its prefix determines how the result is stored: "num" for a numeric field, "text" for a text field.

getFunc()

Returns: String

JavaScript query executed against the profile or organisation to compute this field's value.

getTitle()

Returns: String

Display label for this field, shown to the user viewing the point statement.

getDescription()

Returns: String

Longer explanation of what this field represents, shown alongside its title.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.