Конфигуратор модели

Примечание

Конфигуратор работает с платформой через API. Форматы всех команд создания/чтения/обновления/удаления узлов иерархии можно найти в документации по указанной ссылке.

Первый запуск

Запускаем платформу (Установка и запуск).

Запускаем браузер и в строке адреса пишем: http://localhost/grafana.

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

По умолчанию открывается экран с конфигуратором.

При первом запуске в низ экрана атоматически добавляется панель, которую можно удалить:

Папки модели

Создаваемая модель объекта и информационной системы имеет иерархическую структуру.

На верхнем уровне иерархии находятся узлы, в которых создаются экземпляры соответствующих сущностей.

Проще освоить работу с конфигуратором на примерах.

Объекты

Внутри этой папки создаётся основная иерархия - модель объекта. Иерархия имеет любой уровень вложенности и может включать в себя объекты, теги, тревоги, методы.

Теги

Наиболее простой случай модели объекта - это линейный список его параметров (тегов).

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

Для этого случая служит отдельная папка Теги.

Коннекторы

В этой папке создаются описания коннекторов. Параметры, задаваемые в узле-описании коннектора, зависят от конкретного коннектора.

Расписания

Папка для создания расписаний - генераторов событий.

Хранилища данных

Папка, в которой хранятся описания хранилищ данных. Исторические данные, факты возникновения, пропадания и квитирования тревог хранятся в этих хранилищах.

Примечание

Открытая версия платформы «Пересвет» поддерживает работу только с одним хранилищем, поэтому в конфигураторе для открытой платформы отсутствует узел «Хранилища данных».

Создание новых узлов

1. Выбираем нужный узел, внутри которого хотим создать дочерний.

2. Выбираем нужную синюю кнопку и, нажав её, создаём новый экземпляр необходимой нам сущности.

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

Кроме того, изменится набор кнопок в верхней части конфигуратора.

Синие кнопки показывают, экземпляры каких сущностей могут быть созданы внутри выбранного узла.

Например: внутри объекта могут быть созданы другие объекты или теги; внутри тега могут быть созданы методы и тревоги.

Новый объект

Новый тег

Красная кнопка - удаление выбранного узла из иерархии.

При создании нового узла в иерархии с помощью конфигуратора он создаётся с параметрами по умолчанию. Поэтому имя нового узла совпадает с его идентификатором.

Редактирование свойств узла

На панели справа редактируем свойства узла. При этом изменённые свойства обводятся синей рамкой.

Если у узла изменено хотя бы одно свойство, то активизируются две кнопки:

Записать - сохранение в модели изменённых свойств и

Сбросить - отмена внесённых изменений, возврат к начальным параметрам.

Нажимаем кнопку Записать:

Экспорт данных тега в Excel

Для тега на вкладке Запрос на чтение выполните запрос кнопкой Получить данные. После успешного ответа станет доступна кнопка Сохранить в Excel. Успешным считается HTTP-ответ с кодом 2xx и корректным JSON, прошедший все ограничения экспорта. Пустой список данных также можно экспортировать. Ошибка HTTP или JSON, превышение лимита либо новый запрос сразу очищают предыдущую таблицу и блокируют экспорт.

Файл .xlsx содержит листы Metadata, Data и Raw response:

• Metadata имеет колонки Field, Chunk index, Value. В Field записываются Tag name, Tag ID, HTTP method, Full URL, Parameters JSON, Timestamp, Request JSON и HTTP status.

• Data имеет колонки Tag ID, Series index, Point index, Value index, Chunk index, Value type и Value. Числа и логические значения сохраняют тип Excel.

• Raw response имеет колонки Representation, Part, Content. Representation принимает значения UTF-8 JSON text и Base64 of exact UTF-8 response.

Строки и сериализованные объекты длиннее 30000 UTF-16 code units разбиваются на последовательные chunks с индексами без разрыва Unicode surrogate pair. Строковые XLSX cells создаются явно как строки и записываются буквально, включая начальные =, +, - и @; формулы не создаются. Исходный JSON и Base64 также не изменяются.

Кнопка относится только к последнему успешному запросу. При изменении тега или любого параметра snapshot очищается, таблица удаляется, а экспорт блокируется до следующего успешного запроса.

Для защиты памяти браузера тело ответа проверяется по Content-Length, а затем читается ограниченным streaming reader до JSON-разбора. Экспорт ограничен 25 MiB исходного JSON, 32 MiB полного snapshot запроса, 500000 строками листа Data и 2000000 ячеек workbook. При превышении лимита чтение отменяется, файл не создаётся и выводится ошибка; данные не обрезаются.

Полный URL и объект параметров записываются в файл буквально. Не помещайте секреты в query parameters. Если URL содержит userinfo или в URL/параметрах обнаружены ключи token, api_key, apikey, password, secret, authorization, access_token, client_secret, x-api-key или auth без учёта регистра, конфигуратор потребует явного подтверждения перед скачиванием. URL, параметры и значения не редактируются.

Удаление узла

Выбираем нужный узел в иерархии и нажимаем красную кнопку:

Из иерархии удаляется узел и все его потомки.

Примеры

Работу в конфигураторе с отдельными сущностями проще освоить на примерах.