EducationSoftwareStrategy.com
StrategyCommunity

Knowledge Base

Product

Community

Knowledge Base

TopicsBrowse ArticlesDeveloper Zone

Product

Download SoftwareProduct DocumentationSecurity Hub

Education

Tutorial VideosSolution GalleryEducation courses

Community

GuidelinesGrandmastersEvents
x_social-icon_white.svglinkedin_social-icon_white.svg
Strategy logoCommunity

© Strategy Inc. All Rights Reserved.

LegalTerms of UsePrivacy Policy
  1. Home
  2. Topics

KB42036: How to Change the Number Formatting of a Report Prior to Execution using the MicroStrategy Web SDK


Community Admin

• Strategy


Article outlines how to change the Number Formatting of a Report Prior to Execution using the MicroStrategy Web SDK.

Strategy Web 9.3.0 offers the Format:Template window shown below, out of the box.  This allows users to modify the decimal places, thousand separator, currency symbol, currency position, and negative number style:
 

ka04W00000148gqQAA_0EM440000002Ge5.png

 
However, a user may want to change or adjust the settings based on a special condition before the end-user sees the report.  Using the step-by-step instructions below, developers will be able to create an add-on that will allow control of the number formatting settings before the end user sees the report.
 
The example provided in this document is provided “as-is” to the user and assumes that the user:

  • Can program, compile (e.g. javac, jikes, etc.), and execute Java programs
  • Can configure environment variables (e.g. JAR files, property files, etc.)
  • Have all the necessary tools to create Java applications (JDK, IDE, etc.)
  • Has access to the Strategy SDK documentation.
  • Has read the customization warning at the bottom of this document

 
PREREQUISITES:
For the sample to work, the Strategy Web JAR files must be accessible by the Java Runtime
Environment. The Strategy Web JAR files can be found under:

  • Strategy Web Universal (JSP): {web_root}/WEB-INF/lib directory.
  • Strategy Web (.NET): Program Files\Common Files\Strategy directory.

Note:
More elaborate programs will require additional library files and are out of the scope of this document.
 
Using the Web Customization Editor to create a plug-in
Strategy SDK provides a Web Customization Editor that can be used to create a customization plug-in. The following steps show how to create the plug-in and deploy.

  • Launch the Web Customization Editor.
     
  • Create a new plug-in and give it a meaningful name. For example: ModifyNumberFormatBeforeReportExecution. (For step by step instructions on creating a new plug-in, please navigate to Home > Web SDK > Customizing Strategy Web > Web Customization Editor > Features and Customizable).
     
  • Click in Strategy Web Configuration inside the Application Settings view to expand the hierarchical tree. The expanded list comprises the different settings that can be modified to perform customizations.
     
  • Navigate to Pages. Right-mouse click report(Report Execution) and select Create New Add-On to launch the New Add-On Class Wizard.
     
  • Click Browse... next to the Source folder’s text field to select the src folder and click OK.
     
  • Enter the following information for the rest of the text fields:
    Package: ##Any package the client wants to use##
    Name: ModifyNumberFormatting_AddOn
    Add-on description: This add-on will modify the number format before the report displays for the user.
    Check the box for “Add custom logic after fetching data from Intelligence Server (postCollectData)"
     
