Alpha.Community

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

Свойства

Отображаемое имя

Описание объекта (поля объекта). Позволяет указать произвольное (например, русскоязычное) имя для узнаваемости объекта (поля объекта) в проекте. Не мешает использованию базового англоязычного имени объекта (поля объекта) для обращения в коде.

Кардинальное число

Преобразует объект в массив и задает размер массива (количество элементов в массиве).

Значение

1 Одиночный объект.
>1 Массив соответствующей размерности.

Длина

int8 Length

Размер массива (количество элементов в массиве).

Есть только у массивов и доступно только для чтения в режиме рантайма.

Примеры

Записать в текстовое поле длину массива.

TextEdit_1.Text = Str.ToString (SW_1.Length);

Индекс

int8 Index

Индекс элемента в массиве. Позволяет отследить у какого элемента сработало то или иное событие.

Есть только у массивов и доступно только для чтения в режиме рантайма.

Примеры

Записать в текстовое поле индекс элемента массива, у которого сработало событие изменения значения.

TextEdit_2.Text = Str.ToString(Index);

Записать в текстовое поле текущее значение элемента массива, у которого сработало событие изменения значения.

TextEdit_3.Text = Str.ToString(penwidth[Index]);

В зависимости от индекса элемента в массиве вывести в текстовое поле запись о включении соответствующего режима работы задвижки.

if (SW_1.Mode.Index == 0)
ㅤ TextEdit_1.Text = "Включен режим 1";
else
ㅤ TextEdit_1.Text = "Включен режим 2";

Источник учетных данных

Credentials

Используется при подключении к серверу, который защищен паролем. Указывается в виде ссылки на объект типа Учетные данные АР, существующий в проекте.

Имя клиента

string ClientDisplayName

Позволяет установить отображаемое на сервере имя текущего клиента при подключении. Это имя передается на сервер и может быть видимо для других клиентов, чтобы идентифицировать текущего подключившегося клиента.

Примеры

Вывести в текстовое поле имя текущего клиента, отображаемое при подключении.

LineEdit_1.Text = ApServiceStatsSource.ClientDisplayName;

Режим работы

UInt1 Mode

Используется для выбора способа, которым компонент Статистика: источник данных будет получать статистические данные.

Значение

0 В этом режиме компонент Статистика: источник данных будет получать статистические данные напрямую с сервера.
Используйте этот режим при стабильном соединении с сервером для получения данных в реальном времени.
1 В этом режиме предполагается использование среза дерева статистики. Чтобы начать работу в этом режиме, необходимо заполнить свойство Срез статистики, содержащее данные в формате JSON или XML, представляющие срез дерева статистики.
Используйте этот режим, если у вас нет доступа к серверу, но есть сохраненные данные о статистике.

Таймаут операций получения данных

uint4 Timeout

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

Хост

string Location

Позволяет указать сетевой адрес (хост) сервера, с которым будет устанавливаться соединение.

Порт

uint2 Port

Позволяет задать порт сервера, через который будет осуществляться соединение.

По умолчанию для подключения к серверам используются следующие порты:

  • Alpha.Server – 4572;

  • Alpha.AccessPoint – 4976;

  • Alpha.Historian – 3388;

  • Alpha.Imitator – 4983;

  • Alpha.Licensing – 15151.

Срез статистики

string SnapShot

Свойство хранит срез статистики в формате JSON или XML. Срез представляет собой массив JSON-объектов или структуру XML. Каждый элемент массива JSON или XML представляет узел статистики, содержащий информацию о его имени, типе, значении и дочерних узлах.

