MicroStrategy ONE

Creating a New Add-on for a Specified Page

In creating a new add-on for a page, you create a new add-on Java class, an instance of which is added to the page. The class is then available for other pages as well. This topic provides step-by-step instructions for creating a new add-on and adding it to a specific MicroStrategy Web page.

  1. Launch the Add-on Creation Wizard (Create). 

  2. On the New Add-on Class wizard, do the following: 

    1. For Source folder, click Browse to navigate to the source folder for MicroStrategy project. On the Source Folder Selection dialog, navigate to the source folder and click OK. 

    2. For Package, click Browse to enter or choose the package to which the add-on class will belong. The value is the fully-qualified name of the package. On the Package Selection dialog, navigate to the package and click OK. 

    3. In the Name text box, enter a name for the add-on. 

    4. In the Addon Description text box, enter a description for the add-on. 

    5. If required, click the appropriate check box to specify whether the add-on class should be run before or after data is retrieved from MicroStrategy Intelligence Server. 

    6. Click Next. 

  3. The name and description of the new add-on class you are creating are displayed under Results. If you want to change the information, click Back. When you are satisfied with the name and description, click Finish. 

  4. A new tab—with the name of the new add-on Java class—opens in the Web Customization Editor. The file on this tab contains skeleton code for the new add-on class that does the following: 

    • declares the name of the package 

    • imports the AbstractAppAddOn class 

    • declares the name of the class and has it extend AbstractAppAddOn 

    • defines the getAddOnDescription method and has it return the description that you provided in the wizard. 

    • if you specified when the add-on class should be run, defines the preCollectData and/or postCollectData method. 

  5. Modify the code for the new add-on class to include your own custom logic as appropriate. 

  6. Save your changes. 

The new add-on is added to the page you initially selected when opening the Add-on Creation Wizard. It is listed in the Add-ons table on the Add-On Properties tab for that page.

After you have completed this task, you must restart the application server for changes to take effect, unless the reloadConfigurationFiles property in microstrategy.xml is set to true. See Applying Customization Changes for information on changing the value of the reloadConfigurationFiles property.