Просмотреть исходный

Модуль "Управление лицензиями"

Общая информация

Сервис лицензирования (далее - СЛ):

предназначен для хранения файла лицензии, считывания данных из файла и передачи этих данных приложениям Robin
является отдельным компонентом, который не привязан к какому-то одному конкретному продукту
реализован на net
включен только в Enterprise поставку с web-интерфейсом

На сервере приложений имеется папка, в которую СЛ помещает файл лицензии для его считывания.

Файл лицензии в нужную папку добавляется вручную.

СЛ имеет возможность считывать файл лицензии только с расширением .licx. Если в папке есть файлы с другими расширением, СЛ их игнорирует.

Если в папке несколько файлов с расширением .licx, то СЛ проверяет только самый новый файл (по дате его изменения).

СЛ начинает искать файл лицензии и считывать из него данные при каждом перезапуске.

После проверки файла лицензии СЛ сохраняет данные о лицензиях. Когда приложения обращаются к СЛ для получения информации о лицензиях, СЛ повторно не перепроверяет файл, а сразу отправляет приложениям ранее считанную информацию.

Для просмотра данных о лицензируемых продуктах и управления файлом лицензии в платформе реализован модуль "Управление лицензиями", через пользовательский интерфейс которого и осуществляется доступ к данным.

Модуль "Управление лицензиями"

Модуль "Управление лицензиями» предназначен для отображения записей о лицензиях на продукты платформы Robin.

Документация ROBIN > Управление лицензиями > 2024-05-31_15-56-01.png

Модуль отображается на интерфейсе, если пользователю доступна роль "Администратор лицензирования". Если эта роль недоступна, то модуль "Управление лицензиями" не будет отображаться на экране.

При этом:

Отображение и работа модуля "Управление лицензиями" не зависит от наличия какой-то конкретной лицензии. Даже при отсутствии файла лицензии, модуль все равно будет доступен для работы с ним
На каждый продукт из файла лицензии в таблице имеется отдельная строка
При скролле прокручиваются только строки таблицы, элементы над таблицей и шапка таблицы не перемещаются
Таблица не отображается, если:
- файл лицензии не найден, при этом вместо таблицы отображается текст: "Файл лицензии не найден"
- файл лицензии испорчен, при этом вместо таблицы отображается текст: "Файл лицензии испорчен"
- при попытке прочтения лицензии или передачи данных произошла ошибка, при этом вместо таблицы отображается текст: "Не удалось получить данные из файла лицензии. Неизвестная ошибка"
При возникновении любой ошибки (со стороны бэка или фронта), которая не указана в спецификации отдельно (при переходе в раздел, открытии окон, нажатии кнопок), система выводит уведомление:

"Неизвестная ошибка

Обратитесь к администратору"

Описание столбцов таблицы модуля "Управление лицензиями"

Название элемента

Шаблон\пример

Описание

Продукт

Пример:

Robin AI

Название продукта, на который распространяются права выданной лицензии

Возможные значения в столбце:

Robin Studio
Robin Robot
Robin Orchestrator
Robin Process

Статус

Пример

Истек срок действия

Статус лицензии на продукт

Возможные значения в столбце:

"Активна" – если еще не истек срок действия на продукт
"Истек срок действия" – если истек срок действия на продукт

У Robin Robot в файле лицензии может быть несколько блоков с разными датами истечения срока или дополнительными параметрами

В столбце для каждого блока отображается свой статус

Дата окончания

dd <краткое название месяца>. yyyy

Пример:

30 авг. 2024

Дата, до которой лицензия на продукт будет работать (включительно)

dd <краткое название месяца>. yyyy

Пример:

30 авг. 2024

Дополнительные параметры

Шаблон:

См. в таблице «Сопоставлении параметров файла лицензии и таблицы лицензий»

Помимо даты срока окончания лицензии, у некоторых продуктов есть еще свои дополнительные параметры

У Robin Orchestrator и Robin Process кроме даты окончания нет других параметров, поэтому в столбце "Дополнительные параметры" у этих продуктов будет пусто

Подробнее о значении в столбце в таблице «Сопоставлении параметров файла лицензии и таблицы лицензий»

С помощью выпадающего списка «Столбцы» можно выбрать, какие столбцы будут скрыты или отображены, при этом столбец «Продукт» отображается всегда.

Сопоставление параметров файла лицензии и таблицы лицензий

Подробнее о требованиях к файлу лицензии в

