Alpha.Community

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

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

Для получения статистических данных о работе серверов:Alpha.Server, Alpha.AccessPoint, Alpha.Historian , Alpha.Imitator и Alpha.Licensing воспользуйтесь набором компонентов из юнита ApService.

Компоненты юнита ApService:

  • Статистика: источник данных используется для получения данных статистики от сервера или через срез дерева статистики. Срез дерева статистики - это набор данных о статистике в форматах JSON или XML. Набор данных включает в себя информацию о каждом узле статистики: его имя, тип, значение и дочерние узлы. Подробное руководство по созданию среза дерева статистики доступно здесь.

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

  • Статистика: браузер используется для получения данных об узлах дерева статистики и передачи этих данных графическим компонентам Alpha.HMI (например, Дерево).

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

Далее более подробно рассматривается описание каждого из компонентов ApService, а также принципы их работы.

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

Компонент Статистика: источник данных представляет собой основной инструмент для получения статистических данных. Вся работа по сбору статистических данных начинается с этого компонента, который затем передает информацию другим компонентам в составе юнита ApService.

Источником может быть:

  • Сервер.

  • Срез дерева статистики.

Компонент Статистика: источник данных расположен в юните ApService Библиотеки компонентов. Экземпляр этого типа не отображается на форме и виден только в области Структура объекта.

Подробнее о свойствах, методах и событиях компонента Статистика: источник данных.

Узел статистики

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

Узлы бывают трех типов:

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

Ниже представлен пример дерева статистики Alpha.Server, открытого в приложении Статистика.

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

Компонент Статистика: узел расположен в юните ApService Библиотеки компонентов. Экземпляр этого типа не отображается на форме и виден только в области Структура объекта.

Подробнее о свойствах и событиях компонента Статистика: узел.

Как подписаться на изменения значений узла дерева статистики

Чтобы компонент Статистика: узел инициировал запросы к источнику статистики и запрашивал значения параметра статистики:

  1. Добавьте объект типа Статистика: узел на форму.
  2. В свойстве Источник укажите источник статистики, с которого вы хотите получать значения параметра статистики.

    В проект уже должен быть добавлен объект типа Статистика: источник данных.

  3. Укажите полное имя отслеживаемого узла в свойстве Путь компонента Статистика: узел.
  4. Свойство Активность установите в значение true.
  5. Для получения актуальных значений из узлов используйте событие NodeStateChanged компонента Статистика: узел.

Браузер источника статистики

Компонент Статистика: браузер предназначен для просмотра узлов дерева статистики (далее: браузинг) и передачи результатов браузинга графическим компонентам (например Дерево).

Компонент Статистика: браузер возвращает данные в табличном формате. Для просмотра результатов браузинга подключите Статистика: браузер к одному из компонентов: Дерево или Таблица. Как настроить браузинг узлов дерева статистики с помощью компонента Статистика: браузер описано в демонстрационном проекте.

Компонент Статистика: браузер расположен в юните ApService Библиотеки компонентов. Экземпляр этого типа не отображается на форме и виден только в области Структура объекта.

Подробнее о свойствах и методах компонента Статистика: браузер.

Какие данные возвращает компонент

Компонент Статистика: браузер возвращает данные в табличном формате. Используя указанные ниже идентификаторы, вы можете обращаться к этим данным в проекте. Например, вывести их значения в виде древовидной структуры на форме, используя компоненты Источник данных дерева, Дерево и Колонка дерева из юнита Визуальные.

Идентификатор колонки Тип колонки Тип возвращаемого значения Описание
name 1 string Имя узла.
id 2 string Идентификатор элемента.
has_children 6 bool Наличие у узла дочерних узлов.
parent_id 3 string

Идентификатор родительского узла.

node_type 5 uint1

Идентификатор типа узла статистики.

  • 0 - неизвестный тип,

  • 1 - папка,

  • 2 - секция,

  • 3 - параметр

value_type 5 uint1

Идентификатор типа значения, хранимого в узле статистики.

  • 0 - empty,

  • 1 - bool,

  • 2 - int1,

  • 3 - uint1,

  • 4 - int2,

  • 5 - uint2,

  • 6 - int4,

  • 7 - uint4,

  • 8 - int8,

  • 9 - uint8,

  • 10 - float,

  • 11 - double,

  • 12 - timestamp (uint8),

  • 13 - UUID (16 байт),

  • 14 - string

JSON-браузер источника статистики

Компонент Статистика: JSON-браузер предназначен для просмотра узлов дерева статистики (далее: браузинг) и формирования среза дерева в формате JSON. Подробнее о структуре данных статистики см. здесь.

Как сформировать срез дерева статистики с помощью компонента Статистика: JSON-браузер описано в демонстрационном проекте.

Компонент Статистика: JSON-браузер расположен в юните ApService Библиотеки компонентов. Экземпляр этого типа не отображается на форме и виден только в области Структура объекта.

Подробнее о свойствах, методах и событиях компонента Статистика: JSON-браузер.

JSON-структура данных статистики

Компонент Статистика: JSON-браузер возвращает данные статистики в виде JSON-массива объектов. Каждый объект включает в себя следующие поля:

Имя поля Тип данных Описание Примечание
Name string Сокращенное имя узла статистики.  
Type number Идентификатор типа узла.
  • 0 - неизвестный тип узла,

  • 1 - узел-папка,

  • 2 - узел-секция,

  • 3 - узел-значение

