Skip to main content

Microstrategy Document Autotext macros:

Autotext  code/macros in Microstrategy Document/dashboard

This is a list of the available auto text macros that the Report Services Document engine recognizes.
The following auto text codes allow you to add document variable information to your document. These auto text codes are automatically replaced by information about the document.

Auto text codes for MSTR document/dashboard:

 AUTOTEXTDESCRIPTION 
 {&PAGE} Display the current page.
 {&NPAGES} Display the total number of pages.
 {&DATETIME} Display the current date and time.
 {&USER} Display the user name that is executing the Report Services Document.
 {&DOCUMENT} Display the document name.
 {&DOCUMENTID} Display the document ID.
 {&DESCRIPTION} Display the document description.
 {&PROJECT} Display the project name.
 {&EXECUTIONTIME} Display the execution time.
 {&SERVERNAME} Display the Intelligence Server name
 {&REPORT:FILTERDETAILS} Display the filter details of that report.
 {&REPORT:PROMPTDETAILS} Display the prompt details of that report.
 {&REPORT:REPORTDETAILS} Display the report details.
 {&NOTES} Display the Report Services Document notes.
 {&Prompt1&} Display the answer of the first prompt.
 {&WEBSERVER} Display the Web server URL.
 {&TITLE} Display the Report Services Document inbox title.
 {&PROMPTXML} Display the prompt answers XML.
 {&DOCUMENTMESSAGEID} Display the message ID of the Report Services Document.
 {&REPORT:GUID} Display the GUID of that particular report.
 {&ATTRIBUTE@ELEMENTID} Display the Element ID of that attribute.
 {&ATTRIBUTE@GUID} Display the GUID of that particular attribute.

Description
Code
Sample Output
Comments
Page number
{&PAGE}
1
The current page number
Total number of pages
{&NPAGES}
12
The total number of pages in the document or in the group’s section before page numbering restarts
Date & Time
{&DATETIME}
11/15/2003 7:10:55 PM
Current date and time, of the client computer. For PDFs, this is the date and time when the PDF was generated
You can display only the date without the time, or the month name rather than the number, and so on. 
Current user
{&USER}
Jane User
The full name, not login, of the user who generates the PDF or views the document
Document name
{&DOCUMENT}
Regional Sales Summary
The name of the document as stored in the project
Document description
{&DESCRIPTION}
Revenue and profit by region
Short description of the document
Document inbox title
{&TITLE}
Regional Sales Summary for Tuesday
The name of the document instance
If you send a document to your History List, you can rename that instance of the document. This auto text code displays that name, rather than the document name stored in the project.
Document notes
{&NOTES}
User1: 8/15/2010 10:10:10 AM: Reviewed and approved
Notes (annotations) added to the document.
For background information on notes, see .
Project name
{&PROJECT}
MicroStrategy Tutorial
The name of the project in which the document is stored
Prompts
{&PROMPT1&}
{&PROMPT2&}
:
{&PROMPTn&}
South (for example, if prompt1 is for the attribute Region)
The user's answers to each prompt in the document, identified by number
If n is greater than the number of prompts in the document, the code cannot be replaced with pertinent information. Therefore the code itself is displayed in the PDF.
Prompt details
{&PROMPTDETAILS}
Prompt 1: Region prompt
Northwest, Southwest
Prompt 2: Year
Year (ID)= 2007
Details for all the prompts in the document
You can define how this auto text code is displayed 
MicroStrategy Web Server
{&WEBSERVER}
http://localhost:8080
/MicroStrategy/servlet/mstrWeb
Path to the web server being used, if the document is executed in MicroStrategy Web; otherwise, the value in project configuration
Document execution time
{&EXECUTIONTIME}
The date and time the document was executed
You can display only the date without the time, or the month name rather than the number, and so on. 
To differentiate between Date and Time and Document execution time, do the following:
1Run a document and send it to the History List.
2Each time you retrieve the document from the History List, the PDF is regenerated. The Date and Time change each time, but the Document execution time does not change.

Comments

Post a Comment

Popular posts from this blog

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

Case functions Microstrategy

