Утилиты
Текущий контекст - это системный контекст, который предоставляет различные операции. Он не отображается в видимом дереве контекстов.
Уникальные действия
[?]
Показать данные
Действие получает некоторые данные из системы путем вычисления выражения, показывает их пользователю с помощью UI-процедуры Редактировать данные и обеспечивает автоматическое повторное получение и автообновление показанных данных.
Имя действия:
showData
Неинтерактивный Режим:
Не поддерживается
Права доступа:
Доступен на уровне прав Наблюдателя
Выполнение Параметры:
1. Получение данных:
Выражение для вычисления
Период обновления
2. Представление данных:
Заголовок окна данных
Справка, текст для отображения в окне данных
Icon, строка ID пиктограммы окна данных
3. Расположение окна данных
4. Инструментальная панель Свойства окна данных
Показать отчет
Действие показывает отчет, основанный на пользовательском Устройстве. Оно использует UI процедуру Показать отчет и позволяет управлять стандартными свойствами шаблона дизайна.
Имя действия:
showReport
Неинтерактивный Режим:
Не поддерживается
Права доступа:
Доступен на уровне прав Наблюдателя
Выполнение Параметры:
Данные: устройство для создания отчета.
Свойства дизайна: свойства шаблона дизайна.
Если параметр Визуализация не указан, пользователю предлагается отредактировать свойства шаблона в соответствующем диалоге. После этого открывается окно отчета.
| Пример привязки для использования этого действия без участия пользователя: Цель: Выражение расширенного поиска: Активатор: |
Действия, связанные с переменными
[?]
Показать историю изменений
Текущее действие показывает исторические изменения значения переменной. Оно выводит историю изменений переменной в виде таблицы. Каждое поле формата отслеживаемой переменной отображается в отдельном поле результирующей таблицы. Если значение переменной содержит несколько строк, отображается только первая строка.
Показать информацию о переменной
Текущее действие показывает свойства определения переменной и ее формат.
Действия, связанные с событиями
[?]
Просмотр информации о событии
Текущее действие показывает свойства определения события и его формат.
Расширенные сведения
Информация о контексте
Тип контекста: утилиты
Имя контекста: утилиты
Описание контекста: Утилиты
Путь контекста: утилиты
Маски контекста: утилиты
Права доступа к контексту
[?]
Уровень
Описание
Нет
Основные внутренние операции системы.
Наблюдатель
Доступ и удаление истории переменных/событий.
Доступ к статистике переменных и ее удаление.
Доступ к топологии устройства.
Оператор
Отправка сообщений электронной почты и SMS.
Менеджер
То же, что и Оператор.
Инженер
Запросы на проверку входящих E-mail сообщений.
Администратор
Выполнение внешних приложений.
Общедоступные переменные (Свойства)
[?]
Текущий контекст не имеет публичных переменных (свойств).
Общедоступные функции
[?]
Получить историю переменной
Возврат истории обновления указанной переменной. Дополнительную информацию см. в действии Показать историю переменной.
Имя функции:
variableHistory
Права доступа:
Доступна на уровнеправ Наблюдателя
Входные записи:
1
Вход Формат:
Название | Тип | Описание |
контекст | String | Контекст, в котором определена переменная. |
переменная | String | Имя переменной. |
fromDate | Дата | Временная метка, используемая для выбора только тех обновлений переменной, которые произошли после определенной даты. Если она равна NULL, то будут включены все самые старые события. |
toDate | Дата | Временная метка, используемая для выбора обновлений переменных, произошедших до определенной даты. Если она равна NULL, то будут включены все самые новые события. |
dataAsTable | Boolean | Если отключен (поведение по умолчанию), то результирующая таблица будет содержать по одному дополнительному полю на каждое поле переменной, по которой извлекается история. В текущем случае в результирующую таблицу будут добавлены только первые строки с историческими значениями, остальные строки будут исключать. Текущий режим подходит только для однорядных переменных. Если этот режим включен, то исторические значения будут содержаться в отдельном табличном поле под названием |
лимит | Integer | Максимум исторических значений для извлечения. |
sortAscending | Boolean | Флаг переключения между сортировкой исторических значений по возрастанию и по убыванию. |
Выходные записи:
0...неограниченно
Вывод Формат:
Динамический, имеет как минимум поле vUpdateTime
, содержащее временные метки исторических значений.
Выполнить внешнее приложение
Текущая функция выполняет внешнее приложение, указанное входными аргументами, ожидает его завершения и возвращает его выход.
Возможности текущей функции ограничены. Например, она не может выполнять команды, передаваемые по трубопроводу, и имеет ограниченную поддержку приема аргументов командной строки с экранированием строк и т. д.
Используйте драйвер устройства Внешнее приложение/скрипт для более настраиваемого выполнения приложений.
Имя функции: | выполнить | ||||||||||||
Права доступа: | Доступна на уровнеправ администратора | ||||||||||||
Входные записи: | 1 | ||||||||||||
Вход Формат: |
| ||||||||||||
Выходные записи: | 1 | ||||||||||||
Выходные данные Формат: |
|
{utilities:execute("admin/executer.bat mkdir admin\\\ myPath\\\NewPath")}
создаст папку с путем adminmyPathNewPath
Список переменных
Эта функция возвращает список значений всех одноклеточных (т.е. не табличных и не массивов) переменных во всех контекстах, соответствующих определенной маске и входящих в определенную группу.
Имя функции: | listVariables | ||||||||||||
Права доступа: | Доступна на уровнеправ Наблюдателя | ||||||||||||
Входные записи: | 1 | ||||||||||||
Вход Формат: |
| ||||||||||||
Выходные записи: | 0...неограниченно | ||||||||||||
Выходные данные Формат: |
|
Статистика
Эта функция возвращает последние значения для статистического канала (например, среднее значение за последний месяц, минимальное значение за последний день и т. д.).
Имя функции: | статистика | ||||||||||||||||||||||||||||||||||||
Права доступа: | Доступна на уровнеправ Наблюдателя | ||||||||||||||||||||||||||||||||||||
Входные записи: | 1 | ||||||||||||||||||||||||||||||||||||
Вход Формат: |
| ||||||||||||||||||||||||||||||||||||
Выходные записи: | 0...неограниченно | ||||||||||||||||||||||||||||||||||||
Вывод Формат: |
|
Без обработки Статистика
Текущая функция возвращает необработанные статистические данные для канала статистики.
Имя функции:
rawStatistics
Права доступа:
Доступно на уровнеправ Наблюдателя
Входные записи:
1
Вход Формат:
Название | Тип | Описание |
контекст | String | Имя контекста для получения статистики. |
имя | String | Имя канала, из которого будет получена статистика. |
Выходные записи:
0...неограниченно
Выходные данные Формат:
Динамический
Без обработки Статистика
Текущая функция возвращает необработанные статистические данные для канала статистики.
Имя функции:
rawStatistics
Права доступа:
Доступно на уровнеправ Наблюдателя
Входные записи:
1
Вход Формат:
Название | Тип | Описание |
контекст | String | Имя контекста для получения статистики. |
имя | String | Имя канала, из которого будет получена статистика. |
Выходные записи:
0...неограниченно
Выходные данные Формат:
Динамический
Статистика сущностей контекста
Возврат статистики для сущностей указанного контекста или контекстов.
Имя функции: | contextEntitiesStatistics | ||||||||||||||||||||||||||||||
Права доступа: | Доступна на уровнеправ Наблюдателя | ||||||||||||||||||||||||||||||
Входные записи: | 1 | ||||||||||||||||||||||||||||||
Вход Формат: |
| ||||||||||||||||||||||||||||||
Выходные записи: | 0...неограниченно | ||||||||||||||||||||||||||||||
Выходные данные Формат: |
|
Удалить статистику
Текущая функция используется для очистки всех данных, собранных каналом статистики.
Имя функции:
deleteStatistics
Права доступа:
Доступна на уровнеправ Наблюдателя
Входные записи:
1
Вход Формат:
Название | Тип | Описание |
маска | String | Маска контекстов для поиска каналов статистики. |
канал | String | Имя канала, из которого нужно очистить данные. |
Выходные записи:
0
Выход Формат:
Нет
Допустимые значения
Эта функция возвращает таблицу данных, подходящую для использования в качестве значений выбора поля другой таблицы данных. Чаще всего она используется в выражении расширенного поиска привязки таблицы данных, которая нацелена на свойство выбора поля.
Функция сначала строит промежуточную таблицу данных, оценивая выражение. Затем она проходит по этой таблице строка за строкой и оценивает два других выражения для каждой строки. Один возвращает значения выбора, а второй - его описание.
Аргументами selectionValues
являются все выражения. В примере ниже видно, что аргумент tableExpression
- это не просто ссылка на переменную типа DataTable, а выражение, которое возвращает таблицу данных.
callFunction("Утилиты" , "selectionValues" , "{users.admin.models.svExampleModel:svTable}" , "{ifIndex}" ,"{ifDescr}" )
В следующем примере показано, как выражение использует функцию getVariable
для получения переменной svTable
.
callFunction("Утилиты" , "selectionValues" , 'getVariable("users.admin.models.svExampleModel", "svTable")' , "{ifIndex}" , "{ifDescr}" )
Имя функции: | selectionValues | ||||||||||||
Права доступа: | Доступно на уровнеправ Наблюдателя | ||||||||||||
Входные записи: | 1 | ||||||||||||
Вход Формат: |
| ||||||||||||
Выходные записи: | 0...неограниченно | ||||||||||||
Выход Формат: |
|
Сводка
Эта функция агрегирует данные временного ряда, вычисляя средние значения, минимумы, максимумы, итоги, количество выборок и другие метрики для каждого источника и периода времени. Числовые значения могут быть получены из источника:
События исторического контекста, хранящиеся в базе данных сервера
Исторические значения контекстной переменной (также загружено из базы данных сервера)
Данные, собранные каналом статистики
Входные данные функции представляют собой многорядную таблицу. Каждая строка входной таблицы определяет отдельный ряд данных. Каждый ряд данных будет представлен отдельным столбцом в выходных данных функции, например, "средние значения за период по источникам для переменной A" или "количество образцов за период по источникам для события B".
Формат входной таблицы, используемой этой функцией, может меняться в зависимости от установленной локали. Чтобы автоматически создать входную таблицу в нужном формате, используйте функции functionInputFormat
и table
: table(functionInputFormat("Утилиты", "Сводка"), [, Объект field1, Объект field2, ...])
Имя функции: | сводка | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Права доступа: | Доступна на уровнеправ Наблюдателя | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Входные записи: | 0...неограниченно | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Вход Формат: |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Записи на выходе: | 0...неограниченно | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Выход Формат: | Статические поля вывода, которые всегда доступны:
Дополнительные колонки выхода функции определяются сериями данных, указанными во входе функции:
|
Сгенерировать событие задним числом
Сгенерировать события с временем создания в прошлом. Текущее событие полезно в первую очередь для обновления истории событий, которые были получены из стороннего источника с задержкой.
Имя функции:
fireBackdatedEvent
Права доступа:
Доступно на уровнеправ администратора
Входные записи:
0...неограниченно
Вход Формат:
Название | Тип | Описание |
контекст | String | Путь к контексту, в котором нужно сгенерировать событие. |
событие | String | Имя события, которое необходимо сгенерировать. |
Уровень | Integer | Уровень события или null для использования уровня по умолчанию. |
creationTime | Дата | Прошлая дата события. Будет сохранена в базе данных сервера. |
данные | Таблица данных | Данные, относящиеся к конкретному событию. Должны соответствовать формату, указанному в определении события. |
Выходные записи:
0
Выходные данные Формат:
Нет
Создание местоположения компонента для сетки
Удобная функция для создания таблицы данных, соответствующей формату переменной расположение компонента. Вводимые значения, отличные от path
, форматируются и возвращаются в поле grid
. Выходные absolute
и dockabled
поля содержат пустую, но правильно отформатированную таблицу данных.
Function Name: | componentLocationForGrid | ||
Permissions: | Доступно на уровне прав менеджера | ||
Input Records: | 1 | ||
Input Format: | Name | Type | Description |
path | String | Строка, указывающая путь к целевой приборной панели или контейнеру, как описано в поле | |
row | Integer | Описание этих полей см. в поле | |
column | Integer | ||
rowSpan | Integer | ||
columnSpan | Integer | ||
Output Records: | 1 | ||
Output Format: | Name | Type | Description |
path | String | Tо же значение, что и в поле ввода | |
absolute | Data Table | Тот же формат, что и у поля | |
grid | Data Table | Тот же формат, что и у поля | |
dockable | Data Table | Тот же формат, что и у поля |
Создать компонентное местоположение для абсолюта
Удобная функция для создания таблицы данных, соответствующей формату переменной расположение компонента. Входные значения, отличные от path
, форматируются и возвращаются в поле absolute
вывода. Поля вывода grid
и dockabled
содержат пустую, но правильно отформатированную таблицу данных.
Function Name: | componentLocationForAbsolute | ||
Permissions: | Доступно на уровне прав менеджера | ||
Input Records: | 1 | ||
Input Format: | Name | Type | Description |
path | String | Строка, указывающая путь к целевой приборной панели или контейнеру, как описано в поле | |
x | Integer | Описание этих полей см. в поле | |
y | Integer | ||
width | Integer | ||
height | Integer | ||
zIndex | Integer | ||
Output Records: | 1 | ||
Output Format: | Name | Type | Description |
path | String | Tо же значение, что и в поле ввода | |
absolute | Data Table | Тот же формат, что и у поля | |
grid | Data Table | Формат такой же, как у поля | |
dockable | Data Table | Тот же формат, что и у поля |
Создание местоположения компонента для Dockable
Удобная функция для создания таблицы данных, соответствующей формату переменной расположение компонента. Входные значения, отличные от path
, форматируются и возвращаются в поле вывода dockable
. Поля вывода grid
и absolute
содержат пустую, но правильно отформатированную таблицу данных.
Function Name: | componentLocationForDockable | ||
Permissions: | Доступно на уровне прав менеджера | ||
Input Records: | 1 | ||
Input Format: | Name | Type | Description |
path | String | Строка, указывающая путь к целевой приборной панели или контейнеру, как описано в поле | |
position | String | Описание этих полей см. в поле | |
positionAttribute | String | ||
targetId | String | ||
tabIndex | Integer | ||
tabPosition | String | ||
preferredWidth | Integer | ||
preferredHeight | Integer | ||
minimumWidth | Integer | ||
minimumHeight | Integer | ||
x | Integer | ||
y | Integer | ||
width | Integer | ||
height | Integer | ||
movable | Boolean | ||
closable | Boolean | ||
resizable | Boolean | ||
collapsible | Boolean | ||
maximizable | Boolean | ||
floatable | Boolean | ||
collapsed | Boolean | ||
showHeader | Boolean | ||
description | String | ||
icon | Data Table | ||
Output Records: | 1 | ||
Output Format: | Name | Type | Description |
path | String | Tо же значение, что и в поле ввода | |
absolute | Data Table | Тот же формат, что и у поля | |
grid | Data Table | Формат такой же, как у поля | |
dockable | Data Table | Тот же формат, что и у поля |
Получить модули
Возврат таблицы с информацией обо всех модулях, доступных в указанном магазине. Указанный адрес storeAddress
должен существовать и быть настроен в Списке магазинов в разделе Глобальные Конфигурации.
Имя функции: | getModules | ||
Права доступа: | Доступно на уровне прав Менеджера | ||
Входные записи: | 1 | ||
Вход Формат: | Название | Тип | Описание |
storeAddress | String | Укажите адрес магазина, из которого необходимо получить список модулей. | |
Выходные записи: | 0... Не ограничено | ||
Выход Формат: | Имя | Тип | Описание |
id | String | Идентификатор модуля. | |
описание | Boolean | Успешно | |
изображение | Блок данных | Изображение, связанное с модулем | |
версии | Таблица данных | Таблица данных, содержащая информацию для различных версий модуля.
|
Получить решения
Возврат таблицы с информацией обо всех решениях, доступных в указанном магазине. Указанный адрес storeAddress
должен существовать и быть настроен в Списке магазинов в разделе Глобальные конфигурации.
Имя функции: | getSolutions | ||
Права доступа: | Доступно на уровне прав менеджера | ||
Входные записи: | 1 | ||
Вход Формат: | Название | Тип | Описание |
storeAddress | String | Укажите адрес магазина, из которого необходимо получить список решений. | |
Выходные записи: | 0... Не ограничено | ||
Выходные данные Формат: | Имя | Тип | Описание |
имя | String | Название решения. | |
описание | строка | Описание решения. | |
Модули | Data Table | Список идентификаторов модулей, из которых состоит решение. В таблице данных имеется одно поле:
|
Установка модулей
Установка любого количества модулей путем предоставления списка идентификаторов модулей. Указанный адрес storeAddress
должен существовать и быть настроен в Списке магазинов в разделе Глобальные конфигурации.
Имя функции: | installModules | ||
Права доступа: | Доступна на уровне прав Менеджера | ||
Входные записи: | 1...неограниченно | ||
Вход Формат: | Название | Тип | Описание |
storeAddress | String | Адрес магазина. | |
id | String | Идентификатор модуля, который необходимо установить. | |
Выходные записи: | 0... Не ограничено | ||
Выходные данные Формат: | Имя | Тип | Описание |
id | String | Идентификатор модуля | |
установленный | Boolean | Указывает, был ли модуль Успешно установлен. | |
статус | String | Если модуль не был успешно установлен, указывает причину неудачи. |
Удаление модулей
Удалите любое количество модулей, предоставив список идентификаторов модулей.
Имя функции: | uninstallModules | ||
Права доступа: | Доступна на уровне прав Менеджера | ||
Входные записи: | 1 | ||
Вход Формат: | Название | Тип | Описание |
id | String | Идентификатор модуля, который необходимо удалить. | |
Выходные записи: | 0... Не ограничено | ||
Выход Формат: | Имя | Тип | Описание |
имя | String | Имя модуля | |
не установлен | Boolean | Указывает, был ли модуль успешно деинсталлирован | |
Статус | String | Если модуль не был успешно деинсталлирован, указывает причину неудачи |
Общедоступные события
[?]
Общие события: info (Information)