EducationSoftwareStrategy.com
StrategyCommunity

Knowledge Base

Product

Community

Knowledge Base

TopicsBrowse ArticlesDeveloper Zone

Product

Download SoftwareProduct DocumentationSecurity Hub

Education

Tutorial VideosSolution GalleryEducation courses

Community

GuidelinesGrandmastersEvents
x_social-icon_white.svglinkedin_social-icon_white.svg
Strategy logoCommunity

© Strategy Inc. All Rights Reserved.

LegalTerms of UsePrivacy Policy
  1. Home
  2. Topics

KB320054: New feature - URL API parameter to run a VI dashboard with a specified sheet selected


Community Admin

• Strategy


URL API parameter to run a VI dashboard with a specified sheet selected

Starting in 10.6, a new parameter has been introduced in the URL API. The purpose of this feature is to allow a user to execute a dashboard and when the dashboard is returned it will have selected specific sheet.
To take advantage of this feature, the user can either specify a key, which can be obtained via code or in the html; or they can specify the sheet based on the index. The two approaches are described below:
 
Obtaining the key via code or HTML:
When using this option, the URL API parameter is layoutKey, and can be appended as seen in the following example (the following syntax is for IIS):
 


http://ServerName/MicroStrategy/asp/Main.aspx?evt=3140&src=Main.aspx.3140&documentID=D0DB0DE9456554711034F1ABB5B248FB&layoutKey=W63

 
To obtain the layoutKey value, the steps below need to be followed:

  1. Depending on the browser being used, go to View Source, in the below example, Google Chrome is being used, so the Ctrl+U shortcut was used.
  2. Once you are seeing the Source code, scroll all the way down until you see the function mstrApp.start, the value that starts with a W or a K will be the one you need to use as seen below:
ka04W000000Ofs3QAC_0EM4400000025Nm.jpeg

 
 
Specifying the value based on the index:
To use this approach, the parameter layoutIndex will be used, this parameter is the index of the sheet and starts with the number 0; so, if we have 10 sheets and we wanted to select the 5th one, we would specify layoutIndex=4, and the syntax will be like the one below:
 



 


http://ServerName/MicroStrategy/asp/Main.aspx?evt=3140&src=Main.aspx.3140&documentID=D0DB0DE9456554711034F1ABB5B248FB&layoutIndex=4

 
Additional information:
For information on how to do run a Report Services document with an assigned layout, you can refer the following article:
KB42552: How to construct URL API to run a Report Services document with assigned layout in MicroStrategy Web 9.4.x-10.x


Comment

0 comments

Details

Knowledge Article

Published:

June 12, 2017

Last Updated:

July 10, 2017