Документация BILLmanager 5

Интеграция с Omnidesk

Обратите внимание!
Модуль доступен только в BILLmanager Corporate.

Интеграция позволит провайдеру организовать взаимодействие между HelpDesk-системой Omnidesk и BILLmanager.

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

Настройка на стороне Omnidesk

  1. Зарегистрируйтесь в сервисе Omnidesk.
  2. Откройте интерфейс Omnidesk → Настройки API добавить API-ключ, который будет использовать BILLmanager.
  3. Для работы с обращениями из BILLmanager создайте собственный канал: перейдите в Кастомные каналыДобавить кастомный канал → заполните данные формы → кнопка Создать канал.
    В качестве Webhook URL укажите адрес в формате https://URL/mancgi/omnidesk_webhook?secret_key, secret_key — Секретный ключ сервиса, последовательность символов, которую необходимо сгенерировать самостоятельно.
  4. Добавьте сотрудника, от имени которого будет происходить взаимодействие между системами BILLmanager и Omnidesk: перейдите в Команда Сотрудники → кнопка Добавить сотрудника.

    Обратите внимание!
    Сотрудник интеграции должен обладать полными правами для работы с кастомными и email-каналами. Подробнее см. в документации Omnidesk.


  5. Добавьте поля обращения, которые будут заполняться данными из BILLmanager: перейдите в Каналы Управление обращениямиПоля данных → кнопка Добавить поле. Подробнее см. в документации Omnidesk.

    Добавление полей типов Список и Чекбокс


Настройка на стороне BILLmanager

Установка модуля

Для интеграции BILLmanager с Omnidesk установите соответствующий модуль: Интеграция → Модули → модуль Omnidesk → кнопка Установить.

Установка модуля Omnidesk

Настройка параметров интеграции

Для настройки модуля заполните параметры интеграции: Интеграция Модули выберите модуль Omnidesk → кнопка Настроить.

  • API URL — URL-адрес личного кабинета Omnidesk в формате yourcompany.omnidesk.ru, либо собственный поддомен. Подробнее см. в документации Omnidesk;
  • Email пользователя интеграции — email сотрудника, от имени которого происходит взаимодействие между системами BILLmanager и Omnidesk;

    Обратите внимание!
    Для корректной работы интеграции сотрудник должен обладать полными правами на управление запросами. Подробнее см. в документации Omnidesk.
  • API ключ — API-ключ для интеграции с BILLmanager;
  • Кастомный канал — ID кастомного канала из Omnidesk. Например, cch477;
  • Секретный ключ уведомленийсекретный ключ сервиса для проверки подлинности уведомлений. См. раздел Настройка на стороне OmniDesk;
  • Синхронизировать запросы с — дата, начиная с которой будут синхронизированы запросы в Omnidesk.

 

Параметры интеграции

Настройка кастомных полей

При добавлении кастомного поля вы устанавливаете связь между полем на стороне Omnidesk и значением в BILLmanager.

  1. Создайте сотрудника с email, совпадающим с email пользователя интеграции. Подробнее см. в статье Сотрудники и отделы.
  2. Выдайте пользователю права группы Поддержка. Подробнее см. в статье Сотрудники и отделы.
  3. Добавьте кастомное поле: Интеграция Модули →  выберите модуль Omnidesk → кнопка Настроить → кнопка Добавить кастомное поле.
  4. Настройте кастомные поля:
    1. Сущность — выберите сущность, к которой относится кастомное поле — обращение или пользователь.
    2. Поле в Omnidesk — выберите имя поля в Omnidesk.
    3. Значение — выберите значение сущности в BILLmanager, которое будет передано для "Поля в Omnidesk".

  5. Нажмите кнопку Ok.

Чтобы изменить поле после сохранения, нажмите Редактировать.

Кастомное поле

Редактирование значения кастомных полей

Добавление новых значений для полей

Значения формируются на основании данных пользователей и запросов BILLmanager. Доступные значения хранятся в файле /usr/local/mgr5/etc/omnidesk/custom_fields_values.json.

Чтобы добавить новые значения:

  1. Сформируйте объект. Каждое значение представляет собой объект вида:

    {
      "client_id": {
       "entity": "user",
       "name": "ID клиента",
       "sql": "SELECT account FROM user WHERE id = __id__"
      }
    }
    Пояснения
    Значения по умолчанию
  2. Добавьте объект в файл /usr/local/mgr5/etc/omnidesk/custom_fields_values.json.

Дополнительные настройки

Для синхронизации оценок ответов поддержки с BILLmanager:

  1. Откройте интерфейс Omnidesk → вкладка Настройки Оценка ответов.
  2. Включите опцию Клиенты могут оценивать работу сотрудников в обращениях по почте и из центра поддержки.

    Обратите внимание!
    В Omnidesk используется три типа оценки: отлично, хорошо, плохо. В BILLmanager только два типа оценки: отлично, плохо.

Настройки оценки качества ответов

Устройство модуля интеграции

База данных

Модуль использует в работе следующие таблицы:

  • ticket2external_case — связывает запрос в BILLmanager с обращением Omnidesk;
  • ticket_message2external_case_message — связывает сообщения в запросе BILLmanager и обращении Omnidesk;
  • user2external_user — связывает пользователя BILLmanager с пользователем Omnidesk.

Логирование

Логи взаимодействия биллинговой системы с Omnidesk записываются в файлы:

  • var/omnidesk_webhook.log — работа CGI для уведомлений;
  • var/pmomnidesk.log — взаимодействие между системами BILLmanager и Omnidesk;
  • var/billmgr.log — работа библиотеки, подключённой к BILLmanager.
Сообщения об ошибках