Утилиты

Текущий контекст - это системный контекст, который предоставляет различные операции. Он не отображается в видимом дереве контекстов.

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

[?]

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

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

Имя действия:	showData
Неинтерактивный Режим:	Не поддерживается
Права доступа:	Доступен на уровне прав Наблюдателя
Выполнение Параметры:	1. Получение данных: Выражение для вычисления Период обновления 2. Представление данных: Заголовок окна данных Справка, текст для отображения в окне данных Icon, строка ID пиктограммы окна данных 3. Расположение окна данных 4. Инструментальная панель Свойства окна данных

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

Действие показывает отчет, основанный на пользовательском Устройстве. Оно использует UI процедуру Показать отчет и позволяет управлять стандартными свойствами шаблона дизайна.

Имя действия:	showReport
Неинтерактивный Режим:	Не поддерживается
Права доступа:	Доступен на уровне прав Наблюдателя
Выполнение Параметры:	Данные: устройство для создания отчета. Свойства дизайна: свойства шаблона дизайна. Если параметр Визуализация не указан, пользователю предлагается отредактировать свойства шаблона в соответствующем диалоге. После этого открывается окно отчета. Пример привязки для использования этого действия без участия пользователя: Цель: `utilities:showReport!` Выражение: `table("<<data><T>><<designProperties><T>>", {form/dataTableEditor1:dataTable}, array("title", "Some title"))` Активатор: `form/button1:click@`

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

[?]

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

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

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

Текущее действие показывает свойства определения переменной и ее формат.

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

[?]

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

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

Расширенные сведения

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

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

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

Описание контекста: Утилиты

Путь контекста: утилиты

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

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

[?]

Уровень	Описание
Нет	Основные внутренние операции системы.
Наблюдатель	Доступ и удаление истории переменных/событий. Доступ к статистике переменных и ее удаление. Доступ к топологии устройства.
Оператор	Отправка сообщений электронной почты и SMS.
Менеджер	То же, что и Оператор.
Инженер	Запросы на проверку входящих E-mail сообщений.
Администратор	Выполнение внешних приложений.

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

[?]

Текущий контекст не имеет публичных переменных (свойств).

Общедоступные функции

[?]

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

Возврат истории обновления указанной переменной. Дополнительную информацию см. в действии Показать историю переменной.

Имя функции:	variableHistory
Права доступа:	Доступна на уровне прав Наблюдателя
Входные записи:	1…неограниченно
Входной Формат:	Название	Тип	Описание
	context	String	Контекст или маска контекстов для загрузки истории переменных.
	variable	String	Имя переменной.
	fromDate	Date	Временная метка, используемая для выбора только тех обновлений переменной, которые произошли после определенной даты. Если она равна NULL, то будут включены все самые старые события.
	toDate	Date	Временная метка, используемая для выбора обновлений переменных, произошедших до определенной даты. Если она равна NULL, то будут включены все самые новые события.
	dataAsTable	Boolean	Если отключен (поведение по умолчанию), результирующая таблица будет содержать одно дополнительное поле на каждое поле переменной, из которой извлекается история. Таким образом, этот режим подходит, если применимо следующее: В таблице входных параметров функции есть только одна запись Параметр Context не является маской Переменная, на которую указывают параметры Context и Variable, является переменной с одной записью Во всех остальных случаях значение этого параметра не будет учитываться. Если включено или не учитывается, исторические значения будут содержаться в отдельном табличном поле с именем `vValue`.
	limit	Integer	Максимум исторических значений для извлечения.
	sortAscending	Boolean	Флаг переключения между сортировкой исторических значений по возрастанию и по убыванию.