Ca se functions Microstrategy Case functions return specified data in a SQL query based on the evaluation of user-defined conditions. In general, a user specifies a list of conditions and corresponding return values. Case This function evaluates multiple expressions until a condition is determined to be true, then returns a corresponding value. If all conditions are false, a default value is returned.  Case  can be used for categorizing data based on multiple conditions. This is a single-value function. Syntax Case ( Condition1 ,  ReturnValue1 ,  Condition2 , ReturnValue2 ,...,  DefaultValue ) Example Case(([Total Revenue] < 300000), 0, ([Total Revenue] < 600000), 1, 2) sum(Case (Day@DESC in (“Sat”,”Sun”), Sales, 0) {~+} Sum(Case(Category@DESC In("Books","Electronics"),Revenue,0)){~+} CaseV (case vector) CaseV  evaluates a single metric and returns different values according to the results. It can be used to perfo...

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

Control the display of null and zero metric values

Show   Control the display of null and zero metric values in a grid report You can determine how to display or hide rows and columns in a grid report that consist only of null or zero metric values. You can have MicroStrategy hide the rows and columns in the following ways: Hide rows and columns that consist only of null metric values Hide rows and columns that consist only of zero metric values Hide rows and columns that consist only of null or zero metric values (default) Once you have defined how MicroStrategy hides null and zero metric values in the grid, you can quickly show or hide the grid using the Hide Nulls/Zeros option in the Data menu, as described below, or by clicking the  Hide Nulls/Zeros  icon  in the Data toolbar. To determine how null and zero metric values are displayed or hidden in a grid report Open the report in Edit mode. From the  Tools  menu, select  Report Options . The Report Options...

Display a report in different view modes through URL API in MicroStrategy Web

The URL parameter report view mode in Microstartegy visMode - the mode in which the document is displayed, e.g. 2 for Interactive reportviewmode  determines how reports are displayed in the view mode, e. g. 1 for grid mode. &reportViewMode=1 (grid) &reportViewMode=2 (graph) & reportViewMode=3 (grid/graph)  &visMode=0 (no visualization) &visMode=51 (AJAX visualization)  <--- this and Flash (50) require that you setup a Custom Visualization in the report definition.&visMode=50 (Flash visualization). M ake sure those modes are enabled in Document Properties. Other parameters in the URL API Webserver - name or IP address of the webserver  Evt - event/action to be performed, e.g. 2048001 for running a document  Src - web page component to perform the event  documentID - document object ID to be executed  The parameter to pass an answer to an element list prompt:  elementsPromptAnswers=AttrID;AttrID:E...

MicroStrategy default sort order for an attribute elements browsing

MicroStrategy default sort order for an attribute elements browsing and display How does MicroStrategy 9.x resolve the default sort order for an attribute when different sort orders are defined for different forms? Consider the following cases: CASE 1 A new attribute is created with three forms, all with sort order set to none. Form Name Form Type Default Sort Order ID ID None DESC DESC None LongDesc None None The overall sort order is evaluated and stored in the attribute definition when the attribute is saved. With all form sort orders set to none there is no saved sort order, MicroStrategy defaults to sort ascending by ID. CASE 2 The same attribute is modified so the forms are now: Form Name Form Type Default Sort Order ID ID None DESC DESC Descending LongDesc None Ascending Now when the attribute is saved, MicroStrategy goes through each form in the order they appear in the main 'Forms' window of the attribute editor. The first...

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

Microstrategy Caches explained

Microstrategy Caches Improving Response Time: Caching A  cache is a result set that is stored on a system to improve response time in future requests.  With caching, users can retrieve results from Intelligence Server rather than re-executing queries against a database. To delete all object caches for a project 1 In Developer, log into a project. You must log in with a user account that has administrative privileges. 2 From the  Administration  menu, point to  Projects , and then select  Project Configuration . The Project Configuration Editor opens. 3 Expand  Caching , expand  Auxiliary Caches , then select  Objects . To delete all configuration object caches for a server 1 Log in to the project source. 2 From the  Administration  menu in Developer, point to  Server , and then select  Purge Server Object Caches . 4 Click  Purge Now . To purge web cache follow the steps in the link ...

Apply or Pass-through functions in Microstrategy

Ap ply (Pass-Through) functions MSTR Apply functions provide access to functions or syntactic constructs that are not standard in MicroStrategy but are provided by various RDBMS systems.. Syntax common to Apply functions Apply Function Name   ("expression with placeholders", Arg1, Arg2, Arg3, …ArgN) where: Apply Function Name  – is a generic name used for the predefined pass-through functions described above expression with placeholders  – is the string describing the actual expression or syntax that the engine uses while generating the SQL and which is sent to the RDBMS. The placeholders are represented by #0, #1, and so on. "#" is a reserved character for MicroStrategy. Arg  – is an argument that replaces the parameter markers in the pattern. Arg1 replaces #0, Arg2 replaces #1, and so on. There are   five  pre-defined Apply functions to replace regular, predefined functions of the same type. For more details, cli...

Transaction Services - Configure Transactions

Configure Transactions in MSTR Web Transaction Services-enabled document displayed on an iPhone, iPad, or Android device can allow users to insert/update/delete data in to the database, using the options in the Configure Transactions Editor. To do so, you must link a Transaction Services report to a grid or to text fields in a panel stack. If the document is being displayed on an iOS device, you can link the report to the cells of a transaction table. Data from the input objects defined in the Transaction Services report is displayed in the grid, text fields, or cells for users to edit. Prerequisites:        Ø   You must have the Web Configure Transaction privilege assigned by MSTR user admin. Ø   Create the Transaction Services report (usually a grid report) you want to link to the grid, text fields, or transaction table cells. Make sure that the Transaction Services report must contain the input object for each value you w...