Available URL Parameters
Available URL Parameters
You can use the following case-sensitive parameters within the dashboard URL. Note that for some parameters, you can use either a plain-text version or an encrypted version. For example, the dashboard URL can include an encrypted version of the dashboard name.
DASHBOARD=dashbdname.dashboard
This parameter specifies the dashboard to display. You must specify either this parameter or the XDASHBOARD parameter.
dashbdname is the name of the dashboard, including the folder to which it belongs, if any. For example:
DASHBOARD=Dashboards/Dashboard%20with%20Filters%20and%20Listing%20Button.dashboard
Here %20 represents a space character; see URL Encoding, earlier in this page.
XDASHBOARD=encryptedvalue
Encrypted version of the DASHBOARD parameter. You can use parameter only within the context of a web session. You must specify either this parameter or the DASHBOARD parameter.
To create encryptedvalue, start with the name of the dashboard, including the folder to which it belongs, if any. For example:
Dashboards/Dashboard with Filters and Listing Button.dashboard
Do not include URL escaping; for example, leave a space as a space character.
Then use the Encrypt() class method of %CSP.PageOpens in a new tab to encrypt this value. Use the value returned by Encrypt() as the value of the XDASHBOARD parameter.
EMBED=1
If this parameter is 1, the dashboard is displayed in embedded mode. This is equivalent to setting NOTITLE=1, NOMODIFY=1, NOBORDER=1, and WORKLISTS=0.
XEMBED=encryptedvalue
Encrypted version of the EMBED parameter. You can use parameter only within the context of a web session.
To create encryptedvalue, start with the value you would use for EMBED. Then use the Encrypt() class method of %CSP.PageOpens in a new tab to encrypt this value. Use the value returned by Encrypt() as the value of the XEMBED parameter.
NOTITLE=1
If this parameter is 1, the dashboard is displayed without a title area. The title area is the top area, as in the following example:
![The Dashboard Title area, showing the Menu button, the Home, About, and Logout links, the Username, and the license info.](images/d2imp_settings_dashboard_title_area.png)
NOMODIFY=1
If this parameter is 1, the dashboard cannot be modified. This option removes items from Menu. It also suppresses the edit options on widgets, so that a widget includes only minimize, maximize, and remove options in the upper right.
NOBORDER=1
If this parameter is 1, the dashboard is displayed without the border.
RESIZE=boolean
Specifies whether the widgets can be resized and moved. If boolean is 1 (the default), the widgets can be resized and moved. If boolean is 0, they cannot.
WORKLISTS=n
Where n is 0, 1, or 2. This parameter specifies the number of worklist areas to display on the left.
XWORKLISTS=encryptedvalue
Encrypted version of the WORKLISTS parameter. You can use parameter only within the context of a web session.
To create encryptedvalue, start with the value you would use for WORKLISTS. Then use the Encrypt() class method of %CSP.PageOpens in a new tab to encrypt this value. Use the value returned by Encrypt() as the value of the XWORKLISTS parameter.
SCHEME=schemename
Specifies the color scheme for the dashboard (if you do not want to use the default). For schemename, specify a scheme as listed in the General tab of the Settings page. See Specifying Basic Settings.
SETTINGS=name1:value1;name2:value2;name3:value3;...;
Where name1, name2, name3, and so on are names of dashboard settings, as described in the next section, and value1, value2, value3, and so on are the values for the settings.
You can include this parameter multiple times in the URL.
For example, to pass values to a specific widget in a dashboard, use the following variation:
basic_dashboard_url&SETTINGS=TARGET:widgetname;name:value;name:value;name:value;...;
To pass values to all widgets in a dashboard, use a URL of the following form, noting the exclusion of the TARGET parameter used in the previous example:
basic_dashboard_url&SETTINGS=name:value;name:value;name:value;...;
To pass values to multiple widgets in a dashboard, use the following variation:
basic_dashboard_url&SETTINGS=...;&SETTINGS=...;&SETTINGS=...;...;
A setting for a specific widget always takes precedence over settings for all widgets. Otherwise, the settings are applied in the order in which they are specified; if one setting is inconsistent with another setting, the later setting takes effect. These settings do not take precedence over any user settings.
XSETTINGS=encryptedvalue
Encrypted version of the SETTINGS parameter. You can use parameter only within the context of a web session.
To create encryptedvalue, start with the value that you would use with SETTINGS. Then use the Encrypt() class method of %CSP.PageOpens in a new tab to encrypt this value. Use the value returned by Encrypt() as the value of the XSETTINGS parameter.
IRISUsername=myuser&IRISPassword=mypass
Where myuser is an InterSystems IRIS username and mypass is the corresponding password. Include these parameters if the user has not yet logged in to InterSystems IRIS.
AUTOSAVE
Requests the autosaved version of the dashboard. For information on the autosave feature, see Specifying Basic Settings.