docs.intersystems.com
InterSystems IRIS Data Platform 2019.2  /  Implementing InterSystems IRIS Business Intelligence  /  Accessing Dashboards from Your Application

Implementing InterSystems IRIS Business Intelligence
Options for the SETTINGS Parameter
Previous section           Next section
InterSystems: The power behind what matters   
Search:  


Options for the SETTINGS Parameter
For the SETTINGS URL parameter, you can use settings given in the following list. Any SETTINGS string either applies to all widgets or applies to a specific widget. Include as many SETTINGS strings as you need. For example:
basic_dashboard_url&SETTINGS=...;&SETTINGS=...;&SETTINGS=...;...;
Note:
When InterSystems IRIS parses a SETTINGS parameter, it assumes that any semicolon is a delimiter between two different settings strings. To include a semicolon and not have it treated as a delimiter, you must replace it with %3B%3B (this sequence is two URL-encoded semicolons; it is necessary to use two URL-encoded semicolons because of how the parsing is performed).
TARGET
TARGET:widgetname
Specifies the widget to which this set of settings applies. If you want the settings to apply to all widgets, omit this parameter from the SETTINGS string.
FILTER
FILTER:filter_name.filter_values
Specifies how to filter the given widgets. The arguments depend upon the details of the target widget as follows:
Scenario filter_name filter_values
Target widget displays a pivot table URL-encoded version of [dimension].[hierarchy].[level] URL-encoded version of the allowed filter values that are shown in Allowed Default Values for Filters in the chapter Configuring Settings
Target widget displays a KPI URL-encoded version of the name of a filter defined in that KPI URL-encoded version of an allowed value for this filter, as defined in the KPI
For information on creating URL-encoded strings, see “URL Encoding,” earlier in this chapter.
Notes:
VARIABLE
VARIABLE:variable_name.variable_value
Specifies the value of the given pivot variable. For information on pivot variables, see “Defining and Using Pivot Variables” in Using the Analyzer.
You can use the special token $$$VARIABLES in place of variable_name.variable_value. This is useful if you use the URL in a custom navigate action (which accesses another dashboard from a given dashboard; see “Displaying a Different Dashboard,” elsewhere in this book). In this scenario, $$$VARIABLES is replaced with the current values of the given pivot variables, as specified in the original dashboard. For example:
VARIABLE:$$$VARIABLES
ROWCOUNT
ROWCOUNT:n
Specifies the maximum number (n) of rows to display; this applies only when members are displayed as rows.
COLCOUNT
COLCOUNT:n
Specifies the maximum number (n) of columns to display; this applies only when members are displayed as columns.
ROWSORT
ROWSORT:measure
Specifies the measure by which to sort the rows. Here measure is the MDX identifier for the measure. For example:
ROWSORT:[MEASURES].[mymeasure]
Note that you cannot omit the square brackets of these identifiers (in contrast to other uses of MDX in Business Intelligence).
COLSORT
COLSORT:[MEASURES].[my measure]
Specifies the measure by which to sort the columns. Here measure is the MDX identifier for the measure; see ROWSORT.
ROWSORTDIR
ROWSORTDIR:sortkeyword
Specifies how to sort the rows. Here sortkeyword is one of the following:
COLSORTDIR
COLSORTDIR:sortkeyword
Specifies how to sort the columns. See ROWSORTDIR.
PORTLET
PORTLET:portlet_setting.value
Specifies the value for a portlet setting, to override any configured value for that setting. As with the other SETTINGS options, this setting is applied to all widgets listed by the TARGET parameter (or all portlet widgets if TARGET is not specified).
Here portlet_setting must be the name of the setting as defined in the portlet, and value must be the URL-encoded version of an allowed value for this setting. For information on creating URL-encoded strings, see “URL Encoding,” earlier in this chapter.
You can use multiple portlet specifications; to do so, separate them with a tilde (~). For example:
PORTLET:portletspec1~portletspec2
Where each portletspec is portlet_setting.value
For information on defining portlets, see the chapter “Creating Portlets for Use on Dashboards.”
To see an example, display the dashboard Widget Examples/Custom Portlet, which displays a round clock, and then add the following to the end of the URL in the browser:
&SETTINGS=PORTLET:CIRCLE.0~SIZE.200
Then press Enter. You should see the clock change into a square, slightly larger than it had previously been.
For example, the following limits the column count to 3 for most widgets but limits the column count to 1 for the widget RegionVsYear.
&SETTINGS=TARGET:RegionVsYear;COLCOUNT:1;&SETTINGS=COLCOUNT:3;
Note:
These settings are not supported for custom widgets or custom controls.


Previous section           Next section
Send us comments on this page
View this book as PDF   |  Download all PDFs
Copyright © 1997-2019 InterSystems Corporation, Cambridge, MA
Content Date/Time: 2019-09-19 06:44:29