Use the Mobile URL API in iOS

The URL API for the Mobile SDK for iOS lets you use links to execute both MicroStrategy and non-MicroStrategy actions from inside a custom mobile application that includes MicroStrategy Mobile SDK frameworks. This is useful if you want to access and manipulate MicroStrategy objects such as reports, documents, and folders, or if you want to display standard MicroStrategy Mobile screens or open other applications installed on the mobile device. You can also use URL API links to execute a MicroStrategy report or document from outside your custom mobile application. For example, you can add a URL API link to an email or use it in a browser.

The following common actions can be performed using the URL API for the Mobile SDK.

• Connecting to a specific Intelligence Server and project 

• Returning to the previously viewed page 

• Toggling offline mode 

• Logging out
  

Performing report-related actions

• Executing a report  

• Specifying the page-by selection for a report 

Performing document-related actions  

• Executing a document 

• Displaying a specific document layout 

• Specifying the group-by selection for a document

• Displaying the group-by selection screen
  

• Changing the selector on the current layout 

• Annotating and sharing a document 

• Displaying a specific Information Window 

• Refreshing a document 

• Reprompting a document 

• Selecting a specific panel in a panel stack  

• Printing a document 

• Emailing a screenshot of a document 

Performing folder-related actions

• Browsing a folder 

• Browsing a web folder

Answering prompts

• Answering all prompts 

• Answering element list prompts 

• Answering value prompts 

Displaying standard MicroStrategy Mobile screens 

• Displaying the Folder Browsing screen 

• Displaying the Help screen 

• Displaying the Home screen 

• Displaying the Reports screen 

• Displaying the Settings screen 

• Displaying the Shared Library screen 

• Displaying the Status screen

Opening applications installed on a device

• Deep linking to third-party applications
• Sending an email 

• Passing a location to Google Maps 

• Getting directions from Google Maps 

• Calling a phone (applicable only to mobile phones) 

• Sending a text message (applicable only to mobile phones) 

• Opening a video 

• Opening a web browser

The recommended practice is to use the  mstr namespace for links in both iPhone and iPad applications. The mstripad namespace for iPad is supported only for backward compatibility. If you create your own custom namespace, you should not use either mstr or mstripad to avoid potential conflicts.

Using the URL API requires an understanding of the basic structure of a MicroStrategy Web URL, as well as knowledge of the additional parameters that exist and how they can be used for certain actions. The URL API is discussed in detail in the Web SDK section of the MSDL in Customizing MicroStrategy Web -> Part I: Fundamentals of Customization -> Navigation and Workflow: URL API -> Navigation and Workflow: URL API. Note that not all the URL API parameters available in the Web SDK are available for use in the Mobile SDK.