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

Owned by Эдуард Столяр, created
Last updated: апр. 04, 2024
5 min read

Лицензия – это разрешение на использование программного обеспечения, предоставляемое компанией-разработчиком. Для платформы Visiology лицензии выдаются на определенное количество активных пользователей. Это означает, что одна лицензия может быть использована только для определенного числа людей, которые фактически используют платформу. Каждый активный пользователь, который работает на платформе, использует одно из доступных мест, предусмотренных лицензией.

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

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

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

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

    button.png

     

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

    license-details.png

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

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

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

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

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

GET http://192.168.44.23/v3/dashboard-service/api/licence

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

 

Key

Value

 

Key

Value

Authorization

Bearer Token

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

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

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

Параметр

Описание

Параметр

Описание

adminsNumber

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

editorsNumber

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

otherUsersNumber

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

maxData

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

trialExpirationDate

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

considerHardwareID

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

additionalData

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

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

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

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

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

     

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

    Здесь вы увидите список как активированных, так и не активированных пользователей, а также вы сможете:

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

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

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

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

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

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

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

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

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

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

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

     

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

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

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

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

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

  • когда пользователь не был активен в течение количества дней, указанных в конфигурационном файле appsettings.json:

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

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

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

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

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

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

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

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

Чтобы получить токен доступа, нужно отправить 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 на вкладке General Settings:

username

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

password

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

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

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

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

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

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

GET http://192.168.44.23/v3/dashboard-service/api/licence

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

 

Key

Value

 

Key

Value

Authorization

Bearer Token

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

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

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

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

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

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

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

  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-адрес или домен вашего сервера:

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

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

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

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

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

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

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