Alpha.Community

В разделе Документация вы найдете все для уверенного старта и работы с Альфа платформой: от пошаговых инструкций по установке и конфигурированию до подробного описания работы компонентов и подсистем. Для поиска необходимых тем и вопросов в документации, воспользуйтесь поиском и фильтрацией результатов.

Информация лицензирования: Получение (LicenseInfo)

Компонент предназначен для получения информации о лицензии на компоненты Альфа платформы (далее – продукты), установленные на локальной или удаленных рабочих станциях, включенных в сеть Alpha.Net.

Чтобы получить информацию о лицензии из проекта Alpha.HMI, необходимо:

  1. Добавить экземпляр LicenseInfo на форму.
  2. Отправить JSON-запрос серверу лицензирования Alpha.Licensing, вызвав функцию компонента RequestLicenseInfo() (или RequestRemoteLicenseInfo(), если запрос отправляется на удаленную рабочую станцию). В качестве входного параметра функции указать JSON-запрос. Шаблоны JSON-запросов приведены ниже.
  3. В обработчике событий RequestLicenseInfoComplete (RequestRemoteLicenseInfoComplete) указать, что должно происходить при успешном получении JSON-ответа. Для чтения ответа можно использовать внутреннюю переменную события LicenseInfoJSON, куда записывается полученный JSON-ответ. Также ответ записывается в свойство LicenseInfo компонента. Примеры JSON-ответов приведены ниже.

    При отправке нескольких JSON-запросов из одной команды следует учитывать разницу в чтении ответа из внутренней переменной LicenseInfoJSON и из свойства LicenseInfo.

    Значение свойства LicenseInfo перезаписывается при получении каждого нового значения, а в переменной LicenseInfoJSON полученное значение сохраняется до передачи в обработчик события. Так как процесс обработки асинхронный, то к моменту выполнения обработчика значение свойства LicenseInfo может несколько раз измениться. А значение аргумента LicenseInfoJSON будет тем же, что и в момент наступления события.

  4. В обработчике событий RequestLicenseInfoFailed (RequestRemoteLicenseInfoFailed) указать, что должно происходить, если JSON-ответ от сервера получить не удалось. У события есть внутренняя переменная FailReasonCode, куда записывается номер ошибки. Чтобы получить текст ошибки по ее номеру, используйте функцию GetErrorDescriptionByCode() компонента.

Компонент может запрашивать информацию только у сервера лицензирования Alpha.Licensing версии 1.11.2 и новее.

Какую информацию предоставляет сервер лицензирования

Сервер лицензирования – это сервер, хранящий всю информацию о правах на использование продуктов Альфа платформы и/или их отдельных функций. В дальнейшем такие права будем называть лицензиями. Лицензии предоставляются лицензионными ключами. Сервер лицензирования объединяет информацию о лицензиях, предоставляемых всеми лицензионными ключами. На каждой рабочей станции устанавливается свой сервер лицензирования.

Ключи бывают аппаратными и программными. Для лицензирования продуктов используются два вида лицензионных ключей: Sentinel и Guardant. Подробнее об этом – в документе, описывающем лицензирование Альфа платформы.

Таким образом, сервер лицензирования может предоставить:

  • информацию об отдельном лицензионном ключе – его типе, о предоставляемых им лицензиях на компоненты и/или их функции;
  • информацию о конкретной лицензии на продукт и/или его функцию – на определенном ключе или на устройстве в целом (со всех ключей);
  • лицензионные данные – общую информацию обо всех лицензиях на продукты и/или их функции – на определенном ключе или на устройстве в целом (со всех ключей);
  • полную лицензионную информацию – лицензионные данные с устройства в целом (со всех ключей).

Как построить JSON-запрос к серверу лицензирования

Чтобы построить JSON-запрос к серверу лицензирования, необходимо указать команду запроса и объект, которого касается запрос. Некоторые команды требуют указания параметров. Параметры для каждой команды описаны в подразделах с примерами запросов, приведенном ниже.

