Использование новой автоматизации обновлений пользователей

[Discourse]

Это руководство объясняет, как использовать новый триггер обновления пользователя в плагине Discourse Automation для создания постов при обновлении пользователями своих профилей.

Требуемый уровень пользователя: Администратор

Плагин Discourse Automation включает триггер для скрипта создания постов. Этот триггер позволяет автоматически создавать посты в указанной теме, когда пользователь обновляет свой профиль, при условии выполнения определенных условий.

Настройка автоматизации

1. Перейдите в example.discourse.com/admin/plugins/automation в вашем экземпляре Discourse.
2. Нажмите на «Новая автоматизация».
3. Выберите «Создать пост» в качестве скрипта.
4. Выберите «После обновления пользователя» в качестве триггера.

Параметры конфигурации

Пользовательские поля и поля профиля пользователя

Укажите, какие поля должны быть заполнены пользователем перед запуском скрипта после обновления профиля. Вы можете выбрать пользовательские поля, поля профиля или оба типа.

Примечание: Должно быть указано хотя бы одно из полей: «Пользовательские поля» или «Поля профиля пользователя». Автоматизация сработает только после того, как пользователь заполнит все указанные поля.

Один раз на пользователя

Включите эту опцию, чтобы ограничить автоматизацию срабатыванием только один раз для каждого пользователя. После того как автоматизация сработала для конкретного пользователя, она не сработает снова для этого пользователя при последующих обновлениях профиля.

Только новые пользователи

Включите эту опцию, чтобы ограничить автоматизацию срабатыванием только для пользователей, которые присоединились после включения автоматизации. Это полезно для рабочих процессов приветствия/введения, когда вы не хотите, чтобы существующие пользователи запускали автоматизацию.

Создатель

Вы можете выбрать, кто будет создавать пост:

• Конкретный пользователь
• Системный пользователь (по умолчанию, если создатель не указан)
• Пользователь, запустивший автоматизацию (т. е. пользователь, обновивший свой профиль)

Использование плейсхолдеров

Вы можете использовать плейсхолдеры в содержимом поста для включения информации из профиля пользователя. Доступны следующие встроенные плейсхолдеры:

• %%USERNAME%% — имя пользователя, обновившего свой профиль
• %%NAME%% — полное имя пользователя, обновившего свой профиль
• %%UPDATED_USER_USERNAME%% — то же, что и %%USERNAME%%
• %%UPDATED_USER_NAME%% — то же, что и %%NAME%%
• %%CREATOR_USERNAME%% — имя пользователя-создателя поста

Кроме того, любые поля профиля пользователя или пользовательские поля, указанные в конфигурации триггера, становятся доступными в качестве плейсхолдеров. Например, если указано поле профиля «location», становится доступным плейсхолдер %%LOCATION%%. Имена пользовательских полей преобразуются в верхний регистр, а пробелы заменяются на подчеркивания.

Вот пример:

Добро пожаловать в наше сообщество, @%%USERNAME%%!

Мы рады, что вы присоединились к нам из %%LOCATION%%.
Расскажите нам больше о вашем интересе к %%CUSTOM_FIELD_1%%!

Примечание: Плейсхолдеры должны быть написаны заглавными буквами и окружены %%. Любой плейсхолдер, который не требуется в полях «Пользовательские поля» или «Поля профиля пользователя» триггера, может не быть заменен, если пользователь не заполнил эту информацию.

Тестирование автоматизации

Вы можете протестировать автоматизацию, используя свой собственный профиль:

1. Настройте автоматизацию, как описано выше.
2. Обновите свой профиль пользователя, заполнив указанные в триггере поля.
3. Сохраните изменения профиля.
4. Проверьте указанную тему, чтобы убедиться, что автоматический пост был создан.

Помните, что действие запускается при сохранении профиля пользователем, но выполняется только при соответствии условиям триггера, которые вы установили.

Устранение неполадок

Если вы столкнулись с проблемами:

1. Убедитесь, что хотя бы одно из полей «Пользовательские поля» или «Поля профиля пользователя» настроено в триггере — оба не могут быть оставлены пустыми.
2. Перепроверьте, что имена полей в вашей конфигурации точно совпадают с пользовательскими полями или полями профиля, определенными в вашем экземпляре Discourse.
3. Убедитесь, что плейсхолдеры в содержимом вашего поста определены правильно и соответствуют ожидаемому формату (например, %%LOCATION%% для поля профиля «location»).
4. Если используется опция «Один раз на пользователя», имейте в виду, что автоматизация отслеживает пользователей, которые уже её запустили. Пользователь, который уже запустил автоматизацию, не запустит её снова.
5. Если используется опция «Только новые пользователи», убедитесь, что учетная запись пользователя была создана после включения автоматизации.

