‘Add user to group….’ script has different field input for the two triggers

[simon]

Looking at the “Add user to group through User Custom Field” script, there seems to be a bit of an issue. If the “User first logged in” trigger is selected, the “User Custom Field name” input should be set to the name of the User Field, for example “Native Language.” But if the “Recurring” trigger is selected, the “User Custom Field name” input needs to be set based on the User Field’s id. For example “user_field_5”.

Details about how to find the name for when the Recurring trigger is used are here: Finding Userfield Custom Name for 'Add user to group through User Custom Field' - #2 by leonardo.

Ideally, the friendly name (for example “Native Language”) would be used as the correct value for both of the available triggers. The relevant code is here: https://github.com/discourse/discourse-automation/blob/main/lib/discourse_automation/scripts/add_user_to_group_through_custom_field.rb. The way that the “User first logged in” trigger finds the correct User Custom Field from the field name (instead of the id) is here:

https://github.com/discourse/discourse-automation/blob/main/lib/discourse_automation/scripts/add_user_to_group_through_custom_field.rb#L54-L67

Maybe there’s a backwards compatible way that logic could be applied to the Recurring trigger.

[JammyDodger]

Just to note, this is mentioned in the walkthrough:

'Add user to group through custom field' Automation

Here’s a quick walkthrough of how to set up an Automation using the Add user to group through custom field option to automatically add people to groups depending on the User Custom Field they select at signup (or whenever they fill it out, depending on how you set your user custom field up): Create the groups: [create the groups] The Automation script uses a group’s Full Name, so make sure you add one. Create the User Custom Field: [example user custom field] …

I’ve mentioned about reworking the script for consistency, though it’s not been prioritised yet. There’s also the public user custom fields and staff user custom fields admin settings that would be nice to bring into line with it as well.

(And there’s also poll groupable user fields too, which uses the ‘friendly name’)

[simon]

Here’s a PR to fix the issue:

FEATURE: allow User Custom Field input field to accept the UserField name

[JammyDodger]

This has now been resolved with a new dropdown to select your existing User Custom Fields from, which works for both triggers:

UX: introduce custom field component (#229)