MicroStrategy URL Structure
The following table summarizes the root URL structure used for every request to MicroStrategy Web.
| Environment | Main Application URL | Administration URL |
|---|---|---|
J2EE
|
http://webserver/MicroStrategy/servlet/mstrWeb
|
http://webserver/MicroStrategy/servlet/mstrWebAdmin
|
.NET
|
http://webserver/MicroStrategy/asp/Main.aspx
|
http://webserver/MicroStrategy/asp/Admin.aspx
|
Every request sent to MicroStrategy Web calls a central controller. Parameters are appended to Main.aspx or mstrWeb (in a .NET and J2EE environment, respectively) to indicate to the controller how the request should be internally forwarded and handled.
The following examples show a URL for accessing a MicroStrategy folder when the user does not have an existing session. The URL contains not only the parameters needed to connect to MicroStrategy Web, but also the parameters needed to log on and create a session.
J2EE environment:
<a href="http://webserver/MicroStrategy/servlet/mstrWeb?server=INTELLIGENCE_SERVER&project=MicroStrategy+Tutorial&evt=2001&folderID=8D678D6D11D3E4981000E787EC6DE8A4&uid=username&pwd=password">Shared
Reports Folder Browsing page</a>
.NET environment:
<a href="http://webserver/MicroStrategy/asp/Main.aspx?server=INTELLIGENCE_SERVER&project=MicroStrategy+Tutorial&evt=2001&Main.aspx.2001&folderID=8D678D6D11D3E4981000E787EC6DE8A4&uid=username&pwd=password">Shared
Reports Folder Browsing page</a>
In the sample URLs shown above, username represents a MicroStrategy username and password represents the associated MicroStrategy password. These parameters are used simply to illustrate how a session can be created using URL parameters. For security reasons, it is not a recommended practice to pass user credentials in cleartext in the URL.
To learn about the parameters that can be used in the URL, refer to the MicroStrategy URL parameterssection.
See also
- Scenarios: Altering application workflow and navigation: Modifying the application URL structure
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
| |
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.
| |
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.
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.
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.
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.
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.
|
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 sections that should be hidden on a dashboard or document. For example, if you add hiddensections=path,datasets to the URL for executing a dashboard, neither the navigation information nor the datasets panel are displayed on the dashboard 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 sections hidden. To make the sections visible again during the same session, you must add the hiddensections=none parameter to the URL.
The value of this parameter is case-sensitive. So, for example, if you want to hide the dockTop page section on a document, you would need to use hiddensections=dockTop. If you mistakenly used hiddensections=docktop or hiddenSections=DockTop, the dockTop page section would remain visible on the document.
|
The name of a MicroStrategy Web page. This parameter can be used only for the following MicroStrategy Web pages:
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
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).
|
The MicroStrategy login name to be used to authenticate with Intelligence Server.
| |
The password for the corresponding uid (login name) submitted.
| |
The session state. See Authentication Using the URL API for instructions on how to use this parameter.
| |
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.
| |
|
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.
|
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.
Because element prompt answers are matched with prompts using theAttributeID, the order of the prompt answers does not determine the order in which prompts are answered.
| |
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 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.
The EnumDSSXMLObjectTypes interface has a list of object types.
| |
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 wouldn't signify an unfurnished answer to this element prompt; instead, the first prompt answer would be the one for the first value prompt.
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.
|
Using the URL API to Access a MicroStrategy Web Page
To access a MicroStrategy page, you use the evt and src parameters in the URL.
Every out-of-the-box action in MicroStrategy Web is associated with a specific event. The evt parameter in the URL (evt is short for “event”) specifies that event. Each event corresponds to an event code— either a MicroStrategy-defined out-of-the-box event code or a user-defined custom event code. You set the evt parameter to the code of the event, or action, that you want to take place. For example, to execute a report, you would set the evt parameter to "4001", while you would set it to "3002" to display the Shared Reports page.
The event definition file, events.xml, contains information about which MicroStrategy-defined events are mapped to which event codes. It also provides information about required and optional parameters that must or can be used with each event to refine a specific request. Refer to the Event Handlers Reference for access to the information in this file. Information about user-defined events and event codes is stored in plug-ins (that is, custom user-defined XML event definition files), which can be created using the Web Customization Editor.
The src parameter (src is short for “source”) specifies the MicroStrategy Web application component that you wish to perform the handling of the specified event. The src parameter allows you to specify the page that should be executed, as well as the particular bean on that page that should be used, if desired. For example, if you create a custom page with multiple beans, the src parameter allows you to specify exactly which bean should be used for a particular event. The structure of the src parameter reflects the hierarchy of the page and its component beans, as shown below.
J2EE environment:
src = mstrWeb.<page>.<bean>.<child bean>.<event ID>
.NET environment:
src=Main.aspx. <page> . <bean> . <child bean> . <event ID>
This path is built using the hierarchy to a component in a page in the Page Configuration file. There can be as many nested child beans as are included in the bean hierarchy in the page.
The sample URLs below show the evt and src parameters required to display the contents of the "Customer Analysis" folder in the Shared Reports page in the MicroStrategy Tutorial.
J2EE environment:
http://webserver/MicroStrategy/servlet/mstrWeb?evt=2001&src=mstrWeb.shared.fb.2001&folderID=78AAF4654A62E9D384D0E094BE585507&...
.NET environment:
http://webserver/MicroStrategy/asp/Main.aspx?evt=2001&src=Main.aspx.shared.fb.2001&folderID=78AAF4654A62E9D384D0E094BE585507&...
While t is possible to access certain pages in certain circumstances using only the src parameter, the recommended practice is to always include the evt parameter.
The sections below describe how to use the URP API to access both an out-of-the-box MicroStrategy Web page that is provided for you and a custom page that you have built.
Accessing an Out-of-the-Box MicroStrategy Web Page
In the out-of-the-box MicroStrategy Web product, certain events specified by the evt parameter are automatically mapped to a particular MicroStrategy Web page. For example, to export a document to PDF, you need to create a URL that includes the event that accesses the "RW Fast Export PDF" page. The "RW Fast Export PDF" page is defined in the Page Configuration file as follows:
<page allow-cancel="false"desc="RW Fast Export PDF"desc-id="mstrWeb.246" feature-id="" login-required="true" name="rwFastExport" persist-mode="8" track="false">
The desc attribute for this page is set to "RW Fast Export PDF" and the name attribute is set to "rwFastExport". To find the value to use for the evt parameter in the URL (that is, the ID of the event that is mapped to this page), open events.xml and search for an event whose target attribute is set to "rwFastExport" (that is, the same value as the name attribute of the "RW Fast Export PDF" page).
<eventid="3069"name="rwFastPDFExport"target="rwFastExport">
<arguments>
<argument id="3001" name="documentID" />
<argument id="3010" name="messageID" />
<argument id="3029" name="triggerID" />
...
</arguments>
</event>
Sample URLs for exporting a Report Services document to PDF are shown below. Because the ID of the event associated with the "RW Fast Export PDF" page is "3069", the evt parameter in the URL is set to "3069". When the request is received, MicroStrategy Web application uses this value to redirect the request to the target associated with this event ID— that is, the MicroStrategy Web page with the name "rwFastExport".
J2EE environment:
http://webserver/MicroStrategy/servlet/mstrWeb?evt=3069&...other URL parameters...
.NET environment:
http://webserver/MicroStrategy/asp/Main.aspx?evt=3069&...other URL parameters...
The URL can also have other optional or required parameters, identified by the <argument> child elements of the <event> element in the event definition file.
It is possible for multiple events to be mapped to the same MicroStrategy Web page (that is, targetattribute). For example, there are several events in events.xml that have the name of the Report Execution page (that is, the page whose name attribute is defined as "report" in the Page Configuration file) as the value of their target attribute. In such cases, the values of the ID and name attributes specify the action that will be taken.
<event id="4001" name="runReport" target="report">
<arguments>
...
</arguments>
</event>
...
<event id="3005" name="editReport" target="report">
<arguments>
...
</arguments>
</event>
In the example shown above, the Report Execution page is accessed for both events, but the value of the ID attribute specifies the action that will be taken— evt=4001 to execute a report and evt=3005 to edit a report— and the name attribute describes that action.
In addition to the evt and src parameters, the URL can also contain general parameters, authentication parameters, and prompt-answering parameters. For general information on these parameters, see MicroStrategy URL Parameters. For information on using the other parameters, refer to the following scenarios:
The Event Handlers Reference provides a comprehensive list of all event handlers along with the names and IDs of all events and arguments.
Accessing a Custom MicroStrategy Web Page
In order to access a custom page, you must always use both the evt and src parameters as part of the request. The src parameter should contain the path to your page so the event is handled by the new page instead of the original page. For example, if you created a copy of the "Report Execution" page and named it "my_report", the src parameter would be:
J2EE environment:
src=mstrWeb.my_report.4001
.NET environment:
src=Main.aspx.my_report.4001
The URL for the custom page would be:
J2EE environment:
http://webserver/MicroStrategy/servlet/mstrWeb?evt=4001&src=mstrWeb.my_report.4001&...
.NET environment:
http://webserver/MicroStrategy/asp/Main.aspx?evt=4001&src=Main.aspx.my_report.4001&...
The sample URLs shown above assume that you want to use the default behavior rather than specifying the bean. If you create multiple custom beans in the custom page, you can use the src parameter to specify exactly which bean should be used when the page is displayed, as illustrated in the URLs below:
J2EE environment:
http://webserver/MicroStrategy/servlet/mstrWeb?evt=4001&src=mstrWeb.my_report.myBean.4001&...
.NET environment:
http://webserver/MicroStrategy/asp/Main.aspx?evt=4001&src=Main.aspx.my_report.myBean.4001&...
There is another parameter that can be used to access MicroStrategy Web pages, but it is not recommended that you use it. The pg parameter (pg is short for “page”) is provided primarily as a convenience for accessing non-contextual pages. The description for the pg parameter in the MicroStrategy URL Parameters topic lists all the MicroStrategy Web pages for which the pg parameter is supported. The sample URLs below illustrate how to use the pg parameter to access a custom page called "myCustomPage".
J2EE environment:
http://webserver/MicroStrategy/servlet/mstrWeb?pg=myCustomPage
.NET environment:
http://webserver/MicroStrategy/asp/Main.aspx?pg=myCustomPage
Very nice post here thanks for it I always like and search such topics and everything connected to them.Excellent and very cool idea and the subject at the top of magnificence and I am happy to comment on this topic through which we address the idea of positive re like this.
ReplyDeleteMsbi Online Training India | msbi training online
Microstrategy Url Api Parameters >>>>> Download Now
Delete>>>>> Download Full
Microstrategy Url Api Parameters >>>>> Download LINK
>>>>> Download Now
Microstrategy Url Api Parameters >>>>> Download Full
>>>>> Download LINK Wo