Extension Hooks
Rules attached to named points in a record's life: before or after it is saved, posted or approved, and when its status changes. A hook is a condition (the same expression language as custom rules) and one action: refuse with a message, warn, send on one of this company's webhooks, or write a log line. A hook cannot change a record or run code. New hooks start in dry run: evaluated and logged, never acting, until you switch them live. To fill in, work out, check, show or lock a field, use Custom Logic instead.
Где это найти
- Модуль: Платформа
- Группа: Автоматизация
- Раздел: Extension Hooks
- Экран: Extension Hooks
Адрес в консоли: /platform/extension-hooks
Список · 11 столбцы · 15 поля в его форме · 4 из них необходимых · 4 действия
Что показывает этот список
Это столбцы списка в том порядке, в котором они отображаются. По любому из них можно выполнить сортировку, фильтрацию, скрыть или экспортировать.
| Столбец | Добрый | Название поля |
|---|---|---|
| Hook | Текст | name |
| Point | Статус | point |
| Модуль | Код | module_key |
| Экран | Код | resource_key |
| Делает | Статус | action_kind |
| Режим | Статус | mode |
| Беги | Число | run_count |
| Отказался | Число | veto_count |
| Ошибки | Число | error_count |
| На | Да или нет | is_active |
| Last problem | Текст | last_error |
Форма
Что запрашивается при создании записи? Обязательные поля отмечены; выбор из списка конфигураций — это вариант, который администратор может расширить без выпуска.
| Поле | Тип | Выбор | Примечания |
|---|---|---|---|
| Имя необходимый | Текст | A name people will recognise in the run log. | |
| Для чего это нужно | Длинный текст | Why this rule exists. | |
| Point необходимый | Выбор | Before a record is saved, After a record is saved, Before a document is posted, After a document is posted, Before an approval is given, After an approval is given, Before the status changes, After the status changed | When in the record's life the hook runs. |
| Экран необходимый | Выбор | Поиск выполнен по существующим записям. | The screen whose records the hook watches, e.g. CRM › Accounts, or a custom object. "Every screen" covers the whole module (not for a hook that refuses). |
| Делает необходимый | Выбор | Refuse with a message (before points only), Warn but allow (before points only), Send on a webhook (after points only), Only write it in the run log | Only a before hook can refuse or warn; only an after hook can send. |
| Состояние | Длинный текст | When the hook acts, e.g. total > 10000 and is_empty(project_code). Empty means always. You may use record fields, previous, changed, status, to_status, user and today. | |
| Сообщение | Текст | What a person is told. {field} is replaced by the record's value. | |
| Message (as an expression) | Текст | Optional: work the message out, e.g. concat("Over budget by ", total - 10000). | |
| Only when moving to | Текст | For the status points: comma-separated statuses; empty means any move. | |
| Вебхук | Выбор | Поиск выполнен по существующим записям. | One of this company's outbound webhooks. It signs and screens the target like every delivery. |
| What is sent | Текст | A set of named expressions, e.g. {"number": "record_no", "total": "total"}. Empty sends the record without personal or secret fields. | |
| Заказ | Число | Hooks at the same point run in this order. | |
| Time budget (ms) | Число | 10 to 500. A run over it is skipped and counted as an error. | |
| Runs per minute | Число | A ceiling for warnings, sends and log lines (a refusal is never throttled). | |
| На | Да или нет | A hook that fails ten runs in a row is switched off with the reason; switch it on again after fixing it. |
Что вы можете здесь сделать
Тест начальный
Try this hook without running it
Запрашивается: Sample record (JSON) Or a real record id
Switch live
Запрашивает подтверждение: Switch this hook live? It will refuse, warn or send on real saves from now on.
Back to dry run
Запрашивает подтверждение: Put this hook back in dry run? It stops acting at once and is only evaluated and logged.
Run log
Здесь действуют следующие правила
Всё на этом экране подчиняется правилам платформы, а не её собственным правилам. Вот что стоит знать, прежде чем использовать:
- Сужение списка — Поиск, условия, сортировка, итоги, экспорт и сохраненные представления.
- Что может быть изменено — Пять оснований, по которым запись не может быть отредактирована.
- Компании и бизнес-подразделения — что делает с ним переключатель, расположенный выше в этом списке.
- Создание записи — Обязательные поля, откуда берутся варианты выбора и как распределяется число.
- Импорт электронной таблицы — Этот экран принимает один символ, и он обрабатывается по тем же правилам, что и ввод текста.