Выходные записи:	0...неограниченно
Выходной Формат:	Выходной формат динамический. Он имеет строковые поля `vContext` и `vVariable`, которые являются историей для более чем одной загруженной переменной. Он всегда имеет поле даты `vUpdateTime`, которое содержит временные метки исторических значений. Он имеет поле таблицы данных `vValue`, которое содержит исторические значения, если параметр dataAsTable был включен или не учитывался. Он имеет столбцы, соответствующие полям единственной переменной, для которой эта история была загружена, если параметр dataAsTable был отключен и учитывался.

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

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

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

Используйте драйвер устройства Внешнее приложение/скрипт для более настраиваемого выполнения приложений.

Имя функции:	execute
Права доступа:	Доступна на уровне прав администратора
Входные записи:	1
Входной Формат:	Название	Тип	Описание
	command	String	Полное имя команды с аргументами.
	directory	String	Рабочая директория, может быть опущена, но только если следующий аргумент, кодировка, также опущен. Если нет необходимости указывать каталог, но есть необходимость указать кодировку, в качестве аргумента каталога следует использовать NULL.
	charset	String	Каноническое имя кодировки, указанное в java.nio API, может быть опущено. Список поддерживаемых кодировок можно найти в документации Oracle.
Выходные записи:	1
Выходной Формат:	Имя	Тип	Описание
	exitCode	Integer	Код выхода команды.
	output	String	Захват вывода команды.
	errors	String	Захват вывода ошибок команды.

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

Список переменных

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

Имя функции:	listVariables
Права доступа:	Доступна на уровне прав Наблюдателя
Входные записи:	1
Входной Формат:	Название	Тип	Описание
	mask	String	Маска контекста для перечисления переменных из списка.
	group	String	Группа переменной.
Выходные записи:	0...неограниченно
Выходной Формат:	Название	Тип	Описание
	context	String	Описание контекста.
	variable	String	Описание переменной.
	value	String	Строковое представление значения переменной.

Статистика

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

Имя функции:	statistics
Права доступа:	Доступна на уровне прав Наблюдателя
Входные записи:	1
Входной Формат:	Название	Тип	Описание
	mask	String	Маска контекста для получения статистических данных.
	channel	String	Название канала.
	key	String	Ключ набора данных или NULL для использования набора данных по умолчанию.
	period	String	Период времени, за который нужно показать последние значения. Если NULL, данные будут получены за все периоды. Названия: Период: миллисекунда или мс для Миллисекунды секунда, sec или s для Секунды минута, min или m для Минут час, hr или h для Часов день или d для дней неделя или w для Недель месяц для Месяцев (Заметим, что месяц основан на нуле, т. е. значение для января равно 0.) год или y для Годов
	full	Boolean	Если true, то возвращаются все значения статистики за указанный период (например, все средние значения за час). Если false, возвращаются только последние собранные значения (например, последние средние значения за полный час).
	average	Boolean	Показать среднее значение за последний период выбранного типа. По умолчанию: true.
	minimum	Boolean	Показать минимальное значение для последнего периода выбранного типа. По умолчанию false.
	maximum	Boolean	Показать максимальное значение для последнего периода выбранного типа. По умолчанию false.
	sum	Boolean	Показать общее значение за последний период выбранного типа. По умолчанию false.
	first	Boolean	Показать первое значение для последнего периода выбранного типа. По умолчанию false.
	last	Boolean	Показать последнее значение для последнего периода выбранного типа. По умолчанию false.
Выходные записи:	0...неограниченно
Выходной Формат:	Название	Тип	Описание
	context	String	Имя контекста, в котором происходят данные.
	start	Date	Начало периода времени.
	end	Date	Конец периода времени.
	key	String	Ключ набора данных или NULL, если использовался набор данных по умолчанию.
	average	Float	Среднее значение за период времени.
	minimum	Float	Минимальное значение за период времени.
	maximum	Float	Максимальное значение за период времени.
	sum	Float	Общее значение за период времени.
	first	Float	Первое значение за период времени.
	last	Float	Последнее значение за период времени.

Необработанная Статистика

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

