Adding parameters to the web-client URL

When launching the Xtraction web client, you can use parameters in the URL to specify certain settings or startup options for the current session. 

To add a parameter to the URL, add a /#/? to the end, followed by the parameter name, an equal sign (=), and the value of the parameter. You can add multiple parameters by including an ampersand (&) between each one.

For example: http://localhost/xtraction/#/?cycle=true&favorite=MyDashboards

follows the pattern of: [Xtraction URL]/#/?parameter=value&parameter=value

The following is a full list of the supported URL parameters, including a description, the possible values, and examples of different uses.

This parameter collapses the navigation pane on startup, which enables dashboards to occupy most of the screen when combined with starting the browser in full-screen Kiosk mode.

Note that Collapsed is not necessary when the LinkTo and LinkToId parameters are used, as Xtraction already starts with the navigation pane collapsed when those parameters are present.

If Collapsed is invalid, Xtraction will not collapse the navigation pane upon startup.

Collapsed is usually used with other parameters to load a favorite set of dashboards in full screen and automatically cycle through those dashboards.

•Possible values: true

•Example: This URL loads Xtraction with the navigation pane collapsed and cycles every 30 seconds through a Favorites set called MyDashboards:

http://localhost/Xtraction/#/?collapsed=true&favorite=MyDashboards&cycle=true&refreshSeconds=30

Cycle starts Xtraction with cycling enabled for the dashboards loaded in the Auto Refresh & Cycle area of the home page.

When Cycle is used, the Refresh Enabled option is also enabled, so the Refresh parameter is not required.

•Possible values: true

•Examples: This URL loads Xtraction with the navigation pane collapsed and cycles every 30 seconds through a Favorites set called MyDashboards:

http://localhost/Xtraction/#/?cycle=true&collapsed=true&favorite=MyDashboards&refreshSeconds=30

This URL loads Xtraction with the navigation pane collapsed and cycles through a Favorites set called Default. Because the refreshSeconds parameter is not specified, the default interval is used:

http://localhost/Xtraction/#/?cycle=true&collapsed=true&favorite=Default

This parameter starts Xtraction in Debug Mode, so that any error messages that display will include detailed information about the error.

•Possible values: true

•Example: This URL starts Xtraction in Debug Mode: http://localhost/xtraction/#/?DebugMode=true

TitleFontSize is used to control the size of the title text for dashboards and components. ChartFontSize controls the text within the components (labels and data). These settings affect all dashboards, documents, and reports displayed during the current session.

With either parameter, DisplayMode is also required. Just setting values for TitleFontSize or ChartFontSize without using DisplayMode will have no effect.

If TitleFontSize or ChartFontSize isn't specified in the URL, all text size defaults to M (Medium). The other sizes are smaller than normal (XS and S) and larger than normal (L and XL).

•Possible values:

•DisplayMode: true

•TitleFontSize and ChartFontSize: These values represent sizes ranging from extra small to extra large. They're case-sensitive and must be capitalized exactly as shown: XS, S, M, L, XL.

•Example: This URL starts Xtraction with extra-large dashboard and component titles and large text for the component labels and data values:

http://localhost/xtraction/#/?DisplayMode=true&TitleFontSize=XL&ChartFontSize=L

The Favorite parameter specifies a Favorites folder to load into the Auto Refresh & Cycle area of the home page at startup, with the first dashboard in the list to be loaded automatically into the display area.

If this parameter is not included in the URL, Xtraction automatically loads the Favorites folder specified as the default (if one exists). If this parameter is not included in the URL and no Favorites folder is specified as the default, then the Auto Refresh & Cycle area remains empty.

Favorite is usually combined with the Cycle and refreshSeconds parameters to automatically load a set of dashboards and begin cycling through them upon startup. The Collapsed parameter is also often included if additional space is needed for displaying the dashboards.

•Possible values: The name of any Favorites folder found in the current user’s settings.

•Example: This URL loads Xtraction with a Favorites set called MyDashboards, the navigation pane collapsed, and a cycle of every 30 seconds:

http://localhost/Xtraction/#/?favorite=MyDashboards&collapsed=true&cycle=true&refreshSeconds=30

LinkTo and LinkTold are used together to display a specific dashboard, document, or report at startup. When LinkTo and LinkTold are used, Xtraction automatically loads with the navigation pane collapsed, as though the Collapsed parameter has been included.

LinkTo and LinkTold can be combined with the Refresh and refreshSeconds parameters to periodically refresh the dashboard after it initially loads.

•Possible values:

•LinkTo: Use the appropriate value for the type of object you want to display—a dashboard, document, or report. These values are case-sensitive and must be in all caps: DASHBOARD, DOCUMENT, REPORT.

•LinkToId: This is the ID of the specific dashboard, document, or report you want to display. The ID can be found in the LinkId column of the dashboard, document, or report table in the Xtraction database.

•Examples: This URL loads the dashboard with the specified ID at startup and automatically refreshes it every 2 minutes:

http://localhost/Xtraction/#/?LinkTo=DASHBOARD&LinkToId=e1ee9b6e-f17d-4024-ae56-21659b6b17d0&refresh=true&refreshSeconds=120

This URL loads the document with the specified ID at startup:

http://localhost/Xtraction/#/?LinkTo=DOCUMENT&LinkToId=e1ee9b6e-f17d-4024-ae56-21659b6b17d0

This URL loads the report with the specified ID at startup:

http://localhost/Xtraction/#/?LinkTo=REPORT&LinkToId=e1ee9b6e-f17d-4024-ae56-21659b6b17d0

Refresh enables the Refresh Enabled option in the Auto Refresh & Cycle area of the home page. When this option is enabled, the current dashboard, document, or report is automatically refreshed periodically.

The Refresh parameter is usually combined with LinkTo, LinkToId, and refreshSeconds in order to load a specific dashboard and then refresh it at a specific interval.

•Possible values: true

•Example: This URL loads a specific dashboard and automatically refreshes it every 2 minutes:

http://localhost/Xtraction/#/?refresh=true&refreshSeconds=120&LinkTo=DASHBOARD&LinkToId=e1ee9b6e-f17d-4024-ae56-21659b6b17d0

The refreshSeconds parameter determines how long Xtraction displays a dashboard before refreshing it or cycling to the next dashboard.

•Possible values: Any integer between 5 and 600.

•Examples: This URL loads a specific dashboard and automatically refreshes it every 2 minutes:

http://localhost/Xtraction/#/?refresh=true&refreshSeconds=120&LinkTo=DASHBOARD&LinkToId=e1ee9b6e-f17d-4024-ae56-21659b6b17d0

This URL loads Xtraction with a Favorites set called MyDashboards, the navigation pane collapsed, and a cycle of every 30 seconds:

http://localhost/Xtraction/#/?refreshSeconds=30&favorite=MyDashboards&collapsed=true&cycle=true

Theme sets the color scheme for the Xtraction interface during the current session. The choices come from a predefined set of color schemes.

If this parameter is not included in the URL, Xtraction will default to the theme specified in the Administration Settings dialog.

If the Theme value is invalid, Xtraction defaults to the Ivanti theme.

•Possible values: These values are case-sensitive and must be capitalized exactly as shown: Black, Blue, Ivanti, LightBlue, LightGray, LightGrayInternational, Marval, Shavlik.

•Example: This URL loads Xtraction with the LightGray color scheme: http://localhost/Xtraction/#/?theme=LightGray