The URL copied from the Share View URL window can be modified to control what parts of Viewer show when someone uses the URL. See the next table for details on all syntax that makes up a URL and that can optionally be added to the URL for customizing what displays with the grid or how the view is filtered. Here is an example URL, which runs the specified view with the Stratum View Pane and top panel hidden.
http://server-xyz:55001/StratumView.aspx?ViewId=386
Item |
Format & Values |
Required? |
StratumHostURL and StratumView.aspx file name |
The Stratum URL includes either the http:// or https:// preface, the Stratum.View.aspx syntax, the name of the Stratum server, and the port number. Example: http://server-xyz:#####/StratumView.aspx where server-xyz is the name of the Stratum.Viewer server and ##### is its port number. |
Yes |
ViewId |
The unique identifier of the view to be run. ViewID=# where # is the ID assigned to the view by Stratum.Viewer. Note: Always use a question mark ? to separate the Stratum.View.aspx file name and the View ID. |
Yes |
Syntax For Controlling What Parts Of The Stratum & View Interface Display |
||
Stratum View Pane and top panel syntax &SVP |
Showing the View Pane allows users to run other views or access other features. To show, use &SVP=1 To hide, use &SVP=0 |
No If syntax is not included, view pane and top panel are hidden. |
Toolbar icons in grid toolbar syntax &T |
Showing the icons gives access to features such as Email View, Save As, and other functionality. To show, use &T=1 To hide, use &T=0 Note: If you don’t want any part of the toolbar to display and want to exclude the space typically reserved for it above the grid, use &T=0&P=0. |
No If syntax is not included, toolbar icons will show. |
Paging icons in grid toolbar syntax &P |
Showing the icons allows users to page through results if there are multiple pages of rows and columns. To show, use &P=1 To hide, use &P=0 Note: If you don’t want any part of the toolbar to display and want to exclude the space typically reserved for it above the grid, use &T=0&P=0. |
No If syntax is not included, paging icons will show. |
View name above grid syntax &N |
To show, use &N=1 To hide, use &N=0 |
No If syntax is not included, view name will show. |
Logo displayed above a view’s grid (to right of the view name) syntax &VI |
To show, use &VI=1 To hide, use &VI=0 Note: A logo that applies to all views can be defined in the Views section of the Application window by administrators. The logo is an image meant to show up above a view grid, to the right of a view’s name. Setting the &VI to 1 won’t have any impact on views run from a URL unless a logo has also been defined in the Application window. |
No If syntax is not included, logo will show (if one has been specified). |
View Filter section syntax &VF |
To show, use &VF=1 To hide, use &VF=0
|
No If syntax is not included, view filter will show. |
View explorer section syntax &VE |
To let the display of view explorer be controlled by the “User Options” of the person running the URL, exclude the &VE from the URL. Set the item to 0 or 1 if you prefer this syntax in the URL to control the display of view explorer. The URL will ignore the view explorer “User Options” setting of the person running the URL. To show, use &VE=1 To hide, use &VE=0 |
No If syntax is not included, user options control the view explorer display. |
Navigation Panel section syntax &NP |
To let the display of the navigation panel be controlled by the “User Options” of the person running the URL, exclude the &NP from the URL. Set the item to 0 or 1 if you want this syntax in the URL to control the display of the navigation panel. The URL will ignore the navigation panel “User Options” setting of the person running the URL. To show, use &NP=1 To hide, use &NP=0 |
No If syntax is not included, user options control the navigation panel display. |
Syntax For Passing Member Filters In URL’s (examples) |
||
Level Name and member values |
If you want to filter the view for a particular value(s), specify the level name and value(s) for the level(s) that will be used to filter the view. &<Level Name>=<Key Value> Example with one member specified: &Region=300 Example with multiple members specified: &Region=300;400 Notes: A
semi-colon is typically used to separate multiple values specified
for a single level. See the &D syntax in the next row of this
table for more info and alternatives. |
Optional; use if filtering by level members |
Delimiter that is used between key values URL using a member filter. Syntax &D |
Defines the delimiter that is used between key values. Choose a delimiter that will not exist in your key values. For example, if your key values typically include a semi-colon, then you will need to choose a different delimiter. Do not use & or = as a delimiter. |
Optional alternate |
Syntax For Passing Stratum Parameters In URL’s (examples) |
||
Stratum Parameters &vp: |
If your view uses Stratum Parameters and you want to specify a filter using the Stratum Parameters, the syntax is as follows. &vp:<Stratum Select Member Parameter Name>=<Values to filter> &vp:<Stratum Drop Down Parameter Name>=<Value to filter> &vp:<Stratum User List Parameter Name>=<User List ID to filter> &vp:<Stratum Expression Parameter Name>=<Expression to filter> Notes:
A semi-colon is used to separate multiple values specified for
a Select Members type of parameter. |
Optional; use if filtering by Stratum Parameters |
Tips For Locating Info Used In URL’s |
||
Where To Find View ID’s |
Search for the view using the top panel in Stratum and look at the ID in the View list window where search results show up. If you are already using the view, right-click its name and select Properties. The ID shows in the Properties window. |
Yes |
Where to Find Level Names |
You can use either the level name or its caption in the URL syntax. The caption always displays in the grid when you run the view. Level names and their captions display in a level’s Properties window. Right-click the level in the Stratum view or view explorer and select Properties. |
Optional; use if filtering by level members |
Where To Find Stratum Parameter Names |
Any URL copied from the Share View URL window contains the names of parameters if the view has Stratum Parameters. The name of a parameter also can be found in view explorer. Right-click the associated view name in the Stratum View Pane and select Edit. Expand the parameter group for the parameter to see the parameter name. The name also shows in its Properties window, accessed by double-clicking the parameter in view explorer. |
Optional; use if filtering by Stratum Parameters |
Where To Find User List ID |
A User List ID is needed if your URL references a User List Parameter. To find an ID, go to Stratum’s User List list window and look at the List ID info for the list. If you have a list open in the User List Maintenance window, the List ID shows as one of the properties in the Attributes section of the window. |
Optional; use if filtering by Stratum User List Parameter |