Имя функции:	rawStatistics
Права доступа:	Доступно на уровне прав Наблюдателя
Входные записи:	1
Входной Формат:	Название	Тип	Описание
	context	String	Имя контекста для получения статистики.
	name	String	Имя канала, из которого будет получена статистика.
Выходные записи:	0...неограниченно
Выходной Формат:	Динамический

Без обработки Статистика

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

Имя функции:	rawStatistics
Права доступа:	Доступно на уровне прав Наблюдателя
Входные записи:	1
Входной Формат:	Название	Тип	Описание
	context	String	Имя контекста для получения статистики.
	name	String	Имя канала, из которого будет получена статистика.
Выходные записи:	0...неограниченно
Выходной Формат:	Динамический

Статистика сущностей контекста

Возврат статистики для сущностей указанного контекста или контекстов.

Имя функции:	contextEntitiesStatistics
Права доступа:	Доступна на уровне прав Наблюдателя
Входные записи:	1
Входной Формат:	Название	Тип	Описание
	mask	String	Контекст или маска контекста, связанная с нужными сущностями. Опция, по умолчанию - корневой контекст.
	type	String	Укажите тип сущности для сбора статистики. Обязательно для заполнения, должно быть предоставлено одно из следующих значений: 1 - Переменные 2 - Функции 4 - События
	name	String	Укажите точное имя сущности для фильтрации результатов. Опция, по умолчанию отображаются все связанные сущности.
Выходные записи:	0...неограниченно
Выходной Формат:	Название	Тип	Описание
	context	String	Путь контекста, связанный с сущностью.
	name	String	Имя сущности.
	getCount	Integer	Только переменные - количество раз, когда было получено значение переменной.
	setCount	Integer	Только переменные - количество раз, когда было установлено значение переменной.
	execCount	Integer	Только функции - количество выполнений функции.
	subscribeCount	Integer	Только события - количество раз, когда компоненты подписались на событие.
	unsubscribeCount	Integer	Только события - количество раз, когда компоненты отписывались от события.
	listenerCount	Integer	Только события - количество слушателей события.
	instancesCount	Integer	Только события - количество экземпляров события.

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

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

Имя функции:	deleteStatistics
Права доступа:	Доступна на уровне прав Наблюдателя
Входные записи:	1
Входной Формат:	Название	Тип	Описание
	mask	String	Маска контекстов для поиска каналов статистики.
	channel	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
Входной Формат:	Название	Тип	Описание
	tableExpression	String	Выражение, которое должно вернуть таблицу, записи которой будут использованы для построения списка значений выбора.
	valueExpression	String	Выражение расширенного поиска, которое вычисляется над каждой записью таблицы и должно возвращать строковое представление значения выбора.
	descriptionExpression	String	Выражение, которое вычисляется над одной записью и должно возвращать описание значения выбора.
Выходные записи:	0...неограниченно
Выходной Формат:	Название	Тип	Описание
	value	String	Строковое представление значения выбора.
	description	String	Описание значения выбора.

Сводка

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

События исторического контекста, хранящиеся в базе данных сервера
Исторические значения контекстной переменной (также загружено из базы данных сервера)
Данные, собранные каналом статистики

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

