В разделе Документация вы найдете все для уверенного старта и работы с Альфа платформой: от пошаговых инструкций по установке и конфигурированию до подробного описания работы компонентов и подсистем. Для поиска необходимых тем и вопросов в документации, воспользуйтесь поиском и фильтрацией результатов.
-
Альфа платформа (ред. 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)
-
Администрирование
-
Отчеты
-
Бланки переключений
-
Специальные возможности
Функции
int4 Generate(bool activationFlag)
Создает текст конфигурационного файла Агент Alpha.Security.
Входной параметр отвечает за совместимость создаваемой конфигурации со старыми версиями Alpha.Security (тип значения – bool). В качестве значения следует указывать true.
Результат:
- сразу после вызова функции активируется событие GenerationStarted;
- в случае успешного завершения операции активируется событие GenerationFinished, а строка-результат записывается в свойство GeneratedString;
- в случае неуспешного завершения операции активируется событие GenerationFailure.
Для создания конфигурации должны быть заполнены все обязательные поля. Обязательно следует указать:
- адрес и порт Net-агента – в соответствующих свойствах;
- параметры хотя бы одного LDAP-сервера – с помощью функции AddLdap();
- учетную запись администратора LDAP (в стандартном для LDAP виде) и пароль;
- пароль пользователя, чья учетная запись используется по умолчанию;
- адрес корневой папки LDAP-сервера;
- защищено ли соединение агента безопасности с LDAP-сервером.
Если в процессе создания конфигурации возникнет ошибка, функция вернет ее код. Чтобы ознакомиться с текстом ошибки, обратитесь ко значению свойства Ошибка конфигурирования (Error) компонента, либо ко значению внутренней переменной Error события GenerationFailure.
void Read(string XML)
Выполняет чтение конфигурации из конфигурационного файла Агент Alpha.Security.
Входной параметр – строка, содержащая полный текст конфигурационного файла Агент Alpha.Security в xml-формате (тип значения – string).
Чтобы получить такую строку из файла с помощью компонентов Alpha.HMI, используйте функцию ReadTextFile() компонента Окружение: файлы (File System). В качестве входного параметра функции укажите полный путь к файлу конфигурации.
Пример вызова:
Configurator.Read(FileSystem.ReadTextFile("C:/Program Files/Automiq/Alpha.Security/alpha.security.agent.xml "));
Результат:
- сразу после вызова функции активируется событие ReadingStarted;
- в случае успешного завершения операции активируется событие ReadingFinished;
- в случае неуспешного завершения операции активируется событие ReadingFailure.
bool AddLdap(string LDAPHost, int4 LDAPPort)
Добавляет описание LDAP-сервера, к которому должен подключаться агент безопасности. Добавленное описание хранится во внутреннем массиве компонента.
Входные параметры:
- IP-адрес или имя компьютера, на котором развернут LDAP-сервер;
- номер порта для подключения к LDAP-серверу.
Функция возвращает результат добавления LDAP-сервера в конфигурацию:
- true – информация добавлена;
- false – информацию не удалось добавить.
В случае успешного завершения операции активируется событие LdapListChanged.
void ClearLdapList()
Очищает внутренний массив LDAP-серверов компонента.
Функция не требует входных параметров.
В случае успешного завершения операции активируется событие LdapListChanged.
string GetLdapHost(int4 index)
Предоставляет IP-адрес одного из указанных в конфигурационном файле LDAP-серверов.
Поскольку в конфигурационном файле может быть указано несколько LDAP-серверов, перечень их IP-адресов записывается в компонент в виде массива. Обратиться к конкретному значению можно по номеру его записи в массив.
Каждый элемент массива соответствует значению атрибута Address одного из xml-элементов <LDAPServer>, вложенного в xml-элемент <LdapHosts>, в конфигурационном файле агента безопасности.
int4 GetLdapPort(int4 index)
Предоставляет номер порта для подключения к одному из указанных в конфигурационном файле LDAP-серверов.
Поскольку в конфигурационном файле может быть указано несколько LDAP-серверов, перечень портов для подключения к ним записывается в компонент в виде массива. Обратиться к конкретному значению можно по номеру его записи в массив.
Каждый элемент массива соответствует значению атрибута Port одного из xml-элементов <LDAPServer>, вложенного в xml-элемент <LdapHosts>, в конфигурационном файле агента безопасности.
GetAuditServerHost
string GetAuditServerHost(int4 index)
Предоставляет IP-адрес одного из указанных в конфигурационном файле серверов-потребителей аудита.
Поскольку в конфигурационном файле может быть указано несколько серверов-потребителей, перечень их IP-адресов записывается в компонент в виде массива. Обратиться к конкретному значению можно по номеру его записи в массив.
Каждый элемент массива соответствует значению атрибута Host xml-элемента <Server>, вложенного в один из xml-элементов <OpcDaLogConsumer>, в конфигурационном файле агента безопасности.
GetAuditServerPort
int4 GetAuditServerPort(int4 index)
Предоставляет порт для подключения к одному из указанных в конфигурационном файле серверов-потребителей аудита.
Поскольку в конфигурационном файле может быть указано несколько серверов-потребителей, перечень портов для подключения к ним записывается в компонент в виде массива. Обратиться к конкретному значению можно по номеру его записи в массив.
Каждый элемент массива соответствует значению атрибута TCPServerPort xml-элемента <Server>, вложенного в один из xml-элементов <OpcDaLogConsumer>, в конфигурационном файле агента безопасности.
GetServerProgId
string GetAuditServerPort(int4 index)
Предоставляет ProgID (строковый идентификатор) одного из указанных в конфигурационном файле серверов-потребителей аудита.
Поскольку в конфигурационном файле может быть указано несколько серверов-потребителей, перечень их ProgID записывается в компонент в виде массива. Обратиться к конкретному значению можно по номеру его записи в массив.
Каждый элемент массива соответствует значению атрибута ProgId xml-элемента <Server>, вложенного в один из xml-элементов <OpcDaLogConsumer>, в конфигурационном файле агента безопасности.
GetServerType
string GetServerType(int4 index)
Предоставляет информацию о типе одного из указанных в конфигурационном файле серверов-потребителей аудита.
Поскольку в конфигурационном файле может быть указано несколько серверов-потребителей, перечень их типов записывается в компонент в виде массива. Обратиться к конкретному значению можно по номеру его записи в массив.
Каждый элемент массива соответствует значению атрибута Type xml-элемента <Server>, вложенного в один из xml-элементов <OpcDaLogConsumer>, в конфигурационном файле агента безопасности.
GetSeverityCount
int4 GetServerType(int4 index)
Предоставляет количество категорий важности сообщений для одного из указанных в конфигурационном файле серверов-потребителей аудита.
Поскольку в конфигурационном файле может быть указано несколько серверов-потребителей, значение от каждого из них записывается в компонент в виде элемента массива. Обратиться к конкретному значению можно по номеру его записи в массив.
Каждый элемент массива соответствует количеству элементов <Severity> внутри элемента <SeverityMap>, вложенного в один из элементов <OpcDaLogConsumer>, в конфигурационном файле агента безопасности.
GetSignalsCount
int4 GetSignalsCount(int4 index)
Предоставляет количество сигналов, предназначенных для записи сообщений аудита, в одном из указанных в конфигурационном файле серверов-потребителей аудита.
Поскольку в конфигурационном файле может быть указано несколько серверов-потребителей, значение для каждого из них записывается в компонент в виде элемента массива. Обратиться к конкретному значению можно по номеру его записи в массив.
Каждый элемент массива соответствует количеству элементов <Signal> внутри элемента <SignalMap>, вложенного в один из элементов <OpcDaLogConsumer>, в конфигурационном файле агента безопасности.
GetSeverityCategory
string GetSeverityCategory(int4 i, int4 k)
Предоставляет название выбранной категории важности сообщений.
Поскольку в конфигурационном файле может быть указано несколько серверов-потребителей, каждый из них описывается в компоненте в виде элемента массива A[i]. Каждый элемент массива А[i] представляет собой массив B, каждый элемент B[i,k] которого описывает одну из категорий важности описываемого сервера A[i].
Массив A, описывающий сервера-потребители = [[Массив B, описывающий первый сервер], [Массив B, описывающий второй сервер]] Массив B, описывающий первый сервер = [[Описание первой категории важности], [Описание второй категории важности]] Массив B, описывающий второй сервер = [[Описание первой категории важности], [Описание второй категории важности]]
Обратиться к конкретной категории важности можно по номеру элемента в массивах A и B (i, k).
Каждый элемент массива B[i,k] соответствует одному из значений атрибута Category xml-элемента <Severity>, вложенного в xml-элемент <SeverityMap> одного из xml-элементов <OpcDaLogConsumer> в конфигурационном файле агента безопасности.
Пример использования приведен в описании функции GetSeverityValue().
GetSeverityValue
int4 GetSeverityValue(int4 i, int4 k)
Предоставляет числовое значение выбранной категории важности сообщений.
Поскольку в конфигурационном файле может быть указано несколько серверов-потребителей, каждый из них описывается в компоненте в виде элемента массива A[i]. Каждый элемент массива А[i] представляет собой массив B, каждый элемент B[i,k] которого описывает одну из категорий важности описываемого сервера A[i].
Массив A, описывающий сервера-потребители = [[Массив B, описывающий первый сервер], [Массив B, описывающий второй сервер]] Массив B, описывающий первый сервер = [[Описание первой категории важности], [Описание второй категории важности]] Массив B, описывающий второй сервер = [[Описание первой категории важности], [Описание второй категории важности]]
Обратиться к конкретной категории важности можно по номеру элемента в массивах A и B (i, k).
Каждый элемент массива B[i,k] соответствует одному из значений атрибута Value xml-элемента <Severity>, вложенного в xml-элемент <SeverityMap> одного из xml-элементов <OpcDaLogConsumer> в конфигурационном файле агента безопасности.
Допустим, в конфигурационном файле описан один сервер-потребитель сообщений (один элемент <OpcDaLogConsumer>), для которого описано четыре категории важности сообщений аудита:
<AuditLogConsumers TraceAudit="1">
<OpcDaLogConsumer>
<Server Host="127.0.0.1" Type="OPC" ...>
<SeverityMap>
<Severity Category="Critical" Value="800"/>
<Severity Category="Important" Value="200"/>
<Severity Category="Info" Value="100"/>
<Severity Category="Debug" Value="0"/>
</SeverityMap>
</Server>
</OpcDaLogConsumer>
</AuditLogConsumers>
Чтобы получить список категорий важности сообщений с их значениями в каждом сервере-потребителе, вызовите нужные функции в коде, выполняющемся в случае успешного чтения конфигурации Агент Alpha.Security (например, в обработчике события ReadingFinished). Укажите в качестве входных параметров индексы i (индекс в массиве серверов-потребителей) и k (индекс в массиве категорий важности). Приведенный ниже пример написан на языке Alpha.Om, в нем итоговый список записывается в лог:
i: int4 = 0;
while (i < Configurator.ConsumersCount) //цикл выполняется, пока в массиве A
не будут описаны все сервера-потребители
{
k: int4 = 0;
while (k < Configurator.GetSeverityCount(i)) //цикл выполняется, пока в массив B
не будут записаны все категории важности i-го сервера-потребителя
{
DebugTool.Log("Категория важности: "+Configurator.GetSeverityCategory(i,k)+";
Значение: "+String.ToString(Configurator.GetSeverityValue(i,k)));
//в Журнал времени исполнения записываются названия и значения категорий
важности для i-го сервера
k += 1;
}
i += 1;
}
В результате вызова функций в Журнал времени исполнения запишутся названия категорий важности с их значениями:
GetSignalName
string GetSignalName(int4 i, int4 k)
Предоставляет название указанного сигнала, предназначенного для записи сообщений аудита, в указанном сервере-потребителе.
Поскольку в конфигурационном файле может быть указано несколько серверов-потребителей, каждый из них описывается в компоненте в виде элемента массива A[i]. Каждый элемент массива А[i] представляет собой массив B, каждый элемент B[i,k] которого описывает один из сигналов в описываемом сервере A[i].
Массив A, описывающий сервера-потребители = [[Массив B, описывающий первый сервер], [Массив B, описывающий второй сервер]] Массив B, описывающий первый сервер = [[Описание первого сигнала], [Описание второго сигнала]] Массив B, описывающий второй сервер = [[Описание первого сигнала], [Описание второго сигнала]]
Обратиться к конкретному сигналу можно по номеру элемента в массивах A и B (i, k).
Каждый элемент массива B[i,k] соответствует одному из значений атрибута Name xml-элемента <Signal>, вложенного в xml-элемент <SignalMap> одного из xml-элементов <OpcDaLogConsumer> в конфигурационном файле агента безопасности.
Пример использования приведен в описании функции GetSignalType().
GetSignalMode
int4 GetSignalMode(int4 i, int4 k)
Предоставляет информацию о режиме записи сообщения в указанный сигнал в указанном сервере-потребителе. Возвращает значение в числовом виде, где:
- 1 – соответствует DynamicEvent (запись сообщения с xml-конструкцией, описывающей динамическое событие);
- 2 – соответствует Value (обычная запись сообщения).
Поскольку в конфигурационном файле может быть указано несколько серверов-потребителей, каждый из них описывается в компоненте в виде элемента массива A[i]. Каждый элемент массива А[i] представляет собой массив B, каждый элемент B[i,k] которого описывает один из сигналов в описываемом сервере A[i].
Массив A, описывающий сервера-потребители = [[Массив B, описывающий первый сервер], [Массив B, описывающий второй сервер]] Массив B, описывающий первый сервер = [[Описание первого сигнала], [Описание второго сигнала]] Массив B, описывающий второй сервер = [[Описание первого сигнала], [Описание второго сигнала]]
Обратиться к конкретному сигналу можно по номеру элемента в массивах A и B (i, k).
Каждый элемент массива B[i,k] соответствует одному из значений атрибута Mode xml-элемента <Signal>, вложенного в xml-элемент <SignalMap> одного из xml-элементов <OpcDaLogConsumer> в конфигурационном файле агента безопасности.
Пример использования приведен в описании функции GetSignalType().
GetSignalType
string GetSignalType(int4 i, int4 k)
Предоставляет название типа сообщений в указанном сигнале для указанного сервера-потребителя.
Поскольку в конфигурационном файле может быть указано несколько серверов-потребителей, каждый из них описывается в компоненте в виде элемента массива A[i]. Каждый элемент массива А[i] представляет собой массив B, каждый элемент B[i,k] которого описывает один из сигналов в описываемом сервере A[i].
Массив A, описывающий сервера-потребители = [[Массив B, описывающий первый сервер], [Массив B, описывающий второй сервер]] Массив B, описывающий первый сервер = [[Описание первого сигнала], [Описание второго сигнала]] Массив B, описывающий второй сервер = [[Описание первого сигнала], [Описание второго сигнала]]
Обратиться к конкретному сигналу можно по номеру элемента в массивах A и B (i, k).
Каждый элемент массива B[i,k] соответствует одному из значений атрибута Type xml-элемента <Signal>, вложенного в xml-элемент <SignalMap> одного из xml-элементов <OpcDaLogConsumer> в конфигурационном файле агента безопасности.
Допустим, в конфигурационном файле описан один сервер-потребитель сообщений (один элемент <OpcDaLogConsumer>), в котором для записи сообщений аудита предназначено несколько сигналов:
<AuditLogConsumers TraceAudit="1">
<OpcDaLogConsumer>
<Server Host="127.0.0.1" Type="OPC" ...>
<SignalMap>
<Signal Name="DynEvents.NormalDynSignal" Mode="DynamicEvent" Type="Normal"/>
<Signal Name="DynEvents.AdminDynSignal" Mode="DynamicEvent" Type="Admin"/>
<Signal Name="DynEvents.UserNameDynSignal" Mode="DynamicEvent" Type="UserName"/>
<Signal Name="DynEvents.DisplayNameDynSignal" Mode="DynamicEvent" Type="DisplayName"/>
<Signal Name="DynEvents.GroupNameDynSignal" Mode="DynamicEvent" Type="GroupName"/>
<Signal Name="DynEvents.WorkstationNameDynSignal" Mode="DynamicEvent" Type="WorkstationName"/>
<Signal Name="DynEvents.NormalMessage" Mode="Value" Type="Normal"/>
<Signal Name="DynEvents.AdminMessage" Mode="Value" Type="Admin"/>
<Signal Name="DynEvents.UserNameMessage" Mode="Value" Type="UserName"/>
<Signal Name="DynEvents.DisplayNameMessage" Mode="Value" Type="DisplayName"/>
<Signal Name="DynEvents.GroupNameMessage" Mode="Value" Type="GroupName"/>
<Signal Name="DynEvents.WorkstationNameMessage" Mode="Value" Type="WorkstationName"/>
</SignalMap>
</Server>
</OpcDaLogConsumer>
</AuditLogConsumers>
Чтобы получить список параметров сигналов в каждом сервере-потребителе, вызовите нужные функции в коде, выполняющемся в случае успешного чтения конфигурации Агент Alpha.Security (например, в обработчике события ReadingFinished). Укажите в качестве входных параметров индексы i (индекс в массиве серверов-потребителей) и k (индекс в массиве сигналов). Приведенный ниже пример написан на языке Alpha.Om, в нем список сигналов с их параметрами записывается в лог:
i: int4 = 0;
while (i < Configurator.ConsumersCount) //цикл выполняется, пока в массиве A не будут описаны все сервера-потребители
{
k: int4 = 0;
while (k < Configurator.GetSignalsCount(i)) //цикл выполняется, пока в массив B не будут записаны все сигналы i-го сервера-потребителя
{
DebugTool.Log("Название сигнала: "+Configurator.GetSignalName(i,k)+"; Режим записи: "+String.ToString(Configurator.GetSignalMode(i,k))+"; Тип сообщения: "+Configurator.GetSignalType(i,k)); //в Журнал времени исполнения записывается список сигналов i-го сервера
k += 1;
}
i += 1;
}
В результате вызова функций в Журнал времени исполнения запишется список сигналов с их параметрами:
void ClearLogConsumersList()
Очищает внутренний массив серверов-потребителей в компоненте.
Функция не требует входных параметров.
В случае успешного завершения операции активируется событие ConsumersListChanged.
void AddLogConsumer(string Host, string HostTcpReserve, int4 TCPServerPort, string ProgID, string Type)
Добавляет описание сервера-потребителя аудита сообщений. Добавленное описание хранится во внутреннем массиве компонента.
Входные параметры:
- имя или IP-адрес сервера;
- имя или IP-адрес сервера для резервного канала связи с сервером TCP (значение может быть пустым);
- порт для подключения к TCP-серверу (если выбран TCP-сервер);
- строковый идентификатор OPC-сервера (если выбран OPC-сервер);
- тип сервера:
- для Windows возможны значения OPC (по умолчанию) и TCP;
- для других ОС допустимо только TCP.
В случае успешного завершения операции активируется событие ConsumersListChanged.
AddSeverity
bool AddSeverity(int4 consumerIndex, string severityCategory, int4 severityValue)
Добавляет в компонент категорию важности сообщений для указанного сервера-потребителя.
Входные параметры:
- индекс сервера-потребителя во внутреннем массиве компонента;
- название категории важности;
- значение категории важности.
Функция возвращает результат добавления категории в компонент:
- true – категория добавлена;
- false – категорию не удалось добавить. В таком случае следует проверить значение индекса – оно может быть больше, чем размер массива в компоненте.
AddSignal
bool AddSignal(int4 consumerIndex, string signalName, int4 signalMode, string signalType)
Добавляет в компонент информацию о сигнале, предназначенном для записи сообщений, для указанного сервера-потребителя.
Входные параметры:
- индекс сервера-потребителя во внутреннем массиве компонента;
- название сигнала;
- режим записи сообщения в сигнал:
- 1 – соответствует DynamicEvent (запись сообщения с xml-конструкцией, описывающей динамическое событие);
- 2 – соответствует Value (обычная запись сообщения);
- тип сообщений, записывающихся в сигнал.
Функция возвращает результат добавления информации о сигнале в компонент:
- true – информация добавлена;
- false – информацию не удалось добавить. В таком случае следует проверить значение индекса – оно может быть больше, чем размер массива в компоненте.