Магазин виджетов

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

Для работы с магазинов виджетов достаточно браузера. Интерфейс магазина предполагает работу пользователей на рабочей станции с разрешением не хуже 1920×1080). Интерфейс не поддерживает работу на мобильных устройствах. Для входа в магазин новому пользователю необходимо получить у администратора логин/пароль.

Ролевая модель магазина

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

Требования к ролевым функциям

- Пользователь может видеть список всех виджетов.
- Пользователь может видеть детали одного виджета (описание, тэги, список реализаций).
- Разработчик может добавлять новые виджеты, при этом они становятся доступными для редактирования только ему (становятся «его» виджетами).
- Разработчик может удалить виджет, если он не имеет ни одной реализации в статусе публичной доступности. При удалении виджета, все реализации виджетов также удаляются.
- Разработчик может редактировать метаданные виджетов, которые он добавил сам (его виджеты).
- Разработчик может добавить своему виджету произвольное количество разных тэгов.
- Разработчик может удалить реализацию своего виджета (если он не имеет статуса публичной доступности). Удаляется метаданные и файлы.
- Разработчик может добавить новую реализацию виджета (загрузить новый zip архив). При добавлении новая реализация виджета имеет сброшенный признак публичного доступа (т.е. не доступна для использования).Также при добавлении новая реализация имеет сброшенный признак нарушения обратной совместимости (т.е. считается обратно совместимой). (пока всегда).
- Тестировщик может переводить статус реализации из тестирования в эксплуатацию.
- Администратор может видеть список пользователей.
- Администратор может видеть детали одного пользователя.
- Администратор может добавлять нового пользователя.
- Администратор может давать/забирать роли у пользователя.
Если у учетной записи забрали роль *разработчик*, он теряет возможность менять свои виджеты.

При логине пользователя в магазин загружается список всех виджетов в магазине. Для каждого виджета доступны следующие действия: - загрузить список релизов виджета; - выполнить экпорт виджета; - удалить виджет; - выполнить импорт нового виджета; - создать новый виджет.

Ниже описаны основные операции, доступные пользователям магазина, с учетом их роли.

Создание нового виджета

Нажать Add widget. В окне ввести данные нового виджета: - имя виджета; - описание виджета. По умолчанию новый виджет создается с новым GUID от системы, но если пользователь хочет ввести свой GUID, при отключении генерации GUID появляется строка для ввода GUID. Это уникальный идентификатор виджета, поэтому , при его вводе в ручную слдеует учитывать этот факт. После заполнения всех полей нажать *Add widget*.

Импорт нового виджета

Нажать Import widget. В окне выбрать файл с новым релизом виджета.

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

Спиок релизов виджетов

Нажать Releases - загрузится список релизов виджета. На форме релизов виджета доступны следующие действия: - создать новый релиз виджета; - удалить релиз виджета, если он не был опубликован; - опубликовать релиз; - изменить мета информацию о виджете: GUID, имя, описание.

При создании нового релиза,требуется загрузить zip с виджетом, подготовленный согласно [руководству программиста](/ru/develop).

Нельзя удалить виджет, если он уже опубликован. Поскольку магазин предоставляет виджеты многим инстансам, необходимо учитывать, что в инстансах могут использоваться разные релизы виджетов.

При операции публикации релиза виджета,. новая версия виджета становится доступна инстансам.

Экспорт виджета

Экпорт виджета всегда выгружает последний релиз. GUID и версия релиза виджета указана в файле package-info.json. Операция экспорта и импорта удобна для перемещения виджетов между разными магазинами, например тестовый и продуктовый, поскольку сохраняются GUID и номера версий, и достаточно просто становится сопровождать релизы в разных магазинах. Для экспорта следует нажать кнопку Export, произойдет выгрузка zip файла.

Удаление виджета

Удаление виджета производится по кнопке Delete. После подтверждения операции, удаляется виджет и все го релизы.

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

