Import-pipeline table provider that awards Points against a Reward (points bucket) as an import pipeline runs. Registered under the provider id "points". Each row awards points to a profile or an organisation, depending on the target reward's points type, and records which reward and target were touched so that finished can recalculate their points balances once the pipeline completes. Only insert is supported; update, delete and updateOrInsert are not implemented and throw UnsupportedOperationException.

Implements: DatabaseTableProvider


Properties

PropertyReturnsDescription
providerIdStringProvider id this class is registered under. Used to select it from a DatabaseUpdateStep or DatabaseSourceStep configuration.
queryParametersList<TableParameter>Query parameters this provider accepts when building its source criteria: startDate and finishDate, both required, which bound the issuedDate (or the expiryDate, when filtering on expired points) of the points returned.
tableFieldsList<TableParameter>Describes the row columns this provider accepts for insert: pointsBucketName (required, the name of the Reward, i.e. points bucket, to award points from), awardTo (required, the profile or organisation identifier to award the points to), reason, pointsTag (the name of an existing points tag to record against the award), amount and issuedDate.

Methods

getProviderId()

Returns: String

Provider id this class is registered under. Used to select it from a DatabaseUpdateStep or DatabaseSourceStep configuration.

getQueryParameters()

Returns: List<TableParameter>

Query parameters this provider accepts when building its source criteria: startDate and finishDate, both required, which bound the issuedDate (or the expiryDate, when filtering on expired points) of the points returned.

getTableFields()

Returns: List<TableParameter>

Describes the row columns this provider accepts for insert: pointsBucketName (required, the name of the Reward, i.e. points bucket, to award points from), awardTo (required, the profile or organisation identifier to award the points to), reason, pointsTag (the name of an existing points tag to record against the award), amount and issuedDate.

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