Имя функции:	summary
Права доступа:	Доступна на уровне прав Наблюдателя
Входные записи:	0...неограниченно
Входной Формат:	Название	Тип	Описание
	seriesName	String	Имя серии данных, т.е. имя столбца серии в выводе функции. Должно содержать только английские буквы, цифры и символы подчеркивания.
	seriesDescription	String	Понятное человеку описание серии, т. е. описание выходного поля.
	startDate	Date	Самая ранняя дата первой выборки данных, которая будет обработана для серии.
	endDate	Date	Последняя дата последней выборки данных, которая будет обработана для серии.
	masks	String	Разделенный пробелами список масок контекстов, соответствующих источникам, из которых загружаются данные серии. Примеры: `users..devices.` - все устройства, доступные для вызывающей функции `users.john.devices.dev1 users.john.devices.dev2` - два конкретных устройства
	entity	String	Имя контекстной сущности (т.е. переменной или функции), исторические значения которой будут обрабатываться серией.
	entityType	Integer	Тип контекстной сущности, исторические значения которой будут обрабатываться серией. Может быть переменной или функцией, см. ссылку на их числовой код здесь.
	expression	String	Выражение AggreGate, которое должно возвращать число. Выражение используется для: Получения числовых выборок данных из Таблиц данных, представляющих исторические события и значения переменных. Обработать предварительно агрегированные выборки данных, содержащиеся в канале статистики (если серия относится к статистике). Если выражение возвращает NULL, обработанный образец данных отбрасывается.
			Выражение расширенного поиска серии Окружение:
			Контекст по умолчанию	Контекст, в котором обрабатывается история/статистика.
			Таблица данных по умолчанию	Таблица данных, представляющая текущее обрабатываемое историческое событие или значение переменной.
			Строка по умолчанию	0
			Переменные окружения	Толькостандартные переменные.
	dateExpression	String	Выражение AggreGate, которое должно возвращать дату. Используется для получения дат получения образцов из Таблиц данных, представляющих исторические события и значения переменных. Выражение NULL (по умолчанию подходит для большинства случаев) заставляет функцию использовать временные метки, указывающие, когда исторические события и значения переменных были записаны в базу данных сервера.
			Серия Выражение расширенного поиска по дате Окружение:
			Контекст по умолчанию	Контекст, в котором обрабатывается история/статистика.
			Таблица данных по умолчанию	Таблица данных, представляющая обрабатываемое в данный момент историческое событие или значение переменной.
			Строка по умолчанию	0
			Переменные окружения	Толькостандартные переменные.
	grouping	Integer	Тип периода времени, используемый для группировки данных. Доступные типы см. здесь.
	aggregation	Integer	Тип агрегации числовых значений. Доступные типы см. здесь.
	changeType	Integer	Тип серии. Описание доступных типов см. здесь. Числовые коды типов: 0 - Индикатор 1 - Счетчик 2 - Счетчик без переполнения 3 - абсолютный
	outOfRangeValuesHandling	Integer	Определяет, как будут обрабатываться значения, выпадающие из диапазона значений (т.е. значения типа индикатора или расходы в секунду, рассчитанные в соответствии с вышеуказанным типом серии данных): 0 - Игнорировать, т.е. не соблюдать указанные ниже минимальное и максимальное значения 1 - Исключать, т.е. не обрабатывать значения, выходящие из диапазона, указанного ниже. 2 - Нормализовать, т.е. преобразовать низкие и высокие значения, выходящие за пределы диапазона, в нижние или верхние границы соответственно
	minValue	Double	Минимально допустимое значение типа индикатора или расхода в секунду.
	maxValue	Double	Максимально допустимое значение типа датчика или скорость в секунду.
	timeZone	String	Часовой пояс, используемый для выравнивания временных периодов в выходной таблице. Если значение равно null, используется часовой пояс по умолчанию AggreGate Server. Временные зоны могут быть указаны в строковой форме, например: GMT-8 GMT-08:00 Америка/Лос_Анджелес Указание разных часовых поясов для разных серий данных не поддерживается и приведет к непредсказуемым результатам.
	showDetails	Integer	Определяет, будут ли данные за период времени добавлены в вывод функции: 0 - Никогда, запись за период будет пропущена, если другие серии не определят, что она должна быть видна. Если эта опция используется для всех серий, раздел Подробности будет фактически пропущен, и будут показаны только итоги. 1 - Всегда, запись за период будет добавлена, даже если другие серии определят, что она должна быть пропущена. 2 - Ценно, запись за период будет добавлена только в том случае, если агрегированное значение не равно Null или NaN (или если другие серии определяют, что оно должно быть видимым). Значение по умолчанию - Всегда.
	showTotals	Boolean	Определяет, будут ли в вывод функции добавлены итоги по всем сериям. Будет использоваться только значение, определенное для первой серии (т. е. в первой строке входа функции), остальные значения будут игнорироваться.
	sortPriority	Integer	Определяет политику сортировки для выхода функции: 0 - сначала группировка по периодам времени, затем по источникам 1 - сначала группировка по источникам, затем по временным периодам