Действия с пользователями доступно только роли *Администратор*. Следует выбрать в меню пункт Users. Загрузится список пользователей, с указанием их роли, LastName, FirstName. *Администратору* доступны следующие действия: - заблокировать пользователя; - изменить роль пользователя; - изменить пароль пользователя; - добавить нового польльзователя.

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

Ниже в разделе представлено описание некоторых виджетов, которые доступны для построения дашбордов.

Библиотека виджетов

Название виджета Вид, схема виджета Описание
Единичное текущее значение параметра
Единичное текущее значение параметра (Компактное)
В виджет выводится единичное значение текущего параметра.
Схема виджета (на примере):
Название виджета: «Серверная»
Дата/Время последнего значения: «15:08»
Иконка (необязательный) : выбирается из библиотеки иконок
Название параметра, Зона (необязательный), Название объекта, сер. номер контроллера :
Название параметра задается в виджете. Если зона не задана она не выводится, Название объекта и номер контроллера выводятся из текущих названий в рубрикаторе
Статус параметра: выводится в виде цветного фона (красная - критическая, желтая-предупреждение)
Значение параметра: значение в размерностью параметра
Спец. иконки: иконка графика позволяет переходить на график параметра, иконка границ показывает границы контроля параметра. Иконка границы контроля не выводится, если параметр не контролируется
Список значений параметров
Список значений параметров (Компактный)
В виджете выводится список значений параметров. Количество значений в списке настраивается в шаблоне (атрибут paramvalues). Схема вывода значений аналогична описанной схеме в шаблоне «Единичное текущее значение параметра»
Единичное текущее значение параметра c фоновой картинкой Виджет позволяет вывести текущее значение параметра с фоновой картинкой.
Схема виджета (на примере):
Название виджета: «ПРОЗРАЧНОСТЬ ВОДЫ»
Дата/Время последнего значения: «22:23»
Фоновая картинка: выбирается из библиотеки картинок
Иконка (необязательный) : выбирается из библиотеки иконок
Название параметра: Название параметра задается в виджете.
Статус параметра: выводится в виде цветного фона (красная - критическая, желтая-предупреждение)
Значение параметра: значение в размерностью параметра
Название виджета Вид, схема виджета Описание
Интервальное единичное значение параметра
Интервальное единичное значение параметра (Компактный)
В виджет выводится единичное значение параметра на интервале.
Интервал определен значениями ИНТЕРВАЛ и СДВИГ, в параметрах виджета.
Схема виджета (на примере):
Название виджета: «Серверная»
Дата/Интервал значения: «06/01/2018»
Название параметра, Зона (необязательный), Название объекта, сер. номер контроллера :
Название параметра задается в виджете. Если зона не задана она не выводится, Название объекта и номер контроллера выводятся из текущих названий в рубрикаторе
Карта статусов параметра: выводится в виде круговой диаграммы
Значение параметра: значение в размерностью параметра
Список значений параметров на интервале
Список значений параметров на интервале (Компактный)
В виджете выводится список значений параметров на интервале. Количество значений в списке настраивается в шаблоне (атрибут paramvalues). Схема вывода значений аналогична описанной схеме в шаблоне «Интервальное единичное значение параметра»
Название виджета Вид, схема виджета Описание
Таблица значений В виджет-таблицу выводятся текущие значения параметров.
При настройке таблицы следует точно соблюдать следующие правила:
1) В ячейку таблицы можно указать параметр и иконку.
2) При задании картинки в Списке картинок она помещается вверху виджета.
3) Название колонок и строк можно скрывать с помощью атрибутов настройки
4) Если атрибут параметра Управляемый, т.е. ему можно задать значение, в ячейке таблицы появится карандаш, при нажатии на который можно изменить значение в ячейке таблицы
График параметра

