Web UI Special References

context

String

Context path to the context of the desired action.

action

String

Name of action to execute.

parameters

Data Table

Data table containing action input parameters. The field names of the data table must be the input parameter names of the action. The data table must contain a single row, with the values for each input parameter.

dashboard

String

The dashboard context path or an absolute URL. Example values:

• "users.admin.dashboards.exampleDashboard" Dashboard context path.

• "http://www.dashboardserver.com/users.admin.dashboards.exampleDashboard" Absolute URL of a dashboard.

• "http://example.com/" Absolute URL of an external site.

historyUrlChanged

Boolean

Default value is False. Determines whether to redirect user to the context path or URL defined by dashboard, or append the dashboard value to the end of the current URL.

• False - redirect user to the dashboard context or URL indicated by the dashboard argument.

• True - redirect users to the URL created by appending the value of dashboard to the current URL.

  • If current URL is http://example.com/ and dashboard is “users.admin.dashboards.exampleDashboard", the redirect will be "http://www.dashboardserver.com/users.admin.dashboards.exampleDashboard".

newTab

Boolean

Default value is False. Determines whether to open the redirect in a new tab.

• False - Open redirect in the current tab.

• True - Open redirect in a new tab.

parameters

Data Table

Data table indicating dashboard parameters to append to the URL. The data table must have a single row, with a field for every parameter. Each field of the data table represents a query parameter, and the corresponding value in the row must contain the value for that key-value pair.

By default, the web/redirect() function will redirect the user to a currently running dashboard instance, if one exists, of the provided dashboard parameter.

In order to redirect the user to a new dashboard instance, provide a unique value with one or more of the special parameter keys:

• dc - Indicates the default context of a relative dashboard. Using this parameter key allows the same relative dashboard to be opened multiple times with a different context. Can be any value when redirecting to absolute or instantiable dashboards.

• instanceId - Refers to a specific class instance when opening a dashboard containing a Class Data Table or Class Field List component. Can be any value if no class instances are being referenced in the redirect target.

Example

The web/redirect() function evaluated with the indicated parameters:

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

Will concatenate the URL with the following query string:

?key1=value1&key2=value2

The redirect URL will be:

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

Redirecting to an external site (http://some.external-site.example.com) with the following expression:

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

Is identical to calling:

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

componentLocation

Data Table

Formatted the same as the Component Location variable and is applied only in the case when both the newTab and historyUrlChanged parameters are False.

The componentLocation parameter indicates the Component Location variable that should be applied to the dashboard when it is opened. This controls the location of dashboard in relation to the dashboard where the web/redirect(...) function was called.

The helper functions Create Component Location for Grid, Create Component Location for Absolute, and Create Component Location for Dockable from the Utilities Context can be used to conveniently create a properly formatted data table for the componentLocation parameter.

Example

The function componentLocationForDockable() can be used to create a Component Location variable that opens the dashboard users.admin.dashboards.example as a tab in the component named panel0, with the tab group located at the top of the component:

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