Веб-расширения

Раздел для разработчиков.

Веб-расширения — сторонние программы внутри приложения Bpium. Для каждого расширения создается свой пункт в главном меню, по которому оно открывается. Расширение состоит из js-файла, css-файл и других ресурсов (например, шаблонов или изображений).

Типы расширений

  • Модальные — открываются в отдельном слое поверх открытого раздела в Bpium (например, каталога с записями). Могут занимать часть экрана или всю рабочую область приложения. При этом основной экран приложение Bpium остается в DOM-дереве. Пример — панель телефонии Oktell.
  • Экранные — экранные модули занимают всю рабочую область приложения, замещая в DOM-дереве открытый раздел приложения. Этот тип расширений поддерживается пока не полностью.

Создание расширений

1. Выберите уникальное название

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

2. Напишите расширение

Исходный код минимального расширения приведен в нашем публичном репозитарии:
https://bitbucket.org/snippets/bpium/d4bMe/blank-modal-extension

3. Регистрация расширения

Bpium защищает расширения от тиражирования между системами в разных компаниях. Все расширения проходят через систему лицензирования. Подключение расширения к системе возможно только при наличии лицензии на это расширение в лицензии компании.

Чтобы зарегистрировать расширение в системе лицензирования Bpium, напишите письмо на почту bpium@bpium.ru, указан выбранный уникальный код расширения и регистрационный номер компании.

Без регистрации расширения подключить его будет невозможно.


Подключение расширений

Подключать сторонние и собственные расширения можно только в Enterprise версии.

Файлы расширения необходимо положить в рабочую папку Bpium:
bpium_path/www/modules/my-extension/

Список подключенных расширений храниться в каталоге «Расширения» в разделе «Система». Для подключения расширения создайте новую запись в этом каталоге:

  • Название — название расширения в главном меню приложения
  • Иконка — иконка расширения в главном меню иконка (список доступных значений)
  • Код — уникальный идентификатор расширения, должен совпадать названием модуля в скрипте (переменная moduleName)
  • JS URL — относительный или абсолютный путь до js-скртипта. Напрмиер: modules/my-extension/main.js
  • CSS URL — относительный или абсолютный путь до js-скртипта. Напрмиер: modules/my-extension/main.css

После этого обновите страницу в браузере.

Проверка подключения

При старте приложение делает запрос к серверу:
/auth/company

Ответ сервера содержит набор подключенных расширений:
{ "domain": "admin", "title": "Моя компания", "extensions": [ массив расширений ]}

Сервер не вернет расширения, на которые не получена лицензия для компании.


results matching ""

    No results matching ""