Функции, относящиеся к контекстам

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

Функция	Описание		Тип результата	Серверная поддержка	Фронтенд-поддержка
actionAvailable(String context, String action [, String schema])	Оценивает, доступно ли заданное действие в указанном контексте. Возвращает true, если действие, идентифицированное параметром action, доступно в контексте, указанном параметром context для вызывающей функции actionAvailable. Если действие недоступно, возвращается false. Пример: `actionAvailable("users.admin.models.demoModel", "edit")` возвращает "true" или "false"		Boolean	Да	Да
available(String context [, String schema])	Возвращает true, если контекст с путем контекст существует и доступен вызывающему. Пример: `available("users.admin.models.demoModel")` возвращает "true" или "false"		Boolean	Да	Да
callFunction(String context, String function, Object parameter1, Object parameter2, ...)	Вызывает функцию под названием функция контекста с путем контекст и возвращает ее выход. Ввод функции таблица данных строится из массива параметров (parameter1, parameter2, ...). Правила, используемые для заполнения таблицы данными, описаны здесь. Пример: `callFunction("Utilities", "Evaluate Expression", "2+2")` возвращает таблицу с одной записью: "`(Result=4)`"		DataTable	Да	Да
callFunctionEx(String context, String function, DataTable parameters [, String schema])	Аналогичный callFunction(...) вызывает функцию под названием функция контекстас путем контекст и возвращает ее результат. Параметры функции представлены таблицей данных. Пример: `callFunctionEx("Utilities", "Evaluate Expression", table("<<expression><S>>", "2+2"))` возвращает таблицу с одной записью: "`(Result=4)`"		DataTable	Да	Да
dc([String schema])	Возвращает путь контекста по умолчанию, определенный во время оценки выражения. Пример: `dc()` возвращает путь контекста по умолчанию, например `"users.admin.models.demoModel"`		String	Да	Да
dc([String schema])		Другой способ получения пути контекста по умолчанию - это использование ссылки `{.:}`.	String	Да	Да
dr()	Возвращает строку по умолчанию, определенную во время оценки выражения. Пример: `dr()` возвращает индекс строки по умолчанию; не определён в Expression Builder, если не задана таблица/строка по умолчанию		Integer	Да	Да
dt()	Возвращает таблицу по умолчанию, определенную во время оценки выражения. Пример: `dt()` возвращает DataTable по умолчанию; не определён в Expression Builder, если не задана таблица по умолчанию		DataTable	Да	Да
dt()		Другой способ получения пути контекста по умолчанию - это использование ссылки `{}`.	DataTable	Да	Да
eventAvailable(String context, String event [, String schema])	Возвращает true, если контекст с путем, определенный аргументом контекст, имеет переменную, определенную аргументом событие, и это событие доступно вызывающему. Пример: `eventAvailable("users.admin.devices.virtual", "event1")` возвращает "true" или "false"		Boolean	Да	Да
eventFormat(String context, String event [, String schema [, Boolean asTable]])	Возвращает строковое представление формата события или ноль, если контекст/событие недоступен или формат события динамический. По умолчанию используется режим кодирования невидимых разграничителей для кодирования таблицы в виде строки. Чтобы вернуть результат в виде таблицы данных, задайте для asTable значение `true`. Обратите внимание, что при вычесление выражений в редакторе выражений веб-интерфейса функция eventFormat должна вычисляться на сервере при использовании параметра asTable. Пример: `eventFormat("users.admin.devices.virtual", "event1")` возвращает строку формата события или "null"		String	Да	Да
eventGroup(String context, String event [, String schema])	Возвращает имя группы, к которой принадлежит событие, или значение null, если оно не принадлежит ни одной группе. Пример: `eventGroup("users.admin.devices.virtual", "event1")` возвращает имя группы события или "null"		String	Да	Нет
fireEvent(String context, String event, Integer level, Object parameter1, Object parameter2, ...)	Запускает событие под названием событие в контексте. Использует определенный уровень или уровень события по умолчанию, если параметр уровня - NULL. Коды уровня события описаны здесь. Если предоставляется лишь один параметр типа Data Table, эта таблица будет использоваться в качестве таблицы данных события, при этом формат таблицы данных этого параметра должен совпадать с форматом таблицы данных события. В ином случае Таблица данных, представляющая данные события, строится из массива параметров (parameter1, parameter2, ...). Правила, используемые для заполнения таблицы данными, описаны здесь. Эта функция возвращает идентификатор сгенерированного события или ноль, если генерация событий блокируется системой. Пример: `fireEvent("users.admin.devices.virtual", "event1", 3, "text0", 100)` возвращает ID события или "null"		Long	Да	Да
		Функция fireEvent() сработает лишь в выражении, которое оценивается в AggreGate Server. Выражения, которые оцениваются в AggreGate Client или Agent, не вызовут генерирование событий сервера.	Long	Да	Да
