Справка TeamWox → Сервисдеск → Публичная часть

Публичная часть

Модуль "Сервисдеск" поставляется вместе с публичным компонентом, который позволяет интегрировать его с внешним веб-сайтом. Это позволит посетителям веб-ресурса общаться с пользователями системы TeamWox посредством заявок.

Следует внимательно относиться к интеграции модуля "Сервисдеск" с веб-сайтом. Одновременная установка публичного компонента на множестве страниц может привести к значительному замедлению работы веб-ресурса.

Интеграция модуля с сайтом происходит с помощью файла стилей css и JavaScript. Эти файлы должны быть вызваны со специальной HTML страницы, пример которой приведен ниже:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <title></title>
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  <link href="http://www.yourwebsite.com/servicedesk/style.css" type="text/css" rel="stylesheet" />
  <script type="text/javascript">
  var tw_servicedesk_params=
  {
   url:'https://team.yourdomain.com',
   sid:'user_id',
   container:'service_desk',
   user_name:'user_name',
   user_email:'user_email',
   user_company:'user_compamy',
   incidents_per_page:3,
   comments_per_page:5,
   filter_groups:[group_id],
   filter_categories:[category_id],
   filter_products:[product_id],
   logo:'logo_html_code',
  }
  </script>
  <script src="http://www.yourwebsite.com/servicedesk/script.js" type="text/javascript"></script>
</head>
<body>
<div id="service_desk"></div>
</body>
</html>

На данной странице есть ряд конструкций, которые должны обязательно присутствовать:

Ссылки на CSS и JS файлы

Для работы публичного компонента модуля "Сервисдеск" необходимы два файла, "script.js" и "style.css". Их необходимо скачать из вашей системы TeamWox по ссылкам следующего вида:

https://team.yourdomain.com/public/servicedesk/style.css

https://team.yourdomain.com/public/servicedesk/script.js

В них вместо "team.yourdomain.com" необходимо указать адрес вашей системы TeamWox. Скачанные файлы необходимо разместить на сайте, куда будет интегрирована публичная часть модуля. Затем в HTML файле должны быть указаны соответствующие ссылки на них, например:

При достаточном уровне знаний CSS и JavaScript, пользователь может вносить изменения в оформление публичной части модуля "Сервисдеск".

Идентификатор контейнера

Вписывание публичного компонента модуля происходит в определенный контейнер на HTML-странице. Это может быть любой контейнер. В примере, указанном выше, им является тэг <div>:

В данном случае ключевым моментом является присвоение контейнеру уникального идентификатора (id="service_desk" в примере), который в последующем будет необходимо указать в одном из параметров ниже.

Параметры

Параметры указываются в конструкции "var tw_servicedesk_params={...}". Часть из них является обязательными:

url:'адрес сервера TeamWox'

Здесь в одинарных кавычках указывается адрес вашего сервера TeamWox, например, 'team.yourdomian.com'.

sid:'идентификатор пользователя'

Данное поле является одним из наиболее важных. Оно влияет на разграничение прав доступа пользователей сайта к созданным заявкам. С помощью специальной конструкции в его значение должен подставляться уникальный идентификатор для каждого посетителя сайта.

Для зарегистрированных пользователей сайта в качестве значения поля можно использовать MD5 от ключевого слова и идентификатора пользователя на сайте.
Для анонимных посетителей можно использовать MD5 от cookies.
Если на сайте предусмотрено разделение посетителей по группам, то подставляя идентификатор группы в данное поле, вы сможете организовать совместную работу пользователей с одними и теми же заявками. При установке фиксированного значения "sid", любой пользователь сможет просматривать все созданные заявки.

В данном поле должен быть указан такой параметр, который невозможно подобрать. Использование простых идентификаторов является неприемлемым и может привести к несанкционированному доступу к заявкам. Видимость заявок тому или иному пользователю определяется именно по значению данного поля. Примеры для каждого из вышеуказанных случаев приведены в отдельном разделе.

container:'идентификатор контейнера'

В данном параметре указывается идентификатор контейнера, в котором будет отображаться интерфейс публичной части модуля "Сервисдеск".

user_name:'имя пользователя'

Этот параметр должен собираться веб-сайтом, в его значение должна быть вписана конструкция, подcтавляющая соответствующую информацию о пользователе сайта.

Следующая группа параметров является необязательной:

user_email:'адрес электронной почты пользователя'

Адрес электронной почты обратившегося.

В системе TeamWox работает автоматическая привязка заявок к организациям по адресу электронной почты.

user_company:'название компании пользователя'

Название компании обратившегося.

Адреса электронной почты и названия компаний также должны собираться веб-сайтом. В их значения необходимо вписать конструкции, подставляющие соответствующие данные посетителей сайта.

incidents_per_page:количество заявок на одной странице

Здесь указывается количество заявок, которые будут отображаться на одной странице. При отсутствии этого параметра будет использовано значение по умолчанию (10).

comments_per_page:количество комментариев на одной странице

В данном параметре указывается количество комментариев к заявке, отображающееся на одной странице. При отсутствии параметра будет использовано значение по умолчанию (10).

filter_groups:[список идентификаторов доступных групп]

Здесь необходимо в квадратных скобах через запятую указать идентификаторы групп, которые будут доступны пользователям для выбора при создании заявки. Идентификатор группы указывается на вкладке "Информация" окна редактирования ее параметров.

Для того чтобы группа была доступна публично, необходимо включить для нее соответствующую опцию в настройках.

filter_categories:[список идентификаторов доступных категорий]

В этом параметре в квадратных скобках необходимо через запятую указать идентификаторы категорий, созданных в группах, по которым пользователи смогут создавать заявки. Идентификатор категории указывается на вкладке "Категории" окна редактирования параметров группы.

filter_products:[список идентификаторов доступных продуктов]

В этом параметре в квадратных скобхах необходимо через запятую указать идентификаторы продуктов, созданных в группах, по которым пользователи смогут создавать заявки. Идентификатор продукта указывается на вкладке "Продукты" окна редактирования параметров группы.

logo:'HTML код шапки окна'

С помощью данного параметра можно заменить стандартную шапку окна заявок на свою собственную. Для этого в параметры нужно указать собственный HTML код шапки. Самыми простыми примерами является:

<img src="yourwebsite.com/res/logo.png" />
<span style="font-size:14px; color: rgb(73, 194, 85);">Service Desk</span>

Дополнительные примеры реализации публичной части модуля "Сервисдеск" на "PHP" и ".NET" приведены в отдельных разделах. Пример рабочей страницы публичного компонента модуля приведен в разделе "Внешние заявки".

В настоящий момент предусмотрено два языка окна заявок, русский и английский, которые автоматически выбираются в зависимости от языка операционной системы пользователя. Переводы интерфейса хранятся в файле "script.js". При достаточном уровне знаний, новые переводы могут быть самостоятельно добавлены в него.

← Интеграция SID →