Low-code дизайнер / Пользовательские расширения

Пользовательские расширения

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

Готовые расширения легко выгружаются в виде файлов и переносятся из одной компании в другую.

Добавить расширение

Вы можете создать новое расширение с нуля или загрузить готовое. Для этого перейдите в Администрирование > Расширения и нажмите кнопку +Добавить расширение.

exten_1

Создать расширение с нуля

В открывшемся окне выберите опцию Создать и внесите данные о расширении. 

exten_2

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

Заполните обязательные поля и нажмите на кнопку Создать.

Откроется страница управления расширением. Здесь вы сможете отредактировать или дополнить описание, добавить свойства, методы API, настроить новые виджеты или действия в бизнес-процессах. Вся работа осуществляется на 6 вкладках: Основные, Настройки, Виджеты, Методы API, Действия в БП, Процессы.

Вкладка «Основные»

Дополните или отредактируйте основную информацию о расширении.

exten_3

  • Название* — наименование расширения;
  • Иконка — графическое обозначение расширения;
  • Краткое описание* — информация о возможностях расширения, которая отображается в разделе Администрирование;
  • Детальное описание —  подробное описание функций расширения;
  • Ссылка на справку — ссылка на документацию, описывающую процесс работы с расширением;
  • Разработчик —  разработчик (компания-разработчик), создавший данное расширение;
  • Сайт разработчика — ссылка на сайт разработчика.

Укажите всю необходимую информацию и нажмите Сохранить.

Вкладка «Настройки»

Добавьте глобальные параметры, которые можно использовать для настройки методов API расширения, а также в серверных сценариях виджетов и бизнес-процессов расширения. Например, можно добавить параметры для хранения токена или ключа API. Для обращения к параметрам в сценариях используйте синтаксис Namespace.params.data."название параметра".

Нажмите +Добавить и в окне создания заполните поля:

exten_4

  • Отображаемое имя*  название свойства, которое будет отображаться на различных формах расширения и в его настройках;
  • Имя свойства*  название свойства, использующееся при работе с API, сценариями;
  • Подсказка  дополнительная информация о свойстве;
  • Тип*  тип свойства, например, «Строка»;
  • Поиск и сортировка по полю  если вы выберете эту опцию, то значение данного поля будет использоваться в качестве параметра для поиска;
  • Полнотекстовый поиск значение поля будет участвовать в полнотекстовом поиске.
  • Заполняется по формуле  эта опция доступна только для полей типа строка, число и деньги. Вы можете указать формулу, при помощи которой система будет автоматически рассчитывать значение для данного свойства. Подробнее читайте в статье «Заполнение и отображение поля по формуле».
  • Отображается при выполнении условия  эта опция позволяет скрывать/отображать свойство в зависимости от заданных вами условий. Подробнее читайте в статье «Заполнение и отображение поля по формуле».

После того, как вы укажете все настройки, нажмите Сохранить.

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

exten_20

Вкладка «Виджеты»

На данной вкладке можно создать свои собственные виджеты для форм бизнес-процессов, приложений, страниц разделов и т.д. Настроенный виджет будет доступен для работы в Дизайнере Интерфейсов. Его можно перетаскивать на формы и настраивать, как любой другой системный виджет.

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

Нажмите +Виджет, в открывшемся окне внесите всю необходимую информацию о виджете.

exten_5

  • Название*  наименование виджета;
  • Код виджета*  уникальный идентификатор, необходимый для использования виджета в рамках расширения;
  • Описание  описание функциональных возможностей виджета и его особенностей;
  • Расширение  укажите, к какому расширению относится виджет;
  • Иконка  графическое обозначение, которое помогает пользователям лучше ориентироваться в системе, быстрее находить нужный виджет.

После сохранения откроется Дизайнер интерфейсов, в котором можно настроить виджет.

exten_6

Подробнее о настройках виджетов читайте в разделе «Дизайнер интерфейсов».

Вкладка «Методы API»

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

exten_16

  • Название* — укажите название метода.
  • Адрес* —  Выберите метод для HTTP вызова: GET или POST. Укажите адрес, по которому будет доступен метод.
  • Функция* — создайте функцию, которая будет выполняться при получении запроса.
  • Авторизация — выберите тип авторизации, который будет применяться при получении запроса.
    • Внутренняя авторизация — метод можно будет вызывать из сценариев процессов, виджетов, форм, но при этом его нельзя будет вызвать из внешней системы. Пользователь, от имени которого исполняется сценарий, должен быть авторизован в ELMA365.
    • Внешняя авторизация — при выборе этой опции метод будет доступен из внешней системы по токену.
  • Асинхронный запуск — опция позволяет продолжить работу, не дожидаясь окончания выполнения метода.
  • Описание — укажите подробное описание метода.

