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

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

Веб-расширения — это сторонние программы (веб-модули) внутри приложения КОСКО BPM. Расширение состоит из JS-файла, CSS-файла и других ресурсов (например, шаблонов или изображений).

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

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

  • Экранные — занимают всю рабочую область приложения, замещая в DOM-дереве открытый раздел приложения. Этот тип расширений поддерживается пока не полностью.

  • Фоновые — работают в фоне и управляют DOM-деревом (встраивают элементы) в нужный момент.

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

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

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

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

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

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

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

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

Файлы расширения необходимо разместить на внешнем веб-сервере или положить в рабочую папку на сервере КОСКО BPM (если у вас несколько серверов, то на каждый сервер): bpium_path/www/modules/my-extension/

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

  • Название — название расширения в главном меню приложения

  • Код — уникальный код расширения (должен совпадать с зарегистрированным в лицензии)

  • Иконка — класс иконки для отображения в меню

  • JS URL — URL или путь к JavaScript файлу расширения (можно указать несколько, каждый с новой строки)

  • CSS URL — URL или путь к CSS файлу расширения (можно указать несколько, каждый с новой строки)

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

При старте веб-приложение КОСКО BPM делает запрос к серверу:
/auth/company

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

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