Записи на выходе:	0...неограниченно
Выходной Формат:	Статические поля вывода, которые всегда доступны:
	Название	Тип	Описание
	periodName	String	Человекочитаемое имя периода времени, в котором агрегированные данные представлены выходной записью.
	periodMiddle	Date	Первая миллисекунда периода времени, за который агрегированные данные представлены выходной записью.
	periodEnd	Date	Средняя миллисекунда периода времени, за который агрегированные данные представлены выходной записью.
	periodStart	Date	Последняя миллисекунда периода времени, за который агрегированные данные представлены выходной записью.
	context	String	Путь контекста источника, данные которого представлены выходной записью.
	Дополнительные колонки выхода функции определяются сериями данных, указанными во входе функции:
	Название	Тип	Описание
	имя, определяемое полем ввода `seriesName`	`Date` для серии, использующей типы агрегации First Date и Last Date. `Integer` для серий, использующих тип агрегации Total Количество и Valid Количество. `Double` для других серий.	Каждый динамический столбец содержит агрегаты для каждого источника на время и период, рассчитанные в соответствии с параметрами серии.

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

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

Имя функции:	fireBackdatedEvent
Права доступа:	Доступно на уровне прав администратора
Входные записи:	0...неограниченно
Входной Формат:	Название	Тип	Описание
	context	String	Путь к контексту, в котором нужно сгенерировать событие event.	String	Имя события, которое необходимо сгенерировать.
	event	String	Имя события, которое необходимо сгенерировать.
	level	Integer	Уровень события или null для использования уровня по умолчанию.
	creationTime	Date	Прошлая дата события. Будет сохранена в базе данных сервера.
	data	Data Table	Данные, относящиеся к конкретному событию. Должны соответствовать формату, указанному в определении события.
Выходные записи:	0
Выходной Формат:	Нет

Создание местоположения компонента для сетки

Удобная функция для создания таблицы данных, соответствующей формату переменной расположение компонента. Вводимые значения, отличные от path, форматируются и возвращаются в поле grid. Выходные absolute и dockabled поля содержат пустую, но правильно отформатированную таблицу данных.

Имя функции:	componentLocationForGrid
Права доступа:	Доступно на уровне прав менеджера
Входные записи:	1
Входной Формат:	Name	Type	Description
	path	String	Строка, указывающая путь к целевой приборной панели или контейнеру, как описано в поле `path` переменной Расположение компонента.
	row	Integer	Описание этих полей см. в поле `grid` переменной Расположение компонента.
	column	Integer
	rowSpan	Integer
	columnSpan	Integer
Выходные записи:	1
Выходной Формат:	Name	Type	Description
	path	String	Tо же значение, что и в поле ввода `path`.
	absolute	Data Table	Тот же формат, что и у поля `absolute` в переменной Расположение компонентаНе содержит строк.
	grid	Data Table	Тот же формат, что и у поля `grid` в переменной Расположение компонента. Содержит одну строку, содержащую значения, указанные во входных данных функции.
	dockable	Data Table	Тот же формат, что и у поля `dockable` в переменной Расположение компонента. Не содержит строк.

Создать компонентное местоположение для абсолюта

Удобная функция для создания таблицы данных, соответствующей формату переменной расположение компонента. Входные значения, отличные от path, форматируются и возвращаются в поле absolute вывода. Поля вывода grid и dockabled содержат пустую, но правильно отформатированную таблицу данных.