Вкладка «Действия в БП»

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

Настроенный блок действия будет доступен в дизайнере бизнес-процессов, на панели инструментов, на вкладке Интеграции. Его можно будет переиспользовать для разных процессов.

Нажмите +Действие и в открывшемся окне укажите информацию.

exten_7

  • Название* – наименование действия;
  • Код* – уникальный идентификатор, необходимый для использования действия бизнес-процессах;
  • Тип – выберите тип действия:
    • Скрипт – выполняет заданный сценарий на определенном шаге бизнес-процесса;
    • Вызов процесса – запускает бизнес-процесс, созданный в расширении на вкладке Процессы.

Нажмите Сохранить, чтобы перейти к настройкам действия.

Действие типа Скрипт

Такое действие можно использовать для создания интеграций, например, для отправки запросов во внешнюю систему. Настройки действия выполняются на трех вкладках: Настройки, Контекст, Сценарии.

exten_8

На вкладке Настройки, укажите:

  • Название – наименование действия;
  • Название по умолчанию – наименование, отображающееся на блоке действия при добавлении его на схему бизнес-процесса;
  • Цвет блока – цвет, в который будет окрашен блок действия на схеме процесса;
  • Описание описание функциональных возможностей действия и его особенностей
  • Модель выполнения – способ выполнения действия:
    • Синхронное – простое выполнение заданного в действии сценария;
    • Запрос результата – система выполнит заданный сценарий и запросит результат проделанной работы. Бизнес-процесс продолжится только после того, как ответ на запрос во внешний сервис будет true;
    • Обратный вызов – система выполнит заданный сценарий, а бизнес-процесс продолжится только после того, как система даст положительный ответ на запрос внешнего сервиса;
  • Количество повторов при ошибке – укажите, сколько раз система должна попытаться выполнить действие;
  • Пауза между повторами при ошибке (сек)* – определите частоту попыток.

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

Чтобы создать новую контекстную переменную, нажмите +Добавить.

exten_9

В открывшемся окне укажите все  настройки переменной.

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

exten_10

На вкладке Сценарии создается сценарий действия. Для написания сценариев используется язык программирования TypeScript. Более подробно про принципы написания сценариев в  QuickBPM вы можете прочитать  в справке по TypeScript SDK.

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

Действие типа Вызов процесса

Такое действие позволяет вызвать процесс, настроенный в Расширении на влкадке Процессы. Все настройки действия выполняются на двух вкладках: Настройки и Контекст.

exten_11

На вкладке Настройки, укажите:

  • Название – наименование действия;
  • Название по умолчанию – наименование действия, отображающееся при добавлении его на диаграмму бизнес-процесса;
  • Цвет блока – цвет, в который будет окрашен блок действия на схеме процесса;
  • Описание описание функциональных возможностей действия и его особенностей;
  • Процесс – из выпадающего списка выберите, к какому процессу расширения вы хотите привязать данное действие. Кнопка Обновить процесс до его последней версии используется, в том случае, если вносились изменения в список входных или выходных переменных процесса. В противном случае обновлять процесс не требуется;
  • Количество повторов при ошибке – укажите, сколько раз система должна попытаться выполнить действие;
  • Пауза между повторами при ошибке (сек)* – определите частоту попыток.

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

Чтобы добавить создать новую контекстную переменную, нажмите +Добавить.

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

exten_12

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

Вкладка «Процессы»

На этой вкладке вы можете создать свои собственные бизнес-процессы, работающие в рамках расширения, которые затем можно добавить в действие. Таким образом вы сможете создать новый блок для бизнес-процесса с собственной логикой исполнения.

начало внимание

Обратите внимание, процессы, добавленные на этой вкладке, нельзя напрямую запустить в интерфейсе системы. Это можно сделать только с помощью блока Действие БП либо через сценарий.

конец внимание

Нажмите +Процесс, в появившемся окне внесите необходимые данные.

exten_13

  • Название* – наименование процесса;
  • Код виджета* – уникальный идентификатор, необходимый для использования процесса в рамках расширения;

Далее, откроется дизайнер бизнес-процессов. Подробнее о работе в нем читайте в статье Введение в бизнес-процессы.

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

После того как вы настроите расширение, его необходимо подключить. Для этого, в разделе Администрирование > Расширения нажмите на название расширения. На открывшейся странице, нажмите Включить.

Далее, откроется страница настроек расширения.

exten_15

Укажите все требуемые параметры и нажмите Сохранить. Расширение готово к работе.