ValueType number Идентификатор типа значения, хранимого в узле.

0 - empty,

1 - bool,

2 - int1,

3 - uint1,

4 - int2,

5 - uint2,

6 - int4,

7 - uint4,

8 - int8,

9 - uint8,

10 - float,

11 - double,

12 - timestamp,

13 - UUID,

14 - string

Value number, string, boolean или null Значение, хранимое в узле статистики.  
Children json-объект Массив дочерних узлов (рекурсивно представленных в виде аналогичных объектов).  

Как создать срез дерева статистики

Для создания среза дерева статистики используйте автоматическую генерацию файла статистики с помощью внешних приложений: Статистика и Alpha.HMI.Statistics. Полученную структуру из файла можно скопировать и вставить в свойство Срез статистики.

Генерация XML структуры

Используйте сервисное приложение Статистика.

  1. Для сохранения статистики сервера в файл выделите корневой узел сервера в дереве статистики.

  2. Нажмите кнопку или выберите в подменю Файл →Сохранить статистику в файл….

    Файл будет сохранен с расширением .stat, содержащий XML-структуру. Скопируйте ее и вставьте в свойство Срез статистики.

Генерация JSON структуры

Используйте прикладное решение Alpha.HMI.Statistics.

  1. Для сохранения статистики сервера в файл выделите в дереве навигации узел сервера и щелкните по нему правой кнопкой мыши. В открывшемся меню нажмите Сохранить статистику в файл... .

  2. Файл будет сохранен с расширением .jstat, содержащий JSON-структуру. Скопируйте ее и вставьте в свойство Срез статистики.

Как получить статистические данные Alpha.Server (Демо-проект)

Далее кратко описан небольшой пример использования компонентов Статистика: браузер, Статистика: JSON-браузер и Статистика: источник данных для получения статистических данных с Alpha.Server в проекте Alpha.HMI (проект сделан на языке Alpha.Om).

В примере показано, как:

В результате будет подготовлена форма, при открытии которой статистические данные будут получены с Alpha.Server и отображены в двух видах: в виде древовидной структуры и в виде среза дерева статистики в формате JSON.

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

Настроить компонент источника данных статистики

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

  2. Укажите адрес сервера и порт в свойствах Хост и Порт.

    1. Активируйте компонент Статистика: источник данных, установив свойство Активность в значение true.

    2. В свойстве Режим работы установите режим работы источника на 0 для приема данных с сервера.

Настроить отображение статистических данных в виде древовидной структуры

  1. Добавьте на экранную форму объект типа Дерево.

  2. В Структуре объектов щелкните правой кнопкой мыши по компоненту Дерево → Создать. Откроется мастер создания элементов.

    1. В поле Тип элемента оставьте Экземпляр типа, Базовый тип элемента → Источник данных дерева(раздел Визуальные) → Создать.

    2. В Структуре объектов добавится компонент Источник данных дерева дочерним компоненту Дерево.

  3. Для объекта Источник данных дерева аналогичным образом добавьте Колонки дерева с идентификаторами:

    • name

    • id

    • parent_id

    • has_children

    Используйте значения Идентификатора колонки и Тип колонки в соответствии с таблицей возвращаемых значений в разделе Какие данные возвращает компонент, которая поможет правильно настроить свойства для каждой Колонки дерева. Имя колонки указывается в произвольном виде.

Настроить браузер для просмотра узлов дерева статистики Alpha.Server.

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

  2. В редакторе свойств у объекта Статистика: браузер укажите ссылку на добавленный ранее компонент Статистика: источник данных. Для этого нажмите правой кнопкой мыши по свойству Источник → Сослаться → ApStatSource_1.

    В свойстве Рекурсивный запрос установите значение true для просмотра узлов на всех уровнях иерархии дерева статистики, включая все подуровни.

  3. Для просмотра узлов дерева статистики сразу после открытия экранной формы в рантайме, воспользуйтесь обработчиком события Opened. Пропишите в нем следующий код:

    Tree_1.TreeDataSource_1.ApStatBrowser_1.GetChildren("");

Сформировать срез дерева статистики с помощью компонента JSON-браузер

  1. Чтобы сформировать срез дерева статистики в формате JSON, добавьте на форму компонент Статистика: JSON-браузер.

  2. В редакторе свойств у объекта Статистика: JSON-браузер укажите ссылку на добавленный ранее компонент Статистика: источник данных. Для этого нажмите правой кнопкой мыши по свойству Источник → Сослаться → ApStatSource_1.

  3. Для удобства просмотра среза дерева статистики с отступами и переносами строк, переведите свойство Форматирование в режим true.

  4. Добавьте на форму текстовое поле, куда будет выводиться срез дерева статистики.

  5. Для формирования среза дерева статистики сразу после открытия экранной формы в рантайме, воспользуйтесь обработчиком события Opened. Используйте метод GetChildren компонента Статистика: JSON-браузер, передав пустую строку в качестве аргумента, чтобы получить срез от корневого узла

    ApStatJsonBrowser_1.GetChildren("");
  6. Чтобы получить результаты сформированного среза дерева статистики, в обработчике события GetChildrenComplete у компонента Статистика: JSON-браузер пропишите следующий код:

    Text_1.Text = result;