Создание пользовательских шаблонов автонастройки IP телефонов в 3CX V15 +4


В этой статье мы рассмотрим весьма полезную технологию – пользовательские шаблоны IP телефонов 3CX. Шаблоны автонастройки 3CX позволяют автоматически единообразно настроить большой парк IP телефонов в организации. Однако 3CX поставляется с готовыми шаблонами, настроенными разработчиками 3CX таким образом, чтобы они подходили большинству потребителей. Если у вашей организации есть какие-либо особые требования к конфигурации IP телефонов, например, собственная “раскладка” программируемых кнопок под дисплеем телефона, конфигурация мелодий вызова, специфические параметры SIP и т.п. – модифицируйте стоковый шаблон под ваши нужды. Как это сделать, описано ниже.

Начало работы


Прежде всего, сделайте копию стокового шаблона 3CX. И уже с копией продолжайте работу.



  1. В интерфейсе управления 3CX перейдите в раздел Settings — Templates.
  2. В выпадающем списке выберите стоковый шаблон автонастройки IP телефона, который следует изменить (1)
  3. Убедитесь, что внутри файла шаблона указана именно та модель телефона, для которой будет создаваться пользовательский шаблон (2).
  4. Вверху нажмите кнопку Copy (3), введите новое имя шаблона и нажмите OK. Это имя будет присоединено к имени стокового шаблона. Вы увидите полное имя пользовательского шаблона в выпадающем списке, как показано ниже.


Внесение изменений


Обратите внимание, что для применения изменений в шаблон, необходим перезапуск сервиса Management Console Service (MC01). Это влечен потерю соединений в клиентах MyPhone/Web Client, которые отвечают за статусы и индикацию присутствия пользователей. Поэтому рекомендуется отлаживать шаблоны на тестовой системе 3CX и тестовой группе IP телефонов – не в рабочем окружении.