В виджет выводятся графики значений параметров для заданного интервала. Интервал определен значениями ИНТЕРВАЛ и СДВИГ в параметрах виджета.
На график можно вывести любое кол-во графиков.
Вид графика может быть трех типов: линейный график, линии в стеке, и японская свеча. Для графика типа «японская свеча» допускается вывод только одного параметра. В виджете активны кнопки-подписи, при клике на них, можно скрывать/показывать график
График пирог с долей участия Виджет выводит доли значений параметров в процентах от суммы значений всех входных параметров для заданного интервала. Интервал определен значениями ИНТЕРВАЛ и СДВИГ в параметрах виджета.
Название виджета Вид, схема виджета Описание
Список сигнальных параметров
Список сигнальных параметров
Виджет построен в виде таблицы и используется для
контроля и управления состояния сигнальных параметров
(параметры, которые имеют 2 состояния-false/true).
Такие параметры могут изменять свое состояние через
работу расписаний или правил, поэтому виджет оперативно
отображает состояние сигналов и позволяет изменить их
состояние тем пользователям, которые имеют права на изменение.
Количество строк в виджете настраивается в шаблоне виджета.
Атрибуты таблицы:
Индикатор состояния: Задается в виде двух иконок для символа
переключателя. Если не задавать иконки, используется «Вкл./Выкл»
Заголовок, имя объекта, зона: Заголовок задается в виджете, Зона и
объект выводятся из текущих названий в рубрикаторе. (не выдается для компактного виджета)
Режим управления: Автоматический, если параметр управляется
расписанием/правилом, ручное-если изменение параметра
осуществляется в ручную.
Последнее переключение: последние дата и время изменения состояния
параметра.
Ручной режим: отсылка команды системе на переход в ручное управление
сигналом. После того, как команда выполнится (до 5 сек-10 сек,
в зависимости от производительности канала с контроллером),
пользователь может переводить сигналы на виджете с помощью Индикатора состояния
Виджет набор иконок сигнальных параметров Виджет выводит сигнальные значения в виде иконок
с состоянием Вкл.- зеленая иконка, Выкл. - красная иконка, Статус не определен - серая иконка.
Название виджета Вид, схема виджета Описание
Комплексный базовый виджет Виджет предоставляет возможность вывода как текущих, так и интервальных значений. Схема представления информации описана в соответствующих типах виджетов
Комплексный виджет№1 Виджет реализует следующую схему показа данных:
верхний атрибут - текущее значение параметра,
атрибут в центре - интервальное значение любого параметра, не обязательно совпадающее с текущим,
нижний атрибут - параметр сигнального типа, характеризующий состояние управления. Подразумевается, что этот параметр связан с двумя верхними параметрами
Название виджета Вид, схема виджета Описание
Виджет событие Виджет предоставляет возможность вывести события платформы. Конфигурация виджета позволяет задать кол-во событий в виджете, задать фильтры на тип события и список объектов. Список событий в виджете обновляется по мере прихода событий в дашборд
Виджет видео-событий Виджет выводит события платформы и связанный с событием видео-контент. Конфигурация виджета позволяет задать кол-во событий в виджете, задать фильтры на тип события и список объектов. Список событий в виджете обновляется по мере прихода событий в дашборд. Для использования этого виджета необходимо, чтобы была настроена интеграция платформы с ПО AxxonSoft (система видеонаблюдения)
Название виджета Вид, схема виджета Описание
Виджет картинка Виджет предоставляет возможность вывода картинки и текста.
Текст располагается по центру картинки на прозрачном фоне. Виджет используется в качестве информационного,
оформительского представления. Внесение текста осуществляется в панели конфигурации виджета в секции I.
Картинка выбирается в библиотеке картинок. Для виджета не задаются параметры.
Виджет заголовок Виджет предоставляет возможность создать тематический блок на дашборде.
Текст блока задается в названии виджета. Виджет создает на всю ширину дашборда строку с текстом, выделяя таким образом остальные виджеты в тематический блок.
Название виджета Вид, схема виджета Описание
Виджет 2D-план Виджет выводит интерактивные представления устройств на подложке-изображении. Подходит для создания интерактивных планов или схем. Список представлений устройств на текущий момент: мультидатчик (температура, влажность, освещенность, шум, CO2), датчик протечки, световые линии, гирконы, видеокамеры. Виджет позволяет увидеть текущие показания датчиков, отображать цветовые статусы и управлять устройствами непосредственно с плана.