Дополнительные соображения

• Производительность: Если у вас большое количество пользователей с частыми обновлениями профиля, отслеживайте ресурсы системы, чтобы убедиться, что автоматизация не влияет на производительность.
• Права доступа пользователей: Убедитесь, что автоматизация использует учетную запись с достаточными привилегиями для создания постов в указанной теме.
• Закрытые/архивированные темы: Автоматизация не создаст посты в темах, которые закрыты или архивированы.

[Seth_Godin]

Извините, что задаю вопрос новичка, но не могли бы вы дать немного контекста? У меня в панели управления включена автоматизация. Но как её установить и где её найти?

спасибо

[JammyDodger]

Страницу автоматизации можно найти по адресу /admin/plugins/discourse-automation

Она должна быть в дополнительном меню здесь (простите за скриншот с телефона ):

Оттуда вы создадите новую автоматизацию, и, как я понимаю, этот новый триггер предназначен для скрипта «Создать пост».

После создания и выбора триггера «после обновления пользователя» появятся все дополнительные параметры, чтобы соответствовать скриншоту в первом сообщении.

[Seth_Godin]

Спасибо, @JammyDodger!

Скриншот, показывающий, где спрятана функция создания новой автоматизации, очень помог, спасибо.

Я продвинулся почти до конца, но получил ошибку, которую трудно разобрать:

[JammyDodger]

Я думаю, что речь идет об опции «поля профиля пользователя». Похоже, что это тоже обязательное поле.

Возможно, должно быть так, что либо пользовательское поле, либо поле профиля должно быть обязательным.

Этот вопрос, возможно, лучше задать @Juan_David_Martínez

[sam (Sam Saffron)]

Я знаю, что последнее, чего вы могли ожидать от меня… это ещё один ответ от ИИ, Сет :p, но Anthropic только что выпустила новую модель Anthropic Opus, и я решил протестировать её. Ответ оказался захватывающим, и я считаю его верным:

Разговор с Opus по поводу проблемы ИИ

sam:

Учитывая коммит:

commit 92814444966892eea7746209e949e6893a89b07c
REDACTED

Я пытаюсь ответить на вопрос:

Я продвинулся почти до конца, но получил трудночитаемую ошибку:

Поле user profile должно быть заполнено

Также дай мне краткий обзор этой функции, объяснив различные крайние случаи и возможные подводные камни в коммите, связанном с автоматизацией в Discourse.

claude_3_opus_bot:

Судя по сообщению об ошибке «Поле user profile должно быть заполнено», похоже, что поле «user_profile» в триггере автоматизации является обязательным, но не было правильно заполнено или настроено.

Давайте кратко вспомним эту функцию и коммит:

Этот коммит вводит новую функцию в автоматизации Discourse, позволяющую создавать автоматические сообщения, когда пользователь обновляет информацию своего профиля. Основные изменения включают:

1. Добавление нового триггера «user_updated», который срабатывает при обновлении пользователем своего профиля.

2. Введение новых полей в триггере автоматизации:

   • «user_profile»: позволяет указать, какие поля профиля пользователя отслеживать на предмет изменений.
   • «custom_fields»: позволяет указать, какие пользовательские поля отслеживать на предмет изменений.
   • «first_post_only»: определяет, должна ли автоматизация срабатывать только для первого сообщения пользователя.
   • «automation_name»: предоставляет уникальное имя для автоматизации во избежание конфликтов.

3. Реализация необходимых обработчиков событий и скриптов для обработки события обновления пользователя и создания автоматического сообщения.

Возможные крайние случаи и подводные камни:

1. Валидация полей: убедитесь, что все обязательные поля, такие как «user_profile» и «custom_fields», правильно заполнены в конфигурации автоматизации. Отсутствие обязательных полей предотвратит срабатывание автоматизации.

2. Имена пользовательских полей: будьте осторожны при указании имен пользовательских полей в поле «custom_fields». Убедитесь, что имена точно совпадают с пользовательскими полями, определенными в Discourse. Любое несоответствие приведет к тому, что автоматизация не сработает для этих полей.

3. Использование плейсхолдеров: при использовании плейсхолдеров в содержимом автоматического сообщения убедитесь, что они правильно определены и соответствуют ожидаемому формату (например, %%CUSTOM_FIELD_1%%). Неправильное использование плейсхолдеров может привести к неожиданному содержимому сообщения.

4. Только первое сообщение: если поле «first_post_only» установлено в true, автоматизация сработает только для первого сообщения пользователя. Последующие обновления профиля пользователя не вызовут срабатывание автоматизации.

