/
Управление лицензией

Управление лицензией

Лицензионная политика платформы Visiology предполагает использование именных лицензий для работы с модулями Visiology Designer и Smart Forms. Это означает, что одна лицензия закрепляется за одним конкретным сотрудником. Каждый пользователь, который имеет доступ к платформе (независимо от того, работает ли он в данный момент или нет), занимает одно место в лицензии.

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

Просмотр параметров лицензии

Для просмотра параметров лицензии необходимо выполнить следующие шаги:

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

    button.png

     

  2. В открывшемся окне перейдите на вкладку О лицензии. Здесь вы увидите идентификатор оборудования (Hardware ID), который привязан к вашей лицензии, количество разрешенных активированных пользователей и другую информацию:

    about.png

Существует также альтернативный способ просмотра параметров лицензии – с помощью API:

Для получения параметров лицензии необходимо выполнить следующие шаги:

  1. Получите токен доступа, как описано в секции Получение токена доступа (см. ниже);

  2. Отправьте GET запрос по адресу http(s)://<domain>/v3/workspace-service/api/v1/license, где <domain> – домен или IP-адрес сервера платформы.

Пример запроса в Postman:

GET http://192.168.44.23/v3/workspace-service/api/v1/license

Единственным параметром запроса будет Bearer Token:

 

Key

Value

 

Key

Value

Authorization

Bearer Token

Токен, который вы получили, выполняя шаг 1.

В ответе на запрос вы получите параметры лицензии:

В таблице ниже приведен перечень доступных параметров и их описание:

Параметр

Описание

Параметр

Описание

adminsNumber

Количество администраторов, разрешенных данной лицензией.

editorsNumber

Количество редакторов, разрешенных данной лицензией.

otherUsersNumber

Количество разрешенных пользователей (кроме администраторов и редакторов).

maxData

Максимальный объем данных, разрешенный данной лицензией (в гигабайтах).

trialExpirationDate

Дата окончания действия лицензии.

considerHardwareID

Указывает, используется ли привязка к идентификатору оборудования.

additionalData

Дополнительная информация.

Просмотр списка активированных пользователей

Для просмотра списка активированных пользователей выполните следующие шаги:

  1. Войдите на платформу, используя учетные данные глобального администратора.

  2. В боковой панели нажмите кнопку с изображением шестерёнки:

    button.png

     

  3. Откроется окно со списком пользователей:

    user-list.png

    Интерфейс окна предоставляет следующие возможности:

    • узнать дату последней активности пользователя;

    • найти необходимого пользователя с помощью поисковой строки;

    • активировать или деактивировать пользователя вручную (см. ниже).

    • разрешить или запретить использование соответствующего модуля (дизайнер дашбордов или Smart Forms).

    Общее количество занятых лицензий отображается в заголовке раздела. В нашем примере – 3: «Активированных пользователей: 3».

Так как платформа синхронизирована с Keycloak, список пользователей добавляется на платформу автоматически. Добавляются все пользователи, которые зарегистрированы в Keycloak.

Синхронизация пользователей с Keycloak осуществляется каждые 60 минут. Это означает, что если администратор добавит нового пользователя в Keycloak, он не сразу появится в списке пользователей на платформе (при условии, что пользователь не входит в систему. В случае успешной аутентификации, пользователь будет сразу добавлен в список). Это значение используется по умолчанию. Его можно изменить в поле SyncDataWithAuthServiceCron конфигурационного файла appsettings.json:

image-20240320-062126.png

Активация/деактивация пользователей

Пользователи могут быть активированы/деактивированы двумя способами: вручную и автоматически.

Ручная активация/деактивация

Для активации/деактивации пользователя вручную необходимо сделать следующее:

  1. Войдите на платформу, используя учетные данные глобального администратора.

  2. В боковой панели нажмите кнопку с изображением шестерёнки:

    button.png

     

  3. В открывшемся окне на вкладке Пользователи включите/выключите переключатель напротив пользователя, которого вы хотите активировать/деактивировать. Сделать это можно для двух компонентов платформы:
    - Visiology Designer
    - Smart Forms
    При включенной опции пользователь может работать с компонентом в соответствии со своими правами доступа. Если опция отключена, доступ закрыт:

    • В Visiology Designer пользователь не сможет открыть ни один дашборд при условии, что достигнут лимит по активным пользователям. Если лицензия позволяет еще пользователей, то у пользователя будет доступ как на чтение, так и на редактирование.

    • В Smart Forms система запретит сохранять любые внесенные в формы изменения при условии, что достигнут лимит по активным пользователям (пользователь сможет только просматривать формы). Если лимит не достигнут, пользователь будет активирован при сохранении изменений.

      options.png

Автоматическая активация/деактивация

Автоматическая активация пользователя происходит по-разному, в зависимости от того, каким компонентом он пользуется:

  • Для дизайнера дашбордов автоматическая активация происходит при первом входе пользователя в интерфейс дашборда.

  • Для Smart Forms активация происходит, когда пользователь нажимает кнопку Сохранить после внесения изменений в форме.
    В обоих случаях, глобальный администратор при необходимости может потом деактивировать пользователя в ручном режиме.

