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.

Labels:

Comments

Post a Comment

Popular posts from this blog

Microstrategy Custom number formatting symbols

Custom number formatting symbols If none of the built-in number formats meet your needs, you can create your own custom format in the Number tab of the Format Cells dialog box. Select  Custom  as the Category and create the format using the number format symbols listed in the table below. Each custom format can have up to four optional sections, one each for: Positive numbers Negative numbers Zeros Text Each section is optional. Separate the sections by semicolons, as shown in the example below: #,###;(#,###);0;"Error: Entry must be numeric" For more examples, see  Custom number formatting examples . To jump to a section of the formatting symbol table, click one of the following: Numeric symbols Character/text symbols Date and time symbols Text color symbols Currency symbols Conditional symbols Numeric symbols For details on how numeric symbols apply to the Big Decimal data type, refer to the  Project Design Guide . ...
4 comments
Read more

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...
4 comments
Read more

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:...
2 comments
Read more

Create an alert-based subscription in MicroStrategy Distribution Services

Create an alert-based subscription in MicroStrategy Distribution Services on Web Subscription to a report or Report Services document which will be executed when a certain conditional threshold is met based on another executing report. For example, a scheduled report executes which shows the Revenue by day for the past week. If the Revenue on any one day falls below a certain value, a subscription to another report or Report Services document can be triggered and delivered to a recipient. An alert based subscription can only be created directly on a report; however, another report or Report Services document can be delivered when the alert based subscription is triggered. Note: you need a grid report to create an alert and you cannot create if you want to create on a document with text boxes. The following example will walk through the basic steps on how to setup a subscription based on an alert like this: Follow the brief  steps bel...
2 comments
Read more

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...
3 comments
Read more

Creating a .mstrc file from an empty text file

Creating a .mstrc file from an empty text file If instead a “.mstrc” file needs to be created for an environment connection prior submission, please follow these steps. To create a MicroStrategy Environment connection file .mstrc, please open a Notepad or Notepad++. Use the Notepad and use the following syntax by replacing the values according to your environment: {   "authenticationMode" : 1,   "dossierServerURL" : " https://LIBRARY_SERVER_URL/MicroStrategyLibrary_EXAMPLE/" ",   "environmentName" : "ENVIRONMENT_NAME" } The file looks like: Note: If it is a default MicroStrategy installation of MicroStrategy Library, the environment URL format will be the following: https://LIBRARY_SERVER_URL_or_IP:8080/MicroStrategyLibrary/ Save and assign a name to the file like “My_first_connection_file.mstrc”.   What does the .mstrc include? Environment Name—a unique name for your environment dossierServerURL—refers to URL of the Li...
1 comment
Read more

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...
6 comments
Read more

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...
5 comments
Read more

Derived metric based on attribute values

Derived metric based on attribute values Here is how could create and display data correctly on using below simple steps.  Create a report with Category, Subcategory and Revenue. Create New Metric in a report or VI.  Case((Category@ID = 1), Revenue, 0) Booksand Name it as Revenue for  where 2 is Category ID for "Books"  Report will display result as below.  Result for new metric is blank. Now to fix this create a new Derived metric on Category attribute first with formula as  Max(Category) {~ }  and calling Books Now Edit the "Revenue for Books metric and Replace Category@ID with this new Books metric formula would looks like this  Case((Books = 1), Revenue, 0).  Report result would now display as expected as shown below
2 comments
Read more

Microstrategy Dashboard performance improvements steps

Microstrategy  Dashboard performance improvements steps: Many times, causes of poor performance can be simplified to specific components. To troubleshoot performance issues, users must identify these components, then make the appropriate modifications to the environment and/or to the MicroStrategy dashboard to reduce bottlenecks. Dashboard execution stages can be represented below: MicroStrategy Intelligence Server When an end user makes a  Document Execution Request  through any client (a web browser via MicroStrategy Web, the MicroStrategy Desktop/Developer client, the MicroStrategy Mobile app, or the MicroStrategy Office client), the request is sent to the MicroStrategy Intelligence Server, which processes the request and prepares the response. The MicroStrategy Intelligence Server will execute all children datasets on the dashboard by either generating SQL and running this against the data warehouse, or by fetching data from a cache. The Inte...
1 comment
Read more