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 document/dashboard applying selections as filters or slices

Applying selections as filters or slices In a Microstrategy Document the selections a user makes in a selector can either filter or slice the data in the target: Filtering means that the data for the current selection is calculated only when it is requested by the user. The selections are used to filter the underlying dataset before the metric values are aggregated at the level of the Grid/Graph that is displayed in the document. If the source attribute is not included in the Grid/Graph, the metric values from all the selected elements are aggregated and shown at the level specified in the Grid/Graph. All metric condition selectors (which filter metric values or ranks) and selectors that target other selectors filter data by default. You cannot change them to slicing selectors. Slicing means that the data for each available item in the selector is calculated in advance when the document is first displayed. Selections made while ...

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

Custom Tooltips in Microstrategy developer and Web

Custom Tooltips in Microstrategy developer and Web The following table describes the macros you can use to customize graph tooltips in both MicroStrategy Developer and MicroStrategy Web: Macro Information Displayed {&TOOLTIP} All relevant labels and values associated with a graph item. {&GROUPLABEL} Name of the graph item's category. This value is often the graph item's attribute element information, as attributes are commonly used as the categories of graph reports. {&SERIESLABEL} Name of the graph item’s series. This value is often the graph item's metric name information, as metrics are commonly used as the series of graph reports. {&VALUE} The value of a given data point. {&XVALUE} The X-value of a data point. Only applicable to Bubble charts and Scatter plots. {&YVALUE} The Y-value of a data point. Only applicable to Bubble charts and Scatter plots. {&ZVALUE} The Z-value of a data point. Only applicable to Bubble charts and Scatter plots. {...

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

Personalizing file locations, email and file subscriptions using macros in Microstrategy

Personalizing file locations MSTr allows to dynamically specify the  File Location  and  Backup File Location  in a file device using macros.  For example, if you specify the  File Location  as  C:\Reports\{&RecipientName}\ ,  all subscriptions using that file device are delivered to subfolders of  C:\Reports\ . Subscribed reports or documents for each recipient are delivered to a subfolder with that recipient’s name, such as  C:\Reports\Jane Smith\  or  C:\Reports\Hiro Protagonist\ . The table below lists the macros that can be used in the  File Location  and  Backup File Location  fields in a file device: Description Macro Date on which the subscription is sent {&Date} Time at which the subscription is sent {&Time} Name of the recipient {&RecipientName} User ID (32-character GUID) of the recipient {&RecipientID} Distribution Services add...
Microstrategy Release Types Platform release Interval:  Annually every twelve (12) months in December Who:  Entire customer base What:  Focus on production level security, stability, and performance defect fixes for all customers. Expectation:  Customer has chosen platform path and wants product stability without new enhancements. Support:  Three (3) years, patches for approved P1 defects, and regular hotfix cadence addresses critical defects. Feature Release Interval:  Quarterly every three (3) months Who:  Customers with specific feature requirements. What:  New functionality developed in close collaboration with customers and customer council. Expectation:  Customer has chosen feature path, will consume further feature releases. Support:  Six (6) months patch support for approved P1 defects and (eighteen) 18 months troubleshooting. Customers upgrade to next feature release for roll-up f...

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

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

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