Web SDK
Installing MicroStrategy Web and the MicroStrategy SDK
Once you have installed and configured the Java Development Kit from Sun Microsystems, you must install MicroStrategy Web and the MicroStrategy SDK.
MicroStrategy Web with the ASP.NET front-end is installed by default in the C:\Program Files(x86)\Microstrategy\Web ASPx folder.
MicroStrategy Web with the JSP front-end is packaged within a single WAR file, MicroStrategy.war, which is located by default in the C:\Program Files (x86)\Microstrategy\Web JSP folder.
Detailed instructions for deploying MicroStrategy Web with the JSP front-end are included in the Installation and Configuration Guide provided as part of the MicroStrategy product documentation.
Download the latest MicroStrategy Web SDK zip file to your local machine and extract the contents.
Prior to MicroStrategy 9.3.1, the SDK was included with the product and was installed by default in C:\Program Files(x86)\Microstrategy\SDK folder on a Windows operating system, and in the MicroStrategy/SDK folder on a non-Windows operating system. It is possible that some instructions in the MSDL may assume that this is the location of the SDK installation.
The next step in deploying and configuring the Web Customization Editor is to download and install Eclipse.
Downloading and Installing Eclipse
Access http://www.eclipse.org and download a 4.x version of the Eclipse SDK.
When you unzip the downloaded zip file into a new folder, an eclipse folder will be created automatically under the directory where you unzip the file.
In the eclipse folder, create a new folder called workspace.
Open the eclipse folder and double-click on eclipse.exe. The Workspace Launcher window opens.
On the Workspace Launcher window:
use the Browse button to select the workspace folder that you created under the Eclipse directory.
check the Use this as the default and do not ask again check box to select it.
Click OK. The Eclipse window opens with the Java perspective loaded.
Close the Welcome tab of the Java - Eclipse SDK to view the Package Explorer tab.
The default memory settings for Eclipse are defined in eclipse.ini (located in the C:\eclipse download name\eclipse folder). The recommended values for memory settings Xms and Xmx are 512m and 1024m respectively. These values can be updated by editing eclipse.ini.
Next step in deploying and configuring the Web Customization Editor is to deploy and configure the Web Customization Editor.
Welcome to the Customizations Explorer
The Customizations Explorer helps you find any customization scenario in the MicroStrategy Developer Library (MSDL). The MSDL provides detailed instructions for performing more than 100 customization scenarios using the MicroStrategy SDK. The collection of these scenarios is based on customer requirements and feedback received, and represent the most typical and popular customizations implemented by MicroStrategy consultants and customers.
To find a customization scenario, you can search for it with relevant keywords or find it in the list of scenarios below. The scenarios are organized in the same categories as those used in the MSDL.
Basic Scenarios: Cosmetic Changes for Look and Feel
Basic Scenarios: Altering Application Workflow and Navigation
Basic Scenarios: Customizing Existing Functionality
Advanced Scenarios: Customizing Presentation of Data and Web Components
Advanced Scenarios: Extending Existing or Adding New Functionality
External Security Module Scenarios: Customizing Authentication
Single Sign-on Customization Scenarios
Basic Scenarios: Cosmetic Changes for Look and Feel
Changing the Color of the Bars at the Top
Removing the MicroStrategy Web Button
Replacing the MicroStrategy Web Button
Modifying the Amount of Project Detail Displayed on the Welcome Page
Modifying the Project Icon on the Welcome page
Modifying Icons on the Default Home Page
Modifying the Icons Based on a MicroStrategy Web Color Theme
Changing Color of the Table Header on the Folder Browsing Pages
Modifying Default View of Folder Browsing page Content from Icon View to List
Modifying the Amount of Detail displayed on the Folder Browsing pages
Modifying the Icons used on the Folder Browsing pages
Removing columns on the Folder Browsing page
Removing Folder Description on Folder Browsing pages such as Shared Reports
Hiding the Text Metrics Displayed on a Report Grid
Modifying the Look and Feel of a Report Grid
Modifying the Amount of Information displayed on the Prompt Page
Adding Icons to Buttons on the Prompt Page
Modifying the Images on the Prompt Selection Shopping Cart
Modifying the Color and Font Properties of a Prompt
Removing the Prompt Summary from the Prompt Page
Using a Custom Numbering Format for Prompts
Modifying the Font properties on the Default Home page
Modifying the Font properties on the Folder Browsing Pages
Adding Localized Text to a Page
Adding Localized Text to the Browser Title for a Page
Changing Prompt Layout on the Prompt Page
Changing the Layout of the Prompt Selection Shopping Cart
Removing Document Scrollbars when Two Sets of Scrollbars are Displayed
Basic Scenarios: Altering Application Workflow and Navigation
Displaying Folder Contents and Report on the Same Page
Moving the Page Section on the Report Execution page
Removing the Page Section on the Report Execution page
Creating a Custom Default Page Section That Can be Inherited by All Pages
Customizing the main application URL
Linking to a MicroStrategy Folder from an External Web Site or Other Location
Linking to a MicroStrategy Report from an External Web Site or Other Location
Removing Individual Items from the Navigational or Path Information
Removing the Navigational/Path Information
Adding a Shortcut to a Specific Page
Adding a Conditional Shortcut to All Pages
Removing a Shortcut from a Specific Page
Removing a Shortcut from All Pages
Removing the Links on the Welcome page to Version and About MicroStrategy Web information
Rearranging the links on the Home page
Removing a link from the Home page
Removing the Links on the Folder Browsing Page for Individual Projects
Creating a New Ribbon for a Report
Hiding Toolbar Items Based on Feature Availability
Disabling Toolbar Items Based on Feature Availability
Adding a Custom page to the list of Default Start pages and making it the Default Start page
Changing the Sort Order on the My Subscriptions Page
Displaying Different Subscription Types on Separate Pages
Creating a Custom Report Page and Accessing It through a Link on an Existing Page
Passing Value and Object Prompt Answers in the URL
Removing a link or button from the Processing page
Building a URL with Multiple Events
Basic Scenarios: Customizing Existing Functionality
Adding or Removing the Number and Types of Available Export Formats
Adding or Removing a TimeStamp for a Report or a Document
Displaying Information about Connection to Intelligence Server
Validating Prompt Answers for a Report
Adding a New Paper Size Option for Printing a Report
Adding Shortcuts and Changing the Root Folder in the Object Browser for a Report
Disabling Functionality on Report Grid or Graph
Removing the AutoStyle Picker above the Report Grid
Using Streamlined Versions of the Report Page
Modifying Predefined Quick Thresholds
Persisting Information in Every Request
Creating a Custom Toolbar Group
Adding or Removing Context Menu Items
Displaying Objects Selected in a Report
Advanced Scenarios: Customizing Presentation of Data and Web Components
Displaying Dynamic Content in MicroStrategy Web pages (.NET only)
Displaying Reports in a PDF Format
Redirecting to an External URL when an HTML Document is Clicked
Opening Documents in a New Browser Window
Processing Events with JavaScript before Submitting Them
Adding Extra Arguments to All Links
Including the Prompt Question on the Document Execution Page
Altering Report Title Text on the Report Execution Page
Displaying Report Cell Contents as Preformatted Text
Hiding an Attribute Column Automatically on an Executed Report Grid
Including the Prompt Question on the Report Execution Page
Modifying the Report Grid Presentation Rules by Extending ReportGridTransformImpl
Advanced Scenarios: Extending Existing or Adding New Functionality
Adding a Dynamic Image to a Document
Answering a Prompt Question by Supplying an Answer in the URL
Applying a Bulleted List View on Folder Browsing Pages
Changing the View Mode of the Shared Reports Page on the Fly
Modifying Export Properties for a Report Programmatically
Modifying the Prompt Style for a Specific Report
Refreshing a Document Automatically
Adding GUI Elements to an Existing Prompt
Adding Custom Password Validation Rules
Retrieving Report XML and Automatically Logging Out
Retrieving Report XML in a Custom Format
Displaying the List of Projects in a Tabbed Display
Displaying MicroStrategy Intelligence Server Statistics
Displaying the TinyURL Version of an Object Link on the Properties Dialog
Enabling Custom Drill Paths for Different Attribute Elements
Creating a Custom Event for Grid Manipulations
Causing MicroStrategy Web to Return a Grid when Drilling on a Graph
Adding Extra Arguments to an Existing Event
Using a Custom Web Feature to Provide Special Functionality for a User Group
Adding Context Menu Items Not Implemented by Default
Disabling or Removing Context Menu Items for a Specific Object
Adding Context Menu Items that Display Information about the Object
External Security Module Scenarios: Customizing Authentication
Mapping Credentials using an External Repository
Displaying Different Login Pages based on Project
Creating a Session from a Custom Login Page
Displaying Different Start Pages based on User Group
Restricting Access during Certain Times
Restricting the Number of Open User Sessions
Single Sign-on Customization Scenarios
Adding a New Trusted Authentication Provider
Changing the Default Settings for CA SiteMinder
Changing the Default Settings for IBM Tivoli Access Manager
Specifying Multiple Header Variables for Authentication