Web SDK Customization Tools

The Web SDK provides intuitive customization tools and rich documentation to help you understand key concepts and accomplish customization tasks. The Web SDK lets you gain in-depth technical knowledge about MicroStrategy Web products and at the same time addresses the needs of developers who want to perform customizations without concerning themselves with high-level conceptual information.

Web SDK customization tools:

• Documentation from MicroStrategy Developer Library (Web SDK section)

  At the heart of the Web SDK is the documentation content provided as part of the MicroStrategy Developer Library (MSDL). The MSDL provides the content you need to learn the key concepts and gain in-depth knowledge about MicroStrategy Web products, and resources to understand and perform customizations using Web SDK. A perfect place to start is with the Best practices for customizing MicroStrategy Web. This includes important information such as how to minimize the impact of upgrades and how to apply customization changes. 

• Page Configuration file, MicroStrategy Web Page Reference, and MicroStrategy Custom Tags Reference

  These resources help you customize the navigation and layout within the MicroStrategy Web products.

  • Because of the object-oriented and multi-layered architecture, customization tasks involving page layout and navigation can be accomplished with minimal coding. In most cases, these tasks involve modifying parameters in a single Page Configuration file.

  • The MicroStrategy Custom Tags Reference lists the tags that can be used to work with MicroStrategy Web components. 

• Style Catalog Configuration file and Transform Parameters Reference

  These resources help you customize the look and feel within the MicroStrategy Web products. Since the presentation layer is separate from the business logic, these tools provide all the information necessary for customizing the appearance and display.

  • Styles for reports, folders, prompts and so on are stored in a Style Catalog Configuration file that hosts a collection of styles, and APIs for manipulating them.

  • The values for modifying the properties for styles and transforms are available in the Transform Parameters Reference. 

• Complete API Reference

  The API Reference provides detailed information for all the packages along with summary information for the classes and interfaces. The reference also lists the class hierarchies for the packages. 

• Other customization references

  The References section provides additional references such as the Event Handlers Reference and Troubleshooting Reference that provide all the information necessary for accomplishing customizations in a quick and easy manner. 

• SDK kits and sample applications

  The Web SDK also provides custom MicroStrategy portlet samples, such as a sample iGoogle Gadget and a sample JSR 168 MicroStrategy Portlet. The purpose of these samples is to illustrate how to reuse the MicroStrategy Web components to integrate business intelligence into your application. Sample applications are also provided which are ready to be implemented. 

• Sample code

  The Web SDK also contains code samples that are provided with MicroStrategy Web products. The actual code samples are available with the install; however, you can gain additional information about the samples and related concepts from the MSDL. These code samples help you get started with common customization tasks.