Коды полей форм
Pyrus предоставляет различные инструменты для автоматизации процессов — Pyrus API , Расширения, скрипты , боты, подпроцессы , связанные формы и др.
Чтобы максимально интегрировать эти инструменты в систему Pyrus, разработчики форм и интеграций могут обращаться к полям форм для получения или установки их значений.
- Расширения используют поля формы для обмена данными между внешним сервисом и формой Pyrus.
- Боты и скрипты обращаются к полям формы, чтобы считывать их значения и в зависимости от них выполнять заданные действия: отправлять сообщения, переводить задачу на следующий этап, закрывать или переоткрывать её и т. д. При этом один бот может работать в нескольких формах, обращаясь к полям с одинаковым уникальным идентификатором — кодом.
- В формах Pyrus поля используют для обмена данными между двумя формами, как, например в подпроцессах, или для переноса данных из одной формы в другую, как в связанных формах.
Во всех этих случаях, чтобы нужное поле было правильно идентифицировано, мы рекомендуем использовать код поля.
Подсказка: в связанных формах значения поля из основной формы копируется в поле подформы, если в этих полях совпадает код.
Код — постоянный идентификатор поля
Существует три способа идентификации поля формы.
- По названию поля — его видят пользователи и могут изменять администраторы в настройках шаблона формы.
- По ID — уникальному числовому идентификатору поля. ID недоступен для редактирования администраторами и может быть изменен только при обновлении платформы.
- По коду поля — строковому идентификатору, который не видят пользователи, но может изменять администратор. Важно, что код сохраняется при переименовании поля или при смене ID.
Код поля в расширениях. Чтобы опубликовать расширение, разработчик в своем личном кабинете задает соответствие между информацией из внешней системы и полями формы Pyrus, благодаря которому происходит обмен данными между двумя сервисами. Для этого нужно указывать коды и типы полей.
Код поля в формах. Указание кодов полей в настройке поля формы делает более удобным подключение к форме различных расширений.
Например, вы устанавливаете расширение Telegram в форму Обращение клиента, чтобы сообщения от клиентов из мессенджера превращались в задачи Pyrus. Можно указать коды Subject и SenderName для полей Тема и Имя отправителя, а затем задать соответствие между этими полями и данными клиента, который пишет в Telegram.
Теперь если вы захотите подключить к этой форме другой мессенджер, например WhatsApp, Pyrus автоматически предложит задать такое же соответствие между информацией из сообщения WhatsApp и полями формы.
Обратите внимание: коды полей уже прописаны в готовых шаблонах форм Pyrus, которые служат для автоматизации наиболее распространенных процессов в организации.
Код поля в ботах и скриптах. Указание кода поля в настройке поля обеспечивает корректную работу бота, даже если название или тип поля изменились. При этом работать бот может сразу в нескольких формах, в которых есть поля с одинаковыми кодами.
Например, поле типа Контакт заполняется ответственным специалистом в двух формах — Обращение клиента и Работа с отзывами, поэтому у поля в обеих формах указан одинаковый код ResponsiblePerson. Вы можете создать бота, который сформирует отчёт по нагрузке сотрудников в рамках двух форм. Для этого необходимо использовать один бот для обеих форм — он продолжит работать, даже если поле будет переименовано или если код ResponsiblePerson будет перенесен в другое поле любой из форм.
Пример обращения к полю формы по коду в скриптах Pyrus:
form.onChange(['CallStartTime', 'CallEndTime']) .setValues(['CallDuration'], state => { const [start, end] = state.changes; if (!start || !end) return null; const duration = end.value - start.value; return duration; });
Список кодов полей платформы Pyrus
Pyrus поддерживает ряд наиболее часто используемых кодов полей форм. Эти коды применяются в готовых шаблонах форм и в расширениях.
Обратите внимание: если вы применяете собственные коды, рекомендуем создавать их в формате CamelCase.
Код поля | Название поля | Разрешенный тип поля | Service Desk | CRM | Рекрутинг и HR | Документооборот |
---|---|---|---|---|---|---|
Attachments | Приложенные файлы | Файлы | ✔️ | ✔️ | ✔️ | ✔️ |
EdiDocumentsToSign | Документы для подписи | Файлы | ✔️ | |||
EdiContragentRu | Контрагент, с которым осуществляется документооборот | Организация | ✔️ | |||
EdiOrgDetailsRu | Реквизиты организации, от лица которой будет выполнена отправка документа | Справочник, ссылающийся на каталог типа EdiSendersRU | ✔️ | |||
EventDate | Дата и время события | Срок | ✔️ | ✔️ | ||
CallDuration | Продолжительность звонка | Число, Время | ✔️ | ✔️ | ✔️ | |
CallEndTime | Время окончания звонка | Время, Телефон | ✔️ | ✔️ | ✔️ | |
CallStartTime | Время начала звонка | Время, Телефон | ✔️ | ✔️ | ✔️ | |
CallStatus | Статус звонка | Текстовое поле | ✔️ | ✔️ | ✔️ | |
PhoneNumberFrom | Номер телефона клиента | Телефон | ✔️ | ✔️ | ✔️ | |
PhoneNumberTo | Номер телефона оператора | Телефон | ✔️ | ✔️ | ✔️ | |
ResponsiblePerson | Ответственный | Контакт | ✔️ | ✔️ | ✔️ | |
Message | Сообщение | Текстовое поле | ✔️ | |||
Subject | Тема обращения | Текстовое поле | ✔️ | |||
LeadName | Название сделки | Текстовое поле | ✔️ | |||
LeadStatus | Статус сделки | Поле с типом выбор | ✔️ | |||
Price | Стоимость | Деньги | ✔️ | ✔️ | ||
PageUrl | Ссылка на страницу, с которой пришло сообщение | Текстовое поле | ✔️ | ✔️ | ||
PostUrl | Ссылка на пост, связанный с сообщением | Текстовое поле | ✔️ | ✔️ | ||
Rating | Оценка сервиса | Поле с типом выбор | ✔️ | |||
RatingComment | Комментарий к оценке | Текстовое поле | ✔️ | |||
RatingDate | Дата оценки | Дата | ✔️ | |||
SenderName | Имя отправителя | Текстовое поле | ✔️ | ✔️ | ✔️ | |
SenderEmail | Почтовый адрес отправителя | Эл. почта, Текстовое поле | ✔️ | ✔️ | ✔️ | |
SenderAccountUrl | Ссылка на профиль отправителя | Текстовое поле | ✔️ | ✔️ | ||
UserBrowser | Название браузера, из которого пришло сообщение | Текстовое поле | ✔️ |
Список постоянно пополняется, поэтому если вы разрабатываете шаблоны форм, ботов или расширения и не нашли подходящих кодов полей, заполните заявку на создание нового кода. В ней опишите сценарии, в которых вы планируете использовать код, и укажите:
название, назначение и тип поля;
требуемый код.