Skip to main content

Prompts in URL API

Prompts in 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 theAttributeID, 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.Itdetermines 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.Itdetermines 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 pertainonlyto value prompts. So, for example, if the first value prompt for a report is preceded by an element prompt, you wouldnotsignify 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.

Comments

Popular posts from this blog

Microstrategy Dossiers explained

Microstrategy  Dossiers With the release of MicroStrategy 10.9, we’ve taken a leap forward in our dashboarding capabilities by simplifying the user experience, adding storytelling, and collaboration.MSTR has  evolved dashboards to the point that they are more than dashboards - they are  interactive, collaborative analytic stories . Ultimately, it was time to go beyond dashboards, both in concept and in name, and so  the've  renamed VI dashboards to  ‘ dossiers ’.  Dossiers can be created by using the new Desktop product or Workstation or simply from the Web interface which replaces Visual Insights. All the existing visual Insights dashboards will be converted to Dossiers   With MicroStrategy 10.9, there was an active focus on making it easier to build dashboards for the widest audience of end users. To achieve this, some key new capabilities were added that make it easier to author, read, interact and collaborate on dashboards ...

MicroStrategy URL API Parameters

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:...

Configure a report for use with Bulk Export in MicroStrategy

Configure a report for use with Bulk Export in MicroStrategy The Bulk Export feature enables a large report to be saved as a delimited text file. Using this feature, it is possible to retrieve result sets from a large dataset without having to load the entire dataset into memory. PS:  Once a report is setup for bulk export it cannot be used as a regular report. So if the report needs to be run as a normal report and as a bulk export report, the first step is to make a copy of the report for use with bulk export. Configure Bulk Export Bulk Export options are only available in MicroStrategy Developer. Open a 3-tier connection using MicroStrategy Developer and edit the desired report. Go to 'Data' on the top menu bar. Select 'Configure Bulk Export': Specify any additional desired configuration options. General Settings Bulk export database instance : This is the database instance to use to store the bulk export results. Temporary tables w...

Microstrategy Document Editor Sections Important Notes:

Microstrategy Document Editor Sections Important Notes: The Layout area is in the center of the Document Editor interface and provides the framework for precisely controlling where controls (such as text fields, grid and graph reports, images, and widgets) are displayed when the document is viewed in different display modes, printed, exported, emailed, and so on. To add data to the document, drag objects from the  Dataset Objects  panel and drop them into the  Layout  area. Controls are rendered differently depending on what section they are placed in, as described below:   Page Header : The control is displayed at the top of each page in the document. By default, if a document contains multiple layouts, the same Page Header is displayed for all layouts in the document. You can change this setting so that each layout has a separate Page Header. Document Header : The control is displayed once at the beginning of the document, immediately below the Page Header sec...

Microstrategy "Error type: Odbc error. Odbc operation attempted

 "Error type: Odbc error. Odbc operation attempted: SQLExecDirect. [HYT00:0: on SQLHANDLE] [MicroStrategy][ODBC Oracle Wire Protocol driver]Timeout expired" is shown when executing reports from Web When users are trying to execute some reports in MicroStrategy web in particular, they may receive the Error “SQL Generation Complete Index out of range” and “Timeout expired” error as shown below: Possible Causes: One possible cause is that the MicroStrategy Intelligence Server using a cached database connection that was already dropped by the RDBMS. To resolve this: Admin should delete the database connection caches and create a new DSNs in case they are sharing DSNs to connect to different databases. In addition, change the settings for the ‘Connection lifetime’ and the ‘Connection idle time out’.  Follow the steps below to perform the mentioned changes and verify the report after each step and some of the settings require i-server r...

Star Schemas issue fixes in Modelling of Microstartegy

Star Schemas issue fixes in Modelling of Microstartegy Explanation This schema is characterized by one lookup table per dimension, with base tables at the lowest level. This is the fastest way to set up a data warehouse: This type of schemas is supported but has restrictions such as when adding aggregate tables: Problem Double counting. According to the diagram above, a report that contains month and the a metric SUM(SALES_AMT) will go to the aggregate table and join to the column to retrieve the description from the table. Since the column is not unique in its lookup table, the results will appear duplicated. Recommendation MicroStrategy engine is optimized to work with snowflake schemas, where each attribute level has a distinct lookup table. Star schemas are supported with restrictions, as long as fact tables are not at a higher level than the dimension tables to which they are joined. Consult the following MicroStrategy Knowledgebase document for further information....

Types of filters in Microstrategy

Types of filters in Microstrategy Below are the types of filters: 1. Attribute qualification filter These types of qualifications restrict data related to attributes on the report. a) Attribute form qualification Filters data related to a business attribute’s form(s), such as ID or description. •  For example, the attribute Customer has the forms ID, First Name, Last Name, Address, and Birth Date. An attribute form qualification might filter on the form Last Name, the operator Begins With, and the letter H. The results show a list of customers whose last names start with the letter H. b) Attribute element list qualification Filters data related to a business attribute’s elements, such as New York, Washington, and San Francisco, which are elements of the attribute City. • For example, the attribute Customer has the elements John Smith, Jane Doe, William Hill, and so on. An attribute element list qualification can filter data to display only those customer...

display a group horizontally in MSTR document

Display a group horizontally in MSTR document By default,  groups are displayed vertically in a document.  This means that the detail sections are displayed below the Group Header. For example, a document is grouped by Year. The Detail section includes revenue and profit information by region.  Displaying the group vertically yields the following document: For certain documents, displaying and printing the group horizontally is desired. When displayed horizontally, the detail sections are displayed next to the Group Header, running horizontally across the page. The example given above, if displayed horizontally, shows a row containing the year, and then, for each region, the Region, Revenue, and Profit. When the document is viewed as a PDF, it displays as shown below: When being designed, the document with horizontal display looks like the following in MicroStrategy Developer: The sections within the group are turned sideways and listed horizontally...

Types of prompts in Microstrategy

Types of prompts in Microstrategy The different types of prompts allow you to create a  prompt  for nearly every part of a report. Prompts can be used in many objects including reports, filters, metrics, and custom groups, but all prompts require user interaction when the report is executed. The correct prompt type to create depends on what report objects you want users to be able to base a filter on to filter data, as described in the list below. Filter definition prompts   allow users to determine how the report's data is filtered, based on one of the following objects: Attributes in a hierarchy : Users can select prompt answers from one or more attribute elements from one or more attributes. The attribute elements that they select are used to filter data displayed on the report. This prompt lets you give users the largest number of attribute elements to choose from when they answer the prompt to define their filtering criteria. For example, on a repor...