fireEventEx(String context, String event, Integer level, DataTable value [, String schema])	Работает так же, как и fireEvent(), но принимает данные события в виде таблицы value и позволяет указать схему при помощи параметра schema. Пример: `fireEventEx("users.admin.devices.virtual", "event1", 3, table("<<string><S>><<int><I>>", "text0", 100))` возвращает ID события или "null"
fullDescription(String context [, String delimiter])	Возвращает полное описание определенного контекста, т.e. описания всех родительских контекстов, разделенных строкой-разделителем. Строка-разделитель по умолчанию "-". Пример: если описания заданы как "Users", "Admin", "Devices", "Virtual", то `fullDescription("users.admin.devices.virtual", " / ")` возвращает `"Users / Admin / Devices / Virtual"`		String	Да	Да
functionAvailable(String context, String function [, String schema])	Возвращает true, если контекст с путем, указанным аргументом контекст, имеет функцию, определенную аргументом функция, и эта функция доступна для вызывающего. Пример: `functionAvailable(dc(), "calculator")` возвращает "true" или "false"		Boolean	Да	Да
functionGroup(String context, String function[, String schema])	Возвращает имя группы, которой принадлежит функция, или значение null, если она не принадлежит ни одной группе. Пример: `functionGroup(dc(), "calculator")` возвращает имя группы функции или "null"		String	Да	Нет
functionInputFormat(String context, String function [, String schema [, Boolean asTable]])	Возвращает строковое представление формата ввода функции или ноль, если контекст/функция недоступны или формат ввода функции динамический. По умолчанию используется режим кодирования невидимых разграничителей для кодирования таблицы в виде строки. Чтобы вернуть результат в виде таблицы данных, задайте для asTable значение `true`. Обратите внимание, что при вычесление выражений в редакторе выражений веб-интерфейса функция eventFormat должна вычисляться на сервере при использовании параметра asTable. Пример: `functionInputFormat(dc(), "calculator")` возвращает строку входного формата функции или "null"		String	Да	Да
functionOutputFormat(String context, String function [, String schema [, Boolean asTable]])	Возвращает строковое представление формата вывода функции или ноль, если контекст/функция недоступны или формат вывода функции динамический. По умолчанию используется режим кодирования невидимых разграничителей для кодирования таблицы в виде строки. Чтобы вернуть результат в виде таблицы данных, задайте для asTable значение `true`. Обратите внимание, что при вычесление выражений в редакторе выражений веб-интерфейса функция eventFormat должна вычисляться на сервере при использовании параметра asTable. Пример: `functionOutputFormat(dc(), "calculator")` возвращает строку выходного формата функции или "null"		String	Да	Да
getVariable(String context, String variable [, String schema])	Получает переменную под названием переменная из контекста с путем контекст и возвращает ее значение. Пример: `getVariable("users.admin.models.demoModel", "demoVar")` возвращает значение переменной (DataTable), если переменная существует в контексте по умолчанию		DataTable	Да	Да
setVariable(String context, String variable, Object parameter1, Object parameter2, ...)	Устанавливает переменную под названием переменная контекста с путем контекста. Если обеспечивается лишь один параметр типа Data Table, эта таблица будет использоваться в качестве нового значения переменной. В ином случае Таблица данных, представляющая новое значение переменной, строится из массива параметров (parameter1, parameter2, ...). Правила, используемые для заполнения таблицы данными, описаны здесь. Пример: `setVariable("users.admin.models.demoModel", "demoVar", 101, "text3", 102, "text4")` возвращает "null" (Переменная обновляется/переопределяется; функция не возвращает результата)		Null	Да	Да
setVariableEx(String context, String variable, DataTable value [, String schema])	Аналогичный setVariable(...) Устанавливает переменную под названием переменная контекста с путем контекста. Параметры функции представлены таблицей данных. Пример: `setVariableEx("users.admin.models.demoModel", "demoVar", table("<<integerField><I>><<stringField><S>>", 101, "text3"))` возвращает "null" (переменная demoVar обновляется в контексте `users.admin.models.demoModel`; функция не возвращает результата)		Null	Да	Да
setVariableField(String context, String variable, String field, Integer record, Object value [, String schema])	Устанавливает значение ячейки указанной переменной контекста. Ячейка задается параметрами поле и запись. Пример: `setVariableField("users.admin.models.demoModel", "demoVar", "stringField", 1, "newText")` возвращает "null" (Значение `stringField` обновляется для записи #1 в переменной `demoVar` в контексте `users.admin.models.demoModel`; функция не возвращает результата)		Null	Да	Да
setVariableRecord(String context, String variable, Integer record, Object parameter1, Object parameter2, ...)	Изменяет значения определенного ряда переменной контекста. Номер ряда задается параметром запись. Другие параметры используются для изменения значений этого ряда. Пример: `setVariableRecord("users.admin.models.demoModel", "demoVar", 0, 999, "first")` возвращает "null" (Перезаписывает запись #0 переменной `demoVar` значениями предоставленных полей)		Null	Да	Да
variableAvailable(String context, String variable [, String schema])	Возвращает true, если контекст с путем, определенный аргументом контекст, имеет переменную, определенную аргументом переменная, и эта переменная доступна вызывающему. Пример: `variableAvailable("users.admin.models.demoModel", "demoVar")` возвращает "true" или "false"		Boolean	Да	Да
variableFormat(String context, String variable [, String schema [, Boolean asTable]])	Возвращает строковое представление формата переменной или ноль, если контекст/переменная недоступны или формат переменной динамический. По умолчанию используется режим кодирования невидимых разграничителей для кодирования таблицы в виде строки. Чтобы вернуть результат в виде таблицы данных, задайте для asTable значение `true`. Обратите внимание, что при вычесление выражений в редакторе выражений веб-интерфейса функция eventFormat должна вычисляться на сервере при использовании параметра asTable. Пример: `variableFormat("users.admin.models.demoModel", "demoVar")` возвращает строку формата переменной `demoVar` или "null", если переменная не определена		String	Да	Да
variableGroup(String context, String variable[, String schema])	Возвращает имя группы, которой принадлежит переменная, или значение null, если она не принадлежит ни одной группе. Пример: `variableGroup("users.admin.models.demoModel", "demoVar")` возвращает "groupName" или "null", если переменная не принадлежит ни к одной группе		String	Да	Нет
variableReadable(String context, String variable [, String schema])	Возвращает true, если контекст с путем, определенный аргументом контекст, имеет переменную, определенную аргументом переменная, и эта переменная читается вызывающим. Пример: `variableReadable("users.admin.models.demoModel", "demoVar")` возвращает "true" или "false"		Boolean	Да	Да
variableWritable(String context, String variable [, String schema])	Возвращает true, если контекст с путем, определенный аргументом контекст, имеет переменную, определенную аргументом переменная, и эта переменная записывается вызывающим. Пример: `variableWritable("users.admin.models.demoModel", "demoVar")` возвращает "true" или "false"		Boolean	Да	Да

DPF_EXPORT_V5.8.8 / TIME_1778138036 / 2026-05-07 07:13:56 / STRLEN_38990 / STRLEN_HTML_31242

{VERSION}

Was this page helpful?