В разделе Документация вы найдете все для уверенного старта и работы с Альфа платформой: от пошаговых инструкций по установке и конфигурированию до подробного описания работы компонентов и подсистем. Для поиска необходимых тем и вопросов в документации, воспользуйтесь поиском и фильтрацией результатов.
-
Альфа платформа (ред. 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)
-
Администрирование
-
Отчеты
-
Бланки переключений
-
Специальные возможности
Функции
void Load(string userUID)
Загружает информацию об учетной записи из подсистемы безопасности в элемент.
Входной параметр – уникальный идентификатор (uid) учетной записи вида alpha:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (тип значения - string).
Вызов: SecurityManagerUser.Load("alpha:ab5cc552-a515-48ab-9e82-436aabf6bdfc")
Результат:
- в случае успешного завершения операции активируется событие LoadComplete;
- в случае неуспешного завершения операции активируется событие LoadFailed.
void Save()
Отправляет информацию об учетной записи в подсистему безопасности после:
- редактирования ранее выгруженной из подсистемы безопасности учетной записи;
- создания учетной записи из проекта Alpha.HMI с помощью функции New() и свойств элемента.
Функция не требует входных параметров.
При вызове функции выполняется автоматическая проверка уникальности указанного логина.
Вызов: SecurityManagerUser.Save()
Результат:
- в случае успешного завершения операции активируется событие SaveComplete;
- в случае неуспешного завершения операции активируется событие SaveFailed.
SetId
void SetId(id string)
Задает id для учетной записи, загруженной в элемент.
Входной параметр – идентификатор в виде строки.
Идентификатор формируется подсистемой безопасности автоматически в момент создания учетной записи. Эту функцию можно использовать для указания собственного идентификатора при создании новой учетной записи.
uint2 SetPassword(string password)
Устанавливает пароль для учетной записи, загруженной в элемент.
Входной параметр – пароль в виде строки. Функция возвращает код ошибки установки пароля. Коды ошибок аналогичны приведенным в описании функции ValidatePassword().
Подсистема безопасности Alpha.Security не накладывает требований к содержанию пароля. Требования к паролю устанавливаются путем назначения прав из стандартного приложения Alpha.Security.
uint2 ValidatePassword(string password)
Проверяет устанавливаемый пароль на соответствие назначенным парольным политикам, без установки пароля пользователю.
Входной параметр – пароль в виде строки. Функция возвращает код несоответствия парольным политикам. Если функция возвращает 0, ошибок нет.
| Возвращаемое значение | Описание ошибки |
|---|---|
| 1 | Не используется. |
| 2 | Длина пароля не соответствует требуемой. |
| 4 | В пароле отсутствуют цифры. |
| 8 | В пароле отсутствуют символы верхнего регистра. |
| 16 | В пароле отсутствуют символы нижнего регистра. |
| 32 | В пароле отсутствуют специальные символы. |
| 64 | Ошибка при чтении значений прав, устанавливающих сложность пароля для пользователя. |
| 128 | Пароль должен отличаться от предыдущих паролей. |
| 256 | Пароль не должен содержать пробелы. |
| 512 | Ошибка при чтении значения права, устанавливающего минимальную длину пароля. |
| 1024 | Пароль не может быть пустым. |
При возникновении нескольких ошибок, их коды складываются. Например, получено значение 18. Это сумма 2 и 16, где 2 – недопустимая длина пароля, а 16 – отсутствие символов нижнего регистра.
Подсистема безопасности Alpha.Security не накладывает требований к содержанию пароля. Требования к паролю устанавливаются путем назначения прав из стандартного приложения Alpha.Security: Количество в пароле символов в нижнем регистре (LowerCount), Количество в пароле символов в верхнем регистре (UpperCount), Количество цифровых символов в пароле (NumberCount), Сложность пароля (PasswordComplexity), Минимальная длина пароля (PasswordMinLength), Количество специальных символов в пароле (SpecialCount).
string GetGroupsList()
Предоставляет список групп, в которых состоит пользователь учетной записи, загруженной в элемент.
Функция не требует входных параметров.
Возвращает данные в JSON-формате.
Вызов: SecurityManagerUser.GetGroupsList()
Результат запроса списка групп в JSON-формате:
{
"data": [
{
"groupID": "alpha:ab5cc552-a515-48ab-9e82-436aabf6bdfc",
"groupName": "Диспетчеры"
}
]
}
string GetApplicationsList()
Предоставляет список приложений с правами пользователя, чья учетная запись загружена в элемент.
Функция не требует входных параметров.
Возвращает данные в JSON-формате.
Вызов: SecurityManagerUser.GetApplicationsList()
Результат запроса списка приложений в JSON-формате:
{
"data": [
{
"appID": "Alpha.Security",
"appName": "Alpha.Security"
},
{
"appID": "Управление состоянием оборудования",
"appName": "Управление состоянием оборудования"
}
]
}
GetRoles
string GetRoles(string appID)
Предоставляет список ролей пользователя, чья учетная запись загружена в элемент, в указанном приложении.
Входной параметр – ID приложения, из которого требуется получить список ролей (тип значения – string).
Возвращает данные в JSON-формате.
Вызов: SecurityManagerUser.GetRoles("Управление состоянием оборудования")
Результат запроса списка приложений в JSON-формате:
{
"data": [
{
"roleID": "alpha:ec5b145e-7d43-4c18-934c-1da6d4cb407f",
"roleName": "rolename"
}
]
}
GetRights
string GetRights(string appID)
Предоставляет список личных прав пользователя, чья учетная запись загружена в элемент, из указанного приложения.
Входной параметр – ID приложения, из которого требуется получить список прав (тип значения – string).
Возвращает данные в JSON-формате. Для строковых прав значения (если их несколько) разделены сочетанием символов \n.
Для получения списка эффективных прав используйте функцию GetEffectiveRights.
Вызов: SecurityManagerUser.GetRights("Управление состоянием оборудования")
Результат запроса списка приложений в JSON-формате:
{
"data": [
{
"appName": "Управление состоянием оборудования",
"tokenType": "bool",
"tokenName": "Управление резервуаром",
"tokenDescription": "Право управления резервуаром",
"ownerId": "alpha:07dba445-1903-498c-abdf-af7f55c145c4",
"tokenValueAllow": "TRUE",
"tokenValueDeny": "FALSE"
}
]
}
string GetEffectiveRights(string appID)
Предоставляет список эффективных прав пользователя, чья учетная запись загружена в элемент, из указанного приложения.
Входной параметр – ID приложения, из которого требуется получить список эффективных прав (тип значения – string).
Возвращает данные в JSON-формате. Для строковых прав значения (если их несколько) разделены сочетанием символов \n.
Вызов: SecurityManagerUser.GetEffectiveRights("Управление состоянием оборудования")
Результат запроса списка приложений в JSON-формате:
{
"data": [
{
"appName": "Управление состоянием оборудования",
"tokenType": "bool",
"tokenName": "Управление резервуаром",
"tokenDescription": "Право управления резервуаром",
"ownerId": "alpha:07dba445-1903-498c-abdf-af7f55c145c4",
"tokenValueAllow": "TRUE",
"tokenValueDeny": "FALSE"
}
]
}
void New()
Освобождает элемент от загруженной в него информации для создания нового приложения.
Функция не требует входных параметров.
Вызов: SecurityManagerUser.New()
После создания новой учетной записи не забудьте загрузить её в подсистему безопасности с помощью функции Save().
AddRole
void AddRole(string roleUID)
Назначает указанную роль пользователю, чья учетная запись загружена в элемент.
Входной параметр – уникальный идентификатор (uid) роли вида alpha:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (тип значения - string).
Вызов: SecurityManagerUser.AddRole("alpha:4ce9483e-e137-41c2-bf1c-343e9b731f20")
DeleteRole
void DeleteRole(string roleUID)
Лишает указанной роли пользователя, чья учетная запись загружена в элемент.
Входной параметр – уникальный идентификатор (uid) роли вида alpha:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (тип значения - string).
Вызов: SecurityManagerUser.DeleteRole("alpha:4ce9483e-e137-41c2-bf1c-343e9b731f20")
void AddGroup(string groupUID)
Добавляет в указанную группу пользователя, чья учетная запись загружена в элемент.
Входной параметр – уникальный идентификатор (uid) группы вида alpha:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (тип значения - string).
Вызов: SecurityManagerUser.AddGroup("alpha:ffdad1f9-ae36-4980-82b8-c7180a63b451")
DeleteGroup
void DeleteGroup(string groupUID)
Удаляет из указанной группы пользователя, чья учетная запись загружена в элемент.
Входной параметр – уникальный идентификатор (uid) группы вида alpha:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (тип значения - string).
Вызов: SecurityManagerUser.DeleteGroup("alpha:ffdad1f9-ae36-4980-82b8-c7180a63b451")
AddRight
void AddRight(string appID, string rightName, uint1 rightType, string allowedValue, string forbidenValue)
Назначает право пользователю, чья учетная запись загружена в элемент.
Входные параметры:
- ID приложения, содержащего право (тип значения – string);
- имя права (тип значения – string);
- тип права (тип значения – uint1):
- 0 – строковый;
- 1 – логический;
- разрешающее значение права (тип значения – string);
- запрещающее значение права (тип значения – string).
Для строковых прав значения (если их несколько) можно разделить с помощью сочетания символов \n. Пример: "значение1\nзначение2\nзначение3".
Вызов: SecurityManagerUser.AddRight("Управление состоянием оборудования","Управление насосом",1,"true","false")
ChangeRight
void ChangeRight(string appID, string rightName, string allowedValue, string forbidenValue)
Меняет значения прав пользователя, чья учетная запись загружена в элемент.
Входные параметры:
- ID приложения, содержащего право (тип значения – string);
- имя права (тип значения – string);
- новое разрешающее значение права (тип значения – string);
- новое запрещающее значение права (тип значения – string).
Для строковых прав значения (если их несколько) можно разделить с помощью сочетания символов \n. Пример: "значение1\nзначение2\nзначение3".
Вызов: SecurityManagerUser.ChangeRight("Управление состоянием оборудования","Управление насосом","false","true")
DeleteRight
void DeleteRight(string appID, string rightName)
Лишает права пользователя, чья учетная запись загружена в элемент.
Входные параметры:
- ID приложения, содержащего право (тип значения – string);
- имя права (тип значения – string).
Вызов: SecurityManagerUser.DeleteRight("Управление состоянием оборудования","Управление насосом")
string GetErrorDescriptionByCode(uint1 FailReasonCode)
Возвращает текстовое описание ошибок, возникающих при загрузке и сохранении учетных записей.
Входной параметр – переменная FailReasonCode (тип значения – uint1).