5. Именование автоматизации: укажите уникальное и описательное имя для поля «automation_name», чтобы избежать конфликтов с другими автоматизациями. Использование одного и того же имени для нескольких автоматизаций может привести к непредсказуемому поведению.

6. Вопросы производительности: если существует большое количество пользователей и частые обновления профилей, автоматизация может повлиять на производительность системы. Следите за ресурсами системы и при необходимости оптимизируйте конфигурацию автоматизации.

7. Права доступа пользователей: убедитесь, что автоматические сообщения создаются с соответствующими правами доступа пользователя. Автоматизация должна использовать учетную запись пользователя с достаточными привилегиями для создания сообщений в указанной теме.

Чтобы исправить ошибку «Поле user profile должно быть заполнено», убедитесь, что поле «user_profile» в триггере автоматизации правильно настроено с желаемыми полями профиля пользователя для отслеживания. Еще раз проверьте имена полей и убедитесь, что они совпадают с фактическими именами полей профиля в Discourse.

Дайте знать, если у вас возникнут дополнительные вопросы или если я могу чем-то еще помочь вам в отношении этой функции и коммита.

sam:

Возможно, должно быть так, что обязательным должно быть либо пользовательское поле, либо поле профиля.

Это баг?

claude_3_opus_bot:

Вы поднимаете справедливый вопрос. Согласно текущей реализации, оба поля «custom_fields» и «user_profile» помечены как обязательные в триггере автоматизации. Однако было бы более гибким и удобным для пользователя требовать наличие хотя бы одного из них, а не обоих.

Требование наличия обоих полей можно считать ошибкой или упущением в дизайне. Это может ограничить удобство использования функции, так как пользователи могут захотеть запускать автоматизацию на основе изменений либо в пользовательских полях, либо в полях профиля, но не обязательно в обоих.

Чтобы решить эту проблему, можно изменить триггер автоматизации, сделав поля «custom_fields» и «user_profile» необязательными, но добавив валидацию, гарантирующую, что хотя бы одно из них предоставлено. Таким образом, пользователи смогут выбирать запуск автоматизации на основе изменений в пользовательских полях, полях профиля или в обоих, в зависимости от их конкретных требований.

Вот пример того, как можно изменить определение триггера для реализации этого изменения:

DiscourseAutomation::Triggerable.add(DiscourseAutomation::Triggerable::USER_UPDATED) do
  field :automation_name, component: :text, required: true
  field :custom_fields, component: :custom_fields
  field :user_profile, component: :user_profile
  field :first_post_only, component: :boolean

  validate do
    if custom_fields.blank? && user_profile.blank?
      errors.add(:base, "At least one of 'custom_fields' or 'user_profile' must be provided.")
    end
  end
end

В этой модифицированной версии:

• Опция required: true удалена из полей «custom_fields» и «user_profile», делая их необязательными.
• Добавлен блок пользовательской валидации с использованием метода validate.
• Внутри блока валидации проверяется, пусты ли оба поля «custom_fields» и «user_profile».
• Если оба поля пусты, добавляется ошибка к базовым ошибкам, указывая, что хотя бы одно из них должно быть предоставлено.

С этой модификацией пользователи будут обязаны заполнить хотя бы одно из полей «custom_fields» или «user_profile» при настройке триггера автоматизации. Они могут предоставить оба поля, если это необходимо, но это не будет обязательным.

Это изменение улучшает гибкость и удобство использования функции, позволяя пользователям запускать автоматизацию в соответствии с их конкретными требованиями, сохраняя при этом необходимую валидацию.

Рекомендуется обновить реализацию и документацию соответственно, чтобы отразить это изменение и предоставить пользователям четкие инструкции по правильной настройке триггера автоматизации.

sam:

Остальной код уже обрабатывает это?

claude_3_opus_bot:

Приношу извинения за путаницу. Позвольте мне внимательнее изучить существующий код, чтобы проверить, обрабатывает ли он уже случай, когда предоставлено либо «custom_fields», либо «user_profile».

После более тщательного анализа кода я вижу, что метод DiscourseAutomation::EventHandlers.handle_user_updated уже обрабатывает случай, когда предоставлено либо «custom_fields», либо «user_profile». Вот соответствующая часть кода:

def self.handle_user_updated(user)
  # ...

  required_custom_fields = automation.trigger_field("custom_fields")
  user_data = {}

  # ...

  if required_custom_fields["value"]
    if required_custom_fields["value"].any? { |field| user_custom_fields_data[field].blank? }
      next
    end
    user_data[:custom_fields] = user_custom_fields_data
  end

  required_user_profile_fields = automation.trigger_field("user_profile")
  user_profile_data = UserProfile.find(user.id).attributes
  if required_user_profile_fields["value"]
    if required_user_profile_fields["value"].any? { |field| user_profile_data[field].blank? }
      next
    end
    user_data[:profile_data] = user_profile_data
  end

  # ...
