Alpha.Community

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

Функции

Generate

int4 Generate(bool activationFlag)

Создает текст конфигурационного файла Агент Alpha.Security.

Входной параметр отвечает за совместимость создаваемой конфигурации со старыми версиями Alpha.Security (тип значения – bool). В качестве значения следует указывать true.

Результат:

  • сразу после вызова функции активируется событие GenerationStarted;
  • в случае успешного завершения операции активируется событие GenerationFinished, а строка-результат записывается в свойство GeneratedString;
  • в случае неуспешного завершения операции активируется событие GenerationFailure.

Для создания конфигурации должны быть заполнены все обязательные поля. Обязательно следует указать:

Если в процессе создания конфигурации возникнет ошибка, функция вернет ее код. Чтобы ознакомиться с текстом ошибки, обратитесь ко значению свойства Ошибка конфигурирования (Error) компонента, либо ко значению внутренней переменной Error события GenerationFailure.

Read

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.

AddLdap

bool AddLdap(string LDAPHost, int4 LDAPPort)

Добавляет описание LDAP-сервера, к которому должен подключаться агент безопасности. Добавленное описание хранится во внутреннем массиве компонента.

Входные параметры:

  • IP-адрес или имя компьютера, на котором развернут LDAP-сервер;
  • номер порта для подключения к LDAP-серверу.

Функция возвращает результат добавления LDAP-сервера в конфигурацию:

  • true – информация добавлена;
  • false – информацию не удалось добавить.

В случае успешного завершения операции активируется событие LdapListChanged.

ClearLdapList

void ClearLdapList()

Очищает внутренний массив LDAP-серверов компонента.

Функция не требует входных параметров.

В случае успешного завершения операции активируется событие LdapListChanged.

GetLdapHost

string GetLdapHost(int4 index)

Предоставляет IP-адрес одного из указанных в конфигурационном файле LDAP-серверов.

Поскольку в конфигурационном файле может быть указано несколько LDAP-серверов, перечень их IP-адресов записывается в компонент в виде массива. Обратиться к конкретному значению можно по номеру его записи в массив.

Каждый элемент массива соответствует значению атрибута Address одного из xml-элементов <LDAPServer>, вложенного в xml-элемент <LdapHosts>, в конфигурационном файле агента безопасности.

GetLdapPort

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;
}

В результате вызова функций в Журнал времени исполнения запишется список сигналов с их параметрами:

ClearLogConsumersList

void ClearLogConsumersList()

Очищает внутренний массив серверов-потребителей в компоненте.

Функция не требует входных параметров.

В случае успешного завершения операции активируется событие ConsumersListChanged.

AddLogConsumer

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 – информацию не удалось добавить. В таком случае следует проверить значение индекса – оно может быть больше, чем размер массива в компоненте.