Имя функции:	componentLocationForAbsolute
Права доступа:	Доступно на уровне прав менеджера
Входные записи:	1
Входной Формат:	Name	Type	Description
	path	String	Строка, указывающая путь к целевой приборной панели или контейнеру, как описано в поле `path` переменной Расположение компонента.
	x	Integer	Описание этих полей см. в поле `absolute` переменной Расположение компонента
	y	Integer
	width	Integer
	height	Integer
	zIndex	Integer
Выходные записи:	1
Выходной Формат:	Name	Type	Description
	path	String	Tо же значение, что и в поле ввода `path`.
	absolute	Data Table	Тот же формат, что и у поля `absolute` в переменной Расположение компонента. Содержит одну строку, содержащую значения, указанные во входных данных функции.
	grid	Data Table	Формат такой же, как у поля `grid` в переменной Component Location. Не содержит строк.
	dockable	Data Table	Тот же формат, что и у поля `dockable` в переменной Расположение компонента. Не содержит строк.

Создание местоположения компонента для Dockable

Удобная функция для создания таблицы данных, соответствующей формату переменной расположение компонента. Входные значения, отличные от path, форматируются и возвращаются в поле вывода dockable. Поля вывода grid и absolute содержат пустую, но правильно отформатированную таблицу данных.

Имя функции:	componentLocationForDockable
Права доступа:	Доступно на уровне прав менеджера
Входные записи:	1
Входной Формат:	Name	Type	Description
	path	String	Строка, указывающая путь к целевой приборной панели или контейнеру, как описано в поле `path` переменной Расположение компонента.
	position	String	Описание этих полей см. в поле `dockable` переменной Расположение компонента.
	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
Выходные записи:	1
Выходной Формат:	Name	Type	Description
	path	String	Tо же значение, что и в поле ввода `path`.
	absolute	Data Table	Тот же формат, что и у поля `absolute` в переменной Расположение компонентаНе содержит строк.
	grid	Data Table	Формат такой же, как у поля `grid` в переменной Component Location. Не содержит строк.
	dockable	Data Table	Тот же формат, что и у поля `dockable` в переменной Расположение компонента Содержит одну строку, содержащую значения, указанные во входных данных функции.

Получить модули

Возврат таблицы с информацией обо всех модулях, доступных в указанном магазине. Указанный адрес storeAddress должен существовать и быть настроен в Списке магазинов в разделе Глобальные Конфигурации.

Имя функции:	getModules
Права доступа:	Доступно на уровне прав Менеджера
Входные записи:	1
Входной Формат:	Название	Тип	Описание
Входной Формат:	storeAddress	String	Укажите адрес магазина, из которого необходимо получить список модулей.
Выходные записи:	0... Не ограничено
Выходной Формат:	Имя	Тип	Описание
	id	String	Идентификатор модуля
	description	Boolean	Успешно
	image	Data Block	Изображение, связанное с модулем
	versions	Data Table	Таблица данных, содержащая информацию для различных версий модуля. version: Указывает версию модуля. description: Описание модуля content: Файл, содержащий модуль. dependencies: Список зависимостей модуля. preInstallScript: Скрипт, который будет запущен перед установкой модуля. postInstallScript: Скрипт, который будет запущен после установки модуля. preUninstallScript: Скрипт, который будет запущен перед удалением модуля. postUninstallScript: Скрипт, который будет запущен после удаления модуля.

Получить решения

Возврат таблицы с информацией обо всех решениях, доступных в указанном магазине. Указанный адрес storeAddress должен существовать и быть настроен в Списке магазинов в разделе Глобальные конфигурации.