Для использования источника статистики в режиме среза, создайте необходимую структуру в формате XML или JSON и вставьте её содержимое в данное свойство. Способы создания среза описаны в разделе Как создать срез дерева статистики.

  • Пример среза в формате XML

    <StatisticFolder Name="File">
    ㅤ<Folders>
    ㅤㅤ<StatisticFolder Name="Приложение">
    ㅤㅤㅤㅤ<Attributes>
    ㅤㅤㅤㅤㅤ<StatisticAttribute Name="Имя экземпляра приложения Value="Alpha.Licensing.Agent" />
    ㅤㅤㅤㅤㅤ<StatisticAttribute Name="Версия" Value="1.11.1.1" />
    ㅤㅤㅤㅤㅤ<StatisticAttribute Name="Версия старта" Value="21.09.2023 06:12:34" />
    ㅤㅤㅤㅤ</Attributes>
    ㅤㅤㅤ<Folders>
    ㅤㅤㅤㅤ<StatisticFolder Name="Клиенты">
    ㅤㅤㅤㅤㅤ<Folders>
    ㅤㅤㅤㅤㅤㅤ<StatisticFolder Name="Клиент 2">
    ㅤㅤㅤㅤㅤㅤㅤ<Attributes>
    ㅤㅤㅤㅤㅤㅤㅤㅤ<StatisticAttribute Name="Адрес клиента" Value="127.0.0.1:49675" />
    ㅤㅤㅤㅤㅤㅤㅤㅤ<StatisticAttribute Name="Время подключения " Value="21.09.2023 06:12:35" />
    ㅤㅤㅤㅤㅤㅤㅤㅤ<StatisticAttribute Name="Идентификатор сессии" Value="1" />
    ㅤㅤㅤㅤㅤㅤㅤㅤ<StatisticAttribute Name="Количество операций" Value="379395" />
    ㅤㅤㅤㅤㅤㅤㅤ</Attributes>
    ㅤㅤㅤㅤㅤㅤ</StatisticFolder>
    ㅤㅤㅤㅤㅤ</Folders>
    ㅤㅤㅤㅤ</StatisticFolder>
    ㅤㅤㅤ</Folders>
    ㅤㅤ</StatisticFolder>
    ㅤ</Folders>
    </StatisticFolder>

    <StatisticFolder> – папка в структуре статистики.

    <Folders> – список подпапок (позволяет организовать их вложенность).

    <StatisticAttribute> – атрибут с указанным именем.

    <Value> – значение атрибута.

  • Пример среза в формате JSON

    [
        {
            "Name": "Приложение",
            "Type": 1,
            "ValueType": 0,
            "Value": null,
            "Children": [
                {
                    "Name": "Имя экземпляра приложения",
                    "Type": 3,
                    "ValueType": 14,
                    "Value": "Alpha.Licensing.Agent",
                    "Children": []
                },
                {
                    "Name": "Версия",
                    "Type": 3,
                    "ValueType": 14,
                    "Value": "1.11.1.1",
                    "Children": []
                },
                {
                    "Name": "Время старта",
                    "Type": 3,
                    "ValueType": 14,
                    "Value": "21.09.2023 06:12:34",
                    "Children": []
                },
                {
                    "Name": "Клиенты",
                    "Type": 1,
                    "ValueType": 0,
                    "Value": null,
                    "Children": [
                        {
                            "Name": "Клиент 2",
                            "Type": 1,
                            "ValueType": 0,
                            "Value": null,
                            "Children": [
                                {
                                    "Name": "Адрес клиента",
                                    "Type": 3,
                                    "ValueType": 14,
                                    "Value": "127.0.0.1:49675",
                                    "Children": []
                                },
                                {
                                    "Name": "Время подключения",
                                    "Type": 3,
                                    "ValueType": 14,
                                    "Value": "21.09.2023 06:12:35",
                                    "Children": []
                                },
                                {
                                    "Name": "Идентификатор сессии",
                                    "Type": 3,
                                    "ValueType": 14,
                                    "Value": "1",
                                    "Children": []
                                },
                                {
                                    "Name": "Количество операций",
                                    "Type": 3,
                                    "ValueType": 7,
                                    "Value": 380045,
                                    "Children": []
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]			   
  • Name – имя узла.

  • Type – идентификатор типа узла.

  • ValueType – числовой идентификатор типа значения.

  • Value – значение данного элемента.

  • Children – массив, содержащий дочерние элементы данного узла.

Формат среза статистики

string SnapShotFormat

Свойство позволяет указать формат, в котором представлены данные статистики , переданные через свойство Срез статистики.

Значения

json Срез статистики предоставлен в формате JSON.
xml Срез статистики предоставлен в формате XML.

Active

bool Active

Включает/выключает активность компонента.

Значения

true Компонент активен.
false Компонент неактивен