URL parameters

•Description: The Collapsed parameter is used to start Xtraction with the left navigation pane collapsed. This parameter, combined with starting the browser in full-screen Kiosk mode, allows the dashboards to occupy almost the entire screen.

Note that this parameter 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 the parameter is invalid, Xtraction will not collapse the navigation pane upon startup.

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

•Possible values: true

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

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

•Description: The Cycle parameter starts Xtraction with cycling enabled for the dashboards loaded in the Auto Refresh & Cycle area of the home screen.

When the Cycle parameter 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 cycling 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 cycling through a Favorites set called Default. Because no refreshSeconds parameter is specified, the default interval is used:

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

•Description: The DebugMode parameter starts Xtraction in Debug Mode.

Normally, when an error occurs, a generic error message is displayed. By starting the Xtraction web client in Debug Mode, any error messages that display will include more detailed information about the error.

•Possible values: true

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

•Description: These parameters are used to control the size of the text of the dashboard titles and text within the components. These settings will affect all dashboards, documents, and reports displayed during this session.

In order to change either the title text size or component text size, the DisplayMode parameter is required. Just setting values for the TitleFontSize or ChartFontSize without also using the DisplayMode parameter will have no affect.

If either the TitleFontSize or ChartFontSize are not specified in the URL, Xtraction defaults the missing setting as M (Medium). Therefore, S and XS are smaller fonts then normal, while L and XL are larger fonts then normal.

•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.

•Examples: 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

•Description: The Favorite parameter specifies a Favorites folder to load into the Auto Refresh & Cycle area of the home screen during Xtraction startup.

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

If a Favorites Folder is loaded into the Auto Refresh & Cycle area, the first dashboard in the list will be automatically loaded into the display area.

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

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

•Examples: This URL loads Xtraction with a Favorites set called MyDashboards, the navigation pane is collapsed, and it is cycling the dashboards every 30 seconds:

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

•Description: LinkToId and LinkTo are used together to display a specific dashboard, document, or report at startup.

When the LinkTo and LinkToId parameters are used, Xtraction automatically loads with the left navigation pane collapsed, as though the Collapsed parameter had been included.

These parameters can be combined with the refreshSeconds and Refresh 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

•Description: The Refresh parameter enables the Refresh Enabled option in the Auto Refresh & Cycle area of the home screen. When this option is enabled, the current dashboard, document, or report is automatically refreshed periodically.

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

•Possible values: true

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

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

•Description: 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 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 is collapsed, and it is cycling the dashboards every 30 seconds:

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

•Description: The Theme parameter 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 parameter value is invalid, Xtraction defaults to LD (the default Ivanti theme).

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

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