Alpha.Community

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

Функции

Execute

Выполняет запрос значений сигналов из источника данных в соответствии с заданной конфигурацией. Запрос может быть выполнен в одном из двух режимов: историческом или оперативном. По завершении выполнения запроса срабатывает событие OnExecuteFinished.

Синтаксис

uint4 Execute(string parameters)

Параметры

parameters string Строка в формате JSON, задающая параметры запроса. Подробное описание параметров приведено ниже.

Возвращаемое значение

uint4 Идентификатор (requestId) созданного запроса.

Параметры JSON

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

Общие параметры

Ключ Описание Тип данных Возможные значения Обязательный Особенности
tag Тег сигнала на сервере. string - Нет Если указан в корне, применяется ко всем колонкам. Иначе задается в колонках.
mode Режим запроса. string historical, operative Да Определяет тип данных: исторические или оперативные.
show_metrics Включение метрик выполнения. bool true, false Нет Если true, возвращаются метрики (число строк, время выполнения).
columns Список колонок для вывода данных. array Массив объектов с описанием Да Определяет структуру выходных данных.

Параметры для режима historical

Ключ Описание Тип данных Возможные значения Обязательный Особенности
historical_range_start Начало исторического интервала. object См. объект границы интервала Да Задает начальную временную границу.
historical_range_end Окончание исторического интервала. object См. объект границы интервала Да Задает конечную временную границу.

Объект описания границы интервала (historical_range_start, historical_range_end)

Ключ Описание Тип данных Возможные значения Обязательный Особенности
timestamp Метка времени границы. uint8 - Да  
include_bound Включение границы. bool true, false Нет По умолчанию true.

Параметры для режима operative

Ключ Описание Тип данных Возможные значения Обязательный Особенности
operative_interval Интервал обновления (в секундах). uint4 - Да Определяет частоту обновления данных.
preload_historical_data Подгрузка исторических данных. bool true, false Нет По умолчанию false. Если true, подгружаются исторические данные.

Описание колонок (columns)

Ключ Описание Тип данных Возможные значения Обязательный Особенности
id Идентификатор колонки. string - Да Уникальный ID в наборе данных.
type Тип данных колонки. string attribute Да Поддерживается только attribute.
parameters Параметры колонки. object См. параметры для типа attribute Да Зависят от типа колонки.

Параметры для типа attribute

Ключ Описание Тип данных Возможные значения Обязательный Особенности
id Идентификатор атрибута. String См. идентификаторы атрибутов Да Определяет тип возвращаемых данных.
tag Тег сигнала. String - Нет Если не указан, берется из корня JSON.

Возможные идентификаторы атрибутов

Идентификатор Описание Тип данных
value Значение сигнала. variant
quality Качество сигнала. uint4
timestamp Метка времени клиента. uint8
server_timestamp Метка времени сервера. uint8
source_kind

Код источника значения.

  • 1: значение загружено из истории.
  • 2: значение получено из оперативных данных.
uint4
custom_info Пользовательское поле. uint8

Метрики выполнения запроса

Ключ Описание Тип данных
metrics Метрики выполнения запроса. object
Содержимое метрик
row_count Количество строк в результате. uint8
exec_elapsed_ms Время выполнения (в миллисекундах). uint8

Примеры

Получить значение сигнала someTag1 за заданный исторический период.

{
  "tag": "someTag1",
  "mode": "historical",
  "historical_range_start": {
    "timestamp": 133917408000000000
  },
  "historical_range_end": {
    "timestamp": 133918272000000000
  },
  "columns": [
    {
      "id": "value",
      "type": "attribute",
      "parameters": {
        "id": "value"
      }
    }
  ]
}

Получить оперативные данные для сигнала someTag1 с предзагрузкой исторических данных.

{
  "tag": "someTag1",
  "mode": "operative",
  "operative_interval": 69,
  "preload_historical_data": true,
  "columns": [
    {
      "id": "value",
      "type": "attribute",
      "parameters": {
        "id": "value"
      }
    }
  ]
}

Получить оперативные значения для сигналов someTag1 и someTag2.

{
  "mode": "operative",
  "operative_interval": 69,
  "preload_historical_data": true,
  "columns": [
    {
      "id": "value_1",
      "type": "attribute",
      "parameters": {
        "tag": "someTag1",
        "id": "value"
      }
    },
    {
      "id": "value_2",
      "type": "attribute",
      "parameters": {
        "tag": "someTag2",
        "id": "value"
      }
    }
  ]
}

CancelExecuteAll

Отменяет выполнение всех текущих запросов значений сигналов, ранее запущенных функцией Execute

Синтаксис

void CancelExecuteAll()