Продукт	Название параметра в файле	Название столбца\параметра в таблице	Значение в файле	Значение в таблице
Любой продукт	Expiration	Столбец "Дата окончания"	Дата в формате "yyyy-MM-dd" Пример: 2023-08-30	Шаблон: dd <краткое название месяца>. yyyy Пример: 30 авг. 2023
Любой продукт			Unlimited	Бессрочная
Robin Studio	LowCode	Столбец "Дополнительные параметры", Параметр "Low-code"	yes
Robin Studio			В лицензии нет блока Robin Robot с этим параметром
Robin Robot	IsDemo	Столбец "Дополнительные параметры", Параметр "Demo"	yes
			В лицензии нет блока Robin Robot с этим параметром	В таблице не будет строки с Robin Robot и параметром "Demo".
	Сочетание параметров: SerialNumber EnvironmentId Username	Столбец "Дополнительные параметры", Параметры: "Серийный номер машины" "Идентификатор среды" "Учётная запись"	3 параметра содержат данные об учетной записи, на которой будет разрешен запуск роботов: SerialNumber - серийный номер машины EnvironmentId - идентификатор среды Username - учетная запись Пример записи в файле: SerialNumber=Fgfdd321C228-009312 EnvironmentId=09q33442399edrftgderfKL Username=LAPTOP-5К400dd\hp	Шаблон: Серийный номер машины <значение из лицензии> Идентификатор среды <значение из лицензии> Учётная запись <значение из лицензии> Пример (см. соотв. пример для файла):
			В лицензии нет блока Robin Robot с этими параметрами	В таблице не будет строки с Robin Robot и параметрами "Серийный номер машины", "Идентификатор среды" и "Учётная запись"
	Concurrent	Столбец "Дополнительные параметры" \ Параметр "Конкурентные лицензии"	целое число >=1 Пример записи в файле: Concurrent=3	Шаблон: Конкурентные лицензии <число из лицензии> Пример:
			В лицензии нет блока Robin Robot с этим параметром	В таблице не будет строки с Robin Robot и параметром "Конкурентные лицензии".

При активации со стороны Администратора лицензирования выполняются следующие операции со стороны СЛ:

Проверка лицензии при перезагрузке СЛ

Администратор запускает или перезагружает СЛ.

2. После успешного запуска, СЛ начинает процесс проверки файла лицензии. Ищет в папке файл с расширением .licx:

1. если найден 1 файл с .licx, выполняется следующий шаг;
2. если найдено несколько файлов с .licx, СЛ выбирает из них самый новый по дате изменения файла и выполняет следующий шаг;
3. если не найден файл с .licx, выполняется шаг №5;
4. если при поиске лицензии возникла неизвестная ошибка, выполняется шаг №5.

3. СЛ проверяет, было ли изменено содержимое файла лицензии (проверяет подпись):

1. Если нет, выполняется след. шаг;
2. Если изменено, СЛ сохраняет информацию об этом. UC на этом завершается;
3. Если при проверке лицензии возникла неизвестная ошибка, выполняется шаг №5.

4. СЛ считывает данные о лицензиях.

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

Проверка лицензии при изменении содержимого папки

Администратор лицензирования изменяет содержимое папки с лицензиями:
1. удаляет один из файлов;
2. переносит файл из папки в другую директорию;
3. добавляет новый файл в папку;
4. изменяет один из файлов;
5. заменяет один файл из папки другим файлом.

2. СЛ начинает процесс проверки файла лицензии. Ищет в папке файл с расширением .licx:

1. если найден 1 файл с .licx, выполняется следующий шаг;
2. если найдено несколько файлов с .licx, СЛ выбирает из них самый новый по дате изменения файла и переходит к выполнению следующего шага;
3. если не найден файл с .licx, выполняется шаг №5;
4. если при поиске лицензии возникла неизвестная ошибка, выполняется шаг №5.

3. СЛ проверяет, было ли изменено содержимое файла лицензии (проверяет подпись):

1. Если нет, выполняется следующий шаг;
2. Если изменено, выполняется шаг №5;
3. Если при проверке лицензии возникла неизвестная ошибка, выполняется шаг №5.

4. СЛ считывает данные о лицензиях.

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

Передача приложению данных о лицензии

Приложение отправило СЛ запрос на получение данных о лицензии одного из приложений.

1. СЛ определяет из запроса, о каком продукте требуется передать данные.

2. СЛ ищет нужные данные среди той информации, которую он сохранил при последней проверке файла лицензии.

3. СЛ отправляет ответ приложению. Возможные варианты ответа:

1. файл лицензии не найден
2. файл лицензии испорчен
3. продукт не лицензирован (в файле не было блока с нужным продуктом)
4. если есть данные о запрашиваемом продукте, СЛ отправляет параметры лицензии этого продукта

4. У ROBIN Robot в файле может быть несколько лицензий с разными параметрами - СЛ сразу отправит данные обо всех лицензия ROBIN Robot.

Просмотр интерфейса СЛ

1.Пользователь авторизуется в системе Вход в систему

2. Если пользователю не доступна роль "Администратор лицензирования", то модуль "Управление лицензиями" не отображается.

3. Если Пользователю доступна роль "Администратор лицензирования" , то ему доступна работа с модулем " Управление лицензиями".

4. При этом Система отображает интерфейс модуля:

если файл лицензии не был найден, на странице отображается только текст:
"Файл лицензии не найден"
если содержимое лицензии изменили (лицензия не прошла проверку подписи), на странице отображается только текст:
"Файл лицензии испорчен"
если возникла неизвестная ошибка, из-за которой сервис лицензирования не может вернуть данные о лицензии, на странице отображается только текст:
"Не удалось получить данные из файла лицензии. Неизвестная ошибка"
если нет каких-либо ошибок с файлом лицензии, на странице отображается таблица со списком лицензий

5. Пользователь просматривает список лицензий на продукты.