Автоматическая деактивация пользователя происходит в двух случаях:

  • когда пользователь удаляется администратором в Keycloak;

  • когда пользователь не был активен в течение количества дней, указанных в конфигурационном файле /var/lib/visiology/scripts/v3/env-files/ws.env:

    WS_INACTIVE_DAYS=180

    Значение по умолчанию – 180 дней. Минимальное допустимое значение – 30 дней. Если вы введете число меньше 30, система автоматически установит значение 30. Ограничений на максимальный срок не предусмотрено.

Управление доступом к компонентам платформы

Платформа позволяет предоставлять или блокировать доступ пользователей к основным модулям – Visiology Designer и Smart Forms.

Управление доступом осуществляется через опцию Разрешено использовать, доступную для настройки глобальному администратору платформы:

options2.png

  • Если опция включена, пользователь имеет полный доступ к модулям в рамках своих ролевых прав. Он может открывать дашборды и формы, просматривать данные, а также создавать и редактировать объекты (при наличии соответствующих прав).

  • Если опция отключена, доступ пользователя к функционалу ограничен. Попытка выполнения ключевых действий приведёт к сообщению об ошибке:

    • В Visiology Designer: при попытке открыть любой дашборд система отобразит сообщение об ошибке.

    • В Smart Forms: пользователь может открыть форму для просмотра, однако попытка сохранить внесенные изменения будет заблокирована с отображением сообщения об ошибке.

Параметр Разрешено использовать глобально разрешает или запрещает пользователю взаимодействие с функционалом дашбордов и Smart Forms, независимо от его статуса активности.

Продление лицензии

По окончании срока действия лицензии вы не сможете создавать и просматривать дашборды на платформе. Для продления лицензии необходимо выполнить несколько шагов:

  1. Получить токен доступа, который будет использоваться для получения идентификатора оборудования;

  2. Получить идентификатор оборудования.

  3. Отправить идентификатор оборудования в компанию Visiology;

  4. Получить лицензионный ключ и активировать его.

Получение токена доступа

Чтобы получить токен доступа, нужно отправить POST запрос по адресу http(s)://<domain>/v3/keycloak/realms/Visiology/protocol/openid-connect/token, где <domain> – домен или IP-адрес сервера платформы.

Пример запроса в Postman:

POST http://192.168.44.23/v3/keycloak/realms/Visiology/protocol/openid-connect/token

Параметры запроса

Key

Value

Параметры запроса

Key

Value

Headers

content-type

application/x-www-form-urlencoded

content-length

<calculated when request is sent>

host

<calculated when request is sent>

Body

grant_type

password

scope

dashboard_service formula_engine dashboard_viewer

client_id

Идентификатор клиента, создаваемого в Keycloak. Рекомендуется создать отдельного клиента для отправки подобных запросов. Пример значения: visiology-designer

В Keycloak для данного клиента должна быть включена поддержка Direct access grants на вкладке Настройки:

direct-acces-grants.png

username

Имя пользователя. Например, admin.

password

Пароль пользователя.

Без имени-1-20240404-105401.png

После получения токена необходимо отключить опцию Direct access grants в Keycloak.

В ответе на запрос вы получите токен доступа:

Без имени-20240404-105457.png

Получение идентификатора оборудования

Теперь, с помощью полученного токена доступа, необходимо получить идентификатор оборудования. Для этого нужно отправить GET запрос по адресу http(s)://<domain>/v3/workspace-service/api/v1/license, где <domain> – домен или IP-адрес сервера платформы.

Пример запроса в Postman:

GET http://192.168.44.23/v3/workspace-service/api/v1/license

Единственным параметром запроса будет Bearer Token:

 

Key

Value

 

Key

Value

Authorization

Bearer Token

Токен, который вы получили, выполняя шаг 1.

Без имени-1-20240404-105557.png

В ответе на запрос вы получите идентификатор оборудования:

Без имени-20240404-105645.png

Ответ на данный запрос также содержит параметры лицензии.

Отправка идентификатора оборудования

После получения идентификатора необходимо отправить его в Visiology по адресу key@visiology.com с корпоративного email адреса. В письме укажите идентификатор оборудования ("Hardware ID") и “Лицензионный номер”, полученный при покупке лицензии.

Активация лицензионного ключа

Для активации ключа сделайте следующее:

  1. Введите команду /var/lib/visiology/scripts/v3/prepare-config.sh с флагом -l и добавьте после него лицензионный ключ. Например:

    v3/prepare-config.sh -l khu67gyiTrcyr3WyrexU5fi76Bvgpi78H/p98jPomp0kpoi9hj76gi76 fvtur4dsy543/sxutrcu65vUoiy6vbo87bPiubNp98jo8jihp8i7gi7Ytd534wsaywr3zs6y453s86u5 fcIo76luybLip78hp98j09J0

  2. Перезапустите сервер, выполнив команду ./run.sh --restart.

  3. Подождите, пока произойдет перезагрузка.

  4. Введите в адресной строке браузера следующий URL:
    <IP>/v3
    где <IP> – IP-адрес или домен вашего сервера:

    Без имени-1-20240404-110004.png

  5. Для авторизации введите свой логин и пароль:

    Без имени-20240404-110050.png

Смотрите также

Развёртывание платформы
Обновление платформы

На этой странице

Время чтения: 3 мин.

Нужна дополнительная помощь?

Свяжитесь с технической поддержкой.