{
 "command": "команда",
 "object": "объект",
 "params": {}
}

Объект запроса – это описанная выше информация, которую предоставляет сервер лицензирования:

  • Лицензионный ключ licenseKeys. При запросе информации о лицензионном ключе в качестве объекта запроса укажите licenseApi/licenseInfo/licenseKeys.
  • Лицензия на продукт и/или его функцию licenseFeature. При обращении к лицензии на продукт/функцию в качестве объекта запроса укажите licenseApi/licenseInfo/licenseFeature.
  • Лицензионные данные licenseData. При обращении к лицензионным данным в качестве объекта запроса укажите licenseApi/licenseInfo/licenseData.
  • Лицензионная информация licenseInfo. Включает в себя лицензионные данные licenseData и информацию о лицензионных ключах licenseKeys. При обращении к полной лицензионной информации в качестве объекта запроса укажите licenseApi/licenseInfo/licenseInfo.

В запросе можно указать одну из следующих команд:

  • Get – команда для получения информации о конкретном объекте. При использовании этой команды необходимо указывать идентификатор объекта, которого касается запрос. Команду можно отправить объектам licenseKeys и licenseFeature.
  • List – команда для получения списка объектов конкретного типа. В ответе будут получены только значимые поля. Команду можно отправить объектам licenseKeys, licenseData и licenseInfo.
  • Fetch – команда для получения списка объектов конкретного типа. В ответе будет получена вся информация об указанных объектах. Команду можно отправить объектам licenseKeys, licenseData и licenseInfo.

Примеры JSON-запросов и возвращаемых JSON-ответов

Ниже приведены примеры запросов к серверу лицензирования и его ответов для каждого объекта.

licenseKeys – Get: запрос информации о конкретном ключе

Чтобы получить информацию о конкретном лицензионном ключе, в параметрах запроса необходимо указать идентификатор ключа licenseKeyId и его класс licenseKeyClass.

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

{
 "command": "Get",
 "object": "licenseApi/licenseInfo/licenseKeys",
 "params": 
  {
   "licenseKeyId":"0123456789",
   "licenseKeyClass":"Guardant"
  }
}

Пример ответа:

