Using URL Parameters to View a Report

If guest access is configured for the SAS Visual Analytics Viewer, you can use this URL: http://host/SASVisualAnalyticsViewer/VisualAnalyticsViewer/guest.jsp. However, to log on and display a single report using guest access, you can use a URL such as this one (which has parameters to specify the name and location of the report): http://host/SASVisualAnalyticsViewer/VisualAnalyticsViewer_guest.jsp?reportName=My+Report&reportPath=/Shared+Data/VA+Reports/&appSwitcherDisabled=true. This second URL is useful for tasks such as using an <iframe> tag to incorporate a single report within another web application because the SAS Visual Analytics application bar, menu bar, and toolbar are not included.

The following table lists the parameters that can be included in the second URL:

Parameter	Description
reportName	Specifies the name of the report that you want to view. This parameter is required if you are accessing a specific report through a URL.
reportPath	Specifies the path to the report that you want to view. This parameter is required if you are accessing a specific report through a URL.
appSwitcherDisabled	Disables the application bar, which enables you to return to the home page or to access other parts of SAS Visual Analytics and other SAS applications. The default value is false. Note: If you are displaying in an <iframe> tag, you must disable the application bar by specifying `appSwitcherDisabled=true`.
commentsEnabled	Enables the Comments tab in the right pane. The default value is true. If both propertiesEnabled and commentsEnabled are false, then the right pane is not added to the viewer.
propertiesEnabled	Enables the Properties tab in the right pane. The default value is true. If both propertiesEnabled and commentsEnabled are false, then the right pane is not added to the viewer.
reportViewOnly	Hides the SAS Visual Analytics banner, including all of the menus.
reportContextBar	Enables all of the menu options for the report. The default value is true. If reportContextBar is false, then it is implied that both propertiesEnabled and commentsEnabled are false, and the right pane is not added to the viewer. This parameter can be used only in the modern viewer. Note: If reportContextBar is false, you will also hide the back link, which does not allow section linking or report linking to work properly.

Parameters are specified in the URL as a sequence of name and value pairs using query string syntax. The URL specifies your server, an absolute path to SAS Visual Analytics, and the query string (following the question mark character). Each parameter name in the query string is separated from the next value by an equal sign (=). Multiple name and value pairs are separated by ampersand characters (&). In this example, reportName=My+Report is the parameter that specifies the name of the report. The second name and value pair (reportPath=/Shared+Data/VA+Reports/) is the parameter that specifies the path to that report. The third name and value pair (appSwitcherDisabled=true) disables the application bar. It must be present if you are displaying the report in an <iframe> tag.

There are special rules for formatting name and value pairs in a URL. Special characters (such as most punctuation characters, including spaces) in a value must be URL-encoded. A space can be encoded as a plus sign (+) or %20. Other characters are encoded using the %nn convention, where nn is the hexadecimal representation of the character in the ASCII character set. In the previous example, the value /Shared+Data/VA+Reports/ actually identifies the report path /Shared Data/VA Reports/. The spaces in the names are encoded as plus signs (+).

The reportName and reportPath parameters must be specified in the URL. The reportName parameter specifies the name of the report that you want to view (for example,

My
                     Report

). The reportPath parameter specifies the path to that report (for example, /Shared Data/VA Reports/).

Note: You can use these parameters with the standard viewer URL that requires login credentials (http://host/SASVisualAnalyticsViewer/VisualAnalyticsViewer.jsp). For example, you can use http://host/SASVisualAnalyticsViewer/VisualAnalyticsViewer.jsp?reportViewOnly=true to hide the banner.

URL parameters can be used to specify values for report parameters, such as display rules, filters, ranks, and aggregated measures.

Note: You must know the exact name of the parameter and the valid values for that parameter if you are going to include the parameter in your URL or change its values.

Last updated: January 8, 2019