Alpha.Community

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

События

OnExecuteFinished

Завершение выполнения метода Execute

Параметры

requestId uint4 Идентификатор запроса, который позволяет сопоставить ответ с ранее отправленным запросом.
resultCode uint1

Код результата выполнения запроса. Возможные значения:

  • 0 - Успешно.
  • 1 - С ошибками.
  • 2 - Неуспешно.
resultDescription string Описание результата в формате JSON-строки. Параметр содержит информацию о выполненном запросе и может включать детали ошибок, если они возникли.

Формат параметра resultDescription:

{
  "messages": [
    {
      "code": 63, 
      "text": "Невозможно открыть сессию для работы с историческими данными" ᅠ
    }
  ]
}
  • code - Код сообщения.
  • text - Текстовое сообщение.

OnExecuteStatusChanged

Изменение состояния выполнения запроса, инициированного методом Execute.

Параметры

requestId uint4 Идентификатор запроса, который позволяет сопоставить ответ с ранее отправленным запросом.
statusCode uint1

Код текущего состояния выполнения запроса. Возможные значения:

  • 0 – Неопределённое состояние;
  • 1 – Выполнение не начато;
  • 2 – Подготовка к выполнению запроса (может быть пропущен, если подготовка не требуется или уже произведена ранее);
  • 3 – Выполнение запроса в процессе (может быть пропущен, если при подготовке возникли ошибки);
  • 4 – Выполнение запроса завершено.
statusData string Дополнительная информация о состоянии в формате JSON.

Формат параметра statusData

  • Для statusCode = 3 (Выполнение в процессе):

    {
      "progress": 0
    }

    progress - Прогресс выполнения запроса. Обновление прогресса выполняется один раз в секунду при наличии изменений. Возможные значения: от 0 до 100.

  • Для statusCode = 4 (Выполнение завершено):

    {
      "result_code": value,
      "result_description": {
        "messages": [
          {
            "code": value,
            "text": value
          }
        ],
        "metrics": {
          "row_count": value,
          "exec_elapsed_ms": value
        }
      }
    }				

    result_code - Код результата запроса. Возможные значения:

    • 0: Успешно;
    • 1: С ошибками;
    • 2: Неуспешно.

    result_description - Описание результата.

    messages - Массив сообщений, описывающих результат. Каждое сообщение содержит:

    • code - Код сообщения;
    • text - Текст сообщения.

    metrics - Описание метрик выполнения.