Grant Custom Badge Upon Reading ToS

[TempAccount]

Continuing the discussion from How does the reader / read guideline badges work?:

How would someone repurpose this for a custom badge, where the user will be automatically awarded upon reading the terms?

---

Resource found:

This for the “read guidelines” badge:

The default badge queries

This is a reference guide for the SQL queries of the default badges, and their trigger information (where available). Core Badges Anniversary (This one has some extra backend magic in to choose the dates, but I’ll include it anyway) start_date = start_date.iso8601(6) end_date = end_date.iso8601(6) SELECT u.id FROM users AS u JOIN posts AS p ON p.user_id = u.id JOIN topics AS t ON p.topic_id = t.id WHERE u.id > 0 AND u.acti…

and also this… although I don’t know where to insert the SQL for the badge:

Badge for reading a topic?

I think this should be possible with something like: SELECT user_id, CURRENT_TIMESTAMP AS granted_at FROM topic_users WHERE topic_id = 281534 AND total_msecs_viewed/60000 >= 5 -- min number of minutes viewed

…as well as the underlying question if /tos is considered a topic if users can only see it from the view of the tabs:

[NateDhaliwal]

@TempAccount

I don’t know where to insert the SQL for the badge

Does this help?

Creating triggered custom badge queries

This guide explains how to create triggered custom badge queries in Discourse, including the types of badges, constraints for triggered badges, and an example query. Required user level: Administrator This feature is disabled by default. To enable it, follow this guide. When defining badges in Discourse, you’ll encounter a “Trigger” option with the following choices: Update daily When a user acts on a post When a user edits or creates a post Wh…

[TempAccount]

Ooh, looks like it will help/or guide me in the correct direction!
Thanks!

[JammyDodger]

I’m not sure it’s possible to link a similar one up to the ToS instead in the same way. The Read Guidelines one relies on the read_faq being recorded in the user_stats table and there isn’t currently a mechanism to do the same for the ToS.

As the user viewable version isn’t the actual topic, I don’t think viewing that page is recorded anywhere (like topic_views etc).

[TempAccount]

Is it possible to alter the database/tables to include a new read_tos?

---

There is potentially an ugly workaround…
…publishing a topic as a published page instead of using the seamless integration like FAQ and About. I don’t know if this will actually work…

Testing and findings:

• The SQL query returns users that have read the topic and thereby should be awarded the badge, but i have not received that notification.

• I can confirm that visits to /pub/slug without visiting the topic directly will update the view count of the topic… however even with an absurdly low read time, the badge hasn’t been granted automatically.

• It’s also to note that the topic itself still indicates as new and unread to the user.

• …

• Further isolation testing results in that the SQL query implies users must visit the topic directly to be considered having read the topic. I cannot confirm nor deny, as badge has not been awarded, but is most plausible.

When does the “update daily” trigger run?

[Heliosurge (Dan DeMontmorency)]

Do you know off hand what the team did when they updated the ToS where we had to confirm we reviewed it? While not a badge was this maybe the Policy plugin?

[JammyDodger]

@TempAccount

When does the “update daily” trigger run?

You can speed this bit up by manually triggering jobs::BadgeGrant from your /sidekiq/scheduler page (for those with access). Mine ran 3 hours ago, but it will differ from site to site.

If you didn’t mind just having them in a regular old topic you could create a new one and add the link to it to your tos url admin setting so it shows up in the tabs still. You could then grant a badge quite easily based on people viewing that topic (though your experiments with published pages may also bear fruit as well )

I think to do it the same as the Read Guidelines one you’d need to create a plugin to replicate the behaviour for the ToS (not my forte though, so take that with a pinch of salt )

@Heliosurge

Do you know off hand what the team did when they updated the ToS where we had to confirm we reviewed it? While not a badge was this maybe the Policy plugin?

This is a required custom field, which I think works out quite nicely for that. Though you only say you’ve read them rather than actually reading them, so it may depend on what the main thrust of granting the badge is for.

[TempAccount]

@JammyDodger

If you didn’t mind just having them in a regular old topic you could create a new one and add the link to it to your tos url admin setting so it shows up in the tabs still. You could then grant a badge quite easily based on people viewing that topic

Wait this is actually smart!

You could then also close and unlist the topic so it cannot be replied to and must be accessed by direct link.

@JammyDodger

(though your experiments with published pages may also bear fruit as well )

Unfortunately, that wouldn’t be working as straightforward as the above.