[Core] Promotion Points

[mous13]

What problem would you like to solve?
Invision Community's perscom plugin had promotion points which let you assign point requirements for promotions. When .io released, it didn't come with promotion points.

The idea is to recreate the promotion points system that was loved in the invision community plugin and modernising it.

Promotion Points Ledger
A single unified ledger interface (page on admin) where admins can configure what record entities can increase/decrease points and how much (using forumify settings).

A new entity called point transactions will be created with the following properties:

• created_at
• perscom_user_id
• points
• record
• description

The record property would be to define where it came from so if we were to have a transaction log for users to see, then they'd know where it came from. It would be nullable so in case admins want to +/- points from a user manually due to rule breaking or some other reason then they can explain that in the description property.

Additional context

Points decay would be a neat feature to include. Admins could set a decay criteria such as if user has not received a record for award, qualification, or combat for x days, decay points by x.

[jannes-io]

where admins can configure what record entities can increase/decrease points and how much (using forumify settings).

This should just be configuration on the entity forms themselves, like award form, qualification form, operation form (for combat records), (idk what else can give points?).

The ledger is the actual list of transactions.

The record property would be to define where it came from

You'd need to keep 2 separate fields, RecordClass and RecordId.

RecordClass would be the fully qualified classname so you can later get the original repository through entity manager, but on the table you can use a custom renderer to chop off the first part of the classname.

Are we going to have to make some functionality to "recalculate" someone's/or everyones promotion points? Say the admin changes the amount of PP an award gives, now everyone that's already been awarded those points will have to get their points recalculated and a new entry added to the ledger with the difference between current PP and new PP as a correction?

[mous13]

Sounds good, so each point giving entity will receive a points property to define the number of points it can award (-/+). Then the points_ledger entity will have two separate fields RecordClass and RecordId.

Are we going to have to make some functionality to "recalculate" someone's/or everyones promotion points? Say the admin changes the amount of PP an award gives, now everyone that's already been awarded those points will have to get their points recalculated and a new entry added to the ledger with the difference between current PP and new PP as a correction?

I definitely think we can look into this but make it optional. Using forumify platform's settingRepository to define perscom.points.recalculation.

1 = Recalculate everyone's PP based on the changes.
2 = Don't recalculate.

Easier way to do this is to query the ledger for any entries with the appropriate RecordClass that has had an adjustment, then modify the entry to store the new point value. But if you think showing a new entry with the difference between current PP and new PP as a correction then we can try that way.

[jannes-io]

Easier way to do this is to query the ledger for any entries with the appropriate RecordClass that has had an adjustment, then modify the entry to store the new point value. But if you think showing a new entry with the difference between current PP and new PP as a correction then we can try that way.

The point of a ledger is that each entry is immutable, the only thing that can change the total is new entries into the ledger.

I think the implementation can be done in a smart way, for example, if an award has its PP value changed from 5 to 10, that's a +5, so then query all the award records, and for each recipient add "times received * value diff" correction record. In this case, if the user received the award 4 times, it'd be a correction record of 20 (4 * 5).