Параметры, передаваемые на телефон, начинаются с этой строки в шаблоне <![CDATA[

Все параметры, указанные выше этой строки, необходимы для работы интерфейса управления 3CX, и менять их не следует. Ошибка в этих строках может привести к тому, что пользовательский шаблон не будет виден в выпадающем списке в интерфейсе управления 3CX. Параметры добавочного номера в интерфейсе также станут недоступны. В этом случае вам необходимо будет восстановить последнюю работающую копию содержимого файла шаблона или полностью удалить этот добавочный номер (пользователя).

Общие рекомендации


  • Избегайте дублирования одинаковых параметров автонастройки в шаблоне.
  • Для уточнения параметров обращайтесь к документации по автонастройке производителя IP телефона, но не в техподдержку 3CX.
  • Вы также можете задать вопрос на публичном форуме 3CX.
  • Если какой-либо параметр следует изменить с установленного значения B в значение по умолчанию A, не просто удаляйте это параметр, а явным образом установите ему значение A.
  • Никогда не изменяйте определение модели телефона “ua=”XXXXX””, заданное в шаблоне. Оно используется системой.
  • После внесения изменений в шаблон, не забудьте перезапустить сервис Management Console Service (MC01) и принудительно перенастройте телефон после внесения изменений.
  • Если не перенастраивать телефон принудительно, автоматическое применение параметров шаблона происходит, как правило, в течении 24 часов.

Проверка корректности изменений


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



Если IP телефон в данный момент подключен к 3CX, выделите его в интерфейсе (раздел Phones) и нажмите кнопку +Config. Это принудительно применяет к телефону конфигурацию, указанную в шаблоне.



Также, можно перейти на вкладку Provisioning и скопировать URL автонастройки. Вместо {mac} укажите MAC адрес IP телефона. Например, URL может иметь вид http://mypbx.3cx.eu/provisioning/ads234cfsda/cfg123456787890. Вставьте ее в любой браузер, и вы получите готовый XML файл настройки для конкретного IP телефона. Некоторые браузеры сразу отображают содержимое файла, если он имеет корректный XML формат. Чтобы увидеть содержимое в текстовом виде, кликните правой кнопкой мыши и выберите Show Source.

Применение пользовательского шаблона к IP телефону


Применение к ненастроенному или сброшенному по умолчанию IP телефону


  1. В интерфейсе 3CX перейдите в раздел Phones.
  2. Выделите новый телефон, который нужно настроить.
  3. Выберите Add/Assign Ext, в зависимости от того, что вам необходимо.
  4. Во вкладке Phone Provisioning скопируйте MAC адрес телефона.
  5. В этой же вкладке, в выпадающем списке ваших телефонов удалите привязанный телефон, нажав кнопку Delete справа.
  6. Вверху нажмите кнопку Add.
  7. В выпадающем списке выберите ваш пользовательский шаблон.
  8. Вставьте скопированный ранее MAC адрес телефона.
  9. Нажмите дважды OK, чтобы сохранить параметры пользователя.
  10. Перейдите в раздел Phones, выберите телефон и нажмите Reprovisioning.

Применение к настроенному и подключенному IP телефону


  1. В интерфейсе управления 3CX перейдите в раздел Extensions, кликните по номеру (пользователю), для которого необходимо применить шаблон, и перейдите на вкладку Phone Provisioning.
  2. В выпадающем списке с вашими телефонами, выберите IP телефон, к которому нужно применить пользовательский шаблон.
  3. Скопируйте MAC адрес телефона.
  4. Удалите привязанный телефон, нажав кнопку Delete справа.
  5. Вверху нажмите кнопку Add.
  6. В выпадающем списке выберите ваш пользовательский шаблон.
  7. Вставьте скопированный ранее MAC адрес телефона.
  8. Нажмите дважды OK, чтобы сохранить параметры пользователя.
  9. Перейдите в раздел Phones, выберите телефон и нажмите Reprovisioning.

Особенности шаблонов


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

Пользовательские шаблоны Yealink


В отличии от других производителей, Yealink для автонастройки использует 2 конфигурационных файла. Из-за этого в шаблоне присутствуют два раздела <![CDATA[, которые генерируют два файла автонастройки для каждого телефона.

  • Первый раздел <![CDATA[ определяет общие параметры данной модели телефона (model) и соответствует именам файлов вида y0000000000xx.cfg. Здесь xx – идентификатор конкретной модели, определенный Yealink. Менять его нельзя.  В данной статье эти файлы называются y-files.
  • Второй раздел <![CDATA[ определяет индивидуальную конфигурацию устройства с данным MAC адресом. Она включает добавочный номер и другие параметры конкретного пользователя.

Для того, чтобы пользовательский шаблон Yealink работал корректно, перед применением шаблона необходимо выполнить ручное редактирование:

  • Имя пользовательского шаблона изменяет название соответствующей модели телефона Yealink. Поэтому это новое название должно быть указано выше раздела <![CDATA[ для соответствующей модели (правый скриншот). Обратите внимание, чтобы название модели соответствовало корректному индексу xx в y-file (например, y-file T19P имеет индекс 53, и менять его нельзя!).



  • Имена y0000000000xx.cfg должны быть уникальны в отличающихся пользовательских шаблонах. Проще всего добиться этого – выделить содержимое файла и скопировать его в текстовый редактор. Затем, используя функцию Replace All, найти тест y0000000000 и заменить его на y1000000000 для первого пользовательского шаблона, y2000000000 для второго пользовательского шаблона и т.д.

y file.png

Универсальные шаблоны


Настоятельно не рекомендуется явно указывать в шаблоне такие параметры как номера портов, IP адрес или FQDN сервера 3CX, учетные данные пользователя и т.п. Если шаблон не содержит такой жестко заданной информации, его можно назвать универсальным (переносимым). Он может быть перенесен на другую инсталляцию системы 3CX. Это весьма полезно для интеграторов, которые модифицируют шаблоны для решения специфических задач пользователей. Универсальные шаблоны должны быть размещены в папке
C:\ProgramData\3CX\Instance1\Data\Http\Interface\provisioning\XXXXXXXXXX\CustomTemplates\phones

При обновлении системы, файлы в этом каталоге сохраняются (резервируются, а затем восстанавливаются). Не используйте имя файла пользовательского шаблона совпадающее с именем стокового шаблона. Стоковые шаблоны перезаписываются при каждом обновлении 3CX. Таким образом, ваши пользовательские шаблоны будут перезаписаны без предупреждения.

Если путь CustomTemplate\phones отсутствует, создайте эти папки (соблюдая регистр символов) и перезапустите сервис MC01.

Поддержка пользовательских шаблонов компанией 3CX


3CX поставляет стоковые шаблоны для всех поддерживаемых IP телефонов, а также для некоторых устаревших IP телефонов. Шаблоны для устаревших телефонов позволяют их автоматически корректно настроить и обеспечить многие современные функции 3CX. Однако модификация стоковых шаблонов лишает вас официальной поддержки 3CX, как описано здесь. Если у вас возникли проблемы с конкретным IP телефоном, перед открытием заявки следует сбросить его в настройки по умолчанию и настроить стоковым шаблоном. После этого повторите действия, вызвавшие проблему, а только после этого открывайте заявку в техподдержке 3CX.

Иными словами, 3CX не предоставляет никакой дополнительной поддержки по пользовательским шаблонам, за исключением данного руководства. Кроме того, если вы создали пользовательский шаблон, необходимо постоянно отслеживать обновления соответствующего стокового шаблона. Поскольку стоковые шаблоны соответствуют прошивкам IP телефонов, устаревший пользовательский шаблон может привести к некорректной работе IP телефона с обновленной прошивкой.
-->


К сожалению, не доступен сервер mySQL