Installing a custom search panel

Preface: This section details how to upload and install your own search panel using custom Search Mask XML definition files. If you are not experienced in navigating the SharePoint Management Shell (command-line interface) contact MacroView Services to get in touch with a professional SharePoint consultant.

 

For SharePoint Server (on-premises)

Before making any changes to your search panels, you will need to deactivate the MacroView DMF Search Web Application Feature.

To do this, you will need to:

  • Have Farm Administrator permission level on your SharePoint server.
  • In SharePoint Central Administration, navigate to Application Management and click Manage web applications.
  • On this page select your SharePoint web application and click on Manage Features in the ribbon.
  • Scroll to find MacroView DMF Search and click the Deactivate button.

With MacroView DMF Search deactivated, you are now ready to upload and install your custom Search Mask XML using the DMF Search Mask Manager. This tool is used to upload and install your custom Search Mask XML to your SharePoint Server (on-premises).

 

Download the version of DMF Search Mask Manager that corresponds with your version of SharePoint Server:

 DMF Search Mask Manager for SharePoint Server 2010

 DMF Search Mask Manager for SharePoint Server 2013 and 2016

 

To install a search panel:

  • Find and move your Search Mask XML definition file(s) into the same folder that contains the DMF Search Mask Manager.
  • Using the SharePoint Management Shell, navigate to the unzipped folder containing the DMF Search Mask Manager and Search Mask XML definitions.
  • Execute the following command in the SharePoint Management Shell:

.\DMF.SearchMasks.exe YOURSERVERURL YOURPATHTOXMLPANELSFILE

 

To delete a search panel:

  • Using the SharePoint Management Shell, navigate to the unzipped folder containing the DMF Search Mask Manager.
  • Execute the following command in the SharePoint Management Shell:

.\DMF.SearchMasks.exe -delete YOURSERVERURL 'PANELNAME'

 

After you have finished making the necessary changes, re-activate the MacroView DMF Search feature on the correct web application for the changes to take effect.

 

For SharePoint Online (Office 365) or Client-Side Only Mode

To install your custom Search Mask XML definition in MacroView DMF or Message, you simply need to host the search mask on your SharePoint Online (Office 365) tenancy, then point MacroView to that location.

First, upload your O365Mask.xml file to a location hosted on your SharePoint Online (Office 365) tenancy. Your O365Mask.xml file should contain all search masks you intend on using with MacroView DMF or Message, including the Email Search and Keyword Search provided by default and any custom ones you have created.

If you have your Search Mask XML definition(s) spread across multiple files, copy and paste them into the O365Mask.xml file before proceeding with the upload.

After the upload is complete, you'll need to point MacroView DMF or Message to the O365Mask.xml file location:

  1. Open Microsoft Outlook, select the MacroView ribbon tab and click Options.
  2. Select the Support tab on the left panel and navigate to the section titled Search Settings.
  3. Next to the Client Side Search Mask Location, click the grey box and browse to the file's location on your SharePoint Online (Office 365) tenancy.
  4. Close Microsoft Outlook, DMF Explorer (if applicable) and the MacroView DMF Local Service.
  5. Open Microsoft Outlook, click on the Search view at the bottom of the MacroView pane on the right side of the Outlook window.
  6. Click the Search Type drop down and view your newly installed search panels.

Related articles

Have more questions? Submit a request

0 Comments

Article is closed for comments.