Имя функции:	getSolutions
Права доступа:	Доступно на уровне прав менеджера
Входные записи:	1
Входной Формат:	Название	Тип	Описание
Входной Формат:	storeAddress	String	Укажите адрес магазина, из которого необходимо получить список решений.
Выходные записи:	0... Не ограничено
Выходной Формат:	Имя	Тип	Описание
	name	String	Название решения.
	description	String	Описание решения.
	modules	Data Table	Список идентификаторов модулей, из которых состоит решение. В таблице данных имеется одно поле: id: ID модуля

Установка модулей

Установка любого количества модулей путем предоставления списка идентификаторов модулей. Указанный адрес storeAddress должен существовать и быть настроен в Списке магазинов в разделе Глобальные конфигурации.

Имя функции:	installModules
Права доступа:	Доступна на уровне прав Менеджера
Входные записи:	1...неограниченно
Входной Формат:	Название	Тип	Описание
	storeAddress	String	Адрес магазина.
	id	String	Идентификатор модуля, который необходимо установить.
Выходные записи:	0... Не ограничено
Выходной Формат:	Имя	Тип	Описание
	id	String	Идентификатор модуля
	installed	Boolean	Указывает, был ли модуль Успешно установлен.
	status	String	Если модуль не был успешно установлен, указывает причину неудачи.

Удаление модулей

Удалите любое количество модулей, предоставив список идентификаторов модулей.

Имя функции:	uninstallModules
Права доступа:	Доступна на уровне прав Менеджера
Входные записи:	1
Входной Формат:	Название	Тип	Описание
Входной Формат:	id	String	Идентификатор модуля, который необходимо удалить.
Выходные записи:	0... Не ограничено
Выходной Формат:	Имя	Тип	Описание
	name	String	Имя модуля
	uninstalled	Boolean	Указывает, был ли модуль успешно деинсталлирован
	status	String	Если модуль не был успешно деинсталлирован, указывает причину неудачи

Построить хранилище

Создает или обновляет таблицу в базе данных, которая будет служить хранилищем для класса. Вызов этой функции в контексте утилит будет нацелен на реляционную базу данных, настроенную для сервера. При вызове в контексте устройства, использующего драйвер базы данных SQL или драйвер графовой базы данных, она создаст или обновит таблицу в базе данных, указанной в конфигурации устройства.

Имя функции:	storageConstruct
Права доступа:	Доступна на уровне прав Менеджера
Входные записи:	1
Входной Формат:	Название	Тип	Описание
	table	String	Имя таблицы, которая будет создана или обновлена в базе данных.
	fields	Data Table	Список полей для создания в указанной таблице. Этот входной параметр имеет тот же формат, что и таблица Поля в конфигурации класса.
	lifeCycles	Data Table	Таблица, описывающая жизненные циклы класса, который будет управлять создаваемой таблицей. Этот входной параметр форматируется так же, как таблица Жизненные циклы в конфигурации класса.
	manyToManyRelations	Data Table	Таблица, описывающая связи класса, который будет управлять создаваемой таблицей. Этот входной параметр форматируется так же, как таблица Отношения многие ко многим в конфигурации класса.
	inheritedTables	Data Table	Список таблиц, которые наследуются таблицей, названной во входном параметре table. Эта таблица данных имеет одно поле с любым количеством строк: Name: Имя таблицы, унаследованной таблицей, названной во входном параметре table
	dropExistingColumns	Boolean	Необязательный входной параметр со значением по умолчанию `True` и следующим воздействием на выполнение функции: Если `True`, любые столбцы, уже существующие в таблице, названной входным параметром table, будут удалены, за исключением столбцов, перечисленных во входном параметре fields. Если `False`, любые столбцы, уже существующие в таблице, названной входным параметром table, не будут затронуты, даже если они не перечислены во входном параметре fields.
Выходные записи:	0
Выходной Формат:	Нет

Общедоступные события

[?]

Общие события: info (Information)

DPF_EXPORT_V5.8.8 / TIME_1766394548 / 2025-12-22 09:09:08 / STRLEN_105140 / STRLEN_HTML_105917

{VERSION}

Was this page helpful?