советы партнёрам Битрикс24 при внедрении и эксплуатации
Как быстро найти и исправить ошибки в бизнесс-процессах при внедрении приложения «Бонусные карты и программа лояльности для Битрикс24»
Задачи со стороны бизнеса
— снизить стоимость проекта по внедрению приложения у клиента;
Для кого статья
— Партнёры Битрикс24, осуществляющие внедрение приложения у клиентов;
— Сотрудники IT-отделов со стороны клиента, которые отвечают за работу Битрикс24;
При внедрении и эксплуатации приложения специалист выполняет типовые операции по его настройке, диагностике технических и логических ошибок если они появляются, в статье рассказывается, как быстро находить и исправлять такие ошибки, как эффективно взаимодействовать со службой технической поддержки приложения.
Требования к настройкам бизнес-процессов
- Каждый вызов активити приложения должен заканчиваться записью отладочной информации в журнал работы бизнес-процесса, это стандартное активити «Запись в отчет».
- Если бизнес-процесс разветвлённый, то в журнал БП должны быть добавлены записи, позволяющие понять, по какой «ветке БП» пошло исполнение
Почему это важно: активити БП которые ставит приложение это, по сути, удалённый вызов API-метода (функции), он может закончиться как успешно, так и ошибкой. Причин ошибки много: нарушение работы сети, ошибки уровня «приложения», логические ошибки в бизнес-логике, например — попытка начислить бонусы на заблокированную карту. Именно для этого все активити приложения возвращают расширенную отладочную информацию для записи в журнал работы БП.
Каждое активити приложения возвращает стандартные поля для отладки его работы:
- operation_status_code — статус работы приложения, тип строка, перечисление (error или success)
- operation_status_message — текстовое сообщение с описанием результата операции в виде понятном обычному менеджеру
- activity_return_result — массив переменных, которые возвращены приложением как результат работы активити
Пример: Ошибка при настройке бизнес-процесса в Битрикс24
Пример бизнес-процесса, ошибки в работе которого очень трудно диагностировать и отладить: в журнал работы БП не записываются данные после вызова активити приложения
Пример: корректная настройка бизнес-процесса в Битрикс24
Пример бизнес-процесса, ошибки в котором можно быстро диагностировать во время его настройки и последующей работы
Порядок диагностики Ошибки при работе бизнес-процесса
- Посмотреть в лог работы конкретного бизнес-процесса
- Добавить отладочные записи после вызова каждого активити приложения
- Посмотреть в системный журнал приложения с использованием утилит для интеграторов.
- В случае если ошибка действительно есть и она на стороне приложения, то связаться с технической поддержкой передав ей информацию для диагностики
Что нужно передать технической поддержке приложения для диагностики ошибки
- Скриншот бизнес-процесса или его части где есть ошибка
- Содержимое лога работы бизнес-процесса с отладочной информацией по вызовам активити
- Ссылку на эксельку с B24io.Loyalty — B24 partner dashboard и информацию за какой период времени нужно смотреть системный журнал приложения.
- При необходимости — доступы в портал где ошибка воспроизводится
.