Customize page connections with URL API

URL APIs are useful while integrating an app with an external website, portal, or other third-party application, as well as out-of-the-box Strategy Web. By passing the appropriate parameters through a URL, you can achieve functionality on a mobile device such as:

• Allow users to execute a report or browse the contents of a folder.
• Enable drilling from a document to a report or other documents. You can also embed a document drilling link in a report grid within a document.
• Allow objects such as images, text boxes, and shapes to be used for application navigation. 

The following table summarizes the base URL structure used for every request to Strategy Web:

The high-level steps to add a URL/API link to a button that passes on filtering values are:

1. In your document, click Insert, then click Panel Stack. Adding a panel stack allows the button to be targeted by a selector. 
2. Click Insert, then hover over Button. Choose your icon type. 
3. Using the cross-hairs, draw your button inside the panel stack. 

​​

1. Right-click the Button, then select Properties and Formatting. 
2. In the Properties and Formatting window, click Button. Then select Configure actions on this button. 
3. Select Navigate to this URL. Here, you can add your URL/API link. For example, the link below passes filtering information to the selected document. 

http://Webserver/MicroStrategy/asp/Main.aspx 
?evt=2048001 
&src=Main.aspx.2048001 
&visMode=0 
¤tViewMedia=2 
&documentID=E1E21F5148410F59E7C6ED80CFFE400B 
&elementsPromptAnswers=8D679D4B11D3E4981000E787EC6DE8A4;8D679D4B11D3E4981000E787EC6DE8A4:1^Northeast

• Webserver - name or IP address of the webserver 
• Evt - event/action to be performed, e.g. 2048001 for running a document 
• Src - web page component to perform the event 
• documentID - document object ID to be executed 
• visMode - the mode in which the document is displayed, e.g. 2 for Interactive

The parameter to pass an answer to an element list prompt: 

• elementsPromptAnswers=AttrID;AttrID:ElemID^ElemName 
• AttrID - object ID of the prompted attribute 
• ElemID - element ID of the attribute element used as prompt answer 
• ElemName - description of the attribute element used as prompt answer

1. Once the URL has been added, click OK to apply your changes, then close the Properties and Formatting window. 

Add a Selector to pass filtering values

1. If you want users to first choose a value, such as an attribute element, to apply filtering to the linked document, add a selector. Click Insert, then Selector. 
2. Add the desired metric or attribute to the selector. Ensure the dataset matches the data on the second document the link will open. 
3. Right-click the selector, then click Properties and Formatting. 
4. Click Selector under Properties, then make sure the panel stack with the URl API link is targeted. 
5. Click OK to save your changes. 

Now when you change the selector and tap the button on your mobile device, the new document will open with the filtering applied. 
KB440954