Специальные ссылки Web UI

Специальная ссылка Web UI инициирует операцию, характерную для Web UI. Она имеет следующий формат:

web/operation([parameter1, parameter2,...])

Поддерживаются следующие операции:

Выход из системы

Ссылка web/logout() завершает текущую сессию Web UI и выводит пользователя из системы. Если пользователь зарегистрирован с помощью технологии единого входа (SSO), поставщику идентификационных данных будет отправлена команда для аннулирования текущего токена аутентификации.

Выполнить действие

Ссылка web/executeAction(context, action[, parameters]), вызванная из контекста, выполняет указанное действие. При необходимости можно указать входные параметры действия.

Имя параметра

Тип параметра

Подробности

context

Строка

Контекстный путь к контексту желаемого действия.

action

Строка

Имя действия, которое необходимо выполнить.

parameters

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

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

Перенаправление

Ссылка web/redirect(dashboard, historyUrlChanged, newTab, parameters, componentLocation) перенаправляет текущего пользователя на веб-панель, указанную параметром dashboard. Параметр dashboard может быть как контекстным путем, так и другим URL.

Имя параметра

Тип параметра

Подробности

dashboard

Строка

Путь к контексту инструментальной панели или абсолютный URL. Примерные значения:

  • "users.admin.dashboards.exampleDashboard" Путь к контексту инструментальной панели.

  • "http://www.dashboardserver.com/users.admin.dashboards.exampleDashboard" Абсолютный URL-адрес инструментальной панели.

  • "http://example.com/" Абсолютный URL-адрес внешнего сайта.

historyUrlChanged

Булево

Значение по умолчанию - False. Определяет, перенаправлять ли пользователя на контекстный путь или URL, заданный dashboard, или добавить значение dashboard в конец текущего URL.

  • False - перенаправление пользователя на контекст панели или URL, указанный аргументом dashboard.

  • True - перенаправляет пользователя на URL, созданный путем добавления значения dashboard к текущему URL.

    • Если текущий URL - http://example.com/, а dashboard - "users.admin.dashboards.exampleDashboard", то перенаправление будет "http://www.dashboardserver.com/users.admin.dashboards.exampleDashboard".

newTab

Булево

Значение по умолчанию - False. Определяет, открывать ли перенаправление в новой вкладке.

  • False - Открывать редирект на текущей вкладке.

  • True - Открывать редирект в новой вкладке.

parameters

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

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

По умолчанию функция web/redirect() перенаправляет пользователя на текущий экземпляр инструментальной панели, если таковой существует, с указанным параметром dashboard.

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

  • dc - Указывает контекст по умолчанию относительной инструментальной панели. Использование этого ключа позволяет открывать одну и ту же относительную панель несколько раз с разным контекстом. Может иметь любое значение при перенаправлении на абсолютные панели или панели экземпляра класса.

  • instanceId - ссылка на конкретный экземпляр класса при открытии инструментальной панели, содержащей компонент Class Data Table или Class Field List. Может иметь любое значение, если в цели перенаправления нет ссылок на экземпляры классов.

Пример

Функция web/redirect() вычисляется с указанными параметрами:

{web/redirect(
	"users.admin.dashboards.exampleDashboard", 
	False, 
	False, 
	'structure("key","value1","value2")'
	)
}

Конкатенирует URL со следующей строкой запроса:

?key1=value1&key2=value2

URL перенаправления будет таким: 

http://www.dashboardserver.com/users.admin.dashboards.exampleDashboard?key1=value1&key2=value2

Перенаправление на внешний сайт (http://some.external-site.example.com) с помощью следующего выражения:

{web/redirect(
	"http://some.external-site.example.com", 
	False, 
	False, 
	'structure("key","value1","value2")'
	)
}

Это идентично вызову:

{web/redirect("http://some.external-site.example.com?key1=value1&key2=value2")}

componentLocation

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

Форматируется так же, как и переменная Component Location, и применяется только в том случае, если оба параметра newTab и historyUrlChanged равны False.

Параметр componentLocation указывает переменную Component Location, которая должна быть применена к инструментальной панели при ее открытии. Она управляет расположением dashboard относительно панели, на которой была вызвана функция web/redirect(...).

Вспомогательные функции Create Component Location for Grid, Create Component Location for Absolute и Create Component Location for Dockable из контекста Utilities Context могут быть использованы для удобного создания правильно отформатированной таблицы данных для параметра componentLocation.

Пример

Функция componentLocationForDockable() может быть использована для создания переменной Component Location, которая открывает панель users.admin.dashboards.example как вкладку в компоненте с именем panel0, причем группа вкладок расположена в верхней части компонента:

evaluate(
  '{web/redirect("users.admin.dashboards.example", 
  false, 
  false, 
  \'structure("key","value1","value2")\', 
  \'{utilities:componentLocationForDockable(
    "^", 
    "tab", 
    "", 
    "panel0", 
    "", 
    "top")}\' )}')

Was this page helpful?