MicroStrategy URL Parameters

MicroStrategy Web provides a wide range of parameters that can be used in combination to achieve different types of requests. The two fundamental parameters are the evt (short for “event”) parameter and the src (short for “source”) parameter. Every request to a MicroStrategy Web product corresponds to a specific event or action, which is handled by a specific MicroStrategy Web application component or source. Each event comes with an associated list of required and optional parameters that can be used to refine the specific request.

 

The table below provides a list of commonly used parameters with brief descriptions.

 

Parameters

Description

General Parameters

 

evt

The event or action that you want your MicroStrategy Web product to perform. A comprehensive list of event names and IDs can be found in events.xml, as well as the Event Handlers Reference. See Using the URL API to Access a MicroStrategy Web Page topic for instructions on how to access both out-of-the-box and custom MicroStrategy Web pages using the evt and src parameters.

src

The MicroStrategy Web application component that you wish to perform the handling of the specified event. See Using the URL API to Access a MicroStrategy Web Page topic for instructions on how to access both out-of-the-box and custom MicroStrategy Web pages using the evt and src parameters.
 

reportID

The global unique identifier (GUID) of a MicroStrategy report.

 

Note: The recommended practice is to reference a report by its ID in the URL because it is a unique identifier.

 

reportName

The name of a MicroStrategy report.
 

Note: While it is possible to reference a report by its name in the URL, this is not the recommended practice because of potential problems. For example, the report name will change with the user's locale, and the URL will break if the report name is not properly encoded.

 

documentID

The global unique identifier (GUID) of a MicroStrategy document or HTML document.
 

Note: The recommended practice is to reference a document by its ID in the URL because it is a unique identifier.

 

documentName

The name of a MicroStrategy document or HTML document.
 

Note: While it is possible to reference a document by its name in the URL, this is not the recommended practice because of potential problems. For example, the document name will change with the user's locale, and the URL will break if the document name is not properly encoded.

 

folderID

The global unique identifier (GUID) of a MicroStrategy folder.
 

objectID

The global unique identifier (GUID) of a MicroStrategy object. The objectID is generally used in URLs where the event request can apply to multiple types of objects.
 

objectType

Specifies the type of object the objectID represents. The objectType is represented by a value from EnumDSSXMLObjectType.
 

target

Specifies the page to be opened when the evt parameter is set to the "Open Page" event id ("3004")
 

hiddensections

A comma-separated list of the page sections that should be hidden. For example, if you add hiddensections=header,path. to the URL, neither the header section nor the navigation bar would be displayed on the page returned by the request.
 

Because this value is stored in temp cookies, it remains in effect for the duration of the session. Any subsequent request within the same http session will keep the specified page sections hidden. To make the page sections visible again during the same session, you must add the hiddensections=none parameter to the URL.

 

Note: The value of this parameter is case-sensitive. So, for example, if you want to hide the dockTop page section, you would need to use hiddensections=dockTop. If you mistakenly used hiddensections=docktop or hiddenSections=dockTop, the dockTop page section would remain visible.

 

pg

The name of a MicroStrategy Web page. This parameter can be used only for the following MicroStrategy Web pages:

  • About page (pg=about)

  • Admin FAQS page (pg=adminFaqs)

  • Admin Help page (pg=adminHelp)

  • Admin page (pg=welcomeadmin)

  • Change Password / Change Password Preference page (pg=chPwd / pg=prefChPwd)

  • Create Document page (pg=createDocument)

  • Create Report page (pg=create)

  • Desktop page (pg=desktop)

  • Frequently Asked Questions page (pg=faqs)

  • History List page (pg=historyList)

  • Logout page (pg=logout)

  • My Reports page (pg=my)

  • My Subscriptions page (pg=subs)

  • Online Help page (pg=help)

  • Projects page (pg=welcome)

  • Search page (pg=search)

  • Shared Reports page (pg=shared)

  • Summary page (pg=summary)

  • User Preferences page (pg=prefs)

  • Welcome page (pg=welcome)

 

Note: Using the pg parameter to access a MicroStrategy Web page is not recommended; instead, you should use a combination of the evt and src parameters. The pg parameter is provided primarily as a convenience for accessing non-contextual pages. See Using the URL API to Access a MicroStrategy Web Page topic for instructions on how to access both out-of-the-box and custom MicroStrategy Web pages using the evt and src parameters.

 

Authentication Parameters

 

Note: These parameters are used only for MicroStrategy Web pages that require a session with MicroStrategy Intelligence Server.

 

ConnMode

The authentication mode used for connecting to Intelligence Server.

server

The name or IP address of the machine that hosts the Intelligence Server to which to the MicroStrategy Web product connects.

project

The name of the MicroStrategy project (reporting or analytical application).
 

uid

The MicroStrategy login name to be used to authenticate with Intelligence Server.
 

pwd

The password for the corresponding uid (login name) submitted.
 

usrSmgr

The session state. See Authentication Using the URL API for instructions on how to use this parameter.
 

