KB38524: How to Change the Export Name for Document Exports Using the MicroStrategy Web SDK

 This article discusses how to change the export name when exporting using a custom Add-on. Below are steps on how to do this: 

1. Launch the Web Customization Editor.
2. Create a new plug-in and give it a meaningful name. For example: ChangeExportName. 
3. On the Application Settings tab, navigate to Strategy Web Configuration > Pages
4. Right-click on export(Export) and "Create New Add-on"
        Select a source folder for the project
        Choose any package that will contain the custom code
        Give a meaningful name for this Add-on such as "ModifyReportNameExportAddon"
        Provide a meaningful description
        Check the box for "Add custom logic before fetching data from Intelligence Server (preCollectData)"
5. Click Next, then Finish.
6. A java class should open.  Place the following code in the Add-on class:

public void preCollectData(PageComponent page) {
    	ExportBean eb = getExportBean(page);
    	if (eb != null) {
   			String name = "CUSTOM_EXPORT_NAME_HERE";
   			String formatType = eb.getExportFormat().getExportFormatType();
   			if (Integer.parseInt(formatType) == EnumExportFormats.ExportFormatExcelWithFormattingIServer) {
   				eb.setCustomReportName(name);    			
   			}
    	}
    } 
         
    protected ExportBean getExportBean(WebComponent wc) {
        ExportBean result = null;
        if (wc instanceof ExportBean) {
        	result = (ExportBean) wc;
        } else {
        	for (int i = 0; i < wc.getChildCount(); i++) {
        		result = getExportBean(wc.getChild(i));
        		if (result != null) {
        			break;
        		}
        	}
        }
        return result;
    }

1. Save changes.
2. Right click on the exportBinary(ExportBinary) page and choose "Add Existing Add-on".
3. Choose the class that was just created, in the above sample it is "ModifyReportNameExportAddOn"
4. Restart Web.
5. When exporting, the custom export name will appear.

 
 
The example provided in this document is provided “as-is” and user has read the following customization warning:
ADDITIONAL INFORMATION:
The Strategy SDK allows you to customize several Strategy products and extend and integrate the Strategy business intelligence functionality into other applications. However, before changing the way Strategy products look or behave, it is helpful to understand how the application is built. For more information regarding the Strategy products or the process of customizing Strategy products, please refer to Strategy Developer Zone (https://developer.microstrategy.com).
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/us/services/support/contact.
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.