KB42509: How to Specify the Default Search Option from the Search Functionality in MicroStrategy Web SDK

When searching in Strategy Web 9.2.x, users have the following search options:

• In all folders
• Only inside folder Shared Reports
• Only inside folder My Reports
• Only inside folder <current folder name> (only shown when searching inside a folder)

To specify the default search option, follow the steps below:
 
 

1. Launch the Web Customization Editor.
2. Create a new plug-in and give it a meaningful name. For example: DefaultSearchSharedReports. (For step by step instructions on creating a newplug-in, please navigate to Home > Web SDK > Customizing Strategy Web > Web Customization Editor > Features and Customizable).
3. 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.
4. Navigate to Strategy Web Configuration > Pages > search(SearchPage) > Beans > sb for the search bean.
5. In the Intialization Properties tab, add a new property 'folderType' with Type 'int', Source 'enum', and Value '7' for Shared Reports.
   Add the following for the Shared Reports or My Reports folder:
   
• Shared Reports: com.Strategy.webapi.EnumDSSXMLFolderNames.DssXmlFolderNamePublicReports or 7
• My Reports: com.Strategy.webapi.EnumDSSXMLFolderNames.DssXmlFolderNameProfileReports or 20
6. Note: refer to the Strategy Javadocs Constant Field Values for other folders.
   
7. In the Request Properties tab, remove the folderType property, to prevent the quick search event to take precende over the default search option. Please note that the following customization will result in always defaulting to the desired folder type.
8. Remove Event map 3016 - Map ID 2003 - Argument ID 3001 and 3008.
9. Note: Because of the known issue described in TN: 42456, where you can't edit the event-maps in the WCE for the search bean, you will have to manually add a few lines to the pageconfig.xml. 
10. Locate the pageconfig.xml file in your plugins folder (\MicroStrategy\plugins\PluginNAme\WEB-INF\xml) and open it in an editor.
    
11. Add the following after <page name="search"> :
     
    <event-maps>
       <event-map id="3016" map-id="2003" root-only="true" target="sb">
         <argument deleted="1" id="3001"/>
         <argument deleted="1" id="3008"/>
       </event-map>
    </event-maps>
    
12. Save your changes and restart your 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://resource.microstrategy.com/msdz/).
 
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 http://www.microstrategy.com/Support/ContactUs.asp.
  
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.