Note: It is not a recommended practice to pass user credentials in the URL because of security issues. You can use the External Security Module to incorporate the authentication and authorization logic. The External Security Module authenticates a user against a non-MicroStrategy source from your organization’s authentication system and creates a session. The session state, rather than the user credentials are passed in the URL.

 

Prompt-Answering Parameters

 

Note: Not all kinds of prompt answers can be passed using the URL API.

 

promptsAnswerXML

An XML representation of a collection of prompt answers. Passing this parameter with any number of common events automatically applies the supplied prompt answers to as many of the prompts as are found in the particular report, document, or HTML document.

 

originMessageID

An existing report, document, or HTML document instance. This parameter is used by the resulting report, document, or HTML document to extract the prompt answers from the specified instance and use them as prompt answers to any corresponding prompts in the requested report, document, or HTML document.

 

elementsPromptAnswers

A convenience parameter that allows you to answer single or multiple element prompts by supplying individual prompt answers in the form of AttributeID;AttributeElementID^DisplayName. When there are multiple prompt answers, each individual answer is separated by a "," (comma) separator character. In addition, you can include multiple elements to answer the same element prompt by separating each AttributeElementID^DisplayName combination (for the same AttributeID) with the ";" separator character. For example, the following parameter value represents two element prompt answers, the first of which has three different elements to answer the prompt and the second of which has only one element to answer the prompt: AttrID1;AttrElemID1a^DisplayName1a;AttrElemID1b^DisplayName1b;AttrElemID1c^DisplayName1c,AttrID2;AttrElem2^DisplayName2.

 

The ElementName for an element prompt is optional, but without it, the element name does not show up in the prompt details pane in the report page.

 

Note: Because element prompt answers are matched with prompts using the AttributeID, the order of the prompt answers does not determine the order in which prompts are answered.

 

objectsPromptAnswers

A convenience parameter that allows you to answer single or multiple object prompts by supplying individual answers in the form of objectID~type~name. When there are multiple prompt answers, each individual answer is separated by a "^" (caret) separator character. In addition, you can include multiple objects to answer the same object prompt by separating each objectID~type~name combination with the "%1B" separator character. For example, the following parameter value represents two object prompt answers, which each include two objects (of the same type) to answer the prompt: objectID1a~type1~name1a%1BobjectID1b~type1~name1b^objectID2a~type2~name2a%1BobjectID2b~type2~name2b.

 

The name for an object prompt is optional, but without it, the object name does not show up in the prompt details pane in the report page.

 

Because object prompt answers do not have an identifier that allows them to be matched with the actual prompts, the order of the prompt answers is very important. It determines the order in which prompts are answered. If you want to skip an object prompt answer when there are multiple object prompts, simply use the "^" (caret) delimiter character, without anything else, to signify an unfurnished prompt answer. An unfurnished prompt answer for the first prompt would be represented by a single caret character ("^"), while an unfurnished prompt answer for subsequent prompts would be represented by two caret characters ("^^”)—one delimiting the previous furnished prompt answer and one delimiting the unfurnished prompt answer.

 

The prompt answers, and their order, in this parameter pertain only to object prompts. So, for example, if the first object prompt for a report is preceded by an element prompt, you would not signify an unfurnished answer to this element prompt; instead, the first prompt answer would be the one for the first object prompt.

 

Note: The EnumDSSXMLObjectTypes interface has a list of object types.

 

valuePromptAnswers

A convenience parameter that allows you to answer single or multiple value prompts by supplying answers in the form of a string value.  When there are multiple prompt answers, each individual answer is separated by a "^" (caret) separator character. For example, the following parameter value represents two value prompt answers: Northwest^2005.

 

Because value prompt answers do not have an identifier that allows them to be matched with the actual prompts, the order of the prompt answers is very important. It determines the order in which prompts are answered. If you want to skip an object prompt answer when there are multiple object prompts, simply use the "^" (caret) delimiter character, without anything else, to signify an unfurnished prompt answer. An unfurnished prompt answer for the first prompt would be represented by a single caret character ("^"), while an unfurnished prompt answer for subsequent prompts would be represented by two caret characters ("^^”)— one delimiting the previous furnished prompt answer and one delimiting the unfurnished prompt answer.

 

The prompt answers, and their order, in this parameter pertain only to value prompts. So, for example, if the first value prompt for a report is preceded by an element prompt, you would not signify an unfurnished answer to this element prompt; instead, the first prompt answer would be the one for the first value prompt.

 

Note: Because of the convention for signifying unanswered prompts, you are not able to answer a value prompt with an empty string through the URL.

 

promptAnswerMode

This parameter specifies how the answering of the prompts will be handled. It takes the following values.

 

1 - Answers all required prompts and optional prompts with default answers. Required prompts without any default answers remain open while optional prompts without default defaults answers are closed with an empty answer.

 

2 - Closes all optional prompts with an empty answer.

 

 

See also