{
 "result":
 {
  "licenseKeyId":"0123456789",
  "licenseKeyClass":"Guardant",
  "licenseKeyType":"Guardant Sign",
  "licenseData":
  [
   {
    "licenseFeatureId":"11",
    "licenseFeatureDescription":"Alpha.HMI",
    "licenseFeatureCountType":"PER_DOMAIN",
    "licenseFeatureCount":"1"
   },
   {
    "licenseFeatureId":"12",
    ...
  ]
 }
}
Описание полей JSON-ответа
Поле Описание
licenseKeyId Идентификатор ключа.
licenseKeyClass Класс ключа. Примеры значений – HASP, Guardant.
licenseKeyType Тип ключа. Обычно здесь указывается, программный это ключ или аппаратный.
licenseData Массив информации обо всех лицензиях на продукты и/или функции, записанных на этот ключ. Здесь:
  • licenseFeatureId – идентификатор лицензии на продукт и/или функцию;
  • licenseFeatureDescription – название продукта или его функции;
  • licenseFeatureCountType – тип учёта количества лицензий. Возможные значения:
    • PER_PROCESS – количество лицензий на процесс;
    • PER_HOST – количество лицензий на хост;
    • PER_DOMAIN – количество лицензий на домен.
  • licenseFeatureCount – количество лицензий, предоставляемых этим ключом.

licenseKeys – List: запрос краткой информации обо всех ключах

Под краткой информацией подразумевается перечень используемых ключей, включающий идентификаторы и названия классов ключей. Чтобы получить краткую информацию обо всех лицензионных ключах, установленных на рабочую станцию, обратитесь к объекту licenseKeys с командой List.

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

{
 "command": "List",
 "object": "licenseApi/licenseInfo/licenseKeys",
}

Пример ответа:

{
 "result":
 {
  "licenseKeys":
  [
   {
    "licenseKeyId":"0123456789",
    "licenseKeyClass":"Guardant"
   },
   {
    "licenseKeyId":"0123456788",
    "licenseKeyClass":"Guardant"
   }
  ]
 }
}
Описание полей JSON-ответа
Поле Описание
licenseKeys Массив информации о ключах. Здесь:
  • licenseKeyId – идентификатор ключа;
  • licenseKeyClass – класс ключа. Примеры значений – HASP, Guardant.

licenseKeys – Fetch: запрос полной информации обо всех ключах

Чтобы получить полную информацию обо всех лицензионных ключах, установленных на рабочей станции, обратитесь к объекту licenseKeys с командой Fetch.

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

{
    "command": "Fetch",
    "object": "licenseApi/licenseInfo/licenseKeys"
}

Пример ответа:

{
 "result":
 {
  "licenseKeys":
  [
   {
    "licenseKeyId":"0123456789",
    "licenseKeyClass":"Guardant",
    "licenseKeyType":"Guardant Sign",
    "licenseData":
    [
     {
      "licenseFeatureId":"11",
      "licenseFeatureDescription":"Alpha.HMI",
      "licenseFeatureCountType":"PER_DOMAIN",
      "licenseFeatureCount":"1"
     },
     {
     "licenseFeatureId":"12",
     ...
    ]
   }
  ],
  [
   {
    "licenseKeyId":"0123456788",
    "licenseKeyClass":"Guardant",
    ...
   },
  ]
 }
}
Описание полей JSON-ответа
Поле Описание
licenseKeys Массив информации обо всех ключах, установленных на рабочей станции. Количество вложенных объектов массива (в квадратных скобках) соответствует количеству ключей.
licenseKeyId Идентификатор ключа.
licenseKeyClass Класс ключа. Примеры значений – HASP, Guardant.
licenseKeyType Тип ключа. Обычно здесь указывается, программный это ключ или аппаратный.
licenseData Массив информации обо всех лицензиях на продукты и/или функции, записанных на этот ключ. Здесь:
  • licenseFeatureId – идентификатор лицензии на продукт и/или функцию;
  • licenseFeatureDescription – название продукта или его функции;
  • licenseFeatureCountType – тип учёта количества лицензий. Возможные значения:
    • PER_PROCESS – количество лицензий на процесс;
    • PER_HOST – количество лицензий на хост;
    • PER_DOMAIN – количество лицензий на домен.
  • licenseFeatureCount – количество лицензий, предоставляемых этим ключом.

licenseFeature - Get: запрос информации о лицензии на продукт или функцию

Чтобы получить информацию о лицензировании конкретного продукта/функции, в параметрах запроса необходимо указать источник:

  • если требуется информация с определенного лицензионного ключа, в параметрах указываются идентификатор ключа licenseKeyId, его класс licenseKeyClass и идентификатор продукта/функции licenseFeatureId.
  • если требуется полная информация со всех ключей, в параметрах указывается только идентификатор продукта/функции licenseFeatureId.

Пример запроса с определенного лицензионного ключа:

{
 "command": "Get",
 "object": "licenseApi/licenseInfo/licenseFeature",
 "params": 
  {
   "licenseKeyId":"0123456789",
   "licenseKeyClass":"Guardant",
   "licenseFeatureId":"11"
  }
}

Пример запроса со всех ключей:

{
 "command": "Get",
 "object": "licenseApi/licenseInfo/licenseFeature",
 "params": 
  {
   "licenseFeatureId":"11"
  }
}

Пример ответа:

{
 "result":
 {
  "licenseFeatureId":"11",
  "licenseFeatureDescription":"Alpha.HMI",
  "licenseFeatureCountType":"PER_DOMAIN",
  "licenseFeatureCount":"1"
 }
}
Описание полей JSON-ответа
Поле Описание
licenseFeatureId Идентификатор лицензии на продукт и/или функцию.
licenseFeatureDescription Название продукта или функции.
licenseFeatureCountType

Тип учёта количества лицензий. Возможные значения:

  • PER_PROCESS – количество лицензий на процесс;
  • PER_HOST – количество лицензий на хост;
  • PER_DOMAIN – количество лицензий на домен.

licenseFeatureCount Количество лицензий, предоставляемых указанным ключом или всеми ключами.

licenseData – List: запрос краткой информации обо всех лицензиях на продукты и/или функции

Под краткой информацией подразумевается перечень лицензий, включающий их идентификаторы и названия продуктов и/или функций. Чтобы получить краткую информацию обо всех лицензиях на продукты и функции, в параметрах запроса необходимо указать источник:

  • если требуются лицензионные данные с определенного лицензионного ключа, в параметрах указываются идентификатор ключа licenseKeyId и его класс licenseKeyClass.
  • если требуются лицензионные данные со всех ключей, параметры указывать не нужно. Обратите внимание, что результат запроса со всех ключей содержит информацию обо всех возможных лицензиях на продукты и функции – в том числе тех, которые могут быть не активны на вашем устройстве.

Пример запроса с определенного лицензионного ключа:

{
 "command": "List",
 "object": "licenseApi/licenseInfo/licenseData",
 "params": 
  {
   "licenseKeyId":"0123456789",
   "licenseKeyClass":"Guardant"
  }
}

Пример запроса со всех ключей:

{
 "command": "List",
 "object": "licenseApi/licenseInfo/licenseData",
}

Пример ответа:

{
 "result":
 {
  "licenseData":
  [
   {
    "licenseFeatureId":"11",
    "licenseFeatureDescription":"Alpha.HMI"
   },
   {
    "licenseFeatureId":"12",
    "licenseFeatureDescription":"Alpha.HMI"
   }
   ...
  ]
 }
}
Описание полей JSON-ответа
Поле Описание
licenseFeatureId Идентификатор лицензии на продукт и/или функцию.
licenseFeatureDescription Название продукта или функции.

licenseData – Fetch: запрос полной информации обо всех лицензиях на продукты и/или функции

Чтобы получить полную информацию обо всех лицензиях на продукты и функции, в параметрах запроса необходимо указать источник:

  • если требуются лицензионные данные с определенного лицензионного ключа, в параметрах указываются идентификатор ключа licenseKeyId и его класс licenseKeyClass.
  • если требуются лицензионные данные со всех ключей, параметры указывать не нужно. Обратите внимание, что результат запроса со всех ключей содержит информацию обо всех возможных лицензиях на продукты и функции – в том числе тех, которые могут быть не активны на вашем устройстве.

Пример запроса с определенного лицензионного ключа:

{
 "command": "Fetch",
 "object": "licenseApi/licenseInfo/licenseData",
 "params": 
  {
   "licenseKeyId":"0123456789",
   "licenseKeyClass":"Guardant"
  }
}

Пример запроса со всех ключей:

{
 "command": "Fetch",
 "object": "licenseApi/licenseInfo/licenseData",
}

Пример ответа:

{
 "result":
 {
  "licenseData":
  [
   {
    "licenseFeatureId":"11",
    "licenseFeatureDescription":"Alpha.HMI",
    "licenseFeatureCountType":"PER_DOMAIN",
    "licenseFeatureCount":"1"
   },
   {
    "licenseFeatureId":"12",
    "licenseFeatureDescription":"Alpha.Server (1 000)",
    "licenseFeatureCountType":"PER_DOMAIN",
    "licenseFeatureCount":"0"
   }
   ...
  ]
 }
}
Описание полей JSON-ответа
Поле Описание
licenseFeatureId Идентификатор лицензии на продукт и/или функцию.
licenseFeatureDescription Название продукта или функции.
licenseFeatureCountType

Тип учёта количества лицензий. Возможные значения:

  • PER_PROCESS – количество лицензий на процесс;
  • PER_HOST – количество лицензий на хост;
  • PER_DOMAIN – количество лицензий на домен.

licenseFeatureCount Количество лицензий, предоставляемых указанным ключом или всеми ключами.

licenseInfo – List: запрос краткой лицензионной информации

Под краткой информацией подразумевается перечень ключей и предоставляемых ими лицензий. Чтобы получить краткую лицензионную информацию, обратитесь к объекту licenseInfo с командой List. Обратите внимание, что результат запроса содержит информацию обо всех возможных лицензиях на продукты и функции – в том числе тех, которые могут быть не активны на вашем устройстве.

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

{
 "command": "List",
 "object": "licenseApi/licenseInfo/licenseInfo"
}

Пример ответа:

{
 "result":
 {
  "licenseKeys":
  [
   {
    "licenseKeyId":"0123456789",
    "licenseKeyClass":"Guardant"
   },
   {
    "licenseKeyId":"0123456788",
    "licenseKeyClass":"Guardant"
   }
  ],
  "licenseData":
  [
   {
    "licenseFeatureId":"11",
    "licenseFeatureDescription":"Alpha.HMI"
   },
   {
    "licenseFeatureId":"12",
    ...
  ]
 }
}
Описание полей JSON-ответа
Поле Описание
licenseKeys

Массив информации обо всех ключах, установленных на рабочей станции. Количество вложенных объектов массива (в квадратных скобках) соответствует количеству ключей. Здесь:

  • licenseKeyId – идентификатор ключа;
  • licenseKeyClass – класс ключа. Примеры значений – HASP, Guardant.
licenseData Массив информации обо всех лицензиях на продукты и/или функции на сервере. Здесь:
  • licenseFeatureId – идентификатор лицензии на продукт и/или функцию;
  • licenseFeatureDescription – название продукта или его функции.

licenseInfo – Fetch: запрос полной лицензионной информации

Чтобы получить полную лицензионную информацию, обратитесь к объекту licenseInfo с командой Fetch. Обратите внимание, что результат запроса содержит информацию обо всех возможных лицензиях на продукты и функции – в том числе тех, которые могут быть не активны на вашем устройстве.

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

{
 "command": "Fetch",
 "object": "licenseApi/licenseInfo/licenseInfo"
}

Пример ответа:

{
 "result":
 {
  "licenseKeys":
  [
   {
    "licenseKeyId":"0123456789",
    "licenseKeyClass":"Guardant",
    "licenseKeyType":"Guardant Sign"
   },
   {
    "licenseKeyId":"0123456788",
    "licenseKeyClass":"Guardant",
    "licenseKeyType":"Guardant Sign"
   }
  ],
  "licenseData":
  [
   {
    "licenseFeatureId":"11",
    "licenseFeatureDescription":"Alpha.HMI",
    "licenseFeatureCountType":"PER_DOMAIN",
    "licenseFeatureCount":"1234567"
   },
   {
    "licenseFeatureId":"12",
    "licenseFeatureDescription":"Alpha.Server (1 000)",
    "licenseFeatureCountType":"PER_DOMAIN",
    "licenseFeatureCount":"0"
   }
   ...
  ]
 }
}
Описание полей JSON-ответа
Поле Описание
licenseKeys

Массив информации обо всех ключах, установленных на рабочей станции. Количество вложенных объектов массива (в квадратных скобках) соответствует количеству ключей. Здесь:

  • licenseKeyId – идентификатор ключа;
  • licenseKeyClass – класс ключа. Примеры значений – HASP, Guardant;
  • licenseKeyType – тип ключа. Обычно здесь указывается, программный это ключ или аппаратный.
licenseData Массив информации обо всех лицензиях на продукты и/или функции на сервере. Здесь:
  • licenseFeatureId – идентификатор лицензии на продукт и/или функцию;
  • licenseFeatureDescription – название продукта или его функции;
  • licenseFeatureCountType – тип учёта количества лицензий. Возможные значения:
    • PER_PROCESS – количество лицензий на процесс;
    • PER_HOST – количество лицензий на хост;
    • PER_DOMAIN – количество лицензий на домен.
  • licenseFeatureCount – количество лицензий, предоставляемых этим ключом.