MicroStrategy ONE

Adding an Existing Add-on to a Specified Page

This topic provides step-by-step instructions on adding an instance of an existing add-on Java class to a specified MicroStrategy Web page.

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

  2. On the Add-on Creation Wizard, select an existing add-on class that you want to add to the page: 

    1. For the Add-on Class, click Modify. On the Select Add-on dialog, enter the fully-qualified name of the add-on class and click OK. 

    2. Click Next. 

  3. Use the shopping cart to select properties for the add-on. 

    If you highlight only one property in either pane, the declaration for that feature is displayed in the pane below, together with other information about the property. If you highlight multiple properties, only the text Multiple Selection is displayed.

    If the add-on does not have any properties, the final panel opens with the name of the add-on class displayed under Results.

  4. Click Next. 

  5. Specify the source and define the value for each add-on property. 

    1. The property Type is already determined. 

    2. For Source, select one of the following choices from the drop-down list.

      • default: The default source is request.

      • request: The value is returned by an HTTP request.

      • enum: The value specifies the ID of a Java enumeration. Consult the API documentation for a list of available enumerations.

      • const: This source setting uses a constant value.

      • preferences: The value is the ID of a MicroStrategy Web preference.

      • browserSetting: This source uses a browser cookie.

      • feature: This source setting uses a MicroStrategy Web feature.

    3. For Value, enter the corresponding value for the property. 

  6. Click Next. 

  7. Review the name and properties of the add-on class displayed under Results. If you want to change the information, click Back. When you are satisfied with the name and description, click Finish. 

  8. The add-on is now included in the Add-ons table on the Add-on Properties tab for the page you initially selected when opening the Add-on Creation Wizard. 

  9. Save your changes.

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.