Zammad – приложение для организации службы поддержки, которое позволяет управлять заявками и организовывать работу команды. В этой статье мы рассмотрим функционал mybi connect для работы с данными этого источника.
API Zammad позволяет получать различные данные.
Для того чтобы добавить новый источник данных необходимо в левом боковом меню сервиса выбрать пункт “Источники данных” и нажать на кнопку “Добавить новый+”. Перейдя в раздел “Прочее”, необходимо выбрать источник Zammad и нажать на кнопку “Подключить”:
В открывшейся форме необходимо заполнить поля настройки источника:
Поле “Название источника” может быть любым и необходимо для того, чтобы вы могли однозначно идентифицировать этот источник среди других. В поле “Домен” необходимо ввести домен вашего сайта на платформе Zammad. В поле “Токен доступа” необходимо вставить сгенерированный Zammad токен доступа. Для создания токена откройте в Zammad в параметрах профиля раздел “Доступ по ключу”:
Нажмите “Создать”:
Введите имя ключа (произвольную строку), укажите срок окончания его действия и отметьте необходимые для выгрузки разделы. Для корректной работы необходимы пункты “Admin (интерфейс администратора)” и “Ticket -> Agent (доступ к заявкам агентов на основе группового доступа)”. После создания ключа на экране отобразится токен, его необходимо скопировать и вставить в строку настройки источника.
После ввода всех необходимых данных необходимо завершить настройку источника, нажав на кнопку “Продолжить”.
Базовая выгрузка
После завершения настройки подключения в таблице “Источники” появится новый, с заданным ранее названием. Далее можно запустить историческую загрузку данных, выбрав напротив источника в колонке “Действия” пункт меню “Загрузить” и указав период для получения данных:
Обратите внимание, что период доступной исторической загрузки зависит от выбранных вами параметров тарифа, а для триального периода составляет 1 месяц.
По завершению загрузки в базе данных появятся сведения по заявкам в специально спроектированном нами виде, наиболее удобном для дальнейшего анализа:
Более детально ознакомиться со структурой выгрузки вы можете здесь.
Если в каких-то из этих данных вы не нуждаетесь, можно воспользоваться функционалом по выбору необходимых таблиц и выбрать только те, в которые будут загружаться данные в процессе базовой выгрузки:
Это позволит вам как ограничить набор данных, так и в какой-то мере сэкономить количество расходуемых на выгрузку строк.
Кроме возможности выбора таблиц, в базовой выгрузке также существует функционал фильтрации, позволяющий ограничить данные, загружаемые в те или иные таблицы. Вот пример использования фильтра:
Этот фильтр позволяет хранить в БД только записи по активным организациям.
Пользовательская выгрузка
Пользовательская выгрузка позволяет организовать загрузку произвольного набора полей с последующем автоматическим обновлением по текущий период. Необходимым условием создания выгрузки является наличие настроенного источника. Для ее создания необходимо перейти в раздел “Планировщик заданий“, нажать на кнопку “Добавить новое+” и выбрать из списка “Выгрузка отчетов из Zammad”. Далее вы попадете на форму с параметрами выгрузки:
В ней необходимо задать имя отчета, выбрать аккаунт Zammad, сформировать список необходимых полей, указать параметры обновления данных. По умолчанию загружаемые данные сохраняются в таблицу zammad_reports в формате JSON.
Воспользовавшись опцией “Зафиксировать структуру” в поле “Описание таблиц” можно добавить специальное правило, описывающее, каким образом полученные сведения должны обрабатываться mybi connect. Это даст возможность пользователю сохранять данные в удобном виде и в указанных таблицах. Для завершения настройки отчета необходимо нажать на кнопку “Продолжить”.
Добавив отчет в список заданий, его можно запустить для загрузки данных, это можно сделать отобразив меню “Выбрать” в колонке “Действия” напротив созданного отчета и выбрав пункт меню “Выполнить”:
После указания периода загрузки данные будут загружены в хранилище.
Сверка загруженных данных
Задание “Проверка загруженных данных” позволяет выявить наличие расхождений между имеющимися сведениями в базе данных и сервисе-источнике (в данном случае Zammad), а также актуализировать состояние загруженных данных за прошлые периоды в случае выявления расхождений.
При выявлении отклонений используются следующий набор параметров и показателей для сравнения:
- статус заявок;
- количество заявок;
- количество статей.
Результаты проверки загруженных данных вы можете найти в журнале событий (колонка “Действия” -> Журнал событий -> Сверка).
Удаление устаревших данных
Учитывая, что у любых данных есть свойство накапливаться со временем, а объем хранилища в нашем сервисе ограничен в зависимости от используемого тарифного плана, в некоторых случаях можно воспользоваться дополнительным заданием “Удаление устаревших данных“. Это задание позволяет удалять данные по заявкам из хранилища, которые были получены более чем N дней назад, где N – это количество дней, указанное в настройках задания:
Мы будем рады вашим вопросам и рациональным комментариям относительно функционала сервиса в чате нашего телеграм-канала @mybi connect