ka04W00000148gqQAA_0EM440000002GeG.png
  • Click Finish. The ModifyNumberFormatting_AddOn.java file should open in Eclipse.  For additional information on Add-On creation, reference the MSDZ (Home > Web SDK > Customizing Strategy Web > Part II: Advanced Customization Topics > Customizing Add-ons> Add-on Creation).
     
  • Modify the postCollectData method as follows:


    
    public void postCollectData(PageComponent page) {
    	ReportBean rb = getReportBean(page);
    
    	if (rb != null) try {
    		rb.getReportInstance().setAsync(false);
    		int status = rb.getReportInstance().pollStatus();
    		if (status == 1) {
    
    			Enumeration metrics = rb.getReportInstance().getTemplate().getTemplateMetrics().elements();
    			boolean needApplyChanges = false;
    			while (metrics.hasMoreElements()) {
    
    				WebTemplateMetric metric = (WebTemplateMetric) metrics.nextElement();
    				WebFormatContainer container = metric.getFormatContainer();
    
    				String category = String.valueOf(1);
    				String separator = "1";
    				String decimal = "2";
    				String currency = "\243";
    				String currpos = String.valueOf(2);
    				String neg = String.valueOf(4);
    				String prevformat = "#,##0.00";
    				String format = GridFormatHelper.constructNumberFormat(category, separator, decimal, currency, currpos, neg, prevformat);
    				String incomingCategory = container.getGridFormat().getValue("FormattingNumber", "Category");
    				if (category.equals(incomingCategory)) {
    					needApplyChanges = true;
    					container.setDefaultForProperty(2, "FormattingNumber", "DecimalPlaces", true);
    					container.setFormatProperty(2, "FormattingNumber", "DecimalPlaces", decimal, false);
    					container.setDefaultForProperty(2, "FormattingNumber", "ThousandSeparator", true);
    					container.setFormatProperty(2, "FormattingNumber", "ThousandSeparator", separator, false);
    					container.setDefaultForProperty(2, "FormattingNumber", "CurrencySymbol", true);
    					container.setFormatProperty(2, "FormattingNumber", "CurrencySymbol", currency, false);
    					container.setDefaultForProperty(2, "FormattingNumber", "CurrencyPosition", true);
    					container.setFormatProperty(2, "FormattingNumber", "CurrencyPosition", currpos, false);
    					container.setDefaultForProperty(2, "FormattingNumber", "NegativeNumbers", true);
    					container.setFormatProperty(2, "FormattingNumber", "NegativeNumbers", neg, false);
    					container.setDefaultForProperty(2, "FormattingNumber", "Format", true);
    					container.setFormatProperty(2, "FormattingNumber", "Format", format, false);
    
    				} else {
    					container.setDefaultFormats();
    				}
    			}
    			if (needApplyChanges) {
    
    				rb.setApplyChangesOnCollectData(true);
    				rb.applyChanges();
    				rb.collectData();
    			}
    		}
    	} catch (Exception e) {
    		e.printStackTrace();
    	}
    }
    
    private static ReportBean getReportBean(WebComponent wc) {
    	ReportBean result = null;
    
    	if (wc instanceof ReportBean) {
    		result = (ReportBean) wc;
    	} else {
    
    		for (int i = 0; i < wc.getChildCount(); i++) {
    
    			result = getReportBean(wc.getChild(i));
    			if (result != null) break;
    		}
    	}
    	return result;
    }



  • Save the changes. 
  • Double-click report(Report Execution) to open the editor. 
  • Click on the Add-on Properties tab.  On the Add-On Properties tab, the custom add-on class ModifyNumberFormatting_AddOn, should be listed under Class Name:
ka04W00000148gqQAA_0EM440000002Ge3.png
  • Restart the Web Server to see the changes applied in Web.

 
ADDITIONAL INFORMATION:
The Strategy SDK allows you to customize the standard Strategy Web interface, and extend and integrate the Strategy business intelligence functionality into other applications. However, before changing the way Strategy Web products look or behave, it is helpful to understand how the application is built. For more information regarding the Strategy Web architecture or the process of customizing Strategy Web, please refer to Strategy Developer Zone (https://community.strategy.com/topic/0TO44000000FliLGAS/sdk ).
 
To access the Strategy Developer Zone, you must have access to the Strategy Knowledge Base, you must have purchased the Strategy SDK, and you must be current on your Strategy maintenance agreement. If you are a US-based business and believe that you satisfy all three of these conditions but you do not have access to the Strategy Developer Zone, please contact Strategy Technical Support at support@microstrategy.com or at (703) 848-8700. If you are an international business, please contact Strategy Technical Support at the appropriate email address or phone number found at https://www.microstrategy.com/en/support/contact-support.
 
CUSTOMIZATION WARNING:
This customization is provided as a convenience to Strategy users and is only directly applicable to the version stated. While this code may apply to other releases directly, Strategy Technical Support makes no guarantees that the code provided will apply to any future or previous builds. In the event of a code change in future builds, Strategy Technical Support makes no guarantee that an updated version of this particular customization will be provided. In the event of a code change in future builds, Strategy may not be able to provide additional code on this matter even though this customization is provided at this time for this specific build. For enhancements to this customization or to incorporate similar functionality into other versions, contact your Account Executive to inquire about Strategy Consulting assistance.
 


Comment

0 comments

Details

Knowledge Article

Published:

June 8, 2017

Last Updated:

June 8, 2017