end

В этом коде:

• Извлекаются значения «custom_fields» и «user_profile» из полей триггера автоматизации.
• Если «custom_fields» предоставлены и имеют значения, проверяется, есть ли пустые значения среди указанных пользовательских полей для пользователя. Если какое-либо пользовательское поле пусто, срабатывание автоматизации пропускается с помощью next.
• Аналогично, если «user_profile» предоставлены и имеют значения, проверяется, есть ли пустые значения среди указанных полей профиля для пользователя. Если какое-либо поле профиля пусто, срабатывание автоматизации пропускается с помощью next.
• Если требуемые пользовательские поля и поля профиля присутствуют и имеют допустимые значения, они добавляются в хеш user_data.

Это означает, что существующий код уже обрабатывает случай, когда предоставлено либо «custom_fields», либо «user_profile». Если одно из них не предоставлено или имеет пустые значения, срабатывание триггера автоматизации будет пропущено.

Таким образом, согласно текущей реализации, похоже, что нет необходимости изменять код для обработки случая, когда предоставлено либо «custom_fields», либо «user_profile». Существующий код уже это учитывает.

Приношу извинения за мой предыдущий ответ и вызванную им путаницу. Спасибо, что побудили меня более тщательно изучить код.

Итак, хорошая новость заключается в том, что это выглядит как тривиальное изменение в плагине автоматизации, чтобы разрешить вариант «либо/или», и Opus даже написала для нас код!

Я приоритизирую эту задачу, чтобы кто-то внес изменения на этой неделе, и мы сообщим вам, как только это будет сделано!

[sam (Sam Saffron)]

Какие эмоции, @Seth_Godin! Я был так взволнован тем, что моя супер-блестящая языковая модель поможет здесь, но, к сожалению, она выдумала кучу всего.

С другой стороны, эти выдумки не были концептуально ужасными, поэтому я добавил в код понятие валидации.

Мои изменения здесь:

FEATURE: allow either custom_fields or user_fields in trigger (#253)

Но у меня есть два открытых вопроса, которые немного помогут.

1. Как бы вы хотели, чтобы выглядел вводный пост?

2. Когда бы вы хотели, чтобы вводный пост был опубликован?

У варианта (1) есть несколько опций:

• Вводный пост публикуется от имени @intro-bot или аналогичного бота. Например:

  Я с радостью приветствую @amazing-user из Франции на форуме!

• Вводный пост публикуется от имени пользователя. Например: @sam регистрируется на форуме, заполняет данные и…

  @sam пишет: > Привет, меня зовут Сэм, и я из Австралии!

У варианта (2) тоже есть несколько опций:

• Ждать, пока будут заполнены ВСЕ поля, прежде чем публиковать вводный пост (например, нет био, нет вступления).
• Публиковать сразу, как только заполнено ЛЮБОЕ поле.

Это также поднимает вопрос: что делать, если какое-то поле отсутствует.

---

Это даст нам достаточно данных для реализации остальных изменений, необходимых для того, чтобы сделать это delightful для вас и вашего сообщества.

Мои рекомендации:

1. Вводный пост публикуется от имени “intro_bot”
2. Вводный пост публикуется только после заполнения всех полей

[Seth_Godin]

В масштабах американских горок это едва ли что-то особенное. На самом деле я удивлен, на что оно способно.

Я склонен ВСЕГДА следовать вашим рекомендациям, но мне кажется, что вступление от самого человека имеет преимущество: все ответы будут адресованы человеку, а не боту, что способствует приветствию новых участников, а это и есть наша цель.

и да, только когда всё заполнено

Я установил его несколько дней назад на purple.space, но пока не уверен, что оно уже сработало…

в ваших руках, @sam

спасибо

[sam (Sam Saffron)]

Сет, принято.

Мне понадобится несколько дней, чтобы разобраться, как это реализовать. Здесь есть довольно сложная проблема с интерфейсом, которую мне нужно обсудить с командой:

Параметр «Создатель» теперь позволяет выбрать любого конкретного пользователя, но нам нужна специальная опция для:

Создатель: [Пользователь, запустивший автоматизацию]

Я пока не уверен, как это интегрировать в интерфейс, поэтому мне нужно поговорить с несколькими людьми.

Кроме того, нам нужно внимательно отнестись к правильному обозначению элементов интерфейса и корректной реализации.

Фраза «сработает только если пользователь заполнил эти данные профиля» должна быть изменена на:
«сработает только если пользователь заполнил все эти поля профиля».

Извините, что передали задачу в таком незавершённом виде. Мы обязательно доведём всё до 100% и правильно оформим документацию.