MicroStrategy ONE

Creating link URLs manually

A link is a connection in a document to another document, a report, or a web page. A link lets an analyst execute another document or report (the target) from a document (the source), and to pass parameters to answer any prompts that are in the target. For example, if a user is viewing a document containing regional sales, he can click a particular region to execute another document that displays sales for the stores in that region. This is a form of drilling, where the user has drilled from region to store. The source document could also link to the underlying dataset report, to display profit and cost values as well. The source could link to a web page that contains economic information about the region. A link can also email or export a document or report, or subscribe to a document or report.

This topic provides instructions for creating link URLs manually, that is, by using the object ID and link syntax. You can also use the Link Editor to create links; it is easier and more intuitive than manually defining link URLs. For a comparison of the two methods, see Comparison of Link Editor and manually creating link URLs.

If you have decided to manually create link URLs, you must know and understand the link syntax to accurately create the correct link URL. The link URL must be in the following format:

  • To execute a document

    http://MSTRWebURL?evt=2048001&documentID=objectID&viewMode=2&promptinfo

  • To re-execute the source document

    http://MSTRWebURL?evt=2048001&documentName={&Document}&viewMode=2&promptinfo

  • To execute a report

    http://MSTRWebURL?evt=4001&reportID=objectID&promptinfo

  • To execute a report by supplying a template and a filter

    http://MSTRWebURL?evt=4033&templateID=bjectID&filterID=objectID&promptinfo

  • To execute a dataset report of the source document

    http://MSTRWebURL?evt=4001&reportID={&ReportName:GUID}&promptinfo

  • To subscribe to the target or send it via email

    http://MSTRWebURL?evt=event#&objectID=ObjectID&objectType=#&promptinfo

MicroStrategy Narrowcast Server must be installed and configured on your system before a document can be emailed.

The italics represent variables that are replaced when creating the link. The variable MSTRWebURL is the base URL, whose syntax differs depending on the MicroStrategy Web environment. The item promptinfo represents a number of different parameters that can be used to pass prompt information to the target. All the parameters and variables, and auto text codes that can be used in them, are described in detail in the topics listed below. Notice that parameters are joined with the ampersand (&).

The link URL is displayed as pop-up text when the user hovers the cursor over the text field in PDF View. This pop-up text does not display in MicroStrategy Web, but you can add a tooltip to display the link URL or any other information. The tooltip also displays as pop-up text, but only in MicroStrategy Web. For more information, see Creating pop-up tooltips in controls.

Creating a link manually is similar to creating a hyperlink, as described in Defining hyperlinks in documents. Set the Is Hyperlink property to True and define the target in the Hyperlink property. When the Is Hyperlink property is True, the text is automatically underlined when the document is displayed.

Prerequisites

Before creating links manually, you should do some preliminary planning. For example, create any target documents, HTML documents, and reports, and find their IDs. Know the prompts of the targets and how they will be answered (for example, with prompt XML or an attribute element).

To manually create a link URL

  1. From the Document Editor in Design View, select the text field on which to drill.

  2. In the Property List, select True from the Is Hyperlink drop-down list.

  3. In the Property List, type the target URL in the Hyperlink field. Use one of the following syntaxes and replace the italicized variables, where MSTRWebURL represents the correct base URL syntax for your Web environment and promptinfo represents any of the optional prompt information parameters:

Action

Syntax

Execute a document

http://MSTRWebURL?evt=2048001&documentID=objectID&viewMode=2&promptinfo

Re-execute the source document

http://MSTRWebURL?evt=2048001&documentName={&Document}&viewMode=2&promptinfo

Execute a report

http://MSTRWebURL?evt=4001&reportID=objectID&promptinfo

Execute a report by supplying the template and filter

http://MSTRWebURL?evt=4033&templateID=objectID&filterID=objectID&promptinfo

Execute a dataset report of the source document

http://MSTRWebURL?evt=4001&reportID={&ReportName:GUID}&promptinfo

Export a document, HTML document, or report

http://MSTRWebURL?evt=3067&documentID=objectID&promptinfo

http://MSTRWebURL?evt=3067&documentID=objectID&promptinfo

http://MSTRWebURL?evt=3067&reportID=objectID&promptinfo

Export a document or report to PDF

http://MSTRWebURL?evt=3069&documentID=objectID&promptinfo

http://MSTRWebURL?evt=3062&reportID=objectID&promptinfo

Send a document or HTML document via email now

http://MSTRWebURL?evt=3037&objectID=objectID&objectType=55&promptinfo

Send a report via email now

http://MSTRWebURL?evt=3037&objectID=objectID&objectType=3&promptinfo

Send a document or HTML document via email on a schedule

http://MSTRWebURL?evt=3036&objectID=objectID&objectType=55&promptinfo

Send a report via email on a schedule

http://MSTRWebURL?evt=3036&objectID=objectID&objectType=3&promptinfo

Subscribe to a document or HTML document

http://MSTRWebURL?evt=3034&objectID=objectID&objectType=55&promptinfo

Subscribe to a report

http://MSTRWebURL?evt=3034&objectID=objectID&objectType=3&promptinfo

MicroStrategy Narrowcast Server must be installed and configured on your system before a document can be emailed.

Alternatively, you can right-click the control and select Properties. The Properties dialog box opens. On the General tab, select the Is Hyperlink check box and type the target URL in the Hyperlink text box.

For details on each of the variables, see:

Related Topics