Утилиты

Это системный контекст, который предоставляет различные операции. Он не отображается в видимой части контекстного дерева.

Уникальные действия

[?]

Показать данные

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

Имя действия:

showData

Не интерактивный режим:

не поддерживается

Права доступа:

Доступно на уровне без прав доступа

Параметры выполнения:  

1. Сбор данных:

  • Выражение для подсчета
  • Период обновления

2. Представление данных:

  • Заголовок окна данных
  • Помощь, текст, который будет отображен в окне данных
  • Иконка, строка ID иконки, которая принадлежит иконке данных

3. Месторасположение окна данных

Показать отчет

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

Имя действия:

showReport

Неинтерактивный режим:

не поддерживается

Права доступа:

Доступно на уровне с правами доступа для Наблюдателя

Параметры выполнения:

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

    Пример привязки для использования данного действия без взаимодействия с пользователем:

    Цель: utilities:showReport!

    Выражение: table("<<data><T>><<designProperties><T>>", {form/dataTableEditor1:dataTable}, table("<<title><S>>", "Some title"))

    Активатор: form/button1:click@

    Действия, связанные с переменной

    [?]

    Показать историю изменений

    Это действие показывает исторические изменения значения переменной. Оно выводит историю изменения переменной в форме таблицы. Каждое поле формата отлеживаемой переменной отображается в отдельном поле итоговой таблицы. Если значение переменной содержит несколько рядов, отображается лишь первый ряд.  

    Показать информацию о переменной

    Это действие отображает свойства определения переменной и ее формат.  

    Действия, относящиеся к событию

    [?]

    Просмотреть информацию о событии

    Это действие показывает свойства определения события и его формат.

    Дополнительная информация

    Информация о контексте

    Тип контекста: утилиты

    Имя контекста: утилиты

    Описание контекста: utilities

    Путь контекста: utilities

    Контекстная маска: utilities

    Права доступа к контексту

    [?]

    Уровень

    Описание

    Отсутствует

    Основные внутренние операции системы.

    Наблюдатель

    Доступ и удаление истории переменных/событий.

    Доступ и удаление статистики переменных.

    Доступ к топологии устройств.

    Оператор

    Отправка E-mail и SMS сообщений.

    Менеджер

    Те же, что у Оператора.

    Инженер

    Запросы на проверку входящей почты.

    Администратор

    Выполнение внешнего приложения.

    Общие переменные (свойства)

    [?]

    У этого контекста нет общих переменных (свойств).

    Общие функции

    [?]

    Получить историю переменной

    Возвращает историю изменений указанной переменной. См. просмотреть историю переменной.

    Имя функции:

    variableHistory

    Права доступа:

    Доступно на уровне с правами доступа для Наблюдателя.

    Записи ввода:

    1

    Формат ввода:

    Имя

    Тип

    Описание

    mask

    Строка

    Контексты, где определена переменная.

    event

    Строка

    Имя переменной.

    fromDate

    Дата

    Временная метка, используемая для выбора лишь тех событий изменения переменной, которые происходили после определенной даты. Если соответствует NULL, будут выбраны все события изменений.

    toDate

    Дата

    Временная метка, используемая для выбора лишь тех событий изменения переменной, которые происходили до определенной даты. Если соответствует NULL, будут выбраны все события изменений.

    dataAsTable

    Булевое

    Если выключено (по умолчанию), таблица результатов будет содержать одно дополнительное поле для каждого поля переменной, чья история извлекается. В этом случае только первые ряды исторических значений буду добавляться к таблице результатов, другие ряды будут исключаться. Таким образом, данный режим подходит только для переменной с одной строкой.

    Если включено, исторические значения будут содержаться в отдельном поле таблицы под названием vValue.

    limit

    Целое

    Максимальное количество извлекаемых исторических значений.

    sortAscending

    Булевое

    Флажок, переключающий между восходящей и нисходящей сортировкой исторических значений.

    Записи вывода:

    0...не ограничено

    Формат вывода:

    динамический, как минимум имеет поле vUpdateTime, содержащее временную метку исторических значений.

    Выполнить внешнее приложение

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

    Имя функции:

    execute

    Права доступа:

    Доступно на уровне с правами доступа для Администратора

    Записи ввода:

    1

    Формат ввода:

    Имя

    Тип

    Описание

    command

    Строка

    Полное квалификационное имя команды с аргументами.

    directory

    Строка

    Рабочая директория, может быть опущена.

    charset

    Строка

    Каноническое имя кодирования, как обозначено в API java.nio, может быть опущено.

    Список поддерживаемых кодировок можно найти в Oracle-документации.

    Записи вывода:

    1

    Формат вывода:

    Имя

    Тип

    Описание

    exitCode

    Целое

    Код выхода команды.

    output

    Строка

    Захват вывода команды.

    errors

    Строка

    Захват вывода ошибки команды.

    {utilities:execute("admin/executer.bat mkdir admin\\ myPath\\NewPath")} создаст папку с путем adminmyPathNewPath

    Перечислить переменные

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

    Имя функции:

    listVariables

    Права доступа:

    Доступно на уровне с правами доступа для Наблюдателя

    Записи ввода:

    1

    Формат ввода:

    Имя

    Тип

    Описание

    mask

    Строка

    Маска контекста, согласно которой перечисляются переменные.

    group

    Строка

    Группа переменных.

    Записи вывода:

    0...не ограничено

    Формат вывода:

    Имя

    Тип

    Описание

    context

    Строка

    Описание контекста.

    variable

    Строка

    Описание переменной.

    value

    Строка

    Представление строки значения переменной.  

    Статистика

    Эта функция возвращает последние значения для статистического канала (например, среднее значение последнего месяца, минимальное последнего дня и пр. )

    Имя функции:

    статистика

    Права доступа:

    Доступно на уровне с правами доступа для Наблюдателя

    Записи ввода:

    1

    Формат ввода:

    Имя

    Тип

    Описание

    mask

    Строка

    Маска контекста для выбора статистических данных.

    channel

    Строка

    Имя канала.

    key

    Строка

    Ключ набора данных или NULL для использования набора данных по умолчанию.

    period

    Строка

    Период времени для отображения последних значения. Если NULL, будут выбраны данные для всех периодов.

    Имена периодов:

    • millisecond или ms для миллисекунд
    • second, sec или s для секунд
    • minute, min или m для минут
    • hour, hr или h для часов
    • day или d для дней
    • week или w для недель
    • month для месяцев (обратите внимание, что месяц основан на нуле, т.е. значение для января -- 0.)
    • year или y для года

    full

    Булевое

    Если верно (true), все статистические данные возвращаются согласно периоду, указанному ранее (т.е. среднечасовой). Если неверно (false), возвращаются только последние собранные данные (например, последнее среднее целого часа).  

    average

    Булевое

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

    minimum

    Булевое

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

    maximum

    Булевое

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

    sum

    Булевое

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

    first

    Булевое

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

    last

    Булевое

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

    Записи вывода:

    0...не ограничено

    Формат вывода:

    Имя

    Тип

    Описание

    context

    Строка

    Имя контекста, который породил данные.

    start

    Дата

    Начало промежутка времени.

    end

    Дата

    Конец промежутка времени.

    key

    Строка

    Ключ набора данных или NULL, если используется набор данных по умолчанию.

    average

    Плавающее

    Среднее значение для промежутка времени.

    minimum

    Плавающее

    Минимальное значение для промежутка времени.

    maximum

    Плавающее

    Максимальное значение для периода времени.

    sum

    Плавающее

    Итоговое значение для периода времени.

    first

    Плавающее

    Первое значение для периода времени.

    last

    Плавающее

    Последнее значение для периода времени.

    Сырые статистические данные

    Эта функция возвращает сырые статистические данные для статистического канала.

    Имя функции:

    rawStatistics

    Права доступа:

    Доступно на уровне с правами доступа для Наблюдателя.

    Записи ввода:

    1

    Формат ввода:

    Имя

    Тип

    Описание

    context

    Строка

    Имя контекста для выбора статистических данных.

    name

    Строка

    Имя канала для выбора статистических данных.

    Записи вывода:

    0...не ограничено

    Формат вывода:

    динамический

    Удалить статистику

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

    Имя функции:

    deleteStatistics

    Права доступа:

    Доступно на уровне с правами доступа для Наблюдателя.

    Записи ввода:

    1

    Формат ввода:

    Имя

    Тип

    Описание

    mask

    Строка

    Маска контекстов для поиска статистических каналов.

    channel

    Строка

    Имя канала, откуда удаляются данные.

    Записи вывода:

    0

    Формат вывода:

    Отсутствует

    Допустимые значения

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

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

    Имя функции:

    selectopnValues

    Права доступа:

    Доступно на уровне с правами доступа для Наблюдателя.

    Записи ввода:

    1

    Формат ввода:

    Имя

    Тип

    Описание

    tableExpression

    Строка

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

    valueExpression

    Строка

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

    descriptionExpresssion

    Строка

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

    Записи вывода:

    0... не ограничено

    Формат вывода:

    Имя

    Тип

    Описание

    value

    Строка

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

    description

    Строка

    Описание допустимых значений.

    Обобщение

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

    Этот ввод функции представляет из себя таблицу со многими строками. Каждая строка в таблице ввода опеделяет отчетливые серии данных. Каждая серия данных будет представлена отдельным столбцом в выводе функции, например, "средние значения для переменной А за период и на источник" или "количество образцов для события B за период и на источник".

    Имя функции:

    summary

    Права доступа:

    Доступно на уровне с правами доступа для Наблюдателя.

    Записи ввода:

    0... не ограничено

    Формат ввода:

    Имя

    Тип

    Описание

    seriesName

    Строка

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

    seriesDescription

    Строка

    Удобное описание серии, например, описание поля вывода.

    startDate

    Дата

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

    endDate

    Дата

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

    masks

    Строка

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

    Примеры:

    • users.*.devices.* - все доступные устройства для вызова функции
    • users.john.devices.dev1 users.john.devices.dev2 - два отдельных устройства

    entity

    Строка

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

    entityType

    Целое

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

    expression

    Строка

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

    • Извлекать числовые образцы данных из таблицы данных, представляющей хронологические события и значения переменной
    • Обрабатывать ранее собранные образцы данных, содержащиеся в статистическом канале (если серия относится к статистике)

    Если выражение возвращает NULL, обработанный образей данных удаляется.

    Среда вычисления выражения серии:

    Контекст по умолчанию

    Контекст, чья история/статистика обрабатывается.

    Таблица данных по умолчанию

    Таблица данных, представляющая обрабатываемое в данный момент историческое событие или значение переменной.

    Строка по умолчанию

    0

    Переменные среды

    Только стандартные переменные.

    dateExpression

    Строка

    Выражение SberMobile, которое должно возвращать дату. Оно используется для извлечения дат сбора образцов из таблицы данных, представляющей исторические события и значения переменных.

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

    Среда вычисления выражения даты серии:

    Контекст по умолчанию

    Контекст, чья история/статистика обрабатывается

    Таблица данных по умолчанию

    Таблица данных, представляющая обрабатываемое в данный момент историческое событие или значение переменной.

    Строка по умолчанию

    0

    Переменные среды

    Только стандартные переменные.

    grouping

    Целое

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

    aggregation

    Целое

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

    changeType

    Целое

    Типы серий. См. описание доступных типов здесь.

    Коды числовых типов:

    • 0 - датчик
    • 1 - счетчик
    • 2 - счетчик без переполнения
    • 3 - абсолютный

    outOfRangeValuesHandling

    Целое

    Определяет, как обрабатываются выходящие за пределы диапазона значения (т.е. значения типа датчика или посекундные значения, рассчитываемые в соответствии с вышеуказанными типами серий):

    • 0 - Игнорировать, т.е. не руководствоваться приведенными ниже минимальными и максимальными значениями
    • 1 - Удалить, т.е. не обрабатывать данные, выходящие за пределы приведенного ниже диапазона
    • 2 - Нормализовать, т.е. перевести низкие и высокие значения, выходящие за пределы диапазона, в нижние и верхние границы

    minValue

    Двойное

    Минимально разрешенное значение типа датчика или посекундные данные.

    maxValue

    Двойное

    Максимально разрешенное значение типа датчика или посекундные данные.

    timeZone

    Строка

    Временная зона, используемая для выравнивания временных периодов в таблице вывода. Если она равна null, используется временная зона SberMobile Server по умолчанию.

    Временные зоны могут определяться в форме строки, например:

    • GMT-8
    • GMT-08:00
    • America/Los_Angeles

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

    showDetails

    Булевое

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

    showTotals

    Булевое

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

    sortPriority

    Целое

    Определяет метод сортировки вывода функции:

    • 0 - сначала группирует по временным периодам, затем по источникам
    • 1 - сначала группирует по источникам, затем по временным периодам

    Записи вывода:

    0... не ограничено

    Формат вывода:

    Всегда доступные поля статического вывода:

    Имя

    Тип

    Описание

    periodName

    Строка

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

    periodMiddle

    Дата

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

    periodEnd

    Дата

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

    periodStart

    Дата

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

    context

    Строка

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

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

    Имя

    Тип

    Описание

    имя, определяемое полем ввода seriesName

    • Дата для серий с использованием типов объединения Первая дата и Последняя дата.
    • Целое для серий с использованием типа объединения Количество.
    • Двойной для других серий.

    Каждый динамический столбец содержит объединения по отдельному источнику, отдельному временному периоду, рассчитанные согласно параметрам серии.

    Сгенерировать событие задним числом

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

    Имя функции:

    fireBackdatedEvent

    Права доступа:

    Доступно на уровне с правами доступа для Администратора

    Записи ввода:

    0...unlimited

    Формат ввода:

    Имя

    Тип

    Описание

    context

    Строка

    Путь контекста, в котором генерируется событие.

    event

    Строка

    Имя генерируемого события.

    level

    Целое

    Уровень события или ноль для использования уровня по умолчанию.

    creationTime

    Дата

    Дата события в прошлом. Будет сохранена в базе данных сервера.

    data

    Таблица данных

    Специфичные данные по событию. Должны соответствовать формату, заданному в определении события.

    Записи вывода:

    0

    Формат вывода:

    Отсутствует

    Общие события

    [?]

    Общие события: info (информация)