В разделе Документация вы найдете все для уверенного старта и работы с Альфа платформой: от пошаговых инструкций по установке и конфигурированию до подробного описания работы компонентов и подсистем. Для поиска необходимых тем и вопросов в документации, воспользуйтесь поиском и фильтрацией результатов.
-
Альфа платформа (ред. 26)
-
Лицензирование Альфа платформы
-
Ключи Guardant
-
Ключи Sentinel
-
-
Правила брандмауэра
-
Настройка DCOM
-
Работа в ОС Linux
-
Alpha.Server 6.5 (ред. 2. Предварительная)
-
Alpha.Server
-
Основные механизмы
-
Приложения
-
Модули
-
Коммуникационные модули
-
Link
-
TCP Сервер
-
-
Modbus
-
Modbus RTU Опросчик
-
Настройка обмена данными со станцией
-
Modbus RTU Станция
-
Modbus TCP Опросчик
-
Modbus TCP Станция
-
-
OPC
-
OPC AE Сервер
-
Функциональные возможности
-
OPC DA
-
OPC DA Клиент
-
OPC DA Сервер
-
-
OPC HDA
-
OPC HDA Клиент
-
OPC HDA Сервер
-
-
OPC UA
-
OPC UA Клиент
-
Настройка обмена данными с OPC UA сервером
-
Установка безопасного соединения
-
Приложения
-
OPC UA Сервер
-
Сертификаты
-
Приложения
-
-
-
МЭК 60870-5
-
МЭК 60870-5-101 Опросчик
-
Приложения
-
МЭК 60870-5-101 Станция
-
МЭК 60870-5-104 Опросчик
-
МЭК 60870-5-104 Станция
-
-
Универсальный модуль Опросчик (Меркурий, DCON)
-
МЭК 61850 Клиент
-
Обмен данными с устройствами
-
Набор данных устройства и сигналы сервера
-
ПОРТАЛ Клиент
-
Настройка обмена данными с ППД
-
ТЭМ-104
-
Приложения
-
BACnet Клиент
-
Настройка обмена данными с устройством
-
Приложения
-
EtherNet/IP Сканер
-
Приложения
-
FINS Клиент
-
Настройка обмена данными с ПЛК
-
MDLC Клиент
-
Настройка обмена данными с устройством MDLC
-
MQTT Клиент
-
Настройка обмена данными
-
Siemens S7 Клиент
-
Настройка обмена данными с ПЛК
-
Приложения
-
SNMP Менеджер
-
SQL Клиент
-
Настройка обмена данными с источником
-
Приложения
-
UNET Клиент
-
-
Служебные модули
-
Клиент безопасности
-
Получение значений из Alpha.Security
-
Модуль вычислений
-
Модуль истории
-
Приложения
-
Подсистема резервирования
-
Data Buffer
-
NetDiag, NetDiag2
-
Приложения
-
ProcessMonitor
-
SMTP
-
Snapshot
-
Запись данных в файл-срез
-
Модули Syslog
-
Syslog Клиент
-
Syslog Сервер
-
Приложения
-
Приложения
-
-
Write VQT
-
FS Generator
-
-
-
Сервисные приложения
-
Конфигуратор
-
Статистика
-
Просмотрщик лога кадров
-
-
Alpha.AccessPoint 6.5 (ред. 2. Предварительная)
-
Alpha.Imitator 6.5 (ред. 2. Предварительная)
-
Приложения
-
Alpha.Historian 4.0 (ред. 3. Предварительная)
-
Устройство и принципы работы
-
Управление базами данных
-
Общие
-
4x
-
3x
-
-
Устаревшие разделы
-
Справочник
-
Настройки базы данных
-
Alpha.Domain 1.5 (ред. 1)
-
Принципы настройки подсистемы
-
Приложения
-
Alpha.DevStudio 4.2 (ред. 4. Предварительная)
-
Руководство пользователя
-
Знакомство с Alpha.DevStudio
-
Разработка проекта
-
Описание домена
-
Добавление компонентов домена
-
-
Добавление объектов
-
Описание объектов
-
Добавление атрибутов
-
-
Пользовательский интерфейс
-
Инструменты
-
Редакторы
-
-
Интерфейс командной строки
-
Справочник
-
Элементы
-
Автоматизация
-
ВНИИАЭС
-
Карты адресов
-
Коммуникационные модули
-
-
Гидроуклон
-
Служебные модули
-
-
Инконтрол
-
Инконтрол
-
-
Контроллеры Modicon
-
Modbus
-
Контроллеры
-
-
Контроллеры OMRON
-
Карты адресов
-
Коммуникационные модули
-
Контроллеры
-
-
Контроллеры REGUL
-
Modbus
-
OPC
-
Контроллеры
-
МЭК 60870-5
-
-
Контроллеры SIMATIC
-
Карты адресов
-
Коммуникационные модули
-
Контроллеры
-
-
Контроллеры ТРЭИ
-
Modbus
-
Карты адресов
-
Коммуникационные модули
-
Контроллеры
-
-
Обобщенные устройства
-
Карты адресов
-
Коммуникационные модули
-
Настройки по умолчанию
-
-
Общие элементы
-
Последовательная шина
-
Устройства
-
-
Программируемые логические контроллеры
-
Modbus
-
OPC
-
Контроллеры
-
-
Развёртывание
-
Компьютеры
-
Устройства
-
-
Связи
-
Ссылки
-
-
Сервер истории
-
Сети BACnet
-
Карты адресов
-
Коммуникационные модули
-
Настройки по умолчанию
-
-
Сети CANopen
-
Карты адресов
-
Коммуникационные модули
-
Настройки по умолчанию
-
-
Сети EtherNet/IP
-
Карты адресов
-
Коммуникационные модули
-
Настройки по умолчанию
-
-
Сети Ethernet
-
Сети KNX
-
Карты адресов
-
Коммуникационные модули
-
Настройки по умолчанию
-
Устройства
-
-
Сети Link
-
Link
-
Карты адресов
-
-
Сети MDLC
-
Карты адресов
-
Коммуникационные модули
-
Настройки по умолчанию
-
-
Сети MQTT
-
Карты адресов
-
Коммуникационные модули
-
-
Сети Modbus
-
Modbus
-
Карты адресов
-
-
Сети NFL
-
Карты адресов
-
Коммуникационные модули
-
-
Сети OPC
-
OPC
-
Карты адресов
-
-
Сети SMTP
-
Карты адресов
-
Служебные модули
-
-
Сети SNMP
-
Карты адресов
-
-
Сети SQL
-
Карты адресов
-
Коммуникационные модули
-
-
Сети Syslog
-
Карты адресов
-
Служебные модули
-
-
Сети МЭК 60870-5
-
Карты адресов
-
МЭК 60870-5
-
-
Сети МЭК 61850
-
Карты адресов
-
Устройства
-
-
ТПТС-НТ
-
Инконтрол
-
Контроллеры
-
-
Теплосчетчики ТЭМ
-
Карты адресов
-
Коммуникационные модули
-
Устройства
-
-
Уровень управления
-
Вычисления
-
-
Файловый обмен
-
Физический уровень
-
Элементы HMI
-
Элементы сервера
-
Карты адресов
-
Коммуникационные модули
-
Коммуникационные модули\Link
-
Коммуникационные модули\Modbus
-
Коммуникационные модули\OPC
-
Коммуникационные модули\МЭК 60870-5
-
Настройки по умолчанию
-
Служебные модули
-
-
-
Атрибуты
-
Om.BACnet
-
Om.CANopen
-
Om.EtherNetIP
-
Om.GenericDevices
-
Om.HMI
-
Om.Hydroslope
-
Om.IEC60870
-
Om.KNX
-
Om.MDLC
-
Om.MQTT
-
Om.OPC
-
Om.PLC
-
Om.Server
-
Om.System
-
-
-
Alpha.Security 1.7 (ред. 18)
-
LDAP-сервер и его настройка
-
Редактирование конфигурации на LDAP-сервере с помощью SecurityConfigurator
-
Приложения
-
Alpha.Om 1.4 (ред. 6. Предварительная)
-
Функции
-
Математические функции
-
Строковые функции
-
Функции обработки времени
-
Функции типа variant
-
-
Приложения
-
Alpha.HMI 2.0 (ред. 31. Предварительная)
-
Руководство пользователя
-
О продукте
-
Основные этапы работы с проектом
-
Запуск дизайнера
-
Запуск на исполнение
-
-
Разработка мнемосхем
-
Экранные формы
-
Компоненты
-
Графические примитивы
-
Готовые компоненты
-
-
Действия с объектами и экранными формами
-
Просмотр характеристик
-
Свойства объектов
-
Свойства в рантайме
-
Обработчики событий
-
Функции объектов
-
-
Заливка градиентом
-
Демонстрационный проект Резервуарный парк
-
-
Источники данных
-
OPC DA
-
TCP
-
Получение событий
-
-
Взаимодействие с окружением проекта
-
Приложения
-
Справочное руководство
-
Компоненты для работы с данными
-
Источник OPC
-
Элемент OPC
-
Источник AP
-
Элемент AP
-
Учетные данные АР
-
Браузер источника АР
-
Запрос алармов
-
Менеджер алармов
-
Запрос значений элемента AP
-
Запрос значений множества сигналов АР
-
Запрос значений сигналов АР
-
Очередь активных алармов
-
-
Компоненты окружения
-
Окружение: архиватор
-
Окружение: группа окон
-
Окружение: окно
-
Окружение: сеть
-
Окружение: файлы
-
Окружение: ошибка работы с файлами
-
Окружение: система
-
Окружение: запрос системного журнала
-
Окружение: браузер файлов
-
Окружение: процесс
-
Окружение: этот процесс
-
Окружение: переменные среды процесса
-
Текстовый файл
-
Оборудование: клавиатура
-
Оборудование: монитор
-
Снимок экрана
-
-
Компоненты для предоставления сервисных функций
-
Статистика: браузер
-
Статистика: JSON-браузер
-
Статистика: узел
-
Статистика: источник данных
-
-
Данные: агрегатор
-
Компоненты печати
-
Печать
-
Принтер
-
Системные принтеры
-
Размеры страницы
-
-
Компоненты для выполнения SQL-запросов
-
Источник SQL
-
Запрос источника SQL
-
Запрос SQL
-
-
Компоненты разметки
-
Линейная разметка
-
Плоская разметка
-
Вес элемента разметки
-
Ограничение размеров элемента разметки
-
Сворачивание элемента разметки
-
Выравнивание элемента разметки
-
Отступы элемента разметки
-
-
Графические компоненты
-
Линейный градиент
-
Радиальный градиент
-
Соединительная линия
-
Место соединения
-
Линия
-
Кривая линия
-
Прямоугольник
-
Эллипс
-
Изображение
-
Точка трансформации
-
-
Компоненты для построения пользовательского интерфейса
-
Индикатор гистограммы
-
Всплывающая подсказка
-
Уведомление
-
Перемещение
-
Кнопка
-
Курсор
-
Глобальный курсор
-
Полоса прокрутки
-
Панель вкладок
-
Системная кнопка
-
Флажок
-
Текст
-
Расширенный текст
-
Поле ввода
-
Редактор текста
-
Индикатор прогресса
-
Ползунок
-
Выпадающий список
-
Фрейм
-
-
Встраиваемые компоненты
-
Alpha.Alarms
-
Свойства
-
Функции
-
События
-
-
Alpha.Trends
-
Свойства
-
Функции
-
События
-
-
-
Компоненты для проверки ввода и преобразования форматов
-
Входной формат
-
Выходной формат
-
Формат булевского значения
-
Формат даты/времени
-
Формат числа с плавающей запятой
-
Проверка ввода
-
Проверка ввода целого числа
-
Проверка ввода беззнакового целого числа
-
Проверка ввода числа с плавающей запятой
-
Проверка ввода регулярного выражения
-
-
Компоненты периодичного выполнения
-
Таймер
-
Мигание
-
Команда
-
Звук
-
Инициализатор
-
Сессия
-
-
Буфер обмена
-
Веб содержимое
-
Компоненты для работы с графиками
-
График: данные
-
График: декоратор линии
-
График: линия
-
График: ось
-
График: поле графика
-
График: реперная линия
-
График: точка пересечения
-
График: экспорт
-
-
Компоненты для формирования древовидной структуры
-
Дерево
-
Источник данных дерева
-
Колонка дерева
-
-
Экранные формы
-
Средство отладки
-
Менеджер проекта
-
Среда исполнения
-
-
Alpha.HMI.WebViewer 2.0 (ред. 31. Предварительная)
-
О продукте
-
-
Alpha.HMI - дополнительные модули
-
Alpha.HMI.Security 2.0 (ред. 15)
-
Руководство пользователя
-
Справочное руководство
-
Контекст безопасности (SecurityContext)
-
Список пользователей (UserList)
-
Настройка безопасности: Контроль целостности (SecurityIntegrityControl)
-
Числовой элемент безопасности (NumericTokenProxy)
-
Строковый элемент безопасности (StringTokenProxy)
-
Булевский элемент безопасности (BoolTokenProxy)
-
Настройка безопасности: Менеджер (SecurityManager)
-
Настройка безопасности: Приложение (SecurityManagerApplication)
-
Настройка безопасности: Пользователь (SecurityManagerUser)
-
Настройка безопасности: Группа (SecurityManagerGroup)
-
Мастер конфигурирования Security (Configurator)
-
Информация лицензирования: Получение (LicenseInfo)
-
-
-
Alpha.HMI.Tables 2.1 (ред. 1)
-
Построение таблицы модели данных
-
Справочник API
-
Таблицы
-
Таблица
-
Свойства
-
Функции
-
События
-
-
Таблица: декоратор
-
Свойства
-
-
Таблица: итератор
-
Свойства
-
Функции
-
-
Таблица: модель данных
-
Свойства
-
Функции
-
События
-
-
Таблица: столбец
-
Свойства
-
Функции
-
События
-
-
Таблица: устойчивый итератор
-
Функции
-
-
-
-
-
Alpha.HMI - библиотеки
-
Alpha.HMI.CommonLib 3.0 (ред. 2)
-
Руководство пользователя
-
Примеры использования компонентов расширения
-
Справочное руководство
-
Типы
-
Тема оформления
-
Конвертер значений
-
Утилиты для работы со строками
-
Утилиты для работы с окном
-
Утилиты для работы с файлами
-
Информация о продукте
-
Буфер аргументов события
-
Обработчик события
-
Пользовательская команда
-
Текстовые шаблоны
-
Редакторы
-
Редактор целого числа
-
Редактор даты
-
Редактор времени
-
Редактор интервала времени
-
Горизонтальный сплиттер
-
Вертикальный сплиттер
-
Рамка с ошибкой
-
Редактор даты и времени
-
-
Меню
-
Элемент меню
-
Результат выбора меню
-
-
Панель инструментов
-
Кнопка панели инструментов
-
Кнопка выпадающего списка
-
Разделитель панели инструментов
-
Панель поиска
-
Тема оформления панели инструментов
-
-
Строка статуса
-
Кнопка авторизации
-
Кнопка-индикатор журнала сообщений
-
Индикатор подключения к серверу
-
Кнопка вызова экранной клавиатуры
-
Параметры вызова экранной клавиатуры
-
-
Диалоги
-
Результат выбора папки
-
Результат выбора цвета
-
Результат выбора параметров подключения
-
Результат выбора даты и времени
-
Результат ввода значения
-
Результат редактирования колонтитула
-
Результат выбора файла
-
Результат диалога авторизации
-
Список файлов
-
Дерево сигналов
-
Журнал сообщений
-
Редактируемая таблица
-
Редактор ячейки таблицы
-
-
Экранные формы
-
Меню
-
Календарь
-
Сообщение
-
Диалог ввода значения
-
Диалог выбора цвета
-
Диалог подключения к серверу
-
Редактор колонтитула
-
Файлы
-
Диалог открытия файла
-
Диалог сохранения файла
-
Диалог выбора папки
-
-
Безопасность
-
Диалог авторизации пользователя
-
Диалог смены пароля
-
Диалог ввода учетных данных
-
-
Общие свойства компонентов библиотеки
-
-
-
-
Alpha.HMI - приложения
-
Alpha.HMI.AdminConsole 1.0 (ред. 3)
-
Руководство пользователя
-
Справочное руководство
-
Консоль администрирования
-
Инструментальная панель
-
Разрешения
-
AdminConsole_Page
-
-
-
Alpha.HMI.Alarms 3.3 (ред. 1. Предварительная)
-
Руководство пользователя
-
Встраивание в проект
-
Привлечение внимания к важным событиям
-
Квитирование событий
-
Экспорт сообщений в файл
-
Справочное руководство
-
Alarms
-
Свойства
-
Функции
-
-
Alarms_Table
-
Свойства
-
Функции
-
-
Alarms_Sounds
-
Свойства
-
Функции
-
-
EventStatistics
-
Свойства
-
-
Разрешения пользователя
-
Свойства
-
Функции
-
-
-
-
Alpha.HMI.ComtradeViewer 1.1 (ред. 1)
-
Встраивание в проект
-
API
-
ComtradeViewer
-
Свойства
-
Функции
-
-
Разрешения (ComtradeViewer_Permissions)
-
Свойства
-
-
-
Alpha.HMI.Explorer 4.0 (ред. 2)
-
Руководство пользователя
-
Справочное руководство
-
Explorer_Form
-
-
Alpha.HMI.IntegrityControl 2.8 (ред. 1)
-
Руководство пользователя
-
Контроль целостности
-
Справочное руководство
-
IntegrityControl
-
IntegrityConfiguration
-
Разрешения
-
Настройки
-
IntegrityControl_KTN
-
IntegrityControl_Form
-
IntegrityConfiguration_Form
-
-
-
Alpha.HMI.SecurityConfigurator 4.0 (ред. 1)
-
Руководство пользователя
-
Редактирование конфигурации
-
Приложения
-
Справочное руководство
-
SecurityConfigurator
-
Настройки
-
Разрешения
-
SecurityConfigurator_Page
-
SecurityConfigurator_Form
-
-
-
Alpha.HMI.SetPoints 2.5 (ред. 2)
-
Руководство пользователя
-
Приложения
-
Справочное руководство
-
SetPoints
-
SetPoints_Settings
-
Разрешения
-
Тема оформления Уставок
-
SetPoints_Page
-
SetPoints_Form
-
-
-
Alpha.HMI.Statistics 1.2 (ред. 1)
-
Руководство пользователя
-
Справочное руководство
-
Statistics
-
Разрешения
-
Настройки
-
Statistics_Form
-
-
-
Alpha.HMI.SystemLogViewer 2.0 (ред. 1)
-
Руководство пользователя
-
Справочное руководство
-
SystemLogViewer
-
Разрешения
-
Тема оформления Журнала событий
-
SystemLogViewer_Form
-
-
-
Alpha.HMI.Trends 2.4 (ред. 1. Предварительная)
-
Руководство пользователя
-
Встраивание в проект
-
Сохранение и загрузка данных
-
Справочное руководство
-
Свойства
-
Функции
-
-
-
-
Alpha.Alarms 3.30 (ред. 1)
-
Варианты запуска
-
Начало работы
-
Аспекты безопасности
-
Просмотр оперативных событий
-
Подавление и блокирование событий источника/объекта
-
Аналитика событий
-
Фильтрация сообщений о событиях
-
Дополнительные возможности
-
Работа со встраиваемым компонентом
-
Alarms-API
-
Свойства
-
Функции
-
События
-
-
-
Alpha.Trends 3.33 (ред. 3. Предварительная)
-
Начало работы
-
Просмотр значений сигналов
-
Аналитика графиков
-
Использование реперных линий
-
Вертикальные реперы
-
-
Вспомогательные функции
-
Работа со встраиваемым компонентом Alpha.Trends
-
Свойства
-
Функции
-
События
-
-
Alpha.Tools 1.6 (ред. 8)
-
EventLogViewer
-
Приложения
-
OpcExplorer
-
Настройка и подключение к источнику данных
-
Просмотр адресного пространства
-
Приложения
-
-
Alpha.RMap 1.7 (ред. 2)
-
Приложения
-
Установка и настройка
-
-
Alpha.Diagnostics 2.2
-
Alpha.AuditReport
-
Настройка Alpha.AuditReport
-
Alpha.SystemMonitor
-
Интерфейс
-
Настройка
-
Alpha.Hashcheck
-
Настройка конфигурации
-
Alpha.NTPClient
-
Alpha.Utilities
-
Приложения
-
Alpha.Reports 1.1 (ред. 18)
-
Руководство администратора
-
Приложения
-
Конфигуратор
-
Конструктор отчётов
-
Описание интерфейса и функций программы
-
Приложения
-
Поддерживаемые функции
-
Текстовые
-
Числовые
-
Математические
-
Информационные
-
Логические
-
Поиск и ссылки
-
Дата и время
-
База данных
-
Финансовые
-
-
-
Библиотека
-
Функции библиотеки
-
Приложения
-
Просмотр отчётов
-
-
Alpha.SmartControl 9.3 (ред. 1)
-
Администрирование
-
Отчеты
-
Бланки переключений
-
Специальные возможности
Информация лицензирования: Получение (LicenseInfo)
Компонент предназначен для получения информации о лицензии на компоненты Альфа платформы (далее – продукты), установленные на локальной или удаленных рабочих станциях, включенных в сеть Alpha.Net.
Чтобы получить информацию о лицензии из проекта Alpha.HMI, необходимо:
- Добавить экземпляр LicenseInfo на форму.
- Отправить JSON-запрос серверу лицензирования Alpha.Licensing, вызвав функцию компонента RequestLicenseInfo() (или RequestRemoteLicenseInfo(), если запрос отправляется на удаленную рабочую станцию). В качестве входного параметра функции указать JSON-запрос. Шаблоны JSON-запросов приведены ниже.
- В обработчике событий RequestLicenseInfoComplete (RequestRemoteLicenseInfoComplete) указать, что должно происходить при успешном получении JSON-ответа. Для чтения ответа можно использовать внутреннюю переменную события LicenseInfoJSON, куда записывается полученный JSON-ответ. Также ответ записывается в свойство LicenseInfo компонента.
Примеры JSON-ответов приведены ниже.
При отправке нескольких JSON-запросов из одной команды следует учитывать разницу в чтении ответа из внутренней переменной LicenseInfoJSON и из свойства LicenseInfo.
Значение свойства LicenseInfo перезаписывается при получении каждого нового значения, а в переменной LicenseInfoJSON полученное значение сохраняется до передачи в обработчик события. Так как процесс обработки асинхронный, то к моменту выполнения обработчика значение свойства LicenseInfo может несколько раз измениться. А значение аргумента LicenseInfoJSON будет тем же, что и в момент наступления события.
- В обработчике событий 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",
...
]
}
}
| Поле | Описание |
|---|---|
licenseKeyId
|
Идентификатор ключа. |
licenseKeyClass
|
Класс ключа. Примеры значений – HASP, Guardant. |
licenseKeyType
|
Тип ключа. Обычно здесь указывается, программный это ключ или аппаратный. |
licenseData
|
Массив информации обо всех лицензиях на продукты и/или функции, записанных на этот ключ. Здесь:
|
licenseKeys – List: запрос краткой информации обо всех ключах
Под краткой информацией подразумевается перечень используемых ключей, включающий идентификаторы и названия классов ключей. Чтобы получить краткую информацию обо всех лицензионных ключах, установленных на рабочую станцию, обратитесь к объекту licenseKeys с командой List.
Пример запроса:
{
"command": "List",
"object": "licenseApi/licenseInfo/licenseKeys",
}
Пример ответа:
{
"result":
{
"licenseKeys":
[
{
"licenseKeyId":"0123456789",
"licenseKeyClass":"Guardant"
},
{
"licenseKeyId":"0123456788",
"licenseKeyClass":"Guardant"
}
]
}
}
| Поле | Описание |
|---|---|
licenseKeys
|
Массив информации о ключах. Здесь:
|
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",
...
},
]
}
}
| Поле | Описание |
|---|---|
licenseKeys
|
Массив информации обо всех ключах, установленных на рабочей станции. Количество вложенных объектов массива (в квадратных скобках) соответствует количеству ключей. |
licenseKeyId
|
Идентификатор ключа. |
licenseKeyClass
|
Класс ключа. Примеры значений – HASP, Guardant. |
licenseKeyType
|
Тип ключа. Обычно здесь указывается, программный это ключ или аппаратный. |
licenseData
|
Массив информации обо всех лицензиях на продукты и/или функции, записанных на этот ключ. Здесь:
|
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"
}
}
| Поле | Описание |
|---|---|
licenseFeatureId
|
Идентификатор лицензии на продукт и/или функцию. |
licenseFeatureDescription
|
Название продукта или функции. |
licenseFeatureCountType
|
Тип учёта количества лицензий. Возможные значения:
|
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"
}
...
]
}
}
| Поле | Описание |
|---|---|
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"
}
...
]
}
}
| Поле | Описание |
|---|---|
licenseFeatureId
|
Идентификатор лицензии на продукт и/или функцию. |
licenseFeatureDescription
|
Название продукта или функции. |
licenseFeatureCountType
|
Тип учёта количества лицензий. Возможные значения:
|
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",
...
]
}
}
| Поле | Описание |
|---|---|
licenseKeys
|
Массив информации обо всех ключах, установленных на рабочей станции. Количество вложенных объектов массива (в квадратных скобках) соответствует количеству ключей. Здесь:
|
licenseData
|
Массив информации обо всех лицензиях на продукты и/или функции на сервере. Здесь:
|
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"
}
...
]
}
}
| Поле | Описание |
|---|---|
licenseKeys
|
Массив информации обо всех ключах, установленных на рабочей станции. Количество вложенных объектов массива (в квадратных скобках) соответствует количеству ключей. Здесь:
|
licenseData
|
Массив информации обо всех лицензиях на продукты и/или функции на сервере. Здесь:
|