Создание нового проекта
Порядок создания проекта для единоразового или многократного мониторинга работы модели.
Переход к форме создания проекта
Переход к форме создания нового проекта осуществляется из основного меню приложения одним из следующих способов.
- Способ 1: Панель управления > Создать > Проект
-
Алгоритм создания проекта из шаблона описан на отдельной странице.
В результате откроется редактор для создания нового проекта:
Обзор редактора проекта
В редакторе проекта есть 8 основных разделов:
- Выбор типа объекта (проект или шаблон проекта). В данном случае автоматически выбран тип "Проект"
- Заполнение/редактирование основной информации (уникальное название и описание)
- Добавление/удаление/редактирование узлов (данных, преобразований или метрик)
- Добавление/удаление/редактирование ребер (связей между узлами)
- Настройка расписания
- Добавление/удаление/редактирование светофоров проекта
- Добавление/удаление/редактирование доступов
- Добавление/удаление/редактирование меток
Кроме того, для проекта доступны кнопки просмотра диаграммы с отображением узлов и ребер между ними, сохранения проект и удаления несохраненных данных о проекте.
Также в редакторе есть кнопка добавления нового объекта. С ее помощью можно одновременно создавать несколько проектов.
Название и описание проекта являются текстовыми полями, которые вводятся пользователем. Название проекта должно быть уникальным и содержать только латинские буквы, цифры, знаки "дефис" и "нижнее подчеркивание".
После заполнения всех параметров проекта необходимо нажать на кнопку сохранения и в появившемся всплывающем окне подтвердить создание проекта.
Подробнее о других настройках ниже.
Настройка узлов проекта
После добавление узла с помощью кнопки «+» появляется форма для настройки узла:
В форме доступны следующие поля:
- Тип узла: выпадающий список с вариантами «Метрика», «Преобразование» или «Датасет».
- Алиас узла: техническое название узла, по которому будет производиться обращение к его содержимому в рамках проекта. Например, по алиасу узла с датасетом будет производиться обращение к данным в параметрах метрики. Алиас должен содержать только латинские буквы и цифры, и не должен повторяться в рамках проекта.
- Настройки: набор дополнительных полей, зависящих о типа узла, с кнопкой «+», предназначенной для добавления в узел конкретного объекта соответствующего типа
Ниже приведены описания настроек по типам объектов.
Узел датасета
При выборе типа узла «Датасет» кнопка «+» для настроек раскроет модельное окно с каталогом датасетов:
После выбора датасета из каталога в пункте «Настройки» появятся поля с параметрами, описывающими выбранный датасет. Данные поля являются информационными, дальнейшая настройка узла не требуется:
Узел преобразования
При выборе типа узла «Преобразование» кнопка «+» для настроек раскроет модельное окно с каталогом преобразований:
После выбора преобразования из каталога в пункте «Настройки» появятся поля с параметрами, описывающими выбранное преобразование:
Часть из параметров редактируемы и являются входными данными для преобразования, поэтому необходимо нажать на кнопку редактирования и в открывшемся окне ввести необходимые данные:
Узел метрики
При выборе типа узла «Метрика» кнопка «+» для настроек раскроет модельное окно с каталогом метрик:
После выбора метрики из каталога в пункте «Настройки» появятся поля с параметрами, описывающими выбранную метрику:
Часть из параметров редактируемы и являются входными данными для метрики, поэтому необходимо нажать на кнопку редактирования и в открывшемся окне ввести необходимые данные:
Настройка ребер проекта
Ребра соединяются узлы друг с другом для определения последовательности выполнения узлов.
Для настройки ребер необходимо нажать на кнопку отображения диаграммы проекта, а затем соединить узлы в нудной последовательности, протянув стрелку от одного узла к другому. Ребра определятся автоматически в соответствующем поле:
Важно учитывать ограничения на работу с ребрами для разных типов узлов:
- Датасет: нельзя создавать входящие в узел ребра, исходящие ребра могут вести в узел преобразования или метрики.
- Преобразование: входящие ребра могут исходить из узла датасета или другого преобразования, исходящие ребра могут вести в узел преобразования или метрики.
- Метрика: входящие ребра могут исходить из узла датасета или преобразования, нельзя создавать исходящие ребра
Ограничений на число входящих и исходящих ребер для любого узла нет.
Дополнительной параметризации у ребер нет.
Настройка расписания
Единоразовый запуск
Важно
Если планируется единоразовый запуск проекта, не проводите настройку расписания.
Расчет начнется сразу после создания проекта.
Регулярные запуски
После выбора настройки расписание откроется модальное окно настройки расписания:
Период (обязательно) - периодичность запуска проекта:
- Ежедневно;
- Еженедельно;
- Ежемесячно.
Режим (обязательно) - режим забора данных из источника:
- От даты запуска - период отсчитывается от даты запуска;
- Ближайший законченный полный период - ближайший законченный полный период (неделя с пн по вс / месяц с 1 по 31 число / ...).
Дата начала (обязательно) - дата начала регулярного мониторинга. От этой даты "назад" отсчитываются периоды для забора данных.
Количество периодов (обязательно) - количество периодов для забора данных (ширина скользящего окна), данные за это число периодов будут учтены в расчетах.
Пример
Пусть датой начала проекта выбрано 20 октября 2022 (четверг),
период - еженедельно, количество периодов - 2.
Тогда в случае выбора режима От даты запуска
расчеты будут проводиться на данных за 6-20 октября 2022 (2 недели с чт по чт), а при выборе режима
Ближайший законченный полный период - на данных за 3-17 октября 2022 (2 недели с пн по пн).
Важно
Настройка скользящего окна для забора данных при регламентных запусках проекта
доступна только для датасетов с отмеченным Столбцом, содержащим дату наблюдения
при создании датасета.
Для датасетов без такого столбца
регламентный запуск проекта также возможен. В этом случае при каждом запуске
для расчета берутся все записи, имеющиеся в объекте данных на текущий момент.
Настройка светофоров
Светофор проекта – это показатель качества метрик всего проекта в целом. Светофор может быть зеленым, желтым, или красным. Также светофор может быть главным и дополнительным. Главный светофор отображается в каталоге проектов.
При нажатии на кнопку добавления светофора появляется модальное окно настройки светофора:
Параметры светофора следующие:
- Название (обязательно)
- Тип (обязательно):
- Главный светофор - отображается в каталоге как светофор по проекту, может быть не более одного;
- Дополнительный светофор - отображается только в проекте, может быть сколько угодно.
- Правило вычисления светофора (обязательно).
Правило светофора можно заполнить автоматически с помощью кнопки «Установить правило по умолчанию». В таком случае создастся правило, которое использует все метрики проекта, которые возвращают скалярное значение. Логика правила будет основываться на светофоры метрик – если все светофоры метрик зеленые – светофор проекта зеленый. Если есть хоть один красный светофор метрики – светофор проекта красный. В иных случаях светофор проекта желтый.
Альтернативный метод создания правила – ручное написание правила, после чего необходимо нажать на кнопку «Валидировать» для проверки правильности написанного правила. При написании правила необходимо придерживаться следующего синтаксиса:
- Правило представляет собой логическое выражение формата
If условие then действие [elif условие then действие] else действие
. Блокelif
может повторяться ноль и более раз. - Действие – это либо блок с присвоение цвета светофора при выполнении условия.
Имеет вид
result = <GREEN|YELLOW|RED>
. Либо вложенное if-выражение той же структуры. - Условие – это логическое выражение, содержащее сравнения
скалярных значений метрик или их светофоров с какими-либо значениями:
- Для обращения к скалярному значению метрики необходимо использовать метод
scalar(<алиас ноды с метрикой>)
. Доступные логические операторы:>,
<,
>=
,<=
,==
,!=
. Сравнение производится либо со скалярным значением другой метрики, либо с действительным числом. - Для обращения к светофору метрики необходимо использовать метод
signal(<алиас ноды с метрикой>)
. Доступные логические операторы:==
,!=
. Сравнение производится либо со светофором другой метрики, либо с константамиRED
,YELLOW
,GREEN
. - В логическом выражении также могут использоваться
круглые скобки и операторы
OR
иAND
.
- Для обращения к скалярному значению метрики необходимо использовать метод
После заполнения всех параметров светофора необходимо нажать кнопку «Добавить».
Настройка доступов
Настройка доступов позволяет определить перечень пользователей, которые могут получить доступ к создаваемому проекту. При нажатии на кнопку настройки доступов открывается соответствующее модельное окно:
На форме доступны следующие поля и кнопки:
- Добавить – добавляет еще одну строчку для заполнения пары пользователь-уровень доступа.
- Имя пользователя – выпадающий список из имен пользователей системы.
- Доступ – уровень доступа, выдаваемый пользователю:
- Владелец – полный доступ с возможностью редактирования проекта;
- Только чтение – доступ только на просмотр результатов отработки проекта.
После заполнения всех параметров доступа необходимо нажать кнопку «Сохранить».
Настройка меток
Метки – это теги проектов. При нажатии на кнопку настройки меток появится окно с выпадающим списком доступных меток, где можно либо выбрать существующие метки, либо написать собственную метку. Число меток на одном проекте не ограничено.
Просмотр созданного проекта
После того как проект создан, в каталоге проектов (Панель управления > Проекты) появляется соответствующая этому проекту строка и отображается статус данного проекта.
Инструкция по просмотру отчета с результатами проекта представлена в разделе "результаты мониторинга".